Definition
An interface to maintain employee time events.
Business Context and Use
This service is used by the External Time Recording System (ETRS) to upload time events into the SAP ByDesign system. This is an asynchronous message storing the received time events in business object Employee Time Event.
The time recording system has the responsibility to collect time events from the time recording terminal and periodically upload the time events to the SAP ByDesign system using the service Employee Time Event Bundle Create Request. The scheduling of this upload is in the responsibility of ETRS.
The terminal shall not upload time events for employees not participating in external time recording.
More Information
General Information
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.
Definition
To create employee time events for one or more employees. Either all or no employee time events are created.
Business Context and Use
This service is offered to upload time events from external time recording terminals to the ByDesign system through a request message “Employee Time Event Bundle Create Request”.
Structure
| Structure Element |
Description |
|---|
| ID |
Unique GUID generated for each message, such as 00300571D06B1DDCA08F250379A2417B |
| CreationDateTime |
Creation time stamp of the message, such as 2008-12-31T23:59:59.1234Z |
| SenderParty-InternalID |
The ID of the sending business system. Currently fixed value 'ETRS' to be used |
| SenderParty-InternalID-schemeID |
Fixed value = 'CommunicationSystemID' |
| SenderParty-InternalID-schemeAgencyID |
Fixed value = '310' |
| BusinessScope-TypeCode |
2 stands for the receiving process component. Fixed value = '2' |
| BusinessScope-TypeCode-listID |
Fixed value = '25201' |
| BusinessScope-TypeCode-listAgencyID |
Fixed value = '310' |
| BusinessScope-ID |
Fixed Value = '29'. 29 stands for the process component 'Time and Labour Management'. |
| BusinessScope-ID-schemeID |
Fixed value = '10555' |
| BusinessScope-ID-schemeAgencyID |
Fixed value = '310' |
| BusinessScope-TypeCode |
Fixed value = '3'. '3' stands for the receiving process component. |
| BusinessScope-TypeCode-listID |
Fixed value = '25201' |
| BusinessScope-TypeCode-listAgencyID |
Fixed value = '310' |
| BusinessScope-ID |
Fixed Value = '251'. 251 stands for the process component 'External Employee Time Recording'. |
| BusinessScope-ID-schemeID |
Fixed value = '10555' |
| BusinessScope-ID-schemeAgencyID |
Fixed value = '310' |
| EmployeeTimeEvent-EmployeeTimeRecordingCardID |
Identifier of the time recording card by means of which the time event was recorded, such as 4829 |
| EmployeeTimeEvent-TypeCode |
The time event code, such as '1'. The values are: <1> - Clock in. <2> - Clock out |
| EmployeeTimeEvent-ReasonCode |
The reason for an employee time event item, such as DE01. The reason describes why the employee has interrupted his regular work. Example: Doctor appointment.The List of available time event reason codes is defined in business configuration as part of fine tuning. |
| EmployeeTimeEvent-DateTime |
The date and time when the event takes place |
| EmployeeTimeEvent-DateTime-timeZoneCode |
The time zone of the time stamp. |
| EmployeeTimeEvent-DateTime-daylightSavingTimeIndicator |
The daylight saving time indicator of the time stamp. |
| EmployeeTimeEvent-EmployeeTimeRecordingDeviceID |
Identifier of the time recording device on which the time event was recorded |
Example
<n0:EmployeeTimeEventBundleCreateRequest xmlns:n0="http://sap.com/xi/AP/TimeAndLabourManagement/Global" xmlns:prx="urn:sap.com:proxy:AFP:/1SAI/TXS68229981E977B4F25E5B:710:2008/01/11">
<MessageHeader>
<ID>00300571D06B1DDCA08F250379A2417C</ID>
<CreationDateTime>2011-11-30T08:00:59.1234Z</CreationDateTime> <SenderParty>
<InternalID schemeID="CommunicationSystemID" schemeAgencyID="310">ETRS</InternalID>
</SenderParty>
<BusinessScope>
<TypeCode listID="25201" listAgencyID="310">2</TypeCode>
<ID schemeID="10555" schemeAgencyID="310">29</ID>
</BusinessScope>
<BusinessScope>
<TypeCode listID="25201" listAgencyID="310">3</TypeCode>
<ID schemeID="10555" schemeAgencyID="310">251</ID>
</BusinessScope>
</MessageHeader>
<EmployeeTimeEvent>
<EmployeeTimeRecordingCardID>9001</EmployeeTimeRecordingCardID> <TypeCode>1</TypeCode>
<DateTime timeZoneCode="CET" daylightSavingTimeIndicator="true">2011-11-30T08:00:00</DateTime>
<EmployeeTimeRecordingDeviceID>DEV01</EmployeeTimeRecordingDeviceID> </EmployeeTimeEvent>
<EmployeeTimeEvent>
<EmployeeTimeRecordingCardID>9001</EmployeeTimeRecordingCardID> <TypeCode>2</TypeCode>
<DateTime timeZoneCode="CET" daylightSavingTimeIndicator="true">2011-11-30T17:30:00</DateTime>
<ReasonCode>DE01</ReasonCode>
<EmployeeTimeRecordingDeviceID>DEV01</EmployeeTimeRecordingDeviceID> </EmployeeTimeEvent>
</n0:EmployeeTimeEventBundleCreateRequest>
Show full documentation
Show full documentation