Campaign | partitions | partition[n] | server | logging
Properties in this category affect logging behavior for the specified partition on the IBM® Campaign server.
enableWindowsEventLogging
Description
This property enables or disables IBM® Campaign server logging to the Windows event log.
If the value is TRUE, logging to the Windows event log is enabled.
If the value is FALSE, logging to the Windows event log is disabled, and the windowsEventLoggingLevel and windowsEventLoggingCategory settings are ignored.
Default value
FALSE
Valid Values
TRUE | FALSE
logFileBufferSize
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
This property is used when the value of keepFlowchartLogOpen is TRUE. Specify a value to indicate the number of messages to buffer before writing to the log. If the value is 1, every log message is written immediately to file, effectively disabling buffering but having a negative impact on performance.
This property is ignored if keepFlowchartLogOpen is FALSE.
Default value
5
keepFlowchartLogOpen
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
This property specifies whether IBM® Campaign opens and closes the flowchart log file each time a line is written to the log file.
A value of TRUE can improve performance of real-time interactive flowcharts. When the value is TRUE, IBM® Campaign opens the flowchart log file only once, and closes it when the flowchart's server process exits. A side effect of using the TRUE value is that recently-logged messages may not be immediately visible in the log file, as IBM® 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.
If the value is FALSE, IBM® Campaign opens and closes the flowchart log file.
Default value
FALSE
Valid Values
TRUE | FALSE
logProcessId
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
The logProcessId property controls whether the process ID (pid) of the IBM® Campaign Server process is logged in the log file.
If the value is TRUE, the process ID is logged.
If the value is FALSE, the process ID is not logged.
Default value
TRUE
Valid Values
TRUE | FALSE
logMaxBackupIndex
Configuration category
Campaign|partitions|partition[n]|server|logging
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
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
The loggingCategories property specifies the category of messages written to the IBM® 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:
ALL
BAD_ORDER
CELL_ACCESS
CONFIG
DATA_ERRORS
DBLOAD
FILE_ACCESS
GENERAL
COMMANDS
MEMORY
PROCRUN
QUERY
SORT
SYSQUERY
TABLE_ACCESS
TABLE_MAPPING
TABLE_IO
WEBPROC
loggingLevels
Configuration category
Campaign|partitions|partition[n]|server|logging
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)
MEDIUM
HIGH
ALL: includes trace messages and is intended primarily for diagnostic purposes
*
You may want to set loggingLevels to ALL during configuration and testing. This value generates a large amount of data and therefore may not be advisable for production operation. Setting any logging level higher than its default can adversely affect performance.
You can adjust these settings from within a flowchart by using Tools > Logging Options .
windowsEventLoggingCategories
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
This property specifies the category of messages written to the Campaign server windows event log. This property 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
ALL
BAD_ORDER
CELL_ACCESS
CONFIG
DATA_ERRORS
DBLOAD
FILE_ACCESS
GENERAL
COMMANDS
MEMORY
PROCRUN
QUERY
SORT
SYSQUERY
TABLE_ACCESS
TABLE_MAPPING
TABLE_IO
WEBPROC
logFileMaxSize
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
This 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
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
This property controls the amount of detail written to the IBM® Campaign server windows event log based on severity.
Default value
MEDIUM
Valid Values
LOW: represents the least detail (the most severe errors only)
MEDIUM
HIGH
ALL: includes trace messages and is intended primarily for diagnostic purposes.
enableLogging
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
This property specifies whether IBM® Campaign server logging is turned on at session startup.
If the value is TRUE, logging is turned on.
If the value is FALSE, logging is turned off.
Default value
TRUE
Valid Values
TRUE | FALSE
AllowCustomLogPath
Configuration category
Campaign|partitions|partition[n]|server|logging
Description
This property allows users to change the log path for each campaign flowchart that generates flowchart-specific logging information when it is run.
A setting of True allows users to change the path through the user interface or when using unica_svradm to run the flowchart.
A setting of False prevents users from changing the path to which the flowchart log file is written.
Default value
FALSE
Valid Values
TRUE | FALSE