13 Configuring IM-SSF

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

• Configuring IM-SSF CAP Phase 1

• Configuring IM-SSF CAP Phase 2

• Configuring IM-SSF CAP Phase 3

• Configuring IM-SSF INAP CS-1

• Configuring IM-SSF WIN Phase 1

• Configuring IM-SSF WIN Phase 2

• Configuring IM-SSF AIN 0.1

• Configuring IM-SSF AIN 0.2

Configuring IM-SSF CAP Phase 1

This section describes how to configure IM-SSF CAP phase 1 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:

1. In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed Interworking Modules is displayed.

2. In the list of the deployed modules, select the module instance that you want to configure. The module instance configuration screen is displayed in the Configuration pane.

   The configuration screen of the IM-SSF CAP phase 1 contains the subtabs described in Table 13-1.

Table 13-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 13-2 describes the configuration parameter on the General subtab.

Table 13-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 13-3 describes configuration parameters on the Call Handling subtab.

Table 13-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 13-4.

Table 13-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 13-5.

Table 13-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 13-6 describes configuration parameters on the TCAP subtab.

Table 13-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. The hierarchy of the MBeans is shown on Figure 13-1.

Figure 13-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 13-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 13-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 13-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 13-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 13-6.

Operations

None

Configuring IM-SSF CAP Phase 2

This section describes how to configure IM-SSF CAP phase 2 using the Service Broker Administration Console and Java MBeans.

Configuring IM-SSF CAP Phase 2 with the Administration Console

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

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

1. In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed Interworking Modules is displayed.

2. In the list of the deployed modules, select the module instance that you want to configure. The module instance configuration screen is displayed in the Configuration pane.

   The configuration screen of the IM-SSF CAP phase 2 contains the subtabs described in Table 13-7.

Table 13-7 IM-SSF CAP Phase 2 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".
Charging	Enables you to configure functionality related to charging operations. For more information, see "Configuring Charging Parameters".
Media Resources	Enables you to set up the media resources that Service Broker uses to play announcements. For more information, see "Configuring Media Resources 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 enclode / decode an SS7 interface and enables you to specify an alias for an Interworking Module instance.

Table 13-8 describes the configuration parameter on the General subtab.

Table 13-8 General Parameter

Name	Type	Description
Alias	STRING	Specifies the alias of the IM's SS7 address. The alias is an index to 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 encode / decode SS7 messages.

Configuring Call Handling Parameters

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

Table 13-9 describes configuration parameters on the Call Handling subtab.

Table 13-9 IM-SSF CAP Phase 2 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: ORIG
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
IM-SSF Media Capability	BOOL	Specifies whether or not the underlying network supports IP/SRF/MRF. This determines if the IM-SSF can handle media-related operations, such as EstablishTemporaryConnection or ConnectToResource. Possible values: True False Default value: True
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 values: 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: True
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 values: 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: DATA
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 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 13-10.

Table 13-10 IM-SSF CAP Phase 2 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.
MSISDN	STRING	Specifies a condition on session MSISDN. When the condition is met, IM-SSF invokes triggers towards the SCP.
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 (that is invokes a trigger towards the failed SCP). Possible values: CONTINUE_CALL RELEASE_CALL Default value: CONTINUE_CALL
TDP List	STRING_LIST	Specifies a list of TDPs that must be triggered. 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 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 13-11.

Table 13-11 IM-SSF CAP Phase 2 Operation Propagation

Name	Type	Description
Name	STRING	Specifies a unique identifier.
Operation	STRING	Specifies an operation. Possible values: RequestReportBCSMEvent PlayAnnouncement PromptAndCollect FurnishChargingInfo ApplyCharging
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 Charging Parameters

The Charging subtab enables you to configure functionality related to charging operations.

Table 13-12 describes configuration parameters on the Charging subtab.

Table 13-12 IM-SSF CAP Phase 2 Charging Parameters

Name	Type	Description
Tccd in Seconds	INT	Specifies the time interval, in seconds, that the IM-SSF waits for ApplyCharging message after sending the ApplyChargingReport message. Tccd range of values is 1 to 20 seconds. Default value: 8

Configuring Media Resources Parameters

The Media Resources subtab enables you to define the media resources that the SSP can connect in order to play announcements.

The table in the Media Resources subtab displays the media resources that are used to play announcements. Each row represents one media resource. When defining a new media resource, you need to specify the fields described in Table 13-13.

Table 13-13 IM-SSF CAP Phase 2 Media Resource Definition Fields

Name	Type	Description
Name	STRING	Specifies a name of the media resource.
Alias	STRING	Specifies a unique identifier that applications use to instruct Service Broker which media resource to connect in order to play announcements. Aliases are defined in a URI format. For example: [e-mail].
Address Digits	STRING	Specifies the digits part of the media resource address. The media resource address is used to set up a connection towards the media resource.
Nature of Address	STRING	Specifies the NatureOfAddress part of the media resource address. The media resource address is used to set up a connection towards the media resource. Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL NETWORK_SPECIFIC Default value: SUBSCRIBER_NUMBER
Address Numbering Plan Indicator	STRING	Specifies the NumberingPlanInd part of the media resource address. The media resource address is used to set up a connection towards the media resource. Possible values: ISDN DATA TELEX
Numbering Qualifier	STRING	Specifies the numbering qualifier of the media resource address. Possible values: NONE DIALLED_DIGITS USER_PROVIDED_FAILED_NETWORK_SCREENING USER_PROVIDED_NOT_SCREENED REDIRECTING_TERMINATING_NUMBER Default value: NONE
Number Screening	STRING	Specifies the numbering screening of the media resource address. Possible values: UNDEFINED USER_PROVIDED_NOT_VERIFIED USER_PROVIDED_VERIFIED_PASSED USER_PROVIDED_VERIFIED_FAILED NETWORK_PROVIDED Default value: UNDEFINED
Presentation Restriction	STRING	Specifies the presentation restriction of the media resource address. Possible values: UNDEFINED ALLOWED RESTRICTED NOT_AVAILABLE Default value: UNDEFINED
Operation Type	STRING	Possible values: Internal: The media resource is internal part of the SSP. ConnectToResource (CTR) operation is used to connect the media resource. External: The media resource not a part of the SSP. EstablishTemporaryConnection (ETC) is used to connect the media resource.
Answer Indication	BOOL	Specifies how to set the bothwayThroughConnectionInd in the ServiceInteractionIndicatorTwo parameter in the ETC and CTR operations. Possible values: True Connection to the media resource causes the switch to generate answer indication backwards. This opens a media path from the caller to the media resource (bothwayPathRequired). False The media path opens only in the direction from the media resource to the caller. Default value: True

Note:

When an internal media resource is used (CTR), the Address Digits, Nature of Address and Address Numbering Plan Indicator parameters can be set to 'None' in order to instruct the network's session control entity to connect its pre-configured media resource.

Configuring TCAP Parameters

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

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

Table 13-14 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 2 with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-SSF CAP phase 2 through JMX. The hierarchy of the MBeans is shown on Figure 13-2.

Figure 13-2 IM-SSF CAP Phase 2 MBeans Hierarchy

The following sections provide reference information for the IM-SSF CAP phase 2 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

ImssfCap2MBean

ImscfCap2MBean is a root MBean for the IM-SSF CAP phase 2 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 getCharging()

Gets a reference to the instance of ChargingMBean

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 13-8.

Operations

None

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

• ImssfModeOfOperation

• SessionCase

• TssfDurationInSeconds

• TssfUserInteractionDurationInSeconds

• ImssfMediaCapability

