[opcae]

Settings for the OPC A&E Client

[opcae] addTimeToComment

Type
int
Default
1
Range
0 - 2
Due to the correction of timestamps in the client the original server timestamp can be appended to the alert comment. The config entry specifies the adding mode: 0 => The time will not be added to the comment 1 => The time will only be added if a timestamp correction has been performed 2 => Time will always be added to the comment

[opcae] alertClassPrefix

Type
char
Prefix of alert classes. If you set the config entry twoStateConditionsOnly to "yes", the client and server enable the automatic adaptation of alert classes. The alert classes have to be structured as follows: 

alertClassPrefix_AE_<Priority>
Priority is a number from 1 to 1000.

[opcae] alwaysWriteComment

Type
bool
Default
0
Range
0|1
This config entry defines if the AE client forces the writing of comment, though the timestamp check in the client fails. This is necessary, if timestamps are not reliable and therefore the event manager executes timestamp corrections. 0 => Do not force comments 1 => Force comments

[opcae] browseOnStart

Type
bool
Default
0
Range
0|1
By default the transfer of all current server data (Event Categories, Conditions, Server Items) during client start is deactivated. This prevents that erroneous data from the server are automatically adopted by the client during connection establishment. With this config entry the transfer at start-up can be activated (browseOnStart = 1). The transfer can also be triggered manually at any time using the "Update" button in the client parameterization panel.

[opcae] correctFutureTimes

Type
bool
Default
0
Range
0|1
Defines if future times shall be corrected or not. 0 => Do not correct the time 1 => Do correct the time

[opcae] reduPostfix

Type
char
Is not used.

[opcae] refreshDelay

Type
int
Default
-1
Range
>=-1
The AE client executes a refresh if the server state changes to RUNNING or TEST. For this refresh a delay in seconds can be specified. The default is -1 which means that there is no automatic refresh on state change.

[opcae] refreshMessage

Type
string
Range
-
The AE client executes a refresh if server indicates that refresh is needed using the event message specified with this config entry. e.g. refreshMessage = "I need refresh" Per default this entry is empty, which means that the client does not execute a refresh depending on simple event messages.

[opcae] server

Type
string
Defines the datapoint for the A&E server. Several this kind of entries can exist for the OPC A&E client of WinCC OA since the client can process alerts/events of several OPC A&E servers.

[opcae] sourceSeparator

Type
char
Default
.
Separator used by the server for the items. The source separator separates the items passed by the server during the browsing into elements. The default is a dot ("."). The client also has to use this separator (for example, PVLEVEL4.Level1). An arbitrary separator can be used.

[opcae] startDelay

Type
int
Default
0
With the entry startDelay the setting of the manager state "running" can be delayed to avoid that subsequent managers, depending on the OPC AE client start, are started too early.

[opcae] timeFormatComment

Type
string
Default
[]{original time: %Y.%m.%d %H:%M:%S.%z}
Range
-
Defines the format of the time when appending to the alert comment. For details of the allowed constants for the format string see: formatTime()

[opcae] useJsonForSimpleEvents

Type
bool
Default
0
Range
0|1
Defines if JSON format shall be used for mapping simple/tracking events to string DPE.