Skip Headers
Oracle® Application Integration Architecture Oracle Communications Order to Cash Integration Pack Implementation Guide for Siebel CRM, Oracle Order and Service Management, and Oracle Billing and Revenue Management
Release 11.1

Part Number E22651-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

11 OLM - Synchronize Fulfillment Order Billing Account Business Flow: Implementation

This chapter provides an overview of the Synchronize Fulfillment Order Billing Account business flow and discusses the implementation of Oracle Billing and Revenue Management (Oracle BRM) interfaces, industry Oracle Application Integration Architecture (Oracle AIA) components, and integration services.

This chapter includes the following sections:

11.1 Synchronize Fulfillment Order Billing Account Business Flow Overview

This business flow is enabled using the Oracle Communications Order to Cash Siebel Customer Relationship Management (Siebel CRM), Oracle Order and Services Management (Oracle OSM), and Oracle BRM pre-built integration options.

The following integration flow involves interfacing order customer accounts to one or more Oracle BRM instances:

This flow leverages the Create/Sync Account integration flow, which enables the synchronization of customer information from Siebel CRM to Oracle BRM.

For more information about the Create/Sync Account integration flow, see Chapter 18, "Understanding the Process Integration for Customer Management."

11.2 Interfacing Orders to Create Customer Data in Oracle BRM

This integration flow uses the following interfaces:

* - Indicates integration artifacts that are from the Customer Management process integration (Create/Sync Account flow). They are described in more detail in Section 19.6, "Integration Services."

Figure 11-1 Interfacing Orders to Create Customer Data in BRM Sequence Diagram

This image is described in surrounding text.

This is the sequence of events:

  1. The order management system drops the message into the AIA_CRTCUST_OUT_JMSQ JMS queue, which is picked up by the ProcessFulfillmentOrderBillingAccountListOSMCFSCommsJMSConsumer and routed to CommunicationsBillingEBSV1. This enterprise business service (EBS) routes the message to CommsProcessFulfillmentOrderBillingAccountListEBF.

  2. The CommsProcessFulfillmentOrderBillingAccountListEBF extracts the relevant customer data (ProcessBillingAccountListEBM) and routes it to CommsProcessBillingAccountListEBF through CommunicationsBillingEBSV1.

    This leverages the Create/Sync Account flow.

  3. The CommsProcessBillingAccountListEBF prepares the QueryCustomerPartyListEBM message.

    This enterprise business message (EBM) is required for querying the entire account data from Siebel CRM before creating the account in Oracle BRM

  4. Invoking the CommunicationsCustomerPartyEBSV2 with operation QueryCustomerPartyList routes the message to CustomerPartyEBSV2 through the Comms2CoreCustomerPartyBridge service. The core CustomerPartyEBSV2 further routes the message to QueryCustomerPartyListSiebelProvABCSImplV2 (a core service implemented in the MDM pre-built integration).

  5. The QueryCustomerPartyListSiebelProvABCSImplV2 prepares the application business message (ABM), which is required to invoke Siebel's SWI_Customer_Party_Service.

    This query service invokes the Siebel database and fetches the account details and replies to QueryCustomerPartyListSiebelProvABCSImplV2 with response ABM.

  6. This response ABM is then transformed to the QueryCustomerPartyListResponseEBM and is sent back to the CommsProcessBillingAccountListEBF through CustomerPartyListEBSV2, Comms2CoreCustomerPartyBridge, and CommunicationsCustomerPartyEBSV2.

  7. The CommsProcessBillingAccountListEBF service invokes the CommunicationsCustomerPartyEBSV2 with operation SyncCustomerPartyList, which instantiates SyncCustomerPartyListBRMCommsProvABCSImpl.

  8. This SyncCustomerPartyListBRMCommsProvABCSImpl invokes Oracle BRM on opcode PCM_OP_CUST_COMMIT_CUSTOMER to create an account. To update an existing account, either opcode PCM_OP_CUST_UPDATE_CUSTOMER or PCM_OP_CUSTCARE_MOVE_ACCT is called, whichever is applicable.

  9. If an account is successfully created or updated, an appropriate response (SyncCustomerPartyListResponseEBM) is sent back to CommsProcessBillingAccountListEBF in an asynchronous delayed response mode.

  10. The CommsProcessBillingAccountListEBF then sends the ProcessBillingAccountListResponseEBM response message to CommsProcessFulfillmentOrderBillingAccountListEBF in an asynchronous delayed response mode.

  11. CommsProcessFulfillmentOrderBillingAccountListEBF drops a message into AIA_UPDCUST_IN_JMSQ store and forward (SAF) queue where order management is notified of the SyncCustomer status.

