Appendix: Scenarios for Integration With PeopleSoft Supply Chain Management

This appendix discusses real-life scenarios for using PeopleSoft EIPs. We provide an overview discussion of EIP examples and discuss how to:

• Set up the Sales Order Load EIP.

• Process the Sales Order Load EIP.

• Set up the Sales Orders Acknowledgement EIP.

• Process the Sales Orders Acknowledgement EIP.

• Set up the Purchase Order Dispatch EIP.

• Process the Purchase Order Dispatch EIP.

• Set up the Advanced Shipping Notice EIP.

• Process the Advanced Shipping Notice EIP.

• Set up the Billing Invoice EIP.

• Process the Billing Invoice EIP.

Understanding This Appendix

We are providing examples of the most commonly used SCM EIPs. EIP setup and processing is similar for EIPs of the same design pattern, so you can use this information and apply it to other EIPs. In this appendix, we discuss setting up and processing the following EIPs:

• Sales Order Load

• Sales Order Acknowledgement

• Purchase Order Dispatch

• Advanced Shipment Notice

• Billing Invoice

See Setting Up Service Operations.

See PeopleSoft SCM Inbound EIPs.

See PeopleSoft SCM Outbound EIPs.

Note. The real-life scenarios described within this PeopleBook may not conform to the business rules and procedures within your organization. These scenarios should not be construed as consulting or implementation advise for your specific industry or your individual organization. The information here should be adapted or even disregarded based on the needs of your organization. PeopleSoft does not guarantee that the information included here will work as intended within your customized environment.

Common Elements in this Appendix

Example: Setting Up the Sales Order Load EIP

This section discusses the Sales Order Load EIP.

Understanding the Sales Order Load EIP

The Sales Order Load EIP is an asynchronous inbound service operation used to load sales orders from a third-party into PeopleSoft Order Management. The Sales Order Load EIP meets EDI requirements of the X.12 850 transaction set.

Before you can receive sales orders using with the Sales Order Load EIP, you must:

Page Used to Set Up the Sales Order Load EIP

Activating the Sales Order Load Service Operations

Use the PeopleSoft Integration Broker to activate the SALES_ORDER_LOAD service operations.

Access the Service Operations-General page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General).

For the SALES_ORDER_LOAD service operation, select the Active check box for the applicable service operation version. If the desired version is not the default version for the service operation, the default version must also be activated.

If the inbound sales order data is a flat file using the EDI format X.12 850, then you must activate the EDI_TXN_850 service operation in addition to the SALES_ORDER_LOAD service operation.

On the General tab of the Service Operations component, select the View Queue link at the bottom of the page to access the Queue Definitions page.

See Also

Enterprise PeopleTools PeopleBook: Integration Broker

Verifying the Queue is in Run Mode

Access the Queue Definitions page (PeopleTools, Integration Broker, Integration Setup, Queues).

For the SALES_ORDER_LOAD queue, verify the Queue Status field has a value of Run.

Click the Return button to go back to the Service Operations component.

Activating the Handler

Access the Service Operations-Handlers page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Handlers).

For the SALES_ORDER_LOAD service operation, click the Handlers tab of the Service Operations component. Select the value of Active in the Status field for the SalesOrderLoad handler.

Activating the Routings

Access the Service Operations-Routings page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Routings).

For the SALES_ORDER_LOAD service operation, click the Routings tab of the Service Operations component. Activate an inbound routing definition for each sender node and external alias name that will be permitted to send in sales order data. In this example, both delivered routings permit data to be sent from any valid node, but each routing has a unique external alias and purpose. To activate a routing, select the check box next to the routing definition and click the Activate Selected Routings button. There are two delivered routing definitions:

• The SALES_ORDER_LOAD routing definition is used to receive inbound sales order data using an XML format.

• The SALES_ORDER_LOAD_EDI_850 routing definition is used to receive inbound sales order data using the EDI X.12 850 transaction format and transform the data to the standard PeopleSoft format for sales orders.

Select the link attached to the routing definition name to access the Routings component and confirm the routing definition parameters.

Confirming the Parameters of the Routing Definition

Access the Routings-Parameters page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Routings. Select the link attached to the routing definition name, then select the Parameters tab).

On the Routings tab of the Service Operations component, select the link attached to the routing definition name. This link accesses the Routing Definitions component. Select the Parameters tab and complete the following steps:

1. Confirm the external alias name in the External Alias field for the routing is correct. When sending or receiving data, the Integration Broker determines which routing to use by referring to the external alias name, not the routing name.

2. Add or change the transform programs on this routing definition. A routing definition defines the sending and receiving nodes for a transaction and specifies any inbound and outbound transformations to invoke. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another; for example, from XML to a flat file. Use a transform program when one node sends a request or response message with a data structure different from the structure required by the other node. You must decide, based on your environment, to change, remove, or add transform programs. The SALES_ORDER_LOAD_EDI_850 routing definition is delivered with the transform program, EDI_850_I, to convert incoming data from the EDI X.12 850 transaction format to the standard PeopleSoft format for sales orders. If you are not using EDI then you will want to use the SALES_ORDER_LOAD routing definition instead.

Verifying the Node is Active

Access the Node Definitions page (PeopleTools, Integration Broker, Integration Setup, Nodes, Node Definitions).

Verify the Active Node check box has been selected for any nodes used in the routings that you activated on the Service Operations-Routings page for SALES_ORDER_LOAD service operation. If the routings are from "ANY" node, verify each node you plan to integrate from is active.

Setting the Inbound File Rule for EDI Flat File Data

Access the Inbound File Loader Rules page (PeopleTools, Integration Broker, File Utilities, Inbound File Loader Rules).

For inbound flat file data using the EDI X.12 850 format, configure and activate the inbound file loader rule within PeopleSoft Integration Broker.

See Also

Enterprise PeopleTools PeopleBook: Integration Broker, "Using the Inbound File Loader Utility"

