Automation editor reference

Documentation Index

Fetch the complete documentation index at: https://docs.practicemate.com.au/llms.txt

Use this file to discover all available pages before exploring further.

Use this reference when you want to understand what each part of the Automation editor does.

​

Opening Automations

Open Automations from the sidebar. The Automations page lets you:

• search saved Automations
• open an Automation
• create a new Automation
• see how many Runs an Automation has
• see whether it is Active or Inactive
• see the next scheduled run
• see the last run status
• open row actions such as Run Now or Delete

​

Editor tabs

Saved Automations have three tabs. Editor is where you build the workflow. Runs shows Automation Run history, run details, activity, and logs. Settings controls processing rules and usage limits. For a new Automation, Runs and Settings are disabled until the Automation is saved.

​

Save Automation

Save Automation stores the current workflow. PracticeMate checks the Automation before saving. You may be asked to fix missing details such as:

• Automation name
• data source
• at least one Automation Step
• selected Recipe
• selected Template
• selected Reviewer for a Clinical Review step

When the Automation is saved, PracticeMate also locks the selected Recipe Version and Template Version for the workflow.

​

Automation details

The first section is Automation details. Use Name for the short label your team will recognise. Good names are specific:

• Birthday Card Email
• Flu Vax Recall SMS
• Weekly Chronic Disease Review Report
• Health Check Clinical Review

Avoid names like Test, New Automation, or Reminder unless the purpose is obvious to everyone who will use it. Use Description for a short explanation of what the Automation is for. For example: Sends patients an email on their birthday.

​

When

The When section controls how Automation Runs start.

​

Manual

Choose Manual when the Automation should only run after a Member chooses Run Now. Manual is useful when:

• you are still building or checking the Automation
• the workflow needs a team member to decide when it should run
• the Automation should not run automatically

Manual Automations can be edited and run manually. They do not have a next scheduled run.

​

Scheduled

Choose Scheduled when PracticeMate should start Automation Runs automatically. Scheduled Automations ask for: Timezone: the local timezone used for the schedule. Frequency: Daily, Weekly, or Monthly. Days of week: shown for Weekly schedules. Day of month: shown for Monthly schedules. Time: the hour, minute, and AM/PM value. PracticeMate also shows the schedule in plain language, such as At 12:00 AM, every day.

​

Active and Inactive

An Active Automation has automatic triggers enabled. An Inactive Automation does not have automatic triggers enabled. Manual Automations appear Inactive because they do not have a schedule. They can still be run manually.

​

Starting from

The Starting from section chooses which patients the Automation should process. Select Add Data Source when the section is empty.

​

Run Recipe

Run Recipe is the current data source for patient-based Automations. It evaluates a Recipe and uses the matching Patient Cohort as the starting point for the Automation. After you choose Run Recipe, use Using Recipe to select the Recipe. PracticeMate shows the expected number of patients based on the last time the Recipe was run. Use this as a sense check before saving or running the Automation.

​

Changing the data source

Use Change when you need to choose a different data source type. Today, most practices will use Run Recipe.

​

Recipe version is out of date

If the selected Recipe has changed since the Automation was saved, the editor may show a warning that the Recipe version is out of date. Choose Update to latest only after checking that the newer Recipe is the one you want this Automation to use.

​

Then do

The Then do section contains the ordered Automation Steps. Each step processes the Patient Cohort from Starting from. Select Add First Step or Add Step to open the step chooser. The chooser lets you browse or search available steps.

​

Step cards

Each step appears as a card. Step cards include:

• a drag handle for reordering
• a step icon
• a step name field
• expand and collapse controls
• a delete button
• the step’s own settings

You can rename a step to make the workflow easier to read. For example, rename Send Email to Send birthday Email if that helps your team. Step order matters. PracticeMate runs the steps from top to bottom.

​

Available Automation Steps

PracticeMate currently includes these step types.

​

Clinical Review

Clinical Review pauses the Automation Run and asks a registered Member to review before the Automation continues. Use Clinical Review when a qualified person should check the Patient Cohort or output before the next steps run. The step asks for: Reviewer: the registered Member who should receive the Clinical Review Request. When the Automation Run reaches this step, PracticeMate creates a Clinical Review Request. The Automation Run waits while the review is open. If the review is approved, the Automation continues to the next step. If the review is rejected or expires, the Automation Run stops. When Clinical Review is followed by more steps, the editor shows a Clinical Review gate between the review step and the remaining workflow. This is a reminder that the next steps only run after approval.

​

Create Report