• BodyEncodingFormat

• NoaOfCalledPartyNumber

• InternalNetworkNumberIndicatorOfCalledPartyNumber

• NumberingPlanIndicatorOfCalledPartyNumber

• NoaOfCallingPartyNumber

• NumberIncompleteteIndicatorOfCallingPartyNumber

• NumberingPlanIndicatorOfCallingPartyNumber

• ScreeningIndicatorOfCallingPartyNumber

• CallingPartyCategoryOfCallingPartyNumber

• TypeOfNumberOfCalledPartyNumber

• NumberingPlanIndicatorOfCalledPartyBcdNumber

For more information on these attributes, see Table 13-9.

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 the 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 13-10.

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 this operation to another module.

Factory Method

OperationPropagationSet.createOperationPropagation()

Attributes

• Operation

• ModuleName

• EnablePropagation

For more information on these attributes, see Table 13-11.

Operations

None

ChargingMBean

ChargingMBean enables you to configure functionality related to charging operations.

Factory Method

Created automatically

Attributes

• TccdInSeconds

For more information on these attributes, see Table 13-12.

Operations

None

MediaResourcesMBean

MediaResourcesMBean is a container for instances of MediaResourceMBean. Each instance of MediaResourceMBean represents a single media resource to which an SSP can connect.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getMediaResource()

Returns an array of references to instances of MediaResourceMBean

ObjectName createMediaResourceMBean()

Creates a new instance of MediaResourceMBean

void destroyMediaResourceMBean()

Destroys an existing instance of MediaResourceMBean

ObjectName lookupMediaResourceMBean()

Gets a reference to the instance of MediaResourceMBean

MediaResourceMBean

Each instance of MediaResourceMBean represents one media resource to which an SSP can connect to play announcements.

Factory Method

MediaResources.createMediaResource()

Attributes

• Name

• Alias

• AddressDigits

• NatureOfAddress

• AddressNumberingPlanIndicator

• NumberingQualifier

• NumberScreening

• PresentationRestriction

• OperationType

• AnswerIndication

For more information on these attributes, see Table 13-13.

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 13-14.

Operations

None

Configuring IM-SSF CAP Phase 3

This section describes how to configure IM-SSF CAP phase 3 using the Service Broker Administration Console and Java MBeans.

Configuring IM-SSF CAP Phase 3 with the Administration Console

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

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

1. In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed Interworking Modules is displayed.

2. In the list of the deployed modules, select the module instance that you want to configure. The module instance configuration screen is displayed in the Configuration pane.

   The configuration screen of the IM-SSF CAP Phase 3 contains the subtabs described in Table 13-15.

Table 13-15 IM-SSF CAP Phase 3 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".
Charging	Enables you to configure functionality related to charging operations. For more information, see "Configuring Charging Parameters".
Media Resources	Enables you to set up the media resources that Service Broker uses to play announcements. For more information, see "Configuring Media Resources 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 / decode SS7 messages and enables you to specify an alias for an Interworking Module instance.

Table 13-16 describes the configuration parameter on the General subtab.

Table 13-16 General Parameter

Name	Type	Description
Alias	STRING	Specifies the alias of the IM's SS7 address. The alias is an index to 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 encode / decode SS7 messages.

Configuring Call Handling Parameters

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

Table 13-17 describes configuration parameters on the Call Handling subtab.

Table 13-17 IM-SSF CAP Phase 3 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
IM-SSF Media Capability	BOOL	Specifies whether or not the underlying network supports IP/SRF/MRF. This determines if the IM-SSF can handle media-related operations, such as EstablishTemporaryConnection or ConnectToResource Possible values: True False Default value: True
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: True
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 values: 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 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 13-18.

Table 13-18 IM-SSF CAP Phase 3 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.
MSISDN	STRING	Specifies a condition on session MSISDN. When the condition is met, IM-SSF invokes triggers towards the SCP.
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 (that is, invokes a trigger towards the failed SCP). Possible values: CONTINUE_CALL RELEASE_CALL Default value: CONTINUE_CALL
TDP List	STRING_LIST	Specifies a list of TDPs that must be triggered. 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 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 13-19.

Table 13-19 IM-SSF CAP Phase 3 Operation Propagation

Name	Type	Description
Name	STRING	Specifies a unique identifier
Operation	STRING	Specifies an operation. Possible values: RequestReportBCSMEvent PlayAnnouncement PromptAndCollect FurnishChargingInfo ApplyCharging
Module name	STRING	Specifies a name of a module instance to which an operation is propagated.
Enable propagation	BOOL	Specifies whether IM-SSF 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.

Configuring Charging Parameters

The Charging subtab enables you to configure functionality related to charging operations.

Table 13-20 describes configuration parameters on the Charging subtab.

Table 13-20 IM-SSF CAP Phase 3 Charging Parameter

Name	Type	Description
Tccd in Seconds	INT	Specifies the time interval, in seconds, that the IM-SSF waits for ApplyCharging message after sending the ApplyChargingReport message. Tccd range of values is 1 to 20 seconds. Default value: 8

Configuring Media Resources Parameters

The Media Resources subtab enables you to define the media resources that the SSP can connect in order to play announcements.

The table in the Media Resources subtab displays the media resources that are used to play announcements. Each row represents one media resource. When defining a new media resource, you need to specify the fields described in Table 13-21.

Table 13-21 IM-SSF CAP Phase 3 Media Resource Definition Fields

Name	Type	Description
Name	STRING	Specifies a name of the media resource.
Alias	STRING	Specifies a unique identifier that applications use to instruct Service Broker which media resource to connect in order to play announcements. Aliases are defined in a URI format. For example: [e-mail].
Address Digits	STRING	Specifies the digits part of the media resource address. The media resource address is used to set up a connection towards the media resource.
Nature of Address	STRING	Specifies the NatureOfAddress part of the media resource address. The media resource address is used to set up a connection towards the media resource. Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL NETWORK_SPECIFIC Default value: NATIONAL
Address Numbering Plan Indicator	STRING	Specifies the NumberingPlanInd part of the media resource address. The media resource address is used to set up a connection towards the media resource. Possible values: ISDN DATA TELEX Default value: ISDN
Numbering Qualifier	STRING	Specifies the numbering qualifier of the media resource address. Possible values: NONE DIALLED_DIGITS USER_PROVIDED_FAILED_NETWORK_SCREENING USER_PROVIDED_NOT_SCREENED REDIRECTING_TERMINATING_NUMBER Default value: NONE
Number Screening	STRING	Specifies the numbering screening of the media resource address. Possible values: UNDEFINED USER_PROVIDED_NOT_VERIFIED USER_PROVIDED_VERIFIED_PASSED USER_PROVIDED_VERIFIED_FAILED NETWORK_PROVIDED Default value: UNDEFINED
Presentation Restriction	STRING	Specifies the presentation restriction of the media resource address. Possible values: UNDEFINED ALLOWED RESTRICTED NOT_AVAILABLE Default value: UNDEFINED
Operation Type	STRING	Possible values: internal The media resource is internal part of the SSP. ConnectToResource (CTR) operation is used to connect the media resource. external The media resource not a part of the SSP. EstablishTemporaryConnection (ETC) is used to connect the media resource. Default value: internal
Answer Indication	BOOL	Specifies how to set the bothwayThroughConnectionInd in the ServiceInteractionIndicatorTwo parameter in the ETC and CTR operations. Possible values: True Connection to the media resource causes the switch to generate answer indication backwards. This opens a media path from the caller to the media resource (bothwayPathRequired). False The media path opens only in the direction from the media resource to the caller. Default value: True

