Skip to content

Merge main into staging #629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 16, 2025
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
8 changes: 4 additions & 4 deletions site/guide/model-inventory/manage-model-inventory-fields.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,11 @@ Number
:::: {.flex .flex-wrap .justify-around}

::: {.w-50-ns}

![Simple number field type](number-simple.png){fig-alt="A screenshot showing a simple number field type" .screenshot group="number"}

:::

::: {.w-40-ns}

![Currency number field type](number-currency.png){fig-alt="A screenshot showing a currency number field type" .screenshot group="number"}

:::
Expand All @@ -79,10 +77,12 @@ URL
: Text value in valid URL format.

Date
: Date value in `yyyy-mm-dd` format.
: - Date value in `yyyy-mm-dd` format.
- Selection is in the current user's timezone; other users viewing this field will see the value automatically in their timezone.

Date Time
: Date value in `yyyy-mm-dd, 24hr` format.
: - Date value in `yyyy-mm-dd, 24hr` format.
- Selection is in the current user's timezone; other users viewing this field will see the value automatically in their timezone.

Email
: Text value in valid email (`user@domain.com`) format.
Expand Down
40 changes: 31 additions & 9 deletions site/guide/model-workflows/set-up-model-workflows.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Workflows cannot be saved until condition branches are connected to other steps.

To configure a condition branch:

1. On the Configure Condition Branch module, click **+ Add Branch**.
1. On the Configure Condition Branch modal, click **+ Add Branch**.
2. Enter in the **[path name]{.smallcaps}** and designate the **[conditions]{.smallcaps}**[^12] that apply to this path.
3. Continue with steps 1 and 2 until your conditional branch logic is complete.

Expand Down Expand Up @@ -186,6 +186,24 @@ For example, if you wanted your models where the field `GenAI Model` is set to `

:::

#### Wait

- Creates a time condition for displaying next available action.
- Used to enforce a time delay or a calendar date milestone.

::: {.callout title="Time stamp configuration is in the current user's timezone."}
Other users viewing those fields or the workflow will see the value automatically in their timezone.
:::

To configure a wait step, select when you would like to [resume workflow]{.smallcaps}:

| Option | Required field | Description |
|---:|---|---|
| After Time Interval | [wait duration]{.smallcaps} | Wait for a set amount of time in minutes, hours, or days. Applies to all models under the workflow. |
| At Specified Date | [wait until]{.smallcaps} | Wait until a specific timestamp. Applies to all models under the workflow. If the milestone date inputted is in the past, the next workflow step will display immediately. |
| At Specified Date on Model Field | [model field]{.smallcaps}[^15] | Wait until a specific timestamp as defined by a valid `Date` or `Date Time` type model inventory field on a per model basis. If the selected field is empty[^16] or the milestone date inputted is in the past, the next workflow step will display immediately. |
: **Wait** step configuration {.hover tbl-colwidths="[30,15,45]"}

### Add conditional requirements

Conditional requirements can be configured for all four available step types:
Expand All @@ -198,7 +216,7 @@ Conditional requirements can be configured for all four available step types:
| Condition Branch | Under each branch's **[conditions]{.smallcaps}**, you're able to designate the `AND` and `OR` conditions that apply to that path. |
: Step type conditional options {.hover tbl-colwidths="[20,80]"}

For Status Change[^15], User Action[^16], and Condition Branch[^17] conditions, you're able to add a single independent **Rule** or a linked condition **Group**. These rules and groups can be nested if desired:
For Status Change[^17], User Action[^18], and Condition Branch[^19] conditions, you're able to add a single independent **Rule** or a linked condition **Group**. These rules and groups can be nested if desired:

- Click **{{< fa plus >}} Rule** to add an independent rule.
- Click **{{< fa plus >}} Group** to add a linked group of rules that all must be true to qualify.
Expand All @@ -210,9 +228,9 @@ For Status Change[^15], User Action[^16], and Condition Branch[^17] conditions,
#### Link approval steps
Approval steps need to be subsequently linked to both a [Rejected]{.bubble .red .red-bg} and an [Approved]{.bubble .green .green-bg} Status Change step:

1. First, configure an **Approval** step.[^18]
1. First, configure an **Approval** step.[^20]

2. Then, drag two **Status Change** steps onto the canvas:[^19]
2. Then, drag two **Status Change** steps onto the canvas:[^21]

- Assign a `Rejected` status to one in the **Set Document Status** field.
- Assign an `Approved` status to the other in the **Set Document Status** field.
Expand Down Expand Up @@ -280,15 +298,19 @@ Approval steps need to be subsequently linked to both a [Rejected]{.bubble .red

[^14]: [Approval](#approval) steps

[^15]: [Status Change](#status-change) steps
[^15]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)

[^16]: Make model inventory fields **[required on registration]{.smallcaps}** to ensure necessary fields have valid values.

[^17]: [Status Change](#status-change) steps

[^16]: [User Action](#user-action) steps
[^18]: [User Action](#user-action) steps

[^17]: [Condition Branch](#condition-branch) steps
[^19]: [Condition Branch](#condition-branch) steps

[^18]:
[^20]:

- [Configure workflow steps](#configure-workflow-steps)
- [Approval](#approval) steps

[^19]: [Status Change](#status-change) steps
[^21]: [Status Change](#status-change) steps