SIP parameters

Below are SIS parameters for SIP general settings, network settings, default network interface settings, and profile tables.

SIP general settings

Parameter Description Example 
 Name

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.

 
 sis-sip
 
 Description

An optional arbitrary description for the SIS instance.

 
 My SIP SIS
 
 Default service timeout

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

 
 5000
 
 SIS worker pool size

Number of processing threads available for handling internal SIS tasks.

 
 4
 
 SIS worker queue size

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.

 
 50
 
 Maximum compositions

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.

 
 0
 
 Audit level

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

 
 NONE
 
 Fine-grained tracing enabled

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

 
 false
 
 Session replication mode

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.

 
 automatic
 
 Replicate by default

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().

 
 false

SIP network settings

Parameter Description Example 
 Automatic 100 Trying support

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

 
 true
 
 Automatic 100rel support

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

 
 true
 
 Automatic Dialog ID Rewriting Enabled

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.

 
 true
 
 Offset ports

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.

 
 false
 
 Port offset

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.

 
 101
 
 SIP worker pool size

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

 
 4
 
 SIP worker queue size

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.

 
 500
 
 TCP I/O threads

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

 
 1
 
 [[rate-limited-error-response-status-code]]Rate-limited error response status code

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.

 
 500
 
 Retry-After period

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.

 
 -1
 
 RFC3263 Failover Enabled

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.

 
 false
 
 RFC3263 Failover Timer

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.

 
 10000
 
 RFC3263 Blacklist 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.

 
 300000
 
 UDP Max Request Size

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.

 
 1300

SIP default network interface settings

Parameter Description Example 
 Virtual addresses

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.

 
 sis1.mydomain.com, sis2.mydomain.com
 
 IP address

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.

 
 AUTO
 
 Port

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

 
 5060
 
 Secure port

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

 
 5061
 
 SIP transports

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

 
 UDP,TCP
 
 Via sent-by address

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.

 
 sis.mydomain.com

SIP profile tables

Parameter Description Example 
 Root configuration profile table name

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.

 
 sis-configs-sip
 
 Root configuration profile name

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

 
 sis-sip
 
 Macros profile table name

Name of the profile table used to store SIS macros.

 
 sis-sip-macros
 
 Triggers profile table name

Name of the profile table used to store SIS triggers.

 
 sis-sip-triggers
 
 Compositions profile table name

Name of the profile table used to store SIS compositions.

 
 sis-sip-compositions
 
 Interceptors profile table name

Name of the profile table used to store SIS interceptors.

 
 sis-sip-interceptors
 
 Network Interface Definitions profile table name

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

 
 sis-sip-network-interfaces
 
 Network Routes profile table name

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

 
 sis-sip-network-routes
 
 Extension References profile table name

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

 
 sis-sip-extension-refs
 
 Service References profile table name

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

 
 sis-sip-service-refs
 
 Interceptor References profile table name

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

 
 sis-sip-interceptor-refs
 
 External Platform Definitions profile table name

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

 
 sis-sip-ext-platforms
 
 Address Subscriptions profile table name

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

 
 sis-sip-address-subscriptions
 
 Trigger Address Tracing profile table name

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

 
 sis-sip-trigger-address-tracing
 
 Experimental Features profile table name

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

 
 sis-sip-experimental-features

IN parameters

Below are SIS parameters for IN general settings, network settings, default network interface settings, and profile tables.

IN general settings

Parameter Description Example 
 Name

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.

 
 sis-in
 
 Description

An optional arbitrary description for the SIS instance.

 
 My IN SIS
 
 Default service timeout

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

 
 2000
 
 SIS worker pool size

Number of processing threads available for handling internal SIS tasks.

 
 2
 
 SIS worker queue size

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.

 
 5000
 
 Maximum dialogs

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

Note Assisting and third-party call dialogs are never rejected by the SIS because of maximum dialog limiting, but do contribute towards the total network dialog count. 
 0
 
 Audit level

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

 
 NONE
 
 Fine-grained tracing enabled

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

 
 false

IN network settings

Parameter Description Example 
 Query-liveness period

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.

 
 180000
 
 ICA proxy SCCP address

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.

 
 type=C7,ri=pcssn,pc=201,ssn=100

IN default network interface settings

Below are general default network interface settings, followed by those specific to the ocss7, signalware, and tcapsim stacks.

Note
Using TCAP stacks

IN general default network interface settings

Parameter Description Example 
 Local SCCP address

SCCP address assigned to the SIS instance, included in dialog open requests sent by the SIS instance to the network. TIP: See also SCCP Address Format and Administering the CGIN Resource Adaptor Entity.

 
 type=C7,ri=pcssn,pc=202,ssn=101
 
 Responder SCCP address

SCCP address used by the SIS when sending responses to received dialog open requests. This setting is optional and only needs to be specified if an address different to that filled in by the TCAP stack when sending open responses is required. See also SCCP Address Format.

 
 type=C7,ri=pcssn,pc=202,ssn=101
 
 Default TCAP invoke timeout

