You are here: SwitchKit® Development Environment - Installation and Maintenance Guide > 2 Installation > List of Environment Variables

List of Environment Variables

This section provides the names of all of the environment variables available with SwitchKit. The environment variables are listed in alphabetical order and each is described indicating what it is used for. The variable name in the Defaults file is provided, along with the valid values for each variable.

Important! Environment variables should be set within the value ranges specified for each variable listed. Setting a variable outside this range will result in unexpected behavior.

The environment variables and the Defaults file are read at start-up by LLC and SwitchKit applications. To modify settings at run-time, you can use CSA. See the CSA User’s Guide.

SK_APP_ DISABLED_TIMEOUT

SK_APP_ DISABLED_TIMEOUT specifies the number of seconds that an application must be silent and fail to respond to pings before the LLC considers it unavailable.This value applies to all applications connected to the LLC. You can dynamically change this environment variable using the SwitchKit graphical user interface, CSA. See the Converged Services Administrator User’s Guide, "Changing Environment Variables at Run-Time."

Defaults file variable name

app_disabled_timeout

Valid Values

SK_APP_DISABLE_TIMEOUT = 15

Disconnect applications after 15 seconds (default)

SK_APP_DISABLE_TIMEOUT = 1 to 65535

Valid range for timeout

SK_AUTO_RETURN
_CHANNELS

SK_AUTO_RETURN_CHANNELS specifies whether a ChannelReleased message from the switch should trigger an automatic sk_returnChannel. The use of SK_AUTO_RETURN_CHANNELS is recommended because it simplifies application development. It also prevents a possible race condition, if an XL_ChannelReleased message is immediately followed by an XL_RequestForService, before the application has been able to return the channel. It defaults to 0 for backward compatibility.

Defaults file variable name

auto_return_channels

Valid Values

SK_AUTO_RETURN_CHANNELS = 0

– Disable (default)

SK_AUTO_RETURN_CHANNELS = 1

– Enable

SK_BACKUP_WHEN
_CLEARLOG

SK_BACKUP_WHEN_CLEARLOG controls whether a backup of log files will be saved when the clear log command is sent to the LLC.

Defaults file variable name

backup_when_clearlog

Valid Values

SK_BACKUP_WHEN_CLEARLOG = 0

– Disabled

SK_BACKUP_WHEN_CLEARLOG = 1

– Enabled (default)

SK_CHANNEL_RECOVERY_METHOD

SK_CHANNEL_RECOVERY_METHOD allows LLC control of the channel in case of an abrupt disconnect from an application that is controlling the channel.

Defaults file variable name

channel_recovery_method

Valid Values

SK_CHANNEL_RECOVERY_METHOD = 0

– OFF (default) channels owned by the application are left in their current state

SK_CHANNEL_RECOVERY_METHOD = 1

– Release the non-idle channels owned by the application

SK_CHANNEL_RECOVERY_METHOD = 2

– Take non-idle channels owned by the application out of service

SK_CHANNEL_RECOVERY_METHOD = 3

– Take all channels out-of-service within the watched channel group(s)

Note:

Methods 1 and 2 only affect non-idle channels (channels that are in active calls).

For Method 2 and 3, after you restart the application to watch the channel groups, you must bring the channels back in-service using the ForceGroupState message.

Method 3, will affect channels:

• in an entire group being watched using the sk_watchChannelGroup() function;

• that are not watched by any other applications;

• that are currently active only after they are released prior to being brought out-of-service.

SK_CSA_INSTALL_DIR

SK_CSA_INSTALL_DIR is set when CSA is installed. This environment variable is used by CSA to store the files it sends to Sw itch M ana g e r. The default path for the CSA installation is C:\Program Files\Cantata\CSA.

Important! Note: If this environment is not set then CSA will crash.

Defaults file variable name

csa_install_dir

Valid Values

SK_CSA_INSTALL_DIR = YourInstallationFolder

Example

SK_CSA_INSTALL_DIR = C:\Program Files\Cantata\CSA

SK_DEBUG_CHANNEL_MANAGER

Important! SK_DEBUG_CHANNEL_MANAGER should only be used after consulting with a Dialogic Technical Support representative.

Use this environment variable to enable logging of debug messages from the LLC channel manager. These messages will be logged in the messages.log.

SK_DEBUG_CHANNEL_MANAGER needs to be set in conjunction with SK_ENABLE_CHANNEL_OWNERSHIP_LOGGING.. For more information on channel state changes, see the description of SK_ENABLE_CHANNEL_ OWNERSHIP_LOGGING.

Defaults file variable name

debug_channel_manager

Valid Values

SK_DEBUG_CHANNEL_MANAGER = 1

– Enables channel manager debug logging

SK_DEBUG_CHANNEL_MANAGER = 0

– Disables channel manager debug logging (default)

SK_DISABLE_CSM

SK_DISABLE_CSM enables or disables LLC from sending the SK_ConnectionStatusMsg to all connected applications.

Defaults file variable name

disable_CSM

Valid Values

SK_DISABLE_CSM = 0

– LLC sends ConnectionStatusMsg to all applications (default)

SK_DISABLE_CSM = 1

– LLC does not send ConnectionStatusMsg to any application

SK_DISABLE_FILE_ ROLLOVER_LOGGING

SK_DISABLE_FILE_ROLLOVER_LOGGING disables the printing of the switch mid-plane query information banner and the connected SwitchKit application banners within the maintenance_llc.log.

Defaults file variable name

disable_file_rollover_logging

Valid Values

SK_DISABLE_FILE_ROLLOVER_LOGGING = 0

– Enables printing of information about each connected process when the log file rolls over (default)

SK_DISABLE_FILE_ROLLOVER_LOGGING = 1

– Disables printing of information about each connected process when the log file rolls over

SK_DISABLE_PPL_EVENT_LOGGING

Set SK_DISABLE_PPL_EVENT_LOGGING to stop the SwitchManager from printing identified PPL events to an alarm.log file.

Defaults file variable name

disable_ppl_event_logging

Valid Values

SK_DISABLE_PPL_EVENT_LOGGING = 0

– Enables logging of all identified PPL events (default)

SK_DISABLE_PPL_EVENT_LOGGING = 1

– Disables logging of all identified PPL events

SK_DISABLE_PPL_UNKNOWN_EVENT_LOGGING

Set SK_DISABLE_PPL_UNKNOWN_EVENT_LOGGING to stop the SwitchManager from printing unknown PPL events to an alarm.log file.

Defaults file variable name

disable_ppl_unknown_event_logging

Valid Values

SK_DISABLE_PPL_UNKNOWN_EVENT_LOGGING = 0

– Enables logging of all unknown PPL events (default)

SK_DISABLE_PPL_UNKNOWN_EVENT_LOGGING = 1

– Disables logging of all unknown PPL events

SK_DISPLAY_
CONNECTION_COUNT

SK_DISPLAY_CONNECTION_COUNT is used to enable the logging of the total number of applications connected to LLC any time an applications connects or disconnects.

Defaults file variable name

display_connection_count

Valid Values

SK_DISPLAY_CONNECTION_COUNT = 0

– No additional information will be logged (default).

SK_DISPLAY_CONNECTION_COUNT = 1

– Text similar to the following will be printed in the maintenance.llc.log each time a connection to an application or node is created or destroyed.

Example

Jun 19 2002 16:33:49: New Link - total created: 69 - active count: 5

Jun 19 2002 16:33:49: Destroyed Link - total created: 69 - active count: 4

If this environment variable is not defined, the usual text will be displayed when connections are created or destroyed.

SK_ENABLE_CHANNEL_ OWNERSHIP_LOGGING

Important! SK_ENABLE_CHANNEL_OWNERSHIP_LOGGING should only be used after consulting with a Dialogic Technical Support representative.

Use this environment variable to enable logging of the channel ownership changes which are then logged in messages.log. The logs include the channel state information as well as information about the application gaining/losing ownership.Channel ownership by an application can change for many reasons. Here are some examples:

