| Description | Manage Employee Time Profile |
| Name | MangeTimxProfileIn |
| Namespace | http://sap.com/xi/AP/TimeAndLabourManagement/Global |
| Product | SAP Business ByDesign |
| Process component | Time and Labour Management |
| Process component namespace | http://sap.com/xi/AP/TimeAndLabourManagement/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 | Manage Employee Time Profile |
| General web service documentation | A2X Web Services (SOAP) |
An interface to replicate or create Employee Time Profile from a source system or file.
The web service interface Manage Employee Time profile In enables you to connect external applications to your SAP Business ByDesign system and to create and edit time profiles in your system.
It enables you to change the time recording method, assign a time model and add time accounts.
The web service interface manage Employee Time Profile In is relevant if your company wants to manage Employee Time Profiles from external applications.
The web service interface Manage Employee Time ProfileIn offers the operations MaintainBundle.
Here is an example of a simple web service request:
<n0:EmployeeTimeProfileMaintainBundleRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>1</ID>
<UUID/>
<ReferenceID/>
<ReferenceUUID/>
</BasicMessageHeader>
<TimeProfile>
<ObjectNodeSenderTechnicalID>1</ObjectNodeSenderTechnicalID>
<EmployeeUUID/>
<EmployeeID>1234580</EmployeeID>
<DatePeriod>
<StartDate>2023-01-01</StartDate>
<EndDate>9999-12-31</EndDate>
</DatePeriod>
<PlanedWorkTime>
<ActionCode>04</ActionCode>
<ModelId>PNOR2</ModelId>
<TimeRecordingIndicator>true</TimeRecordingIndicator>
<TimeAccProV>
<EmployeeTimeAccountTypeCode listID="" listAgencyID="">US0010</EmployeeTimeAccountTypeCode>
<EmployeeTimeAccountProcessingRuleCode listID="US0010" listAgencyID="">11</EmployeeTimeAccountProcessingRuleCode>
</TimeAccProV>
</PlanedWorkTime>
</TimeProfile>
</n0:EmployeeTimeProfileMaintainBundleRequest_sync>
The Business area Time And Labor Management is in scope and content is deployed.
General Rules for Using this Web Service
MaintainTimeProfileBundle
Maintain TimeProfileBundle operations enable external applications to create and change business document data. TimeProfileBundle operations enable external applications to simulate maintain bundle requests without changing business document data. In particular, Maintain TimeProfile Bundle operations have the following functions:
• Return system messages similar to corresponding maintain bundle operations
• Provide the same message type as the corresponding operation Maintain Bundle
• Do not assign internal numbers from a productive number range interval (number range statuses are not increased)
• Do not change business documents
Action Code
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.
Action Code Description
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.
| Action Code | Description |
|---|---|
| 04 | Save; the system creates or changes the node element data. |
| 05 | Remove; the system deletes the node element. If the node element does not exist, the system does not send an error message. |
Note: Action code 04 (Save) creates business documents if the system could not identify a matching target business document. This applies in particular if no business document ID or UUID is provided by the web service consumer. The web service consumer (external application) is responsible for providing correct business document IDs or UUIDs and to avoid accidental creation of duplicate business documents.
List Processing
The processing of node elements with cardinality > 1 (for example a list of descriptions in different languages or a list of working time period) can be controlled using List Complete Transmission Indicators (LCTI). The LCTI indicates whether a list of node elements is transmitted completely. The LCTI of a node element with cardinality > 1 is modeled as an attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).
LCTI Description
false The list of node elements is not transmitted completely and hence all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be identified uniquely, the system processes the node elements according the action code. If transmitted node elements in the list cannot be identified uniquely, the system appends the node element to the corresponding list of node elements in the target business document.
true The list of elements is transmitted completely and hence all node elements that are not transmitted are removed. If no node element is transmitted, the complete list is removed.
Default list complete transmission indicator: false.
Note: The LCTI refers to the completeness of the list of node elements and does not state completeness of sub-elements.
Example
Empty and Missing Elements
Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.
Example
Communication Timeout
Maintain Time Profile Bundle operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer is responsible for ensuring reasonable sizes of data for mass operations.
If too many employees / time models back dated changes occur, then there may be Time Outs, so limit the backdates of time models and the number of employees in one execution of the web service.
Message Header
Maintain Time Profile bundle operations support exactly one execution (idem potency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements EmployeeUUID or EmployeeID of the BasicMessageHeader node element.
Object Node Sender Technical Identifier
Request node elements with cardinality > 1 contain an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message.
The object node sender technical identifiers are provided as ObjectNodeSenderTechnicalID in request message types and referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types.
If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request is returned as the reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID is returned as initial as well.
Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements for only a single call. The web service consumer is not required to specify them or to use the same values for different calls. Also, the service provider does not interpret these values at all, but returns them to the web service consumer instead in the ReferenceObjectNodeSenderTechnicalID elements.
Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.
Example
Request:
<BasicMessageHeader>
<ID>1</ID>
<UUID/>
<ReferenceID/>
<ReferenceUUID/>
</BasicMessageHeader>
Response:
<n0:EmployeeTimeProfileMaintainBundleConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCH:/1SAI/TASA57156EFDCD817313B47:804"/>
Response Message
The structure of the response message consists of two parts:
• A business document-specific part containing information about IDs and UUIDs of the created and changed business documents
• Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request
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.
Scenarios
Possible scenarios include the following:
• Create a new Employee Time Profile
The MaintainBundle operation is used to create a new working time profile
• Update the Employee Time Profile
The MaintainBundle operation is used to update the working time profile.
Here is an example web service request to update TimeProfile including Time acc prov :
<n0:EmployeeTimeProfileMaintainBundleRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>1</ID>
<UUID/>
<ReferenceID/>
<ReferenceUUID/>
</BasicMessageHeader>
<TimeProfile>
<ObjectNodeSenderTechnicalID>1</ObjectNodeSenderTechnicalID>
<EmployeeUUID/>
<EmployeeID>1234580</EmployeeID>
<DatePeriod>
<StartDate>2023-01-01</StartDate>
<EndDate>9999-12-31</EndDate>
</DatePeriod>
<PlanedWorkTime>
<ActionCode>04</ActionCode>
<ModelId>PNOR2</ModelId>
<TimeRecordingIndicator>true</TimeRecordingIndicator>
<TimeAccProV>
<EmployeeTimeAccountTypeCode listID="" listAgencyID="">US0010</EmployeeTimeAccountTypeCode>
<EmployeeTimeAccountProcessingRuleCode listID="US0010" listAgencyID="">11</EmployeeTimeAccountProcessingRuleCode>
</TimeAccProV>
</PlanedWorkTime>
</TimeProfile>
</n0:EmployeeTimeProfileMaintainBundleRequest_sync>
| Description | Maintain employee time profile bundle |
| Name | MaintainTimeProfileBundle |
| Synchronous | yes |
| Release Status | Released |
A process agent that creates, updates, and deletes Employee time profile data i.e., time model, time recording method and Time account from a source system or file to an SAP Business ByDesign system.
Show full documentation