The Ready for Shipping plugin provides an automated solution for securing sensitive documents in Encompass®, such as disclosures and closing documents. By applying protection rules when a document is marked as “Ready to Ship,” the plugin ensures that these files are locked from unauthorized edits, reducing compliance risks and improving workflow efficiency.


Benefits

  • Enhanced Security: Automatically protects critical documents from accidental changes.
  • Improved Compliance: Ensures sensitive files remain locked once marked “Ready to Ship.”
  • Time Savings: Eliminates the need for complex business rules and manual persona management.
  • Flexible Control: Allows customization of protection rules for different document types and user roles.

 

Activation

To turn this tool on:

1. Log in to Encompass® as a Super Admin.

2. Open LTK PowerTools™ from the Encompass® menu. Confirm the license includes the Optimized or Enterprise Tier.


3. Click Settings > PowerTools™ Optimized tab.

4. Turn on Ready for Shipping by clicking On.

Important: After activation of the Tool, be sure to wait for the prompt stating that the download is complete prior to continuing.

5. Ensure a license number populated and restart Encompass®.

 

How to Use It

Step 1: Before configuring the plugin, set up Encompass® for Document Protection. 

  • Create a Role called “PD” (Protected Documents)


  • Go to Business Rules > Role Access to Documents and assign the PD role to the Protected Documents section


  • In Persona Settings:
    • Remove access to Protected Documents from roles like Loan Officers and Processors


    • Grant access to roles like Underwriters, Admins, or upper management


 

Once this is done, test it by opening a loan, selecting a document, and setting its status to “Ready to Ship.” The plugin will automatically apply the Protected Doc role to that document.



If someone without access tries to open it, the document will be read-only and cannot be edited.


Step 2: Customize Protection Rules

  1. Open the Admin – Ship Ready Protect Doc form


  1. Click Edit Settings to configure how and when documents are protected.

 

Auto-Protect Doc Types Tab

  • Select document types to be automatically protected
  • Exclude specific document names if edits are needed before shipping by clicking Document List



Ready to Ship Checkbox Access Tab

  • Define which Personas can mark documents as “Ready to Ship”
  • Exclude certain documents for broader access if necessary using Document List


 This flexibility allows early protection for some documents while ensuring only authorized users can unlock them.

 

Red Document Names

If document names appear in red, it means a template was not found—possibly due to a typo or an outdated document. These documents will not be protected until corrected.

 

Installed Components

  • Custom Form: Admin – Ship Ready Protect Doc
  • Codebase Assemblies: ShipReadyProtectDocProCodeBase
  • Custom Data Objects: None
  • Plugins: ShipReadyProtectDocProPlugin.dll

 

Custom Fields Created:

Fields:

Description

Format/Type

Max Length

CX.CURRENTUSER.ID

Current Logged In User ID

String

32