• Gain of ownership

AllocateChannel (and AllocateChannelGroup)
RFS via the watchChannelGroup method
RequestChannel
requestOutseizedChannel
requestRouteControlledChannel)
TransferChannel (from another application)
Redundant Application Pool (RAP) switchover to new primary
Outsieze or routeControl on an unclaimed channel

• Loss of ownership

Transfer channel (to another application)
sk_returnChannel
ChannelReleased (withdata) message received from switch
DS0 of purge or out of service
Termination of application
Redundant Application Pool (RAP) switchover to new primary

SK_ENABLE_CHANNEL_OWNERSHIP_LOGGING needs to be set in conjunction with SK_DEBUG_CHANNEL_MANAGER.

Defaults file variable name

enable_channel_ownership_logging

Valid Values

SK_ENABLE_CHANNEL_OWNERSHIP_LOGGING = 1

– Enables logging of channel ownership

SK_ENABLE_CHANNEL_OWNERSHIP_LOGGING = 0

– Disables logging of channel ownership (default)

SK_FILE_CLOSEOUT_
HOUR

SK_FILE_CLOSEOUT_HOUR specifies the hour on which to cycle all managed log files. You may not want to set this variable, if you have already set SK_FILE_LIFETIME. You can dynamically change this environment variable using the SwitchKit graphical user interface, CSA. See the Converged Services Administrator User’s Guide, "Changing Environment Variables at Run-Time."

Defaults file variable name

file_closeout_hour

Valid Values

SK_FILE_CLOSEOUT_HOUR = 0

– File close-out midnight, local time (Default)

Valid values are integers 0-23. If SK_FILE_CLOSEOUT_HOUR = 7, all managed logs files will cycle at 7:00 AM local time. Be aware, the longer the log files remain open, the larger they grow. Large files can consume all available disk space and cause system errors. It is recommended that log files never remain open longer than 24 hours.

SK_FILE_LIFETIME

SK_FILE_LIFETIME specifies in hours the length of time log files are open. There is no minimum or maximum length of time. You may not want to set this variable, if you have already set SK_FILE_CLOSEOUT_HOUR. You can dynamically change this environment variable using the SwitchKit graphical user interface, CSA. See the Converged Services Administrator User’s Guide, "Changing Environment Variables at Run-Time."

Defaults file variable name

file_lifetime

Valid Values

SK_FILE_LIFETIME = 24

– Close logs every 24 hours (Default)

The valid range is 1-24

Any whole number of hours can be specified. Be aware, the longer the log files remain open, the larger they grow. Large files can consume all available disk space and cause system errors. It is recommend that log files never remain open longer than 24 hours.

Important! When you set the SK_FILE_LIFETIME variable and start the SwitchKit processes, the file is set to expire at the next nearest interval specified. If you set it to close every hour, it will close on the next hour (which is generally less than 60 minutes).

SK_FILE_MAX_SIZE

SK_FILE_MAX_SIZE specifies the size, in megabytes, to which the log file is allowed to grow before cycling. When a log cycles because the size is too big, any existing logging timers are not reset. The log will still cycle at the proper time. For example, assuming SK_FILE_LIFETIME = 1 and SK_FILE_MAX_SIZE = 1; if it is now 1:45 p.m. and the log file reaches one megabyte, the log will cycle at 1:45 p.m. The log will cycle again at 2:00 pm.

Defaults file variable name

file_max_size

Valid Values

SK_FILE_MAX_SIZE can be set to any positive integer value. There is no default value.

SK_HANDLER_BEHAVIOR

SK_HANDLER_BEHAVIOR allows you to customize the behavior of handlers within an application. The default handler or handler stack acts as a safety net if all other handlers invoked return SK_NOT_HANDLED. Currently, the default handler stack is used, if no other handlers are defined.

For example:

• If a channel handler is defined by an application and then a call processing message arrives, the message will be handed to the channel handler(s) or stack of channel handlers.

