Approval workflows overview
This page is for web managers, editors-in-chief and administrators who must make sure content is signed off before it reaches the public. In Exponential the sign-off is a workflow with an Approve event, connected to the publishing operation by a trigger. The facts come from Workflows; this page explains the moving parts and the decisions a public body makes.
Contents
- The moving parts
- What happens to one article
- Decisions to make
- Prerequisites people forget
- What approvals do not cover
- Related pages
The moving parts
| Part | What it is | Where |
|---|---|---|
| Workflow | an ordered list of events, in a workflow group | Setup > Workflows (/workflow/grouplist) |
| Approve event | a step that holds a version until an approver decides | the workflow's edit page |
| Trigger | connects a workflow to an operation, before or after it | Setup > Triggers (/trigger/list), row Before publishing content |
| Collaboration item | the approval request approvers decide | My account > Collaboration (/collaboration/view/summary) |
| Pending version | the version waiting for the decision | My pending items (/content/pendinglist) |
| Workflow process | one running approval for one version | Setup > Workflow processes (/workflow/processlist) |
| Workflow cronjob | workflow.php, in the frequent part by default; publishes approved versions | Setup > Cronjobs |
What happens to one article
- An editor presses Send for publishing. The version becomes pending.
- The trigger Before publishing content starts the approval workflow; the Approve event creates a collaboration item for the approvers and the process waits.
- An approver opens the request, reads the preview and presses Approve or Deny (with a comment).
- At the next run of the workflow cronjob: approved versions are published; denied versions go back to the author as drafts (Workflows, section 1).
The editor follows it on My pending items, which says what holds the version and links to the approval.
Decisions to make
| Question | Where it is set | Typical public-sector answer |
|---|---|---|
| Which content needs approval? | Approve event: Affected sections, Affected languages, Affected versions | the public sections, all languages, all versions |
| Who approves? | Groups who approve content (prefer groups to named users) | an approvers' group per area |
| Who may publish without approval? | Excluded user groups | a small, documented group; see Emergency publishing bypass |
| New pages only, or every change? | Affected versions: all, new objects, updates | all versions, if a typo fix must also be checked; otherwise new objects only |
| One approver or two? | one Approve event, or two in sequence | see Two-person rule |
| Separate legal or language review? | an extra Approve event, a second group, or an object state | see Legal review step, Multilingual approvals |
Setting up the event field by field: Setting up the Approve event.
Prerequisites people forget
- The workflow cronjob must run. Without it, approved content is never published. The status bar of Setup >
Workflow processes says whether
workflow.phpis scheduled (Workflows, section 3.4). - Approvers need the rights to decide: the collaboration module and
content/versionread(Role design: approvers). - One workflow per trigger. To run several workflows on publishing, use a Multiplexer event in the triggered workflow.
- Test with sample data:
./console exp:collaborationsampledata --dry-run --allow-root-usershows what it would create;--removetakes it away again (Workflows, section 3.6).
What approvals do not cover
- Removing, moving and hiding content are other operations; the trigger list shows which operations can start a workflow. Limit those rights by role instead.
- The approver's own content is let through by the Approve event.
- Excluded user groups publish directly.
- An approval checks a version, not later changes: the next version needs its own approval (with Affected versions set to all).
Related pages
- Setting up the Approve event
- Collaboration inbox
- Set up an approval workflow for a section
- Workflows guide
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.