[ems]

logconfig.MFSINK

MF Sink Log Filter

Controls the log messages that are sent to the MF sink. The format is 'levels|moduleIDs|specifierIDs' (repeated if necessary). The values between the pipes can be in the format: 'm-n,o,p' (ie "0-4, 5,6"). The wildcard character '*' can also be used to indicate all valid numbers. Example: '*|*|*' indicates that all log messages should be sent to the sink. Alternatively, '0,1|0-10|*|4|*|*' indicates that CRITICAL(0) and ERROR(1) level messages with module IDs in the range 0-10 will be sent to the sink; and all INFO(4) level messages will be sent as well.

Valid values

Pipe delimited ranges for log levels, module IDs and specifier IDs. Ranges can be comma separated integers or range of integers or '*'.

Default value

*|*|*

Takes effect immediately

metricsconfig.MFSINK

MF Sink Metrics Filter

Specifies the metrics that are delivered to the MF Sink. '*' indicates that all metrics will be sent to the sink. Alternatively, '5-10,50-55,70,71' indicates that metrics with IDs 5,6,7,8,9,10,50,51,52,53,54,55,70 and 71 will be sent to the MF sink.

Valid values

Comma separated list of metric values or ranges. A metric value must be between 0 and 141 inclusive. The values '*' and blank are also allowed.

Default value

*

Takes effect immediately

ors.reportinginterval

OR reporting interval

Interval (seconds) accumulated operational reports are submitted to the Reporting Server

Valid values

An integer between 1-299 inclusive.

Default value

60

Takes effect At start/restart

rc.cdr.batch_size

CDR Batch Size

The number of CDR messages queued up by the reporting client before sending them up to the reporting server. A higher batch size (e.g. 50 records) will lessen bandwidth constraints, at the cost of making sending CDR data at larger intervals.

Valid values

An integer between 1-5000 inclusive.

Default value

500

Takes effect At start/restart

rc.cdr.local_queue_max

Maximum Records in the Persisted Local DB File for CDR data

This option specifies the maximum number of data items to the local database for CDR reporting. Queuing to the local database will occur either when the Reporting Server is unavailable, or when data is being provided to the Client faster than the Server can consume it. This value defaults to -1 indicating an "unlimited" number of records will be allowed. A value of 0 indicates that no records will be persisted locally and data will be discarded if the RS is unavailable.

Valid values

An integer greater or equal to -1.

Default value

-1

Takes effect At start/restart

rc.cdr.local_queue_path

Persistent DB File for CDR Data

The full path of the local database file used to locally persist data for CDRs.

Valid values

Path to the DB file.

Default value

cdrQueue_rm.db

Takes effect At start/restart

rc.certificate

TLS Certificate for Reporting Client

The file name of the TLS certificate in "PEM" format. Required to connect to the Reporting Server (ActiveMQ) over TLS.

Valid values

File path

Default value

(blank)

Takes effect at start/restart

rc.ors.batch_size

OR Batch Size

The number of OR messages queued up by the reporting client before sending them up to the reporting server.

Valid values

An integer between 1-5000 inclusive.

Default value

500

Takes effect At start/restart

rc.ors.local_queue_max

Maximum Records in the Persisted Local DB File for OR data

This option specifies the maximum number of data items to the local database for Operational Reporting. Queuing to the local database will occur either when the Reporting Server is unavailable, or when data is being provided to the Client fdaster than the Server can consume it. This value defaults to -1 indicating an "unlimited" number of records will be allowed. A value of 0 indicates that no records will be persisted locally and data will be discarded if the RS is unavailable.

Valid values

An integer greater or equal to -1.

Default value

-1

Takes effect At start/restart

rc.ors.local_queue_path

Persistent DB File for OR Data

The full path of the local database file used to locally persist data for Operational Reporting.

Valid values

Path to the DB file.

Default value

orsQueue_rm.db

Takes effect At start/restart

