Adapter for PeopleSoft

Requirements

For the Adapter for PeopleSoft to work correctly, you must establish an HTTP connection to PeopleSoft from Sterling B2B Integrator at run time.

How the Adapter for PeopleSoft Works

To understand how the Adapter for PeopleSoft works, you need to understand how the business processes associated with the adapter interact with the PeopleSoft system.

PeopleSoft Send Business Process (PS Send)

You can run the PeopleSoft Send (PS Send) business process manually or from a parent business process. The PS Send business process sends an HTTP post to the PeopleSoft system.

The following figure shows how the PS Send business process works:

PeopleSoft Send and Wait Business Process (PS Send and Wait)

The PeopleSoft (PS) Send and Wait business process works the same as the PS Send business process with an additional function: PS Send and Wait waits for an asynchronous notification from another business process.

The following figure shows how the PS Send and Wait business process works:

.

For information about how the PS Send and Wait business process uses Sterling B2B Integrator services to perform its work, see Implementing the PS Send and Wait Business Process.

PeopleSoft Receive Business Process (PS Receive)

The PeopleSoft Receive (PS Receive) business process uses the HTTP Server adapter and HTTP Respond service to perform its functions. PeopleSoft never communicates directly with the PeopleSoft Receive business process. The HTTP Server adapter receives the communication and passes the information to the business process. Responses to PeopleSoft, if required, are done using the HTTP Respond service.

The following figure shows how the PS Receive process works:

Upon receiving an HTTP post, the Perimeter server notifies the HTTP Server adapter, which starts the PS Receive business process. After it has started, PS Receive notifies a business process waiting for a response from PeopleSoft.

For information about how the PS Receive business process uses Sterling B2B Integrator services to perform its work, see Implementing the PS Receive Business Process.

Implementing the Adapter for PeopleSoft

Implementing the PS Send Business Process

Typing Service for PS Send

The Typing service enables Sterling B2B Integrator to determine, at run time, which translation to perform on the input document. The service determines the input document type and sets a business process parameter (map_name) indicating which map to use to translate the document.

How the Typing Service Works

The following figure shows how the Typing service works:

1. When the Typing service receives an input document, the Typing service takes the first map in the typing_maplist parameter and attempts to translate the input document using that map.
2. If the input document matches the left side of the map, the Typing service uses the Translation service classes to perform the translation defined by the map.

   If the input document does not match the left side of the map, the Typing service takes the next map in the typing_maplist parameter and attempts a translation. This process continues until a match is found and a translation occurs.

3. At translation time the following extended rule executes:

#map_name="fixed_sales_order_load"

This rule sets the map_name element value to fixed_sales_order_load in the output of the translation.

1. The Typing service searches the output of the document translation for the map_name element, which is specified in the required_parmlist parameter.
2. The Typing service takes the value of the specified element and sets a business process parameter using the name from the required_parmlist and the value found in the element. For example, param name = map_name, value = fixed_sales_order_load.

Creating a Typing Map for PS Send

To determine the input document type, the Typing service uses a Sterling B2B Integrator typing map.

Before using the PS Send business process, you must create a typing map in the Sterling B2B Integrator Map Editor for each message supported by the business process.

Configuring the Typing Service for PS Send

The following code is an example of the Typing service BPML for the PS Send business process:

		<operation name="Typing">
					<participant name="TypingService"/>
			<output message="Xout">
				<assign to="." from="*"/>
				<assign to="typing_maplist">SalesOrderLoadMapName SalesQuoteLoadMapName 
                ShippingNotificationMapName</assign>
				<assign to="required_parmlist">map_name</assign>
				<assign to="validate_input_against_dtd">yes</assign>
			</output>
			<input message="Xin">
				<assign to="." from="*"/>
			</input>
		</operation>

Translation Service for PS Send

The Translation service receives the input document from the Typing service. Using the map indicated by the map_name business process parameter, the Translation service translates an Sterling B2B Integrator-defined document to a PeopleSoft-supported message.

Typically, to use the Translation service, you would include the following rule in the BPML:

<assign to="map_name">myMapName</assign>

Because the Typing service sets the business process parameter for you, an assign rule is not needed.

Creating a Translation Map for PS Send

To translate the input document, the Translation service uses an Sterling B2B Integrator map. Before using the business process, you must create a translation map in the Sterling B2B Integrator Map Editor for each message supported by the business process. This map is created in much the same way as a typing map. For more information, see Creating a Typing Map for PS Send.

Configuring the Translation Service for PS Send

The following code is an example of the Translation service BPML for the PS Send business process.

<operation name="translate">
		<participant name="Translation"/>
		<output message="Xout">
				<assign to="." from="*"/>
		</output>
		<input message="Xin">
				<assign to="." from="*"/>
		</input> 
</operation>

HTTP Client Services and Adapter for PS Send

The HTTP Client Begin Session service initiates an HTTP session with PeopleSoft through the HTTP Client adapter. After the session is initiated, the HTTP Client POST service takes the translated document and posts it to a PeopleSoft system through HTTP. The HTTP Client End Session service closes the HTTP session.