Setting the Inbound File Rule for Non-EDI Flat File Data

Access the File Inbound page (Enterprise Components, Integration Definitions, Inbound File Rule).

For inbound flat files that are not using the EDI X.12 850 format, configure and activate the inbound file rule within the PeopleSoft Enterprise Components menu.

1. Adding the Definition Name of SALES_ORDER, and Message Name of SALES_ORDER_LOAD.

2. Confirming that the Status field is set to Active.

Note. If the file identified in the Inbound File field is an index file, as shown in the page shot above, then the index file lists the names of a set of data files to be processed. Each line of the index file must reference a plain text file using a file name with full directory path information. The wildcards * and ? may be used only in the file name and not in the directory path.

See Also

PeopleSoft Enterprise Components for PeopleSoft Enterprise Financial Management Solutions, Enterprise Service Automation, Asset Lifecycle Management, and Supply Chain Management 9.1 PeopleBook

Example: Processing the Sales Order Load EIP

This section discusses how you process inbound sales orders.

Pages Used to Process Sales Orders Load EIP

Loading EDI Flat File Data

Access the Inbound File Processing page (PeopleTools, Integration Broker, File Utilities, Inbound File Processing).

For inbound flat file data using the EDI X.12 850 format, use the Inbound File Processing run control page to launch the Application Engine process PTIB_INFILE that initiates the file-to-message processing. The file-to-message processing function reads the file and publishes it as a message.

See Also

Enterprise PeopleTools PeopleBook: Integration Broker, "Using the Inbound File Loader Utility"

Loading Non-EDI Flat File Data

Access the Inbound File process page (Enterprise Components, Integration Definitions, Initiate Processes, Inbound File Publish).

For inbound flat file data not using the EDI format, use the Inbound File run control page to launch an Application Engine process that initiates the file-to-message processing. The file-to-message processing function reads the file and publishes it as a message.

See Also

PeopleSoft Enterprise Components for PeopleSoft Enterprise Financial Management Solutions, Enterprise Service Automation, Asset Lifecycle Management, and Supply Chain Management 9.1 PeopleBook

Running Electronic Commerce

Access the Run Electronic Commerce page (Order Management, Electronic Commerce, Process Staged Orders/RFQs).

The Electronic Commerce process (OM_EC) is part of the overall inbound electronic commerce flow and is the process that takes sales orders that are loaded in the staging tables and validates the fields that are on the record to insure that the values are correct. The process performs these steps:

• Edits the data, such as customer numbers and units of measure, to ensure that they are valid.

• Converts the customer's product or item number to a PeopleSoft product identifier, when a PeopleSoft product identifier is not provided.

• Assigns PeopleSoft order numbers.

• Sets system defaults and status flags.

• Validates data changes to ensure that they are valid.

• Loads data into the production order tables (order staging data that is found to have errors is not loaded into the production tables until the errors are resolved).

See Also

Running Electronic Commerce for Inbound Sales Orders and Quote EIPs

Correcting Errors

Access the Data Definition Maintenance page (SCM Integrations, Transaction Error Handling, Maintain Data Definitions).

Use the Data Definition Maintenance page to view the status of the transaction. Select a Transaction Type of PO. Enter a business Unit. Click the Search button.

Click the Details icon to access the Error Summary page where you can view and correct errors.

Navigate to the Header, Line, Schedule, Addresses, Notes, or User Defined References to fix errors.

See Also

Using Sales Order and Quotation Enterprise Integration Points

Using Data Definition Maintenance

Completing the Orders

Access the Order Completion page (Order Management, Quotes and Orders, Process Orders, Order Completion).

The Order Completion/Repricing process (OM_BACKGRND) completes processing for sales orders that are entered into PeopleSoft Order Management by several methods, including flat file and XML messages. Completing this process enables you to access the orders from the Order Entry Form component.

Enter the selection criteria, and click Run.

See Also

Running Order Completion/Repricing

Example: Setting Up the Sales Order Acknowledgement EIP

This section discusses the Sales Order Acknowledgement EIP.

Understanding the Sales Order Acknowledgment EIP

The Sales Order Acknowledgement EIP is an asynchronous outbound service operation to send an acknowledgement to your customers that a sales order has been received. The data from this service operation is passed to a third-party system or to PeopleSoft CRM. The Sales Order Acknowledgement EIP meets EDI requirements of the X.12 855 transaction set.

Before you can send order acknowledgements with the Sales Order Acknowledgement EIP, you must:

See Also

Setting Up Service Operations

Integrating With a Third-Party Point-of-Use Supplier System

Integrating With a Third-Party Surgical Resource Software Application

Pages Used to Set Up the Sales Order Acknowledgement EIP

Verifying Contacts

Access the Contact page (Customers, Contact Information) using the Customer ID in the correct history mode.

You must ensure that the customer you are interacting with has a contact set up to accept EDI transmissions, and that the contact is a ship to contact.

Access the Contact Customer page using the Contact Customer Information link on the Contact page.

Select the Primary Ship To check box to receive the proper shipping notifications.

Under the Documentation link, make sure the Document Code is ACKN (order acknowledgement), and Preferred Communication is XML & Print or XML Only.

See Also

Maintaining Contacts

Activating the Sales Order Acknowledgement Service Operation

Use the PeopleSoft Integration Broker to activate the Sales Order Acknowledgement service operation.

Access the Service Operations-General page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General).

For the SALES_ORDER_ACKNOWLEDGEMENT service operation, select the Active check box for the applicable service operation version. If the desired version is not the default version for the service operation, the default version must also be activated.

On the General tab of the Service Operations component, select the View Queue link at the bottom of the page to access the Queue Definitions page.

Service Operation Versions

