Skip Headers
Oracle® Application Integration Architecture Oracle Lead to Order Integration Pack for Oracle CRM on Demand and Oracle E-Business Suite Implementation Guide
Release 3.1.1

Part Number E22284-06
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

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

4 Process Integration for Product Management

This chapter provides an overview of the product management process integration and describes product synchronization, Oracle CRM on Demand and Oracle E-Business Suite (Oracle EBS) interfaces, core Oracle Application Integration Architecture (Oracle AIA) components, and integration services.

This chapter includes the following sections:

4.1 Overview

The process integration for product management supports the Synchronize Items Integration flow, which enables the synchronization of simple products from Oracle EBS to CRM On Demand. This one-way flow of data from Oracle EBS to CRM On Demand is initiated when simple products are created or updated in Oracle EBS.

Figure 4-1 illustrates the overall flow for the process integration:

Figure 4-1 Product Management Integration Flow

This image is described in surrounding text.

4.1.1 Solution Assumptions and Constraints

The integration design assumes that the following statements are true:

  1. Product data integration is a one-way flow from Oracle EBS to CRM On Demand. After items are synchronized to CRM On Demand, modifications made to the products in CRM On Demand are not synchronized back to Oracle EBS.

  2. Only selected item attributes are synchronized to CRM On Demand, as follows:

    • Item Name (part of the Key Flex Field structure)

    • Item Description

    • Item Type

    • Item Status

    • Order Management-related attributes (orderable flag, customer ordered flag)

  3. Nonorderable items are not loaded into CRM On Demand as simple products.

    Only products in Oracle EBS that are marked as both Customer Ordered and Customer Order Enabled are synchronized to CRM On Demand except in the following circumstances:

    • The service configuration flag PUBLISH_ALL_PRODUCT is set to N by default, which means that only products that are marked as Customer Order Enabled are synchronized to Oracle EBS. You can change the value of this property to Y, in which case all products, whether orderable or not, are synchronized to CRM On Demand.

    • If you change the Customer Order Enabled status of a product from Y (orderable) to N (nonorderable), the product continues to synchronize to CRM On Demand.

  4. Item Name in Oracle EBS comprises concatenated key flex field segments. It cannot exceed 50 characters in length.

  5. Special characters such as '&' should not be used in the Oracle EBS Item Name definition.

  6. If a product is updated in Oracle EBS, and if the product is synchronized to CRM On Demand, the update is also synchronized to CRM On Demand.

  7. Products cannot be deleted in Oracle EBS or CRM On Demand.

  8. Products that are part of the product batch load into Oracle EBS are not synchronized to CRM On Demand.

4.2 Product Synchronization

The Synchronize Items integration flow enables the synchronization of items from Oracle EBS to CRM On Demand. This synchronization is a one-way feed from Oracle EBS to CRM On Demand. After items are created or updated in Oracle EBS, a business event is triggered that enables the synchronization of items from Oracle EBS to CRM On Demand. This flow is used for incremental loads (manual creation of products) or run-time updates. For high-volume product data loads from Oracle EBS to CRM On Demand, use the Batch Data Load integration flow that is supported by this pre-built integration.

Only customer-orderable items are synchronized as part of this flow. The following attributes of an item are synchronized and passed to CRM On Demand:

4.2.1 Create Items Flow

This integration flow uses the following interfaces:

  • CreateItemEbizEventConsumer

  • CreateProductEbizReqABCSImpl

  • ItemEBSV2

  • SyncItemListCRMODProvABCSImpl

Figure 4-2 illustrates the Create Item integration flow:

Figure 4-2 Create Item Flow Sequence Diagram

This image is described in surrounding text.

When you initiate the process, the following events occur:

  1. The CreateItemEbizEventConsumer listens to business events and receives the WF_EVENT_T_msg event payload for the Create event. The CreateItemEbizEventConsumer is routed to the CreateProductEbizReqABCSImpl with the complete event payload.

  2. The CreateProductEbizReqABCSImpl invokes the ItemEBSV2 with the operation SyncItemList.

    • As part of the enrichment process, the CreateProductEbizReqABCSImpl queries the EGO_ITEM_SYNC_OP_V view object through the Oracle EBS adapter QuerySimpleItemAdapter based on event payload to get the EgoItemSyncOpVCollection_msg.

    • As part of the transformation process, the CreateProductEbizReqABCSImpl transforms the EgoItemSyncOpVCollection_msg message into the SyncItemListEBM. Invoke the ItemEBSV2 with the operation SyncItemList. The ItemEBSV2 is a routing service with several operations on the Item enterprise business message (EBM). In the process, the cross-reference is created by concatenating the inventory item ID, organization ID, and operating unit.

  3. The ItemEBSV2 routes the SyncItemListEBM to the SyncProductCRMODProvABCSImpl.

  4. The SyncItemListCRMODProvABCSImpl transforms the SyncItemListEBM to the CRM On Demand product message and then calls a CRM On Demand product Upsert web service to synchronize the product.

    The CRM On Demand web service completes the request and returns a response message. In the process, the cross-reference is linked to the CRM On Demand IDs of the product.

