Skip to content
Open
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/faq/faq-validation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Custom artifact types support the same features as default types, including cust

[^3]: [Assess compliance](/guide/validation/assess-compliance.qmd)

[^4]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd)
[^4]: [Log artifacts](/guide/validation/log-artifacts.qmd)

[^5]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd)

Expand Down
3 changes: 2 additions & 1 deletion site/get-started/validator/quickstart-validator.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -177,5 +177,6 @@ Now that you've grasped the basics of using {{< var vm.product >}} for validatio

[^5]: [Assess compliance](/guide/validation/assess-compliance.qmd#map-evidence)

[^6]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd#add-artifacts-on-validation-reports)
[^6]: [Log artifacts](/guide/validation/log-artifacts.qmd#add-artifacts-on-validation-reports)


3 changes: 2 additions & 1 deletion site/guide/_sidebar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,8 @@ website:
contents:
- guide/validation/view-filter-artifacts.qmd
- guide/validation/customize-artifact-layouts.qmd
- guide/validation/add-manage-artifacts.qmd
- guide/validation/log-artifacts.qmd
- guide/validation/update-artifacts.qmd
- guide/validation/customize-artifact-overview-page.qmd
- text: "---"
- section: "Reporting"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

:::: {.content-visible unless-format="revealjs" when-meta="includes.blocks"}
- The associated record's inventory fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)]
- Fields from artifacts logged on the associated record^[[Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd)]
- Fields from artifacts logged on the associated record^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)]

1. Click **{ } Insert Variable {{< fa angle-down >}}** in the toolbar while editing a content block.

Expand Down
4 changes: 2 additions & 2 deletions site/guide/inventory/_field-types.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Attachments

