R12:Payment Process Request (PPR)

This Doc Describes the PPR Setup Step by Step table

changes, Functional Steps, PPR Status Changes and
Packages used to add/update PPR Instruction and Extract
XML Data.

Table Changes:

--Internal Bank Accounts

SELECT * FROM CE_BANK_ACCOUNTS;

--Payment Documents to be used for Printed type Payments

SELECT * FROM CE_PAYMENT_DOCUMENTS;
SELECT * FROM AP_CHECK_FORMATS;

-- Payable Formats
SELECT * FROM IBY_FORMATS_B;

--Payable Profiles
SELECT * FROM IBY_SYS_PMT_PROFILES_B
SELECT * FROM IBY_EXTRACTS_TL;

-- Payment Methods
SELECT * FROM IBY_PAYMENT_METHODS_B;

-- stores the criteria that a payment batch uses to select invoices for payment
SELECT * FROM AP_INV_SELECTION_CRITERIA_ALL;

/*AP_SELECTED_INVOICES_ALL is a temporary table that stores

information about invoices selected for payment in a
payment batch. Your Oracle Payables application
inserts into this table after you initiate a payment batch.
There will be one row for each invoice that Payables selects for
payment in the current payment batch. When you build payments
in a payment batch, your Oracle Payables
application uses information in this table to create
rows in AP_SELECTED_INVOICE_CHECKS.*/
SELECT * FROM AP_SELECTED_INVOICES_ALL
SELECT * FROM AP_SELECTED_INVOICE_CHECKS_ALL
SELECT * FROM AP_UNSELECTED_INVOICES_ALL
-- This table containes locked invoices details to prevent other check runs from selecting the
same invoices
SELECT * FROM AP_PAYMENT_SCHEDULES_ALL

--This table contains transaction details, document details, payer, payee, etc
SELECT * FROM IBY_DOCS_PAYABLE_ALL;
SELECT * FROM IBY_PAYMENTS_ALL;
SELECT * FROM AP_INVOICE_PAYMENTS_ALL;

-- XML documents associated with a particular transaction generated by FORMAT

PAYMENT INSTRUCTION Program
SELECT * FROM IBY_TRXN_DOCUMENTS;

-- Stores PPR instructions

SELECT * FROM IBY_PAYMENT_INSTRUCTIONS_ALL

--Payables Payments Data

SELECT * FROM AP_CHECKS_ALL;

Functional Steps:

Following steps are needed to create a New Payment Format in Oracle Payables R12 and
associate it with Payment Document.

Step A. Create XML Template

Payables Manager > Setup > Payment > Payment Administrator > Formats > XML Publisher
Format Templates

Click on 'Create Template'

Enter the Following values:
Name:
Code:
Application: Payments
Data Definition: Oracle Payments Funds Disbursement Payment Process Request Extract 1.0
Type: RTF
Default Output Type: PDF
Description:
File: Click on Browse and then upload the rtf file from your local machine.
Language: English
Territory: United States

Click on Apply.

Step B. Create Payment Format

Payables Manager > Setup > Payment > Payment Administrator > Formats > Formats

Select Type: Disbursement Payment Instruction

Click on 'Create'
Enter the Following values:
Code:
Name:
Data Extract: Oracle Payments Funds Disbursement Payment Instruction Extract 1.0
XML Publisher Template: XML Template Name created in Step A

Click on Apply

Step C. Create Payment Document

Payables Manager > Setup > Payment > Bank Accounts

Query up your Bank Name. It is assumed that your Bank has already been setup in AP.
Click on 'GO'

Select the Bank Account and click on Manage Payment Documents.

Click on 'Create'

Enter the Following Values:

Name:
Paper Stock Type: Blank Stock
Number of Lines per Remittance Stub:
Format: Payment format Name created in Step B
Payment Document Category: CHECK PAY
First Available Document Number:
Last Available Document Number:

Enter any other information that you may need.

Click on Apply

Step D. Create Payment Process Profile

Payables Manager > Setup > Payment > Payment Administrator > Payment Process Profiles
Click on 'Create'

Enter the Following Values:

Code:
Name:
Payment Instruction Format: Payment format Name created in Step B
Processing Type:
Payment Completion Point:
Default Payment Document: Payment Document Name created in Step C
Payment File:
Default Printer:

Enter any other information that you may need.

Click Apply

Step E. Payment Process Request Templates

Payables Manager > Payments > Entry > Payments Manager

Click on Templates
Click on Create

Enter all valid information in the template that you have created in the Installation steps.

PPR Status Changes:

NEW

This status indicates that the PPR has been successfully submitted for processing, and the
AutoSelect program is digesting the criteria provided by the user on the header of the PPR in
preparation of the automatic selection the invoices and memos related to that criteria.

SELECTING INVOICES

This status indicates that the AutoSelect program is selecting the eligible invoices/memos for
the payment batch based on Due Date, Discount Date, Pay Group, and other criteria provided
by the user on the header of the PPR

CANCELLED - NO INVOICES SELECTED

If no invoices or memos met the selection criteria provided by the user on the header of the
PPR, the PPR is automatically terminated and the status changes to this status.

MISSING..." STATUSES

Other statuses may appear at this point in the process if the user failed to included required
information on the PPR header, such as "Missing Exchange Rates", etc.

INVOICES SELECTED
After selecting the documents (invoices/memos), they are locked to prevent other checkruns
from selecting the same documents

INVOICES PENDING REVIEW

