Optional Switchover Server parameters

Callback Interaction Recovery Enabled

General optional server parameter

To enable switchover support for callback interactions, add this parameter and set it to 1. This server parameter is available in CIC 4.0 SU 3 and higher releases.

By default this parameter is set to 0 or Off.

Note:
For information about a known side effect of enabling this server parameter, see A note about the loss of duration information for interactions.

Chat Interaction Recovery Enabled

General optional server parameter

To enable switchover support for chat interactions, add this parameter and set it to 1. This server parameter is available in CIC 4.0 SU 3 and higher releases.

By default this parameter is set to 0 or Off.

Note:
For information about a known side effect of enabling this server parameter, see A note about the loss of duration information for interactions

Note:
CIC does not support SMS resiliency when the Chat destination option is selected.

CustomMirrorDir

Packaged server parameter

This parameter specifies one or more directories on the active server that are mirrored on the backup server. These parameters are mirrored in addition to the default set of mirrored directories.

Any time a file is added, removed, or modified in one of these directories, the change is mirrored in the corresponding directory on the backup server. Separate each directory in the list with a semicolon (;).

To mirror the directory recursively (including directory additions and deletions), place a + in front of the directory name.

For example:

+D:\I3\IC\ImportantDir

To stop recursive monitoring, remove the +.

Custom Upgrade Attribute Exceptions

Customizable server parameter

For more information, see Appendix C.

Custom Upgrade File Synchronization Directories

Customizable server parameter

For more information, see Appendix C.

Custom Upgrade File Synchronization Exceptions

Customizable server parameter

For a description, see Appendix C.

Custom Upgrade Synchronization Directories

Customizable server parameter

For a description, see Appendix C.

Directmessage Interaction Recovery Enabled

General optional server parameter

To enable switchover support for social media direct messages, set this parameter to a non-zero integer.

ForceSwitchoverFQDNs

General optional server parameter

This parameter enables the Switchover system to override the system-generated names for the switchover pair, which it automatically resolves. When this parameter is set to Yes or 1, the Switchover system instead uses the names that the system administrator specifies in the SwitchoverServerFQDN A and SwitchoverServerFQDN B server parameters.

Note:
If this server parameter is missing or disabled, then Switchover will try to automatically resolve the FQDNs from the NetBIOS.

For more information about the use of this system parameter, see Win32 CIC client machines outside the LAN cannot re-connect.

InitialMirrorDir

Packaged server parameter

This parameter specifies one or more directories on the active server that are mirrored on the backup server when the CIC server starts, in addition to the default mirrored directories. Separate each directory in the list with a semicolon (;).

If you want the directory mirrored recursively (including directory additions and deletions), place a + in front of the directory name.

For example:

+D:\I3\IC\ImportantDir

Mail Interaction Recovery Enabled

General optional server parameter

To enable switchover support for email interactions, create this parameter and set it to 1.

Note:
For information about a known side effect of enabling this server parameter, see A note about the loss of duration information for interactions.

This server parameter is available in CIC 4.0 SU 3 and higher releases.

By default this parameter is set to 0 or Off.

Mail Interaction Recovery Filter Enabled

General optional server parameter

This parameter limits the email interactions that the system synchronizes to the backup server. Create this parameter and set to a value of “1” to synchronize only the emails previously assigned to an agent’s queue.

Note: For more information about scalability of email interaction recovery, see Recovery of email interactions.

This parameter requires that you also set the Mail Interaction Recovery Enabled parameter to 1.

By default, this parameter is set to 0 or Off.

MirrorExceptions

Packaged server parameter

This parameter specifies the extensions of file types that you do not want to mirror. Separate multiple extensions with semicolons (;)> For example: txt; gif; myext.

Server A Address

General optional server parameter

To specify the IP address of the dedicated Switchover NIC on SwitchoverServer A in a dual or multiple NIC configuration, add this parameter.

When Server A Address and Server B Address are set, the Switchover system uses these addresses exclusively to direct its traffic.

Server B Address

General optional server parameter

To specify the IP address of the dedicated Switchover NIC on SwitchoverServer B in a dual or multiple NIC configuration, add this parameter.

