Configure Clustering Server Manager

Do the following to configure the Clustering Server Manager.

Prerequisites

Navigation

  1. On the CSM machine, open the file C:\Program Files\AgilePoint\AgilePoint Clustering Server Manager\csmService.exe.config

Instructions

  1. In the CSM configuration utility, add the following keys to the appSettings node:
    Field Name Definition

    AdvancedLoadBalanceCondition

    Definition:
    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 difference of number of running process instances among multiple machines is greater than 10 percent, rebalancing starts.

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

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

    AdvancedLoadBalanceInterval

    Definition:
    Rebalances the process 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" />

    database

    Definition:
    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"/>

    InitialLeaseTime

    Definition:
    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:
    Any integer greater than or equal to 60, representing a number of seconds.

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

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

    lock

    Definition:
    Specifies the path to the lock database. Having a separate lock database for CSM provides 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:

    <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 is specified for CSM, CSM uses the same lock database as AgilePoint Server.

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

    port

    Definition:
    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

    Definition:
    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:
    Any integer greater than or equal to 5, representing a number of seconds.

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

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

    ServiceName

    Definition:
    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.