Skip to main content

Install ArcGIS Data Store

You can install ArcGIS Data Store using an using an interface or run the installation file from the command line. Specify the type or types of data store to install on each machine.

Note:

  • Each type of ArcGIS Data Store can use either relatively little or significant amounts of resources depending on the number of users and workloads that it supports in the system. It is imperative to ensure that the machines have sufficient resources for all software, data, and network traffic that they are expected to consume; otherwise, resource issues could result in inoperable data stores.

    Apply good judgement in decisions around whether or not to collocate multiple data stores or ArcGIS Server sites on the same infrastructure with this in mind, and monitor system performance. If you are in doubt, a conservative approach that preserves flexibility and minimizes impact to other parts of the system is to install and run each data store type on separate machines.

  • The license that you purchase for ArcGIS Knowledge Server dictates the core capacity of the machines where you install the graph store. See the product sales update for ArcGIS Knowledge Server for more information.

Complete the steps to Prepare to install ArcGIS Data Store, and then install ArcGIS Data Store.

Note:

You cannot alter which ArcGIS Data Store types are installed on the machine. That means you cannot add another type later, but it also means you cannot uninstall an ArcGIS Data Store type if you decide you do not need it.

Prepare to install ArcGIS Data Store

Complete these steps before you install ArcGIS Data Store:

  1. Verify that your server meets the minimum system requirements for ArcGIS Data Store and read Considerations before creating a data store.

  2. Modify the firewall of the data store server to allow communication on ports needed for the type of data store you will create.

    If the firewall on the data store server blocks communication through these ports, the GIS Server site can't connect to the data store.

  3. Download the ArcGIS Data Store setup package from My Esri and extract it to a directory on the server where you will install ArcGIS Data Store.

  4. Before beginning the installation, read the license agreement located at <CD_ROOT or untar directory>/Documentation/EULA.pdf.

Use an installation interface

For an interactive ArcGIS Data Store installation experience, complete the following steps:

  1. Sign in to the server as a user with administrative privileges.

    You cannot install ArcGIS Data Store as a root user.

  2. Run the setup program from the ArcGIS Data Store download folder or setup media.

    The setup program begins by checking the prerequisites that must be met to set up and use ArcGIS Data Store. If your system does not meet the prerequisites, follow the instructions on the dialog box to correct any issues.

    If all prerequisites are met, the Introduction dialog box appears.

  3. Click Next on the Introduction dialog box to proceed.

  4. On the Master Agreement dialog box, read the license agreement, and do one of the following:

    • If you accept the terms, click I accept the master agreement, and click Next to proceed.

    • If you do not accept the terms, close the Master Agreement dialog box by clicking Cancel.

  5. Choose the type of data store to install on this machine and click Next.

    It is recommended that you install data store types on separate machines to avoid resource contention between data stores. This is especially important in the case of spatiotemporal big data stores and graph stores. Do not install these data stores on the same machine as other data stores or ArcGIS Enterprise components.

  6. On the Choose Install Folder dialog box, specify the installation location, and click Next to continue.

  7. Review the summary information, and click Install to begin the installation.

  8. When completed, click Done to close the interface.

Follow the postinstallation instructions below to configure ArcGIS Data Store to start with the operating system.

  1. Create a Microsoft Windows account to be used for the ArcGIS Data Store account.

    It is recommended that you use a domain account, so you may need to request this from your IT department. If you choose to use a local Windows account, the installation interface can create the account for you, but it will not work if you have more than one machine that runs ArcGIS Data Store.

  2. Download the ArcGIS Data Store setup packages from My Esri.

    Note:

    There are two ArcGIS Data Store self-extracting files— ArcGIS_DataStore_Windows_<version>_<productID>.exe and ArcGIS_DataStore_Windows_<version>_<productID>.exe.001. Download both files.

  3. To extract the setup files, double-click the ArcGIS_DataStore_Windows_<version>_<productID>.exe setup package and specify a folder on the server where you will install ArcGIS Data Store.

    Note:

    The ArcGIS_DataStore_Windows_<version>_<productID>.exe and ArcGIS_DataStore_Windows_<version>_<productID>.exe.001 files must be in the same folder when you extract their contents.

  4. Before you begin the installation, read the End User License Agreement (EULA), which is included as a PDF in the \Documentation folder of the ArcGIS Data Store download.

Run the ArcGIS Data Store installation

For an interactive installation experience, follow the steps below:

  1. Double-click the Setup.exe file to run the ArcGIS Data Store installation.

    The interface prompts you to provide a location for the installation directory. The installation directory contains the ArcGIS Data Store application files.

  2. Choose the type of data store to install on this machine.

    If a data store type is already installed on this machine, that option will be disabled.

  3. Specify a location on the local machine where you want the data store files to be stored.

  4. Provide credentials for the ArcGIS Data Store account you created in the preparation steps, or allow the installer to create a local account.

    You must provide a login and password for a Windows domain or local account.

    If you use a local Windows account, you cannot define a shared backup location until you change to a domain account.

    If you allow the installer to create a local account, the password you provide must adhere to your operating system's local security policy. Read the Microsoft documentation for instructions to determine the password requirements of your Windows machine.

    After installation, you can run the configureserviceaccount utility to change the ArcGIS Data Store account if needed.