:::: {.content-visible when-format="html" when-meta="includes.artifacts"}
Attachments
: Upload supporting files for your artifact.^[[Manage attachments on artifacts](/guide/validation/add-manage-artifacts.qmd#manage-attachments)] Files must be less than 50 MB each in size.
: Upload supporting files for your artifact.^[[Manage attachments on artifacts](/guide/validation/update-artifacts.qmd#manage-attachments)] Files must be less than 50 MB each in size.
::::

Calculation
Expand Down Expand Up @@ -302,7 +302,7 @@ User

:::: {.content-hidden unless-format="revealjs"}
Attachments
: Upload supporting files for your [record](/guide/inventory/edit-inventory-fields.qmd#manage-attachments){target="_blank"} or [artifact](/guide/validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. Files must be less than 50 MB each in size.
: Upload supporting files for your [record](/guide/inventory/edit-inventory-fields.qmd#manage-attachments){target="_blank"} or [artifact](/guide/validation/update-artifacts.qmd#manage-attachments){target="_blank"}. Files must be less than 50 MB each in size.

Calculation
: Define a `formula(params)` function that reads field values from the `params` dictionary (`params["fieldKey"]`) and returns a read-only value. Formulas are written in Starlark and have access to a set of built-in helpers for dates, numbers, and lists.
Expand Down
63 changes: 0 additions & 63 deletions site/guide/inventory/_reference-field-values.qmd

This file was deleted.

37 changes: 10 additions & 27 deletions site/guide/inventory/configure-record-interdependencies.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,12 @@ affected by or affects other records in your inventory.

3. Select a record or find your record by applying a filter or searching for it.[^5]

4. Any existing record interdependencies are shown under the **Interdependencies** section.

On the interactive flowchart, the currently viewed record is highlighted:
4. On the record details page, click the **Interdependencies** tab to view an interactive flowchart:

- The currently viewed record is highlighted with a blinking animation.
- Click and drag to change what area is displayed on the flowchart.
- To zoom in and out, use your mouse scroll button or zoom trackpad gesture.

![Example record interdependencies](record-interdependencies.png){fig-alt="A screenshot showing example record interdependencies" .screenshot}

## Edit interdependencies

1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
Expand All @@ -46,40 +43,26 @@ affected by or affects other records in your inventory.

3. Select a record or find your record by applying a filter or searching for it.[^7]

4. Click **{{< fa square-plus >}} Manage Dependencies** to open up the interdependencies detail menu.
4. On the record details page, click the **Interdependencies** tab.

5. Select either the **{{< fa arrow-up >}} Upstream** or **{{< fa arrow-down >}} Downstream** tab:
5. Click **{{< fa square-plus >}} Manage Dependencies** to open up the interdependencies detail menu.

6. Select either the **{{< fa arrow-up >}} Upstream** or **{{< fa arrow-down >}} Downstream** tab:

- **Upstream** — Provides input or intermediate results to another record.
- **Downstream** — Receives input and typically performs further processing, predictions, or actions based on that input.

You can swap between the **{{< fa arrow-up >}} Upstream** or **{{< fa arrow-down >}} Downstream** tabs to set both interdependency types at once.

6. On your list of related records from the inventory, add or remove interdependencies as desired:
7. On your list of related records from the inventory, add or remove interdependencies as desired:

- **Add** — Check off any records that are either upstream or downstream dependent on the current record.
- **Remove** — Uncheck any records previously linked as upstream or downstream dependent on the current record.
- **Add** — Select the checkbox for any records that are either upstream or downstream dependent on the current record.
- **Remove** — Unselect the checkbox for any records previously linked as upstream or downstream dependent on the current record.

7. Click **Save** to apply your changes.
8. Click **Save** to apply your changes.

Once applied, interdependencies will populate on all linked records.

:::: {.flex .flex-wrap .justify-around}

::: {.w-40-ns}

![Upstream Model linked to the downstream Current Model](upstream-record.png){fig-alt="A screenshot showing the Upstream Model linked to the downstream Current Model" .screenshot group="interdependency"}

:::

::: {.w-40-ns}

![Downstream Model linked to the upstream Current Model](downstream-record.png){fig-alt="A screenshot showing the Downstream Model linked to the upstream Current Model" .screenshot group="interdependency"}

:::

::::


<!-- FOOTNOTES -->

Expand Down
84 changes: 67 additions & 17 deletions site/guide/inventory/customize-record-overview-page.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ aliases:
- /guide/model-inventory/customize-model-overview-page.html
---

Configure what and how inventory fields appear when you open a record’s details in the inventory.
Configure what and how inventory fields appear when you open a record’s details in the inventory.

:::{.callout title="Changes are automatically saved to your account and do not affect other users."}
Customizations will apply to all records in your inventory.
Customizations will apply to all records of the same type in your inventory.

:::

Expand All @@ -26,31 +26,76 @@ Customizations will apply to all records in your inventory.

## Organize, show, or hide record fields

::: {.callout title="Default main column items cannot be reorganized or hidden."}
The following fields will always appear on your record overview pages under the main column as faded cells:
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

- Record Stakeholders
- Interdependencies
- Artifacts
- Recent Activity
:::
2. Under the [record type]{.smallcaps} drop-down, select the type of record you want to customize the overview page for.[^2]

3. Select a record or find your record by applying a filter or searching for it.[^3]

4. On the record details page, click the **Inventory Fields** tab.

5. Click on **{{< fa pencil >}} Manage Fields**:

::: {.panel-tabset}

#### {{< fa chart-column >}} Show {#} Columns

Under Show {#} Columns, click {{< fa chevron-up >}} increase or {{< fa chevron-down >}} to decrease the number of columns shown.

#### {{< fa chart-bar >}} Change fields display

a. Click **{{< fa chart-bar >}} Change fields display** to configure the inventory fields[^4] that appear:

- To hide fields or field groups from view: Hover over an inventory field, then click {{< fa eye >}}.
- To show previously hidden fields or field groups: Hover over an inventory field, then click {{< fa eye-slash >}}.
- To rearrange the order of fields and field groups: Click and hold, then drag-and-drop.
- To pin a field to the Overview tab: Hover over the field, then click **{{< fa star >}}** to highlight the field.[^5]

::: {.callout}
To narrow down your list of fields:

- Click **{{< fa filter >}} Search by group or field name** to search for specific inventory fields.
- To show only highlighted fields, click **Show only highlighted in overview**.
:::

b. Click **Save Configuration** to apply your changes to all overview pages for that record type.

:::

### Highlight inventory record fields

To pin inventory record fields to the **Overview** tab for quick access:

1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

2. Under the [record type]{.smallcaps} drop-down, select the type of record you want to customize the overview page for.[^2]
2. Under the [record type]{.smallcaps} drop-down, select the type of record you want to edit fields for.[^6]

3. Select a record or find your record by applying a filter or searching for it.[^7]

4. On the record details page, select either the **Overview** or **Inventory Fields** tab:

2. Select a record or find your record by applying a filter or searching for it.[^3]
::: {.panel-tabset}

3. Click on **{{< fa wrench >}} Customize Layout**.
#### **Overview** tab

4. On the Customize Layout modal that appears, configure the inventory fields[^4] that appear:
- If there are no highlighted fields: Click on **{{< fa star >}} Highlight fields**.
- If there are already highlighted fields: Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change fields display**.

- Toggle optional inventory fields or field groups on or off to show or hide them from view.
- Click and hold a field or field group and drag-and-drop to rearrange the order of fields and field groups. Fields and field groups can be moved from the Side Column to the Main Column and vice versa.
#### **Inventory Fields** tab

To narrow down your list of fields, search via the **{{< fa filter >}} Filter** bar.
Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change fields display**.

5. Click **Save Layout** to apply your changes to all record overview pages for that layout scope.
:::

5. Hover over an inventory field, then click **{{< fa star >}}** and select your Highlight Tone:

- [**{{< fa star >}} Normal**]{.grey}
- [**{{< fa star >}} Loud**]{.teal}
- [**{{< fa star >}} Loudest**]{.pink}

To unpin a highlighted field: Hover over the field, then click **{{< fa star >}}** and select **{{< fa star >}} Don't highlight**.

6. Confirm that the right inventory fields are pinned to the **Overview** tab with the correct highlight tone.


<!-- FOOTNOTES -->
Expand All @@ -63,3 +108,8 @@ The following fields will always appear on your record overview pages under the

[^4]: [Manage inventory fields](manage-inventory-fields.qmd#inventory-field-types)

[^5]: [Highlight inventory record fields](#highlight-inventory-record-fields)

[^6]: [Manage inventory record types](manage-inventory-record-types.qmd)

[^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)
Binary file removed site/guide/inventory/downstream-record.png
Binary file not shown.
Loading
Loading