Workflow Rules
Encompass Innovation Journey Support
Configuring Automated Workflows
Working with Disclosure Automation Tools and Workflows
Encompass Innovation Playbook - CREDIT via Workflow Automation
Encompass Innovation Playbook - DISCLOSURES & FEES via Workflow Automation
Encompass Innovation Playbook - FLOOD via Workflow Automation
Encompass Innovation Playbook - REG B via Workflow Automation
Watch: Encompass Innovation Overview Video
Automating your workflow provides the foundation for building an exception-based process. The focus of this initial version is to automate the creation and completion of Workflow Tasks. The Workflow Rules feature provides for an event driven automation mechanism to automate your processes. The figure below provides a high-level overview of how the automation works. The administrator can define “Workflow Rules” to configure this automation
In addition, some of the Workflow Rules are triggered from Encompass in addition to the existing support for the Encompass web interface or via APIs. The following events support this expanded scope: Field Value Modified, Document Added, Role Assigned, and Milestone Completed.
Creating Workflow Rules
As an administrator, you configure “Workflow Rules” to automate workflows. These rules are configured from the Encompass Admin Portal for the Encompass web interface. You can access the Workflow Rules configuration from the Workflow Management section in the left navigation menu. This menu option for Workflow Management is available only if you are either the “admin” user or a user with Super Administrator or Administrator persona.
This section provides detailed steps for performing the following configuration tasks:
-
Create a new workflow rule
-
Activate a workflow rule
-
View the listing of rules
-
Modifying a workflow rule
-
Delete a workflow rule
-
Export/Import Rules
To Create a Workflow Rule
- From the Encompass Admin Portal, select Workflow Management from the left navigation menu and then select Workflow Rules.
- Select New Rule.
-
On the New Rule screen, enter the rule name. The rule name must be unique. If the rule name entered is already in use, the following error displays:
-
In the Priority field, select High to indicate that the rule is high priority.
Note: Users are only able to have 150 high priority rules at a time. Workflow Rules utilizing the Loan Updated triggering event can not be marked as high priority. Rules should only be marked as high priority if the user is going to be waiting for the results of an action before proceeding. For example, if a user is completing a task and another task is created as a result of this action, then the rule would be a good candidate for high priority.
-
To set a date when the rule is effective, select the date option in the When is this rule effective? field. You can use the loan created date (Encompass field 2025), the application date (Encompass field 3142), or the transaction details application date (Encompass Field 745).
-
Once a date field is selected, you can then define the conditions for this date (such as loans between a date range or loans created on or after a certain date)
-
-
Enter a tag for the rule in the Tags field to group the rule with other rules with the same tag. Tags do not support special characters or spaces. When entering a tag, use letters, numbers, or the follwoing special characters:
-
Comma (,), Dollar Sign ($), Hyphen (-), Underscore (_), Period (.), Plus (+), Exclamation Mark (!), Asterisk (*), Open Parenthesis ( ( ), Closed Parenthesis ( ) )
-
-
Select a triggering event for the workflow rule from the Triggering Event field. For information on configuring the Triggering Event tab, see the Triggering Event section below.
- Define the conditions on the Conditions tab. For more information on configuring the Conditions tab, see the Conditions section below.
- Select the resulting actions on the Result tab. For more information on configuring the Result tab, see the Result section below.
- Provide any comments associated to a workflow rule in the Comments section.
- To activate the rule, Select the Activate toggle
. This toggle turns the rule on and off. - To save the workflow rule, select Save.
Triggering Events
There are several options available to define when the workflow rule is triggered. In addition, information
icons are available next to the Triggering Event field. These new icons provide context sensitive information when the user hovers over them. When a triggering event type or resulting action type is selected, the information icon is updated so that the information that is displayed is relevant to the selection the user made.
Field Value Modified
Workflow rules can be configured to trigger when a field value has been modified on a loan.
To Select Field Value Modified for the Triggered Event
- In the Triggering Event field, select Field Value Modified.
- In the Encompass Field ID field, enter a field ID or select Select ID for search for a field.
- In the Was Changed field select one of the following operators:
- Any Change <> Blank - Triggers the workflow rule when any change is made to the trigger field, except when the field is cleared.
To Blank - Triggers the workflow rule only if the trigger field has been cleared.
To Specific Value - Triggers the workflow rule when the trigger field is updated to a specific value.
From Specific Value to Specific Value - Triggers the workflow rule when the trigger field is updated from one specific value to another.
From Blank to Specific Value - Triggers the workflow rule when the trigger field is updated from a blank value to a specific value.
From Specific Value to Blank - Triggers the workflow rule when the trigger field is updated from a specific value to a blank value.
- To add additional fields, select +Add Another.
Note: In order for a Field Value Modified event to trigger, the triggering field must be part of the Encompass Reporting Database and the Audit Trail. When an administrator adds a field that is not part of the audit trail, the following information displays:
Additionally, if the administrator knows the field ID they want to configure the rule off of, they can enter the field in the Encompass Field ID field. This not only makes it easier to enter fields IDs, but also enables you to enter a virtual field ID. For example, if you want to track if a document, such as a flood certificate, is received you can not track that virtual field change by adding [Document.DateReceived.Flood Certificate] in the Field Modified event. You could then enure that the rule triggers by adding a condition, such as Not IsEmpty([Document.DateReceived.Flood Certificate]) in the Advanced Conditions in the Conditions tab of the rule.
Example Condition:
Note: This method of defining the field ID has no validation in place to ensure that the field entered matches a field in Encompass. Administrators should only enter a field if they are sure that they are entering a valid Encompass field ID.
Loan Created
To create a workflow rule that triggers when the loan is created, select Loan Created in the Triggering Event field.
Loan Updated
Deprecation Notice: Due to performance and scalability considerations, the Loan Updated event is no longer supported effective May 11th, 2022. Please consider using a different event such as Field Value Modified, Milestone Completed, or Task Completed.
Milestone Completed
To Configure the Milestone Completed Triggering Event:
- In the Triggering Event field, select Milestone Completed.
- In the Selected Milestones section, select the Add
icon. - Select the check box in front of each milestone you want to add to the triggering event, and then select Apply.
- To remove any milestones that were added to the rule, select the Remove
icon next to the milestone name.
Role Assigned
Workflow Rules can be set to trigger when the loan is assigned to a role.
To Select Role Assigned for the Triggered Event
- In the Triggering Event field, select Role Assigned.
- In the Role field, select a user role from the list.
- In the Assigned To field, select User to specify a user or select User Group to specify a user group.
- In the User or User Group field, select the user or user group that this rule applies to.
Note: If the selected role doesn't have a user associated with it, the User option is disabled.
Ready for Homeowners Insurance Request
This event triggers when the Intent to Proceed field (Encompass field 3164), Subject Property Address (Encompass field 11), and key borrower fields are populated. This rule does not trigger if the Subject Property field is set to TBD or if you do not use the Consumer Connect borrower portal. A rule based on this event only triggers once for a specific loan.
To Select Ready for Homeowners Insurance Request for the Triggered Event
- In the Triggering Event field, select Ready for Homeowners Insurance Request.

