Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions 13/umbraco-workflow/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,24 @@ All Workflow configuration is optional and will fallback to defaults, if not set
{
"Workflow": {
"ReminderNotificationPeriod": Timespan.FromHours(8),
"ActionNotificationPeriod": Timespance.FromMinutes(5),
"EnableTestLicense": false,
"EmailTemplatePath": "~/Views/Partials/WorkflowEmails",
"SettingsCustomization”: {...}
"SettingsCustomization": {...},
"HistoryCleanupPolicy": {...}
}
}
```

### Workflow Configuration

#### ReminderNotificationPeriod

A `TimeSpan` representing the period between checking for, and sending, reminder notifications for overdue workflows. This setting is used in conjunction with `ReminderDelay` to determine if a workflow is overdue.
A `string` representing the period between checking for, and sending, reminder notifications for overdue workflows. This setting is used in conjunction with `ReminderDelay` to determine if a workflow is overdue. The default value is eight hours. The permitted value is a `TimeSpan`-parseable string, eg `0.00.01:00` for one minute.

#### ActionNotificationPeriod

A `string` representing the period between checking for, and sending, action notifications for active workflows. The default value is five minutes. The permitted value is a `TimeSpan`-parseable string, eg `0.00.01:00` for one minute.

#### EnableTestLicense

Expand Down Expand Up @@ -98,6 +105,7 @@ All available `SettingsCustomization` options are illustrated below along with t
"ConfigureApprovalThreshold": bool,
"RejectionResetsApprovals": bool,
"LockIfActive": bool,
"ScheduledContentLock": 0|1|2 matching the ScheduledLockMode enum values,
"MandatoryComments": bool,
"AllowAttachments": bool,
"AllowScheduling": bool,
Expand All @@ -123,9 +131,8 @@ All available `SettingsCustomization` options are illustrated below along with t
}
}
```

{% hint style="info" %}
These are complex types and are not recommended to have values set from Configuration. Instead, these values can be set from the BackOffice to hidden or read-only to prevent further changes.
* These are complex types and are not recommended to have values set from Configuration. Instead, these values can be set from the BackOffice to hidden or read-only to prevent further changes.
{% endhint %}

### General
Expand Down Expand Up @@ -162,6 +169,16 @@ When true, and ApprovalThreshold is Most or All, rejecting a task resets progres

When true, prevents editing content where the node is in an active workflow. When false, content can be edited at any stage of a workflow.

#### ScheduledContentLock (int)

Sets the scheduled content lock to one of None (0), Workflow (1), or All (2):

| Value | Name | Description |
| ------------- | -------- | -------------------------------------------------|
| 0 (_default_) | None | Scheduled content is not locked |
| 1 | Workflow | Content scheduled via Workflow can not be edited |
| 2 | All | All scheduled content can not be edited |

#### MandatoryComments (bool)

When true (default), comments are required when approving a workflow task. When false, comments are optional when approving a workflow task. Comments are always required when submitting changes for approval.
Expand Down
9 changes: 8 additions & 1 deletion 13/umbraco-workflow/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,16 @@ Check the [Version Specific Upgrade Notes](upgrading/version-specific.md) articl

This section contains the release notes for Umbraco Workflow 13 including all changes for this version.

