PK
Doa, mimetypeapplication/epub+zipPK D iTunesMetadata.plist[
This chapter describes how to configure the Oracle Communications Service Broker Orchestration Engine.
You set up the Orchestration Engine (OE) using the OE configuration screen.
To access the OE configuration screen:
In the domain navigation pane, expand OCSB.
Expand Processing Tier.
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. |
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:
|
Enable SDR |
BOOL |
Specifies whether or not the OE generates SDRs. Possible values:
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.
|
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: module-instance-name.module-type@convergin.com You can specify several SIP URIs separated by a space. For example:
|
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:
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. |
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.
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.
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.
Orchestration User's Guide
Release 6.1
E29453-01
February 2013
Oracle Communications Service Broker Orchestration User's Guide, Release 6.1
E29453-01
Copyright © 2010, 2013, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
This chapter describes how to use the Oracle Communications Service Broker Orchestration Studio to define the order of messages sent by a called party.
Orchestration logic defines how the OE routes messages generated by the calling party. For example, you can set an initial INVITE to be routed from Application 1 to Application 2 to Application 3. Figure 7-1 shows the order in which the OE routes an INVITE message from a calling party to a called party.
Orchestration logic does not specify how the OE routes messages received from a called party. By default, when a called party generates a message (for example, an OK response to an INVITE message), the OE routes this message in the reverse order, from Application 3 to Application 2 to Application 1. Figure 7-2 shows the order in which the OE routes an OK response from a called party to a calling party.
When an application in the orchestration chain depends on the information generated by a previous application, you might need to route all messages, including those generated by a calling party and those generated by a called party, in the same order. For example, you might need a message to be first routed to an online charging application and then to a bill shock application. In this case, a bill shock application can perform certain actions based on the information generated by the online charging application.
To allow the OE to route all messages across applications in the same order, you need to group these applications in a unidirectional group. Figure 7-3 shows how the OE routes a message generated by a called party through applications in a unidirectional group.
When grouping applications into unidirectional groups, you must observe the following limitations:
You can group only those applications that run consecutively. For example, on Figure 7-3, you can group Application 1 and Application 2. However, you cannot group Application 1 and Application 3 because they do not run consecutively.
Each application in a unidirectional group must be implemented as a Back-to-Back (B2B) application.
Note: Service Broker does not support unidirectional groups when the Diameter-based orchestration mode is enabled. For more information on the Diameter-based orchestration mode, see the discussion on improving performance in Diameter-only environments in Oracle Communications Service Broker Online Mediation Controller Implementation Guide. |
To group applications into a unidirectional group:
In the orchestration logic flow, press and hold the Ctrl key while selecting all IM icons of IMs that you want to form into a group.
In the toolbar, the Unidirectional button becomes available.
Click the Unidirectional button.
All the selected IM icons are now grouped.
The Orchestration Studio automatically assigns an identifying numeral to the application group. Selecting any application within the group and clicking the Actions tab displays the unidirectional group number in the Unidirectional Group field. You cannot change the unidirectional group number in this field.
To ungroup a unidirectional group:
Select all the IM icons in the unidirectional chain.
Click the Cancel Unidirectional Group button.
This appendix presents some typical use cases that can be used as examples when creating orchestration logic flows in the Oracle Communications Service Broker Orchestration Studio.
Some of the use cases in this appendix are based on the use cases described in Oracle Communications Service Broker Concepts Guide.
Using the procedures described in the earlier chapters in this guide to create orchestration logic flows, the use cases reproduced here demonstrate how you can build specific flows in the Orchestration Studio.
In addition, each use case displays the XML code that is generated by the Orchestration Studio while you graphically build the flow on the canvas.
The code contains some elements that are automatically inserted by the software and do not affect the behavior of the logic.
The following flows illustrate Service Broker orchestration capabilities.
The following use case shows how the Orchestration Engine forwards a session to an online charging application server and then to a VPN service.
To build an IN service interaction flow:
Drag the Conditions icon to canvas and draw a connecting line between Start and the icon.
Drag the IM icon representing IM-SSF INAP to the canvas and then drag the IM icon representing IM-SSF CAP to the canvas.
Draw a connector line from the green connection point on the Conditions icon to IM-SSF INAP and then draw a connector line from IM-SSF INAP to IM-SSF CAP.
Select the Conditions icon and in the Actions tab, click New Group.
Group 0 is displayed under Trigger Point.
Select Group 0, click SIP Method and in the Method field, type INVITE.
Select the IM icon representing IM-SSF INAP and in the Properties tab, type the address of the destination online charging application server in the Alias field and click Apply.
The address of the application server must match the one set for the SCCP Local SSN.
For more information, see the discussion on configuring IM-SSF in Oracle Communications Service Broker Modules Configuration Guide.
Select the IM icon representing IM-SSF CAP and in the Properties tab, type the name of the destination VPN application server in the Alias field and click Apply.
Figure A-1 shows the orchestration logic flow for IN service interaction.
Clicking Source displays the generated XML code of the flow you created graphically.
Figure A-2 shows the source code of the IN service interaction flow.
The following use case shows how Service Broker communicates with the IMS network and provides service interaction based on the logic retrieved from the database.
To build an IMS service interaction flow:
Drag the Conditions icon to the canvas and draw a connecting line between Start and the icon.
Drag the IM icons representing the following IMs to the canvas in the order in which they are listed:
IM-SSF
IM-ASF
IM-OCF
Draw a connector line from the green connection point on the Conditions icon to the IM-SSF.
Draw connector lines from the IM-SSF to connect the remaining IM icons in the order you placed them on the canvas.
Select the Conditions icon and in the Actions tab, click New Group.
Group 0 is displayed under Trigger Point.
Select Group 0, click SIP Method and in the Method field, type INVITE.
Select the IM icon representing IM-SSF and in the Properties tab, type the address of the destination online charging application server in the Alias field and click Apply.
The address of the application server must match the one set for the SCCP Local SSN.
For more information, see the discussion on configuring IM-SSF in Oracle Communications Service Broker Modules Configuration Guide.
Select the IM icon representing IM-ASF and in the Properties tab, type the address of the destination SIP application server in the Alias field and click Apply.
Use the format: sip
:<ip address>
Select the IM icon representing IM-OCF and in the Properties tab, type the address of the destination charging server in the Alias field and click Apply.
Use the format: sip:
<ip address>
Figure A-3 shows the shows the orchestration logic flow for IMS service interaction.
Clicking Source displays the XML code of the flow you created graphically.
Figure A-4 shows the source code of the IMS service interaction flow.
By default, when the OE receives a 302 Moved Temporarily response from an application, the OE releases the session. When you want the OE to continue the session after receiving a 302 Moved Temporarily response, you need to enforce the application that returned the 302 Moved Temporarily response to work as a Back-to-Back (B2B) application.
The following flow demonstrates the case when a VPN service with which the OE communicates through the IM-ASF a 302 Moved Temporarily response. The IM-ASF is set to force the session to continue to the online charging application.
To enforce a B2B flow:
Drag the Conditions icon to canvas and draw a connecting line between Start and the icon.
Drag the IM icon representing the IM-ASF to the canvas and then drag the IM icon representing the IM-OCF to the canvas.
Draw a connector line from the green connection point on the Conditions icon to IM-ASF and and then draw a connector line from IM-ASF to IM-OCF.
Select the Conditions icon and in the Actions tab, click New Group.
Group 0 is displayed under Trigger Point.
Select Group 0, click SIP Method and in the Method field, type INVITE.
Select the IM icon representing IM-ASF and in the Actions tab, do the following:
Select the Back to Back checkbox.
In the Response field, type 302.
The session is forced to continue to the IM-OCF. Figure A-5 shows a B2B flow.
Clicking Source displays the XML code of the flow you created graphically.
Figure A-6 shows the source code of the B2B flow.
In the following use case, if the session is originating, the OE routes the session to the VPN application server and then to the online charging application server. If the session is terminating, the OE routes the session directly to the online charging application server.
To build a flow that continues the session when conditions are not met:
Drag the Conditions icon to canvas and draw a connecting line between Start and the icon.
Drag the IM icon representing the IM-ASF to the canvas and draw a connecting line from the green connection point on the Conditions icon to the IM icon.
Drag the IM icon representing the IM-OCF to the canvas and draw a connecting line between IM-ASF and IM-OCF.
Drag another IM icon representing the IM-OCF to the canvas and draw a connecting line from the red connection point on the Conditions icon to the IM-OCF you added in step 3.
Select the Conditions icon and in the Actions tab, click New Group.
Group 0 is displayed under Trigger Point.
Select Group 0 and click SIP Header.
In the right pane, type the following:
Header field: x-wcs-session-case
Content field: x-wcs-session-case:orig
Figure A-7 shows the conditional flow. If the message header meets the conditions, it goes to the IM-ASF and then to IM-OCF. If the message header does not meet the conditions, it goes directly to IM-OCF.
Clicking Source displays the XML code of the flow you created graphically.
Figure A-8 and Figure A-9 show the source code of the conditional flow.
When you create an orchestration logic using the Orchestration Studio, Service Broker stores the orchestration logic in SM-LSS as a part of the subscriber's profile. With Online Mediation Controller, subscriber profile data, including subscriber-specific orchestration logic, is stored in the Subscriber Store instead of SM-LSS.
To access the Subscriber Store, Service Broker uses the Subscriber Provisioning API. The API provides operations for adding and managing subscriber profile data in the store. The operation that adds a new subscriber to the Subscriber Store is called storeSubscriber. In the request body, you provide the orchestration logic in the iFC format.
To facilitate the process of creating of iFC, you can build the orchestration logic using the Orchestration Studio visual tools. Because the Orchestration Studio generates the iFC code of the orchestration logic, you can copy the iFC representation and paste it into the storeSubscriber request body.
To create an orchestration logic for a subscriber in Online Mediation Controller:
Create a subscriber profile in SM-LSS. For more information, see the discussion on configuring SM-LSS in Oracle Communications Service Broker Modules Configuration Guide.
Build an orchestration flow for the subscriber using the Orchestration Studio tools. See "Building an Orchestration Logic Flow" for more information.
To view the iFC code that the Orchestration Studio generated for the orchestration flow, click Source.
Copy the entire iFC code and paste it into the <ifc> element of the storeSubscriber request body.
For more information, see the discussion on the subscriber store API reference in Oracle Communications Service Broker Subscriber Store User's Guide.
This chapter describes how to use the Oracle Communications Service Broker Orchestration Studio to provide additional information to applications.
You can configure the OE to send additional information to an application. For example, you can inform the application that the calling party has been blacklisted for not meeting his billing obligations and that the OE should not complete the call.
You provide additional information to an application as a part of defining the IM that communicates with this application.
To provide additional information to an application:
In the orchestration logic flow, select the IM icon of the IM that communicates with the application to which you want to provide additional information.
Click the Actions tab.
In the Service Info text field, type the information you want to provide to the application.
The OE adds the text you type to the body of the message it forwards to the application.
This document provides a description of Oracle Communications Service Broker orchestration capabilities.
This document is intended for system administrators.
This document assumes that you are familiar with the following:
Initial Filter Criteria (iFC)
Session Initiation Protocol (SIP)
IP Multimedia Subsystem (IMS) architecture and interfaces
The following documents provide additional information about Service Broker and orchestration logic.
Oracle Communications Service Broker Concepts Guide
Oracle Communications Service Broker Installation Guide
(Optional) Oracle Communications Service Broker Service Controller Implementation Guide
(Optional) Oracle Communications Service Broker Online Mediation Controller Implementation Guide
(Optional) Oracle Communications Service Broker Social Voice Communicator Implementation Guide
(Optional) Oracle Communications Service Broker VPN Implementation Guide
(Optional) Oracle Communications Service Broker Subscriber Store User's Guide
Oracle Communications Service Broker System Administrator's Guide
Oracle Communications Service Broker Modules Configuration Guide
Oracle Communications Service Broker Signaling Server Unit Configuration Guide
Oracle Communications Service Broker Security Guide
(Optional) Oracle Communications Service Controller Release Notes
(Optional) Oracle Communications Online Mediation Controller Release Notes
Oracle Communication Service Broker documentation is available from the Oracle software delivery Web site:
Additional Oracle Communications documentation is available from Oracle Technology Network:
http://www.oracle.com/technetwork/index.html
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc
.
Access to Oracle Support
Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info
or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs
if you are hearing impaired.