| Description | Personnel Administration - Rehire an employee |
| Name | ManagePersonnelRehireIn |
| Namespace | http://sap.com/xi/A1SGlobalization/HCM/XX/Global |
| Product | SAP Business ByDesign |
| Process component | Personnel Administration |
| Process component namespace | http://sap.com/xi/AP/PersonnelAdministration/Global |
| Deployment unit | Human Capital Management |
| Endpoint Activation | By Scoping of Process Component | Operations |
|
| Release Status | Not Released |
| Technical documentation on the SAP API Business Hub | Personnel Administration - Rehire an employee |
| General web service documentation | A2X Web Services (SOAP) |
An interface to rehire an employee from a source system or file. Currently, rehires can only be created.
The web service interface 'Manage Personnel Rehire In' enables you to connect external applications to your SAP Business ByDesign system and to maintain Employee Rehire data, and is relevant if your company wants to manage Employee Rehire data from external applications through its operation 'MaintainBundle'.
The following is an example of a simple rehire request in which an employee is rehired on 10-April-2014:
<n0:PersonnelRehireBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID></ID>
<UUID></UUID>
<ReferenceID></ReferenceID>
</BasicMessageHeader>
<PersonnelRehire actionCode="01">
<!-- Employee Rehire Date !-->
<RehireDate>2014-04-10</RehireDate>
<!-- Leaving date of an Employee is applicable only in case of temporary employee. In case of Permanent Employee please remove "LeavingDate" tag!-->
<LeavingDate>2015-04-10</LeavingDate>
<!-- Employee ID !-->
<Employee>
<ID>3389</ID>
</Employee>
<!-- Country of employment !-->
<Employment>
<CountryCode>DE</CountryCode>
</Employment>
<!-- Employee's workagreement data !-->
<WorkAgreement>
<TypeCode>2</TypeCode>
<AdministrativeCategoryCode>2</AdministrativeCategoryCode>
<AgreedWorkingHoursRate>
<DecimalValue>36</DecimalValue>
<BaseMeasureUnitCode>WEE</BaseMeasureUnitCode>
</AgreedWorkingHoursRate>
<!-- Employee's Org assignment details !-->
<OrganisationalCentreID>MC23200</OrganisationalCentreID>
<JobID>MC3400</JobID>
</WorkAgreement>
</PersonnelRehire>
</n0:PersonnelRehireBundleMaintainRequest_sync>
Personnel Administration should be in scope.
This service can only be used for rehiring of employees once in any system. Hence, only '01 = create' action code is supported in this service. All other action codes are hereby not supported.
Leaving date of an employee is applicable only in case of temporary employee. In the case of Permanent Employees, please remove 'LeavingDate' tag.
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
Possible scenarios include the following:
The MaintainBundle operation is used to create rehire data of employee
1. Employee details
2. Work agreement
3. Employment
The following is an example of a web service request for employee rehire:
<n0:PersonnelRehireBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID></ID>
<UUID></UUID>
<ReferenceID></ReferenceID>
</BasicMessageHeader>
<PersonnelRehire actionCode="01">
<!-- Employee Rehire Date !-->
<RehireDate>2014-04-10</RehireDate>
<!-- Employee ID !-->
<Employee>
<ID>3389</ID>
</Employee>
<!-- Country of employment !-->
<Employment>
<CountryCode>DE</CountryCode>
</Employment>
<!-- Employee's workagreement data !-->
<WorkAgreement>
<TypeCode>1</TypeCode>
<AdministrativeCategoryCode>2</AdministrativeCategoryCode>
<AgreedWorkingHoursRate>
<DecimalValue>36</DecimalValue>
<BaseMeasureUnitCode>WEE</BaseMeasureUnitCode>
</AgreedWorkingHoursRate>
<!-- Employee's Org assignment details !-->
<OrganisationalCentreID>MC23200</OrganisationalCentreID>
<JobID>MC3400</JobID>
</WorkAgreement>
</PersonnelRehire>
</n0:PersonnelRehireBundleMaintainRequest_sync>
The response of the service will have the following:
For successful execution -
1. UUID - Personnel Rehire business object
2. Change State ID
3. Referenced Sender Technical ID
4. Log for any warning or information messages.
For errors, the log is updated with errors.
The sample response of the service is as follows:
Response generated with <UUID> is an indicator that employee has been rehired successfully.
<n0:PersonnelRehireBundleMaintainConfirmation_sync xmlns:n0="http://sap.com/xi/SAPG/Global" xmlns:prx="urn:sap.com:proxy:QXX:/1SAI/TAE07222BC58A1:804"> <PersonnelRehire> <ChangeStateID>20150728111208.3295690</ChangeStateID> <UUID>00163e06-58b8-1ee5-8da3-2f676e3163b4</UUID> </PersonnelRehire> <Log> <MaximumLogItemSeverityCode>3</MaximumLogItemSeverityCode> <Item> <TypeID>060(/HCF_WORKAGREEMENT/)</TypeID> <CategoryCode>INC.BOI</CategoryCode> <SeverityCode>2</SeverityCode> <Note>10.04.2014 added to service start date</Note> </Item> </Log> </n0:PersonnelRehireBundleMaintainConfirmation_sync>
| Description | Rehire an employee |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
An interface to rehire an employee from a source system or file. Currently, rehires can only be created.
The web service interface 'Manage Personnel Rehire In' enables you to connect external applications to your SAP Business ByDesign system and to rehire employees and maintain their employment & work agreement details in your system, and is relevant if your company wants to access and manage employee data from external applications.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as Personnel Rehire node element that contains the employee data to be maintained. The detailed structure of the Personnel Rehire node will be explained in the following sub-chapters. The Personnel Rehire node can occur multiple times in the request message – this means that personnel rehire data for multiple employees can be maintained through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and an account-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as employee UUID.
Personnel Administration should be in scope.
The structure of operation Maintain Bundle contains general information of employee as well as Employment & Work Agreement nodes.
The data is visible on Personnel File screen under Personnel Administration work center when Personnel Administration is scoped in the system, and on Employee screen under Business Partners work center when Personnel Administration is not scoped.
The UUID element is not visible on the user interface but may be known out of the response of a read service.
The following are the details of each node structure of Personnel Rehire maintain bundle:
The Employee node element contains only employee ID of an employee who needs to be hired. Other relevant information like name, gender, date of birth, etc., will be picked up from previous employment details.
Employment node details contains country details for which an employee is being rehired.
Work Agreement node can be used to create work agreement for an employee.
Most commonly used codes are TypeCode, AdministrativeCategoryCode and BaseMeasureUnitCode.
| Work agreement Type Code | Description |
|---|---|
| 1 | Permanent |
| 2 | Temporary |
| 3 | Executive |
| 4 | Trainee |
| 5 | Working student |
| 6 | Retiree |
Administrative Category Codes are dependent on the county of employment and every country will have their specific category codes. Commonly used code are -
| AdministrativeCategoryCode | Country Code | Description |
|---|---|---|
| 1 | US | Hourly |
| 2 | US | Salaried Non-Exempt |
| 3 | US | Salaried Exempt |
| 1 | DE | Hourly-Paid Industrial Worker |
| 2 | DE | Salaried Employee |
| 3 | DE | Senior Executive |
| 4 | DE | Monthly-Paid Industrial Worker |
| Base Measure Unit Code | Description |
|---|---|
| DAY | Day |
| MON | Month |
| WEE | Week |
Example -
The following is an example of an XML snippet which will help rehire an employee for Germany with the employee's private address of US and work agreement of 35 hours per week with organization and job ID assignment.
<n0:PersonnelRehireBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID></ID>
<UUID></UUID>
<ReferenceID></ReferenceID>
</BasicMessageHeader>
<PersonnelRehire actionCode="01">
<!-- Employee Rehire Date !-->
<RehireDate>2014-04-10</RehireDate>
<!-- Employee ID !-->
<Employee>
<ID>3389</ID>
</Employee>
<!-- Country of employment !-->
<Employment>
<CountryCode>DE</CountryCode>
</Employment>
<!-- Employee's workagreement data !-->
<WorkAgreement>
<TypeCode>1</TypeCode>
<AdministrativeCategoryCode>2</AdministrativeCategoryCode>
<AgreedWorkingHoursRate>
<DecimalValue>36</DecimalValue>
<BaseMeasureUnitCode>WEE</BaseMeasureUnitCode>
</AgreedWorkingHoursRate>
<!-- Employee's Org assignment details !-->
<OrganisationalCentreID>MC23200</OrganisationalCentreID>
<JobID>MC3400</JobID>
</WorkAgreement>
</PersonnelRehire>
</n0:PersonnelRehireBundleMaintainRequest_sync>
The Manage Personnel Rehiring – Maintain Bundle can only be used for internal employees.
Employment
The element country code corresponds to the country to which an employee is being rehired.
Work Agreement
The element OrganisationalCentreID can be used to update the organization to which an employee belongs. AgreedWorkingHoursRate can be used to update the agreed working hours.
Show full documentation