[agentx]

connection_delay_sec

Subagent connection delay (s)

The number of SECONDS to wait between each reconnection attempt to SNMP Master Agent.

Valid values

An integer greater than 0

Default value

60

Takes effect at start/restart

max_connection_attempt

Subagent connection attempts

The maximum connection attempts to be made by the SNMP Subagent to SNMP Master Agent. Value if not set or value lesser than or equal to 0 means no limit on number of attempts.

Valid values

An integer greater than 0

Default value

-1

Takes effect at start/restart

[cdr]

call-timeout

Call Timeout

Specifies the amount of time, in minutes, until a call is considered 'timed out' from the perspective of VAR and CDR reporting

Valid values

An integer from 1 - 1440 inclusive

Default value

180

Takes effect at start/restart

db-maintenance-batch-size

Batch Size for DB Maintenance Service

Specifies the maximum duration, in minutes, to process in a batch for services that support batch purging

Valid values

An integer from 1 - 1440 inclusive

Default value

5

Takes effect at start/restart

max-page-count

Max Page Count

The maximum number of pages that will be returned in any given CDR or Call Events report request

Valid values

An integer from 1 - 100 inclusive

Default value

10

Takes effect at start/restart

max-page-size

Max Page Size

The maximum number of records per page that will be returned in any given CDR or Call Events report request

Valid values

An integer from 1 - 10000 inclusive

Default value

100

Takes effect at start/restart

media-service-cdrs.reduce

Disable the storage of RM and MCP CDRs that have certain media service types

When this option is set to true the following CDRs will not be stored to the remote database: Any RM CDR or MCP CDR with media service type set to: media, cpd, record or conference.

Default value

true

Takes effect at start/restart

or-call-counting.enable

Enable the counting of MCP VXML calls and MCP Treatment without VXML calls for peaks and arrivals data

When this option is set to true the RS will calculate peaks and arrivals for MCP VXML calls and MCP Treatment calls (without VXML).

Default value

true

Takes effect at start/restart

[dbmp]

rs.db.retention.cdr.default

Data Retention Default for CDRs

The number of days for which Call Detail Records data will be retained in the database.

Valid values

An integer greater than 0

Default value

30

Takes effect immediately

rs.db.retention.events.default

Data Retention Default for Upstream Events

The number of days for which call log events (upstream logs) data will be retained in the database.

Valid values

An integer greater than 0

Default value

7

Takes effect immediately

rs.db.retention.latencies.daily.default

Data Retention Default for Daily Latency Data

The number of days for which daily latency histogram data will be retained in the database.

Valid values

An integer greater than 30

Default value

90

Takes effect immediately

rs.db.retention.latencies.hourly.default

Data Retention Default for Hourly Latency Data

The number of days for which hourly latency histogram data will be retained in the database.

Valid values

An integer greater than 0

Default value

7

Takes effect immediately

rs.db.retention.latencies.monthly.default

Data Retention Default for Monthly Latency Data

The number of days for which monthly latency histogram data will be retained in the database.

Valid values

An integer greater than 30

Default value

1095

Takes effect immediately

rs.db.retention.latencies.weekly.default

Data Retention Default for Weekly Latency Data

The number of days for which weekly latency histogram data will be retained in the database.

Valid values

An integer greater than 30

Default value

364

Takes effect immediately

rs.db.retention.operations.30min.default

Data Retention Default for 30-minute OR Data

The number of days for which 30-minute operational data will be retained in the database.

Valid values

An integer greater than 0

Default value

7

Takes effect immediately

rs.db.retention.operations.5min.default

Data Retention Default for 5-minute OR Data

The number of days for which 5-minute operational data will be retained in the database.

Valid values

An integer greater than 0

Default value

1

Takes effect immediately

rs.db.retention.operations.daily.default

Data Retention Default for Daily OR Data

The number of days for which daily operational data will be retained in the database.

Valid values

An integer greater than 30

Default value

90

Takes effect immediately

rs.db.retention.operations.hourly.default

Data Retention Default for Hourly OR Data

The number of days for which hourly operational data will be retained in the database.

Valid values

An integer greater than 0

Default value

7

Takes effect immediately

rs.db.retention.operations.monthly.default

