AgilePoint Server Manager

The AgilePoint Server Manager is a sever administration component you can use to to start, stop, add, delete, configure, and manage AgilePoint Server instances.

Background and Setup

Examples

Prerequisites

AgilePoint NX OnPremises or AgilePoint NX PrivateCloud.
Sign in to Windows using a user login that belongs to the local system's Administrators group.

How to Start

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.

General tab

Specifies the basic configuration to identify the AgilePoint Server instance.

Field Name	Definition
Service Name	Description: Specifies the name you want to use to identify the Windows service associated with the AgilePoint Server instance. Allowed Values: One line of text (a string). Default Value: None
Display Name	Description: Specifies the name you want to display to users to identify the AgilePoint Server instance. Allowed Values: One line of text (a string). Default Value: None
Location	Description: Specifies the path to the AgilePoint Server instance. Allowed Values: A valid absolute file path. Default Value: None
User Name (Domain\User Name)	Description: Specifies the user name of the AgilePoint Service Account. Allowed Values: A registered Windows user on the AgilePoint Server machine that has the correct permissions for the AgilePoint Service Account. For more information, refer to Administrator Types. Default Value: The user name that is specified for the AgilePoint Service Account during AgilePoint Server installation. Limitations: When you install AgilePoint Server, the AgilePoint Service Account and AgilePoint System Account are configured to use the same credentials. However, after installation, it is recommended to separate these accounts for security purposes. Changing the credentials for the AgilePoint Windows Service does not have an effect on the credentials for the AgilePoint System Account. To simplify maintenance and keep the AgilePoint Service Account credentials in sync, AgilePoint recommends you use the same Service Account credentials for the AgilePoint Windows Service and the Windows service for AgilePoint Data Services. However, this is not a technical requirement. If you change the Impersonation section credentails, it also changes the AgilePoint Service Account credentials for the AgilePoint Windows Service. Example: MYDOMAIN\APServiceUser
Password	Description: The password for the AgilePoint Service Account. Allowed Values: An alphanumeric string that represents a password. Default Value: The password that is specified for the AgilePoint Service Account during AgilePoint Server installation. Limitations: The password for this user must match the password for the Windows user account that is associated with the AgilePoint Service Account. If you change this password, you must change it in Windows, and then change the password here.
Add New Service Instance	Creates a new AgilePoint Server instance.
Start Service	Function: Starts the Windows service for the selected AgilePoint Server instance. Example: (Example) Start an AgilePoint Server Instance
Stop Service	Function: Stops the Windows service for the selected AgilePoint Server instance. Example: (Example) Stop an AgilePoint Server Instance
Delete Service	Function: Deletes the selected AgilePoint Server instance.
Refresh	Function: Refreshes the selected AgilePoint Server instance.
Open Server Configuration	Function: AgilePoint Server Configuration Utility Function of this Screen: This utility is a user-friendly editor for the main AgilePoint Server configuration file, netflow.cfg.
Update	Function: Saves changes to an AgilePoint Windows Service instance configuration.
SVC Utility	Function: Runs the Windows Service Client Utility Tool .
Activity Removal Utility	Opens this Screen: Activity Removal Utility Function of this Screen: Deletes a custom process activity from AgilePoint NX.
Activity Deployment Utility	Opens this Screen: AgilePoint Activity Deployment Utility Function of this Screen: Deploys a custom process activity created with AgilePoint NX Developer to AgilePoint Server

Networking tab

Configures the network connection for AgilePoint Server instance.

