|Oracle iReceivables Implementation Guide|
Part Number E13659-04
This chapter covers the following topics:
iReceivables includes the configuration package ARI_CONFIG, written in PL/SQL. The ARI_CONFIG configuration package lets you modify attributes in iReceivables without having to make changes to any other part of the code. ARI_CONFIG contains in two files the variables and functions for this configurable component. The two files are ARICNFGS.pls (package specification) and ARICNFGB.pls (package body).
The ARICNFGS.pls package specification contains variables referenced in the ARICNFGB.pls package body. Functions and procedures in the package body are referenced elsewhere in the iReceivables code.
You can modify these components using the ARI_CONFIG configuration package:
Account Summary page information section
Account Summary page discount alerts and dispute statuses section
Contact Us global button e-mail address
iReceivables transaction search and customer search
Note: The other iReceivables components previously configurable using ARI_CONFIG are now managed by the tech stack. See: Configuring and Troubleshooting Oracle HTTP Server with Oracle E-Business Suite for more information.
You can also:
Customize the Dispute pages.
Edit iReceivables messages using the Oracle Application Object Library.
A company can provide its customers with access to additional information on the Account Summary home page, such as news, FAQs, and policy statements. The right side of the Account Summary page is devoted to displaying additional information.
When the Account Summary page is rendered, a call is made to the procedure ari_config.get_homepage_customization. This procedure returns the HTML code that is rendered in the information section.
The procedure get_homepage takes the following parameters:
customer site use id
encrypted customer id
encrypted site use id
With these parameters, you can create dynamic content, such as marketing messages and personalized account information.
For more information about the get_homepage parameters, see the documentation included in ARICNFGB.pls.
A company can configure the display of discount alerts and dispute statuses for each customer or external user.
By default, the left side of the Account Summary page, below the customer's account summary, displays discount alerts and the status of open disputes for the accessing customer. If a customer does not have invoices eligible for discount or does not have open dispute requests, iReceivables either displays the messages “No Discounts” or “No Credit Requests” or, if you prefer, iReceivables does not display this section at all.
You control the display of discount alerts and dispute statuses using the customization functions in the ARI_CONFIG package. Both functions operate in the same manner:
The function returns a RENDER flag, indicating whether or not to render the region (Y or N).
The function returns override HTML to replace the actual table.
If the function returns Y for the RENDER flag, iReceivables displays the current data or displays the messages “No Discounts” or “No Credit Requests” if there is no data. If the procedure returns N for the RENDER flag, the region is not displayed.
Depending on the user or on your business needs, you can also replace the default messages with your own messages or information display.
You can customize iReceivables Dispute pages according to your requirements. You can perform these customizations:
Create customized messages for the Enter Dispute Details page and the Review Credit Request page.
Personalize the Invoice Summary table to display invoice flexfields and attachments.
Personalize the Invoice Lines region of the Enter Dispute Details page and the Review Credit Request page to display the invoice line flexfield.
Personalize the Invoice Lines region of the Enter Dispute Details page to display a Search region to search by invoice line attributes, when there is a large number of invoice lines.
Add customized messages to the Message Dictionary for the Enter Dispute Details page and the Review Credit Request page. You create messages based on the lookup types CREDIT_MEMO_REASON and ARI_INVOICE_SECTION in these formats:
Enter Dispute Details page - ARI_DD_<CREDIT_MEMO_REASON lookup code>
Enter Dispute Details page: Invoice section - ARI_DD_<ARI_INVOICE_SECTION lookup code>
Review Credit Request page - ARI_DR_<CREDIT_MEMO_REASON lookup code>
Review Credit Request page: Invoice section - ARI_DR_<ARI_INVOICE_SECTION lookup code>
Note: The Enter Dispute Details page displays the default message when no customized message is defined.
See: Editing iReceivables Messages.
This example provides custom messages for the dispute reason code DAMAGED_GOODS.
Define a message called ARI_DD_DAMAGED_GOODS that reads: "Please attach a digital image of the damaged goods." When the user selects this dispute reason, the Dispute Details page displays this additional instruction message. Along with the message, you can also personalize the Dispute Details page to enable attachments.
If you think that this kind of dispute will take longer to process, you can define an additional message called ARI_DR_DAMAGED_GOODS that reads: "We will process your dispute within the next 7 business days. If you do not receive a response within this time frame, please e-mail us quoting the request ID."
The Contact Us global button on the tool bar is a “mail-to” (HTML) link. When the user clicks the Contact Us global button, the user's e-mail package opens with a new outgoing message pre-addressed to the contact person in the To field.
The setup tasks for personalizing the e-mail information if you are new to iReceivables are:
Enable Contact Info rule
Create a new rule as required giving values for the following parameters:
Customer Site Use
See: Set Up Rules, Profile Options, and System Parameters.
The setup tasks for personalizing the e-mail information for iReceivables Release 11i and earlier releases, are:
Each iReceivables page calls the ARI_CONFIG configuration package while the page is generated, to retrieve the e-mail address appropriate to the current context. You can dynamically configure the Contact Us icon using the logic that you define to determine which e-mail address to display.
When an iReceivables page is generated, the API is passed the parameters and values listed in the table below. The values entered in these parameters determine the e-mail address to use for the Contact Us icon and for the current context.
|p_customer_id||Primary key for HZ_CUST_ACCOUNTS|
|p_customer_site_use_id||Primary key for HZ_CUST_ACCT_SITES|
|p_language_string||Language code used to render the page|
|p_trx_id||Cash Receipt ID (for payments)|
|p_trx_id||Customer Trx Id (for all other transactions)|
Form Functions Window, Oracle E-Business Suite System Administrator's Guide - Security
You can extend the iReceivables transaction search and iReceivables customer search to include additional search attributes according to your business practices. You can extend the transaction search by providing additional transaction search attributes in the Status and Transaction Type lists on the Account Details page. You can extend the customer search by providing additional customer search attributes in the Search By list on the Customer Search page.
You need to provide custom code for your custom search attributes using these procedures in the ARICNFGB.pls file:
search_custom_trx for the custom transaction search.
search_custom_customer for the custom customer search.
These procedures are called by the client Java code whenever users initiate a search using your custom search attributes.
To extend the iReceivables search:
Use the Lookups window to define look up codes for your custom transaction or customer search attributes. See: Review and Update Receivables Lookups.
Use the Messages window to define error messages that refer to validations on your input parameters.
Write your code for the custom search attributes that you defined.
Message Window, Oracle E-Business Suite Developer's Guide
Use the Messages window in the Oracle Application Object Library to edit iReceivables messages according to your needs. All iReceivables messages use the prefix “ARI” in the message name.
Warning: Do not perform either of these actions when you edit iReceivables messages:
Do not insert returns. Inserting returns into HTML-based messages can cause a fatal system error.
Do not modify text strings that contain an ampersand (&). These text strings are parameters that iReceivables replaces with actual values. For example, the text strings &trx_type and &salesperson represent the transaction type and salesperson name respectively. iReceivables cannot display these messages correctly if you modify these strings.
Before you begin to edit iReceivables messages, make a copy of the Message Dictionary runtime message file and store it in a directory protected from upgrades. The Message Dictionary runtime message file is located in the directory:
Note: You must have access to the system administrator and application developer responsibilities to perform this task.
Implementing Message Dictionary, Oracle E-Business Suite Developer's Guide
Copyright © 2002, 2010, Oracle and/or its affiliates. All rights reserved.