External Lock

To set a lock on a dock appointment.

Technical Data

Entity Type	Service Operation
Release State	released
Technical Name	DockAppointmentExternalLockRequestConfirmation_In
Namespace	http://sap.com/xi/EWM/Global
Application Component	SCM-EWM
Web Service Definition (Back End)	/SCWM/BIF_YRD_DAPP_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 dock appointment. A locked dock appointment cannot be changed or cancelled by a user in the back-end system while the dock appointment is being changed by a service operation. The external lock prevents several users from making changes to one dock appointment at the same time. In the standard implementation, the lock is valid for the current day. A user can only change the dock appointment again after the validity period of the external lock has expired or after the External Unlock operation has been called.

Note

External LockRelated OperationsExternal Unlock

The External Lock operation has been designed to prevent users from making changes with back-end system reports or transactions while the dock appointment is being processed by a service operation. It serves purely technical purposes.

Related Operations

External Unlock

To remove the external lock from a dock 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 dock appointment

If successful, the operation returns a log along with the dock 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 dock appointment that is already locked.
If no dock 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

DockAppointmentExternalLockConfirmation_sync
DockAppointmentExternalLockRequest_sync

Notes on SAP Implementation

The Setting Date of Expiration of External Lock (/SCWM/EX_SR_BIF_LK_EXPIRE) Business Add-In (BAdI) is available for this operation.