Create Report creates an exportable spreadsheet from the Patient Cohort. Use Create Report when your practice wants a downloadable snapshot of the patients found by the Automation. The step asks for: Report Name: the name used for the Report. Append Date to Report Name: adds the run date to the Report name, so repeated runs are easier to tell apart. Expire after viewing: makes the Report expire immediately after it is viewed. This is recommended for stronger security.

​

Send Email

Send Email sends an Email Communication to patients using an Email Template. The step asks for: Using Template: the Email Template to send. Send Email uses Template Variables in the Email Template to fill patient and practice details at send time. PracticeMate filters patients before sending. Patients can be skipped when, for example, they have no usable Email address, have opted out, or have already been processed by this Automation when Prevent reprocessing is on. Email Communications use Credits. The Automation’s limits are checked while the step runs.

​

Email template version is out of date

If the selected Email Template has changed since the Automation was saved, the editor may show a warning that the Email Template version is out of date. Choose Update to latest only when you want the Automation to use the newest saved Email Template wording.

​

Send SMS

Send SMS sends an SMS Communication to patients using an SMS Template. The step asks for: Using Template: the SMS Template to send. SMS Templates are filtered separately from Email Templates, so the selector only shows SMS Templates. PracticeMate filters patients before sending. Patients can be skipped when, for example, they have no usable mobile number, have opted out, or have already been processed by this Automation when Prevent reprocessing is on. SMS Communications use Credits based on SMS length and segment count. The automatic opt-out footer is included when SMS content is prepared.

​

SMS template version is out of date

If the selected SMS Template has changed since the Automation was saved, the editor may show a warning that the SMS Template version is out of date. Choose Update to latest only when you want the Automation to use the newest saved SMS Template wording.

​

Wait

Wait pauses the Automation for a set amount of time before the next step. Use Wait when the workflow needs a delay between steps. The step asks for: Duration: the number to wait. Interval: minutes, hours, days, weeks, or months. PracticeMate shows a validation message if the duration is outside the allowed range for the chosen interval, and adjusts the value when you leave the field.

​

Runs tab

The Runs tab shows what happened when an Automation ran. Select a run from the history to view its details. The left side shows Run history. The overview cards show:

• completed run count
• failed run count
• in-progress run count
• average runtime
• Credits consumed and Credits available

The selected run shows:

• status
• total patients
• Credits used
• start time
• completion time
• run duration
• step activity
• run logs

​

Run Now

Run Now starts a Manual Automation Run. PracticeMate asks for confirmation before starting the run.

​

Run statuses

Automation Runs can show these statuses. Completed means the run finished successfully. Failed means an unexpected error prevented the run from finishing. In progress means the run is currently running. Waiting for review means the run is paused while a Clinical Review Request waits for a review outcome. Stopped means the run ended intentionally before all downstream steps, usually because a Clinical Review was rejected or expired.

​

Activity steps

The run detail view shows each data source and step in order. Each activity card can show whether the step:

• succeeded
• failed
• was skipped
• was stopped by a limit
• is waiting

Use this section to see where the Automation spent time and which step needs attention.

​

Run logs

Run logs show messages recorded while the Automation Run was processed. Logs are useful when a step was skipped, stopped, or failed. They can explain issues such as missing contact details, opted-out patients, limit checks, or delivery preparation problems.

​

Settings tab

The Settings tab controls processing rules and limits for a saved Automation.

​

Processing Rules

Prevent reprocessing skips patients previously processed by this Automation for the same Recipe. This is useful for workflows where a patient should not receive the same Communication or be handled repeatedly just because the Automation runs again. For example, in a birthday Email Automation, Prevent reprocessing helps avoid contacting the same patient again if the Automation is run twice for the same birthday Recipe result. Turn it off only when your practice intentionally wants the same patient to be processed again on later runs.

​

Limits

Limits apply per Automation Run. Credit Limit stops the Automation once the run has used that many Credits. Use 0 for no Credit Limit. Communication Limit shows the maximum number of Email and SMS Communications the Automation can send in one run. In the current editor, this value is displayed in Settings but not changed there.

​

Common checks before saving

Before saving an Automation, check:

• The Automation name and description are clear.
• When is Manual while building, or Scheduled only when the workflow is ready.
• The selected Recipe finds the right Patient Cohort.
• The expected patient count looks sensible.
• The selected Template has been reviewed and tested.
• Automation Steps are in the correct order.
• Clinical Review is included when a reviewer should check before downstream steps run.
• Email and SMS steps use the correct Template type.
• Wait steps use the intended duration.
• Report settings are appropriate for the sensitivity of the Patient Cohort.
• Prevent reprocessing is set the way your workflow needs.
• Credit and Communication limits are acceptable.
• The Automation has been saved after important changes.