File Attached
The File Attached triggering event enables workflow rules to trigger whenever a document is added to a specific document folder. This trigger can be used as a way to determine if a service order, such as credit or flood, has been successfully ordered and then perform actions as a result
To Select File Attached as the Triggering Event
-
From the Triggering Event tab on a workflow rule, select File Attached in the Triggering Event field.
-
To add one or more document folder that will trigger the workflow rule, select the Add icon.
-
On the Select Document Folders window, select the checkbox in front of any document folders you want to use for the rule.
-
Select Apply.
-
To remove any document folders from the Selected Document Folders section. Select Remove
next to the document name.
Condition Added
The Condition Added triggering event enables workflow rules to be triggered when a new enhanced condition is added to a loan.
To Select Condition Added as the Triggering Event:
- From the Encompass Admin Portal, select Workflow Management.
- Select Workflow Rules, and then select New Rule to create a new rule.
- In the Triggering Event field, select Condition Added.
- Select a condition from the condition list that displays.
Condition Status Updated
The Condition Status Updated triggering event enables workflow rules to be triggered when the status of a specific enhanced condition is updated.
To Select Condition Status Updated as the Triggering Event:
-
From the Triggering Event tab on a workflow rule, select Condition Status Updated in the Triggering Event field.
-
Select the condition type that the workflow rule will apply to in the Condition Type field.
-
In the Select Status field, select the one or more statuses that the workflow rule should be listening for.
-
In the Selected Conditions section, select Add.
-
On the Select Conditions window, select the checkbox for each condition that the rule will apply to and then select Apply.
-
To remove a condition from the Selected Conditions list, select the Remove X icon.
Service Order Fulfilled
The Service Order Fulfilled triggering event enables administrators to trigger workflow rules when a requested service order has been fulfilled by a partner on a loan.
To Select Service Order Fulfilled as the Triggering Event:
- From the Encompass Admin Portal, select Workflow Management.
- Select Workflow Rules, and then select New Rule to create a new rule.
- In the Triggering Event field, select Condition Added.
- Select a service category from the Service Category field.
- Select the service order product that will trigger the event when an order has been fulfilled from the Product field.
Task Group Created
Workflow Rules can be set to trigger when a task group is created on a loan. With this option, the admin is able to specify a task group from the task group templates that have already been configured.
To Select Task Group Created for the Triggered Event
- In the Triggering Event field, select Task Group Created.
-
Select a task group from the list of task groups displayed.
- To search for a task group, start typing the name of the task group in the search field. The list is filtered as you type.
-
Select a specific task group by selecting the circle in front of the task.
Task Group Completed
Workflow Rules can be set to trigger when a task group is completed on a loan. With this option, the admin is able to specify a task group from the task group templates that have already been configured.
To Select Task Group Completed for the Triggered Event
- In the Triggering Event field, select Task Group Completed.
-
Select a task group from the list of task groups displayed.
- To search for a task group, start typing the name of the task group in the search field. The list is filtered as you type.
-
Select a specific task group by selecting the circle in front of the task.
Task Created
Workflow Rules can be set to trigger when a task is created on a loan. With this option, the admin is able to specify a task from the workflow task templates that have already been configured.
To Select Task Created for the Triggered Event
- In the Triggering Event field, select Task Created.
-
Select a task from the list of task groups displayed.
- To search for a task, start typing the name of the task in the search field. The list is filtered as you type.
-
Select a specific task by selecting the circle in front of the task.
Task Completed
Workflow Rules can be set to trigger when a task is completed on a loan. With this option, the admin is able to specify a task from the workflow task templates that have already been configured.
To Select Task Completed for the Triggered Event
- In the Triggering Event field, select Task Completed.
-
Select a task from the list of tasks displayed.
- To search for a task, start typing the name of the task in the search field. The list is filtered as you type.
-
Select a specific task by selecting the circle in front of the task.
-
To specify a disposition that the task must be in when completed, select the disposition from the With Disposition field.
Sub-Task Created
Workflow Rules can be set to trigger when a sub-task is created on a loan. With this option, the admin is able to specify a sub-task from the task/sub-tasks templates that have already been configured.
To Select Sub-Task Created for the Triggered Event
- In the Triggering Event field, select Sub-Task Created.
-
Select a task from the list of tasks displayed.
- To search for a task, start typing the name of the task in the search field. The list is filtered as you type.
-
Select a specific sub-task from the Subtask Description section by selecting the circle in front of the sub-task.
Sub-Task Completed
Workflow Rules can be set to trigger when a sub-task is completed on a loan. With this option, the admin is able to specify a sub-task from the task/sub-tasks templates that have already been configured.
To Select Sub-Task Completed for the Triggered Event
- In the Triggering Event field, select Sub-Task Completed.
- To specify a disposition that the task must be in before the rules is triggered, select With Disposition and then select a disposition for the rule.
- Note: The administrator must enable the Enable disposition at sub-tasks level option on the WORKFLOW MANAGEMENT > Task Global Settings page for this option to work.
-
Select a task from the list of tasks displayed.
- To search for a task, start typing the name of the task in the search field. The list is filtered as you type.
-
Select a specific sub-task from the Subtask Description section by selecting the circle in front of the sub-task.
Task Updated
Workflow Rules can be set to trigger when a task has been updated on a loan. This triggering event enables administrators to configure rules that trigger when the status of a task has changed or when the disposition of the task has changed.
To Select Task Updated for the Triggered Event:
- In the Triggering Event field, select Task Updated.
- Select the task that the event should trigger for.
- In the Task Field Changed field, select Status or Disposition
- If you selected Status for step 5, select a status in the Changed To field to define the status that the task needs to be changed to before the rule is triggered.
- Additional, if you only want to trigger the rule when the task changes from a specific status, select a status from the Changed From field.
- If you selected Disposition for step 5, select a disposition in the Changed To field to define the disposition that the task needs to be changed to before the rule is triggered.
- Additional, if you only want to trigger the rule when the task changes from a specific disposition, select a disposition from the Changed From field.
Scheduler Completed
This triggering event works with the Start Scheduler resulting action. The triggering action enables the workflow engine to listen for the "completed" event produced by the scheduler service for your selected scheduler template.
To Select Scheduler Completed for the Triggering Event:
- From the Triggering Event tab on a workflow rule, select Scheduler Completed from the Triggering Event field.
- In the Select Scheduler field, select the scheduler that the rule should monitor for completion.
Only active scheduler templates will be available for selection in workflow rules.
Conditions
Administrators can add conditions associated with a workflow rule. The following types of conditions can be associated with a workflow rule:
- Advanced Conditions
- Channels
- Required Tasks
- Required Document Folders
- Required Fields
To Define Conditions for the Workflow Rule
- From the New Rule page, select the Conditions tab.
- In the Advanced Conditions field, define the conditions that, when met, enable the rule to trigger.
- Note: The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- For assistance with building conditions, select Query Builder.
- Enter or search for a field. For this initial release, users can only search for an exact match of a field ID. Partial field search support will be added in a future release.
- Select an operator for your query from the list. The available options are based on the format of the field you entered/selected.
- Enter the value to complete this query.
- Once the query is completed, select Apply to apply the query to the rule. The code is copied to the Code Editor.
- To ensure that the syntax doesn't result in an error, select Validate to check your automated readiness conditions.
Note: A message displays on a successful or failed validation. If the validation fails, the error message indicates where the error occurred.
Example:

- In the Channels section, select the channels that the workflow rule applies to. If this rule is not tied to a channel, do not make a selection here.
- In the Required Tasks section, select Add
to add one or more required tasks that must be completed before the rule is executed.Note: These are the new Workflow Tasks that have already been configured by you or other administrator team members in your company. For more information, refer to the Working with Task-Based Workflows setup guide
- On the Select Required Tasks page, select the tasks from the list of available tasks and then select Apply.
- To search for a task, start typing the name of the task in the search field. The list is filtered as you type.
- In the Required Documents Folders section, select Add
to add one or more required document folders that must be completed before the rule is executed. - On the Select Required Documents Folder page, select one or more document folders from the list of available document folders and then select Apply.
- Select the Menu
option next to a document folder to toggle whether or not the document folder requires an attachment.
- Select the Menu
- In the Required Fields section, select Add
to add one or more required fields that must be completed before the rule is executed. - On the Select Fields section, select one or more required fields that must be completed before the rule is executed. Select the Standard Fields or Custom Fields tab to switch between available standard or custom fields.
- To search for a document folder, start typing the field id in the search field and then select Search
. To clear the filtered list after searching, select Clear.
- To search for a document folder, start typing the field id in the search field and then select Search
Additional Information about the Query Builder:
User can add additional lines to the query builder to build more complex conditions. To add additional lines to the query:
-
Select the first Menu
icon , and then the middle icon (
) to add another query. -
Repeat the process detailed starting with step 5 above to configure the query.
-
If there is more than one query, select the second Menu
option to indicate whether to use the AND condition or the OR condition with your queries. -
If you need to delete a query, you can select the first Menu
icon , and then the left icon (
) to remove the query line. -
To change the order of the queries, select the Handle
at the front of the row.
To create nested queries, select the first menu and then select the right icon (
)
Result
Once the any conditions have been set, administrators can define the result of the rule once it is executed. The following result options are available:
- Request for Evidence of Homeowners Insurance
- Apply Enhanced Conditions
- Assign Role
- Update Custom field
- Update Enhanced Conditions Tracking Status
- Change Loan's Pipeline Folder
- Update Loan Field
- Order Service
- Update Service Order
- Create Task Group
- Create Task
- Create Sub-Task
- Update Task Priority
- Complete Task Group
- Complete Task
- Complete Sub-Task
- Update Task Priority
- Update Task Disposition
- Start Scheduler
- Cancel Scheduler
- Send Notification
- Send Disclsoures
- Request/Send Documents
Administrators can configure multiple resulting actions for a single workflow rule. This enables administrators to create efficient workflow rules that accomplish multiple actions when a single triggering event occurs. To edit any of the added resulting actions, select the resulting action from the Added Resulting Actions list to view the configuration details in the right panel. You can also delete any added resulting actions from the same panel by selecting the Delete
icon.
Note: Administrators can configure up to five resulting actions per rule.
Nested Resulting Actions
Nested Resulting Actions enable lenders to create a task, send a notification, or start a scheduler based off the success or failure of an attempt of certain resulting actions. Nested actions are supported for the following resulting action.
-
Order Service
-
Order Mavent Report
-
Send Disclosure
-
Request/Send Documents
-
Start Scheduler
To configure a Nested Action
- From the Result tab on a workflow rule, select the Menu
next to a resulting action that supports nested actions. - Select Add Nested.

