[Cluster]

member.1

Member 1

Describes the IP and TCP port on which the member ID 1 can be reached. The TCP port corresponds to the cmcomm.tcpbondinglocalport configuration of the cluster manager with member ID 1.

Default value

(blank)

Takes effect After restart

member.2

Member 2

Describes the IP and TCP port on which the member ID 2 can be reached. The TCP port corresponds to the cmcomm.tcpbondinglocalport configuration of the cluster manager with member ID 2.

Default value

(blank)

Takes effect After restart

members

Members

List of ID's of the members in the cluster (unsigned integers 1 to 32 delimited by space). The ID's correspond to the NLB unique host identifier (priority) number specified for each of the NLB cluster machines.

Default value

1 2

Takes effect After restart

mymemberid

My Member ID

Indicates this cluster manager instance's member ID (select one among the ID's listed in Cluster.members).

Default value

(blank)

Takes effect After restart

NLBScriptPath

NLB Batch Script Path

Absolute path to the executable NLB.bat script.

Default value

$InstallationRoot$\bin\NLB.bat

Takes effect After restart

[CMClusterMgr]

ElectionTimer

ElectionTimer

Election timer in milli-seconds. If there is no response from remote cluster manager(s) for the election process after the specified milli-seconds, the local cluster manager will become the master. If the local resource manager is up and running, the local resource manager will become the active node.

Valid values

Number must be from 1000 to 10000 inclusive

Default value

3000

Takes effect After restart

[Cmcomm]

heartbeattimer

Heartbeat Interval between CMs

Heart beat interval between cluster managers for determining health of each other.

Default value

2000

Takes effect After restart

tcpbondinglocalport

Member 1

This corresponds to the TCP port where other cluster manager can reach this cluster manager. The port here must correspond to the port specified in Cluster.member.N, where N is the value of cluster.mymemberid.

Default value

9801

Takes effect After restart

[Cmservicemgrbase]

serverport

Server Port

This corresponds to the TCP port where this cluster manager is listening for the Resource Manager to connect. This port must correspond to the port specified in the Resource Manager's cmserviceagent.cmport configuration

Default value

6001

Takes effect After restart

[ems]

log_dll.MFSINK

MF Sink DLL

Specifies the full path of the MF Sink library

Default value

$InstallationRoot$\bin\EMSMFAdapter.dll

Takes effect At start/restart

log_sinks

Log Sinks

List of one more pipe-delimited identifiers for log sinks that should be loaded upon initialization of the EMS Logging Service.

Default value

MFSINK

Takes effect At start/restart

logconfig.MFSINK

MF Sink Log Filter

Specifies the logs that are delivered to the MF Sink.

Default value

*|*|*

Takes effect immediately

metricsconfig.MFSINK

MF Sink Metrics Filter

Specifies the metrics that are delivered to the MF Sink.

Default value

*

Takes effect immediately

mfadapter.initfile

EMS to MF Mapping

Specifies the full path of the EMS MF mapping file, which maps EMS log IDs to MF counterparts.

Default value

$InstallationRoot$\config\@ID_MAPPING_FILE@

Takes effect At start/restart

trace_flag

Trace Flag

Flag specifying whether debug level logging is enabled. When enabled, debug level logs will be processed and filtered like logs (and metrics) and all other levels.

Default value

false

Takes effect immediately

[log]

all

Output for level all

