16 Configuring IM-OCF

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

Configuring IM-OCF with the Administration Console
Configuring IM-OCF with Java MBeans

Configuring IM-OCF with the Administration Console

This section describes how to configure IM-OCF module instances using the Service Broker Administration Console.

To access the IM-OCF Configuration screen:

In the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules. The list of currently deployed Interworking Modules is displayed.
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-OCF contains the subtabs described in Table 16-1.

Table 16-1 IM-OCF Configuration Subtabs

Subtab	Description
Call Handling	Enables you to define how the IM-OCF handles calls. For more information, see "Configuring Call Handling Parameters".
Diameter Credit Control Application	Enables you to configure parameters specific to the IM-OCF DCCA interface. For more information, see "Configuring Diameter Credit Control Application Parameters"
MRF	Enables you to specify pre-, mid-, and post-call announcements that the IM-OCF can request media resources to play. For more information, see "Configuring MRF Parameters".
Monitoring	Enables you to define how Runtime MBeans and notifications should operate. For more information, see "Configuring Monitoring Parameters".

Configuring Call Handling Parameters

The Call Handling tab enables you to define how the IM-OCF handles calls and sends CCRs. The Call Handling tab contains the subtabs described in Table 16-2.

Table 16-2 IM-OCF Call Handling Subtabs

Subtab	Description
General	Enables you to set up how IM-OCF handles sessions. For more information, see "Configuring Call Handling General Parameters".
CCR Handling	Enables you to specify points in a call at which Service Broker sends a CCR. For more information, see "Configuring CCR Handling".

Subtab

Description

General

Enables you to set up how IM-OCF handles sessions.

For more information, see "Configuring Call Handling General Parameters".

CCR Handling

Enables you to specify points in a call at which Service Broker sends a CCR.

For more information, see "Configuring CCR Handling".

Configuring Call Handling General Parameters

The General subtab enables you to set up how IM-OCF handles sessions. Table 16-3 describes configuration parameters on the General subtab.

Table 16-3 IM-OCF Call Handling General Parameters

Name	Type	Description
Event Handling	STRING	Specifies which mode of Ro operation IM-OCF uses to support event-based charging. Possible values: ECUR Stands for Event Charging with Unit Reservation. With ECUR, IM-OCF sends two requests. One request specifies the desired service consumption. The second request indicates the actual service that has been consumed. IEC Stands for Immediate Event Charging. With IEC, IM-OCF sends a one time request with charging information on a service that has been consumed. Default value: ECUR
Next Quota Request Interval in Milliseconds	INT	Defines in milliseconds how much time prior to the end of quota, IM-OCF needs to request a new quota. Default value: 10
Termination-Cause AVP on SAL BYE	STRING	Specifies how to set a CCR Termination-Cause AVP when session is disconnected by an internal Service Broker SAL BYE message. Possible values: DIAMETER_LOGOUT DIAMETER_SERVICE_NOT_PROVIDED DIAMETER_BAD_ANSWER DIAMETER_ADMINISTRATIVE DIAMETER_LINK_BROKEN DIAMETER_AUTH_EXPIRED DIAMETER_USER_MOVED DIAMETER_SESSION_TIMEOUT Default value: DIAMETER_LOGOUT
Termination-Cause AVP on SAL CANCEL	STRING	Specifies how to set a CCR Termination-Cause AVP when session is disconnected by an internal Service Broker SAL CANCEL message. Possible values: DIAMETER_LOGOUT DIAMETER_SERVICE_NOT_PROVIDED DIAMETER_BAD_ANSWER DIAMETER_ADMINISTRATIVE DIAMETER_LINK_BROKEN DIAMETER_AUTH_EXPIRED DIAMETER_USER_MOVED DIAMETER_SESSION_TIMEOUT Default value: DIAMETER_SERVICE_NOT_PROVIDED
Termination-Cause AVP on SAL Final Error Response	STRING	Specifies how to set a CCR Termination-Cause AVP when session is disconnected by an internal Service Broker SAL final error response message. Possible values: DIAMETER_LOGOUT DIAMETER_SERVICE_NOT_PROVIDED DIAMETER_BAD_ANSWER DIAMETER_ADMINISTRATIVE DIAMETER_LINK_BROKEN DIAMETER_AUTH_EXPIRED DIAMETER_USER_MOVED DIAMETER_SESSION_TIMEOUT Default value: DIAMETER_SERVICE_NOT_PROVIDED
Termination-Cause AVP upon GSU Expiration	STRING	Specifies how to set a CCR Termination-Cause AVP when IM-OCF disconnects a session due to expiration of Granted Service Units. This parameter is used only when the Monitor Call Duration parameter is set to True. Otherwise, this parameter is ignored. Possible values: DIAMETER_LOGOUT DIAMETER_SERVICE_NOT_PROVIDED DIAMETER_BAD_ANSWER DIAMETER_ADMINISTRATIVE DIAMETER_LINK_BROKEN DIAMETER_AUTH_EXPIRED DIAMETER_USER_MOVED DIAMETER_SESSION_TIMEOUT Default value: DIAMETER_AUTH_EXPIRED
Give Precedence to XER on CCR Generation	BOOL	IM-OCF constructs a CCR towards the Online Charging Function (OCF), based on internal Service Broker message information, and an original CCR (if such exists) from a core network call control entity that is carried on the internal Service Broker message. This parameter specifies which of the two sources receives precedence. Possible values: True False Default value: True
Pass Credit Control Messages inside Service Broker	STRING	Specifies whether or not IM-OCF attaches CCAs to internal Service Broker messages. If IM-CF attaches CCAs, this parameter specifies a format in which CCA is encoded. Possible values: NONE XER Default value: NONE
Monitor Call Duration	BOOL	Specifies whether or not IM-OCF uses internal resources to monitor call duration. Possible values: True False Default value: True
Max Call Duration in Minutes	INT	Specifies a maximum call duration that IM-OCF allows. IM-OCF disconnects calls that exceed this duration. This parameter is used only when the Monitor Call Duration parameter is set to True. Otherwise, this parameter is ignored.