Configuring the HTTP Client Services for PS Send

To configure the HTTP Client services for the PS Send business process:

Create configurations of the HTTP Client Begin Session service, HTTP Client POST service, and HTTP End Session service. See Creating a Service Configuration.

The following code is an example of the HTTP Client services BPML for PS Send:

<sequence name="send data">
  <operation name="HTTP Client Begin">
    <participant name="HTTPClientBeginSession"/>
   <output message="HttpClientBeginServiceInputMessage">
     <assign to="." from="PrimaryDocument"/>
     <assign to="RemoteURL">http://remote/url/to/peoplesoft</assign>
     <assign to="HTTPClientAdapter">HTTPClientAdapter</assign>
   </output>
    <input message="inmsg">
     <assign to="." from="*"/>
    </input>
 </operation>
  <operation name="HTTP Client Post">
    <participant name="HTTPClientPost"/>
   <output message="HttpClientPostServiceInputMessage">
     <assign to="." from="PrimaryDocument"/>
     <assign to="SessionToken" from="SessionToken/text()"/>
   </output>
    <input message="inmsg">
     <assign to="." from="*"/>
    </input>
 </operation>
  <operation name="HTTP Client End">
    <participant name="HTTPClientEndSession"/>
   <output message="HttpClientEndServiceInputMessage">
     <assign to="SessionToken" from="SessionToken/text()"/>
   </output>
    <input message="inmsg">
     <assign to="." from="*"/>
    </input>
 </operation>
  <onFault>
   <sequence>
      <operation name="HTTP Client End">
        <participant name="HTTPClientEndSession"/>
       <output message="HttpClientEndServiceInputMessage">
         <assign to="SessionToken" from="SessionToken/text()"/>
       </output>
        <input message="inmsg">
         <assign to="." from="*"/>
       </input>
      </operation>
   </sequence>
  </onFault> 
</sequence>

When it has been configured properly, the PS Send business process can support almost any PeopleSoft-supported XML message.

Implementing the PS Send and Wait Business Process

Typing Service for PS Send and Wait

In the PS Send and Wait business process, the Typing service selects the correct translation map and the cross-reference (XREF) cookie information to correlate incoming PeopleSoft responses with Sterling B2B Integrator requests. For example, the XREF cookie could be an invoice number or a contract number.

The Typing service extracts the XREF cookie information from the business process input document. The fields used for the XREF cookie are determined during the manual creation of the Typing map.

Configuring the Typing Service for PS Send and Wait

The following code is an example of Typing service BPML for the PS Send and Wait business process:

<operation name="Typing">
		<participant name="TypingService"/>
		<output message="Xout">
				<assign to="." from="*"/>
				<assign to="typing_maplist">SalesOrderLoad_Map_and_XREFCookie
                SalesQuoteLoad_Map_and_XREFCookie 
                ShippingNotification_Map_and_XREFCookie
    </assign>
				<assign to="required_parmlist">map_name XREFCookie</assign>
				<assign to="validate_input_against_dtd">yes</assign>
		</output>
		<input message="Xin">
				<assign to="." from="*"/>
		</input> 
</operation>

Translation Service for PS Send and Wait

For the PS Send and Wait business process, the Translation service operates in the same manner as it does for the PS Send business process. For more information, see Translation Service for PS Send.

Request Response XREF Service for PS Send and Wait

Configuring the Request Response XREF Service for PS Send and Wait

To configure the Request Response XREF service for PS Send and Wait, create the service configuration.

The following code is an example of the Request Response XREF service BPML for the PS Send and Wait process.

<operation name="Cross Reference">
	<participant name="RequestResponseXREFService"/>
		<output message="Xout">
			<assign to="." from="*"/>
		</output>
		<input message="Xin">
			<assign to="." from="*"/>
		<input> 
</operation>

HTTP Client Services and Adapter for PS Send and Wait

The HTTP Client services and adapter operate in the same manner as they do for the PS Send business process. For more information, see HTTP Client Services and Adapter for PS Send.

Consume Service for PS Send and Wait

Configuring the Consume Service for PS Send and Wait

The following code is an example of the Consume service BPML for the PS Send and Wait process:

<consume>
	<input message="anOutMsg">
		<assign to="." from="//aDocument"></assign>
	</input> 
</consume>

Implementing the PS Receive Business Process

Inflation Service for PS Receive

The incoming message sent by PeopleSoft is compressed and encoded. To process the data on the message, Sterling B2B Integrator must decode and then uncompress (inflate) the data. The Inflation service performs this action. In addition, the Inflation service contains simple typing logic to determine whether the incoming message is a ping message or a business request. The message type is used by the Decision service to handle the message appropriately.

Configuring the Inflation Service for PS Receive

No configuration is required.

The following code is an example of the Inflation service BPML for the PS Receive process:

		<operation name="Inflate incoming PS message">
					<participant name="ExampleZlibInflateService"/>
			<output message="Xout">
				<assign to="." from="*"/>
			</output>
			<input message="Xin">
				<assign to="." from="*"/>
			</input>
		</operation>

