Configuring SIS Instance Parameters

Name of the new SIS instance. This name is used for the Service Interaction Manager resource adaptor entity. Each resource adaptor entity in the SLEE must have a unique name.

An optional arbitrary description for the SIS instance.

Default timeout period, measured in milliseconds, used by the SIS when waiting for a response to an event from a service or extension component.

Number of processing threads available for handling internal SIS tasks.

The size of the queue used for tasks awaiting the availability of a processing thread. If the queue is full, a subsequent task will be executed by the thread generating the task. If 0 is specified for the queue size, an unbound queue is used.

The maximum number concurrent active compositions the SIS will allow. This is to prevent the SIS from consuming excessive memory if composition state is not cleaned up due to an internal error. If the limit is reached, requests that attempt to start new compositions will be rejected with a 503 error response. A value of zero disables limiting.

SIS auditing level — valid values are ALL, COMPONENT, and NONE

Boolean flag indicating whether the fine-grained tracing facilities on the SIS are enabled (true) or disabled (false).

Specifies session replication is enabled. Possible values are disabled, enabled, or automatic. The value automatic means replication is enabled if the SIS’s Rhino namespace supports the key-value store replication method.

If true, and session replication is enabled, then all sessions are replicated. If false, and session replication is enabled, then a session is only replicated on demand, when the application calls SipSession.startReplicating().

Boolean flag indicating if "100 Trying" responses should be automatically sent whenever an INVITE is received.

Boolean flag indicating if "Supported: 100rel" headers should be automatically added to to outgoing requests in UAC mode.

Boolean flag indicating if the SIS should rewrite headers that contain embedded dialog IDs, when forwarding requests between dialogs as a B2BUA. This is so that user agents on one side of the B2BUA don’t see Dialog IDs from the other side, which wouldn’t be recognised.

Applies to Target-Dialog and Replaces headers, including Replaces header values inside a Refer-To header.

Boolean flag indicating if the SIS should add an offset to its configured SIP ports. Used when there are multiple SIS nodes on the same host.

If Offset ports is enabled, then the value of Node ID - Port offset is added to the SIS’s SIP port numbers. This value should match the lowest node ID in the cluster.

Number of processing threads available to the SIP stack for handling incoming messages.

The size of the queue used for tasks awaiting the availability of a processing thread. If the queue is full, the SIP stack will drop the message (UDP) or temporarily suspend reads on the socket (TCP and TLS). If 0 is specified for the queue size, an unbound queue is used.

Number of processing threads for handling TCP I/O. TCP connections will be divided between the I/O threads.

Specifies the status code to be used in an error response sent when an initial request or mid-dialog failover request is rejected due to rate limiting. This must be a 5xx error code.

Specifies the Retry-After header value when an initial request or mid-dialog failover request is rejected due to rate limiting with a 500 or 503 error response. This is an integer value indicating the number of seconds after which the SIS expects to be available again.

If a negative value is specified then a Retry-After header will not be included in relevant responses.

Specifies whether to use RFC 3263 failover and load balancing. By default this is disabled, to match existing behaviour. If enabled, the SIS uses RFC 3263 DNS procedures to find possible servers and automatically fails over to backup servers where available. If multiple servers are found in DNS they are sorted and tried according to their SRV priority and weight as per RFC 3263. If disabled, the DNS procedures are still used to find server addresses, but only the first address is used.

Specifies the duration of the failover timer in milliseconds. If RFC 3263 failover is enabled and this timer expires before any responses were received, the SIS treats this as a transport error and tries sending the request to the next available server. This timer should be set to a value smaller than the default Timer B and Timer F timers (32s) so that failures can be detected promptly. A value of zero or less disables this timer.

The duration in milliseconds for which a server will be "blacklisted" after a failure is detected. This avoids the SIS trying to contact the server immediately after a failure, when it is probably just going to fail again. After this time has passed, the failed server may be tried again on subsequent client transactions. If a server specifies a Retry-After duration in a 503 response, that value will be used instead. If this property is zero or less, then no blocking of failed addresses will occur.

The maximum size, in bytes, of SIP requests that may be sent sent using UDP. Requests larger than this will automatically be sent using TCP, as per RFC3261 §18.1.1. Values of zero or less disable this feature; the SIS will try to send with UDP anyway. This is not recommended as fragmentation and packet loss are more likely with large UDP datagrams.

Specifies whether to reject requests that arrive with a Route or Request-URI that the SIS does not recognize as its own address.

If true (default), the SIS rejects these requests with 403 for initial requests and 481 for mid-dialog requests.

If false, the SIS will attempt to forward the request to the next hop, which could cause unexpected behaviour such as routing loops.

The time (ms) at which an automatic 100 Trying response must be sent for all non-INVITE server transactions, regardless of transport protocol, as per RFC 4320.

Should almost always be left at the default of 3500ms, unless it is known that the network uses T1 and T2 values that differ from SIP defaults.

Non-INVITE server transactions on unreliable transports (UDP) always use this timer value.

