Defining Financial Gateway Integration Options

This chapter provides an overview of the Financial Gateway integration process and discusses how to register a source application with Financial Gateway.

Understanding the Financial Gateway Integration Process

Source applications can easily integrate with Financial Gateway to take advantage of its payment processing functionality. Financial Gateway is delivered with Cash Management 9 and can integrate with:

Treasury Management (Cash Management and Deal Management)
Receivables
Payables (Pay Cycle Manager)
eSettlements
Expenses (through Payables\Pay Cycle Manager)
Third-party applications.

For integrating with third-party applications, users can take advantage of the robust integration functionality of Financial Gateway that provides the options of using flat files, component interfaces, or PeopleSoft Integration Broker to bring payments into the system.

These are the integration methods for integrating with Financial Gateway:

Application Class

Application classes are the most efficient method for integrating data between Financial Gateway and other PeopleSoft Enterprise source applications sharing the same database. This method employs a set of objects that use message structures as parameters, and it initiates Financial Gateway processing. This method eliminates the need to set up Integration Broker to pass messages unless a Business Process Execution Language (BPEL) process server is included as part of this integration.
Integration Broker (IB)

Integration Broker can be used for non-PeopleSoft source applications that are capable of generating XML-based messages. For non-PeopleSoft source applications, the payment message structure is the same as those that are used with application classes, but Financial Gateway processes them differently. Because third-party source applications cannot call application classes, Integration Broker is used. Third-party source systems publish messages to the Integration Broker that are then routed to subscription PeopleCode. These subscription events call the same application classes that are used in the application class method. Both an application class call from a PeopleSoft source application and the execution of subscription code by a message in the Integration Broker carry out the same logic that is used to pass the message structure to Financial Gateway and trigger processing logic.

The PAYMENT_REQUEST application message is sent from the third-party application and calls the Payment Load Application Engine process (PMT_LOAD) that loads payments into the Financial Gateway system.

The PAYMENT_STATUS_REQUEST is sent from the third-party applications to request the status of a payment from Financial Gateway.

The PAYMENT_CANCEL application message is sent from the third-party application to cancel payments that have already been sent to Financial Gateway.

The PAYMENT_RESPONSE application message is sent from Financial Gateway to the third-party application in response to any of the messages described previously.

For payment acknowledgments to non-PeopleSoft source applications, the acknowledgment message is published to the Integration Broker and routed to the source application. The node name of the source application may need to be captured to specifically route messages; however, a generic publish can also be used if more than one source application exists. In such cases, all involved source applications receive every acknowledgment. Hence, the file communication method depends on the connector that is used in the Integration Broker.

All of these application messages can be synchronous or asynchronous.
Flat File

For third-party source applications that are unable to create XML messages, Financial Gateway provides the Import Flat File component, which loads flat files in either predefined, comma-separated-value (CSV) format or a fixed-length-field format.
Component Interface

Component interfaces are another alternative method for sending payments to Financial Gateway from third-party source applications that lack the ability to create XML messages. This method enables the user to write custom programs using Java or C and send payments to Financial Gateway without using flat files. Oracle/PeopleSoft provides a component interface to populate payment request staging tables and submit a PAYMENT_REQUEST IP message that calls the PaymentHandler application class to process the request.

BPEL Integration

You can set up your system to use the Business Process Execution Language (BPEL) Process Server as the primary integration point between any source system and Financial Gateway. The BPEL Process Server executes BPEL processes and stores process information that tracks the status and progress of each process instance. The BPEL Web-service-based interface along with the flexible mapping tool provide an easy way to implement customizations. The integration between the BPEL Server and Financial Gateway enables users to modify the Web service component using the BPEL Designer, thus providing a framework to customize the integration of external source systems with Financial Gateway, as well as the ability to access other Web services and manipulate the system without having to write actual code.

Note. Using a BPEL Process Server in conjunction with PeopleSoft application classes does require the defining of an Integration Broker node.

You can use the BPEL Process in conjunction with Financial Gateway to:

Load payments.
Get payment status.
Cancel payment.