The Default Service Operation Version group box displays the most current version of this service operation. If there have been changes to the PeopleSoft application that have required the service operation to change, for example new fields or tables, then the Non-Default Versions group box displays any older versions of the service operation based on the older release of the PeopleSoft application. The default version is always the current version, however you can use a non-default version to communicate with third-party systems that want to receive the data based on an old version. Select the link in the Non-Default Versions box to access the Service Operation Version page. This page contains information about the non-default version, including message and queue. In addition, the Logical Transforms group box contains transforms to convert the data to or from the default version. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another. Based on your environment, you will review and possibly change these transforms.

See Also

Enterprise PeopleTools PeopleBook: Integration Broker

Verifying the Queue is in Run Mode

Access the Queue Definitions page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General. Select the Queue link attached to this service operation).

For the SALES_ORDER_ACKNOWLEDGEMENT queue, verify the Queue Status field has a value of Run.

Click the Return button to go back to the Service Operations component.

Activating the Handler

Access the Service Operations-Handlers page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Handlers).

For the SALES_ORDER_ACKNOWLEDGEMENT service operation, click the Handlers tab of the Service Operations component. If you want to use chunking, select the value of Active in the Status field for the OnRoute handler.

Activating the Routings

Access the Service Operations-Routings page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Routings).

For the SALES_ORDER_ACKNOWLEDGEMENT service operation, click the Routings tab of the Service Operations component. Activate an outbound routing definition for each receiver node and external alias name that data will be sent to. To activate a routing, select the check box next to the routing definition and click the Activate Selected Routings button. The following routing definitions are predefined:

• The SALES_ORDER_ACKNOWLEDG_EDI_855 routing definition sends outbound sales order acknowledgements using the EDI X.12 855 format as a flat file. The data is converted from the PeopleSoft standard XML format to the EDI X.12 855 transaction format and then from XML to a flat file. If you wish to send the data as an XML file using the EDI X.12 855 format, then alter the routing definition to remove the second transform program.

• The SALES_ORDER_ACKNOWLEDGEMENT_CR routing definition sends outbound sales order acknowledgements using the PeopleSoft standard XML format to PeopleSoft CRM.

• The SALES_ORDER_ACKNOWLEDGEMENT_V1 routing definition sends outbound sales order acknowledgements using the PeopleSoft standard XML format and converts the data from the current service operation version (version 2) to an older version (version 1) of the service operation. This routing definition is used when you are sending data to a third-party system that is still using an older version of the service operation.

• The SALES_ORDER_ACKNOWLEDGEMENT_V2 routing definition sends outbound sales order acknowledgements using the PeopleSoft standard XML format. This routing definition is used when you are sending data to a third-party system that is using the current version of the service operation.

Note. You do not need to select a routing definition if the batch publish rule is set up to post to a flat file only.

Confirming the Parameters of the Routing Definition

Access the Routings-Parameters page (PeopleTools, Integration Broker, Integration Setup, Routings, Parameters).

On the Routings tab of the Service Operations component, select the link attached to the routing definition name. This link accesses the Routing Definitions component. Select the Parameters tab and complete the following steps:

1. Confirm the external alias name in the External Alias field for the routing is correct. When sending or receiving data, the Integration Broker determines which routing to use by referring to the external alias name, not the routing name.

2. Verify or change the transform programs on this routing definition. A routing definition defines the sending and receiving nodes for a transaction and specifies any inbound and outbound transformations to invoke. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another; for example, from XML to a flat file. Use a transform program when one node sends a request or response message with a data structure different from the structure required by the other node. You must decide, based on your environment, to change, remove, or add transform programs. The SALES_ORDER_ACKNOWLEDG_EDI_855 routing definition is delivered with two transform programs. The EDI_855_O transform program converts outbound sales order acknowledgements from the standard PeopleSoft XML format to the EDI X.12 855 transaction format (still in XML). The XML_TO_FILE transform program converts the EDI X.12 855 formatted data from XML to a flat file format. You can remove the XML_TO_FILE transform program to send your data in the XML EDI X.12 855 format. If you are not using EDI then you will want to use the SALES_ORDER_ACKNOWLEDGEMENT_V2 routing definition instead.

   The transform program, to convert data from the current version of a service operation to an older version, is located on the Service Operation Version page of the non-default version. Select the non-default version on the Service Operations-General page to access the Service Operation Version page.

Verifying the Node is Active

Access the Node Definitions page (PeopleTools, Integration Broker, Integration Setup, Nodes, Node Definitions).

Verify the Active Node check box has been selected for any nodes used in the routings that you activated on the Service Operations-Routings page for SALES_ORDER_ACKNOWLEDGEMENT service operation.

Verifying the Node is Connected to the Network

Access the Nodes-Connectors page (PeopleTools, Integration Broker, Integration Setup, Nodes, Connectors).

For an outbound service operation, verify the node or routing is connected to the correct network using the Gateway ID and Connector ID fields. Depending on the file output location, you may need a password. If a password is needed, you should use the password encryption utility on this page.

Note. Your database administrator will need to assist you with this setup.

Activate the Batch Publish Rule

Access the Batch Publish Rules page (Enterprise Components, Integration Definitions, Batch Publish Rules).

For the SALES_ORDER_ACKNOWLEDGEMENT message name (service operation):

1. Select Active Status to activate this publish rule definition.

2. Select the appropriate Output Format. The PeopleSoft Application Engine program can create either an Extensible Markup Language (XML) message that flows through PeopleSoft Integration Broker architecture or a flat file generated on the PeopleSoft Process Scheduler server and not published elsewhere.

3. If you want to use message chunking, configure a chunking rule and then enter it in the Chunking Rule ID field.

Setting Up Chunking for the Batch Publish Rule

Access the Customer ID Chunk page (SCM Integrations, Chunking Rule, CustID to Node Mapping).

If using chunking for the batch publish rule, set up the chunking rule mapping definitions. You can use a delivered chunking rule or create a new chunking rule.

