Show TOC

 External Unlock

 

To remove an external lock from a dock appointment.

Technical Data

Entity Type

Service Operation

Release State

released

Technical Name

DockAppointmentExternalUnlockRequestConfirmation_In

Namespace

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

Application Component

SCM-EWM

Web Service Definition (Back End)

/SCWM/BIF_YRD_DAPP_ULOCK_RC

Direction

inbound

Mode

synchronous

Idempotency

no

Change/Update Behavior

not applicable

P2P Communication Enabled

true

Business Context and Use

The External Unlock inbound operation is a request to the Site Logistics Processing  process component to remove an external lock that has been set on a dock appointment by the  External Lock operation. Removing an external lock from a dock appointment allows all users to change the dock appointment again in change functions of the back-end system. For more information about the business context, see the External Lock operation.

Note
External UnlockExternal Lock
The External Unlock operation has been designed to remove the purely technical locks that have been set by the External Lock operation. If you want to unlock dock appointments that have been locked using locking mechanisms in your back-end systems, use the unlock functions in your back-end systems.

Features

The External Unlock 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 with the dock appointment as output.

Error Handling

Consider the following during error handling:

  • The system raises an error message if you call the External Unlock operation for a dock appointment that is not 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

  • DockAppointmentExternalUnlockConfirmation_sync

  • DockAppointmentExternalUnlockRequest_sync