• If all the channel handlers return SK_NOT_HANDLED, then the message will be returned in the original call to sk_rcvAndDispatch().

• If a channel handler is not defined but a default handler is defined, then the message is handed to the default handler or stack of default handlers.

If SK_HANDLER_BEHAVIOR is set to SK_HDLR_BHVR_SAFETY_NET(1), a default handler will be used when the appropriate non-default handlers have returned SK_NOT_HANDLED.

In effect, the default handler stack acts as a safety net for all messages. In the above example, if a channel handler or handler stack is defined, and all handlers return SK_NOT_HANDLED, then the default handler or handler stack will be presented the message if defined and the SK_HANDLER_BEHAVIOR is enabled.

Important! The default handler or handler stack cannot act as a safety net to itself.

Defaults file variable name

handler_behavior

Valid Values

Use the following to set the bitmask:

SK_HDLR_BHVR_SAFETY_NET(1)

SK_LIB_DIR

SK_LIB_DIR specifies the location of the base directory of the SwitchKit installation. Must be set to the base directory of SwitchKit. If this variable is not set, LLC will terminate. Variable is automatically created for the default installation directory.

Important! When reinstalling SwitchKit on Windows NT®, SK_LIB_DIR gets overwritten.

Defaults file variable name

There is no default setting for SK_LIB_DIR.

SK_LLC_HOST

SK_LLC_HOST specifies what machine the LLC is running on.This environment variable should be set similarly on both the primary host and the redundant host. SK_LLC_HOST affects all client modules of the LLC. The value may be either a host name or an IP address.

Defaults file variable name

llc_host

Valid Values

SK_LLC_HOST = localhost

– local host (Default)

SK_LLC_PORT

SK_LLC_PORT specifies the port number of the host the LLC resides on. This environment variable should be set similarly on both the primary host and the redundant host. Each LLC and all applications that intend to connect to the LLC must have SK_LLC_PORT set to the same value in their environment.

Defaults file variable name

llc_port

Valid Values

SK_LLC_PORT = 1312

– Port 1312 (Default)

Valid values are 1024-32767

SK_LLC_RETRY_DELAY

SK_LLC_RETRY_DELAY specifies the delay between each LLC connection retry. This variable only applies to connections between the LLC and SwitchKit applications, not connections between the LLC and the CSP. For example, this variable can be used for connections between LLC and RLLC, LLC and SwitchManager, and between LLC and SwitchKit user applications.

Defaults file variable name

llc_retry_delay

Valid Value

SK_LLC_RETRY_DELAY = 2

– Retry connection every two seconds (Default)

Valid values include any integer.

Important! Dialogic recommends that this value not be changed from the default.

SK_LOG_LEVEL

SK_LOG_LEVEL specifies the EXS API message logging to be done by LLC. You can dynamically change this environment variable using the SwitchKit graphical user interface, CSA. See the Converged Services Administrator User’s Guide, "Changing Environment Variables at Run-Time." The possible options are to log to:

• socket.log

• messages.log

• and/or the screen output

Socket.log is the preferred log level.

Defaults file variable name

log_level

Valid Values

Use the following to set the bitmask:

SK_LOG_NONE (0)

– LLC will perform no EXS API message logging

SK_LOG_SOCKET (0x01)

– LLC will log EXS API messages to socket.log (default)

SK_LOG_MESSAGE (0x02)

– LLC will log EXS API messages to message.log

SK_LOG_SCREEN_OFF (0x04)

– LLC screen output is disabled

SK_LOG_DIR

SK_LOG_DIR specifies the directory where all SwitchKit log files that are generated on this host computer will be stored. If this variable is not set, log files will be stored in the directory from which the process was started. See Setting Environment Variables on Windows® XP or Setting Environment Variables on Windows® XP.

Defaults file variable name

log_dir

Valid Values

Default = None
Any network path that is read/write accessible.

SK_DIALOGUE_MONITOR

SK_DIALOGUE_MONITOR is used to activate the LLC's dialogue monitor.

Defaults file variable name

dialogue_monitor

