Advanced Properties for HA server drain and coherence


THE INFORMATION IN THIS ARTICLE APPLIES TO:

  • EFT v7.4.2 and later
  • EFT v4.x to v7.4.x stores advanced properties in the registry.

EFT v8.0 and later store Advanced Properties in a JSON file. When you upgrade from EFT v7.4.x to EFT v8, the non-default settings that you have defined in the registry will be added to the Advanced Properties file during upgrade. (Default settings become part of the EFT configuration files.) For a more on how to use advanced properties, and a spreadsheet of the advanced properties, please refer to the "Advanced Properties" topic in the help for your version of EFT.

DISCUSSION

Use the following advanced properties for HA server drain and coherence.

In EFT v8 and later:

Add the name:value pair to the AdvancedProperties.JSON file in EFT's \ProgramData\ directory as described in the "Advanced Properties" topic in the online help for your version of EFT.

{
"name": value
}

In versions prior to v8.0:

Add the advanced properties to HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\GlobalSCAPE Inc.\EFT Server 7.4\

DrainingTimeoutSecs  

Draining timeout in seconds allows you to adjust the time for ongoing event rules and transfers to complete before draining starts.

  • Type: DWORD 

  • Default is 900 seconds (15 minutes).

  • Maximum is 86400 seconds (24 hours).

  • If set to 0, then immediately shutdown and do not drain.

 ClusterOutOfSyncHealSecs

 Amount of time in seconds that an HA node will wait for incoming administrative messages to arrive before declaring itself to be out-of-sync with the cluster and initiating draining and restart.

  • Type: DWORD 

  • Default is 30 seconds.

  • If out of sync is detected, the node attempts to heal; if it can heal within the timeout period, the system resyncs and continues to operate as expected.

  • If out of sync is detected and cannot be repaired within the heal timeout period, the node will enter drain mode and then restart the service.

  • If set to 0, then do not attempt to heal; continue to operate the node out of sync.

 ClusterCoherenceQueueMsmqType

Determines the type of coherence queue to use when using MSMQ.

msmq-multicast uses multicast-based MSMQ queues to send administrative updates.
msmq-iterative uses point-to-point MSMQ queues.

v7.4.2.0 - 8.2.x default value = msmq-multicast.

  • Type: STRING

  • To use the TCP instead of MSMQ Broadcasting, set to ClusterCoherenceQueueMsmqType to msmq-iterative

  • To use MSMQ Broadcasting, either delete the property or set the ClusterCoherenceQueueMsmqType to msmq-multicast

 ClusterCoherenceQueueDetectPrivateIP

Used to explicitly define the IP/Subnet via registry entry/advanced property, localized per node.

  • Type: STRING

  • It can either be set to autodetect (which is the default, which causes it to find and use the first private subnet it finds), or it can be set to the prefix of the interface to use (e.g., “192.168.0", "192.168." or "192.168" just the prefix of the subnet, with no quotes).

  • Changes made in the registry are recorded in the ActiveNodes.json (located in the HA cluster's Shared configuration folder), which is used automatically by the EFT nodes to pass information between themselves and should not be edited.

  • If you do not choose to use the default subnet on a particular EFT node, that node will simply place the IP address you put for the advanced properties key in the “IP” field. That IP address will be the one the other nodes use to try to talk to it.​

 HaErrorHandlerDrainServer 

When HaErrorHandler is recovering from an error, should it drain the server before restarting?

  • Type: DWORD

  • Default value: false

  • Cached: yes

  • Backup/restore: yes​​

 ShutdownHttpsListenerOnDrain 

 Determines if EFT should shutdown the HTTP/S server socket(s) immediately upon entering draining.

  • Type: DWORD

  • Default value:  Default value is 0 to leave HTTP/S listeners open to accommodate WTC chunking; 1 shutdowns listeners immediately,

  • Cached: Yes

  • Backup/restore: Yes