When Server A Address and Server B Address are set, the Switchover system uses these addresses exclusively to direct its traffic.

SMS Interaction Recovery Enabled

General optional server parameter

To enable switchover support for SMS interactions, add this parameter and set it to Yes or 1. This server parameter is available in CIC 2016 R4 and higher releases.

By default this parameter is set to 0 or Off.

Note:
For information about a known side effect of enabling this server parameter, see A note about the loss of duration information for interactions

The recovery of SMS generic objects requires that you also configure the IonNotifier parameter. For information, see Call Recovery Feature Technical Reference in the PureConnect Documentation Library.

Socialconversation Interaction Recovery  Enabled

General optional server parameter

To enable switchover support for social media conversations, set this parameter to a non-zero integer.

StatServer_DisableQPSLoggingOnBackup

General optional server parameter

To disable the backup server from sending its log data to the CSV file, add this parameter and set its value to Yes. For more information, see Location of log data.

Switchover Disable Gateway Ping

General optional server parameter

To enable the gateway ping, set this server parameter to No or 0. To disable the gateway ping set the parameter to Yes or 1.

For more information about using this server parameter, see Detecting Network Connection Status of the Backup and Primary in Primary Monitor.

Switchover DS Request Timeout

General optional server parameter

To specify the timeout length (in seconds) for DS requests that are sent by the backup server to the primary server, add this parameter. The requests can be sent during either the initial startup of the backup server or the resynchronization with the primary server.

The default value is 120 seconds.

Switchover File Monitor Health Check Interval

General optional server parameter

Set this parameter to the number of seconds between each health check request that is sent from the backup server to the File Monitor on the primary server.

To turn off the health check request, set this parameter to 0.

If no value is specified, the default value is 60 seconds.

This parameter works with the Switchover File Monitor Health Check Timeout parameter. For more information, see Configuration options for File Monitor Health Checks.

Switchover File Monitor Health Check Timeout

General optional server parameter

Set this parameter to the number of seconds that the backup server gives File Monitor to respond to the health check request before it times out and traces the failure.

If no value is set, the default value is 10 seconds.

This parameter works with the Switchover File Monitor Health Check Interval parameter. For more information, see Configuration options for File Monitor Health Checks.

Switchover IP Retry Delay

General optional server parameter

Add this parameter, if necessary, for use with Interaction Director Switchover systems.

When monitoring IP, this server parameter has the same effect as Switchover TS Failure Retry Delay.

The Interaction Director server install automatically creates this server parameter. Genesys recommends that you review this server parameter in Interaction Administrator on the Interaction Director server to confirm the setting.

Switchover IP Timeout

General optional server parameter

Add this parameter, if necessary, for use with Interaction Director Switchover systems.

When monitoring IP, this server parameter has the same effect as Switchover TS Timeout.

The Interaction Director server install automatically creates this server parameter.

Note:
Confirm the setting of this server parameter in Interaction Administrator on the Interaction Director server.

Switchover Max Restarts

General optional server parameter

To specify the maximum number of times in a restart period that a new process ID can be returned in the TS ping notification before a restart occurs, add this parameter. By default, this value is 2.

Switchover Max Restarts Period

General optional server parameter

To specify the time period (in seconds) during which the Switchover system counts TS ping notifications that contain new process IDs, add this parameter. By default, this value is 300 (5 minutes).

Switchover Max Sequential Restarts

General optional server parameter

To specify the maximum number of sequential times that a new process ID can be returned in the TS ping notification before a switch occurs, add this parameter. By default, this value is 2.

Switchover Max TS Failures

General optional server parameter

To specify the number of TS ping failures the Switchover system on the backup server tolerates before starting a switchover, add this parameter.

Note:
Set this value greater than 0. The default value is 2.

Note:
The failure count is reset each time the Switchover system successfully receives a response from TS on the primary server.

Switchover Monitoring

General optional server parameter

Add this parameter, if necessary, for use with Interaction Director Switchover systems.

The Interaction Director server install automatically creates this server parameter. It sets up an IP ping process in Interaction Director configurations, which are similar to the TS ping process in CIC configurations. The default value is TsServer.

Note:
Confirm the setting of this server parameter in Interaction Administrator on the Interaction Director server.