### [13.3.0](https://github.com/umbraco/Umbraco.Workflow.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.3.0) (October 23 2024 )
* Adds scheduled content locking feature. Documents can be made readonly until the scheduled release date passes, to ensure approved content is not modified without workflow approval. [#84](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/84)
* Adds support for content segments. Segment names are displayed when requesting approval and in workflow history [#60](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/60)
* Adds support for Arabic.
* Improves UI in workflow detail overlay. Reduces the number of elements and shifts appropriate data points into tag elements.
* Adds email queue for thread-safe email notifications. Emails are now processed in the hosted service, via a first-in first-out queue. This resolves a reported issue where sending large numbers of emails could result in data reader errors. [#85](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/85)

### [13.2.1](https://github.com/umbraco/Umbraco.Workflow.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F13.2.1) (October 3 2024)
* Ensure scheduling information is displayed in workflow history [#82](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/82)
* Fixes an issue where dates were not correctly localised for scheduled workflows [#81](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/81)
* Fixes an issue where dates were not correctly localized for scheduled workflows [#81](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/81)
* Fixes an issue where scheduled workflows did not apply the release/expire date if the content node was already scheduled [#81](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/80)
* Ensure converting integers to strings uses the invariant culture to avoid unexpected formatting

Expand Down
4 changes: 4 additions & 0 deletions 13/umbraco-workflow/workflow-section/workflow-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ You can configure the **General** Settings from the **Workflow** section in the
* **Rejection resets approvals** - When true, and the approval threshold is Most or All, rejecting a task resets the previous approvals for the workflow stage.
* **Allow configuring approval threshold** - Enables setting the approval threshold for any stage of a workflow (on a content node or Document Type).
* **Lock active content** - Determines how the content in a workflow should be managed. Set to `true` or `false` depending on whether the approval group responsible for the active workflow step should make modifications to the content. Content is locked after the first approval in the workflow - until then, the content can be edited as normal.
* **Lock scheduled content** - When not None, prevents edits to content with a scheduled release date:
* **None** - Disables scheduled content locking
* **Workflow** - Prevent editing scheduled content when scheduling was approved via Workflow
* **All** - Prevents editing all scheduled content
* **Administrators can edit** - Set to true to allow administrators to edit content at any stage of the workflow, ensuring flexibility and control over the content approval process.
* **Mandatory comments** - Set to true to require comments when approving workflows. Comments are always required when submitting changes for approval, and are always optional for admin users.
* **Allow attachments** - Provide an attachment (such as a supporting document or enable referencing a media item) when initiating a workflow. This feature is useful when a workflow requires supporting documentation.
Expand Down
20 changes: 18 additions & 2 deletions 14/umbraco-workflow/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ All Workflow configuration is optional and will fallback to defaults, if not set
{
"Workflow": {
"ReminderNotificationPeriod": Timespan.FromHours(8),
"ActionNotificationPeriod": Timespance.FromMinutes(5),
"EnableTestLicense": false,
"EmailTemplatePath": "~/Views/Partials/WorkflowEmails",
"DateFormats": {
Expand All @@ -51,7 +52,11 @@ All Workflow configuration is optional and will fallback to defaults, if not set

#### ReminderNotificationPeriod

A `TimeSpan` representing the period between checking for, and sending, reminder notifications for overdue workflows. This setting is used in conjunction with `ReminderDelay` to determine if a workflow is overdue.
A `string` representing the period between checking for, and sending, reminder notifications for overdue workflows. This setting is used in conjunction with `ReminderDelay` to determine if a workflow is overdue. The default value is eight hours. The permitted value is a `TimeSpan`-parseable string, eg `0.00.01:00` for one minute.

#### ActionNotificationPeriod

A `string` representing the period between checking for, and sending, action notifications for active workflows. The default value is five minutes. The permitted value is a `TimeSpan`-parseable string, eg `0.00.01:00` for one minute.

#### EnableTestLicense

Expand Down Expand Up @@ -109,6 +114,7 @@ All available `SettingsCustomization` options are illustrated below along with t
"ConfigureApprovalThreshold": bool,
"RejectionResetsApprovals": bool,
"LockIfActive": bool,
"ScheduledContentLock": 0|1|2 matching the ScheduledLockMode enum values,
"MandatoryComments": bool,
"AllowAttachments": bool,
"AllowScheduling": bool,
Expand Down Expand Up @@ -136,7 +142,7 @@ All available `SettingsCustomization` options are illustrated below along with t
```

{% hint style="info" %}
These are complex types and are not recommended to have values set from Configuration. Instead, these values can be set from the BackOffice to hidden or read-only to prevent further changes.
* These are complex types and are not recommended to have values set from Configuration. Instead, these values can be set from the BackOffice to hidden or read-only to prevent further changes.
{% endhint %}

### General
Expand Down Expand Up @@ -173,6 +179,16 @@ When true, and ApprovalThreshold is Most or All, rejecting a task resets progres

When true, prevents editing content where the node is in an active workflow. When false, content can be edited at any stage of a workflow.

#### ScheduledContentLock (int)

Sets the scheduled content lock to one of None (0), Workflow (1), or All (2):

| Value | Name | Description |
| ------------- | -------- | -------------------------------------------------|
| 0 (_default_) | None | Scheduled content is not locked |
| 1 | Workflow | Content scheduled via Workflow can not be edited |
| 2 | All | All scheduled content can not be edited

#### MandatoryComments (bool)

When true (default), comments are required when approving a workflow task. When false, comments are optional when approving a workflow task. Comments are always required when submitting changes for approval.
Expand Down
10 changes: 9 additions & 1 deletion 14/umbraco-workflow/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,17 @@ Check the [Version Specific Upgrade Notes](upgrading/version-specific.md) articl

This section contains the release notes for Umbraco Workflow 14 including all changes for this version.

### [14.1.0](https://github.com/umbraco/Umbraco.Workflow.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.1.0) (October 23 2024 )
* Adds scheduled content locking feature. Documents can be made readonly until the scheduled release date passes, to ensure approved content is not modified without workflow approval. [#84](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/84)
* Adds support for readonly mode when a document is pending workflow approval. Along with the scheduled content lock, this feature requires Umbraco 14.3.0, which is now the minumum version dependency for Umbraco Workflow v14.
* Adds support for content segments. Segment names are displayed when requesting approval and in workflow history [#60](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/60)
* Adds support for Arabic.
* Improves UI in workflow detail overlay. Reduces the number of elements and shifts appropriate data points into tag elements.
* Adds email queue for thread-safe email notifications. Emails are now processed in the hosted service, via a first-in first-out queue. This resolves a reported issue where sending large numbers of emails could result in data reader errors. [#85](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/85)

### [14.0.3](https://github.com/umbraco/Umbraco.Workflow.Issues/issues?q=is%3Aissue+is%3Aclosed+label%3Arelease%2F14.0.3) (October 3 2024)
* Ensure scheduling information is displayed in workflow history [#82](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/82)
* Fixes an issue where dates were not correctly localised for scheduled workflows [#81](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/81)
* Fixes an issue where dates were not correctly localized for scheduled workflows [#81](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/81)
* Fixes an issue where scheduled workflows did not apply the release/expire date if the content node was already scheduled [#81](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/80)
* Ensure converting integers to strings uses the invariant culture to avoid unexpected formatting
* Fixes an issue related to sending notification emails in sites with a large number of workflow groups [#79](https://github.com/umbraco/Umbraco.Workflow.Issues/issues/79)
Expand Down
Loading