Analytics AgileConnector

This AgilePoint Server extension (AgileConnector) lets you connect to Analytics Center component for AgilePoint NX.

Background and Setup

To configure an AgileConnector, ​ do the procedure in this topic.

Prerequisites

How to Start

  1. On the AgilePoint Server machine, in Windows Explorer, right-click the file (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\WCFConfigurationUtility.exe, and click Run as Administrator.

    Configuration Utility Run As Administrator Screen
  2. On the AgilePoint Server Manager screen, in the left pane, select your AgilePoint Server instance.

    Select AgilePoint Server Intance
  3. Click Open Server Configuration Open Server Configuration icon.

    Click Open Server Configuration
  4. On the AgilePoint Server Configuration screen, click the Integrations tab.

    Click Integrations tab

Enable the Analytics AgileConnector

To enable the Analytics Center AgileConnector, ​ do the procedure in this topic.

How to Start

  1. On the AgilePoint Server Configuration screen, in the Integrations tab, click Add.

    Click Add

Procedure

  1. In the Impersonator field, enter the AgilePoint user name that is used to connect to your e-mail server.

    By default, this is the AgilePoint Service Account.


    Enter Impersonator Field
  2. Go to the assembly (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\Master\bin\AgilePoint.AgileConnector.Analytics.dll.

    Enter Impersonator Field
  3. Click OK.

AgilePoint Analytics Settings screen

Configures the connections from AgilePoint NX to the Analytics Center AgileConnector.

Figure: AgilePoint Analytics Settings screen

AgilePoint Analytics Settings screen

Prerequisites

How to Start

  1. On the Integrations tab, select Analytics.

    Click Analytics
  2. Click Configure Configure icon.

    Click Configure

Fields

Field Name Definition

AgilePoint 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.

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;

Connect

Function:
Verifies whether the specified connection string is correct.

Reset Analytics Sync Operation On Next AgilePoint Service Start

Function:
Specifies whether the Analytics AgileConnector synchronizes all of the data from the AgilePoint NX databases with Analytics Center after the next time you restart AgilePoint Server.
Accepted Values:
  • Deselected - The AgileConnector synchronizes only new or changed data from the AgilePoint NX workflow and Data Entities databases.

    This is the default mode of operation. It is recommended for typical system use.

  • Selected - The next time AgilePoint Server restarts, all of the data from AgilePoint NX workflow database and Data Entities database with the Analytics Center database. After synchronization, this field gets deselected by default.

    This operation overwrites all of the data in the Analytics Center database, and replaces it with the data in the AgilePoint NX workflow and Data Entities databases, whether the data is different or not.

    This may be useful if you suspect that the data is not synchronized between AgilePoint NX and Analytics Center, or if there is an unusual circumstance, such as if you perform a manual upgrade on the Analytics Center component. However, this synchronization can take several hours to complete.

Default Value:
Deselected