If using the CUSTOMER_ID chunking rule ID, access the Customer ID Chunk page.

Select the node for each customer that receives electronic data.

Chunking is only needed if you have requirements to break up the outbound data and send them to different destinations based on attributes in the message such as business unit or customer ID. For example, use chunking to send a single customer's messages to a specific node setup for that trading partner. If you are using a middleware product to actually determine trading partner destinations then a single transaction with all trading partner transactions can usually be sent directly to the middleware product. You would not need to activate message chunking in this situation.

See Also

Setting Up Chunking

Example: Processing the Sales Order Acknowledgement EIP

This section discusses processing the Sales Order Acknowledgement EIP.

Pages Used to Process the Sales Order Acknowledgement EIPs

Publishing Outbound Sales Order Acknowledgement Messages

Access the Publish Outbound Message page (SCM Integrations, Publish Outbound Message).

Click the Sales Order Acknowledgement check box, and click the Sales Order Acknowledgement link to access the Order Acknowledgement Message Selection Criteria page.

For technical details about individual EIPs, use the Interactive Services Repository (ISR) in the My Oracle Support website located at https://support.oracle.com/CSP/ui/flash.html.

Example: Setting Up the Purchase Order Dispatch EIP

This section discusses setting up the Purchase Order Dispatch EIP.

Understanding the Purchase Order Dispatch EIP

The Purchase Order Dispatch EIP is an outbound asynchronous service operation to send purchase orders and purchase order change requests (change orders) to vendors. If enabled, the system generates a Purchase Order Dispatch EIP transaction when you run the Publish Outbound Message process. This message also supports flat-file processing. You can specify whether to send purchase orders based on business unit or vendor.

Before you can publish messages with the Purchase Order Dispatch EIP, you must:

Pages Used to Set Up the Purchase Order Dispatch EIP

Setting the Purchase Order Dispatch Method

Access the PO Header Details page (Purchasing, Purchase Orders, Add/Update POs).

Select the Dispatch check box to ensure that the system dispatches the PO. Also, select a dispatch Method of EDX.

See Also

Creating Purchase Orders Online

Activating the Purchase Order Dispatch Service Operation

Use the PeopleSoft Integration Broker to activate the Purchase Order Dispatch service operation.

Access the Service Operations-General page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General).

For the PURCHASE_ORDER_DISPATCH service operation, select the Active check box for the applicable service operation version. If the desired version is not the default version for the service operation, the default version must also be activated.

On the General tab of the Service Operations component, select the View Queue link at the bottom of the page to access the Queue Definitions page.

Service Operation Versions

The Default Service Operation Version group box displays the most current version of this service operation. If there have been changes to the PeopleSoft application that have required the service operation to change, for example new fields or tables, then the Non-Default Versions group box displays any older versions of the service operation based on the older release of the PeopleSoft application. The default version is always the current version, however you can use a non-default version to communicate with third-party systems that want to receive the data based on an old version. Select the link in the Non-Default Versions box to access the Service Operation Version page. This page contains information about the non-default version, including message and queue. In addition, the Logical Transforms group box contains transforms to convert the data to or from the default version. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another. Based on your environment, you will review and possibly change these transforms.

See Also

Enterprise PeopleTools PeopleBook: Integration Broker

Verifying the Queue is in Run Mode

Access the Queue Definitions page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General. Select the Queue link attached to this service operation).

For the PURCHASE_ORDER queue, verify the Queue Status field has a value of Run.

Click the Return button to go back to the Service Operations component.

Activating the Handler

Access the Service Operations-Handlers page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Handlers).

For the PURCHASE_ORDER_DISPATCH service operation, click the Handlers tab of the Service Operations component. If you are using chunking, select the value of Active in the Status field for the OnRoute handler.

Activating the Routings

Access the Service Operations-Routings page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Routings).

For the PURCHASE_ORDER_DISPATCH service operation, click the Routings tab of the Service Operations component. Activate an outbound routing definition for each receiver node and external alias name that data will be sent to. To activate a routing, select the check box next to the routing definition and click the Activate Selected Routings button. The following routing definitions are predefined:

• The PURCHASE_ORDER_DISPATCH routing definition sends outbound purchase orders using the PeopleSoft standard XML format. This routing definition is used when you are sending data to a third-party system that is using the current version of the service operation.

• The PURCHASE_ORDER_DISPATCH_V1 routing definition sends outbound purchase orders using the PeopleSoft standard XML format and converts the data from the current service operation version (version 2) to an older version (version 1) of the service operation. This routing definition is used when you are sending data to a third-party system that is still using an older version of the service operation.

Note. You do not need to select a routing definition if the batch publish rule is set up to post to a flat file only.

Confirming the Parameters of the Routing Definition

Access the Routings-Parameters page (PeopleTools, Integration Broker, Integration Setup, Routings, Parameters).

On the Routings tab of the Service Operations component, select the link attached to the routing definition name. This link accesses the Routing Definitions component. Select the Parameters tab and complete the following steps:

1. Confirm the external alias name in the External Alias field for the routing is correct. When sending or receiving data, the Integration Broker determines which routing to use by referring to the external alias name, not the routing name.

2. Verify or change the transform programs on this routing definition. A routing definition defines the sending and receiving nodes for a transaction and specifies any inbound and outbound transformations to invoke. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another; for example, from XML to a flat file. Use a transform program when one node sends a request or response message with a data structure different from the structure required by the other node. You must decide, based on your environment, to change, remove, or add transform programs.

   The transform program, to convert data from the current version of a service operation to an older version, is located on the Service Operation Version page of the non-default version. Select the non-default version on the Service Operations-General page to access the Service Operation Version page.

Verifying the Node is Active

Access the Node Definitions page (PeopleTools, Integration Broker, Integration Setup, Nodes, Node Definitions).

Verify the Active Node check box has been selected for any nodes used in the routings that you activated on the Service Operations-Routings page for PURCHASE_ORDER_DISPATCH service operation.

