License-Web ADI is available when you purchase Oracle HRMS.

Orace web ADI Responsbty shoud have Desktop Integraton Menu. In R12
we have set of predefned form functons for few Integrators. We need to
attach those functons to Desktop Integraton Menu to have access to those
Integrators.
Security Settings
It s aso possbe to gve access to a users f there are no securty
mpcatons by settng the profe opton BNE Aow No Securty Rue to Yes
!cel
o Go to Toos > Macros > Securty
o Securty Leve tab change t Low.
o Trusted Pubshers tab - Check Trust a nstaed add-ns and
tempates.
o Trusted Pubshers tab - Check Trust access to Vsua Basc Pro|ects.
Internet !plorer
o Go to Toos > Internet Optons > Securty Tab
o Cck the "Internet" con n the "Seect a zone" box and then cck
the "Custom Leve" button.
o When the "Securty Settngs" daog box appears, scro down to
"Scrptng" on the menu. Enabe- Aow status bar updates scrpt.
o Cck "OK" to cose the Internet Optons daog box and Cose the
browser wndow so that new settngs can be used.
"etting Starte#
When HR: Enabe Web ADI Integraton s Y, the Web ADI Create Document
program s nvoked for an HR user by cckng on the Export Data con on the
toobar of an HRMS wndow.
Seq Prompt Submenu Functon
10 Create Document Create Document
20 Defne Layout Web ADI Layout Defnton
30 Defne Mappng Web ADI Text Mappng
40 HR Create Document HRMS Create Document
These functons are suffcent to get you started, but more may be added for
specfc tasks. Note that the HR Create Document functon s the same as
Create Document but fters out Integrators nked to forms and the HR
Startup ntegrators. When creatng custom ntegrators the HR Setup
Integrator (HR_SETUP_SETUP_INTG) shoud be run from the Create Document
functon. If an attempt s made to aunch the HR Create Document functon
wthout havng created any genera ntegrators, the error,800:GENERAL% s
an nvad Integrator Key
$oncepts
Integrator - Ths s the defnton that stores the nformaton about the
acton the user wshes to perform. For exampe, downoadng specfc data to
a spreadsheet for vewng or to modfy and upoad back to the database. For
ADE users, ths equated to the Stye.
A%I - Appcaton Programmng Interface. Ths s the p/sq nterface by whch
data s vadated and upoaded nto Orace HRMS. You woud assocate an ap
wth an ntegrator f t was ntended to ether create new data n the
appcaton or update data that had been prevousy downoaded. See Orace
HRMS Confgurng,Reportng and System Admnstraton manua for a st of
supported aps.
&iew - A vew s an ob|ect by whch you can query data on a tabe or tabes.
If the acton you are ntendng to perform nvoves downoadng data, you
must assocate a vew wth the ntegrator. If you are usng Create stye APIs,
you do not requre a vew. You can eect to use a seeded vew, for exampe,
PER_PEOPLE_V, to use wth your ntegrator. However, f the ntegrator s for
updatng data, then t s recommended that you create your own vews and
remember to ncude the OB|ECT_VERSION_NUMBER, and any other In/Out
parameters used by your chosen API.
Layout - Ths s where the user seects the coumns to be dspayed n the
spreadsheet or Word document from the API and/or Vew used by the
ntegrator. An ntegrator can have more than one ayout defned for t. You
can choose whch one to use when you create your document.
Mapping - the mappng defnton nks the data source to the ap coumns.
If no vew s specfed aganst the ntegrator or no text fe used to oad data,
then no mappng s needed. When the data source s a vew, the mappng s
created automatcay, however f a text fe s beng used then a mappng
needs to be manuay defned to assocate each coumn n the fe (source) to
the reevant ap parameter (target).
$reating Integrators in Web ADI
Creatng ntegrators s a system admnstraton step requred to enabe
downoad or upoad of data from and to wndows for whch no seeded
ntegrator exsts. Web ADI has two types of ntegrators:
Appcaton Integrators
Standaone Integrators
An Appcaton Integrator nks to a specfc form. You typcay use the form to
downoad HRMS data, usng some form restrcton, modfy the data, and then
upoad
the data.
You use standaone ntegrators drecty from the sef-servce menu functon.
These ntegrators aow you to create new data or downoad and update
exstng data. You can set up a query restrcton to use at runtme. For
Standaone Integrators the form name s GENERAL.
'o $reate (ploa# Integrator
1. Seect HR Create Document from the menu. The Settngs page of the
Web ADI wzard appears.
2. In the Settngs page, seect a spreadsheet vewer n the Vewer fed.
3. Deseect the Reportng check box, as ths ntegrator s used to upoad
data to the database.
4. In the Integrator page, seect the seeded ntegrator "HR Integrator
Setup".
5. In the Layout page, seect the defaut ayout "HR Integrator Setup".
6. In the Content page, seect none.
7. In the Revew page, you can see fu detas of the document that w
be created. Choose the Back button f you want to change any of the
nformaton, or choose the Create Document button to contnue
8. On Document Creaton Revew page, Cck on Create Document button.
Open fe and Enabe Macros f prompted. A Processng wndow w
open and a Confrmaton wndow w advse when document has been
created.
o (pl -Ignore
o Meta#ata 'ype -Seect Lst of Vaues from Orace menu or rght cck on
mouse. Choose CREATE
o Application Short )a*e -Choose your Appcaton Short Name
o Integrator (ser )a*e - Enter a name for your ntegrator (For e.g. EMP
Detas)
o &iew )a*e- Ignore (Vews are ony requred for Downoad or update
Integrators.
For create stye aps s provded by Manua nput to spreadsheet or text
Fe.
o +or* )a*e- GENERAL
o A%I %ac,age )a*e - PL/SOL Package Name
o A%I %roce#ure )a*e- Procedure Name
o Inter.ace (ser )a*e- Enter a unque name
o Inter.ace %ara*eter List- Enter a unque name
o A%I 'ype - Seect Lst of Vaues from Orace menu or rght cck on mouse.
Choose PROCEDURE
o A%I Return 'ype- Ignore
9. Upoad by gong to Orace menu on spreadsheet toobar, and seect
Upoad.
$reate +or* +unction
o Functon Name: SG_INV_LOCATOR
o User Functon Name: Inventory Locator Web ADI Upoad
o Descrpton: Inventory Locator Web ADI Upoad
o Type: SSWA Servet functon
o Parameters: bne:page=BneCreateDoc
o Htm ca: orace.apps.bne.webu.BneAppcatonServce
Associate +or* +unction with Integrator
1. Seect HR Create Document from the menu. The Settngs page of the
Web ADI wzard appears.
2. In the Settngs page, seect a spreadsheet vewer n the Vewer fed.
3. Deseect the Reportng check box, as ths ntegrator s used to upoad
data to the database.
4. In the Integrator page, seect the seeded ntegrator "HR Mantan
Integrator Form Functon Assocatons ".
5. In the Layout page, seect the defaut ayout "Form Functon
Assocaton".
6. In the Content page, seect "Form Functon Assocaton".
7. In the Revew page, you can see fu detas of the document that w
be created.
8. Open fe and Enabe Macros f prompted. A Processng wndow w
open and a Confrmaton wndow w advse when document has been
created.
Enter the foowng detas after gettng exce sheet:
Integrator appcaton short Name: INV
Integrator User Name : Inventory Locator Web ADI
Upoad
Form functon : SG_INV_LOCATOR
9. Upoad by gong to Orace menu on spreadsheet toobar, and seect
Upoad.
%ara*eters 'o Integrator
1. Seect HR Create Document from the menu. The Settngs page of the
Web ADI wzard appears.
2. In the Settngs page, seect a spreadsheet vewer n the Vewer fed.
3. Deseect the Reportng check box, as ths ntegrator s used to upoad
data to the database.
4. In the Integrator page, seect the seeded ntegrator "HR Create
Standaone Ouery".
5. In the Layout page, seect the defaut ayout "Standaone Ouery
Detas".
6. In the Content page, seect "Standaone Integrators".
7. Seect Mappng
o Mappng- HR Create Standaone Ouery Mappng.
o Appcaton Short Name -INV
o Integrator User Name - Inventory Locator Web ADI Upoad
8. Revew page, you can see fu detas of the document that w be
created.
9. Open fe and Enabe Macros f prompted. A Processng wndow w
open and a Confrmaton wndow w advse when document has been
created.
Enter the foowng detas after gettng exce sheet:
SOL WHERE CLAUSE:
WHERE ORGANIZATION_CODE = $PARAM$.p_organzaton_code
PARAMETER_NAME PARAMETER_TYPE PROMPT
Parameter1:p_organzaton_code VARCHAR2
Organzaton Code
De.ining a )ew Layout
Use ths procedure to defne or modfy a ayout.
1. From the Orace Appcatons navgator, seect the Defne Layout nk.
Ths may be under the Desktop Integraton responsbty, or t may be
ocated under a dfferent responsbty assgned to you by your system
admnstrator.
2. In the Defne Layout wndow, seect an ntegrator(Inventory Locator
Web ADI Upoad).
3. In the Seect Layout wndow, defne a new ayout. Enter a name and
ayout key for the new ayout. Layout key s used to nternay dentfy
the ayout. You cannot change the ayout key after t s specfed.
4. In the Defne Layout wndow, seect the approprate vaues for the
feds. The Defne Layout wndow aows you to determne the
pacement of feds, add optona feds, and set defaut vaues. A
requred feds must be ncuded n your ayout. Incude optona feds
by seectng the Seect check box. The tabe that foows descrbes the
feds n the Defne Layout wndow.
+iel#s Description
%lace*ent/ Defnes the ocaton of the fed on the spreadsheet. Choces
are Context, Header, and Lne. In your spreadsheet:
o Context: Appears at the top of the spreadsheet as read-ony,
contextua nformaton.
o Header: Feds whose vaues do not change for every record you
are upoadng. Ths regon appears above the ne regon n the
spreadsheet.
o Lne: Feds whose vaues change for every record that s
upoaded to Orace Appcatons. Ths s the data you add and
modfy. For exampe, n the |ournas ntegrator, Account feds
shoud be n the ne regon.
De.ault 'ype - $onstant/ Used when the text entered n the Defaut
Vaue fed s used as the defaut vaue n the spreadsheet.
De.ault 'ype - nviron*ent/ Used to reference an envronment
varabe when settng a defaut for a fed. Vaues are as foows:
o sob.chartofaccountsd: ID of the chart of accounts assgned to
your current set of books
o sob.perodsetname: Name of the caendar assgned to the
current set of books
o sob.transactoncaendard: ID of the caendar assgned to the
current set of books
o sob.setofbooksd: ID of the current set of books
o sysdate: System date
o database: Name of the current database
o oauser.d: ID of your current Orace Appcatons user
o sob.accountedperodtype: Vaue for the Perod Type n the
current set of books defnton
o sob.currencycode: Currency for the current set of books
o sob.atestencumbranceyear: Last encumbrance year of the
current set of books
o sob.adbfag: Ths fag returns True or Fase vaues f the current
set of books have average baances enabed
o sob.consodatonfag: Ths fag returns True or Fase vaues f
the current set of books s a consodaton set of books
De.ault 'ype -S0L/ Used to run a SOL statement to determne the
defaut for the
fed. Web ADI runs the SOL statement entered n the Defaut Vaue fed
and automatcay popuates the spreadsheet wth the resuts. If more
than one vaue s returned from the query, t uses the frst vaue.You can
use the foowng tokens n the SOL statement for the Defaut Vaue fed:
o $profes$.profename: Returns the vaue for the current users
profe when you enter the name of the profe opton.
o $env$.userd: Returns the current user ID.
o $env$.appd: Returns the current appcaton ID.
o $env$.respd: Returns the current responsbty ID.
o $env$.anguage: Returns the current sesson anguage.
De.ault 'ype - %ara*eter/ Used to reference a parameter that
your system admnstrator stores n the form functon (Sef Servce
Lnk) that you use to access the Create Document fow. The
parameters that can be referenced are specfc to each ntegrator.
De.ining Mappings
You can choose to automatcay mport data nto the spreadsheet
durng the Create Document fow. When you choose to mport data on
the Content page, Web ADI prompts you to seect a mappng. Web ADI
requres a mappng n order to determne where mported data shoud
be paced n the spreadsheet. Mappng assocates coumns n the
mported data wth coumns n the spreadsheet. You do not need to
create new mappngs for feds that do not have data, or f a mapped
fed s not ncuded n the spreadsheet. You need to create mutpe
mappngs for content ony f the assocatons between the downoaded
coumns and the feds n the spreadsheet change. If you mport text
fes wth vared data structures, you may have to defne more than
one mappng for the text fe.
De.ining a )ew Mapping
Use ths procedure to defne mappng between source data and
coumns n a spreadsheet.
1. From the Orace Appcatons Navgator, seect the Defne Mappng nk.
Ths may be under the Desktop Integraton responsbty, or t may be
ocated under a dfferent responsbty assgned to you by your system
admnstrator.
2. In the Mappng wndow, seect an ntegrator.
3. In the Seect Content wndow, seect a content to mport. For exampe,
Text Fe.
Content ndcates the nformaton you w mport nto your
spreadsheet. One or
more mappngs can be defned for a partcuar content.
4. In the Seect Mappng wndow, seect Defne Mappng. Enter a name for
the new
mappng, a mappng key, and the number of coumns to be mapped.
Mappng key s used to nternay dentfy the mappng. It cannot be
changed after you specfy the key name. Key names must not contan
spaces. Number of coumns n an estmate. Coumns can be added or
deeted ater n the Defne Mappng process.
5. In the Defne Mappng - Source to Target Coumns wndow, assocate
coumns beng mported from the content to feds n the spreadsheet.
Cck the st of vaues for the Source Coumn to vew a st of avaabe
coumns to mport, and then enter the search crtera. (If you know the
name of the Source Coumn, you can type t drecty nto the fed
wthout usng the st of vaues.) Cck the rado button next to the
coumn name, and then cck seect to seect coumns to map.
o Use the Target Coumn fed next to each Source Coumn to
create a mappng between the two feds. The Target Coumn st
of vaues contans a st of coumns that can exst n a
spreadsheet. You may add new rows f more coumns need to be
mapped. Cck the st of vaues for the Target Coumn to vew a
st of avaabe coumns to mport, and then enter the search
crtera. Cck the rado button next to the coumn name, and
then cck seect to seect coumns to map.
o Some Target Coumns support the transaton of ID vaues from
Source
Coumns. To fnd out f the transaton of IDs s supported by a
specfc
coumn, seect that coumn and cck Lookup. If the coumn
supports the ID transaton, a check box appears under Lookup
for that coumn name. To perform the ID transaton, seect the
Lookup check box for the desred
coumns.
6. Appy the mappng defnton you have created.
De.ining Setup .or 1ey +le!.iel#s
Wth Web ADI verson BNE.D, you have the opton to set rght-
|ustfcaton and zero paddng for every segment of a key fexfed,
regardess of ths settng at the vaue set eve. Lsts of vaues for
fexfeds appy character format masks after a segment vaue has
been seected. These format masks such as rght-|ustfy and zero
paddng and maxmum character wdth s derved from the fexfed
vaue set defnton. Use the Web ADI Setup Optons feature to overrde
the vaues specfed n the vaue set defnton. To set the rght-|ustfy
and zero-f format mask for a key fexfed, or for specfc segments
wthn the key fexfed structure:
1. From the Orace Appcatons Navgator, seect Desktop Integraton,
then Setup Optons. Choose Seect Key Fexfeds.
2. To appy the rght-|ustfy and zero-f format mask to every segment of
a
fexfed, seect t from the st.
3. To appy the format mask to specfc segments of the key fexfed,
choose Seect
Structure, and then seect the approprate segments. The Overrdden
coumn w dspay the number of segments seected.
Technical
1. The man tabes n ADI are as foows:
BNE_CONTENTS_TL
BNE_INTEGRATORS_TL
BNE_INTERFACES_TL
BNE_INTERFACE_COLS_TL
BNE_LAYOUTS_TL
BNE_LAYOUT_COLS
BNE_MAPPINGS_TL
Sampe scrpt to prnt out ntegrator detas. Note ony update ntegrators
have aps. Reportng_Fag='N' Otherwse they are assocated wth the _INTFC
entty
set Pagesze 1000
set nesze 200
set termout on
set verfy off
spoo bne.s
seect dstnct
substrb(bt.appcaton_d,1,12) APP_ID,
substrb(bt.user_name,1,35) INTEGRATOR_NAME,
b.reportng_fag,
substrb(bcv.ayout_code,1,35) INTEGRATOR_LAYOUT,
substrb(bv.user_name,1,30) ASSOC_VIEW,
substrb(bv.nterface_name,1,20) API,
substrb(bv.upoad_type,1,3) TYPE
from
bne_ntegrators_t bt,
bne_ayout_cos_v bcv,
bne_ayouts_b b,
bne_nterfaces_v bv
where
bt.INTEGRATOR_CODE = bv.INTEGRATOR_CODE
and bv.nterface_code = bcv.INTERFACE_CODE
and bt.ntegrator_code=b.ntegrator_code
and upper(bt.user_name) ke upper('%&&Integrator_name%')
order by b.reportng_fag
/
Sampe scrpt to fnd ntegrators assocated wth a form functon
seect securty_code Integrator,
securty_type Type,
securty_vaue Functon
from bne_securty_rues
where appcaton_d=800
and securty_vaue = '&functon_name'
2. The foowng Vew ets are avaabe for downoad from Metank to hep wth
the HR Integrator setup.
Patch 3196431 - Dsabng ntegrators
Patch 4125542 - Creatng standaone ntegrators
Patch 3196360 - Ma merge exampe
Patch 3196357 - Upgradng ADE to Web ADI
Patch 3196355 - Downoad exampe
Patch 4125537 - Creatng ntegrators
Patch 4112747 - Assocatng Form Functons wth ntegrators
3. Debuggng
You can get a og fe to hep dagnose an error n Web ADI. The foowng
profe optons need to be set:
BNE: Server Log Fename: Use ths profe opton to change the name of the
Web ADI og fe on the mdde ter. If ths profe opton s not set, bne.og s
used.
BNE: Server Log Path: Ths profe opton can be used to set the drectory for
the Web ADI og fe on the appcatons server. If ths profe opton s not set,
then the FND_TOP/og drectory s used.
BNE: Server Log Leve: Ths profe opton determnes the eve of deta that s
recorded n the Web ADI og fe. The vad vaues are noted beow. The eve
of granuarty and amount of nformaton recorded to the og fe ncreases as
you move down the st.
CRITICAL_ERROR: - Messages that are the resut of a system faure. The
ntegrty and reabty of the system s n doubt as a resut of ths error.
ERROR: - Messages that are the resut of an unexpected error n the system. It
s possbe to recover from these errors; the system may st be n a usabe
state. Settng the profe opton to ths vaue w
ncudeCRITICAL_ERROR messages n the og fe.
WARNING: - Messages trapped by the appcaton.These errors were handed
by the appcaton but the system admnstrator shoud be aware of them
occurrng. Settng the profe opton to ths vaue w ncudeERROR and
CRITICAL_ERROR messages as we.
INFORMATION: - Addtona messagng s added to the og fe that ncudes
processng nformaton. Settng the profe opton to ths vaue
ncudes CRITICAL_ERROR, WARNING, and ERROR og messages. Ths s the
settng that s used by Web ADI f the profe opton s not set at the ste eve.
DETAIL: - Messages that summarze what s wrtten to the og fe. Settng the
profe opton to ths vaue ncudes CRITICAL_ERROR, WARNING, ERROR, and
INFORMATION og messages.
TRACE: - Messagng that generated detaed debuggng statements. Settng
the profe opton to ths vaue ncudes CRITICAL_ERROR, WARNING, ERROR,
INFORMATION and DETAIL og messages.
4. Creatng an Integrator n an NLS envronment
The scrpt $BNE_TOP/sq/BNENLINS.sq needs to be run to popuate mutpe
anguage rows on BNE_INTEGRATORS_TL tabe