The timeout period, measure in milliseconds, the SIS uses whenever it needs to send invoke requests to the network.

 
 5000
 
 Default dialog activity timeout

The default timeout period, measured in milliseconds, for dialogs with no activity before they are terminated.

 
 1800000
 
 TCAP fibers maximum pool size

The maximum number of threads in the TCAP layer fiber pool. If zero, then a pool is not used: work is done directly in the I/O thread.

 
 4
 
 TCAP fibers queue size

The maximum number of waiting fibers in the TCAP layer fiber pool.

If the queue becomes full and there are less than the maximum number of worker threads, a new thread is started. If the queue is full and no more threads are permitted, then subsequent fiber tasks are executed directly by the calling thread (usually the I/O thread).

A zero-sized queue is possible and implies that work is either immediately assigned an idle thread, or the work is done by the calling thread.

 
 250
 
 Inbound ACN mappings

Activity Context Name mappings for inbound dialogs: a comma-separated list of values in <external OID>:<internal ASN.1 or interceptor> format. Allows the SIS to be reconfigured to accept the external application context name as a synonym for the internal application context name. An external ACN can be mapped to only one internal ACN. Several external ACNs can be mapped to the same internal ACN. The righthand side of each mapping can either name an application context valueref (such as etsi_inap_cs1.core-INAP-CS1-SSP-to-SCP-AC, or it can name the interceptor to use to determine the AC to use (such as map.phase-1).

 
 1.2.34.567.8.9.0.1:etsi_inap_cs1.core-INAP-CS1-IP-to-SCP-AC
 
 Outbound ACN mappings

Activity Context Name mappings for outbound dialogs: a comma-separated list of values in <internal ASN.1>:<external OID> format. Allows the SIS to be reconfigured to write the external application context name in place of the internal application context name. An internal ACN can be mapped to only one external ACN. Multiple internal ACNs can be mapped to the same external ACN.

 
 etsi_inap_cs1.core-INAP-CS1-IP-to-SCP-AC:1.2.34.567.8.9.0.1
 
 Relaxed BER decoding rules

Specifies whether or not to relax the BER decoding rules to allow certain types of malformed data. If false, then the BER rules are strictly enforced and malformed data will be rejected.

 
 false
 
 TCAP stack

Name of the TCAP stack for the SIS to use. Three stacks are currently supported: ocss7, a TCAP stack that connects to one or more TCAP Manager (SGC) processes, signalware, a TCAP stack that connects to one or more backend processes running on Mavenir Signalware, and tcapsim, a simulated TCAP stack that does not require any specific hardware.

 
 ocss7

IN default network interface settings specific to the OC SS7 stack

Note

  • These parameters only need valid values if using the ocss7 TCAP stack.
Parameter Description Example 
 SGCs

Comma-separated list of host:port OC SGC data ports which the TCAP stack will connect to. The TCAP stack will attempt to establish a connection to all of the configured host:port pairs. For use with OCSS7 1.1.0 and newer.

 
 ocss71:8081,ocss72:8081
 
 URL List

Comma-separated list of host:port locations where the SIS instance can expect to find OC SS7 SGC TCAP Manager processes running and listening for connections from the SLEE. The TCAP stack will attempt to establish a connection to one of the configured TCAP managers on a round robin basis. For use with OCSS7 1.0.1 and older.

 
 ocss71:8080,ocss72:8080
 
 URL List Retry Interval

The wait interval in milliseconds between subsequent connection attempts to the TCAP Managers. This value applies to all TCAP manager connections.

 
 1000
 
 Local SSN

The subsystem number used when the Local SCCP Address property does not provide one, for example in the case when it is set to "auto".

 
 -1
 
 Open Transactions Capacity

The maximum number of open transactions (dialogs) at any moment in time.

 
 100000
 
 Max Scheduler Threads

The maximum number of threads used by the scheduler.

 
 10
 
 Scheduler Node List Size

The number of events that may be scheduled on a single scheduler thread. This value multiplied with the value for Max Scheduler Threads should be directly proportional to Open Transactions Capacity. 0 = autosize.

 
 0
 
 Waiting Tasks Capacity

The maximum number of inbound messages and timeout events that may be waiting to be processed at any moment in time. This value should be directly proportional to Open Transactions Capacity. 0 = autosize.

 
 0
 
 Worker Group Queues

The number of threads used by the worker group to process timeout events and inbound messages.

 
 100
 
 Worker Queue Size

The maximum number of tasks in one worker queue. This value multiplied with the value for Worker Group Queues should be directly proportional to (2 * Waiting Tasks Capacity). 0 = autosize.

 
 0
 
 Sender Queue Size

The maximum number of outbound messages in the sender queue. This value is directly proportional to Open Transactions Capacity. 0 = autosize.

 
 0
 
 Heartbeat Enabled

Enables the heartbeat between the TCAP stack and the SGC.

 
 true
 
 Heartbeat Period

The interval, in seconds, between successive heartbeat sends.

 
 5

IN network interface parameters specific to the Signalware stack

Note These parameters only need valid values if using the signalware TCAP stack.
Parameter Description Example 
 Backends

Comma-separated list of host:port locations where the SIS instance can expect to find Signalware backend processes running and listening for connections from the SLEE.

 
 signalware1:10001,signalware2:10001
 
 Base weight

Base incoming traffic weight advertised to backends.

This property is a comma-separated list that must include at least one numeric item — the weight value used by any node that does not explicitly specify a weight. Additional items may specify weights for particular nodes, using the form {nodeid,nodeid,…​}weight.

For example, the value 100,{101}50,{102,103}75 specifies a weight of 50 for node 101, a weight of 75 for nodes 102 and 103, and a default weight of 100 for all other nodes.

Each weight is a positive integer used to balance load between nodes. The values have no particular unit other than relative to each other. A node will receive new dialogs in proportion to its weight; for example, two nodes with weights of 10 will receive about the same number of dialogs each, and a node with a weight of 20 will receive twice as many as a node with a weight of 10.

Tip One approach is to treat them as percentages and assign 100 to the busiest node, with smaller values for nodes that take less load.

The actual weight used for a particular node is the base weight specified here, modified by the function defined by weight function below, based on the amount of traffic that node has processed.

 
 100
 
 Weight function

Definition of the weight function applied to "full-rate" weights to find the actual rate to use. This is used to gradually increase load on a newly-joined cluster node, so as not to immediately swamp it with traffic.

The function is specified as a series of comma-separated values S(1),T(1),S(2),T(2),…​,S(N-1),T(N-1),S(N) where:

  • S(i) is the multiplier (in the range [0.0 .. 1.0]) of the "full-rate" weight to use in state (i)

  • T(i) is the total number of dialogs that must be received on a particular node before moving to state (i+1).

 
 0.01,10,0.10,1000,0.50,5000,1.00
 
 Fiber map size

The number of fibers in the fixed-size fiber map used to process incoming traffic. This value must be at least as large as the value of the TCAP Fibers Queue Size property.

 
 256
 
 Dialog allocation timeout

The maximum time, in milliseconds, to block while waiting to allocate a new dialog before returning an error to the calling service code.

 
 5000
 
 Dialog pool size

The size of the pre-allocation pool for outgoing dialogs. This pool is used to satisfy requests for new outgoing dialogs, and is refilled asynchronously. If the pool becomes empty due to a high rate of dialog creation, outgoing dialogs must wait for the backend to allocate a new dialog, increasing latency.

One pool is maintained per backend connection.

 
 100

IN network interface parameters specific to the tcapsim stack

Note These parameters only need valid values if using the tcapsim TCAP stack.
Parameter Description Example 
 Global title translation table

Path to the file containing the global translation table description

 
 ${rhino.dir.home}${/}config${/}tcapsim-gt-table.txt
 
 Listen addresses

Comma-separated list of {nodeid,…​}host:port addresses to listen on for incoming connections from other Sim TCAP stacks.

 
 localhost:10100
 
 Remote addresses

Comma-separated list of {nodeid,…​}host:port addresses of other Sim TCAP stacks that should be connected to.

 
 localhost:10150
 
 Maximum dialogs

Maximum number of concurrent dialogs the stack can support.

 
 10000
 
 Base transport layer

Base transport layer used to carry SUA messages. Valid values are: tcp, sctp and auto. Default is tcp.

 
 tcp

IN profile tables

Parameter Description Example 
 Root configuration profile table name

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.

 
 sis-configs-in
 
 Root configuration profile name

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

 
 sis-in
 
 Macros profile table name

Name of the profile table used to store SIS macros.

 
 sis-in-macros
 
 Triggers profile table name

Name of the profile table used to store SIS triggers.

 
 sis-in-triggers
 
 Compositions profile table name

Name of the profile table used to store SIS compositions.

 
 sis-in-compositions
 
 Interceptors profile table name

Name of the profile table used to store SIS interceptors.

 
 sis-in-interceptors
 
 Network Interface Definitions profile table name

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

 
 sis-in-network-interfaces
 
 Network Routes profile table name

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

 
 sis-in-network-routes
 
 Extension References profile table name

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

 
 sis-in-extension-refs
 
 Service References profile table name

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

 
 sis-in-service-refs
 
 Interceptor References profile table name

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

 
 sis-in-interceptor-refs
 
 External Platforms profile table name

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

 
 sis-in-ext-platforms
 
 Address Subscriptions profile table name

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

 
 sis-in-address-subscriptions
 
 Service Key Subscriptions profile table name

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

 
 sis-in-service-key-subscriptions
 
 Service Configuration profile table name

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

 
 sis-in-service-configs
 
 Trigger Address Tracing profile table name

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

 
 sis-in-trigger-address-tracing
 
 Experimental Features profile table name

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

 
 sis-in-experimental-features
Previous page Next page
SIS Version 3.1.0