Verifying the Node is Connected to the Network

Access the Nodes-Connectors page (PeopleTools, Integration Broker, Integration Setup, Nodes, Connectors).

For an outbound service operation, verify the node or routing is connected to the correct network using the Gateway ID and Connector ID fields. Depending on the file output location, you may need a password. If a password is needed, you should use the password encryption utility on this page.

Note. Your database administrator will need to assist you with this setup.

Activate the Batch Publish Rule

Access the Batch Publish Rules page (Enterprise Components, Integration Definitions, Batch Publish Rules).

For the PURCHASE_ORDER_DISPATCH message name (service operation):

1. Select Active Status to activate this publish rule definition.

2. Select the appropriate Output Format. The PeopleSoft Application Engine program can create either an Extensible Markup Language (XML) message that flows through PeopleSoft Integration Broker architecture or a flat file generated on the PeopleSoft Process Scheduler server and not published elsewhere.

3. If you want to use message chunking, configure the chunking rule and then enter it in the Chunking Rule ID field.

Setting Up Chunking for the Batch Publish Rule

Access the Setup Vendor to Node page (SCM Integrations, Chunking Rule, Manage ChunkRule Vendor ID Map).

If using chunking for the batch publish rule, set up the chunking rule mapping definitions. You can use a delivered chunking rule or create a new chunking rule.

If using the VENDOR_ID chunking rule ID, access the Setup Vendor to Node page. If using the BUSINESS_UNIT chunking rule ID, access the BusUnit Mapping page.

Select the node for each vendor that receives electronic data.

Chunking is only needed if you have requirements to break up the outbound data and send them to different destinations based on attributes in the message such as business unit or vendor ID. For example, use chunking to send a single vendor's messages to a specific node setup for that trading partner. If you are using a middleware product to actually determine trading partner destinations then a single transaction with all trading partner transactions can usually be sent directly to the middleware product. You would not need to activate message chunking in this situation.

See Also

Setting Up Chunking

Example: Processing the Purchase Order Dispatch EIP

This section discusses processing the purchase order dispatch EIP.

See Also

Creating Purchase Orders Online

Dispatching and Printing Purchase Orders

Pages Used to Process the Purchase Order EIP

Dispatching Purchase Orders

Access the Dispatch Purchase Orders process page (Purchasing, Purchase Orders, Dispatch POs).

Ensure that the PO to be dispatched is included in your selection criteria. Click Run to stage POs for dispatch.

Publishing Outbound Purchase Order Messages

Access the Publish Outbound Message page (SCM Integrations, Publish Outbound Message).

Click the Purchase Order Dispatch check box, and click the Purchase Order Dispatch link to access the Purchase Order Dispatch page.

1. Select BU or Vendor as a Selection Type.

2. If you select BU, the BU Sel Type fields are enabled, and you can select All BUs or a 1 Bus Unit. If you select Vendor, the Vendor Selection Type fields are enabled, and you can select 1 Vendor or All Vendor.

For technical details about individual EIPs, use the Interactive Services Repository (ISR) in the My Oracle Support website located at https://support.oracle.com/CSP/ui/flash.html.

Example: Setting Up the Advanced Shipping Notice EIP

This section discusses the Advanced Shipping Notice EIP.

Understanding the Advanced Shipping Notice EIP

The Advanced Shipping Notice (ASN) EIP is an asynchronous outbound service operation to notify your customers that a sales order has been shipped. The data from this service operation is passed to an external system or to the PeopleSoft CRM Field Service and CRM Order Capture applications. The Advanced Shipping Notice EIP meets EDI requirements of the X.12 856−Shipping Notice/Manifest transaction set, and is also used with warehouse management systems. An ASN transaction is generated when a sales order entered from PeopleSoft Order Management has been depleted in PeopleSoft Inventory. You can specify whether to generate the ASN for all sales order shipments in the business unit, sales orders belonging to a specific shipping ID, sales orders for a specific sold to customer, or sales orders for a specific ship to customer.

Before you can publish messages with the Advanced Shipment Notice EIP, you must:

See Also

Creating Advanced Shipping Notices

Integrating With a Third-Party Point-of-Use Supplier System

Integrating With a Third-Party Surgical Resource Software Application

Pages Used to Set Up the Advanced Shipping Notice EIP

Enabling the Inventory Business Unit

You must enable ASN generation in the business unit shipping the items.

Access the Inventory Definition - Business Unit Options page (Set Up Financials/Supply Chain, Business Unit Related, Inventory, Inventory Definition, Inventory Options).

Select the Use Advanced Shipment Notice check box in the External Interfaces group box.

See Also

Defining PeopleSoft Inventory Business Unit Attributes

Verifying Contacts

You must ensure that the customer you are interacting with has a contact set up to accept EDI transmissions, and that the contact is a ship to contact.

Access the Contact page (Customers, Contact Information) using the Customer ID in the correct history mode.

Access the Contact Customer page using the Contact Customer Information link on the Contact page.

Select the Primary Ship To check box to receive the proper shipping notifications.

Click the Documentation link corresponding to the appropriate customer to access the Contact Additional Info page.

Under the Documentation group box, make sure the Document Code is ASN (advanced shipping notification), and Preferred Communication is XML & Print or XML Only.

See Also

Entering Contact Credit Card Information

Activating the ASN Service Operation

Use the PeopleSoft Integration Broker to activate the Advanced Shipping Notice service operation.

Access the Service Operations-General page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General).

For the ADVANCED_SHIPPING_NOTICE service operation, select the Active check box for the applicable service operation version. If the desired version is not the default version for the service operation, the default version must also be activated.

On the General tab of the Service Operations component, select the View Queue link at the bottom of the page to access the Queue Definitions page.

Service Operation Versions

