Setting Up Common Components for Bank Statement, Payment, and Payment Acknowledgment Processing
To define event code notification, use the Enter Event Code Definition component (TR_EVENT_CD_DEF_GBL).
This topic discusses how to set up components that are used to import bank statements, dispatch payments, and import bank acknowledgments.
Page Name |
Definition Name |
Usage |
---|---|---|
PMT_FORMAT_CATLOG |
Create new or modify existing bank statement, payment, and payment acknowledgment layouts by defining transformation processing details, payment methods, parameters, and properties. |
|
Allowable Format Properties Page |
PMT_FORMAT_VALUES |
Select the type of list option to apply as the allowed format property. See the Layout Catalog Page for more information. |
TR_CODE_MAPPINGS |
Define input and output values for mappings of a selected code map group. |
|
TR_EVENT_CD_DEF_PG |
Enter codes for system events, and define actions for the system to perform when they occur. |
|
Encryption Profile Page |
ENCRYPTION_PRFL |
Define encryption standards to be used to protect data when communicating with banks. Determine algorithms and store public and private keys that are used in encryption. For complete instructions on setup and configuration, see PeopleTools: Security Administration. |
These application pages are common to setting up the three electronic banking processes:
Layout Catalog
The Layout Catalog is a repository of information that is used for establishing how data should be formatted when processing bank statements, payments, and payment acknowledgements.
Code Mappings
For Bank Statement Import processing, you map external bank codes to their internal PeopleSoft equivalents to ensure efficient statement processing.
For Dispatch Payment processing, the Code Mappings page is used to associate PeopleSoft input code values with external bank output code values.
(Optional) Event Code Definition
You can setup events that can occur during Bank Statement Import and Dispatch Payment processing so that interested parties will be notified by email of those events.
(Optional) Encryption Profile
You can use encryption algorithms to secure statement and payment files that are sent between your organization and your bank.
The Layout Catalog is the central repository for information regarding all supported bank payment, payment acknowledgment, and bank statement layouts. After a layout is added to this component, it is available for use within the system. The component contains all the information about a layout—such as the transformation Application Engine program or Application Class that contains the logic to process the layout—that the system needs at setup and runtime. This component can be configured to meet each bank's specific formatting needs.
Note: PeopleSoft also provides additional miscellaneous layouts in the layout catalog that are used for importing various kinds of data.
See Layout Catalog Page.
Delivered Payment Layouts
You can view these layouts by accessing the Layout Catalog page (
).PeopleSoft delivers these bank payment layouts:
Layout ID |
Layout Name |
Supported Payment Method |
---|---|---|
820 |
EDI 820 payment layout |
Wire Transfer (WIR) |
820 ACH |
EDI 820 payment layout for ACH |
Automated Clearing House (ACH) Direct Debit (DD) |
CCD |
NACHA CCD payment layout |
ACH DD |
CCD+ |
NACHA CCD+ payment layout |
ACH DD |
CTX |
NACHA CTX payment layout |
ACH DD |
DEU_INTL |
German International EFT (Used with BI Publisher template) |
Electronic Funds Transfer (EFT) |
DEU_DOM |
German Domestic Payments (Used with BI Publisher template) |
WIR |
DIRDEB |
Edifact version 96A payment layout |
DD |
ESP_EFT |
Spanish EFT payment (Used with BI Publisher template) |
EFT |
FRA_EFT |
French EFT payment format. (Used with BI Publisher template) |
EFT |
FUNDTRNFR |
Funds Transfer |
WIR |
IAT |
NACHA IAT payment format |
ACH DD |
ISO_CT_03 |
ISO 20022 Credit Transfer V3, Pain.001.001.03 This layout is used for generic credit transfers. |
ACH EFT WIR |
ISO_CT_05 |
ISO 20022 Credit Transfer V5, Pain.001.001.05 This layout is used to dispatch payments electronically as XML messages. |
ACH EFT WIR |
ISO_DD_02 |
ISO Direct Debit Pain.008.001.02 This layout is used for generic direct debits. |
DD |
ISOV2 |
ISO 20022 Credit Transfer V2, Pain.001.001.02 This layout is used for generic credit transfers. |
ACH EFT WIR |
ISOV2_DD |
ISO 20022 Direct Debit Pain.008.001.01 This layout is used for generic direct debits. |
DD |
JPN_ZENGIN |
Japanese Zengin Format (Used with BI Publisher template) |
EFT |
MT101 |
SWIFT MT101 payment layout |
WIR EFT |
MT103 |
SWIFT MT103 payment layout |
WIR EFT |
MT103 BULK |
Multi 103 payment layout |
WIR EFT |
NLD_INTL |
Netherlands International EFT (Used with BI Publisher template) |
EFT |
PAYMENTEIP |
PeopleSoft XML layout, PAYMENT_DISPATCH IP Message |
ACH DD WIR EFT |
PAYMUL |
Edifact Version 96A payment layout |
EFT |
CORECRDTRN |
ISO 20022 Payment Initiation |
WIR |
PPD |
NACHA PPD Payment Format |
ACH DD |
SEPA_CT |
SEPA Credit Transfer, Pain.001.001.02 |
ACH EFT WIR |
SEPA_CT_03 |
SEPA Credit Transfer V3, Pain.001.001.03 Adheres to Rulebook version 6.0. |
ACH EFT WIR |
SEPA_CT_CH |
SEPA Credit Transfer, Pain.001.001.03.ch.02 |
ACH EFT WIR |
SEPA_DD |
SEPA Direct Debit, Pain.008.001.01 |
DD |
SEPA_DD_02 |
SEPA Direct Debit V2, Pain.008.001.02 Adheres to Rulebook version 6.0. |
DD |
SEPA_DD_2B |
SEPA Direct Debit B2B, Pain.008.001.02 (Business to Business Version) |
DD |
STPCREDTRN |
ISO 20022 STP Credit Transfer |
WIR |
Note: Application-specific requirements may use slightly different versions of the above formats.
Delivered system-defined payment layout properties:
Layout ID |
Layout Name |
Description |
---|---|---|
ISO_CNCL |
ISO Payment Cancellation Layout |
This layout is defined with document type Payment Cancellation and is used to send payment cancellation request to the bank. It is associated with corresponding payment layout through layout property. |
ISO_RVSL |
ISO Payment Reversal |
This layout is defined with document type Payment Reversal and is used to send payment reversal request to the bank. It is associated with corresponding payment layout through layout property. |
ISO_RVS_2 |
ISO Payment Reversal |
This layout is defined with document type Payment Reversal and is used to send payment reversal request to the bank. It is associated with corresponding payment layout through layout property. |
SEPA_RVSL |
Payment Reversal |
This layout is defined with document type Payment Reversal and is used to send payment reversal request to the bank. It is associated with corresponding payment layout through layout property. |
SEPA_RVS_2 |
Payment Reversal - Pain 007.001.02 |
This layout is defined with document type Payment Reversal and is used to send payment reversal request to the bank. It is associated with corresponding payment layout through layout property. |
Delivered Bank Statement Layouts
You can view these layouts by accessing the Layout Catalog page (
).PeopleSoft delivers these bank statement layouts:
Layout ID |
Layout Name |
Document Type |
---|---|---|
BAI2 |
BAI2 bank statement layout |
Bank Statement |
EDI822 |
EDI 822 account analysis |
Bank Statement |
FINSTA |
FINSTA bank statement layout |
Bank Statement |
PSBD1 |
PeopleSoft Business Document version 1 |
Bank Statement |
PSBD2 |
PeopleSoft Business Document version 2 |
Bank Statement (for PeopleSoft FMS 8.8 and later - see note) |
MT940 |
SWIFT MT940 bank statement layout |
Bank Statement |
MT942 |
SWIFT MT942 bank statement layout |
Bank Statement |
Note: You can import bank-statement, data files using the PSBD2 layout if you have Cash Management 8.8 or a later version installed and are using a third-party communication toolkit that has the capability of processing files in XML format. Sample files that can be used as guidelines for transforming bank statement date files into the PSBD2 layout can be found on Oracle's My Oracle Support website.
Delivered Bank Payment Acknowledgment Layouts
You can view these layouts by accessing the Layout Catalog page (
).PeopleSoft delivers these Payment Acknowledgment layouts:
Layout ID |
Layout Name |
Document Type |
---|---|---|
ACHNOC |
ACH Notification of Change |
Payment Return (notification that the payment contains errors) |
ACHRETURN |
NACHA acknowledgment |
Payment Return (payment or prenotification error – statement of changes to be made before payments can be processed) |
BANSTA |
Edifact Version 96A Acknowledgment layout |
Payment Acknowledgment (bank payment acknowledgment) |
CONTRL |
Edifact Version 96A Acknowledgment layout |
Payment Acknowledgment (bank payment file acknowledgment) |
EDI997/824 |
EDI X12 997/824 |
Payment Acknowledgment (payment validated and payment complete) |
EDI 827 |
EDI Functional return layout |
Functional Return (payment error – statement of changes to be made before payment is allowed) |
PMTACKEIP |
PeopleSoft Acknowledgment layout |
Payment Acknowledgment |
PMTINITACK |
ISO 20022 payment status XML |
Payment Acknowledgment |
PMT_STATV2 |
ISO 20022 payment status V2, Pain.002.001.002 |
Payment Acknowledgment |
PMT_STATV3 |
ISO 20022 payment status V3, Pain.002.001.003 |
Payment Acknowledgment |
PAYREQEIP |
Inbound Payment Request |
PeopleSoft Inbound Payment layout in CSV or fixed-length, flat-file format. |
Delivered Miscellaneous Layouts
You can view these layouts by accessing the Layout Catalog page (Banking, Administer Bank Integration, Layout Catalog, Layout Catalog).
PeopleSoft delivers these additional layouts:
Layout ID |
Layout Name |
Document Purpose |
---|---|---|
POOL |
Pool Import |
Importing investment pool data in Cash Management |
STOCK |
Stock Import |
Importing stock quotes for Deal Management. |
SEC_MARKET |
Security Values |
Importing security market values |
OFAC |
OFAC sanctions list |
Importing list of Specially Designated Nationals (SDN) |
EU |
EU sanctions list |
Importing European Union SDN list |
SDN_LOAD |
Enterprise sanctions list |
Importing SDN list from within an enterprise |
SECURITY |
Security Definition Import |
Importing the security definition. |
See Understanding the Financial Sanctions Service.
See Maintaining Pool Positions.
See Maintaining Equities.
Code Mappings enable you to define the mappings between external system codes with their equivalent internal PeopleSoft codes. For example, PeopleSoft stores 03 account types as checking accounts, and the required code for the EDI 820 bank statement layout is DA for deposit account. Code mappings are used to map these hard-coded field values to each other so that the transformation program component can use them. This allows a single transformation program to be used across multiple banks even though the program may need different code mappings.
Code mappings are most useful for fields that may change for every bank. Bank statement processing uses mappings for three fields: bank statement codes, reconciliation or "recon" codes, and statement activity types. For example, a bank identifies certain miscellaneous fees with the numeric code 564. If you define it as a Bank Fee, you can assign the input value of 564 to the output value of BKFEE. Other banks may use a different value to identify bank fee.
See Defining Statement Activities.
There are three levels to the code mapping data-structure hierarchy:
Code Map Group: The highest level, this is a container for all the fields for a given code map set. For instance, a code map group could represent all the code mappings for a particular bank.
Code Map Header: The second level, this represents a particular field for which the transformation Application Engine obtains the code map.
Code Map Items: The items contain all the possible input and output values for a particular field or header.
To access Code Mappings defined in the database, use an application class entitled CodeMapper within the transformation program.
Class CodeMapper
To access Code Mappings, which is defined in the database, use an application class entitled CodeMapper within the transformation program. This table provides the details of the CodeMapper Application Class (Package - TR_CODE_MAPPING.Utilities).
Note: The CodeMapper application class should only be accessed by advanced users to customize their layouts or create a new layout program.
Method |
Description |
---|---|
public
|
The constructor for this class. |
public String
|
Obtains the default value for a code map field based on the group ID and field name. |
public String
|
Obtains an input value based on the group ID, field name, and output value that are passed into the method. |
public String
|
Obtains an output value based on the group ID, field name, and input value that are passed into the method. |
|
Initializes the rowset that is used by the component. In essence, this method will obtain all the possible mappings for the given group ID. This minimizes the number of trips to the database and in turn decreases the amount of time to search for a value. This method must be called prior to any of the previous methods being called. |
The following code sample illustrates how to use the CodeMapper class within PeopleCode:
/* Import the code mapping class into the people code where it is to be
called */
import TR_CODE_MAPPING:Utilities:CodeMapper;
/* Initialize the object (this initiates the constructor for the class */
&oMapper = create CodeMapper();
/* Initializes the object to contain the data for the given Group */
&oMapper.initializeRowset(&strGroupID);
/* Obtain the output value for the given Group ID, the field called
"BANK_STMT_CODE" and the value in &strInput */
&strOutput = &oMapper.getOutput(&strGroupID, "BANK_STMT_CODE", &strInput);
The files that are sent to and received from your bank during the Dispatch Payment and Bank Statement processes can be encrypted and decrypted. This functionality is provided by the PeopleSoft Encryption Technology (PET), which supports several industry standard encryption formats that are used by a large number of banks. To enable encryption and decryption, you need to create encryption profiles in PeopleTools (
). For complete instructions on setup and configuration, see PeopleTools: Security Administration.The general steps for setting up an encryption profile are:
Consult your bank to determine a common algorithm to use.
Install the required toolkit to produce the encryption format.
Load public and private keys into the PeopleTools PET Keyset store.
Use the Layout Catalog page (PMT_FORMAT_CATLOG) to create new or modify existing bank statement, payment, and payment acknowledgment layouts by defining transformation processing details, payment methods, parameters, and properties.
Navigation:
This example illustrates the fields and controls on the Layout Catalog page (1 of 2). You can find definitions for the fields and controls later on this page.

