Using Enterprise Integration Points for Items
This topic discusses how to:
Send outbound data with the Item Master EIP.
Send item information to PeopleSoft CRM.
Receive inbound data with the Item Master EIP and the Item Price List EIP.
PeopleSoft applications provide the following enterprise integration points (EIPs)—the Item Price List EIP, the Item Master EIPs, and the CRM Item Sync EIPs—that enable you to synchronize item data with third-party systems. With the Item Price List EIP, you can receive item price list data that is published by third-party sources or load this information from a flat file. With the CRM Item Sync EIPs, you can send item records to PeopleSoft CRM.
With the Item Master EIPs, you can send and receive complete item records.
The Item Master EIP includes four XML-based service operations defined in PeopleSoft Integration Broker: ITEM_SYNC, ITEM_SYNC_EFF, ITEM_FULLSYNC, and ITEM_FULLSYNC_EFF. Activate the ITEM_SYNC service operation to send incremental updates automatically as item information is updated online or by using the Change Item Status process (INS4000), Item Loader process (IN_ITMLOAD), or Publish Outbound Message process. Activate the ITEM_FULLSYNC service operation to perform full data replication by scheduling a batch process using the Full Data Publish utility. This process generates an outbound transaction containing item information.
If you are sending item data to a third-party system that cannot process effective-dated rows, activate the _EFF version of either the ITEM_SYNC or ITEM_FULLSYNC service operations. When you send item updates by using the _EFF service operations, future-dated segments of the data are removed from the outbound transaction and sent when the effective date equals the current date.
When you activate the ITEM_SYNC or ITEMSYNC_EFF service operations, outbound item information is generated from these 11 points within the PeopleSoft system as approved items are being maintained:
Define Item component.
Purchasing Attributes component.
Approve Item component.
Purchasing Attributes component.
Units of Measure component.
Universal Item Identifiers.
Copy Item component.
Revision Maintenance component.
BOM Mass Maintenance by MMC.
BOM Mass Maintenance by ECO.
Item Loader process (IN_ITMLOAD).
Item Add component.
Note: To send the outbound data for BOM Mass Maintenance by MMC or by ECO, run both the ENPMMAIN COBOL process and the Publish Outbound Message (Item Revision option) process. To send the data for Revision Maintenance, run the Publish Outbound Message (Item Revision option) process.
See PeopleSoft SCM Outbound EIPs.
See General WMS Integration Issues.
Message Structure
Each service operation uses a message to define the fields and records to be used in the EIP. The structure of the item messages is:
Segment |
Parent |
Valid Relationships |
---|---|---|
Item Master. |
None. |
|
Item Detail. |
Item Master. |
1:1 on effective-dated messages or both 1:1 and 1:many on messages that are not effective-dated. |
Item UOM. |
Item Master. |
1:1 or 1:many. |
Item Purchasing Attributes. |
Item Master. |
1:0 or 1:1. |
Item Bus Unit Attributes. |
Item Master. |
1:0, 1:1, or 1:many. |
Item Bus Unit Weight/Volume. |
Item Bus Unit Attributes. |
1:0 or 1:1, or 1:many. |
Item Revision. |
Item Bus Unit Attributes. |
1:0, 1:1, or 1:many. |
Item Category. |
Item Master. |
1:0, 1:1, or 1:many. |
Item Manufacturer. |
Item Master. |
1:0, 1:1, or 1:many. |
Universal Item Identifier. |
Item Master. |
1:0, 1:1, or 1:many. |
Message Segments
The segments that are delivered in each of the item messages vary depending on the source of the message. The tables that are provided under each of the data sources display the segments that are delivered based on the function that is being performed.
The parent segment of the message is always included on the EIP transaction.
If the parent segment does not have a PSCAMA record, or if it does have a PSCAMA record with a blank audit action code, then no modifications are made to the parent segment. In this case, the parent is included only for reference purposes.
The EIP transaction is published if any fields for a source record are altered on any of the pages that are listed.
The audit action code on the PSCAMA record is set to the appropriate code based on the action that is being performed (add, change, or delete). Because all fields of the source record are not sent on the EIP transaction, cases may exist in which transactions are published even though none of the fields have been modified. The logic that determines whether to publish a transaction only checks that the source record has been altered. It does not check field by field to determine whether the altered fields are on the message used by the EIP transaction.
Because the logic that publishes the transaction does not check field by field to determine whether a specific field has been altered, all fields that are on a message segment are published if any field that is on the source record is altered.
The item EIP transactions are published only for an item that has an Approved status.
Define Item
The component sends out various segments of a message depending on the function that is being performed.
Add mode with a status of Approved:
Segment
Audit Action
Comments and Data Rules
Item Master
A
Always published.
Item Detail
A
Always published.
Item UOM
A
Always published.
Update or Correction mode with an item that is saved with a new Approved status.
Because an item EIP transaction is never published until it is approved, all message segments for the item are used when approved:
Segment
Audit Action
Comments and Data Rules
Item Master
A
Always published.
Item Detail
A
Always published.
Item UOM
A
Always published.
Item Purchasing Attributes
A
Published only if any exist.
Item Bus Unit Attributes
A
Published only if any exist.
Item Bus Unit Wgt/Vol
A
Published only if any exist.
Item Revision
A
Published only if any exist.
Item Category
A
Published only if any exist.
Item Manufacturer
A
Published only if any exist.
Universal Item Identifier
A
Published only if any exist.
Update or Correction mode with a previously approved item:
Segment
Audit Action
Comments and Data Rules
Item Master
C or space
Always published.
Item Detail
C, D, or space
Published only if a field from the Inventory Item table (ITEM_INV) is modified.
Item UOM Page
The Item UOM page provides these message segments:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
Space |
Always published. |
Item UOM |
A, C, or D |
Always published. |
Item Manufacturer |
Space |
Published only if GTINs are added, changed, or deleted. |
Universal Item Identifier |
A, C, or D |
Published only if GTINs are added, changed, or deleted. |
Universal Item Identifiers Page
The Universal Item Identifiers page provides these message segments:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
Space |
Always published. |
Item Manufacturer |
Space |
Published only if GTINs are added, changed, or deleted. |
Universal Item Identifier |
A, C, or D |
Published only if GTINs are added, changed, or deleted. |
Purchasing Attributes Page
The Purchasing Attributes page provides these message segments:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
Space |
Always published. |
Item Purchasing Attributes |
A or C |
Always published. |
Define Business Unit Item Page
You can use Add or Update mode.
Add mode: When the page is saved in Add mode, all message segments for the Item EIP are published with an Audit Action Code of A.
Interfacing systems that are only taking a transaction when the item is added to the business unit use this message to build all information for the item.
Interfacing systems that take transactions before a business unit is established update their item structures with the business unit level information:
Segment
Audit Action
Comments and Data Rules
Item Master
A
Always published.
Item Detail
A
Always published.
Item UOM
A
Always published.
Item Purchasing Attributes
A
Published only if it exists.
Item Bus Unit Attributes
A
Only the business unit that is being added is published. In this situation, the relationship between the Item Master segment and the Item Bus Unit Attributes segment is always a one-to-one relationship.
Item Bus Unit Wgt/Vol
A
Published only if any exist.
Update mode:
Segment
Audit Action
Comments and Data Rules
Item Master
Space
Always published.
Item Bus Unit Attributes
C or space
Only the business unit that is being changed is published. In this situation, the relationship between the Item Master segment and the Item Bus Unit Attributes segment is always a one–to-one relationship.
Item Bus Unit Wgt/Vol
A, C, or D
Only published if the BU_ITEMS_WTVOL is modified.
Item Approval Page
Because the item EIP is never published until an item is approved, all segments for the item are published when it is approved:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
A |
Always published. |
Item Detail |
A |
Always published. |
Item UOM |
A |
Always published. |
Item Purchasing Attributes |
A |
Published only if any exist. |
Item Bus Unit Attributes |
A |
Published only if any exist. |
Item Bus Unit Wgt/Vol |
A |
Published only if any exist. |
Item Revision |
A |
Published only if any exist. |
Item Category |
A |
Published only if any exist. |
Item Manufacturer |
A |
Published only if any exist. |
Universal Item Identifier |
A |
Published only if any exist. |
Item Copy Page
The Item Copy page provides these message segments:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
A or space |
Always published. |
Item Detail |
A |
Published only if this segment is copied. |
Item UOM |
A |
Published only if this segment is copied. |
Item Purchasing Attributes |
A |
Published only if this segment is copied. |
Item Bus Unit Attributes |
A |
Published only if this segment is copied. |
Item Bus Unit Wgt/Vol |
A |
Published only if this segment is copied. |
Item Category |
A |
Published only if any exist. |
REV Maintenance
The REV Maintenance page provides these message segments:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
Space |
Always published. |
Item Bus Unit Attributes |
Space |
Always published. |
Item Bus Unit Wgt/Vol |
A, C, or D |
Always published. |
BOM Mass Maintenance by MMC and BOM Mass Maintenance by ECO
The BOM Mass Maintenance pages provide these message segments:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
Space |
Always published. |
Item Bus Unit Attributes |
Space |
Always published. |
Item Bus Unit Wgt/Vol |
A, C, or D |
Always published. |
Item Loader Process
The Item Loader process provides different message segments depending on the action that is being taken with the item.
When adding a new item with an Approved status:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
A |
Always published. |
Item Detail |
A |
Always published. |
Item UOM |
A |
Always published. |
Item Purchasing Attributes |
A |
Published only if it exists. |
Item Bus Unit Attributes |
A |
Published only if it exists. |
Item Bus Unit Wgt/Vol |
A |
Published only if it exists. |
Item Revision |
A |
Published only if it exists. |
Item Category |
A |
Published only if it exists. |
Item Manufacturer |
A |
Published only if it exists. |
Universal Item Identifier |
A |
Published only if it exists. |
When updating an existing item that has reached an Approved status:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
C or space |
Always published. |
Item Detail |
C or space |
Published only if altered on inbound message. |
Item UOM |
A, C, or space |
Published only if altered on inbound message. |
Item Purchasing Attributes |
C or space |
Published only if altered on inbound message. |
Item Bus Unit Attributes |
A, C, or space |
Published only if altered on inbound message. |
Item Bus Unit Wgt/Vol |
A, C, or space |
Published only if altered on inbound message. |
Item Revision |
A, C, or space |
Published only if altered on inbound message. |
Item Category |
A, C, or space |
Published only if altered on inbound message. |
Item Manufacturer |
A, C, or space |
Published only if altered on inbound message. |
Universal Item Identifier |
A, C, or space |
Published only if altered on inbound message. |
Full Data Publish
This function is used to copy all items in the database to an interfacing system, or if chunking is being used, to copy all items for a specific chunking value. In this case, all data is published with an audit action code of A:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
A |
Always published. |
Item Detail |
A |
Always published. |
Item UOM |
A |
Always published. |
Item Purchasing Attributes |
A |
Published only if it exists. |
Item Bus Unit Attributes |
A |
Published only if it exists. |
Item Bus Unit Wgt/Vol |
A |
Published only if it exists. |
Item Revision |
A |
Published only if it exists. |
Item Category |
A |
Published only if it exists. |
Item Manufacturer |
A |
Published only if it exists. |
Universal Item Identifier |
A |
Published only if it exists. |
If you are integrating with PeopleSoft CRM, you can use the CRM Item Sync EIPs to synchronize item data in the CRM and PeopleSoft Inventory systems. The CRM Item Sync EIPs are two service operations defined in PeopleSoft Integration Broker, ITEM_CRM_FULLSYNC_EFF and ITEM_CRM_SYNC_EFF. Use the ITEM_CRM_FULLSYNC_EFF service operation to send a list of all items in the PeopleSoft Inventory Item Master table to CRM. The PeopleSoft CRM FieldService and Call Center applications use this item information for initial population of their Item Master tables. Use the ITEM_CRM_SYNC_EFF service operation to send incremental updates automatically as item information is modified online or by the Item Loader process (IN_ITMLOAD). When you use the ITEM_CRM_SYNC_EFF service operation, you must also activate the internal ITEM_CRM_SYNC service operation. This service operation does not send data to the PeopleSoft CRM system, but it is essential for ITEM_CRM_SYNC_EFF to work properly.
When you activate the ITEM_CRM_SYNC and ITEM_CRM_SYNC_EFF service operations, outbound item information is generated from these five points within the PeopleSoft system as approved items are being maintained:
Define Item component.
Approve Item component.
Units of Measure component.
Copy Item component.
Item Loader process (IN_ITMLOAD).
Item Add component.
See PeopleSoft SCM Outbound EIPs.
See PeopleSoft CRM Integrated FieldService
See PeopleSoft CRM Call Center
Setting Up the CRM Item Sync EIPs
PeopleSoft delivers the service operations in PeopleSoft Integration Broker with a default status of Inactive. You must activate each service operation before attempting to send or receive data from a third-party source or another PeopleSoft system, such as CRM. To set up this service operation:
Setup within the PeopleSoft Inventory application:
There are no setup steps within PeopleSoft Inventory.
Setup within PeopleSoft Integration Broker and Enterprise Components:
Service Operation |
Direction and Type |
Handlers |
Chunking Available? |
Integrates With |
---|---|---|---|---|
ITEM_CRM_FULLSYNC_EFF |
Outbound Asynchronous |
No |
CRM |
|
ITEM_CRM_SYNC_EFF |
Outbound Asynchronous |
No |
CRM |
|
ITEM_CRM_SYNC |
Local Asynchronous |
ItemCRMSyncEff |
No |
CRM |
See Setting Up Service Operations.
See PeopleTools: PeopleSoft Integration Broker
Message Structure
Each service operation uses a message to define the fields and records to be used in the EIP. The structure of this item messages is:
Segment |
Parent |
Valid Relationships |
---|---|---|
Item Master |
(None) |
|
Item Detail |
Item Master |
1:1 on effective-dated messages or both 1:1 and 1:many on messages that are not effective-dated. |
Item Substitute |
Item Master |
1:0, 1:1, or 1:many. |
Item UOM |
Item Master |
1:1 or 1:many. |
UOM Type |
Item UOM |
1:1 or 1:many. |
Message Segments
The segments that are delivered in each of these item messages varies depending on the source of the message. The tables that are provided under each of the data sources that are listed display the segments that are delivered based on the function that is being performed.
The parent segment of the message is always included on the EIP transaction.
If the parent segment does not have a PSCAMA record, or if it does have a PSCAMA record with a blank audit action code, then no modifications were made to the parent segment. In this case, the parent is included only for reference purposes.
The EIP transaction is published if any fields for a source record are altered on any of the pages that are listed.
The audit action code on the PSCAMA record is set to the appropriate code based on the action that is being performed. Because all fields on the source records are not sent on the transaction, cases might exist where data is published even though none of the fields have been modified. The logic that determines whether to publish an EIP transaction only checks that the source record has been altered. It does not check field by field to determine whether the altered fields are on the message used by the EIP transaction.
Because the logic that publishes the transaction does not check field by field to determine whether a specific field has been altered, all fields that are on a message segment are published if any field on the source record is altered.
The item EIP transactions are published only for an item that has an Approved status.
Define Item
The Define Item component sends out various segments of the item message depending on the function that is being performed.
Add mode with a status of Approved:
Segment
Audit Action
Comments and Data Rules
Item Master
A
Always published.
Item Detail
A
Always published.
Item UOM
A
Always published.
UOM Type
A
Always published.
Item Substitute
A
Published only if any exist.
Update or Correction mode with an item that is saved with a new Approved status. Because an item EIP transaction is never published until it is approved, all message segments for the item are used when approved:
Segment
Audit Action
Comments and Data Rules
Item Master
A
Always published.
Item Detail
A
Always published.
Item UOM
A
Always published.
UOM Type
A
Always published.
Item Substitute
A
Published only if any exist.
Update or Correction mode with an item that was previously approved:
Segment
Audit Action
Comments and Data Rules
Item Master
C or space
Always published.
Item Detail
C, D, or space
Published only if a field from the Inventory Item table (ITEM_INV) is modified.
Item Substitute
C, D
Published only if a field from the Item Substitute table (SUBSTITUTE_ITM) is modified.
Item UOM Page
The Item UOM page provides these message segments:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
Space |
Always published. |
Item UOM |
A, C, or D |
Always published. |
UOM Type |
A, C, or D |
Always published. |
Item Approval Page
Because an item EIP transaction is never published until it is approved, all message segments for the item are used when approved:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
A |
Always published. |
Item Detail |
A |
Always published. |
Item UOM |
A |
Always published. |
UOM Type |
A |
Always published. |
Item Substitute |
A |
Published only if any exist. |
Item Copy Page
The Item Copy page provides these message segments:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
A or space |
Always published. |
Item Detail |
A |
Published only if this segment is copied. |
Item UOM |
A |
Published only if this segment is copied. |
UOM Type |
A |
Published only if this segment is copied. |
Item Substitute |
A |
Published only if any exist. |
Item Loader Process
The Item Loader process provides different message segments depending on the action that is being taken with the item:
When adding a new item in an Approved status:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
A |
Always published. |
Item Detail |
A |
Always published. |
Item UOM |
A |
Always published. |
UOM Type |
A |
Always published. |
When updating an existing item that has reached an Approved status:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
C or space |
Always published. |
Item Detail |
C or space |
Published only if altered on inbound message. |
Item UOM |
A, C, or space |
Published only if altered on inbound message. |
Full Data Publish
This function is used to copy all items in the database to an interfacing system, or if chunking is being used, to copy all items for a specific chunking value. In this case, all transactions are published with an audit action code of A:
Segment |
Audit Action |
Comments and Data Rules |
---|---|---|
Item Master |
A |
Always published. |
Item Detail |
A |
Always published. |
Item UOM |
A |
Always published. |
UOM Type |
A |
Always published. |
You can receive inbound item data by using any of the Item Master EIPs that are listed in the another topic. With the Item Price List EIP, you can receive item price list data that is sent by third-party sources using the ITEM_PRICELIST_LOAD service operation. The ITEM_PRICELIST_LOAD service operation supports requirements of the X.12 832 - Price/Sales transaction set.
Item records that are created from EIPs or flat files are inserted into the item loader staging tables for inbound processing. The Item Loader process validates the staged data, and if no errors are found, updates the database. You can correct any errors that are flagged by the Item Loader process by using the Data Definition Maintenance component.