View on GitHub

equella.github.io

Workflow Moderation User Guide

Table of Contents

Workflow moderation overview

The workflow process

Contribute a resource for moderation

Moderation queue

Tasks

Moderating a task

Workflow example

Notifications

Manage tasks

Workflow moderation overview

An EQUELLA workflow is a process whereby a new resource must pass through one or more stages of review or moderation before becoming fully available. The process automatically notifies users when they must moderate the resource. A workflow is associated with a collection and can be a simple one-step review or complex multi-step editorial and technical review comprising multiple publication paths.

An EQUELLA workflow provides a structure for an institution’s quality assurance processes. Workflows are used to record the outcomes of each moderation task review and move resources through the review process based on these outcomes. Workflows are typically created by the Content Administrator, who designates reviewers (moderators) and determines the structure of the workflow.

The purpose of this guide is to explain the moderation and review process and demonstrate to users how to perform workflow moderation tasks.

Please note that this guide has been developed to best reflect the full capabilities of EQUELLA, and as such may differ from your own installation. Contact the system administrator for access to extra features or to reconfigure your installation.

The workflow process

A workflow is typically created by a content administrator as an ordered process that has rules for passing a resource from one step to the next. The content administrator designates users, groups or roles to a moderation task to create workflow task moderators. Workflow task moderators can be allocated to multiple moderation tasks with moderator options determined by the workflow creator that can include: rejection, modification, acceptance by one group member or acceptance by all group members.

Once the moderators have completed their review the next workflow step is determined by the moderator responses. The workflow history displays the resource’s workflow progress and can be used to view all review events and moderators.

Resources can enter moderation when they are:

The example ‘Documentation Workflow’ used in this guide is a simple workflow intended to be used for reviewing documents.

Contribute a resource for moderation

Resources can only be submitted for moderation using a collection that has an associated workflow.

