External Lock

To set a lock on a transportation unit appointment.

Technical Data

Entity Type	Service Operation
Release State	released
Technical Name	TransportationUnitAppointmentExternalLockRequestConfirmation_In
Namespace	http://sap.com/xi/EWM/Global
Application Component	SCM-EWM
Web Service Definition (Back End)	/SCWM/BIF_YRD_TAPP_LOCK_RC
Direction	inbound
Mode	synchronous
Idempotency	no
Change/Update Behavior	not applicable
P2P Communication Enabled	true

Business Context and Use

The External Lock inbound operation is a request to the Site Logistics Processing process component to set an external lock on a transportation unit appointment. A locked transportation unit appointment cannot be changed by a user in the back-end system while the transportation unit appointment is being changed by a service operation. The external lock prevents several users from making changes to one transportation unit appointment at the same time. In the standard implementation, the lock is valid for the current day. A user can only change the transportation unit appointment again after the validity period of the external lock has expired or after the External Unlock operation has been called.

Note

The External Lock operation has been designed to prevent users from making changes with back-end system reports or transactions while the transportation unit appointment is being processed by a service operation. It serves purely technical purposes. If you want to block a transportation unit appointment for business reasons, for example, during arrivals, departures, goods movements, loading, or unloading, do not use the External Lock operation. Use the functions that are available in the back-end system.

Related Operations

To remove the external lock from a transportation unit appointment, you must use the External Unlock operation.

Features

The External Lock operation requires the following data as input:

Universal unique identifier (UUID) of the external lock
Yard resource appointment ID of the transportation unit appointment

If successful, the operation returns a log along with the transportation unit appointment and the lock expiration date as output.

Error Handling

Consider the following during error handling:

The system raises no error message if you call the External Lock operation for a transportation unit appointment that is already locked.
If no transportation unit was found for the yard resource appointment ID, the system returns an error message. Check if the yard resource appointment ID is correct.

Message Types

TransportationUnitAppointmentExternalLockConfirmation_sync
TransportationUnitAppointmentExternalLockRequest_sync

Notes on SAP Implementation

Configuration and Authorizations

For more information, see the Transportation Unit Appointment business object.

Enhancements

The Business Add-In (BAdI) Setting Date of Expiration of External Lock (/SCWM/EX_SR_BIF_LK_EXPIRE) is available for this operation. With this BAdI, you can change the expiration of the lock on transportation unit appointments.