The Data Store configuration app opens when the installation completes. Use the configuration app to create a relational store, object store, spatiotemporal big data store, or graph store and register it with the GIS Server site you will use as the hosting server.

Run from a terminal

To install ArcGIS Data Store from a command prompt, complete the following steps:

  1. Sign in to your machine as a user with administrative privileges.

    You cannot install ArcGIS Data Store as a root user.

  2. Run the setup silently at the prompt.

    See the following sample syntax: <CD_ROOT or untar directory>/Setup -m silent -l yes -d /software/datastore -f Relational

    Command line options include the following:

    Option

    Description

    -m MODE or --mode MODE

    Optional.

    MODE is one of the following: silent or gui. The default value is gui.

    -l CHOICE or --license-agreement CHOICE

    Required for silent mode. CHOICE can be yes or no. Yes indicates that you have read and agreed to the Esri Master Agreement (E204, E300). Read the agreement at https://www.esri.com/legal/licensing-translations.

    -d DIRECTORY or --directory DIRECTORY

    Optional. By default, ArcGIS Data Store is installed in the user's $HOME directory. To use a different directory, specify it with the -d or --directory option.

    The path /arcgis/datastore will be appended to the installation directory.

    -f CHOICE or -features CHOICE

    Optional. This option specifies the type of data store that will be installed on the machine. The default value is Relational,Object.

    CHOICE can be one of the following:

    • Graph

    • Object

    • Relational

    • Spatiotemporal

    • Complete

    Although you can specify more than one choice separated by commas or use Complete to install all data store types, It is recommended that you install each data store type on separate machines to avoid resource contention between data stores. This is especially important in the case of spatiotemporal big data stores and graph stores. Do not install these data stores on the same machine as other data stores or ArcGIS Enterprise components.

    -v or --verbose

    Installer runs in verbose mode.

    -h or --help

    Displays command line help and exits.

    -e or --examples

    Displays usage examples of these options and exits.

Follow the postinstallation instructions below to configure ArcGIS Data Store to start with the operating system.

Postinstallation configuration

If you want ArcGIS Data Store to start with the operating system, complete the steps specific to your operating system below.

Operating systems that support systemd

