civex automation
Manage automated workflow processing
| Command | Description |
|---|---|
cancel |
Cancel one run. |
delete |
Delete runs, so a waiting one never starts. |
enqueue |
Manually enqueue a workflow job for a specific record. |
jobs |
List workflow jobs, with the fields that started each one. |
logs |
Show captured log output for a job. |
resume |
Lift a pause: triggers fire and waiting runs are picked up again. |
run |
Process all pending workflow jobs. Use --watch to keep polling. |
stats |
Show failed step-execution counts by plugin, across all jobs. |
status |
Say whether automation is paused, and how many runs are waiting or running. |
stop |
Stop all automation, for example a workflow that keeps triggering itself. |
civex automation cancel
Cancel one run.
A waiting run never starts; a running one stops before its next step.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
JOB_ID |
str |
yes | Job ID or short prefix |
civex automation delete
Delete runs, so a waiting one never starts.
A running run stops before its next step; a finished one is removed with its log. What a run already changed in records stays, in their history.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
JOB_IDS... |
str |
no | Run IDs or short prefixes |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--pending |
flag | false |
Every run still waiting to start. |
--yes, -y |
flag | false |
Don't ask first. |
civex automation enqueue
Manually enqueue a workflow job for a specific record.
Usage
Options
| Option | Type | Default | Description |
|---|---|---|---|
--workflow, -w |
str |
Workflow name (required) | |
--record, -r |
str |
Record ID or short prefix (required) |
civex automation jobs
List workflow jobs, with the fields that started each one.
Usage
Options
| Option | Type | Default | Description |
|---|---|---|---|
--status, -s |
str |
Filter: pending, running, completed, failed, cancelled |
civex automation logs
Show captured log output for a job.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
JOB_ID |
str |
yes | Job ID or short prefix |
civex automation resume
Lift a pause: triggers fire and waiting runs are picked up again.
Usage
civex automation run
Process all pending workflow jobs. Use --watch to keep polling.
Usage
Options
| Option | Type | Default | Description |
|---|---|---|---|
--watch, -w |
flag | false |
Keep polling for new jobs |
--interval |
int |
5 |
Seconds between polls (--watch only) |
civex automation stats
Show failed step-execution counts by plugin, across all jobs.
Usage
civex automation status
Say whether automation is paused, and how many runs are waiting or running.
Usage
civex automation stop
Stop all automation, for example a workflow that keeps triggering itself.
Pauses automation (nothing new is triggered or started, and manual runs are
refused), cancels every waiting run, and stops every running one before its
next step. A step already in progress finishes or times out first. Start
again with civex automation resume.
Usage
Options
| Option | Type | Default | Description |
|---|---|---|---|
--yes, -y |
flag | false |
Don't ask first. |