Adding New Fields to the R12 Payments Funds Disb XML File

Next Blog» Create Blog | Sign InSEARCH BLOG FLAG BLOG

Friday, 6 June 2008

Part 2: Adding new fields to the R12 Payment Funds Disbursement XML file

IBY_FD_EXTRACT_EXT_PUB is a standard PL/SQL package

that is used to extend (i.e. add additional tags to) the XML

file generated during a R12 Oracle Payments ‘Payment

Process Request’:

This XML file is then used as the data source for the XML

Publisher cheque or electronic file presentation layout.

To understand how to use IBY_FD_EXTRACT_EXT_PUB, we

have to understand the structure of the XML file created by

the Payments process request.

There are 4 main levels to the file. These are:

Top Level: Outbound Payment Instruction

This is the top level of the XML File and there is one

Outbound Payment Instruction per Payment process

request.

Level 2: Outbound Payment:

This is the Payment Level i.e. an individual cheque or BACS

payment amount to a supplier. There can be multiple

Outbound Payments per Outbound Payment Instruction.

Level 3: Document Payable:

Details the documents (i.e. invoices) being paid. There can

be multiple Document Payable tags per Outbound Payment

About Me

KEVIN

WOODROW

I am a

consultant

specializing in

planning, implementing

and managing Business

Intelligence, reporting

and technical solutions

for Oracle Financials and

Supply Chain Customers.

View my complete profile

Blog Archive

▼ 2008 (18)

▼ July (4)

OBI EE and .NET

Framework V2

Who Am I? An

investigation into

R12 UMX Proxy

User...

Oracle ERP Technology and Business Intelligence Blog My notes, thoughts and findings on implementing Oracle Business Intelligence, reporting

and technology solutions for ERP Customers.

of 5Oracle ERP Technology and Business Intelligence Blog: Part 2: Adding new fields to the ...

8/5/2008http://kwoodrow.blogspot.com/2008/06/part-2-adding-new-fields-to-r12-payment.html

Level 4: Document Payable Line:

This level details the invoice line. There can be multiple

Document Payable Line tags per Document Payable.

Here is an example Payments file viewed using XML

notepad:

Additional XML tags can be added at each of these 4 levels

by coding different PL/SQL functions in

IBY_FD_EXTRACT_EXT_PUB.

The following table lists the functions you need to modify to

add additional tags to each level of the XML file:

XML File LevelIBY_FD_EXTRACT_EXT_PUB

Function To Modify

Example of Parameter

Usage

OutboundPaymentInstruction

Get_Ins_Ext_Agg

(p_payment_instruction_id IN

NUMBER)

SELECT

FROM

iby_pay_instructions_all

WHERE

payment_instruction_id =

p_payment_instruction_id;

OutboundPaymentGet_Pmt_Ext_Agg

(p_payment_id IN NUMBER)

SELECT *

FROM iby_payments_all

WHERE ipa.payment_id =

p_payment_id;

DocumentPayable

Get_Doc_Ext_Agg

(p_document_payable_id IN

NUMBER)

SELECT *

FROM iby_docs_payable_all dp

WHERE

dp.document_payable_id =

P_document_payable_id;

DocumentPayableLine

Get_Docline_Ext_Agg

(p_document_payable_id IN

NUMBER, p_line_number IN

NUMBER)

PaymentProcessProfile

Get_Ppr_Ext_Agg

(p_payment_service_request_id

IN NUMBER)

SELECT *

FROM

iby_pay_service_requests

WHERE

payment_service_request_id =

BIP XSL-TEXT

Templates : Part

2

BIP XSL-TEXT

Templates : Part

1

► June (9)

► May (5)

► 2007 (5)

Labels

BI Publisher / XML

Publisher (13)

Bill Presentment

Architecture (2)

Check Printing (3)

Discoverer (3)

eText (4)

General Ledger (1)

IBY_FD_EXTRACT_EXT_P

UB (2)

OBI EE (1)

Payments (6)

Proxy User (1)

Quick Reminders (2)

Security (1)

System Administrator (1)

UMX (1)

User Management (1)

Workflow (1)

XDOLoader (2)

XSL-TEXT (2)



As shown in the example below, it is best practice to group

all of your custom tags within a parent tag called 'Extend'

EXAMPLE:

The following is an example of adding an 'Extend' tag and

some additional invoice data to the ‘DocumentPayable’ level

of the XML file:

--

-- This API is called once per document payable.

-- Implementor should construct the extract extension elements

-- at the document level as a SQLX XML Aggregate

-- and return the aggregate.

--

FUNCTION Get_Doc_Ext_Agg(p_document_payable_id IN NUMBER)

RETURN XMLTYPE

IS

v_att1 ap_invoices_all.attribute1%TYPE;



v_detail_line VARCHAR2(255);

v_result XMLTYPE;

BEGIN

SELECT ai.attribute1,ai.attribute2,ai.attribute3

INTO v_att1, v_att2, v_att3

FROM iby_docs_payable_all dp,ap_invoices_all ai

WHERE dp.calling_app_doc_unique_ref2 = ai.invoice_id

AND dp.document_payable_id = p_document_payable_id;

v_detail_line := xxcsd_build_inv_line(p_document_payable_id);

--now build the XML string

SELECT XMLConcat(XMLElement("Extend",

XMLElement("XXCSD_INVOICE_DFF1", v_att1),



XMLElement("XXCSD_INV_DETAIL", v_detail_line)

)

)

INTO v_result

FROM dual;

RETURN v_result;

END Get_Doc_Ext_Agg;

As you can see, I’ve added 4 new

tags ‘XXCSD_INVOICE_DFF1’, ‘XXCSD_INVOICE_DFF2’, ‘XXC

p_payment_service_request_id;



SD_INVOICE_DFF3’ and ‘XXCSD_INV_DETAIL’ to the XML

File:

These new XML tags can now be referenced in my XML

Publisher presentation template and added to my cheque or

electronic payment file layout.

For example, here is the tag ‘XXCSD_INV_DETAIL’ used in

an ETEXT template:

Posted by Kevin Woodrow at 05:37

Labels: BI Publisher / XML Publisher, IBY_FD_EXTRACT_EXT_PUB,

Payments

2 comments:

Ben said...

Hey Kevin,

I would be interested in seeing (as in downloading) source

XML, eText RTF and resultant flat files from this series of

posts you're doing.

The Oracle documentation for the eText format is terrible.

Thanks!

17 June 2008 09:21

Anonymous said...

.

19 June 2008 17:17

Post a Comment



Links to this post

Create a Link

Home

Subscribe to: Post Comments (Atom)

Newer Post Older Post



Adding New Fields to the R12 Payments Funds Disb XML File

Documents

Transcript of Adding New Fields to the R12 Payments Funds Disb XML File