A value of zero means the 100 Trying response is sent immediately.

Negative values disable this behaviour, so no automatic 100 Trying responses are sent.

The time (ms) at which an automatic 100 Trying response is sent for non-INVITE server transactions on TCP and other reliable transports, as per RFC 4320.

A negative value means inherit the configured Non-INVITE Trying Timer value (default 3500), this is the default setting. Otherwise a value between zero and Non-INVITE Trying Timer may be configured.

A value of zero means the 100 Trying response is sent immediately.

If Non-INVITE Trying Timer is disabled, this setting is ignored and no automatic 100 Trying responses are sent.

Specifies whether to redact DTMF signals in SIP message traces sent to SAS. Applies to INFO requests with the "application/dtmf-relay" Content-Type. If true, SAS traces of these requests will have the DTMF signal characters replaced with "-", to prevent sensitive information leaking via SAS.

Optional comma-separated list of alternative hostnames that the SIS is known by, such as virtual IP addresses and hostnames in a cluster. When making routing decisions, the SIS will consider these names to be local.

The IP address or hostname for the SIS. The SIS will listen on this address. The address "AUTO" will automatically select the node’s primary IP address, for convenience and use in a cluster, where each node has its own IP address.

Port that will be used for unencrypted SIP transports (UDP, TCP).

Port that will be used for encrypted SIP transports (TLS).

SIP transports to be supported by the SIS. This is a comma-separated list containing one or more of UDP, TCP or TLS.

Specifies an IP address or hostname that will be used in the "sent-by" field of Via headers added by the SIS. If a value is not specified the SIS will use the local IP address of the node. In some scenarios it may be necessary to specify a value to use a virtual server address.

Name of the root configuration profile table where the root configuration profile will be created. This defaults to the name specified for IN configurations during SIS installation.

Name of the root configuration profile to create for the SIS instance. This defaults to the SIS instance name.

Name of the profile table used to store SIS macros.

Name of the profile table used to store SIS triggers.

Name of the profile table used to store SIS compositions.

Name of the profile table used to store SIS interceptors.

Name of the profile table used to store SIS network interface definitions.

Name of the profile table used to store SIS network routes.

Name of the profile table used to store SIS extension component references.

Name of the profile table used to store SIS service references.

Name of the profile table used to store SIS interceptor references.

Name of the profile table used to store SIS external platform definitions.

Name of the profile table used to store SIS composition-provisioning information for triggerable addresses.

Name of the profile table used to store fine-grained tracing information for arbitrary addresses that may appear in initial events.

Name of the profile table used to store experimental feature settings.

Name of the new SIS instance. This name is used for the Service Interaction Manager resource adaptor entity. Each resource adaptor entity in the SLEE must have a unique name.

An optional arbitrary description for the SIS instance.

Default timeout period, measured in milliseconds, used by the SIS when waiting for a response to an event from a service or extension component.

Number of processing threads available for handling internal SIS tasks.

The size of the queue used for tasks awaiting the availability of a processing thread. If the queue is full, a subsequent task will be executed by the thread generating the task. If 0 is specified for the queue size, an unbound queue is used.

Maximum number of concurrent network dialogs the SIS will allow before rejecting new first-party conducted dialogs. A value of zero disables limiting.

SIS auditing level — valid values are ALL, COMPONENT, and NONE

Boolean flag indicating whether the fine-grained tracing facilities on the SIS are enabled (true) or disabled (false).

The period of inactivity on a dialog, measured in milliseconds, before the SIS will attempt to query the liveness of the dialog, if possible, via the ActivityTest operation or some other means. The minimum period that can be specified is 1000ms. The maximum is 86400000ms (one day). A value of 0 will disable this feature.

SCCP address used by the SIS as the destination for dialog open requests created for third party call setup attempts initiated by services using an InitiateCallAttempt request. This setting is optional but must be specified in order for third-party call support to be enabled in the SIS. See also SCCP Address Format.

Name of the root configuration profile table where the root configuration profile will be created. This defaults to the name specified for IN configurations during SIS installation.

Name of the root configuration profile to create for the SIS instance. This defaults to the SIS instance name.

Name of the profile table used to store SIS macros.

Name of the profile table used to store SIS triggers.

Name of the profile table used to store SIS compositions.

Name of the profile table used to store SIS interceptors.

Name of the profile table used to store SIS network interface definitions.

Name of the profile table used to store SIS network routes.

Name of the profile table used to store SIS extension component references.

Name of the profile table used to store SIS service references.

Name of the profile table used to store SIS interceptor references.

Name of the profile table used to store SIS external platform definitions.

Name of the profile table used to store SIS composition-provisioning information for triggerable addresses.

Name of the profile table used to store SIS composition-provisioning information for triggerable service keys.

Name of the profile table used to store configuration information for services that the SIS fires events to.

Name of the profile table used to store fine-grained tracing information for arbitrary addresses that may appear in initial events.

Name of the profile table used to store experimental feature settings.