25 Configuring IM-OCF Ro

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

Configuring IM-OCF Ro with the Administration Console

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

To access the IM-OCF Ro Configuration screen:

In the domain navigation pane, expand OCSB.
Expand Processing Tier.
Select 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-OCF Ro configuration pane contains the subtabs described in Table 25-1.

Table 25-1 IM-OCF Configuration Subtabs

Subtab	Description
Call Handling	Enables you to define how the IM-OCF Ro handles calls. See "Configuring Call Handling Parameters" for more information.
Diameter Credit Control Application	Enables you to configure parameters specific to the IM-OCF Ro DCCA interface. See "Configuring Diameter Credit Control Application Parameters" for more information.
Async Announcement Manager	Enables you to set up how IM-OCF Ro triggers the MRF to play announcements. See "Configuring Asynchronous Announcement Manager Parameters" for more information.
Monitoring	Enables you to define how Runtime MBeans and notifications should operate. See "Configuring Monitoring Parameters" for more information.
Degraded Mode	Enables you to set up how a session is charged when an online charging server is not available. See "Configuring the Degraded Mode" for more information.

Configuring Call Handling Parameters

The General tab enables you to set up how IM-OCF Ro handles sessions. Table 25-2 describes configuration parameters in the General subtab.

Table 25-2 IM-OCF Ro Call Handling General Parameters

Name	Type	Description
Event Handling	STRING	Specifies which mode of Ro operation IM-OCF Ro uses to support event-based charging. Possible values: ECUR Stands for Event Charging with Unit Reservation. With ECUR, IM-OCF Ro 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 Ro sends a one time request with charging information on a service that has been consumed. Default value: ECUR
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

Configuring Diameter Credit Control Application Parameters

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

Table 25-3 IM-OCF Diameter Credit Control Application Subtabs

Subtab	Description
AVPs	Enables you to specify Attribute-Value Pairs (AVPs) to be set in CCRs. See "Configuring AVPs" for more information.
General	Enables you to set up a DCCA dialect and enables monitor call duration. For more information, see "Configuring General Parameters".

Subtab

Description

AVPs

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

See "Configuring AVPs" for more information.

General

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

For more information, see "Configuring General Parameters".

Configuring AVPs

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

Table 25-4 IM-OCF DCCA AVPs Subtab Parameters

Name	Type	Description
Destination-Host AVP	STRING	Specifies the value to set in a CCR Destination-Host AVP. The Destination-Host AVP combined with the Destination-Realm AVP defines a Diameter destination node that communicates with the IM-OCF Ro. The IM-OCF Ro sends messages to the address you specify for the Diameter destination node. An alternative way to specify a Diameter destination node is to set the Destination-Realm AVP field with an alias of a Diameter destination node, which you define in the Diameter SSU Outbound Destination. See "Configuring Outbound Destinations" in the Signaling Domain Configuration Guide for more information. In this case, the Destination-Host AVP is ignored.
Destination-Realm AVP	STRING	Specifies the value to set in a CCR Destination-Realm AVP. The Destination-Realm AVP combined with the Destination-Host AVP defines a Diameter destination node that communicates with the IM-OCF Ro.The IM-OCF Ro sends messages to the address you specify for the Diameter destination node. An alternative way to specify a Diameter destination node is to set the Destination-Realm AVP field with an alias of a Diameter destination node, which you define in the Diameter SSU Outbound Destination. See "Configuring Outbound Destinations" in the Signaling Domain Configuration Guide for more information. In this case, the Destination-Host AVP is ignored.
Service-Context-Id AVP	STRING	Specifies the value to set in a CCR Service-Context-Id AVP. Default value: 32260@3gpp.org
User-Name AVP	STRING	Specifies the value to set in a CCR User-Name AVP.
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 General Parameters

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

Table 25-5 IM-OCF DCCA General Subtab Parameters

Name	Type	Description
DCCA Dialect	STRING	Specifies the DCCA dialect that IM-OCF Ro uses. Possible values: STANDARD_DCCA Standard DCCA dialect BRM Oracle Communications Billing and Revenue Management DCCA dialect Default value: Standard

Name

Type

Description

DCCA Dialect

STRING

Specifies the DCCA dialect that IM-OCF Ro uses.

Possible values:

STANDARD_DCCA

Standard DCCA dialect
BRM

Oracle Communications Billing and Revenue Management DCCA dialect

Default value: Standard

Configuring Asynchronous Announcement Manager Parameters

