The Workflow Entity
Catalytic\SDK\Entities\Workflow
Common Properties
These are the most commonly used properties of a Workflow
.
Name | Type | Description |
---|---|---|
id | string | The unique ID of the Workflow |
name | string | The descriptive name of the Workflow |
description | string | A description of what the Workflow does |
category | string | A descriptive grouping for your Workflow |
inputFields | array | A collection of the required and optional input fields that can be passed to this Workflow when starting it. |
Permission and Visibility Properties
These are the properties that determine how users can find, edit, start or access a Workflow
.
Name | Type | Description |
---|---|---|
isPublished | bool | Indicates whether the Workflow is published or is in draft mode |
isArchived | bool | Indicates whether is Archived and no longer available for users to find, start or edit. |
fieldVisibility | string | The default visiblity level of fields for this Workflowpublic , internal , confidential or highlyConfidential |
instanceVisibility | string | The visbility level of this Workflowopen or restricted |
adminUsers | array | The users or groups who who may view, start, and edit this Workflow . Users will be represented by their Email ,groups by their group name (starting with g_ ). |
standardUsers | array | The users or groups who who may view and start this Workflow . Users will be represented by their Email ,groups by their group name (starting with g_ ). |
Other Properties
These are less commonly used properties, or properties that are often used only with specific interfaces.
Name | Type | Description |
---|---|---|
workflowId | string | Read-only alias for Id . |
createdBy | string | The email address of the user who created this Workflow |
owner | string | The email address of the user who is the primary admin for this Workflow . This user will receive fix tasks when there isa problem in an Instance of this Workflow |
Constructors
Workflow($id = null, $name = null, $teamName = null, $description = null, $category = null, $owner = null, $createdBy = null, $inputFields = null, $isPublished = null, $isArchived = null, $fieldVisibility = null, $instanceVisibility = null, $adminUsers = null, $standardUsers = null)
Creates a new instance of the Workflow
class. Note that this does not create a new Workflow
on the platform. That functionality is not yet supported in this SDK. Until it is supported, you must create a Workflow in the Web UI.
Updated almost 3 years ago