Workflow
Workflow provides roles, content moderation, an approvals view, preview links, scheduled publishing and service contacts.
To use them you need LocalGov Workflow which is included in LocalGov Drupal, but not switched on. Talk to your developer about enabling it.
How to use
Please see this video guide by content designer Ben Hills-Jones.
Checking if Workflow is enabled
There's an easy way to check if Workflow is enabled on your site. If you see a'Published' toggle and a 'Save' button, Workflow is not enabled.
If you see a 'Current state' drop down menu in the sidebar, Workflow is enabled. Click 'Save' to save the page in the selected state.
Workflow concepts
- Role: A named set of permissions that can be applied to a user account. Depending on your role and your site's custom configuration, you may not be able to do all the actions on this page.
- Revision: Drupal lets you create a new revision every time a piece of content is updated. This allows you to track how the piece of content has changed over time on your site. Read more on drupal.org. One version will be the current revision, indicating which version is available to logged out users.
- State: A revision can exist in one of a number of states (Draft, Needs review, Published, Archived). If the current revision is Published it is available to logged out users.
- Transitions: Moving the current revision from one state to another is called a transitition. We can do this manaully by setting the state when we save a piece of content, or we can schedule a time for it to happen automatically.
Roles
Editor
A Editor may publish all content, and is responsible for moderating content written by Contributors.
- Can move content between all transitions
- Can create, edit, delete media
- Can create, edit, delete all content (except News article / Newsroom)
- Can manage revisions on all content (except News article / Newsroom)
Author
An author can publish their own content
- Can move content between most transitions
- Can create and edit any media
- Can delete own media
- Can create and edit own content (except News article / Newsroom)
- Can delete own content
Contributor
A contributor can draft content and it will be reviewed by an Editor
- Can move content between limited transitions (cannot publish)
- Can create and edit any media
- Can delete own media
- Can create and edit own content (except News article / Newsroom)
- Can delete own content
Content moderation
Content can exist in one of the following states:
- Draft
- Needs Review
- Published
- Archived
Not all roles have the permission to move content between all states.
A common workflow may be:
- A Contributor creates a new piece of content and saves it as Draft
- They return to the content and finish it and save it as Needs review
- An Editor reviews the content and either:
- Publishes it,
- Suggests some amendments and returns it to Draft.
Viewing content
Content is shown under four tabs according to its state:
The "Overview" tab includes all content you have permission to view or edit
"Approve" shows content waiting for you to check and publish
"Review" shows content that has reached its expiry date
"Unpublished" shows content that's not live on your site, in a Draft, Needs Review or Archived state
Creating a new draft of Published content
When we edit a piece of published content and save it as Draft or Needs Review, the content remains published and creates a new revision.
The Latest version tab will show the new revision, whereas the View tab will allow you to see the current Published version.
Revision log
You can leave a comment in the Revision log to describe what is being changed in any given edit.
You can view all revisions of the content by visiting the Revisions log. You can compare versions, and restore a previous version if necessary.
Previews
Responsive layout preview
At the top of the edit page, next to your account settings there is a button ("Layout preview") which allows you to preview how the content will look across a number of devices.
If you don't see this button talk to the site administrator.
Preview link
Depending on your permissions, you can also generate a Preview link. This allows you to share a draft of a piece of content with another person for time you specify.
The preview can be viewed by anyone with the link, so caution should be taken when sharing unpublished content.
Sharing a Preview link for multiple pages
It's now possible to create a single link for a Guide, Step by Step and Subsite, so you don't have to send individual links to each pages. Go to an overview page then click on 'Preview link' and you should see the child pages have been automatically added.
If you don't see this happening:
- update localgov and code for each content format: Guides, Step by Step and Subsites
- when logged in, go to Config > Content Authoring > Preview Link settings and turn 'Multiple entities' on
- if neither work, ask your developer or post a message in #group-content and we'll help
Previewing multiple pages at once doesn't work in Directories or on Subsite pages yet. We're working on this and will keep you posted.
Setting the Preview link expiry time
You can now decide how long a preview link will continue working. It's a single value for all preview links you send, rather than a different value for each one.
To set the expiry time:
- go to Configuration > Preview link settings
- scroll to the foot of the page and you'll see this field
- Enter the number of days you would like the preview link to last
- Click 'Save configuration'
Scheduled publishing
'Scheduling' allows you to publish or unpublish content at a specific date and time, so you don't have to stay up late!
This needs a submodule called 'LocalGov Review Date'. It's included in LocalGov Drupal, but is not switched on - talk to your developer about enabling it.
How to publish content on a specific date
- Create a piece of content and leave it in either "Draft" or "Needs review"
- Click the 'Scheduling' tab
- Click 'Add Schedule' button
- Leave the 'latest revision' revision selected
- On the 'Execute transition dropdown' select the 'Publish' option
- Set the date and time you want
- Click the 'Schedule' button when done
How to unpublish content on a specific date
- Create a piece of content and Publish it
- Click the 'Scheduling' tab
- Click 'Add Schedule' button
- Leave the 'latest revision' revision selected
- On the 'Execute transition dropdown' select the 'Archive' option
- Set the date and time you want
- Click the 'Schedule' button when done
How to publish a new version of a piece of published content on a specific date
- Create the two versions
- Create a piece of content and publish it
- Edit the content to create the new version and save it as Draft or Needs Review
- Create a transtion to unpublish the first version
- Click the 'Scheduling' tab
- Click 'Add Schedule' button
- Select the currently published revision
- On the 'Execute transition dropdown' select the 'Archive' option
- Set the date and time you want
- Click the 'Schedule' button when done
- Create a transtion to publish the second version
- Click 'Add Schedule' button
- Select the version that you want published in the future
- On the 'Execute transition dropdown' select the 'Publish' option
- Set the date and time you want
- Click the 'Schedule' button when done
Manage all scheduled content
To see and manage all current scheduled content, click on Content > Scheduling. Here you can review, delete or reschedule any of the transitions.
Review date
This needs a submodule called 'LocalGov Review Date'. It's included in LocalGov Drupal, but is not switched on - talk to your developer about enabling it.
Content should be reviewed regularly to ensure that it is relevant and up to date. We can track these reviews using the 'Review date' feature.
An example workflow for Review date
- On publishing a piece of content we set a default review date of 1 year
- A year passes and the review due date passes
- A revision of the content appears in the "Needs Review" dashboard
- An editor does a thorough review and publishes the reviewed content, with a new review date of 1 year.
Set the Review date
When you create or edit a piece of content you will see the Review date panel in the sidebar.
When you make an edit you can choose whether to classify it as a "Content review" or not. By default this is set to false.
If you toggle this button to true you can set the date that the next review is due.
When the next review is due, a revision of the content will appear under the 'Review' tab. The (unreviewed) content will remain published unless you decide to remove it.
Service contacts
This feature allows you to:
- assign 'owners' or 'subject matter experts' to content to save you capturing this information in a spreadsheet or elsewhere
- automatically email them when content needs to be reviewed
To use this you need the 'LocalGov Workflow Notifications' and 'LocalGov Review Date' which are included in LocalGov Drupal, but not switched on. Talk to your developer about enabling them.
How to use
Please see this video guide by content designer Ben Hills-Jones.
Adding a service contact
- Click on 'Content' in the main menu and then 'Service contacts'
- Click on 'Add service contact'
- Either add a Drupal user (start typing their username) or add a name and email address
- Notifications (by email) default to on, but you can turn them off if you like
- Add notes if you wish
Attach a service contact to any page
- Navigate to the page and click 'Edit'
- In the right hand panel, look for 'Service contacts'
- Start typing their name
- Click 'Remove' if a contact is no longer needed
- Set the review date as described above
When the review date is reached, an email will be sent to all the Service contacts listed on that page.
Possible upgrades
We're thinking about:
- Importing service contacts and associating them with content, maybe via a spreadsheet upload
- Creating groups of service contacts to cover holidays and people moving on
- Assigning groups of urls to a pages to a service contact so it's quicker to manage. The interface would be similar to content access by path
- Allowing service contacts to comment or make changes in Drupal rather than replying by email
If you like any of these ideas please get in touch!