Data Upload in Oracle HRMS Using Web ADI
Data Upload in Oracle HRMS Using Web ADI
com
By
www.aboutoracleapps.com
Inroduction
WEB ADI is a self service tool that comes free with Oracle HRMS pack.It is widely used to migrate the data
from excel sheets (coming from legacy system) into Oracle tables.It does not require any creation of a
program.You just need to set up an integrator and call an appropriate API which in turn pump the legacy
data into oracle.
You can download data from your Oracle HRMS application to spreadsheets or word processing documents
on your desktop using Web ADI.You can query the data in a window, download the queried data to your
desktop, and view the data in spreadsheet format or in a word processing document. In some cases, you
can manipulate the data you have downloaded, and upload your changes back to Oracle HRMS. Validation
of the data takes place by the Application Programmatic Interfaces (APIs) used to upload the data, and any
errors are flagged. Please note that if any errors occur, no data is uploaded to the database.
You can create an empty spreadsheet and enter new data into it, or bring in the data from a text file, then
upload the data into Oracle HRMS. The data is validated using the usual HRMS validation. Standard Oracle
security is maintained.
Integrators
The functionality available with Web ADI depends on the information stored in an ‘integrator’. Each
integrator contains all relevant information about a particular data download, upload or create process,
When you create your spreadsheet or word processing document using Web ADI, you select an appropriate
integrator, and Web ADI handles the transfer and validation of data accordingly.
Data Upload
You can use Web ADI to upload data from spreadsheet into oracle HRMS. You can do this only if the
spreadsheet was created using an upload integrator.You can only upload data using an integrator that has
been created for this purpose (for example, the HR Update Salary Proposals integrator available from the
Salary Management folder). You must specify at thetime you download the data that you intend to upload it
again, by unchecking the Reporting check box. You must also have access to a responsibility that gives you
access rights to upload data as well as download it.Data to be uploaded is validated before the upload
occurs. You must ensure that you enter values in all mandatory fields so that validation is successful when
the data is uploaded to the application. If you do not, the data is not uploaded, and an error message
appears in the Messages column in the spreadsheet for the record with the invalid data.For example, if you
11/13/2008
www.aboutoracleapps.com
are using the HR Update Salary Proposals integrator, you must enter values in the Proposed_salary and
Change_date fields, as a minimum, for any row you want to upload. If your organization has created its own
integrators for uploading data, your system administrator can tell you which fields you must enter.When you
change any field in the spreadsheet, the row is flagged for upload. By default, only flagged rows are
uploaded.
You can configure Web ADI to use your own integrators for downloading and uploading data between
Oracle HRMS and spreadsheets or word processors.
Creating Integrators
Creating integrators is a system administration step required to enable
download and/or upload of data from and to windows for which no
seeded integrator exists.
To create an integrator:
1. Select HR Create Document from the menu. The Settings page of the Web ADI wizard appears.
Caution: When moving between Web ADI pages, do not use your browser’s Back or Forward buttons, as
this causes information to be lost; instead, use the Back, Next and Cancel buttons displayed on the Web
ADI page.
2. In the Settings page, select a spreadsheet viewer in the Viewer field.
3. Uncheck the Reporting check box, as this integrator is used to upload data to the database.
4. In the Integrator page, select the seeded integrator ”HR Integrator Setup”.
5. In the Layout page, select the default layout ”HR Integrator Setup”.
6. In the Content page, select None.
7. In the Review page, you can see full details of the document that will be created. Choose the Back button
if you want to change any of the information, or choose the Create Document button to continue.
8. A spreadsheet document is created, containing all the fields you need to enter to create your own
integrator.
Download–only Integrators
For download–only integrators, including letter generation integrators,enter details in the following columns:
1) METADATA_TYPE – enter DOWNLOAD.
2) APPLICATION_ID – enter the Application ID of your custom application. This is derived from the
FND_APPLICATION table.
Note: To identify the ID for your application, navigate to the Applications window using System Administrator
responsibility. Query the name of your application, then from the Help menu, choose Diagnostics,
Examine.... In the Field List of Values, select APPLICATION_ID. The ID of the application appears in the
Value field.
3) INTEGRATOR_USER_NAME – the name that appears when the end user selects the integrator in the
Web ADI Create Document pages.
4) VIEW_NAME – Web ADI uses a view to determine the tablesand columns to download. Enter the name
of the view you want to use to base the download on.
5) FORM_NAME – the name of the window from which you want the integrator to be available to the user.
Enter the form name of the window, or enter LETTER for a letter generation integrator.For download–only
and letter generation integrators, leave the remaining columns blank.
11/13/2008
www.aboutoracleapps.com
that allow the creation of new data, enter details in the following
columns:
1) METADATA_TYPE – enter CREATE (to allow creation of new data) or UPDATE (to allow update
of existing data)
2) APPLICATION_ID – enter the Application ID of your custom application. This is derived from the
FND_APPLICATION table.
Note: To identify the ID for your application, navigate to the Applications window using System Administrator
responsibility. Query the name of your application, then from the Help menu, choose Diagnostics,
Examine.... In the Field List of Values, select APPLICATION_ID. The ID of the application appears in the
Value field.
3) INTEGRATOR_USER_NAME – this is the name that will appear when the end user selects the
integrator in the Web ADI Create Document pages. Enter a user–friendly name.
4) VIEW_NAME – Enter the name of the view you want to use to base the download on. If creating an
empty spreadsheet for upload, leave this column blank.
5) FORM_NAME – this is the name of the window from which you want the integrator to be available to
the user. If the integrator is to be available directly from the Web ADI menu, enter GENERAL in this
field.API_PACKAGE_NAME. For upload integrators, whether CREATE or UPDATE, you must supply the
name of the API that
handles the upload of data.
6)API_PROCEDURE_NAME. Specify the name of the API
procedure to use to upload the data.
7) INTERFACE_USER_NAME. This is a name that will appear to end users in any messages or prompts
dealing with the interface
(view or API). Enter a user–friendly name.
8) INTERFACE_PARAMETER_NAME. This is a name that will appear to end users in any messages or
prompts dealing with the interface (API) parameters. Enter a user–friendly name.
9)API_TYPE. – Enter PROCEDURE or FUNCTION, according to the type of API you are
using.API_RETURN_TYPE – For APIs of type FUNCTION, enter the
datatype of the value returned by the function, for example,VARCHAR2.
11/13/2008
www.aboutoracleapps.com
7. Choose the Proceed to Upload button, then choose the Upload button in the page that appears next. The
upload takes place, and a series of upload messages is displayed, indicating the success or failure of the
upload.
8. If the upload fails, return to the spreadsheet and correct any errors, then retry the upload. Further details
of errors are available in the Messages column at the end of each row of the spreadsheet. If the upload is
successful, the data is uploaded to the database.
Confirmation messages indicate the success of the upload.
Note: Web ADI uploads all rows to the database if the data is error–free. If any errors occur, no rows are
uploaded.
EXAMPLE
Step 2 : Open the form Create Document the following page will open.Unchek the ‘Reporting’ option while
uploading the data into Oracle HRMS.Click Next button located at right bottom.
Step 3 :Choose ‘HR Integrator Setup’ option and click Next button located at right bottom.
Step 4 :Choose content None and Click Next button located at right bottom.
11/13/2008
www.aboutoracleapps.com
After this a Web Page will pop up showing processing of creating document.
After processing spreadsheet will pop up automatically wherein you have to enter the required information.
1. METADATA_TYPE : CREATE
2. APPLICATION_ID : 800
3. INTEGRATOR_USER_NAME : EMP_DATA
4. VIEW_NAME : EMP_DATA
5. FORM_NAME : GENERAL
6. API_PACKAGE_NAME : HR_EMPLOYEE_API
7. API_PROCEDURE_NAME : CREATE_EMPLOYEE
11/13/2008
www.aboutoracleapps.com
8. INTERFACE_USER_NAME : EMPLOYEE_DATA
9. INTERFACE_PARAM_NAME : EMPLOYEE_DATA
10. API_TYPE : PROCEDURE
Step 7 :Click on Oracle option in the toolbar and then select ‘Upload’.
As soon as you click the upload option then a following window will prop up .You can check the option ‘Show
Trace Messages’ if you want to trace the messages.
Step 8 : Check the option ‘Show Trace Messages’ and click the ‘Upload’ Button.
11/13/2008
www.aboutoracleapps.com
As soon as the upload is Successful you will see a ‘Green Icon’ with a smiling face in the
‘Message’ column of the spreadsheet. If the upload fails then you will see the red icon along with
the error message in the ‘Message’ column of the spreadsheet.
The message will appear that No Layouts are defined for this integrator.
Step 10 : Press the ‘Defined Layout’ button to create a new layout.
Step 11 : Give any user friendly Layout Name and Layout Key and select Field list as Created ‘EMPLOYEE
DATA’.click continue.
11/13/2008
www.aboutoracleapps.com
Step 12 : The layout will appear as shown below. Required field are mandatory fields that are to be filled in.
you can select the type of placement of the fields as header/Line level depending upon the requirement.
Below the required fields are the Optional fields .One can select as many fields available depending upon
the requirements. Make sure that proper setups are done into the system. Just check the select box and
then press ‘Apply’ button.
Step 13 : Switch back to Web ADI responsibility and open the form ‘Create Document’.
Step 14 : Select the custom integrator ‘EMP_DATA’ .Continue to Press ‘Next’ button till spreadsheet
appears.
11/13/2008
www.aboutoracleapps.com
Step 15 : Enter the Employee information into respective columns. First column contains ‘Upl’.As soon as
you enter the information the line is flagged which indicates that the data can be uploaded. if you want to
enter the bulk data of say 20,000 employees then first unprotect the sheet then expand the sheet so that all
20,000 records can be inserted. Please check that all the rows are flagged. Those rows that are not flagged
will not get uploaded.
11/13/2008
www.aboutoracleapps.com
Step 16 : Click Oracle into the menu bar and the select ‘Upload’
Step 17 : Check ‘Show trace Option’ and then press ‘Upload’ button.
All the records will be inserted into respective Oracle HRMS tables if the upload is successful. If a single
record fails then uploading of the data fails. Make sure that all the data that you have is free from
discrepancy and all the required setups are available in the system.
Note: The data is usually provided in Excel by the client .Just Copy that data and paste into the Web ADI
generated spreadsheet and then select upload. You can upload as many rows of data as you can. This ADI
is easy to use and it gives row-wise error messages and are easier to debug.
Following are some of the API’s that can be used to upload the Employee Data using WEB ADI.
1) hr_competence_element_api.create_competence_element
2) hr_contingent_worker_api.create_cwk
To create the contingent worker for an organization.
3) hr_employee_api.create_employee
To create an Employee
4) hr_employee_api.create_applicant
To create an applicant.
5) hr_competences_api.create_competence
To create the competencies for an organization.
6) hr_maintain_proposal_API.insert_salary_proposal
To upload the CTC for an employee
7) hr_grade_api.create_grade
To create the grade defined for an organization.
8) hr_job_api.create_job
To create the job defined for an organization.
11/13/2008
www.aboutoracleapps.com
9) hr_position_api.create_position
To create the position defined for an organization.
10) hr_person_address_api.create_person_address
To create the employee address.Both primary and secondary addresses can be created .For primary
Address make primary_flag=’Y’ in an API.
11) hr_performance_ratings_api.create_performance_rating
To upload the performance ratings of employees.
12) hr_phone_api.create_phone
To upload the telephone numbers for employees.
13) hr_sit_api.create_sit
To create the special information types like Awards,Visa details,passport details,bank details,ESOP
details,etc..
14) pay_element_entry_api.create_element_entry
To upload the elements of salary(one by one) for employees .
15)hr_location_api.create_location
To create the locations for an organization.
These are create style API’s.You can use update also if the employee already exists and you need to
update the information.For that use ‘METADATA_TYPE’ as ‘UPDATE’ to achieve the desired results
www.aboutoracleapps.com
11/13/2008