Encompass Desktop Shared Lock and Restricted Operations

📘

As of this writing, the functionality described in this knowledge article is in Limited Availability and is optional. It is not applied automatically. Please refer to the instructions below for enabling this feature:

1. Request Encompass Desktop Shared Lock be Enabled - After upgrading to Encompass 26.1 or later, submit a Standard Support Case through the ICE Resource Center to enable this feature.
2. Test First - Request the new functionality be applied to your Encompass instance in a UAT or other test environment so you can determine how this type of shared lock (concurrent editing) works and affects your loan workflows and processes with non-production loans.

To remove this functionality from your Encompass instance later, submit a new Standard Support Case.

Encompass Desktop Shared Lock - Why is it needed?

Problem - Exclusive Loan Locks Create Delays

Before release 26.1, Encompass desktop could only place an “exclusive lock” when a loan is open. This resulted in backend API Integrations* being blocked from updating a loan while it was under an exclusive lock. Since loans may remain open in Encompass desktop for longer periods of time, API Integrations had to wait, poll, and/or retry during these exclusive lock time periods. This hindered the speed of operations.

* API Integrations - Encompass Developer Connect, EPC Service Integrations, and/or Plug-ins 2.0.

Solution - Encompass Desktop Shared Lock

As of release 26.1, backend API Integrations can update a loan while the loan is open in the Encompass desktop interface by using an optional “Desktop Shared Lock” functionality. This aligns Encompass desktop behavior with Encompass web and Encompass Developer Connect. No more waiting for loans to be unlocked.

How It Works

1. Encompass desktop user opens a loan. This creates a Desktop Shared Lock.
2. Backend API Integrations can update the loan while it is open in Encompass desktop.
3. Encompass desktop users can continue working on the loan uninterrupted.
4. External changes are merged after the Encompass desktop user saves the loan.

❗️

Certain API Integration loan operations are restricted while the loan is open in Encompass desktop. See Shared Lock and Restricted Operations below for more details.

Shared Lock and Restricted Operations

Review the following details about the restricted operations for the Encompass Desktop Share Lock feature:

• Prevents data conflicts and protects loan integrity.
• When the loan is open in Encompass desktop, only the Encompass desktop user may perform “restricted operations”.
• Restricted operations include the following V1 Borrower Pair APIs:
  • V1 Create Borrower Pair
    /encompass/v1/loans/{loanId}/applications
  • V1 Delete Borrower Pair
    /encompass/v1/loans/{loanId}/applications/{applicationId}
  • V1 Move Borrower Pair
    /encompass/v1/loans/{loanId}/applications
• Any API Integrations that attempt these operations, during this time, will return a “409 Conflict” error.
• After the loan is closed in Encompass desktop, the API Integration may perform restricted operations.

The response contracts for the V1 and V3 Resource Lock APIs include the following new attribute:

Sample Response for V3 Resource Lock

[
    {
        "id": "b5c684b2-e990-4c9d-890c-dd54fa33433e",
        "resource": {
            "entityId": "2c2a9811-c3fb-48ef-9640-89bcecee9d6e",
            "entityType": "Loan"
        },
        "userId": "lotest2",
        "fullName": “Loan Officer",
        "userType": "Internal",
        "lockType": "NGSharedLock",
        "lockTime": "2026-02-03T10:00:02Z",
        "restricted": true 
    } 
] 

Important Considerations on Resource Locks

• Use a Resource Lock to place a temporary hold on the loan resource, while an API integration runs.
• The Resource Lock types are the following:
  • Exclusive Lock – Prevents all other users from accessing the loan. Use with caution since it blocks both end users and system access.​
  • NGShared Lock – Prevents subsequent end users from opening the loan in Encompass. Prevents API users from creating Exclusive Locks.​
  • NGShared Lock with Restrictions ("lockType": "NGSharedLock", "restricted": true) This is a new type of resource lock introduced in release 26.1.​
    • Functions the same as an NGShared Lock, and indicates the loan is currently open in Encompass desktop.
    • The restricted attribute cannot be set by the API user. It is RetrieveOnly.​
    • The restricted attribute is not refreshed when the user closes the loan in Encompass desktop.
• Cleanup Requirement – You should delete the Resource Lock when the API integration is complete.

Resource Lock Truth Table

The following Truth Table illustrates the behavior when an application/service attempts to lock and/or update a loan when another application/service currently has the loan open/locked.

¹ API Integration: Encompass Developer Connect, EPC Service Integrations, and/or Plug-ins 2.0.

² Restricted Operations: Create or Delete Borrower Pair, and Swap/Move Borrowers.

³ Encompass web: Encompass web and other connect products.​

❗️

Planned Enhancements and Known Issues

For a list of known issues for Plugins 2.0 and Encompass Desktop Shared Lock (currently in LA), review the following Knowledge Article: Resource Center Article Number: 000116298