Configuring CCR Handling

The CCR Handling subtab enables you to specify points in a call at which Service Broker sends a CCR. The subtab contains a table in which each row represents a point in a call.

Table 16-4 describes configuration parameters that you define for each point in a call.

Table 16-4 IM-OCF Call Handling CCR Handling Parameters

Name

Type

Description

Name

STRING

Specifies a unique identifier

Point In Call

STRING

Specifies a point in a call for which you define whether or not Service Broker needs to send a CCR.

Possible options:

INITIATED
ALERTED
CONNECTED
INFO_RECEIVED
REINVITED
REINVITED_OK
UPDATED
UPDATED_OK
EARLY_RELEASED
ACTIVE_RELEASED

Send CCR

STRING

Specifies whether or not Service Broker sends a CCR at the point selected in the Point In Call drop-down list.

Possible options:

Yes

Service Broker sends a CCR
No

Service Broker does not sends a CCR
Dynamic

Service Broker sends a CCR when a subscriber's location changed. You can set the Send CCR parameter for a point in call to "Dynamic" only when Send CCR for a previous point in call is set to "Yes".

Default value: Yes

Configuring Diameter Credit Control Application Parameters

The Diameter Credit Control Application tab enables you to configure parameters related to the IM-OCF Diameter Credit Control Application (DCCA) interface. The Diameter Credit Control Application tab contains subtabs described in Table 16-5.

Table 16-5 IM-OCF Diameter Credit Control Application Subtabs

Subtab	Description
General	Enables you to setup a DCCA dialect and enables monitor call duration. For more information, see "Configuring General Parameters".
AVPs	Enables you to specify Attribute-Value Pairs (AVPs) to be set in CCRs. For more information, see "Configuring AVPs".
Credit Control Failure Handling	Enables you to setup how IM-OCF handles a call when receiving a CCA with a Result-Code that contains an error. For more information, see "Configuring Credit Control Failure Handling".

Subtab

Description

General

Enables you to setup a DCCA dialect and enables monitor call duration.

For more information, see "Configuring General Parameters".

AVPs

Enables you to specify Attribute-Value Pairs (AVPs) to be set in CCRs.

For more information, see "Configuring AVPs".

Credit Control Failure Handling

Enables you to setup how IM-OCF handles a call when receiving a CCA with a Result-Code that contains an error.

For more information, see "Configuring Credit Control Failure Handling".

Configuring General Parameters

The General subtab enables you to set up a DCCA dialect and enable monitor call duration. Table 16-6 describes the parameters you can configure.

Table 16-6 IM-OCF DCCA General Subtab Parameters

Name	Type	Description
DCCA Dialect	STRING	Specifies the DCCA dialect that IM-OCF should use. Possible values: BRM_DCCA Oracle Communications Billing and Revenue Management DCCA dialect STANDARD_DCCA Standards DCCA dialect Default value: BRM_DCCA
Monitor Call Duration	BOOL	Specifies whether or not IM-OCF uses internal resources to monitor call duration. Possible values: True False Default value: True

Name

Type

Description

