Comala Workflows is now Comala Document Management. Click here for the latest documentation.

Overview

The Comala Workflows app provides several new CQL fields which can be used to filter search results using Confluence Search REST API.

(warning)Confluence CQL-enabled search requires Confluence 5.9 or above

CQL Fields

The following workflow-related search fields are available if you are using Confluence 5.9 or above:
Filter NameCQL FieldTypeNotesVer
Has WorkflowawphasworkflowTEXT

Filter to content which has a workflow applied

Use true as the text value.

5.1
Workflow Approval AssigneeapprovalassigneeUSER

Filter by assigned reviewer

See also: Assigning reviewers

4.12+
Workflow ApproverapproverUSER

Filter by user who approved content during a review

See also: Content reviews

4.12+
Workflow StatestateTEXTFilter by current workflow State4.10+
Workflow State ChangestatechangeDATEFilter by date of last workflow state Transition4.11+
Workflow State ExpirystateexpiryDATE

Filter by current workflow state Expiry Date

See also: State expiry date

4.11+
Workflow Task AssigneetaskassigneeUSER

Filter by workflow Task assignee

See also: Assign a task

5.1
Workflow NameworkflownameTEXT

Filter by workflow name

6.0

Read Confirmation Status

readAckStatusTEXT

Filter by the read confirmation status.

Possible values: pending, acknowledge, overdue

6.0

These fields can be used in Confluence Search, any macros that support CQL and the CQL REST API.

CQL Field Search Example

To search for content where the current state is "Draft" (state=Draft), the REST API URL would look like:

http://<confluence_url>/rest/api/content/search?cql=state=Draft

Content Properties

Comala Workflows uses JSON Content Properties to store and keep track of workflows data and support the new reporting utilities (for version 6.0 and later). Workflow information is available as a API expansion point using metadata.properties.comalaworkflows

Not all values provided in the current implementation may be supported in future updates but the following core values are unlikely to change.

  • workflowName
  • "currentState
  • "currentStateColour
  • "currentStateStart


See also

External Links:

Reporting Guide: