@antelopejs/dms-automation
The visual automation builder of the AntelopeJS DMS.
What it does
- Builds procedures as node graphs. Triggers start a run, actions do the work, and flow and data nodes branch, loop and shape values.
- Starts procedures from schedules, webhooks, manual runs or DMS events such as a user registering or a record being created.
- Keeps every run with its trace, shows where and why it failed, and re-runs it with its own payload.
- Shows the health of every procedure, with KPIs over the last 24 hours, 7 days or 30 days.
- Lets any module add its own nodes through
@antelopejs/interface-dms-automation.
Install
Run the AntelopeJS CLI from the root of a project that already loads @antelopejs/dms:
ajs project modules add @antelopejs/dms-automation
Quick start
The module works without configuration. Restart the backend, then the frontend, and open Automation in the Modules group. While no procedure exists, the Overview offers three recipes to start from: Forward a webhook, Send a scheduled digest and Run it on demand.
To add a node from your own module, depend on the interface and register the node in start():
import { RegisterActionType } from "@antelopejs/interface-dms-automation";
RegisterActionType({
id: "bakery.restock-order",
name: "Place restock order",
description: "Order an ingredient restock from a supplier",
icon: "i-lucide-shopping-cart",
inputSchema: { type: "object", properties: { ingredient: { type: "string" } } },
outputSchema: { type: "object", properties: { ordered: { type: "boolean" } } },
async execute(input: { ingredient?: string }, ctx) {
ctx.log("info", "placing restock order", input);
return { ordered: true };
},
});
Compatibility
| Package | Supported | Tested with |
|---|---|---|
@antelopejs/interface-api | >=0.2.0 <1.0.0 | 0.2.0 |
@antelopejs/interface-api-util | >=0.3.0 <1.0.0 | 0.3.0 |
@antelopejs/interface-core | >=0.4.0 <1.0.0 | 0.4.0 |
@antelopejs/interface-data-api | >=0.6.0 <1.0.0 | 0.6.0 |
@antelopejs/interface-database | >=0.3.1 <1.0.0 | 0.3.1 |
@antelopejs/interface-database-decorators | >=0.2.1 <1.0.0 | 0.2.1 |
@antelopejs/interface-dms | >=0.12.0 <1.0.0 | 0.12.0 |
@antelopejs/interface-dms-automation | >=0.6.1 <0.7.0 | 0.6.1 |
@antelopejs/interface-redis | >=0.0.9 <1.0.0 | 0.0.9 |
The @antelopejs/interface-dms-automation row is the interface range this release implements. The module also needs these:
- A DMS backend that implements the
@antelopejs/interface-dmsrange in the table above. - The
@antelopejs/dms-frontendrenderer in the range thatengines["@antelopejs/dms-frontend"]offrontend-vue/package.jsondeclares. Theajs dmsCLI refuses to build the module with a renderer outside that range. - An API provider,
@antelopejs/api, for webhooks. - An
@antelopejs/interface-databaseimplementation. @antelopejs/interface-redis, only to run several instances. See Clustering.
Documentation
The sources of the guide are in packages/dms-automation/docs. The module ships the dms-automation Claude Code skill in packages/dms-automation/skills, declared under antelopeJs.skills.
Contributing
This package lives in the AntelopeJS/dms-automation pnpm workspace, next to @antelopejs/interface-dms-automation. Read CONTRIBUTING.md and the repository README for the development commands.