Field Name	Definition
WSHttp Port	Description: A free, unique port AgilePoint Server instance can use for WSHttp binding. This field is required. Allowed 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	Description: A free, unique port AgilePoint Server instance can use for TCP binding. This field is required. Allowed 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	Description: A free, unique port AgilePoint Server instance can use for BasicHttp binding. This field is required. Allowed 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	Description: A free, unique port AgilePoint Server instance can use for Web HTTP binding. This field is required. Allowed 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
Check Port Availability	Function: Tests the specified ports to make sure they are free.
Service Factory Binding	Opens this Screen: Global Extended Module screen. Function of this Screen: Specifies the authentication scheme for your REST endpoint for the AgilePoint Server instance.
Domain	Description: The common name (CN) or domain name or fully qualified domain name associated with your SSL certificate. To Open this Field: Click the SSL Settings tab. Allowed Values: An appSettings key in the following format: One line of text (a string) representing your common name or domain name. Default Value: None Example: mydomain.com
Use Secure Connection (SSL)	Description: The common name (CN) or domain name or fully qualified domain name associated with your SSL certificate. For more information, refer to Configure AgilePoint Server to use SSL. To Open this Field: Click the SSL Settings tab. Allowed Values: An appSettings key in the following format: Selected - SSL encryption is enabled. Deselected - SSL encryption is disabled. Default Value: Deselected
Add New Service Instance	Creates a new AgilePoint Server instance.
Start Service	Function: Starts the Windows service for the selected AgilePoint Server instance. Example: (Example) Start an AgilePoint Server Instance
Stop Service	Function: Stops the Windows service for the selected AgilePoint Server instance. Example: (Example) Stop an AgilePoint Server Instance
Delete Service	Function: Deletes the selected AgilePoint Server instance.
Refresh	Function: Refreshes the selected AgilePoint Server instance.
Open Server Configuration	Function: AgilePoint Server Configuration Utility Function of this Screen: This utility is a user-friendly editor for the main AgilePoint Server configuration file, netflow.cfg.
Update	Function: Saves changes to an AgilePoint Windows Service instance configuration.
SVC Utility	Function: Runs the Windows Service Client Utility Tool .
Activity Removal Utility	Opens this Screen: Activity Removal Utility Function of this Screen: Deletes a custom process activity from AgilePoint NX.
Activity Deployment Utility	Opens this Screen: AgilePoint Activity Deployment Utility Function of this Screen: Deploys a custom process activity created with AgilePoint NX Developer to AgilePoint Server

Global Extended Module screen

Specifies the authentication scheme for your REST endpoint for the AgilePoint Server instance.

Fields