Valid Values

SK_DIALOGUE_MONITOR=0

– -disables the LLC’s dialogue monitor (default)

SK_DIALOGUE_MONITOR=1

– - enables the LLC’s dialogue monitor

See LLC: Application Load Balancing for TCAP for more information on how to use the LLC’s dialogue monitoring capabilities.

SK_NO_DEFAULT
_CONNECTION

By default, LLC connections are established using the SK_LLC_HOST, SK_LLC_PORT, SK_RLLC_HOST and SK_RLLC_PORT definitions. When a connection is made, these values determine what LLC is connected to if sk_createConnection has never been called. Enabling SK_NO_DEFAULT_CONNECTION stops an application from using the environment settings to determine the LLC location. To establish the LLC connection, the application must call sk_createConnection. After the initial call, any time the LLC connection must be re-established, the data provided in the original sk_createConnection is used.

Defaults file variable name

no_default_connection

Valid Values

SK_NO_DEFAULT_CONNECTION = 0

– Establish connections based on environment definitions. Default.

SK_NO_DEFAULT_CONNECTION = 1

– Require sk_createConnection to establish connection to LLC.

SK_NUM_RETRIES_TO _LLC

SK_NUM_RETRIES_TO_LLC specifies the number of times an application will retry the connection to LLC before NACKing the request. This value applies to all applications, including Redundant LLC. It does not apply to the SwitchMgr.

Defaults file variable name

num_retries_to_llc

Valid Value

SK_NUM_RETRIES_TO_LLC = 0

– Retry connection to LLC once (Default)

SK_NUM_RETRIES_TO_LLC = 1

– Channel can only be released by application that initially requested the channel.

This variable may be set to any number of retries, but retries take time. The application will be waiting for a response the entire time. SK API is retrying to send the message.

SK_RETURN_CHANNEL_BY_OWNER_ONLY

SK_RETURN_CHANNEL_BY_OWNER_ONLY controls the channel release behavior related to the application that initially sent the channel request. When this environment variable is disabled, any application can return any channel.

Defaults file variable name

return_channel_by_owner_only

Valid Values

SK_RETURN_CHANNEL_BY_OWNER_ONLY = 0

– Feature disabled. Any application can return any channel. (Default)

SK_RETURN_CHANNEL_BY_OWNER_ONLY = 1

– Channel can only be released by application that initially requested the channel.

SK_RLLC_HOST

SK_RLLC_HOST specifies the IP Address of the host the redundant LLC resides on. This environment variable should be set similarly on both the primary host and the redundant host.

Defaults file variable name

rllc_host

Valid Values

SK_RLLC_HOST = localhost

– local host (Default)

SK_RLLC_PORT

SK_RLLC_PORT specifies the port number of the host the redundant LLC resides on. This environment variable should be set similarly on both the primary host and the redundant host. Each LLC and all applications that intend to connect to the RLLC must have SK_RLLC_PORT set to the same value in their environment.

Defaults file variable name

rllc_port

Valid Values

SK_RLLC_PORT = 1312

– Port 1312 (Default)

Valid values are 1024-32767

SK_SIP_UA_APPSELECT _OPTION

SK_SIP_UA_APPSELECT_OPTION allows load sharing of SIP user agent (UA) Accept Registration Requests. SIP UA load sharing can be enabled from a user application by sending a sk_pplComponentRegister(0xA7) and then setting the environment variable, with the appropriate option, on the host.

When enabled this load sharing feature will cause only one PPL event indication to be sent to a user application (CSA and Switchmgr will be excluded from the list). Because only a single PPLEventIndication is expected for each of these SIP transactions, it is not required that the LLC keep track of applications load. It will simply select the next registered application by using a round robin or randomizing algorithm.

Defaults file variable name

sip_ua_appselect_option

Valid Values

Value | Option | Description
--- | --- | ---
0 default | SIP_UA_BROADCAST | No load sharing. Sends to all registered applications.
1 | SIP_UA_RANDOMIZE | Sends to one randomly selected application.
2 | SIP_UA_ROUNDROBIN | Sends to one application, which is selected in a round robin manner. The first available application is selected; the selection process then proceeds through the applications, always choosing the next one available starting from the application it last selected.

