AgilePoint Server Configuration in netflow.cfg

To configure AgilePoint Server, do the procedure in this topic.

AgilePoint Server is configured in the <server> node of the AgilePoint Server configuration file netflow.cfg.

Prerequisites

How to Start

  1. On the AgilePoint Server machine, in a text editor, open the file netflow.cfg.

XML Node Format

<server
    eventCap="[integer]"
    workingCap="[integer]"
    maxLoop="[integer]"
    swapoutTime="[integer]"
    archiveTime="[integer]"
    assemblyPath="[assembly path]"
    ServiceName="[AgilePoint Server instance name]"
    trustedAuthorization="[True or False]"
    Locale="[default locale for the newly registered user]"
    activeHostingType="[implementation architecture type]"
    initCPUUsage="[integer]"
    ualExpirationPeriod="[Time in minutes]"
    initiatorCap="[integer]"
    enableUnicodeSupport="[true or false]"
    disableLicenseCheck="[true or false]"
    sendLicenseExpiryNotificationBeforeDays="[integer]"
    MaximumOfManualWorkitems="[integer]"
    checkNetworkAvailability="[true or false]"
    GCInterval="[integer]"

/>

XML Node Example

<server
    eventCap="10"
    workingCap="10"
    maxLoop="50"
    swapoutTime="5"
    archiveTime="180"
    assemblyPath=""
    ServiceName="AgilePointWindowsService"
    trustedAuthorization="True"
    Locale="en-US"
    activeHostingType="OnPremises"
    initCPUUsage="50%"
    ualExpirationPeriod="5"
    initiatorCap="0"
    enableUnicodeSupport="false"
    disableLicenseCheck="false"
    sendLicenseExpiryNotificationBeforeDays="30"
    MaximumOfManualWorkitems="50"
    checkNetworkAvailability="true"
    GCInterval="2"
/>

Attributes

Field Name Definition

eventCap
Function:
Specifies the maximum number of threads to process human task activities.

For more information, refer to Thread Pool Sizing Guidelines.

Accepted Values:
An integer.
Default Value:
None
Example:
<server eventCap="10" ... />

workingCap
Function:
Specifies the maximum number of threads to process system activities.

For more information, refer to Thread Pool Sizing Guidelines.

Accepted Values:
An integer.
Default Value:
None
Example:
<server workingCap="10" ... />

maxLoop
Function:
Specifies the maximum number of sessions for an activity.

Once a process instance runs the activity a number of times that exceeds the maximum, the process instance is Suspended.

Accepted Values:
An integer.
Default Value:
50
Example:
<server maxLoop="75" ... />

swapoutTime
Function:
Specifies the maximum amount of time a process instance remains in idle before it is swapped out of memory.

Increasing the swap out time lets the process stay in memory longer, avoiding the CPU intensive swapping, but keep in mind this may eventually affect capacity. Because swapping consumes a lot of CPU time, it may be beneficial to reduce this number if the CPU is low on memory to improve performance.

Accepted Values:
An integer that represents a number of minutes.
Default Value:
5
Example:
<server swapoutTime="2" ... />

archiveTime
Function:
Specifies the minimum number of days to save Completed or Cancelled processes before archiving.
Accepted Values:
An integer, representing a number of days.

If you set this value to 0, archiving does not occur.

Default Value:
180
Example:
<server archiveTime="180" ... />

assemblyPath
Function:
Specifies the path of the assembly that helps to load the assembly from a custom path that is different from the GAC or service bin folder.

By default, this attribute does not show in netflow.cfg​.

Accepted Values:
A valid path.
Default Value:
None
Example:
<server assemblyPath="C:\Program Files\AgilePoint\AgilePointServerInstance" ... />

ServiceName
Function:
Specifies the name of AgilePoint Server instance.
Accepted Values:
AgilePoint Server instance name.
Default Value:
AgilePointServerInstance

AgilePoint recommends that you do not change this value.

Example:
<server ServiceName="AgilePointServerInstance" ... />

trustedAuthorization
Function:
Specifies whether API calls are trusted. If this setting is turned off, API calls that can pose special security risks require additional access rights for authorization.

