Oracle Apps Adapter 6.0 | webMethods Oracle Applications Adapter Documentation | webMethods Oracle Applications Adapter 12.2.7 Predefined Transaction Services Documentation | Human Resource Predefined Transaction Services | Receive Employee Service
 
Receive Employee Service
This service is in the WmOAHR1227 package and has the following fully-qualified service name: humanResource1227.intoOA.employee:receiveEmployee.
This service imports employee information.
The Receive Employee service imports new and modified employee data into the Oracle Applications production tables. This predefined transaction service can handle multiple employee records in a single business document. Each record in the business document is inserted or updated according to the underlying Oracle Applications APIs and the data in the business document’s columns. Each business document must contain an assignment child in the business document structure. Business documents can contain new employee records, modified employee records, or both.
Database Scripts
This service uses the following database scripts:
Database Script
Description
wm_install_into_employee.sql
Runs all the scripts listed below, except the uninstall script.
wm_into_employee_pkg.sql
Installs following components which calls the concurrent process to submit the employee information.
WM_EMP_IMP_HANDLER_PKG.
WM_HANDLE_EMP
WM_EMPLOYEE_ASG_IMPORT_PKG.
WM_EMP_CREATE_ASG
WM_EMPLOYEE_ASG_IMPORT_PKG.
WM_EMP_UPDATE_ASG
wm_drop_into_employee.sql
Uninstalls all components created by wm_install_into_employee.sql.
For more information about using database scripts, see Database Scripts.
Supporting Transaction Definitions
This service was built from the configured services defined in the following transaction definition:
*EmployeeTransactions1227.txp
For information about using the transaction definition files to customize this service, see Transaction Definitions.
Flow Control
The main flow executes as follows:
*specifyDefaultSettings specifies the default parameter settings required for service execution. You should change these settings accordingly.
*importEmployee imports data into the production table using Oracle Applications HRMS APIs. It also uses the execEmployeeProg, execEmpAssignCreateProg, and execEmpAssignUpdateProg services to execute the required internal HRMS APIs. Since a single database transaction spans over multiple service calls for the inbound Employee transaction, set the AutoCommit setting to OFF to control the entire transaction through the webMethods service. If execution is successful, it commits the entire transaction for Employee Header information and Employee Assignments information to the database. If the status of the execution is FAILED due to exceptions thrown by HRMS APIs or due to data error, it rolls back the entire transaction. When the execution status is FAILED, the HRMS returns the business error messages returned by the HRMS APIs captures them in the empImportResults document, which can then be sent to the trading partners.
*execEmployeeProg invokes the stored procedure WM_EMP_IMP_HANDLER_PKG.WM_HANDLE_EMP that calls the corresponding HRMS APIs to import Employee data into the Oracle Applications system. This service produces a status ID, execution status message for normal concurrent program completion, a database stored procedure error message (if an exception occurs in the stored procedure execution), data errors (if the HRMS APIs capture any business errors), and any other output values that must be passed to create, update, or correct the Employee Assignments. If this service returns a status of FAILED, it rolls back the entire transaction and processes the next Employee information.
*execEmpAssignCreateProg invokes the stored procedure WM_EMPLOYEE_ASG_IMPORT_PKG.WM_EMP_CREATE_ASG. This stored procedure creates new Employee Assignments using corresponding HRMS APIs to import Employee Assignments information into the Oracle Applications system. This service produces status ID, execution status message for normal concurrent program completion, a database stored procedure error message (if an exception occurs in the stored procedure execution), data errors (if the HRMS APIs capture any business errors), and any other output values. If this service returns the status of FAILED, the it rolls back the entire transaction and processes the next Employee information.
*execEmpAssignUpdateProg invokes the stored procedure WM_EMPLOYEE_ASG_IMPORT_PKG.WM_EMP_UPDATE_ASG. This stored procedure updates existing Employee Assignments using the corresponding HRMS APIs to import updated Employee Assignments information into the Oracle Applications system. This service produces status ID, execution status message for normal concurrent program completion, database stored procedure error message (if an exception occurs in the stored procedure execution), data errors (if the HRMS APIs capture any business errors), and other output values. If this service returns the status of FAILED, it rolls back the entire transaction and processes the next Employee information.
For more details on receive transactions, see Overview of Receive Service Transaction.
Business Document Structure
The business document structure is EmployeeBizDoc. Its structure is as follows:
*1.0 .EMPLOYEE
*1.1 EMPLOYEE_ASSIGNMENTS
1.0 .EMPLOYEE
Field Name
Description
ACTION
Required. Add or change employee information.
ACTION_SUBTYPE
Required when ACTION indicates a change to employee information. Values are Update or Correct.
EMPLOYEE NUMBER
Number assigned to existing employees. If the employee number generation is automatic in the applications for new employees, this field should be null.
EFFECTIVE_START_DATE
Required.
EFFECTIVE_END_DATE
BUSINESS_GROUP_NAME
Required. Name of the business group to which the employee belongs.
PERSON_TYPE_CODE
Required. Example values are Employee, Consultant, or Temporary.
LAST_NAME
Required. Employee’s last name.
FIRST_NAME
Employee’s first name.
START_DATE
Required. Start date of hire for the employee.
APPLICANT_NUMBER
Number assigned to an applicant.
COMMENT
DATE_EMPLOYEE_DATA_VERIFIED
Date when the employee last verified the data.
DATE_OF_BIRTH
Required.
DATE_OF_DEATH
EMAIL_ADDRESS
EXPENSE_CHECK_SEND_TO_ADDRESS
Mailing address.
FULL_NAME
Employee’s full name.
KNOWN_AS
Preferred name, if different from first name.
PRIMARY_ADDRESS_FLAG
Required.
ADDRESS_STYLE
Required. Address style for specific region.
ADDRESS_TYPE
Required. Address type such as H for home or M for mailing.
ADDRESS_LINE1
Required. Corresponding address of the employee.
ADDRESS_LINE2
ADDRESS_LINE3
CITY
Required.
STATE
Required.
POSTAL_CODE
Required.
COUNTY
Required.
COUNTRY
Required.
PHONE_TYPE
Required. Customized field value for type of phone such as H1 for home or M for mobile.
TELEPHONE_NUMBER
Required. Phone number.
MARITAL_STATUS
Marital status of employee.
MIDDLE_NAME
Middle name of employee.
NATIONALITY
Nationality of employee.
NATIONAL_IDENTIFIER
Required. Number by which employee is identified in a given legislation.
PREVIOUS_PERSON_LAST_NAME
Previous last name of person.
REGISTERED_DISABLED_FLAG
Indicates if the person is classified as disabled.
SEX
Required. Gender.
TITLE
Title such as Mr., Mrs., or Dr.
SUFFIX
Suffix after the surname such as Sr., Jr., or III.
WORK_SCHEDULE
CORRESPONDENCE_LANGUAGE
Correspondence language for the employee.
STUDENT_STATUS
FULL_TIME_EMPLOYMENT_CAPACITY
Employment capacity of the person.
ON_MILITARY_SERVICE_FLAG
Indicates whether the employee is away for military service.
SECOND_PASSPORT_EXISTS_FLAG
Indicates whether a second passport exists for the person.
BACKGROUND_CHECK_STATUS
Indicates whether background has been checked.
BACKGROUND_CHECK_DATE
The background check date.
BLOOD_TYPE
LAST_MEDICAL_TEST_DATE
Date when last medical test was conducted.
LAST_MEDICAL_TEST_BY
Name of the doctor who conducted the medical test.
REHIRE_RECOMMENDATION
Recommendation for a rehired employee.
REHIRE_REASON
Reason for rehiring a person.
RESUME_EXISTS_FLAG
Indicates if résumé exists for the employee.
RESUME_LAST_UPDATED_DATE
Date when résumé of the person was last updated.
OFFICE_NUMBER
INTERNAL_LOCATION
MAILSTOP
Internal mail location.
HONORS
PRE_NAME_ADJUNCT
Name prefix of the person.
COORD_BEN_MED_PLN_NO
Coordination of benefits medical group plan number.
COORD_BEN_NO_CVG_FLAG
Indicates if employee has other coverage for coordination of benefits.
DEPENDENT_ADOPTION_DATE
DEPENDENT_VLNTRY_SERVICE_FLAG
Indicates if dependent works as a volunteer.
RECEIPT_OF_DEATH_CERTIFICATE_DATE
USES_TOBACCO_FLAG
BENEFIT_GROUP
Benefit group name.
ORIGINAL_DATE_OF_HIRE
Date when the employee was originally hired.
ADJUSTED_SVC_DATE
Previous date of hire for the employee.
TOWN_OF_BIRTH
REGION_OF_BIRTH
COUNTRY_OF_BIRTH
1.1 EMPLOYEE_ASSIGNMENTS
Field Name
Description
ACTION
Required. Add or change an employee’s assignment.
ACTION_SUBTYPE
Required when ACTION indicates a change to employee information. Values are Update or Correct.
ASSIGNMENT_NUMBER
Required, if modifying employee assignment number.
EFFECTIVE_START_DATE
Required.
EFFECTIVE_END_DATE
Required.
BUSINESS_GROUP_NAME
Required. Name of the business group to which the employee belongs.
RECRUITER_NAME
Name of the recruiter.
GRADE
Grade of the employee.
POSITION
Position of the employee.
JOB
Job name of the employee.
USER_ASSIGNMENT_STATUS
Required. Assignment status of the employee.
PAYROLL_NAME
Payroll name of the employee.
LOCATION_ADDRESS_LINE_1
Location address for the employee assignment.
LOCATION_ADDRESS_LINE_2
LOCATION_ADDRESS_LINE_3
LOCATION_CITY
LOCATION_COUNTY
LOCATION_STATE
LOCATION_POSTAL_CODE
LOCATION_COUNTRY
PERSON_REFERRED_BY
Person who has referred the employee.
SUPERVISOR_NAME
Employee supervisor’s name.
PROGRESSION_POINT_NAME_NUMBER
Number indicating the progression of the pay scale and their incremental order number
RECRUITMENT_ACTIVITY_NAME
Recruitment activity name for the employee.
SOURCE_ORGANIZATION_NAME
Name of the source organization such as a Division or Business Unit.
ORGANIZATION_NAME
Required.
GROUP_NAME
Name of the group to which the employee belongs.
VACANCY_NAME
Name of the vacancy position.
PAY_BASIS
Basis of payment such as Annual, Hourly, or Monthly.
SALARY_APPROVED_FLAG
Indicates the payment approval.
RATE_BASIS
SALARY_UOM
Unit of measure of the salary.
PROPOSED_SALARY
ASSIGNMENT_TYPE
Required.
ASSIGNMENT_PRIMARY_FLAG
Indicates if the assignment is primary. Required when importing an assignment that contains no address details.
CURRENT_EMPLOYER
Name of the current employer.
ASSIGNMENT_CHANGE_REASON
Reason of changing the current assignment.
COMMENT
DATE_PROBATION_END
The ending probation date for the employee.
GL_ACCOUNT_NUMBER
General ledger account number.
EMPLOYMENT_CATEGORY
Category of the employment such as Full time or Intern.
NORMAL_WORKING_FREQUENCY
Normal frequency at which the employee works such as Day, Hour, Month, Week, or Year.
INTERNAL_ADDRESS_LINE
Internal address detail such as floor.
MANAGER_FLAG
Indicates if the employee for the assignment is a manager.
NORMAL_HOURS
Normal hours of work.
PERFORMANCE_REVIEW_PERIOD
PERF_REVIEW_PERIOD_FREQUENCY
Frequency units. Use with PERF_REVIEW_PERIOD to define time between reviews.
TERMINATION_ACCEPTED_PERSON
Person accepting the termination of the employee.
ACCEPTED_TERMINATION_DATE
Date when termination of employment was accepted.
ACTUAL_TERMINATION_DATE
Actual date of termination of employment.
FINAL_PAYROLL_PROCESSED_DATE
Date when the final payroll for the employee is processed.
LAST_STANDARD_PROCESS_DATE
Last date for including the employee in any standard payroll processing.
LEAVING_REASON
Reason for termination of assignment.
NOTIFIED_TERMINATION_DATE
Date when termination of employment was noted.
PROJECTED_TERMINATION_DATE
Projected employment termination date.
PROBATION_PERIOD
Probation period for the employee.
PROBATION_UNIT
Unit of measure for the probation period.
SALARY_REVIEW_PERIOD
Period by which the salary is reviewed.
SALARY_REVIEW_PERIOD_FREQUENCY
Frequency by which the salary period is reviewed.
SET_OF_BOOKS_NAME
General ledger set of books name.
ASSIGNMENT_SOURCE_TYPE
Employment source name such as Advertisement, Agency, Walk-in, or Career fair.
WORK_TIME_NORMAL_FINISH
Normal time when the work is finished.
WORK_TIME_NORMAL_START
Normal time when the work starts.
BARGAINING_UNIT_CODE
Unit code for bargaining for payment decision such as United Auto Workers or International Steel Workers.
LABOUR_UNION_MEMBER_FLAG
Indicates employee is a labor union member.
HOURLY_SALARIED_CODE
Code indicating the payment type for the assignment, such as Hourly or Salary.
CONTRACT_TYPE
COLLECTIVE_AGREEMENT_NAME
ESTABLISHMENT_NAME
ASSIGNMENT_TITLE