Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
16 changes: 14 additions & 2 deletions site/guide/shared/_work-with-filters.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand All @@ -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).

:::

::::


Expand Down
4 changes: 2 additions & 2 deletions site/guide/shared/work-with-filters.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
90 changes: 45 additions & 45 deletions site/guide/workflows/_add-new-workflows.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
Expand All @@ -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 **Add Model Workflow** 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 **Add Artifact Workflow** 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).

:::

Expand All @@ -62,15 +62,15 @@ a. Click **Add Artifact Workflow** to save your blank workflow, and then [config

::: {.callout title="Please note that only one workflow can be configured to initiate on model registration."}
<br>
[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}

:::

[^on-artifact-registration]:

::: {.callout title="Please note that only one workflow can be configured to initiate on registration for each type of artifact."}
<br>
[Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd)
[Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd){.button}

:::

Expand All @@ -84,49 +84,49 @@ a. Click **Add Artifact Workflow** to save your blank workflow, and then [config


:::: {.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 **Add Model Workflow** 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 **Add Artifact Workflow** 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.

::::
10 changes: 5 additions & 5 deletions site/guide/workflows/_configure-workflow-steps.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
28 changes: 14 additions & 14 deletions site/guide/workflows/_link-workflow-together.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.

:::

Expand Down
34 changes: 34 additions & 0 deletions site/guide/workflows/_publish-workflows.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!-- Copyright © 2023-2026 ValidMind Inc. All rights reserved.
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)]

:::

::::

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.


:::: {.content-hidden unless-format="revealjs"}
::: {.f5 .pl3 .mt4 .pr3 .embed}
**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](/guide/workflows/configure-workflows.qmd#edit-existing-workflows){target="_blank"}.

:::

::::
Loading
Loading