Using workflows

What is a workflow?

Workflow is a sequence of steps that define the life cycle of pages. This ensures the quality of content by setting up a reviewing and approval process. In such a process, individual roles and users can work with pages in certain steps of their life cycle (such as Edit, Published, Archived, …).

An example of a simple workflow process is a website that publishes scientific articles. An author writes an article and sends it for approval to an editor. The editor makes corrections and submits the article to the head of the respective department. The head then publishes the page, thus making it publicly available to read on the website.

Note

Workflow only covers editing of page content, typically on the Page or Content tab in the Pages application. Changes made to the static design of pages are outside the scope of workflow.

Using workflows

This topic describes how you can manage pages under a workflow.

The following tasks refer to buttons in the Pages application by their default captions, e.g., Submit for approval, Approve, Reject. However, the caption texts are customizable, so you may not always see the same buttons in the user interface.

Applying a workflow on a page

This functionality is useful when you want to apply a workflow on a page, or a page and its children. For example, when you create a page outside of an existing workflow scope.

Your site needs to have at least one workflow defined, and you need to have the Manage workflow permission assigned in the content module to be able to use this functionality.

To apply a workflow on a single page or a page and its children:

  1. In the Pages application, navigate to the page that you want to apply a workflow on.

  2. Click Apply workflow.

  3. Select the workflow that you want to apply on the page.

  4. Choose from the following options:

    1. To this page only
    2. To this page and its children

    Selecting a workflow to apply to a page

    Applying a workflow on a page directly also creates a workflow scope that can be edited later.

  5. Click Save & Close.

Submitting a page for approval

When a page is in the Edit step, you can submit it for approval to move it to the next step.

  1. In the Pages application, navigate to the page that you want to submit for approval.
  2. Click Submit for approval. The page will be moved to the next step in the workflow process.

Submitting a page for approval with a comment

To submit a page for approval and add a comment for the person who will be approving it, follow these steps:

  1. In the Pages application, navigate to the page that you want to submit for approval.

  2. Click (…) icon next to the Submit for approval button and then click Comment and submit for approval. A dialog box opens.

    Commenting and submitting a page for approval

  3. Enter your comment and click Approve. The page moves to the next step in the workflow process.

Viewing pages waiting for your approval

To view and manage pages that are in a workflow step that you can approve:

  1. Open the Pending pages application.
  2. (Optional) Click Navigate to page to view the current version of the page on the live site.
  3. (Optional) Click Edit to make changes to the page and approve or reject it.

Approving and rejecting a page

When a page reaches a step that requires user interaction, you can approve the page, or, if settings of the step permit, reject it.

  1. Navigate to the page you want to approve or reject.
  2. (Optional) Make changes to the page.
  3. Approve or reject the page. Note that if the step that follows is the Published step, the default text of the Approve button changes to Publish.
    1. To approve the page without commenting on the approval, click Approve.
    2. To reject the page without commenting on the rejection, click Reject.
    3. To approve the page and make a comment, click the arrow icon next to the Approve button, then click Comment and approve. Enter your comment into the dialog box and click Approve.
    4. To reject the page and make a comment, click the arrow icon next to the Reject button, then click Comment and reject. Enter your comment into the dialog box and click Reject.

Publishing a page

When a page is published, its most recent version will be made available to visitors on the live site. You can publish pages in one of the following ways:

  • Manually moving through the whole workflow process
  • Directly publishing if the current step allows it
  • Publishing multiple page at once

Manually moving through the whole workflow process

  1. Navigate to the page that you want to publish.
  2. Repeatedly approve the page until it is in the Published step.

Directly publishing a page

When a page is in a standard approval step and the settings of the step allow it, you can publish the page immediately. To do this, a direct approval path must exist in the workflow process. Direct publishing won’t work if your workflow process contains user decisions.

  1. Navigate to the page that you want to publish.
  2. Click the arrow icon next to the Approve button, then click Approve until published.

Publishing multiple pages at once

You can publish entire sections of your website using the List mode.

  1. In the Pages application, switch to the Listing mode.
  2. Navigate to the page, which is a parent of the pages that you want to publish.
  3. Select the pages you want to publish. You have two options:
    1. Check the boxes next to pages you want to publish.
    2. Select All pages in the drop-down list below the page list.
  4. Select Publish in the drop-down list marked (select an action) and click OK to confirm. You will be redirected to a page with the list of pages to be published.
  5. (Optional) Adjust the following settings:
    1. Publish also all child pages
    2. Perform Undo check-out for checked out pages – if checked, all pages that are checked out will be checked in and the changes made during the last check-out will be discarded.
  6. Click Yes to start publishing the pages.

Sending notification emails

Before moving a page to the next workflow step, you can prevent the system from sending notification emails to users involved in the next step. To manage moving of pages between different workflow steps without sending notification emails, switch to the Properties -> Workflow tab and clear the Send notification emails check box.

Note that based on your system configuration, you may not be able to view the Workflow tab.

Archiving a page

When you archive a page, it stays in its location in the content tree, but it isn’t visible on the live site. You can archive pages in one of the following ways:

  • Manually archiving
  • Archiving multiple pages at once

Tip: You can set a Redirect after unpublish on the Content tab of a page to redirect users to a different page after the URL of the archived page is accessed.

Manually archiving a page

When a page reaches a step that is immediately followed by the Archived step, you can click the Archive button to archive the page.

Archiving multiple pages at once

You can archive entire sections of your website using the List mode.

  1. In the Pages application, switch to the Listing mode.
  2. Navigate to the page, which is a parent of the pages that you want to archive.
  3. Select the pages you want to archive. You have two options:
    1. Check the boxes next to pages you want to archive.
    2. Select All pages in the drop-down list below the page list.
  4. Select Archive in the drop-down list marked (select an action) and click OK to confirm. You will be redirected to a page with the list of pages to be archived.
  5. (Optional) Adjust the following settings:
    1. Archive also all child pages
    2. Perform Undo check-out for checked out pages - if checked, all pages that are checked out will be checked in and the changes made during the last check-out will be discarded.
  6. Click Yes to start archiving the pages.

Viewing a page’s workflow history

For all pages under a workflow, the system records every move from one step to another. That means that you can review all the workflow actions that were performed on the page, the users who performed them and comments.

To view the workflow history of a page, select it in the content tree of the Pages application and navigate to Properties -> Workflow.

Restarting a workflow cycle

When a page reaches the Published or Archived step (whichever comes first), it completes its workflow cycle. That means that the page has gone all the way from the Edit step through the whole process to the final step. To start a new cycle and put the page back to the edit step, do the following:

  • If you’re using basic workflow, open the page in the Pages application, make changes to it and click Save. This will create a new version of the page.
  • If you’re using advanced workflow, click Create new version.

When you start a new cycle, the system re-evaluates workflow scopes that cover this page and chooses the workflow with the highest priority.

Removing pages from a workflow

If you want to remove pages from an existing workflow. That is, pages that are under a workflow scope, and that are in any of the steps belonging to the workflow, then proceed as follows:

  1. Open the Workflows application.

  2. Edit () the workflow from which you want to remove the page.

  3. Switch to the Pages tab.

  4. Select the pages that you want to remove from the workflow.

  5. Choose the Remove workflow and keep currently published data option in the second drop-down list under the list of pages.

    Removing a page from a workflow

  6. Click OK.

Note that this action does not remove the page from under the workflow scope. It may become part of the workflow again when modified.