Siebel Analytics Platform Installation and Configuration Guide > NQClusterConfig.INI File Reference >

Cluster Section Parameters in the Configuration File

Analytics License: All licenses.

Operating Systems: All.

The parameters in the Cluster section provide configuration information for the Siebel Analytics Cluster Server feature. The NQClusterConfig.INI file parameters are described in this topic. The parameters are listed in the order they appear in the configuration file.

ENABLE_CONTROLLER

This parameter is for machines that host a Cluster Controller. (A single machine can host a Cluster Controller, a Siebel Analytics Server, or one of each.) When set to YES, it specifies that the Cluster Controller functionality is enabled on this machine (the parameters PRIMARY_CONTROLLER and SECONDARY_CONTROLLER determine whether this machine is to act as the primary or secondary Cluster Controller). Valid values are YES and NO.

When set to NO, or commented out, the Cluster Controller functionality is not enabled. Upon startup, a log entry is generated in the NQCluster.log file indicating this. The NO setting allows the Siebel Analytics Server administrator to temporarily disable a Cluster Controller if, for example, the machine is being serviced.

Example: ENABLE_CONTROLLER = YES;

PRIMARY_CONTROLLER

Identifies the computer that is to act as the primary Cluster Controller. This is the computer that has primary responsibility for monitoring the operational configuration of the servers in the cluster and assigning session requests within the cluster. This parameter is required.

A machine can host one Siebel Analytics Server, one Cluster Controller, or one of each. The machine acting as the primary Cluster Controller needs to be on the same subnet as the other machines in the cluster.

Specify the machine name of the computer that is to be the primary Cluster Controller. This needs to be the NetBIOS name (computer name) of the machine. Double or single quotes are not required if the value consists of only nonkey, nonreserved words, or alphanumeric characters.

Example: PRIMARY_CONTROLLER = SERVER01;

SECONDARY_CONTROLLER

Identifies the machine acting as the secondary Cluster Controller. This is the computer that assumes responsibility for monitoring the operational configuration of the servers in the cluster and assigning session requests within the cluster if the primary Cluster Controller is unavailable.

A machine can host one Siebel Analytics Server, one Cluster Controller, or one of each. The machine acting as the secondary Cluster Controller needs to be on the same subnet as the other machines in the cluster. It also needs to be a physically different machine than the primary Cluster Controller.

This parameter is optional. If you do not specify a secondary Cluster Controller, the cluster is not operational if the primary Cluster Controller is unavailable, although sessions already assigned do continue to operate.

Specify the machine name of the computer that is to be the secondary Cluster Controller. This needs to be the NetBIOS name (computer name) of the machine. Double or single quotes are not required if the value consists of only nonkey, nonreserved words, or alphanumeric characters. Do not specify the same machine name as that used in the PRIMARY_CONTROLLER parameter.

Example: SECONDARY_CONTROLLER = SERVER02;

SERVERS

Identifies the Siebel Analytics Servers that belong to this cluster. A cluster can contain a maximum of 16 Siebel Analytics Servers. A server can belong to only one cluster. This parameter is required.

Specify the machine names of the Siebel Analytics Server machines in this cluster. This needs to be the NetBIOS name (computer name) of the machine. Separate the machine names with a comma ( , ). Double or single quotes are not required if the value consists of only nonkey, nonreserved words, or alphanumeric characters.

If the names of the machines you specified as the primary and secondary Cluster Controllers are also hosting Siebel Analytics Servers, make sure to include their names in this list as well.

Example: SERVERS = SERVER01,SERVER02,SERVER03,SERVER04, SERVER05,SERVER06,SERVER07;

MASTER_SERVER

Identifies the Siebel Analytics Server in the cluster that is to function as the master server for the cluster for online repository editing. This is the Siebel Analytics Server in the SERVERS list that the Server Administration Tool connects to for online repository changes. When the changes are saved, the resulting repository is published so the changes can be propagated to the servers in the cluster. (For more information about the location of the publishing directory, see the parameter REPOSITORY_PUBLISHING_DIRECTORY.)

This parameter is required. Only one server may be specified as the master server.

Specify the machine name of the Siebel Analytics Server computer that is to be the master server. This needs to be the NetBIOS name (computer name) of the machine. Double or single quotes are not required if the value consists of only nonkey, nonreserved words, or alphanumeric characters.

Example: MASTER_SERVER = SERVER03;

SERVER_POLL_SECONDS

This specifies the frequency of heartbeat messages between the cluster controller and each Siebel Analytics Server in the cluster. This parameter is required.

Valid values are 1 to 60 seconds. The default is every 5 seconds. This is the recommended value. Specify the number of seconds as a whole integer.