Typing Service for PS Receive

The PS Receive business process uses the Typing service to set the XREF cookie.

Setting the XREF Cookie

The Typing service sets the business process parameters for the XREF cookie. For more information, see Typing Service for PS Send and Wait.

Configuring the Typing Service for PS Receive

The following code is an example of BPML for setting the XREF cookie:

<operation name="Typing">
				<participant name="TypingService"/> 
	<output message="Xout">
					<assign to="." from="*"/>
					<assign to="typing_maplist">SalesOrderAck_XREFCookie</assign>
					<assign to="required_parmlist">XREFCookie</assign>
					<assign to="validate_input_against_dtd">yes</assign>
				</output>
				<input message="Xin">
					<assign to="." from="*"/>
				</input>
			</operation>

If an unsolicited transaction is received by the PS_Receive adapter, the Typing service fails. The BPML unencodes and decompresses the XML document and stores it as the primary document.

To handle unsolicited transactions, add an on-fault in the Respond To Message sequence. The sequence in the on-fault can further process the transaction received. For example, you could print the document out to the file system so that another business process can collect the file and start a different process.

Decision Engine Service for PS Receive

The Decision Engine service enables the PS Receive business process to react differently to each message type. The service takes the output of the Inflation service and performs actions based on the document type. If the message is a ping, the Decision Engine service directs the process flow to create a response for a ping message.

To use this service, create a rule in the BPML:

<rule name="PingRule">
  <condition>isPing="ping"</condition>
</rule>

Configuring the Decision Engine Service for PS Receive

The following code is an example of Decision service BPML for the PS Receive business process:

<choice>
			<select>
					<case ref="PingRule" activity="RespondToPing"/>
					<case ref="PingRule" negative="true" activity="RespondToMessage"/>
			</select>
			
			<sequence name="RespondToPing">
				...				
			</sequence>
			
			<sequence name="RespondToMessage">
			...	
			</sequence>
			
</choice>

Request Response DXREF Service for PS Receive

Configuring the DXREF Service for PS Receive

To configure the DXREF service, create a service configuration. See Creating a Service Configuration.

The following code is an example of the Request Response DXREF service BPML for the PS Receive business process:

<operation name="De-Cross Reference">
	<participant name="RequestResponseDXREFService"/>
	<output message="Xout">
	<assign to="." from="*"/>
	</output>
	<input message="Xin">
	<assign to="." from="*"/>
	</input> 
</operation>

Translation Service for PS Receive

The Translation service creates two types of responses to incoming messages:

Configuring the PS Receive Translation Service for Ping Reply

Configuring the PS Receive Translation Service for Business Request Reply

Produce Service for PS Receive

The Consume and Produce services facilitate communication between the PS Send and Wait and PS Receive business processes. The link created by the Request Response XREF and Request Response DXREF services enables this communication. The Produce service persists the PeopleSoft message in the database. The Produce service notifies the consuming business process associated with the business process ID received from the DXREF service. The notified business process retrieves the message from the database and continues.

Configuring the Produce Service for PS Receive

The following code is an example of Produce service BPML for the PS Receive business process:

<produce>
	<participant name="ConsumeWF"/>
	<output message="anOutMsg">
		<assign to="INVOKE_ID_LIST" from ="//PSSend_Wait/text()"/>
		<assign to="aDocument" from="//PrimaryDocument" append="true"/>
	</output> 
</produce>

HTTP Respond Service for PS Receive

Use the HTTP Respond service to send a response to the Perimeter server, which responds to PeopleSoft. The HTTP Respond service notifies the Perimeter server that the response from PeopleSoft has been processed and that it can send an acknowledgment to PeopleSoft.

Configuring the HTTP Respond Service for PS Receive

To configure the HTTP Respond service for the PS Receive process, include the service configuration provided with Sterling B2B Integrator in your business process, and set the doc-has-headers parameter to False.

The following code is an example of HTTP Respond service BPML for the PS Receive business process:

<operation name="HttpResponse">
    <participant name="HttpRespond"/>
    <output message="Xout">
         <assign to="doc-has-headers">false</assign>
         <assign to=".">from="*"/>
    </output>
    <input message="Xin">
         <assign to="." from="*"/>
    </input> 
</operation>

Timestamp Service for PeopleSoft for PS Receive

Configuring the Timestamp Service for PeopleSoft

To configure the Timestamp Service for PeopleSoft, create the service configuration. See Creating a Service Configuration. No BPML parameters are required.

The following code is an example of PS Time Stamp service BPML for the PS Receive business process:

<operation name="Insert ISO-8061 formatted TimeStamp for PeopleSoft">
	<participant name="ExamplePeopleSoftTimeStampService"/>
	<output message="Xout">
	<assign to="." from="*"/>
	</output>
	<input message="Xin">
	<assign to="." from="*"/>
	</input> 
</operation>