Show TOC

 External Lock

 

To set a lock on a vehicle appointment.

Technical Data

Entity Type

Service Operation

Release State

released

Technical Name

VehicleAppointmentExternalLockRequestConfirmation_In

Namespace

http://sap.com/xi/EWM/Global

Application Component

SCM-EWM

Web Service Definition (Back End)

/SCWM/BIF_YRD_VAPP_LOCK_RC

Direction

inbound

Mode

synchronous

Idempotency

no

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 vehicle appointment. A locked vehicle appointment cannot be changed by a user in the back-end system while the vehicle appointment is being changed by a service operation. The external lock prevents several users from making changes to one vehicle appointment at the same time. In the standard implementation, the lock is valid for the current day. A user can only change the vehicle 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 vehicle appointment is being processed by a service operation. It serves purely technical purposes. If you want to block a vehicle 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 vehicle 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 vehicle appointment

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

  • In systems based on SAP EWM: If you get the error message Vehicle activity &1 was not found in the data (/SCWM/SHP_RCV 286), no vehicle was found for the yard resource appointment ID. Check if the yard resource appointment ID is correct.

Message Types

  • VehicleAppointmentExternalLockConfirmation_sync

  • VehicleAppointmentExternalLockRequest_sync

Notes on SAP Implementation

Configuration and Authorizations

For more information, see the Vehicle 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 vehicle appointments.