11 Configuring the Orchestration Engine

The following sections describe how to configure the Service Broker Orchestration Engine using the Service Broker Administration Console and Java MBeans:

Configuring the Orchestration Engine with the Administration Console
Configuring the Orchestration Engine with Java MBeans
Supporting Orchestration with Non-Configured Application

Configuring the Orchestration Engine with the Administration Console

This section describes how to configure the OE using the Service Broker Administration Console.

To access the Orchestration Engine configuration screen:

In the Domain Navigation pane, select OCSB > Processing Tier > Orchestration Engine. The OE Configuration screen is displayed in the Configuration pane.

The OE Configuration screen contains the subtabs described in Table 11-1.

Table 11-1 OE Configuration Subtabs

Subtab	Description
General	Enables you to specify a subscriber profile receiver and enable SDR generation. For more information, see "Configuring General Parameters".
Static Route OLP	Enables you to specify applications that the OE should invoke and the order in which they are invoked. This tab is ignored if the OE is not configured to work with the Static Route OLP. For more information, see "Configuring Static Route OLP Parameters".
HSS OLP	Enables you to set up the OE connection to an HSS. This tab is ignored if the OE is not configured to work with the HSS OLP. For more information, see "Configuring HSS OLP Parameters".
Monitoring	Enables you to define how logging and notifications operate. For more information, see "Configuring Monitoring Parameters".

Configuring General Parameters

The General subtab enables you specify a subscriber profile receiver and enable SDR generation.

Table 11-2 describes configuration parameters on the General subtab.

Table 11-2 General Parameters

Name	Type	Description
Subscriber Profile Receiver	STRING	Specifies which OPR the OE uses to retrieve an orchestration profile. Possible values: OlpDefaultInfoReceiver OlpLSSInfoReceiver OlpHSSInfoReceiver Default value: OlpDefaultInfoReceiver
Enable SDR	BOOL	Specifies whether or not the OE generates SDRs. Possible values: True False Default value: True
Enable Session Persistency	STRING	Specifies the point in a call when session persistency begins. Persistency continues throughout the session with each new state overwriting the previous state in the repository. When Session Starts: Persistency begins when the first session setup message is received. The current state of the session is then stored in the persistent repository. Each state is overwritten by the state that follows it until the end of the session. On Ringback: Persistency begins when a ringing indication is received. The current state of the session is then stored in the persistent repository. Each state is overwritten by the state that follows it until the end of the session. On Answer: Persistency begins when an answer indication is received. The current state of the session is then stored in the persistent repository. Each state is overwritten by the state that follows it until the end of the session. Never: No state of the active session is stored.

Name

Type

Description

Subscriber Profile Receiver

STRING

Specifies which OPR the OE uses to retrieve an orchestration profile.

Possible values:

OlpDefaultInfoReceiver
OlpLSSInfoReceiver
OlpHSSInfoReceiver

Default value: OlpDefaultInfoReceiver

Enable SDR

BOOL

Specifies whether or not the OE generates SDRs.

Possible values:

True
False

Default value: True

Enable Session Persistency

STRING

Specifies the point in a call when session persistency begins. Persistency continues throughout the session with each new state overwriting the previous state in the repository.

When Session Starts: Persistency begins when the first session setup message is received. The current state of the session is then stored in the persistent repository. Each state is overwritten by the state that follows it until the end of the session.
On Ringback: Persistency begins when a ringing indication is received. The current state of the session is then stored in the persistent repository. Each state is overwritten by the state that follows it until the end of the session.
On Answer: Persistency begins when an answer indication is received. The current state of the session is then stored in the persistent repository. Each state is overwritten by the state that follows it until the end of the session.
Never: No state of the active session is stored.

Configuring Static Route OLP Parameters

The Static Route OLP subtab enables you to specify applications that the OE invokes and the order in which they are invoked.

Note:

This tab is regarded only when the OE is configured to work with the Static Route OLP. In this case the Subscriber Profile Receiver parameter in the General tab is set to OlpDefaultInfoReceiver.

Table 11-3 describes the configuration parameter on the Static Route OLP subtab.

Table 11-3 Static Route OLP Parameter

Name	Type	Description
Default Routing Targets	STRING_LIST	Specifies a list of application SIP URIs that the OE must invoke. The format of a SIP URI is: "<module-instance-name>.<module-type>@convergin.com" You can specify several SIP URIs separated by a space. For example: "sip:IMSCFCAP4_instance.IMSCFCAP4@convergin.com" "sip:IMASF_instance.IMASF@convergin.com"

Name

Type

Description

Default Routing Targets

STRING_LIST

Specifies a list of application SIP URIs that the OE must invoke.

The format of a SIP URI is:

"<module-instance-name>.<module-type>@convergin.com"

You can specify several SIP URIs separated by a space.

For example:

"sip:IMSCFCAP4_instance.IMSCFCAP4@convergin.com"

"sip:IMASF_instance.IMASF@convergin.com"

Configuring HSS OLP Parameters

In the HSS OLP tab you can define the address of the HSS that the OE connects, and you can optionly specify mobile subscribers for whom the OE obtains orchestration logic (iFCs) from the HSS.

Note:

This tab is regarded only when the OE is configured to work with the HSS OLP. In this case the Subscriber Profile Receiver parameter in the General tab is set to OlpHSSInfoReceiver.

Table 11-4 describes the configuration parameters on the HSS OLP tab.

