2 Configuring the Orchestration Engine

This chapter describes how to configure the Oracle Communications Service Broker Orchestration Engine.

Setting Up the Orchestration Engine

You set up the Orchestration Engine (OE) using the OE configuration screen.

To access the OE configuration screen:

1. In the domain navigation pane, expand OCSB.

2. Expand Processing Tier.

3. Select Orchestration Engine.

   Table 2-1 describes the tabs available on the OE configuration screen.

Table 2-1 OE Configuration Subtabs

Task	Description
General	Enables you to specify a subscriber profile receiver and enable Service Data Records (SDRs) 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 orchestration logic processor (OLP). See "Configuring Static Route OLP Parameters" for more information.
HSS OLP	Enables you to set up the OE connection to an Home Subscriber Server (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 (SPR) and enable SDR generation.

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

Table 2-2 General Parameters

Name	Type	Description
Subscriber Profile Receiver	STRING	Specifies which SPR 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 the discussion on configuring an SM-LSS in Oracle Communications Service Broker Modules Configuration Guide. 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 2-3 describes the configuration parameter on the Static Route OLP subtab.

Table 2-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 2-4 describes the configuration parameters on the HSS OLP tab.

Table 2-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. For more information about configuring monitoring, see the discussion on configuring Service Broker monitoring in Oracle Communications Service Broker System Administrator's Guide.

Routing a Session through Non-Configured Applications

Typically, all applications in a production system are known. In this case, you define an individual IM-ASF module instance to communicate 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 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 creating and configuring IM-ASF, see the discussion on setting up IM-ASF SIP in Oracle Communications Service Broker Modules Configuration Guide.