Setting Up Service Operations

Understanding Inbound EIPs

PeopleSoft Integration Broker can receive data from a third-party system or another PeopleSoft system, such as CRM. The inbound data can have the following data formats:

• An XML file that uses the PeopleSoft format.

  This XML file could be generated by another PeopleSoft system, generated by a third-party system in this PeopleSoft XML format, or generated by a third-party system and then converted to the PeopleSoft XML format by a middleware product. Once received by your PeopleSoft system, the inbound data is placed in the message queue, checked for errors and then moved to the inbound staging tables to be processed by the individual PeopleSoft application.

• A flat file that uses the PeopleSoft format.

  This file could be generated by a third-party system in this PeopleSoft format or generated by a third-party system and then converted to the PeopleSoft format by a middleware product. A flat file could also come from another PeopleSoft system. The PeopleSoft Integration Broker uses transforms to convert the data from a flat file to an XML file also using the PeopleSoft format. The inbound data is then placed in the message queue, checked for errors, and then moved to the inbound staging tables to be processed by the individual PeopleSoft application.

• A flat file using an EDI X.12 format.

  This file could be generated by a third-party system in this EDI X.12 flat file format or generated by a third-party system and then converted to the EDI X.12 flat file format by a middleware product. An EDI flat file could also come from another PeopleSoft system. Once received by your PeopleSoft system, the PeopleSoft Integration Broker uses transforms to convert the data from a flat file to an XML file and then from EDI X.12 format to the PeopleSoft format. The inbound PeopleSoft-formatted XML data is then placed in the message queue, checked for errors, and then moved to the inbound staging tables to be processed by the individual PeopleSoft application.

• An XML file using an EDI X.12 format.

  This file could be generated by a third-party system in this EDI X.12 XML format or generated by a third-party system and then converted to the EDI X.12 XML format by a middleware product. An EDI XML file could also come from another PeopleSoft system. Once received by your PeopleSoft system, the PeopleSoft Integration Broker uses transforms to convert the data from EDI X.12 format to the PeopleSoft format. The inbound PeopleSoft-formatted XML data is then placed in the message queue, checked for errors, and then moved to the inbound staging tables to be processed by the individual PeopleSoft application.

Understanding Outbound EIPs

PeopleSoft Integration Broker can send data to a third-party system or another PeopleSoft system, such as CRM using the following data formats:

• An XML file that uses the PeopleSoft format.

  PeopleSoft can generate a PeopleSoft-formatted XML file to be received by another PeopleSoft system, such as CRM, or a third-party system with or without conversion by a middleware product.

• A flat file that uses the PeopleSoft format.

  PeopleSoft can generate a PeopleSoft-formatted XML file that is converted, by PeopleSoft Integration Broker, into a PeopleSoft-formatted flat file. This flat file can be received by a third-party system or processed by a middleware product and then received by a third-party system.

• A flat file using an EDI X.12 format.

  PeopleSoft can generate a PeopleSoft-formatted XML file that is converted, by PeopleSoft Integration Broker, using two transforms (Application Engine programs). The data is first converted into the EDI X.12 format and then from XML to flat file format.

• An XML file using an EDI X.12 format.

  You do not have to use a flat file for EDI formatted data. As delivered, the PeopleSoft Integration Broker converts the PeopleSoft-formatted XML data into a EDI X.12 formatted flat file using transform programs; first by converting to an EDI XML format and then to a flat file format. However, you can change the system to output EDI X.12 data in an XML format by removing the second transform program.

Setup Within PeopleSoft Integration Broker

To activate a service operation, complete the following steps in PeopleSoft Integration Broker:

1. Activate the service operation.

   On the General tab of the Service Operations component, 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.

2. For asynchronous service operations only, verify the queue is running.

   On the General tab of the Service Operations component, select the View Queue link at the bottom of the page. On the Queue Definitions page, verify the Queue Status field has a value of Run.

3. Activate the service operation handlers.

   Note: This step does not apply to all service operations.

   On the Handlers tab of the Service Operations component, select the value of Active in the Status field for all needed handlers.

   • For inbound asynchronous service operations, activate the OnNotify handler.

   • For inbound synchronous service operations, activate the OnRequest handler.

   • If you are using chunking on an outbound service operation, activate the OnRoute handler.

4. Activate the service operation routings.

   On the Routings tab of the Service Operations component, activate a routing definition for each node that will send or receive data. To activate a routing, select the check box next to the routing definition and click the Activate Selected Routings button.

   • Activate an inbound routing to receive data into PeopleSoft SCM.

   • Activate an outbound routing for sending data to a third-party system or another PeopleSoft product, such as CRM.

   • Activate a local routing for sending data using an effective-dated outbound service operation.

   • Activate a local routing to receive inbound flat files.

   • You must activate at least one routing if the data is being sent in an XML format.

   • You can skip this step if a batch publish rule is set up to post to a flat file only.

5. Verify the routing definition 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:

   • 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.

   • Add or verify 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. Many pre-defined routings are delivered with transform programs. You must decide, based on your unique situation, to change, remove, and add transform programs. For example, some delivered transform programs convert data to the EDI format, if you are not using EDI then you will want to use a different routing definition or remove that transform program from the routing definition.

6. Verify the node from the routing is active.

   Go to the Node Definitions page and verify the Active Node check box has been selected for any sender or receiver nodes used in the routings that you activated on your Service Operations-Routings page.

7. For an outbound service operation, verify the node or routing is connected to the correct network.

8. For inbound service operations using a flat file, define the inbound file rule and run control parameters:

   • For X.12 formatted EDI files, use the Inbound File Loader Rules page and the Inbound File Processing run control under the Integration Broker menu.

   • For PeopleSoft formatted files, use the File Inbound page and the Inbound File run control under the Enterprise Components menu.

Setup Within PeopleSoft Enterprise Components

To activate chunking, inbound file rules, batch publish rules, or full publish rules for a service operation, complete the following steps in PeopleSoft Enterprise Components:

• Setup the publish utility.

  If the outbound EIP is sending (publishing) data using the publish utility, setup full or batch data publishing.

  The full publish utility automates the process of copying the contents of an entire table into another database or third-party system. You can use the utility to synchronize data between systems. The publishing rules include pages for full table publishing rules, batch publishing rules, record mapping, languages, and batch programs.

  Setup for full or batch data publishing using the Full Data Publish Rules component or the Batch Publish Rules component. On both of these components, the Message Name field is the service operation. Complete the following tasks:

  1. Activate the rule by selecting the value of Active for the Status field.

  2. Specify the desired output (XML-based message or flat file).

  3. If you want to use chunking select a Chunking Rule ID. The outbound data will be sent to the nodes specified by the chunking rule.

  If you have more than one publish rule defined for a service operation, you should activate a rule for each batch program. For example, item status change, Item Revisions, and Item Loader each have unique rules for the ITEM_SYNC service operation, so three rules must be activated for ITEM_SYNC.

• For outbound asynchronous service operations using chunking, activate and configure the appropriate chunk rule mapping definitions. For instance, use the BusUnit Mapping component (EO_CHUNKBU) to configure the BUSINESS_UNIT chunk rule.

  See Setting Up Chunking.

• Setup the inbound file rules in order to used the inbound file publish utility.

  When external systems send flat files, use the inbound file publish utility to translate the incoming data into transactions that are acceptable to your PeopleSoft system. Use the Inbound File Rules page to define the file, file layout, service operation, and other parameters to accept the inbound file.