21 Configuring IM-SSF AIN 0.2

The following sections describe how to configure IM-SSF 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:

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

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

The IM-SSF AIN 0.2 configuration pane contains the subtabs described in Table 21-1.

Table 21-1 IM-SSF AIN 0.2 Configuration Subtabs

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

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

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

Table 21-3 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 21-4.

Table 21-4 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 21-5.

Table 21-5 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 21-6.

Table 21-6 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: mrf.network@domain.com.
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 21-7 describes configuration parameters on the TCAP subtab.

Table 21-7 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. Figure 21-1 shows the hierarchy of the IM-SSF AIN 0.2 MBeans.

Figure 21-1 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 21-2.

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

Factory Method

OperationPropagationSet.createOperationPropagation()

Attributes

Operation
ModuleName
EnablePropagation

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

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 21-6.

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 21-7.

Operations

None