Knowledge Base

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 existing trigger rules if previously set up
  

Prerequisites

Please note that before this tool can be activated, clients must be able to access the Toolshed Portal and have obtained API credentials.

Toolshed Portal

If the primary Encompass® Administrator does not have access to the Toolshed Portal, please email support@lendertoolkit.com with the administrator's name, email address, phone number and the Encompass® Client ID.  Our support team will be happy to assist with setting up access.

API User and Persona

Please note that the API versions of our PowerTools™ and automations 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.

Request API Credentials for PowerTools and Automations

Activation

Loan Folder Move - API  is activated for through the Toolshed Portal. 

1. Sign in to Toolshed Portal with an administrator account. Select the correct Encompass® instance.
   
2. Open Settings -> Enabled Products.
   
3. Locate Loan Folder Move - API. Click Activate.
   
4. Download and save the Loan Folder Move API Installation Package.
   
5. Open Input Form Builder › Manage Customizations › Import Package Wizard.
   
6. Browse to the downloaded package and click Import.
   

Important: The API and SDK versions of the PowerTool™ cannot be active at the same time. Companies currently use the SDK (desktop) version, must turn it off and uninstall it before activating the API version.

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.
  

Note: Changes made through any Encompass® interface (Desktop, Web, or Developer Connect) will fire the move, because the field-change webhook is emitted at the Encompass® server level when the loan is saved.

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. Custom rules should not clear it themselves.
  

Installed Components:

• Custom Form: None (server-side/webhook driven)
  
• Codebase Assemblies: None
  
• Custom Data Objects: None
  
• Plugins: None
  

Custom Fields Created: