Field Triggers

View the "Creating and Using Business Rules" Quick Reference Guide

Use the Field Triggers tool to create and manage rules that execute custom actions when the value in a field is changed. You can specify a condition for applying the rule, the field ID and criterion for triggering the rule, and the action to take when the criterion is met.

You can also export Field Trigger business rules, one at a time, from an Encompass environment, save them onto your computer and then import the business rule into another Encompass environment. All Field Trigger business rules can be exported and then imported, irrespective of their Status.

To Create a Field Trigger: 

  1. On the menu bar, click Encompass, and then click Settings.

  2. On the left panel, click Business Rules, and then click Field Triggers.

  3. On the Field Triggers screen, click the New icon.

ClosedCreate a Trigger Name

  • Type the name of the trigger.

ClosedSelect all Channels this rule applies to 

  • Select the channels where the rule will be applied.

  • Select No channel selected to apply the rule to a loan where none of the channel options are selected.

Note: The channel for each loan is specified on the Borrower Summary form.

ClosedIs there a condition for this trigger

  1. Select No to always apply the rule.

  2. Or, select Yes to create a condition for when the rule is applied.

  • Select a category for the condition, such as Loan Purpose.

  • Select a value for the category, such as Purchase.

  • If you select Current Role for the category, you can configure the rule to only be applied when a specific role is assigned to finish a specific milestone. After selecting Current Role, click the Lookup icon (magnifying glass), and then select the specific role. Then select the specific milestone from the drop-down list.

Note: If you select the Advanced Conditions option, you can create expressions to define custom conditions. Click the Find icon to select filters for the Advanced Conditions option or, for detailed instructions on how to create your own code, refer to the "Advanced Coding for Business Rules" document.

ClosedSelect Filters for the Advanced Conditions Option 

  1. Select Advanced Conditions as the category condition, and then click the Find icon on the right.

  2. Click the New icon to add a new filter.

    Note: If you have existing filters, the New icon places the new filter at the bottom of the list. Select an existing filter and then click the Insert button to insert a new filter above the selected filter.

  3. On the Add/Edit Search Filter window:

    • Type a Field to add as a filter.

    • Or, click the Find icon, select a field from the list, and click OK.

    • Or, click the Find icon, type one or more characters in the Find field and then click Find. The first occurrence of the characters in any column is found. Continue clicking Find to view additional occurrences. Select a field from the list, and click OK.

  4. Select an Operator, enter (or select) a Value, and then click OK.

    • The Operator and Value define how the field will be used. For example: Field ID= 1109 (Loan Amount), Operator = Greater than, Value = 250000.

  5. Click OK.

  6. Repeat steps 2 through 5 to add more filters.

  7. To use parentheses to control the order in which multiple filters are evaluated, click Parentheses, select the filters to group, click the New icon, and click OK.

  8. Use the AND/OR button to determine how search filters are used together.

  9. When finished, click OK.

ClosedAdd and apply field events

  1. Click Add.

  2. In the Activation section of the window, select the Activation Type.

  • Based on the activation type you select, you will be asked to enter additional information as described below.

ClosedIf you selected Field value modified as the Activation Type

  • Enter the field ID for the field associated with the field event. Or click Find, select a form from the left, right-click to select a field, and then click Add.

  • Select the Criterion that will activate the rule, such as Any change in field value. Depending on the selection, you may be asked to enter additional information as follows:

  • When field is set to a specific value - Enter the value in the Value field.

  • When field is set in a range of values - Enter the lower and upper limits of the range in the Range fields (available for numeric fields only).

  • When field is set to an item from a list of values - Create a list of the values that will be checked against the value entered in the field. Click Add and then type the value over <New Value> on the list. Repeat the process to add more values to the list.

ClosedIf you select Milestone completed as the Activation Type

  • Select the milestone that will trigger the rule when it is completed.

ClosedIf you select Rate Lock actions as the Activation Type

  • Select a rate lock event from the Rate Lock Action drop-down list.

  1. In the Action section of the window, select the action that will be triggered when the defined criterion is met.

ClosedUpdate the value of one or more fields

  1. In the Action section, Click Add.

  2. In the Assign To Field field, enter the field ID of the field that will be updated.

  3. In the Value field, enter the value that will be assigned to the field ID.

  • If you select the Evaluate expression as a custom calculation check box, you can enter a calculation that will be used to determine the assigned value. For detailed information on creating custom calculations, refer to the "Loan Custom Field Calculations" document.

  1. Click OK. Repeat to add additional fields to update.

ClosedCopy new value into one or more fields

  1. In the Action section, click Add.

  2. In the Copy To Field list, type a field ID over <Enter Field ID>. The value associated with the Trigger Field ID, will be copied to this field.

  3. Repeat steps 1 and 2 to add additional fields to copy the value from the Trigger Field to.

ClosedMark one or more tasks as complete

  • Select the tasks that will be marked as completed when the event is triggered.

ClosedSend an Email to One or More Users

  1. In the Action section, click Add.

  2. Enter the Subject and Body of the email. You can include loan data by specifying a field ID within square brackets.

  3. Select the check box to include the email information in the Loan Log.

  4. Click the plus (+) buttons to select the Users and Roles that will receive the message.

  5. Click OK.

ClosedRun advanced code

  1. In the Advanced Code area, enter the code that will be run when the action is triggered. For detailed instructions on how to create your own code, refer to the "Advanced Coding for Business Rules" document.

  2. Click OK.

ClosedApply a loan template

  1. In the Action section, select Apply loan template form the Action Type list.

  2. Click the Find icon next to the Select Loan Template field, select a template to apply, and then click Select.

In the following scenarios, the business rule will be triggered as expected if the conditions of the rule are met, however, the loan template will not be applied to the loan file: 1) if the trigger field is changed by a field calculation or other logic (i.e., the trigger field is a calculated field), 2) the trigger field is changed by other components that don't rely on the user utilizing an on-screen element to change the field value (for example, an ICE Mortgage Technology Network service or the Encompass SDK), or 3) the trigger field is changed due to an imported item.

  1. When finished adding event details, click OK.
  2. In the Notes/Comments field, type details and helpful notes about the rule as needed.

  3. When finished, and then click Save.

Work with Field Triggers