This example illustrates the fields and controls on the Layout Catalog page (2 of 2). You can find definitions for the fields and controls later on this page.

Define the file layouts, output type, and integration options that a particular bank supports. The catalog stores information about the layout, the program name containing the logic to generate or process the layout, and additional required setup or processing parameters that the layout requires.
If the bank does not support any of the delivered layouts or has a modified version of a delivered layout, you can create a new layout or edit a delivered layout. After a new or modified layout is added to the Layout Catalog, it is available for use in the system.
If you are adding new layouts or editing existing layouts for an organization's payment processing requirements, you must first create the new layout before you can continue this setup procedure. Follow the procedures to create a new layout that are outlined in the sections Defining Payment Grouping Rules, Defining Code Mappings for Banks Statements, Payments, and Payment Acknowledgments, and Creating Payment Layouts. Then add the new layout to the Layout Catalog.
See Understanding the Layout Catalog.
See Code Mappings Page.
Layout Details
Field or Control |
Description |
---|---|
Transformation Program Type |
Select the method used to create or process a file layout. The options are:
For payments, this transformation program will process the PAYMENT_DISPATCH IP into a payment file layout. For bank statements, this transformation will process a bank-statement file layout into the BANK_STATEMENT_LOAD or BANK_ACCT_ANALYSIS_LOAD IP. |
Report Name |
Select the BI Publisher report name used to generate the payment file. This field appears only if BI Publisher is selected in the Transformation Program Type field. |
Source Document Name |
Select the source document used to map the PAYMENT_DISPATCH IP to the BI Publisher template. The source is a message object with the name IBY_PPIOUT_1_0. This field appears only if BI Publisher is selected in the Transformation Program Type field. |
Root Package ID |
Enter an application class package name. This field appears only if Application Class is selected as the transformation type. This value is delivered for integration with other PeopleSoft source applications. |
Qualified Package/Class Path |
This field appears only if Application Class is selected as the transformation 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 integration type. This value is delivered for integration with other PeopleSoft source applications. |
Result Message Name |
This field is used during communication with the Integration Broker. It is the name of the message that publishes the file layouts to the Integration Broker. For example, many of the payment layouts are delivered with the PMT_FLAT_FILE message. This means that the file layout will be published into the Integration Broker under the message name PMT_FLAT_FILE. In the message monitor, you will see instances of the PMT_FLAT_FILE message. This value can be changed to any unstructured message to help distinguish different layouts in the Integration Broker and control the communication properties for a message. When communicating with a bank's FTP server, for example, you may want files to be sent to different directories. For example, if you use the EDI 820 layout for wires and the CCD+ layout for ACH payments with the same bank, you may want to create a new message called PMT_CCD_FILE and set it as the Result Message Name for the CCD+ layout. In the Integration Broker, you can then assign communication properties to the PMT_FLAT_FILE and then assign different communication properties to the PMT_CCD_FILE. If both layouts were communicated under the same message name, you could only specify one set of communication properties or one directory in this case. For payment acknowledgments, the required message is PAYMENT_ACKNOWLEDGE. For bank statements, this field displays the name of the output IP message from the transformation program. For all delivered bank statement layouts except EDI 822, the IP message is BANK_STATEMENT_LOAD_VERSION_2. Bank statement layout EDI 822 uses the IP message BANK_ACCT_ANALYSIS_LOAD. |
Grouping Rule |
This field appears only for payment layouts. Specify a payment grouping rule for the layout. Only one grouping rule can be applied to a payment layout. |
Default Max Payment Per File |
Enter the maximum number of payments allowed in a payment file of this type. This field appears only for payment layouts. |
Supported Payment Methods
This group box appears only for payment layouts and is used for defining the specific payment methods that are supported by the payment layout.
Select a layout payment method. Values are:
Automated Clearing House
Direct Debit
Electronic Funds Transfer
Wire Transfer
See the payment layout table for a list of delivered layouts and their corresponding payment methods.
Layout Properties
Layout Properties are information that is needed by a transformation program to successfully create and process a layout. A layout property can be anything, but generally is either a data value that is needed by a layout that is not captured in the system or a processing flag that is needed by a transformation program. These properties are defined at design time, bound with values at setup time, and available to the transformation program at runtime. The values for these defined properties are captured at setup time for every bank.
For example, the layout property SENDER_ID, which is used by the EDI 820 payment layout, identifies the ID of the party that is sending the file. No field is defined in Financial Gateway to store this value, yet this layout requires the property at runtime. Adding SENDER_ID to the layout properties allows this value to be set up for every bank. At runtime, this value is available to the transformation program to be included in the 820 layout.
Field or Control |
Description |
---|---|
Property Code |
Displays the name of the layout field. For the SEPA_CT_03 layout, the following details are available:
Important! If you specify a default, file-extension value for the FILEEXT property code, you must enter a period before the file extension. For example, you enter .TXT, not TXT. Note: A specific layout property FS_MAP_ID is available for configuration when the selected value in the Transformation Program Type field is Data Mapper . The property level for this property is set at the bank level. The property value is identified on the Bank Integration Layouts page, and it should match the Map Definition value setup in the Data Export Import Utility. |
Type |
Specify the property code data type: Date, Number, String, Time, or Yes/No. |
Property Level |
This determines where the property will be set up: bank, account, or system level. For payment layouts, this also determines where in the PAYMENT_DISPATCH IP this value is available to the transform program. System and bank level properties are available in the PMT_HEADER_PROP record. Account level properties are available in the PMT_BATCH_PROP record. For payment files, the layout property values are included in the PAYMENT_DISPATCH IP for use in transformation programs at runtime. The records PMT_HEADER_PROP and PMT_BATCH_PROP contain these values. If you are creating a new transformation program and need to capture some setup information, such as company TAXID, a layout property would be added to the Layout Catalog. It would be set up at bank of account level. You can then use this information in the PAYMENT_DISPATCH message of the transformation program. |
Required |
Select to indicate that this property code is required. |
Read Only |
Select to make this property code a display-only value. This type is good for system settings that need to be captured, but do not vary by bank. |
Max Length (maximum length) |
Enter the maximum character length. At setup time, the entered value is validated to ensure that it is not longer than the maximum length and is the type specified (for example, string, number, yes/no, and so on). |
|
Click the Allowed Values icon to access the Allowable Format Properties page (PMT_FORMAT_VALUES), where you can select the type of list option to apply as the allowed format property. Select one of these list options:
|
Default Value |
Enter a property-code, default value. You can override this value when defining integration layouts for a bank or account. |
Sequence |
Enter sequence numbers to prioritize the property codes. Properties with lower numbers will be displayed first at setup time. During the transformation process, the system processes property codes from the lowest to the highest value. |
Use the Code Mappings page (TR_CODE_MAPPINGS) to define input and output values for mappings of a selected code map group.
Navigation:
This example illustrates the fields and controls on the Code Mappings page. You can find definitions for the fields and controls later on this page.

