Resource Lock

The resourceLock APIs help provide data consistency in an environment where multiple client applications can access the same resource, such as a loan.


Supported Resources

This API currently supports operations on the loan resource. Other resources will be supported in a future release.

When a loan is locked, all resources (contacts, eFolder, etc) within the loan inherit that lock.
There are two types of resource locks:

  • V3 Resource Lock types: exclusive and NGSharedLock
    "lockType":"exclusive" | "NGSharedLock"
  • V1 Resource Lock types: exclusive and shared
    "lockType":"exclusive" | "shared"


An exclusive resource lock should be used carefully. Acquiring an exclusive lock causes Encompass to grant the currently logged-in user exclusive write access to the resource. Authorized users can read a locked resource, but they cannot delete or update the resource. Attempting to lock a resource that has an exclusive lock, returns a message to the user stating that the resource is already locked and provides an option of opening the resource in read-only mode. The Encompass SmartClient currently only acquires an exclusive lock.


In most cases, a shared resource lock is recommended. A shared lock allows multiple users to share write access to the resource. When a user has a shared lock on a resource, other users can edit the resource by retrieving a shared lock on that resource as well. Any updates to the resource while locked are applied sequentially as they occur. When a shared lock is applied to a resource, an exclusive lock cannot be obtained.