NOTE:  Increasing the value causes failures to be detected less rapidly. Decreasing the value may increase system overhead.

Example: SERVER_POLL_SECONDS = 5;

CONTROLLER_POLL_SECONDS

This specifies the frequency of heartbeat messages between the primary Cluster Controller and the secondary cluster controller (if one is defined). If no secondary cluster controller is defined, this parameter is ignored.

Valid values are 1 to 60 seconds. The default is every 5 seconds. This is the recommended value. Specify the number of seconds as a whole integer.

NOTE:  Increasing the value causes failures to be detected less rapidly. Decreasing the value may increase system overhead.

Example: CONTROLLER_POLL_SECONDS = 5;

MONITOR_CONTROLLER_PORT

Specifies the TCP port number to use for intracluster communication to the cluster controller. This parameter is required.

The default port is 9700.

NOTE:  The default port numbers in the NQClusterConfig.INI file have not been registered through the Internet Assigned Numbers Authority (IANA), nor, as of the date this document was prepared, have these ports been assigned to any specific use by IANA.

When assigning a port number, use the following guidelines:

• Port numbers may be in the range of 1024 to 49151.
• Before selecting a port number, verify that no installed application uses the port number on any machine in the cluster.
• When installing additional software packages, do not assign the port number used in Siebel Analytics clustering communications to other applications as TCP ports.

  NOTE:  Do not specify the same port number as that specified for the MONITOR_SERVER_PORT (described below).

  Example: MONITOR_CONTROLLER_PORT = 9700;

MONITOR_SERVER_PORT

Specifies the TCP port number to use for intracluster communication to the clustered servers. This parameter is required.

The default port is 9701.

NOTE:  The default port numbers in the NQClusterConfig.INI file have not been reserved through the Internet Assigned Numbers Authority (IANA), nor, as of the date this document was prepared, have these ports been assigned to any specific use by IANA.

When assigning a port number, use the following guidelines:

• Port numbers may be in the range of 1024 to 49151.
• Before selecting a port number, verify that no installed application uses the port number on any machine in the cluster.
• When installing additional software packages, do not assign the port number used in Siebel Analytics clustering communications to other applications as TCP ports.

  NOTE:  Do not specify the same port number as that specified for the MONITOR_CONTROLLER_PORT (described above).

  Example: MONITOR_SERVER_PORT = 9701;

CLIENT_SERVER_PORT

Specifies the TCP port number to use for ODBC connections on the clustered servers. This parameter is required.

The default port is 9703.

NOTE:  The default port numbers in the NQClusterConfig.INI file have not been reserved through the Internet Assigned Numbers Authority (IANA), nor, as of the date this document was prepared, have these ports been assigned to any specific use by IANA.

When assigning a port number, use the following guidelines:

• Port numbers may be in the range of 1024 to 49151.
• Before selecting a port number, verify that no installed application uses the port number on any machine in the cluster.
• When installing additional software packages, do not assign the port number used in Siebel Analytics clustering communications to other applications as TCP ports.

  NOTE:  Do not specify the same port number as that specified for the CLIENT_CONTROLLER_PORT.

  Example: CLIENT_SERVER_PORT = 9703;

CLIENT_CONTROLLER_PORT

Specifies the TCP port number to use for ODBC connections on the cluster controllers. This parameter is required.

The default port is 9706.

NOTE:  The default port numbers in the NQClusterConfig.INI file have not been reserved through the Internet Assigned Numbers Authority (IANA), nor, as of the date this document was prepared, have these ports been assigned to any specific use by IANA.

When assigning a port number, use the following guidelines:

• Port numbers may be in the range of 1024 to 49151.
• Before selecting a port number, verify that no installed application uses the port number on any machine in the cluster.
• When installing additional software packages, do not assign the port number used in Siebel Analytics clustering communications to other applications as TCP ports.

  NOTE:  Do not specify the same port number as that specified for the CLIENT_SERVER_PORT.

  Example: CLIENT_CONTROLLER_PORT = 9706;

SERVER_MANAGER_PORT

Specifies the TCP port number to use for intracluster communication. This parameter is required only under UNIX.

The default port is 9702.

NOTE:  The default port numbers in the NQClusterConfig.INI file have not been reserved through the Internet Assigned Numbers Authority (IANA), nor, as of the date this document was prepared, have these ports been assigned to any specific use by IANA.

When assigning a port number, use the following guidelines:

• Port numbers may be in the range of 1024 to 49151.
• Before selecting a port number, verify that no installed application uses the port number on any machine in the cluster.
• When installing additional software packages, do not assign the port number used in Siebel Analytics clustering communications to other applications as TCP ports.

  Example: SERVER_MANAGER_PORT= 9702;