Oracle® Application Integration Architecture Agile Product Lifecycle Management Integration Pack for Oracle E-Business Suite: Design to Release Implementation Guide Release 11.3 E40004-02 |
|
|
PDF · Mobi · ePub |
This chapter provides an overview of the process integration for item synchronization and discusses solution assumptions and constraints, interfaces, core Oracle Application Integration Architecture (Oracle AIA) components, and integration services.
This chapter includes the following sections:
Agile PLM is the system of record for product design and part information. The Item Synchronization process sends the new part numbers together with the part attributes from Agile PLM to Oracle E-Business Suite. Synchronization of an item from Agile PLM to Oracle E-Business Suite is performed in the following two scenarios:
A part number is created in Agile PLM and the same part number must be created in Oracle E-Business Suite/PIM.
A part already exists in Agile PLM and Oracle E-Business Suite/PIM; however, a change is created on the item in Agile PLM.
The information of this item from Agile PLM must be synchronized with the existing item information in Oracle E-Business Suite/PIM.
The process of synchronization of an item can be triggered on-demand by the user. An engineer creating a new part in Agile PLM synchronizes the same with Oracle E-Business Suite/PIM through an action menu based process extension (PX). If the item does not exist in Oracle E-Business Suite/PIM, it will be created, or else updated.
The item synchronization process is almost the same as the New Part Request (NPR) process. However, for item synchronization, a new PX (SyncItem PX) in Agile PLM is used to trigger the publication of a new part into Oracle E-Business Suite/PIM or synchronization of an updated part from Agile PLM into Oracle E-Business Suite/PIM. The part information is replicated in Oracle E-Business Suite/PIM and a transfer status is returned. On the contrary to the item synchronization, if a part was created outside of Agile and Agile does not have the part number, the NPR process involves sending the part number from Oracle E-Business Suite into Agile.
All this is performed in realtime. No approval or any other role is involved in the process.
The item synchronization process includes:
For item synchronization, the part number is created first in Agile PLM and then in Oracle E-Business Suite.
If the part already exists in Oracle E-Business Suite, the part data will be synchronized with Agile PLM's part information.
An action menu based process extension (syncitemPX) is used to trigger the publication of the part number into Oracle E-Business Suite/PIM or synchronization of an updated part from Agile PLM into Oracle E-Business Suite/PIM.
The part information is replicated in Oracle E-Business Suite/PIM and a transfer status is returned whether it was successful or not.
The following exception conditions create error messages for this integration process:
The context organization is not passed.
More than one item master organizations exist and the default master organization configuration property is not setup or is invalid.
Table 5-1 lists the activities in item synchronization integration services orchestration:
Table 5-1 Activities in Item Synchronization Orchestration
Step | Name | Step Description |
---|---|---|
1. |
Agile PLM SyncItemPX is triggered. |
The Agile PLM Sync Item PX is triggered by the Agile PLM user from the Agile PLM Web client as part of New Part creation in Agile PLM. |
2. |
Invoke SyncItemListAgileReqABCS with AgileSyncItemListABM as input. |
The SyncItemPX process invokes SyncItemListAgileReqABCS with AgileSyncItemListABM as input. |
3. |
Invoke SyncItemListAgileReqABCSImpl with AgileSyncItemListABM as input. |
SyncItemListAgileReqABCS invokes SyncItemListAgileReqABCSImpl with AgileSyncItemListABM as input. |
4. |
SyncItemListAgileReqABCSImpl invokes ItemEBSV2 with the SyncItemList operation. |
SyncItemListAgileReqABCSImpl transforms AgileSyncItemListABM into SyncItemListEBM and invokes SyncItemList operation on ItemEBSV2 with SyncItemListEBM as the input. SyncItemListEBM is routed to Oracle E-Business Suite SyncItemListEbizProvABCSImpl. |
5. |
SyncItemListEbizProvABCSImpl transforms and then calls the Oracle E-Business Suite service. |
SyncItemListEbizProvABCSImpl first transforms SyncItemListEBM into the input of the Oracle E-Business Suite service to create or update the item in Oracle E-Business Suite and then calls that service. SyncItemListEbizProvABCSImpl invokes ItemResponseEBSV2 with SyncItemListResponseEBM as input, which is routed to SyncItemListAgileReqABCSImpl. |
6. |
SyncItemListAgileReqABCSImpl transforms and then returns the response to SyncItemListAgileReqABCS. |
SyncItemListAgileReqABCSImpl transforms SyncItemListResponseEBM into AgileSyncItemListResponseABM and returns the same to SyncItemListAgileReqABCS. |
7. |
SyncItemListAgileReqABCS returns AgileSyncItemListResponseABM to the SyncItemPX. |
SyncItemListAgileReqABCS returns AgileSyncItemListResponseABM to SyncItemPX. |
8. |
SyncItemPX returns the part number to New Part Creation UI in Agile PLM |
SyncItemPX gets a message from AgileSyncItemListResponseABM and displays an appropriate message in UI. |
The process integration for item synchronization flow includes a list of services and three transaction boundaries. This flow includes the following services:
SyncItemListAgileReqABCS
SyncItemListAgileReqABCSImpl
ItemEBSV2
SyncItemListEbizProvABCSImpl
SyncItemListEbizAdapter
ItemResponseEBSV2
The following table describes the transactions, database operations involved and solutions in case of any errors.
Table 5-2 Transaction Boundaries and Recovery details
S.No | Transaction | DB Operations | In Case of Error | Recovery |
---|---|---|---|---|
1 |
SyncItemListAgileReqABCS invokes SyncItemListAgileReqABCSImpl with AgileSyncItemListABM as input. SyncItemListAgileReqABCSImpl transforms AgileSyncItemListABM into SyncItemListEBM and invokes SyncItemList operation on ItemEBSV2 with SyncItemListEBM as the input. ItemEBSV2 routes the SyncItemListEBM to SyncItemListEbizProvABCSImpl. SyncItemListEbizProvABCSImpl first transforms SyncItemListEBM into the input of the Oracle E-Business Suite service to create or update the item in Oracle E-Business Suite and then calls that service. |
AIA cross-referenceentries |
RollBack Cross-Reference Entries |
Sync Item Again from Agile |
SyncItemListEbizProvABCSImpl invokes ItemResponseEBSV2 with SyncItemListResponseEBM as input, which is routed to SyncItemListAgileReqABCSImpl. ItemResponseEBSV2 routes SyncItemListResponseEBM to SyncItemListAgileReqABCSImpl. |
||||
2 |
SyncItemListAgileReqABCSImpl transforms SyncItemListResponseEBM into AgileSyncItemListResponseABM and returns the same to SyncItemListAgileReqABCS. |
AIA cross-referenceentries |
RollBack Cross-Reference Entries |
Sync Item Again from Agile |
3 |
SyncItemListAgileReqABCS returns AgileSyncItemListResponseABM to SyncItemPX. |
None |
Sync Item Again from Agile |
For more information about rollback procedures, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack, "Configuring Oracle AIA Processes for Error Handling and Trace Logging", "Configuring Fault Policies to Not Issue Rollback Messages".
Part number generation occurs first in Agile PLM and adheres to policies established in Oracle E-Business Suite/PIM.
An Action based PX (SyncItem PX) is designed in such a way that any attribute for an item could be passed into the payload along with the site-specific attributes if multisite is enabled in Agile PLM.
Dynamic invocation interface (DII) is used in PX for triggering the integration so that no stubs are generated for the Application Business Messages (ABMs) and packaged in the PX jar; any changes to the payload will have minimum impact.
Oracle E-Business Suite INV: Default primary unit of measure and INV: Default Item Status profile options must be set up to create the item successfully.
The Action menu based PX is designed in such a way that any attribute for the item could be passed in the payload.
Table 5-3 lists the Agile PLM Web Services Definition Language (WSDL) files:
Table 5-3 Agile PLM Web Services Definition Language (WSDL) files
Interface | Description |
---|---|
SyncItemListAgileReqABCS SyncItemListAgileReqABCSImpl |
|
ItemABS.wsdl |
Used to create an item in Oracle E-Business Suite |
Table 5-4 lists the Agile PLM XML Schema Definition (XSD) files:
Table 5-5 lists the Oracle E-Business Suite WSDL files:
Table 5-5 Oracle E-Business Suite WSDL files
Interface | Description |
---|---|
SyncItemListEbizProvABCSImpl |
|
SyncItemListEbizAdapter.wsdl |
Used for the OA Adapter "INV_EBI_ITEM_PUB.process_item" pl/sql function call |
Table 5-6 lists the Oracle E-Business Suite XSD files:
Table 5-7 lists the industry components used in the process integration for item synchronization:
Table 5-7 Industry Components for Item Synchronization
Component | Name |
---|---|
Enterprise Business Object (EBO) |
ItemEBO |
Enterprise Business Message (EBM) |
SyncItemListEBM SyncItemListResponseEBM |
Enterprise Business Service (EBS) |
ItemEBSV2 ItemResponseEBSV2 |
Table 5-8lists the core components locations:
Table 5-8 Core Component Locations
Component | Location |
---|---|
EBO and EBM XML Schema Definition (XSD) files |
$AIA_HOME/AIAMetaData/AIAComponents/EnterpriseObjectLibrary/Core/EBO/ $AIA_HOME/AIAMetaData/AIAComponents/ ApplicationObjectLibrary /Ebiz/Release1/Core |
WSDL files |
$AIA_HOME/apps/AIAMetaData/AIAComponents/ EnterpriseBusinessServiceLibrary /Core/EBO/ $AIA_HOME/AIAMetaData/AIAComponents/ ExtensionServiceLibrary/Ebiz $AIA_HOME/AIAMetaData/AIAComponents/ApplicationConnectorServiceLibrary/Ebiz/V1 |
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, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack 11g Release 1, "How to Access Oracle AIA Content in Oracle Enterprise Repository."
EBOs can be extended, for instance, to add new data elements. These extensions are protected, and they will 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."
Table 5-9 lists the Agile PLM and Oracle E-Business Suite components:
Table 5-9 Agile PLM and Oracle E-Business Suite Components
Services | Agile PLM (Requester) | Oracle E-Business Suite (Provider) |
---|---|---|
ABMs |
AgileSyncItemListABM AgileSyncItemListResponseABM |
APPS_INV_EBI_ITEM_PUB_PROCESS_ITEM |
Application Business Connector Service (ABCS) |
SyncItemListAgileReqABCS SyncItemListAgileReqABCSImpl |
SyncItemListEbizProvABCSImpl |
Table 5-10 lists the core components locations:
Table 5-10 Core Component Locations
Component | Location |
---|---|
Application Business Objects, ABM, and Common XSD files |
$AIA_HOME/AIAMetaData/AIAComponents/ApplicationObjectLibrary/AgilePLM/V1/schemas $AIA_HOME/AIAMetaData/AIAComponents/ApplicationObjectLibrary/Ebiz/V1/schemas $AIA_HOME/AIAMetaData/AIAComponents/ApplicationObjectLibrary/Ebiz/Release1/Core |
WSDL files |
$AIA_HOME/AIAMetaData/AIAComponents/ApplicationObjectLibrary/AgilePLM/V1/wsdls $AIA_HOME/AIAMetaData/AIAComponents/ApplicationObjectLibrary/Ebiz/wsdls $AIA_HOME/AIAMetaData/AIAComponents/ExtensionServiceLibrary/Ebiz $AIA_HOME/AIAMetaData/AIAComponents/ApplicationConnectorServiceLibrary/Ebiz/V1 |
The integration services for the item synchronization process are:
ItemEBSV2
SyncItemListAgileReqABCSImpl
SyncItemListEbizProvABCSImpl
ItemEBSV2 exposes the operations related to the item integration on the item EBO. The following list itemizes the routing rules:
ItemEBSV2
SyncItemList: Routes SyncItemListEBM to SyncItemListEbizProvABCSImpl
ItemResponseEBSV2
SyncItemListResponse: Routes SyncItemListResponseEBM to SyncItemListAgileReqABCSImpl
SyncItemListAgileReqABCSImpl transforms the Agile PLM message (AgileSyncItemListABM) into SyncItemListEBM, calls the routing service to synchronize the item, and receives the SyncItemListResponseEBM response from Oracle E-Business Suite. It then transforms the SyncItemListResponseEBM response from the routing EBS back to the Agile PLM message (AgileSyncItemListResponseABM) and sends it to SyncItemListAgileReqABCS, which returns it to the calling Agile PLM PX.
The process includes:
Receives the AgileSyncItemListABM from the SyncItemListAgileReqABCS invoked by the Agile PLM Action PX
Transforms this message into SyncItemListEBM:
Populates the EBM header
Determines the target system IDs and adds them in the EBM header for controlling the routing
Validates the required fields
Maps to SyncItemListEBM
Calls the target ItemEBSV2 service with the operation SyncItemList
Transforms the SyncItemList Response message (from SyncItemListResponseEBM) to an AgileSyncItemListResponseABM Agile PLM message
Sends AgileSyncItemListResponseABM back to SyncItemListAgileReqABCS, which in turn sends it to the respective PX
SyncItemListEbizProvABCSImpl receives the SyncItemListEBM message from ItemEBSV2, transforms it into an Oracle E-Business Suite-specific SyncItemListABM.
Note:
Generate Item Number and Description service is called only if the syncActionCode value in the EBM is CREATEREPLACE. In the NPR flow, the value of syncActionCode is CREATEREPLACE; however, in the item synchronization flow, where the value of syncActionCode is CREATEUPDATE, the Generate Item Number and Description service is not called.
Subsequently, the Sync Item PL/SQL Application Programming Interface (API) is called to synchronize an item in Oracle E-Business Suite. It transforms the Oracle E-Business Suite-specific response message SyncItemListResponseABM to SyncItemListResponseEBM and calls the routing service ItemResponseEBSV2 from which the response is sent to Agile PLM.
The process includes:
Receives SyncItemListEBM from ItemEBSV2
Transforms SyncItemListEBM into Oracle E-Business Suite specific message SyncItemListABM
Applies the dynamically generated eXtensible Stylesheet Language (XSL) onto this transformation
This dynamic XSL is generated based on the eXtensible Stylesheet Language Transform (XSLT) defined at the customer site, which allows mapping of the EBM attributes to the ABM attributes that can be configured at the customer site. To allow this mapping, a template call is made at the end of the Transformation XSL file (the one that transforms the EBM to ABM) and this dynamic XSL is called from the original EBM-To-ABM transformation XSL.
Creates an item in Oracle E-Business Suite with Oracle E-Business Suite Generated Item Number instead of Agile PLM Generated Item Number
Populates the EBM header
Determines the target system IDs and adds them in the EBM header for controlling the routing
Validates the required fields
Invokes the Sync Item API
Transforms Oracle E-Business Suite-specific message SyncItemListResponseABM into SyncItemListResponseEBM
Calls ItemResponseEBSV2 to send response message SyncItemListResponseEBM to SyncItemListAgileReqABCSImpl