To load payments, the Load Payment BPEL Process takes in a PAYMENT_REQUEST IP message and redirects it to Financial Gateway. Financial Gateway then generates the appropriate PAYMENT_RESPONSE IP message and returns it synchronously back to the BPEL Process Server. The process map then directs the response message back to the original calling application.

For obtaining a payment status from Financial Gateway, the source application initiates the Request Payment Status service by passing a GET_PAYMENT_STATUS IP message to the BPEL Process Server with either a payment ID or a key structure specified in the source registration. The process then submits the message to the Financial Gateway. Financial Gateway searches for the payment statuses for each payment that is identified in the inbound message and stores the information in the PAYMENT_RESPONSE IP message. This message is then passed back to the BPEL Process Server, which passes it back to the calling source application.

To cancel a payment, the source application sends a CANCEL_PAYMENT IP message to the BPEL Process Server and the Cancel Payment process redirects it to the Financial Gateway. The Financial Gateway processes the payment cancelation and generates a PAYMENT_RESPONSE IP message. The message is returned to the BPEL Process Server and then passed back to the calling application where the payment status is updated accordingly.

Registering a Source Application with Financial Gateway

This section provides an overview of the registration process and discusses how to register source applications that are to be integrated with Financial Gateway.

Understanding the Registration Process

To establish integration, you must first register the source applications with Financial Gateway. The registration process defines the methods and data structures that are employed to send payments from source applications to Financial Gateway and payment acknowledgments from Financial Gateway back to the source applications. Registration also defines information to be included with the payment message that is used for validating the payment, creating a unique payment ID, and determining the status of the payment during the settlement process. Integration with PeopleSoft Enterprise applications is accomplished using a delivered set of integration modules.

Page Used to Register Source Applications with Financial Gateway

Page Name	Object Name	Navigation	Usage
Source Registration	PMT_REGISTRATION	Financial Gateway, Administration, Source Registration	Register a source application by defining the high-level information that is needed to process payments using Financial Gateway.

Registering Source Applications with Financial Gateway

Access the Source Registration page.

Integration Details

The Integration Details field values are preconfigured for integration between Financial Gateway and other PeopleSoft applications. Changes should only be made for registering third-party applications.

Inbound Integration Type and Outbound Integration Type	Choose from the following options: Application Class: Select to perform integrations by calling application classes. If this value is selected, then a root package, path, and class ID are required. Integration Broker: Select to use Integration Broker to pass data between the source application and Financial Gateway. If this option is selected, a node must be defined. See Defining Integration Broker Settings for Payments. Flat File: Select this option for making or canceling payments in predefined, comma-separated value (csv) file format or a fixed-length field format from a third-party application. If this option is selected, a directory must be specified in the File Path field. None: Select if payment acknowledgment functionality is not enabled. This option is available only for outbound integration. Component Interface: Select this option for using a component interface to load transactions into Financial Gateway. This option is available only for inbound integration.
Inbound Node	Select the integration node to use if the External Publish box is selected.
Root Package ID	Enter an application-class, package name. This field appears only if Application Class is selected as an outbound integrations type. This value is delivered for integration with other PeopleSoft source applications.
Path	This field appears only if Application Class is selected as an outbound integrations type. This value is delivered for integration with other PeopleSoft source applications.
Application Class ID	This field appears only if Application Class is selected as an outbound integrations type. This value is delivered for integration with other PeopleSoft source applications.
Node Name	Select a node to be used for communication between the source application and Financial Gateway using the Integration Broker. This field appears only if Integration Broker is selected as an outbound-integrations type.
External Source	Select to enable the Execute Edit functionality that provides an additional level of data validation when you are importing payments from third-party applications.
External Publish	Select to send the PAYMENT_REQUEST message from the source application to Financial Gateway using an Integration Broker node. This field is available only if Application Class is selected as the inbound integration type. You can use this functionality to route the PAYMENT_REQUEST message to a Business Process Execution Language (BPEL) Process Server before sending it on to Financial Gateway. See Oracle BPEL Process Manager Quick Start Guide See Oracle Application Server Integration Installation Guide See Defining Integration Broker Settings for Payments. See Understanding the Payment Process in Financial Gateway.
Financial Sanctions Validation	Select to require financial sanctions validation of payees for payments from this source application before they can be loaded into Financial Gateway. See Setting Up and Using the Financial Sanctions Service.