[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

    ../logs/MRCPProxy

    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.
  • 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.
  • Valid values

    • true
    • false

    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/MRCPProxy

    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/MRCPProxy

    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.
  • 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.
  • Valid values

    • true
    • false

    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/MRCPProxy

    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).
  • Local Time (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.
  • Coordinated Universal Time (utc) The time of log record generation is expressed as Coordinated Universal Time (UTC).
  • Valid values

    • local
    • 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
  • HH:MM:SS.sss (time) The time string is formatted according to the HH:MM:SS.sss (hours, minutes, seconds, and milliseconds) format.
  • According to the system's locale (locale) The time string is formatted according to the system's locale.
  • ISO 8601 format (ISO8601) The date in the time string is formatted according to the ISO 8601 format. Fractional seconds are given in milliseconds.
  • Valid values

    • time
    • locale
    • ISO8601

    Default value

    ISO8601

    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/MRCPProxy

    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, debug and all.
  • 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 log evenets are generated.
  • Valid values

    • all
    • debug
    • trace
    • interaction
    • standard
    • none

    Default value

    standard

    Takes effect immediately

    [snmp]

    SNMP settings.

    timeout

    SNMP Task Timeout

    The maximum amount of time that SNMP can wait for a new task. This value is specified in milliseconds.

    Valid values

    The parameter must be an integer value greater than zero.

    Default value

    100

    Takes effect At start/restart

    [stack]

    connection.portrange

    RTSP Port Range for MRCPv1 Client

    The port range of RTSP stack used by MRCPv1 client.

    Default value

    10000-11999

    Takes effect At start/restart

    connection.timeout

    MRCP Connection Timeout

    The connection timeout for SRM MRCPv1 and MRCPv2 Stack to establish a TCP connection to the server. The value must be integer values in milliseconds.

    Default value

    10000

    Takes effect At start/restart

    trace.debug

    Enable MRCP Stack Debug Trace

    Whether to enable the stack debug message

    Valid values

    • true
    • false

    Default value

    true

    Takes effect At start/restart

    [vrmproxy]

    fips_enabled

    FIPS Mode Enabled

    Specifies whether to enable FIPS mode in MRCP Proxy. When FIPS mode is enabled, only FIPS 140-2 approved ciphers and algorithms can be used in SSL connections.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect After restart

    timeout.back_in_service

    Error recovery time for speech resource

    Timeout in milliseconds for a server to be put back in service after it encounters errors such as timeout or TCP connection error.

    Default value

    10000

    Takes effect Immediately

    timeout.barge_in_occurred

    BARGE-IN Timeout

    Timeout of BARGE-IN-OCCURRED in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.clean_loop

    Session Clean Interval

    Interval to clean idle sessions as determined by timeout.max_idle parameter.

    Default value

    60000

    Takes effect Immediately

    timeout.close_session

    Close-Session Timeout

    Timeout of Close-Session request in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.control

    CONTROL Timeout

    Timeout of CONTROL message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.define_grammar

    DEFINE-GRAMMAR Timeout

    Timeout of DEFINE-GRAMMAR message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.get_params

    GET-PARAMS Timeout

    Timeout of GET-PARAMS message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.get_result

    GET-RESULT Timeout

    Timeout of GET-RESULT message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.get_server_info

    Get-Server-Info Timeout

    Timeout of to get a response for Get-Server-Info request (Ping) in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.max_idle

    Session Max Idle Timeout

    Max session idle time in milliseconds. Sessions exceeding this idle time will be terminated.

    Default value

    180000

    Takes effect Immediately

    timeout.open_session

    Open-Session Timeout

    Timeout of Open-Session in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.pause

    PAUSE Timeout

    Timeout of PAUSE message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.recog_start_timers

    RECOGNITION-START-TIMERS Timeout

    Timeout of RECOGNITION-START-TIMERS message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.recognize

    RECOGNIZE Timeout

    Timeout of RECOGNIZE message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.reconnect_interval

    TCP re-connect Interval

    If TCP connection is not yet established with the MRCP server, interval in milliseconds to try reconnecting.

    Default value

    10000

    Takes effect Immediately

    timeout.resume

    RESUME Timeout

    Timeout of RESUME message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.set_params

    SET-PARAMS Timeout

    Timeout of SET-PARAMS message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.speak

    SPEAK Timeout

    Timeout of SPEAK message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    timeout.stop

    STOP timeout

    Timeout of STOP message in milliseconds.

    Default value

    10000

    Takes effect Immediately

    uri

    MRCP Proxy Contact RTSP URI

    This parameter specifies the full RTSP URI the MRCPv1 clients should use for contacting this proxy. The MRCP Proxy will listen for TCP connections at the port specified by the URI. If port is not specified in the URI, default port 11000 will be assumed. For deployments where MRCP Proxy is in a separate box from the MCP, the default value must be changed with the the IP of the MRCP Proxy.

    Default value

    rtsp://localhost:11000/mrcpproxy

    Takes effect Immediately