Workflows

A workflow is a mechanism that enforces a sequence of operations through which an item moves from draft to publication. Each workflow is a set of statuses and transitions.

Creating workflows

You can create different workflows for different types of items. For example, the workflow for an article can include first draft, final draft, and publication. The workflow for an image can include initial upload, cropping, and adding metadata.

To create a workflow:

  1. From the Navigation Menu, select Admin > Workflows. A New Workflow widget appears.
  2. In the Name field, type a name for the workflow.
  3. In the Sites field, add sites to which the workflow applies (or leave blank to apply the workflow to all sites). For information about creating sites, see Creating sites.
  4. In the Content Types field, select the content types to which this workflow applies.
  5. In the Actions field, do the following:
    1. Click Add Status. A new status box appears.
    2. Type the name of the status.
    3. If this is the first status that you created, click Add Transition in the status box labeled New. Otherwise, click Add Transition in the previous status box that you created.
    4. Drag your mouse over the status box you created in step a. A transition box appears between the two status boxes.
    5. In the transition box, type a name for the transition.
    6. Repeat steps a–e to add additional statuses and transitions.
  6. Click Save.

The following example is an illustration of a simple workflow for an article.

../../../_images/new-workflow.png

Simple workflow

After you save a workflow—

  • Brightspot lists the workflow in the Workflows widget.
  • Each time you create a new item for the workflow’s content type, the Editorial toolbar displays the workflow status and a Workflow button. When the button is clicked, the Workflow Widget appears.
  • Brightspot saves a draft for each status in the workflow. You can retrieve those drafts from the Revisions widget.
  • The item’s current status appears in the dashboard’s Recent Activity and Unpublished Drafts widgets.
  • Items created before a workflow was created automatically enter the workflow—unless they are published. For example, if you saved a draft of an article, and your administrator later created the Simple workflow, your article can be submitted to the workflow.

For a details of an item’s statuses as it transitions through a workflow, see Workflow status.

Modifying workflows

To modify a workflow:

  1. From the Navigation Menu, select Admin > Workflows. The Workflow widget appears with a list of existing workflows.
  2. Click the workflow you want to modify. Brightspot displays the workflow in the Edit Workflow widget.
  3. Modify the workflow; see Creating workflows for details.

Archiving workflows

To archive a workflow, follow the procedure in Archiving content.

Transitioning an item through a workflow

To transition an item through a workflow:

  1. Open the item in the content edit form.

  2. Perform the required edit for the item’s status. For example, if the item’s status is Pending Review, perform an editorial review to accept or reject the article.

  3. In the Editorial toolbar, click Workflow. A widget appears.

    ../../../_images/workflow-widget-review-state.png
  4. In the Workflow widget, do the following:

    1. Enter an optional comment for the users or roles performing the next step in the workflow.
    2. Click the applicable transition.

Brightspot retains a draft of an item in each status. For example, referring to the illustration Simple workflow, Brightspot saves a copy of the article in the Pending Review, Approved, Rejected, and Published statuses. You can retrieve the draft of an item in each of its statuses; for details, see Revisions widget.

Introducing published content into a workflow

When you create a workflow for a particular content type, published items of that type are exempt from the workflow. However, you may want published items to go through a workflow, such as if you added a quality control step for spelling or graphic attributions.

  1. Search for the published item and open it in the content edit form.

  2. Do one of the following:

    In either case, the item enters the workflow associated with its type.

Limiting users’ access to workflow transitions

You can limit users’ access to certain workflow transitions. For example, you may want one group of users to do only content editing, and another group of users to do only proofreading. This level of access control is available only for user roles, not for individual users.

To limit access to workflow transitions:

  1. From the Navigation menu, select Admin > Users & Roles.

  2. In the Roles widget, select the role whose available transitions you want to limit. The Edit Tool Role widget appears.

  3. Under Main, under Permission Settings, under Types, select All Except. A form appears.

    ../../../_images/roles-permissions-options.png
  4. Under Restricted Types, click add_circle_outline and select Content Type. A form appears.

    ../../../_images/restrictions-content-types-transitions.png

    Restrictions on content type-transitions for a role

  5. From the Type list, select a content type.

  6. From the Actions list, select All Except. A form appears.

  7. From the Type Actions list, select the transitions that you want to exclude from the role.

  8. Repeat steps 4–7 to add additional restrictions for content type-workflow transition combinations.

  9. Click Save.

Referring to the illustrations Simple workflow and Restrictions on content type-transitions for a role:

  • When the role is working on an article, and
  • When the article is in status Pending Review, then
  • The role can only reject the article, not approve it.
  • All other roles can both approve and reject the article.
../../../_images/workflow-widget-limited.png

Workflow options for role with limited permissions

../../../_images/workflow-widget-unlimited.png

Workflow options for role with unlimited permissions