Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This routine is available starting with SIL Engine™ 3.1.9.
Info
titleAvailability
Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

getWorkflowStatusIds(workflowName [, isDraft])

Package

Alias

Pkg Usage

Description

Excerpt
hiddentrue
Retrieves an unique list of statuses (ids) for a given workflow.

Retrieves an unique list of statuses (ids) for a given workflow.

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

workflow name

String

Yes

Name of the given workflow.

isDraft

Boolean

No

Flag for specifying whether we should consider the draft or not. If not specified, it defaults to "false".

Return

...

Type

string String []

The return value is an array of strings, containing the ids for the existing statuses in the workflow.

Examples

Example 1

Code Block
string key = "TEST-19";
return getWorkflowStatusIds(key.workflow);

Result:   11|3|4|5|6

Example 2

Code Block
string key = "TEST-19";
return getWorkflowStatusIds(key.workflow, false);

Result:   11|3|4|5|6

Example 3

Setting the second parameter to "true", if we do have a draft where another status is added, the result will contain this status also.

Code Block
string key = "TEST-19";
return getWorkflowStatusIds(key.workflow, true);

Result:   11|3|4|5|6|10100

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "workflow_routine" and space = currentSpace ( )
labelsworkflowarray_routineroutines