Skip to main content

ArcGIS Velocity administrator operations

Use the ArcGIS Velocity Administrator directory to perform the following tasks:

  • View general information about your Velocity site

  • View items registered with your Velocity site

  • Back up and restore configured Velocity feeds and real-time analytics

  • Import and configure server certificates

  • Update Velocity security information

  • View and edit system properties

  • Manage Velocity logs

Note:

If you are upgrading to 12.2, refer to upgrading ArcGIS Velocity for more information.

View the about resource

The about resource returns site, hardware, federation state, and license information about your Velocity site.

To view the about resource, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click About.

View items

The items resource lists the feeds, real-time analytics, and stream items registered with your Velocity site. You can use this resource to review the items that exist on your site.

To view items, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Items.

Back up and restore configured Velocity feeds and real-time analytics

By default, Velocity automatically creates an item configuration backup file every 24 hours and stores it in the configuration backup location specified during installation. This file contains configuration information for all feeds and real-time analytics on the site. You can back up and restore feeds and real-time analytics by exporting and importing snapshots.

To edit the default export snapshot settings, use Edit backup restore settings.

Note:

Only organization-authenticated administrators can access operations under Backup Restore Info in the Velocity Administrator directory. These operations are not available when you sign in with the primary site administrator (PSA) account. This is because recreated items must exist under an ArcGIS organization user. The PSA cannot own items in ArcGIS Enterprise.

Export a snapshot

To export a copy of the site item configuration, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Backup Restore Info.

  3. Click Export Snapshot.

  4. Click Export.

Import a snapshot

To import an item configuration file, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Backup Restore Info.

  3. Click Import Snapshot.

  4. Provide the item configuration backup file.

  5. Click Import.

Note:

This action recreates feeds and real-time analytics under the authenticated account performing the action. You may need to redistribute these items to other users. An item configuration file does not preserve credentials and API keys. Items may require some level of reconfiguration.

Reset a snapshot

You can reset a snapshot to delete all existing feed, real-time analytic, and stream service items owned by users in a site. This is a permanent action and may take a few minutes to complete. To reset a snapshot, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Backup Restore Info.

  3. Click Reset Snapshot.

  4. Click Reset.

Edit backup restore settings

The backup restore settings display the current backup restore location and backup frequency.

To edit settings, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Backup Restore Info.

  3. Click Settings.

  4. Click Edit.

  5. Specify the directory where automatic backup files will be stored in the Backup Restore Location option. For example:

    C:\Program Files\ArcGIS\Velocity\config\velocity\0123456789abcdef\snapshots_new

    <installation directory>/arcgis/velocity/nfs_share/config/velocity/0123456789abcdef/snapshots_new

  6. Click Backup Frequency to choose how often to back up the information.

    For example, Every 1 day(s) at 01:00 AM.

  7. Choose the response format in the Format option.

    The default is HTML.

  8. Click Update.

Import and configure server certificates

You can import an existing server, root, or intermediate certificate, including certificates signed by a commercial certificate authority (CA) or a corporate (internal) CA.

Import an existing CA-signed certificate

Note:

To import the certificate into your server, the certificate and its associated private key must be stored in the PKCS#12 format, which is represented by a file with either the .p12 or .pfx extension.

To import a CA-signed certificate to the Velocity Administrator directory, complete the following steps:

  1. Sign in to the Velocity Administrator directory using the Velocity primary site administrator credentials.

    The URL is in the format https://velocity.example.com:7143/arcgis/admin.

  2. Accept the security warnings presented by your browser.

  3. Click machines > [machine name].

  4. Click sslcertificates, then click importExistingServerCertificate, and provide the information for the following options:

    1. Certificate Password: Type the password to unlock the file containing the certificate.

    2. Alias: Type a unique name that easily identifies the certificate. For example, server-cert.

    3. Certificate File: Browse to the location and select the existing CA-signed certificate.

    4. Import certificate chain: Check this check box if you want to import root or intermediate certificates included in the .pfx or .p12 file. The alias for these certificates matches the alias provided above and are appended with either _root or _intermediate depending on the type of certificate.

  5. Click Import.

Import a root or intermediate certificate

To import a root or intermediate certificate to the Velocity Administrator directory, complete the following steps:

  1. Sign in to the Velocity Administrator directory using the Velocity primary site administrator credentials.

    The URL is in the format https://velocity.example.com:7143/arcgis/admin.

  2. From Velocity Administrator directory, click machines > [machine name] .

  3. Click sslcertificates > ImportRootOrIntermediate.

  4. On the Import Root or Intermediate page, provide the following information:

    1. Alias: Type a unique name for the alias. For example, caroot.

    2. Browse to the location and select the root certificate provided by CA.

  5. Click Import.

Note:

Importing a root certificate restarts all ArcGIS Velocity services by default. To prevent the restart, check the Do not restart the Velocity services after import check box.

Update Velocity security information

You can update the security configuration and the site administrator credentials.

Update the security configuration

The security configuration returns the identity store information, along with various security configurations, for an organization. Use the update option to update the security configuration, including TLS protocols and cipher suites, for your Velocity site. To update the security configuration, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Security > config > update.

Update the primary site administrator credentials

You create the primary site administrator account when you create the Velocity site. You can update the credentials for this account by using either the user interface or the command line.

Update the primary site administrator credentials using the user interface

To change the username or password for this account, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Security > psa > update.

Reset a primary site administrator's password using the command line

