Create an AgilePoint Server instance

Prerequisites

• AgilePoint NX OnPremises or AgilePoint NX Private Cloud.
• An AgilePoint NX license that supports more than one AgilePoint Server instance.

Good to Know

• You must complete the procedures in this topic in the order shown.

To set up folders for a new AgilePoint Server instance, do the procedure in this topic.

Procedure

1. On the AgilePoint Server machine, create these folders:
   • (Folder for an additional AgilePoint Server instance) C:\Program Files\AgilePoint\[YourAgilePointServerInstanceName] - This folder contains all the files and folders related to AgilePoint Sever instance. You can customize the name.
   • (New AgilePoint web application folder) C:\Program Files\AgilePoint\[YourAgilePointInstanceWebsiteName] - This folder contains the web sites for the AgilePoint NX AgilePoint Server and Analytics Center. You can customize the name.
     • YourPortalWebsiteName - This folder contains all the files and folders related to the Portal.
     • YourAnalyticsCenterWebsiteName - You can create this folder if you have a license for Analytics Center. This folder contains all the files and folders related to the Analytics Center.
     • YourReportCenterWebsiteName - You can create this folder if you have a license for Report Center. This folder contains all the files and folders related to the Report Center.
       Note: The Report Center component (sometimes referred to as AgileReports) can only be used by customers who purchased this component before April 1, 2020. This version is no longer available for purchase, including by current and previous purchasers of AgilePoint NX or the Report Center component. In AgilePoint NX v8.0 and higher, Report Center has been replaced with the Analytics Center component.

AgilePoint requires one or more databases, depending upon the AgilePoint components you install. You must create these databases on your database server.

To set up databases for a new AgilePoint Server instance, do the procedure in this topic.

How to Start

1. Make sure your SQL Server is up and running.
2. Open the SQL Server Management Studio:
   1. On your AgilePoint Server machine, click Start, and type Run.
   2. Click Run.
   3. On the Run screen, in the Open field, enter SSMS.exe.
   4. Click OK.

Good to Know

• It is only necessary to create the database. The database tables are created automatically during installation.

Procedure

Repeat the following instructions to create the databases listed in the AgilePoint Databases section.

1. In SQL Server Management Studio, Right-click on Databases and select New Database.
2. On the New Database screen, enter a database name.

AgilePoint Databases

To create a new web site in IIS for an AgilePoint Server instance, do the procedure in this topic.

How to Start

1. On the AgilePoint Server machine, open IIS Manager.

Procedure

1. In IIS Manager, In the Connections pane, right-click the Application Pools.
2. Click Add Application Pool.
3. On the Add Application Pool screen, in the Name field, enter the name of the application pool.
4. On the Actions pane, click Advanced Settings.
5. On the Generate Process Model Event Log Entry, in the Identity field, click the Ellipses (...) button.
6. On the Application Pool Identity screen, in the Custom account, click Set.
7. On the Set Credentials screen, in the User name field, enter the user name for the AgilePoint Service Account.

   Format:

   domain\username

   Example:

   MYDOMAIN\APServiceUser

8. In the Password field, enter the password for the AgilePoint Service Account.
9. In the Conform password field, reenter the password for the authentication account.
10. In the IIS Manager, in the Connections pane, right-click the Sites.
11. Click Add Website....
12. On the Add Website screen, in the Site name field, enter the name of the web site.
13. In the Application pool, click Select.
14. Browse (New AgilePoint web application folder) C:\Program Files\AgilePoint\[YourAgilePointInstanceWebsiteName]\YourPortalWebsiteName.
15. Click Connect As.
16. On the Connect As screen, in the Specific user, click Set.
17. On the Set Credentials screen, in the User name field, enter the user name for the AgilePoint Service Account.

    Format:

    domain\username

    Example:

    MYDOMAIN\APServiceUser

18. In the Password field, enter the password for the AgilePoint Service Account.
19. In the Conform password field, reenter the password for the authentication account.
20. In the Port field, specify a unique port number.

    The port number must be higher than 10000.

To create a new AgilePoint Server instance, do the procedure in this topic.

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.

   
   
   

2. On the AgilePoint Server Manager screen, click Add New Service Instance .

   
   
   

Procedure