DCCA Dialect

STRING

Specifies the DCCA dialect that IM-OCF should use.

Possible values:

BRM_DCCA

Oracle Communications Billing and Revenue Management DCCA dialect
STANDARD_DCCA

Standards DCCA dialect

Default value: BRM_DCCA

Monitor Call Duration

BOOL

Specifies whether or not IM-OCF uses internal resources to monitor call duration.

Possible values:

True

False

Default value: True

Configuring AVPs

The AVPs subtab enables you to specify Attribute-Value Pairs (AVPs) to be set in CCRs. Table 16-7 describes the AVPs that you can specify.

Table 16-7 IM-OCF DCCA AVPs Subtab Parameters

Name	Type	Description
Origin-Host AVP	STRING	Specifies the value to set in a CCR Origin-Host AVP.
Origin-Realm AVP	STRING	Specifies the value to set in a CCR Origin-Realm AVP.
Destination-Host AVP	STRING	Specifies the value to set in a CCR Destination-Host AVP.
Destination-Realm AVP	STRING	Specifies the value to set in a CCR Destination-Realm AVP.
Auth-Application-Id AVP	INT	Specifies the value to set in a CCR Auth-Application-Id AVP. Default value: 4
Service-Context-Id AVP	STRING	Specifies the value to set in a CCR Service-Context-Id AVP.
Origin-State-Id AVP	INT	Specifies whether or not to set the Origin-State-Id AVP in a CCR. If the value of this parameter is 0, then Origin-State-Id AVP is also set to 0, indicating that this AVP is not used. Default value: 0
User-Name AVP	STRING	Specifies the value to set in a CCR User-Name AVP.
CC-Time AVP	INT	Specifies the value to be set in a CCR CC-Time AVP. This AVP defines the number of requested service units (for example, call minutes) and is used in SCUR scenarios.
CC-Service-Specific-Units AVP	INT	Specifies the value to be set in a CC-Service-Specific-Units AVP. This AVP defines the number of requested service units (for example, number of SMSs) and is used in ECUR and IEC scenarios.
Ro Node-Functionality AVP	INT	Specifies the value to set in a CCR Node-Functionality AVP. Possible values: 0 Specifies S-CSCF 1 Specifies P-CSCF 2 Specifies I-CSCF 3 Specifies MRFC 4 Specifies MGCF 5 Specifies BGCF 6 Specifies AS Default value: 6

Configuring Credit Control Failure Handling

The Credit Control Failure Handling subtab enables you to define how IM-OCF handles a call when responded with CCA that contains an error Result-Code. The subtab contains a table in which each row represents a Result-Code range. For each range, you can define how IM-OCF handles a CCA containing a Result-Code in this range.

Caution:

IM-OCF is provided with preconfigured settings that define how it handles the following Result-Code values:

3003
4001
4010-4012
5003
5006

It is strongly recommended to not use this subtab to override these preconfigured settings.

Table 16-8 describes the parameters that you can define for each range.

Table 16-8 IM-OCF DCCA Credit Control Failure Handling Subtab Parameters

Name	Type	Description
Name	STRING	Specifies a unique row identifier
Range Low	STRING	Specifies the low limit of a Result-Code range. Together with the Range High parameter, it specifies a range of Result-Code values. If you need to define a range with only one Result-Code value, specify this value in both the Range Low and Range High parameters. Note: IM-OCF uses preset handling settings that you cannot change for the following Result-Code values: 3003 4001 4010-4012 5003 5006 Do not define any of these codes. Preset handling prevails user settings.
Range High	STRING	Specifies the high limit of a Result-Code range. Together with the Range Low parameter, it specifies a range of Result-Code values. If you need to define a range with only one Result-Code value, specify this value in both the Range Low and Range High parameters. Note: IM-OCF uses preset handling settings that you cannot change for the following Result-Code values: 3003 4001 4010-4012 5003 5006 Do not define any of these codes. Preset handling prevails user settings.
Use CCFH	BOOL	Specifies whether or not IM-OCF uses the Credit Control Failure Handling (CCFH) AVP when IM-OCF receives a CCA with an error Result-Code. Possible values: True IM-OCF uses the value in the CCFH AVP. It continues or terminates the session as defined by the CCFH AVP. False IM-OCF ignores the value in the CCFH AVP, and terminates the session.
Call Handling	STRING	Specifies a method for default call handling in the following cases: When Use CCA CCFH is set to False. When Use CCA CCFH is set to True, but the CCA does not contain a CCFH AVP. Possible options: TERMINATE CONTINUE Default value: TERMINATE
Announcement ID	STRING	Specifies the announcement to be played if IM-OCF ends up terminating a session due to the error Result-Code specified in Range Low and Range High. You need to specify the ID of an announcement, that is a string that must reference a valid announcement defined in your network. The Announcement is played only when a session is terminated, and if the error Result-Code arrives on a CCA response to initial or update CCR. If IM-OCF terminates a call as a result of an error Result-Code on a final CCA, then post call announcements can be played, as defined in the MRF Announcements configuration screen. The Announcement ID parameter is optional. If you do not set it, then sessions will just be terminated, without any announcement being played.

