Setting Up PeopleSoft Integration Broker for Bank Statements, Payments, and Payment Acknowledgements
This topic discusses how to set up PeopleSoft Integration Broker for bank statements, payments, and payment acknowledgements. For more information, refer to the product documentation for PeopleTools: Integration Broker and PeopleTools: Integration Broker Administration.
|
Page Name |
Definition Name |
Usage |
|---|---|---|
|
Service Operations - General Page |
IB_SERVICE |
Define and activate a service operation. |
|
Service Operations - Handlers Page |
IB_SERVICEHDLR |
Activate one or more service operation handlers. |
|
Service Operations - Routings Page |
IB_SERVICERTNGS |
Define and activate routing definitions on the service operation. |
|
Queue Definitions Page |
IB_QUEUEDEFN |
Activate the queue used by the service operation. |
|
Routings - Parameters Page |
IB_ROUTINGDEFNDOC |
Verify the external service alias names used by this routing. |
|
Node Definitions Page |
IB_NODE |
Activate node used by the service operation. |
|
Nodes - Connectors Page |
IB_NODECONN |
For an outbound service operation, verify the node is connected to the correct network. |
|
Full Data Publish Rules Page |
EO_MSGPUBFULL |
Activate the full data publish rule for the service operations using the full data publish rules. |
|
Batch Publish Rules Page |
EO_MSGPUBATCH |
Activate the batch publish rule for the service operations using the batch publish utility. |
|
File Inbound Page |
EO_FILE_INBOUND |
Define the parameters to receive inbound flat files from third-party systems. |
PeopleSoft Integration Broker is delivered with many integration points to send and receive data with a third-party system. These integration points are implemented using service operations. 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.
The service operations for PeopleSoft Cash Management’s Financial Gateway include:
|
Service Operation |
Description |
Direction and Type |
Handlers |
|---|---|---|---|
|
BANK STATEMENT FILE |
Receives non-XML or unstructured bank statements into the Financial Gateway. |
Inbound Asynchronous |
ProcessFile |
|
CANCEL PAYMENT |
Sends request from the third-party source to Financial Gateway to cancel a payment. Sends message synchronously. |
Inbound Synchronous |
REQUESTHDLR |
|
LOAD PAYMENT |
Receives payments into the Financial Gateway. |
Inbound Synchronous |
REQUESTHDLR |
|
REQUEST PAYMENT STATUS |
Sends request from the third-party source for the status of a payment ID. The Financial Gateway responds with the payment status. |
Inbound Synchronous |
REQUESTHDLR |
|
PAYMENT_RESPONSE_OUT_ASYNC |
Financial Gateway sends a response message asynchronously for the incoming payment request. |
Outbound Asynchronous Note: The PMT_RESPONSE message is published only when the Outbound Integration Type is Integration Broker on the Source Registration page. |
(none) |
|
PMT_ACKNOWLEDGE |
Sends a payment acknowledgement status that the payment was received. |
Outbound Asynchronous |
(none) |
|
PAYMENT ACKNOWLEDGE FILE |
Sends an unstructured acknowledgement from PeopleSoft that the payment was received. |
Inbound Asynchronous |
ProcessFile |
|
PAYMENT CANCEL |
Sends request from the third-party source to Financial Gateway to cancel a payment. Sends message asynchronously. |
Inbound Asynchronous |
ProcessCancel |
|
PAYMENT_REQUEST |
Sends a payment status request from the source asynchronously. |
Inbound Asynchronous |
ProcessPayments |
|
PMT FLAT FILE |
Sends a payment message from the Financial Gateway using a flat file structure. |
Outbound Asynchronous |
(none) |
|
PMT FLAT FILE INBOUND |
Sends a payment message to the Financial Gateway using a flat file structure. |
Inbound Asynchronous |
ProcessFile |
Setting Up Service Operations
To activate a service operation, complete the following steps in PeopleSoft Integration Broker:
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.
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.
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.
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 Financial Gateway.
Activate an outbound routing for sending data to a third-party system or another PeopleSoft product.
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 are 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.
Verify the routing definition parameters.
On the Routings page 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 predefined 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.
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. Financial Gateway communicates with the third-party bank using an Integration Broker node with a specified connector. The Integration Broker contains a set of communication connectors that will provide connectivity with most banks. The most common connectors used are the FTP, FTPs, AS2, HTTP, HTTPS, FILE, and JMS.
For an outbound service operation, verify the node or routing is connected to the correct network.
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.
Note: For complete information on the setup and use of service operations, see the product documentation for PeopleTools: Integration Broker your PeopleTools release.
Use the Node Definitions page (IB_NODE) to activate node used by the service operation.
Navigation:
This example illustrates the fields and controls on the Node Definitions page.
Payment files can be sent to the Integration Broker for communication with your bank. The Integration Broker contains a set of communication connectors that will provide connectivity with most banks. The most common connectors used are the FTP, FTPs, AS2, HTTP, HTTPS, FILE, and JMS.
The Bank Integration Layouts component enables you to specify an output type for payment files. If you select Integration Broker, then a node must be entered. At runtime, the payment will be asynchronously published to this node in the Integration Broker. Integration Broker then provides the communication functionality.
Before you begin enabling Integration Broker service operations, you must set up the basic Integration Broker settings, such as Gateway, and application server with service operations enabled, domain active, channels active, messages active, and so on.
Define the settings to process payment files through PeopleSoft Integration Broker using an output-type service operation.
Create a node definition that represents the bank on the Node Definitions page.
Activate a corresponding outbound, asynchronous service operation routing for the node definition on the Service Operations - Routings page.
PeopleSoft delivers the PMT_FLAT_FILE service operation for the delivered layouts. Both the layouts and the corresponding service operation are configured to be published to the Integration Broker. To implement payment processing functionality, select the PMT_FLAT_FILE service operation.
Complete the Nodes - Connectors page.
Define connector properties information at the node or node transaction level on the Connectors page.
Integration Broker comes with a variety of connectors that can be used. The primary connector for use with banks is the FTPTARGET connector. This enables you to send files using FTP and FTPs to your bank.
If you use Integration Broker with the FTP connector ID FTPTARGET and leave the FILENAME parameter blank, the PMT_DISPATCH process will override this property and generate a unique filename for each message using the Bank Integration Layout properties FILENAME and FILEEXT to generate this value.
Some banks, however, require all files to be sent under the same filename. Therefore, define the connector property FILENAME with a value to ensure that all files are delivered to the bank with the same filename.
Note: You can configure your Integration Broker node to use an AS2 connector.
See the product documentation for PeopleTools: Integration Broker and PeopleTools: Integration Broker Administration.
Use the Integration Broker - Connectors page (IB_NODECONN) to for an outbound service operation, verify the node is connected to the correct network.
Navigation:
This example illustrates the fields and controls on the Integration Broker - Connectors page. You can find definitions for the fields and controls later on this page.
Note: This section describes how to set up an Integration Broker node for importing bank statement files and payment acknowledgment files from an FTP server. Files can also be imported from a bank using a file server—a method that neither employs Integration Broker nor requires setting up an Integration Broker node.
To set up an Integration Broker node for importing files from an FTP server:
Create a new node, name it, and enter a description for the node.
Leave the default values for all the other fields.
On the Connectors page, select FTPTARGET in the Connector ID field.
The appropriate properties for the FTP Target connector are displayed.
Enter the appropriate property values:
Field or Control
Description
FTPS
A yes (Y) or no (N) value. Determines whether the target FTP server requires a secured FTP connection or not.
HOSTNAME
The host name of the FTP server. For example, for the URL ftp://www.hostname.com, the host name would be www.hostname.com.
METHOD
The FTP method that is being used. Enter either PUT or GET. The system will always use GET when importing a bank statement regardless of which value is entered in this field.
PASSWORD
The password that corresponds to the USERNAME value to access the FTP server. This value must be encrypted. To obtain an encrypted version of the password, use the Password Encryption Utility at the bottom of the page.
TYPE
The type of files that are to be transferred—ASCII or BINARY.
USERNAME
The user name that is used to access the FTP server.
Send Uncompressed
A yes (Y) or no (N) value. Determines whether to send files compressed or not.
Note: The system uses values that are defined on the Bank Statement Import page to automatically override two node connector properties, DIRECTORY and FILENAME.
Note: You can configure your Integration Broker node to use an AS2 connector.
See the product documentation for PeopleTools: Integration Broker and PeopleTools: Integration Broker Administration.