Install AgilePoint Data Services

Prerequisites

• AgilePoint NX OnPremises or AgilePoint NX PrivateCloud.
• Your system meets the minimum system requirements for this component.

  For more information, refer to AgilePoint Data Services Requirements.

• You have completed all of the pre-installation instructions for this component.

  For more information, refer to Set Up Your Environment for AgilePoint NX.

• AgilePoint Server installed on the AgilePoint Server machine.

Good to Know

• The installer UI is optimized for system resolutions 1366x768 or 1920x1080 with 100% scaling. If you use other screen resolutions, the installer UI may not display correctly, which can cause installation errors.

How to Start

1. On the AgilePoint Server machine, open the folder C:\AgilePoint\9.0-Full\AgilePoint\DataService.
2. Right-click the Setup.exe file, and click Run as administrator.

   
   
   

3. If a supported version of .NET Runtime is not installed, this screen shows.
   1. Click Close.
   2. Install the supported version of .NET Runtime.
   3. Right-click the Setup.exe file, and click Run as administrator.

   
   
   

4. This screen shows if an AgilePoint NX installation is running on this machine.
   • To resume the installation, click Continue.
   • To restart the installation, click Start.

   
   
   

Procedure

1. On the Welcome to AgilePoint Data Services Installation screen, click Next.

   
   
   

2. On the Prerequisites screen:
   • If there are any errors, do this procedure:
     1. Click Cancel.
     2. Correct the errors.
     3. Right-click the AgilePoint NX Setup.exe file, and click Run as administrator.

        The AgilePoint Data Services installation starts.

     
     
     

     Issue	Resolution
     Supported operating system is installed	Install a supported operating system on this machine. For more information, refer to System Requirements for AgilePoint Server.
     Current user has local administrator privileges	Sign in to this machine as a user with administrator privileges.
     User Account Control (UAC) is turned off	Turn user access control (UAC) off. For more information, refer to Turn Off User Account Control (UAC).
     Supported version of .NET Framework is installed	Install a supported version of .NET Framework on this machine. For more information, refer to System Requirements for AgilePoint Server.

   • If there are no errors, click Next.

     
     
     

3. On the AgilePoint Data Services Installation screen, in the Install Location field, complete this field.

   
   
   

   Field Name	Definition
   Install Location	Description: The folder where you want to install the AgilePoint component.

4. Click Next.
5. On the AgilePoint Data Services Installation screen, click Install.

   
   
   

   The AgilePoint Data Services installation starts.

   
   
   

6. After the installation completes, click Next.

   
   
   

7. On the AgilePoint Data Services Configuration screen, enter the following information:

   
   
   

   Field Name	Definition
   Domain	Description: The authentication domain for the AgilePoint Service Account. Allowed Values: One line of text (a string) with no spaces that represents an authentication domain in your environment. Default Value: None
   User Name	Description: 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. Allowed Values: One line of text (a string) that represents a user name for an account with the required privileges detailed in Set Up the AgilePoint Service Account. Default Value: None Limitations: During installation, you must use the same AgilePoint Service account credentials for all AgilePoint systems. However, for security purposes, AgilePoint recommends you change separate these account credentials after installation. For more information, refer to: Administrator Types How Do I Change the Credentials for AgilePoint Administrator Accounts?
   Password	Description: The password for the AgilePoint Service Account. Allowed Values: An alphanumeric string that represents a password. Default Value: None

8. To make sure the user credentials are valid, click Test.

   
   
   

   If the user credentials are valid, this validation message shows.

   
   
   

9. Click Next.
10. On the Data Services Configuration screen, complete these fields:

    
    
    

    Field Name	Definition
    AgilePoint Service URL	Specifies the AgilePoint Service URL for your AgilePoint BPMS environment. For more information, refer to Find Your AgilePoint Service URL in AgilePoint NX.
    Time Interval	Description: Specifies the timer interval, in minutes, used by Data Services to check for new entries in the database. Allowed Values: An integer. Represents A number of minutes Default Value: 0
    Enable Data Population	Description: Turns on the data population feature, which lets application data to be written to the database. Allowed Values: On - Turns on the Data Population feature. Off - Turns off the Data Population feature. Default Value: On
    Enable Data Tracking	Description: Turns on the data tracking feature, which lets application data to be tracked across processes and components. Allowed Values: On - Turns on the Data Tracking feature. Off - Turns off the Data Tracking feature. Default Value: On

11. Click Next.
12. On the AgilePoint Data Services Configuration screen, enter the following information for your Data Services database.

    
    
    

    Field Name	Definition
    Database Type	Description: Specifies the database technology to store your data. Allowed Values: Microsoft SQL Server. Default Value: Microsoft SQL Server
    Windows Authentication	Description: Specifies whether the database connection uses Windows authentication. Allowed Values: On - The database connection uses Windows Authentication, and the machine's authenticated user connects to the database server. If this option is selected, the User Name and Password fields are not required. Off - The database connection does not use Windows authentication. If this option is selected, you must specify the user name and password for the authentication account AgilePoint Server uses to connect to the database. Default Value: On
    User Name	Description: The user name for the account AgilePoint Server uses to connect to the database. To Open this Field: Turn off Windows Authentication. Allowed Values: An alphanumeric string that contains a user name for the database. Default Value: None
    Password	Description: The password for the authentication account. To Open this Field: Turn off Windows Authentication. Allowed Values: An alphanumeric string that represents a password. Default Value: None
    Database Server	Description: The database used for data tracking. Allowed Values: An alphanumeric string with no spaces that represents a database server name. Default Value: None Example: mydatabase mydatabase/sharepoint

13. Once you enter the Database Server, click Connect to authenticate the database user account and populate the names of the databases on your database server.

    
    
    

14. In the Database Location section, enter the following information for your AgilePoint database.

    
    
    

    Field Name	Definition
    Create New Database / Use Existing Database	Description: Specifies whether to create a database for AgilePoint Data Services. Allowed Values: Create New Database - Specifies the name of a database to create for AgilePoint Data Services. Use Existing Database - Specifies the name of an existing database you want to use for AgilePoint Data Services. Default Value: Create New Database
    New Database Name	Description: Specifies the name of a new database you want to create as your AgilePoint Data Services database. This option is only available if your database is installed on the same machine where you are installing this component. To Open this Field: Select Create New Database. Allowed Values: One line of text (a string). Not Accepted: Spaces Default Value: AP_Data_Svcs_DB
    Database	Description: Specifies the name of an existing database you want to use for AgilePoint Data Services. To Open this Field: Select Use Existing Database. Click Connect to populate the list. Allowed Values: A database name from the list. Default Value: None

15. Click Next.
16. On the Deployment screen, click Deploy.

    
    
    

    The AgilePoint Data Services installation runs. If any error messages show on the screen, you can use the log to troubleshoot the errors. If an error exists, contact AgilePoint Customer Support.

    
    
    

17. After the installation completes, click Next.

    
    
    

18. On the Finish screen, click Finish.

    
    
    

19. Restart the machine.

    This is optional, but recommended. Rarely AgilePoint users have reported an issue with shortcuts not displaying if the machine is not restarted. There are no other known issues if you do not restart the machine. Windows sometimes prompts to restart, and sometimes not. This is determined by the operating system.