[Common]

enable-ipv6

Enables IPv6 for SIP-Server connection

T-library configuration parameter to enable SSG using IPv6 for connecting with SIP-Server

Valid values

  • 1
  • 0

Default value

1

Takes effect At start/restart

[ems]

logconfig.MFSINK

MF Sink Log Filter

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

Valid values

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

Default value

*|*|*

Takes effect immediately

logconfig.TRAPSINK

SNMP Trap Sink Log Filter

Specifies the metrics that are delivered to the SNMP Trap Sink.

Default value

*|*|*

Takes effect At start/restart

[fm]

http_proxy

HTTP Proxy

The HTTP proxy to be used for HTTP requests

Default value

(blank)

Takes effect At start/restart

request_wait_time

HTTP Request Wait time

Controls Fetching module Request wait time. Specified in milli-seconds

Default value

5000

Takes effect At start/restart

[HTTP]

CertFile

HTTPS Certificate File Name

Name of the HTTPS Server Certificate file.

Default value

$InstallationRoot$/config/x509_certificate.pem

Takes effect After restart

CertKeyFile

HTTPS Cert Key file

Name of the HTTPS Server Certificate Key file.

Default value

$InstallationRoot$/config/x509_private_key.pem

Takes effect After restart

CertPassword

HTTPS Cert Password

Password for accessing the HTTP Server Certificate Key File.

Default value

(blank)

Takes effect After restart

HTTPDefaultPage

Default HTTP Page

Default HTTP Page, being used by SSG for storing the outbound requests.

Default value

SSG

Takes effect After restart

HTTPPort

HTTP Port

Describes the port on which HTTP requests can be received from client applications.

Default value

9800

Takes effect After restart

HTTPSPort

HTTPS Port

Describes the port on which HTTPS requests can be received from client applications.

Default value

9801

Takes effect After restart

TLSType

Secure protocol version

Name of the secure protocol with version information.

Valid values

  • SSLv23
  • SSLv3
  • SSLv2
  • TLSv1

Default value

SSLv23

Takes effect After restart

[log]

all

Output for level all

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