Switchover NetTest A

General optional server parameter

Add this parameter, if necessary, for switchover in WAN environments.

Switchover NetTest A specifies the name or IP address of a computer on the same network segment as SwitchoverServer B. The Switchover system uses the IP address on SwitchoverServer A when SwitchoverServer A is the backup server.

Whenever a failure condition is detected, the Switchover system on the backup server uses ICMP echo to ping this IP endpoint. It must find the IP endpoint on the same network segment as the active server. If the Switchover system cannot ping this endpoint, it assumes that the active server is still operable and doesn't switch because there a WAN failure.

Important!
Since the Switchover system no longer has a network connection (and thus cannot replicate changes), it logs an error to the event log and shuts down processing. Restart the backup server, so that the Switchover system can resume its monitoring and replication.

Recommendation: The value for Switchover NetTest A is the closest pingable (ICMP echo) IP address to SwitchoverServer B from SwitchoverServer A.

Switchover NetTest B

General optional server parameter

Add this parameter, if necessary, for switchover in WAN environments.

This parameter specifies the name or IP address of a computer on the same network segment as SwitchoverServer A. The Switchover process on SwitchoverServer B uses the IP address when SwitchoverServer B is the backup server.

Recommendation: The value for Switchover NetTest B is the closest pingable (ICMP echo) IP address to SwitchoverServer A from SwitchoverServer B.

Switchover NetTest Timeout

General optional server parameter

Add this parameter, if necessary, for use with Switchover in WAN environments. It is used with Switchover NetTest A and Switchover NetTest B.

This parameter specifies the amount of time (in seconds) Switchover waits for the ICMP echo to return.

By default, this value is 1 second.

Switchover Notifier Reconnect Delay

General optional server parameter

Specifies the interval in seconds that the Notifier connections will wait to re-establish a new connection after a loss. Lower values can improve reconnection response during short periods of connection los with the primary monitor.

The default value is 5. The minimum value is 5. The maximum value is 60.

Switchover Ping on Aux Connection

General optional server parameter

This parameter moves the TS ping from the main data connection to the auxiliary connection.

By default, this parameter is set to 0, which means it is not enabled.

Note:
To enable QoS on the ping on the auxiliary connection (not the main connection), be sure that both the Switchover Ping on Aux Connection and the Switchover Use QoS For Ping parameters are enabled. If only the Switchover Use QoS For Ping parameter is enabled, QoS is not used on the ping.

Switchover Primary Monitor Ping Delay

General optional server parameter

Specifies the delay in seconds between the primary monitor pings to the notifier on the primary monitor.

The default value is 0. The maximum value is 300.

Switchover Primary Monitor Retry Ping Delay

General optional server parameter

Specifies the delay in seconds between pings when the primary monitor is in retry mode.

The default value is 0. The minimum value is 0. The maximum value is 300.

Switchover Primary Monitor Retry Count

General optional server parameter

Specifies the number of times the primary monitor will send retry pings before it begins diagnosing the connection issues.

The default value is 2. The minimum value is 1. The maximum value is 50.

Switchover Primary Monitor Timeout

General optional server parameter

Specifies the timeout value in seconds for a ping from the primary monitor on the backup to the notifier on the primary. If a ping is not received in this time frame, the primary monitor will then begin its retry mode.

The default value is 0, which indicates that the value will be one half of the monitored module timeout whose default value is 10 seconds. The maximum value is 300.

Switchover QoS DSCP

General optional server parameter

When Switchover Use QoS For Ping parameter is enabled, add this parameter to set the value in the QoS byte. Differentiated Services Code Point (DSCP) is the 6 most significant bits of a packet. You can use DSCP to prioritize QoS traffic on Switchover.

Note:
To enable QoS on the auxiliary connection ping, enable both the Switchover Ping on Aux Connection and the Switchover Use QoS For Ping parameters. If only the Switchover Use QoS For Ping parameter is enabled, QoS is not used on the ping.

Switchover Reconnect Timeout

General optional server parameter

