HRMS APIS

HRMS APIs

Below are use full API in HRMS most of time these API are used to migrate external data from legacy system to oracle apps

Updating the Per_periods_of_service table using

hr_ex_employee_api.update_term_details_emp

Terminate employee

hr_ex_employee_api.actual_termination_emp

Applying the final process in the shared instance using hr_ex_employee_api.final_process_emp

Re – Hire Employee

hr_employee_api.re_hire_ex_employee

Update  Existing Person in system

hr_person_api.update_us_person

Hire New Emp

hr_employee_api.create_us_employee

Costing

pay_cost_allocation_api.create_cost_allocation

Load  Assignment

hr_assignment_api.update_us_emp_asg

Load Update Assign Criteria

hr_assignment_api.update_emp_asg_criteria

Note : Contact Person Id Is To Be Passed

hr_contact_rel_api.create_contact

Note : Contact Person Id is passed as Null(default of API)

hr_contact_rel_api.create_contact

Load Phones

hr_phone_api.create_phone

hr_person_address_api.update_person_address

Load Addresses

hr_person_address_api.update_person_address

hr_person_address_api.create_person_address

Load Payment Methods

hr_personal_pay_method_api.create_us_personal_pay_method

Element Loading

py_element_entry_api.create_element_entry

py_element_entry_api.update_element_entry

Load Salaries

hr_upload_proposal_api.upload_salary_proposal

Salary Proposal

hr_maintain_proposal_api.approve_salary_proposal

State tax rules

pay_state_tax_rule_api.create_state_tax_rule

pay_state_tax_rule_api.update_state_tax_rule

County Tax Rules

pay_county_tax_rule_api.create_county_tax_rule

pay_county_tax_rule_api.update_county_tax_rule

City Tax Rules

pay_city_tax_rule_api.create_city_tax_rule

pay_city_tax_rule_api.update_city_tax_rule

Schools and Colleges

per_esa_upd.upd

per_esa_ins.ins

Performance Reviews

hr_perf_review_api.create_perf_review

hr_perf_review_api.update_perf_review

State Information Taxes

hr_sit_api.update_sit

hr_sit_api.create_sit

Qualifications

per_qualifications_api.create_qualification

per_qualifications_api.update_qualification

Locations

hr_location_api.update_location

hr_location_api.create_location

Organization

hr_organization_api.update_organization

hr_organization_api.create_org_classification

If any Change in Organization information.

if information2 = 'Y' then

hr_organization_api.enable_org_classification

If any Change in Organization information.

if information2 = 'N' then

hr_organization_api.disable_org_classification

If Organization does not exist in instance

hr_organization_api.create_organization api

Jobs

hr_job_api.update_job

hr_job_api.create_job

Positions

hr_position_api.update_position

hr_position_api.create_position

API Avability of HRMS

API Avability of HRMS

So here are few Business events required for your bespoken application and there underline API's details

Add a New Employee

Insert person :hr_entry_api.insert_element_entry

Update people group :hr_assignment_api.update_emp_asg_criteria

Update assignment :hr_assignment_api.update_us_emp_asg

Insert base salary :insert into per_pay_proposals

Insert check as the payment method :hr_entry_api. insert_element_entry

Update Employee Information

Update personal information if it changed: per_per_upd.upd

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

Insert or Update Addresses :hr_person_address_api.create_person_address

Update existing address records :hr_person_address_api.update_person_address

Phones

Insert or create a phone :hr_phone_api.create_phone

update existing phone records :hr_person_address_api.update_person_address

Schools and Colleges

Insert or create a schol and college information :per_esa_ins.ins

update existing records :per_esa_upd.upd

Insert or Update Deductions

If deduction is ended, use the delete API to set end date :hr_entry_api.delete_element_entry

Update deduction if exists, else insert it :hr_entry_api.insert_element_entry

Qualifications

Insert or create a qualifications information :per_qualifications_api.create_qualification

update qualifications records :per_qualifications_api.update_qualification

End Date /delete Element Enties

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

If direct deposit is ended, use the delete API to set end date:hr_personal_pay_method_api.delete_personal_pay_method

Insert bank account if it does not exist :insert into pay_external_accounts

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

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

Jobs

Create new Job :hr_job_api.create_job

Updating the job details :hr_job_api.update_job

Positions

Create new position :hr_position_api.create_position

Updating the position details :hr_position_api.update_position

Where I can get the details for these API's

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';

Publicly Callable Business Process APIs in Oracle HRMS

Oracle APIs are a logical grouping of all external process routines. The Oracle HRMS API sets delivers a set of PL/SQL packages procedures and functions that provide an open interface to the database.

There are three options for you to find the details:

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.

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.

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.

Etrm via metalink

TRM helpful in selecting the appropriate API call.

Considertaion for using API

Before using any API's of payroll and HRMS you must have clear understanding of

Data Tracking

Validation paramater

Correction, insert mode of API's

Additional Note for API's documents

You can download "Configuring, Reporting and System Administration in Oracle HRMS" document from the Oracle documentation library. It has a list of api's.