You can set up IM-OCF Ro to trigger an MRF to play announcements. Using the Async Announcement Manager tab, you can specify the alias of the MRF that plays announcements. In addition, you set up the rules that define the announcement to be played and the way how the MRF plays this announcement. For example, you can define that the MRF plays an announcement to a calling party when the time granted for the call is over, and the mobile subscriber is located in the home network.

You set up the Announcement Manager by configuring parameters on the subtabs described in Table 25-6.

Table 25-6 IM-OCF Ro Async Announcement Manager Subtabs

Subtab	Description
General	Enables you to specify the alias of the MRF that plays announcements. See "Configuring General Parameters" for more information.
Async Announcements	Enables you to set up the rules that define announcements to be played as well as to specify how the MRF plays these announcements. See "Configuring Async Announcements" for more information.

Subtab

Description

General

Enables you to specify the alias of the MRF that plays announcements.

See "Configuring General Parameters" for more information.

Async Announcements

Enables you to set up the rules that define announcements to be played as well as to specify how the MRF plays these announcements.

See "Configuring Async Announcements" for more information.

Configuring General Parameters

The General subtab enables you to specify the alias of the MRF that plays announcements. Table 25-7 describes the parameter you can configure.

Table 25-7 Async Announcement Manager General Parameter

Name	Type	Description
MRF Alias	STRING	Specifies the alias of the MRF that IM-OCF Ro uses to play announcements. The alias has the format of a SIP URI: sip: name1.name2@domain_name. For example: sip:ocsb.mrf@processing_domain1.

Name

Type

Description

MRF Alias

STRING

Specifies the alias of the MRF that IM-OCF Ro uses to play announcements.

The alias has the format of a SIP URI: sip: name1.name2@domain_name. For example: sip:ocsb.mrf@processing_domain1.

Configuring Async Announcements

The Async Announcements subtab enables you to set up rules for playing announcements. In addition, you set up the rules that define the announcement to be played and the way how the MRF plays this announcement.

The subtab contains the table in which each row represents a single rule. Table 25-8 describes the parameters you can configure.

Table 25-8 Async Announcement Manager Announcements Parameters

Name	Type	Description
Name	STRING	Specifies the unique identifier of the rule.
Enabled	BOOL	Specifies whether or not the announcement is enabled. Possible values: TRUE FALSE Default value: TRUE
Reason Type	STRING	Specifies the parameter that IM-OCF Ro checks in the CCA message received from the online charging server. When the value of the specified parameter matches the range that you defined using the Lower Limit and Upper Limit parameters, IM-OCF triggers the MRF to play the announcement. Possible values: ANY GRANTED_TIME RESULT_CODE SAL_ERROR Default value: ANY Note: When you set Reason Type to ANY, IM-OCF Ro always triggers the MRF to play the announcement.
Lower Limit	INT	Specifies the lower limit of the range for the parameter that you specified in Reason Type. When the value of the specified parameter is greater than the value set in Lower Limit and less than the value set in Upper Limit, IM-OCF Ro triggers the MRF to play the announcement. To configure IM-OCF Ro to trigger the MRF to play the announcement, regardless of the value of the lower limit, set this parameter to -1. Note: IM-OCF does not use the Lower Limit parameter if you set Reason Type to ANY.
Upper Limit	INT	Specifies the upper limit of the range for the parameter that you specified in Reason Type. When the value of the specified parameter is greater than the value set in Lower Limit and less than the value set in Upper Limit, IM-OCF Ro triggers the MRF to play the announcement. To configure IM-OCF Ro to trigger the MRF to play the announcement, regardless of the value of the upper limit, set this parameter to -1. Note: IM-OCF does not use the Upper Limit parameter if you set Reason Type to ANY.
Network	STRING	Specifies the location of the mobile subscriber required for triggering the MRF to play the announcement. Possible values: ANY HOME_ZONE HOME_NETWORK ROAMING Alternatively, you can specify the ID of a specific MSC that serves the mobile subscriber.
Service Side	STRING	Specifies the IM-OCF Ro's service side required for triggering the MRF to play the announcement. Possible values: BOTH ORIG TERM Default value: BOTH
Call State	STRING	Specifies the call state when IM-OCF Ro triggers the MRF to play the announcement. Possible values: PRECALL MIDCALL POSTCALL Default value: PRECALL
Priority	INT	Specifies the order in which the MRF plays different announcement when the conditions of multiple rules are met. Default value: 0
Announcement Code	INT	Specifies the identifier of the announcement that the MRF plays. Default value: 0
Threshold	INT	Specifies how much time, in seconds, prior to the end of quota, IM-OCF Ro triggers the MRF to play the announcement. IM-OCF uses the Threshold parameter only for the announcements whose Call State parameter is set to MIDCALL. Default value: 0 Note: Setting the Threshold parameter to any positive value when Call State set to PRECALL or POSTCALL causes an error.