Specifies the duration in seconds that switchover on the backup will attempt to reconnect with the primary. This timeout begins once the primary monitor has diagnosed the connection and signaled the appropriate event to the switchover state machine. Therefore, the actual duration from the time connections issues were first detected to the time the backup gives up and switches over will be longer than this because there is the interval where the retry pings are sent and then the network checks all made by the primary monitor. This can take around 15 seconds if the backup is not connected to the network or 70 seconds if the primary is not connected to the network.

A value of 0 indicates an immediate switchover when a connection is lost. A value greater than 0 indicates the number of seconds that the timer will be set to expire. The default value is 30. The minimum value is 0. There is no maximum value.

Note:
This parameter is new in CIC 2015 R# releases and up. It was known as Switchover Reconnect Delay from 4.0 SU4 through 4.0 SU6.

Switchover TS Failure Retry Delay

General optional server parameter

To specify the number of seconds that the Switchover system waits, after marking a TS failure, before sending the second ping, add this parameter. The system switches once the failure count exceeds the value stored in the Switchover Max TS Failures parameter, which defaults to 2.

Note:
Set this value to greater than 0 seconds. The default is 1 second.

Switchover TS Timeout

General optional server parameter

To specify the number of seconds that the Switchover system waits from the time the ping is sent until it is marked as a TS failure, add this parameter.

This parameter also specifies the number of seconds that the Switchover system waits after a TS success before it sends another ping.

Set this value between 5 - 60 seconds. The default is 10 seconds.

Switchover Unreachable Primary Ping Count

Optional server parameter

Specifies the number of times that a ping set is sent to the primary before switching over. A ping set consists of one or more pings sent during a single attempt to detect the primary's system on the network. Pings will be sent until the primary responds or the maximum number of ping attempts is reached.

This count is not the number of pings sent in a single set when trying to contact the primary; it is the maximum number of ping sets that are sent to the primary before a switchover will occur.

The delay between sending ping sets is defined by the Switchover Unreachable Primary Ping Delay parameter.

If you enter values 0-3, the switchover system sends 3 additional ping sets to the primary server. If these attempts fail, the server is considered unreachable and a switchover is initiated.

If you enter a value of -1, it results in unlimited attempts until the primary server is reached. In this case, if the connection issue is determined to be an unreachable primary server, switchover will not occur since the backup server will keep waiting for the primary server to be reachable again.

Note:
Use a value of -1 only if a switchover should never occur as long as the primary server is reachable.
In many cases, the switchover occurs after the Notifier timeout occurs, not as a result of the unreachable primary pings.

The default value is 0. The minimum value is -1. There is no maximum value.

Switchover Unreachable Primary Ping Delay

Optional server parameter

Specifies the interval in seconds between sending ping sets to the primary monitor when it is unreachable. See the Switchover Unreachable Primary Ping Count parameter for the definition of a ping set.

The default value is 10. The minimum value is 1. The maximum value is 300.

Switchover Use QoS for Ping

General optional server parameter

To customize QoS for the TS ping on the auxiliary connection, add this parameter and set it to Yes or 1 to enable it.

Use this parameter to set the priority of ping (echo request and echo reply) packets.

You can make further customizations by using the Switchover QoS DSCP parameter.

When enabling DSCP tagging, AF41 (DSCP 34) is tagged by default. To change the value, set it to any of the tagging classes.

Note:
To enable QoS on the ping on the auxiliary connection (not the main connection), enable both the Switchover Ping on Aux Connection and the Switchover Use QoS For Ping parameters. If only the Switchover Use QoS For Ping parameter is enabled, QoS is not used on ping.

SwitchoverServerFQDN A

General optional server parameter

When the ForceSwitchoverFQDNs server parameter is enabled, then the SwitchoverServerFQDN A server parameter contains the fully qualified domain name of the Switchover Server A. For more information, see ForceSwitchoverFQDNs and Win32 CIC client machines outside the LAN cannot re-connect in Problems with the Switchover system running improperly.

SwitchoverServerFQDN B

General optional server parameter

When the ForceSwitchoverFQDNs server parameter is enabled, then the SwitchoverServerFQDN B server parameter contains the fully qualified domain name of the Switchover Server B.

For more information, see ForceSwitchoverFQDNs and Win32 CIC client machines outside the LAN cannot re-connect in Problems with the Switchover system running improperly.