If your operating system supports the use of systemd to bootstrap and manage processes, complete the following steps to configure ArcGIS Data Store to start with the operating system:

  1. Within a command shell, switch to root user.

  2. Copy <ArcGIS Data Store installation directory>/framework/etc/scripts/arcgisdatastore.service to /etc/systemd/system, and update the permissions of /etc/systemd/system/arcgisdatastore.service from 700 to 600.

    If you configure a spatiotemporal big data store on the machine, edit the arcgisdatastore.service file to add comment marks (#) to the relational store parameter and remove the comment marks from the spatiotemporal big data store parameters as follows:

    /# Configuration for relational data store /# LimitNOFILE=65535 /# LimitNPROC=25059 /# Configuration for spatiotemporal big data store LimitNOFILE=65536 LimitNPROC=25059 LimitAS=infinity LimitFSIZE=infinity

    No edits are needed for machines running any of the other ArcGIS Data Store types.

  3. Still as the root user, run the following command to automatically create the links in /etc/systemd/system/multi-user.target.wants:

    $ systemctl enable arcgisdatastore.service

  4. To verify that the systemd service is properly configured, restart the service and check its status as follows:

    $ systemctl stop arcgisdatastore.service $ systemctl start arcgisdatastore.service $ systemctl status arcgisdatastore.service

  5. End the root user session.

  6. Reboot the operating system and verify that ArcGIS Data Store restarts properly.

Note:

If you install ArcGIS Data Store on a Linux machine that includes systemd v228 or a later version, you may need to enable and raise the systemd limit to 512 maximum threads if the data store machine is heavily used. (For example, SUSE Linux Enterprise Server (SLES) 12 SP2 includes systemd v228.) Setting systemd to a maximum of 512 threads can prevent any single service from spawning too many threads and consuming all server resources.

To enable and raise the limit, as the root user, uncomment and edit the following line in the arcgisdatastore.service unit file before deploying it to the /etc/systemd/system directory:

# TasksMax=512

Operating systems that support SysV

If your operating system supports the use of SysV to bootstrap and manage processes, complete the following steps to configure ArcGIS Data Store to start with the operating system:

  1. Within a command shell, switch to root user.

  2. Copy the <ArcGIS Data Store installation directory>/framework/etc/scripts/arcgisdatastore shell script to the appropriate supported Linux distribution-based locations provided below:

    • RHEL Server: /etc/rc.d/init.d/

    • SLES: /etc/init.d/

  3. Change the directory to the applicable init.d folder, and review the arcgisdatastore script to ensure that root has at least read and execute permissions.

  4. Edit the arcgisdatastore script as follows:

    1. Update the datastorehome variable to the ArcGIS Data Store installation directory, for example, /home/username/arcgis/datastore.

    2. For RHEL Server only, add the following line just before # Description: ArcGIS Data Store Service:

      # chkconfig: 35 99 01

    3. Save the edits to the arcgisdatastore script.

  5. Still as root user, run the following command to automatically create the links in /etc/rc*.d with the appropriate run levels:

    • RHEL Server:

      $ chkconfig --add arcgisdatastore $ chkconfig arcgisdatastore on

    • SLES:

      $ insserv arcgisdatastore $ chkconfig arcgisdatastore on

  6. End the root user session.

  7. Reboot the operating system and verify that ArcGIS Data Store restarts properly.

Install from a command prompt

Instead of using an interface, you can call the installation file from a command prompt and provide the necessary information to install ArcGIS Data Store by following the steps below:

  1. Open a command prompt using the Run As Administrator option.

  2. Run the ArcGIS Data Store setup from the command line.

    The syntax to run the setup file from the command line is as follows:

    <path to ArcGIS Data Store setup>\Setup.exe /qb ACCEPTEULA=<yes | no> {ADDLOCAL=<graph | object | relational | spatiotemporal | ALL} {MSA=<true | false>} {INSTALLDIR=<directory>} USER_NAME=<account login> PASSWORD=<account password>

    Option

    Description

    /qb

    The /qb option is not required, but it allows you to run the setup without prompts (also called a silent installation). Use this if you script the installation.

    ACCEPTEULA

    The ACCEPTEULA option is required to accept the End User License Agreement during a silent installation. Specify yes to agree to the End User License Agreement and install the software. Specifying no or omitting this property will result in a failed installation.

    ADDLOCAL

    Use the ADDLOCAL option to specify the type of data store to install on this machine.

    If you do not specify the ADDLOCAL option, it defaults to relational,object.

    You can specify more than one choice separated by commas to install all data store types. However, if you install multiple data store types on the same machine, it is imperative to ensure that there are enough machine resources to support all intended workloads concurrently. In the case of the spatiotemporal big data store and graph store, do not install these data stores on the same machine as other data stores or ArcGIS Enterprise components.

    INSTALLDIR

    The first time you install ArcGIS Data Store on a machine, you can specify an installation directory for the data store using the INSTALLDIR option. If you do not specify a directory the first time you install ArcGIS Data Store on a machine, the default location of C:\Program Files\ArcGIS\DataStore is used.

    MSA

    To use a group managed service account for the ArcGIS Data Store account, specify the MSA option and set it to true. If you do not specify the MSA option, it defaults to false.

    A managed service account must already exist on your domain if you set the MSA option to true. Do not use the MSA option with a local account or a domain account that requires a password.

    USER_NAME

    Use the USER_NAME option to specify the login to be used for the ArcGIS Data Store account.

    If you set the MSA option to true, use the USER_NAME option to specify the group managed service account.

    If you did not specify the MSA option or you set it to false, use the USER_NAME option to specify the local or network Windows login to use for the ArcGIS Data Store account.

    For domain accounts (which include group managed service accounts and Windows network logins), provide the domain and account name; for example, for Windows account myaccount on domain mydomain, specify mydomain\myaccount with the USER_NAME option.

    PASSWORD

    Use the PASSWORD option to specify the password of the local or network Windows login that you provided for the USER_NAME option.

    Do not use the PASSWORD option if you provided a group managed service account for the USER_NAME option.

    In the following example, a domain account is specified when installing ArcGIS Data Store, the relational store files are installed, and the silent option (/qb) is specified to avoid prompts:

    <path to ArcGIS Data Store setup>\Setup.exe /qb ACCEPTEULA=yes ADDLOCAL=relational INSTALLDIR=c:\arcgisdatastore USER_NAME=mydomain\mylogin PASSWORD=D0mayneAcc0untPw

    In this example, a group-managed service account is used and the files for a spatiotemporal big data store are installed:

    <path to ArcGIS Data Store setup>\Setup.exe /qb ACCEPTEULA=yes ADDLOCAL=spatiotemporal MSA=TRUE INSTALLDIR=c:\arcgisdatastore USER_NAME=mydomain\managedserviceaccount

    Caution:

    If you do not specify the ArcGIS Data Store account during a silent (/qb) installation, or you provide invalid credentials, the setup displays a warning message during installation. The message can be closed by clicking OK. Under these circumstances, the ArcGIS Data Store account is set to the Windows LocalSystem account.

Next step

After you install ArcGIS Data Store, create the data store type (or types) that you installed.