Configuring MRF Parameters

The MRF subtab enables you to configure the IM-OCF announcement playing functionality. The MRF tab contains two subtabs described in Table 16-9.

Table 16-9 MRF Subtabs

Name	Description
General	Enables you to specify the address of the MRF that Service Broker uses to play announcements. For more information, see "Configuring General MRF Parameters".
MRF Announcements	Enables you to specify pre-, mid-, and post-call announcements that may be played by media resources. For more information, see "Configuring MRF Announcements".

Name

Description

General

Enables you to specify the address of the MRF that Service Broker uses to play announcements.

For more information, see "Configuring General MRF Parameters".

MRF Announcements

Enables you to specify pre-, mid-, and post-call announcements that may be played by media resources.

For more information, see "Configuring MRF Announcements".

Configuring General MRF Parameters

The General subtab enables you to specify the address of the MRF that Service Broker uses to play announcements.

Table 16-10 IM-OCF General Parameters

Name	Type	Description
MRF Address	STRING	Specifies the address of the MRF that Service Broker uses to play announcements. The address has a format of a SIP URI. For example: sip:mrf@192.168.0.15:5080

Name

Type

Description

MRF Address

STRING

Specifies the address of the MRF that Service Broker uses to play announcements.

The address has a format of a SIP URI.

For example: sip:mrf@192.168.0.15:5080

Configuring MRF Announcements

The MRF Announcements subtab enables you to specify pre-, mid-, and post-call announcements that the IM-OCF can request media resources to play. The MRF Announcements subtab contains a table in which each row represents an announcement.

Table 16-11 describes configuration parameters that you can define for each announcement.

Table 16-11 IM-OCF MRF Announcement Parameters

Name	Type	Description
Name	STRING	Specifies a unique identifier
Point In Call	STRING	Specifies the point in call when the announcement is played. Possible values: PRECALL MIDCALL POSTCALL REJECTCALL Default value: PRECALL
Announcement Name	STRING	Specifies the announcement file name
Activity	BOOL	Specifies whether or not the announcement is enabled. Possible values: True False Default value: True
Announcement ID	STRING	Specifies a unique announcement identifier
MSC ID	STRING	The announcement is relevant only to sessions that where triggered by the specified MSC. When this value is not set, the announcement is relevant to all MSCs.
Call Direction	STRING	Specifies the call direction for which the announcement is applicable. Possible values: ORIG Stands for outgoing call TERM Stands for incoming call BOTH Stands for both incoming and outgoing calls Default value: ORIG
T1	STRING	When Point In Call is set to PRECALL, this parameter specifies a lower limit of a time range in seconds. The announcement is played prior to the call if the allowed call duration (granted units) is in the specified range. When Point In Call is set to MIDCALL, this parameter specifies the time in seconds, before the call quota ends, and the announcement is played.
T2	STRING	When Point In Call is set to PRECALL, this parameter specifies an upper limit of a time range in seconds. The announcement is played prior to the call if the allowed call duration (granted units) is in the specified range.

Configuring Monitoring Parameters

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

Configuring IM-OCF with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-OCF through JMX. The hierarchy of the MBeans is shown on Figure 16-1.

Figure 16-1 IM-OCF MBeans Hierarchy

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

ImocfMBean

ImocfMBean is a root MBean for the IM-OCF configuration.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getCallHandlingGeneral()

Gets a reference to the instance of CallHandlingGeneralMBean

ObjectName getSendCcrRecords()

Gets a reference to the instance of SendCcrRecordsMBean

ObjectName getDiameterCreditControlApplicationAvps()

Gets a reference to the instance of DiameterCreditControlApplicationAvpsMBean

ObjectName getDiameterCreditControlApplicationGeneral()

Gets a reference to the instance of DiameterCreditControlApplicationGeneralMBean

ObjectName getCcfhRecords()

Gets a reference to the instance of CcfhRecordsMBean

ObjectName getMrfAnnouncementsGeneral()

Gets a reference to the instance of MrfAnnouncementsGeneralMBean