The Default Service Operation Version group box displays the most current version of this service operation. If there have been changes to the PeopleSoft application that have required the service operation to change, for example new fields or tables, then the Non-Default Versions group box displays any older versions of the service operation based on the older release of the PeopleSoft application. The default version is always the current version, however you can use a non-default version to communicate with third-party systems that want to receive the data based on an old version. Select the link in the Non-Default Versions box to access the Service Operation Version page. This page contains information about the non-default version, including message and queue. In addition, the Logical Transforms group box contains transforms to convert the data to or from the default version. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another. Based on your environment, you will review and possibly change these transforms.

See Also

PeopleTools 8.50 PeopleBook: PeopleSoft Integration Broker

Verifying the Queue is in Run Mode

Access the Queue Definitions page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General. Select the Queue link attached to this service operation).

For the ADVANCED_SHIPPING_NOTICE queue, verify the Queue Status field has a value of Run.

Click the Return button to go back to the Service Operations component.

Activating the Handler

Access the Service Operations-Handlers page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Handlers).

For the ADVANCED_SHIPPING_NOTICE service operation, click the Handlers tab of the Service Operations component. If you are using chunking, select the value of Active in the Status field for the OnRoute handler.

Activating the Routings

Access the Service Operations-Routings page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Routings).

For the ADVANCED_SHIPPING_NOTICE service operation, click the Routings tab of the Service Operations component. Activate an outbound routing definition for each receiver node and external alias name that data will be sent to. To activate a routing, select the check box next to the routing definition and click the Activate Selected Routings button. The following routing definitions are predefined:

• The ADVANCED_SHIPPING_NOTI_EDI_856 routing definition sends outbound shipping notices using the EDI X.12 856 format as a flat file. The data is converted from the PeopleSoft standard XML format to the EDI X.12 856 transaction format and then from XML to a flat file. If you wish to send the data as an XML file using the EDI X.12 856 format, then alter the routing definition to remove the second transform program.

• The ADVANCED_SHIPPING_NOTICE routing definition sends outbound shipping notices using the PeopleSoft standard XML format. This routing definition is used when you are sending data to a third-party system that is using the current version of the service operation.

• The ADVANCED_SHIPPING_NOTICE_CR routing definition sends outbound shipping notices using the PeopleSoft standard XML format to PeopleSoft CRM.

• The ADVANCED_SHIPPING_NOTICE_V1 routing definition sends outbound shipping notices using the PeopleSoft standard XML format and converts the data from the current service operation version (version 2) to an older version (version 1) of the service operation. This routing definition is used when you are sending data to a third-party system that is still using an older version of the service operation.

Note. You do not need to select a routing definition if the batch publish rule is set up to post to a flat file only.

Confirming the Parameters of the Routing Definition

Access the Routings-Parameters page (PeopleTools, Integration Broker, Integration Setup, Routings, Parameters).

On the Routings tab of the Service Operations component, select the link attached to the routing definition name. This link accesses the Routing Definitions component. Select the Parameters tab and complete the following steps:

1. Confirm the external alias name in the External Alias field for the routing is correct. When sending or receiving data, the Integration Broker determines which routing to use by referring to the external alias name, not the routing name.

2. Verify or change the transform programs on this routing definition. A routing definition defines the sending and receiving nodes for a transaction and specifies any inbound and outbound transformations to invoke. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another; for example, from XML to a flat file. Use a transform program when one node sends a request or response message with a data structure different from the structure required by the other node. You must decide, based on your environment, to change, remove, or add transform programs. The ADVANCED_SHIPPING_NOTI_EDI_856 routing definition is delivered with two transform programs. The EDI_856_O transform program converts outbound shipping notices from the standard PeopleSoft XML format to the EDI X.12 856 transaction format (still in XML). The XML_TO_FILE transform program converts the EDI X.12 856 formatted data from XML to a flat file format. You can remove the XML_TO_FILE transform program to send your data in the XML EDI X.12 856 format. If you are not using EDI then you will want to use the ADVANCED_SHIPPING_NOTICE routing definition instead.

   The transform program, to convert data from the current version of a service operation to an older version, is located on the Service Operation Version page of the non-default version. Select the non-default version on the Service Operations-General page to access the Service Operation Version page.

Verifying the Node is Active

Access the Node Definitions page (PeopleTools, Integration Broker, Integration Setup, Nodes, Node Definitions).

Verify the Active Node check box has been selected for any nodes used in the routings that you activated on the Service Operations-Routings page for ADVANCED_SHIPPING_NOTICE service operation.

Verifying the Node is Connected to the Network

Access the Nodes-Connectors page (PeopleTools, Integration Broker, Integration Setup, Nodes, Connectors).

For an outbound service operation, verify the node or routing is connected to the correct network using the Gateway ID and Connector ID fields. Depending on the file output location, you may need a password. If a password is needed, you should use the password encryption utility on this page.

Note. Your database administrator will need to assist you with this setup.

Activate the Batch Publish Rule

Access the Batch Publish Rules page (Enterprise Components, Integration Definitions, Batch Publish Rules).

For the ADVANCED_SHIPPING_NOTICE message name (service operation):

1. Select Active Status to activate this publish rule definition.

2. Select the appropriate Output Format. The PeopleSoft Application Engine program can create either an Extensible Markup Language (XML) message that flows through PeopleSoft Integration Broker architecture or a flat file generated on the PeopleSoft Process Scheduler server and not published elsewhere. If you are sending data to a PeopleSoft system, select Message as your format.

3. If you want to use message chunking, configure a chunking rule and then enter it in the Chunking Rule ID field.

Setting Up Chunking for the Batch Publish Rule

Access the Customer ID Chunk page (SCM Integrations, Chunking Rule, CustID to Node Mapping).

If using chunking for the batch publish rule, set up the chunking rule mapping definitions. You can use a delivered chunking rule or create a new chunking rule.