Configuring Monitoring Parameters

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

Configuring the Degraded Mode

In Online Mediation Solution Controller, Service Broker relies upon an external online charging server (OCS) to apply charges for the use of network services.

When an online charging server is unavailable, IM-OCF Ro switches to the special mode known as degraded mode. This mode enables IM-OCF Ro to continue a session and charge a mobile subscriber during the time when the charging server is temporarily unavailable.

To check the availability of the charging server, every time when IM-OCF Ro sends an accounting request to the charging server, IM-OCF Ro waits a specified period of time for a response from the server. If the server does not respond, IM-OCF Ro switches to the degraded mode.

After IM-OCF Ro switched to the degraded mode, IM-OCF Ro handles the session in this mode until the session is terminated even if the online charging server becomes available. However, when the charging server becomes available, IM-OCF Ro sends to the server charging information gathered during the session.

In the degraded mode, IM-OCF Ro communicates with the Service Broker local charging server. The local online charging server imitates the work of an external charging server. This means that the local charging server can receive Credit Control Requests (CCRs) from, and send Credit Control Answers (CCAs) to, IM-OCF Ro.

To gather this information, IM-OCF Ro writes Charging Data Records (CDRs). IM-OCF Ro replays the CDRs to the online charging server after this server becomes available again. Then the server actually charges the mobile subscriber.

See "Administrating Degraded Mode" in the Oracle Communications Service Broker Online Mediation Controller Implementation Guide for more information.

You use the Degraded Mode tab to configure the parameters of this mode as described in Table 25-9.

Table 25-9 Degraded Mode Parameters

Name	Type	Description
On OCF Failure	STRING	Specifies the behavior of IM-OCF Ro when the OCF fails. Possible values: ALWAYS_REFUSE Degraded mode is disabled. If the OCF fails, IM-OCF Ro refuses to grant the service. USE_LOCAL_REFUSE Degraded mode is enabled. IM-OCF Ro writes CDRs. If a local OCF or CDR writing fails, IM-OCF Ro refuses to grant the service. USE_LOCAL_GRANT Degraded mode is enabled. IM-OCF Ro writes CDRs. If a local OCF or CDR writing fails, IM-OCF Ro grants the service. Note: This setting is overridden by the OCF AVPs 'Credit Control Failure Handling' and 'Realtime Required'. Default value: USE_LOCAL_REFUSE
CDR Mode	STRING	Specifies how IM-OCF Ro writes CDRs. Possible options: NORMAL IM-OCF Ro begins to write CDRs when IM-OCF Ro switches to the degraded mode. HISTORY Like in the Normal mode, IM-OCF Ro begins to write CDRs when IM-OCF Ro switches to the degraded mode. In addition, IM-OCF stores all CDRs that IM-OCF previously sent to the OCS. ALWAYS IM-OCF Ro always writes CDRs. Default value: NORMAL
CDR Writer Impl	STRING	Specifies the full path of the bundle that implements the CDR writer functionality. This is a preset parameter. Do NOT change the value of this parameter.
CDR Writer Service	STRING	Specifies the full path of the CDR writer service. This is a preset parameter. Do NOT change the value of this parameter.
Degraded Mode Timer	INT	Specifies the period of time, in milliseconds, that IM-OCF Ro waits for a response from the online charging server. If the online charging server does not respond within the specified period of time, IM-OCF Ro switches to the degraded mode.
Local-OCF Alias	STRING	Specifies the alias of the local online charging server. This alias is mapped to the destination host and destination realm of the local online charging server as defined in the configuration of Diameter SSU outbound routing rules. See "Configuring Outbound Destinations" in "Configuring Diameter Signaling Server Units" of the Oracle Communications Service Broker Signaling Domain Configuration Guide.
Local-OCF External Protocol	STRING	Specifies the protocol that IM-OCF Ro uses to communicate with the local online charging server. Default value: Ro
Degraded Mode Error Codes	STRING	Specifies the error codes that trigger IM-OCF Ro to enable the degraded mode. You can type several error codes separated by comma.

Configuring IM-OCF Ro with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring the IM-OCF Ro through JMX. Figure 25-1 shows the hierarchy of the IM-OCF MBeans.

