Workflow Configuration Guide

Workflow Operation

In easyDITA, workflows are used to manage assignments. As users complete a series of steps, the assignment moves through the workflow to completion. Workflow names and steps can be configured to better align with your organization's content development process.

Workflow steps can also be configured to trigger other actions. For example, when the last step of a workflow is completed, this can trigger a publish or a file status change on all assignment resources.

Workflow Examples

Workflow Design Considerations

When you begin designing a workflow, you should think about how your content development process looks like. Keep in mind that you can design multiple workflows if different publications or types of assignments follow different processes.

Ask yourself the following questions:

• What different deliverables does my organization produce?
• Who writes the content?
• Who reviews the content?
• Who contributes to the content?
• What approvals are required and who can approve the content?
• Are there any limitations that should be in place for accessing the content?
• Are there any processes that should be automated?

Workflow Components

Once you have a general idea of your workflow requirements, you can begin defining your workflows. There are three components to a workflow you must define:

• Steps
• Multiple Assignees
• Triggers

All assignments follow a workflow with defined steps that must be completed by the assigned user(s). For example, in this workflow, one person is assigned to review the content and another to revise it:

1. Review
2. Revise

There is no limit to how many steps you can have in a workflow and you can name the steps whatever you want.

When designing a workflow you should think about both your content development process and who completes the work at each step. For example, consider if multiple reviews are necessary or if you require approvals for any publications.

If you integrate triggers into your workflows, keep in mind that these are automated events that will happen every time the specified step is completed. While automation can improve your content development process, you also lose some control over that process so it's important to carefully consider triggers.

There are three workflow triggers available in easyDITA:

Publish

A publishing event is automatically triggered when a workflow step is completed. For example, in the “Author, Review, Verify” workflow, the assigned resource(s) automatically publishes once the “Verify” step is completed.

Review-Only Mode

The assigned resource is put in Review-Only Mode when a workflow step is completed, which prevents you from editing the document directly, but you can suggest changes or deletions and add comments. For example, in a workflow with the steps “Author, Review, Verify”, you can add a trigger to put the document in Review-Only Mode when the “Review” step is active so the reviewer can add suggestions, but not edit the document.

Status Change

The status of the assigned resources changes when a workflow step is completed. For example, in a workflow with the steps “Author, Review, Verify”, you can add a trigger to change the status of the assigned resource(s) to “Approved” when the “Verify” step is completed.

Blank Workflow Customization Worksheet

Complete the workflow table for each workflow you want customized:

Display Name

The name shown for each step and in the Workflow drop-down menu.

Triggers

If specified, this step will trigger an action, such as a status change or publishing action.

Multiple Assignees

If multiple users are assigned to a step, specify Claim or All Must Complete. If you specify Claim, then one user must claim and complete the step. If you specify All Must Complete, then all users assigned must to complete the step.

Completed Workflow Customization Worksheet Example