Document 786553.1
Document 786553.1
Document 786553.1
In this Document
Abstract
History
Details
1. Functional Overview
2. Setup Steps
a. Registering Data Sources
b. Creating Database View
c. Registering Data Source View
d. Configuring Hyperlinks
e. Uploading Company Logo
f. Creating a Custom Message
g. Creating a New Template
h. Template Assignment
i. Uploading External Templates
j. Testing the Template
k. Debugging
3. Webcast Recording
4. Additional Resources
5. Patch Information
a. For release 11.5.10
Summary
References
APPLIES TO:
ABSTRACT
Information Center: Oracle Bills Presentment Architecture (BPA) > Note 1427149.2
Functional Overview
Setup Steps
HISTORY
1 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
DETAILS
1. Functional Overview
Prior to the release of Bill Presentment Architecture (BPA), Oracle Receivables only offered document printing programs such as Invoice
or Statement print which provided a rigid structure of output that you could not change. If you needed to make modifications to the
layout or data in the Invoice, you would have to write a custom program to replace the seeded print program.
Oracle Receivables
Oracle Applications seeded in BPA, such as Oracle Order Management and Oracle Service Contracts
Other Oracle Applications
Legacy systems and other non-Oracle applications
Company Logo
Invoice details such as the Invoice Number, Billing Date, description of the items being billed for in the invoice
Option for Special instructions
Summary of amount to be paid
2. Setup Steps
If the Invoice (or any other billing document) you wish to present to your customer requires information not provided by
Oracle Receivables, Order management or Service Contracts, then you will need to set up your own data source.
2 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
The above shows BPA Training Data Source is being defined. The field Oracle Receivables Interface Context provides a list
of values that ties in with whatever Line Transaction Flexfields you have defined within Receivables. In this example there
is a Line Transaction Flexfield defined with the name LEGACY.
For more information on Line Transaction Flexfields please review, Note 1068344.1, Setting Up Receivables Descriptive
Flexfields [Video]
Define the database object to be used as a source from which data will be retrieved. The underlying data object is defined
via SQL*Plus within the APPS schema. Following is sample code to define a custom view which will be used in the Details
Page display area.
This sample view makes use of a custom table bpa_temp. If the information you need is already provided in the Seeded
Data Sources, you do not need to create your own view.
Following is an example of a view for the Lines and Tax Display area, wherein additional fields have been added after
lines.global_attribute20 to pick up a Part number.
CREATE OR REPLACE FORCE VIEW apps.arbpa_detailpage_v (
customer_trx_id,
customer_trx_line_id,
line_number,
line_type,
description,
quantity,
unit_of_measure_name,
unit_price,
extended_amount,
sales_order,
uom_code,
trx_number,
tax_exists_for_this_line_flag,
line_tax_rate,
tax_code,
printed_tax_name,
interface_line_attribute1,
interface_line_attribute2,
3 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
interface_line_attribute3,
interface_line_attribute4,
interface_line_attribute5,
interface_line_attribute6,
interface_line_attribute7,
interface_line_attribute8,
interface_line_attribute9,
interface_line_attribute10,
interface_line_attribute11,
interface_line_attribute12,
interface_line_attribute13,
interface_line_attribute14,
interface_line_attribute15,
unformatted_unit_price,
attribute1,
attribute2,
attribute3,
attribute4,
attribute5,
attribute6,
attribute7,
attribute8,
attribute9,
attribute10,
attribute11,
attribute12,
attribute13,
attribute14,
attribute15,
set_of_books_id,
reason_code,
quantity_ordered,
quantity_credited,
unit_standard_price,
sales_order_line,
sales_order_date,
accounting_rule_duration,
attribute_category,
rule_start_date,
interface_line_context,
sales_order_source,
revenue_amount,
default_ussgl_transaction_code,
default_ussgl_trx_code_context,
last_period_to_credit,
item_context,
tax_exempt_flag,
tax_exempt_number,
tax_exempt_reason_code,
tax_vendor_return_code,
global_attribute_category,
gross_unit_selling_price,
gross_extended_amount,
extended_acctd_amount,
mrc_extended_acctd_amount,
org_id,
global_attribute1,
global_attribute2,
global_attribute3,
global_attribute4,
global_attribute5,
global_attribute6,
global_attribute7,
global_attribute8,
global_attribute9,
global_attribute10,
global_attribute11,
global_attribute12,
global_attribute13,
global_attribute14,
global_attribute15,
global_attribute16,
global_attribute17,
global_attribute18,
global_attribute19,
global_attribute20,
segment1,
inventory_item_id)
AS
SELECT lines.customer_trx_id customer_trx_id,
lines.customer_trx_line_id customer_trx_line_id,
TO_CHAR (lines.line_number) line_number,
lines.line_type line_type,
4 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
NVL (ar_invoice_sql_func_pub.get_description(lines.customer_trx_line_id),
lines.description) description,
TO_CHAR (NVL (lines.quantity_invoiced, lines.quantity_credited)) quantity,
uom.unit_of_measure unit_of_measure_name,
TO_CHAR (NVL (lines.unit_selling_price, 0),
fnd_currency.get_format_mask (trx.invoice_currency_code, 40)) unit_price,
TO_CHAR (lines.extended_amount,
fnd_currency.get_format_mask (trx.invoice_currency_code, 40)) extended_amount,
lines.sales_order,
lines.uom_code,
trx.trx_number,
ar_invoice_sql_func_pub.get_taxyn (lines.customer_trx_line_id)
tax_exists_for_this_line_flag,
ar_bpa_utils_pkg.fn_get_line_taxrate (lines.customer_trx_line_id)
line_tax_rate,
ar_bpa_utils_pkg.fn_get_line_taxcode (lines.customer_trx_line_id)
tax_code,
ar_bpa_utils_pkg.fn_get_line_taxname (lines.customer_trx_line_id)
printed_tax_name,
lines.interface_line_attribute1,
lines.interface_line_attribute2,
lines.interface_line_attribute3,
lines.interface_line_attribute4,
lines.interface_line_attribute5,
lines.interface_line_attribute6,
lines.interface_line_attribute7,
lines.interface_line_attribute8,
lines.interface_line_attribute9,
lines.interface_line_attribute10,
lines.interface_line_attribute11,
lines.interface_line_attribute12,
lines.interface_line_attribute13,
lines.interface_line_attribute14,
lines.interface_line_attribute15,
TO_CHAR (NVL (lines.unit_selling_price, 0)) unformatted_unit_price,
lines.attribute1,
lines.attribute2,
lines.attribute3,
lines.attribute4,
lines.attribute5,
lines.attribute6,
lines.attribute7,
lines.attribute8,
lines.attribute9,
lines.attribute10,
lines.attribute11,
lines.attribute12,
lines.attribute13,
lines.attribute14,
lines.attribute15,
lines.set_of_books_id,
lines.reason_code,
lines.quantity_ordered,
lines.quantity_credited,
lines.unit_standard_price,
lines.sales_order_line,
lines.sales_order_date,
lines.accounting_rule_duration,
lines.attribute_category,
lines.rule_start_date,
lines.interface_line_context,
lines.sales_order_source,
lines.revenue_amount,
lines.default_ussgl_transaction_code,
lines.default_ussgl_trx_code_context,
lines.last_period_to_credit,
lines.item_context,
lines.tax_exempt_flag,
lines.tax_exempt_number,
lines.tax_exempt_reason_code,
lines.tax_vendor_return_code,
lines.global_attribute_category,
lines.gross_unit_selling_price,
lines.gross_extended_amount,
lines.extended_acctd_amount,
lines.mrc_extended_acctd_amount,
lines.org_id,
lines.global_attribute1,
lines.global_attribute2,
lines.global_attribute3,
lines.global_attribute4,
lines.global_attribute5,
lines.global_attribute6,
5 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
lines.global_attribute7,
lines.global_attribute8,
lines.global_attribute9,
lines.global_attribute10,
lines.global_attribute11,
lines.global_attribute12,
lines.global_attribute13,
lines.global_attribute14,
lines.global_attribute15,
lines.global_attribute16,
lines.global_attribute17,
lines.global_attribute18,
lines.global_attribute19,
lines.global_attribute20,
item.segment1,
lines.inventory_item_id
FROM mtl_system_items item,
mtl_units_of_measure_tl uom,
ra_customer_trx_lines_all lines,
ra_customer_trx_all trx
WHERE trx.customer_trx_id = lines.customer_trx_id
AND trx.complete_flag = 'Y'
AND lines.uom_code = uom.uom_code(+)
AND lines.line_type = 'LINE'
AND lines.inventory_item_id = item.inventory_item_id
AND lines.warehouse_id = item.organization_id
AND trx.org_id = lines.org_id
AND uom.language = 'US';
IMPORTANT:
For additional information on how to define a custom view, especially one to be used in the Lines and Tax Display area,
please review the section Creating Database Views in the Oracle Bill Presentment User's Guide.
Associate the Registered Data Source with the the underlying Database View.
4. Click on the Register button and identify under which area you intend to use the data source within the
billing document.
6 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
NOTE:
If you are selecting Content Items associated to a Lines and Tax view, and you do not see a complete list
of all the fields defined in your customer view, ensure that the Template Item checkbox next to the
Content Item = CUSTOMER_TRX_LINE_ID is checked.
Doing so, ensures that all fields of your custom view are available in the Content Items list.
7 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
1. Re-enable the Data Source, now that the view has been associated to it. This allows you to pick this data source
when you move to the Create a New Template step below.
d. Configuring Hyperlinks
Since documents created by BPA can be viewed online, there may be situations where you would like to include a
hyperlink in the billing document.
You can upload a logo to be used in your billing document to give it a professional look and to clearly identify your
company.
8 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
Provide a name for the logo, this name will be available for use later during Template creation. Pick Item Type =
Image, and identify the image to use.
9 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
Provide a name for the message, this name will be available for use later during Template creation. . Pick Item Type =
Message, and provide the text of the message.
1. BPA has provided some seeded Default templates that you cannot modify. However you can duplicate them to
create your own templates. The easiest way to create a new template is to duplicate one of these default templates
by using the Duplicate icon.
2. General Information:
Provide the name for the new template. In our example, we have created an alternate data source which we would
like to use, we provide this information in the Supplementary Data Source field
10 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
3. Once the new template is created, you can query for it, then click on the Update icon to modify it.
5. If you click on the content icon, you will see a page that looks like the following. The left pane shows a list of all
available items, and the right pane shows items you have chosen to display in your template.
11 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
6. To change the content item for the logo, you need to click on the content icon in the Logo Area
In the next screen you pick Data Source as Custom : None, pick BPA Logo created in step e.
7. To add the custom message, navigate to the Instructions Area, and click on the Content Item icon
In the next screen you pick Data Source as Custom : None, pick BPA message created in step f.
8. To add a hyperlink, navigate to the area in which you want to add the hyperlink and click on the Pencil Icon. In the
properties page you can then associate a link to any of the items in that area. In the following screenshot, we are
12 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
This section is similar to the Primary Page Design, except that the data source is our custom view. Clicking on the
content icon allows you to pick what items you want to use in the template.
11. Once you have done the steps above, you should re-query the template, click on the checkbox by its name, and
Mark it as Complete, the status will then change from Incomplete to Complete. This will make the template
available in the next step Template Assignment.
13 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
h. Template Assignment
Define the criteria for when BPA will use the template you created.
2. Provide a Rule name, Supplementary Data Source, and define the order of rules to derive what template should be
used. Note that you can define one set of rules for Online Viewing and another set of rules for Printed Bills.
3. Pick the attributes and the conditions that will control when the template is going to be used, then click on Continue
14 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
Note that in this screen you are defining the template to use for Invoice, you can follow the same process to define
the template for Debit Memo and Credit Memo.
5. After completing the steps above, you are ready to use your template!
If the functionality provided within the BPA template design is insufficient for your business requirements, you have the
option of creating external templates. Using XML Publisher and an add-on utility to Microsoft Word you can create .rtf files.
However, the subject of XML publisher and the creation of .rtf templates is outside the scope of this white paper. This
section simply discusses how to upload the external template once it has been created.
2. Identify the file name associated with the template, and the language.
3. Provide Item Mapping to define what fields in the template map to which fields in the Database
15 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
4. After completing the steps above, query the template and Mark as Complete
Create a test invoice, using the Bill To Customer = BPA Customer (since this was a condition we defined in the Template
Assignment section step h.3.)
Once the transaction is complete, you can click on the BPA icon.
16 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
k. Debugging
You can set the Option column of the concurrent program definition to get the debug messages in the concurrent request
log. Please follow the below steps to enable the debug at concurrent program level.
-Djbo.debugoutput=console
3. Webcast Recording
To watch a recording of a webcast on this topic, please review Note 740964.1, Advisor Webcast Archived Recordings and locate the
topic Receivables Community: Bill Presentment Architecture Setup and Usage.
4. Additional Resources
Note 564735.1, Oracle Bill Presentment Architecture Release Notes - Release 12.0.6
Note 344350.1, Bills Presentment Architecture FAQ
Note 279302.1, What Is Bills Presentment Architecture (BPA)?
Note 738542.1, How to view and print Balance Forward Bills in Bill Presentment Architecture
Note 727160.1, BPA What Column Names Are Available To Use In Custom Templates?
Note 561423.1, How Do You Update BPA Templates To Include Messages On Invoices?
Note 371343.1, How To Register A Line View In Bills Presentment Architecture To
Note 286486.1, Where To Find Documentation On Product Oracle BPA
5. Patch Information
17 of 18 05/06/17, 6:47 PM
Document 786553.1 https://support.oracle.com/epmos/faces/DocContentDisplay?_adf.ctrl-s...
SUMMARY
18 of 18 05/06/17, 6:47 PM