| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
| Excerpt | ||
|---|---|---|
| ||
Workflows are scripted |
...
using macro notation, which is stored in a template. But working with this markup notation is not always simple, unless you are an advanced and experienced user. Workflow builder visual editor is a graphical way to create custom workflows without using markup language. |
...
 |
You can
toggle between the workflow builder visual editor and the markup editor using the workflow builder and markup editor icons
use the Save options to save the current workflow as a template (with the appropriate administrator permission) to either the current space document management dashboard or the global workflows dashboard
It is also an easier way to understand and communicate the document life-cycles within your organization, or when starting a new project with a customer or stakeholder.
...
Workflow builder will not support deprecated elements in legacy workflows. If this occurs, workflow builder will warn you and you will need to use the markup editor to update the workflow.
How to Use Workflow Builder
| Excerpt | ||
|---|---|---|
| ||
Depending on the workflow scope i.e., global, space or page, you need different permissions to use workflow builder i.e., global admin, space admin or any page edit permission if page mode is enabled (see Page vs. Space Mode). Workflow builder can be accessed for a workflow in:
If page mode is enabled then it can also be accessed on a page:
The most common method of accessing workflow builder is through the space |
...
tools menu to use the space document management dashboard. |
To use the workflow builder for space workflows, first ensure you have space admin privileges, then:
...
Workflow Panel - workflow view | Workflow Panel - state view |
|---|---|
 |  |
