The Need

• Reference tables : The details for driving basic Information.
• Employee tables : The details for driving employee vital details
• Payroll tables : Payroll details for employee or any other elements.

API Avability of HRMS

Add a New Employee

1. Insert person :hr_entry_api.insert_element_entry
2. Update people group :hr_assignment_api.update_emp_asg_criteria
3. Update assignment :hr_assignment_api.update_us_emp_asg
4. Insert base salary :insert into per_pay_proposals
5. Insert check as the payment method :hr_entry_api. insert_element_entry

Update Employee Information

1. Update personal information if it changed: per_per_upd.upd
2. Update assignment and people group information if it exists, set mode to correct or update :hr_assignment_api.update_emp_asg_criteria

Add terminating employees
In Oracle On Terminate screen, select Actual Process Date and/or Final Process Date and click on Terminate button. Optionally, enter 'Leaving Reason,' 'Notified,' 'Projected,' 'Last Standard Proces' values.
These are API's are available for termination

 
Hr_ex_employee_api (File name: peexeapi.pkb)
This file contains three (3) procedures.....
hr_ex_employee_api.actual_termination_emp
hr_ex_employee_api.update_term_details_emp
hr_ex_employee_api.final_process_emp
Note: The API's have to be called in that order.

Address

1. Insert or Update Addresses :hr_person_address_api.create_person_address
2. Update existing address records :hr_person_address_api.update_person_address

Phones

1. Insert or create a phone :hr_phone_api.create_phone
2. update existing phone records :hr_person_address_api.update_person_address

Schools and Colleges

1. Insert or create a schol and college information :per_esa_ins.ins
2. update existing records :per_esa_upd.upd

Insert or Update Deductions

1. If deduction is ended, use the delete API to set end date :hr_entry_api.delete_element_entry
2. Update deduction if exists, else insert it :hr_entry_api.insert_element_entry

Qualifications

1. Insert or create a qualifications information :per_qualifications_api.create_qualification
2. update qualifications records :per_qualifications_api.update_qualification

End Date /delete Element Enties

1. End Date /delete Element Enties :py_element_entry_api.delete_element_entry

There are 4 date track delete modes available (variable p_datetrack_delete_mode)

• DELETE end date element entry
• DELETE_NEXT_CHANGE delete next changes
• FUTURE_CHANGE delete future changes
• ZAP completely remove element entry from the database

Insert or Update Direct Deposits

1. If direct deposit is ended, use the delete API to set end date :hr_personal_pay_method_api.delete_personal_pay_method
2. Insert bank account if it does not exist :insert into pay_external_accounts
3. Update direct deposit if exists, else insert it :hr_personal_pay_method_api.create_personal_pay_method

Inform Manager of Inactive Employee Credit card process

1. Use this if required inactivate employee credit card process : hr_ex_employee_api.actual_termination_emp

Jobs

1. Create new Job :hr_job_api.create_job
2. Updating the job details :hr_job_api.update_job

Positions

1. Create new position :hr_position_api.create_position
2. Updating the position details :hr_position_api.update_position

For Oracle release 11 ,11i release 12, the APIs are located in the operating system directories:
$PER_TOP/patch/xxx/sql and $PAY_TOP/patch/xxx/sql,
Refer to filenames like pe****api.pkh, py****api.pkh, and hr****api.pkh, where **** represents wildcard characters.
You can identify the package name and version of the API.
Run this query

 
 
SELECT text
FROM all_source
WHERE name LIKE '%your_api_name%'
AND text LIKE '%Header%';
 

This query will return the header line of the pac kage and package body showing the package name and current version number.

 
 
SELECT object_type,object_name
FROM user_objects
WHERE object_name
LIKE 'HR%API';
 

1. Oracle Documents
   To find a current list of publicly callable business process APIs in Oracle HRMS; you need to go into your On Line Help from within applications and use the search field to find 'Publicly Callable Business'. In the Search Results frame you will see a link to 'Publicly Callable Business Process APIs in Oracle HRMS (Oracle HRMS)' listed.
2. Irep
   To find correct information on APIs you check Oracle Integration Repository (irep) which can accessed via MetaLink by selecting the Knowledge tab - Knowledge Browser sub-tab, then in the Online Documentation box select - Oracle Integration Repository.
3. Search the database
   You may find official documentation on Publicaly Callable APIs as in options 1.
   You can search in the HR Schema for the stored procedures with name 'HR%API'. Open the Package spec and then read the inline comment about the parameters. This is very useful to understand what is meant by each paramater and what the API does.
4. Etrm via metalink
   TRM helpful in selecting the appropriate API call.

Considertaion for using API

1. Data Tracking
2. Validation paramater
3. Correction, insert mode of API's

Additional Note for API's documents