From c02d8352989a29dbcff10a17c3d18e96c21c3f66 Mon Sep 17 00:00:00 2001 From: Emma Van Der Heide Date: Wed, 26 Aug 2026 21:52:20 -0400 Subject: [PATCH 1/3] [SC-16950] Document the workflows list table and workflow details page Documents the redesigned Settings > Workflows list (unified table with search, sort, filter, and count) and the new workflow details page (properties rail, version history, read-only diagram with Edit Workflow, and active executions), and routes the clone/edit/delete/publish flows through the new experience. Co-Authored-By: Claude Fable 5 --- .../workflows/_configure-workflow-steps.qmd | 12 ++- site/guide/workflows/_publish-workflows.qmd | 4 +- site/guide/workflows/configure-workflows.qmd | 28 +++++-- site/guide/workflows/setting-up-workflows.qmd | 83 ++++++++++++++++++- 4 files changed, 114 insertions(+), 13 deletions(-) diff --git a/site/guide/workflows/_configure-workflow-steps.qmd b/site/guide/workflows/_configure-workflow-steps.qmd index fdd273e1da..96433a6ea4 100644 --- a/site/guide/workflows/_configure-workflow-steps.qmd +++ b/site/guide/workflows/_configure-workflow-steps.qmd @@ -9,15 +9,17 @@ a. In the left sidebar, click **{{< fa gear >}} Settings**. b. Under {{< fa shield >}} Governance, select **Workflows**. -c. Click on the workflow you'd like to modify, then: +c. Click on the workflow you'd like to modify to open that workflow's details page.^[[Setting up workflows](/guide/workflows/setting-up-workflows.qmd#view-workflow-details)] + +d. Click **{{< fa pencil >}} Edit Workflow** to open the workflow editor, then: - For workflows that start when a webhook is received, double-click the **Start** node to configure the webhook.[^on-webhook] - To add a step, drag and drop a new step onto the canvas. - Double-click the new step to open up the configuration modal. -d. After you're finished with step configuration, click **Update Step** to apply your changes. +e. After you're finished with step configuration, click **Update Step** to apply your changes. -e. After you've configured a step,^[To delete a step, refer to: [Delete workflow steps](/guide/workflows/configure-workflows.qmd#delete-workflow-steps)] you can then [link your workflow together](/guide/workflows/configure-workflows.qmd#link-workflow-together). +f. After you've configured a step,^[To delete a step, refer to: [Delete workflow steps](/guide/workflows/configure-workflows.qmd#delete-workflow-steps)] you can then [link your workflow together](/guide/workflows/configure-workflows.qmd#link-workflow-together). ::: {.callout} Refer to [Introduction to workflows](/guide/workflows/introduction-to-workflows.qmd#workflow-elements) for information on available step types and details on how to set up conditional requirements. @@ -43,7 +45,9 @@ a. In the left sidebar, click **{{< fa gear >}} Settings**. a. Under {{< fa shield >}} Governance, select **Workflows**. -a. Click on the workflow you'd like to modify, then: +a. Click on the workflow you'd like to modify to open that workflow's details page. + +a. Click **{{< fa pencil >}} Edit Workflow** to open the workflow editor, then: - For workflows that start when a webhook is received, double-click the **Start** node to configure the webhook. - To add a step, drag and drop a new step onto the canvas. diff --git a/site/guide/workflows/_publish-workflows.qmd b/site/guide/workflows/_publish-workflows.qmd index 77e95200f3..c19c3898e0 100644 --- a/site/guide/workflows/_publish-workflows.qmd +++ b/site/guide/workflows/_publish-workflows.qmd @@ -16,10 +16,12 @@ a. In the left sidebar, click **{{< fa gear >}} Settings**. b. Under {{< fa shield >}} Governance, select **Workflows**. -c. Hover over the workflow you want to publish. +c. Locate the workflow you want to publish. d. Under the **Actions** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. + You can also publish a draft workflow from its details page — under Actions, click **{{< fa circle-check >}} Publish Workflow**. + e. Click **Yes, Publish** to confirm the publication of the workflow. diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index fbf439396d..af862d179a 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -63,11 +63,15 @@ To create a copy of an existing workflow as a new draft workflow:[^3] 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Hover over the workflow you'd like to clone.[^4] +2. Under {{< fa shield >}} Governance, select **Workflows**. + +3. Locate the workflow you'd like to clone.[^4] -3. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa copy >}} Clone Workflow**. +4. Under the **Actions** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa copy >}} Clone Workflow**. -4. Make your changes to the workflow's **Title** and **Workflow Type**. + You can also clone a workflow from its details page[^5] — under Actions, click **{{< fa copy >}} Clone Workflow**. + +5. Make your changes to the workflow's **Title** and **Workflow Type**. Additional changes can be made to the cloned workflow after cloning by editing. @@ -92,7 +96,11 @@ You can edit a workflow in several ways: 2. Under {{< fa shield >}} Governance, select **Workflows**. -3. Click on the workflow you'd like to modify to edit the configuration for that workflow.[^5] +3. Click on the workflow you'd like to modify to open that workflow's details page.[^5] + +4. On the details page, click **{{< fa pencil >}} Edit Workflow** to open the workflow editor. + + **Edit Workflow** is available when viewing the latest version of the workflow. To edit the workflow's details instead, such as its title and description, click **{{< fa pencil >}} Edit Details** under Actions. #### Via workflows applied to records @@ -122,6 +130,8 @@ b. When you are finished, click **Save New Version** to apply your changes. c. Enter your **Version Notes** to describe your changes. +d. Close the workflow editor to return to the workflow's details page, where the diagram reflects your saved changes. + ### Delete workflow steps @@ -158,9 +168,11 @@ Deleting workflow steps on workflows active on records may result in malfunction 2. Under {{< fa shield >}} Governance, select **Workflows**. -3. Hover over the workflow you would like to remove.[^11] +3. Locate the workflow you would like to remove.[^11] -4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa trash-can >}} Delete Workflow**. +4. Under the **Actions** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa trash-can >}} Delete Workflow**. + + You can also delete a workflow from its details page[^12] — under Actions, click **{{< fa trash-can >}} Delete Workflow**. 5. Click **Yes, Delete Workflow** to permanently remove that workflow and make it inaccessible for any future runs. @@ -180,7 +192,7 @@ Deleting workflow steps on workflows active on records may result in malfunction [^4]: [Setting up workflows](setting-up-workflows.qmd#view-sort-and-filter-workflows) -[^5]: [Setting up workflows](setting-up-workflows.qmd#view-sort-and-filter-workflows) +[^5]: [Setting up workflows](setting-up-workflows.qmd#view-workflow-details) [^6]: [Manage workflows](/guide/workflows/manage-workflows.qmd#update-workflow-versions) @@ -194,3 +206,5 @@ Deleting workflow steps on workflows active on records may result in malfunction [^11]: [Setting up workflows](setting-up-workflows.qmd#view-sort-and-filter-workflows) +[^12]: [Setting up workflows](setting-up-workflows.qmd#view-workflow-details) + diff --git a/site/guide/workflows/setting-up-workflows.qmd b/site/guide/workflows/setting-up-workflows.qmd index 9a567a45d2..c965d3f0a8 100644 --- a/site/guide/workflows/setting-up-workflows.qmd +++ b/site/guide/workflows/setting-up-workflows.qmd @@ -32,10 +32,26 @@ To view workflows set up for your organization: 2. Under {{< fa shield >}} Governance, select **Workflows**. -3. Sort and filter the list of workflows to narrow down results: + All workflows are listed together in a single table, with a total count of workflows shown beneath the table: + + - **ID** — The unique identifier for the workflow. + - **Name** — The title of the workflow. + - **Status** — Whether the workflow is a `Draft` workflow or an `Active` workflow. + - **Created By** — The user who created the workflow. + - **Target** — The type of workflow: `Artifact`, `Inventory Record` + - **Target Type** — The subcategory of workflow target. For example: Validation Issue (artifact workflow) + - **Description** — The description of the workflow. + - **Trigger** — The type of trigger that initiates the workflow. + - **Actions** — Menu of actions available for that workflow. + +3. Search, sort, and filter the list of workflows to narrow down results: ::: {.panel-tabset} +### Search workflows + +Click **{{< fa magnifying-glass >}}** to search for workflows by name. + ### Sort workflows Click on any column header to sort the list of workflows by that column: @@ -64,6 +80,54 @@ Click **{{< fa filter >}} Filter** to filter for workflows using different [work ::: +## View workflow details + +Click on a workflow in the list to open that workflow's details page, where you can review the workflow's configuration and monitor its activity before making any changes:[^1] + +::: {.panel-tabset} + +### Review workflow properties + +The right sidebar shows the properties that apply to the workflow as a whole: + +- **Target** — The type of workflow: `Artifact`, `Inventory Record` +- **Target Type** — The subcategory of workflow target. For example: Validation Issue (artifact workflow) +- **Status** — Whether the workflow is a `Draft` workflow or an `Active` workflow. +- **Workflow Start** — The trigger that initiates the workflow. +- **Expected Duration** — The SLA defined for the workflow based on the start date. + +The sidebar also lists when and by whom the workflow was created and last updated, along with actions available for that workflow: + +- **{{< fa pencil >}} Edit Details** — Edit the workflow's details, such as its title and description. +- **{{< fa copy >}} Clone Workflow** — Create a copy of the workflow as a new draft workflow.[^2] +- **{{< fa circle-check >}} Publish Workflow** — For `Draft` workflows, publish the workflow for use.[^3] +- **{{< fa trash-can >}} Delete Workflow** — Permanently delete the workflow.[^4] + +### Browse version history + +The details page displays the latest version of the workflow by default. To review a previous version, click on the **Version** drop-down and select the version you'd like to view. + +For the selected version, the details page shows who created that version and when, along with the version notes describing the changes — and the workflow diagram and active executions update to reflect that version. + +::: {.callout} +Older versions of a workflow are read-only and cannot be edited or initiated on records or artifacts. +::: + +### Preview the workflow diagram + +Under Workflow diagram, a read-only preview shows the steps and links that make up the selected version of the workflow. + +When viewing the latest version, click **{{< fa pencil >}} Edit Workflow** to open the workflow editor and make changes to the workflow's steps and links.[^5] + +### Monitor active executions + +Under Active Executions, review the runs of the displayed version that are currently in progress: + +- Each row shows the record or artifact the workflow is running on, its current stage, and the record owner. +- Click on a row to go to that record or artifact. + +::: + ## Set up workflows :::{#workflow-setup} @@ -74,3 +138,20 @@ Click **{{< fa filter >}} Filter** to filter for workflows using different [work - [Workflows and lifecycles FAQ](/faq/faq-workflows.qmd) - [Working with workflows](working-with-workflows.qmd) + + + +[^1]: [Configure workflows](configure-workflows.qmd) + +[^2]: [Clone existing workflows](configure-workflows.qmd#clone-existing-workflows) + +[^3]: + + ::: {.callout-important title="Once a workflow is published, it cannot be reverted to draft status."} + You can continue to make changes to published workflows by creating new versions of workflows. + ::: + +[^4]: [Delete existing workflows](configure-workflows.qmd#delete-existing-workflows) + +[^5]: [Edit existing workflows](configure-workflows.qmd#edit-existing-workflows) + From b5584bd46a94d7ec12cc4206cba3018c69a16c0f Mon Sep 17 00:00:00 2001 From: Emma Van Der Heide Date: Thu, 27 Aug 2026 17:08:31 -0400 Subject: [PATCH 2/3] [SC-16950] Extend read-only version callout to risk tier targets Co-Authored-By: Claude Fable 5 --- site/guide/workflows/setting-up-workflows.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/workflows/setting-up-workflows.qmd b/site/guide/workflows/setting-up-workflows.qmd index c965d3f0a8..9efc72c71d 100644 --- a/site/guide/workflows/setting-up-workflows.qmd +++ b/site/guide/workflows/setting-up-workflows.qmd @@ -110,7 +110,7 @@ The details page displays the latest version of the workflow by default. To revi For the selected version, the details page shows who created that version and when, along with the version notes describing the changes — and the workflow diagram and active executions update to reflect that version. ::: {.callout} -Older versions of a workflow are read-only and cannot be edited or initiated on records or artifacts. +Older versions of a workflow are read-only and cannot be edited or executed on records, artifacts, or risk tier templates or assessments. ::: ### Preview the workflow diagram From 4f8e7a95591e40a802398b2180e5ce6fe1c74e1a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 27 Aug 2026 23:44:39 +0000 Subject: [PATCH 3/3] chore: refresh chatbot product map --- site/llm/chatbot-product-map.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/llm/chatbot-product-map.md b/site/llm/chatbot-product-map.md index 210a7a9a8d..446d6e9a38 100644 --- a/site/llm/chatbot-product-map.md +++ b/site/llm/chatbot-product-map.md @@ -641,7 +641,7 @@ **Docs (primary):** - `/guide/workflows/setting-up-workflows.html` - - Sections: View, sort, and filter workflows; Sort workflows; Filter workflows; How do I create effective filters?; Set up workflows; What's next + - Sections: View, sort, and filter workflows; Search workflows; Sort workflows; Filter workflows; How do I create effective filters?; View workflow details; Review workflow properties; Browse version history **Docs (related):**