The Workflow Entity

catalytic.sdk.entities.Workflow

Common Methods

These are the most commonly used methods of a Workflow.

NameReturn TypeDescription
getIdUUIDThe unique ID of the Workflow
getNameStringThe descriptive name of the Workflow
getDescriptionStringA description of what the Workflow does
getCategoryStringA descriptive grouping for your Workflow
getInputFieldsList<Field>A collection of the required and optional input fields that can be passed to this Workflow when starting it.

Permission and Visibility Methods

These are the methods that determine how users can find, edit, start or access a Workflow.

NameReturn TypeDescription
getIsPublishedBooleanIndicates whether the Workflow is published or is in draft mode
getIsArchivedBooleanIndicates whether is Archived and no longer available for users
to find, start or edit.
getFieldVisibilityFieldVisibilityThe default visiblity level of fields for this Workflow
Public, Internal, Confidential or HighlyConfidential
getInstanceVisibilityInstanceVisibilityThe visbility level of this Workflow
Open or Restricted
getAdminUsersList<String>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_).
getStandardUsersList<String>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 Methods

These are less commonly used methods, or methods that are often used only with specific interfaces.

NameReturn TypeDescription
getWorkflowIdUUIDRead-only alias for Id.
getReferenceNameStringRead-only alias for Id, represented as a string
getCreatedByStringThe email address of the user who created this Workflow
getOwnerStringThe email address of the user who is the primary admin
for this Workflow. This user will receive fix tasks when there is
a problem in an Instance of this Workflow

Constructors

Workflow()
Workflow(UUID id, String name, String teamName, String description, String category, String owner, String createdBy, List<Field> inputFields, boolean isPublished, boolean isArchived, List<Field> inputFields, boolean isPublished, boolean isArchived, FieldVisibility fieldVisibility, InstanceVisibility instanceVisibility, List<String> adminUsers, List<String> standardUsers);

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.