Data Retention Default for Monthly OR Data

The number of days for which monthly operational data will be retained in the database.

Valid values

An integer greater than 30

Default value

1095

Takes effect immediately

rs.db.retention.operations.weekly.default

Data Retention Default for Weekly OR Data

The number of days for which weekly operational data will be retained in the database.

Valid values

An integer greater than 30

Default value

364

Takes effect immediately

rs.db.retention.sq.daily.default

Data Retention Default for Daily Service Quality Data

The number of days for which daily Service Quality summary data will be retained in the database.

Valid values

An integer greater than 30

Default value

90

Takes effect immediately

rs.db.retention.sq.failures.default

Data Retention Default for Service Quality Failures

The number of days for which Service Quality failure detail records will be retained in the database.

Valid values

An integer greater than 0

Default value

365

Takes effect immediately

rs.db.retention.sq.hourly.default

Data Retention Default for Hourly Service Quality Data

The number of days for which hourly Service Quality summary data will be retained in the database.

Valid values

An integer greater than 0

Default value

7

Takes effect immediately

rs.db.retention.sq.monthly.default

Data Retention Default for Monthly Service Quality Data

The number of days for which monthly Service Quality summary data will be retained in the database.

Valid values

An integer greater than 30

Default value

365

Takes effect immediately

rs.db.retention.sq.weekly.default

Data Retention Default for Weekly Service Quality Data

The number of days for which weekly Service Quality summary data will be retained in the database.

Valid values

An integer greater than 30

Default value

180

Takes effect immediately

rs.db.retention.var.30min.default

Data Retention Default for 30-minute VAR Data

The number of days for which 30-minute Call Summary and IVR Action Summary data will be retained in the database.

Valid values

An integer greater than 0

Default value

7

Takes effect immediately

rs.db.retention.var.5min.default

Data Retention Default for 5-minute VAR Data

The number of days for which 5-minute Call Summary and IVR Action Summary data will be retained in the database.

Valid values

An integer greater than 0

Default value

1

Takes effect immediately

rs.db.retention.var.daily.default

Data Retention Default for Daily VAR Data

The number of days for which daily Call Summary and IVR Action Summary data will be retained in the database.

Valid values

An integer greater than 30

Default value

90

Takes effect immediately

rs.db.retention.var.hourly.default

Data Retention Default for Hourly VAR Data

The number of days for which hourly Call Summary and IVR Action Summary data will be retained in the database.

Valid values

An integer greater than 0

Default value

7

Takes effect immediately

rs.db.retention.var.monthly.default

Data Retention Default for Monthly VAR Data

The number of days for which monthly Call Summary and IVR Action Summary data will be retained in the database.

Valid values

An integer greater than 30

Default value

1095

Takes effect immediately

rs.db.retention.var.weekly.default

Data Retention Default for Weekly VAR Data

The number of days for which weekly Call Summary and IVR Action Summary data will be retained in the database.

Valid values

An integer greater than 30

Default value

364

Takes effect immediately

[https]

https.certificate.algorithm

SSL Certificate Algorithm

The SSL algorithm used for the configured keystore.

Valid values

Name of HTTPS algorithm

Default value

SunX509

Takes effect at start/restart

https.client.authentication

Client Authentication requirement

HTTPS client authentication requirements.

Valid values

  • none
  • preferred
  • required
<dl> <dt>none</dt><dd>No certificate request, so client-side authentication is disabled.</dd> <dt>required</dt><dd>A certificate is requested and the server will require a valid, non-empty certificate response to establish the connection. (Only works for BIO connector type).</dd> <dt>preferred</dt><dd>A certificate is requested, but the server will still establish the connection if the certificate response is empty.</dd> </dl>

Default value

none

Takes effect at start/restart

https.connector.type

HTTPS Connector Type

The type of Jetty connector to use

Valid values

  • 1
  • 2
<dl> <dt>NIO</dt><dd>Non-blocking NIO connector (Refer to Jetty's JavaDoc for class org.mortbay.jetty.security.SslSelectChannelConnector for more information).</dd> <dt>BIO</dt><dd>Blocking BIO connector (Refer to Jetty's JavaDoc for class org.mortbay.jetty.security.SslSocketConnector for more information).</dd> </dl>

