WebADI

What is Web ADI?

Web Applications Desktop Integrator (Web ADI) is a self–service Oracle application, accessed using a browser. The Web ADI software does not need to be installed on individual client machines. Processing takes place on the server rather than on individual client PCs. Web ADI generates Microsoft Excel or Word documents on your desktop, and uploads the data you have selected to upload. The appearance of the spreadsheet or word processing document is determined by configurable layouts. System administrators can restrict the fields that end users work with in the spreadsheet, and can create different layouts for different users. Experienced end–users can also create their own layouts to include just the fields they need to work with.

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 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.

HR: Enable Web ADI Integration Profile Option

In the System Profile Values window, set the HR: Enable Web ADI Integration profile option to Yes at Site level. When this profile option is set to Yes, users see the Web ADI pages when they choose the Export Data icon on the toolbar of an HRMS window.

When the profile option is set to No, the Export Data icon launches the Application Data Exchange (ADE) software as before.

Configuring Web ADI

You can configure Web ADI to use your own integrators for downloading and uploading data between Oracle HRMS and spreadsheets or word processors.

To configure Web ADI

1. Set up an integrator of the type required.

2. Define one or more layouts for the integrator.

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.

Download/Upload and Create Integrators

For integrators that allow both download and upload, or integrators

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.

To upload the integrator

Follow the steps for uploading a spreadsheet.

Defining Layouts

Each integrator must have at least one layout, specifying the columns to appear in the spreadsheet.

To define a layout:

1. Choose Define Layout from the Web ADI menu. The Layout page appears.

2. Select the integrator for which you want to define the layout and choose Go.

3. If the integrator already contains layouts, these are displayed. Choose the Define Layout button to define a new layout.System Administrators should always create at least one default layout for an integrator. End users can optionally create their own layouts to restrict the fields displayed to those they are concerned with.

4. In the Define Layout page, enter a unique name for the layout. This appears whenever the user is required to select the layout, so should clearly indicate the purpose of the layout.

5. Enter a unique key. The key is used internally by the system to identify the mapping.

6. The Field List defaults to the complete list of columns available in the view and/or API. Choose Continue. In the next page, you will then select a subset of these fields to include in your layout.

Uploading Data using Web ADI

You can upload data to the Oracle applications database using a spreadsheet created in Web ADI.

To upload data from a spreadsheet using Web ADI:

1. If you have saved the spreadsheet on your local PC, locate and open the spreadsheet in Excel.

2. In the Upl column of the spreadsheet, each row where you have changed data in any field is flagged for upload. As you change data in a field, the row is flagged for upload.

3. Select the Oracle menu on the Excel toolbar, and choose Upload.

4. If you are not already logged in to Oracle applications, a login page appears. Enter your user name and password, then choose the Login button.

5. In the Set Responsibility page, choose your responsibility and then choose Select.

6. In the Upload Parameters page, choose the Parameters button. If you only want to upload flagged rows, choose the Flagged Rows option button. To upload all rows (for example, if uploading from a text file) choose the All Rows option button.

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 1 : Select the responsibility Web ADI.

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.

Step 5 :Click ‘Create Document’ button located at right bottom

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.

For present example I had taken following information into account:

Step 6 :Enter following information into the required fields.

1. METADATA_TYPE : CREATE2. APPLICATION_ID : 8003. INTEGRATOR_USER_NAME : EMP_DATA4. VIEW_NAME : EMP_DATA5. FORM_NAME : GENERAL6. API_PACKAGE_NAME : HR_EMPLOYEE_API7. API_PROCEDURE_NAME : CREATE_EMPLOYEE8. INTERFACE_USER_NAME : EMPLOYEE_DATA9. INTERFACE_PARAM_NAME : EMPLOYEE_DATA10.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.

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.

Step 9 : Open Define Layout form of ‘Web ADI’ responsibility.

Step 9 :Click ‘Go’ button.

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.

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.

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.

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

To create the competency data for an employee.

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.

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.

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.