1. In the Service Name field, enter the name to use to identify the Windows service associated with the AgilePoint Server instance.
2. In the Display Name field, enter the name to display to show in AgilePoint Server Manager.
3. In the Location field, click Browse.
4. Select the (Folder for an additional AgilePoint Server instance) C:\Program Files\AgilePoint\[YourAgilePointServerInstanceName].

   This folder contains all the files and folders related to AgilePoint Sever instance.

5. In the User Name field, enter the user name for the AgilePoint Service Account.
6. In the Password field, enter the password for the AgilePoint Service Account.
7. Click the Networking tab.
8. On the Networking tab, complete these fields.

   Field Name	Definition
   WSHttp Port	Function: A free, unique port AgilePoint Server instance can use for WSHttp binding. This field is required. Accepted Values: A port number on your machine for WSHttp binding. The port number must be unique (not used for any other purpose) and higher than 10000. Default Value: 13487
   TCP Port	Function: A free, unique port AgilePoint Server instance can use for TCP binding. This field is required. Accepted Values: A port number on your machine for TCP binding. The port number must be unique (not used for any other purpose) and higher than 10000. Default Value: 13488
   BasicHttp Port	Function: A free, unique port AgilePoint Server instance can use for BasicHttp binding. This field is required. Accepted Values: A port number on your machine for BasicHttp binding. The port number must be unique (not used for any other purpose) and higher than 10000. Default Value: 13489
   Web HTTP Port	Function: A free, unique port AgilePoint Server instance can use for Web HTTP binding. This field is required. Accepted Values: A port number on your machine for Web HTTP binding. The port number must be unique (not used for any other purpose) and higher than 10000. Default Value: 13490

9. Click Check Availability of Ports to make sure the ports are free.
10. In the Service Factory Binding field, click Browse.

    When you click the Browse button, the Global Extended Module screen opens.

11. On the Global Extended Module screen, in the Assembly field, click the Ellipses button.
12. Select the .dll file that provides server side authentication for REST services.

    In some circumstances you must create a custom authentication module.

    For more information, refer to Server Side Authentication Using WCF Endpoints for AgilePoint Server.

    The default .dll is (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\bin\AgilePoint.REST.ServiceBindingFactory.dll

13. Click OK.
14. Click the Portal tab.
15. On the Portal tab, in the Portal Site list, select the name of the web site you created for AgilePoint NX Portal.

    For more information, refer to Create a New Website in IIS for an AgilePoint Server Instance.

16. In the Application Pool list, select the name of the application pool you created.

    For more information, refer to Create a New Website in IIS for an AgilePoint Server Instance.

17. In the Portal Master Database field, select the name of your Portal database.

    For more information, refer to Set up Databases for a New AgilePoint Server Instance.

18. In the Portal Tenant Database field, select the name of your tenant database.

    For more information, refer to Set up Databases for a New AgilePoint Server Instance.

19. (Optional) If you have a license for Analytics Center, do this procedure.
    1. In the Analytics Website field, select the website you created for Analytics Center.

       For more information, refer to Create a New Website in IIS for an AgilePoint Server Instance.

    2. In the Application Pool list, select the IIS application pool form the list for the Analytics Center web application to run.
    3. In the Analytics Database field, select the name of the database that you created for Analytics Center.

       For more information, refer to Set up Databases for a New AgilePoint Server Instance.

    4. (Optional) Click the Configuration tab.
    5. (Optional) On the Configuration tab, complete these fields.

       Field Name	Definition
       Log File Max Size	Function: Specifies the maximum file size for your log file in MB. To manage storage space for log files, the AgilePoint Server creates a new log file when the current log file reaches the specified maximum file size. Accepted Values: An integer. Default Value: 50
       Log File Location	Function: Specifies the location for your AgilePoint Server log file. Accepted Values: An absolute path to your log file folder. Default Value: (AgilePoint Server instance installation folder) C:\Program Files\AgilePoint\AgilePointServerInstance
       Cleanup Temp Files on Server Starts	Function: Specifies whether to delete the temp files from the AgilePoint Server machine when AgilePoint Server starts. Accepted Values: On - Deletes the temporary files to reduce disk storage space, including cache files. Off - AgilePoint Server does not automatically delete temporary files. Default Value: Off
       Enable JWT Authentication	Function: Specifies whether to use JSON Web Token (JWT) for Active Directory authentication as an alternative to the basic authentication. Accepted Values: On - Uses JWT authentication for Active Directory. Off - Uses basic authentication for Active Directory. Default Value: Off

20. Click Update.