4 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

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

To access the Orchestration Engine configuration screen:

1. In the domain navigation pane, expand OCSB.

2. Expand Processing Tier.

3. Select Orchestration Engine.

   Table 4-1 describes the tasks involved in configuring Orchestration Engine.

Table 4-1 OE Configuration Subtabs

Task	Description
General	Enables you to specify a subscriber profile receiver and enable SDR generation. See "Configuring General Parameters" for more information.
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. See "Configuring Static Route OLP Parameters" for more information.
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. See "Configuring HSS OLP Parameters" for more information.
Custom OPR	Enables you to specify the name of the OPR that the OE should use to retrieve subscriber profiles. See "Configuring Custom OLP Parameters" for more information.
Monitoring	Enables you to define how logging and notifications operate. See "Configuring Monitoring Parameters" for more information.

Configuring General Parameters

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

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

Table 4-2 General Parameters

Name	Type	Description
Subscriber Profile Receiver	STRING	Specifies which OPR the OE uses to retrieve an orchestration profile. Possible values: OlpDefaultInfoReceiver Select this option when you want the OE to use the static route OLP. To define the static route, use the Static Route OLP tab. See "Configuring Static Route OLP Parameters" for more information. OlpLSSInfoReceiver Select this option when you want the OE to retrieve subscriber profiles from an SM-LSS. See "Configuring SM-LSS" for more information. OlpHSSInfoReceiver Select this option when you want the OE to retrieve subscriber profiles from an HSS. To define the address of the HSS, use the HSS OLP tab. See "Configuring HSS OLP Parameters" for more information. OlpCustomInfoReceiver This option is relevant for the Online Mediation Controller only. Select this option when you want the OE to retrieve subscriber profiles from the Subscriber Store. You can enable the Degraded Mode only when this option is selected. See "Configuring Custom OLP Parameters" for more information.
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 4-3 describes the configuration parameter on the Static Route OLP subtab.

Table 4-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: [e-mail] You can specify several SIP URIs separated by a space. For example: sip:[e-mail] sip:[e-mail]

Configuring HSS OLP Parameters

In the HSS OLP tab you can define the address of the HSS that the OE connects, and you can optionally 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 4-4 describes the configuration parameters on the HSS OLP tab.

Table 4-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 finds all matches and respond to the OE with one or more iFCs that comprise the subscribers orchestration logic. You need to specify a regular expression in a SIP URI format. You can use the following wildcards: asterisk (*), which matches zero or more occurrences of any character. For example, sip:78880*@oracle.com matches sip:[e-mail] and sip:[e-mail]. period (.), which matches one occurrence of any character. For example, sip:[e-mail] matches sip:[e-mail] and sip:[e-mail]. exclamation mark (!), which represents any number of characters in the middle of the PSI or at the end of the PSI. For example, sip:78880!@oracle.com matches sip:[e-mail] and sip:[e-mail] If you specify this parameter, it prevails the session headers, and session headers are ignored. Leave the parameter empty to have the HSS search an orchestration logic for a subscriber, based on the To and From headers of a session. It is recommended to 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 Custom OLP Parameters

In the Custom OLP tab, you specify the name of the OPR that the OE should use to retrieve subscriber profiles. This is relevant for Online Mediation Controller only. Do not change the name of the OPR.

If the subscriber profile is missing, the OPR returns the error, and the OE terminates the session.

Configuring Monitoring Parameters

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

See "Configuring Monitoring with the Administration Console" for more information about configuring monitoring.

Configuring the Orchestration Engine with Java MBeans

Service Broker provides a set of MBeans with attributes and operations for configuring the OE through JMX. Figure 4-1 shows the hierarchy of the Orchestration Engine MBeans.

Figure 4-1 OE MBeans Hierarchy

The following MBeans are common for all components of Service Broker and described in "Configuring Monitoring with Java MBeans":

• MonitoringGeneralMBean

• ThresholdCrossedNotificationRulesMBean

• ThresholdCrossedNotificationRuleMBean

• StateChangedNotificationRulesMBean

• StateChangedNotificationRuleMBean

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

Configuring Pre-Orchestration and Post-Orchestration with Java MBeans

With Service Broker, you can set up subscriber-specific orchestration chains. A subscriber-specific orchestration chain determines how the OE routes sessions across application servers for a specific subscriber. You configure subscriber-specific orchestration chains by specifying an iFC for each subscriber in SM-LSS.

In addition to a subscriber-specific iFC, you might need to configure iFC that the OE invokes for all subscribers before or after applications defined in a subscriber-specific iFC.

For example, you might need to play a mid-call announcement to any subscriber who does not have enough credit units to continue a call. Similarly, your business requirements might dictate the need to send a credit control request in the beginning of a session for all subscribers.

To set up iFC common for all subscribers, you can configure additional iFC that the OE invokes at the following stages:

• Before invoking a subscriber-specific iFC

• After invoking a subscriber-specific iFC

• Before triggering each application defined in the subscriber-specific iFC

• After triggering each application defined in the subscriber-specific iFC

When configuring these additional iFC, you must observer the following limitations:

• You cannot group applications in these additional iFC into unidirectional groups.

• If you configure the OE to invoke a common iFC before or after triggering each application defined in the subscriber-specific iFC, and applications in the subscriber-specific iFC were grouped into unidirectional groups, then the applications defined in the common iFC belong to the same group as the application in the subscriber-specific iFC.

You specify the iFC that the OE invokes and the stage when the OE invokes the iFC using the OrchestrationExtensionsMBean. Figure 4-2 shows the hierarchy of the OrchestrationExtensionsMBean.

Figure 4-2 OrchestrationExtensionsMBean Hierarchy

---

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

Operations

None

---

HssReceiverOlpMBean

HssReceiverOlpMBean enables you to define the address of the HSS that the OE connects, and you can optionally 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 4-4.

Operations

None

---

CustomReceiverOlpMBean

CustomReceiverOlpMBean enables you to define the name of the OPR that the OE should use to retrieve subscriber profiles.

Factory Method

Created automatically

Attributes

• CustomOPRName

This is relevant for Online Mediation Controller only. Do not change the name of the OPR.

Operations

None

---

OrchestrationExtensionsMBean

OrchestrationExtensionsMBean is the root MBean for configuring additional iFC that are common for all subscribers. Using OrchestrationExtensionsMBean, you need to create individual instances of OrchestrationExtensionMBean for each iFC.

Factory Method

Created automatically.

Attributes

None

Operations

ObjectName createOrchestrationExtension()

Creates an instance of OrchestrationExtensionMBean.

void destroyOrchestrationExtension()

Destroys an instance of OrchestrationExtensionMBean.

ObjectName [] lookupOrchestrationExtension()

Gets an array of references to the instances of OrchestrationExtensionMBean.

---

OrchestrationExtensionMBean

OrchestrationExtensionMBean enables you to configure an iFC that is common for all subscribers. The OE invokes these iFC in addition to subscriber-specific iFC.

Factory Method

OrchestrationExtensions.createOrchestrationExtension()

Attributes

string Triggers

Specifies when the OE invokes the additional iFC. You can set this attribute to the following values:

• PreChain

  The OE invokes the iFC before the subscriber-specific orchestration iFC.

• PostChain

  The OE invokes the iFC after the subscriber-specific iFC.

• PreAS

  The OE invokes the iFC before triggering each application defined in the subscriber-specific iFC.

• PostAS

  The OE invokes the iFC after triggering each application in the subscriber-specific iFC.

You can set the Trigger attribute to more than one value. The values must be separated with comma.

string Ifc

Specifies the iFC that defines how the OE orchestrates applications.

Operations

None