SK_SOCKET_VALIDATE
_WAIT

When an application connects to LLC, a handshaking occurs through which critical information regarding the connection is exchanged. SK_SOCKET_VALIDATE_WAIT allows the time allocated to validate a client connection to the LLC to be changed.

Defaults file variable name

socket_validate_wait

Valid Values

SK_SOCKET_VALIDATE_WAIT = 3

– Allow three seconds for socket validation (Default)

This variable may be set to any number of seconds.

SK_LLC_SWITCHBACK_ MODE

SK_LLC_SWITCHBACK_MODE can be used by the LLC to determine whether to automatically switchback an LLC to its original Primary/Secondary configuration; or remain in its current fail-over configuration until told to do otherwise by the SK_LLC_CONTROL_START_SYNC_TLV in LLCControl.

Defaults file variable name

llc_switchback_mode

Valid Values

Value | Option | Description
--- | --- | ---
0 default | SB_PRIMARY_PREFERED_MODE | The LLC designated as Primary (no -r) will always attempt to gain control and become active. In the event that the primary active LLC receives a GO_STANDBY request, a switch-over will occur. Once synchronization is complete between the two LLCs a switchback will occur and the primary will regain control from the secondary.
1 | SB_MANUAL_MODE | Whichever LLC is currently active will remain active until told to GO_STANDBY manually by an LLCControl message. In the event that two LLCs are concurrently in the active state, and have been configured by an AddLLCNode message, the one that has been configured the longest will win arbitration. If the configuration times are equal then the Primary (no -r) will win arbitration. .

SK_TRANSFERCHAN_ OPTION

SK_TRANSFERCHAN_OPTION allows you to decide when the LLC will transfer channel ownership for a particular application. The default, option 0, is to transfer the ownership when the LLC receives a TransferChanMsg. When option 1 has been selected, the transfer will not take place until the LLC receives the TransferChanMsgAck and has successfully sent it to the requesting application.

Defaults file variable name

transferchan_option

Valid Values

SK_TRANSFERCHAN_OPTION = 0

– transfer application ownership on transferChan request (Default if not defined).

SK_TRANSFERCHAN_OPTION = 1

– transfer application ownership on transferChanAck

SK_WARN_ORPHAN_RFS

SK_WARN_ORPHAN_RFS specifies that when the switch sends a Request For Service or Request for Service with Data on a channel that is not associated with an application, a warning message is logged in the maintenence.log file The warning message states: "Message RFS received on channel n that was not associated with any app" .

You can dynamically change this environment variable using the SwitchKit graphical user interface, CSA. See the Converged Services Administrator User’s Guide, "Changing Environment Variables at Run-Time."

Defaults file variable name

warn_orphan_rfs

Valid Values

SK_WARN_ORPHAN_RFS = 0

– No Warning (Default)

SK_WARN_ORPHAN_RFS = 1

– Log Warning

SK_FILE_EXPIRE_ALL_AT_ONCE

Not supported.

See Converged Services Administrator.
CSA. GUI-based tool used to configure, provision and monitor a Excel platform related to, for example, SIP, H.323, and VDAC Resouce Attributes.
See Programmable Protocol Language.
In PPL, a condition that, when met, drives a state machine (PPL Component) from one state to another, by invoking an associated Primitive. In PPL files, an Event is marked by an arrow and text.
See Request For Service.
Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.
The point in the Excel platform where a DS0 connects to a network. Also known as a "socket."
A 32-bit address, used in IP routing, which includes a Network address identifier assigned by a central authority and a Host ID (an end station identifier assigned by a LAN administrator).
Session-Initiation Protocol. A signaling protocol used for establishing sessions in an IP network. A session could be a simple, two-way telephone call, or it could be a collaborative multi-media conference session.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
RFS. A Status Message indicating that some entity is requesting service from the Excel platform.