|Oracle® Application Integration Architecture Siebel CRM Integration Pack for Oracle Order Management: Order to Cash Implementation Guide
Part Number E20515-05
|PDF · Mobi · ePub|
This chapter provides an overview of the process integration for Asset Management and discusses how to create and update assets. Also discussed are Siebel Customer Relationship Management (Siebel CRM) 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:
The process integration for Asset Management is a one-way synchronization of new or updated customer-owned item instances from Oracle EBS into a Siebel CRM asset. The asset integration supports the following flows:
Create assets: This flow enables the synchronization of new customer-owned item instances from Oracle EBS to Siebel CRM Asset.
Update assets: This flow enables the synchronization of updates to item instances from Oracle EBS to Siebel CRM Asset.
Bulk load of assets: This flow enables the extraction, transformation, and loading of initial Item instance data from Oracle EBS to Siebel CRM Asset. This feature uses Oracle Data Integrator (ODI) to extract relevant data from Oracle EBS and map it to Siebel interface tables. This process also enables cross-referencing between Oracle EBS and Siebel CRM.
For more information about initial data loads, see Chapter 2, "Loading Initial Data."
Find prerequisites in Chapter 13, "Reviewing Prerequisites and Data Requirements."
These are the assumptions and constraints for the asset integration:
After assets are synchronized to Siebel CRM; they cannot be changed in Siebel CRM.
In Oracle EBS, item instances are created and updated for items for which the Track in Installed Base attribute is set to True.
Only customer-owned (Organization Party) item instances (assets) are synchronized from Oracle EBS to Siebel CRM.
In Siebel CRM, the asset is created upon synchronization from Oracle EBS, and not by any workflow process in Siebel when the order status is completed.
Because asset synchronization is one-way from Oracle EBS to Siebel CRM, assets should not be updated in Siebel.
When products are synchronized from Oracle EBS to Siebel CRM, they are cross-referenced using this concatenation of keys from Oracle EBS:
inventory item id::organization id::operating unit id TYPE = SHELL
When orders are fulfilled and item instances are created in Oracle EBS, the master organization Id and the shipping organization Ids are stored along with the item instance details in Oracle EBS.
When products are synchronized it should be ensured that they are also synchronized in the master organization and any other organizations, (such as the item validation organization), which Order Management requires. Then asset integration fetches the product from the cross-reference using the following:
inventory item id::master org id::operating unit id
Figure 12-1 illustrates where the asset integration flow occurs in the Order to Cash integration:
Figure 12-2 illustrates the Create Asset and Update Asset integration flows:
The Create Assets integration flow synchronizes new item instances from Oracle EBS to Siebel CRM Assets in real time and it enables a Customer Service Representative (CSR) to share the asset information with customers.
The item instances are created in the following ways in Oracle EBS:
After sales orders are picked, released, and shipped, an install base item instance is created in Oracle EBS (using auto-creation).
An item instance can be manually created for a customer (for both serial and nonserial items).
The major attributes of the Oracle EBS Item Instance that are synchronized to Siebel CRM Asset are:
Asset Number and Serial Number
Status and Install Date
Figure 12-3 illustrates the Create Assets integration flow:
This integration flow uses the following interfaces:
Figure 12-4 illustrates the Create Assets flow sequence diagram.
When you initiate the create assets process, the following events occur:
The create event is raised when a new item instance is created in Oracle EBS either through the user interface or through the Order fulfillment process.
The event is raised for simple and complex asset creations. The CreateItemInstanceEbizEventConsumer dequeues the message using the EBS adapter listening on the create item instance event. The event payload is then routed to the CreateItemInstanceEbizReqABCSImpl service.
Using the Oracle EBS adapter, the CreateItemInstanceEbizReqABCSImpl service queries CSI_ASSET_INTEGRATION_V passing in the instance ID and gets the entire item instance ABM message as QueryItemInstanceRespMsg.
The CreateItemInstanceEbizReqABCSImpl then transforms the QueryItemInstanceRespMsg into the CreateInstalledProductEBM, and then it invokes the InstalledProductEBSV2 with the operation CreateInstalledProductList.
In the case of a complex asset, as part of the create transformation, the parent ID is ignored even if it is available in the message. It is mapped, and the relationship with the parent item instance is built only as part of the update process.
The InstalledProductEBSV2 routes the CreateInstalledProductEBM to the Siebel provider application business connector service (ABCS) implementation CreateAssetSiebelProvABCSImpl.
The CreateAssetSiebelProvABCSImpl transforms the CreateInstalledProductEBM into the Siebel Asset application business message (ABM) CRMIntegSEBLHORAssetInterface as CreateAssetReqMsg.
It then calls the Siebel Asset web service CRMIntegSEBLHORAssetInterface to create the asset in Siebel and returns a response message CreateAssetRespMsg. The CreateAssetSiebelProvABCSImpl then transforms the Siebel response message to the enterprise business message (EBM) CreateInstalledProductRespMsg (the Siebel Asset ID links to the common ID in the cross-reference) and then the message is sent back to the InstalledProductEBSV2.
The Update Assets integration flow is initiated when item instances are updated in Oracle EBS. Updates include status updates, updates due to return material authorization (RMA) orders, and relationship updates to build the hierarchy to represent the bill of material (BOM).
This one-way synchronization is from Oracle EBS to Siebel CRM. As item instances are updated in Oracle EBS, a business event is triggered that enables the synchronization of the latest asset status from Oracle EBS to Siebel CRM.
Item Instances are updated when:
A shipped confirmation of an item instance (auto-update) is received.
Merchandise is returned (RMA transaction). The install base item status is updated as returned, and the quantity is also updated.
Manual updates of item instances occur (the update of attributes versus the retiring of assets).
Asset updates are not allowed from Siebel CRM to Oracle EBS.
Figure 12-5 illustrates the Update Assets integration flow:
This integration flow uses the following interfaces:
Figure 12-6 illustrates the Update Assets integration flow:
When you initiate the Update Assets process, the following events occur:
The Oracle EBS update event is raised when an item instance is updated in Oracle Apps through the user interface, the Order fulfillment process, the RMA process, or when the Update Assets process is building relationships to represent a BOM structure.
The event is raised for simple and complex asset updates. The UpdateItemInstanceEbizEventConsumer dequeues the message using the EBS adapter listening on the Update item instance event. The event payload is then routed to the UpdateItemInstanceEbizReqABCSImpl service.
The UpdateItemInstanceEbizReqABCSImpl service, using EBS adapter, queries the CSI_ASSET_INTEGRATION_V, passes in the Instance ID, and gets the entire item instance ABM message as QueryItemInstanceRespMsg.
The UpdateItemInstanceEbizReqABCSImpl then checks the cross-reference for the existence of the Parent ID.
If the QueryItemInstanceRespMsg has the Parent ID for the item instance, then the UpdateItemInstanceEbizReqABCSImpl checks the cross-reference for the common Parent ID and the current Common Instance ID. This verification ensures that the Update process occurs after the Create process.
If the cross-reference does not exist for the parent, the UpdateItemInstanceEbizReqABCSImpl waits.
If the cross-reference does not exist for the parent or for the instance, the UpdateItemInstanceEbizReqABCSImpl waits for the parent and the instance that is to be created by the Create process, which must be initiated by the Create event from Oracle EBS. After it is created, the UpdateItemInstanceEbizReqABCSImpl continues with the rest of the processing, as described in the remaining steps.
If the cross-reference exists for the parent and the instance, the UpdateItemInstanceEbizReqABCSImpl transforms the QueryItemInstanceRespMsg into the UpdateInstalledProductEBM and then invokes the InstalledProductEBSV2 with the operation UpdateInstalledProductList
For complex assets, the Parent ID, if available, is mapped as part of the Update transformation, and the relationship with the parent item instance is built.
The InstalledProductEBSV2 routes the EBM message to UpdateAssetSiebelProvABCSImpl.
The UpdateAssetSiebelProvABCSImpl checks for the existence of Siebel IDs in the cross-reference for the parent and the current instance, and then it transforms the UpdateInstalledProductEBM into the Siebel Asset ABM message CRMIntegSEBLHORAssetInterface as UpdateAssetReqMsg.
Then it calls the Siebel Asset web service CRMIntegSEBLHORAssetInterface to update the asset in Siebel and returns a response message UpdateAssetRespMsg. The UpdateAssetSiebelProvABCSImpl then transforms the Siebel response message to the UpdateInstalledProductRespMsg, and then it sends the message back to InstalledProductEBSV2.
The Siebel CRM interface for the CreateInstalledProduct flow and the UpdateInstalledProduct flow is SWIAssetManagementIO.
The CreateInstalledProduct flow and the UpdateInstalledProduct flow include the following services:
Request and Response Schema:
For more information about Siebel web services, see CRM Web Services Reference.
The Oracle EBS interface for the CreateInstalledProduct flow and the UpdateInstalledProduct flow is CSI_ASSET_INTEGRATION_V.
For more information about Oracle E-Business Suite 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 E-Business Suite documentation for R12.1.3 and beyond, see this library:
The assets integration uses the following delivered core components:
The industry enterprise business object (EBO) and enterprise business message XML schema (EBM XSD) files are located here: $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseObjectLibrary/Core/EBO/
The industry enterprise business service (EBS) WSDL files are located here: $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseBusinessServiceLibrary/Core/EBO/
For detailed documentation of individual EBOs and EBMs, click the AIA Reference Doc link on the 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, "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 they 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, "Understanding Extensibility."
The following services are delivered with the process integration for Asset Management:
For more information, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack, "Configuring and Using Oracle Enterprise Repository as the Oracle AIA SOA Repository."
The InstalledProductEBSV2 is a routing service that exposes all of the enterprise operations that can be performed with the InstalledProductEBO. All of the integration flows for the Order to Cash integration make use of the operations provided by this enterprise business service.
The following operations on the InstalledProductEBSV2 are used in the asset integration flows:
The QueryItemInstanceEbizAdapter is a Mediator routing service in which the database adapter for querying the item instance is registered so that the database adapter call from the ABCSReqImpl becomes a Simple Object Access Protocol (SOAP) web service call.
The QueryItemInstanceEbizR12VersionAdapter is an adapter service. This queries the R12 Ebusiness suite view for an item instance. This adapter call from the ABCSReqImpl becomes a SOAP web service call. This service is specific for an R12 Ebusiness suite instance.
The CreateItemInstanceEbizEventConsumer is a Mediator routing service that listens on the Create Item Instance event in Oracle Apps. It dequeues the event message and routes it to the CreateItemInstanceEbizReqABCSImpl service.
The CreateItemInstanceEbizReqABCSImpl is a Business Process Execution Language (BPEL) process invoked by the CreateItemInstanceEbizEventConsumer service passing in the Create Item Instance payload.
This service queries the entire Item Instance Oracle EBS ABM message, then transforms into an EBM, and invokes the CreateInstalledProductList operation of the InstalledProductEBSV2.
This transformation is required: Oracle EBS Item Instance ABM to CreateInstalledProductListEBM.
The CreateAssetSiebelProvABCSImpl is a BPEL process that is invoked by the CreateInstalledProduct operation of the InstalledProductEBSV2, passing in the Create Installed Product EBM payload. This service transforms the EBM into a Siebel ABM and invokes the create operation on the Siebel Asset web service interface.
The following transformations are required:
Installed ProductList EBM to CreateAsset ABM
CreateAsset response ABM to CreateInstalledProductList response EBM
The UpdateItemInstanceEbizEventConsumer is a Mediator routing service that listens on the Update Item Instance event in Oracle Apps, then dequeues the event message and routes it to the UpdateItemInstanceEbizReqABCSImpl service.
The UpdateItemInstanceEbizReqABCSImpl is a BPEL process that is invoked by the UpdateItemInstanceEbizEventConsumer service, passing in the Update Item Instance payload. This service queries the entire Item Instance Oracle EBS ABM message, transforms into an EBM, and invokes the UpdateInstalledProduct operation of the InstalledProductEBSV2.
This transformation is required: Ebiz Item Instance ABM to UpdateInstalledProductEBM.
The UpdateAssetSiebelProvABCSImpl is a BPEL process that is invoked by the UpdateInstalledProduct operation of the InstalledProductEBSV2, passing in the update Installed Product EBM payload.
This service transforms the EBM into the Siebel ABM and invokes the update operation on the Siebel Asset web service interface.