To reset the password for the primary site administrator, complete the following steps:

  1. Open a command-line window using the Run as administrator option.

  2. At the command line, browse to the C:\Program Files\ArcGIS\Velocity\tools\passwordreset folder.

    For example,

    cd "C:\Program Files\ArcGIS\Velocity\tools\passwordreset"
    
  3. If you have forgotten the name of the primary site administrator account and want to retrieve it, run the passwordreset.bat utility with the -l option.

    passwordreset.bat -l
    
  4. To reset the password, run the passwordreset.bat utility.

    passwordreset.bat my_new_password
    
  1. Sign in to the Linux machine using the account that installed Velocity.

  2. Open a terminal window.

  3. Browse to the folder <installation directory>/arcgis/velocity/tools/passwordreset.

  4. If you have forgotten the name of the primary site administrator account and want to retrieve it, run the passwordreset.sh utility with the -l option.

    ./passwordreset.sh -l
    
  5. To reset the password, run the passwordreset.sh utility.

    ./passwordreset.sh my_new_password
    

View and edit system properties

You can view license information, and view and edit custom system properties for memory allocation, forward proxy server, and WebContextURL.

View licenses

The system licenses resource returns license information for Velocity. A valid license is required for Velocity to function correctly. This resource returns higher-level licensing information, such as the Velocity version and license expiration date. To view license information, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click System > Licenses.

View system properties

The system properties resource returns information about custom system properties. To view the system properties, including memory allocation, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click System > Properties.

Update system properties

Custom system properties that can be updated include minimum and maximum memory values allocated to Velocity services, forward proxy server configurations, and WebContextURL settings.

Memory allocations

You can change the minimum and maximum memory values allocated to the Control Plane, Feeds, Real-Time Analytics, Stream Server, and Gateway services using the Update Properties option. By default, each of these services has a minimum of 500 MB and a maximum of 2048 MB of memory. Consider increasing the minimum and maximum memory for these services when Velocity requires additional memory.

Forward proxy server configuration

You can configure HTTP and HTTPS forward proxy server values using the Update Properties option. The HTTP and HTTPS proxy settings allow administrators to configure Velocity to access online resources through HTTP and HTTPS proxies.

Learn more about forward proxy

Reverse proxy server configuration

If you are using a reverse proxy server, configure the WebContextURL property with the public URL used to access Velocity, including the web context, using the Update Properties option. This ensures that Velocity constructs the correct URLs on resources that are sent to the end user.

Learn more about WebContextURL

To update the system properties, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click System > Properties > Update Properties.

Note:
  • When updating the system properties, the property must be set with a valid JSON object. The Update Properties option overwrites all existing properties.

  • Updating the WebContextURL property triggers a restart of the Velocity services.

  • Changing the minimum or maximum memory settings for the following services automatically restarts the affected service: ArcGIS Velocity Enterprise Control Plane, ArcGIS Velocity Enterprise Feeds, ArcGIS Velocity Enterprise Real-Time Analytics, and ArcGIS Velocity Enterprise Stream Server.

    For the ArcGIS Velocity Enterprise Gateway, changes to the minimum or maximum memory settings do not automatically restart the services. You must manually restart the gateway for the changes to take effect.

    Learn more about restarting services

Manage Velocity logs

Velocity records events and associated errors in logs. Logs are an important tool for monitoring and troubleshooting problems with your organization. Information in the logs helps you identify errors and provides context on how to address problems. The logs also contain a history of events over time.

All events record specific information, such as the log level type, the time at which the event occurred, the source component that logged it, the machine on which the event occurred, and an item ID, if applicable.

Log levels

The following table describes the log levels:

Level Description
Severe Serious problems that require immediate attention. This level only includes severe messages.
Warning Moderate problems that require attention. This level includes severe messages.
Info Common administrative messages, including messages about organization settings being updated. This level includes severe and warning messages.
Fine Common messages from the use of the organization, such as names of operations and requests received. This level includes severe, warning, and information messages.
Verbose Messages that provide additional detail about how the organization fulfills operations and requests. This level includes severe, warning, info, and fine messages. When querying the Admin Log, you can choose the Verbose option from the drop-down menu.
Debug Highly verbose messages designed for developers and support technicians who need a deeper understanding of the organization's state during troubleshooting. Do not use this level in a production environment, as it may degrade performance. If you are not troubleshooting an issue, use the Warning level instead.

Log source

The following table describes the sources from which events are logged:

Source Description
Admin Log Activity related to system administration, such as sign-in attempts, service management operations, and server configuration changes.
Control Plane Platform-level operations, such as service startup, configuration, health checks, and background system maintenance.
Feed Manager Feed lifecycle orchestration, such as feed start and stop actions, task initialization, scheduling, and execution outcomes.
Real-Time Analytic Manager Real-time analytics processes, such as analytic startup, processing behavior, metrics, warnings, and runtime errors.
Stream Manager Lifecycle and runtime management of streams, such as stream creation, deployment, and operational status.

Query logs

To query and view logs, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Logs > Query.

When querying logs, you can filter by log level, source component, a start or end time, and item ID.

Clean logs

Cleaning logs involves removing all logs from the disk for all log sources. This action cannot be undone. To clean logs, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Logs > Clean.

Edit log settings

When working with Velocity logs, you may need to change some of the log settings to effectively capture events. To edit log settings, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Logs > Settings.

When editing log settings, changes to the log location or maximum log file age in days automatically restart all Velocity services.

View site information

The site information resource contains information about the current version and build of Velocity. To view site information, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

    The URL is in the format https://velocity.example.com:7143/arcgis/admin.

  2. Click Home > Info.

For more information about the REST API endpoints, refer to the Velocity REST API documentation.