11.3 Oracle BRM Interfaces

This integration flow uses these services:

For more information, see Oracle Communications Billing and Revenue Management (BRM) Documentation, "BRM Documentation," Reference, API reference."

For information about the Oracle BRM interfaces used by the Create/Sync Account integration flow, see Section 19.3, "Oracle BRM Interfaces."

11.4 Industry Oracle AIA Components

This integration flow uses these industry components:

The industry enterprise business object (EBO) and EBM XSD files are located here: $AIA_HOME/apps/AIAMetaData/AIAComponents/EnterpriseObjectLibrary/Industry/Communications/EBO/

The industry EBS WSDL files are located here: $AIA_HOME/apps/AIAMetaData/AIAComponents/EnterpriseBusinessServiceLibrary/Industry/Communications/EBO/

For detailed documentation of individual EBOs and EBMs, click the AIA Reference Doc link on EBO and EBM detail pages in the Oracle Enterprise Repository (OER).

For more information about using the OER and configuring it to provide the AIA Reference Doc link, see Oracle Application Integration Architecture - Foundation Pack: Integration Developer's Guide, "Configuring and Using Oracle Enterprise Repository as the Oracle SOA Repository."

EBOs can be extended, for instance, to add new data elements. These extensions are protected, and remain intact after a patch or an upgrade.

For more information, see Oracle Application Integration Architecture - Foundation Pack: Integration Developer's Guide, "Extensibility for Oracle AIA Artifacts," Extending EBOs.

For more information about the industry Oracle AIA components used by the Create/Sync Account integration flow, see Section 19.5, "Industry Oracle AIA Components."

11.5 Integration Services

These services are delivered with the Interfacing Orders to Create Customer Data in Oracle BRM integration flow:

For more information about the integration services delivered with the Create/Sync Account integration flow, see Section 19.6, "Integration Services."

11.5.1 ProcessFulfillmentOrderBillingAccountListOSMCFSCommsJMSConsumer

The ProcessFulfillmentOrderBillingAccountListOSMCFSCommsJMSConsumer is a Mediator process that has a JMS Adapter Service, which continuously polls the Oracle AIA queue AIA_CRTCUST_OUT_JMSQ.

The ProcessFulfillmentOrderBillingAccountListOSMCFSCommsJMSConsumer dequeues the ProcessFulfillmentOrderBillingAccountListEBM message and routes it to the CommunicationsBillingEBSV1 by calling the ProcessFulfillmentOrderBillingAccountList operation.

This service has one operation: Consume_Message.

11.5.2 CommunicationsBillingEBSV1

The CommunicationsBillingEBSV1 is implemented as a Mediator service to perform routing to Oracle BRM. The CommunicationsBillingEBSV1 uses the following operation in this integration flow:

  • ProcessFulfillmentOrderBillingAccountList - the order management system invokes this operation to create customer information in Oracle BRM.

For more information about this EBS, see Oracle Application Integration Architecture - Foundation Pack: Integration Developer's Guide, "Designing and Developing Enterprise Business Services" and Oracle Fusion Middleware Concepts and Technologies Guide for Oracle Application Integration Architecture Foundation Pack, "Understanding Enterprise Business Services."

11.5.3 CommsProcessFulfillmentOrderBillingAccountListEBF

The CommsProcessFulfillmentOrderBillingAccountListEBF is implemented as an asynchronous BPEL process. It performs these operations, as shown in Figure 11-2:

  • Receives the ProcessFulfillmentOrderBillingAccountListEBM from the Oracle OSM with the target Oracle BRM instance identified.

  • Transforms the message into the ProcessBillingAccountListEBM appropriately.

  • Invokes the CommunicationsBillingEBSV1.ProcessBillingAccountList, which in turn invokes the CommsProcessBillingAccountListEBF.

  • Awaits response from CommunicationsBillingResponseEBSV1.ProcessBillingAccountListResponse.

  • On receipt of response, calls CommunicationsBillingResponseEBSV1.ProcessFulfillmentOrderBillingAccountList to send the response back to the order management system.

CommsProcessFulfillmentOrderBillingAccountListEBF

Figure 11-2 CommsProcessFulfillmentOrderBillingAccountListEBF

This image is described in surrounding text.

This process has the following operations.

  • Operation: initiate

    This is an asynchronous operation to start the CommsProcessFulfillmentOrderBillingAccountListEBF.

  • Operation: CallbackResponse

    This is an asynchronous callback operation. It makes a call back to the calling process, and passes a FaultMsg in the EBMHeader in case of any error received from CommsProcessBillingAccountListEBF.

For more information about this EBF, see Oracle Application Integration Architecture - Foundation Pack: Integration Developer's Guide, "Designing and Developing Enterprise Business Flows" and Oracle Fusion Middleware Concepts and Technologies Guide for Oracle Application Integration Architecture Foundation Pack, "Understanding Enterprise Business Flows."

11.5.4 CommsProcessBillingAccountListEBF

The CommsProcessBillingAccountListEBF is implemented as an asynchronous BPEL process. it performs these operations, as shown in Figure 11-3.

  • Receives ProcessBillingAccountListEBM from CommunicationsBillingEBSV1.

  • Constructs a QueryCustomerPartyListEBM payload and queries the Siebel web service with this payload through CommunicationsCustomerPartyEBSV2, Comms2CoreCustomerPartyBridge, CustomerPartyEBSV2, and QueryCustomerPartyListSiebelProvABCSImpl.

  • Receives a response QueryCustomerPartyListResponseEBM, constructs a SyncCustomerPartyListEBM message and then invokes and routes the message through the CommunicationsCustomerPartyEBSV2 EBS.

Figure 11-3 CommsProcessBillingAccountListEBF

This image is described in surrounding text.

11.5.5 CommunicationsBillingResponseEBSV1

The CommunicationsBillingResponseEBSV1 is implemented as a Mediator service to perform response routing from Oracle BRM. The CommunicationsBillingResponseEBSV1 has the following operation used in this integration flow:

  • ProcessFulfillmentOrderBillingAccountListResponse - ProcessFulfillmentOrderBillingAccountListEBF invokes this operation to respond to the order management system.

For error scenarios, a response message can be optionally sent back to the order management system. The decision whether to send a response message back to the order management system is done based on the responseCode attribute of the DataArea of the incoming EBM (ProcessFulfillmentOrderBillingAccountListEBM) from the order management system.

If the responseCode value in the incoming EBM is REQUIRED_FOR_BUSINESS_AND_SYSTEM_ERRORS, the response message is sent back to the order management system for all errors. However, if the responseCode value is REQUIRED_FOR_BUSINESS_ERRORS, the response message is only sent back to the order management system for business errors.

Caution:

with errors, Oracle OSM and the OSM AIA cartridges do not expect a response back. Instead, they use the Oracle AIA order fallout notification to both generate a trouble ticket and change the order and line status to indicate failure.

For more information about this EBS, see Oracle Application Integration Architecture - Foundation Pack: Integration Developer's Guide, "Designing and Developing Enterprise Business Services" and Oracle Fusion Middleware Concepts and Technologies Guide for Oracle Application Integration Architecture Foundation Pack, "Understanding Enterprise Business Services."

11.5.6 ProcessFulfillmentOrderBillingAccountListResponseOSMCFSCommsJMSProducer

The ProcessFulfillmentOrderBillingAccountListResponseOSMCFSCommsJMSProducer is a BPEL process that has an adapter service, which produces the customer response messages to AIA_UPDCUST_IN_JMSQ.

This process has one operation: Produce_PFOBALResponse to produce the message into the AIA_UPDCUST_IN_JMSQ queue. This operation is called by the CommunicationsBillingResponseEBSV1 after the account or customer is interfaced in Oracle BRM.