14 Configuring IM-SSF CAP Phase 1

The following sections describe how to configure IM-SSF using the Service Broker Administration Console and Java MBeans.

Configuring IM-SSF CAP Phase 1 with the Administration Console

This section describes how to configure the IM-SSF CAP phase 1 by using the Service Broker Administration Console.

To access the IM-SSF CAP phase 1 configuration screen:

In the domain navigation pane, expand OCSB.
Expand Processing Tier.
Expand Interworking Modules.

A list of currently deployed Interworking Modules is displayed.
From the module list, select the module instance that you want to configure.

The IM-SSF CAP phase 1 configuration pane contains the subtabs described in Table 14-1.

Table 14-1 IM-SSF CAP Phase 1 Configuration Subtabs

Subtab	Description
General	Enables you to configure general parameters for an Interworking Module instance. For more information, see "Configuring General Parameters".
Call Handling	Enables you to configure how the IM-SSF handles calls. For more information, see "Configuring Call Handling Parameters".
Subscriber Data	Enables you to define IN triggers that the IM-SSF invokes towards the SCP above. For more information, see "Configuring Subscriber Data Parameters".
Operation Propagation	Enables you to define whether the IM-SSF processes operations on its own or propagates these operations to another module. For more information, see "Configuring Operation Propagation Parameters".
TCAP	Enables you to set up the TCAP layer of the IM-SSF. For more information, see "Configuring TCAP Parameters".
Monitoring	Enables you to define how Runtime MBeans and notifications operate. For more information, see "Configuring Monitoring Parameters".

Configuring General Parameters

The General subtab displays the protocol variant that is used to encode and decode SS7 messages and enables you to specify an alias for an IM instance.

Table 14-2 describes the configuration parameter on the General subtab.

Table 14-2 General Parameter

Name	Type	Description
Alias	STRING	Specifies the alias of the IM's SS7 address. The alias is an index to the SS7 SSU configuration, where the IM's SS7 address is configured. The IM uses this alias to set the origination field of outgoing SS7 messages. This ensures that further session messages arrive to this IM instance.
Plugin	STRING	Specifies the protocol variant used over the SS7 interface. It informs the IM which plug-in (class) to use to enclode and decode SS7 messages.

Configuring Call Handling Parameters

The Call Handling subtab enables you to define how IM-SSF handles calls.

Table 14-3 describes configuration parameters on the Call Handling subtab.

Table 14-3 IM-SSF CAP Phase 1 Call Handling Parameters

