Install Canned Reports for Analytics Center

To install the canned reports for Analytics Center, do the procedure in this topic.

Prerequisites

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 Edit App screen.

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

How to Start

  1. On your AgilePoint Server machine, right-click the file (Analytics Center Management Utility installation folder) C:\Program Files\AgilePoint\AgilePointServer\Master_Analytics\bin\AgilePoint.Analytics.Management.exe, and click Run as Administrator.

    AgilePoint Analytics Management Application Path
  2. On the AgilePoint Analytics Center Management Utility, click the Starter Pack For Analytics Center tab.

    Click Starter Pack For Analytics Center

Procedure

  1. On the Starter Pack For Analytics Center tab, complete these fields.

    Complete Fields
    Field NameDefinition

    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.
  2. To make sure the user credentials are valid, click Verify Login.

    Click Verify Login
  3. Complete this field as necessary.

    Click Overwrite Existing Templates
    Field NameDefinition

    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:

  4. Click Install Templates.

    Click Install Template