Specifies the outputs to which an application sends all log events. The log output types must be separated by a comma when more than one output is configured.

Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    (blank)

    Takes effect immediately

    check-point

    Check point interval

    Specifies, in hours, how often the application generates a check point log event, to divide the log into sections of equal time. By default, the application generates this log event every hour. Setting the option to 0 prevents the generation of check-point events.

    Valid values

    0 - 24

    Default value

    1

    Takes effect immediately

    compatible-output-priority

    Enable 6.X compatible log output priority

    Specifies whether the application uses 6.x output logic.

    Valid values

  • true The log of the level specified by "Log Output Options" is sent to the specified output.
  • false The log of the level specified by "Log Output Options" and higher levels is sent to the specified output.
  • Default value

    false

    Takes effect immediately

    debug

    Output for level debug

    Specifies the outputs to which an application sends the log events of the Debug level and higher (that is, log events of the Standard, Interaction, Trace, and Debug levels). The log output types must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    ..\logs\ClusterMgr

    Takes effect immediately

    expire

    Log Expiration

    Determines whether log files expire. If they do, sets the measurement for determining when they expire, along with the maximum number of files (segments) or days before the files are removed.

    Valid values

  • false No expiration; all generated segments are stored.
  • [number] file or [number] Sets the maximum number of log files to store. Specify a number from 1-100.
  • [number] day Sets the maximum number of days before log files are deleted. Specify a number from 1-100.
  • Default value

    20

    Takes effect immediately

    interaction

    Output for level interaction

    Specifies the outputs to which an application sends the log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels). The log outputs must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    ..\logs\ClusterMgr,network

    Takes effect immediately

    keep-startup-file

    Keep startup log file

    Specifies whether a startup segment of the log, containing the initial T-Server configuration, is to be kept. If it is, this option can be set to true or to a specific size. If set to true, the size of the initial segment will be equal to the size of the regular log segment defined by the segment option. The value of this option will be ignored if segmentation is turned off (that is, if the segment option set to false).

    Valid values

  • false No startup segment of the log is kept.
  • true A startup segment of the log is kept. The size of the segment equals the value of the segment option.
  • [number] KB Sets the maximum size, in kilobytes, for a startup segment of the log.
  • [number] MB Sets the maximum size, in megabytes, for a startup segment of the log.
  • Default value

    false

    Takes effect After restart

    memory

    Memory snapshot file name

    Specifies the name of the file to which the application regularly prints a snapshot of the memory output, if it is configured to do this. The new snapshot overwrites the previously written data. If the application terminates abnormally, this file will contain the latest log messages. Memory output is not recommended for processors with a CPU frequency lower than 600 MHz.

    Valid values

    [string] (memory file name)

    Default value

    (blank)

    Takes effect immediately

    memory-storage-size

    Memory output buffer size

    Specifies the buffer size for log output to the memory, if configured.

    Valid values

  • [number] KB or [number] The size of the memory output, in kilobytes. The minimum value is 128 KB.
  • [number] MB The size of the memory output, in megabytes. The maximum value is 64 MB
  • Default value

    (blank)

    Takes effect When memory output is created

    message_format

    Log messages format

    Specifies the format of log record headers that an application uses when writing logs in the log file. Using compressed log record headers improves application performance and reduces the log file's size. With the value set to short:
  • A header of the log file or the log file segment contains information about the application (such as the application name, application type, host type, and time zone), whereas single log records within the file or segment omit this information.
  • A log message priority is abbreviated to Std, Int, Trc, or Dbg, for Standard, Interaction, Trace, or Debug messages, respectively.
  • The message ID does not contain the prefix GCTI or the application type ID.
    A log record in the full format looks like this:
    2002-05-07T18:11:38.196 Standard localhost cfg_dbserver GCTI-00-05060 Application started
    A log record in the short format looks like this:
    2002-05-07T18:15:33.952 Std 05060 Application started
  • Valid values

    • short
    • full
  • short An application uses compressed headers when writing log records in its log file.
  • full An application uses complete headers when writing log records in its log file.
  • Default value

    short

    Takes effect immediately

    messagefile

    Message file

    Specifies the file name for application-specific log events. The name must be valid for the operating system on which the application is running. The option value can also contain the absolute path to the application-specific *.lms file. Otherwise, an application looks for the file in its working directory.

    Valid values

    [string].lms (message file name)

    Default value

    (blank)

    Takes effect Immediately, if an application cannot find its *.lms file at startup

    print-attributes

    Enable printing extended attributes

    Specifies whether the application attaches extended attributes, if any exist, to a log event that it sends to log output. Typically, log events of the Interaction log level and Audit-related log events contain extended attributes. Setting this option to true enables audit capabilities, but negatively affects performance. Genesys recommends enabling this option for Solution Control Server and Configuration Server when using audit tracking. For other applications, refer to Genesys 7.5 Combined Log Events Help to find out whether an application generates Interaction-level and Audit-related log events; if it does, enable the option only when testing new interaction scenarios.

    Valid values

  • true Attaches extended attributes, if any exist, to a log event sent to log output.
  • false Does not attach extended attributes to a log event sent to log output.
  • Default value

    false

    Takes effect immediately

    segment

    Log Segmentation

    Specifies whether there is a segmentation limit for a log file. If there is, sets the mode of measurement, along with the maximum size. If the current log segment exceeds the size set by this option, the file is closed and a new one is created.

    Valid values

  • false No segmentation is allowed.
  • [number] KB or [number] Sets the maximum segment size, in kilobytes. The minimum segment size is 100 KB.
  • [number] MB Sets the maximum segment size, in megabytes.
  • [number] hr Sets the number of hours for the segment to stay open. The minimum number is 1 hour.
  • Default value

    10000

    Takes effect immediately

    spool

    Folder for the temporary network log output files

    Specifies the folder, including full path to it, in which an application creates temporary files related to network log output. If you change the option value while the application is running, the change does not affect the currently open network output.

    Valid values

    [path] (the folder, with the full path to it)

    Default value

    (blank)

    Takes effect immediately

    standard

    Output for level standard

    Specifies the outputs to which an application sends the log events of the Standard level. The log output types must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    ..\logs\ClusterMgr,network

    Takes effect immediately

    time_convert

    Time generation for log messages

    Specifies the system in which an application calculates the log record time when generating a log file. The time is converted from the time in seconds since the Epoch (00:00:00 UTC, January 1, 1970).

    Valid values

    • local
    • utc
  • local The time of log record generation is expressed as a local time, based on the time zone and any seasonal adjustments. Time zone information of the application's host computer is used.
  • utc The time of log record generation is expressed as Coordinated Universal Time (UTC).
  • Default value

    local

    Takes effect immediately

    time_format

    Time format for log messages

    Specifies how to represent, in a log file, the time when an application generates log records.
    A log record's time field in the ISO 8601 format looks like this:
    2001-07-24T04:58:10.123

    Valid values

    • time
    • locale
    • ISO8601
  • time The time string is formatted according to the HH:MM:SS.sss (hours, minutes, seconds, and milliseconds) format.
  • locale The time string is formatted according to the system's locale.
  • ISO8601 The date in the time string is formatted according to the ISO 8601 format. Fractional seconds are given in milliseconds.
  • Default value

    time

    Takes effect immediately

    trace

    Output for level trace

    Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels). The log outputs must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    ..\logs\ClusterMgr

    Takes effect immediately

    verbose

    Verbose Level

    Determines whether a log output is created. If it is, specifies the minimum level of log events generated. The log events levels, starting with the highest priority level, are Standard, Interaction, Trace, and Debug.

    Valid values

    • all
    • debug
    • trace
    • interaction
    • standard
    • none
  • all All log events (that is, log events of the Standard, Trace,Interaction, and Debug levels) are generated.
  • debug The same as all.
  • trace Log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels) are generated, but log events of the Debug level are not generated.
  • interaction Log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels) are generated, but log events of the Trace and Debug levels are not generated.
  • standard Log events of the Standard level are generated, but log events of the Interaction, Trace, and Debug levels are not generated.
  • none No output is produced.
  • Default value

    standard

    Takes effect immediately