WorkflowGroupDto

DTO for workflow groups within a workflow.

Workflow Group Deadlines:
Each group's deadline is DeadlineIntervalValue DeadlineIntervalUnits counted from the task's due date
(before it) or its start date (after it), as the group's DeadlineRelativeTo says. Groups in one
workflow can count from different dates.

All workflow steps within a group inherit the group's calculated deadline.

Properties

Name	Type	Description
name	string	The name of the workflow group
The name of the workflow group
description	string	The description of the workflow group
The description of the workflow group
deadlineIntervalValue	integer	The deadline interval, in DeadlineIntervalUnits. Zero or positive: counted back from the task's due date, or forward from its start date, as DeadlineRelativeTo says. Zero is that date itself. Example: Tax Return Workflow, all counted back from the due date "Data Collection" group: 14 days "Preparation" group: 7 days "Review" group: 1 day "Filing" group: 0 days (the due date itself)
The deadline interval, in DeadlineIntervalUnits. Zero or positive: counted back from the task's due date, or forward from its start date, as DeadlineRelativeTo says. Zero is that date itself. Example: Tax Return Workflow, all counted back from the due date "Data Collection" group: 14 days "Preparation" group: 7 days "Review" group: 1 day "Filing" group: 0 days (the due date itself)
deadlineIntervalUnit	enum	Day Week Month Year
Day Week Month Year
deadlineRelativeTo	enum	DueDate StartDate
DueDate StartDate
groupNumber	integer	The group number that determines the display order and sequencing of this group within the workflow. Groups are displayed in ascending order by this number (1, 2, 3, etc.).
The group number that determines the display order and sequencing of this group within the workflow. Groups are displayed in ascending order by this number (1, 2, 3, etc.).
dependsOnPreviousGroup	boolean	Whether every step in this group waits for all steps in the previous group to be completed or skipped before it can start. Not applicable to the first group.
Whether every step in this group waits for all steps in the previous group to be completed or skipped before it can start. Not applicable to the first group.
condition	ConditionDto
clientTypes	array of enum	The types of clients this group is applicable to. An empty list means the group applies to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
The types of clients this group is applicable to. An empty list means the group applies to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
steps	array of WorkflowStepDto	The workflow steps contained within this group. All steps inherit the group's calculated deadline for planning and prioritization.
The workflow steps contained within this group. All steps inherit the group's calculated deadline for planning and prioritization.

JSON Example

{
  "name": "string",
  "description": "string",
  "deadlineIntervalValue": 0,
  "deadlineIntervalUnit": "Day",
  "deadlineRelativeTo": "DueDate"
}

Properties

JSON Example

Contained in Schemas