This chapter includes these topics:
This chapter provides detailed information about the business interfaces that are available for the Employee Master business object.
This table lists all of the available interface components:
|
Note: You can find additional technical information about each type of business interface component. For additional descriptions of the information available, and instructions for finding this information, see Chapter 5, "Accessing Additional Information for Business Interface Components." |
The EmployeeManager web service (JP080020) manges the processing of these web service operations:
| Operation | Description |
|---|---|
| processEmployee | You use the processEmployee web service operation to add, change (net change) or delete employee and employee attachments (media objects) records in JD Edwards EnterpriseOne. You can also add or change address book, phone, and electronic address records, but cannot delete them. |
| getEmployee | You use the getEmployee web service operation to get employee data from the JD Edwards EnterpriseOne database based on the query criteria. |
| processPendingEmployee | You use the processPendingEmployee web service operation to insert employee data into table F060116Z (Unedited Quick Hire Transaction File). This service allows inserting multiple employee records at the same time. You cannot update or delete records using this operation. |
To access Javadoc for the EmployeeManager web service and its related operations, review these Javadoc packages:
JP080020 (EmployeeManager)
J0800040 (processEmployee)
J0800041 (getEmployee)
J0800050 (processPendingEmployee)
The processEmployee web service operation is an inbound transaction operation that enables consumers to process employee information within the JD Edwards EnterpriseOne system.
The consumer can complete the following tasks in the JD Edwards EnterpriseOne Human Capital Management system. As you work with employee records, you can also work with related address book records for the employee.
Add, change, or delete employee records.
Add or change address book records for employees when working with employee records.
Add or change phone number records for employees when working with employee records.
Add or change electronic address records for employees when working with employee records.
Add, change, or delete tax override records of US employees.
Add or change tax overrides records of Canada, Australia, and New Zealand employees.
Add, change, or delete additional tax overrides of US and Canada employees.
Add or delete Media Objects for employees.
The processEmployee web service operation calls the processAddressBook (J0100001) business service (BSSV) to process employee address information. If all validations succeed, the processEmployee operation in Add mode calls the Process Employee Integrations Wrapper BSFN to process the employee record. In Update mode, the web service operation retrieves data from the Employee Master table (F060116), and its related data, for net change. The process then calls the performNetChange utility (J0000020) to perform net change. After the net change is done, the web service calls the Process Employee Integrations Wrapper BSFN to process the employee record. In Delete mode, the web service calls the Wrapper BSFN to delete the employee and its related data.
The EmployeeManager published business service also uses the processEntity (J0100010) utility business service when it compares values for address book records and uses the getProcessingVersion (J0000010) utility business service to retrieve program versions.
|
Important: The processAddressBook BSSV processes the Tax ID number of the employee, which may be considered sensitive information. The BSSV does not treat the Tax ID differently than other information. Address Book Data privacy provided in the JD Edwards EnterpriseOne software is not supported by this BSSV. If the processAddressBook BSSV fails, it will not process the address book information and will rollback any address book changes. |
The processEmployee web service operation calls the Process Employee Integrations Wrapper BSFN (B0801350) to process an Employee record. B0801350 in turn primarily calls the Employee Master MBF (B0500575) to process the employee record. The wrapper BSFN (B0801350) also has calls to following BSFN's:
N0800016 - HRM Tax Id Edit US
N0800017 - HRM Tax Id Edit CA
N75A0002 - Validate Tax Id - AU
N75Z0002 - Validate Tax Id - NZ
N0000604 - Validate Application Id
N0000602 - F00095 Record Reservation
B0000603 - Set Object Reservation Text Substitution Error
N0800002 - Set Employee Current Status
B0500575 - Employee Master MBF
B9900410 - Get Environment Value
N0800030 - Fiscal Year Begin End Dates
X0005 - Get UDC
B9800420 - Get Data Dictionary Definition
B0000564 - Get Internal Next Number
B9800140 - Get User Address Book Number
B0800010 - Get Organizational PO
N0500042 - F08001 Retrieve Job Specific Info
N0800003 - Verify Job/Retrieve Job Default Information
N0800204 - Track Date in Current Job
N0800006 - Calculate Pay Period Salary from Annual Salary Input
N0500025 - Salary Calculations Server
N0800004 - Compa-Ratio Server
N0800146 - Get a specific ESS Common Setting
N0700040 - F069016 Fetch Tax Area Profile
B0500543 - Validate Geo Code HR
N0500020 - Update Payroll Lock Out Code
B0500132 - F06017 Canadian Tax Info
N0800008 - Update F06210 to Force Payroll Rerun
N0500032 - Synchronize EE/Supervisor in EE Master & Org Structure
N0800020 - Update Employee Job Server
|
Note: The processEmployee web service and its related web services and business functions perform all of the required validations for country-specific data for Australia (AU), Canada (CA), New Zealand (NZ), and the United States (US) including tax ID, tax overrides, and payroll data. |
If all validations are successful, the processEmployee web service operation writes to these JD Edwards tables:
F060116 (Employee Master)
F0101 (Address Book Master)
F0111 (Who's Who)
F0115 (Phones)
F0016 (Address by Effective Date)
F01151 (Electronic Addresses)
F060117 (Employee Master International Data)
F060117A (Employee Master International Data Tag)
F060120 (Employee Master Additional Informational File)
F06017 (Employee Tax Exceptions/Overrides)
F0701732 (Additional Tax Overrides)
F75A0006 (Australian Employee Tax Overrides)
F75Z0005 (New Zealand Employee Tax Overrides)
You must provide values for the following fields when using the processEmployee web service:
Action Code
Address Number
Required for change and delete actions.
Alpha Name
Social Security Number
Required in Add mode for US and Canadian employees.
Rehire
Required when rehiring a former employee.
Cost Center Home
Sex Male/Female
Minority EEO
Values must exist in UDC 06/M.
RT Salary
A value for either the salary or the hourly field must be provided, depending on the employee's pay class.
RT Hourly
A value for either the salary or the hourly field must be provided, depending on the employee's pay class.
Date of Birth
Required for Canada only.
Tax Area Work
Tax Area Residence
Tax File Number
Required for Australia and New Zealand employee in Add mode.
You must pass the listed values for the following fields and options to the BSSV because these values are in drop-down combo boxes or radio buttons:
JIT Values field in the Additional Tax Overrides (USA) program (P0701732).
You must pass the values as one of these numeric characters: 0, 1, -1, 2, 3, 4, 5, 6, 7, 8, 9.
Basis of Employment options in the Australian Employee Tax Override program (P75A0005) require the following values:
Blank: Full Time
3: Part Time
4: Casual
Variation From Levy option in the Australian Employee Tax Override program (P75A0005) require the following values:
1: 1.5%
2: 1.25%
3: 1%
4: Exempt
Extra Emoluments Payment options in the New Zealand Employee Tax ID Number program (P75Z0002) require following values:
1: No Override Selected
2: 7.5% override selected
3: 30% overrides selected
4: 33% override selected
Before you use this operation, you can set business service properties to specify the version of called programs. This table includes information about the business service properties that the processEmployee operation uses:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J0800040 | J0800040_EMP_MBF_VERSION | Employee Master Processing Version | ZJDE0001 |
| J0800040 | J0800040_AB_MBF_VERSION | Address Book MBF Version when called by Employee BSSV | ZJDE0001 |
|
Note: The processing options in versions that you specify in the business service properties determine how data is processed and how certain fields are populated in the JD Edwards EnterpriseOne database tables. |
This table includes information that can help determine whether the processEmployee operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the system returns a confirmation message to the consumer. The return message includes all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the EnterpriseOne system.
The system returns non-zero values for certain fields. See Returned Values. |
| If I encounter errors while processing a transaction, do I need to reverse the transaction? | This operation uses standard transaction processing. If the system encounters errors during processing, no data in the JD Edwards EnterpriseOne system is updated. No manual updates are required.
Error and warning messages from EnterpriseOne are returned to the EmployeeManager PBSSV as an E1MessageList. If you receive errors while processing this operation, review your selection criteria and business service properties, and then retry your query. |
| Does this operation use record reservation? | Yes. This operation calls the F00095 Record Reservation business function (N0000602). This function reserves records in the JD Edwards EnterpriseOne system when the operation is changing or deleting existing data. |
At a minimum, the system return values for these fields:
EntityID
Entity Type Code
Alpha Name
Company
Home Business Unit
Gender
Ethnic Code
Pay Class
Pay Frequency
Salary
Hourly Rate
Date – Original Employment
Date Started
Pay Start Date
Date – Current Position
Country Code
Change Reason
Tax Area Work
Tax Area Residence
Full Time Equivalents
The getEmployee web service operation is a database query operation that enables consumers to retrieve and review employee information from the JD Edwards EnterpriseOne database.
The getEmployee operation (J0800041) is managed by the EmployeeManager PBSSV and uses the following value objects to fetch employee information based on the query criteria:
InternalGetEmployee
InternalGetEmployeeWhereFields
InternalShowEmployee
InternalShowAddTaxCAandUS
InternalShowTaxOverridesAU
InternalShowTaxOverridesCA
InternalShowTaxOverridesNZ
InternalShowTaxOverridesUS
MOItem_Internal
This getEmployee operation retrieves data from these tables, based on the query:
F0101 (Address Book Master)
F0111 (Who's Who)
F0016 (Address by Effective Date)
F0115 (Address Book - Phone Numbers)
F01151 (Electronic Address)
F060116 (Employee Master)
F060117 (Employee Master International Data)
F060117A (Employee Master International Data Tag)
F060120 (Employee Master Additional Informational File)
F06017 (Employee Tax Exceptions/Overrides)
F0701732 (Additional Tax Overrides)
F75A0006 (Australian Employee Tax Overrides)
F75Z0005 (New Zealand Employee Tax Overrides)
Before you use this operation, you can set business service properties to specify the number of records retrieved. This table includes information about the business service property that the getEmployee operation uses:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J0800041 | J0800041_MAX_ROWS | Maximum rows retrieved | 100 |
This table includes information that can help determine whether the getEmployee operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the system returns records to the consumer. The records that are returned to the consumer include all of the fields that are listed in the response interface for this operation. Some of the fields can include blank or zero values depending on the data that exists in the JD Edwards EnterpriseOne tables. |
| If I encounter errors while processing a transaction, do I need to reverse the transaction? | This operation does not process transactions; therefore, no updates are necessary if you encounter errors.
Error and warning messages from EnterpriseOne are returned to the EmployeeManager PBSSV as an E1MessageList. If you receive errors while processing this operation, review your selection criteria and business service properties, and then retry your query. |
| Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing. |
The processPendingEmployee web service operation is an inbound operation that enables consumers to insert employee details into the Unedited Quick Hire Transaction table (F060116Z). The web service also provides a success or error message. The processPendingemployee operation will pass the pending employees' information to the ProcessPendingEmployeeWrapper BSFN (B0800670) which will insert the records into the F060116Z table.
Before you use this operation, you can set business service properties to specify the versions of programs to use. The processing options in versions that you specify in the business service properties determine how data is processed and how certain fields are populated in the JD Edwards EnterpriseOne database tables.
| Group | Key | Description | Default Value |
|---|---|---|---|
| J0800050 | None | Version of Employee Quick Hire (P060116Q) | ZJDE0001 |
You must provide values for the Social Security Number field when using the processPendingEmployee web service.
Additionally, if the version of the Employee Quick Hire program (P060116Q) that you specify in the business service properties has the New Hire processing option activated, you must also provide values for the following fields:
Alpha Name
Supervisor Number
Date Started
Job Type and Step
This table includes information that can help determine whether the processPendingEmployee operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the system returns records to the consumer. At a minimum, the system returns a value for the batch number and the number of records inserted. If the operation does not complete successfully, the system returns an error message. |
| If I encounter errors while processing a transaction, do I need to reverse the transaction? | This operation uses standard transaction processing. If the system encounters errors during processing, no data in the JD Edwards EnterpriseOne system is updated. No manual updates are required.
Error and warning messages from EnterpriseOne are returned to the EmployeeManager PBSSV as an E1MessageList. If you receive errors while processing this operation, review your selection criteria and business service properties, and then retry your query. |
| Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing. |
This section describes the available real-time events associated with the Employee Master business object, which include:
RTEMOUT, which is a container event for these single events:
RTPIOUT, which is a container event for these single events:
RTPIOUTB
RTPIOUTC
RTEMOUT is a real-time event notification used by JD Edwards EnterpriseOne to notify external systems of changes to employee master records (F060116).
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure |
|---|---|---|---|---|---|
| RTEMOUT | Employee Master | RTE | Container
Container event for:
|
05 | D0500873A: Employee Master RTE Notification A Structure |
Conceptual Approach
When a user adds, modifies, or deletes employee master data from the JD Edwards EnterpriseOne system, the system publishes an event. The RTEMOUT event is a container event activated on the F060116, F060117, and F060120 table triggers and contains all columns from the modified records and an action code specifying what action was performed on the data (added, changed, deleted). Whenever data from one of the tables handled by the container event (F060116, F060117, and F060120) is modified, the corresponding record from the other table is automatically fetched and included in the container.
Objects that Can Initiate the Event
These objects can initiate the RTEMOUTB event, and the single events contained within the event:
F060117 - Employee Master - International Data table trigger
B0500575 - Employee Master Business Function
RTEMOUTB is a real-time event notification used by JD Edwards EnterpriseOne to notify external systems of changes to employee master records (F060116).
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTEMOUTB | Employee Details | RTE | Single | 05 | D0500873B: Employee Master RTE Notification B Structure | Included in container event RTEMOUT. |
Conceptual Approach
When a user adds, modifies, or deletes employee master data, F060116 table only, from the JD Edwards EnterpriseOne system, the system publishes an event. The RTEMOUT event is a container event activated on the F060116 table trigger and contains all columns from the modified employee master record (F060116) and an action code specifying what action was performed on the data (added, changed, deleted). Whenever data from one of the tables handled by the container event (F060116, F060117, and F060120) is modified, the corresponding record from the other table is automatically fetched and included in the container.
RTEMOUTC is a real-time event notification used by JD Edwards EnterpriseOne to notify external systems of changes to employee master records (F060117).
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTEMOUTC | Employee International Details | RTE | Single | 05 | D0500873C: Employee Master RTE Notification C Structure | Included in container event RTEMOUT. |
Conceptual Approach
When a user adds, modifies, or deletes employee master data, F060117 table only, from the JD Edwards EnterpriseOne system, the system publishes an event. The RTEMOUT event is a container event activated on the F060117 table trigger and contains all columns from the modified employee master record (F060117) and an action code specifying what action was performed on the data (added, changed, deleted). Whenever data from one of the tables handled by the container event (F060116, F060117, and F060120) is modified, the corresponding record from the other table is automatically fetched and included in the container.
RTEMOUTD is a real-time event notification used by JD Edwards EnterpriseOne to notify external systems of changes to employee master records (F060120).
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTEMOUTD | Employee Additional Details | RTE | Single | 05 | D0500873D: Employee Master RTE Notification D Structure | Included in container event RTEMOUT. |
Conceptual Approach
When a user adds, modifies, or deletes employee master data, F060120 table only, from the JD Edwards EnterpriseOne system, the system publishes an event. The RTEMOUT event is a container event activated on the F060120 table trigger and contains all columns from the modified employee master record (F060120) and an action code specifying what action was performed on the data (added, changed, deleted). Whenever data from one of the tables handled by the container event (F060116, F060117, and F060120) is modified, the corresponding record from the other table is automatically fetched and included in the container.
RTPIOUT is a real-time event notification used by JD Edwards EnterpriseOne to notify external systems of changes to employee master records (F060116). This message is similar to the message issued by RTEMOUT.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure |
|---|---|---|---|---|---|
| RTPIOUT | Employee Personal Information | RTE | Container
Container event for:
|
05 | D0500873A: Employee Master RTE Notification A Structure |
Conceptual Approach
When a user adds, modifies, or deletes employee master data from the JD Edwards EnterpriseOne system, the system publishes an event. The RTPIOUT event is a container event activated within the employee master business function and contains a specific subset of columns, and an action code specifying what action was performed on the data (added, changed, deleted). Whenever data from one of the tables handled by the container event (F060116 and F060117) is modified the corresponding record from the other table is automatically fetched and included in the container.
Objects That Can Initiate The Event
These objects can initiate the RTPIOUT event, and the single events contained within it:
B0500575 - Employee MBF International Data
RTPIOUTB is a real-time event notification used by JD Edwards EnterpriseOne to notify external systems of changes to employee master records (F060116). This message is similar to the message issued by RTEMOUTB.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTPIOUTB | Employee Personal Details | RTE | Single | 05 | D0500881B: Person Information RTE Notification B Structure | Included in container event RTPIOUT. |
Conceptual Approach
When a user adds, modifies, or deletes employee master data, F060116 table only, from the JD Edwards EnterpriseOne system, the system publishes an event out to a third party system. The RTPIOUT event is a container event activated within the employee master business function and contains a specific subset of columns, from the modified employee master record (F060116) and an action code specifying what action was performed on the data (added, changed, deleted). Whenever data from one of the tables handled by the container event (F060116 and F060117) is modified, the corresponding record from the other table is automatically fetched and included in the container.
RTPIOUTC is a real-time event notification used by the JD Edwards EnterpriseOne system to notify external systems of changes to employee master records (F060117). This message is similar to the message issued by RTEMOUTC.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTPIOUTC | Emp Per International Details | RTE | Single | 05 | D0500881C: Person Information RTE Notification C Structure | Included in container event RTPIOUT. |
Conceptual Approach
When a user adds, modifies, or deletes employee master data, F060117 table only, from the JD Edwards EnterpriseOne system, the system publishes an event out to a third party system. The RTPIOUT event is a container event activated within the employee master business function and contains a specific subset of columns, from the modified employee master record (F060117) and an action code specifying what action was performed on the data (added, changed, deleted). Whenever data from one of the tables handled by the container event (F060116 and F060117) is modified the corresponding record from the other table is automatically fetched and included in the container.
You use batch import programs to import data from an external software system into the JD Edwards EnterpriseOne system, where it can then be processed by EnterpriseOne programs.
This table lists and describes the available batch import programs that are associated with the Employee Master business object: