Ascentn.AgilePoint.WCFService.exe.config Configuration Reference

The file Ascentn.AgilePoint.WCFService.exe.config provides back-end configuration settings for AgilePoint Server and the Cluster Server Manager component.

Prerequisites

How to Start

  1. On the AgilePoint Server machine, open the file (AgilePoint Server instance installation folder) C:\Program Files\AgilePoint\AgilePointServerInstance\bin\Ascentn.AgilePoint.WCFService.exe.config.
Note: If you are using an older version of AgilePoint Server where Cluster Server Manager is a separate component, the CSM configuration file is c:\Program Files\AgilePoint\AgilePoint Clustering Server Manager\csmService.exe.config

Procedure

  1. In Ascentn.AgilePoint.WCFService.exe.config, add or modify the following keys as necessary for your environment.
    Field NameDefinition

    LicenseActivationCode
    Description:
    Specifies the encrypted activation code for the AgilePoint license. This code is paired with a license key to enable product activation.
    Allowed Values:
    An appSettings key in the following format:

    <add key="LicenseActivationCode" value="[activation code]" />

    This value must be supplied by AgilePoint Sales or Customer Support.

    Default Value:
    None
    Example:
    <add key="LicenseActivationCode" value="DFKORh lBxwvSGlo2R03T7AHnlq729JjpNZHYH6ruF8NmiXGctp2wigeklicXPp+eNaEzHTKKD51z JJWj17Ejls1OQxGy59eSyKYzlrkV22DtlDSssKCDB6ntTEpfPVlr35Gl2fzCaLdOfd1zPEbMjka6 IlsnQ+36ln7tgnb5wwV7yCqkWCPxtsxYlpBgxBDoycvNr0IYi+NJwvKRaY8wPMwtsy5sFp2h9pNA DPx9HuYfeJwc8eonlR7002MH9mV9k45Hcnyq/ybs7oEZBzZyyQ8xcBJQgj0qNLtmTZ9mvjJkl7vE ZIS3w/f40JJ6obEy7MJKr7wRUZQmXreubTf/MdF+udsZjTVg9hjEhU4fiVQNwkVNTa2iP4OdmcVh lOBUVr4d8nhOtJiR6KBhTdr6FLBW2dk8rC+eSJJceUt9wF2kfLGwSzUzl8P2rAvHNPQopCb3eeiA sFLqng92o6J/jLdFs7k1xXrTNSIA05gcwOrTQPs+7n1qkU619EGvijSvFBbwLNtFMoD6PQ+5EXSz V8MuSXnSvrbAaJnh5MdRRL1COiIFXmOzMOZ1++jFnV3IL6TcOka5th2sDk+CnszRxL8iARJyUzdM 0jQkDKCibk7Bm6hMm+EQcBGM7ntN5efsIPNkz0aOGKNH/qkdwL24tFxOI0wdoW0I6FazCY6Zf4IO gaGrWSWgTwuwUwbRI2LQnVyb/ue+WqeB047nJY1sFV/LRfLmx1c/SoWKzzGImJr9NsRpnrHVH/eR ptoSjK5DX00QjEZF78ojIcuPu/D0kk98v+hCOekwtF0oXaeEaaHWBsgi7xUgpSbLDnUbbt3F16dA vrK/cDUKNdNZg06Ve+OB80eUzS9dJBEh/7QS1QgJSZ5bYS95Vx/HLEPUfFqEkNFnpRAoLYmIChnj xvA5ffZItVt+P6BjXKlBS7staCpllBwO6DkXXpY993mh6vGG7mHyn1JjA0TPQAEYuYqeT0eqS8zG BQSiIwdMffnG6yWBZXHGsj5cXpfBxn+HP0/RpUKtVzjd2olq4myzSEB8fFWMaoPXGMrH6MHzKRlC lZjoAzZs3rKqmx+ZaG9qkvDUnczuyZqiLe7PpIjXy3q5FftKvWsEQ9pfN0Z7fnMZLNs+QHpFLj0k lvsoI/gBmFbjgfDJ8SfOiZYbgifCXFiyYzPXJg+rppP2lhISNSPWpBFpIwS0ntPCwKpqhQ7NLDMA ZbTnBus+OnEatxfvAVYtAJYGfT/qRhqDFAjGqNJxuysy/X9wmbx1XwL5ERZmRBES5j8Od9FlY2gB yRK2hS2Cu+8RtcOTa2N/BsxGAkO3R99ztKwn9uGAItmGGKXNgLpLxoen7a4DEwx+iM1n2iWYcpO3 2IdaWphvtlILoxNhCIwsbNq/8KhlyQzjGewixwpnl9IHDEIYDKVTc5QFAMBaXZLzS7ntjTePu3tK 0W2VIwSmXm9A9/+CCkm3mQ2VI96p3kLO1H0u3frI1voRilZJwHUgHGE4nwM1CyV85S5oAQJWCGWT N7+NAoEei0CYDAAYiOeX8fG1aqlMXBp8Wwlld085iqJDYuwPMB717jH89sKrHndDsQCLqnKzZgdp bTtvrBL8pRkPI+LfziHoL6EKY1IRo6NVsYsLxTXnXXsCcob0w2sBgnpahVwZXNA5FafounHPHiCm 0B7pACbyXQ+LKWwoYYNJI20cLIgsAcwXgqbXYjqaQQfu0PyKgJ6tZMuzV+fLbA1toq+s7h7LYLj4 FACaKVzYYIxq0cktosg6wOBuukyjwlRzNZVLGiJrXqj0+KKmIIrbc4tsAaP72wRN1PMDRQaGFkT2 1AWs3b/JTFyse0VZNgXgPEDPDUu4wUhIjil5zySahnrnl79x6nwd+2qz8FHIun6/oEhFepu9U0JM xCqw+gbeysruVrd9zPTtgXBP5HxgPHqxu09MDFdxomCRXxxduSVIAg/hBva97eO5TXovtcYxZl8u ffF1PWxUupv9tSxiU2WYru/bkyaI5Q==" />

    bindTo
    Description:
    Specifies an IP address for AgilePoint Server in environments where the CSM component cannot bind to the server using the machine name.
    Allowed Values:
    An appSettings key in the following format:

    <add key="bindTo" value="[IP address using numerals or *]" />

    Default Value:
    None.

    For backward compatibility, if this value is not present, the CSM component uses the AgilePoint Server machine name.

    Example:
    If the full IP address is 197.168.0.9, any of these example formats can apply:
    • <add key="bindTo" value="197.168.0.9" />
    • <add key="bindTo" value="197.168.0.*" />
    • <add key="bindTo" value="197.*.0.9" />
    • <add key="bindTo" value="*.168.0.*" />
    • <add key="bindTo" value="197.168.*.*" />

    LogFileFolder
    Description:
    Specifies the location for your AgilePoint Server log file.
    Allowed Values:
    An appSettings key in the following format:

    <add key="LogFileFolder" value="[absolute path to your log file folder]" />

    Default Value:
    (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\log
    Example:
    <add key="LogFileFolder" value="c:\Users\Log" />

    MaxLogFileSize
    Description:
    Specifies the maximum file size for your log file.
    Allowed Values:
    An appSettings key in the following format:

    <add key="MaxLogFileSize" value="[number of MB]" />

    This value is an integer that represents log file size in MB.

    Default Value:
    50
    Example:
    <add key="MaxLogFileSize" value="150" />

    AdvancedLoadBalanceCondition
    Description:
    Rebalances the process load among AgilePoint Server machines in a CSM environment when the difference in the number of processes running on the machines crosses a specified threshold.

    The value of this field specifies this threshold in terms of a percentage difference in the number of processes.

    This is an advanced, optional configuration setting.

    Allowed Values:
    An appSettings key in the following format:

    <add key="AdvancedLoadBalanceCondition" value="[percent difference]" />

    This value is a decimal number that represents a percentage.

    The recommended value is 0.5, or 50 percent.

    Default Value:
    0.1

    This means if the largest difference between the number of running process instances among multiple machines is greater than 10 percent, rebalancing starts.

    Example:
    <add key="AdvancedLoadBalanceCondition" value="0.13" />

    In this example, load rebalance is triggered when the largest difference in the number of processes running on the AgilePoint machines is 13 percent or higher.

    For example:

    • SERVER1 has 1000 running process instances
    • SERVER2 has 1500 running process instances
    • SERVER3 has 1200 running process instances
    • SERVER2 - SERVER1 = 500 (This is the largest difference.)
    • SERVER3 - SERVER1 = 200
    • SERVER2 - SERVER3 = 300
    • Total: SERVER1 + SERVER2 + SERVER2 = 3700
    • Percentage: 500/3700 = 13.5%

    AdvancedLoadBalanceInterval
    Description:
    Rebalances the running load among AgilePoint Server machines in a CSM environment periodically. The value of this field specifies the number of minutes for each interval.

    This is an advanced, optional configuration setting.

    Allowed Values:
    An appSettings key in the following format:

    <add key="AdvancedLoadBalanceInterval" value="[number of minutes]" />

    This value is an integer.

    The recommended value is 30, which means the load balance is checked every 30 minutes.

    If this value is less than 30, it will cause frequent loading and unloading among machines.

    Default Value:
    0

    This means AdvancedLoadBalanceInterval is turned off. If configuration file does not this key, it will not perform advanced balancing.

    Example:
    <add key="AdvancedLoadBalanceInterval" value="20" />

    AllowedLocalSystemPathForFileUpload
    Description:
    Specifies the location for your local file system folders to upload files with the File Upload form control in eForm Builder.

    This key is used to restrict access from your AgilePoint NX apps to specific folders on the AgilePoint Server machine.

    Allowed Values:
    An appSettings key in the following format:

    <add key="AllowedLocalSystemPathForFileUpload" value="[absolute paths to one or more folders on your AgilePoint Server machine separated by semicolons (;)]" />

    Default Value:
    None
    Example:
    <add key="AllowedLocalSystemPathForFileUpload" value="C:\My Files\Folder1;D:\Folder2;" />
    Limitations:

    This key is available in these releases:

    database
    Description:
    Specifies the connection string for the main AgilePoint database.
    Allowed Values:
    An appSettings key in the following format:

    <add key="database" value="application name=[AgilePoint CSM];server=[SQL Server name]; database=[database name];trusted_Connection=yes"/>

    Default Value:
    None
    Example:
    <add key="database" value="application name=AgilePoint CSM;server=(local);database=ap_licenses;trusted_Connection=yes"/>

    EnvironmentType
    Description:
    Specifies the environment type for system notification. This helps to identify from which environment a notification was sent.

    The subject line for system notification contains the machine name and, optionally, the environment type. The machine name shows in the subject line by default and does not require configuration.

    Allowed Values:
    An appSettings key in the following format:

    <add key="EnvironmentType" value="[name of your environment]" />

    The environment name can include letters and spaces.

    Default Value:
    None
    Example:
    <add key="EnvironmentType" value="Asia Region Production" />
    Limitations:

    This field is available in these releases:

    InitialLeaseTime
    Description:
    The number of seconds AgilePoint Server initiates its lease on Cluster Server Manager once the heartbeat is initiated.
    • This is an advanced, optional configuration setting.
    • This only applies to CSM running on a virtual machine under heavy load.

    Allowed Values:
    An integer.

    Range

    • Greater than or equal to 60

    Represents

    • A number of seconds

    Format:

    <add key="InitialLeaseTime" value="[seconds]" />

    Default Value:
    60
    Example:
    <add key="InitialLeaseTime" value="120" />

    lock
    Description:
    Adds a lock to the database, so that errors do not occur when AgilePoint tries to communicate with the database from multiple servers. This setting supports high availability for the CSM component independent of AgilePoint Server.

    This value is optional, but you must create it if you want to use it.

    Allowed Values:
    An appSettings key in the following format:
    Note: In the setting for AgilePoint v5.0 R2 SP1 and later, the brackets ([ ]) in the value [SIMPLIFIED] are literal and required. In the setting for AgilePoint v5.0 R2 and earlier, the brackets within the values (for example, [SQL Server name]) indicate variables. In this case,you must replace the entire value [SQL Server name], including the brackets, with the actual value for your environment, such as mydatabaseserver. This difference is shown in the examples.

    AgilePoint BPMS v5.0 R2 SP1 and later:

    <add key="lock" value="[SIMPLIFIED]"/>

    AgilePoint BPMS v5.0 R2 and earlier:

    <add key="lock" value="application name=[AgilePoint CSM];server=[SQL Server name]; database=[database name];trusted_Connection=yes"/>

    Default Value:
    None

    If no lock database value is specified for CSM, CSM uses the same lock database as AgilePoint Server.

    Example:
    AgilePoint BPMS v5.0 R2 and earlier:

    <add key="lock" value="[SIMPLIFIED]"/>

    AgilePoint BPMS v5.0 R2 and earlier:

    <add key="lock" value="application name=AgilePoint CSM;server=(local);database=lock;trusted_Connection=yes"/>

    port
    Description:
    Specifies the port for TCP/IP communication between AgilePoint Server and the AgilePoint CSM.
    Allowed Values:
    An appSettings key in the following format:

    <add key="port" value="[CSM port number]"/>

    Default Value:
    13481
    Example:
    <add key="port" value="13481"/>

    RenewOnCallTime
    Description:
    The number of seconds CSM renews the lease for an AgilePoint Server instance after it makes a call.
    • This is an advanced, optional configuration setting.
    • This only applies to CSM running on a virtual machine under heavy load.

    Allowed Values:
    An integer.

    Range

    • Greater than or equal to 5

    Represents

    • A number of seconds

    Format:

    <add key="RenewOnCallTime" value="[seconds]" />

    Default Value:
    5
    Example:
    <add key="RenewOnCallTime" value="10" />

    ServiceName
    Description:
    Specifies the name of the AgilePoint CSM Windows service.
    Allowed Values:
    The following appSettings Key:

    <add key="ServiceName" value="AgilePoint Clustering Server Manager"/>

    Default Value:
    AgilePoint Clustering Server Manager

    AgilePoint recommends that you do not change this value.

    UseAdvanced_ADAuth
    Description:
    Specifies whether to use advanced Active Directory authentication.
    Allowed Values:
    An appSettings key in this format:

    <add key="UseAdvanced_ADAuth" value="[true or false]"/>

    • false - Uses Active Directory authentication with the search directory mechanism.
    • true - Uses the PrincipleContext authentication mechanism.
    Default Value:
    false