By default, this setting is configured as True (turned on). However, if your organization does not use APIs to access AgilePoint NX, or you want to restrict the access these specific methods due to security risks, you can configure this setting to False.

Accepted Values:
  • True - The API authentication account does not require a role with special access controls for any API methods, other than the access controls that are normally required to make API calls.

    This setting means that API calls are made from a trusted system.

  • False - These API methods are restricted:
    • Complete Procedure
    • Save Temporary File
    • Remove Temporary File
    • Query Database
    • Query Database (Extended)

    ​If trustedAuthorization is set to False, these methods can be enabled individually with access controls. For complete information, including settings, access controls, and troubleshooting, refer to Why Do I Get an Access Denied Error for an API Method Call?.

Default Value:
True
Example:
<server trustedAuthorization="False" ... />

Locale
Function:
Specifies the default locale for a registered user in AgilePoint NX.
Accepted Values:
  • en-US
  • ja-JP
  • fr
  • es
  • de-DE
  • zh-TW
  • zh-CN
  • ca
  • nl
  • da
Default Value:
en-US
Example:
<server Locale="en-US" ... />

activeHostingType
Function:
Specifies your AgilePoint NX implementation architecture type.

For more information, refer to What is the Difference Between the AgilePoint NX Implementation Types?.

Accepted Values:
  • OnPremises
  • PrivateCloud
  • OnDemand
Default Value:
OnPremises
Example:
<server activeHostingType="OnPremises" ... />

initCPUUsage
Function:
Specifies the maximum limit of CPU usage to work with low priority server operations.

If the CPU usage decreases below initCPUUsage, then the low priority server operations are handled. By default, this attribute does not show in netflow.cfg​.

Accepted Values:
An integer from 1-100 that represents a percentage.
Default Value:
50%
Example:
<server initCPUUsage="50%" ... />

ualExpirationPeriod
Function:
Specifies the expiry time for a user session for the concurrent user license.

For more information, refer to AgilePoint NX (v6.0 or Higher) App and User License FAQ.

By default, this attribute does not show in netflow.cfg​.

Accepted Values:
An integer that represents a number of minutes.
Default Value:
5
Example:
<server ualExpirationPeriod="5" ... />

initiatorCap
Function:
Specifies the maximum number of threads available for a process initiator.
Accepted Values:
An integer.
Default Value:
None
Example:
<server initiatorCap="100" ... />

enableUnicodeSupport
Function:
Specifies whether to turn on support for Unicode characters.
Accepted Values:
  • true - Turns on Unicode feature.
  • false - Turns off Unicode feature.
Default Value:
false
Example:
<server enableUnicodeSupport="false" ... />

disableLicenseCheck
Function:
Specifies whether to disable daily license check.
Accepted Values:
  • true - Turns on daily license check.
  • false - Turns off daily license check.
Default Value:
false
Example:
<server disableLicenseCheck="false" ... />

sendLicenseExpiryNotificationBeforeDays
Function:
Specifies the number of days before the AgilePoint NX license expires to send an e-mail notification.
Accepted Values:
An integer.
Default Value:
15
Example:
<server sendLicenseExpiryNotificationBeforeDays="30" ... />

MaximumOfManualWorkitems
Function:
Specifies the maximum number of participants associated with human task activity.
Accepted Values:
An integer.
Default Value:
2147483647
Example:
<server MaximumOfManualWorkitems="50" ... />

checkNetworkAvailability
Function:
Specifies if the network for AgilePoint Server goes down, the AgilePoint Server engine stays on hold for a few minutes. If network connectivity is not restored, the AgilePoint Server engine stops running.
Accepted Values:
  • true - If the network for AgilePoint Server goes down, the AgilePoint Server engine stays on hold for a few minutes. If network connectivity is not restored, the AgilePoint Server engine stops running.
  • false - The AgilePoint Server engine continues running.
Default Value:
false
Example:
<server checkNetworkAvailability="true" ... />

GCInterval
Function:
Specifies the time interval to do garbage collection for AgilePoint Server. The garbage collection intervals can have an effect AgilePoint Server performance.
Accepted Values:
An integer that represents hours.
Default Value:
1
Example:
<server GCInterval="2" ... />

Related Topics