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
3 changes: 1 addition & 2 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,7 @@ website:
- file: guide/model-inventory/managing-model-inventory.qmd
contents:
- guide/model-inventory/configure-model-interdependencies.qmd
- text: "Manage inventory custom fields"
file: guide/model-inventory/manage-inventory-custom-fields.qmd
- guide/model-inventory/manage-model-inventory-fields.qmd
- text: "---"
- text: "MODEL DOCUMENTATION"
- file: guide/model-documentation/working-with-documentation-templates.qmd
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Changes are automatically saved to your account and do not affect other users.
## What's next

- [Register models in the inventory](register-models-in-inventory.qmd)
- [Manage model inventory custom fields](manage-inventory-custom-fields.qmd)
- [Manage model inventory fields](manage-model-inventory-fields.qmd)


<!-- FOOTNOTES -->
Expand Down
2 changes: 1 addition & 1 deletion site/guide/model-inventory/edit-model-inventory-fields.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Edit individual model detailed fields in the model inventory to customize them t
## What's next

- [Register models in the inventory](register-models-in-inventory.qmd)
- [Manage inventory custom fields](manage-inventory-custom-fields.qmd)
- [Manage model inventory fields](manage-model-inventory-fields.qmd)


<!-- FOOTNOTES -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Manage model inventory custom fields"
title: "Manage model inventory fields"
date: last-modified
---

Create and edit custom fields that appear on all models in your model inventory. Choose from an array of custom field types with different properties and use cases.
Create and edit the fields that appear on all models in your model inventory. Choose from an array of field types with different properties and use cases.

::: {.prereq}

Expand All @@ -14,20 +14,20 @@ Create and edit custom fields that appear on all models in your model inventory.

:::

## Add or edit custom fields
## Add or edit inventory fields

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under Workspace Settings, select **Custom Fields**. Here you can edit existing custom fields, or add a new one:
2. Under Workspace Settings, select **Model Inventory Fields**. Here you can edit existing inventory fields, or add a new one:

- To add a new field, click **{{< fa plus >}} Add New Field**.
- To edit an existing field, select **{{< fa pencil >}} Edit** under the Actions column for the desired field.

You can also choose to indicate that a field is **required on registration**.
You can also choose to indicate that a field is **[required on registration]{.smallcaps}**.

3. When you are satisfied with the setup of your field, click **Save**.

#### Custom field types
#### Inventory field types

| Field type | Details |
|---:|---|
Expand All @@ -44,11 +44,11 @@ Create and edit custom fields that appear on all models in your model inventory.
| User | Select list pre-populated with users from your User Directory.[^2] |
: {.hover tbl-colwidths="[25,75]"}

## Delete custom fields
## Delete inventory fields

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under Workspace Settings, select **Custom Fields**.
2. Under Workspace Settings, select **Model Inventory Fields**.

3. Select **{{< fa pencil >}} Edit** under the Actions column for the field you'd like to delete.

Expand Down
2 changes: 1 addition & 1 deletion site/guide/model-inventory/managing-model-inventory.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ listing:
fields: [title, description]
contents:
- configure-model-interdependencies.qmd
- manage-inventory-custom-fields.qmd
- manage-model-inventory-fields.qmd
---

Once you're familiar with the model inventory, dive into more advanced features like managing model interdependencies, changing the stage of models, and customizing what's shown on the model inventory to support your organization's requirements.
Expand Down
10 changes: 5 additions & 5 deletions site/guide/model-inventory/register-models-in-inventory.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ To be able to document models using ValidMind's model documentation and validati

2. Click **{{< fa plus >}} Register New Model**.

3. Depending on whether or not your organization has custom fields[^2] required on model registration, input the information on the Register New Model panel.
3. Depending on whether or not your organization has additional fields[^2] required on model registration, input the information on the Register New Model panel.

#### Basic Model Information

If no custom fields are required on registration for your models:
If no additional fields are required on registration for your models:

1. Provide the information outlined in the basic model information fields table below.

Expand All @@ -48,13 +48,13 @@ If no custom fields are required on registration for your models:

#### Additional Model Information

If custom fields are required on model registration for your organization:
If additional fields are required on model registration for your organization:

1. First enter the [Basic Model Information](#basic-model-information), then click **Next {{< fa chevron-right >}}**.

To return to the previous panel, click **{{< fa chevron-left >}} Back**.

2. Fill in your organization's required custom fields.
2. Fill in your organization's required additional fields.

3. Click **Register Model** to create a new entry in the model inventory.

Expand All @@ -68,7 +68,7 @@ If custom fields are required on model registration for your organization:

[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd)

[^2]: [Manage inventory custom fields](/guide/model-inventory/manage-inventory-custom-fields.qmd)
[^2]: [Manage model inventory fields](manage-model-inventory-fields.qmd)

[^3]: [Working with documentation templates](/guide/model-documentation/working-with-documentation-templates.qmd)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Changes are automatically saved and will affect only your account.

<!-- - [Customize model inventory layout](customize-model-inventory-layout.qmd)
- [Edit model inventory fields](edit-model-inventory-fields.qmd)
- [Manage inventory custom fields](manage-inventory-custom-fields.qmd) -->
- [Manage model inventory fields](manage-model-inventory-fields.qmd) -->



Expand Down
16 changes: 8 additions & 8 deletions site/guide/model-workflows/set-up-model-workflows.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Refer to [Available step types](#available-step-types) for information on availa
|---:|---|
| Display action button when (optional) | Add conditional requirements for displaying this step.[^6] |
| Action button label (required) | Text that displays on your action button. |
| Request fields (optional) | Include custom fields alongside your action if desired. Select the field, then click **{{< fa plus >}} Add Field** to insert.[^7] |
| Request fields (optional) | Include inventory fields alongside your action if desired. Select the field, then click **+ Add Field** to insert.[^7] |
| To set status (required) | Select the status to transition to. |
: **User Action** step configuration {.hover tbl-colwidths="[40,60]"}

Expand All @@ -97,7 +97,7 @@ Refer to [Available step types](#available-step-types) for information on availa

::: {.w-40-ns .mt2}

![](user-action-custom-field.png){fig-alt="A screenshot showing the action transition panel with the Date On Hold custom field"}
![](user-action-inventory-field.png){fig-alt="A screenshot showing the action transition panel with the Date On Hold inventory field"}

Example
: A `Put On Hold` action that requests a value in the Date On Hold field, and transitions the model lifecycle status to On Hold.
Expand All @@ -108,15 +108,15 @@ Example

#### Approval
- When your resource reaches the approval step, roles or users in the selected **Approval Group** will receive your configured message.
- Requires either a **User Role**[^8] or **User Type** custom field[^9] to select from, and must be connected to both an approval and rejection Status Change step.[^10]
- Requires either a **User Role**[^8] or **User Type** inventory field[^9] to select from, and must be connected to both an approval and rejection Status Change step.[^10]

::: callout
Please note that roles or users must be assigned to the **Approval Group** field before the workflow is transitioned into the **Approval** step in order for the message to be displayed to those roles or users.
:::

| Field | Description |
|---:|---|
| Approval Group (required) | Select the **User Role** or **User Type** custom field that indicates roles or users responsible for approval. |
| Approval Group (required) | Select the **User Role** or **User Type** inventory field that indicates roles or users responsible for approval. |
| Threshold (required) | Percentage of approvers required for the resource to be approved.[^11] |
| Approval Message (required) | When your resource reaches this approval step, the users in the selected group will recieve the following message. |
: **Approval Group** step configuration {.hover tbl-colwidths="[35,65]"}
Expand All @@ -128,14 +128,14 @@ Please note that roles or users must be assigned to the **Approval Group** field

::: {.w-50-ns}

![](approval-group-setup.png){fig-alt="A screenshot showing an Approval Group step configuration with a custom field selection of Approval Users"}
![](approval-group-setup.png){fig-alt="A screenshot showing an Approval Group step configuration with a inventory field selection of Approval Users"}

:::

::: {.w-40-ns}

Example
: A message shown to the user type custom field `Approval Group` users requesting approval of model documentation.
: A message shown to the user type inventory field `Approval Group` users requesting approval of model documentation.

:::

Expand Down Expand Up @@ -231,11 +231,11 @@ Approval steps need to be subsequently linked to both a `Rejected` and an `Appro

[^6]: [Add conditional requirements](#add-conditional-requirements)

[^7]: [Manage inventory custom fields](/guide/model-inventory/manage-inventory-custom-fields.qmd)
[^7]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)

[^8]: [Manage roles](/guide/configuration/manage-roles.qmd)

[^9]: [Manage inventory custom fields](/guide/model-inventory/manage-inventory-custom-fields.qmd)
[^9]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)

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

Expand Down
4 changes: 2 additions & 2 deletions site/releases/2024-feb-14/highlights.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ We simplified the instructions for getting started with the {{< var validmind.de

<!---Panchicore/sc 2799/model owner should be able to edit model by @panchicore in [#562](https://github.com/validmind/frontend/pull/562)--->
Model owners can edit model details
: Model owners can now edit the values for fields displayed on the model details page. Previously it was only possible to edit custom fields defined by your organization.
: Model owners can now edit the values for fields displayed on the model details page. Previously it was only possible to edit inventory fields defined by your organization.

<!---Reducing load time by using localstorage for Auth0 by @even-steven in [#570](https://github.com/validmind/frontend/pull/570)--->
Performance improvements for the {{< var validmind.platform >}}
Expand All @@ -168,7 +168,7 @@ Added support for filtering model inventory by developers / validators

<!---Support for custom model fields by @panchicore in [#509](https://github.com/validmind/frontend/pull/509)--->
Support for custom model fields in the model inventory
: The model inventory has been updated to allow organizations to add custom fields. This enhancement enables administrators to customize the model inventory data schema according to your specific organizational needs. This can be done by accessing **Custom Fields** in the **{{< fa gear >}} Settings** page.
: The model inventory has been updated to allow organizations to add additional fields. This enhancement enables administrators to customize the model inventory data schema according to your specific organizational needs. This can be done by accessing **Model Inventory Fields** in the **{{< fa gear >}} Settings** page.

The initial release supports the following field types:

Expand Down
12 changes: 6 additions & 6 deletions site/releases/2024-mar-27/highlights.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -78,18 +78,18 @@ Try it:
- [Model Inventory]({{< var url.us1 >}}/model-inventory)
- [Model Findings]({{< var url.us1 >}}/model-findings)

<!---Custom Fields during Model Registration by @even-steven in [#628](https://github.com/validmind/frontend/pull/628)--->
#### Custom fields for model registration
<!---Additional Fields during Model Registration by @even-steven in [#628](https://github.com/validmind/frontend/pull/628)--->
#### Additional fields for model registration

When registering new models in the model inventory, you can now designate custom fields as mandatory. Users must complete these custom fields before they can proceed with registering a model. This feature ensures that all necessary information is provided upfront, improving the completeness and accuracy of the model registration process.
When registering new models in the model inventory, you can now designate additional fields as mandatory. Users must complete these additional fields before they can proceed with registering a model. This feature ensures that all necessary information is provided upfront, improving the completeness and accuracy of the model registration process.

You can specify the custom fields that are required under **{{< fa gear >}} Settings** > **Custom Fields**:
You can specify the inventory fields that are required under **{{< fa gear >}} Settings** > **Model Inventory Fields**:

<video src="/assets/video/releases/required-custom-fields.mp4" controls alt="A video that demonstrates how you can add custom fields under Settings > Custom Fields." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
<video src="/assets/video/releases/required-inventory-fields.mp4" controls alt="A video that demonstrates how you can add additional fields under Settings > Model Inventory Fields." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
Your browser does not support the video tag.
</video><br>

Try it: [Custom Fields]({{< var url.us1 >}}/settings/inventory-model-custom-fields)
Try it: [Model Inventory Fields]({{< var url.us1 >}}/settings/inventory-model-custom-fields)

<!---feat: improvements to groups by @sammusaev in [#627](https://github.com/validmind/frontend/pull/627)--->
<!---feat: see user invite history by @sammusaev in [#612](https://github.com/validmind/frontend/pull/612)--->
Expand Down
6 changes: 3 additions & 3 deletions site/releases/2024-may-22/release-notes.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -606,13 +606,13 @@ This picker allows you to set whether the section is **In Progress** or **Done**
::::

<!---
PR #711: Added feature to specify a template for Rich Text Custom fields
PR #711: Added feature to specify a template for Rich Text inventory fields
URL: https://github.com/validmind/frontend/pull/711
Labels: enhancement
--->
### Specify a template for rich text custom fields
### Specify a template for rich text inventory fields

We added a new property to the **Long Text** custom field: `ENABLE RICH TEXT FORMATTING`.
We added a new property to the **Long Text** inventory field: `ENABLE RICH TEXT FORMATTING`.

- Toggling this property changes the field to a rich text editor rather than a simple text area.
- Another field called **Template** is also available and enables you to specify the default value within the rich text editor. This feature can be useful for defining procedures or guidelines that all models need to follow.
Expand Down