Campaign | partitions | partition[n] | server | logging

Properties in this category affect flowchart logging behavior for the specified partition on the HCL® Campaign server.

enableWindowsEventLogging

Description

This property enables or disables HCL 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.

Attention: Windows Event logging can cause issues with flowchart runs. Avoid enabling this feature unless advised by Technical Support.
Default value

FALSE

Valid Values

TRUE | FALSE

logFileBufferSize

Configuration category
Campaign|partitions|partition[n]|server|logging
Description

This property is used when 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 HCL 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, HCL 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 HCL 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, HCL 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

This property controls whether the process ID (pid) of the HCL Campaign Server process is included 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

This 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

This property specifies the category of messages written to the HCL Campaign server flowchart log file. This property works in conjunction with loggingLevels, which determines the severity of messages to log for all selected categories.

Specify one or more categories in a comma-separated list. Use ALL as shorthand to indicate that you want to log all categories.

The values that you specify determine which events are logged by default for all flowcharts. Users can override the default selections by opening a flowchart for editing and choosing Options > Logging options. The corresponding Logging Options are indicated below in parentheses, after each configuration value.

Default value

ALL

Valid Values
  • ALL
  • BAD_ORDER (Log ID ordering errors)
  • CELL_ACCESS (Cell level operations)
  • CONFIG (Log config settings at start of run)
  • DATA_ERRORS (Log data conversion errors)
  • DBLOAD (External DB loader operations)
  • FILE_ACCESS(File operations)
  • GENERAL (Others)
  • COMMANDS (External interface)
  • MEMORY (Memory allocation)
  • PROCRUN (Process Run)
  • QUERY (Queries issues against user tables)
  • SORT (Log data sorting progress)
  • SYSQUERY (Queries issued against system tables)
  • TABLE_ACCESS (Table level operations)
  • TABLE_MAPPING (Log table mapping info at start of run )
  • TABLE_IO (Log data I/O process)
  • WEBPROC (Web server interface)

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
Note: 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 Windows event log for the Campaign server. 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 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 Windows event log for the HCL Campaign server, 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 for diagnostic purposes.

enableLogging

Configuration category
Campaign|partitions|partition[n]|server|logging
Description

This property specifies whether HCL 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 flowchart that generates flowchart-specific logging information when it is run. By default, all flowchart log files are saved in Campaign_home/partitions/partition_name/logs.

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