Professional Documents
Culture Documents
Introduction
This paper will explain detailed solutions on how to use WEB ADI to
convert legacy data to Oracle Application. This papers focus is on best
practices for preparing data for upload, creating documents and defining
layouts, data upload and upload reconciliation.
Key Concepts
Integrator - This is the definition that stores the information about the
action the user wishes to perform. For example, downloading specific data
to a spreadsheet for viewing or to modify and upload back to the
database.
API - Application Programming Interface. This is the pl/sql interface by
which data is validated and uploaded into Oracle Application. You would
associate an API with an integrator if it was intended to either create new
data in the application or update data that had been previously
downloaded.
View - A view is an object by which you can query data on a table or
tables. If the action you are intending to perform involves downloading
data, you must associate a view with the integrator. If you are using
Create style APIs, you do not require a view. You can elect to use a seeded
view, for example, PER_PEOPLE_V, to use with your integrator. However, if
the integrator is for updating data, then it is recommended that you
create your own views and any other In/Out parameters used by your
chosen API.
One thing to beware of is the use of Aliases in views if you are
downloading from a form. For example, if you use an alias for
Applicant_Name called Starter, and then use a restrictive query in the
form on Applicant Name before running the integrator in Web ADI, you will
get the following error in the BNE log.
BneBaseSQL.executeBneQuery: Exception while running query. Error
Code: 904, Message: ORA-00904: "APPLICANT_NAME": invalid identifier.
This column APPLICANT_NAME has been overwritten by the alias in the
definition loaded into the BNE tables.
Layout - This is where the user selects the columns to be displayed in the
spreadsheet or Word document from the API and/or View used by the
integrator. An integrator can have more than one layout defined for it. You
can choose which one to use when you create your document.
Mapping - The mapping definition links the data source to the API
columns. If no view is specified against the integrator or no text file used
to load data, then no mapping is needed. When the data source is a view,
the mapping is created automatically, however if a text file is being used
then a mapping needs to be manually defined to associate each column in
the file (source) to the relevant API parameter (target).
Creating an Integrator
1.
Login to the application and navigate to Desktop Integrator
-> Create Document
2.
3.
Select Viewer as Excel 2007 and DO NOT tick the Reporting
checkbox because you will be uploading a new integrator definition
to the database. Click on Next button.
4.
Choose None for Content to open empty document. Click on
Next button.
5.
On Document Creation Review page, Click on Create
Document button and open file, A Processing window will open and
a Confirmation window will advise when document has been
created.
6.
In the blank spreadsheet enter a value for each of the
columns as follows.
Metadata Type
Form Name
- GENERAL
7.
Upload by going to Oracle menu on spreadsheet toolbar, and
select Upload.
This example demonstrates how to create an integrator that will allow the
download the data and upload it to oracle application.
1.
Login to the application and navigate to Desktop Integrator
-> Create Document
2.
3.
Select Viewer as Excel 2007 and DO NOT tick the Reporting
checkbox because you will be uploading a new integrator definition
to the database. Click on Next button.
4.
Choose None for Content to open empty document. Click on
Next button.
5.
On Document Creation Review page, Click on Create
Document button and open file, A Processing window will open and
a Confirmation window will advise when document has been
created.
6.
In the blank spreadsheet enter a value for each of the
columns as follows.
Metadata Type
This example demonstrates how to define an integrator that will allow the
upload of new records into Oracle Application from spreadsheet and also
using a text.
1.
2.
Select Viewer as Excel 2007 and DO NOT tick the Reporting
checkbox because you will be uploading a new integrator definition
to the database. Click on Next button.
3.
Choose None for Content to open empty document. Click on
Next button.
4.
On Document Creation Review page, Click on Create
Document button and open file, A Processing window will open and
a Confirmation window will advise when document has been
created.
5.
In the blank spreadsheet enter a value for each of the
columns as follows.
Metadata Type
1.
Login to the application and navigate to Desktop Integrator
-> Create Document
2.
3.
Select Viewer as Excel 2007 and DO NOT tick the Reporting
checkbox because you will be uploading a new integrator definition
to the database. Click on Next button.
4.
Choose None for Content to open empty document. Click on
Next button.
5.
On Document Creation Review page, Click on Create
Document button and open file, A Processing window will open and
a Confirmation window will advise when document has been
created.
6.
In the blank spreadsheet enter a value for each of the
columns as follows.
Metadata Type
Integrator Name
- Name entered above
SQL Where Clause
- where
last_name=$PARAM$.last_name
1st Parameter Name - last_name
1st Parameter Type
- Varchar2
1st Parameter Prompt - Last Name equals
N.B. Add 2nd, 3rd params, etc as required
9.
Upload by going to Oracle menu on spreadsheet toolbar,
and select Upload.
Default Types
session language.
You can enter Excel-compatible formulas
as default values for fields. Follow the Excel
formula syntax and enclose field names in
brackets.
For example: [credit]+[debit]
Note that referencing the field names rather
than the cell names prevents your formulas
from being corrupted if the order of the fields is
changed in the layout.
Document Properties
Protect Sheet - Select Yes or No to set the state of the document
spreadsheet.
Read Only - select this box if you want the field to display as a nonupdateable, read-only field.
column widths for the fields at the Line level. Therefore, when
setting the column spans for a header or context field, be
aware that the width of a column is determined by the width of
the line fields in the spreadsheet.
Title - (optional) enter a title for the header.
Hint Span - enter the number of columns for the field hint to span.
The hint for a field can include the following: * - indicates the field
is required.
List - indicates that the field provides a list of values. Double-click
when the document is generated. The user can add more rows once
the document is downloaded to Excel.
Width - enter the width of the field in characters.
Frozen Pane - use this selection to set the fields that you want to
1.
Login to the application and navigate to System Administrator
-> Application -> Function.
2.
Function
3.
Login to the application and navigate to System Administrator
-> Application -> Menu
4.
Query for a menu of a responsibility and add this function to
the menu.
5.
LOV to an Integrator
This example demonstrates how to create a LOV on an integrator field.
Call the procedure BNE_INTEGRATOR_UTILS.CREATE_TABLE_LOV using
below parameters.
Like you want to create a LOV on DEPTNO column using query- SELECT
DEPTNO, DNAME FROM DEPT;
P_APPLICATION_ID
P_INTERFACE_CODE
P_INTERFACE_COL_NAME
you want to create LOV
P_ID_COL
(DEPTNO)
P_MEAN_COL
P_DESC_COL
P_TABLE
P_ADDL_W_C
clause
P_WINDOW_CAPTION
P_WINDOW_WIDTH
P_WINDOW_HEIGHT
P_TABLE_BLOCK_SIZE
P_TABLE_SORT_ORDER
P_USER_ID
Integrator Application ID
Interface Code
On which column of Interface
Column of LOV Query
Column of LOV Query (DNAME)
NULL if there is no Description
Table of LOV Query (DEPT)
1=1, If no additional where
NULL (Optional)
400 (Popup window width)
300 (Popup window height)
10 (No of records in each block)
NULL (Optional)
Use ID (Created By)
Technical Information
Integrator
BNE_INTEGRATORS_B
BNE_INTEGRATORS_TL
BNE_INTEGRATORS_VL
Layout
BNE_LAYOUTS_B
BNE_LAYOUTS_TL
BNE_LAYOUTS_VL
Layout Columns
BNE_LAYOUT_COLS
BNE_LAYOUT_COLS_V
Mapping
BNE_MAPPINGS_B
BNE_MAPPINGS_TL
BNE_MAPPINGS_VL
Content
BNE_CONTENTS_B
BNE_CONTENTS_TL
BNE_CONTENTS_VL
Interface
BNE_INTERFACES_B
BNE_INTERFACES_TL
BNE_INTERFACES_VL
Sql Qury to get Package and View name used in Integrator
Layout
FNDLOAD apps/$APPS_PASSWORD 0 Y DOWNLOAD
$BNE_TOP/admin/import/bnelay.lct
XX_TEST_CREATE_LAYOUT.ldt BNE_LAYOUTS LAYOUT_ASN=XXCUST
LAYOUT_CODE=" XX_TEST_CREATE_LAYOUT
Mapping
FNDLOAD apps/$APPS_PASSWORD 0 Y DOWNLOAD
$BNE_TOP/admin/import/bnemap.lct
XX_HR_86_MAP.ldt BNE_MAPPINGS MAPPING_ASN="PER"
MAPPING_CODE="HR_86_MAP
FNDLOAD apps/$APPS_PASSWORD 0 Y
UPLOAD $BNE_TOP/admin/import/bnemap.lct
XX_HR_86_MAP.ldt
Content
FNDLOAD apps/$APPS_PASSWORD 0 Y DOWNLOAD
$BNE_TOP/admin/import/bnecont.lct
GENERAL_223_CNT.ldt BNE_CONTENTS CONTENT_ASN=XXCUST
CONTENT_CODE=" GENERAL_223_CNT
Click on Go.
3. Enter a name for the layout and select the number of headers.
Enter a Layout Name and specify the Number of Headers to place across the top of the document.
If your document has one header, all fields that you identify as Header fields will display in a
single list. If your layout includes numerous header fields, you may consider defining multiple
headers to place them horizontally across the top of your document.
click on Next button.
4. Select the fields to appear on the layout, set defaults for the fields, and select the
placement of the field as context, header, or line item.
Determine the fields to be included in the Layout, their placement and default values. The page
displays Required Fields and Optional Fields. Administering Web ADI 2-3 Some integrators offer
the option Include Graph of Lines Data. Select the box to include a graph.
All required fields must be included in your layout. Include optional fields by selecting the Select
box. The following table describes the options available for the fields in your layout:
Layout Field Options
Fields
Placement
Description
Defines the location of the field on the spreadsheet.
Choices
are Context, Header, and Line. In your spreadsheet:
Context: Appears at the top of the spreadsheet as
read-only, contextual information.
Header: Fields whose values do not change for every
record you are uploading. This region appears above
the line region in the spreadsheet. If you specified
multiple headers, select the one you wish the field to
display in (for example: Header 1, Header 2, or Header
3).
Line: Fields whose values change for every record that
is uploaded to Oracle Applications. The rows of data in
this region represent every record that will be
uploaded.
Default Types
Default Type - Constant
setting a
default for a field. Values are as follows:
sysdate: System date
database: Name of the current database
oauser.id: ID of your current Oracle Applications user
Default Type - Parameter
values
for fields. Follow the Excel formula syntax and enclose field
names in brackets.
For example: [credit]+[debit]
Note that referencing the field names rather than the cell
names prevents your formulas from being corrupted if the
order of the fields is changed in the layout.
5. In the Create Layout page, define display properties for the page components. Use this page to
mark fields as Read Only, to Hide fields, and to move the fields up or down in the display order.
Document Properties
Protect Sheet - select Yes or No to set the state of the document when
downloaded. A protected sheet will allow you to update the data fields but will
Administering Web ADI 2-5 not allow you to insert rows. The user can change this setting in Excel
by
selecting Protection from the Tools menu.
Style sheet - select a style sheet to apply to the document.
5. Set properties for the layout components including field width or column span,
hidden or unhidden, and position.
Read Only
Design Considerations:
When setting the column spans for context and header fields, you must consider the column
widths that are set at the line item level. The following figure shows the layout specifications for
the Context fields and how these specifications rendered in the actual document. The Context
Prompt Span is defined as 5 columns and the Context Data Span is defined as 4 columns. Note
that the Prompt span covers columns B through D:
Column B is the automatically generated Upload line item column
Column C is the Period line item column
Columns D, E, and F are key flexfield segment columns
The following figure shows the same document after increasing the Header Hint Span to 3.
Note that achieving the desired layout may require several iterations, as changing the column
spans for the fields in the first header will affect the placement of the fields in the second header.
For example, in the preceding figure, when the Hint Span was changed to 3 for Header 1, the Hint
text for Header 2 was moved to a narrower column resulting in part of that text being hidden.