To contribute a resource for moderation

  1. Open a browser and enter your EQUELLA URL (e.g. http://equella.myinstitution.edu).
  2. Log in to EQUELLA.
  3. Select Contribute from the navigation menu. The Contribute page displays.
  4. Select the required collection from the list (e.g. Documentation). The contribution wizard displays for the selected collection.
  5. Enter the relevant metadata to complete the About page of the wizard. Add required attachments.
  6. Click Next to display the Workflow details page. (NOTE: The Workflow details page is specific to this example, not a standard part of the moderation process. Some wizards would not have a Workflow page, and saving the resource would automatically enter it into the associated moderation workflow.)
  7. Select Updated or new document. The Review Decisions section establishes the structure of the workflow and includes a user selector wizard control to determine who will conduct the content review. This section will be completed as the first step of the example workflow.
  8. Click Save.
  9. Enter a message if required, then click Submit for Moderation to enter the resource into the documentation workflow. Saving as a draft will save the resource, but will not enter it into the workflow, nor make it ‘live’.

The Resource summary page Details section shows the following links relevant to the workflow:

Moderation progress

The Moderation progress link can be found in the Details section of the Resource summary page, and at the bottom of each result on the My tasks results page.

Select this link to display the Moderation progress page and see a diagrammatic representation of the workflow.

The current step is highlighted in yellow, completed tasks are highlighted in green and a Tasks awaiting moderation list displays at the top of the flow chart with moderator details.

Moderation history

The Moderation history link can be found in the Details section of the Resource summary page. Select this link to display the Moderation history page.

A resource’s Moderation history page provides details on any submission, status change and moderation events pertaining to this resource.

The Moderation history page has the following elements:

Moderation queue

The Moderation queue enables the logged-in user to view all their resources currently waiting for moderation within a workflow. The Moderation queue link is accessed from the My resources page.

To view the Moderation queue page

  1. Select My resources from the navigation menu.

The My resources page displays. The default on first entering My resources is Published resources.

  1. Click the Moderation queue link at the top of the page. The results display all resources belonging to the logged-in user that is currently in a moderation workflow.

The Moderation queue results page elements include:

Tasks

After a resource has been submitted for moderation, users allocated to the first moderation task will have the task added to their My tasks page. As the resource moves through the workflow steps, the relevant users will receive their tasks.

The user is notified of pending tasks by the red number (number of waiting tasks displayed beside the My tasks navigation menu item).

Clicking on My tasks displays the My tasks page with all pending tasks displayed.

Notification of new tasks can be configured to be sent by email to the relevant users.

Tasks portlet

The Tasks portlet on the Dashboard page also shows the user the number of pending tasks.

Each item on the Tasks portlet is a link. In the tasks section of the portlet, selecting any link takes the user to the My tasks page, with the relevant tasks displayed. The Tasks portlet includes notifications.

Selecting the following task links opens the My tasks page and displays:

My tasks page

The My tasks results page displays the tasks waiting to be moderated.

The My tasks page elements are:

Sort and filter

The Sort and Filter boxes on the My tasks results page display options relevant to tasks.

The sort options are:

From the My tasks results pages, the following filter options are available:

Moderating a task

Accessing task moderation

Tasks can be moderated from the resource summary page or the contribution wizard page. Moderating from the contribution wizard page enables the moderator to access all the metadata stored during contribution, depending on workflow configuration.

To moderate from the resource summary page

  1. From the My tasks results page, click Moderate on the relevant resource link. The resource summary page opens with the black task moderation section displayed at the top.

To change to the contribution wizard page if required, click the View Metadata button, where the task moderation section is also displayed.

To moderate from the contribution wizard page

  1. From the My tasks results page, click Moderate. The contribution wizard page opens with the task moderation section displayed at the top. A

If required, click Edit Resources to edit the contribution wizard fields.

Click View Summary to display the resource summary screen with the task moderation section displayed at the top.

Task moderation section

The task moderation section enables the user to approve or reject the task. It also allows users to assign tasks to themselves, cancel assignments, post comments and move between tasks.

The task moderation section is made up of the following elements:

Assigning tasks

If there is a group of moderators selected for a task, of which only one is required to complete the task, a moderator would assign themselves the task. Assigning the task informs the other moderators that someone has already taken ownership of the task.

To assign a task

  1. Click the assign to me link in the task moderation section. The Assigned to field changes to Me, and the link changed to cancel assignment.

Select the cancel assignment link to change the status back to unassigned.

Posting comments

Comments can be added to a task, which can be read by other moderators. This is a great way to share information.

To post a comment

  1. Select the Post a comment link in the task moderation section. The Task comments screen displays.
  2. Type the required text in the Enter your comment text box, then click Submit.
  3. Click the Cancel button to return to the task moderation section.

Viewing comments

Select the (x) comments link to view existing comments. The task comments page displays.

Click Close to return to the task moderation section.

Reject a task

A task is rejected when the moderator decides changes need to be made before the resource moves on to the next step of the moderation workflow.

When a task is rejected, the moderator enters a moderation comment outlining the reasons for rejection, the resource goes back to the rejection point set in the workflow and a rejection notification is sent to the appropriate users. The user would then edit and redraft the resource to re-enter it into the workflow.

To reject a task

  1. Click Reject from the task moderation section. The Rejecting task page displays.
  2. Type the reason for rejection in the Enter your rejection message edit box, then click Submet. (NOTE: this field is mandatory.) The My tasks page displays with a confirmation receipt at the top of the screen.

Approve a task

A task is approved once the required moderator or moderators have reviewed the resource and decide it is ready to move to the next stage of the moderation workflow.

To approve a task

  1. Click Approve from the task moderation section. The Approving task page displays.
  2. If relevant, type a message in the Enter an optional approval message text box, then click Submet. The My tasks page displays with a confirmation receipt at the top of the screen.

Workflow example

The following example is based on the example ‘Documentation Workflow’ created in the EQUELLA Workflow Configuration Guide. It is intended to demonstrate how a resource moves through a simple moderation process.

Review Decisions task

In the example moderation process, the Document Administrator has been selected as the single moderator for the Review Decisions task. This task requires the moderator to select whether the resource requires a content review and an editorial review. If a content review is required, a reviewer must be assigned.

To complete the review decisions task

  1. Log in as the Document Administrator.
  2. Click the My task navigation menu item.
  3. Click the EQUELLA Workflow User Guide Moderate button. The contribution wizard page displays with the task moderation section.
  4. Go to the Workflow details page of the wizard. (NOTE: The Workflow details page is specific to this example, not a standard part of the moderation process. Some wizards would not have a Workflow page, and saving the resource would automatically enter it into the associated moderation workflow.)
  5. Click Edit Resources to enable the wizard fields.
  6. Select Required in the Is a content review required? field.
  7. Select the Select a user link to choose the user to moderate the content review. In this example, the Document Administrator will be selected.
  8. Select Required in the Is an Editorial Review required? field.
  9. Click Save. 10.Click Approve. The Approving task page displays. Enter a message if required, then click Submit. The My tasks page is displayed. The resource then moves on to the next task in the workflow.

Content review task

In this case, because the next task was allocated to the Document Administrator, which is the logged-in user in this example, the EQUELLA Workflow User Guide appears on the My tasks page, with a Task name of Content Review.

Select the Moderation progress link for EQUELLA Workflow User Guide to view the moderation progress in a diagrammatic format.

To complete the content review task

  1. Click the EQUELLA Workflow User Guide Moderate button. The contribution wizard page displays with the task moderation section.
  2. In the task moderation section, select the assign to me link to assign to task to the Document Administrator (logged-in user).

NOTE: The task does not have to be assigned to a moderator to be approved or rejected, but assigning tasks shows who has taken ownership of that task.

  1. Review the attachments and resource metadata, editing if required.
  2. Either:
    • Click Approve to move the resource to the next moderation task, in this case Editorial review. The Approving task page displays. Enter a message, if required, then click Submit.

OR

If the resource returns to the original contributor, its status is ‘rejected’ and it must be redrafted and resubmitted for moderation or removed from the system to clear the rejected notification.

If the task is approved, the resource moves to the Editorial Review task, which is similar to the Content Review task in this example. If this task was not required, it moves to the Create PDF task.

Create PDF task

Select the Moderation progress link for EQUELLA Workflow User Guide to view the moderation progress in a diagrammatic format.

To complete the Create PDF task

  1. Follow steps 1 to 4 in the Content review task section. If the task is approved and the pdf created, the resource moves to the Check PDF task.

Check PDF task

In the example workflow, the Document Administrator and the rest of the Document Administration group are selected for the Check PDF moderation task. This task requires the moderator to ensure the PDF is viewable on all supported platforms and no conversion artifacts have been added.

To complete the Check PDF moderation task

  1. Follow steps 1 to 4 in the Content review task section. If the task is approved, the workflow is complete and the resource becomes live.

Notifications

Notifications are messages used to notify users of an event. These messages are related to a moderation workflow, for example, when a moderation task becomes overdue, or is rejected. Notifications can also be sent when a resource becomes ‘Live’, which lets the user know that the resource is now available for use.

Rejection notifications are immediate, and can be viewed within minutes of the resource being rejected, whereas other types of notifications are processed as a timed event (for example, overnight), so will not display until after that timed event has run.

There are a number of ways that users can choose to be alerted to notifications. Emails can be sent, RSS and ATOM feeds can be set up as well as the Notifications menu item on the EQUELLA navigation bar.

Notifications menu item

The user is alerted to existing notifications from the red number (number of notifications) displayed beside the Notifications navigation menu item.

Selecting Notifications displays the Notifications page, with all notifications displayed.

Tasks portlet

The Tasks portlet on the Dashboard page also shows the user the number of notifications, broken down by type.

Each item in the notifications portlet is a link. In the notifications section of the portlet, selecting any link takes the user to the Notifications page, with the relevant tasks displayed.

Selecting the following notification links opens the Notifications page and displays:

Notifications set up via the Profile function

Notifications can be configured via the Profile function accessible from any EQUELLA page. Collections are selected, and a notification is sent to the user when resources belonging to those collections become available (Live).

To set up Profile notifications

  1. Select the PROFILE link on the top right-hand side of the any EQUELLA page. The Edit user page displays.
  2. In the Notifications section, use the arrows to select the required collection or collections. Use:
    • Double Right Arrows to select all collections
    • Right Arrow to select the highlighted collection
    • Left Arrow to deselect the highlighted collection
    • Double Left Arrows to deselect all collections
  3. Click Save. A notification is sent whenever a resource belonging to the selected collection or collections becomes available (Live).

Notification emails

Users can configure their profiles so emails are sent to alert the user to new notifications.

To set up email notifications

  1. Select the PROFILE link on the top right-hand side of the any EQUELLA page. The Edit user page displays.
  2. Select Send notifications to email.

Selecting this option also sends an email to the user when a new moderation task is added.

Uncheck this option to switch off email notifications (except moderation overdue messages).

Notifications page

The Notifications results page displays details of notifications.

The notifications results page elements are:

Filter

The Filter box on the Notifications results page displays options relevant to notifications.

From the notifications results pages, the following filter options are available:

Redrafting

This action is intended for resources that require redrafting (editing), usually after being rejected and prior to moderation workflow completion. Selecting this operation allows the resource to be edited and re-submitted for moderation or saved as a draft.

To access the Redraft this version function

  1. From the Actions section of Resource summary page, select Redraft this version.

The Editing page displays.

  1. Edit the resource, then click Save. The Save dialog displays.
  2. Enter a message if relevant, then click Submit for Moderation. The resource re-enters the workflow at the appropriate moderation task.

Manage tasks

There may be many resources at various stages of a workflow at any one time within the EQUELLA system, and the Manage tasks function and Task statistics portlet allow administrators to view the progress of these resources through the workflow. Information, such as moderator details, length of time at a particular task and at what point in the workflow resources are getting held up, can be easily detected using these functions.

Manage tasks privilege

The privilege associated with access to the Manage task function is MANAGE_WORKFLOW. Granting this privilege to a user, group or role will display the Manage tasks menu item in the left-hand navigation bar.

Manage tasks page

The Manage tasks page displays all workflow tasks. Content and system administrators would typically be granted privileges to access this function to view moderation progress.

To open the Manage tasks page

  1. Log in to EQUELLA as an administrator. The EQUELLA Dashboard page displays.
  2. Select Manage tasks from the left-hand navigation menu. The Manage tasks page displays. The Manage tasks page has the Search box at the top, where criteria are selected, and the results list displayed below.

The search box has a search text box to enter keyword searches, and a Within drop-down list. Searching can be refined by selecting All workflows or a specific workflow (e.g. Document Review) from the Within drop-down list.

If a workflow is selected from the Within drop-down box, an extra filter displays in the Filter box.

Each task on the Manage tasks results page displays the following elements:

Each task can also have the following links:

Sort and filter

The Sort and Filter boxes on the Manage tasks results page displays options relevant to managing tasks.

The sort options are:

From the Manage tasks results pages, the following filter option is available:

Task statistics portlet

A Tasks statistics portlet can be added to an administrator’s Dashboard to display basic information relating to the number of tasks in a workflow over a weekly or monthly time period.

To create a Task statistics portlet

  1. From the Dashboard page, click Screen Options. The screen options display at the top of the screen.
  2. Click the Tasks statistics link. The Create portlet page displays.
  3. Enter a Title (defaults to Task statistics).
  4. Select a Weekly or Monthly Default trend, then click Save. The new portlet displays on the Dashboard page.
  5. The tasks statistics portlet lists tasks where there are current resources waiting to be moderated.

This portlet displays the top five tasks with waiting items, ordered by number of waiting items. (In the example above, there are only four tasks with waiting resources hence it only shows four rows.)

The Task statistics portlet elements include:

Select this link to display the Manage resource page, with the relevant resources listed as results.

Users will need the ‘MANAGE_WORKFLOW’ privilege granted to them to see any of the information in the Tasks Statistics portlet.