Workflow view is displayed if you click anywhere on the white space in the right-hand workflow navigator panel background. | State view is shown if you click on any of the state lozenges in the workflow navigator panel or the state icons in the workflow panel. |
Choose the workflow name to edit the overall workflow - workflow name, description, type of content to be applied to, add trigger markup or manage display of workflow popup progress tracker. Edit page Edit page layout, workflow parameters /wiki/spaces/CDMCD/pages/6969366746 or workflow read confirmation for the final state by choosing the appropriate icon/name. You can drag and drop state names in this panel to re-order the states in the workflow. Any change in the list order will be reflected in the visual workflow in the navigator panel. | Choose the state name to edit the state name, description, status color, make the state a final state, add a due date or allow users to manually add tasks when in the state. Edit or add transitions, approvals or tasks to be added by the workflow by choosing the appropriate icon/name. |
...
Just drag and drop a state to a lower or higher position, and you will see how the diagram changes to reflect the new order.
...
Workflow builder will not allow you to drag and drop a state to be the first state in the workflow. The current first state cannot be dragged and dropped to another position in the workflow.
To move a state to be the first state in the workflow you must use the markup editor and copy and paste the state markup to be the first state macro in the workflow.
For example:
add a new state Todo for pending activity using workflow builder.
o
choose the
{ }markup editor icon
o
Locate the Todo state macro markup and cut and paste the markup to position it before the current opening state macro for the In Progress state
o
choose Save
choose the workflow builder icon to return to workflow builder
o
The Todo state is now the first state in the workflow.
...
Approvals
When in the state view, the number of transitions, approvals and tasks are listed for the state.
o
View a list of any existing approvals by clicking on Approvals in the state panel area.
o
Any existing approvals are displayed by name and appended with an approval icon.
...
Approval Icon
...
Indicates ...
...
o
...
Anyone can approve or the users who can approve may be limited but no one is preassigned and a reviewer is not manually assignable.
| Info |
|---|
Anyone can approve is the default Reviewers setting when adding a new approval. |
...
o
...
Reviewer(s) can be manually assigned using the workflow popup on the page or blog post.
| Info |
|---|
An option that can be configured when choosing Limiting the users who can assign for an approval. |
...
o
...
Reviewer credentials are required for a user who is able to undertake the approval.
| Info |
|---|
Until the credentials are added the approval decision buttons in the workflow popup are disabled. |
...
o
...
Reviewer(s) are preassigned (by the workflow on transition into the state).
| Info |
|---|
Displayed when the approval is configured as Set the reviewers that have to approve. |
Add or edit an approval
To add a new approval to the current state, click + Add Approval OR choose an existing named approval to edit.
o
Setting reviewers for an approval
Reviewers for an approval can be set in one of three ways in the Add Approval or Edit Approval panel in workflow builder.
The options are different for each Reviewers option button in the Edit/Add approvals panels.
Reviewers - Anyone can approve
o
In this option the approval can be configured so that a minimum number of reviewers must undertake the content review and agree for a transition to occur.
Reviewers - Limit who can approve and/or assign
o
This option will allow reviewers to be assigned. Choosing each Assignable reviewers option button will display any available further configurable options.
Reviewers - Set all reviewers that have to approve
o
At least one user needs to be added to be automatically assigned for this Reviewers option to be added to the approval.
All the Reviewers options can also be configured in the Advanced settings for the approval.
o
Each approval can be set
to require credentials for a reviewer
to have a condition for the approval to become active
to allow roles to be added for reviewers.
Approvals can also be reordered just by dragging and dropping to a higher or lower position.
o
The order of the approvals will be the initial order they are displayed in the workflow popup on the page before any approvals are undertaken when no conditions are set for any of the approvals.
Further details of content reviews (approvals) can be found in the approval macro page.
Tasks
In the state view you can set/edit the tasks that are added on a workflow transition into the state by clicking on the listed tasks in the workflow panel.
...
Approvals
When in the state view, the number of transitions, approvals and tasks are listed for the state.
o
View a list of any existing approvals by clicking on Approvals in the state panel area.
o
Any existing approvals are displayed by name and appended with an approval icon.
Approval Icon | Indicates ... | ||
|---|---|---|---|
o | Anyone can approve or the users who can approve may be limited but no one is preassigned and a reviewer is not manually assignable.
| ||
o | Reviewer(s) can be manually assigned using the workflow popup on the page or blog post.
| ||
o | Reviewer credentials are required for a user who is able to undertake the approval.
| ||
o | Reviewer(s) are preassigned (by the workflow on transition into the state).
|
Add or edit an approval
To add a new approval to the current state, click + Add Approval OR choose an existing named approval to edit.
o
Setting reviewers for an approval
Reviewers for an approval can be set in one of three ways in the Add Approval or Edit Approval panel in workflow builder.
The options are different for each Reviewers option button in the Edit/Add approvals panels.
Reviewers - Anyone can approve
o
In this option the approval can be configured so that a minimum number of reviewers must undertake the content review and agree for a transition to occur.
Reviewers - Limit who can approve and/or assign
o
This option will allow reviewers to be assigned. Choosing each Assignable reviewers option button will display any available further configurable options.
Reviewers - Set all reviewers that have to approve
o
At least one user needs to be added to be automatically assigned for this Reviewers option to be added to the approval.
All the Reviewers options can also be configured in the Advanced settings for the approval.
o
Each approval can be set
to require credentials for a reviewer
to have a condition for the approval to become active
to allow roles to be added for reviewers.
Approvals can also be reordered just by dragging and dropping to a higher or lower position.
o
The order of the approvals will be the initial order they are displayed in the workflow popup on the page before any approvals are undertaken when no conditions are set for any of the approvals.
Further details of content reviews (approvals) can be found in the approval macro page.
Tasks
In the state view you can set/edit the tasks that are added on a workflow transition into the state by clicking on the listed tasks in the workflow panel.
To add a new task, click on the + Task button on the top of the workflow navigator panel.
o
Tasks can also be reordered just by dragging and dropping to a higher or lower position.
o
Workflow builder uses the task macro to create and set the behaviour for workflow tasks.
A state can also be set as taskable by editing the state attribute parameters. This will allow users to add tasks when the page or blog post is in the state.
Transitions
When in the state view you can edit the existing transitions in the state by choosing on the Transitions option in the state panel.
o
Transitions in a state can be edited using the transitions editor.
A transition can be added by
choosing the type of transition
adding the destination state for the transition
The select transition can be added with more than one possible destination state. The destination state is for the transition is chosen from these added states using the workflow popup on the page.
More than one transition can be added to each state but a submit or select transition cannot be added to a state with an existing approved or rejected transition.
The approved and rejected transitions are not available in the workflow builder transitions editor unless an approval has been added to the state.
| Info |
|---|
Further details of the markup and macros used can be found in the documentation transitions pages. |
Parameters
When in the workflow view you can edit the existing parameters or add a new one by clicking on the + Parameter button on the top of the workflow navigator panel.
o
Tasks can also be reordered just by dragging and dropping to a higher or lower position.
o
...
A state can also be set as taskable by editing the state attribute parameters. This will allow users to add tasks when the page or blog post is in the state.
Transitions
When in the state view you can edit the existing transitions in the state by choosing on the Transitions option in the state panel.
o
Transitions in a state can be edited using the transitions editor.
A transition can be added by
choosing the type of transition
adding the destination state for the transition
The select transition can be added with more than one possible destination state. The destination state is for the transition is chosen from these added states using the workflow popup on the page.
More than one transition can be added to each state but a submit or select transition cannot be added to a state with an existing approved or rejected transition.
The approved and rejected transitions are not available in the workflow builder transitions editor unless an approval has been added to the state.
| Info |
|---|
Further details of the markup and macros used can be found in the documentation transitions pages. |
Parameters
When in the workflow view you can edit the existing parameters or add a new one by clicking on the + Parameter button on the top of the workflow navigator panel.
...
Any existing workflow parameters added to the workflow are listed.
Choose a parameter to edit the parameter details or Add Parameter to create a new workflow parameter using the workflow parameter editor.
...
Workflow parameters can be created to accept one of the following data types - text string; time period duration; Confluence user(s); Confluence group(s) or an option value from a list of set values.
Workflow Read Confirmation
A read confirmation can be enabled in a workflow using workflow builder (or markup editor).
Workflow builder can be used to add a read confirmation to any workflow for the final state.
...
The read confirmation will only be available to add for content in the final state in the workflow.
Editing the Read Confirmation
Clicking the read confirmation link will bring up the configuration options, including:
users assigned to read/confirm the page
user groups assigned to read/confirm the page
a due date indicating when read confirmation should occur by
allow a reviewer to decide to enable or disable the read confirmation on the approved transition to the final state
o 
...
Any existing workflow parameters added to the workflow are listed.
Choose a parameter to edit the parameter details or Add Parameter to create a new workflow parameter using the workflow parameter editor.
...
This feature uses the workflow parameter macro - an example of a type of value reference that can be used in workflows.
Workflow parameters can be created to accept one of the following data types - text string; time period duration; Confluence user(s); Confluence group(s) or an option value from a list of set values.
Workflow Read Confirmation
A read confirmation can be enabled in a workflow using workflow builder (or markup editor).
Workflow builder can be used to add a read confirmation to any workflow for the final state.
...
| Info |
|---|
The read confirmation will only be available to add for content in the final state in the workflow. |
Editing the Read Confirmation
Clicking the read confirmation link will bring up the configuration options, including:
users assigned to read/confirm the page
user groups assigned to read/confirm the page
a due date indicating when read confirmation should occur by
allow a reviewer to decide to enable or disable the read confirmation on the approved transition to the final state
o
Read confirmations use the read-ack macro.
Markup editor
A workflow can also be edited using the markup editor.
To open the markup editor choose the { } icon in the right hand navigator panel.o
...
The markup for the current workflow in workflow builder is displayed.
...
Editing
in the markup editor automatically updates the workflow when viewed in the visual editor for the current workflow
in the visual editor automatically updates the workflow when viewed in the markup editor for the current workflow
Choose the workflow builder icon to return to workflow builder and view changes in the markup displayed in the visual builder.
o
Choose Save in either the visual editor or the markup editor to update the current workflow with your changes before choosing Exit
Workflow translator for cloud
| Status | ||||
|---|---|---|---|---|
|
Workflow builder includes the Workflow Translator for Cloud option to support your migration to cloud available using the Translator button in the workflow navigator panel.
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Not supported
Graphical trigger creation
The The standalone comment macro is deprecated . Use (use the description field of other macros to include extra contextual information)
Authoring using workflow builder
...