Figure 25-1 IM-OCF Ro MBeans Hierarchy

The following sections provide reference information for the IM-OCF Ro 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 the root MBean for the IM-OCF Ro configuration.

Object Name

com.convergin:Type=IMOCF,Version=MBean_Version,Location=AdminServer, Name=IMOCF.Instance_Name

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getCallHandling()

Gets a reference to the instance of CallHandlingMBean

ObjectName getDiameterCreditControlApplicationAvps()

Gets a reference to the instance of DiameterCreditControlApplicationAvpsMBean

ObjectName getDiameterCreditControlApplicationGeneral()

Gets a reference to the instance of DiameterCreditControlApplicationGeneralMBean

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

CallHandlingMBean

CallHandlingMBean enables you to configure how a call is handled.

Object Name

com.convergin:Type=CallHandling,Version=MBean_Version,Location=AdminServer, Name=IMOCF.Instance_Name

Factory Method

Created automatically

Attributes

EventHandling
TerminationCauseAvpOnSalBye
TerminationCauseAvpOnSalCancel
TerminationCauseAvpOnSalFinalErrorResponse

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

Operations

None

DiameterCreditControlApplicationAvpsMBean

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

Object Name

com.convergin:Type=DiameterCreditControlApplicationAvps,Version=MBean_Version,Location=AdminServer,Name=IMOCF.Instance_Name

Factory Method

Created automatically

Attributes

DestinationHostAvp
DestinationRealmAvp
ServiceContextIdAvp
UserNameAvp
RoNodeFunctionalityAvp

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

Operations

None

DiameterCreditControlApplicationGeneralMBean

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

Object Name

com.convergin:Type=DiameterCreditControlApplicationAvps,Version=MBean_Version,Location=AdminServer,Name=IMOCF.Instance_Name

Factory Method

Created automatically

Attributes

DccaDialect

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

Operations

None

DegradedModeMBean

DegradedModeMBeanMBean enables you to configure how IM-OCF Ro operates in the degraded mode.

Object Name

com.convergin:Type=DiameterCreditControlApplicationAvps,Version=MBean_Version,Location=AdminServer,Name=IMOCF.Instance_Name

Factory Method

Created automatically

Attributes

OnOCFFailure
CDRMode
CDRWriterImpl
CDRWriterService
DegradedModeTimer
LocalOCFAlias
ExternalProtocol
Degraded Mode Error Codes

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

Operations

None

AsyncAnnouncementManagerGeneralMBean

AsyncAnnouncementManagerGeneralMBean enables you to specify the alias of the MRF that IM-OCF Ro triggers to play announcements. Each instance of IM-OCF Ro can trigger only one instance of the MRF.

Object Name

com.convergin:Type=AsyncAnnouncementManagerGeneral,Version=MBean_Version,Location=AdminServer,Name=IMOCF.Instance_Name

Factory Method

Created automatically.

Attributes

MrfAlias

For more information about this attribute, see Table 25-7.

Operations

None

AnnouncementInfoTableMBean

AnnouncementInfoTableMBean enables you to manage rules for playing announcements. Each rule defines conditions and the announcement that the MRF plays, if these conditions are met.

Each rule is represented by an instance of AnnouncementInfoMBean. You need to create a separate instance of AnnouncementInfoMBean for each rule.

Object Name

com.convergin:Type=AnnouncementInfoTable,Version=MBean_Version,Location=AdminServer,Name=IMOCF.Instance_Name

Factory Method

Created automatically.

Attributes

None

Operations

ObjectName createAnnouncementInfo()

Creates an instance of AnnouncementInfoMBean.

void destroyAnnouncementInfo

Destroys an instance of AnnouncementInfoMBean.

ObjectName lookupAnnouncementInfo

Returns the reference to a specified instance of AnnouncementInfoMBean.

AnnouncementInfoMBean

AnnouncementInfo enables you to set up parameters of a rule for playing announcements. A rule defines conditions and the announcement that the MRF plays, if these conditions are met. In addition, rules determine how the MRF plays the announcement.

You need to create a separate instance of AnnouncementInfoMBean for each rule.

Object Name

com.convergin:Type=AnnouncementInfo,Version=MBean_Version,Location=AdminServer,Name=Announcement_Name

Factory Method

AnnouncementInfoTable.createAnnouncementInfo()

Attributes

Enabled
ReasonType
ReasonFrom
ReasonTo
Network
ServiceSide
CallState
Priority
AnnouncementCode
Threshold

For more information about these attributes, see Table 25-8.

Operations

None