Install and configure GeoEnrichment Server

Available with Business Analyst license.

Business Analyst Enterprise requires two ArcGIS Server machines.

  1. A complete base deployment with all software components is required; see Installation overview for details.
  2. A dedicated ArcGIS Server machine is needed to install GeoEnrichment Server. This machine must meet the following requirements:
    • For ArcGIS Server and ArcGIS Web Adaptor installations, the server must be federated to your ArcGIS Enterprise portal.
    • The GeoEnrichment server setup requires a Microsoft Windows operating system.
    • The GeoEnrichment server setup cannot be installed on the same machine as the ArcGIS Data Store.
    • The GeoEnrichment server cannot be designated as the hosting server.

Download the setup

To download the setup, complete the following steps:

  1. On the My Esri site, click Downloads and click your current ArcGIS Enterprise version, such as ArcGIS Enterprise 11.5 (Windows). Click Products, click All Versions, and search for Business Analyst.
  2. Look for ArcGIS Business Analyst Enterprise and ensure the latest version is used. Click View Downloads.
  3. To view the details of the download components, expand the details.
  4. For ArcGIS GeoEnrichment Server, click Download.

    The downloaded file appears in your computer's Downloads folder.

Run the setup

Browse to the location of the downloaded setup file and run the GeoEnrichment Server setup.

  1. Double-click setup.exe to run the GeoEnrichment Server installation application.

    The GeoEnrichment Server welcome page appears.

  2. On the GeoEnrichment Server welcome page, click Next.
  3. Review and accept the Esri Master Agreement. Click Next.
  4. Choose whether to install AI Model features and click Next.

    The AI Model feature for semantic search is not installed by default. Semantic search is an AI-enhanced smart search technology that provides improved search results. Installing this feature enables the Find related variables functionality in the data browser and the Include related POIs functionality in points of interest search.

  5. Accept the default destination folder for the GeoEnrichment software to be installed or browse to a different location. Click Next.
  6. Enter the credentials for the ArcGIS Server primary account. Click Next.

    The primary account runs the ArcGIS Enterprise and ArcGIS Server processes and needs to be created when ArcGIS Server is installed. You can specify to use a configuration file from a previous installation.

  7. Specify whether to export a configuration file based on this installation. Click Next.

    Tip:
    Exporting an account configuration file helps with installing multiple systems.

  8. The GeoEnrichment Server software is ready to install. Click Install.
  9. Once the installation is complete, click Next.
  10. Click Finish to close the GeoEnrichment Server installation application.

GeoEnrichment environment configuration utility

After installing the GeoEnrichment Server software, an environment configuration utility is provided to perform several administrative tasks. These tasks include preparing the database and services, creating and sharing items in the portal, optimizing ArcGIS Server memory settings, and registering GeoEnrichment as a utility service in the portal.

The environment configuration wizard relies on the ArcGIS Enterprise portal's built-in identity store. The initial administrator account can be used for authentication, or any other built-in account with administrator privileges. If the wizard cannot discover the portal's administrative URL automatically, an additional page appears, allowing for the URL to be entered manually.

  1. In the Start menu, search for GeoEnrichment and click GeoEnrichment Environment Configuration Utility.

    Note:

    It may be necessary to agree to proceed through the User Account Control prompt.

  2. On the welcome page for the GeoEnrichment Server configuration wizard, click Next to begin specifying the parameters necessary to configure your server environment.
  3. Enter the credentials for the portal administrator user and click Next.
  4. Specify a folder where you want the GeoEnrichment data to be stored. Click Next.

    Note:
    The specified location should have at least 200 GB of dedicated storage for staging and installing the USA data pack. For more information, see Disk space requirements.

  5. Select Yes to register the GeoEnrichment service as a portal utility service. Click Configure.

    Choosing to register the GeoEnrichment service as a portal GeoEnrichment utility service makes the service the default selection for GeoEnrichment processes run on the portal.

  6. As the GeoEnrichment Server environment is configured, a status bar and additional details are available to track the progress. Once completed, click Next.

    The GeoEnrichment Server environment is successfully configured.

  7. Click Finish.
  8. Optionally, manage data using the GeoEnrichment Data Management Utility by checking the Run the data management tools to install data packs check box.

Install GeoEnrichment Server silently

You can install ArcGIS GeoEnrichment Server without a user interface by running the setup using Windows Installer command line parameters.

Installation command line parameters

The following parameter is required when installing ArcGIS GeoEnrichment Server silently:

  • ACCEPTEULA=yes

This property is required to accept the End User License Agreement (EULA) during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this property results in a failed installation. The download contains a PDF version of the EULA. The EULA.pdf file is located in the \Documentation folder.