If using the CUSTOMER_ID chunking rule ID, access the Customer ID Chunk page.

Select the node for each customer that receives electronic data.

Chunking is only needed if you have requirements to break up the outbound data and send them to different destinations based on attributes in the message such as business unit or customer ID. The most common use of chunking with the ASN message is to send a single customer's messages to a specific node setup for that trading partner. If you are using a middleware product to actually determine trading partner destinations then a single transaction with all trading partner transactions can usually be sent directly to the middleware product. You would not need to activate message chunking in this situation.

See Also

Setting Up Chunking

Example: Processing the Advanced Shipping Notice EIP

This sections discusses processing the Advanced Shipping Notice EIP.

Pages Used to Process the Advanced Shipping Notice EIP

Publishing Advanced Shipping Notices

Access the Publish Outbound Message page (SCM Integrations, Publish Outbound Message).

Click the Advanced Shipping Notices check box, and click the Advanced Shipping Notices link to access the Advanced Shipping Notices Selection Criteria page.

All Shipments	Select to generate this transaction for all sales order shipments that have been through the Depletion process (INPDDEPL), but have not previously generated an ASN.
Sold To Customer	Select to generate this transaction for a sales order with a specific sold to customer.
Ship To Customer	Select to generate this transaction for a sales order with a specific ship to customer.
Specific Shipping ID	Select to generate this transaction for sales orders with a specific shipping ID.
Source Bus Unit	Select a valid source business unit. A source business unit is the PeopleSoft Order Management business unit that created the sales order. This field is required if you elect in the Selection Options group box to generate this transaction for a specific sold to or ship to customer. This field is not available for entry if you elect in the Selection Options group box to generate this transaction for all shipments, or for a specific shipping ID.
Sold To Customer	Select a valid sold to customer. This field is only available for entry and is required if you elect in the Selection Options group box to generate this transaction for a specific sold to customer.
Ship To Customer	Select a valid ship to customer. This field is only available for entry and is required if you elect in the Selection Options group box to generate this transaction for a specific ship to customer.
Shipping ID	Select a valid shipping ID. This field is only available for entry and is required if you elect in the Selection Options group box to generate this transaction for a specific shipping ID.
Re-Generate Message	Select this option to regenerate a message for data that have already been sent out.

Note. When you navigate to the process monitor and wait till the process completes successfully, you can click the Details link and then the View Log/Trace link. This shows the output file as a link. The system generates the flat file to reflect the ASN information for the corresponding shipping ID.

Data Separation

PeopleSoft Inventory creates a single occurrence of an ASN transaction for each combination of business unit, source business unit, sold to customer, ship to customer, shipping ID, carrier ID, and ship via. The transaction also lists the ASN creation date and time, the source business unit's address, the vehicle ID, the quantity ordered, the shipping weight, and, if defined, the shipping container ID and container type.

PeopleSoft sends the generated transaction to the ship to customer, the sold to customer, or both.

Example: Setting Up the Billing Invoice EIP

This section discusses the Billing Invoice EIP.

Understanding the Billing Invoice EIP

The Billing Invoice Notice EIP is an asynchronous outbound service operation to send invoices to your customers. The data from this service operation is passed to an external system. The Billing Invoice Notice EIP meets EDI requirements of the X.12 810 transaction set. The transaction is generated when you run the Finalize Bills process (BIIVC000); this populates the BI_HDR_EC table with the outbound invoice data. Once the data is in BI_HDR_EC, the outbound publish process can create the outbound message or flat file.

Before you can send invoices with the Billing Invoice EIP, you must:

See Also

Entering Contact Credit Card Information

Pages Used to Process Billing Invoices

Verifying Contacts

You must ensure that the customer you are interacting with has a contact set up to accept EDI transmissions, and that the contact is a ship to contact.

Access the Contact page (Customers, Contact Information) using the Customer ID in the correct history mode.

Access the Contact Customer page using the Contact Customer Information link on the Contact page.

Click the Primary Bill To check box to receive the proper invoice notifications.

Click the Documentation link corresponding to the appropriate customer to access the Documentation page.

Under the Documentation group box, make sure the Document Code is INVC (invoice), and Preferred Communication is XML & Print or XML only.

See Also

Entering Contact Credit Card Information

Activating the Billing Invoice Notice Service Operation

Use the PeopleSoft Integration Broker to activate the Billing Invoice Notice service operation.

Access the Service Operations-General page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General).

For the BILLING_INVOICE_NOTICE service operation, select the Active check box for the applicable service operation version. If the desired version is not the default version for the service operation, the default version must also be activated.

On the General tab of the Service Operations component, select the View Queue link at the bottom of the page to access the Queue Definitions page.

Service Operation Versions

The Default Service Operation Version group box displays the most current version of this service operation. If there have been changes to the PeopleSoft application that have required the service operation to change, for example new fields or tables, then the Non-Default Versions group box displays any older versions of the service operation based on the older release of the PeopleSoft application. The default version is always the current version, however you can use a non-default version to communicate with third-party systems that want to receive the data based on an old version. Select the link in the Non-Default Versions box to access the Service Operation Version page. This page contains information about the non-default version, including message and queue. In addition, the Logical Transforms group box contains transforms to convert the data to or from the default version. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another. Based on your environment, you will review and possibly change these transforms.

See Also

Enterprise PeopleTools PeopleBook: Integration Broker

Verifying the Queue is in Run Mode

Access the Queue Definitions page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General. Select the Queue link attached to this service operation).

For the BILLING_INVOICE queue, verify the Queue Status field has a value of Run.

Click the Return button to go back to the Service Operations component.

Activating the Handler

Access the Service Operations-Handlers page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Handlers).

For the BILLING_INVOICE_NOTICE service operation, click the Handlers tab of the Service Operations component. If you want to use chunking, select the value of Active in the Status field for the OnRoute handler.

Activating the Routings

