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
2 changes: 1 addition & 1 deletion site/guide/_sidebar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ website:
contents:
- guide/workflows/manage-record-stages.qmd
- guide/workflows/configure-workflows.qmd
- guide/workflows/workflow-configuration-examples.qmd
# - guide/workflows/workflow-configuration-examples.qmd
- file: guide/workflows/working-with-workflows.qmd
contents:
- guide/workflows/manage-workflows.qmd
Expand Down
11 changes: 11 additions & 0 deletions site/guide/workflows/_conditional-requirements.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ Conditional requirements are required or optional for the following step types:^
### {{< fa cube >}} Inventory Record Stage Change [optional]{.smallercaps .pink}
<span id="record-stage-change">

1. Under **[when these conditions are met]{.smallcaps}**, set your `AND` and `OR` conditions.
2. Add a single independent rule or a linked condition group. These rules and groups can be nested if desired:

- Click **{{< fa plus >}} Add Rule** to add an independent rule.
- Click **{{< fa plus-minus >}} Add Group** to add a linked group of rules that all must be true to qualify.

### {{< fa tag >}} Artifact Status Change
<span id="artifact-status-change">

1. Under **[when these conditions are met]{.smallcaps}**, set your `AND` and `OR` conditions.
2. Add a single independent rule or a linked condition group. These rules and groups can be nested if desired:

Expand Down Expand Up @@ -168,6 +177,8 @@ Configure conditional requirements for the following step types:

- {{< fa cube >}} Inventory Record Stage Change **[optional]{.smallercaps}**

- {{< fa tag >}} Artifact Status Change **[optional]{.smallercaps}**

- {{< fa arrow-pointer >}} User Action **[optional]{.smallercaps}**

- {{< fa users >}} Approval **[required]{.smallercaps}**
Expand Down
4 changes: 2 additions & 2 deletions site/guide/workflows/_configure-workflows.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
:::: {.content-visible unless-format="revealjs"}
Set up workflows to match your organizational needs. Workflows can be as simple or as complex as required, with multiple and discrete workflows supported for unique triggers and scenarios.

::: {.callout}
<!-- ::: {.callout}
For more assistance configuring workflows, refer to our [Workflow configuration examples](/guide/workflows/workflow-configuration-examples.qmd).
:::
::: -->

::::

Expand Down
20 changes: 19 additions & 1 deletion site/guide/workflows/_workflow-step-types.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
| [set inventory record stage to]{.smallcaps} | Select the record stage to transition to. |
: **{{< fa cube >}} Inventory Record Stage Change** step configuration {.hover tbl-colwidths="[40,60]"}

### {{< fa tag >}} Artifact Status Change
<span id="artifact-status-change">

- Transitions an artifact into another status.
- Requires available artifact type statuses associated with the workflow.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd#manage-artifact-type-statuses)]

| Field | Description |
|---:|---|
| [when these conditions are met]{.smallcaps} (optional) | Add conditional requirements to qualify for this step.^[ [Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#artifact-status-change)] |
| [set artifact status to]{.smallcaps} | Select the artifact type status to transition to. |
: **{{< fa tag >}} Artifact Status Change** step configuration {.hover tbl-colwidths="[40,60]"}

### {{< fa wifi >}} Workflow State Change
<span id="workflow-state-change">

Expand All @@ -35,6 +47,7 @@ Creates a button that performs an action on behalf of the user.
| Field | Description |
|---:|---|
| [display action button when]{.smallcaps} (optional) | Add conditional requirements for displaying this step.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#user-action)] |
| [step title]{.smallcaps} (optional) | Text that displays at the top of the modal that opens when users click the action button. |
| [action button label]{.smallcaps} | Text that displays on your action button. |
| [requested fields]{.smallcaps} (optional) | Include record or artifact fields alongside your action.[^user-action] |
| [user action deadline]{.smallcaps} (optional) | Include a deadline for when users should complete this action by.^[Toggle **Enable deadline** on to configure a deadline.] |
Expand Down Expand Up @@ -174,7 +187,7 @@ Sends a HTTP request with optional additional conditions.^[[Conditional step req

[^user-action]:

Select from the drop-down to add it to your User Action step. Users must have write permissions for the field in order to enter values.
Select a field from the the drop-down to add it to your User Action step — click **Add All** to add all fields in that group. Users must have write permissions for the field in order to enter values.
<br><br>

- [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)
Expand Down Expand Up @@ -226,8 +239,13 @@ Sends a HTTP request with optional additional conditions.^[[Conditional step req
:::: {.content-hidden unless-format="revealjs"}

#### {{< fa cube >}} Inventory Record Stage Change

Transitions a record into another stage.

#### {{< fa tag >}} Artifact Status Change

Transitions an artifact into another status.

#### {{< fa wifi >}} Workflow State Change

Transitions the workflow into another workflow state.
Expand Down
3 changes: 2 additions & 1 deletion site/guide/workflows/setting-up-workflows.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@ date: last-modified
listing:
- id: workflow-setup
type: grid
grid-columns: 2
max-description-length: 250
sort: false
fields: [title, description]
contents:
- manage-record-stages.qmd
- configure-workflows.qmd
- workflow-configuration-examples.qmd
# - workflow-configuration-examples.qmd
aliases:
- /guide/model-workflows/setting-up-model-workflows.html
includes:
Expand Down
1 change: 1 addition & 0 deletions site/guide/workflows/workflow-configuration-examples.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial
title: "Workflow configuration examples"
date: last-modified
search: false
---

Learn from example workflow configurations to help you tailor workflows to fit your organization's requirements for managing risk throughout your entire risk management lifecycles.
Expand Down
3 changes: 2 additions & 1 deletion site/guide/workflows/workflow-step-types.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ date: last-modified

Select from a variety of workflow step types to build workflows from.

<!--
::: {.callout title="Need more help configuring workflow step types?"}

- [Workflow configuration examples](workflow-configuration-examples.qmd#workflow-step-type-examples)
- [Integrations examples](/guide/integrations/integrations-examples.qmd)
:::
::: -->

{{< include /guide/workflows/_workflow-step-types.qmd >}}
Original file line number Diff line number Diff line change
Expand Up @@ -233,10 +233,10 @@ Configure custom workflows

<br>Try it **live** on the next pages. {{< fa hand-point-right >}}

::: {.f5 .pl3 .mt4 .pr3 .embed}
<!-- ::: {.f5 .pl3 .mt4 .pr3 .embed}
For more assistance configuring workflows, refer to our [Workflow configuration examples](/guide/workflows/workflow-configuration-examples.qmd){target="_blank"}.

:::
::: -->

:::

Expand Down
Loading