Field Name	Definition
Assembly	Description: Specifies 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. Allowed Values: A valid assembly name. Default Value: None. The default .dll is (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\bin\AgilePoint.REST.ServiceBindingFactory.dll
Class	Description: Specifies the implementation of the IWFServiceBindingFactory interface. Allowed Values: RESTNoAuthenticationFactory RESTADAuthenticationFactoryNoCaching RESTADAuthenticationFactory RESTRemoteADAuthenticationFactoryNoCaching RESTRemoteADAuthenticationFactory RESTLocalAuthenticationFactoryNoCache RESTLocalAuthenticationFactory RESTNoAuthenticationFactory RESTMultiADAuthenticationFactoryNoCaching RESTMultiADAuthenticationFactory Default Value: RESTNoAuthenticationFactory

Field Name

Definition

Assembly

Description:: Specifies 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.
Allowed Values:: A valid assembly name.
Default Value:: None.
The default .dll is (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\bin\AgilePoint.REST.ServiceBindingFactory.dll

Class

Description:

Specifies the implementation of the IWFServiceBindingFactory interface.

Allowed Values:

RESTNoAuthenticationFactory
RESTADAuthenticationFactoryNoCaching
RESTADAuthenticationFactory
RESTRemoteADAuthenticationFactoryNoCaching
RESTRemoteADAuthenticationFactory
RESTLocalAuthenticationFactoryNoCache
RESTLocalAuthenticationFactory
RESTNoAuthenticationFactory
RESTMultiADAuthenticationFactoryNoCaching
RESTMultiADAuthenticationFactory

Default Value:

RESTNoAuthenticationFactory

Portal tab

Configures the IIS web sites for AgilePoint NX Portal, and Analytics Center for the AgilePoint Server instance.

Field Name	Definition
Portal Site	Description: Specifies the web site from the list you created for AgilePoint during pre-installation. Allowed Values: A valid web site name. Default Value: AgilePointWebsite
Portal - Application Pool	Description: Specifies the IIS application pool for the AgilePoint NX Portal web application you want to run. Allowed Values: An application pool from the list. Default Value: DefaultAppPool
Portal Master Database	Description: Specifies the portal master database. Allowed Values: The database name you select in the Portal Master Database Name list on the Connection String Builder screen. Default Value: None
Retrieve Database	Opens this Screen: Connection String Builder screen Function of this Screen: Specifies the connection to the AgilePoint portal master database to store the data for apps for the AgilePoint Server instance..
Portal Tenant Database	Description: Specifies the name of the portal tenant database. Allowed Values: The database name you select in the Portal Tenant Database Name list on the Connection String Builder screen. Default Value: None
Report Site	Description: Specifies the web site from the list you created for Analytics Center during pre-installation. Allowed Values: A web site name form the list. Default Value: None
Analytics Center - Application Pool	Description: Specifies the IIS application pool for the Analytics Center web application to run. Allowed Values: An application pool from the list. Default Value: DefaultAppPool
Analytics Database	Description: Specifies the database for Analytics Center. Allowed Values: The database name you select in the Analytics Database Name list on the Connection String Builder screen. To open the Connection String Builder screen, in this field, click Retrieve Database . Default Value: None
Add New Service Instance	Creates a new AgilePoint Server instance.
Start Service	Function: Starts the Windows service for the selected AgilePoint Server instance. Example: (Example) Start an AgilePoint Server Instance
Stop Service	Function: Stops the Windows service for the selected AgilePoint Server instance. Example: (Example) Stop an AgilePoint Server Instance
Delete Service	Function: Deletes the selected AgilePoint Server instance.
Refresh	Function: Refreshes the selected AgilePoint Server instance.
Open Server Configuration	Function: AgilePoint Server Configuration Utility Function of this Screen: This utility is a user-friendly editor for the main AgilePoint Server configuration file, netflow.cfg.
Update	Function: Saves changes to an AgilePoint Windows Service instance configuration.
SVC Utility	Function: Runs the Windows Service Client Utility Tool .
Activity Removal Utility	Opens this Screen: Activity Removal Utility Function of this Screen: Deletes a custom process activity from AgilePoint NX.
Activity Deployment Utility	Opens this Screen: AgilePoint Activity Deployment Utility Function of this Screen: Deploys a custom process activity created with AgilePoint NX Developer to AgilePoint Server

Connection String Builder screen

Specifies the connection to the AgilePoint portal master database to store the data for apps for the AgilePoint Server instance.

Field Name	Definition
Database Type	Description: Specifies the database technology to store your data. Allowed Values: MSSQL Default Value: MSSQL
User Name	Description: The user name for the account AgilePoint Server uses to connect to the database. 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
Integrated Security	Description: Specifies whether the Windows account credentials for the runtime app user are used for authentication. Allowed Values: Selected - The Windows account credentials for the runtime app user are used to access the database. Deselected - The user name and password fields are enabled for database authentication, and you must enter the database credentials. Default Value: Selected
Database Server	Description: Specifies the server name and domain for the AgilePoint database. Allowed Values: An alphanumeric string with no spaces that represents a database server name. Default Value: localhost Example: mydatabase mydatabase/WorkflowFolder
Portal Master Database	Description: Specifies the portal master database. Allowed Values: A portal master database name from the list. When you click Retrieve Database , this field completes. Default Value: None
Portal Tenant Database	Description: Specifies the portal tenant database. Allowed Values: A portal tenant database name from the list. Default Value: None
Connection Pool Size	Description: Specifies the maximum number of simultaneous database connections for the workflow database. Allowed Values: An integer. It is recommended to use a connection pool size that is >= 100, or 2 * the thread pool size. Default Value: 100
Encrypt Connection String	Description: Specifies whether to encrypt the stored database connection string. Allowed Values: On - Saves the database connection string in encrypted format. Off - Saves the database connection string in plain text. Default Value: Off

Configuration tab

Configures general settings for the AgilePoint Server instance.

Field Name	Definition
Log File Max Size	Description: 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. Allowed Values: An integer. Default Value: 50
Log File Location	Description: Specifies the location for your AgilePoint Server log file. Allowed 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	Description: Specifies whether to delete the temp files from the AgilePoint Server machine when AgilePoint Server starts. Allowed 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	Description: Specifies whether to use JSON Web Token (JWT) for Active Directory authentication as an alternative to the basic authentication. Allowed Values: On - Uses JWT authentication for Active Directory. Off - Uses basic authentication for Active Directory. Default Value: Off
Add New Service Instance	Creates a new AgilePoint Server instance.
Start Service	Function: Starts the Windows service for the selected AgilePoint Server instance. Example: (Example) Start an AgilePoint Server Instance
Stop Service	Function: Stops the Windows service for the selected AgilePoint Server instance. Example: (Example) Stop an AgilePoint Server Instance
Delete Service	Function: Deletes the selected AgilePoint Server instance.
Refresh	Function: Refreshes the selected AgilePoint Server instance.
Open Server Configuration	Function: AgilePoint Server Configuration Utility Function of this Screen: This utility is a user-friendly editor for the main AgilePoint Server configuration file, netflow.cfg.
Update	Function: Saves changes to an AgilePoint Windows Service instance configuration.
SVC Utility	Function: Runs the Windows Service Client Utility Tool .
Activity Removal Utility	Opens this Screen: Activity Removal Utility Function of this Screen: Deletes a custom process activity from AgilePoint NX.
Activity Deployment Utility	Opens this Screen: AgilePoint Activity Deployment Utility Function of this Screen: Deploys a custom process activity created with AgilePoint NX Developer to AgilePoint Server