Table 11-4 HSS OLP Parameters

Name	Type	Description
Wildcarded PSI	STRING	Specifies a regular expression that the HSS uses to search for a subscriber's orchestration logic (iFCs). The HSS compares the regular expression against Public Subscriber Identities (PSIs) in its database. The HSS find all matches and respond to the OE with one or more iFCs that comprise the subscribers orchestration logic. You must specify a regular expression in a SIP URI format. For example: sip:*@oracle.com You can leave the parameter empty to have the HSS search an orchestration logic for a subscriber, based on the To and From headers inside a session's SIP message. If you set this parameter, it prevails the session headers, and session headers are ignored. Typically you would use this parameter when a group of subscribers share the same orchestration logic.
Destination-Host AVP	STRING	Specifies the host name of the destination HSS. The OE sets this value in the Destination-Host AVP, inside the UDR that it sends to the HSS. Note that this value must correlate to either a PeerMBean or a RouteMBean that you already configured in the Diameter SSU.
Destination- Realm AVP	STRING	Specifies the value that the OE sets in the Destination-Realm AVP, inside the UDR that it sends to the HSS.

Name

Type

Description

Wildcarded PSI

STRING

Specifies a regular expression that the HSS uses to search for a subscriber's orchestration logic (iFCs). The HSS compares the regular expression against Public Subscriber Identities (PSIs) in its database. The HSS find all matches and respond to the OE with one or more iFCs that comprise the subscribers orchestration logic.

You must specify a regular expression in a SIP URI format. For example:

sip:*@oracle.com

You can leave the parameter empty to have the HSS search an orchestration logic for a subscriber, based on the To and From headers inside a session's SIP message.

If you set this parameter, it prevails the session headers, and session headers are ignored. Typically you would use this parameter when a group of subscribers share the same orchestration logic.

Destination-Host AVP

STRING

Specifies the host name of the destination HSS. The OE sets this value in the Destination-Host AVP, inside the UDR that it sends to the HSS.

Note that this value must correlate to either a PeerMBean or a RouteMBean that you already configured in the Diameter SSU.

Destination- Realm AVP

STRING

Specifies the value that the OE sets in the Destination-Realm AVP, inside the UDR that it sends to the HSS.

Configuring Monitoring Parameters

The Monitoring tab enables you to define how Runtime MBeans and notifications operate for the OE.

For more information about configuring monitoring, see "Configuring Monitoring with the Administration Console".

Configuring the Orchestration Engine with Java MBeans

Service Broker provides a set of MBeans with attributes and operations for configuring the OE through JMX. The hierarchy of the MBeans is shown on Figure 11-1.

Figure 11-1 OE MBeans Hierarchy

For more information, see:

OeMBean
GeneralMBean
StaticRouteOlpMBean
HssReceiverOlpMBean

The following MBeans are common for all components of Service Broker and described in "Configuring Monitoring with Java 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.

Supporting Orchestration with Non-Configured Application

Typically, all applications in a production system are known. In this case, you define an individual IM-ASF module instance to interact with each application. In this case, orchestration logic (for example, iFC) turns a session through various applications through different IM-ASF module instances.

There are cases in which the Orchestration Engine is required to orchestrate each session differently, each through a different application. In this case, it is impossible to pre-configure the different application addresses, either because there are many of them or their address is subject to change. The application addresses are not know to Service Broker.

To support orchestration with non-configured applications, you need to define a special instance of an IM-ASF module, also known as default IM-ASF. This instance will not be limited to interaction with only a single pre-configured application, but will rather allow interaction with any application. This instance must be named "IMASF_default".

Whenever the Orchestration Engine is required to route a session to a non-configured application, it will route it through "IMASF_default" module. When triggered, "IMASF_default" forwards a session to any application, as specified inside the session request, in the application address field.

For example, if the Orchestration Engine has to route a session to a non-configured application address, such as "sip:209.95.109.191:5060", the Orchestration Engine forwards this session to the default IM-ASF. The default IM-ASF forwards the session to the application server which IP address is 209.95.109.191.

For information on defining a default IM-ASF module, see "Defining a Default IM-ASF Module".

OeMBean

OeMBean is a root MBean for the OE configuration.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getGeneral()

Gets a reference to the instance of GeneralMBean

ObjectName getStaticRouteOlp()

Gets a reference to the instance of StaticRouteOlpMBean

ObjectName getHssReceiverOlp()

Gets a reference to the instance of HssReceiverOlpMBean

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

GeneralMBean

GeneralMBean enables you to specify a subscriber profile receiver.

Factory Method

Created automatically

Attributes

SubscriberProfileReceiver
EnableSdr
EnableSessionPersistency

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

Operations

None

StaticRouteOlpMBean

StaticRouteOlpMBean enables you to specify applications that the OE should invoke and the order in which the OE passes a session through these applications.

Factory Method

Created automatically

Attributes

DefaultRoutingTargets

For more information on this attribute, see Table 11-3.

Operations

None

HssReceiverOlpMBean

HssReceiverOlpMBean enables you to define the address of the HSS that the OE connects, and you can optionly specify mobile subscribers for whom the OE obtains orchestration logic (iFCs) from the HSS..

Factory Method

Created automatically

Attributes

WildcardedPsi
DestinationHostAvp
DestinationRealmAvp

For more information on this attribute, see Table 11-4.

Operations

None