pub.synchronization.latch:isLatchClosed

WmPublic. Checks a resource's latch status.

By checking the latch status, you can determine whether a resource has been updated.

Input Parameters

appId	String A unique identifier for the resource for which you want to check the latch status. Typically, the appId is the name of the adapter or the resource.
canonicalKey	String The canonical key. A unique identifier for the canonical document used in the synchronization.
objectId	String A unique identifier for the object or process being synchronized. Typically, the objectId field is set to the name of the business process for which you are performing synchronization, such as "order" or "customer."

Output Parameters

isLatchClosed

String The status of the latch. A value of:

true indicates that the latch is closed. The resource has been updated.

false indicates that the latch is open. The resource has not been updated.

Usage Notes

Use the latch status to determine whether or not to update the resource.

If the latch is closed (isLatchClosed is true), the resource is already updated. Use the pub.synchronization.latch:openLatch service to end execution of the update and open the latch in preparation for the next update to the resource.

If the latch is open (isLatchClosed is false), the resource has not yet been updated. Invoke services to locate and update the record in the target resource. Then invoke the pub.synchronization.latch:closeLatch service to close the latch and prevent circular updates.

For more information about using the pub.synchronization.latch services to prevent echo suppression, see the Publish-Subscribe Developer’s Guide.