diff --git a/site/Makefile b/site/Makefile index 22f6027d50..a065287ac3 100644 --- a/site/Makefile +++ b/site/Makefile @@ -277,7 +277,7 @@ get-api-json: @rm -f reference/vm-api-swagger.json reference/admin-api-swagger.json reference/rapidoc-min.js @mkdir -p reference @echo "Fetching VM API Swagger spec ..." - @curl -s -o reference/vm-api-swagger.json "https://api.prod.validmind.ai/vm/api/v1/swagger.json" || echo "Failed to fetch VM API spec" + @curl -s -o reference/vm-api-swagger.json "https://app.prod.validmind.ai/vm/api/v1/swagger.json" || echo "Failed to fetch VM API spec" @echo "Fetching Admin API Swagger spec ..." @curl -s -o reference/admin-api-swagger.json "https://api.prod.validmind.ai/admin/api/v1/swagger.json" || echo "Failed to fetch Admin API spec" @echo "Fetching RapiDoc JavaScript library ..." diff --git a/site/faq/faq-validation.qmd b/site/faq/faq-validation.qmd index 741abe5beb..a188986d28 100644 --- a/site/faq/faq-validation.qmd +++ b/site/faq/faq-validation.qmd @@ -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) diff --git a/site/get-started/validator/quickstart-validator.qmd b/site/get-started/validator/quickstart-validator.qmd index db62f00678..261be08722 100644 --- a/site/get-started/validator/quickstart-validator.qmd +++ b/site/get-started/validator/quickstart-validator.qmd @@ -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) + diff --git a/site/guide/_sidebar.yaml b/site/guide/_sidebar.yaml index 3d02a23c7e..ea6b1e5024 100644 --- a/site/guide/_sidebar.yaml +++ b/site/guide/_sidebar.yaml @@ -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" diff --git a/site/guide/documentation/content_blocks/_reference-field-values.qmd b/site/guide/documentation/content_blocks/_reference-field-values.qmd index 0fd536c6c1..4f94daea30 100644 --- a/site/guide/documentation/content_blocks/_reference-field-values.qmd +++ b/site/guide/documentation/content_blocks/_reference-field-values.qmd @@ -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. diff --git a/site/guide/inventory/_field-types.qmd b/site/guide/inventory/_field-types.qmd index 77fabc701e..b83cb256c8 100644 --- a/site/guide/inventory/_field-types.qmd +++ b/site/guide/inventory/_field-types.qmd @@ -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 @@ -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. diff --git a/site/guide/inventory/_reference-field-values.qmd b/site/guide/inventory/_reference-field-values.qmd deleted file mode 100644 index 48643150f9..0000000000 --- a/site/guide/inventory/_reference-field-values.qmd +++ /dev/null @@ -1,63 +0,0 @@ - - - - -:::: {.content-visible unless-format="revealjs" when-meta="includes.inventory"} -::: {.callout-button .pl4 .nt4} -::: {.callout collapse="true" appearance="minimal"} -## Reference record field values in your content blocks within documents and library text blocks. - -:::: {.flex .flex-wrap .justify-around} - -::: {.w-50-ns .tc} -[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#reference-field-values){.button .button-green} - -::: - -::: {.w-50-ns .tc} -[Manage text block library](/guide/templates/manage-text-block-library.qmd#add-text-blocks){.button .button-green} - -::: - -:::: -::: -::: - -:::: - - - -:::: {.content-visible unless-format="revealjs" unless-meta="includes.inventory"} -
- -::: {.callout-button .pl4 .nt4} -::: {.callout collapse="true" appearance="minimal"} -## Reference artifact field values in your content blocks within documents and library text blocks. - -:::: {.flex .flex-wrap .justify-around} - -::: {.w-50-ns .tc} -[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#reference-field-values){.button .button-green} - -::: - -::: {.w-50-ns .tc} -[Manage text block library](/guide/templates/manage-text-block-library.qmd#add-text-blocks){.button .button-green} - -::: - -:::: -::: -::: - -:::: \ No newline at end of file diff --git a/site/guide/inventory/configure-record-interdependencies.qmd b/site/guide/inventory/configure-record-interdependencies.qmd index 458ce53913..08cd2a9550 100644 --- a/site/guide/inventory/configure-record-interdependencies.qmd +++ b/site/guide/inventory/configure-record-interdependencies.qmd @@ -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**. @@ -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"} - -::: - -:::: - diff --git a/site/guide/inventory/customize-record-overview-page.qmd b/site/guide/inventory/customize-record-overview-page.qmd index 932638431f..b7356b0937 100644 --- a/site/guide/inventory/customize-record-overview-page.qmd +++ b/site/guide/inventory/customize-record-overview-page.qmd @@ -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. ::: @@ -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. @@ -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) \ No newline at end of file diff --git a/site/guide/inventory/downstream-record.png b/site/guide/inventory/downstream-record.png deleted file mode 100644 index e79a5b5ba3..0000000000 Binary files a/site/guide/inventory/downstream-record.png and /dev/null differ diff --git a/site/guide/inventory/edit-inventory-fields.qmd b/site/guide/inventory/edit-inventory-fields.qmd index 5e1b16274e..ab5194624d 100644 --- a/site/guide/inventory/edit-inventory-fields.qmd +++ b/site/guide/inventory/edit-inventory-fields.qmd @@ -8,76 +8,74 @@ aliases: - /guide/edit-model-inventory-fields.html - /guide/model-inventory/edit-model-inventory-fields.html includes: - pdf-context: true inventory: true --- Edit individual detail fields on a record to ensure that record details are accurate and up-to-date. +Changes you make to inventory fields are automatically logged to the associated record's activity.[^1] + +::: {.callout title="You can reference record field values in your content blocks within documents."} +Learn more: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#reference-field-values) + +::: + ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] The record you want to edit fields for is registered in the inventory.[^1] -- [x] You are the record owner[^2] for the record you want to edit, a [{{< fa hand >}} Customer Admin]{.bubble}, or assigned another role or stakeholder type with sufficient permissions to perform the tasks in this guide.[^3] +- [x] The record you want to edit fields for is registered in the inventory.[^2] +- [x] You are the record owner[^3] for the record you want to edit, a [{{< fa hand >}} Customer Admin]{.bubble}, or assigned another role or stakeholder type with sufficient permissions to perform the tasks in this guide.[^4] ::: -## Edit inventory record fields + +## Edit fields on individual records 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 edit fields for.[^4] +2. Under the [record type]{.smallcaps} drop-down, select the type of record you want to edit fields for.[^5] -3. You can edit fields on individual records, or edit fields on records in bulk for a specific record type: +3. Select a record or find your record by applying a filter or searching for it.[^6] -::: {.panel-tabset} +4. On the record details page: -#### Edit fields on individual records + :::: {.panel-tabset} -a. Select a record or find your record by applying a filter or searching for it.[^5] + ### **Overview** tab -b. On the record details page, click on an inventory field to make your changes.[^6] + Select the **Overview** tab to click on highlighted fields to make changes, or to manage inventory record stakeholders.[^7] -c. Click **Save** to apply your changes. + ### **Inventory Fields** tab -#### Edit fields in bulk for a specific record type + Select the **Inventory Fields** tab to click on additional fields to make changes: -a. First, make sure you're in table view for the record type you want to edit fields for.[^7] + - Enter keywords into the **{{< fa magnifying-glass >}} Search fields by title** bar to narrow down your list of fields to the field you want to edit. + - Click on an attachment field header to manage files for that field.[^8] -b. Select the records you want to edit fields for by: + ::: {.callout title="Aggregation and Calculation field types are auto-computed and read-only."} + To modify how these fields are calculated, update their configuration: [Manage inventory fields](manage-inventory-fields.qmd#inventory-field-types) - - Clicking {{< fa square >}} in the header column to select all records shown on that page. - - Clicking {{< fa square >}} next to a specific record. + ::: - To view more records for selection, scroll down to the bottom of the table view and click **Next {{< fa arrow-right >}}**. + ### Right sidebar -c. At the bottom of the page, review the count of records selected to verify that the correct number of records are selected for editing, then click **{{< fa pencil >}} Edit**. + Click on the core fields in the right sidebar to make changes. -d. Make your changes to the inventory fields for the selected records. + :::: -e. Click **Continue {#}** where `{#}` is the number of fields to be edited. - -f. Review the changes to be applied to the inventory fields for the selected records to verify that the changes are correct, then click **Save {#} Changes**. - -::: - -Changes you make to inventory fields are automatically logged to that record’s activity.[^8] - -
- -{{< include /guide/inventory/_reference-field-values.qmd >}} +5. Click **Save** to apply your changes to the field. ### Manage inventory record stakeholders ::: {.panel-tabset} -### Manage stakeholder types on records +#### Manage stakeholder types on records {{< include /guide/configuration/_manage-stakeholders-on-records.qmd >}} -### Add or remove stakeholders +#### Add or remove stakeholders 1. On the record's detail page, click on the inventory record stakeholder type[^9] you'd like to add users to. @@ -89,76 +87,81 @@ Changes you make to inventory fields are automatically logged to that record’s ::: - - ### Manage attachments on records + - - -:::: {.content-visible when-format="html" when-meta="includes.pdf-context"} ::: {.callout title="Uploaded files must be less than 50 MB each in size."} - To work with attachments on records, first add an attachment inventory field.[^10] - Select attachments in `.pdf` format as context documents when generating text blocks with AI within your documents.[^11] ::: -:::: - -:::: {.content-visible when-format="html" unless-meta="includes.pdf-context"} -::: {.callout title="Uploaded files must be less than 50 MB each in size."} -To work with attachments on records, first add an attachment inventory field.[^10] -::: - -:::: - ::: {.panel-tabset} #### Add attachments to a record -1. On the record's detail page, click on the header of your attachment field. +1. Click on the header of your attachment field. {{< include _add-attachments.qmd >}} #### Remove attachments from a record -1. On the record's detail page, click on the header of your attachment field. +1. Click on the header of your attachment field. {{< include _remove-attachments.qmd >}} ::: +## Edit fields in bulk for multiple records - +In addition to editing individual fields on a per record basis, you can edit fields in bulk for a specific record type: + +1. First, make sure you're in table view for the record type you want to edit fields for.[^12] + +2. Select the records you want to edit fields for by: + + - Clicking {{< fa square >}} in the header column to select all records shown on that page. + - Clicking {{< fa square >}} next to a specific record. + + To view more records for selection, scroll down to the bottom of the table view and click **Next {{< fa arrow-right >}}**. + +3. At the bottom of the page, review the count of records selected to verify that the correct number of records are selected for editing, then click **{{< fa pencil >}} Edit**. + +4. Make your changes to the inventory fields for the selected records. + +5. Click **Continue {#}** where `{#}` is the number of fields to be edited. + +6. Review the changes to be applied to the inventory fields for the selected records to verify that the changes are correct, then click **Save {#} Changes**. -[^1]: [Register records in the inventory](register-records-in-inventory.qmd) -[^2]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders) -[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + -[^4]: [Manage inventory record types](manage-inventory-record-types.qmd) +[^1]: [View record activity](view-record-activity.qmd) -[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^2]: [Register records in the inventory](register-records-in-inventory.qmd) -[^6]: +[^3]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders) - ::: {.callout title="Aggregation and Calculation field types are auto-computed and read-only."} - To modify how these fields are calculated, update their configuration.