Note:

When an internal media resource is used (CTR), the Address Digits, Nature of Address and Address Numbering Plan Indicator parameters can be set to 'None' in order to instruct the network's session control entity to connect its pre-configured media resource.

Configuring TCAP Parameters

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

Table 13-22 describes configuration parameters on the TCAP subtab.

Table 13-22 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 3 with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-SSF CAP phase 3 through JMX. The hierarchy of the MBeans is shown on Figure 13-3.

Figure 13-3 IM-SSF CAP Phase 3 MBeans Hierarchy

The following sections provide reference information for the IM-SSF CAP phase 3 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

ImssfCap3MBean

ImssfCap3MBean is a root MBean for the IM-SSF CAP phase 3 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 getCharging()

Gets a reference to the instance of ChargingMBean

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 13-16.

Operations

None

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

• ImssfModeOfOperation

• SessionCase

• TssfDurationInSeconds

• TssfUserInteractionDurationInSeconds

• ImssfMediaCapability

• BodyEncodingFormat

• NoaOfCalledPartyNumber

• InternalNetworkNumberIndicatorOfCalledPartyNumber

• NumberingPlanIndicatorOfCalledPartyNumber

• NoaOfCallingPartyNumber

• NumberIncompleteteIndicatorOfCallingPartyNumber

• NumberingPlanIndicatorOfCallingPartyNumber

• ScreeningIndicatorOfCallingPartyNumber

• CallingPartyCategoryOfCallingPartyNumber

• TypeOfNumberOfCalledPartyNumber

• NumberingPlanIndicatorOfCalledPartyBcdNumber

For more information on these attributes, see Table 13-17.

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 the 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 13-18.

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 this operation to another module.

Factory Method

OperationPropagationSet.createOperationPropagation()

Attributes

• Operation

• ModuleName

• EnablePropagation

For more information on these attributes, see Table 13-19.

Operations

None

ChargingMBean

ChargingMBean enables you to configure functionality related to charging operations.

Factory Method

Created automatically

Attributes

TccdInSeconds

For more information on these attributes, see Table 13-20.

Operations

None

MediaResourcesMBean

MediaResourcesMBean is a container for instances of MediaResourceMBean. Each instance of MediaResourceMBean represents a single media resource to which an SSP can connect.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getMediaResource()

Returns an array of references to instances of MediaResourceMBean

ObjectName createMediaResourceMBean()

Creates a new instance of MediaResourceMBean

void destroyMediaResourceMBean()

Destroys an existing instance of MediaResourceMBean

ObjectName lookupMediaResourceMBean()

Gets a reference to the instance of MediaResourceMBean

MediaResourceMBean

Each instance of MediaResourceMBean represents one media resource to which an SSP can connect to play announcements.

Factory Method

MediaResources.createMediaResource()

Attributes

• Name

• Alias

• AddressDigits

• NatureOfAddress

• AddressNumberingPlanIndicator

• NumberingQualifier

• NumberScreening

• PresentationRestriction

• OperationType

• AnswerIndication

For more information on these attributes, see Table 13-21.

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 13-22.

Operations

None

Configuring IM-SSF INAP CS-1

This section describes how to configure IM-SSF INAP CS-1 using the Service Broker Administration Console and Java MBeans.

Configuring IM-SSF INAP CS-1 with the Administration Console

This section describes how to configure the IM-SSF INAP CS-1 using the Service Broker Administration Console.

To access the IM-SSF INAP CS-1 Configuration screen:

1. In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed interworking module instances is displayed.

2. In the list of the deployed module instances, select the module instance that you want to configure. The module instance configuration screen is displayed in the Configuration pane.

   The configuration screen of the IM-SSF INAP CS-1 contains the subtabs described in Table 13-23.

Table 13-23 IM-SSF INAP CS-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".
Media Resources	Enables you to set up the media resources that Service Broker uses to play announcements. For more information, see "Configuring Media Resources 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 / decode SS7 messages and enables you to specify an alias for an Interworking Module instance.

Table 13-24 describes the configuration parameter on the General subtab.

Table 13-24 General Parameter

Name	Type	Description
Alias	STRING	Specifies the alias of the IM's SS7 address. The alias is an index to 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 encode / decode SS7 messages.

Configuring Call Handling Parameters

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

Table 13-25 describes configuration parameters on the Call Handling subtab.

Table 13-25 IM-SSF INAP CS-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: ORIG
IM-SSF Media Capability	BOOL	Specifies whether or not the underlying network supports IP/SRF/MRF. This determines if the IM-SSF can handle media-related operations, such as EstablishTemporaryConnection or ConnectToResource. Possible values: True False Default value: True
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: True
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 values: 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 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 13-26.

Table 13-26 IM-SSF INAP CS-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.
MSISDN	STRING	Specifies a condition on session MSISDN. When the condition is met, IM-SSF invokes triggers towards the SCP.
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 (that is invokes a trigger towards the failed SCP). Possible values: CONTINUE_CALL RELEASE_CALL Default value: CONTINUE_CALL
TDP List	STRING_LIST	Specifies a list of TDPs that must be triggered. 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 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 13-27.

Table 13-27 IM-SSF INAP CS1 Operation Propagation

Name	Type	Description
Name	STRING	Specifies a unique identifier.
Operation	STRING	Specifies an operation. Possible values: RequestReportBCSMEvent PlayAnnouncement PromptAndCollect
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 Media Resources Parameters

The Media Resources subtab enables you to define the media resources that the SSP can connect in order to play announcements.

The table in the Media Resources subtab displays the media resources that are used to play announcements. Each row represents one media resource. When defining a new media resource, you need to specify the fields described in Table 13-28.

Table 13-28 IM-SSF INAP CS-1 Media Resource Definition Fields

Name	Type	Description
Name	STRING	Specifies a name of the media resource
Alias	STRING	Specifies a unique identifier that applications use to instruct Service Broker which media resource to connect to in order to play announcements. Aliases are defined in a URI format. For example: [e-mail].
Address Digits	STRING	Specifies the digits part of the media resource address. The media resource address is used to set up a connection towards the media resource.
Nature of Address	STRING	Specifies the NatureOfAddress part of the media resource address. The media resource address is used to set up a connection towards the media resource. Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL NETWORK_SPECIFIC Default value: SUBSCRIBER_NUMBER
Address Numbering Plan Indicator	STRING	Specifies the NumberingPlanInd part of the media resource address. The media resource address is used to set up a connection towards the media resource. Possible values: ISDN DATA TELEX Default value: ISDN
Operation Type	STRING	Possible values: internal The media resource is internal part of the SSP. ConnectToResource (CTR) operation is used to connect the media resource. external The media resource not a part of the SSP. EstablishTemporaryConnection (ETC) is used to connect the media resource. Default value: internal

Configuring TCAP Parameters

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

Table 13-29 describes configuration parameters on the TCAP subtab.

Table 13-29 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 INAP CS-1 with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-SSF INAP CS-1 through JMX. The hierarchy of the MBeans is shown on Figure 13-4.

Figure 13-4 IM-SSF INAP CS-1 MBeans Hierarchy

The following sections provide reference information for the IM-SSF INAP CS-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

ImssfCs1MBean

ImssfCs1MBean is a root MBean for the IM-SSF INAP CS-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 getCharging()

Gets a reference to the instance of ChargingMBean

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 13-24.

Operations

None

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

• ImssfModeOfOperation

• SessionCase

• ImssfMediaCapability

• TssfDurationInSeconds

• TssfUserInteractionDurationInSeconds

• BodyEncodingFormat

