Skip to main content

ArcGIS Velocity administrator operations

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

  • Backup and restore configured Velocity feeds and real-time analytics

  • Import and configure server certificates

  • Update Velocity security information

  • View and edit JVM memory settings by Velocity component

  • Manage Velocity logs

  • View Velocity site information

Backup and restore configured Velocity feeds and real-time analytics

You can back up and restore feeds and real-time analytics by using snapshot import and export.

Note:

Only portal-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 a portal user. The PSA cannot own items in ArcGIS Enterprise.

Export a snapshot

Velocity can back up and restore all feed and real-time analytic items in a site using an item configuration file. By default, the item configuration file is created automatically every 24 hours and can be found in the configuration backup location specified during installation.

To manually 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.

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.

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. Credentials and API keys are not preserved as part of an item configuration file. Items may require some level of reconfiguration.

Reset a site

You can reset a site to delete all existing feed and real-time analytic items owned by users. To reset a site, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click Backup Restore Info.

  3. Click Reset Site.

Import and configure server certificates

You can import an existing server, root, or intermediate certificate.

Import an existing CA-signed certificate

Note:

To import the certificate into your portal, 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://<your_velocity_FQDN>: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://<your_velocity_FQDN>: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:

    This step automatically restarts your Velocity site.

Note:

Importing a root certificate automatically restarts your Velocity site.

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 operation 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 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

Complete the following steps to reset the password for the primary site administrator:

  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\password-reset folder.

    For example,

     cd "C:\Program Files\ArcGIS\Velocity\password-reset"

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

    resetPassword -l

  4. To reset the password, run the resetPassword.bat utility.

    resetPassword my_new_password

  1. Sign in to Velocity.

  2. Open a new Bourne shell.

  3. Browse to the folder <installation location>/arcgis/Velocity/password-reset.

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

    sudo resetPassword.sh -l

  5. To reset the password, run the resetPassword.sh utility.

     sudo resetPassword.sh my_new_password
 resetPassword my_new_password

View and edit JVM memory settings by Velocity component

You can view license information and edit memory properties.

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 version of Velocity and license expiration date. To view system information, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click System > Licenses.

View and update properties

The system properties resource returns information about the memory allocation for each Velocity service. By default, each service has a minimum of 500 MB and a maximum of 2048 MB of memory. To view the system properties memory allocation, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click System > Properties.

You can change the minimum and maximum memory values allocated to each of the Velocity services using the Update Properties operation. Consider increasing the minimum and maximum memory for these services when Velocity exhibits a need for additional memory. To update the memory allocation of each Velocity service, complete the following steps:

  1. Sign in to the Velocity Administrator directory.

  2. Click System > Properties > Update Properties.

Note:

Changing the minimum or maximum memory settings for the following services automatically restarts the affected service.

The following services restart automatically: 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 dropdown 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 events logged from one of the following sources:

Source Description
Admin Log Activity related to system administration, such as login 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, start time 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: <your velocity FQDN>:7143/arcgis/admin

  2. Click Home > Info.