Default value

2

Takes effect at start/restart

https.keystore.path

SSL Keystore Path

The path to the keystore file, which will be used for all the HTTPS connectors.

Valid values

A directory path

Default value

${user.home}/.keystore

Takes effect at start/restart

https.keystore.type

SSL Keystore Type

The type of keystore, which defines the file format that the security implementation supports.

Valid values

A HTTPS keystore type

Default value

JKS

Takes effect at start/restart

https.protocol

HTTPS Protocol

The cryptographic protocol to use.

Valid values

  • SSL
  • SSLv2
  • SSLv3
  • TLS
  • TLSv1
<dl> <dt>SSL</dt><dd>Supports some version of SSL.</dd> <dt>SSLv2</dt><dd>Supports SSL version 2 or higher.</dd> <dt>SSLv3</dt><dd>Supports SSL version 3; may support other versions.</dd> <dt>TLS</dt><dd>Supports some versions of TLS.</dd> <dt>TLSv1</dt><dd>Supports TLS version 1; may support other versions.</dd> </dl>

Default value

TLS

Takes effect at start/restart

https.random.algorithm

Secure Random Algorithm

Refer to the JDK JavaDoc for class java.security.SecureRandom for more information.

Valid values

Name of the RNG (Random Number Generator) algorithm

Default value

(blank)

Takes effect at start/restart

https.security.provider

Security Provider

Refer to the JDK JavaDoc for class java.security.Provider for more information.

Valid values

Name of Java security provider

Default value

(blank)

Takes effect at start/restart

password

SSL Keystore Password

The password for the keystore file.

Valid values

A string

Default value

(blank)

Takes effect at start/restart

[https_key]

password

SSL Key Password

The optional key password for the HTTPS configuration.

Valid values

A string

Default value

(blank)

Takes effect at start/restart

[imdb]

imdb-max-cdr-queries

Max concurrent cdr queries

The maximum number of concurrently executed RM, MCP, CCP CDR in-progress queries

Valid values

An integer from 1 - 15 inclusive

Default value

3

Takes effect at start/restart

imdb-query-lock-timeout

Max query lock timeout in (ms)

The max time the real-time query would wait to acquire the lock against underlying in-memory storage in milliseconds

Valid values

An integer from 100 - 5000 inclusive

Default value

1000

Takes effect at start/restart

[latency]

threshold.asr_input_response

Threshold Criteria for ASR Input Response Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.audio_fetch

Threshold Criteria for Audio Fetch Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

1000|95

Takes effect at start/restart

threshold.call_answer

Threshold Criteria for Call Answer Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.call_reject

Threshold Criteria for Call Reject Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.cumulative_response

Threshold Criteria for Cumulative Response Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.data_fetch

Threshold Criteria for Data Fetch Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.dtmf_input_response

Threshold Criteria for DTMF Input Response Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.grammar_fetch

Threshold Criteria for Grammar Fetch Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

1000|95

Takes effect at start/restart

threshold.inbound_first_prompt

Threshold Criteria for First Prompt Inbound Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.initial_response

Threshold Criteria for Initial Response Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

4000|95

Takes effect at start/restart

threshold.interprompt

Threshold Criteria for Inter Prompt Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.java_script_execution

Threshold Criteria for JavaScript Execution Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

50|99

Takes effect at start/restart

threshold.java_script_fetch

Threshold Criteria for JavaScript Fetch Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

1000|95

Takes effect at start/restart

threshold.mrcp_asr_session_establish

Threshold Criteria for MRCP ASR Session Establish Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

100|95

Takes effect at start/restart

threshold.mrcp_asr_set_params

Threshold Criteria for MRCP ASR Set Params Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

100|95

Takes effect at start/restart

threshold.mrcp_asr_stop

Threshold Criteria for MRCP ASR Stop Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

100|95

Takes effect at start/restart

threshold.mrcp_define_grammar

Threshold Criteria for MRCP Define Grammar Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

500|95

Takes effect at start/restart

threshold.mrcp_recognize

Threshold Criteria for MRCP Recognize Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

500|95

Takes effect at start/restart

threshold.mrcp_speak

Threshold Criteria for MRCP Speak Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

100|95

Takes effect at start/restart

threshold.mrcp_tts_session_establish

Threshold Criteria for MRCP TTS Session Establish Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

100|95

Takes effect at start/restart

threshold.mrcp_tts_set_params

Threshold Criteria for MRCP TTS Set Params Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

100|95

Takes effect at start/restart

threshold.mrcp_tts_stop

Threshold Criteria for MRCP TTS Stop Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

100|95

Takes effect at start/restart

threshold.noinput_response

Threshold Criteria for No Input Response Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.outbound_first_prompt

Threshold Criteria for First Prompt Outbound Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.page_compile

Threshold Criteria for Page Compile Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

100|95

Takes effect at start/restart

threshold.page_fetch

Threshold Criteria for Page Fetch Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

1500|95

Takes effect at start/restart

threshold.recording_response

Threshold Criteria for Recording Response Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

Takes effect at start/restart

threshold.transfer_response

Threshold Criteria for Transfer Response Latency

This parameter defines the latency threshold (milliseconds) and percentile (%) for a given latency. For every Service Quality period the Reporting Server will calculate the actual latency associated with the specified percentile. If that number exceeds the threshold specified here, an error is logged.

Valid values

The format is as follows: (threshold)|(percentile). Threshold and percentile must be non-negative integers.

Default value

2000|95

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

<dl> <dt>stdout</dt><dd>Log events are sent to the Standard output (stdout).</dd> <dt>stderr</dt><dd>Log events are sent to the Standard error output (stderr).</dd> <dt>network</dt><dd>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.</dd> <dt>[filename]</dt><dd>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.</dd> </dl>

Default value

(blank)

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

<dl> <dt>stdout</dt><dd>Log events are sent to the Standard output (stdout).</dd> <dt>stderr</dt><dd>Log events are sent to the Standard error output (stderr).</dd> <dt>network</dt><dd>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.</dd> <dt>[filename]</dt><dd>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.</dd> </dl>

Default value

logs/rs.log

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

<dl> <dt>false</dt><dd>No expiration; all generated segments are stored.</dd> <dt>[number]</dt><dd>Sets the maximum number of log files to store. Specify a number from 1-100.</dd> </dl>

Default value

false

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

<dl> <dt>stdout</dt><dd>Log events are sent to the Standard output (stdout).</dd> <dt>stderr</dt><dd>Log events are sent to the Standard error output (stderr).</dd> <dt>network</dt><dd>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.</dd> <dt>[filename]</dt><dd>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.</dd> </dl>

Default value

(blank)

Takes effect immediately

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.

Valid values

  • short
  • full
<dl> <dt>Compressed Headers</dt><dd>An application uses compressed headers when writing log records in its log file.
A log record in the short format looks like this:
2002-05-07T18:15:33.952 Std 05060 Application started</dd> <dt>Complete Headers</dt><dd>An application uses complete headers when writing log records in its log file.
A log record in the full format looks like:
2002-05-07T18:11:38.196 Standard localhost cfg_dbserver GCTI-00-05060 Application started</dd> </dl>

Default value

full

Takes effect immediately

segment

Log Segmentation

Specifies the segmentation limit for a log file. 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

<dl> <dt>false</dt><dd>This setting will cause RS to use a segment size of 10MB</dd> <dt>[number] KB or [number]</dt><dd>Sets the maximum segment size, in kilobytes.</dd> <dt>[number] MB</dt><dd>Sets the maximum segment size, in megabytes. </dd> </dl>

Default value

10MB

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

<dl> <dt>stdout</dt><dd>Log events are sent to the Standard output (stdout).</dd> <dt>stderr</dt><dd>Log events are sent to the Standard error output (stderr).</dd> <dt>network</dt><dd>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.</dd> <dt>[filename]</dt><dd>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.</dd> </dl>

Default value

stdout

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.

Valid values

  • time
  • locale
  • ISO8601
<dl> <dt>time (HH:MM:SS.sss)</dt><dd>The time string is formatted according to HH:mm:ss.SSS.</dd> <dt>locale (dd/MM/yyyy hh:mm:ss aaa)</dt><dd>The time string is formatted according to the system's locale. With format: dd/MM/yyyy hh:mm:ss aaa</dd> <dt>ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)</dt><dd>The date in the time string is formatted according to the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSSZ</dd> </dl>

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