• NoaOfCalledPartyNumber

• InternalNetworkNumberIndicatorOfCalledPartyNumber

• NumberingPlanIndicatorOfCalledPartyNumber

• NoaOfCallingPartyNumber

• NumberIncompleteIndicatorOfCallingPartyNumber

• NumberingPlanIndicatorOfCallingPartyNumber

• ScreeningIndicatorOfCallingPartyNumber

• CallingPartyCategoryOfCallingPartyNumber

• TypeOfNumberOfCalledPartyBcdNumber

• NumberingPlanIndicatorOfCalledPartyBcdNumber

For more information on these attributes, see Table 13-25.

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 the 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 13-26.

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 this operation to another module.

Factory Method

OperationPropagationSet.createOperationPropagation()

Attributes

• Operation

• ModuleName

• EnablePropagation

For more information on these attributes, see Table 13-27.

Operations

None

MediaResourcesMBean

MediaResourcesMBean is a container for instances of MediaResourceMBean. Each instance of MediaResourceMBean represents a single media resource to which an SSP can connect.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getMediaResourcesMBean()

Gets an array of references to instances of MediaResourceMBean

ObjectName createMediaResourceMBean()

Creates a new instance of MediaResourceMBean

void destroyMediaResourceMBean()

Destroys an existing instance of MediaResourceMBean

ObjectName lookupMediaResourceMBean()

Gets a reference to the instance of MediaResourceMBean

MediaResourceMBean

Each instance of MediaResourceMBean represents one media resource to which an SSP can connect to play announcements.

Factory Method

MediaResources.createMediaResource()

Attributes

• Alias

• AddressDigits

• NatureOfAddress

• AddressNumberingPlanIndicator

• OperationType

For more information on these attributes, see Table 13-28.

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 13-29.

Operations

None

Configuring IM-SSF WIN Phase 1

This section describes how to configure IM-SSF WIN phase 1 using the Service Broker Administration Console and Java MBeans.

Configuring IM-SSF WIN Phase 1 with the Administration Console

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

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

1. In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed Interworking Modules is displayed.

2. In the list of the deployed modules, select the module instance that you want to configure. The module instance configuration screen is displayed in the Configuration pane.

   The configuration screen of the IM-SSF WIN Phase 1 contains the subtabs described in Table 13-30.

Table 13-30 IM-SSF WIN 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".
Media Resources	Enables you to set up the media resources that Service Broker uses to play announcements. For more information, see "Configuring Media Resources 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 / decode SS7 messages and enables you to specify an alias for an Interworking Module instance.

Table 13-31 describes the configuration parameter on the General subtab.

Table 13-31 General Parameter

Name	Type	Description
Alias	STRING	Specifies the alias of the IM's SS7 address. The alias is an index to 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 encode / decode SS7 messages.

Configuring Call Handling Parameters

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

Table 13-32 describes configuration parameters on the Call Handling subtab.

Table 13-32 IM-SSF WIN 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
IM-SSF Media Capability	BOOL	Specifies whether or not the underlying network supports IP/SRF/MRF. This determines if the IM-SSF can handle media-related operations, such as EstablishTemporaryConnection or ConnectToResource. Possible values: True False Default value: True
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
MSC ID	STRING	Specifies the value that IM-SSF sets in the mscId field of trigger messages.
MS ID	STRING	Specifies the value that IM-SSF sets in the msID field of trigger messages.
Mobile Equipment Number Manufacturer Code	INT	Specifies the manufacturer code of the equipment. This parameter is used when the IM-SSF sends a new trigger, such as OriginationRequest or AnalyzedInformation message to the SCP. Default value: -1
Mobile Equipment Number Serial Number	STRING	Specifies how to set the mobile equipment number field. This parameter is used when the IM-SSF sends a new trigger, such as OriginationRequest or AnalyzedInformation message to the SCP.
ORREQ Dialed Digits Numbering Plan	STRING	Specifies the NumberingPlan of the DialedDigits field. This parameter is used when IM-SSF sends a new OriginationRequest message to the SCP. Possible values: ISDN DATA TELEX TELEPHONY MARITIME_MOBILE Default value: ISDN
ORREQ Dialed Digits Type of Digits	STRING	Specifies the TypeOfDigits of the DialedDigits field. This parameter is used when IM-SSF sends a new OriginationRequest message to the SCP. Possible values: NOT_DEFINED CALLED_PARTY_NUMBER CALLING_PARTY_NUMBER CALLER_INTERACTION ROUTING_NUMBER Default value: CALLED_PARTY_NUMBER
ORREQ MDN Type of Digits	STRING	Specifies how to set the TypeOfDigits of the MobileDirectoryNumber field. This parameter is used when the IM-SSF sends a new OriginationRequest message to the SCP. Possible values: NOT_DEFINED CALLED_PARTY_NUMBER CALLING_PARTY_NUMBER CALLER_INTERACTION ROUTING_NUMBER Default value: CALLED_PARTY_NUMBER
ORREQ MDN Numbering Plan	STRING	Specifies the NumberingPlan of the MobileDirectoryNumber field. This parameter is used when IM-SSF sends a new OriginationRequest message to the SCP. Possible values: ISDN DATA TELEX TELEPHONY MARITIME_MOBILE Default value: TELEPHONY
ANALYZ Invoke Digits Numbering Plan	STRING	Specifies the NumberingPlan of the InvokeDigits field. This parameter is used when IM-SSF sends a new AnalyzedInformation message to the SCP.
ANALYZ Invoke Digits Type of Digits	STRING	Specifies the TypeOfDigits of the InvokeDigits field. This parameter is used when IM-SSF sends a new AnalyzedInformation message to the SCP.
ANALYZ Invoke Mobile Directory Number Type of Digits	STRING	Specifies how to set the TypeOfDigits of the MobileDirectoryNumber field. This parameter is used when IM-SSF sends a new AnalyzedInformation message to the SCP.
ANALYZ Invoke Mobile Directory Number Nature Numbering Plan	STRING	Specifies the NumberingPlan of the MobileDirectoryNumber field. This parameter is used when IM-SSF sends a new AnalyzedInformation message to the SCP.

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 13-33.

Table 13-33 IM-SSF WIN Phase 1 Subscriber Data Fields