Valid values

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

    ../logs/SSG

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

    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

    7 day

    Takes effect immediately

    interaction

    Output for level interaction

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

    Valid values

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

    ../logs/SSG

    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 Standard level. The log output types must be separated by a comma when more than one output is configured.

    Valid values

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

    ../logs/SSG

    Takes effect immediately

    time_convert

    Time generation for log messages

    Specifies the system in which an application calculates the log record time when generating a log file. The time is converted from the time in seconds since the Epoch (00:00:00 UTC, January 1, 1970).
  • Local Time (local) The time of log record generation is expressed as a local time, based on the time zone and any seasonal adjustments. Time zone information of the application's host computer is used.
  • Coordinated Universal Time (utc) The time of log record generation is expressed as Coordinated Universal Time (UTC).
  • Valid values

    • local
    • utc

    Default value

    local

    Takes effect immediately

    trace

    Output for level trace

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

    Valid values

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

    ../logs/SSG

    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

    [PageCollector]

    [SSG]

    CleanIntervalSecs

    Clean Interval

    Interval in seconds that determines how frequently SSG removes expired or completed requests from the DB.

    Default value

    180

    Takes effect After restart

    ClientPortToTServer

    SSG Client Side TCP Port for TServer Connection

    The local client side TCP port to be used for T-Lib transport. If this parameter is not specified, SSG will let the OS choose the local port.

    Default value

    (blank)

    Takes effect After restart

    ConnRetryIntervalSecs

    SIPS Connection Failure Recovery Interval

    SSG attempts to re-connect to SIP Server in case of connection failure with SIP Server continuously in this interval.

    Default value

    120

    Takes effect After restart

    fips_enabled

    FIPS Mode Enabled

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

    Valid values

    • True
    • False

    Default value

    False

    Takes effect After restart

    InitiatedCallRetryFlag

    Initiated Call Retry flag

    This parameter specifies how to process the requests present in the DB when SSG comes up. If the parameter value is set to 0 (zero), SSG deems all the initiated requests during SSG startup as failures and invokes notification URL for these requests. If it is set to 1, then SSG retries those requests. If the value is set to 2, then SSG deletes requests which are new and initiated. If the value is set to 3, then SSG deletes all the database requests

    Valid values

    • 0
    • 1
    • 2
    • 3

    Default value

    1

    Takes effect After restart

    MaxAttemptsLimit

    Maximum Attempts Limit

    The maximum attempts allowed (as system-wide upper limit) for outbound call requests from customer application.

    Default value

    25

    Takes effect After restart

    MaxDBConnPoolSize

    Max DB Connection Pool Size

    The maximum number of database connections kept alive for use in SSG.

    Default value

    7

    Takes effect After restart

    MinDBConnPoolSize

    Min DB Connection Pool Size

    The minimum number of database connections kept alive for use in SSG.

    Default value

    3

    Takes effect After restart

    pacing.BatchLimit

    Request Batch Size

    Total Number of requests, being fetched from DB in to the memory queue for processing in each cycle. If 'TotalPorts' is configured, SSG uses GVP total port capacity as obtained from SIP-S EventResourceInfo as the batch limit. if 'AvailPorts' is configured, SSG uses current available port capacity as obtained from SIP-S EventResourceInfo as the batch limit. Otherwise,user can configure any integer value as string, which will used as the fetching limit.

    Default value

    TotalPorts

    Takes effect After restart

    pacing.caps.CallRequestsPerSecond

    Max Calls/Sec to SIP Server

    This parameter controls the maximum calls per second that SSG shall initiate via SIP Server

    Default value

    30

    Takes effect After restart

    pacing.EqualPriorityToNewAndOld

    Equal Priority between Old and New

    In each fetch cycle from db, SSG gives equal priority to New and Old records if flag is set to true. Otherwise, New and Old records are not differentiated. If this option is set to true, increased DB fetches may result in some performance degardation.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect After restart

    pacing.NextRetryIntervalSecs

    Next Retry Interval

    This parameter dicates after how many seconds the call will be retried when temporary internal errors occur.

    Default value

    10

    Takes effect After restart

    pacing.PortLoadFactor

    Port Load Factor

    This parameter dictates how many outbound calls are inititated by SSG at a time. This is a % of the current GVP available port capacity.

    Default value

    100

    Takes effect After restart

    pacing.QLowWatermark

    Queue Low Watermark

    When In-Memory queue falls below this pre-defined % of total Batch Limit, SSG activates next fetching cycle.

    Default value

    25

    Takes effect After restart

    pacing.SlotCalculation

    Application Slot Calculation

    This parameter dictates how many records are allotted for an application in each database dip in every fetch cycle. If 'Proportionate' is configured, BatchLimit is divided among applications in the same ratio as their pending requests. if 'Equal' is configured, BatchLimit is divided equally among applications.

    Valid values

    • Proportionate
    • Equal

    Default value

    Proportionate

    Takes effect After restart

    RegRetryIntervalSecs

    Resource DN Registration Failure Recovery Interval

    SSG attempts to re-register the Resource DN in case of registraion failure with SIP Server continuously in this interval.

    Default value

    120

    Takes effect After restart

    ReqAccOnResourceDNErrTimeoutSecs

    Request Acceptance Time-Out on Resource DN Registration Failure

    SSG rejects new requests from tenant applications if SSG fails to register Resource DN with SIP Server after the above time-out.

    Default value

    900

    Takes effect After restart

    ReqAccOnSIPSConnErrTimeoutSecs

    Request Acceptance Time-Out on SIPS Connection Failure

    SSG rejects new requests from tenant applications if SSG fails to connect to SIP Server after the above time-out.

    Default value

    900

    Takes effect After restart

    TimeToLiveLimitMins

    TimeToLive Limit

    The maximum duration allowed (as system-wide upper limit) for outbound call requests from customer application.

    Default value

    1440

    Takes effect After restart

    [Tenant1]

    AccessGroup

    Name of the Access Group

    The Access Group controls enabling of Digest Authentication for a tenant. The users configured under access group are allowed to send HTTP requests to SSG.

    Default value

    (blank)

    Takes effect After restart

    DialPrefix

    Dial Prefix

    The dial prefix, if present, will be prepended to all the target numbers. This applies to all outbound calls (across all IVR profiles) for the tenant. The dial prefix can be used, for example, to select a specific trunk in SIP Server or to select a specific ROUTE in PSTN Connector or to pass some predefined numbers to the switch (if the outbound call is going out via a switch) or any combination of these. Please see GVP User Guide for more details. This parameter is optional.

    Default value

    (blank)

    Takes effect After restart

    RPDN

    Routing Point DN

    The Routing Point DN is used by SSG to make outbound calls in case of Legacy GVP VXML Interpreter is used to play the IVR

    Default value

    (blank)

    Takes effect After restart

    TGDN

    Trunk Group DN

    The Trunk Group DN parameter is used by SSG to fetch the resource information like available ports, total ports etc and also to make outbound calls in case of Next Generation VXML Interpreter is used to play the IVR. The tenant name is same as TGDN.

    Default value

    (blank)

    Takes effect After restart