Docs
Docs
Allesda
DE | EN
Plugins
Allesda
DE | EN
Plugins

AUTOMATE

Documentation
Back

AUTOMATE

What is this for?

With AUTOMATE you can control automatic background tasks.

These are tasks that aren't triggered "by click" from a user, but instead run, for example, on a regular schedule:

  • Cleaning up old data
  • Synchronizing / generating (e.g., ICS files for the CALENDAR)
  • Reminders / checks
  • Working off the email queue (together with MAIL)

Which tasks exist exactly depends on your current installation and the enabled plugins — you'll see them as a list in the admin area.

Typical day-to-day actions

  • Enable / disable a task
  • Set the schedule (e.g., daily at 02:00 or every X minutes)
  • Run a task "right now" (for testing)
  • Pause all tasks (e.g., during maintenance) and resume them again

Step by step

1) View tasks

1. Open Admin → Automate (/settings/admin/automate).
2. You'll see a list of all registered tasks with name, status (active/paused), last run, and schedule.

2) Enable a task and set its schedule

1. Click the task in the list or choose "Edit".
2. Turn on "Active".
3. Enter a schedule:

  • a fixed time (e.g., 02:00),
  • or an interval (e.g., every 15 minutes).

4. Save.

3) Run a task immediately ("Run Now")

If you want to verify everything works correctly without waiting for the next scheduled run:
1. Select the task you want.
2. Click "Run" / "Run now".
3. Check the result in the Logging plugin (if LOGGING is enabled).

4) Pause / resume all tasks

Useful during maintenance or imports when no background jobs should interfere:

  • "Pause all" temporarily stops all executions.
  • "Resume" puts them back on the normal schedule.

> Pause/Resume applies globally to all tasks. To disable individual tasks, use the edit form.

Frequently asked questions / problems

"I don't see AUTOMATE"

  • Check whether the AUTOMATE plugin is enabled for the tenant.
  • Permissions: you need admin permissions for the "System" area.

"Task isn't running"

  • Is the task active?
  • Is it paused globally (press Resume)?
  • Test with "Run Now" and check the logs.

"How do I see what a task did?"

  • If the LOGGING plugin is enabled, you'll find the entry there.
  • Otherwise, the list shows the timestamp of the last run.

Technical URLs (quick reference)

Admin (/settings/admin/automate):

  • GET /settings/admin/automate – Overview
  • POST /settings/admin/automate/update – Edit task (active/schedule)
  • POST /settings/admin/automate/run – Run task immediately
  • POST /settings/admin/automate/pause – Pause all
  • POST /settings/admin/automate/resume – Resume all

Notes

  • AUTOMATE runs per tenant. Tasks of other tenants don't affect you.
  • A task is registered by the plugins themselves. So you can't "invent" your own tasks in the UI — you can only configure the existing ones.