Name	Type	Description
MIN	STRING	Specifies a condition on session MIN When the condition is met, IM-SSF invokes triggers towards the SCP. To apply a rule for all MINs, set this parameter to Default.
DN	STRING	Specifies a condition on session DN. When the condition is met, IM-SSF invokes triggers towards the SCP. To apply a rule for all DNs, set this parameter to Default.
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 (that is, (that is, invokes a trigger towards the failed SCP). Possible values: CONTINUE_CALL RELEASE_CALL Default value: CONTINUE_CALL
TDP List	STRING_LIST	Specifies a list of TDPs that must be triggered. Each trigger is specified in the following format: <id>=<type> where: <id> is one of the following: 36: Origination_Attempt_Authorized 37: Calling_Routing_Address_Available 64: Terminating_Resource_Available 65: T_Busy 66: 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: 65=R,66=N

Configuring Media Resources Parameters

The Media Resources subtab enables you to define the media resources that the SSP can connect in order to play announcements.

The table in the Media Resources subtab displays the media resources that are used to play announcements. Each row represents one media resource. When defining a new media resource, you need to specify the fields described in Table 13-34.

Table 13-34 IM-SSF WIN Phase 1 Media Resource Definition Fields

Name	Type	Description
Name	STRING	Specifies a name of the media resource.
Alias	STRING	Specifies a unique identifier that applications use to instruct IM-SSF which media resource to connect in order to play announcements. Alias is used by IM-SSF to lookup a media resource details in this table. Aliases are defined in a URI format. For example: [e-mail].
Operation Type	STRING	Possible values: switched_based The media resource is an internal part of the SSP. CCDIR operation is used to set up a connection towards the media. resource. external The media resource is not part of the SSP. ConnectResource operation is used to connect the media resource. Default value: switched_based
Address Digits	STRING	Specifies the digits part of the media resource address. The media resource address is used to set up a connection towards the media resource. Note: when this parameter is not set, the network's session control entity uses a pre-configured media resource to play announcements. In this case, Nature of Address and Address Numbering Plan Indicator should be set to None.
Resource Type	STRING	Specifies the value to set in the SpecializedResource parameter of the SEIZERES operation. Possible values: UNUSED DTMF_TONE_DETECTOR ASR_DIGITS ASR_SPEECH_USER_INTERFACE Default value: UNUSED
Private Resource Type	STRING	Specifies the value to set in the PrivateSpecializedResource parameter of the SEIZERES operation
SN-IP Configuration	STRING	Possible values: UNUSED SN IP and SCP are co-located. When you choose this option, you need to set also the SN Address parameter. IP IP and SCP are not co-located Default value: UNUSED
SN Address	STRING	Specifies the value to set in the DestinationDigits parameter of the CONNRES operation. This value is regarded only when SN-IP Configuration parameter is set to SN.

Configuring TCAP Parameters

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

Table 13-35 describes configuration parameters on the TCAP subtab.

Table 13-35 TCAP Parameters

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: 4
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 WIN Phase 1 with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-SSF WIN through JMX. The hierarchy of the MBeans is shown on Figure 13-5.

Figure 13-5 IM-SSF WIN MBeans Hierarchy

The following sections provide reference information for the IM-SSF WIN 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

ImssfWinMBean

ImssfWinMBean is a root MBean for the IM-SSF CAP WIN 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 getCharging()

Gets a reference to the instance of ChargingMBean

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 13-31.

Operations

None

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

• ImssfModeOfOperation

• SessionCase

• TssfDurationInSeconds

• TssfUserInteractionDurationInSeconds

• ImssfMediaCapability

• BodyEncodingFormat

• MscId

• MsId

• MobileEquipmentNumberManufacturerCode

• MobileEquipmentNumberSerialNumber

• OrigreqDialedDigitsNumberingPlan

• OrigreqDialedDigitsTypeOfDigits

• OrigreqMdnTypeOfDigits

• OrigreqMdnNumberingPlan

• AnlyzdInvokeDigitsNumberingPlan

• AnlyzdInvokeDigitsTypeOfDigits

• AnlyzdInvokeMobileDirectoryNumberTypeOfDigits

• AnlyzdInvokeMobileDirectoryNumberNatureNumberingPlan

For more information on these attributes, see Table 13-32.

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

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 the IM-SSF invokes to the SCP above.

Factory Method

SubscriberDataRecords.createSubscriberDataRecord()

Attributes

• Min

• Dn

• ScpAddressAlias

• DefaultCallHandling

• TdpList

For more information on these attributes, see Table 13-33.

Operations

None

MediaResourcesMBean

MediaResourcesMBean is a container for instances of MediaResourceMBean. Each instance of MediaResourceMBean represents a single media resource to which an SSP can connect.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getMediaResource()

Returns an array of references to instances of MediaResourceMBean

ObjectName createMediaResourceMBean()

Creates a new instance of MediaResourceMBean

void destroyMediaResourceMBean()

Destroys an existing instance of MediaResourceMBean

ObjectName lookupMediaResourceMBean()

Gets a reference to the instance of MediaResourceMBean

MediaResourceMBean

Each instance of MediaResourceMBean represents one media resource to which an SSP can connect to play announcements.

Factory Method

MediaResources.createMediaResource()

Attributes

• Alias

• OperationType

• ResourceType

• PrivateResourceType

• SnIpConfiguration

• AddressDigits

• SnAddress

For more information on these attributes, see Table 13-34.

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 13-35.

Operations

None

Configuring IM-SSF WIN Phase 2

This section describes how to configure IM-SSF WIN 2 using the Service Broker Administration Console and Java MBeans.

Configuring IM-SSF WIN Phase 2 with the Administration Console

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

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

1. In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed Interworking Modules is displayed.

2. In the list of the deployed modules, select the module instance that you want to configure. The module instance configuration screen is displayed in the Configuration pane.

   The configuration screen of the IM-SSF WIN phase 2 contains the subtabs described in Table 13-36.

Table 13-36 IM-SSF WIN Phase 2 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".
Media Resources	Enables you to set up the media resources that Service Broker uses to play announcements. For more information, see "Configuring Media Resources 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 / decode SS7 messages and enables you to configure general parameters for an Interworking Module instance.

Table 13-37 describes the configuration parameter on the General subtab.

Table 13-37 General Parameter

Name	Type	Description
Alias	STRING	Specifies the alias of the IM's SS7 address. The alias is an index to 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 encode / decode SS7 messages.

Configuring Call Handling Parameters

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

Table 13-38 describes configuration parameters on the Call Handling subtab.

Table 13-38 IM-SSF WIN Phase 2 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: ORIG
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
IM-SSF Media Capability	BOOL	Specifies whether or not the underlying network supports IP/SRF/MRF. This determines if the IM-SSF can handle media-related operations, such as EstablishTemporaryConnection or ConnectToResource. Possible values: True False Default value: False
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
MSC ID	STRING	Specifies the value that IM-SSF sets in the mscId field of trigger messages.
MS ID	STRING	Specifies the value that IM-SSF sets in the msID field of trigger messages.
Mobile Equipment Number Manufacturer Code	INT	Specifies the manufacturer code of the equipment. Default value: -1
Mobile Equipment Number Serial Number	STRING	Specifies how to set the mobile equipment number field. This parameter is used when the IM-SSF sends a new OriginationRequest message to the SCP.
ORREQ Dialed Digits Numbering Plan	STRING	Specifies the NumberingPlan of the DialedDigits field. This parameter is used when IM-SSF sends a new OriginationRequest message to the SCP. Possible values: ISDN DATA TELEX TELEPHONY MARITIME_MOBILE Default value: DATA
ORREQ Dialed Digits Type of Digits	STRING	Specifies the TypeOfDigits of the DialedDigits field. This parameter is used when IM-SSF sends a new OriginationRequest message to the SCP. Possible values: NOT_DEFINED CALLED_PARTY_NUMBER CALLING_PARTY_NUMBER CALLER_INTERACTION ROUTING_NUMBER Default value: CALLED_PARTY_NUMBER
ORREQ MDN Type of Digits	STRING	Specifies how to set the TypeOfDigits of the MobileDirectoryNumber field. This parameter is used when the IM-SSF sends a new OriginationRequest message to the SCP. Possible values: Possible values: NOT_DEFINED CALLED_PARTY_NUMBER CALLING_PARTY_NUMBER CALLER_INTERACTION ROUTING_NUMBER Default value: CALLING_PARTY_NUMBER
ORREQ MDN Numbering Plan	STRING	Specifies the NumberingPlan of the MobileDirectoryNumber field. This parameter is used when IM-SSF sends a new OriginationRequest message to the SCP. Possible values: ISDN DATA TELEX TELEPHONY MARITIME_MOBILE Default value: TELEX
ANALYZ Invoke Digits Numbering Plan	STRING	Specifies the NumberingPlan of the InvokeDigits field. This parameter is used when IM-SSF sends a new AnalyzedInformation message to the SCP.
ANALYZ Invoke Digits Type of Digits	STRING	Specifies the TypeOfDigits of the InvokeDigits field. This parameter is used when IM-SSF sends a new AnalyzedInformation message to the SCP.
ANALYZ Invoke Mobile Directory Number Type of Digits	STRING	Specifies how to set the TypeOfDigits of the MobileDirectoryNumber field. This parameter is used when IM-SSF sends a new AnalyzedInformation message to the SCP.
ANALYZ Invoke Mobile Directory Number Nature Numbering Plan	STRING	Specifies the NumberingPlan of the MobileDirectoryNumber field. This parameter is used when IM-SSF sends a new AnalyzedInformation message to the SCP.

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 13-39.

Table 13-39 IM-SSF WIN Phase 2 Subscriber Data Fields

Name	Type	Description
MIN	STRING	Specifies a condition on session MIN When the condition is met, IM-SSF invokes triggers towards the SCP. To apply a rule for all MINs, set this parameter to Default.
DN	STRING	Specifies a condition on session DN. When the condition is met, IM-SSF invokes triggers towards the SCP. To apply a rule for all DNs, set this parameter to Default.
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 (that is, invokes a trigger towards the failed SCP). Possible values: CONTINUE_CALL RELEASE_CALL Default value: CONTINUE_CALL
TDP List	STRING_LIST	Specifies a list of TDPs that must be triggered. Each trigger is specified in the following format: <id>=<type> where: <id> is one of the following 36: Origination_Attempt_Authorized 37: Calling_Routing_Address_Available 38: Initial_Termination 39: Called_Routing_Address_Available 40: O_Answer 41: O_Disconnect 64: Terminating_Resource_Available 65: T_Busy 66: T_No_Answer 69: T_Answer 70: T_Disconnect <type> is one of the following: R, which means Interrupt N, which means Notify Separate multiple TDPs with a comma. For example: 65=R,66=N

Configuring Media Resources Parameters

The Media Resources subtab enables you to define the media resources that the SSP can connect in order to play announcements.

The table in the Media Resources subtab displays the media resources that are used to play announcements. Each row represents one media resource. When defining a new media resource, you need to specify the fields described in Table 13-40.

Table 13-40 IM-SSF WIN Phase 2 Media Resource Definition Fields

Name	Type	Description
Name	STRING	Specifies a name of the media resource.
Alias	STRING	Specifies a unique identifier that applications use to instruct IM-SSF which media resource to connect in order to play announcements. Alias is used by IM-SSF to lookup a media resource details in this table. Aliases are defined in a URI format. For example: [e-mail].
Address Digits	STRING	Specifies the digits part of the media resource address. The media resource address is used to set up a connection towards the media resource. Note: when this parameter is not set, the network's session control entity uses a pre-configured media resource to play announcements. In this case, Nature of Address and Address Numbering Plan Indicator should be set to None.
Operation Type	STRING	Possible values: switched_based The media resource is internal part of the SSP. CCDIR operation is used to connect the media resource. external The media resource not a part of the SSP. ConnectResource operation is used to connect the media resource. Default value: switched_based
Resource Type	STRING	Specifies the value to set in the SpecializedResource parameter of the SEIZERES operation. Possible values: UNUSED DTMF_TONE_DETECTOR ASR_DIGITS ASR_SPEECH_USER_INTERFACE Default values: UNUSED
Private Resource Type	STRING	Specifies the value to set in the PrivateSpecializedResource parameter of the SEIZERES operation.
SN-IP Configuration	STRING	Possible values: UNUSED SN IP and SCP are co-located. When you choose this option, you need to set also the SN Address parameter. IP IP and SCP are not co-located. Default value: UNUSED
SN Address	STRING	Specifies the value to set in the DestinationDigits parameter of the CONNRES operation. This value is regarded only when SN-IP Configuration parameter is set to SN.

Configuring TCAP Parameters

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

Table 13-41 describes configuration parameters on the TCAP subtab.

Table 13-41 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 WIN Phase 2 with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-SSF WIN through JMX. The hierarchy of the MBeans is shown on Figure 13-6.

Figure 13-6 IM-SSF WIN MBeans Hierarchy

The following sections provide reference information for the IM-SSF WIN 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

ImssfWinMBean

ImssfWinMBean is a root MBean for the IM-SSF CAP WIN 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 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 13-37.

Operations

None

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

• ImssfModeOfOperation

• SessionCase

• TssfDurationInSeconds

• TssfUserInteractionDurationInSeconds

• ImssfMediaCapability

• BodyEncodingFormat

• MscId

• MsId

• MobileEquipmentNumberSerialNumber

• MobileEquipmentNumberManufacturerCode

• OrigreqDialedDigitsNumberingPlan

• OrigreqDialedDigitsTypeOfDigits

• OrigreqMdnTypeOfDigits

• OrigreqMdnNumberingPlan

• AnlyzdInvokeDigitsNumberingPlan

• AnlyzdInvokeDigitsTypeOfDigits

• AnlyzdInvokeMobileDirectoryNumberTypeOfDigits

• AnlyzdInvokeMobileDirectoryNumberNatureNumberingPlan

For more information on these attributes, see Table 13-38.

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

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 the IM-SSF invokes to the SCP above.

Factory Method

SubscriberDataRecords.createSubscriberDataRecord()

Attributes

• Min

• Dn

• ScpAddressAlias

• DefaultCallHandling

• TdpList

For more information on these attributes, see Table 13-39.

Operations

None

MediaResourcesMBean

MediaResourcesMBean is a container for instances of MediaResourceMBean. Each instance of MediaResourceMBean represents a single media resource to which an SSP can connect.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getMediaResource()

Returns an array of references to instances of MediaResourceMBean

ObjectName createMediaResourceMBean()

Creates a new instance of MediaResourceMBean

void destroyMediaResourceMBean()

Destroys an existing instance of MediaResourceMBean

ObjectName lookupMediaResourceMBean()

Gets a reference to the instance of MediaResourceMBean

MediaResourceMBean

Each instance of MediaResourceMBean represents one media resource to which an SSP can connect to play announcements.

Factory Method

MediaResources.createMediaResource()

Attributes

• Alias

• AddressDigits

• OperationType

• ResourceType

• PrivateResourceType

• SnIpConfiguration

For more information on these attributes, see Table 13-40.

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 13-41.

Operations

None

Configuring IM-SSF AIN 0.1

This section describes how to configure IM-SSF AIN 0.1 using the Service Broker Administration Console and Java MBeans.

Configuring IM-SSF AIN 0.1 with the Administration Console

This section describes how to configure the IM-SSF AIN 0.1 using the Service Broker Administration Console.

To access the IM-SSF AIN 0.1 configuration screen:

1. In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed interworking module instances is displayed.

2. In the list of the deployed module instances, select the module instance that you want to configure. The module instance configuration screen is displayed in the Configuration pane.

   The configuration screen of the IM-SSF AIN 0.1 contains the subtabs described in Table 13-42.

Table 13-42 IM-SSF AIN 0.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".
Media Resources	Enables you to set up the media resources that Service Broker uses to play announcements. For more information, see "Configuring Media Resources 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 / decode SS7 messages and enables you to specify an alias for an Interworking Module instance.

Table 13-43 describes the configuration parameter on the General subtab.

Table 13-43 General Parameter

Name	Type	Description
Alias	STRING	Specifies the alias of the IM's SS7 address. The alias is an index to 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 / decode SS7 messages.

Configuring Call Handling Parameters

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

Table 13-44 describes configuration parameters on the Call Handling subtab.

Table 13-44 IM-SSF AIN 0.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 the 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
IM-SSF Media Capability	BOOL	Specifies whether or not the underlying network supports IP/SRF/MRF. This determines if the IM-SSF can handle media-related operations, such as EstablishTemporaryConnection or ConnectToResource. Possible values: True False Default value: False
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
NatureOfNumber of calledPartyID	STRING	Specifies the NatureOfNumber value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP. Trigger messages: Origination_Attempt Info_ Collected Info_Analyze Termination_Attempt Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL Default value: NATIONAL
NumberingPlan of calledPartyID	STRING	Specifies the NumberingPlan value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP. Trigger messages: Origination_Attempt Info_ Collected Info_Analyze Termination_Attempt Possible values: ISDN PRIVATE UNKNOWN Default value: ISDN
NatureOfNumber of callingPartyID	STRING	Specifies the NatureOfNumber value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL Default value: NATIONAL
NumberingPlan of callingPartyID	STRING	Specifies the NumberingPlan value in the CallingPartyID field that IM-SSF sets when invoking trigger messages towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Possible values: ISDN PRIVATE UNKNOWN Default value: ISDN
ScreeningIndicator of callingPartyID	STRING	Specifies the ScreeningIndicator value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Possible values: USER_PROVIDED_NOT_VERIFIED USER_PROVIDED_VERIFIED_PASSED USER_PROVIDED_VERIFIED_FAILED NETWORK_PROVIDED Default value: USER_PROVIDED_NOT_VERIFIED
userID	STRING	Specifies the value that IM-SSF sets in the userID field when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Default value: -1
BearerCapability	STRING	Specifies the value that IM-SSF sets in the bearerCapability field when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Possible values: SPEECH F31KHZAUDIO F7KHZAUDIO B56KBPS B64KBPS PACKETMODEDATA Default value: SPEECH

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 13-45.

Table 13-45 IM-SSF AIN 0.1 Subscriber Data Fields

Name	Type	Description
DN	STRING	Specifies a condition on session DN. When the condition is met, IM-SSF invokes triggers towards the SCP. To apply a rule for all DNs, set this parameter to Default.
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 (that is, invokes a trigger towards the failed SCP). Possible values: CONTINUE_CALL RELEASE_CALL Default value: CONTINUE_CALL
TDP List	STRING_LIST	Specifies a list of TDPs that must be triggered. Each trigger is specified in the following format: <id>=<type> where: <id> is one of the following 225: OriginatingAttempt 227: InfoCollected 228: InfoAnalyzed 3607: NetworkBusy 3616: TerminationAttempt <type> is one of the following: R, which means Interrupt N, which means Notify Separate multiple TDPs with a comma. For example: 3607=R, 3616=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 13-46.

Table 13-46 IM-SSF AIN 0.1 Operation Propagation

Name	Type	Description
Name	STRING	Specifies a unique identifier.
Operation	STRING	Set this value to SendNotification.
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 Media Resources Parameters

The Media Resources subtab enables you to define the media resources that the SSP can connect in order to play announcements.

The table in the Media Resources subtab displays the media resources that are used to play announcements. Each row represents one media resource. When defining a new media resource, you need to specify the fields described in Table 13-47.

Table 13-47 IM-SSF AIN 0.1 Media Resource Definition Fields

Name	Type	Description
Name	STRING	Specifies a name of the media resource.
Alias	STRING	Specifies a unique identifier that applications use to instruct IM-SCF which media resource to connect in order to play announcements. Alias is used by IM-SCF to lookup for media resource details in this table. Aliases are defined in a URI format. For example: [e-mail].
Announcement Operation	INT	Specifies which operation IM-SCF triggers towards the switch-based media resource. Possible values: 0 PlayAnnoucnement 1 PlayAnnouncementAndCollectDigits Default value: 0
Disconnect Flag	BOOL	Specifies whether or not to set the DisconnectFlag in SendToResource operation. Possible values: Yes The switch disconnects a call immediately after completing playing announcement. No The switch does not disconnect a call immediately after completing playing announcement. Default value: Yes
Answer Indication	BOOL	Specifies whether a switch sends Answer message to the calling party upon connection to the media resource. Possible values: True Connection to the media resource causes the switch to generate answer indication towards the calling party. This opens a media path from the caller to the media resource (bothwayPathRequired). False The media path opens only in the direction from the media resource to the caller. Default value: True

Configuring TCAP Parameters

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

Table 13-48 describes configuration parameters on the TCAP subtab.

Table 13-48 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 AIN 0.1 with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-SSF AIN 0.1 through JMX. The hierarchy of the MBeans is shown in Figure 13-7.

Figure 13-7 IM-SSF AIN 0.1 MBeans Hierarchy

The following sections provide reference information for the IM-SSF AIN 0.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

ImssfAinMBean

ImssfAinMBean is a root MBean for the IM-SSF AIN 0.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 13-43.

Operations

None

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

• ImssfModeOfOperation

• SessionCase

• TssfDurationInSeconds

• TssfUserInteractionDurationInSeconds

• ImssfMediaCapability

• BodyEncodingFormat

• NatureOfNumberOfCalledPartyId

• NumberingPlanOfCalledPartyId

• UserId

• BearerCapability

• NatureOfNumberOfCallingPartyId

• NumberingPlanOfCallingPartyId

• ScreeningIndicatorOfCallingPartyId

For more information on these attributes, see Table 13-44.

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

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 the IM-SSF invokes to the SCP above.

Factory Method

SubscriberDataRecords.createSubscriberDataRecord()

Attributes

• Dn

• ScpAddressAlias

• DefaultCallHandling

• TdpList

For more information on these attributes, see Table 13-45.

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 this operation to another module.

Factory Method

OperationPropagationSet.createOperationPropagation()

Attributes

• Operation

• ModuleName

• EnablePropagation

For more information on these attributes, see Table 13-46.

Operations

None

MediaResourcesMBean

MediaResourcesMBean is a container for instances of MediaResourceMBean. Each instance of MediaResourceMBean represents a single media resource to which an SSP can connect.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getMediaResource()

Returns an array of references to instances of MediaResourceMBean

ObjectName createMediaResourceMBean()

Creates a new instance of MediaResourceMBean

void destroyMediaResourceMBean()

Destroys an existing instance of MediaResourceMBean

ObjectName lookupMediaResourceMBean()

Gets a reference to the instance of MediaResourceMBean

MediaResourceMBean

Each instance of MediaResourceMBean represents one media resource to which an SSP can connect to play announcements.

Factory Method

MediaResources.createMediaResource()

Attributes

• Alias

• AnnouncementOperation

• DisconnectFlag

• AnswerIndication

For more information on these attributes, see Table 13-47.

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 13-48.

Operations

None

Configuring IM-SSF AIN 0.2

This section describes how to configure IM-SSF AIN 0.2 using the Service Broker Administration Console and Java MBeans.

Configuring IM-SSF AIN 0.2 with the Administration Console

This section describes how to configure the IM-SSF AIN 0.2 by using the Service Broker Administration Console.

To access the IM-SSF AIN 0.2 configuration screen:

1. In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed interworking module instances is displayed.

2. In the list of the deployed module instances, select the module instance that you want to configure. The module instance configuration screen is displayed in the Configuration pane.

   The configuration screen of the IM-SSF AIN 0.2 contains the subtabs described in Table 13-49.

Table 13-49 IM-SSF AIN 0.2 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".
Media Resources	Enables you to set up the media resources that Service Broker uses to play announcements. For more information, see "Configuring Media Resources 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 / decode SS7 messages and enables you to specify an alias for an Interworking Module instance.

Table 13-50 describes the configuration parameter on the General subtab.

Table 13-50 General Parameter

Name	Type	Description
Alias	STRING	Specifies the alias of the IM's SS7 address. The alias is an index to 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 / decode SS7 messages.

Configuring Call Handling Parameters

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

Table 13-51 describes configuration parameters on the Call Handling subtab.

Table 13-51 IM-SSF AIN 0.2 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 the 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: ORIG
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
IM-SSF Media Capability	BOOL	Specifies whether or not the underlying network supports IP/SRF/MRF. This determines if the IM-SSF can handle media-related operations, such as EstablishTemporaryConnection or ConnectToResource. Possible values: True False Default value: False
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
NatureOfNumber of calledPartyID	STRING	Specifies the NatureOfNumber value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP. Trigger messages: Origination_Attempt Info_ Collected Info_Analyze Termination_Attempt Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL Default value: NATIONAL
NumberingPlan of calledPartyID	STRING	Specifies the NumberingPlan value of the calledPartyID/collectedAddressInfo fields that IM-SSF sets when invoking a trigger message towards the SCP. Trigger messages: Origination_Attempt Info_ Collected Info_Analyze Termination_Attempt Possible values: ISDN PRIVATE UNKNOWN Default value: ISDN
NatureOfNumber of callingPartyID	STRING	Specifies the NatureOfNumber value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Possible values: SUBSCRIBER_NUMBER UNKNOWN NATIONAL INTERNATIONAL Default value: NATIONAL
NumberingPlan of callingPartyID	STRING	Specifies the NumberingPlan value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Possible values: ISDN PRIVATE UNKNOWN Default value: ISDN
ScreeningIndicator of callingPartyID	STRING	Specifies the ScreeningIndicator value in the CallingPartyID field that IM-SSF sets when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Possible values: USER_PROVIDED_NOT_VERIFIED USER_PROVIDED_VERIFIED_PASSED USER_PROVIDED_VERIFIED_FAILED NETWORK_PROVIDED Default value: USER_PROVIDED_NOT_VERIFIED
userID	STRING	Specifies the value that IM-SSF sets in the userID field when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Default value: -1
BearerCapability	STRING	Specifies the value that IM-SSF sets in the bearerCapability field when invoking trigger message towards the SCP. Trigger messages: Origination_Attempt Info_Collected Info_Analyze Termination_Attempt Possible values: SPEECH F31KHZAUDIO F7KHZAUDIO B56KBPS B64KBPS PACKETMODEDATA Default value: SPEECH

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 13-52.

Table 13-52 IM-SSF AIN 0.2 Subscriber Data Fields

Name	Type	Description
DN	STRING	Specifies a condition on session DN. When the condition is met, IM-SSF invokes triggers towards the SCP. To apply a rule for all DNs, set this parameter to Default.
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 (that is, invokes a trigger towards the failed SCP). Possible values: CONTINUE_CALL RELEASE_CALL Default value: CONTINUE_CALL
TDP List	STRING_LIST	Specifies a list of TDPs that must be triggered. Each trigger is specified in the following format: <id>=<type> where: <id> is one of the following 225: OriginatingAttempt 227: InfoCollected 228: InfoAnalyzed 3607: NetworkBusy 3616: TerminationAttempt <type> is one of the following: R, which means Interrupt N, which means Notify Separate multiple TDPs with a comma. For example: 3607=R, 3616=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 13-53.

Table 13-53 IM-SSF AIN 0.2 Operation Propagation

Name	Type	Description
Name	STRING	Specifies a unique identifier .
Operation	STRING	Specifies an operation. Possible values: SendNotification
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 Media Resources Parameters

The Media Resources subtab enables you to define the media resources that the SSP can connect in order to play announcements.

The table in the Media Resources subtab displays the media resources that are used to play announcements. Each row represents one media resource. When defining a new media resource, you need to specify the fields described in Table 13-54.

Table 13-54 IM-SSF AIN 0.2 Media Resource Definition Fields

Name	Type	Description
Name	STRING	Specifies a name of the media resource.
Alias	STRING	Specifies a unique identifier that applications use to instruct IM-SCF which media resource to connect in order to play announcements. Alias is used by IM-SCF to lookup for media resource details in this table. Aliases are defined in a URI format. For example: [e-mail].
Announcement Operation	INT	Specifies which operation IM-SCF triggers towards the switch-based media resource. Possible values: 0 PlayAnnoucnement 1 PlayAnnouncementAndCollectDigits Default value: 0
Disconnect Flag	BOOL	Specifies whether or not to set the DisconnectFlag in SendToResource operation. Possible values: Yes The switch disconnects a call immediately after completing playing announcement. No The switch does not disconnect a call immediately after completing playing announcement. Default value: Yes
Answer Indication	BOOL	Specifies whether a switch sends Answer message to the calling party upon connection to the media resource. Possible values: True Connection to the media resource causes the switch to generate answer indication towards the calling party. This opens a media path from the caller to the media resource (bothwayPathRequired). False The media path opens only in the direction from the media resource to the caller. Default value: True

Configuring TCAP Parameters

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

Table 13-55 describes configuration parameters on the TCAP subtab.

Table 13-55 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 AIN 0.2 with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-SSF AIN 0.2 through JMX. The hierarchy of the MBeans is shown on Figure 13-8.

Figure 13-8 IM-SSF AIN 0.2 MBeans Hierarchy

The following sections provide reference information for the IM-SSF AIN 0.2 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

ImssfAinMBean

ImssfAinMBean is a root MBean for the IM-SSF AIN 0.2 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 13-50.

Operations

None

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

• ImssfModeOfOperation

• SessionCase

• TssfDurationInSeconds

• TssfUserInteractionDurationInSeconds

• ImssfMediaCapability

• BodyEncodingFormat

• UserId

• BearerCapability

• NatureOfNumberOfCallingPartyId

• NumberingPlanOfCallingPartyId

• ScreeningIndicatorOfCallingPartyId

• NatureOfNumberOfCalledPartyId

• NumberingPlanOfCalledPartyId

For more information on these attributes, see Table 13-51.

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

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 the IM-SSF invokes to the SCP above.

Factory Method

SubscriberDataRecords.createSubscriberDataRecord()

Attributes

• Dn

• ScpAddressAlias

• DefaultCallHandling

• TdpList

For more information on these attributes, see Table 13-52.

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 this operation to another module.

Factory Method

OperationPropagationSet.createOperationPropagation()

Attributes

• Operation

• ModuleName

• EnablePropagation

For more information on these attributes, see Table 13-53.

Operations

None

MediaResourcesMBean

MediaResourcesMBean is a container for instances of MediaResourceMBean. Each instance of MediaResourceMBean represents a single media resource to which an SSP can connect.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName[] getMediaResource()

Returns an array of references to instances of MediaResourceMBean

ObjectName createMediaResourceMBean()

Creates a new instance of MediaResourceMBean

void destroyMediaResourceMBean()

Destroys an existing instance of MediaResourceMBean

ObjectName lookupMediaResourceMBean()

Gets a reference to the instance of MediaResourceMBean

MediaResourceMBean

Each instance of MediaResourceMBean represents one media resource to which an SSP can connect to play announcements.

Factory Method

MediaResources.createMediaResource()

Attributes

• Alias

• AnnouncementOperation

• DisconnectFlag

• AnswerIndication

For more information on these attributes, see Table 13-54.

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 13-55.

Operations

None