4.2.2 Update Items Integration Flow

This integration flow uses the following interfaces:

  • UpdateItemEbizEventConsumer

  • UpdateProductEbizReqABCSImpl

  • ItemEBSV2

  • SyncItemListCRMODProvABCSImpl

Figure 4-3 illustrates the Update Items integration flow:

Figure 4-3 Update Items Flow Sequence Diagram

This image is described in surrounding text.

When you initiate the process, the following events occur:

  1. The UpdateItemEbizEventConsumer listens to business events and receives the WF_EVENT_T_msg event payload for update event.

    The UpdateItemEbizEventConsumer is routed to UpdateProductEbizReqABCSImpl with the complete Event payload.

  2. UpdateProductEbizReqABCSImpl service calls the Enterprise Business Service (EBS) based on the event payload, and then transforms to the SyncItemListEBM and invokes the ItemEBSV2 with operation SyncItemList.

    1. As part of the enrichment process, the UpdateProductEbizReqABCSImpl queries the EGO_ITEM_SYNC_OP_V view object through the Oracle EBS adapter QuerySimpleItemUpdateAdapter based on the event payload to get the EgoItemSyncOpVCollection_msg.

    2. As part of the transformation process, UpdateProductEbizReqABCSImpl transforms the EgoItemSyncOpVCollection_msg message into the SyncItemListEBM.

    3. ItemEBSV2 with the operation SyncItemList is invoked. ItemEBSV2 is a routing Mediator Component service with several operations on the Item EBM.

    4. In the process, the cross-reference is created by concatenating the inventory item ID, organization ID, and operating unit.

  3. ItemEBSV2 routes the SyncItemListEBM to SyncItemListCRMODProvABCSImpl.

  4. SyncItemListCRMODProvABCSImpl transforms SyncItemListEBM to the CRM On Demand Product message and then calls the CRM On Demand product Upsert web service to synchronize the product.

    The CRM On Demand web service completes the request and returns a response message. In the process, the cross-reference is linked with the CRM On Demand IDs of the product.

4.2.3 Batchload Items Integration Flow

This integration flow uses the following interfaces:

  • BatchLoadItemEbizEventConsumer

  • BatchLoadProductEbizReqABCSImpl

  • ItemEBSV2

  • SyncItemListCRMODProvABCSImpl

You initiate the Batchload Items integration flow in Oracle EBS when performing the initial data load from Oracle EBS to CRM On Demand. Details related to the item are synchronized to CRM On Demand.

For information about the initial batch loading of customer account data, see Chapter 2, "Initial Loading and Synchronization of Data".

4.3 Oracle CRM On Demand Interfaces

The CRM On Demand web service provided for the Product Management integration flow is the document/urn:crmondemand/ws/product/10/2004:ProductInsertOrUpdate service.

4.4 Oracle EBS Interfaces

These are the Oracle EBS web services provided for the Product Management integration flow.

Outbound from Oracle EBS Event Interfaces

Oracle EBS View Interfaces

EGO_ITEM_SYNC_OP_V

For more information about Oracle EBS web services and documentation prior to Release 12.1.3, see the library on Oracle Technology Network: http://www.oracle.com/technetwork/documentation/applications-167706.html?. For Oracle EBS documentation for R12.1.3 and beyond, see this library: http://download.oracle.com/docs/cd/E18727_01/index.htm.

4.5 Core Oracle AIA Components

The Product Management integration flow uses the following delivered core components:

The core EBO and EBM XML Schema Definition files can be located by Enterprise Business Object (EBO) within this parent folder: $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseObjectLibrary/Core/EBO/.

The core Oracle EBS Web Service Definition Language (WSDL) files can be located by EBO within this parent folder: $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseBusinessServiceLibrary/Core/EBO/.

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

For more information about using the Oracle Enterprise Repository and configuring it to provide the AIA Reference Doc link, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack 11g Release 1, "Configuring and Using Oracle Enterprise Repository as the Oracle AIA 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 Fusion Middleware Concepts and Technologies Guide for Oracle Application Integration Architecture Foundation Pack 11g Release 1, "Understanding Extensibility."

4.6 Integration Services

These services are delivered with this integration:

For more information, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack 11g Release 1, "Configuring and Using Oracle Enterprise Repository as the Oracle AIA SOA Repository."