This status will only appear if you selected the "Stop Process for Review After Scheduled
Payment Selection" option on the Processing tab of the PPR header. This status means that
the PPR process has stopped, and is waiting for you to review the invoices and memos that
were selected for payment (and make any changes to the batch, as needed). Click on the Take
Action icon to be taken to the Review Proposed Payments window

CALCULATING SPECIAL AMOUNTS

This status will only appear if you selected the "Calculate Payment Withholding and Interest
During the Scheduled Payment Selection" option on the Processing tab of the PPR header.
This status means that interest and withholding tax are being calculated and applied, as
necessary, to the invoices and memos selected for this payment batch

ASSEMBLING/ASSEMBLED PAYMENTS

An "interim" status, it appears after the calculation for interest and withholding has been
completed, and the Build Payments program is starting. It may appear again later after the
user provides any required bank account and PPP information for the invoices/memos
("documents") selected

INFORMATION REQUIRED - PENDING ACTION

This status appears if you did not provide a default Internal (Disbursement) Bank Account
and/or PPP on the header of the PPR. In that case, you need to click on the Take Action icon
to be taken to a form where you can decide which internal bank account and PPP should be
used for each invoice and memo selected for payment

PENDING PROPOSED PAYMENT REVIEW

This status will only appear if you selected the "Stop Process for Review After Creation of
Proposed Payments" option on the Processing tab of the PPR header. In this case, the system
is waiting for you to review (and modify, if needed) the proposed payments for this batch.
Click on the Take Action icon to be taken to the "Review Proposed Payments" window

FORMATTING

This status indicates that the proposed payments have been turned into payment instruction
files. At this point, you will want to click on the Show link to view the new associated
payment instruction file(s). Each payment instruction file with have their own PI Reference
Number. If you have both electronic and paper ("check") payments involved in this payment
batch, you will see a payment instruction file for each type of payment method

CONFIRMED PAYMENT
Once the payment instructions have been transmitted/printed and confirmed, the Status of the
PPR changes to this status to indicate a successfully completed payment batch (PPR)

TERMINATED

If the user terminates a PPR anytime prior to confirmation of the payments (using the
Terminate icon), the status will change to "Terminated", and the PPR is permanently closed

Packages used to add/update PPR Instruction:

Oracle Payments provides the IBY_FD_EXTRACT_EXT_PUB extensibility package to

construct custom XML element structure that can be added to the payment XML extract
generated by Oracle Payments.

The package specification and body definition can be found in files ibyfdxes.pls and
ibyfdxeb.pls respectively.

These files are located in the $IBY_TOP/patch/115/sql directory.

The package allows custom elements to be created at five levels within the payment XML
extract.

You cannot customize the package specification, but the package body contains stubbed
functions that you can customize.
The five functions are as follows:

Instruction - FUNCTION Get_Ins_Ext_Agg(p_payment_instruction_id IN NUMBER)

RETURN XMLTYPE
This function allows XML element to be introduced at instruction level and run only once for
the instruction.
<OutboundPaymentInstruction> Tag

Payment - FUNCTION Get_Pmt_Ext_Agg(p_payment_id IN NUMBER) RETURN

XMLTYPE
This function allows XML element to be introduced at payment level and run once for each
payment in the instruction.
<OutboundPayment> Tag

Document Payable - FUNCTION Get_Doc_Ext_Agg(p_document_payable_id IN

NUMBER) RETURN XMLTYPE
This function allows XML element to be introduced at document payable level and run once
for each document payable in the instruction.
<DocumentPayable> Tag

Document Payable Line - FUNCTION Get_Docline_Ext_Agg(p_document_payable_id IN

NUMBER, p_line_number IN NUMBER) RETURN XMLTYPE
This function allows XML element to be introduced at document payable line level and run
once for each document payable line in the instruction.
<DocumentPayableLine> Tag.

Payment Process Request - FUNCTION Get_Ppr_Ext_Agg(p_payment_service_request_id

IN NUMBER) RETURN XMLTYPE
This function allows XML element to be introduced at document payable level and run once
for each payment process request.
<PaymentProcessProfile> Tag

Extract XML Data of Format Payment Instructions:

R12: Understanding XML Payment Templates and Formats (Doc ID 562806.1)

For getting the XML Data of Payment Format Instruction

1. Go into the responsibility: Oracle Payment Setup

2. Navigate to: Formats > click on the Go To Task icon > query the format payment you are
using

3. Click on the Update icon

4. Assign the XML Publisher Template "Extract Identity", and save your change and return to
the Oracle Payment Setups menu.

5. Click on the Go To Task icon on the XML Publisher Format Templates row > query up the
Extract Identity template.

6. Verify that the template has the file "IBY_IDENTITY_en.xsl" assigned. If not,
please contact support in order to get this file (see Note: 457411.1).

7. Run a Payment Process Request (PPR) with a Payment Process Profile (PPP) assigned that
uses the Format from #1 through #4 above. The output should now be XML format, and can
be viewed using a browser.

8. Migrate the solution as appropriate to other environments.

The Extract Identity Template Has No File Attached (Doc ID 457411.1)

Load the Extract Identity Template with the following command

java oracle.apps.xdo.oa.util.XDOLoader \
UPLOAD \
-DB_USERNAME apps \
-LOB_TYPE TEMPLATE \
-APPS_SHORT_NAME IBY \
-LOB_CODE IBY_IDENTITY \
-XDO_FILE_TYPE XSL-XML \
-LANGUAGE en \
-TERRITORY 00 \
-FILE_NAME $IBY_TOP/patch/115/publisher/templates/IBY_IDENTITY_en.xsl

R12 Oracle Payments Processing 'How To' documents (Doc ID 579132.1)