Skip to content
Draft
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
12 changes: 8 additions & 4 deletions site/guide/workflows/_configure-workflow-steps.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
4 changes: 3 additions & 1 deletion site/guide/workflows/_publish-workflows.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
28 changes: 21 additions & 7 deletions site/guide/workflows/configure-workflows.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.

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

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

83 changes: 82 additions & 1 deletion site/guide/workflows/setting-up-workflows.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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}
Expand All @@ -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)


<!-- FOOTNOTES -->

[^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)