- A new entry is created under the resulting action labeled Select Nested Action. Select On Success to execute the action when the parent action is successful, or select On Failure to execute the action when the parent action is unsuccessful.
- Select Create Task, Start Scheduler, or Send notification from the Resulting Nested Action field.
- The Start Scheduler resulting action only supports the Create Task and Send Notification nested actions.
- Enter a description for the nested action, if desired. This description displays under the specific nested action in the Added Resulting Actions section.
- Based on the selected Resulting Nested Action in step three, select the task, scheduler or notification to use for the action.
Multiple On Success or On Failure nested actions can be added to a resulting action that supports this feature.
Request for Evidence of Homeowners Insurance
To Select Request for Evidence of Homeowners Insurance for the Resulting Action
- From the Result tab on a workflow rule, select Request for Evidence of Homeowners Insurance in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- Select the Email Template drop-down list, and then select an HOI email template to use. (By default, a preconfigured Request for Proof of Homeowner's Insurance template is provided.)
- To preview the email template, select Email Template Preview.
The proof of HOI email template for this feature is configured in the desktop version of Encompass in Encompass Settings > eFolder Setup > Notification Templates. There you can edit the default proof of HOI email template and create new proof of HOI templates.
Apply Enhanced Conditions
To Select Apply Enhanced Conditions for the Resulting Action:
- From the Result tab on a workflow rule, select Apply Enhanced Conditions in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- Select Apply Automated Conditions to automatically apply all automated conditions.
- Select Apply Selected Condition(s) to apply selected automated conditions.
- If you selected Apply Selected Condition(s), select the Add
icon to add conditions. - On the Select Conditions window, select the check box for each condition you want to apply and then select Apply.
- To remove a selected condition from the Selected Conditions list, select Remove

Assign Role
To Select Assign Role for the Resulting Action
- From the Result tab on a workflow rule, select Assign Role from the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- In the Role field, select a user role from the list.
- In the Assigned To field, select User to specify a user or select User Group to specify a user group.
-
In the User or User Group field, select the user or user group that this rule applies to.
Note: If the selected role doesn't have a user associated with it, the User option is disabled.
Update Custom Field
To Select Update Custom Field for the Resulting Action:
- From the Result tab on a workflow rule, select Update Custom Field in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- In the Encompass Field ID field, enter the field ID to update.
- To search for a field ID, select the Search ID button and then select a field from the list. Select Apply to apply the field to the rule.
- Select Clear Current Value to clear the value in this field, or select Set Specific Value to populate a value to this field.
- If you select Set Specific Value, enter the value to populate in the Specific Value field.
Note: This feature only works with custom field IDs, not standard Encompass field IDs.
Update Enhanced Condition Tracking Status
To Select Update Enhanced Condition Tracking Status for the Resulting Action
This resulting action enables administrators to automatically update the tracking status for a specified enhanced conditions when the rule is triggered and all conditions have been met.
- From the Result tab on a workflow rule, select Update Enhanced Conditions Tracking Status in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- Select the Add
icon to add condition that will be updated when the rule is triggered. - On the Select Conditions screen, select the conditions that should be updated and then select Apply.
- In the status column, select the status that the enhanced condition should be updated too when the rule is triggered.
- Select Remove
to remove any unwanted conditions from the Selected Conditions list.
- Select Remove
Change Loan's Pipeline Folder
The Change Loan's Pipeline Folder resulting action enables a workflow rule to move a loan from any folder that the loan resides in, including archived folders and the (Trash) folder, to another folder when triggered. This resulting action is not able to move loans to the (Trash) folder. Additionally, the move only occurs after the loan has been closed for at least 15 minutes in both the desktop and web interface.
To Select and Configure the Change Loan's Pipeline Folder Resulting Action:
-
From the Result tab on a workflow rule, select Change Loan's Pipeline Folder in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- Select the Loan Folder drop-down list, and then select a folder to move the loan to.
Update Loan Field
A Update Loan Field resulting action enables administrators to update both standard and custom loan fields. This resulting action also introduces the ability to dynamically populate fields using the Today() and Now() functions, which insert current date and date/time values, respectively. With this resulting action, users can update a standard or custom field with the following options:
-
Clear Current Value - Removes the existing value in the defined field.
-
Set Specific Value - Enters the specified value in the defined field.
-
Function - Today() - Insert the current date in the format YYYY-MM-DD. This should only be used in a Date field.
-
Function - Now() - to insert the current date and time in a standardized format (see below). This should only be used in a String field. Using this in a date field will cause the value to truncate to just the date.
When using the Function - Now() option, the date and time is inserted in the YYYY-MM-DDTHH:MM:SS:MSSZ format.
-
YYYY: Four-digit year
-
MM: Two-digit month
-
DD: Two-digit day
-
T: A separator indicating the start of the time portion
-
HH: Two-digit hour
-
MM: Two-digit minute
-
SS: Two-digit second
-
MSS: Milliseconds
-
Z: UTC timezone indicator
For example, the value 2024-09-16T14:30:00:000Z represents September 16, 2024, at 2:30 PM UTC.
Things to Consider
-
Custom fields with calculations will not update and will show as a Fail in the Automation Audit
-
Standard fields with calculations only update if the field has a lock icon that is "locked"
(calculation turned off).-
Attempts to update calculation fields will show as a Success on the Automation Audit, whether the loan retained the value sent by the workflow engine or not.
-
-
Negative integers are not supported in this release
-
State fields: Use two-letter abbreviations or the full name (Example: "CA" or California)
-
Phone number fields: Can be entered with or without dashes
To Select Update Loan Field for the Resulting Action
- From the Result tab on a workflow rule, select Update Loan Field in the Resulting action field and then select Add.
- (Optional) Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
In the Encompass Field ID field, enter the field ID to use, or select Select ID to search for a field.
-
After selecting Select ID, a new window displays. The standard fields tab is displayed by default. to view custom fields, select the Custom Fields tab.
-
Select a field from the list, or search for the field ID using the search option. Once the field is selected, select Apply.
-
- Select an option from the Update Type field.
- If you select Set Specific Value, enter the value to use in the Specific Value field.
Order Service
The Order Service resulting action enables administrators to configure a rule that, when triggered, orders the specific services. This action works in conjunction with the Services Management configuration space and can be used to place orders for any automated rule with the rule type of Workflow Engine. For information on configuring service rules that can be invoked by the Workflow Engine, see the Using and Configuring Services Management guide.
Configuring Automated Service Ordering through workflow management rules with the Workflow Engine rule type allows for repeated service ordering via a single rule and eliminates the five minute cool off period that is required for automated rules with the ASO Bot rule type.
To Add an Order Service Resulting Action:
- From the Result tab on a workflow rule, select Order Service in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- In the Select Service Rule section, select the service rule to use for this resulting action from the list of configured automated rules with the Workflow Engine rule type.
Update Service Order
This resulting action enables administrators to automatically update an existing service order on a loan with a specific partner when the rule is triggered, and all conditions have been met. The information that is updated with the partner will depend on the partners support of this feature. Check with your service partner to verify that they support the update service order action, and how the service order is updated when the resulting action is executed.
Note: An active service order must be configured for the specified partner in the Services Management settings in order to see the partner in the workflow rule configuration.
To Select Update Service Order for the Resulting Action
-
From the Result tab on a workflow rule, select Update Service Order in the Resulting Action field, and then select Add.
-
Enter a description for the resulting action in the Description field. This optional description displays under the specific resulting action in the Added Resulting Actions section.
-
-
In the Advanced Conditions field, define any conditions that, when met, enable the selected action to execute. To validate the condition, select Validate.
-
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
-
Select a service category for the desired provider in the Service Category field.
-
Select the desired provider in the Provider field. If you do not see your provider listed:
-
Check with your provider to ensure they support this type of automation.
-
Enure you have an active Service Setup for the provider in Services Management.
-
-
Select All Orders, Last Order, or Active Orders in the Update field to indicate which orders to update.
-
All Orders - Any order for the selected category/provider that has ever been submitted on the loan.
-
Last Order - The order for the selected category/provider with the latest creation date/time.
-
Active Orders - Any order for the selected category/provider that are in an open status.
-
-
If available, select an option from the Service Provider Event Option field. The options in this field are provided by your provider. For information on which option to use for this field, check with your provider.
-
If you selected Mortgage Insurance for step 4, and you want to send documents to the partner when the rule is triggered, select a document stacking template from the Document Stacking Template dropdown.
-
If the stacking template used in the rule is configured with required documents at the time of the rule execution, but those required documents are not in the eFolder, the rule will attach the available documents to the order.
-
Administrators should write their rule readiness conditions in such a way that rules are only triggered for a specific MI partner. If the rule is triggered for an MI partner that isn’t the provider of record for the loan, the rule will not send the documents.
-
For more information on configuring document stacking templates, click here.
Create Tasks by Group
To Select Create Tasks by Group for the Resulting Action
- From the Result tab on a workflow rule, select Create Tasks by Group in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
Select a task group from the list of task groups displayed.
- To search for a task group, start typing the name of the task group in the search field. The list is filtered as you type.
Create Tasks
To Select Create Tasks for the Resulting Action
- From the Result tab on a workflow rule, select Create Tasks in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
Set Allow Duplication to ON to enable a workflow rule to add a task on a loan as many times as the triggering event occurs, even if previous instances of the task are still in an open state.
-
Select a task from the list of tasks displayed.
- To search for a task group, start typing the name of the task group in the search field. The list is filtered as you type.
Note: Tasks that are configured to "Always create when parent is created" are not listed here. If you want to see a task here and configure automation to dynamically add that task, ensure the task does not have the "Always create when parent is created" option selected.
Create Sub-Task
To Select Create Sub-Task for the Resulting Action
- From the Result tab on a workflow rule, select Create Sub-Task in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
Select a task from the list of tasks displayed.
- To search for a task group, start typing the name of the task group in the search field. The list is filtered as you type.
- Select a Sub-Task from the Subtask Description section.
- Select Re-open completed Task to create Sub-Tasks(s) to configure the rule to open a completed parent task in order to create the sub-task.
- Note: If this option is not selected, the sub-task won't be created if the parent task is closed.
Update Task Priority
To Select Update Task Priority for the Resulting Action
- From the Result tab on a workflow rule, select Update Task Priority in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
Select a task from the list of tasks displayed.
- To search for a task, start typing the name of the task in the search field. The list is filtered as you type.
- Select the new priority that the task should be set to when the rule is execute from the Update priority for selected tasks field.
Complete Tasks by Group
To Select Complete Tasks by Group for the Resulting Action
- From the Result tab on a workflow rule, select Complete Tasks by Group in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
-
Select a task group from the list of task groups displayed.
- To search for a task group, start typing the name of the task group in the search field. The list is filtered as you type.
Complete Task
To Select Complete Task for the Resulting Action
- From the Result tab on a workflow rule, select Complete Task in the Resulting action field and then select Add.
- (Optional) Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
In the Select Tasks to complete section, select the Add dropdown field and then select By Type or By Template.
- Select the task types or task templates from the Select Tasks window, and then select Apply.
- In the Complete Tasks with following Disposition field, select the disposition to apply to the tasks when the rule is executed.
- Select Include tasks with open Subtasks to complete all subtasks associated with the selected tasks when the rule is executed.
Complete Sub-Task
To Select Complete Sub-Task for the Resulting Action
- From the Result tab on a workflow rule, select Complete Sub-Task in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
Select a task from the list of tasks displayed.
- To search for a task , start typing the name of the task in the search field. The list is filtered as you type.
- Select a Sub-Task from the Subtask Description section.
Start Scheduler
The Start Scheduler resulting action enables administrators to invoke the scheduler service to start the specified scheduler template.
To Select Start Scheduler as the Resulting Action:
- From the Result tab on a workflow rule, select Start Scheduler in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field, if desired . This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable configured automation to execute.
- The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
Select the scheduler template you want to be started in the Select Scheduler field.
- Only scheduler templates marked as "Active" are available for selection in workflow rules.
Cancel Scheduler
The Cancel Scheduler resulting action enables administrators to "cancel" the specified scheduler template if it is no longer needed on a given loan. If the scheduler is not running on the loan the scheduler service will ignore the request
To Select Cancel Scheduler as the Resulting Action:
- From the Result tab on a workflow rule, select Cancel Scheduler in the Resulting action field and then select Add.
- Enter a description for the resulting action in the Description field, if desired. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute.
- The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
-
Select the scheduler you want to cancel in the Select Scheduler field.
- Only scheduler templates marked as "Active" are available for selection in workflow rules.
Send Notification
This Send notification resulting action enables a workflow rule to invoke a specific email notification template when the rule is triggered. Notification Templates must be defined before configuring this resulting action. See the Notification Templates Feature Added section above for directions on configuring notification templates.
To Select Send Notification for the Resulting Action:
- From the Result tab on a workflow rule, select Send Notification in the Resulting Action field and then select Add.
- Enter a description in the Description field, if desired. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. You can leave this blank to send the notification anytime your triggering event occurs on a loan.
- To validate the condition, select Validate.
- The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- To define the notification template to use, select Select template.
- On the Select Notification Template window, select the template from the list of active notification templates, and then select Apply.
Send Disclosures
The Send Disclosures resulting action enables administrators to send eDisclosure packages when the workflow rule is triggered. This resulting action requires information loan fields for necessary information, such as the plan code, borrower email address, etc. Some of these fields are new in the Encompass 24.1 release as detailed in the New Disclosure Features section of the desktop version of Encompass 24.1 release notes. Additionally, the configuration defined in the Encompass Settings > Docs Setup > eDisclosure Packages settings configured in the desktop version of Encompass is used to determine the package type and document settings for each package. See the eDisclosure Packages online help topic for instructions for configuring the eDisclosure Packages portion in the desktop version of Encompass.
When this action is triggered on a loan, an attempt to disclose to all borrower pairs on the loan is automatically attempted at that time. This will also honor any Encompass Compliance Service (ECS) review settings that have been configured.
To Select Send Disclosures for the Resulting Action:
- From the Result tab on a workflow rule, select Send Disclosures in the Resulting action field and then select Add.
- Enter a description in the Description field, if desired. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
- The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
Request/Send Documents
The Request/Send Documents resulting action enables administrators to write rules to request and or send documents to the defined borrower(s). Selected documents with a source of Custom, Standard, or eFolder Attachment sends the content to the borrowers. Selected documents with a source of Needed requests the documents from the borrowers. The automation relies on configuration of your Document settings in the desktop version of Encompass. The automation service honors this configuration to determine the signature type for documents and the borrower(s) are prompted to eSign if the document being sent is eSignable. For information on configuring documents, click here.
Note: An Encompass Consumer Connect Site ID must be associated with the instance, and One Time Password (OTP) must be enabled for this resulting action to work. For information on configuring OTP settings for your Consumer Connect site, click here.
To Select Request/Send Documents for the Resulting Action:
- From the Result tab on a workflow rule, select Request/Send Documents in the Resulting action field and then select Add.
- Enter a description in the Description field, if desired. This description displays under the specific resulting action in the Added Resulting Actions section.
- In the Advanced Conditions field, define any conditions that, when met, enable the configured automation to execute. To validate the condition, select Validate.
- The conditions syntax utilizes the Visual Basic .NET programming language. For information on how this syntax works, see the Advanced Coding for Business Rules guide.
- Select the intended recipients in the Recipients field.
- To add a document to send, select Add
. - Select the source for all documents you want to send, and then select Apply.
Scenarios for Request/Send Documents Action
Nested actions should be utilized to make your users aware of the results of the attempted automation.
No other options are configured in the workflow rule. Refer to eDisclosure settings and Documents settings to determine how disclosures are generated on loans.
View a Listing of Rules
When a user navigates to the workflow rules page a list of any existing rules displays. Administrators can use the Advanced Search feature to find workflow rules that contain a specific type of configuration. A search can be performed for workflow rules that contain a specific task template, condition template, document name, scheduler template, notification template, role, milestone, or field ID.
To Use Advanced Search for Workflow Rules
-
From the Encompass Admin Portal, select Workflow Management from the left navigation menu.
-
Select Workflow Rules.
-
Select the Menu
option on the top right section of the page, and then select Advanced Search. -
On the Advanced Search page, select the category to search by.
-
The second dropdown list is always "=". Enter or select the search criteria in the 3rd dropdown list.
-
Select Submit to apply the search. The Workflow Rules page displays only the rules where the criteria is present in any part of the rule.
-
To clear the search filter, select the X at the end of the search filter that displays at the top of the list.
Once the search has been applied, you can still further sort and filter the results by the available column.
Note: The advanced search results remain unless you clear the search results or navigate away from the Encompass Admin Portal.
Additionally, administrators can filter and sort the list of rules by column.
Tag Column Search
When searching the workflow rules list by the tags column, users can enter a single tag to view all rules that contain that tag. Subsequent searches for individual tags further refine the list to only show rules that contain all the selected tags, allowing for more precise filtering of results.
How it works:
To illustrate this functionality, consider the following example.
-
You have three tags: Tag1, Tag2, and Tag3
-
You have multiple workflow rules that have been assigned these tags:
-
Rule A has Tag1
-
Rule B has Tag1 and Tag2
-
Rule C has Tag1 and Tag2
-
Rule D has Tag1, Tag2, and Tag3
-
-
A search for Tag1 shows all 4 rules.
-
A subsequent search for Tag2 shows Rule B, C, and D as those rules have Tag1 and Tag2.
-
A third search for Tag3 shows only Rule D, as that is the only rule that has all 3 tags.
Missing Configuration
A Missing Configuration Indicator on the Workflow Rules page enables administrators to easily identify workflow rules that will fail due to missing or inactive resulting action configuration. When a component for a resulting action is either missing or inactive, the indicator displays in front of the workflow rule entry on the workflow rules list. Existing rules with missing configuration are identified nightly. Imported rules are immediately indicated when they have a missing configuration. The following indicators are used:
-
- Indicates that the inactive rule is missing a component for the resulting action. -
- Indicates that the active rule is missing a component for a resulting action and the automation will fail if the rule is triggered.
When there is a missing configuration indicator on a specific rule, the active toggle can not be set to On from the workflow rules list. If the rule is currently active, administrators can quickly switch the toggle to Off from the workflow rules list.
The active toggle will no longer appear inside the details of a workflow rule and can only be managed from the workflow rules list.
Initially, the missing configuration indicator only indicates for the following resulting actions:
Missing Template
-
Create Tasks
-
Complete Task
-
Create Tasks by Group
-
Complete Tasks by Group
-
Create Sub-Task
-
Complete Sub-Task
-
Send Notification
-
Start Scheduler
-
Order Service
Missing Service Rule:
-
Order Service
Missing Provider
-
Update Service Order
Missing Condition Template
-
Update Enhanced Conditions Tracking Status
Modifying A Rule
Administrators can edit existing rules by selecting the Edit
icon. This opens the Workflow Rule in editing mode.
To Edit a Workflow Rule
- From the Workflow Rules page, select the Menu
icon. - Select Edit
. The Edit Rule page displays.
Copy A Rule
Administrators can use the Copy option to start a new rule while using an existing rule as a template. Once the administrator selects the Copy option, a new rule is started with the settings from the original rule preconfigured. To ensure that the name of the rule is unique, the text "copy_" is appended in front of the original rule name.
To Copy a Workflow Rule:
-
From the Workflow Rules page, select the Menu
icon next to the rule you want to copy, and then select Copy
. -
On the New Rule page, make any changes to the rule and then select Save.
Delete A Rule
Administrators can delete existing rules by selecting the Delete
icon. This opens the Workflow Rule in editing mode.
To Edit a Workflow Rule
- From the Workflow Rules page, select the Menu
icon. - Select Delete
. -
To confirm the deletion of the rule, select Delete.
Note: An active rule cannot be deleted. An error message displays if you try to delete an active rule:

Export/Import Rules
The Export/Import Rules option enables administrators to export existing workflow rules or import rules from another environment to a new one. This feature assists administrators with moving rules between a test and production environment. Administrators can export up to 10 rules at a time.
Administrators must ensure that all task dependencies are available in the target instance when an import is performed. This includes roles, user groups, task groups, tasks, sub-tasks, documents, and milestones. To assist in identifying dependency gaps, administrators are presented with messaging to indicate where missing dependencies exist when saving an imported rule.
For example, if an imported rule is set to trigger when a specific task was created, but the task doesn't exist in the environment that the rule was imported into, a message is displayed to alert the administrator of this missing dependency when the rule is saved. The validations behave the same way as the required fields validation when creating or modifying a workflow rule.
Importing and Exporting rules is version specific. Rules exported from one version of Encompass (example - 23.2) are not supported in a different version of Encompass (example - 24.1)
Example Message:
Note: In order to identify missing dependencies, administrators must edit and then save an imported rule. It is recommended that administrators perform this action in order to validate any imported rules prior to activating the rule.
Note: Imported rules are not active by default. The administrator must enable a rule after it has been imported before the rule will take effect.
Note: Administrators must edit existing rules created before the 21.3 Major Release Update and save them again (no change is necessary) before exporting a rule. Any rules created after the 21.3 Major Release will not be affected.
To Export Workflow Rules:
-
From the Encompass Admin Portal, select Workflow Management, and then select Workflow Rules.
-
Select the check box in front of the rules you want to export. You may select up to 10 rules.
-
Select the Export
button. -
On the Export Workflow Rule(s) window, enter a name for the file that will be downloaded to your system. For example, you can enter a name like ChangeSetDeployment. When exporting multiple rules, each rule is downloaded as a separate file and is named with an incremental number for each file. Using the naming ahead, multiple workflow rules would be named ChangeSetDeployment(1).xml, ChangeSetDeployment(2).xml, etc.
-
Select Export.
Note: You may be prompted by your browser to download files. All selected rules are downloaded as one .XML file to your browser's default download folder. Do not modify the XML files that are generated.
To Import Workflow Rules:
-
From the Encompass Admin Portal, select Workflow Management and then select Workflow Rules.
-
Select the Import
button. -
Navigate to the location where the workflow rules .XML file is downloaded, and then select the file or files and select Open.
-
On the Import Workflow Rule(s) window, review the items you and importing and then select Next.
-
Review the validations message and then select Import. Note that any existing duplicate rules will be replaced with the rules in the Import file.
Note: Resulting/Nested action options must be reconfigured after importing