4.6.1 ItemEBSV2

ItemEBSV2 is a lightweight mediator routing service that exposes all of the enterprise operations that can be performed on an Item EBO.

The SyncItemList operation is provided by ItemEBSV2.

For SyncItem (Simple Product), whenever an item is created or updated in the Item master in Oracle EBS, a business event is raised to synchronize the item to CRM On Demand.

Synchronization is required only for items that belong to OE Item Validation Org that are customer orderable and have Item Type = {Model, Option Class, and Standard}. The business event does not discriminate between items based on this mentioned constraint-the event is triggered regardless of these constraints.

The ItemEBSV2 service uses these operations:

  • Post Item Create: oracle.apps.ego.item.postItemCreate

  • Post Item Update: oracle.apps.ego.item.postItemUpdate

  • Item BatchLoad: oracle.apps.ego.ebi.itemLoad

For more information about this Oracle EBS, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack 11g Release 1, "Designing and Developing EBSs" and Oracle Fusion Middleware Concepts and Technologies Guide for Oracle Application Integration Architecture Foundation Pack 11g Release 1, "Understanding EBSs."

4.6.2 CreateProductEbizReqABCSImpl

The CreateProductEbizReqABCSImpl service is a Business Process Execution Language (BPEL) process. It is responsible for calling the Oracle EBS Product web service based on the event payload to get the Oracle EBS Product Application Business Message (ABM) and for transforming the Oracle EBS Product ABM messages into the appropriate item EBM format and invoking the SyncItem Oracle EBS operation.

By default, an orderable product associated with the OE:Item Validation Org is synchronized to CRM On Demand. To bypass validation against the OE:Item Validation Org, the configuration property BYPASS_ITEMVALIDATIONORG_FLAG must be set to Y. The INVENTORY_LOCATION_ID XREF must be set up with all the OE:Item Validation Org. To synchronize nonorderable products, set the configuration property PUBLISH_ALL_PRODUCT to Y.

This is a single operation service. It accepts an Oracle EBS Product message as a request and does not return a response.

4.6.3 UpdateProductEbizReqABCSImpl

The UpdateProductEbizReqABCSImpl is a BPEL process that is responsible for calling the Oracle EBS Product web service based on the event payload to get the Oracle EBS Product ABM and transforming the Oracle EBS Product ABM messages into the appropriate Item EBM format and invoking the SyncItemList Oracle EBS operation. By default, an orderable product associated with the OE:Item validation organization is synchronized to CRM On Demand. To bypass validation against the OE:Item Validation Org, the configuration property BYPASS_ITEMVALIDATIONORG_FLAG must be set to Y. The INVENTORY_LOCATION_ID XREF must be set up with all the OE:Item Validation Org.

This is a single operation service. It accepts an Oracle EBS Product message as a request and does not return a response.

4.6.4 BatchLoadProductEbizReqABCSImpl

The BatchLoadProductEbizReqABCSImpl is a BPEL process that is responsible for calling the Oracle EBS Product web service based on the event payload to get the Oracle EBS Product ABM and transforming the Oracle EBS Product ABM messages into the appropriate Item EBM format and invoking the SyncItemList Oracle EBS operation. This service does not do any filtering of product; any product part of the event is published in the SyncItemList Oracle EBS operation.

This is a single operation service. It accepts an Oracle EBS product message as a request and does not return a response.

4.6.5 CreateItemEbizEventConsumer

The CreateItemEbizEventConsumer has an Oracle Apps adapter configured to listen for create business events with routing services.

One service with one operation is available to read the Oracle EBS message EbizSyncProductReqMsg from the Oracle AQ "WF_BPEL_Q": CreateItemEbizEventConsumer.

This service is implemented as a Mediator Component process with an Oracle Apps adapter for listening to business event and routing services.

4.6.6 UpdateItemEbizEventConsumer

The UpdateItemEbizEventConsumer has an Oracle Apps adapter configured to listen for update business events with routing services.

One service with one operation is available to read the Oracle EBS message EbizSyncProductReqMsg from the Oracle Advanced Queue (AQ) "WF_BPEL_Q": UpdateItemEbizEventConsumer.

This service is implemented as a Mediator Component process with an Oracle Apps adapter for listening to business events and routing services.

4.6.7 BatchloadItemEbizEventConsumer

The BatchloadItemEbizEventConsumer has an Oracle Apps adapter configured to listen for Batchload business events with routing services.

One service with one operation is available to read the Oracle EBS message EbizSyncProductReqMsg from the Oracle AQ "WF_BPEL_Q": BatchloadItemEbizEventConsumer

This service is implemented as a Mediator Component process with an Oracle Apps adapter for listening to business events and routing services.