| Description | Personnel Administration - Hire an employee |
| Name | ManagePersonnelHiringIn |
| 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 - Hire an employee |
| General web service documentation | A2X Web Services (SOAP) |
An interface is used only to hire an employee.
The web service interface 'Manage Personnel Hiring In' enables you to connect external applications to your SAP Business ByDesign system and to maintain Employee Hire data, and is relevant if your company wants to manage Employee Hire data from external applications through its operation 'MaintainBundle'.
The following is an example of a simple hire request in which an employee is hired on 01-jan-2010:
<n0:PersonnelHiringBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID />
<UUID />
<ReferenceID />
<ReferenceUUID />
</BasicMessageHeader>
<PersonnelHiring actionCode="01">
<ObjectNodeSenderTechnicalID>1</ObjectNodeSenderTechnicalID>
<HireDate>2010-01-01</HireDate>
<!-- Employee Personal details !-->
<Employee>
<GivenName>Kate</GivenName>
<FamilyName>Jacob</FamilyName>
<MiddleName></MiddleName>
<AdditionalFamilyName>JK</AdditionalFamilyName>
</Employee>
<!-- Country of Employment is US in this example !-->
<Employment>
<CountryCode>US</CountryCode>
</Employment>
<!-- Workagreement details for an employee !-->
<WorkAgreement>
<TypeCode>1</TypeCode>
<AdministrativeCategoryCode>1</AdministrativeCategoryCode>
<AgreedWorkingHoursRate>
<DecimalValue>34</DecimalValue>
<BaseMeasureUnitCode>WEE</BaseMeasureUnitCode>
</AgreedWorkingHoursRate>
<OrganisationalCentreID>MC23200</OrganisationalCentreID>
<JobID>MC3010</JobID>
</WorkAgreement>
</PersonnelHiring>
</n0:PersonnelHiringBundleMaintainRequest_sync>
Personnel Administration is in scope.
This service can only be used for hiring 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.
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 hire data of employee
1. Employee details
2. Work agreement
3. Employment
The following is an example of a web service request for employee hiring:
The response of the service will have the following:
For successful execution -
1.UUID - Personnel Hire 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 the employee has been hired successfully.
| Description | Hire an employee |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
An interface to hire an employee from a source system or file. Currently, hires can only be created.
The web service interface 'Manage Personnel Hiring In' enables you to connect external applications to your SAP Business ByDesign system and to create employees and 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 hiring node element that contains the employee data to be maintained. The detailed structure of the personnel hiring node will be explained in the following sub-chapters. The personnel hiring node can occur multiple times in the request message – this means that personnel hiring 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 an employee as well as Employment & WorkAgreement nodes.
The data is visible on the Personnel File screen under Personnel Administration work center when Personnel Administration is scoped and on Employees 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 Hiring maintain bundle:
The Employee node element contains all general account information such as ID, name, gender, private address and other identification details.
The following are example code values for element Gender code and Marital Status code:
| GenderCode | Description |
|---|---|
| 0 | Gender not known |
| 1 | Male |
| 2 | Female |
| MaritalStatusCode | Description |
|---|---|
| 1 | Single |
| 2 | Married |
| 3 | Widowed |
| 4 | Divorced |
| 5 | Separated |
| 6 | Domestic Partnership |
The Private Address node element can be used to create an employee’s private addresses.
Example
<PrivateAddress> <CountryCode>US</CountryCode> <RegionCode>CA</RegionCode> <CityName>San Roman</CityName> <StreetPostalCode>21135</StreetPostalCode> <POBoxPostalCode>51123</POBoxPostalCode> <POBoxID>33215</POBoxID> <StreetName>street apprt</StreetName> <HouseID>D-56</HouseID> <PhoneNumberDescription>1133125604</PhoneNumberDescription> <MobilePhoneNumberDescription>3076193028</MobilePhoneNumberDescription> <EmailURI>email@notamail.com</EmailURI> </PrivateAddress>
Note: An address that has been saved cannot be deleted, and hence instances of the AddressInformation node element cannot be deleted in this case.
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 country of employment and every country will have their specific category codes. Commonly used codes 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 hire 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:PersonnelHiringBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
</BasicMessageHeader>
<PersonnelHiring actionCode="01">
<HireDate>2010-01-24</HireDate>
<!-- Employee Basic data !-->
<Employee>
<GivenName>Kate</GivenName>
<FamilyName>Jacob</FamilyName>
<MiddleName>Kumar</MiddleName>
<AdditionalFamilyName></AdditionalFamilyName>
<FormOfAddressCode>1</FormOfAddressCode>
<AcademicTitleCode>1</AcademicTitleCode>
<GenderCode>1</GenderCode>
<MaritalStatusCode>1</MaritalStatusCode>
<NationalityCountryCode>US</NationalityCountryCode>
<BirthName>Ashu</BirthName>
<BirthDate>1983-03-12</BirthDate>
<BirthPlaceName>Haridwar</BirthPlaceName>
<!-- Employee Private address details - US Address!-->
<PrivateAddress>
<CountryCode>US</CountryCode>
<RegionCode>CA</RegionCode>
<CityName>San Roman</CityName>
<StreetPostalCode>21135</StreetPostalCode>
<POBoxPostalCode>51123</POBoxPostalCode>
<POBoxID>33215</POBoxID>
<StreetName>street apprt</StreetName>
<HouseID>D-56</HouseID>
<PhoneNumberDescription>1133125604</PhoneNumberDescription>
<MobilePhoneNumberDescription>3076193028</MobilePhoneNumberDescription>
<EmailURI>email@notamail.com</EmailURI>
</PrivateAddress>
</Employee>
<!-- Country of Employment - Germany !-->
<Employment>
<CountryCode>DE</CountryCode>
</Employment>
<!-- Workagreement details - 35 Hours / Week !-->
<WorkAgreement>
<TypeCode>1</TypeCode>
<AdministrativeCategoryCode>2</AdministrativeCategoryCode>
<AgreedWorkingHoursRate>
<DecimalValue>35</DecimalValue>
<BaseMeasureUnitCode>WEE</BaseMeasureUnitCode>
</AgreedWorkingHoursRate>
<!-- Org center id !-->
<OrganisationalCentreID>10400000</OrganisationalCentreID>
<!-- Job id !-->
<JobID>MC3400</JobID>
</WorkAgreement>
</PersonnelHiring>
</n0:PersonnelHiringBundleMaintainRequest_sync>
The Manage Personnel Hiring – Maintain Bundle can only be used for internal employees.
Employment
The element country code corresponds to a country to which an employee is being hired.
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