Loan Folder Move - API Version

The Loan Folder Move tool automatically relocates a loan to a designated loan folder within Encompass whenever a trigger field is populated. The API version runs entirely on Lender Toolkit’s hosted infrastructure using the Encompass API — there is no desktop plug-in or DLL deployed to user machines.

When a user or business rule sets the trigger field CX.LOAN.FOLDER.MOVE to a target folder name and the loan is saved, the tool detects the change through an Enhanced Field Change (EFC) webhook, validates the destination folder, checks for resource locks, moves the loan, and then clears the trigger field to prevent re-triggering.

Benefits

• Automatic, real-time folder moves — no manual filing
  
• Server-side processing — nothing to install on user workstations
  
• Folder validation prevents moves to invalid or unauthorized folders
  
• Automatic retry for loans that are locked at the time of the move
  
• Admin-friendly configuration — re-uses your existing trigger rules
  

Activation

The API version of Loan Folder Move is activated for your Encompass instance through the Toolshed Portal. Unlike the SDK version, there is no installation package (.empkg) to import.

1. Sign in to the Toolshed Portal with an administrator account and select the correct Encompass® instance.
   
2. Open Settings → Enabled Products.
   
3. Locate Loan Folder Move and click Activate. If prompted, allow the portal to provision the required custom field(s).
   
4. Confirm the product shows as Active for the instance.
   

How to Use the Tool

Automated Move (Trigger Rule)

Loan Folder Move is fully automated. Administrators configure an Encompass® business rule (field trigger) that writes the destination folder name into the trigger field CX.LOAN.FOLDER.MOVE. When the loan is saved, the tool moves the loan to that folder.

• Trigger field: CX.LOAN.FOLDER.MOVE
  
• Value to set: the exact destination loan folder name (for example Active, Closed, or Suspended)
  
• Re-using SDK rules: the triggering field is unchanged from the SDK version, so any existing trigger rules can be re-used as-is — no rebuild required.
  

Processing Behavior

• Folder Validation: The target folder is validated against the instance’s loan folders before the move. Invalid or non-allowed folders result in no move.
  
• Locked-Loan Retry: If the loan is locked, the move is retried automatically (5 minutes, then 15 minutes, then 30-minute intervals) for up to 12 attempts.
  
• Field Clearing: After processing (success or terminal failure), the tool automatically clears CX.LOAN.FOLDER.MOVE so the move does not re-fire. Your rules should not clear it themselves.
  

Admin Setup – API User

Please note that the API versions of our PowerTools™ require an API user to be created in each instance where the PowerTools™ are installed. Lender Toolkit can submit a request to ICE to generate the Client ID and secret key pair.

If credentials have not yet been obtained, use the link below to request credentials.

Installed Components

Custom Fields Created