The following sections detail the changes made to Citect.ini parameters in Citect SCADA version 7.0:
New Parameters
The following parameters are new in version 7.0. For a complete list of the system parameters, refer to the Parameters help.
Alarm Parameters:
[Alarm.ClusterName.ServerName]Clusters |
Sets which clusters this Alarm Server process connects to at startup |
[Alarm.ClusterName.ServerName]CPU |
Sets the CPU that the Alarm Server process is assigned to |
[Alarm.ClusterName.ServerName]Events |
The list of events that this Alarm Server process enables |
[Alarm.ClusterName.ServerName]ShutdownCode |
Determines the Cicode function to run when Alarm Server process shuts down |
[Alarm.ClusterName.ServerName]StartupCode |
Determines the Cicode function to run when Alarm Server process starts up |
Note: The default alarm property write behavior was to write the new value to DBF/RDB. This has changed in version 7.0 onwards. Refer to the parameter
Backup Parameters:
[Backup]SaveiniFiles |
Determines whether the "Save ini files" check box is checked by default during Backup. |
Client Parameters:
[Client]Clusters |
Selects which clusters the client is connected to at startup. |
[Client]ComputerRole |
Specifies the role of the computer |
[Client]Events |
Sets the events to be enabled on the client. |
[Client]ForceClient |
Starts only the client process, and connects to a configured Citect servers using a network connection. |
[Client]FullLicense |
Specifies that a Control Client will use a full server license |
[Client]ShutdownCode |
Determines the Cicode function to run when DisplayClient component shuts down. |
[Client]StartupCode |
Determines the Cicode function to run when DisplayClient component starts up. |
[Client]WaitForConnectAtStartup |
Specifies that connection to a server will wait until it can establish a connection to the server processes before starting up. |
CtCicode Parameters:
[CtCicode]FastFormat |
Controls whether fast formatting is used in the Cicode Editor |
CtEdit Parameters:
[CtEdit]Config |
The directory where the Citect SCADA configuration files such as citect.ini are located. |
[CtEdit]Logs |
The directory where the Citect SCADA log files are located. |
Dial Parameters:
[Dial]MissedScheduleTolerance |
Specifies how many consecutive scheduled dial attempts can be missed before the cache becomes stale |
Driver Parameters:
[<DriverName>]OverriderOSProtection |
Determines whether to override the protection mechanism built-in to the I/O Server for drivers that may not be compatible with Windows Vista. |
General Parameters:
[General]Multiplexor |
Determines whether Citect SCADA runs as a multi-process or single-process application. |
IOServer Parameters:
[IOServer.ClusterName.ServerName]Clusters |
Sets the clusters that the I/O Server process will connect to at startup |
[IOServer.ClusterName.ServerName]CPU |
Sets the CPU that the I/O Server process is assigned to |
[IOServer.ClusterName.ServerName ]Events |
The list of events that this I/O Server process enables |
[IOServer.ClusterName.ServerName]ShutdownCode |
Determines the Cicode function to run when I/O Server process shuts down |
[IOServer.ClusterName.ServerName]StartupCode |
Determines the Cicode function to run when I/O Server process starts up |
Report Parameters:
[Report.ClusterName.ServerName]Clusters |
Sets the clusters this Reports Server process will connect to at startup |
[Report.ClusterName.ServerName]CPU |
Sets the CPU that this Reports Server process is assigned to |
[Report.ClusterName.ServerName]Events |
The list of events that this Reports Server process enables |
[Report.ClusterName.ServerName]ShutdownCode |
Determines the Cicode function to run when this Reports Server process shuts down |
[Report.ClusterName.ServerName]StartupCode |
Determines the Cicode function to run when this Reports Server process starts up |
Trend Parameters:
[Trend.ClusterName.ServerName]Clusters |
Sets the clusters this Trends Server process will connect to at startup |
[Trend.ClusterName.ServerName]CPU |
Sets the CPU that the Trends Server process is assigned to |
[Trend.ClusterName.ServerName]Events |
The list of events that this Trends Server process enables |
[Trend.ClusterName.ServerName]ShutdownCode |
Determines the Cicode function to run when Trends Server process shuts down |
[Trend.ClusterName.ServerName]StartupCode |
Determines the Cicode function to run when Trends Server process starts up |
Obsolete Parameters
The following parameters are no longer supported in version 7.0:
Alarm Parameters:
[Alarm]CPU |
Sets the CPU that the Alarm Server component is assigned to. Replaced with a cluster specific CPU parameter in the following format:[ServerType.ClusterName.ServerName]CPU. |
[Alarm]Name |
The name of the default Alarm Server. To retrieve the server name in your Cicode, refer to the ServiceGetList Cicode function. |
[Alarm]Primary |
Determines if this Alarm Server is the Primary Alarm Server. Information is now configured within the project via the server form. |
[Alarm]Process |
Sets the Citect SCADA process the Alarm Server component is assigned to. No longer required as each process is separate when running multi-process. |
[Alarm]Server |
Determines whether this computer is an Alarm Server. To retrieve the server enabled status in your Cicode, refer to the ProcessIsServer Cicode function. |
Client Parameters:
[Client]Display |
Sets the Citect SCADA computer as a Control Client. To retrieve the client status in your Cicode, refer to the ProcessIsClient Cicode function or the parameter [Client]ComputerRole. The computer role parameter can be set to the following: 0 = Server & Control client, 1 = Control client, 2 =View only client. |
[Client]Manager |
Sets the Citect SCADA computer as a View-only Client. To retrieve the client status in your Cicode, refer to the ProcessIsClient Cicode function or the parameter [Client]ComputerRole. The computer role parameter can be set to the following: 0 = Server & Control client, 1 = Control client, 2 =View only client. |
[Client]Primary |
The name of the primary Citect SCADA server |
[Client]Process |
Sets the Citect SCADA process the Control Client component is assigned to. No longer required as each process is separate when running multi-process. |
[Client]Standby |
The name of the standby Citect SCADA server |
[Client]Shutdown |
Determines the Cicode function to run when DisplayClient component shuts down. Replaced with [Client]ShutdownCode. |
[Client]Startup |
Determines the Cicode function to run when DisplayClient component starts up. Replaced with [Client]StartupCode. |
Code Parameters:
[Code]AlarmShutdown |
Determines the Cicode function to run when Alarm Server component shuts down. Replaced with a cluster specific code startup and shutdown parameters in the following format:[ServerType.ClusterName.ServerName]StartupCode and [ServerType.ClusterName.ServerName]ShutdownCode. |
[Code]AlarmStartup |
Determines the Cicode function to run when Alarm Server component starts up. Replaced with a cluster specific code startup and shutdown parameters in the following format:[ServerType.ClusterName.ServerName]StartupCode and [ServerType.ClusterName.ServerName]ShutdownCode. |
[Code]AutoReRead |
Controls whether the ReRead() function is automatically called |
[Code]IOServerShutdown |
Determines the Cicode function to run when I/O Server component shuts down. Replaced with a cluster specific code startup and shutdown parameters in the following format:[ServerType.ClusterName.ServerName]StartupCode and [ServerType.ClusterName.ServerName]ShutdownCode. |
[Code]IOServerStartup |
Determines the Cicode function to run when I/O Server component starts up. Replaced with a cluster specific code startup and shutdown parameters in the following format:[ServerType.ClusterName.ServerName]StartupCode and [ServerType.ClusterName.ServerName]ShutdownCode. |
[Code]Process |
Sets the process a code component is assigned to |
[Code]ReportShutdown |
Determines the Cicode function to run when Reports Server component shuts down. Replaced with a cluster specific code startup and shutdown parameters in the following format:[ServerType.ClusterName.ServerName]StartupCode and [ServerType.ClusterName.ServerName]ShutdownCode. |
[Code]ReportStartup |
Determines the Cicode function to run when Reports Server component starts up. Replaced with a cluster specific code startup and shutdown parameters in the following format:[ServerType.ClusterName.ServerName]StartupCode and [ServerType.ClusterName.ServerName]ShutdownCode. |
[Code]Shutdown |
Determines the Cicode function to run when Control Client component shuts down |
[Code]Startup |
Determines the Cicode function to run when Control Client component starts up |
[Code]TrendShutdown |
Determines the Cicode function to run when Trends Server component shuts down. Replaced with a cluster specific code startup and shutdown parameters in the following format:[ServerType.ClusterName.ServerName]StartupCode and [ServerType.ClusterName.ServerName]ShutdownCode. |
[Code]TrendStartup |
Determines the Cicode function to run when Trends Server component starts up. Replaced with a cluster specific code startup and shutdown parameters in the following format:[ServerType.ClusterName.ServerName]StartupCode and [ServerType.ClusterName.ServerName]ShutdownCode. |
DNS Parameters:
[DNS]<Server name> |
Determines the IP address (or fully qualified host name) of the primary I/O Server. Functionality replaced by the server network address configuration form and the server redirection parameters with the following format:[AddressForwarding].= |
Event Parameters:
[Event]Alarm |
The classes of events to be enabled by the Alarm Server. Replaced with a cluster specific event parameter in the following format:[ServerType.ClusterName.ServerName]Events. |
[Event]IOServer |
The classes of events to be enabled by the I/O Server. Replaced with a cluster specific event parameter in the following format:[ServerType.ClusterName.ServerName]Events. |
[Event]Name |
The classes of events assigned to the Name entry to be enabled. Has been replaced with the parameter [Client]Events. |
[Event]Report |
The classes of events to be enabled by the Reports Server. Replaced with a cluster specific event parameter in the following format:[ServerType.ClusterName.ServerName]Events. |
[Event]Trend |
The classes of events to be enabled by the Trends Server. Replaced with a cluster specific event parameter in the following format:[ServerType.ClusterName.ServerName]Events. |
General Parameters:
[General]BadOptimise |
Determines whether certain strings are replaced with labels on compile |
[General]CitectRunningCheck |
Checks if a project is currently running on the local machine when a compile is triggered |
IOServer Parameters:
[IOServer]BlockWrites |
Determines whether Citect SCADA will try to block optimize writes to I/O Devices. The IOserver will not block writes |
[IOServer]CPU |
Sets the CPU that the I/O Server component is assigned to. Replaced with a cluster specific CPU parameter in the following format:[ServerType.ClusterName.ServerName]CPU. |
[IOServer]Name |
The name of the default I/O Server. To retrieve the server name in your Cicode, refer to the ServiceGetList Cicode function. |
[IOServer]Process |
Sets the Citect SCADA process the I/O Server component is assigned to. No longer required as each process is separate when running multi-process. |
[IOServer]SaveBackup |
This parameter has been superseded by SaveNetwork |
[IOServer]Server |
Determines whether this computer is an I/O Server . To retrieve the server enabled status in your Cicode, refer to the ProcessIsServer Cicode function. |
LAN Parameters:
[LAN]Bridge |
Determines the bridge level |
[LAN]CancelOnClose |
For users with Novell NetBIOS emulator issues |
[LAN]Disable |
Enables/disables Citect SCADA from the LAN |
[LAN]GroupName |
Determines whether Citect SCADA uses the group name 'CITECT STATION50' or the computer name specified by the [Lan]Node parameter. |
[LAN]KillPiggyBackAck |
Controls whether Citect SCADA will try to optimize network protocols which support piggyback ACK |
[LAN]LanA |
Defines the protocol stack that Citect SCADA uses for NetBIOS communication |
[LAN]NetBIOS |
Enables/disables NetBIOS |
[LAN]NetTrace |
Determines whether the NetBIOS window is enabled on startup |
[LAN]NetTraceBuff |
Sets the number of trace buffers. |
[LAN]NetTraceErr |
Enables the error mode of the NetBIOS window |
[LAN]NetTraceLog |
Enables the logging mode of the NetBIOS window |
[LAN]Poll |
Puts Citect SCADA LAN communications into polled mode |
[LAN]RemoteTimeOut |
The timeout period for remote I/O Device write requests from a Control Client to the I/O Server |
[LAN]Retry |
The number of times to retry establishing communications after a timeout - before an alert message is generated |
[LAN]SendTimeOut |
The timeout to send a network packet across the network |
[LAN]SesRecBuf |
The number of receive NetBIOS Control Blocks (NCBs) that Citect SCADA uses for every session |
[LAN]SesSendBuf |
The number of send NetBIOS control blocks that Citect SCADA uses for every session |
[LAN]TimeOut |
The timeout to send a network packet across the network |
Proxi Parameters:
[Proxi]<I/O Server name> |
Defines a list of proxy server associations |
Report Parameters:
[Report]CPU |
Sets the CPU that the Report Server component is assigned to. Replaced with a cluster specific CPU parameter in the following format:[ServerType.ClusterName.ServerName]CPU. |
[Report]Name |
The name of the default Report Server. To retrieve the server name in your Cicode, refer to the ServiceGetList Cicode function. |
[Report]Primary |
Determines if this Reports Server is the Primary Reports Server. Information is now configured within the project via the server form. |
[Report]Process |
Sets the Citect SCADA process the Reports Server component is assigned to. No longer required as each process is separate when running multi-process. |
[Report]Server |
Determines whether this computer is a Reports Server . To retrieve the server enabled status in your Cicode, refer to the ProcessIsServer Cicode function. |
Server Parameters:
[Server]Name |
The name of the Citect SCADA server . To retrieve the server enabled status in your Cicode, now refer to the ProcessIsServer Cicode function. |
Trend Parameters:
[Trend]BlockByIODevice |
Verifies that I/O problems causing gaps for a trend tag do not cause gaps for every trend tag. Trend blocking is no longer required due to the new subscription architecture. |
[Trend]CPU |
Sets the CPU that the Trends Server component is assigned to. Replaced with a cluster specific CPU parameter in the following format:[ServerType.ClusterName.ServerName]CPU. |
[Trend]Name |
The name of the default Trend Server. To retrieve the server name in your Cicode, refer to the ServiceGetList Cicode function. |
[Trend]Primary |
Determines if this Trend Server is the Primary Trend Server. Information is now configured within the project via the server form. |
[Trend]Process |
Sets the Citect SCADA process the Trends Server component is assigned to. No longer required as each process is separate when running multi-process. |
[Trend]Redundancy |
Enables/disables trend redundancy action. Trend blocking is no longer required due to the new subscription architecture. |
[Trend]Server |
Determines whether this computer is a Trends Server. To retrieve the server enabled status in your Cicode, refer to the ProcessIsServer Cicode function. |
[Trend]StaggerRequestSubgroups |
Reduces network traffic by spacing out trend sample requests. Trend blocking is no longer required due to the new subscription architecture. |
Published June 2018