Name	Type	Description
IM-SSF Mode of Operation	STRING	Specifies the IM-SSF mode of operation. Possible values: DYNAMIC IM-SSF dynamically changes its call control mode, according to the mode requested by the SCP. BACK_TO_BACK IM-SSF monitors calls and ignores the mode requested by the SCP. REDIRECT IM-SSF does not monitor calls and ignores the mode requested by the SCP. Default value: DYNAMIC
Session Case	STRING	Specifies how IM-SSF treats sessions that arrive on the southbound interface, from the OE. Possible values: ORIG All calls are treated as originating calls TERM All calls are treated as terminating calls DYNAMIC Calls are treated dynamically as either originating or terminating calls, depending on the SAL Route header and/or the x-wcs-session-case header generated by a southbound Service Broker IM. Default value: DYNAMIC
Tssf Duration in Seconds	INT	Specifies the value, in seconds, of the IM-SSF Tssf timer. Default value: 20
Tssf User Interaction Duration in Seconds	INT	Specifies the value, in seconds, of the IM-SSF Tssf timer. This parameter is used when the IM-SSF is in the middle of interaction with a media resource. Default value: 1200
Body Encoding Format	STRING	Specifies the method that the IM-SSF uses to encode IN parameters in the body of a SAL message. Possible options: BER XER NONE Default value: NONE
NOA of Called Party Number	STRING	Specifies how to set the NatureOfAddress of the CalledPartyNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL NETWORK_SPECIFIC Default value: NATIONAL
Internal Network Number Indicator of Called Party Number	BOOL	Specifies how to set the InternalNetworkNumberIndicator of the CalledPartyNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: True False Default value: False
Numbering Plan Indicator of Called Party Number	STRING	Specifies how to set the NumberingPlanIndicator of the CalledPartyNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: ISDN DATA TELEX Default value: DATA
NOA of Calling Party Number	STRING	Specifies how to set the NatureOfAddress of the CallingPartyNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL NETWORK_SPECIFIC Default value: NATIONAL
Number Incomplete Indicator of Calling Party Number	BOOL	Specifies how to set the IncompleteIndicator of the CallingPartyNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible options: True False Default value: True
Numbering Plan Indicator of Calling Party Number	STRING	Specifies how to set the NumberingPlanIndicator of the CallingPartyNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: ISDN DATA TELEX Default value: TELEX
Screening Indicator of Calling Party Number	STRING	Specifies how to set the NumberingPlanIndicator of the CallingPartyNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: USER_PROVIDED_NOT_VERIFIED USER_PROVIDED_VERIFIED_PASSED USER_PROVIDED_VERIFIED_FAILED NETWORK_PROVIDED Default value: USER_PROVIDED_NOT_VERIFIED
Calling Party Category of Calling Party Number	STRING	Specifies how to set the CallingNumberCategory of the CallingPartyNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: UNKNOWN LANGUAGE_FRENCH LANGUAGE_ENGLISH LANGUAGE_GERMAN LANGUAGE_RUSSIAN Default value: LANGUAGE_ENGLISH
Type of Number of Called Party Number	STRING	Specifies how to set the TypeOfNumber of the CalledPartyBCDNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: Unknown InternationalNumber NationalNumber NetworkSpecificNumber DedicatedAccessShortcode AlphaNumericStringAttached Default value: NationalNumber
Numbering Plan Indicator of Called Party BCD Number	STRING	Specifies how to set the NumberingPlanIndicator of the CalledPartyBCDNumber. This parameter is used when the IM-SSF sends a new InitialDP message to the SCP. Possible values: Unknown ISDN_TelephonyNumberingPlan DataNumberingPlan TelexNumberingPlan NationalNumberingPlan Default value: DataNumberingPlan

Configuring Subscriber Data Parameters

The Subscriber Data subtab enables you to define IN triggers that IM-SSF invokes towards the SCP above.

The table on the Subscriber Data subtab displays the rules for invoking triggers. Each row represents one rule. When defining a new rule, you need to specify the fields described in Table 14-4.

Table 14-4 IM-SSF CAP Phase 1 Subscriber Data Fields

Name	Type	Description
IMSI	STRING	Specifies a condition on session IMSI. When the condition is met, IM-SSF invokes triggers towards the SCP. To apply a rule for all IMSIs, set this parameter to Default.
MSISDN	STRING	Specifies a condition on session MSISDN. When the condition is met, IM-SSF invokes triggers towards the SCP. To apply a rule for all MSISDNs, set this parameter to Default.
Service Key	STRING	Specifies a Service Key to set on the trigger to the SCP.
SCP Address Alias	STRING	Specifies the SCP to which IM-SSF invokes a trigger. This is an alias to one of the SCCP addresses specified in the SS7 SSU configuration.
Default Call Handling	STRING	Specifies how IM-SSF handles a call when a signal between IM-SSF and SCP fails. Possible values: CONTINUE_CALL RELEASE_CALL
TDP List	STRING_LIST	Specifies a list of TDPs that IM-SSF can trigger. Each trigger is specified in the following format: id=type where: id is one of the following: 2: COLLECTED_INFO 3: ANALYSED_INFORMATION 4: ROUTE_SELECT_FAILURE 12: TERMINATING_ATTEMPT_AUTHORISED 13: T_BUSY 14: T_NO_ANSWER type is one of the following: R, which means Interrupt N, which means Notify When you want to define multiple TDPs, separate these TDPs with a comma. For example: 13=R,14=N

Configuring Operation Propagation Parameters

The Operation Propagation parameters subtab enables you to define whether the IM-SSF processes operations on its own or propagates these operations to another module.

The table on the Operation Propagation subtab displays a list of operations. Each row represents one operation for which you define whether IM-SSF processes this operation or propagates the operation to another module. When configuring a new operation, you need to specify the fields described in Table 14-5.

Table 14-5 IM-SSF CAP Phase 1 Operation Propagation

Name	Type	Description
Name	STRING	Specifies a unique identifier.
Operation	STRING	Specifies an operation. Possible values: RequestReportBCSMEvent
Module name	STRING	Specifies a name of a module instance to which an operation is propagated.
Enable Propagation	BOOL	Specifies whether IM-SSF processes operations on its own or propagates a request to the session control layer. Possible values: True The IM-SSF propagates RRBCSMEvent operations. False The IM-SSF processes RRBCSMEvent operations. Default value: True

Configuring TCAP Parameters

The TCAP subtab enables you to set up parameters of the IM TCAP layer.

Table 14-6 describes configuration parameters on the TCAP subtab.

Table 14-6 TCAP Parameter

Name	Type	Description
Class4 Default Timeout in Seconds	INT	Specifies the time period in seconds that the IM waits for possible REJECT. The timer starts when sending INVOKE for class 4 operations. Default value: 5
Reject Timeout in Seconds	INT	Specifies the time period in seconds that the IM waits for possible REJECT. The timer starts when sending INVOKE for class 1-3 operations. Default value: 1000
Application Part Guard Timer	INT	Specifies the PSM timer, which is a timer for incoming operations. The PSM timer defines the maximum time in seconds that the application (TC-User) has to respond to incoming INVOKE messages. Default value: 200
Activate Invoke Alarm in Application Layer	BOOL	When the TCAP layer receives an INVOKE, it triggers back PABORT if there is no response. The waiting time period for response is configured in the encoding library. The Activate Invoke Alarm in Application Layer parameter specifies whether or not to activate this timer. Possible values: True False Default value: False
Result Split Length	INT	Specifies the maximum length of the TCAP RESULT message. When the actual length of the message exceeds the specified value, the message is split. Default value: 512

Configuring Monitoring Parameters

The Monitoring tab enables you to define how Runtime MBeans and notifications operate for an IM-SSF. For more information about configuring monitoring, see "Configuring Monitoring with the Administration Console".

Configuring IM-SSF CAP Phase 1 with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-SSF CAP phase 1 through JMX. Figure 14-1 shows the hierarchy of the IM-SSF CAP 1 MBeans.

Figure 14-1 IM-SSF CAP Phase 1 MBeans Hierarchy

The following sections provide reference information for the IM-SSF CAP phase 1 configuration MBeans.

Note:

MBeans described in this guide may include additional advanced attributes, which are not described in the guide. Advanced attributes are reserved for internal use. Do not change these attributes.

The following MBeans are common for all components of Service Broker and described in "Configuring Monitoring with Java MBeans":

MonitoringGeneralMBean
ThresholdCrossedNotificationRulesMBean
ThresholdCrossedNotificationRuleMBean
StateChangedNotificationRulesMBean
StateChangedNotificationRuleMBean

ImssfCap1MBean

ImscfCap1MBean is a root MBean for the IM-SSF CAP phase 1 configuration.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getGeneral()

Gets a reference to the instance of GeneralMBean

ObjectName getCallHandling()

Gets a reference to the instance of CallHandlingMBean

ObjectName getSubscriberDataRecords()

Gets a reference to the instance of SubscriberDataRecordsMBean

ObjectName getOperationPropagationSet()

Gets a reference to the instance of OperationPropagationSetMBean

ObjectName getMonitoringGeneral()

Gets a reference to the instance of MonitoringGeneralMBean

ObjectName getThresholdCrossedNotificationRules()

Gets a reference to the instance of ThresholdCrossedNotificationRulesMBean

ObjectName getStateChangedNotificationRules()

Gets a reference to the instance of StateChangedNotificationRulesMBean

ObjectName getMediaResources()

Gets a reference to the instance of MediaResourcesMBean

ObjectName getTcap()

Gets a reference to the instance of TcapMBean

GeneralMBean

GeneralMBean enables you to specify an alias for an Interworking Module instance.

Factory Method

Created automatically

Attributes

Alias

For more information on this attribute, see Table 14-2.

Operations

None

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

ImssfModeOfOperation
SessionCase
TssfDurationInSeconds
TssfUserInteractionDurationInSeconds
BodyEncodingFormat
NoaOfCalledPartyNumber
InternalNetworkNumberIndicatorOfCalledPartyNumber
NumberingPlanIndicatorOfCalledPartyNumber
NoaOfCallingPartyNumber
NumberIncompleteIndicatorOfCallingPartyNumber
NumberingPlanIndicatorOfCallingPartyNumber
ScreeningIndicatorOfCallingPartyNumber
CallingPartyCategoryOfCallingPartyNumber
TypeOfNumberOfCalledPartyNumber
NumberingPlanIndicatorOfCalledPartyBcdNumber

For more information on these attributes, see Table 14-3.

Operations

None

SubscriberDataRecordsMBean

SubscriberDataRecordsMBean is a container for instances of SubscriberDataRecordMBean. Each instance of SubscriberDataRecordMBean defines an IN trigger that the IM-SSF invokes to the SCP above.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getSubscriberDataRecords()

Gets an array of references to instances of SubscriberDataRecordMBean

ObjectName createSubscriberDataRecordMBean()

Creates a new instance of SubscriberDataRecordMBean

void destroySubscriberDataRecordMBean()

Destroys an existing instance of SubscriberDataRecordMBean

ObjectName lookupSubscriberDataRecordMBean()

Gets a reference to the instance of SubscriberDataRecordMBean

SubscriberDataRecordMBean

Each instance of SubscriberDataRecordMBean defines an IN trigger that IM-SSF invokes to the SCP above.

Factory Method

SubscriberDataRecords.createSubscriberDataRecord()

Attributes

Imsi
Msisdn
ServiceKey
ScpAddressAlias
DefaultCallHandling
TdpList

For more information on these attributes, see Table 14-4.

Operations

None

OperationPropagationSetMBean

OperationPropagationSetMBean is a container for instances of OperationPropagationMBean. Each instance of OperationPropagationMBean defines whether the IM-SSF processes a specific operation on its own or propagates this operation to another module.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getOperationPropagation()

Gets an array of references to instances of OperationPropagationMBean

ObjectName createOperationPropagationMBean()

Creates a new instance of OperationPropagationMBean

void destroyOperationPropagationMBean()

Destroys an existing instance of OperationPropagationMBean

ObjectName lookupOperationPropagationMBean()

Gets a reference to the instance of OperationPropagationMBean

OperationPropagationMBean

Each instance of OperationPropagationMBean defines an operation that the IM-SSF either processes on its own or propagates to this operation to another module.

Factory Method

OperationPropagationSet.createOperationPropagation()

Attributes

Operation
ModuleName
EnablePropagation

For more information on these attributes, see Table 14-5.

Operations

None

Tcap MBean

TcapMBean enables you to configure the TCAP layer of the module.

Factory Method

Created automatically

Attributes

Class4DefaultTimeoutInSeconds
RejectTimeoutInSeconds
ActivateInvokeAlarmInApplicationLayer
ApplicationPartGuardTimer
ResultSplitLength

For more information on these attributes, see Table 14-6.

Operations

None