AgilePoint Analytics Center Management Utility screen

This utility changes the configuration for Analytics Center and the Analytics Center Starter Pack.

Update URL tab

Configures the connection between Analytics Center and AgilePoint Server.

Figure: Update URL tab

Update URL tab

Good to Know

  • The Update URL tab on the Analytics Center Management Utility does not show or retain configuration values. Each time you change configuration values on this screen, you must change all of the configuration values.

    It is recommended that you store your configuration information for Analytics Center in a secure location that is easy to find.

  • The Analytics Center Management Utility will not change any configuration values unless values for all of the configuration fields are complete.

Fields

Field Name Definition

Analytics API URL

Function:
Specifies the runtime URL for Analytics Center in your environment, followed by /api.
Accepted Values:
Analytics Center URL, followed by /api in this format:

[Your AgilePoint NX Portal URL]/AnalyticsCenter/api

Default Value:
None
Example:
https://myagilepointnxdomain.com/AnalyticsCenter/api

The domain name for the production environment changes based on the configuration of your environment.

AgilePoint Server REST URL

Function:
Specifies the REST URL for your AgilePoint Server instance.

For more information, refer to Find your AgilePoint Server Instance REST URL.

Accepted Values:
[Your AgilePoint NX Portal URL]/AgilePointServer
Default Value:
None
Example:
  • https://myagilepointnxdomain.com/AgilePointServer

    The domain name for the production environment changes based on the configuration of your environment.

AgilePoint Portal URL

Function:
Specifies the AgilePoint NX Portal Instance URL.

For more information, refer to Find your Portal Instance URL

Accepted Values:
An AgilePoint NX Portal instance URL.
Default Value:
None
Example:
https://myagilepointnxdomain.com

The domain name for the production environment changes based on the configuration of your environment.

AgilePoint Portal Web.Config

Function:
Specifies the location of the configuration file for AgilePoint NX Portal.
Accepted Values:
The web.config file for AgilePoint NX Portal.

Click the Ellipses button, and browse the file (NX Portal installation folder) C:\Program Files\AgilePoint\AgilePointWebApplication\AgilePointPortal\web.config.

Default Value:
None

Workflow DB Connection String

Function:
Specifies the connection string to connect to the workflow database for AgilePoint NX.

For more information, refer to Find your Workflow Database Connection String.

Accepted Values:
A connection string for the workflow database.
Default Value:
None
Example:
  • application name=AgilePoint Server;server=SQLServerName;database=AP_Workflow_DB;trusted_connection=yes
  • application name=AgilePoint Server;Server= SQLServerName;database=AP_Workflow_DB;User ID=bobsmith;Password=pass1234;

Analytics DB Connection String

Function:
Specifies the connection string to connect to the Analytics database.
Accepted Values:
A connection string for the Analytics database.

The connection string must be in a specific format for this field.

Values identifying the database server:

  • application name=AgilePoint Server

    This value is a literal constant. It must not be changed.

  • server=[the name of the database server for AgilePoint NX]

    Complete this value with your database server name.

  • database=[the name of your Analytics Center database]

    The name of your Analytics Center database. By default, this value is AP_Analytics_DB.

Values identifying the connection credentials:

  • Either enter this value for a trusted connection:
    • trusted_connection=yes
  • Or enter these values to use specific authentication credentials:
    • User ID=[database user name]
    • Password=[database user password]

This results in 2 possible formats for the Analytics Center connection string entered in this field, which are both different from the connection string value in the Analytics Center configuration file:

  • application name=AgilePoint Server; server=[the name of the database server for AgilePoint NX]; database=[the name of your Analytics Center database]; User ID=[database user name]; Password=[database user password];
  • application name=AgilePoint Server; server=[the name of the database server for AgilePoint NX]; database=[the name of your Analytics Center database]; trusted_connection=yes;
Default Value:
None
Example:
  • application name=AgilePoint Server;server=MyDatabaseServer;database=AP_Analytics_DB;trusted_connection=yes;
  • application name=AgilePoint Server;Server=MyDatabaseServer;database= AP_Analytics_DB;User ID=bobsmith;Password=pass1234;

Update

Function:
Saves the changes.

Starter Pack For Analytics Center tab

Configures to install the Analytics Center Starter Pack.

Figure: Starter Pack For Analytics Center tab

Starter Pack For Analytics Center tab

Good to Know

  • When the Analytics Center installation completes, it must synchronize data with the AgilePoint NX databases. This synchronization can take up to one hour. The Analytics Center Starter Pack cannot be installed until this synchronization is complete. It is recommended to wait at least one hour after installing Analytics Center before installing the Starter Pack.
  • This installs sample reports (canned reports) for Analytics Center.
  • Installing the Analytics Center Starter Pack is optional.
  • Some of the reports in the Analytics Center Starter Pack require an app to be associated with a category. If you want to use these reports, it is recommended to associate all apps with a category.

    For more information, refer to Change App Details.

  • After you install the Analytics Center Starter Pack, if you see errors in the logs, refer to Troubleshooting Analytics Center Installation.

Fields

Field Name Definition

Analytics API URL

Function:
Specifies the runtime URL for Analytics Center in your environment, followed by /api.
Accepted Values:
Analytics Center URL, followed by /api in this format:

[Your AgilePoint NX Portal URL]/AnalyticsCenter/api

Default Value:
None
Example:
https://myagilepointnxdomain.com/AnalyticsCenter/api

