The Workflow Definition File
A workflow definition is a JSON file containing the definition or description of a workflow. This workflow definition file is a fundamental part of the Digiflo platform and describes the business process or workflow for various parts of the platform. It is used by
- The workflow execution engine, and
- the web portal to render the workflow status and executing actions (also called workflow triggers).
This section describes the digiflo Workflow Format Version 1. For other previous formats versions, see here.
The workflow definition file is a standard JSON document with header properties (root properties) and data related to the workflow statuses, workflow actions (triggers), workflow flow (edges) and workflow data definitions.
Table of contents
JSON file format
See the following reference for details on the JSON file format. We use standard JSON data types in the workflow definition. Custom data objects can be defined.
Header Data
TBD
| Field | Description | Type | Required |
|---|---|---|---|
| workflowDefinitionId | The workflow unique id | guid | yes |
| name | The workflow name | string | yes |
| category | The workflow category | string enum: [Case,Job] | yes |
| description | A human readable description of the workflow | string | yes |
| version | The version of the workflow. See versioning | number | yes |
| fromVersion | The previous wokflow version this workflow can upgrade from. | number | yes |
| createdDate | The date the workflow was created | ISO8601 datetime string | yes |
| modifiedDate | The date the workflow was last modified | ISO8601 datetime string | yes |
| schematicVersion | The schematic (definition format) version of the workflow | number | yes |
| tenantId | The tenant id | guid | yes |
| tenant | The tenant reference | NamedRef | yes |
| status (obsolute?) | The workflow definition status | number enum | yes |
| statuses | The workflow statuses | status[] | yes |
| triggers | The workflow triggers or actions | triggers[] | yes |
| edges | The workflow edges or flow definitions | edges[] | yes |
| dataDefinitions | The workflow data definitions | data[] | yes |
Cosmos DB Related Properties
| Field | Description | Type | Required |
|---|---|---|---|
| id | The cosmos db document id | guid | yes |
| partition | The cosmos db partition | string | yes |
Status Definitions
The workflow status definitions is an array of the following data object:
Trigger Definitions
TBD
Data Definitions
TBD
Data Object Definitions
TBD
Data Files
TBD
Input Forms
TBD
Steps, Sections and Fields
TBD
Data Mappings
TBD
Edge (Flow) Definitions
TBD
Workflow Versioning
TBD
Reference Types
TBD