You are viewing an older version of the Workflow documentation (2.x). View the latest version (3.x) →
Feature Tour

Setup

Workflow makes use of Craft's inbuilt user permissions system, which is already quite powerful. Permissions allow us to set whether a user can edit an entry, or publish live changes - we'll make use of that.

User Groups

To get started, you'll need to create two member groups - lets call them Editor and Publisher. Editor users will be able to create entries, save drafts, and submit these for review. They will not be able to publish entries live. Publishers on the other hand have essentially full access, and are the recipient of email notifications when entries need to be reviewed and approved.

Editors

Start by making a User Group called "Editor" with the following settings for the section you want Workflow enabled for:

General

  • ☐ Access the site when the system is off
  • ☑ Access the control panel
    • ☐ Access the control panel when the system is offline
    • ☐ Perform Craft CMS and plugin updates
    • ☐ Access Workflow

This permission isn't required for front-end submissions.

Section - Pages

  • ☑ View entries
    • ☑ Create entries
    • ☐ Save entries
    • ☐ Delete entries
    • ☑ View other users’ entries
      • ☐ Save other users’ entries
      • ☐ Delete other users’ entries
    • ☑ View other users’ drafts
      • ☐ Save other users’ drafts
      • ☐ Delete other users’ drafts

Things to note are disabling access to the Workflow plugin page, and disabling the ability to Save entries which controls publishing live changes.

Reviewers

You can also make use of more "steps" in the reviewal process by adding Reviewers - as many as you like - between Editors and Publishers.

General

  • ☐ Access the site when the system is off
  • ☑ Access the control panel
    • ☐ Access the control panel when the system is offline
    • ☐ Perform Craft CMS and plugin updates
    • ☐ Access Workflow

Section - Pages

  • ☑ View entries
    • ☑ Create entries
    • ☐ Save entries
    • ☐ Delete entries
    • ☑ View other users’ entries
      • ☐ Save other users’ entries
      • ☐ Delete other users’ entries
    • ☑ View other users’ drafts
      • ☑ Save other users’ drafts
      • ☐ Delete other users’ drafts

Publishers

Create another User Group called "Publisher" with the following settings:

General

  • ☐ Access the site when the system is off
  • ☑ Access the control panel
    • ☐ Access the control panel when the system is offline
    • ☐ Perform Craft CMS and plugin updates
    • ☑ Access Workflow

Section - Pages

  • ☑ View entries
    • ☑ Create entries
    • ☑ Save entries
    • ☐ Delete entries
    • ☑ View other users’ entries
      • ☑ Save other users’ entries
      • ☐ Delete other users’ entries
    • ☑ View other users’ drafts
      • ☑ Save other users’ drafts
      • ☐ Delete other users’ drafts

Workflow

  • ☑ Overview
  • ☐ Settings

You can name either of these groups whatever you like, but we'll refer to them as Editor/Reviewer/Publisher throughout the guide.

Plugin Settings

Next, head to the plugin settings for Workflow, and assign both these groups you created to their respective fields. Easy as that!