Access the Service Operations-Routings page (PeopleTools, Integration Broker, Integration Setup, Service Operations, Routings).

For the BILLING_INVOICE_NOTICE service operation, click the Routings tab of the Service Operations component. Activate an outbound routing definition for each receiver node and external alias name that data will be sent to. To activate a routing, select the check box next to the routing definition and click the Activate Selected Routings button. The following routing definitions are predefined:

• The BILLING_INVOICE_NOTICE_EDI_810 routing definition sends outbound invoices using the EDI X.12 810 format as a flat file. The data is converted from the PeopleSoft standard XML format to the EDI X.12 810 transaction format (still in XML) and then from XML to a flat file. If you wish to send the data as an XML file using the EDI X.12 810 format, then alter the routing definition to remove the second transform program.

• The BILLING_INVOICE_NOTICE_V3 routing definition sends outbound invoices using the PeopleSoft standard XML format and converts the data from the current service operation version (version 4) to an older version (version 3) of the service operation. This routing definition is used when you are sending data to a third-party system that is still using an older version of the service operation.

• The BILLING_INVOICE_NOTICE_V4 routing definition sends outbound invoices using the PeopleSoft standard XML format. This routing definition is used when you are sending data to a third-party system that is using the current version of the service operation.

Note. You do not need to select a routing definition if the batch publish rule is set up to post to a flat file only.

Confirming the Parameters of the Routing Definition

Access the Routings-Parameters page (PeopleTools, Integration Broker, Integration Setup, Routings, Parameters).

On the Routings tab of the Service Operations component, select the link attached to the routing definition name. This link accesses the Routing Definitions component. Select the Parameters tab and complete the following steps:

1. Confirm the external alias name in the External Alias field for the routing is correct. When sending or receiving data, the Integration Broker determines which routing to use by referring to the external alias name, not the routing name.

2. Verify or change the transform programs on this routing definition. A routing definition defines the sending and receiving nodes for a transaction and specifies any inbound and outbound transformations to invoke. A transform program is a type of PeopleSoft Application Engine program that can convert data from one format to another; for example, from XML to a flat file. Use a transform program when one node sends a request or response message with a data structure different from the structure required by the other node. You must decide, based on your environment, to change, remove, or add transform programs. The BILLING_INVOICE_NOTICE_EDI_810 routing definition is delivered with two transform programs. The EDI_810_O transform program converts outbound invoice data from the standard PeopleSoft XML format to the EDI X.12 810 transaction format (still in XML). The XML_TO_FILE transform program converts the EDI X.12 810 formatted data from XML to a flat file format. You can remove the XML_TO_FILE transform program to send your data in the XML EDI X.12 810 format. If you are not using EDI then you will want to use the BILLING_INVOICE_NOTICE_V4 routing definition instead.

   The transform program to convert data from the current version of a service operation to an older version is located on the Service Operation Version page of the non-default version. Select the non-default version on the Service Operations-General page to access the Service Operation Version page.

Verifying the Node is Active

Access the Node Definitions page (PeopleTools, Integration Broker, Integration Setup, Nodes, Node Definitions).

Verify the Active Node check box has been selected for any nodes used in the routings that you activated on the Service Operations-Routings page for BILLING_INVOICE_NOTICE service operation.

Verifying the Node is Connected to the Network

Access the Nodes-Connectors page (PeopleTools, Integration Broker, Integration Setup, Nodes, Connectors).

For an outbound service operation, verify the node or routing is connected to the correct network using the Gateway ID and Connector ID fields. Depending on the file output location, you may need a password. If a password is needed, you should use the password encryption utility on this page.

Note. Your database administrator will need to assist you with this setup.

Activating the Batch Publish Rule

Access the Batch Publish Rules page (Enterprise Components, Integration Definitions, Batch Publish Rules).

For the BILLING_INVOICE_NOTICE message name (service operation):

1. Select Active Status to activate this publish rule definition for this message.

2. Select the appropriate Output Format.

   The PeopleSoft Application Engine program can create either an Extensible Markup Language (XML) message that flows through PeopleSoft Integration Broker or a flat file generated on the PeopleSoft Process Scheduler server and not published elsewhere.

3. If you want to use message chunking, configure a chunking rule and then enter it in the Chunking Rule ID field.

Setting Up Chunking for the Batch Publish Rule

Access the Customer ID Chunk page (SCM Integrations, Chunking Rule, CustID to Node Mapping).

If using chunking for the batch publish rule, set up the chunking rule mapping definitions. You can use a delivered chunking rule or create a new chunking rule.

The BI_CUSTOMER_ID chunking rule ID is delivered as an optional chunking rule for the Billing Invoice Notice batch publish rule. To use this chunking rule, access the Customer ID Chunk page.

Select the node for each customer that receives electronic invoice notifications.

Chunking is only needed if you have requirements to break up the outbound data and send them to different destinations based on attributes in the message such as business unit or customer ID. For example, use chunking to send a single customer's messages to a specific node setup for that trading partner. If you are using a middleware product to actually determine trading partner destinations then a single transaction with all trading partner transactions can usually be sent directly to the middleware product. You would not need to activate message chunking in this situation.

See Also

Setting Up Chunking

Publishing Billing Invoices

This section discusses how to publish billing invoices.

See Also

Processing EDI Transactions in PeopleSoft Billing

Pages Used to Process the Billing Invoice EIP

Publishing Billing Invoices

Access the Publish Outbound Message page (SCM Integrations, Publish Outbound Message).

Select the Billing Invoice Notice check box, and click the Billing Invoice Notice link to access the Billing Invoice Notice Message Selection Criteria page.

Enter a Request ID, Description, and Business Unit.

For technical details about individual EIPs, use the Interactive Services Repository (ISR) in the My Oracle Support website located at https://support.oracle.com/CSP/ui/flash.html.

See Also

Processing EDI Transactions in PeopleSoft Billing