+[^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - [Manage inventory fields](manage-inventory-fields.qmd#inventory-field-types){.button .button-green} +[^5]: [Manage inventory record types](manage-inventory-record-types.qmd) - ::: +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^7]: [Customize inventory layout](/guide/inventory/customize-inventory-layout.qmd#swap-between-views) +[^7]: [Manage inventory record stakeholders](#manage-inventory-record-stakeholders) -[^8]: [View record activity](view-record-activity.qmd) +[^8]: [Manage attachments on records](#manage-attachments) [^9]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) [^10]: [Manage inventory fields](manage-inventory-fields.qmd#inventory-field-types) -:::: {.content-visible when-format="html" when-meta="includes.pdf-context"} [^11]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#generate-content) -:::: +[^12]: [Customize inventory layout](/guide/inventory/customize-inventory-layout.qmd#swap-between-views) + + + + diff --git a/site/guide/inventory/record-interdependencies.png b/site/guide/inventory/record-interdependencies.png deleted file mode 100644 index 9424c58b15..0000000000 Binary files a/site/guide/inventory/record-interdependencies.png and /dev/null differ diff --git a/site/guide/inventory/upstream-record.png b/site/guide/inventory/upstream-record.png deleted file mode 100644 index 096cf7605f..0000000000 Binary files a/site/guide/inventory/upstream-record.png and /dev/null differ diff --git a/site/guide/reporting/export-analytics.qmd b/site/guide/reporting/export-analytics.qmd index 5b7f382ca2..b0e3519013 100644 --- a/site/guide/reporting/export-analytics.qmd +++ b/site/guide/reporting/export-analytics.qmd @@ -36,5 +36,5 @@ Export analytics widgets as comma-delimited tables (`.csv`). [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) +[^2]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) diff --git a/site/guide/reporting/export-artifacts.qmd b/site/guide/reporting/export-artifacts.qmd index 1c358f5d6d..47580d321f 100644 --- a/site/guide/reporting/export-artifacts.qmd +++ b/site/guide/reporting/export-artifacts.qmd @@ -62,7 +62,7 @@ Export tracked model artifacts as comma-delimited tables (`.csv`). [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) +[^2]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) [^3]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts) diff --git a/site/guide/reporting/view-report-data.qmd b/site/guide/reporting/view-report-data.qmd index 1d91bccb2b..e97980147b 100644 --- a/site/guide/reporting/view-report-data.qmd +++ b/site/guide/reporting/view-report-data.qmd @@ -27,4 +27,4 @@ Review detailed data on your models or artifacts within the {{< var validmind.pl [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) \ No newline at end of file +[^2]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) \ No newline at end of file diff --git a/site/guide/reporting/working-with-analytics.qmd b/site/guide/reporting/working-with-analytics.qmd index 9decbbcd07..d5a7f4eb60 100644 --- a/site/guide/reporting/working-with-analytics.qmd +++ b/site/guide/reporting/working-with-analytics.qmd @@ -137,7 +137,7 @@ Rearrange report widgets on your analytics pages, including your custom pages:[^ [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) +[^2]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) [^3]: [Manage roles](/guide/configuration/manage-roles.qmd) diff --git a/site/guide/validation/_add-artifacts-on-documentation.qmd b/site/guide/validation/_add-artifacts-on-documentation.qmd index ecd4c4fe44..56e5f1f8d1 100644 --- a/site/guide/validation/_add-artifacts-on-documentation.qmd +++ b/site/guide/validation/_add-artifacts-on-documentation.qmd @@ -25,7 +25,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. When you are done, click **Add {Artifact Type}** where `{Artifact Type}` is the artifact type you want to add to submit the artifact. - Once created, you can then add supporting documentation to your artifact.^[[Manage attachments on artifacts](/guide/validation/add-manage-artifacts.qmd#manage-attachments)] + Once created, you can then upload attachments to your artifact.^[[Manage attachments on artifacts](/guide/validation/update-artifacts.qmd#manage-attachments)] :::: @@ -44,7 +44,7 @@ d. On the modal that opens, provide information for your artifact. e. When you are done, click **Add {Artifact Type}** where `{Artifact Type}` is the artifact type you want to add to submit the artifact. - Once created, you can then [add supporting documentation to your artifact](/guide/validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. + Once created, you can then [upload attachments to your artifact](/guide/validation/update-artifacts.qmd#manage-attachments){target="_blank"}. :::: diff --git a/site/guide/validation/_autogenerate-validation-issues.qmd b/site/guide/validation/_autogenerate-validation-issues.qmd index 805bd861a0..fe207f68ca 100644 --- a/site/guide/validation/_autogenerate-validation-issues.qmd +++ b/site/guide/validation/_autogenerate-validation-issues.qmd @@ -50,7 +50,7 @@ d. Approve, reject, or regenerate the suggested validation issues: ::: :::: {.content-visible when-format="html" when-meta="includes.compliance"} -e. After approving a validation issue, you can further customize it by clicking on the issue to edit fields such as owner, due date, and status.^[[Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd)] +e. After approving a validation issue, you can further customize it by clicking on the issue to edit fields such as owner, due date, and status.^[[Update artifacts](/guide/validation/update-artifacts.qmd)] :::: diff --git a/site/guide/validation/_track-artifact-resolution.qmd b/site/guide/validation/_track-artifact-resolution.qmd index 384082c022..844d65efa4 100644 --- a/site/guide/validation/_track-artifact-resolution.qmd +++ b/site/guide/validation/_track-artifact-resolution.qmd @@ -3,8 +3,6 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} -As you prepare your validation report, review open or past due artifacts, close resolved ones, or add a mitigation plan: - 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. 1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] @@ -19,7 +17,7 @@ a. Go through the open validation issues one-by-one: - **If the validation issue has been addressed** — - - Add any final comments to assess how the issue was resolved. + - Add any final comments to assess how the issue was resolved.^[[Comment on artifacts](/guide/validation/update-artifacts.qmd#comment-on-artifacts)] - Under **[status]{.smallcaps}**, select `Closed`. - **If part or all of the validation issue remains to be addressed** — @@ -42,7 +40,7 @@ a. Go through the open artifacts one-by-one: - **If the artifact has been addressed** — - - Add any final comments to assess how the issue was resolved. + - Add any final comments to assess how the issue was resolved.^[[Comment on artifacts](/guide/validation/update-artifacts.qmd#comment-on-artifacts)] - Under **[status]{.smallcaps}**, select `Closed`. - **If part or all of the artifact remains to be addressed** — diff --git a/site/guide/validation/_view-all-artifacts.qmd b/site/guide/validation/_view-all-artifacts.qmd index cd600c0956..e224e27f54 100644 --- a/site/guide/validation/_view-all-artifacts.qmd +++ b/site/guide/validation/_view-all-artifacts.qmd @@ -11,7 +11,7 @@ In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** - Filter this list to include only validation issues you want to see,^[[Filter and sort artifacts](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts)] or toggle visibilty for column headers.^[[Customize artifact layouts](/guide/validation/customize-artifact-layouts.qmd)] -- Click on any validation issue for more information, including the proposed remediation plan and any supporting attachments.^[[Manage attachments on artifacts](/guide/validation/add-manage-artifacts.qmd#manage-attachments)] +- Click on any validation issue for more information, including the proposed remediation plan and any supporting attachments.^[[Manage attachments on artifacts](/guide/validation/update-artifacts.qmd#manage-attachments)] Attachments are listed with the following information: @@ -53,7 +53,7 @@ To view a list of validation issues across all records: [Filter this list](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts){target="_blank"} to include only validation issues you want to see, or [toggle visibilty for column headers](/guide/validation/customize-artifact-layouts.qmd){target="_blank"}. -1. Click on any validation issue for more information, including the proposed remediation plan and [any supporting attachments](/guide/validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. +1. Click on any validation issue for more information, including the proposed remediation plan and [any supporting attachments](/guide/validation/update-artifacts.qmd#manage-attachments){target="_blank"}. Attachments are listed with the following information: diff --git a/site/guide/validation/add-manage-artifacts.qmd b/site/guide/validation/add-manage-artifacts.qmd deleted file mode 100644 index 13e709f57b..0000000000 --- a/site/guide/validation/add-manage-artifacts.qmd +++ /dev/null @@ -1,148 +0,0 @@ ---- -# Copyright © 2023-2026 ValidMind Inc. All rights reserved. -# Refer to the LICENSE file in the root of this repository for details. -# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -title: "Add and manage artifacts" -date: last-modified -aliases: - - add-update-model-findings.html - - add-manage-model-findings.html - - /guide/model-validation/add-manage-artifacts.html ---- - -Add artifacts at the record or documentation section level, update your artifacts to include proposed remediation plans and supporting documentation, or delete artifacts that no longer need to be tracked. - -{{< include /guide/inventory/_reference-field-values.qmd >}} - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] The record you want to add or manage artifacts for is registered in the inventory.[^1] -- [x] Development documentation is completed or in progress for your record.[^2] -- [x] Artifact statuses have been set up for use with artifacts.[^3] -- [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] - -::: - -## Add artifacts on documentation - -{{< include _add-artifacts-on-documentation.qmd >}} - -## Add artifacts on validation reports - -While assessing a record's compliance,[^5] you can add artifacts as you complete your validation report: - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a record or find your record by applying a filter or searching for it.[^6] - -3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^7] - -4. Click on a Validation type file.[^8] - - Expand any subsection of the validation report you have attached evidence for to autogenerate validation issues or manually link artifacts to your report: - -::: {.panel-tabset} - -### Autogenerate validation issues - -{{< include _autogenerate-validation-issues.qmd >}} - -### Manually add artifacts - -{{< include _link-artifacts-to-reports.qmd >}} - -::: - - - -## Update artifacts - -As artifacts get resolved or require other changes during the validation process, you can update them: - -1. Locate the artifact you want to update.[^9] - -2. Click on a field to make changes. - - You can also add comments to an artifact. - -::: {.callout-important} -Most updates are applied immediately but you must click **Save** to make changes to the artifact title, description, proposed remediation plan, and attachments effective. -::: - -### Track artifact resolution - -{{< include _track-artifact-resolution.qmd >}} - - - -### Manage attachments on artifacts - -After an artifact is created, you're able to add supporting documentation to it. - -::: {.panel-tabset} - -#### Add attachments to artifacts - -::: {.callout} -Uploaded files must be less than 50 MB each in size. -::: - -1. On the artifacts detail page, click on the **[attachments]{.smallcaps}** header. - -{{< include /guide/inventory/_add-attachments.qmd >}} - -#### Remove attachments from artifacts - -1. On the artifacts detail page, click on the **[attachments]{.smallcaps}** header. - -{{< include /guide/inventory/_remove-attachments.qmd >}} - -::: - -## Delete artifacts - -::: {.callout-important title="Artifact deletion is permanent."} -- While artifact deletion will be logged under your {{< fa wifi >}} Activity,[^10] deleted artifacts cannot be retrieved. -- Deleting an artifact will also remove it from any validation reports[^11] it was previously attached to. - -::: - -If you logged an artifact in error or otherwise no longer need to track that artifact, you can delete it: - -1. Locate the artifact you want to delete.[^12] - -2. On the artifact's detail page, click **{{< fa trash-can>}} Delete {Artifact Type}**[^13] in the right sidebar. - -3. Click **Yes, Delete {Artifact Type}** to confirm permanent deletion of that artifact. - - - - -[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) - -[^2]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) - -[^3]: [Manage artifact types](manage-artifact-types.qmd#manage-artifact-type-statuses) - -[^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^5]: [Assess compliance](/guide/validation/assess-compliance.qmd#link-artifacts-to-reports) - -[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) - -[^7]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) - -[^8]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd#validation-overview) - -[^9]: [View and filter artifacts](view-filter-artifacts.qmd) - -[^10]: [View record activity](/guide/inventory/view-record-activity.qmd) - -[^11]: [Link artifacts to reports](/guide/validation/assess-compliance.qmd#link-artifacts-to-reports) - -[^12]: [View and filter artifacts](view-filter-artifacts.qmd) - -[^13]: [Manage artifact types](manage-artifact-types.qmd) \ No newline at end of file diff --git a/site/guide/validation/customize-artifact-layouts.qmd b/site/guide/validation/customize-artifact-layouts.qmd index 150fc3e61f..57398ec6f5 100644 --- a/site/guide/validation/customize-artifact-layouts.qmd +++ b/site/guide/validation/customize-artifact-layouts.qmd @@ -83,7 +83,7 @@ You can save custom artifact configurations as a view to reapply at any time for [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](add-manage-artifacts.qmd) +[^2]: [Log artifacts](log-artifacts.qmd) [^3]: [Manage artifact fields](manage-artifact-fields.qmd) diff --git a/site/guide/validation/customize-artifact-overview-page.qmd b/site/guide/validation/customize-artifact-overview-page.qmd index 1d5a5d507b..b5aa01d4a2 100644 --- a/site/guide/validation/customize-artifact-overview-page.qmd +++ b/site/guide/validation/customize-artifact-overview-page.qmd @@ -12,7 +12,7 @@ aliases: Configure what and how artifact fields appear when you pull up artifacts logged on records. :::{.callout title="Changes are automatically saved to your account and do not affect other users."} -Customizations will apply to all artifacts in your inventory. +Customizations will apply to all artifacts of the same type in your inventory. ::: @@ -26,32 +26,82 @@ Customizations will apply to all artifacts in your inventory. ::: -## Show or hide fields - -::: {.callout title="Only custom artifact fields can be shown or hidden."} -Default fields will always appear on your artifact overview pages and are represented by by faded cells. Their positions cannot be adjusted. -::: +## Organize, show, or hide artifact fields 1. Open an artifact logged on any record.[^3] -2. Click on **{{< fa wrench >}} Customize Layout**. +2. On the artifact details page, click the **Artifact Fields** tab. + +3. 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 artifact fields[^4] that appear: + + - To hide fields or field groups from view: Hover over an artifact field, then click {{< fa eye >}}. + - To show previously hidden fields or field groups: Hover over an artifact 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 artifact 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 artifact type. + + ::: -3. On the Customize Layout modal that appears, configure the artifact fields[^4] that appear: +### Highlight artifact fields - - Toggle optional artifact 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. +To pin artifact fields to the **Overview** tab for quick access: - To narrow down your list of fields, search via the **{{< fa filter >}} Filter** bar. +1. Open an artifact logged on any record.[^6] -4. Click **Save Layout** to apply your changes to all record overview pages. +2. On the artifact details page, select either the **Overview** or **Artifact Fields** tab: + + ::: {.panel-tabset} + + #### **Overview** tab + + - 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**. + + #### **Artifact Fields** tab + + Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change fields display**. + + ::: + +3. Hover over an artifact 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**. + +4. Confirm that the right artifact fields are pinned to the **Overview** tab with the correct highlight tone. [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](add-manage-artifacts.qmd) +[^2]: [Log artifacts](log-artifacts.qmd) [^3]: [View and filter artifacts](view-filter-artifacts.qmd) [^4]: [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd#artifact-field-types) + +[^5]: [Highlight artifact fields](#highlight-artifact-fields) + +[^6]: [View and filter artifacts](view-filter-artifacts.qmd) diff --git a/site/guide/validation/log-artifacts.qmd b/site/guide/validation/log-artifacts.qmd new file mode 100644 index 0000000000..c30de6a5ef --- /dev/null +++ b/site/guide/validation/log-artifacts.qmd @@ -0,0 +1,72 @@ +--- +# Copyright © 2023-2026 ValidMind Inc. All rights reserved. +# Refer to the LICENSE file in the root of this repository for details. +# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial +title: "Log artifacts" +date: last-modified +aliases: + - add-update-model-findings.html + - add-manage-model-findings.html + - /guide/model-validation/add-manage-artifacts.html + - add-manage-artifacts.html +--- + +Log artifacts at the record or documentation section level during your validation process. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] The record you want to log artifacts on is registered in the inventory.[^1] +- [x] Development documentation is completed or in progress for your record.[^2] +- [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] + +::: + +## Add artifacts on documentation + +{{< include _add-artifacts-on-documentation.qmd >}} + +## Add artifacts on validation reports + +While assessing a record's compliance,[^4] you can add artifacts as you complete your validation report: + +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Select a record or find your record by applying a filter or searching for it.[^5] + +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^6] + +4. Click on a Validation type file.[^7] + + Expand any subsection of the validation report you have attached evidence for to autogenerate validation issues or manually link artifacts to your report: + +::: {.panel-tabset} + +### Autogenerate validation issues + +{{< include _autogenerate-validation-issues.qmd >}} + +### Manually add artifacts + +{{< include _link-artifacts-to-reports.qmd >}} + +::: + + + + +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) + +[^2]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) + +[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^4]: [Assess compliance](/guide/validation/assess-compliance.qmd#link-artifacts-to-reports) + +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^6]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) + +[^7]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd#validation-overview) diff --git a/site/guide/validation/update-artifacts.qmd b/site/guide/validation/update-artifacts.qmd new file mode 100644 index 0000000000..34894b1c6f --- /dev/null +++ b/site/guide/validation/update-artifacts.qmd @@ -0,0 +1,145 @@ +--- +# Copyright © 2023-2026 ValidMind Inc. All rights reserved. +# Refer to the LICENSE file in the root of this repository for details. +# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial +title: "Update artifacts" +date: last-modified +--- + +Update or resolve artifacts as you validate your records, or delete artifacts that no longer need to be tracked. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] There are artifacts logged on any record.[^1] +- [x] Artifact statuses have been set up for use with artifacts.[^2] +- [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] + +::: + +## Edit fields on artifacts + +1. Locate the artifact you want to edit fields for.[^4] + +2. On the artifact details page: + + :::: {.panel-tabset} + + ### **Overview** tab + + Select the **Overview** tab to: + + - Click on highlighted fields to make changes. + - Click the **Description** field text block to make edits. + - [validation issues only]{.smallercaps .pink} Click on the **Proposed Remediation Plan** field text block to make edits. + - [validation issues only]{.smallercaps .pink} Click on the **Attachments** field header to manage files.[^5] + - Click on the **Comments** field text block to add comments to the artifact. + + ### **Artifact Fields** tab + + Select the **Artifact Fields** tab to click on additional fields to make changes: + + - Enter keywords into the **{{< fa magnifying-glass >}} Search fields by title** bar to narrow down your list of fields to the field you want to edit. + - Click on an attachment field header to manage files for that field.[^6] + + ::: {.callout title="Calculation field types are auto-computed and read-only."} + To modify how these fields are calculated, update their configuration: [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd#artifact-field-types) + + ::: + + ### Right sidebar + + Click on the core fields in the right sidebar to make changes. + + :::: + +3. Click **Save** to apply your changes to the field. + +::: {.callout title="You can reference artifact field values in your content blocks within documents."} +Learn more: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#reference-field-values) + +::: + +#### Manage attachments on artifacts + + +After an artifact is created, you can upload attachments as supporting documentation: + +::: {.panel-tabset} + +#### Add attachments to artifacts + +::: {.callout} +Uploaded files must be less than 50 MB each in size. +::: + +1. Click on the header of your attachment field. + +{{< include /guide/inventory/_add-attachments.qmd >}} + +#### Remove attachments from artifacts + +1. Click on the header of your attachment field. + +{{< include /guide/inventory/_remove-attachments.qmd >}} + +::: + +## Comment on artifacts + +1. Locate the artifact you want comment on.[^7] + +2. On the artifact details page, select the **Overview** tab. + +3. Click on the **Comments** field text block. + +4. Enter your comment and click **Submit** to save the comment. + +## Track artifact resolution + +As you prepare validation reports, review logged artifacts and close any artifacts that have been resolved: + +{{< include _track-artifact-resolution.qmd >}} + +## Delete artifacts + +::: {.callout-important title="Artifact deletion is permanent."} +- While artifact deletion will be logged under your {{< fa wifi >}} Activity,[^8] deleted artifacts cannot be retrieved. +- Deleting an artifact will also remove it from any validation reports[^9] it was previously attached to. + +::: + +If you logged an artifact in error or otherwise no longer need to track that artifact, you can delete it: + +1. Locate the artifact you want to delete.[^10] + +2. On the artifact's detail page, click **{{< fa trash-can>}} Delete {Artifact Type}**[^11] in the right sidebar. + +3. Click **Yes, Delete {Artifact Type}** to confirm permanent deletion of that artifact. + + + + +[^1]: [Log artifacts](log-artifacts.qmd) + +[^2]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd#manage-artifact-type-statuses) + +[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^4]: [View and filter artifacts](view-filter-artifacts.qmd) + +[^5]: [Manage attachments on artifacts](#manage-attachments) + +[^6]: [Manage attachments on artifacts](#manage-attachments) + +[^7]: [View and filter artifacts](view-filter-artifacts.qmd) + +[^8]: [View record activity](/guide/inventory/view-record-activity.qmd) + +[^9]: [Link artifacts to reports](/guide/validation/assess-compliance.qmd#link-artifacts-to-reports) + +[^10]: [View and filter artifacts](view-filter-artifacts.qmd) + +[^11]: [Manage artifact types](manage-artifact-types.qmd) \ No newline at end of file diff --git a/site/guide/validation/view-filter-artifacts.qmd b/site/guide/validation/view-filter-artifacts.qmd index c255f36d4c..b5675c9e6b 100644 --- a/site/guide/validation/view-filter-artifacts.qmd +++ b/site/guide/validation/view-filter-artifacts.qmd @@ -144,13 +144,13 @@ Changes are automatically saved to your account and do not affect other users. [^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^3]: [Add and manage artifacts](add-manage-artifacts.qmd) +[^3]: [Log artifacts](log-artifacts.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) [^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^6]: [Add and manage artifacts](add-manage-artifacts.qmd#manage-attachments) +[^6]: [Update artifacts](update-artifacts.qmd#manage-attachments) [^7]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) diff --git a/site/guide/validation/working-with-artifacts.qmd b/site/guide/validation/working-with-artifacts.qmd index ddf6faba54..ddbb30535f 100644 --- a/site/guide/validation/working-with-artifacts.qmd +++ b/site/guide/validation/working-with-artifacts.qmd @@ -9,12 +9,13 @@ listing: type: grid max-description-length: 250 sort: false - grid-columns: 2 + grid-columns: 3 fields: [title, description] contents: - view-filter-artifacts.qmd - customize-artifact-layouts.qmd - - add-manage-artifacts.qmd + - log-artifacts.qmd + - update-artifacts.qmd - customize-artifact-overview-page.qmd aliases: - work-with-model-findings.html @@ -60,18 +61,16 @@ validation results residual analysis : Investigating the errors or discrepancies between predicted and actual outcomes. - ::: :::: - - -## Manage artifacts +## Work with artifacts :::{#artifacts} ::: + ## What's next - [Preparing validation reports](preparing-validation-reports.qmd) \ No newline at end of file diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd index 50f82770a1..ac5d47bc71 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -70,7 +70,7 @@ vi. Click **Save Draft** to save your blank workflow, and then [configure your w ::: {.callout title="Please note that only one workflow can be configured to initiate on registration for each type of artifact."}
- [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd){.button} + [Log artifacts](/guide/validation/log-artifacts.qmd){.button} ::: diff --git a/site/guide/workflows/_initiate-workflows.qmd b/site/guide/workflows/_initiate-workflows.qmd index 7ecc88d7d8..3ebf2cf1d1 100644 --- a/site/guide/workflows/_initiate-workflows.qmd +++ b/site/guide/workflows/_initiate-workflows.qmd @@ -17,7 +17,7 @@ To initiate workflows manually:[^initiate-workflows] 1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your record, locate the Workflows section. +1. On the record details page, click the **Workflows** tab. 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. @@ -30,7 +30,7 @@ To initiate workflows manually:[^initiate-workflows] #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the Workflows section. +1. On the artifact details page,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] click the **Workflows** tab. 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. @@ -66,7 +66,7 @@ To initiate workflows manually: 1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your record, locate the Workflows section. +1. On the record details page, click the **Workflows** tab. 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. @@ -79,7 +79,7 @@ To initiate workflows manually: #### On artifacts -1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the Workflows section. +1. On the [artifact details page](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, click the **Workflows** tab. 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. diff --git a/site/guide/workflows/_review-workflow-history.qmd b/site/guide/workflows/_review-workflow-history.qmd index cf1e0e979a..870a5ef5a9 100644 --- a/site/guide/workflows/_review-workflow-history.qmd +++ b/site/guide/workflows/_review-workflow-history.qmd @@ -13,7 +13,7 @@ Review timelines of workflows running or previously run on a specific record or 2. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -3. On the landing page of your record, locate the Workflows section that shows a timeline of workflows associated with that record. +3. On the record details page, click the **Workflows** tab to view a timeline of workflows associated with that record. Use the buttons or keyboard shortcuts[^timeline-shortcuts] to control the timeline: @@ -39,7 +39,7 @@ If workflows are running or have previously run on your record, you can: #### On artifacts -On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the Workflows section that shows a timeline of workflows associated with that artifact. +On the artifact details page,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] click the **Workflows** tab to view a timeline of workflows associated with that artifact. Use the buttons or keyboard shortcuts[^timeline-shortcuts] to control the timeline: @@ -111,7 +111,7 @@ Review timelines of workflows running or previously run: 2. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -3. On the landing page of your record, locate the Workflows section that shows a timeline of workflows associated with that record. +3. On the record details page, click the **Workflows** tab to view a timeline of workflows associated with that record. If workflows are running or have previously run on your record, you can: @@ -129,7 +129,7 @@ Review timelines of workflows running or previously run: #### On artifacts -On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the Workflows section that shows a timeline of workflows associated with that artifact. +On the [artifact details page](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, click the **Workflows** tab to view a timeline of workflows associated with that artifact. If workflows are running or have previously run on your artifact, you can: diff --git a/site/guide/workflows/manage-workflows.qmd b/site/guide/workflows/manage-workflows.qmd index 026d027a1c..e4cde3c1c9 100644 --- a/site/guide/workflows/manage-workflows.qmd +++ b/site/guide/workflows/manage-workflows.qmd @@ -124,7 +124,7 @@ To adjust the expected end date for a workflow: [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) +[^2]: [Log artifacts](/guide/validation/log-artifacts.qmd) [^3]: [Configure workflows](configure-workflows.qmd) diff --git a/site/reference/vm-api.qmd b/site/reference/vm-api.qmd index 12a0bac64b..e9e1cf0497 100644 --- a/site/reference/vm-api.qmd +++ b/site/reference/vm-api.qmd @@ -22,9 +22,9 @@ bread-crumbs: false }}]() to continue. ::: 1. Select the name of your record you registered earlier to open up the record details page. -2. On the landing page of your record, confirm that the new field that you added is present. +2. On the details page of your record, confirm that the new field that you added is present. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd b/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd index 728fc2488f..ecf65ce2b2 100644 --- a/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd +++ b/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd @@ -189,7 +189,7 @@ Review workflows associated with your records or artifacts: :::: {.slideover--b .auto-collapse-10} ::: {.tc} -**View record workflow** +**View active workflows** ::: 1. Select the name of your record you registered for this course to open up the record details page. diff --git a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd index e1de109313..20b484f621 100644 --- a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd +++ b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd @@ -354,7 +354,7 @@ Run workflows manually ::: 1. Select the name of your model you registered for this course to open up the model details page. -2. On the landing page of your model, locate the Workflows section. +2. On the landing page of your model, click the **Workflows** tab. 3. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. 4. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you configured earlier, then select **Run Now** under **[workflow start]{.smallcaps}**. 5. Click **{{< fa arrow-right >}} Run Workflow Now** to confirm. diff --git a/site/training/validator-fundamentals/finalizing-validation-reports.qmd b/site/training/validator-fundamentals/finalizing-validation-reports.qmd index 83efc88156..5f7ca5093b 100644 --- a/site/training/validator-fundamentals/finalizing-validation-reports.qmd +++ b/site/training/validator-fundamentals/finalizing-validation-reports.qmd @@ -314,7 +314,7 @@ Add more artifacts ::: ::: {.tc} -[Learn more ...](/guide/validation/add-manage-artifacts.qmd){.button target="_blank"} +[Learn more ...](/guide/validation/log-artifacts.qmd){.button target="_blank"} ::: @@ -409,7 +409,7 @@ Track issue resolution ::: ::: {.tc} -[Learn more ...](/guide/validation/add-manage-artifacts.qmd#track-issue-resolution){.button target="_blank"} +[Learn more ...](/guide/validation/update-artifacts.qmd#track-artifact-resolution){.button target="_blank"} :::
Try it **live** on the next pages. {{< fa hand-point-right >}}