Customizing the Synchronization Process with SCADASync.ini

Section

Key

Description

[SyncManager]

EnableSIMFailureButtons

Specifies whether you allow a user to simulate a communication failure for the corresponding transport.

If the value is 1, buttons are enabled on the SCADA Sync Monitor Transport page and users are allowed to simulate a communication failure for the corresponding transport. A value of 1 is recommended only in a test environment.

If the value is 0 (the default), this simulation cannot occur.

Valid Entries: 0 or 1. The default value is 0.

EnablePDBSyncButtons

Specifies whether the Maintenance Mode button is available on the PDB Synchronization Information page of the SCADA Sync Monitor.

If the value is 1, the Enable/Disable Maintenance Mode button is available on the primary node.

If the value is 0, the Enable/Disable Maintenance Mode button is unavailable.

Valid Entries: 0 or 1. The default value is 1.

MMSyncAlarmAcks

Enables or disables Maintenance Mode alarm acknowledgement synchronization.

Valid Entries:

 0 = Disable

 1 = Enable (default)

NOTES:

• Absence of the parameter or setting the parameter to a non-zero value, enables the feature.  
• This key is ignored on the secondary node.

MMSyncSimRegs

Enables or disables Maintenance Mode simulation register synchronization.

Valid Entries:

 0 = Disable

 1 = Enable (default)

NOTES:

• Absence of the parameter or setting the parameter to a non-zero value, enables the feature.  
• This key is ignored on the secondary node.

MMSyncTimeout

Enables, disables, or sets the timeout period for the simulation register synchronization. This key governs how long to wait for the simulation register synchronization to complete.

When disabled, the primary SCADA node waits indefinitely and will not exit Maintenance Mode until simulation register synchronization is completed.

Valid Entries:

 0 = Disable

 n = 1 to 300 seconds (default=10 seconds)

NOTES:

• Absence of the parameter results in the default value.
• This key is ignored on the secondary node.

TimeSyncRateMilliSeconds

Represents the delay, in milliseconds, between each database synchronization. By default, synchronization occurs as fast as possible, but you can delay the synchronization using this setting.

NOTE: By default, this key does not appear within the INI file. You need to add it manually.

IMPORTANT: Use extreme caution when enabling this setting. For example, with a RAMP block, if a data change occurs during this delay, your data may not be accurate when the synchronization occurs. You should not change this setting if you do not have knowledge of the types of data that your pictures reference.

[ScadaRoleMgr]

ClientConnectionsCheckInterval

The interval, in seconds, for the active SCADA node to verify that the iClients are pointing to the correct node.

The lower you set the time for the interval, the more you increase the network traffic.

This parameter should be set to 0 (disabled) on most SCADA nodes. It is only used on SCADA nodes that communicate with older iClients, which require dynamic connections to "pull" clients to the active SCADA node.

Valid Entries: 10 – 600. The default value is 0 (disabled).

DelayAutomaticAfterManualSwitch

The number of seconds that the SCADA Role Manager waits before it makes any active or standby decisions, after a manual switch.

Valid Entries: 2 – 60. The default value is 5.

[FileSync0]

FIXDIR

The iFIX directory that you want synchronized. iFIX 5.1 only supports the PDBPATH directory.

Valid Entries: PDBPATH

Inclusion

The list of files or a specified filter (each item in this list is separated by a semi-colon (;) mark) to send to the standby node when the file(s) change.

Default Value: “*.*”

Exclusion

The list of files or a specified filter (each item in this list is separated by a semi-colon (;) mark) to be excluded from the file synchronization. iFIX 5.1 only supports: "*.TMP;*.EVS;~*.*;*.foo"

Valid Entries: "*.TMP;*.EVS;~*.*;*.foo"

IdleTime

The number of milliseconds that a PDB file remains unchanged before it is sent from the active to the standby node after a failover occurs. The default value is 5000 milliseconds (5 seconds).

Default Value: 5000

Recursive

Specifies if the synchronization process should monitor sub-directories.

If the value is 0, sub-directories not monitored. In iFIX 5.1, only 0 is supported.

Valid Entries: 0 or 1. The default value is 0, and should not be changed.

[LogFile]

DebugLevel

Specifies whether debugging messages, shown in the Debug Log of the SCADA Sync Monitor, are sent to the SCADASync.log file.  

• When the value is 0, no debugging messages are sent to the log file.  
• When the value is 255, all debugging messages are sent to the log file.  

Valid Entries:  0 or 255.  The default value is 0.  

NOTE: Use this option carefully as there are many debugging messages.  The log file can become very large and fill up the SCADA's hard drive.

DeleteOnStartup

Specifies whether the log file is deleted on startup or if messages are added to the existing log when iFIX starts.

• If the value is 1, the existing SCADASync.log is deleted when iFIX starts.
• If the value is 0, new messages are appended to the existing SCADASync.log when iFIX starts.

Valid Entries: 0 or 1. The default value is 1.

NOTE: Use this option carefully as this file can become very large and may fill up the SCADA's hard drive.