Scheduler

Overview#

The Scheduler is designed to streamline operations, allowing Administrators to set up and manage recurring tasks efficiently. It provides an intuitive way to automate routine actions, ensuring that users can meet deadlines without the need for continuous manual intervention. The Scheduler is flexible, offering a variety of Schedule Types — whether it’s sending email reminders, managing lists, or automating record related tasks. This versatility makes it a handy companion for managing your daily operations.

Scheduler Page#

Top Bar

At the top of the page, you'll have access to the following:

Setting	Description
Create Task	A button located at the top-right of the page, enabling users to create a new scheduled task. Clicking it will open up the configuration options that will vary depending on the type selected.
Search Tasks	A search bar next to the “Create Task” button allowing users to search for specific tasks by name in order to view, edit, or delete the task.

Centre

Tasks are presented in a table format with the following column headings:

Setting	Description
Name	Lists the names of scheduled tasks. Each task includes an edit button (pencil icon) next to the name, allowing users to modify the task settings.
Status	Shows the current status of each task.
Enabled	Contains a toggle switch for each task, providing a quick visual reference of which tasks are currently active and allowing users to easily enable or disable tasks as needed.
Type	Displays the type of the scheduled task that was defined on creation. This gives an indication on the function that the task is carrying out. More information can be found on the Schedule Types page.
Next Run	Shows the next scheduled run time for each task. Includes an edit button (pencil icon) next to the date & time, allowing users to manually specify the next time the task runs.
Frequency	Indicates the schedule of how often the recurring task is set to run.

Create/Update Task Window#

Having clicked on the "Create Task" button or the edit icon for an existing task, the following configuration options will be displayed:

Setting	Description
Name	Field to input the name of the task being created. Typically a name will be given that indicates what task is being performed and the name of any people or departments that may be relevant. This serves as a helpful reference when managing tasks in the future.
Type	Dropdown to select the type of task (e.g., Reports Export, List Reminder, etc.). Upon selecting a task type, additional configuration options will appear below. More information can be found on the Schedule Types page. This is only editable when creating a new task.
Start Date and Time	Only shown when creating a new task, this section is where you set when the automated task should run for the first time. Date: Calendar picker to select the date for the first run of the task. Time: Time picker to set the exact time for the first run of the task.
Task Frequency	Section to configure how often the task should run. Period: Numerical field to set the interval between runs. Unit: Dropdown field to choose the time unit (Days, Weeks, etc.) for the defined Period. Days Selection: If the Period/Unit is set to "1 Days" then checkboxes will be displayed in order specify which days of the week the task should be performed (e.g., Monday and Friday).
Task Activation	Ticking the Enable task checkbox will make the task live once created/updated and it will then run according to the Next Run time and schedule frequency.
Workflow	Optional section to configure an automated email after the task completes. Add a recipient: Field to input the name and email address of all necessary recipients. Subject: Field to set the subject of the email. Email Body: Rich text editor to customise the content of the email, allowing you to format text and include placeholders (e.g., `[Recipient.Name]`, `[Account.Name]`).
Create/Update Task Button	Confirmation button at the bottom-right of the window to save the task based on the provided settings.

Start typing to search, or search using the advanced options below.