Skip to main content

Accounts used by ArcGIS Velocity

ArcGIS Velocity uses several accounts to run and access the app.

ArcGIS Velocity services account

Velocity starts and stops system processes, reads and writes data to locations on the local file system, and can be configured to read and write real-time data to files stored in locations elsewhere on a network. To perform these tasks securely, it uses an operating system account that is specified when installing Velocity. This account is referred to as the ArcGIS Velocity services account.

The ArcGIS Velocity services account is used for the following purposes:

  • Start and stop processes that support Velocity and its real-time items. This includes processes, such as the Feed Manager, Stream Service Manager, and ArcGIS Velocity Gateway.

  • Read and write files to the configuration store.

  • Create new configuration backup files every 24 hours.

  • Deploy new folder structures to handle the creation and management of Kafka components on disk.

  • Read and write log messages to the logs directory.

  • Read from local files to process real-time data with feed types.

  • Write to local files to store real-time data with output types.

The ArcGIS Velocity services account defaults to the name arcgis as a local account. Accepting this default is sufficient for most non-production deployments. For production systems, it is recommended that you create a domain or group managed service account before you install Velocity. These account types provide greater flexibility for accessing, reading, and writing data across networked resources, not just the computer where Velocity is installed.

If you choose to use a domain account, use the format DOMAIN\username. If no domain is specified, the Velocity installation wizard creates a local account using the username you specified. If you specify a domain account that does not exist, the installation process returns an error.

The installation wizard offers the option to use a group managed service account (gMSA). This is a special Active Directory domain account that provides automatic password management.

The ArcGIS Velocity services account does not require special permission on the operating system other than full control permissions to the Velocity installation location, logs root, configuration root, and configuration backup locations. If these locations are changed, you must manually grant the ArcGIS Velocity services account the same permissions for the new locations. These locations are specified when you create a Velocity site. The ArcGIS Velocity services account does not need to be an administrator on the machine.

The ArcGIS Velocity services account is the one used when installing the software. The installation makes this service account the owner of all files that it places on the system.

The ArcGIS Velocity services account does not require special permission on the operating system other than the file access to the installation location, logs root, configuration root, and configuration backup locations. The ArcGIS Velocity services account does not need to be an administrator on the machine.

Change the ArcGIS Velocity services account

You do not need to rerun the Velocity installation to change the account that runs ArcGIS Velocity. After you install, you can change the account by running the configureserviceaccount_all utility, which is included with the software. For example, you can change the account to respond to a change in security policy or when troubleshooting.

The utility changes the Run As account value assigned to the ArcGIS Velocity services (Control Plane, Feeds, Gateway, Real-Time Analytics, Stream Server, and Metrics) and grants the account the permissions it needs on the ArcGIS Velocity installation directory.

After running the configureserviceaccount_all utility, verify that the account used to run Velocity has full control of the installation directory, logs directory, configuration store directory, configuration backup locations, and server directories, including their files and subfolders. If necessary, use operating system tools to grant the required permissions.

The utility is installed in <ArcGIS Velocity installation directory>\tools\ConfigUtility.

Note:

Run the utility from a command prompt opened with the Run as administrator option.

In the following example, the configureserviceaccount_all utility sets a domain account to run the ArcGIS Velocity services, grants the account the privileges required on the ArcGIS Velocity installation directory folders and files, and writes a configuration file with the Windows account information to your disk.

configureserviceaccount_all.bat --username mydomain\username --password my_password --writeconfig c:\temp\domainaccountconfig.xml
Note:

Changing the account under which the service runs causes the service to restart.

Note:

The ArcGIS Velocity services account must remain the same when you upgrade Velocity.

The configureserviceaccount_all utility has the following parameters:

configureserviceaccount_all [--username username] [--password password] [--readconfig user-configuration-file] [--writeconfig user-configuration-file]
  • username: The name used for the ArcGIS Velocity services account.

  • password: The password used for the ArcGIS Velocity services account.

  • readconfig: An optional path to a configuration file that you saved from a previous run of the utility.

  • writeconfig: An optional path where a configuration file is saved that allows you to apply the same properties in future runs of the utility.

ArcGIS Velocity primary site administrator account

After installing Velocity, a Velocity site is created. At this point, you need to provide a username and password for a new account that is used initially to federate with a portal in ArcGIS Enterprise. This account is called the ArcGIS Velocity primary site administrator account.

The primary site administrator account is neither an operating system account, such as the ArcGIS Velocity services account, nor is it a portal managed user account that can create, own, or share real-time items. It should not be confused with the primary site administrator of other ArcGIS apps, such as ArcGIS Server. The primary site administrator account is used to administer the Velocity site and to federate it with a portal in ArcGIS Enterprise. After federation, administrators can sign in to the Velocity Administrator directory using the primary site administrator account or an appropriately privileged portal account.

A system administrator can reset the primary site administrator password using the passwordreset utility located on the machine where Velocity is installed. This can be found in <ArcGIS Velocity installation directory>\tools\passwordreset.

A system administrator can reset the primary site administrator password using the passwordreset utility located on the machine where Velocity is installed. This can be found in <ArcGIS Velocity installation directory>/tools/passwordreset.

Portal users

Velocity requires federation with a portal in ArcGIS Enterprise. Velocity uses the portal's identity store to allow access to the Velocity home app and to manage privileges for creating feed and real-time analytic items. Velocity associates ownership of each item created, such as a feed, real-time analytic, or layer, with the portal member who created it.

Velocity requires that a member of the portal be either a Creator user type or higher to access the app. Members of the portal must have the Publish feeds and Publish real-time analytic content privileges to create feeds and real-time analytics, respectively.

Learn more about user roles