Campaign | partitions | partition[n] | server | logging
Properties in this category specify, for the Campaign server, whether standard and Windows event logging are enabled, logging levels and categories, and other logging behavior.
enableWindowsEventLogging
Description
The enableWindowsEventLogging property enables or disables Campaign server logging to the Windows event log.
If the value is yes, logging to the Windows event log is enabled.
If the value is no, logging to the Windows event log is disabled. If disabled, the windowsEventLoggingLevel and windowsEventLoggingCategory settings are ignored.
Default value
no
Valid Values
yes | no
logFileBufferSize
Description
The logFileBufferSize property is used when the value of the keepFlowchartLogOpen property is yes. It sets an upper bound on the number of log messages after which the messages will be written to file.
If the value is 1, every log message is written immediately to file, effectively disabling buffering but causing somewhat worse performance.
This property is ignored if the value of keepFlowchartLogOpen is set to no.
Default value
5
keepFlowchartLogOpen
Description
The keepFlowchartLogOpen property specifies whether Campaign opens and closes the flowchart log file each time a line is written to the log file.
If the value is no, Campaign opens and closes the flowchart log file.
If the value is yes, Campaign opens the flowchart log file only once, and closes the flowchart log file only when the flowchart's server process exits. A value of yes may improve performance of real-time flowcharts. A side effect of using the yes setting is that recently-logged messages may not be immediately visible in the log file, as Campaign flushes the log messages to file only when its internal buffer becomes full or when the number of logged messages equals the value of the logFileBufferSize property.
Default value
no
Valid Values
yes | no
logProcessId
Description
The logProcessId property controls whether the process ID (pid) of the Campaign Server process is logged in the log file.
If the value is yes, the process ID is logged.
If the value is no, the process ID is not logged.
Default value
yes
Valid Values
yes | no
logMaxBackupIndex
Description
The logMaxBackupIndex property specifies the number of backup Campaign server log files that are kept before the oldest is erased.
If the value is 0 (zero), no backup files are created, and the log file is truncated when it reaches the size specified by the logFileMaxSize property.
For a value of n, where n is greater than zero, the files {File.1, ..., File.n-1} are renamed to {File.2, ..., File.n}. Also, File is renamed File.1 and closed. A new File is created to receive further log output.
Default value
1 (creates one backup log file)
loggingCategories
Description
The loggingCategories property specifies the category of messages written to the Campaign server log file. This works in conjunction with loggingLevels, which determines which messages are logged based on severity (for all selected categories). You can specify multiple categories in a comma-separated list. The special category all provides a shorthand for specifying all logging categories.
Default value
ALL
Valid Values
Supported categories are:
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
loggingLevels
Description
The loggingLevels property controls the amount of detail written to the Campaign server log file, based on severity.
Default value
MEDIUM
Valid Values
*
*
*
*
LOW represents the least detail (the most severe errors only), and ALL includes trace messages and is intended primarily for diagnostic purposes. You can adjust these settings from within a flowchart through the Tools >Logging Options menu.
*
You may want to set the loggingLevels property to ALL during configuration and testing, to maximize the logging output from Campaign for diagnostic purposes. This setting generates a large amount of data and therefore may not be advisable for production operation.
windowsEventLoggingCategories
Description
The windowsEventLoggingCategories property specifies the category of messages written to the Campaign server windows event log. This works in conjunction with windowsEventLoggingLevels, which determines which messages are logged based on severity (for all selected categories).
You can specify multiple categories in a comma-separated list. The special category all provides a shorthand for specifying all logging categories.
Default value
ALL
Valid Values
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
logFileMaxSize
Description
The logFileMaxSize property specifies the maximum size, in bytes, that the Campaign server log file is allowed to reach before being rolled over to backup files.
Default value
10485760 (10 MB)
windowsEventLoggingLevels
Description
The windowsEventLoggingLevels property controls the amount of detail written to the Campaign server windows event log based on severity.
Default value
MEDIUM
Valid Values
*
*
*
*
LOW represents the least detail (the most severe errors only), and ALL includes trace messages and is intended primarily for diagnostic purposes.
enableLogging
Description
The enableLogging property specifies whether Campaign server logging is turned on at session startup.
If the value is yes, logging is turned on.
If the value is no, logging is turned off.
Default value
yes
Valid Values
yes | no