ObjectName getAnnouncementRecords()

Gets a reference to the instance of AnnouncementsRecordsMBean

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

CallHandlingGeneralMBean

CallHandlingGeneralMBean enables you to configure how a call is handled.

Factory Method

Created automatically

Attributes

EventHandling
NextQuotaRequestIntervalInMilliseconds
InitialCCRFailureHandling
NonInitialCCRFailureHandling
TerminationCauseAvpOnSalBye
TerminationCauseAvpOnSalCancel
TerminationCauseAvpOnSalFinalErrorResponse
GivePrecedenceToOriginalCCR
CarryCCAOnInternalServiceBrokerMessages
MonitorCallDuration
MaxCallDurationInMinutes
TerminationCauseAvpUponGsuExpiration

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

Operations

None

SendCcrRecordsMBean

SendCcrRecordsMBean is a root MBean for instances of SendCcrRecordMBean that enable you to specify points in a call at which Service Broker sends a CCR.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName createSendCcrRecord()

Creates an instance of SendCcrRecordMBean

void destroySendCcrRecord()

Destroys an instance of SendCcrRecordMBean

ObjectName[] getSendCcrRecord()

Gets an array of references to instances of SendCcrRecordMBean

ObjectName lookupSendCcrRecord()

Returns a specified instance of SendCcrRecordMBean

SendCcrRecordMBean

SendCcrRecordMBean enables you to specify a point in a call at which Service Broker sends a CCR.

Factory Method

SendCcrRecords.createSendCcrRecord()

Attributes

PointInCall
SendCcr

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

Operations

None

DiameterCreditControlApplicationAvpsMBean

DiameterCreditControlApplicationAvpsMBean enables you to specify Attribute-Value Pairs (AVPs) to be set in CCRs.

Factory Method

Created automatically

Attributes

OriginHostAvp
OriginRealmAvp
DestinationHostAvp
DestinationRealmAvp
AuthApplicationIdAvp
ServiceContextIdAvp
OriginStateIdAvp
UserNameAvp
CcTimeAvp
CcServiceSpecificUnitsAvp
RoNodeFunctionalityAvp

For more information on these attributes, see Table 16-7.

Operations

None

DiameterCreditControlApplicationGeneralMBean

DiameterCreditControlApplicationGeneralMBean enables you to setup a DCCA dialect and enable monitor call duration.

Factory Method

Created automatically

Attributes

DccaDialect

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

Operations

None

CcfhRecordsMBean

CcfhRecordsMBean is a root MBean for instances of CcfhRecordMBean that enable you to setup how IM-OCF handles a call when receiving a CCA with a Result-Code that contains an error.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName createCcfhRecord()

Creates an instance of CcfhRecordMBean

void destroyCcfhRecord()

Destroys an instance of CcfhRecordMBean

ObjectName[] getCcfhRecord()

Gets an array of references to instances of CcfhRecordMBean

ObjectName lookupCcfhRecord()

Returns a specified instance of CcfhRecordMBean

CcfhRecordMBean

CcfhRecordMBean enables you to setup how IM-OCF handles a call when receiving a CCA with a Result-Code in a specified range.

Factory Method

CcfhRecords.createCcfhRecord()

Attributes

RangeLow
RangeHigh
UseCcfh
CallHandling
AnnouncementId

For more information on these attributes, see Table 16-8.

Operations

None

MrfAnnouncementsGeneralMBean

MrfAnnouncementsGeneralMBean enables you to specify the MRF address that Service Broker use to play announcements.

Factory Method

Created automatically

Attributes

MrfAddress

For more information on these attributes, see Table 16-10.

Operations

None

AnnouncementRecordsMBean

AnnouncementRecordsMBean is a root MBean for instances of AnnouncementRecordMBean that enable you to specify pre-, mid-, and post-call announcements which IM-OCF requests media resources to play.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName createAnnouncementRecord()

Creates an instance of AnnouncementRecordMBean

void destroyAnnouncementRecord()

Destroys an instance of AnnouncementRecordMBean

ObjectName[] getAnnouncementRecord()

Gets an array of references to instances of AnnouncementRecordMBean

ObjectName lookupAnnouncementRecord()

Returns a specified instance of AnnouncementRecordMBean

AnnouncementRecordMBean

AnnouncementRecordMBean enables you to specify a pre-, mid-, or post-call announcement that the IM-OCF can request media resources to play.

Factory Method

AnnouncementRecords.createAnnouncementRecord()

Attributes

PointInCall
AnnouncementName
Activity
AnnouncementId
MscId
CallDirection
T1
T2

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

Operations

None