Plan: Not Available: Intermediate Available: Pro or Elite
Users: Not Available: All users Available: FYI Admins or User Group permissions
Practice Management Source: Available: All sources
The Stop step is used to prevent remaining steps in a process from executing, if the specified filter no longer applies, or where various conditions are met. For example, if the Process Filter uses a view filtered to particular Job States only, the Stop step will stop the remaining steps if the Job is no longer in that state.
Note: This step does not stop the entire process, only one instance of the process for a particular record. If an entire process needs to be stopped, refer to Stopping a Process that is In Progress.
Stop Step
The Stop step can be configured to stop when either the View selected in the Automation Filter no longer matches, or when selected field conditions are met.
Note: The View no longer matches option does not apply when using CSV Import or Event (Beta) filters. The Field conditions met option must be used to control when the process should stop.
The following is an example of the Stop step, when View no longer matches is selected.
For example, a process is created with a filter on Jobs in a view with a particular Job State (such as Waiting Client Info).
- The process is to send a reminder email to those clients, a Delay step is then set for one week, followed by a Stop step, and then a second reminder email.
- The second email will only send if the job status remains unchanged.
- If the Status has been updated since the process ran, the remaining steps for the process will not execute as those particular jobs no longer match the filter criteria, however the steps will execute for those jobs that still match the process filter.
The following is an example of the Stop step, Field conditions met is selected.
The Field conditions met option allows the process to be stopped based on the specific fields, and the value selected for those fields. This includes fields not available to the view selected in the Process Filter.
For example, if a process is created on a filter with Jobs in a particular Job State, the Field Conditions met can be configured to stop based on:
- The client associated with the job.
- Steps earlier in the process.
- Custom Fields being enabled/disabled.
Advanced Merge Field Formatting can be used to perform calculations or more advanced conditions.
Stop Fields
| Field | Details |
| Stop when |
Used to manage when the process will be stopped. This field can be set to either:
|
| Field |
Displayed within the Conditions section when "Field conditions met" is selected for the Stop When field. Click the Merge Field icon to select the field to be evaluated. Fields based on the Automation Filter will be displayed, as well as general and practice fields, and fields from any steps earlier in the process. |
| Check |
How the field conditions will be checked:
|
| Value |
Enter the value that when matched will cause the automation to be stopped. Values can be manually entered, or selected from a Merge Field, for example, where one field should be matched against another. The value field is case sensitive. Please note when using the Value field:
|
Working with the Stop step
Adding Multiple Conditions
More than one condition can be matching by clicking Add Condition. Another Condition section will be added to the drawer.
When the process is run, all of the conditions will need to be matched to stop the process. If you would like to match one or another condition, you will need to add multiple Stop steps to the process.
Deleting a Condition
To remove a condition, click on the Condition heading to expand the section, and click Remove.
The last condition cannot be removed. To remove the conditions altogether, remove the step from the Automation Process.
Viewing if Conditions were met
When a condition has been met, and the process has been stopped, the Process History tab will display the Status of "Stopped".
The Process Activity drawer will also display more details on when the conditions were evaluated, and what the current value of the field was when the Stop step was run.
- Navigate to the Process History tab.
- Click on a process in the list to display the Process Activity drawer.
Note: If the process was stopped, the Stop step and any further steps that weren't run will display the Stop icon. If the Stop step determined the process should continue, the Success tick icon will be displayed.
- In the Stop step, click on Evaluation of Stop Conditions to expand the section.
In the example above, the "Job Reminders" Custom Field was set to "false" (i.e. not equal to "true") so the process was stopped.