Show full documentation

 Show full documentation

Definition

An interface for synchronizing the worklist

Business Context and Use

The worklist of the timesheet shows the items that the employee will be working on, during any period of time. These items may be manually added by the employee, or be updated when there is a change in the project assignment of the employee.

This update of the worklist is currently a manual synchronization activity, which gets carried out only when the employee launches the timesheet. This becomes an issue when a customer wishes to use the worklist items for recording time via an external time recording application.

The service addresses exactly this problem – it can be called by the external application in order to update the worklist with any changes that could have come in as a result of changes in project assignment. The service can be called prior to querying the worklist for the existing set of items, this way an updated list will be sent to the application invoking the query on the worklist items.

The service may also be tied to a manual action on the external application, so that the user can call for a synchronization of the worklist items on demand.

The web service interface offers the operations SynchronizeWorklist

here is an example.

<n0:EmployeeWorklistSynchronizeActionRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
   <ID>Token 4</ID>
  <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
  <ReferenceID>Token 10</ReferenceID>
  <ReferenceUUID>12345678-90AB-CDEF-0123-456789ABCDEF</ReferenceUUID>
  </BasicMessageHeader>
 <EmployeeWorklist>
  <EmployeeUUID >12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
  <EmployeeID>EmployeeID</EmployeeID>
  <ChangeStateID></ChangeStateID>
 </EmployeeWorklist>
 </n0:EmployeeWorklistSynchronizeActionRequest_sync>

Prerequisites

• The time and labor management business workcenter is in scope.

• Worklist business object instance for the employee is created prior to the service being effective.

For an employee, the worklist business object is created as soon as the employee is hired in the ByD system.

For service agents, this would happen only when :

1. The timesheet is first opened by the service agent

OR

2. The service agent is assigned a valid purchase order against which time recording can be done.

The following business documents are only referenced and will not be created by the service operations. They must exist in the system already at the time the web service is called:

Employee with valid Employee ID

Time Agreement

Worklist of employee

Constraints and Integrity Conditions

General Rules for Using this Web Service

Communication Timeout

Maintain 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.

Message Header

Maintain bundle 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 ID or UUID of the BasicMessageHeader node element.

Change State ID

Using change state identifier (element name ChangeStateID), external applications can enforce that a modifying operation is not executed because the state of the business document has changed since the external application last read its data.

The change state ID is an uninterpretable string that is provided by query and read operations and can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document.

The web service consumer (external application) is responsible for preventing accidental changes to business documents.

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 Employee.

• Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request

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.

Scenarios

Possible scenarios include the following:

Synchronize the worklist.

here is an example.

<n0:EmployeeWorklistSynchronizeActionRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
   <ID>Token 4</ID>
  <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
  <ReferenceID>Token 10</ReferenceID>
  <ReferenceUUID>12345678-90AB-CDEF-0123-456789ABCDEF</ReferenceUUID>
  </BasicMessageHeader>
 <EmployeeWorklist>
  <EmployeeUUID >12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
  <EmployeeID>EmployeeID</EmployeeID>
  <ChangeStateID></ChangeStateID>
 </EmployeeWorklist>
 </n0:EmployeeWorklistSynchronizeActionRequest_sync>

The response for the service will be :

1. Successful: it will return the executed Employee UUID and Employee ID with the last sync date time , else it will return the an error message.

2. A Blank response is returned for invalid Emp id’s (Emp or service agent does not exist)

3. A Blank response is returned for service agent not assigned to a Purchase Order.

 Show full documentation

 Show full documentation

Definition

To synchronize the worklist

Business Context and Use

The worklist of the timesheet shows the items that the employee will be working on, during any period of time. These items may be manually added by the employee, or be updated when there is a change in the project assignment of the employee.

This update of the worklist is currently a manual synchronization activity, which gets carried out only when the employee launches the timesheet. This becomes an issue when a customer wishes to use the worklist items for recording time via an external time recording application.

The service addresses exactly this problem – it can be called by the external application to update the worklist with any changes that could have come in as a result of changes in project assignment. The service can be called prior to querying the worklist for the existing set of items, this way an updated list will be sent to the application invoking the query on the worklist items.

The service may also be tied to a manual action on the external application, so that the user can call for a synchronization of the worklist items on demand.

Structure

Element	Description
EMPLOYEE_ID	The employee for which the adjustments has to be updated.
Employee_UUID	The employee uuid in case available.