[general]
Global settings valid for all managers
[general] accessControlPlugin
- Type
- string
[general] activateAlertFiltering
- Type
- bool
- Default
- 1
- Range
- 0|1
[general] alertPermissionsCompatibilityMode
- Type
- bool
- Default
- 1
- Range
- 0|1
[general] atomicDpSet
- Type
- bool
- Default
- 0
- Range
- 0|1
[general] authCheckPasswordExpired
- Type
- bool
- Default
- 1
When this config entry is 1 (true), the linux PAM account validation will report errors as errors and therefore fail the verifyOSUser() call.
When this config entry is 0 (false), the account validation will report any error in validation, for example an expired password only as a warning in the log, but the verifyOSUser() call will succeed.
This config entry is only used for Linux configurations. Windows based configurations will not be effected.
[general] authclientid
- Type
- string
- Default
- winccoa
This configuration entry defines the client application name used when connecting to the Identity Provider (IdP).
If this entry is not defined, the default value is winccoa.
[general] authendpoint
- Type
- string
- Default
- https://<HOSTNAME>:<default port>/.well-known/openid-configuration;config/root-cert.pem
Multiple authendpoint entries can be defined in a project. Each entry specifies the .well-known endpoint of an Identity Provider (IdP). This endpoint serves as the main entry point for all WinCC OA communications with the IdP.
Each authendpoint can optionally define a trusted Certificate Authority (CA) file by appending a path after a semicolon (;):
authendpoint = "https://...;config/trustedca.pem"The part after the semicolon specifies the trusted CA that should be used exclusively for verifying TLS connections to this Identity Provider. If no CA file is provided, the system-wide default trust store is used.
WinCC OA provides its own OIDC provider. If this provider is not explicitly defined using this configuration entry, it will be automatically appended as the last item:
https://<event-hostname>:8001/realms/<authRealm>/.well-known/openid-configuration[general] authOIDCProviderPort
- Type
- int
- Default
- 3000
Specifies the port where the OIDC service listens.
[general] authOIDCProviderUrl
- Type
- string
- Default
- https://<HOSTNAME>:<default port>
The base URL of the OIDC provider.
In a redundant project, the default values are taken from the EVENT manager connection string.
[general] authOIDCsslCertificate
- Type
- string
- Default
- config/certificate.pem config/privkey.pem config/root-cert.pem
The config entry defines the relative path within your project directory to the certificates that should be used to establish a secure connection via HTTPS.
[general] authRealm
- Type
- string
This configuration entry defines the realm used by the Identity Provider (IdP).
If this entry is not defined, the project name is used as the realm.
[general] authredirecthost
- Type
- string
After successful authentication at the identity provider, the client (Desktop UI, Mobile UI, Dashboard) is redirected to the HTTP server that received the original request initiating the login procedure.
If the client accesses the HTTP server using a different address and/or port than the server itself (for example, when the HTTP server is behind a reverse proxy), this external address and port must be configured using authredirecthost. If no value is specified, the HTTP server's own hostname and port are used.
[general] authType
- Type
- string
This configuration entry defines the authentication type used in the project.
Possible values are:
- legacy
- serverside
- oidc
If this entry is not defined:
- The legacy type is used internally if no accessControlPlugin is configured in the project.
- The serverside type is used if an accessControlPlugin is configured.
The value oidc must be used for projects that target OIDC Authentication.
[general] autoRemoveOrphanedData
- Type
- bool
- Default
- 1
- Range
- 0|1
Automatically removes orphaned data from the SQLite database during the project startup. E.g.
- Deletes a data point if its type does not exist
- Deletes a config if its data point element does not exist
- Deletes a last value if its data point element does not exist
If this feature is disabled, any orphaned data found will be reported as WARNINGs, and you have to clean up the orphaned data manually.
[general] bcmBufferLimitTimeout
- Type
- unsigned
- Default
- 60
- Range
- >=20
[general] cnsUseDoubleAsterisk
- Type
- bool
- Default
- 1
This config entry influences the behaviour of the CNS functions (cnsGetNodesByName() and cnsGetIdSet()) that use pattern matching.
If the value of this config entry is "1", then the wildcard '*' cannot represent any characters and multiple characters in the CNS identification, except '.' and ':'.
The wildcard '**' cannot represent any character and several characters including '.' and ':', and is therefore suitable for pattern matching across several CNS levels.
If the config entry is "0", then '*' and '**' have the same behaviour. Both can then represent all characters, including '.' and ':'.
[general] CtrlAdoMSBoolFormat
- Type
- bool
- Default
- 1
- Range
- 0|1
[general] CtrlAdoNumericalPrecision
- Type
- string
- Range
- double|int32|int64
Note: Drivers that don't support fetching numerical values with low precision will ignore the precision policy.
This config entry is not used under Windows.
[general] ctrlAllowedFeatures
- Type
- string
[general] ctrlMaxBlockedPendings
- Type
- integer
- Default
- 3000
- Range
- >0
[general] ctrlMaxPendings
- Type
- int
- Default
- 200
- Range
- > 0
[ui_5]
ctrlMaxPendings = 120
[general] ctrlMaxWeight
- Type
- integer
- Default
- 10000 (CTRL) bzw. 5000 (UI, Event, ASCII, etc.)
[general] defaultArchive
- Type
- uint
- Default
- 97
- Range
- >=0
[general] discreteImpulseAlertWithoutWent
- Type
- bool
- Default
- 0
- Range
- 0|1
[general] displayName
- Type
- string
[general] dnsLookupTimeout
- Type
- 32bit unsigned integer
- Default
- 2500 milliseconds
- Range
- milliseconds
Use the config entry dnsLookupTimeout to define the maximum DNS lookup timeout. DNS resolution is now performed in an asynchronous time-limited lambda function, which can be configured to be shorter than the default DNS timeout value (30 seconds).
The default value for the DNS timeout is 2500 milliseconds and can be configured via ([general] dnsLookupTimeout). If the timeout is exceeded, DNS resolution will fail.
If the DNS resolution takes longer than 500ms, a warning is issued. This warning can be deactivated by using the config entry [general] suppressDnsLookupWarnings = 1.
NOTE: Do not use values below 100 or above 30000 if you are not familiar with the DNS lookup functionality.
[general] DP_StatisticsPrefix
- Type
- string
- Default
- _Stat
- Range
- -
[general] DP_UserForceSet
- Type
- string
- Default
- _Users.ForceSet
- Range
- -
[general] DP_UserId
- Type
- uint
- Default
- _Users.UserId
- Range
- -
[general] DP_UserName
- Type
- string
- Default
- _Users.UserName
- Range
- -
[general] DP_UserPassword
- Type
- string
- Default
- _Users.Password
- Range
- -
[general] DP_UserPermissions
- Type
- string
- Default
- _Users.Permissions
- Range
- -
[general] DP_UserPermSet
- Type
- string
- Default
- _Users.PermissionSet
- Range
- -
[general] DpCommentSeparator
- Type
- char
- Default
- @
[general] dpFuncLoopCount
- Type
- int
- Default
- 20
- Range
- >=20
[general] dpGetDescriptionMode
- Type
- int
- Default
- 1
- Range
- -2 ... 3
[general] externErrHdl
- Type
- string
WinCC OA uses an internal error handler that is also used to write logs for each manager.
By using this config entry an external error handler plugin can be defined that should be loaded in addition to the internal WinCC OA error handler.
For this config entry the name of the plugin library must be stated, which needs to be located within the bin/ folder of the WinCC OA installation directory.
How to write an external error handler is described in the API chapter.
[general] keepAckColorOnMultipleAck
- Type
- bool
- Default
- 0
- Range
- 0|1
[general] kerberosRootGroup
- Type
- string
- Range
- PVSSRoot or any valid domain group, Default: PVSSRoot
[general] lang
- Type
- string
- Default
- first 'langs' entry
- Range
- one of project languages
- You can also use the option "auto" to set the WinCC OA user interface automatically to the users display language.
- Users display language on Windows: Control panel -> Region and Language -> Display language
- Note that the language that is set via the "lang" entry must be a project language. You cannot set a language for the UI if the language was not selected as a project language when creating a project.
[general] langs
- Type
- string
- Range
- project languages
Example:
langs = "de_AT.utf8"
langs = "en_US.utf8"
langs = "hu_HU.utf8"
[general] limitCryptVersion
- Type
- int
- Default
- 4
- Range
- 0|3|4
- 0 means, that there is no limitation, all versions, including v4 are allowed.
- 3 limits to version 3 (as in 3.19 and older versions).
- 4 allows version 4 as well.
The crypt() function will automatically downgrade to the maximum permitted version. So if limitCryptVersion=3, then crypt("pwd", 4) generates the same hash format as crypt("pwd", 3).
Over the years, the requirements for password hash functions have evolved. The value 4 for limitCryptVersion is the standard and must be used to ensure modern password hash algorithms and the highest level of security.
Reducing this value is only permitted in exceptional cases, for example for compatibility reasons with older WinCC OA versions. In environments with high or particularly strict security requirements, the value must not be reduced.
[general] lowestAutoManNum
- Type
- unsigned integer
- Default
- 1 | 7
- Range
- 1-255
[general] lowestAutoManNumUI
- Type
- unsigned
- Default
- 1 | 7
- Range
- 1-255
[general] maxBcmBufferSize
- Type
- unsigned integer
- Default
- 10000
- Range
- >1000
[general] maxConnectMessageSize
- Type
- unsigned integer
- Default
- 100
- Range
- >=0
[general] messageDiagSec
- Type
- unsigned integer
- Default
- 30
- Range
- 0 - MAX_UINT
[general] mpMatchWholeWord
- Type
- bool
- Default
- 0
- Range
- 0|1
The config entry replaces master datapoint references in alert patterns - see chapter Included alarms.
When the value of the config entry is set to 1, the master datapoint references are replaced only when an exact match of the word is found.
When the value of the config entry is set to 0, the master datapoint references are replaced also when a pattern is found.
[general] msaServicePayloadEncryptionMode
- Type
- int
- Default
- 0
- Range
- 0-2
This entry defines payload encryption modes for a service:
- Payload encryption is disabled = 0,
- Payload encryption is enabled, but its use is optional= 1,
- Payload encryption is enabled and its use is mandatory = 2.
[general] panelAndScriptCipher
- Type
- string
- Default
- AES_256_CBC__HMAC_SHA_3_256__PBKDF2_SHA_3_256__20000
The panelAndScriptCipher parameter is an optional encryption configuration entry used for encrypting and decrypting panels and scripts in the WinCC OA system.
By default, an iteration count of 20,000 is chosen to balance performance and security, following the latest standards and recommendations.
This configuration can be explicitly changed by providing the same string parameter as used in the encypt() function for configuration.
[general] parallelCtrlADO
- Type
- bool
- Default
- 0
- Range
- 0|1
[general] paramLang
- Type
- string
- Default
- first 'langs' entry
- Range
- one of project languages
[general] password
- Type
- string
[general] pathTraversalRestricted
- Type
- bool
- Default
- 0
- Range
- 0|1
When set to 1, this config entry restricts the loading of panels and scripts to files located within the project directory hierarchy (project, sub-project, or installation directories).
When set to 0 (default), no path restriction is enforced and panels and scripts may be loaded from any path accessible to the operating system. This preserves the behaviour of versions prior to the introduction of this entry.
Security recommendation: Set this entry to 1 in all production projects to prevent path-traversal attacks that could load manipulated panels or scripts from outside the intended project directories, bypassing ACL settings.
[general] pmonPort
- Type
- integer
- Default
- 4999
- Range
- 1024-65535
[general] proj_path
- Type
- string
[general] proj_version
- Type
- string
[general] pvss_path
- Type
- string
[general] refuseCNS
- Type
- bool
- Default
- 0
- Range
- 0|1
Specifies if a manager shall hold CNS data of the identification in memory. CNS data is still tranferred with the identification but the manager discards this data if the config entry is activated.
Please note, that this setting uses a different default value for the sections [event] and [valarch]
[general] saveLastValueBit
- Type
- unsigned
- Default
- 0
- Range
- 1-32, 0 = off
[general] serverSideAuthentication
- Type
- bool
- Default
- 0
- Range
- 0|1
[general] statFctActivate
- Type
- bool
- Default
- 1
- Range
- 0|1
If this entry is set to 0, a dp_fct or stat_func config cannot be activated via a script.
[general] statFctInheritCorrValues
- Type
- bool
- Default
- 1
- Range
- 0|1
[general] statFctLimitForMarkAsCorrected
- Type
- integer
- Default
- 0
- Range
- 0 - 1000
[general] statFctMaxIntervalsInPast
- Type
- unsigned integer
- Default
- 3
- Range
- 0 - MAX_UINT
[general] statFuncMinInitTimeRange
- Type
- int
- Default
- 0
- Range
- minimum 0
For historical initialization of statistical functions a dpGetPeriod with bonus 1 is needed. This dpGetPeriod with bonus 1 may cause performance issues in large projects using the NGA.
When setting this config entry to a value other than 0, instead of executing a query by using bonus 1, the time period of the dpGetPeriod is extended into the past and into the future by the period used to calculate the statistical function. In the event that no bonus value can be determined with this procedure, a query is run again with bonus 1 to ensure correct functionality. The calculation period for a statistical function is configured in the PARA module -> config dp_fct -> Synchronization tab -> calc.time interval.
If this period is less than statFuncMinInitTimeRange, the range is increased by statFuncMinInitTimeRange instead. With the default value 0 the standard behavior with bonus 1 is performed.
[general] suppressDnsLookupWarnings
- Type
- bool
- Default
- 0
- Range
- 0|1
If the DNS resolution takes longer than 500ms, a warning is issued. For DNS resolution, see the config entry [general] dnsLookupTimeout. This warning can be deactivated by setting the config entry [general] suppressDnsLookupWarnings = 1.
[general] tlsHandshakeTimeout
- Type
- uint
- Default
- 5000 msecs
- Range
- 250-5000 msecs
This config entry defines the timeout duration for the TLS handshake negotiation on a secure socket.
We recommend a minimum of 250 msecs, but bear in mind that this may vary depending on network performance.
Higher values (tens of seconds) basically disable DoS mitigation.
[general] translateConfig
- Type
- string
- Default
- '' '|'
Syntax:
translateConfig = <filename> <delimiter>
[general] translationFile
- Type
- string
- Default
- [automatic]
[general] translationSourceLang
- Type
- string
- Default
- [automatic]
- Range
- any known language
[general] useCMContainerSerialNumber
- Type
- string
- Default
- 0-0
- Range
- Serial number
Example:
[general]useCMContainerSerialNumber = "3-4736110"
[general] useCMLicense
- Type
- bool
- Default
- 1
- Range
- 0|1
[general] useCommonCryptography
- Type
- bool
- Default
- 1
- Range
- 0|1
The config entry for activating or deactivating the modern Common Cryptography Library (CCL). By default, the status is set to TRUE, which means that the CCL is used. If the status is set to FALSE, the legacy cryptography functionality is used.
[general] useDbAsIso
- Type
- bool
- Default
- 0
- Range
- 0|1
This new regulation influences the upgrade procedure of existing projects.
The following projects can be converted automatically:
- Monolingual projects and
- Multilingual projects if all project languages belong to the same ISO character set (e.g. iso8859-1).
The config entry useDbAsIso is being used when converting an ISO project to an utf8 project. The config entry useDbAsIso = 1 is set in the config file.
[general] useNGA
- Type
- bool
- Default
- 0
- Range
- 0|1
NOTE: Converting an existing project to NGA is currently not recommended.
[general] useNGADirectRead
- Type
- bool
- Default
- 0
- Range
- 0|1
[general] useRDBArchive
- Type
- bool
- Default
- 0
- Range
- 0|1
- 0 = RDB Archive Manager not functional.
- 1 = RDB Archive Manager activated (RDB write/read).
[general] useRDBGroups
- Type
- bool
- Default
- 1 if RDB is configured
- Range
- 0|1
[general] userName
- Type
- string
[general] useSQLite
- Type
- bool
- Default
- 1
- Range
- Not applicable (value depends on project type)
To use an SQLite project, use the configuration entry "useSQLite = 1". This config entry is created automatically when the SQLite® project is selected during project creation.
Use the config entry otherwise only if you are migrating manually from RAIMA to SQLite® (Manual Migration of RAIMA → SQLite®).
[general] useValueArchive
- Type
- bool
- Default
- 1
- Range
- 0|1
[general] useWindowsNTLM
- Type
- bool
- Default
- 0
- Range
- 0|1
Specifies if the Windows NTLM functionality should be used.
The default is "0" to disable the NTLM support in Windows. As long as NTLM is not completely disabled in the Domain Controller, it can be used for authentication. As such, its use can be activated and deactivated with this config entry.