See the following example: <path to the ArcGIS GeoEnrichment Server setup download>\setup.exe /qb ACCEPTEULA=yes

Configuring the ArcGIS GeoEnrichment Data Store account using command line parameters

The GeoEnrichment Data Store account must be configured when ArcGIS GeoEnrichment Server is installed silently. It is recommended that you use the preexisting ArcGIS Server account created during the ArcGIS Server installation. If command line parameters are not used to configure the GeoEnrichment Data Store account during silent installations, the account is set to the Local System account. This is primarily for the convenience of quickly installing ArcGIS GeoEnrichment Server.

Use the command line parameters below to configure the GeoEnrichment Data Store account.

Passing ArcGIS GeoEnrichment Data Store account credentials directly

Caution:
If the GeoEnrichment Data Store account is not defined during a silent (/qb) installation, or the credentials are not valid, the setup displays a warning message during installation. The message can be closed by clicking OK. Under these circumstances, the GeoEnrichment account is set to the Local System account.

USER_NAME=<operating system account>

The account can be a domain account or a local account. If you are using a domain account, it must already exist. If you are using a local account, the account is created if it does not already exist. If the account is not valid, a message box appears during installation indicating the account or password is invalid.

MSA=TRUE

This parameter should only be used with a Managed Service Account. A Managed Service Account must already exist on your domain. Do not use this parameter with a local account or a domain account with a password. A Managed Service Account does not use the PASSWORD parameter.

PASSWORD=<account password>

This is the password for the account specified for the USER_NAME parameter. If the password is not valid, a message appears during installation indicating the account or password is invalid. See the examples below.

Caution:

Command line parameters are case-sensitive. If you are having trouble getting your command line installation working, confirm that the case matches the properties as shown in the examples.

Using a domain account

<path to the ArcGIS GeoEnrichment Server setup download>\setup.exe /qb ACCEPTEULA=yes USER_NAME=mydomain\mydomainaccount PASSWORD=my.password

Using a new or existing local account

<path to the ArcGIS GeoEnrichment Server setup download>\setup.exe /qb ACCEPTEULA=yes USER_NAME=myaccount PASSWORD=my.password

Using a Managed Service Account

<path to the ArcGIS GeoEnrichment Server setup download>\setup.exe /qb ACCEPTEULA=yes MSA=TRUE USER_NAME=mydomain\mymsa

Installing optional AI model feature for semantic search

The ADDLOCAL parameter is used to specify which optional features to install when silently installing ArcGIS GeoEnrichment Server. Installing the AI model feature for semantic search enables enhanced search capabilities for demographic variables and POI. Use the command line parameter below to install semantic search:

  • ADDLOCAL=SemanticSearch

See the following example: <path to the ArcGIS GeoEnrichment Server setup download.\setup.exe /qb ACCEPTEULA=yes USER_NAME=<username> PASSWORD=<password> ADDLOCAL=SemanticSearch

Configure the ArcGIS GeoEnrichment Server environment silently

You can configure the ArcGIS GeoEnrichment Server environment without a user interface using the manageEnvironment.bat tool command line parameters.

Open a command prompt and browse to the directory where the server tools are installed for GeoEnrichment: <ArcGIS Server Installation Directory>/tools/geoenrichment

The ManageEnvironment.bat tool can be run in interactive mode or in non-interactive mode. To run in non-interactive mode, pass the required parameters using the following sample syntax. The user must be a built-in portal administrator. <ArcGIS Server Installation Directory>/tools/geoenrichment/manageEnvironment.bat create -b --yes -u <user name> -p <password>

The parameters of manageEnvironment.bat are as follows:

OptionDescription

create

Create environment

repair

Repair environment

remove

Remove environment

upgrade

Run environment upgrade (only in upgrading state)

info

Show environment configuration information

-b; --batch-mode

Run in non-interactive (batch) mode

-d; --directory <directory>

By default, the GeoEnrichment Data Store is installed in the user's <ArcGIS GeoEnrichment Installation Directory>/data directory. The DIRECTORY specifies a different installation directory.

-h; --help

Show command line syntax help

-l; --log

Log File directory

-nu; --no-utility-service

Do not register GeoEnrichment as a portal utility service

-p; --password <password>

Portal administrator password

-u; --username <username>

Portal administrator username

-y; --yes

Automatically answer yes to all prompts

Uninstall ArcGIS GeoEnrichment Server silently

To uninstall ArcGIS GeoEnrichment Server silently, run this command from the command line:

  • msiexec /x {B2755F3D-5798-417D-AD2B-B30382E38D45} /qb

Next step

Installing Geoenrichment data packs