General settings

[general]

The general characteristics begin with this keyword.

Name	Type	Default	Range	Description
atomicDpSet	bool	0	0\|1	Setting multiple values in one dpSet operation might cause inconsistencies because certain write operations might fail while others succeed. Atomic dpSet operations verify that no write operation fails before changing any values. Therefore, no inconsistencies can arise. By enabling "atomicDpSet" in the "general" section of the config file, i.e., setting "atomicDpSet = 1", all dpSet operations for Original, Lock, and General configs are atomic, except for write operations initiated by WinCC OA drivers, which are never atomic. If atomic behavior is activated but a data point set operation includes other configs besides Original, Lock, and General, the operation is handled non-atomic. By default atomic set behavior is deactivated. Atomic behavior can be used for all data point set operations supported by WinCC OA ("dpSet", "dpSetWait", etc.). If these operations are restricted to Original, Lock, and General configs either all dpSet operations succeed or no operations are executed. In case of a failure, the return code is set accordingly and further error messages can be retrieved in the usual way.
ctrlMaxWeight	int	10000 (CTRL) or 5000 (UI, Event, ASCII, etc.)	-	The Control Interpreter cyclically processes all running scripts. The sum of the weights of the instructions processed in one cycle can be defined here. See also chapter Optimization of WinCC OA.
CtrlAdoMSBoolFormat	bool	1	0\|1	When you set the config entry "CtrlAdoMSBoolFormat = 1" in the general section of the config file, value TRUE is saved as -1 in the database and FALSE is saved as 0. With the config entry "CtrlAdoMSBoolFormat = 0", value TRUE is saved as 1 and FALSE is saved as 0.
CtrlAdoNumericalPrecision	string	""	"double" \| "int32" \| "int64"	Defines the reduced precision in which numerical values will be delivered from a database, if the database specified data type can not be stored in a standard CTRL data type (int, long, float). If this config entry is not used, numerical values might be delivered as string. This is database driver dependent. Note: Drivers that do not support fetching numerical values with low precision will ignore the precision policy. This config entry is not used under Windows.
DpCommentSeparator	char	"@"	-	Separator for the description text (description@format@unit).
defaultArchive	uint	97	>= 0	Defines which archive should be used as default. (97 = RDBManager)
parallelCtrlADO	bool	0	0\|1	Activates the parallel processing (multi-threaded) of database operations in the Control-Extension 'CtrlADO'. By default all requests to the database will be sent sequentially as parallel (thread-save) support is not guaranteed by all database systems.
metaLang	string	lang	Project languages	'locale'-string of the language in which language dependant texts will be defined. These texts will be used for automatic translation.
pmonPort	int	4999	1024 - 65535	The port for the TCP/IP communication with Pmon.
pvss_path	string	""	-	Defines the path to the directories, which includes the WinCC OA static files (such as executables, error texts, icons, etc.).
proj_path	string	""	-	Defines the path to the directory, which includes dynamic files (project-oriented files such as database).
proj_version	string	""	-	Defines the WinCC OA version with which the current project was created or last updated to.
data	string	Local host name[:4897]	-	This entry defines the host name of the Data Manager. Optionally with the port number. Host name and port number are separated by a colon. For redundant systems both data hosts are entered with a dollar sign separately. The complete syntax is: data = "host1[:port1]" or (in case of redundancy): data = "host1[:port1]$host2[:port2]" Further information on the redundancy feature in WinCC OA you will find in Redundancy, basics. or (in case of redundant network connections): data = "host11[:port1],host12[:port1]" Further information on redundant network connections in WinCC OA you will find on the page Redundant network connections. or in general: data = "host11[:port1][,host12[:port1]][$host21[:port2][,host22[:port2]]]" Instead of specifying the host name you can also use IP addresses, e.g. data = "192.168.154.26". The use of IP addresses can possibly bring undesirable effects (resolution of IP - host name when using in scripts). If there are problems with the functionality when using IP addresses, you have to use the host names! This entry replaces the config entries "dataHost" respectively "dataPort" (known from former versions) which remain for compatibility reasons.
dataHost	string	Local host name	-	The computer name of the computer on which the Data Manager (WCCILdata) was started. All programs that want to connect to the Data Manager search the Data Manager on the specified computer. Redundancy: The primary and secondary host are separated through '$'. This format of dataHost/eventHost switches on the redundancy. CAUTION: This entry should not be used anymore. For defining the host names use the "data" entry.
dataPort	int	4897	1024 - 65535	Port number of the Data Manager. CAUTION: This entry should not be used anymore. For defining the port numbers use the entry "data".
event	string	Local host name[:4998]	-	Specifies the host names and optional the port numbers of the Event Manager. The syntax of this entry is the same like the syntax of the config entry "data" (see above). This entry replaces the config entries "eventHost" resp. "eventPort" (known from former versions) which remain for compatibility reasons.
eventHost	string	Local host name	-	The computer name of the computer on which the Event Manager (WCCILevent) was started. All programs that want to connect to the Event Manager search the Event Manager on the specified computer. Redundancy: Primary and secondary host are separated through '$'. This format of dataHost/eventHost switches on the redundancy. CAUTION: This entry should not be used anymore. For defining the host names use the entry "event".
eventPort	int	4998	1024 - 65535	Port number of the Event Manager. CAUTION: This entry should not be used anymore. For defining the port numbers use the entry "event".
connectDelay	int	20	> 0	Time remaining until next attempt is made to connect to another program.
connectRetries	int	30	> 0	Number of connection attempts to another program. There is a connectDelay between the attempts.
dbg	string	""	-	With this entry debug flags for managers can be defined. This is especially useful for the PMON when it is used as Windows-Service, as you can not define commandline arguments in this case. Example: dbg = "2,16,SOME_FLAG"
dbgCount	int	100	> 1	Defines how often a debug message will be printed when a managers sends VC (Value Change) messages. Therefore the manager has to be started with the command line option '-dbg 17'. This option is implemented in the Data- and Event Manager as well as all drivers.
dbgOffset	int	1	> 0	Defines an offset for dbgCount. dbgCount = 100 and dbgOffset = 2 means that debug messages will be printed after 2, 102, 202, ... messages. Therefore the manager has to be started with the command line option '-dbg 17'. This option is implemented in the Data- and Event Manager as well as all drivers.
distributed	bool	0	0\|1	Obligatory entry for a distributed system. A distributed system requires the "distributed = 1" entry. In addition, this value may be overwritten for individual managers. [ctrl_1] distributed = 0 In this case the Control Manager with the number 1 cannot access DPs of other systems (DP identification is not transmitted to this manager).
dpFuncLoopCount	int	20	>= 20	Specifies the limit for an infinite loop (for data point functions). An infinite loop is diagnosed when a data point function receives more hotlinks (hotlinks with same time stamp)than the number specified via the dpFuncLoopCount entry. If the limit is exceeded the loop is broken. If a GREAT deal of hotlinks (e.g. many CTRL parameters) are used in a data point function the default value may be too small (define a bigger value).
DP_StatisticsPrefix	string	_Stat	-	The data points for Msg statistics have the following names: _Stat_<ManagerType>_<ManagerNo>_to_<ManagerType> _<ManagerNo>. To obtain an explicit name for each node in case of redundancy, you can change the prefix _Stat. e.g. _Stat_2
DP_UserName	string	"_Users.UserName"	-	Data point element that contains all user names defined in WinCC OA in a dyn_string. All user arrays must have the same length and all the same indexes define the same user. Examples for this are: user 0 = Username[0], UserId[0], Password[0], ... user 1 =Username[1], UserId[1], Password [1],
DP_UserId	string	"_Users.UserId"	-	Data point element that contains all the User IDs defined in WinCC OA in a dyn_uint.
DP_UserPermissions	string	"_Users.Permissions"	-	Data point element that contains all the user permission strings defined in WinCC OA in a dyn_string. The interpretation of this string is up to the user.
DP_UserPermSet	string	"_Users.PermissionSet"	-	Data point element which holds all permission bits for a user. The interpretation of these bits is up to the user.
DP_UserPassword	string	"_Users.Password"	-	Data point element that contains all the user passwords defined in WinCC OA in a dyn_string. Passwords are saved encrypted (see crypt()).
DP_UserForceSet	string	"_Users.ForceSet"	-	Data point element which holds all permission bits which are independent of the operator station.
dpGetDescriptionMode	int	1	-2 - 3	Controls the mode of operation of dpGetDescription(). For detailed information see the specific chapter of this CTRL function.
keepAckColorOnMultipleAck	bool	0	0\|1	The color used for acknowledged pending alarms is shown also when the alarm is not pending anymore (=1). A CAME alarm is always shown in the color of "CAME acknowledged". The color is used for all acknowledgement types and regardless of whether the CAME or WENT alarms or both were acknowledged. Can be used for open and closed modes of the alert screen.
logStdErr	bool	0	0\|1	Directs the output of the error messages to the terminal window. 1...ON, 0...OFF
logFile	bool	1	0\|1	Directs the output of the error messages to a file. In the directory "log" of the project path each manager has such a file. 1...ON, 0...OFF.
lowestAutoManNum	uint	1	1 - 255	This value specifies a manager number limit for the Data Manager. The Data Manager may assign numbers freely beginning from this manager number. The Data Manager assigns the Manager numbers self when UI, ASCII, CTRL, OPC Srv, OLE DB, COM and API Manager were started without -num argument resp. with "-num 0". The entry is evaluated only by the Data Manager. The default value is 7 in case of redundant projects.
lowestAutoManNumUI	uint	7 (in redundant projects), 1 (in all other projects)	1 - 255	The entry "lowestAutoManNumUI" gives the lowest manager number for the UI manager. The entry "lowestAutoManNum" in the config file sets also "lowestAutoManNumUI". Thus, if you want to set both values separately "lowestAutoManNum" has to be specified before "lowestAutoManNumUI" in the config file. The default for the "lowestAutoManNum" is 1. The default for "lowestAutoManNumUI" is 7 in redundant projects. In other projects it is also 1.
ctrlMaxPendings	int	200	> 0	If a work function (e.g. of a dpConnect) is not yet completed and this event occurs again, the system waits until the first occurrence has been processed. If the frequency of the events is higher than can be processed, the queue of pending events and with it the memory consumption of the CTRL Manager or UI Manager keeps on growing. To prevent this, the CTRL discard all pending runs after ctrlMaxPendings and an error message is issued. This entry can also be used in the sections of single managers: [ui_5] ctrlMaxPendings = 120
ctrlMaxBlockedPendings	int	3000	> 0	Defines how many pending runs (unprocesses hotlinks) may be pending for a blocked query. Every row in all hotlinks is counted, not only the number of hotlinks. For unblocked queries the upper limit is defined with ctrlMaxPendings.
ignoreManager	string int	""	-	A driver ignores the hotlinks of a value change from certain managers. The manager name and numbers identifies each manager. The name corresponds to the section keyword without the brackets: e.g. "ctrl", or "ascii" for the ASCII Manager. Exceptions: All drivers are identified as "driver", all API as "api" and all device managers (Pager, SCA-RS) as "device". Example: [pr] ignoreManager = "ascii" 1
ip_allow	string	""	-	see entries for different sections - ip_allow.
ip_deny	string	""	-	see entries for different sections - ip_deny.
ignoreDebug	bool	0	0\|1	Set "ignoreDebug = 1" in config file under [general], [ctrl], [ui] or [event] to suppress "DebugN()" entries in scripts for the defined Managers. Without entry in config file all DebugN()´s are given.
independentAlertAck	bool	0	0\|1	Defines whether alarms can be acknowledged independent of each other (default = no). If this entry is set to 1, alarms can be acknowledged in the AEScreen without the consideration of a sequence (younger before older alarms, WENT before CAME).
lang	string	First 'langs' entry	Project languages	'locale' string of the language which shall be used as the active language. Multilingual texts will be displayed in this language in the user interface.
langs	string	""	Project languages	'locale' string(s) of the languages which shall be used in the WinCC OA project. Multiple entries of "langs" represent a list of all languages that can be used. The language entries must be unique. Caution The entries must not be modified after the initial database creation. Example Following some examples for langs entries, which can be found inside the config file: langs = "de_AT.iso88591" langs = "en_US.iso88591" langs = "hu_HU.iso88592"
maxLogFileSize	uint	0	>= 0	Specifies the maximum size of the file <proj_path>/log/PVSS_II.log in MB (0 = unlimited). All managers and drivers evaluate this entry (for their own log files). If the file exceeds this size, it is renamed to PVSS_II.log.bak and a new file is created. An existing PVSS_II.log.bak file will be overwritten. Under Windows the script postLogFileHandler.cmd resp. and under Linux the script postLogFileHandler.sh are called. The size of the log file is checked every 30 seconds (the size of the file might be, however, higher depending on the system load and the speed the data is written to the log file).
maxConnectMessageSize	uint	100	>= 0	Defines the maximum number of data points for each dpConnect. A value of 0 indicates, that no limitation will be used.
messageCompression	string	"none"	"none", "zlib", "bzip2", "zlib-bzip2"	Use this config entry to specify the compression scheme. The config entry may contain the following schemes: "none" - no compression "zlib" - compression using zlib (gzip, zip); see http://www.zlib.org "bzip2" - compression by using the bzip2 algorithm (bzip2 is a freely available, high-quality data compressor; see http://www.bzip.org). "bzip2" compresses better than "zlib" at the cost of higher CPU utilization. "zlib-bzip2" - compresses short messages using zlib and bigger messages like Identification using bzip2. You can use the config entry in all config file sections. You can specify several schemes, for example, messageCompression = "zlib-bzip2,zlib". The client and the server agree on the first common scheme. Therefore, if you configure "zlib" on the client and "bzip,zlib" on the server, the "zlib" scheme is used. The default value is "none" and if you want to use compressed messages we recommend to use "zlib-bzip2".
messageDiagSecs	uint	30	0 - MAX_UINT	The entry 0 switches the message statistics and the config statistics off. Any other value specifies the interval (in seconds) for writing the statistics to the _Stat data points. An entry < 0 is overwritten by the value of the data point _Stat_Message.SecsToRefresh:_original.._value.
microsoftStyle	bool	1	0\|1	This entry lets the user adjust the height of the arrows to the height of the text array for the spin button and combobox. If you enter microsoftStyle=0, WinCC OA uses the Motif look and previous display type.
password	string	""	-	Password for the defined user in the config entry "userName".
saveLastValueBit	uint	0	0-32	With this entry you avoid the saving of the last value for data point elements, which have set a userbit (1-32). No archiving is executed, even if the data points have configured an _archive config. If the value is 0 (default), the last values of all data points will be saved.
statFctActivate	bool	1	0\|1	This entry deactivates the execution of statistical functions in the Event Manager, when indicated. When accessing the statistical functions the first time, a corresponding warning will be printed (just) once. This can be used for testing purposes, in case that the Event Manager needs to much time during the start and it is not clear where it has been spent - so the statistical functions (which may consume a lot of time) can be deactivated. Although this entry is defined in the [general] section, it affects only the Event Manager (this has a historical matter).
statFctInheritCorrValues	bool	1	0\|1	You can set the behavior of statistical functions in the config file. The config entry statFctInheritCorrValues decides whether the correction values should be accepted. By default, the correction value changes are accepted. If 0, changes are not accepted, the statistical functions work as usual.
statFctLimitForMarkAsCorrected	int	0	0 - 1000	The config entry statFctLimitForMarkAsCorrected (condition: statFctInheritCorrValue = 1) specifies the threshold for the accepted correction values. If 0, all values are marked as corrected. Values greater than 0 only mark values as of a change greater than x %.
statFctMaxIntervalsInPast	uint	3	0 - MAX_UINT	If more periods than defined via this config entry are not calculated (for a statistical function) in the past yet these periods are discarded and a message is shown. Default value is 3. This means 3 periods are considered (interval beginning from the end of the interval until the current time). Beginning from a delay of 3 intervals (regardless of a possible delay time of the statistical functions) all older intervals are discarded and a message is shown.
translateConfig	string	'' '\|'	-	Defines the filename of the translation table and the delimiter character for automatic translation. The translation table must be located in the 'config' directory. The columns must be separated by the defined delimiter character. Syntax: translateConfig = <filename> <delimiter>
useValueArchive	bool	1	0\|1	Whether the Data Manager works with the RAIMA database as up to now or with the History DB when archiving data is controlled by an entry in the Config file in the [general] section. If you set the value = 0, the former database (RAIMA) is used to save the values history. Value 1 (default): By default, the new History DB is used to save the values history. (Alarms and last values are still saved in the former database [RAIMA]).
userName	string	""	-	The user name all managers use when they start. If $USER is used, it is replaced by the current OS user. This means that the manager is started with the current OS user as WinCC OA user. You can also use the manager option -user $user e.g. WCCOActrl -user $user.
useRDBArchive	bool	0	0\|1	0 = RDB Archive Manager not functional. 1 = RDB Archive Manager activated (RDB write/read).
useRDBGroups	bool	0	0\|1	Defines whether archive groups can be used (= 1) or not (= 0).
valueChangeTimeDiff	uint	30	>= 0	If the original value is changed, the Event Manager checks if the provided source time is more than valueChangeTimeDiff seconds in the future. In this case the system adjusts the source time to the current time and additionally sets the status bit invalid source time (_original.._stime_inv). Thereby, the system also sets the invalid bit. Redundancy: When a manager starts, it determines the time difference between its own computer and the computer of the server. If the system times differ for more than "valueChangeTimeDiff/2" seconds, the manager shows an error message. If the system times differ for more than "valueChangeTimeDiff" seconds, the manager closes the connection and shows an error message. If the valueChangeTimeDiff entry is set in the [event] section in older projects, the system shows an error message. The permitted time difference is 30 seconds. Caution: If a difference between the system times arises during the operation, the system does not check the difference. Caution: When changing valueChangeTimeDiff it is necessary to check the validTimeDiff value. valueChangeTimeDiff must be less or equal to validTimeDiff! Note Remote UIs are using a automatic adjusting independent of the valueChangeTimeDiff value, see Synchronisation Client-Server.
reportFile	string	""	-	Defines the file to write the output of "-report ..." to. The file will be created in the log directory of the project. The placeholder $MAN$, $DATE$, and $TIME$ will be replaced by manager name and number, current date in the format YYYYMMDD and current time in the format HHMMSS, resp. Special names are "stderr" for output to stderr and "stdout" for output to "stdout". Default is to write to stderr.
coverageReportFile	string	""	-	With this config entry an individual file name can be defined for the coverage report. If this entry is empty, the standard reportFile is used. The file will be created in the log directory of the project. The placeholder $MAN$, $DATE$, and $TIME$ will be replaced by manager name and number, current date in the format YYYYMMDD and current time in the format HHMMSS, resp. Special names are "stderr" for output to stderr and "stdout" for output to "stdout". Default is the same file as all other output from "-report ...".
allowPeriphOnDpId	string	"no"	"yes", "no"	With this config entry it's possible to configure peripheral addresses on data point elements of the type DPID, DPIDARRAY, DYNDPID. This option is disabled by default.
chainPrefix	string	""	""	The default verification checks only if there is a trusted root certificate. This config entry allows to extend the verification to check against a specific chain prefix. Example: IOWARootCA is a valid root certificate. The entry chainPrefix = "IOWARootCA;IOWA Sign CA" extends the verification. Therefore, the certificate chain "IOWARootCA;IOWA Sign CA;IOWA-Service1" will be accepted, whereas "IOWARootCA;IOWA-Service2" will be rejected, even though the root certificate is the same.
cipherSuiteList	string	"AES256-SHA"	"AES256-SHA", "DHE-RSA-AES256-SHA256", "DHE-RSA-AES256-GCM-SHA384", "DHE-DSS-AES256-GCM-SHA384", "ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-RSA-AES256-GCM-SHA384"	The cipher suite AES256-SHA is used by default. With this config entry it's possible to choose from the cipher suites listed below. These cipher suites are approved, using another one is considered as a configuration error. AES256-SHA DHE-RSA-AES256-SHA256 DHE-RSA-AES256-GCM-SHA384 DHE-DSS-AES256-GCM-SHA384 ECDHE-ECDSA-AES256-GCM-SHA384 ECDHE-RSA-AES256-GCM-SHA384 Syntax: cipherSuiteList = "<cipherSuite0>, <cipherSuite1>,...,<cipherSuiteN>"

V 3.11 SP1