The domain name for the production environment changes based on the configuration of your environment.

AgilePoint Server REST URL

Function:
Specifies the REST URL for your AgilePoint Server instance.

For more information, refer to Find your AgilePoint Server Instance REST URL.

Accepted Values:
[Your AgilePoint NX Portal URL]/AgilePointServer
Default Value:
None
Example:
  • https://myagilepointnxdomain.com/AgilePointServer

    The domain name for the production environment changes based on the configuration of your environment.

Domain Name

Function:
The authentication domain for the AgilePoint Service Account.
Accepted Values:
An alphanumeric string with no spaces that represents an authentication domain in your environment.

User Name

Function:
Specifies the user name for your AgilePoint Service Account. This account serves as your AgilePoint Service Account, your AgilePoint System Account, and the account that AgilePoint uses to communicate with SharePoint, called the SharePoint impersonator.

This account must be set up before entering the account information here. The AgilePoint installer cannot create this account for you.

For more information, refer to Administrator Types and Permission Groups.

Accepted Values:
A user name for an account with the required privileges detailed in Set Up the AgilePoint Service Account.

Password

Function:
The password for the AgilePoint Service Account.
Accepted Values:
An alphanumeric string that represents a password.

Verify Login

Function:
Verifies whether the specified user credentials are valid.

Starter Pack Location

Function:
Specifies the location of the Analytics Center Starter Pack folder on your AgilePoint Server machine to install the canned reports.
Accepted Values:
An absolute path on your AgilePoint Server machine where the canned reports are stored.
Default Value:
C:\Program Files\AgilePoint\AgilePointServer\Master_Analytics\StarterPack

Overwrite Existing Templates

Function:
Specifies whether to replace all reports in the target location that have the same name as the canned reports you install.

Some AgilePoint NX software releases may have updated versions of canned reports that were included in earlier releases. For example, in AgilePoint NX v8.0 Software Update 1, the look and feel of the canned reports that were released with AgilePoint NX v8.0 was updated. If this option is selected, when you install AgilePoint NX v8.0 Software Update 1, the canned reports from v8.0 are replaced with the updated versions of the reports. If it is deselected, only the new reports from v8.0 Software Update 1 are installed.

Changes to previously released canned reports can differ from one release to the next. Check the Release Notes for your release for information about whether previously release canned reports have changed.

It is also possible, but unlikely, that reports created by Analytics Center users may exist in your AgilePoint NX environment that have the same names as the canned reports.

If you want to make sure that you do not overwrite reports that exist in your environment, and you also want all of the latest canned reports, do this procedure:

  1. In Analytics Center, create clones of all previously released canned reports.
  2. Save the reports with new names.
  3. Select Overwrite Existing Templates.
  4. Install the new canned reports.
Accepted Values:
  • Selected - Replaces all reports that have the same name as the canned reports with the canned reports you install.

    Refer to the Description for this field for more information.

  • Deselected - Installs only canned reports that have names that are different from reports that exist in the target installation folder.

    If canned reports are not installed because they exist with the same name, a message shows in the installation log.

Default Value:
Deselected
Limitations:

This field is available in these releases:

Encrypt Analytics Connection tab

Encrypts the connection strings for the Analytics database.

Figure: Encrypt Analytics Connection tab

Encrypt Analytics Connection tab

Prerequisites

Fields

Field Name Definition

Analytics API URL

Function:
Specifies the runtime URL for Analytics Center in your environment, followed by /api.
Accepted Values:
Analytics Center URL, followed by /api in this format:

[Your AgilePoint NX Portal URL]/AnalyticsCenter/api

Default Value:
None
Example:
https://myagilepointnxdomain.com/AnalyticsCenter/api

The domain name for the production environment changes based on the configuration of your environment.

AgilePoint Server REST URL

Function:
Specifies the REST URL for your AgilePoint Server instance.

For more information, refer to Find your AgilePoint Server Instance REST URL.

Accepted Values:
[Your AgilePoint NX Portal URL]/AgilePointServer
Default Value:
None
Example:
  • https://myagilepointnxdomain.com/AgilePointServer

    The domain name for the production environment changes based on the configuration of your environment.

Domain Name

Function:
The authentication domain for the AgilePoint Service Account.
Accepted Values:
An alphanumeric string with no spaces that represents an authentication domain in your environment.

User Name

Function:
Specifies the user name for your AgilePoint Service Account. This account serves as your AgilePoint Service Account, your AgilePoint System Account, and the account that AgilePoint uses to communicate with SharePoint, called the SharePoint impersonator.

This account must be set up before entering the account information here. The AgilePoint installer cannot create this account for you.

For more information, refer to Administrator Types and Permission Groups.

Accepted Values:
A user name for an account with the required privileges detailed in Set Up the AgilePoint Service Account.

Password

Function:
The password for the AgilePoint Service Account.
Accepted Values:
An alphanumeric string that represents a password.

Verify Login

Function:
Verifies whether the specified user credentials are valid.

Analytics Instance Path

Function:
Specifies the location for the Analytics Center installation folder on your AgilePoint Server machine where the configuration files are stored.
Accepted Values:
An absolute file path on your AgilePoint Server machine.
Default Value:
None.

The sample value is the default location for the Analytics Center installation folder.

Encrypt Analytics Connection

Function:
Encrypts the connection strings configured in the Workflow DB Connection String and the Analytics DB Connection String fields on the Update URL tab.