This page enables you to define the mapping between external bank codes with their equivalent internal PeopleSoft codes for both bank statement and bank payment processing.
Bank statement processing uses mappings for three fields: Bank Statement Codes, Reconciliation Codes, and Statement Activity Types.
For example, a financial organization identifies certain miscellaneous fees with the numeric code 564. If you define a statement activity type of Bank Fee (BNKFEE), you can assign the input value of 564 to the output value of BNKFEE.
Field or Control |
Description |
---|---|
Copy |
Click to create a new mapping group based on the parameters of the current, code map group. |
Mapping Name |
Enter a mapping name. |
Default Value |
Enter a default value for the specific map. The system uses this defined default value if it cannot match the existing mapping input value and you do not select the Return Input if No Match check box. |
Return Input if No Match |
Select to indicate that the system should use the input value as the map-to value if the system cannot match the existing mapping-input value with a defined input value. |
Field Values |
Enter the Input Values and the corresponding Output Values to which they are to be mapped. For bank statement processing, the Input Values are the external bank codes, and the Output Values are the PeopleSoft codes. For bank payments, the Input Values are the PeopleSoft codes, and the Output Values are the external bank codes. |
Use the Event Code Definition page (TR_EVENT_CD_DEF_PG) to enter codes for system events, and define actions for the system to perform when they occur.
Navigation:
This example illustrates the fields and controls on the Event Code Definition page. You can find definitions for the fields and controls later on this page.

Field or Control |
Description |
---|---|
Notify Flag |
Select for the system to send an email or workflow message to the specified party if this event occurs. |
Recipient Type |
Select Person if the message recipient is a specific employee. Select Role if the message recipients should include all users in a specific role, such as a manager. |
Notify Template |
Select the message text template. |
Notify To |
This field is dependent on the selected Person/Role field value. If you select Person, enter the email address of the person to notify. If you select Role, enter the role name. Note: To enable this email notification functionality, you must setup and configure the PeopleTools Simple Mail Transfer Protocol (SMTP) functionality. See the product documentation for PeopleTools: Workflow Technology. |