<dl> <dt>stdout</dt><dd>Log events are sent to the Standard output (stdout).</dd> <dt>stderr</dt><dd>Log events are sent to the Standard error output (stderr).</dd> <dt>network</dt><dd>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.</dd> <dt>[filename]</dt><dd>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.</dd> </dl>

Default value

(blank)

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
<dl> <dt>all</dt><dd>All log events (that is, log events of the Standard, Trace,Interaction, and Debug levels) are generated.</dd> <dt>debug</dt><dd>The same as all.</dd> <dt>trace</dt><dd>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.</dd> <dt>interaction</dt><dd>Interaction level is not mapped and will have the same effect as none.</dd> <dt>standard</dt><dd>Log events of the Standard level are generated, but log events of the Interaction, Trace, and Debug levels are not generated.</dd> <dt>none</dt><dd>No output is produced.</dd> </dl>

Default value

trace

Takes effect immediately

[messaging]

activemq.connectionMode

ActiveMQ Broker Connectors

The type of connectors to enable on the ActiveMQ broker. The choices are a) unencrypted only, b) SSL only, or c) SSL for new clients and unencrypted support for older clients that do not support SSL.

Valid values

  • 0
  • 1
  • 2
An integer equal to 0, 1 or 2

Default value

0

Takes effect at start/restart

activemq.dataDirectory

JMS Data Directory

The full path of the directory that ActiveMQ uses for persistent queuing

Valid values

A directory path

Default value

data/activemq

Takes effect at start/restart

activemq.diskStoreUsageLimit

Limit of disk storage for messages handled by the ActiveMQ broker

Limit of disk storage for messages handled by the ActiveMQ broker.

Valid values

An integer followed by a measurement unit (b, kb, mb, gb).

Default value

256 gb

Takes effect at start/restart

activemq.serverIP

Local listening address for the ActiveMQ's broker

IP Address for the listening port used by the ActiveMQ broker (unencrypted connector).

Default value

(blank)

Takes effect At start/restart

activemq.tlsKeyStore

ActiveMQ keystore for SSL private key and certificate

Path to the Java keystore file containing the cryptographic key and trusted certificate entries needed by the ActiveMQ broker for TLS/SSL support.

Valid values

Path to the keystore file

Default value

keystore.ks

Takes effect at start/restart

activemq.tlsPort

ActiveMQ JMS broker Port for SSL

The SSL listening port for the ActiveMQ JMS broker that receives incoming data from Reporting Clients.

Valid values

An integer greater than 0

Default value

61617

Takes effect at start/restart

activemq.tlsServerIP

Local listening address for the ActiveMQ's broker (TLS)

IP Address for the TLS (encrypted) listening port used by the ActiveMQ broker.

Default value

(blank)

Takes effect At start/restart

activemq.useJmx

Enable JMX monitoring for ActiveMQ

JMX Monitoring can be enabled for monitoring ActiveMQ message queues

Valid values

  • false
  • true
true or false

Default value

false

Takes effect at start/restart

password

ActiveMQ keystore password

The password needed to open the keystore used by the ActiveMQ broker.

Valid values

ActiveMQ broker keystore password

Default value

(blank)

Takes effect at start/restart

port

ActiveMQ JMS broker Port

The listening port for the ActiveMQ JMS broker that receives incoming data from Reporting Clients.

Valid values

An integer greater than 0

Default value

61616

Takes effect at start/restart

[persistence]

hibernate.remote.database

Database Name

The name of remote database that will be used for RS. Used to help construct the JDBC connection URL.

Valid values

A Database Name

Default value

(blank)

Takes effect at start/restart

hibernate.remote.dialect

Database Dialect

The dialect Hibernate should use when interacting with the database

Valid values

  • org.hibernate.dialect.SQLServerDialect
  • org.hibernate.dialect.Oracle10gDialect
MS SQL DB Dialect or Oracle DB Dialect

Default value

(blank)

Takes effect at start/restart

hibernate.remote.driver

Database Driver

SQL Driver Hibernate should use when interacting with the database

Valid values

  • com.microsoft.sqlserver.jdbc.SQLServerDriver
  • oracle.jdbc.driver.OracleDriver
MS SQL DB Datasource or Oracle DB Datasource