Status Integration Details

The Status Integration Details group box enables you to select the number and types of payment statuses for determining the progress or state of each payment that is sent to a bank from a source application through Financial Gateway. This group box does not appear if None is selected as the outbound integration type. Select from the following choices:

Canceled: Identifies a payment that has been canceled. This status can be sent only in response to a request to cancel a payment by a source application.
Error: An error message can be generated and returned during any phase of the processing. If Financial Gateway cannot resolve the error, then the error message is returned to the source system to identify that the payment will not be executed without source application rework. An error message could be returned before a loaded status. Error messages consist of an error code and a description.
Flagged for Hold: The payment is being held from further processing until a manager or other approving authority gives approval to process it further.
Awaiting Dispatch: The status after the payment is successfully persisted in the Financial Gateway database. A unique ID is generated in Financial Gateway and is returned to the source application with this status.

In Process: Payment is currently in the process of being sent to the bank by the Dispatch Payment Application Engine.
Dispatched to Bank: Payment has been sent to bank. When a payment progresses to this status, it can no longer be canceled.
Received by Bank: Payment has been received by bank and is being processed.
Paid: Payment has been settled.

Payment Numbering Properties

Payment ID Prefix	Designate an alphanumeric prefix to use to identify the source application of the payment.
Last Payment Number	Represents the payment identification number of the last payment that was sent by the source application. This value is automatically updated as payments are sent to Financial Gateway.

Drill Back Details

This functionality defines how the user can drill back to the source application to view details of a payment in Financial Gateway.

Drill to Source Transaction	Choose a method for drilling back to the source application to view transaction details. Select from the following values: Component: Use to drill back to a selected PeopleSoft source component using PeopleTools Transfer functionality. Using this method enables users to drill back to the source application using links on the Review Payment page and the Dispatch Payments page for users who have security access to the destination page. DoModal Component: Also used to drill back to a selected PeopleSoft source component. When you select this option, a shared work record is populated that contains the Financial Gateway ID of the transaction. This shared work record is used with the DoModal component call. Using this method, users can click a return button in Financial Gateway to drill back to the page of origin in the source application, providing they have security access to the source application page. External URL: This option enables the user to specify an external URL to view detailed transaction information that is contained outside of the PeopleSoft system. This method launches a new browser and passes the Financial Gateway transaction ID and the key information that is specified in the Source Key Information grid as a parameter in the URL to the desired destination. None: Select this option to disable the inquiry component and the drill-to-source-application functionality.
Menu Name	Enter a valid PeopleTools object menu name. This field appears only if Component or DoModal Component is selected in the Drill to Source Transaction field.
Component Name	Enter a valid PeopleTools object component. This field appears only if Component or DoModal Component is selected in the Drill to Source Transaction field.
Open in New Window	Select to view transaction details in another Web browser when drilling back into a source application. This option is available only if External URL or Component is selected in the Drill to Source Transaction field.

Source System Key Information

Specify the metadata that is used by Financial Gateway to retrieve payment information from the source application. The retrieved payment data can be selected for display in Financial Gateway on the Review Payment Requests page and the Review Payment Details page. These field values are delivered preconfigured for PeopleSoft source applications.

Source Fieldname	Select a field from the source application that contains payment data to be displayed in Financial Gateway.
Destination Field	Select the field in the Payment Gateway records that stores the corresponding information found in the source field that is listed in the Source Fieldname field.
Include in URL	Select to include the field within the URL that is generated to pass control back to the source system. This provides the source system with navigation to the appropriate page and the appropriate content.
Field Label ID	Enter a label that is used to display the destination field.
Display in Payment Details	Select to display field values on the Review Payment Requests page and Review Payment Details page.
Seq (Sequence)	Enter numbers that specify the order in which the fields are displayed on the Payment Details page.