From 527ef26ece616115f54896bccc388d27c605f860 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:15:18 -0700 Subject: [PATCH 1/8] Setup for workflow drafts --- site/guide/workflows/_publish-workflows.qmd | 3 +++ site/guide/workflows/configure-workflows.qmd | 11 ++++++++--- 2 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 site/guide/workflows/_publish-workflows.qmd diff --git a/site/guide/workflows/_publish-workflows.qmd b/site/guide/workflows/_publish-workflows.qmd new file mode 100644 index 0000000000..fda39bcd77 --- /dev/null +++ b/site/guide/workflows/_publish-workflows.qmd @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index 22609a3427..5ed5858215 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -29,16 +29,17 @@ To set up a new custom workflow, you'll need to complete these three steps in se 1. [Add a new workflow](#add-new-workflows) 2. [Configure the workflow steps](#configure-workflow-steps) 3. [Link the workflow together](#link-workflow-together) +4. [Publish the workflow](#publish-workflow) -### Add new workflows +### 1. Add new workflows {{< include /guide/workflows/_add-new-workflows.qmd >}} -### Configure workflow steps +### 2. Configure workflow steps {{< include /guide/workflows/_configure-workflow-steps.qmd >}} -### Link workflow together +### 3. Link workflow together {{< include /guide/workflows/_link-workflow-together.qmd >}} @@ -46,6 +47,10 @@ To set up a new custom workflow, you'll need to complete these three steps in se Click **Tidy Layout** at any time for a linear view of your workflow. ::: +### 4. Publish workflow + +{{< include /guide/workflows/_publish-workflows.qmd >}} + ## Clone existing workflows To create a copy of an existing workflow: From 94babd46181abaddaa45b0bcad5e9bf51220fad2 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:23:54 -0700 Subject: [PATCH 2/8] WIP: Publishing workflows --- site/guide/workflows/_add-new-workflows.qmd | 8 ++++---- site/guide/workflows/_publish-workflows.qmd | 19 ++++++++++++++++++- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd index a13c05b965..db5ac82f2b 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -33,7 +33,7 @@ a. Under **[workflow start]{.smallcaps}**, select when the workflow should be in a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. -a. Click **Add Model Workflow** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). +a. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). #### Add Artifact Workflows @@ -51,7 +51,7 @@ a. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/mo a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. -a. Click **Add Artifact Workflow** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). +a. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). ::: @@ -110,7 +110,7 @@ a. Under **[workflow start]{.smallcaps}**, select when the workflow should be in a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. -a. Click **Add Model Workflow** to save your blank workflow, and then configure your workflow steps. +a. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. #### Add Artifact Workflows @@ -127,6 +127,6 @@ a. Select the **[artifact type]{.smallcaps}** a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. -a. Click **Add Artifact Workflow** to save your blank workflow, and then configure your workflow steps. +a. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. :::: \ No newline at end of file diff --git a/site/guide/workflows/_publish-workflows.qmd b/site/guide/workflows/_publish-workflows.qmd index fda39bcd77..1c353462d0 100644 --- a/site/guide/workflows/_publish-workflows.qmd +++ b/site/guide/workflows/_publish-workflows.qmd @@ -1,3 +1,20 @@ \ No newline at end of file +SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> + +::: {.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.^[[Edit existing workflows](/guide/workflows/configure-workflows.qmd#edit-existing-workflows)] + +::: + +Once you are satisfied with the setup of your workflow, publish the workflow for use: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +1. Under {{< fa shield >}} Governance, select **Workflows**. + +1. Hover over the workflow you want to publish. + +1. Under the **[actions]{.smallcaps}** column, click **{{< fa ellipsis-vertial >}}** and select **{{< fa circle-check >}} Publish Workflow**. + +1. Click **Yes, Publish** to confirm the publication of the workflow. \ No newline at end of file From eba8f2c039ef7c471a370ec999aa8eb4b0a32f8f Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:54:14 -0700 Subject: [PATCH 3/8] Save point --- site/guide/workflows/_add-new-workflows.qmd | 44 +++++++++---------- .../workflows/_configure-workflow-steps.qmd | 10 ++--- .../workflows/_link-workflow-together.qmd | 28 ++++++------ site/guide/workflows/_publish-workflows.qmd | 35 ++++++++++++--- site/guide/workflows/configure-workflows.qmd | 11 +++-- .../using-validmind-for-risk-management.qmd | 4 ++ 6 files changed, 83 insertions(+), 49 deletions(-) diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd index db5ac82f2b..5cda61492d 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -5,13 +5,13 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} To add a new blank workflow: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under {{< fa shield >}} Governance, select **Workflows**. +b. Under {{< fa shield >}} Governance, select **Workflows**. -1. Click **{{< fa plus >}} Add Workflow**. +c. Click **{{< fa plus >}} Add Workflow**. -1. Select the [workflow target]{.smallcaps} type to add: +d. Select the [workflow target]{.smallcaps} type to add: - **Inventory Model** — Workflows that apply to models in your inventory.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)] - **Artifact** — Workflows that apply to logged artifacts.^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] @@ -20,38 +20,38 @@ To add a new blank workflow: #### Add Model Workflows -a. Click **{{< fa plus >}} Add Model Workflow**. +i. Click **{{< fa plus >}} Add Model Workflow**. -a. On the Add New Model Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. +ii. On the Add New Model Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. -a. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: +iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: - - **Manually** — Start this workflow manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] - - **On Model Registration** — Start this workflow when a model is registered in your model inventory.[^on-model-registration] - - **On Field Change** — Start this workflow on a change to a specific model inventory field.[^on-field-change] To configure, select a field under **[model field to monitor]{.smallcaps}**. - - **Via Webhook** — Start this workflow when a webhook event is received. +- **Manually** — Start this workflow manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] +- **On Model Registration** — Start this workflow when a model is registered in your model inventory.[^on-model-registration] +- **On Field Change** — Start this workflow on a change to a specific model inventory field.[^on-field-change] To configure, select a field under **[model field to monitor]{.smallcaps}**. +- **Via Webhook** — Start this workflow when a webhook event is received. -a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. +iv. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. -a. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). +v. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). #### Add Artifact Workflows -a. Click **{{< fa plus >}} Add Artifact Workflow**. +i. Click **{{< fa plus >}} Add Artifact Workflow**. -a. On the Add New Artifact Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. +ii. On the Add New Artifact Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. -a. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: +iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: - - **Manually** — Start this workflow manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] - - **On Artifact Registration** — Start this workflow when a artifact is logged on a model.[^on-artifact-registration] - - **Via Webhook** — Start this workflow when a webhook event is received. +- **Manually** — Start this workflow manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] +- **On Artifact Registration** — Start this workflow when a artifact is logged on a model.[^on-artifact-registration] +- **Via Webhook** — Start this workflow when a webhook event is received. -a. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] this workflow applies to. +iv. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] this workflow applies to. -a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. +v. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. -a. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). +vi. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). ::: diff --git a/site/guide/workflows/_configure-workflow-steps.qmd b/site/guide/workflows/_configure-workflow-steps.qmd index 787992a996..8c3bcfc596 100644 --- a/site/guide/workflows/_configure-workflow-steps.qmd +++ b/site/guide/workflows/_configure-workflow-steps.qmd @@ -5,19 +5,19 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} To add or edit workflow steps: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under {{< fa shield >}} Governance, select **Workflows**. +b. Under {{< fa shield >}} Governance, select **Workflows**. -1. Click on the workflow you'd like to modify, then: +c. Click on the workflow you'd like to modify, 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. -1. After you're finished with step configuration, click **Update Step** to apply your changes. +d. After you're finished with step configuration, click **Update Step** to apply your changes. -1. 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). +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). ::: {.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. diff --git a/site/guide/workflows/_link-workflow-together.qmd b/site/guide/workflows/_link-workflow-together.qmd index a188a59095..39476c5326 100644 --- a/site/guide/workflows/_link-workflow-together.qmd +++ b/site/guide/workflows/_link-workflow-together.qmd @@ -6,17 +6,17 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ::: {.panel-tabset} -#### 1. Start the workflow +#### a. Start the workflow To initiate the beginning of your workflow:^[After you’ve [configured your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps), you can then link your workflow together.] -a. Locate the [**Start**]{.bubble .green .green-bg} of your workflow. +i. Locate the [**Start**]{.bubble .green .green-bg} of your workflow. -a. Drag from the **{{< fa circle >}}** at the bottom of [**Start**]{.bubble .green .green-bg} to the top **{{< fa circle >}}** on the first step of your workflow. +ii. Drag from the **{{< fa circle >}}** at the bottom of [**Start**]{.bubble .green .green-bg} to the top **{{< fa circle >}}** on the first step of your workflow. -a. Continue with linking the rest your steps together. +iii. Continue with linking the rest your steps together. -#### 2. Link steps together +#### b. Link steps together To link subsequent steps together: @@ -31,27 +31,27 @@ Hover over a workflow step to view an animation of the steps connecting to and f {{< fa users >}} Approval steps need to be subsequently linked to both a [Rejected]{.bubble .red .red-bg} and an [Approved]{.bubble .green .green-bg} {{< fa cube >}} Model Stage Change step:^[[Workflow step types](/guide/workflows/workflow-step-types.qmd)] -a. First, configure an **{{< fa users >}} Approval** step. +i. First, configure an **{{< fa users >}} Approval** step. -a. Then, drag two **{{< fa cube >}} Model Stage Change** steps onto the canvas: +ii. Then, drag two **{{< fa cube >}} Model Stage Change** steps onto the canvas: - Assign a stage associated with rejection to one in the **[set model stage to]{.smallcaps}** field. - Assign a stage associated with approval to the other in the **[set model stage to]{.smallcaps}** field. -a. Then, from the bottom of your **{{< fa users >}} Approval** step: +iii. Then, from the bottom of your **{{< fa users >}} Approval** step: - a. Connect the left [**{{< fa circle >}}**]{.red} (red) to your rejection step.^[When complete, the workflow arrow will display as [Rejected]{.bubble .red .red-bg}.] - b. Connect the right [**{{< fa circle >}}**]{.green} (green) to your approval step.^[When complete, the workflow arrow will display as [Approved]{.bubble .green .green-bg}.] +- Connect the left [**{{< fa circle >}}**]{.red} (red) to your rejection step.^[When complete, the workflow arrow will display as [Rejected]{.bubble .red .red-bg}.] +- Connect the right [**{{< fa circle >}}**]{.green} (green) to your approval step.^[When complete, the workflow arrow will display as [Approved]{.bubble .green .green-bg}.] -#### 3. End the workflow +#### c. End the workflow When all your workflow steps have been linked together: -a. Designate the end of your workflow by dragging an **{{< fa circle-stop >}} End** step onto the canvas. +i. Designate the end of your workflow by dragging an **{{< fa circle-stop >}} End** step onto the canvas. -a. Link relevant previous steps to the **{{< fa circle-stop >}} End** step by clicking on the bottom **{{< fa circle >}}** of those steps, and dragging to the top **{{< fa circle >}}** of the **{{< fa circle-stop >}} End** step. +ii. Link relevant previous steps to the **{{< fa circle-stop >}} End** step by clicking on the bottom **{{< fa circle >}}** of those steps, and dragging to the top **{{< fa circle >}}** of the **{{< fa circle-stop >}} End** step. -a. When you are finished configuring your workflow, click **Save** to apply your changes. +iii. When you are finished configuring your workflow, click **Save** to apply your changes. ::: diff --git a/site/guide/workflows/_publish-workflows.qmd b/site/guide/workflows/_publish-workflows.qmd index 1c353462d0..f9acc1e04b 100644 --- a/site/guide/workflows/_publish-workflows.qmd +++ b/site/guide/workflows/_publish-workflows.qmd @@ -2,6 +2,7 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> +:::: {.content-visible unless-format="revealjs"} ::: {.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.^[[Edit existing workflows](/guide/workflows/configure-workflows.qmd#edit-existing-workflows)] @@ -9,12 +10,36 @@ You can continue to make changes to published workflows by creating new versions Once you are satisfied with the setup of your workflow, publish the workflow for use: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under {{< fa shield >}} Governance, select **Workflows**. +b. Under {{< fa shield >}} Governance, select **Workflows**. -1. Hover over the workflow you want to publish. +c. Hover over the workflow you want to publish. -1. Under the **[actions]{.smallcaps}** column, click **{{< fa ellipsis-vertial >}}** and select **{{< fa circle-check >}} Publish Workflow**. +d. Under the **[actions]{.smallcaps}** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. -1. Click **Yes, Publish** to confirm the publication of the workflow. \ No newline at end of file +e. Click **Yes, Publish** to confirm the publication of the workflow. + +:::: + + + +:::: {.content-hidden unless-format="revealjs"} +::: {.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.^[[Edit existing workflows](/guide/workflows/configure-workflows.qmd#edit-existing-workflows)] + +::: + +Once you are satisfied with the setup of your workflow, publish the workflow for use: + +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. + +d. Under the **[actions]{.smallcaps}** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. + +e. Click **Yes, Publish** to confirm the publication of the workflow. + +:::: \ No newline at end of file diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index 5ed5858215..36b145938a 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -43,8 +43,14 @@ To set up a new custom workflow, you'll need to complete these three steps in se {{< include /guide/workflows/_link-workflow-together.qmd >}} -::: {.callout title="Workflow steps relationship unclear on your canvas?"} +
+ +::: {.callout-button .pl4 .nt4} +::: {.callout collapse="true" appearance="minimal"} +### Workflow steps relationship unclear on your canvas? Click **Tidy Layout** at any time for a linear view of your workflow. + +::: ::: ### 4. Publish workflow @@ -53,7 +59,7 @@ Click **Tidy Layout** at any time for a linear view of your workflow. ## Clone existing workflows -To create a copy of an existing workflow: +To create a copy of an existing workflow as a new draft workflow:^ 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -65,7 +71,6 @@ To create a copy of an existing workflow: Additional changes can be made to the cloned workflow after cloning by editing.[^4] - ## Edit existing workflows ::: {.callout title="Saving edits to a workflow already executed on models or artifacts will create a new version of the workflow."} diff --git a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd index e5587bb64b..1fdcc307bb 100644 --- a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd +++ b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd @@ -259,6 +259,10 @@ To set up a new custom workflow, you'll need to complete these three steps in se {{< include /guide/workflows/_link-workflow-together.qmd >}} +### 4. Publish workflow + +{{< include /guide/workflows/_publish-workflows.qmd >}} + ::: ::: From 43aba374c2a4c7f47e338e2cdb2c602bca4b4986 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Fri, 24 Apr 2026 14:02:38 -0700 Subject: [PATCH 4/8] Training WIP --- site/guide/workflows/_add-new-workflows.qmd | 42 +++++++++---------- site/guide/workflows/_publish-workflows.qmd | 23 +++------- site/guide/workflows/configure-workflows.qmd | 14 ++++--- .../using-validmind-for-risk-management.qmd | 8 ++-- 4 files changed, 39 insertions(+), 48 deletions(-) diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd index 5cda61492d..f446a4990c 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -84,49 +84,49 @@ vi. Click **Save Draft** to save your blank workflow, and then [configure your w :::: {.content-hidden unless-format="revealjs"} -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under {{< fa shield >}} Governance, select **Workflows**. +b. Under {{< fa shield >}} Governance, select **Workflows**. -1. Click **{{< fa plus >}} Add Workflow**. +c. Click **{{< fa plus >}} Add Workflow**. -1. Select the [workflow target]{.smallcaps} type to add: +d. Select the [workflow target]{.smallcaps} type to add: - **Inventory Model** — Workflows that apply to models in your inventory. - **Artifact** — Workflows that apply to logged artifacts. #### Add Model Workflows -a. Click **{{< fa plus >}} Add Model Workflow**. +i. Click **{{< fa plus >}} Add Model Workflow**. -a. On the Add New Model Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. +ii. On the Add New Model Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. -a. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: +iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: - - **Manually** — Start this workflow manually. - - **On Model Registration** — Start this workflow when a model is registered in your model inventory. - - **On Field Change** — Start this workflow on a change to a specific model inventory field. To configure, select a field under **[model field to monitor]{.smallcaps}**. - - **Via Webhook** — Start this workflow when a webhook event is received. +- **Manually** — Start this workflow manually. +- **On Model Registration** — Start this workflow when a model is registered in your model inventory. +- **On Field Change** — Start this workflow on a change to a specific model inventory field. To configure, select a field under **[model field to monitor]{.smallcaps}**. +- **Via Webhook** — Start this workflow when a webhook event is received. -a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. +iv. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. -a. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. +v. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. #### Add Artifact Workflows -a. Click **{{< fa plus >}} Add Artifact Workflow**. +i. Click **{{< fa plus >}} Add Artifact Workflow**. -a. On the Add New Artifact Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. +ii. On the Add New Artifact Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. -a. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: +iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: - - **Manually** — Start this workflow manually. - - **On Artifact Registration** — Start this workflow when a artifact is logged on a model. +- **Manually** — Start this workflow manually. +- **On Artifact Registration** — Start this workflow when a artifact is logged on a model. -a. Select the **[artifact type]{.smallcaps}** +iv. Select the **[artifact type]{.smallcaps}** -a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. +v. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. -a. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. +vi. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. :::: \ No newline at end of file diff --git a/site/guide/workflows/_publish-workflows.qmd b/site/guide/workflows/_publish-workflows.qmd index f9acc1e04b..ecdc259acd 100644 --- a/site/guide/workflows/_publish-workflows.qmd +++ b/site/guide/workflows/_publish-workflows.qmd @@ -8,6 +8,8 @@ You can continue to make changes to published workflows by creating new versions ::: +:::: + Once you are satisfied with the setup of your workflow, publish the workflow for use: a. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -20,26 +22,13 @@ d. Under the **[actions]{.smallcaps}** column, click **{{< fa ellipsis-vertical e. Click **Yes, Publish** to confirm the publication of the workflow. -:::: - - :::: {.content-hidden unless-format="revealjs"} -::: {.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.^[[Edit existing workflows](/guide/workflows/configure-workflows.qmd#edit-existing-workflows)] - -::: - -Once you are satisfied with the setup of your workflow, publish the workflow for use: - -a. In the left sidebar, click **{{< fa gear >}} Settings**. - -b. Under {{< fa shield >}} Governance, select **Workflows**. +::: {.f5 .pl3 .mt4 .pr3 .embed} +**Once a workflow is published, it cannot be reverted to draft status.** -c. Hover over the workflow you want to publish. - -d. Under the **[actions]{.smallcaps}** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. +You can continue to make changes to published workflows by [creating new versions of workflows](/guide/workflows/configure-workflows.qmd#edit-existing-workflows){target="_blank"}. -e. Click **Yes, Publish** to confirm the publication of the workflow. +::: :::: \ No newline at end of file diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index 36b145938a..9614406d42 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -24,7 +24,7 @@ aliases: ## Create custom workflows -To set up a new custom workflow, you'll need to complete these three steps in sequence: +To set up a new custom workflow, you'll need to complete these four steps in sequence: 1. [Add a new workflow](#add-new-workflows) 2. [Configure the workflow steps](#configure-workflow-steps) @@ -59,17 +59,19 @@ Click **Tidy Layout** at any time for a linear view of your workflow. ## Clone existing workflows -To create a copy of an existing workflow as a new draft workflow:^ +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.[^3] +2. Hover over the workflow you'd like to clone.[^4] 3. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa copy >}} Clone Workflow**. 4. Make your changes to the workflow's **[title]{.smallcaps}** and **[workflow type]{.smallcaps}**. - Additional changes can be made to the cloned workflow after cloning by editing.[^4] + Additional changes can be made to the cloned workflow after cloning by editing. + +Once you are satisfied with the setup of your workflow, publish the workflow for use. ## Edit existing workflows @@ -174,9 +176,9 @@ Deleting workflow steps on workflows active on models may result in malfunctioni [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^3]: [Setting up workflows](setting-up-workflows.qmd#view-sort-and-filter-workflows) +[^3]: If a cloned workflow's [workflow start]{.smallcaps} trigger conflicts with an existing workflow, the cloned workflow will be set to manual initiation instead. -[^4]: If a cloned workflow's [workflow start]{.smallcaps} trigger conflicts with an existing workflow, the cloned workflow will be set to manual initiation instead. +[^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) diff --git a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd index 1fdcc307bb..3b0c02836b 100644 --- a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd +++ b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd @@ -243,7 +243,7 @@ For more assistance configuring workflows, refer to our [Workflow configuration {{< include /guide/workflows/_configure-workflows.qmd >}} -To set up a new custom workflow, you'll need to complete these three steps in sequence: +To set up a new custom workflow, you'll need to complete these four steps in sequence: ::: {.panel-tabset} @@ -251,15 +251,15 @@ To set up a new custom workflow, you'll need to complete these three steps in se {{< include /guide/workflows/_add-new-workflows.qmd >}} -### 2. Configure workflow steps +### 2. Configure steps {{< include /guide/workflows/_configure-workflow-steps.qmd >}} -### 3. Link workflow together +### 3. Link steps together {{< include /guide/workflows/_link-workflow-together.qmd >}} -### 4. Publish workflow +### 4. Publish {{< include /guide/workflows/_publish-workflows.qmd >}} From 74ba7b4883b8546ccdfe6c40900ba5bf13a2e30c Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Fri, 24 Apr 2026 14:06:21 -0700 Subject: [PATCH 5/8] Edited: Using ValidMind for Model Risk Management --- site/guide/workflows/_publish-workflows.qmd | 2 +- .../using-validmind-for-risk-management.qmd | 19 +++++++++++++++++-- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/site/guide/workflows/_publish-workflows.qmd b/site/guide/workflows/_publish-workflows.qmd index ecdc259acd..8a7c98416f 100644 --- a/site/guide/workflows/_publish-workflows.qmd +++ b/site/guide/workflows/_publish-workflows.qmd @@ -18,7 +18,7 @@ b. Under {{< fa shield >}} Governance, select **Workflows**. c. Hover over the workflow you want to publish. -d. Under the **[actions]{.smallcaps}** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. +d. Under the [actions]{.smallcaps} column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. e. Click **Yes, Publish** to confirm the publication of the workflow. diff --git a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd index 3b0c02836b..e77718332d 100644 --- a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd +++ b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd @@ -279,7 +279,7 @@ To set up a new custom workflow, you'll need to complete these four steps in seq 2. On the Add New Model Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. 3. Under **[workflow start]{.smallcaps}**, select **Manually**. 4. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow. -5. Click **Add Workflow** to save your blank workflow. +5. Click **Save Draft** to save your blank workflow. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -292,7 +292,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. **Configure & link workflow steps** ::: -1. Click on the workflow you'd added earlier, then: +1. Click on the workflow you added earlier, then: - To add a step, drag and drop a new step onto the canvas. For example: {{< fa arrow-pointer >}} User Action - Double-click the new step to open up the configuration modal. 2. After you're finished with step configuration, click **Update Step** to apply your changes. @@ -307,6 +307,21 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. :::: +## {background-iframe="https://app.prod.validmind.ai/settings/workflows" background-interactive="true" data-preload="yes"} + +:::: {.slideover--l .auto-collapse-10} +::: {.tc} +**Publish workflow** +::: + +1. Hover over the workflow you added earlier. +2. Under the [actions]{.smallcaps} column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. +3. Click **Yes, Publish** to confirm the publication of the workflow. + +When you're done, click [{{< fa chevron-right >}}]() to continue. + +:::: + ## {.scrollable .center} :::: {.columns} From 573c298da64fdea17c3af3f79874cef8c142d735 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Fri, 24 Apr 2026 14:08:34 -0700 Subject: [PATCH 6/8] Edited: Setting up workflows --- site/guide/workflows/setting-up-workflows.qmd | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/site/guide/workflows/setting-up-workflows.qmd b/site/guide/workflows/setting-up-workflows.qmd index 56e91b25aa..8b7101f4b2 100644 --- a/site/guide/workflows/setting-up-workflows.qmd +++ b/site/guide/workflows/setting-up-workflows.qmd @@ -43,9 +43,10 @@ Click on any column header to sort the list of workflows by that column: Click **{{< fa filter >}} Filter** to filter for workflows using different [workflow fields]{.smallcaps}: + - **Status** — Whether the workflow is a `Draft` workflow or an `Active` workflow. - **Target Type** — The subcategory of workflow target. For example: Validation Issue (artifact workflow) - **Trigger** — The type of trigger that initiates the workflow. - - **Workflow Target** — The type of workflow: Artifact, Inventory Model + - **Workflow Target** — The type of workflow: `Artifact`, `Inventory Model`
From 9f82bd6f1e5fda104a95ab57438088ef76d60ff9 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Fri, 24 Apr 2026 14:17:17 -0700 Subject: [PATCH 7/8] Updated: Filtering workflows --- site/guide/shared/_work-with-filters.qmd | 16 ++++++++++++++-- site/guide/shared/work-with-filters.qmd | 4 ++-- site/guide/workflows/setting-up-workflows.qmd | 4 +++- 3 files changed, 19 insertions(+), 5 deletions(-) diff --git a/site/guide/shared/_work-with-filters.qmd b/site/guide/shared/_work-with-filters.qmd index 8158e3a46c..9ee26d72d8 100644 --- a/site/guide/shared/_work-with-filters.qmd +++ b/site/guide/shared/_work-with-filters.qmd @@ -55,7 +55,12 @@ Value editor :::: -:::: {.content-visible when-format="html" when-meta="includes.both"} +:::: {.content-visible when-format="html" when-meta="includes.workflows"} +- **[workflow fields]{.smallcaps}** — Workflow properties, such as the workflow status, trigger, workflow target (type of workflow), or target type (subcategory of workflow target). + +:::: + +:::: {.content-visible when-format="html" when-meta="includes.all"} :::: {.columns} ::: {.column width="50%" .pl4 .pr2} @@ -67,17 +72,24 @@ Value editor ::: ::: {.column width="50%" .pl4 .pr3} - [Artifact Filters]{.small-text} - **[artifact information]{.smallcaps}** — One of the artifact fields always created by {{< var vm.product >}}, such as the Business Unit. - **[assignees]{.smallcaps}** — User assigned to the Validation Issue type artifact. - **[artifact fields]{.smallcaps}** — One of the organization-specific artifact fields you added for your own use. + ::: :::: +::: {.column width="100%" .pl4 .pr3} +[Workflow Filters]{.small-text} + +- **[workflow fields]{.smallcaps}** — Workflow properties, such as the workflow status, trigger, workflow target (type of workflow), or target type (subcategory of workflow target). + +::: + :::: diff --git a/site/guide/shared/work-with-filters.qmd b/site/guide/shared/work-with-filters.qmd index 87929e7a72..76d4584744 100644 --- a/site/guide/shared/work-with-filters.qmd +++ b/site/guide/shared/work-with-filters.qmd @@ -5,8 +5,8 @@ title: "Work with filters" date: last-modified includes: - both: true -aliases: + all: true +aliases: - select-your-filters.html # NR This page exists only to provide a page we can link to from the filter modal in the product. # The page is intentionally not included in the sidebar because the docs for the filter modal are already embedded in the correct context: diff --git a/site/guide/workflows/setting-up-workflows.qmd b/site/guide/workflows/setting-up-workflows.qmd index 8b7101f4b2..bbc793e85b 100644 --- a/site/guide/workflows/setting-up-workflows.qmd +++ b/site/guide/workflows/setting-up-workflows.qmd @@ -14,8 +14,10 @@ listing: - manage-model-stages.qmd - configure-workflows.qmd - workflow-configuration-examples.qmd -aliases: +aliases: - /guide/model-workflows/setting-up-model-workflows.html +includes: + workflows: true --- {{< include /guide/workflows/_set-up-workflows.qmd >}} From d3e4b906c905527a2bce5d31191723203803e61a Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Mon, 27 Apr 2026 09:40:13 -0700 Subject: [PATCH 8/8] Edits as per Luis's suggestion --- site/guide/workflows/_add-new-workflows.qmd | 4 ++-- site/guide/workflows/configure-workflows.qmd | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd index f446a4990c..771408300d 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -62,7 +62,7 @@ vi. Click **Save Draft** to save your blank workflow, and then [configure your w ::: {.callout title="Please note that only one workflow can be configured to initiate on model registration."}
- [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) + [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd){.button} ::: @@ -70,7 +70,7 @@ vi. Click **Save Draft** to save your blank workflow, and then [configure your w ::: {.callout title="Please note that only one workflow can be configured to initiate on registration for each type of artifact."}
- [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) + [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd){.button} ::: diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index 9614406d42..2e9ce9b56f 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -26,10 +26,10 @@ aliases: To set up a new custom workflow, you'll need to complete these four steps in sequence: -1. [Add a new workflow](#add-new-workflows) -2. [Configure the workflow steps](#configure-workflow-steps) -3. [Link the workflow together](#link-workflow-together) -4. [Publish the workflow](#publish-workflow) +1. [Add a new workflow](#add-new-workflows) — Create a new workflow in `Draft` status. +2. [Configure the workflow steps](#configure-workflow-steps) — Configure the workflow steps to define the workflow's logic. +3. [Link the workflow together](#link-workflow-together) — Link the workflow steps together to define the workflow's flow. +4. [Publish the workflow](#publish-workflow) — Publish the workflow to make it available for use. ### 1. Add new workflows