Default value

(blank)

Takes effect at start/restart

hibernate.remote.url

Database URL

The JDBC URL that RS should use to connect with the database. For Oracle, the final URL is constructed by appending a colon plus the hibernate.remote.database string to this option's value. For SQL Server, the final URL is constructed by appending ';databasename=' plus the hibernate.remote.database string to this option's value. The JDBC connection URL will equal the hibernate.remote.url string if the hibernate.remote.database parameter is set to empty.

Valid values

A JDBC URL

Default value

(blank)

Takes effect at start/restart

hibernate.remote.user

Database User Name

The user name that RS should use to connect the the remote database

Valid values

User Name

Default value

(blank)

Takes effect at start/restart

password

Database Password

The password that RS should use to connect the the remote database

Valid values

User Password

Default value

(blank)

Takes effect at start/restart

rs.histonly.enabled

HIST-Only Mode

Configures the RS to run in HIST-Only Mode. The RS will never write to the remote database, but will continue to support historical report queries. The HIST-Only RS does not support writing CDR, OR, SQA, or log data. It does not support data summarization or data purging. It does not support real-time (RT) call reports.

Valid values

  • false
  • true
Enable HIST-Only Mode

Default value

false

Takes effect at start/restart

rs.nodb.enabled

No DB mode

Enables the 'no DB' feature for running the RS without a remote DB.

Valid values

  • false
  • true
This option controls 'no DB' mode. In 'no DB' mode, the RS functions without a remote DB, however only a limited number of reporting services are available.

Default value

false

Takes effect at start/restart

[reporting]

binding.address

RS Service Address

The interface IP address that should be used for binding the RS service.

Valid values

An IP address.

Default value

(blank)

Takes effect at start/restart

db.query.timeout.max

The maximum allowed database query running time (in seconds) before the RS sends cancel query request to database server

This parameter only controls the database query sent from RS to database server. The HTTP query on RS reporting would have longer timeout when it involves more than one database query.

Valid values

An integer greater than 0, less than 65535

Default value

60

Takes effect immediately

hostname

RS Reporting Service Hostname

The hostname that should be used for accessing RS.

Valid values

A hostname or fully qualified domain name.

Default value

(blank)

Takes effect at start/restart

password

Basic HTTP Authentication Password

The password for RS to perform basic HTTP authentication.

Valid values

A string

Default value

(blank)

Takes effect at start/restart

port

RS Reporting Service Port

The port on which the RS receives reporting requests.

Valid values

An integer greater than 0

Default value

8080

Takes effect at start/restart

protocol

RS Reporting Service Protocol

The type of communication protocol that RS uses to service reporting requests.

Valid values

  • http
  • https
An integer greater than 0

Default value

http

Takes effect at start/restart

rs.query.limit.30min

Maximum configured units of 30-minute period for all reports with 30-minute granularity

The maximum number of 30-minute periods that are included in any report with granularity of 30-minute.

Valid values

An integer greater than 0

Default value

336

Takes effect immediately

rs.query.limit.5min

Maximum configured units of 5-minute period for all reports with 5-minute granularity

The maximum number of 5-minute periods that are included in any report with granularity of 5-minutes.

Valid values

An integer greater than 0

Default value

288

Takes effect immediately

rs.query.limit.day

Maximum configured units of day period for all reports with day granularity

The maximum number of days that are included in any report with granularity of day.

Valid values

An integer greater than 0

Default value

92

Takes effect immediately

rs.query.limit.hour

Maximum configured units of hour period for all reports with hour granularity

The maximum number of hours that are included in any report with granularity of hour.

Valid values

An integer greater than 0

Default value

168

Takes effect immediately

rs.query.limit.month

Maximum configured units of month period for all reports with month granularity

The maximum number of months that are included in any report with granularity of month.

Valid values

An integer greater than 0

Default value

36

Takes effect immediately

rs.query.limit.week

Maximum configured units of week period for all reports with week granularity

The maximum number of weeks that are included in any report with granularity of week.

Valid values

An integer greater than 0

Default value

53

Takes effect immediately

rs.summarization.buffer

Summarization Buffer Time

The buffer time in minutes from now. The summarization job will only summarize records written before that time.

Valid values

An integer from 0 and 44640 inclusive.

Default value

60

Takes effect at start/restart

username

Basic HTTP Authentication User Name

The username for RS to perform basic HTTP authentication.

Valid values

A string

Default value

(blank)

Takes effect at start/restart

[schedule]

quartz.rs.calltimeout

Call Timeout Process

The CRON schedule that Quartz should use to execute the Call Timeout Process. This process is responsible for timing out RM/MCP/CCP and VAR Call Data Records.

Valid values

Refer to http://www.opensymphony.com/quartz/api/org/quartz/CronExpression.html for more detail

Default value

0 50 * * * ?

Takes effect at start/restart

quartz.rs.dbMaintenancePeriod

RS DB Maintenance Process

The CRON schedule that Quartz should use to purge old data according to each application's data retention policy.

Valid values

Refer to http://www.opensymphony.com/quartz/api/org/quartz/CronExpression.html for more detail

Default value

0 30 1 * * ?

Takes effect at start/restart

quartz.rs.dbPartitioningPeriod

RS Partitioning Process

The CRON schedule that Quartz should use to run partition archiving job.

Valid values

Refer to http://www.opensymphony.com/quartz/api/org/quartz/CronExpression.html for more detail

Default value

0 0 0/1 * * ?

Takes effect at start/restart

quartz.rs.or.counting

RS MCP VXML Processing

The CRON schedule that Quartz should use to run the MCP VXML OR counting job process.

Valid values

Refer to http://www.opensymphony.com/quartz/api/org/quartz/CronExpression.html for more detail

Default value

0 40 * * * ?

Takes effect at start/restart

quartz.var.summarization

VAR Update Process

The schedule that Quartz should use to update VAR summary statistics. This schedule is expressed in milliseconds. For example, by default the VAR Update Process will run every 300 seconds (5 minutes).

Valid values

An integer from 60000 and 86400000 inclusive.

Default value

300000

Takes effect at start/restart

[snmp]

bulk.size

SNMP GetBulk Limit

The maximum number of entries that will be retrieved by a single SNMP GetBulk request. Note that this setting maybe be overriden by client configuration and packet size limit.

Valid values

An integer greater than 0

Default value

50

polling.interval

SNMP Data Collecting Interval (s)

The interval between each SNMP request to a specific component.

Valid values

An integer greater than 0

Default value

60

timeout

SNMP request timeout (ms)

The maximum amount of time the SNMP query will wait to receive the response from the SNMP Agent.

Valid values

An integer greater or equal to 1000

Default value

30000

Takes effect immediately

[sqa]

error.notification.threshold

Threshold for Service Quality Notification

If the percentage of successful calls falls below this threshold during a service quality period, a notification is generated.

Valid values

An integer between 1 and 100 inclusive

Default value

95

Takes effect immediately

monitor.min.alert.number

Minimum Calls for Service Quality Notification

The minimum number of calls that need to be recorded before the service quality notification is issued at the critical level.

Valid values

An integer greater than 0

Default value

100

Takes effect immediately

monitor.min.latency.warn.number

Minimum Latency Measurements for Threshold Warning

The minimum number of latency measurements that need to be recorded before a warning is logged indicating that the latency measurements have exceeded the configured threshold for the update period.

Valid values

An integer greater than 0

Default value

100

Takes effect immediately

service.quality.period

Service Quality Interval Period

This parameter indicates the interval (in seconds) at which service quality data will be forwarded to the RS from the MCP relative to the beginning of the hour. MCP components must be restarted to refresh their version of this parameter if it is updated.

Valid values

  • 300
  • 600
  • 900
  • 1200
  • 1800
  • 3600
An integer equal to 300, 600, 900, 1200, 1800, or 3600.

Default value

900

Takes effect At start/restart

stat.update.interval

Stat Update Interval

This parameter defines the period of time, in seconds, between statistic updates, and is relative to the beginning of the hour, rather than the MCP client start time. MCP components must be restarted to refresh their version of this parameter if it is updated.

Valid values

  • 300
  • 600
  • 900
  • 1200
  • 1800
  • 3600
An integer equal to 300, 600, 900, 1200, 1800, or 3600.

Default value

900

Takes effect At start/restart