Skip to content

Using the Task Scheduler

This document provides an overview of Crafty's task scheduler, which allows you to automate a wide range of tasks, such as backups, running commands on the server console, starting and stopping the server, and more.

With the task scheduler, you can set up complex schedules with ease, specifying intervals of days, months, and times, or using advanced cron expressions for more fine-grained control.

Additionally, you can chain tasks together so that they trigger automatically based on the success of it's parent task.

The task scheduler is a powerful tool to help you save time and streamline your workflow. This document covers essential topics such as scheduling tasks and configuring task chains, to help you get started and make the most of this feature.

Scheduling Tasks

  • Click "Create New Schedule"
  • Choose Whether you want this to be basic, cron, or chain reaction.
    • Basic - Crafty will break down all the scheduling triggers for you.
    • Cron - You will manually use a cron string to set the trigger.
    • Trigger - This schedule will run after its linked schedule runs.

Options will appear and disappear depending upon user's configuration options

sheduler basic example Action - What task do you want your schedule to complete?
Interval - How often would you like this schedule to trigger? (This will take an integer)
Delete After Execution - This would only be triggered one time. Crafty would delete the schedule after execution when this is checked.

sheduler cron example Cron String - This is a validated cron string. For more information on cron please visit Crontab in linux w/ examples
For help creating cron strings we recommend crontab.guru.

Non-standard weekday index

Due to the way our scheduling module works the last value in the Cron string that determines the day is offset by one... So 0 is Monday and not Sunday

HINT: Using day abbreviations still works just fine (MON-SUN).

Delete After Execution - This would only be triggered one time. Crafty would delete the schedule after execution when this is checked.

sheduler chain reaction example Action - What task do you want your schedule to complete?
Delay Offset - How long Crafty will wait after dispatching the parent schedule before firing this one.
Select a Parent Schedule - The schedule that will trigger this schedule upon it's completion.
Delete After Execution - This would only be triggered one time. Crafty would delete the schedule after execution when this is checked.

Example Schedules

Here are some example schedules you could run: Example Schedules