Definition
An interface to provide information to setup an external time recording system.
Business Context and Use
This message is sent from the SAP ByDesign system to the External Time Recording System (ETRS) as synchronous response to a query triggered by the ETRS. The response contains the Employee Time Recording Card ID, the name of the employee as well as the information on whether the employee participates in external time recording. The message contains all employees requested via the query that have an Employee Time Recording Card ID maintained in the SAP ByDesign system, not depending on whether the employee participates in time recording via terminals.
The scheduling of the query is in the responsibility of ETRS.
Example
<n0:EmployeeTimeAgreementTimeRecordingSystemSetupByElementsQuery_sync xmlns:n0="http://sap.com/xi/AP/TimeAndLabourManagement/Global"> <MessageHeader>
<ID>00300571D06B1DED92A0C57978891967</ID>
<CreationDateTime>2012-07-20T06:42:37.789+01:00</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> <EmployeeTimeAgreementTimeRecordingSystemSetupSelectionByElements> <CompanyID>MC1000</CompanyID> </EmployeeTimeAgreementTimeRecordingSystemSetupSelectionByElements> </n0:EmployeeTimeAgreementTimeRecordingSystemSetupByElementsQuery_sync>
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 provide information for the setup of an external time recording system.
Business Context and Use
This service is offered to retrieve employee master data information from the ByDesign system that are required for the operation of the External Time Recording System. The communication is organized as a query response messages with message types
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 |
| EmployeeUUID |
Unique GUID generated for each employee, such as 4829 |
| EmployeeID |
Employee ID, such as MC1572 |
| EmployeeTimeRecordingCardID |
Time recording card ID, such as 4809 |
| EmployeeTimeEventUsageCode |
A usage code for employee master data for external time recoding system, such as 1. The values are: <1> - Time events are used for working time determination in the SAP ByDesign system, that is, the employee is participating in time recording via terminals. <No code value> or <value other than 1> - The employee is not participating in time recording via terminals. The employee information is contained in the message as the employee has been assigned an Employee Time Recording Card ID in the SAP ByDesign system (Example, for access control usage) |
| StartDate |
Start Date of Employee Time Agreement, such as 2012-01-01 |
| EndDate |
End Date of Employee Time Agreement, such as 2018-12-31 |
| GivenName |
Employee given name, such as Pete |
| FamilyName |
Employee family name, such as Graham |
| FormattedName |
Employee formatted name, for example, for display at the terminal, such as Pete Graham |
| NonVerbalCommunicationLanguageCode |
EN |
Sample Query
<n0:EmployeeTimeAgreementTimeRecordingSystemSetupByElementsQuery_sync xmlns:n0="http://sap.com/xi/AP/TimeAndLabourManagement/Global"> <MessageHeader>
<ID>00300571D06B1DED92A0C57978891967</ID>
<CreationDateTime>2012-07-20T06:42:37.789+01:00</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> <EmployeeTimeAgreementTimeRecordingSystemSetupSelectionByElements> <CompanyID>MC1000</CompanyID> </EmployeeTimeAgreementTimeRecordingSystemSetupSelectionByElements> </n0:EmployeeTimeAgreementTimeRecordingSystemSetupByElementsQuery_sync>
Sample Response
<nm:EmployeeTimeAgreementTimeRecordingSystemSetupByElementsResponse_sync xmlns:nm="http://sap.com/xi/AP/TimeAndLabourManagement/Global" xmlns:prx="urn:sap.com:proxy:HGE:/1SAI/TAS0B289CE66336FE4924A5:804"> <MessageHeader>
<ID>00163E0344211ED287B6588C99961EB3</ID>
<CreationDateTime>2012-10-24T08:14:01.681775Z</CreationDateTime> </MessageHeader>
<EmployeeTimeAgreementTimeRecordingSystemSetup>
<EmployeeUUID>00145ef5-88e6-02db-bcdf-489a915c84ec</EmployeeUUID> <EmployeeID>MC1572</EmployeeID>
<EmployeeTimeRecordingCardID>7353</EmployeeTimeRecordingCardID> <EmployeeTimeEventUsageCode>1</EmployeeTimeEventUsageCode> <EmployeeCommon>
<ValidityPeriod>
<StartDate>0001-01-01</StartDate>
<EndDate>9999-12-31</EndDate>
</ValidityPeriod>
<GivenName>Pete</GivenName>
<FamilyName>Graham</FamilyName>
<FormattedName>Pete Graham</FormattedName> <NonVerbalCommunicationLanguageCode>DE</NonVerbalCommunicationLanguageCode>
</EmployeeCommon>
</EmployeeTimeAgreementTimeRecordingSystemSetup>
</nm:EmployeeTimeAgreementTimeRecordingSystemSetupByElementsResponse_sync>
Show full documentation
Show full documentation