[ccp]

cmp.ignoremetrics

Verbose Level

If true, ignore Metrics logs received from CMP Engine; this saves CPU time to not parse messages that will be discarded

Valid values

  • true
  • false
  • 1 true
  • 0 false
  • Default value

    1

    Takes effect immediately

    [ccpccxml]

    allow_dialog_transfer

    Allow Dialog transfer

    Allows transfers through dialog.

    Valid values

    • true
    • false
  • 1 Enable transfers through dialog
  • 0 Disable transfers through dialog
  • Default value

    1

    Takes effect immediately

    ccpccxml.sip.send_progressing

    Send SIP Progressing

    Determines whether 180 SIP response is sent on <accept> tag for all incoming calls.
    0 - 180 response is sent when &#60;send&#62; is called
    1 - 180 response is sent immediately after sending 100 Trying

    Valid values

    • 1
    • 0

    Default value

    1

    Takes effect immediately

    default_uri

    Default CCXML Application

    Specifies the URI for the default CCXML application

    Default value

    file://$InstallationRoot$\config\default.ccxml

    Takes effect immediately

    defaultmaxage

    Default Maxage

    Default Maxage for fetching an initial CCXML page

    Valid values

    From 30 to 180 inclusive (in seconds)

    Default value

    60

    Takes effect immediately

    defaultmaxstale

    Default Maxstale

    Default Maxstale for fetching an initial CCXML page

    Valid values

    From 0 to 180 inclusive (in seconds)

    Default value

    0

    Takes effect immediately

    defaultrejectcode

    Default Reject Code

    Specifies the default SIP Response code to use when an incoming call is rejected by the application

    Default value

    480

    Takes effect immediately

    shutdown_grace_period

    Shutdown Grace Period

    The amount of time (in seconds) sessions are given to terminate after Graceful Stop is selected. Once this grace period is exceeded, sessions are killed by ccxml.kill.unconditional events.

    Valid values

    From 0 to 65535 inclusive (in seconds)

    Default value

    7200

    Takes effect immediately

    sip.allowedunknownheaders

    Unknown headers allowed for a SIP message

    Specifies the unknown headers allowed in a SIP message

    Default value

    (blank)

    Takes effect immediately

    [ccxmli]

    basichttp.recv.host

    BasicHTTP Receive - Host

    The IP or hostname on which the Basic HTTP Event I/O Processor will be listening for HTTP requests. An empty string means "listen on all interfaces".

    Default value

    (blank)

    Takes effect immediately

    basichttp.recv.path

    BasicHTTP Receive - Path

    The access path for the Basic HTTP Event I/O Processor.

    Default value

    /ccxml/basichttp

    Takes effect immediately

    basichttp.recv.port

    BasicHTTP Receive - Port

    The port on which the Basic HTTP Event I/O Processor will be listening for HTTP requests.

    Default value

    4892

    Takes effect immediately

    basichttp.recv.show_error_body

    BasicHTTP Receive - Show Error Body

    When set to TRUE, a descriptive text will be returned in the response body when an HTTP failure response is given for a request to the Basic HTTP Event I/O Processor.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect immediately

    basichttp.send.timeout

    BasicHTTP Send Timeout

    The HTTP response timeout (in milliseconds) value for an event sent to another platform via HTTP.

    Default value

    15000

    Takes effect immediately

    createsession.recv.host

    CreateSession Receive Host

    The IP or hostname on which the Session Creation Event I/O Processor will be listening for HTTP requests. An empty string means "listen on all interfaces".

    Default value

    (blank)

    Takes effect immediately

    createsession.recv.path

    CreateSessoin Receive - Path

    The access path for the Session Creation Event I/O Processor.

    Default value

    /ccxml/createsession

    Takes effect immediately

    createsession.recv.port

    CreateSession Receive - Port

    The port on which the Session Creation Event I/O Processor will be listening for HTTP requests.

    Valid values

    A valid value is an integer from 1025 to 65535 inclusive.

    Default value

    4892

    Takes effect immediately

    createsession.recv.show_error_body

    CreateSession Receive Show Error Body

    When set to TRUE, a descriptive text will be returned in the response body when an HTTP failure response is given for a request to the Session Creation Event I/O Processor.

    Valid values

    • CreateSession Receive Show Error Body true
    • CreateSession Receive Show Error Body false

    Default value

    false

    Takes effect immediately

    debug_data.dir

    Debug Data directory

    Debug Data Directory

    Default value

    (blank)

    Takes effect immediately

    debug_data.dir_levels

    Debug Data directory Levels

    The nesting depth of debug data sub-folders. For example, if the session id is "1234" and directory nesting is set to 2, a file called "debug.dat" will be saved as <ccxmli.debug_data.dir>/1/2/1234/debug.dat. When set to 0, no nesting occurs. Directory nesting can be enabled when there's a need to retain debug data for a lot of sessions, to decrease the number of sub-directories each directory will have.

    Default value

    0

    Takes effect immediately

    debug_data.dir_levels

    Debug Data directory Levels

    The nesting depth of debug data files. For example, if the session id is "1234" and file nesting is set to 2, a file called "debug.dat" will be saved as <ccxmli.debug_data.dir>/1234/d/e/debug.dat. When set to 0, no nesting occurs. File nesting can be enabled when there's a need to retain debug data for a lot of files, to decrease the number of files each directory will have.

    Default value

    0

    Takes effect immediately

    default_caller_id

    Default CallerID

    Default CallerID

    Default value

    sip:ccxml@localhost

    Takes effect immediately

    fetch.timeout

    Initial Page Fetch Timeout

    The default timeout interval (in seconds) for the initial page fetch completion for new CCXML session to complete.

    Default value

    30

    Takes effect immediately

    inactive_session_kill_timeout

    Inactive Session Kill Timeout

    The amount of time (in seconds) that a session may idle without owning any connections or dialogs and without removing any "external" events from its event queue (An external event is an event that does not have an eventsourcetype of ccxml and an eventsource that is the current session's id). If the limit is reached, then ccxml.kill is sent to the session. If the limit value is not configured or is set to 0, then no limit is placed on the idle time.

    Default value

    7200

    Takes effect immediately

    ioproc.http.maxclients

    HTTP IO Max Clients

    HTTP IO Max Clients

    Valid values

    A valid value is an integer from 1 to 500 inclusive.

    Default value

    200

    Takes effect immediately

    ioproc.http.port

    HTTP Port for ioproc

    HTTP Port for ioproc

    Default value

    4892

    Takes effect immediately

    ioproc.http.url

    URL for ioproc

    URL for ioproc

    Default value

    http://<IP-PORT>/ccxml/ioproc

    Takes effect immediately

    kill_by_other

    Kill process externally

    If set to True, allow Process to be killed by external entity.

    Valid values

    • true
    • false

    Default value

    true

    Takes effect immediately

    max_conf_per_session

    Max Conf per session

    Max Conf per session

    Valid values

    A valid value is an integer from 1 to 100000 inclusive.

    Default value

    100000

    Takes effect immediately

    max_conn_per_session

    Max connections per session

    Max Connections per session

    Valid values

    A valid value is an integer from 1 to 100000 inclusive.

    Default value

    100000

    Takes effect immediately

    max_dialog_per_session

    Max dialogs per session

    Max dialogs per session

    Valid values

    A valid value is an integer from 1 to 100000 inclusive.

    Default value

    100000

    Takes effect immediately

    max_internal_loop_count

    Maximum Internal Loop Count

    The number of times a session iterates through an <eventprocessor> loop without removing an "external" event from its event queue (An external event is an event that does not have an eventsourcetype of ccxml and an eventsource that is the current session's id.) or without the session's event queue being empty after processing an event. If the limit is reached, then ccxml.kill.unconditional is sent to the session. If the limit value is not configured or set to 0 then no limit is placed on the event processing.

    Default value

    200

    Takes effect immediately

    max_num_documents

    Max number of documents

    Max number of documents

    Valid values

    A valid value is an integer from 1 to 100000 inclusive.

    Default value

    100000

    Takes effect immediately

    max_num_sessions

    Max number of sessions

    Max number of sessions

    Valid values

    A valid value is an integer from 1 to 100000 inclusive.

    Default value

    100000

    Takes effect immediately

    num_session_processing_threads

    Numbers of threads per session

    Numbers of threads per session

    Valid values

    A valid value is an integer from 1 to 5 inclusive.

    Default value

    5

    Takes effect immediately

    platform.save_ccxml_files

    Save CCXML Files

    When set to True, fetch request/response/data for each fetched CCXML page will be saved.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect immediately

    platform.save_script_files

    Save Script Files

    When set to True, fetch request/response/data for each fetched ECMAScript file will be saved.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect immediately

    trace_flag

    Trace flag

    Trace flag.

    Valid values

    • true
    • false

    Default value

    true

    Takes effect immediately

    [ems]

    dc.default.logfilter

    Default Upstream Log Filter for Data Collection Sink

    Specifies the filter for logs to be delivered "upstream" to the Reporting Server for Call Events reporting. 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|*|*' inidcates that CRITICAL(0) and ERROR(1) level messages with module IDs in the range 0-10 wil 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

    0-2|*|*

    Takes effect At start/restart

    dc.default.metricsfilter

    Default Metrics Filter for Data Collection Sink

    Specifies the default filter for metrics to be delivered "upstream" to the Reporting Server for Call Events reporting. '*' 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. This filter will be used unless the default has been overridden in the tenant or IVR Application profile to which the given call has been associated.

    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

    1001,1009,1012-1013,1031,1050,1052,1058-1059

    Takes effect At start/restart

    dc.trace_flag

    Trace Flag (Data Collection Sink)

    Flag specifying whether debug level logging is enabled for the Data Collection Sink. When enabled (flag is set to TRUE), debug level logs will be processed and filtered like other log levels. When the flag is set to FALSE, debug level log messages will never be processed.

    Valid values

    • FALSE
    • TRUE
    TRUE or FALSE

    Default value

    FALSE

    Takes effect immediately

    log_sinks

    Log Sinks

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

    Valid values

    DATAC, MFSINK or TRAPSINK

    Default value

    DATAC|MFSINK|TRAPSINK

    Takes effect At start/restart

    logconfig.DATAC

    Data Collection 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|*|*' inidcates that CRITICAL(0) and ERROR(1) level messages with module IDs in the range 0-10 wil 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

    0-2|*|*

    Takes effect immediately

    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|*|*' inidcates that CRITICAL(0) and ERROR(1) level messages with module IDs in the range 0-10 wil 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

    0-3,5|*|*

    Takes effect immediately

    metricsconfig.DATAC

    Data Collection Sink Metrics Filter

    Specifies the metrics that are delivered to the Data Collection 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

    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

    1000-1001,1003-1005,1007-1016,1019-1021,1024,1027-1036,1039-1045,1048-1050,1052-1054,1056,1058-1062

    Takes effect immediately

    metricsconfig.TRAPSINK

    Trap Sink Metrics Filter

    Specifies the metrics that are delivered to the Trap Sink.

    Default value

    *

    Takes effect immediately

    rc.batch_size

    Upstream Batch Size

    The number of upstream 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 data at larger intervals.

    Valid values

    An integer between 1-5000 inclusive.

    Default value

    500

    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_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

    $InstallationRoot$\config\cdrQueue.db

    Takes effect At start/restart

    rc.cdr.msg_broker_uri

    Reporting Server Message Broker for CDR

    The URI for the Reporting Server's JMS Message Broker (CDR)

    Valid values

    A URI

    Default value

    tcp://$ReportingServerHostname$:61616

    Takes effect At start/restart

    rc.local_queue_path

    Persistent DB File for Upstream Logging

    The full path of the local database file used to locally persist data for upstream logging to the GVP Reporting Client.

    Valid values

    Path to the DB file.

    Default value

    $InstallationRoot$\config\upstreamQueue_CCP.db

    Takes effect At start/restart

    rc.msg_broker_uri

    Reporting Server Message Broker for Upstream Logging

    The URI for the Reporting Server's JMS Message Broker

    Valid values

    A URI

    Default value

    tcp://$ReportingServerHostname$:61616

    Takes effect At start/restart

    trace_flag

    Trace Flag

    Flag specifying whether debug level logging is enabled. When enabled (flag is set to TRUE), debug level logs will be processed and filtered like other log levels. When the flag is set to FALSE, debug level log messages will never be processed.

    Valid values

    • FALSE
    • TRUE
    TRUE or FALSE

    Default value

    FALSE

    Takes effect immediately

    trapsink.initfile

    SNMP Trap 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\EMStoMFIDs.txt

    Takes effect At start/restart

    trapsink.trapfilterfile

    SNMP Trap Filter

    Specifies the full path of the trap filter file, which maps MF ids to SNMP traps.

    Default value

    $InstallationRoot$\config\trapfilter.txt

    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

    (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

  • 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\ccp

    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 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\ccp,network

    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

    standard

    Output for level standard

    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\ccp,network

    Takes effect immediately

    trace

    Output for level trace

    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\ccp

    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

    [mediacontroller]

    bridge_server

    Address of bridge server

    The address of SIP Bridge Server for use when the two end-points cannot be joined due to media bridging limitations.
    Bridge Server must be able to
  • send media to multiple end-points
  • send and receive from distinct end-points and
  • have transcoding capability.
  • Valid values

    A valid IP address:Port can only contain alphanumeric characters, '.', '-', ':', ' ','/' and '\' characters

    Default value

    (blank)

    Takes effect immediately

    bridge_server.defaultmaxsize

    Bridge Server Default Max Size

    This controls the confmaxsize URI parameter when conference is set up in the bridge server.

    Valid values

    From 1 to 1000 inclusive

    Default value

    4

    Takes effect immediately

    bridge_server.defaultreserve

    Bridge Server Default Reserve

    This controls the confreserve URI parameter when conference is set up in the bridge server.

    Valid values

    From 1 to 1000 inclusive

    Default value

    4

    Takes effect immediately

    bridge_server.profile

    Device Profile of bridge server

    The name of device profile to use with the configured Bridge Server.

    Default value

    Default Conference

    Takes effect immediately

    full_audio_codec

    Full Audio codec

    This defines the audio codecs that get set in the SDP in an initial offer with no media bridge. Codec entry has to be in the format of: payload|name|mime|rate|#channels. Each codec entry is separated by a whitespace.

    Default value

    0|pcmu|audio/basic|8000|1 8|pcma|audio/x-alaw-basic|8000|1 4|g723|none|8000|1 18|g729|audio/g729|8000|1 12|qcelp|audio/QCELP|8000|1 111|aurora|none|8000|1 3|gsm|audio/x-gsm|8000|1 105|AMR|audio/AMR|8000|1 101|telephone-event|none|8000|1

    Takes effect immediately

    full_video_codec

    Full Video codec

    This defines the video codecs that get set in the SDP in an initial offer with no media bridge. Codec entry has to be in the format of: payload|name|mime|rate|#channels. Each codec entry is separated by a whitespace.

    Default value

    34|h263|video/H263|90000|1 98|H264|video/H264|90000|1

    Takes effect immediately

    inbound_allowed_media

    Inbound allowed Media

    The default allowed media types for an inbound call. All inbound calls will be limited to this set of media types in terms of SDP exchange.

    Valid values

    • audio
    • video
    Must be one of the following:
  • audio
  • audio video
  • video
  • Default value

    audio

    Takes effect immediately

    max_reinvites

    MaxReInvites

    Maximum number of re-invite per node allowed in the transaction. If the node has to be updated more than the number defined by this parameter, transaction fails.

    Valid values

    From 1 to 5 inclusive

    Default value

    5

    Takes effect immediately

    max_retries

    MaxRetries

    Maximum number of extra update cycles allowed in the transaction. If after the first round of update, more number of cycles are allowed than what is defined by this parameter, transaction fails.

    Valid values

    From 1 to 5 inclusive

    Default value

    5

    Takes effect immediately

    sipproxy

    SIP Proxy

    The address of SIP Proxy for outbound SIP requests. Should be specified like 10.10.30.205:5070

    Valid values

    A valid IP address:Port can only contain alphanumeric characters, '.', '-', ':', ' ','/' and '\' characters

    Default value

    (blank)

    Takes effect immediately

    [mediactrller]

    conference.defaultreserve

    Default reserve for conference server

    Default URI confreserve parameter for conference server if requested reserve size is not defined

    Default value

    8

    Takes effect immediately

    sdp.localhost

    SDP localhost

    The local host address (only the host part) that will be used in SDP.

    Default value

    $LocalIP$

    Takes effect immediately

    [session]

    copy_unknown_headers

    Copy unknown headers

    Copy unknown headers from request to all responses. If this parameter is turned on, all unknown SIP headers found in SIP request will be automatically copied to its responses. When the flag is set to true, unknown Headers will be copied, and if the flag is set to false, unknown headers will not be copied.

    Valid values

    • true
    • false

    Default value

    true

    Takes effect immediately

    [sip]

    copyunknownheaders

    Copy Unknown Headers

    Copy unknown headers from request to all responses. If this parameter is turned on, all unknown SIP headers found in SIP request will be automatically copied to its responses. 0 is disable and 1 is enable.

    Valid values

    • 0
    • 1

    Default value

    1

    Takes effect At start/restart

    localhostname

    Local Hostname

    sip.localhostname provides configurability of the host address part of Contact, Call-ID and From headers.
    If this parameter is not specified, then the IP Address of the local system will be used.
    If this value is not defined, sip.localport will be ignored.
    This parameter can also be used to provide the fully qualified domain name in SIP requests.

    Example:
    sip.localhostname=sip.genesyslab.com

    Valid values

    A valid local host name can only contain alphanumeric characters, '.', '-', ':', ' ','/' and '\' characters

    Default value

    $LocalHost$

    Takes effect At start/restart

    localport

    Local Port

    Similar to sip.localhostname, the parameter sip.localport provides configurability of the port part of Contact, Call-ID and From Headers.
    If this parameter is not specified, the default SIP port number of 5068 is used.
    Note that if sip.localhostname is not defined, sip.localport will be ignored.

    Valid values

    The port number must be between 1025 and 65535

    Default value

    5068

    Takes effect At start/restart

    localsecureport

    Local Secure Port

    Similar to sip.localhostname, the parameter sip.localsecureport provides configurability of the port part of Contact, Call-ID and From Headers when SIPS is used.
    If this parameter is not specified, the default SIPS port number of 5069 is used.
    Note that if sip.localhostname is not defined, sip.localsecureport will be ignored.

    Valid values

    The port number must be between 1025 and 65535

    Default value

    5069

    Takes effect At start/restart

    localuser

    Contact Header User Name

    Configures the user name portion of the Contact header generated from the platform.

    Default value

    Genesys

    Takes effect At start/restart

    maxtcpconnections

    Maximum TCP Connections

    Defines the maximum number of TCP connections concurrently established. If the maximum number of TCP connections has been reached, new SIP requests to establish TCP connections will be rejected

    Valid values

    The maximum number of connections must be between 1 and 10000

    Default value

    100

    Takes effect At start/restart

    maxtlsconnections

    Maximum TLS Connections

    Defines the maximum number of TLS connections concurrently established. If the maximum number of TLS connections has been reached, new SIP requests to establish TLS connections will be rejected

    Valid values

    The maximum number of TLS connections must be between 1 and 10000

    Default value

    100

    Takes effect At start/restart

    min_se

    Minimum Session Expire Time

    Defines the Min-SE parameter in seconds. This is the minimum duration of session expiry this SIP stack will accept from a user agent client.

    Valid values

    The parameter size must be between 90 and 3600

    Default value

    90

    Takes effect At start/restart

    mtusize

    MTU Size

    Defines the Maximum Transmission Unit (MTU) of the network interfaces. If a SIP request size is within 200 bytes of this value, the request will be sent on a congestion controlled transport protocol, such as TCP.

    Valid values

    The MTU size must be between 1 and 65535

    Default value

    1500

    Takes effect At start/restart

    OPTIONS.header.Accept

    OPTIONS header Accept

    This defines the Accept header value in the SIP OPTIONS response.

    Default value

    application/sdp

    Takes effect immediately

    OPTIONS.header.Accept-Encoding

    OPTIONS header Accept-Encoding

    This defines the Accept-Encoding header value in the SIP OPTIONS response.

    Default value

    (blank)

    Takes effect immediately

    OPTIONS.header.Accept-Language

    OPTIONS header Accept-Language

    This defines the Accept-Language header value in the SIP OPTIONS response

    Default value

    en

    Takes effect immediately

    OPTIONS.header.Allow

    OPTIONS header Allow

    This defines the Allow header value in the SIP OPTIONS response.

    Default value

    INVITE,ACK,CANCEL,BYE,OPTIONS,INFO

    Takes effect immediately

    registerexpiryadjustment

    Register Expiry Adjustment

    Specifies the amount of time (in seconds) that the platform should re-register with the configured registrars before their respective expiration times are reached

    Valid values

    sip.registerexpiryadjustment should be non-negative integer

    Default value

    10

    Takes effect At start/restart

    route.default.tcp

    Default route for TCP

    Default route for TCP. The number denotes the transport defined in sip.transport.x where x is the value of this parameter and will be used when no TCP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    route.default.tls

    Default route for TLS

    Default route for TLS. The number denotes the transport defined in sip.transport.x where x is the value of this parameter and will be used when no TLS routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    route.default.udp

    Default route for UDP

    Default route for UDP. The number denotes the transport defined in sip.transport.x where x is the value of this parameter and will be used when no UDP routes are found. If this parameter is not set, the first UDP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    route.dest.0

    Route Destination Instance 0

    This is an entry in routing table.
    Format: sip.route.dest.x=[Destination] [Netmask] [Transport] [Metric]
    To select an entry in routing table, we mask the outgoing IP Address with [Netmask]; if the result matches with the [Destination], we will accept that route. The [Transport] part determines the transport to use and maps to the index 'x' in one of the transports defined as sip.transport.x. In most of the cases, first accepted route will be used. Unless the protocol is specified or required (for example, when the message size is larger than mtusize, tcp is required to be used), the accepted route in routing table is also required to have matched protocol. If there.s no such route, default transport of that protocol will be used.
    If all cases failed, sip.transport.0.s protocol will be obtained. The default transport of the obtained protocol will be used.
    Note that [Metric] entry is needed but not used at this point.
    For example: sip.route.dest.0=138.120.72.0 255.255.255.0 1 0
    When we make a call to the machine 138.120.72.20, outgoing IP is masked with [netmask] using .bitwise AND. operator. In this case: 138.120.72.20 & 255.255.255.0 gives 138.120.72.0. This matches the defined [Destination] in the route. Therefore, transport in sip.transport.1 will be used.

    Default value

    (blank)

    Takes effect At start/restart

    route.dest.1

    Route Destination Instance 1

    This is an entry in routing table.
    Format: sip.route.dest.x=[Destination] [Netmask] [Transport] [Metric]
    To select an entry in routing table, we mask the outgoing IP Address with [Netmask]; if the result matches with the [Destination], we will accept that route. The [Transport] part determines the transport to use and maps to the index 'x' in one of the transports defined as sip.transport.x. In most of the cases, first accepted route will be used. Unless the protocol is specified or required (for example, when the message size is larger than mtusize, tcp is required to be used), the accepted route in routing table is also required to have matched protocol. If there.s no such route, default transport of that protocol will be used.
    If all cases failed, sip.transport.0.s protocol will be obtained. The default transport of the obtained protocol will be used.
    Note that [Metric] entry is needed but not used at this point.
    For example: sip.route.dest.0=138.120.72.0 255.255.255.0 1 0
    When we make a call to the machine 138.120.72.20, outgoing IP is masked with [netmask] using .bitwise AND. operator. In this case: 138.120.72.20 & 255.255.255.0 gives 138.120.72.0. This matches the defined [Destination] in the route. Therefore, transport in sip.transport.1 will be used.

    Default value

    (blank)

    Takes effect At start/restart

    route.dest.2

    Route Destination Instance 2

    This is an entry in routing table.
    Format: sip.route.dest.x=[Destination] [Netmask] [Transport] [Metric]
    To select an entry in routing table, we mask the outgoing IP Address with [Netmask]; if the result matches with the [Destination], we will accept that route. The [Transport] part determines the transport to use and maps to the index 'x' in one of the transports defined as sip.transport.x. In most of the cases, first accepted route will be used. Unless the protocol is specified or required (for example, when the message size is larger than mtusize, tcp is required to be used), the accepted route in routing table is also required to have matched protocol. If there.s no such route, default transport of that protocol will be used.
    If all cases failed, sip.transport.0.s protocol will be obtained. The default transport of the obtained protocol will be used.
    Note that [Metric] entry is needed but not used at this point.
    For example: sip.route.dest.0=138.120.72.0 255.255.255.0 1 0
    When we make a call to the machine 138.120.72.20, outgoing IP is masked with [netmask] using .bitwise AND. operator. In this case: 138.120.72.20 & 255.255.255.0 gives 138.120.72.0. This matches the defined [Destination] in the route. Therefore, transport in sip.transport.1 will be used.

    Default value

    (blank)

    Takes effect At start/restart

    route.dest.3

    Route Destination Instance 3

    This is an entry in routing table.
    Format: sip.route.dest.x=[Destination] [Netmask] [Transport] [Metric]
    To select an entry in routing table, we mask the outgoing IP Address with [Netmask]; if the result matches with the [Destination], we will accept that route. The [Transport] part determines the transport to use and maps to the index 'x' in one of the transports defined as sip.transport.x. In most of the cases, first accepted route will be used. Unless the protocol is specified or required (for example, when the message size is larger than mtusize, tcp is required to be used), the accepted route in routing table is also required to have matched protocol. If there.s no such route, default transport of that protocol will be used.
    If all cases failed, sip.transport.0.s protocol will be obtained. The default transport of the obtained protocol will be used.
    Note that [Metric] entry is needed but not used at this point.
    For example: sip.route.dest.0=138.120.72.0 255.255.255.0 1 0
    When we make a call to the machine 138.120.72.20, outgoing IP is masked with [netmask] using .bitwise AND. operator. In this case: 138.120.72.20 & 255.255.255.0 gives 138.120.72.0. This matches the defined [Destination] in the route. Therefore, transport in sip.transport.1 will be used.

    Default value

    (blank)

    Takes effect At start/restart

    route.dest.4

    Route Destination Instance 4

    This is an entry in routing table.
    Format: sip.route.dest.x=[Destination] [Netmask] [Transport] [Metric]
    To select an entry in routing table, we mask the outgoing IP Address with [Netmask]; if the result matches with the [Destination], we will accept that route. The [Transport] part determines the transport to use and maps to the index 'x' in one of the transports defined as sip.transport.x. In most of the cases, first accepted route will be used. Unless the protocol is specified or required (for example, when the message size is larger than mtusize, tcp is required to be used), the accepted route in routing table is also required to have matched protocol. If there.s no such route, default transport of that protocol will be used.
    If all cases failed, sip.transport.0.s protocol will be obtained. The default transport of the obtained protocol will be used.
    Note that [Metric] entry is needed but not used at this point.
    For example: sip.route.dest.0=138.120.72.0 255.255.255.0 1 0
    When we make a call to the machine 138.120.72.20, outgoing IP is masked with [netmask] using .bitwise AND. operator. In this case: 138.120.72.20 & 255.255.255.0 gives 138.120.72.0. This matches the defined [Destination] in the route. Therefore, transport in sip.transport.1 will be used.

    Default value

    (blank)

    Takes effect At start/restart

    route.dest.5

    Route Destination Instance 5

    This is an entry in routing table.
    Format: sip.route.dest.x=[Destination] [Netmask] [Transport] [Metric]
    To select an entry in routing table, we mask the outgoing IP Address with [Netmask]; if the result matches with the [Destination], we will accept that route. The [Transport] part determines the transport to use and maps to the index 'x' in one of the transports defined as sip.transport.x. In most of the cases, first accepted route will be used. Unless the protocol is specified or required (for example, when the message size is larger than mtusize, tcp is required to be used), the accepted route in routing table is also required to have matched protocol. If there.s no such route, default transport of that protocol will be used.
    If all cases failed, sip.transport.0.s protocol will be obtained. The default transport of the obtained protocol will be used.
    Note that [Metric] entry is needed but not used at this point.
    For example: sip.route.dest.0=138.120.72.0 255.255.255.0 1 0
    When we make a call to the machine 138.120.72.20, outgoing IP is masked with [netmask] using .bitwise AND. operator. In this case: 138.120.72.20 & 255.255.255.0 gives 138.120.72.0. This matches the defined [Destination] in the route. Therefore, transport in sip.transport.1 will be used.

    Default value

    (blank)

    Takes effect At start/restart

    routeset

    Route Set

    Defines a SIP route set for outbound calls. If defined, this route set will be inserted as the ROUTE header for all outgoing calls. This will force the platform to send the SIP messages via this defined route set.

    Each element in the routeset should be seperated by a comma. This parameter can be used to define outbound proxies. Note that this routeset does not apply to SIP REGISTER messages.

    sip.routeset = &lt;sip:ip/host;priority&gt;, ... e.g. sip.routeset=&lt;sip:p1.example.com;lr&gt;,&lt;sip:p2.domain.com;lr&gt;

    In this example, the Genesys Voice platform will route the request to p1.example.com, which will in turn route the message to p2.domain.com, and finally be redirected to its intended destination.

    Valid values

    A valid routeset must have the format as specify in its description

    Default value

    (blank)

    Takes effect At start/restart

    securerouteset

    Secure Route Set

    Defines a SIPS route set for SIPS outbound calls. If defined, this route set will be inserted as the ROUTE header for all outgoing calls. This will force the platform to send the SIP messages via this defined route set.

    Each element in the routeset should be seperated by a comma. This parameter can be used to define outbound proxies. Note that this routeset does not apply to SIP REGISTER messages.

    sip.securerouteset = &lt;sips:ip/host;priority&gt;, ... e.g. sip.securerouteset=&lt;sips:p1.example.com;lr&gt;,&lt;sips:p2.domain.com;lr&gt;

    In this example, the Genesys Voice platform will route the request to p1.example.com, which will in turn route the message to p2.domain.com, and finally be redirected to its intended destination.

    Valid values

    A valid secure routeset must have the format as specify in its description

    Default value

    (blank)

    Takes effect At start/restart

    sessionexpires

    Session Expires

    Defines the default session expiry value in seconds. The session timer defines the duration of which a SIP session will expire if no re-INVITEs are sent/received within this period.

    Valid values

    The parameter size must be between 90 and 3600

    Default value

    1800

    Takes effect At start/restart

    threadpoolsize

    Threadpool Size

    The size of the thread pool for handling DNS queries.

    Valid values

    The size of the thread pool for handling DNS queries

    Default value

    4

    Takes effect At start/restart

    threads

    Number of Worker Threads

    Specifies the number of worker threads that handles the SIP requests arriving from the SIP transport layer. If the value is 0, all requests are handled within the arriving transport layer thread. Otherwise, all arriving requests are handled by hashing onto the N number of worker threads.

    Default value

    0

    Takes effect After restart

    timer.ci_proceeding

    Client Invite Proceeding Timer

    Defines the client INVITE proceeding timer in milliseconds, default value is 120000. The timer starts after a 1xx response is received for a client INVITE. If a final response is not received before the timer expires, the SIP session and dialog will be destroyed without further notice to the UAS. Note that the CI proceeding timer should be configured to be greater than the connect timeout. This ensures that a CANCEL will be sent to terminate the SIP session properly when connect timeout occurs.

    Valid values

    sip.timer.ci_proceeding must be greater than 0

    Default value

    120000

    Takes effect At start/restart

    transport.0

    Transport Instance 0

    defines transport layer for SIP stack and the network interfaces that are used to process SIP requests Format: sip.transport.x = transport_name
    type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters. Note that this is for LMSIP2.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport0 udp:any:5068

    Takes effect At start/restart

    transport.1

    Transport Instance 1

    defines transport layer for SIP stack and the network interfaces that are used to process SIP requests Format: sip.transport.x = transport_name
    type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters. Note that this is for LMSIP2.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport1 tcp:any:5068

    Takes effect At start/restart

    transport.2

    Transport Instance 2

    defines transport layer for SIP stack and the network interfaces that are used to process SIP requests Format: sip.transport.x = transport_name
    type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters. Note that this is for LMSIP2.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport2 tls:any:5069 cert=$InstallationRoot$\config\x509_certificate.pem key=$InstallationRoot$\config\x509_private_key.pem

    Takes effect At start/restart

    transport.3

    Transport Instance 3

    defines transport layer for SIP stack and the network interfaces that are used to process SIP requests Format: sip.transport.x = transport_name
    type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters. Note that this is for LMSIP2.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    (blank)

    Takes effect At start/restart

    transport.4

    Transport Instance 4

    defines transport layer for SIP stack and the network interfaces that are used to process SIP requests Format: sip.transport.x = transport_name
    type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters. Note that this is for LMSIP2.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    (blank)

    Takes effect At start/restart

    transport.5

    Transport Instance 5

    defines transport layer for SIP stack and the network interfaces that are used to process SIP requests Format: sip.transport.x = transport_name
    type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters. Note that this is for LMSIP2.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    (blank)

    Takes effect At start/restart

    [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