diff --git a/README.md b/README.md index 2c188de20c..8de8105fa5 100644 --- a/README.md +++ b/README.md @@ -218,7 +218,7 @@ When constructing filepaths, including while using [Quarto's Includes](https://q | Correct | Incorrect | |---|---| -| `[Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)` | `[Register models in the inventory](../../register-models-in-inventory.qmd)` | +| `[Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)` | `[Register records in the inventory](../../register-records-in-inventory.qmd)` | ### Column layouts diff --git a/internal/templates/single-source/_guides-vs-training.qmd b/internal/templates/single-source/_guides-vs-training.qmd index b155667e0e..1f196f40fe 100644 --- a/internal/templates/single-source/_guides-vs-training.qmd +++ b/internal/templates/single-source/_guides-vs-training.qmd @@ -10,20 +10,20 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +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. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. +1. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. :::: - :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model by clicking on it or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models). +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. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. -1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. +:::: -:::: \ No newline at end of file diff --git a/site/_quarto.yml b/site/_quarto.yml index 294694a48a..c6e784f422 100644 --- a/site/_quarto.yml +++ b/site/_quarto.yml @@ -199,13 +199,12 @@ website:
  • Configuration
  • Integrations
  • Workflows
    • +
  • Inventory
    • - + right: - text: |
    Community
    @@ -251,7 +258,6 @@ website:
  • Blog
    • - right: | format: html: diff --git a/site/about/contributing/style-guide/conventions.qmd b/site/about/contributing/style-guide/conventions.qmd index 543aea66ee..5b24fac015 100644 --- a/site/about/contributing/style-guide/conventions.qmd +++ b/site/about/contributing/style-guide/conventions.qmd @@ -29,8 +29,8 @@ While the {{< var vm.product >}} community spans far and wide, its heart finds i | Correct | Incorrect | |------|-----| -| Register models in the inventory | Inventory model registration | -| Working with the model inventory | Use the model inventory | +| Register records in the inventory | Inventory record registration | +| Working with the inventory | Use the inventory | | Developer reference | Articles for developers | : **Titles** examples {.hover} @@ -173,7 +173,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o - [^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) + [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Manage model stages](manage-model-stages.qmd) @@ -187,15 +187,15 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o You can use Quarto's ability to display conditional content[^7] to do both in the same file: ```markdown - To view model activity: + To view record activity: :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - 1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] + 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. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. + 1. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. :::: @@ -203,12 +203,14 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - 1. Select a model by clicking on it or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models). + 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. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. - 1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. :::: + ``` - | Inline links in training | Footnotes in user guides | + | Inline links in training | Footnotes in user guides | |------|-----| | ![Example of inline links in training materials](training_inline-links.png){fig-alt="A screenshot showing an example of inline links in training materials" .screenshot group="links"} | ![Example of margin footnotes in a user guide](user-guide_footenotes.png){fig-alt="A screenshot showing an example of margin footnotes in a user guide" .screenshot group="links"} | : **Inline vs footnotes links** examples {.hover} diff --git a/site/about/glossary/_attestation.qmd b/site/about/glossary/_attestation.qmd index 59310afde7..2ca29bdacf 100644 --- a/site/about/glossary/_attestation.qmd +++ b/site/about/glossary/_attestation.qmd @@ -6,7 +6,7 @@ attestation : A formal process where attestation participants certify key model information at a specific time. Attestation is part of your audit trail and confirms that governance, documentation, and control requirements are met. attestation instance -: The invocation of the attestation process on the {{< var validmind.platform >}}. Created when the attestation is triggered by the schedule you set up, it includes a snapshot with model activity and artifacts, questionnaire responses and review status, forming a full record of the review and approval process. +: The invocation of the attestation process on the {{< var validmind.platform >}}. Created when the attestation is triggered by the schedule you set up, it includes a snapshot with record activity and artifacts, questionnaire responses and review status, forming a full record of the review and approval process. attestation participant : A user who participates in the attestation workflow as a submitter, reviewer, or approver. Submitters are assigned from model stakeholders; reviewers and approvers are assigned from organizational roles. diff --git a/site/about/glossary/_models.qmd b/site/about/glossary/_models.qmd index ca9a222101..0bc6ee8e3f 100644 --- a/site/about/glossary/_models.qmd +++ b/site/about/glossary/_models.qmd @@ -47,10 +47,10 @@ For example, consequences of unmitigated model risk can include adverse outcomes model risk management (MRM) : A structured approach to identifying, assessing, mitigating, and monitoring risks arising from the use of quantitative and qualitative models within an organization. Ensures that models are developed, validated, and used appropriately, with robust controls in place. Encompasses practices such as maintaining a model inventory, conducting periodic validations, and ensuring proper documentation. -model vendor -: A company that develops, documents, and sells models to financial institutions. +model vendor, record vendor +: A company that develops, documents, and sells models or records to financial institutions. -vendor model -: A model created by an external source, such as a model vendor. +vendor model, vendor record +: A model or record created by an external source, such as a vendor. diff --git a/site/about/overview-model-risk-management.qmd b/site/about/overview-model-risk-management.qmd index 5be5ae05f0..a37d5d7a71 100644 --- a/site/about/overview-model-risk-management.qmd +++ b/site/about/overview-model-risk-management.qmd @@ -215,7 +215,7 @@ By integrating these features, {{< var vm.product >}} provides a comprehensive s -[^1]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd) +[^1]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) [^2]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd) diff --git a/site/about/use-cases/eu-ai-act.qmd b/site/about/use-cases/eu-ai-act.qmd index fa4da61a3c..9616a96761 100644 --- a/site/about/use-cases/eu-ai-act.qmd +++ b/site/about/use-cases/eu-ai-act.qmd @@ -226,7 +226,7 @@ Integrate all components into a complete compliance workflow addressing Articles **EUR-Lex:**
    [EU AI Act (Regulation (EU) 2024/1689)](https://eur-lex.europa.eu/eli/reg/2024/1689) -[^2]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) +[^2]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) [^3]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) @@ -255,7 +255,7 @@ Integrate all components into a complete compliance workflow addressing Articles [^15]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) -[^16]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd) +[^16]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) [^17]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) diff --git a/site/about/use-cases/sr-11-7.qmd b/site/about/use-cases/sr-11-7.qmd index 6ca28f27af..f97d5ed696 100644 --- a/site/about/use-cases/sr-11-7.qmd +++ b/site/about/use-cases/sr-11-7.qmd @@ -203,9 +203,9 @@ Establish governance framework aligned to SR 11-7. **Board of Governors of the Federal Reserve System:**
    [SR 11-7: Guidance on Model Risk Management](https://www.federalreserve.gov/supervisionreg/srletters/sr1107.htm) -[^2]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) +[^2]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) -[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd) +[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) [^4]: [Working with document templates](/guide/templates/working-with-document-templates.qmd) diff --git a/site/about/use-cases/ss1-23.qmd b/site/about/use-cases/ss1-23.qmd index dd2b1b4918..839ac85387 100644 --- a/site/about/use-cases/ss1-23.qmd +++ b/site/about/use-cases/ss1-23.qmd @@ -210,9 +210,9 @@ Document your proportionality assessment and how it influences your MRM framewor **Bank of England:**
    [SS1/23 – Model risk management principles for banks](https://www.bankofengland.co.uk/prudential-regulation/publication/2023/may/model-risk-management-principles-for-banks-ss) -[^2]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) +[^2]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) -[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd) +[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) diff --git a/site/developer/model-documentation/install-and-initialize-validmind-for-r.qmd b/site/developer/model-documentation/install-and-initialize-validmind-for-r.qmd index 3398550a75..c83aa193a1 100644 --- a/site/developer/model-documentation/install-and-initialize-validmind-for-r.qmd +++ b/site/developer/model-documentation/install-and-initialize-validmind-for-r.qmd @@ -29,7 +29,7 @@ Use the ValidMind R package to document and validate models built in R. The pack - [x] {{< var link.login >}} - [x] The model you want to connect to is registered in the model inventory.[^1] - [x] The model document has a template applied.[^2] -- [x] You are the model owner, model validator, or another model stakeholder with write access to the model's documents.[^3] +- [x] You are the record owner, model validator, or another model stakeholder with write access to the model's documents.[^3] ::: @@ -220,8 +220,8 @@ pip install -U numba -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Working with templates](/guide/templates/working-with-document-templates.qmd) -[^3]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders) +[^3]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders) diff --git a/site/developer/model-documentation/install-and-initialize-validmind-library.qmd b/site/developer/model-documentation/install-and-initialize-validmind-library.qmd index 8238cf968a..408fa86643 100644 --- a/site/developer/model-documentation/install-and-initialize-validmind-library.qmd +++ b/site/developer/model-documentation/install-and-initialize-validmind-library.qmd @@ -31,7 +31,7 @@ listing: - [x] {{< var link.login >}} - [x] The model you want to connect to is registered in the model inventory.[^1] - [x] The model document has a template applied.[^2] -- [x] You are the model owner, model validator, or another model stakeholder with write access to the model's documents.[^3] +- [x] You are the record owner, model validator, or another model stakeholder with write access to the model's documents.[^3] ::: {.callout} The {{< var validmind.developer >}} requires access to the data sources where relevant datasets and model files are stored in order to help you run tests. @@ -74,6 +74,8 @@ A template must already be applied to your selected document to populate test re ::: + + ### Install the {{< var vm.developer >}} To install the {{< var vm.developer >}}: @@ -109,6 +111,8 @@ After you run the code snippet in your environment, the {{< var validmind.develo ::: + + ## Upgrade the {{< var validmind.developer >}} After installing the {{< var validmind.developer >}},[^8] you'll want to periodically make sure you are on the latest version to access any new features and other enhancements: @@ -142,17 +146,17 @@ Version: 2.11.0 -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Working with templates](/guide/templates/working-with-document-templates.qmd) -[^3]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders) +[^3]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders) -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^5]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) -[^6]: [Upgrade the {{< var validmind.developer >}}](#upgrade-the) +[^6]: [Upgrade the {{< var validmind.developer >}}](#upgrade-validmind) [^7]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) diff --git a/site/developer/model-documentation/store-credentials-in-env-file.qmd b/site/developer/model-documentation/store-credentials-in-env-file.qmd index 48dd9cc500..9b496dd145 100644 --- a/site/developer/model-documentation/store-credentials-in-env-file.qmd +++ b/site/developer/model-documentation/store-credentials-in-env-file.qmd @@ -39,7 +39,7 @@ Keeping model credentials in a separate file also allows for precise access cont - [x] {{< var link.login >}} - [x] The model is registered in the model inventory.[^1] -- [x] You are the model owner, model validator, or another model stakeholder with sufficient permissions to perform the tasks in this guide.[^2] +- [x] You are the record owner, model validator, or another model stakeholder with sufficient permissions to perform the tasks in this guide.[^2] ::: {.callout} Before you follow the steps on this page, we recommend that you first complete our introductory guide on how to [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd). @@ -153,11 +153,11 @@ c. Run the cell. -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders) +[^2]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders) -[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^4]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) @@ -188,8 +188,8 @@ c. Run the cell. [^6]: [Use credentials in your Jupyter Notebook](#use-credentials-in-your-jupyter-notebook) -[^7]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#install-the) +[^7]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#install-validmind) [^8]: [Enable monitoring](/guide/monitoring/enable-monitoring.qmd) -[^9]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#install-the) +[^9]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd#upgrade-validmind) diff --git a/site/faq/_faq-attachments.qmd b/site/faq/_faq-attachments.qmd index 727ecae416..a37ad2d71b 100644 --- a/site/faq/_faq-attachments.qmd +++ b/site/faq/_faq-attachments.qmd @@ -4,7 +4,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ## Can we attach files to models, artifacts, or documents? -Yes, attachment type inventory fields are available for custom use.^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)] Once created, attachment type fields allow you to upload supporting files to your model. +Yes, attachment type inventory fields are available for custom use.^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)] Once created, attachment type fields allow you to upload supporting files to your model. - Out-of-the-box functionality is included for attaching files to model artifacts. - You can also attach images to document content blocks and comments. diff --git a/site/faq/faq-collaboration.qmd b/site/faq/faq-collaboration.qmd index 4cdbaaedf0..048a8634d3 100644 --- a/site/faq/faq-collaboration.qmd +++ b/site/faq/faq-collaboration.qmd @@ -14,10 +14,10 @@ listing: sort: false fields: [title, description] contents: - - ../guide/model-inventory/view-model-activity.qmd + - ../guide/inventory/view-record-activity.qmd - ../guide/model-documentation/collaborate-with-others.qmd - ../guide/workflows/working-with-workflows.qmd -categories: ["real-time collaboration", "documents","documentation", "model activity", "auditing", "workflows", "model lifecycle", "validmind platform"] +categories: ["real-time collaboration", "documents","documentation", "record activity", "auditing", "workflows", "model lifecycle", "validmind platform"] --- {{< include _faq-activity.qmd >}} diff --git a/site/faq/faq-inventory.qmd b/site/faq/faq-inventory.qmd index 68951833eb..1aa5bf9ccc 100644 --- a/site/faq/faq-inventory.qmd +++ b/site/faq/faq-inventory.qmd @@ -14,10 +14,10 @@ listing: sort: false fields: [title, description] contents: - - ../guide/model-inventory/view-model-activity.qmd - - ../guide/model-inventory/working-with-model-inventory.qmd - - ../guide/model-inventory/managing-model-inventory.qmd -categories: ["model activity", "model registration", "model inventory", "customization", "model stages", "model interdependencies", "auditing", "exports", "validmind platform"] + - ../guide/inventory/view-record-activity.qmd + - ../guide/inventory/working-with-the-inventory.qmd + - ../guide/inventory/managing-the-inventory.qmd +categories: ["record activity", "model registration", "model inventory", "customization", "model stages", "model interdependencies", "auditing", "exports", "validmind platform"] --- {{< include _faq-activity.qmd >}} @@ -69,12 +69,12 @@ By default, the [{{< fa code >}} Developer]{.bubble} role has sufficient permiss -[^1]: [Register models in the inventory](/guide/model-inventory/working-with-model-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/working-with-the-inventory.qmd) [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^3]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) +[^3]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) -[^4]: [Archive and delete models](/guide/model-inventory/archive-delete-models.qmd) +[^4]: [Archive and delete models](/guide/inventory/archive-delete-records.qmd) -[^5]: [Configure model interdependencies](/guide/model-inventory/configure-model-interdependencies.qmd) \ No newline at end of file +[^5]: [Configure model interdependencies](/guide/inventory/configure-record-interdependencies.qmd) \ No newline at end of file diff --git a/site/faq/faq-privacy.qmd b/site/faq/faq-privacy.qmd index 87a7d2597a..79644eb4e9 100644 --- a/site/faq/faq-privacy.qmd +++ b/site/faq/faq-privacy.qmd @@ -18,8 +18,8 @@ listing: contents: - ../about/deployment/deployment-options.qmd - ../about/fine-print/data-privacy-policy.qmd - - ../guide/model-inventory/view-model-activity.qmd -categories: ["data handling", "privacy", "confidentiality", "model activity", "auditing", "validmind platform", "validmind library"] + - ../guide/inventory/view-record-activity.qmd +categories: ["data handling", "privacy", "confidentiality", "record activity", "auditing", "validmind platform", "validmind library"] --- ## How does {{< var vm.product >}} handle the processing of PII? diff --git a/site/faq/faq-testing.qmd b/site/faq/faq-testing.qmd index 42ddf51e84..dcf8a4cbc0 100644 --- a/site/faq/faq-testing.qmd +++ b/site/faq/faq-testing.qmd @@ -113,7 +113,7 @@ Check out our introductory series — [**{{< var vm.product >}} for model valida [^11]: [Manage roles](/guide/configuration/manage-roles.qmd) -[^12]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) +[^12]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) [^13]: [Assess compliance](/guide/model-validation/assess-compliance.qmd#link-validator-evidence) @@ -121,4 +121,4 @@ Check out our introductory series — [**{{< var vm.product >}} for model valida [^15]: [Manage roles](/guide/configuration/manage-roles.qmd) -[^16]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) \ No newline at end of file +[^16]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) \ No newline at end of file diff --git a/site/faq/faq-workflows.qmd b/site/faq/faq-workflows.qmd index df527cf44c..466236394d 100644 --- a/site/faq/faq-workflows.qmd +++ b/site/faq/faq-workflows.qmd @@ -16,7 +16,7 @@ listing: contents: - ../guide/workflows/working-with-workflows.qmd - ../guide/workflows/manage-model-stages.qmd - - ../guide/model-inventory/manage-model-inventory-fields.qmd + - ../guide/inventory/manage-inventory-fields.qmd - ../guide/attestation/working-with-attestations.qmd categories: ["workflows", "model lifecycle", "lifecycle statuses", "attestations", "validmind platform", "validmind library"] --- diff --git a/site/get-started/developer/quickstart-developer.qmd b/site/get-started/developer/quickstart-developer.qmd index 8548557241..d3c14bbc1a 100644 --- a/site/get-started/developer/quickstart-developer.qmd +++ b/site/get-started/developer/quickstart-developer.qmd @@ -138,7 +138,7 @@ Now that you've grasped the basics of using {{< var vm.product >}} for model dev [^1]: [Quickstart for model documentation](/notebooks/quickstart/quickstart_model_documentation.ipynb) -[^2]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^2]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^3]: [Working with document templates](/guide/templates/working-with-document-templates.qmd) diff --git a/site/get-started/validator/quickstart-validator.qmd b/site/get-started/validator/quickstart-validator.qmd index da751ee363..912420fca1 100644 --- a/site/get-started/validator/quickstart-validator.qmd +++ b/site/get-started/validator/quickstart-validator.qmd @@ -169,7 +169,7 @@ Now that you've grasped the basics of using {{< var vm.product >}} for model val [^1]: [Quickstart for model validation](/notebooks/quickstart/quickstart_model_validation.ipynb) -[^2]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^2]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^3]: [Working with document templates](/guide/templates/working-with-document-templates.qmd) diff --git a/site/guide/_sidebar.yaml b/site/guide/_sidebar.yaml index a3ea5cb2e9..e1a8822d0f 100644 --- a/site/guide/_sidebar.yaml +++ b/site/guide/_sidebar.yaml @@ -31,7 +31,7 @@ website: - guide/configuration/manage-users.qmd - guide/configuration/manage-groups.qmd - guide/configuration/manage-roles.qmd - - guide/configuration/manage-model-stakeholder-types.qmd + - guide/configuration/manage-record-stakeholder-types.qmd - guide/configuration/manage-permissions.qmd - file: guide/configuration/personalizing-validmind.qmd contents: @@ -69,21 +69,25 @@ website: - guide/workflows/transition-workflows.qmd - guide/workflows/manage-workflow-tasks.qmd - text: "---" - - section: "Model inventory" + - section: "Inventory" contents: + - file: guide/inventory/setting-up-the-inventory.qmd + contents: + - guide/inventory/manage-inventory-record-types.qmd + - guide/inventory/manage-inventory-fields.qmd - text: "Working with the inventory" - file: guide/model-inventory/working-with-model-inventory.qmd - contents: - - guide/model-inventory/register-models-in-inventory.qmd - - guide/model-inventory/customize-model-inventory-layout.qmd - - guide/model-inventory/edit-model-inventory-fields.qmd - - guide/model-inventory/customize-model-overview-page.qmd - - file: guide/model-inventory/managing-model-inventory.qmd - contents: - - guide/model-inventory/configure-model-interdependencies.qmd - - guide/model-inventory/manage-model-inventory-fields.qmd - - guide/model-inventory/archive-delete-models.qmd - - guide/model-inventory/view-model-activity.qmd + file: guide/inventory/working-with-the-inventory.qmd + contents: + - text: "Register records in inventory" + file: guide/inventory/register-records-in-inventory.qmd + - guide/inventory/customize-inventory-layout.qmd + - guide/inventory/edit-inventory-fields.qmd + - guide/inventory/customize-record-overview-page.qmd + - file: guide/inventory/managing-the-inventory.qmd + contents: + - guide/inventory/configure-record-interdependencies.qmd + - guide/inventory/archive-delete-records.qmd + - guide/inventory/view-record-activity.qmd - text: "---" - section: "Documents & templates" contents: diff --git a/site/guide/access/register-with-validmind.qmd b/site/guide/access/register-with-validmind.qmd index 05acf96dc9..9f321920c6 100644 --- a/site/guide/access/register-with-validmind.qmd +++ b/site/guide/access/register-with-validmind.qmd @@ -126,4 +126,4 @@ b. `validmind.com` [^7]: [Customize your dashboard](/guide/configuration/customize-your-dashboard.qmd) -[^8]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd) +[^8]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) diff --git a/site/guide/attestation/approve-attestations.qmd b/site/guide/attestation/approve-attestations.qmd index c7051eab3d..1fad77f2ab 100644 --- a/site/guide/attestation/approve-attestations.qmd +++ b/site/guide/attestation/approve-attestations.qmd @@ -37,7 +37,7 @@ After you sign off, the attestation is recorded in the model's history. Attestat -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Manage attestations](/guide/attestation/manage-attestations.qmd) diff --git a/site/guide/attestation/manage-attestations.qmd b/site/guide/attestation/manage-attestations.qmd index c6a3343081..786bd96651 100644 --- a/site/guide/attestation/manage-attestations.qmd +++ b/site/guide/attestation/manage-attestations.qmd @@ -210,6 +210,6 @@ You cannot delete an attestation template if it has any active attestation perio -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) diff --git a/site/guide/attestation/review-attestations.qmd b/site/guide/attestation/review-attestations.qmd index ab939d88ae..bdc32ff2ef 100644 --- a/site/guide/attestation/review-attestations.qmd +++ b/site/guide/attestation/review-attestations.qmd @@ -56,7 +56,7 @@ After you accept the questionnaire, it is sent to the approver for final sign-of -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Manage attestations](/guide/attestation/manage-attestations.qmd) diff --git a/site/guide/attestation/submit-attestations.qmd b/site/guide/attestation/submit-attestations.qmd index ed0a9e8c45..9ce6419629 100644 --- a/site/guide/attestation/submit-attestations.qmd +++ b/site/guide/attestation/submit-attestations.qmd @@ -51,7 +51,7 @@ After you submit, the attestation is sent to your reviewer. The platform maintai -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Manage attestations](/guide/attestation/manage-attestations.qmd) diff --git a/site/guide/attestation/working-with-attestations.qmd b/site/guide/attestation/working-with-attestations.qmd index 25c1b9f0ca..783129caa5 100644 --- a/site/guide/attestation/working-with-attestations.qmd +++ b/site/guide/attestation/working-with-attestations.qmd @@ -138,7 +138,7 @@ Work with your model risk management team to create a template that accurately r -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) diff --git a/site/guide/configuration/_add-model-stakeholder-types.qmd b/site/guide/configuration/_add-model-stakeholder-types.qmd deleted file mode 100644 index bbef5b2aa7..0000000000 --- a/site/guide/configuration/_add-model-stakeholder-types.qmd +++ /dev/null @@ -1,35 +0,0 @@ - - -:::: {.content-visible unless-format="revealjs"} -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -1. Under {{< fa cube >}} Model Inventory, select **Model Stakeholder Types**. - -1. Click **{{< fa plus >}} Add Stakeholder Type**. - -1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type.^[Role names and stakeholder type names cannot be duplicated to reduce confusion.] - -1. Once you click **Add Stakeholder Type**, you can: - - - Configure stakeholder type selection available upon model registration^[[Configure stakeholder types on registration](/guide/configuration/manage-model-stakeholder-types.qmd#configure-stakeholder-types-on-registration)] - - Manage the model inventory field^[[Manage stakeholder type permissions](/guide/configuration/manage-model-stakeholder-types.qmd#manage-stakeholder-type-permissions)] permissions associated with that type - -:::: - -:::: {.content-hidden unless-format="revealjs"} -a. In the left sidebar, click **{{< fa gear >}} Settings**. - -a. Under {{< fa cube >}} Model Inventory, select **Model Stakeholder Types**. - -a. Click **{{< fa plus >}} Add Stakeholder Type**. - -a. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type. - -1. Once you click **Add Stakeholder Type**, you can: - - - Configure stakeholder type selection available upon model registration - - Manage the model inventory field permissions associated with that type - -:::: \ No newline at end of file diff --git a/site/guide/configuration/_add-stakeholder-types.qmd b/site/guide/configuration/_add-stakeholder-types.qmd new file mode 100644 index 0000000000..839680c200 --- /dev/null +++ b/site/guide/configuration/_add-stakeholder-types.qmd @@ -0,0 +1,43 @@ + + +:::: {.content-visible unless-format="revealjs"} +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +1. Under {{< fa cube >}} Inventory, select **Inventory Record Stakeholder Types**. + +1. Click **{{< fa plus >}} Add Stakeholder Type**. + +1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type.^[Role names and stakeholder type names cannot be duplicated to reduce confusion.] + +1. Select the **[inventory record types]{.smallcaps}**^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] this stakeholder type is available on. + +1. Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. + +1. Once you click **Add Stakeholder Type**, you can: + + - Configure stakeholder type selection available upon record registration^[[Configure stakeholder types on registration](/guide/configuration/manage-record-stakeholder-types.qmd#configure-stakeholder-types-on-registration)] + - Manage the inventory field, document, and artifact permissions associated with that type^[[Manage stakeholder type permissions](/guide/configuration/manage-record-stakeholder-types.qmd#manage-stakeholder-type-permissions)] + +:::: + +:::: {.content-hidden unless-format="revealjs"} +a. In the left sidebar, click **{{< fa gear >}} Settings**. + +a. Under {{< fa cube >}} Inventory, select **Inventory Record Stakeholder Types**. + +a. Click **{{< fa plus >}} Add Stakeholder Type**. + +a. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type. + +a. Select the [**[inventory record types]{.smallcaps}**](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} this stakeholder type is available on. + +a. Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. + +a. Once you click **Add Stakeholder Type**, you can: + + - Configure stakeholder type selection available upon record registration + - Manage the inventory field, document, and artifact permissions associated with that type + +:::: diff --git a/site/guide/configuration/_add-use-cases.qmd b/site/guide/configuration/_add-use-cases.qmd index 4203b86571..f21bd3117c 100644 --- a/site/guide/configuration/_add-use-cases.qmd +++ b/site/guide/configuration/_add-use-cases.qmd @@ -7,14 +7,14 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. +1. Under {{< fa cube >}} Inventory, select **Model Inventory Fields**. 1. In the Default Fields group, click on the **Use Case** field to add or remove use cases and use case groups: :::: :::: {.content-visible when-format="html" when-meta="includes.quickstart"} -1. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. +1. Under {{< fa cube >}} Inventory, select **Model Inventory Fields**. 1. In the Default Fields group, click on the **Use Case** field to add use cases and use case groups: diff --git a/site/guide/configuration/_manage-role-permissions.qmd b/site/guide/configuration/_manage-role-permissions.qmd index 052784ccde..d55b08b090 100644 --- a/site/guide/configuration/_manage-role-permissions.qmd +++ b/site/guide/configuration/_manage-role-permissions.qmd @@ -8,7 +8,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Select a permission type to manage: - **Feature Permissions** — Granular permissions for specific features within the {{< var validmind.platform >}}.^[[Manage permissions](/guide/configuration/manage-permissions.qmd)] - - **Field Permissions** — Read and update (write) permissions for model inventory fields^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)] and artifact fields.^[[Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)] + - **Field Permissions** — Read and update (write) permissions for model inventory fields^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)] and artifact fields.^[[Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)] 1. Select **Edit Permissions** to to add or remove user permissions to or from that role. @@ -22,7 +22,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. Select a permission type to manage: - [**Feature Permissions**](/guide/configuration/manage-permissions.qmd){target="_blank"} — Granular permissions for specific features within the {{< var validmind.platform >}}. - - **Field Permissions** — Read and update (write) permissions for [model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd){target="_blank"} and [artifact fields](/guide/model-validation/manage-artifact-fields.qmd){target="_blank"}. + - **Field Permissions** — Read and update (write) permissions for [inventory fields](/guide/inventory/manage-inventory-fields.qmd){target="_blank"} and [artifact fields](/guide/model-validation/manage-artifact-fields.qmd){target="_blank"}. a. Select **Edit Permissions** to to add or remove user permissions to or from that role. diff --git a/site/guide/configuration/_manage-stakeholder-type-permissions.qmd b/site/guide/configuration/_manage-stakeholder-type-permissions.qmd index 3cf8782138..e7b4acff85 100644 --- a/site/guide/configuration/_manage-stakeholder-type-permissions.qmd +++ b/site/guide/configuration/_manage-stakeholder-type-permissions.qmd @@ -3,11 +3,9 @@ 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"} -1. Click on the stakeholder type whose permissions you want to change. - 1. Select a permission type to manage: - - **Models** — Read and update (write) permissions for model inventory fields^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)] and document types.^[[Manage document types](/guide/templates/manage-document-types.qmd)] + - **Records** — Read and update (write) permissions for inventory record fields^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)] and document types.^[[Manage document types](/guide/templates/manage-document-types.qmd)] - **Artifacts** — Read and update (write) permissions for artifact fields,^[[Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)] and add, delete, read, and update (write) permissions for artifact types.^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] 1. Select **Edit Permissions** to modify read and update permissions to or from that type. @@ -24,7 +22,7 @@ a. Click on the stakeholder type whose permissions you want to change. a. Select a permission type to manage: - - **Models** — Read and update (write) permissions for [model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd){target="_blank"} and [document types](/guide/templates/manage-document-types.qmd){target="_blank"}. + - **Records** — Read and update (write) permissions for [inventory fields](/guide/inventory/manage-inventory-fields.qmd){target="_blank"} and [document types](/guide/templates/manage-document-types.qmd){target="_blank"}. - **Artifacts** — Read and update (write) permissions for [artifact fields](/guide/model-validation/manage-artifact-fields.qmd){target="_blank"}, and add, delete, read, and update (write) permissions for [artifact types](/guide/model-validation/manage-artifact-types.qmd){target="_blank"}. a. Select **Edit Permissions** to modify read and update permissions to or from that type. diff --git a/site/guide/configuration/_manage-stakeholders-on-records.qmd b/site/guide/configuration/_manage-stakeholders-on-records.qmd new file mode 100644 index 0000000000..41efa8b9bd --- /dev/null +++ b/site/guide/configuration/_manage-stakeholders-on-records.qmd @@ -0,0 +1,56 @@ + + + + + +:::: {.content-visible when-format="html" when-meta="includes.inventory"} +::: {.callout title="Changes will only apply to individual records."} +- Adding an inventory record stakeholder type on one record in your inventory will not affect the stakeholder types on the other records within your inventory. +- Record stakeholder types available for selection on records is determined by the inventory record types assigned to the stakeholder type.^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd#assign-stakeholder-types-to-record-types)] +::: + +1. On the record details page, click **{{< fa user-plus >}} Manage Stakeholders**. + +1. Toggle the stakeholder types you would like to display for that record. + +1. Add at least one user to each of your desired custom stakeholder types to save the display settings for that record: + + a. Click on your inventory record stakeholder type. + b. Select your users from the drop-down menu. + c. Click **Save** to apply your changes. + +:::: + + + +:::: {.content-visible when-format="html" unless-meta="includes.inventory"} +::: {.callout title="Changes will only apply to individual records."} +- Adding an inventory record stakeholder type on one record in your inventory will not affect the stakeholder types on the other records within your inventory. +- Record stakeholder types available for selection on records is determined by the inventory record types assigned to the stakeholder type.^[[Assign stakeholder types to record types](/guide/configuration/manage-record-stakeholder-types.qmd#assign-stakeholder-types-to-record-types)] +::: + +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.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] + +3. Click **{{< fa user-plus >}} Manage Stakeholders**. + +4. Toggle the stakeholder types you would like to display for that record. + +5. Add at least one user to each of your desired custom stakeholder types to save the display settings for that record: + + a. Click on your inventory record stakeholder type. + b. Select your users from the drop-down menu. + c. Click **Save** to apply your changes. + +:::: \ No newline at end of file diff --git a/site/guide/configuration/_model-stakeholder-types.qmd b/site/guide/configuration/_model-stakeholder-types.qmd deleted file mode 100644 index 389612fcca..0000000000 --- a/site/guide/configuration/_model-stakeholder-types.qmd +++ /dev/null @@ -1,24 +0,0 @@ - - -Model stakeholders determine specific responsibilities and access levels for model review and approval processes for each model in your model inventory, such as read or edit access to model inventory fields. - -:::: {.content-visible unless-format="revealjs"} -
    - -::: {.callout-button .pl4 .nt4} -::: {.callout collapse="true" appearance="minimal"} -### What permissions do model stakeholders have? - -Each model stakeholder also belongs to user groups which determine which models they can see, and have user roles with attached role permissions which define the level of access they have to overarching {{< var validmind.platform >}} features. -::: -::: - -:::: - - -:::: {.content-hidden unless-format="revealjs"} -Each model stakeholder also belongs to [user groups](/guide/configuration/manage-groups.qmd){target="_blank"} which determine which models they can see, and have [user roles](/guide/configuration/manage-roles.qmd){target="_blank"} with attached [role permissions](/guide/configuration/manage-permissions.qmd){target="_blank"} which define the level of access they have to overarching {{< var validmind.platform >}} features. - -:::: \ No newline at end of file diff --git a/site/guide/configuration/_stakeholder-type-on-registration.qmd b/site/guide/configuration/_stakeholder-type-on-registration.qmd index 187efd7326..c2d37b970e 100644 --- a/site/guide/configuration/_stakeholder-type-on-registration.qmd +++ b/site/guide/configuration/_stakeholder-type-on-registration.qmd @@ -4,28 +4,26 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} ::: {.callout} -By default, only the selection of **[model owner]{.smallcaps}**s is required when models are registered in your inventory. +By default, only the selection of **Record Owner**s is required when records are registered in your inventory. ::: -To include selection of additional stakeholder types during model registration: +To include selection of additional stakeholder types during record registration: -1. Click on the stakeholder type you want to select users for during registration. +1. Toggle **[available on record registration]{.smallcaps}**^[[Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)] to display user selection for that stakeholder type. -1. Toggle **[available on model registration]{.smallcaps}**^[[Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)] to display user selection for that stakeholder type. - - (Optional) To make user selection for that stakeholder type mandatory, also toggle **[make it required]{.smallcaps}**. +1. (Optional) To make user selection for that stakeholder type mandatory, also toggle **[make it required]{.smallcaps}**. Changes are saved automatically. :::: :::: {.content-hidden unless-format="revealjs"} -To include selection of additional stakeholder types [during model registration](/guide/model-inventory/register-models-in-inventory.qmd){target="_blank"}: +To include selection of additional stakeholder types [during record registration](/guide/inventory/register-records-in-inventory.qmd){target="_blank"}: a. Click on the stakeholder type you want to select users for during registration. -a. Toggle **[available on model registration]{.smallcaps}** to display user selection for that stakeholder type. +a. Toggle **[available on record registration]{.smallcaps}** to display user selection for that stakeholder type. (Optional) To make user selection for that stakeholder type mandatory, also toggle **[make it required]{.smallcaps}**. diff --git a/site/guide/configuration/_stakeholder-types.qmd b/site/guide/configuration/_stakeholder-types.qmd new file mode 100644 index 0000000000..757bcf47cd --- /dev/null +++ b/site/guide/configuration/_stakeholder-types.qmd @@ -0,0 +1,24 @@ + + +Record stakeholders determine specific responsibilities and access levels for review and approval processes for each record in your inventory, such as read or edit access to inventory fields. + +:::: {.content-visible unless-format="revealjs"} +
    + +::: {.callout-button .pl4 .nt4} +::: {.callout collapse="true" appearance="minimal"} +### What permissions do record stakeholders have? + +Each record stakeholder also belongs to user groups which determine which records they can see, and have user roles with attached role permissions which define the level of access they have to overarching {{< var validmind.platform >}} features. +::: +::: + +:::: + + +:::: {.content-hidden unless-format="revealjs"} +Each record stakeholder also belongs to [user groups](/guide/configuration/manage-groups.qmd){target="_blank"} which determine which records they can see, and have [user roles](/guide/configuration/manage-roles.qmd){target="_blank"} with attached [role permissions](/guide/configuration/manage-permissions.qmd){target="_blank"} which define the level of access they have to overarching {{< var validmind.platform >}} features. + +:::: diff --git a/site/guide/configuration/customize-your-dashboard.qmd b/site/guide/configuration/customize-your-dashboard.qmd index aff4c376d3..913f71c88c 100644 --- a/site/guide/configuration/customize-your-dashboard.qmd +++ b/site/guide/configuration/customize-your-dashboard.qmd @@ -48,7 +48,7 @@ Deletion of dashboards is permanent. 1. In the left sidebar, click **{{< fa home >}} Dashboard**. -2. Click on the tab for the dashboard you would like to edit or remove. +2. Click on the tab for the dashboard you want to edit or remove. 3. Click **{{< fa pencil >}} Edit Dashboard**: @@ -163,7 +163,7 @@ Removing a widget from a dashboard will not delete the linked view or analytics [^1]: [Manage dashboards](#manage-dashboards) -[^2]: [Manage custom inventory views](/guide/model-inventory/customize-model-inventory-layout.qmd#manage-custom-inventory-views) +[^2]: [Manage custom inventory views](/guide/inventory/customize-inventory-layout.qmd#manage-custom-inventory-views) [^3]: [Customize artifact layouts](/guide/model-validation/customize-artifact-layouts.qmd) @@ -171,7 +171,7 @@ Removing a widget from a dashboard will not delete the linked view or analytics [^5]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) -[^6]: [View model activity](/guide/model-inventory/view-model-activity.qmd) +[^6]: [View record activity](/guide/inventory/view-record-activity.qmd) [^7]: [Widget types](#widget-types) diff --git a/site/guide/configuration/manage-model-stakeholder-types.qmd b/site/guide/configuration/manage-model-stakeholder-types.qmd deleted file mode 100644 index ae59f34665..0000000000 --- a/site/guide/configuration/manage-model-stakeholder-types.qmd +++ /dev/null @@ -1,61 +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: "Manage model stakeholder types" -date: last-modified ---- - -{{< include /guide/configuration/_model-stakeholder-types.qmd >}} - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1] - -::: - -## Add or edit model stakeholder types - -::: {.callout-important} -Please note that the stock **Model Developer**, **Model Owner**, and **Model Validator** stakeholder types are required by default for all models, and as such cannot be cannot be modified. -::: - -{{< include /guide/configuration/_add-model-stakeholder-types.qmd >}} - -### Configure stakeholder types on registration - -{{< include /guide/configuration/_stakeholder-type-on-registration.qmd >}} - -### Manage stakeholder type permissions - -{{< include /guide/configuration/_manage-stakeholder-type-permissions.qmd >}} - -## Manage stakeholder types on models - -::: {.callout-important title="Changes will only apply to individual models."} -Adding a model stakeholder type on one model in your inventory will not affect the stakeholder types on the other models within your inventory. -::: - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a model or find your model by applying a filter or searching for it.[^4] - -3. Click **{{< fa user-plus >}} Manage Stakeholders**. - -4. Toggle the stakeholder types you would like to display for that model. - -5. Add at least one user to each of your desired custom stakeholder types to save the display settings for that model: - - a. Click on your model stakeholder type. - b. Select your users from the drop-down menu. - c. Click **Save** to apply your changes. - - - - -[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) \ No newline at end of file diff --git a/site/guide/configuration/manage-platform-notifications.qmd b/site/guide/configuration/manage-platform-notifications.qmd index c11f32ec02..b8cedcc1bf 100644 --- a/site/guide/configuration/manage-platform-notifications.qmd +++ b/site/guide/configuration/manage-platform-notifications.qmd @@ -125,7 +125,7 @@ Enable or disable email notifications for specific events across your organizati [^2]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#commenting) -[^3]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd#manage-stakeholder-types-on-models) +[^3]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd#manage-stakeholder-types-on-records) [^4]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) diff --git a/site/guide/configuration/manage-record-stakeholder-types.qmd b/site/guide/configuration/manage-record-stakeholder-types.qmd new file mode 100644 index 0000000000..5eb986ae4f --- /dev/null +++ b/site/guide/configuration/manage-record-stakeholder-types.qmd @@ -0,0 +1,75 @@ +--- +# 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: "Manage record stakeholder types" +date: last-modified +aliases: + - /guide/configuration/manage-model-stakeholder-types.html +--- + +{{< include /guide/configuration/_stakeholder-types.qmd >}} + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1] + +::: + +## Add record stakeholder types + +{{< include /guide/configuration/_add-stakeholder-types.qmd >}} + +## Edit record stakeholder types + +::: {.callout-important} +Please note that the stock **Record Developer**, **Record Owner**, and **Record Validator** stakeholder types are required by default for all records, and as such cannot be cannot be modified. +::: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa cube >}} Inventory, select **Inventory Record Stakeholder Types**. + +3. Click on the stakeholder type you want to edit. + +4. Make your changes to: + + - **[name]{.smallcaps}** — Click on the name to edit, then click **Save** to apply your changes. + - **[description]{.smallcaps}** — Click on the description to edit, then click **Save** to apply your changes. + - Inventory record types the stakeholder type is available on[^2] + - Display availability of the stakeholder type during record registration[^3] + - Inventory field, document, and artifact permissions associated with the stakeholder type[^4] + +### Assign stakeholder types to record types + +1. Under **[inventory record types]{.smallcaps}**, select the inventory record types the stakeholder type is available on. + +2. Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. + +3. Click **Save Inventory Record Type Links** to apply your changes. + +### Configure stakeholder types on registration + +{{< include /guide/configuration/_stakeholder-type-on-registration.qmd >}} + +### Manage stakeholder type permissions + +{{< include /guide/configuration/_manage-stakeholder-type-permissions.qmd >}} + +## Manage stakeholder types on records + +{{< include /guide/configuration/_manage-stakeholders-on-records.qmd >}} + + + + +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^2]: [Assign stakeholder types to record types](#assign-stakeholder-types-to-record-types) + +[^3]: [Configure stakeholder types on registration](#configure-stakeholder-types-on-registration) + +[^4]: [Manage stakeholder type permissions](#manage-stakeholder-type-permissions) diff --git a/site/guide/configuration/manage-your-profile.qmd b/site/guide/configuration/manage-your-profile.qmd index dd5ad3f1f8..1d5d892347 100644 --- a/site/guide/configuration/manage-your-profile.qmd +++ b/site/guide/configuration/manage-your-profile.qmd @@ -145,6 +145,6 @@ Setting a custom base URL affects only you. [^1]: [Legal Ease.](https://validmind.com/about/legal/) -[^2]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types) +[^2]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types) [^3]: Keys will automatically expire, or can be revoked by organization administrators on an as needed basis. The default automatic expiry for keys is `999` days. diff --git a/site/guide/configuration/managing-users.qmd b/site/guide/configuration/managing-users.qmd index 71c856975c..6418ae9bca 100644 --- a/site/guide/configuration/managing-users.qmd +++ b/site/guide/configuration/managing-users.qmd @@ -16,7 +16,7 @@ listing: - ./manage-users.qmd - ./manage-groups.qmd - ./manage-roles.qmd - - ./manage-model-stakeholder-types.qmd + - ./manage-record-stakeholder-types.qmd - ./manage-permissions.qmd aliases: - /guide/onboarding-users.html diff --git a/site/guide/configuration/set-up-your-organization.qmd b/site/guide/configuration/set-up-your-organization.qmd index caa15232e5..706b114782 100644 --- a/site/guide/configuration/set-up-your-organization.qmd +++ b/site/guide/configuration/set-up-your-organization.qmd @@ -65,7 +65,7 @@ In order to delete a business unit, there must be no models attached to that uni 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Inventory, select **Model Inventory Fields**. 3. In the Default Fields group, click on the **Use Case** field to add or delete use cases and use case groups as required:[^2] @@ -109,4 +109,4 @@ b. If you are sure you want to remove the use case, click **{{< fa trash-can >}} [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^2]: To edit the display behavior of this field on models and model registration, refer to: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#add-or-edit-inventory-fields) +[^2]: To edit the display behavior of this field on models and model registration, refer to: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#add-or-edit-inventory-fields) diff --git a/site/guide/guides.qmd b/site/guide/guides.qmd index ec8e43c8e0..b3628ba037 100644 --- a/site/guide/guides.qmd +++ b/site/guide/guides.qmd @@ -43,15 +43,17 @@ listing: - workflows/introduction-to-workflows.qmd - workflows/setting-up-workflows.qmd - workflows/working-with-workflows.qmd - - id: model-inventory + - id: inventory type: grid + grid-columns: 2 max-description-length: 250 sort: false fields: [title, description] contents: - - model-inventory/working-with-model-inventory.qmd - - model-inventory/managing-model-inventory.qmd - - model-inventory/view-model-activity.qmd + - inventory/setting-up-the-inventory.qmd + - inventory/working-with-the-inventory.qmd + - inventory/managing-the-inventory.qmd + - inventory/view-record-activity.qmd - id: documents-templates type: grid grid-columns: 2 @@ -132,9 +134,9 @@ Our guides offer step-by-step instructions for frequent tasks you perform within :::{#workflows} ::: -## Model inventory +## Inventory -:::{#model-inventory} +:::{#inventory} ::: ## Documents & templates diff --git a/site/guide/integrations/integrations-examples.qmd b/site/guide/integrations/integrations-examples.qmd index c8ed27c0f1..9ee496a775 100644 --- a/site/guide/integrations/integrations-examples.qmd +++ b/site/guide/integrations/integrations-examples.qmd @@ -457,8 +457,8 @@ Synchronize GitLab model registry with ValidMind model inventory for comprehensi [^11]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#webhook) -[^12]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^12]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^13]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^13]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^14]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) \ No newline at end of file +[^14]: [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/integrations/link-external-models.qmd b/site/guide/integrations/link-external-models.qmd index fa9a80c68c..76d7dce10c 100644 --- a/site/guide/integrations/link-external-models.qmd +++ b/site/guide/integrations/link-external-models.qmd @@ -101,16 +101,16 @@ The model is unlinked from the external system. -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Configure connections](configure-connections.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^5]: [Refresh model data](#refresh-model-data) [^6]: [Configure connections](configure-connections.qmd) -[^7]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/managing-integrations.qmd b/site/guide/integrations/managing-integrations.qmd index db6c7c1e8a..da285be92d 100644 --- a/site/guide/integrations/managing-integrations.qmd +++ b/site/guide/integrations/managing-integrations.qmd @@ -254,7 +254,7 @@ Connect AI assistants to {{< var vm.product >}} using the Model Context Protocol [^1]: [Analytics and reporting](/guide/reporting/working-with-analytics.qmd) -[^2]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd) +[^2]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) [^3]: [Introduction to workflows](/guide/workflows/introduction-to-workflows.qmd) [^4]: [Public REST API](/reference/validmind-rest-api-vm.qmd) [^5]: [Testing & documentation](/developer/validmind-library.qmd) diff --git a/site/guide/model-inventory/_add-attachments.qmd b/site/guide/inventory/_add-attachments.qmd similarity index 62% rename from site/guide/model-inventory/_add-attachments.qmd rename to site/guide/inventory/_add-attachments.qmd index fafd32dc24..c979532fad 100644 --- a/site/guide/model-inventory/_add-attachments.qmd +++ b/site/guide/inventory/_add-attachments.qmd @@ -2,11 +2,11 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -1. Click **{{< fa circle-plus >}} Select Files** to add a file. +2. Click **{{< fa circle-plus >}} Select Files** to add a file. - Add a [note]{.smallcaps} to the file by clicking on the **{{< fa ellipsis-vertical >}}** menu, then select **{{< fa file-medical >}} Add Note**. - Update a [note]{.smallcaps} by making your changes in the existing text field. -1. Click **Save** to submit the upload. +3. Click **Save** to submit the upload. - ![Adding attachment notes](/guide/model-inventory/add-attachment-note.gif){ fig-alt="An animated gif demonstrating how to add attachment notes" .screenshot} \ No newline at end of file + ![Adding attachment notes](/guide/inventory/add-attachment-note.gif){ fig-alt="An animated gif demonstrating how to add attachment notes" .screenshot} \ No newline at end of file diff --git a/site/guide/model-inventory/_add-edit-inventory-fields.qmd b/site/guide/inventory/_add-edit-inventory-fields.qmd similarity index 60% rename from site/guide/model-inventory/_add-edit-inventory-fields.qmd rename to site/guide/inventory/_add-edit-inventory-fields.qmd index d6ccc83844..f8e395e038 100644 --- a/site/guide/model-inventory/_add-edit-inventory-fields.qmd +++ b/site/guide/inventory/_add-edit-inventory-fields.qmd @@ -10,20 +10,20 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> To add a new inventory field, click **{{< fa plus >}} Add Field**: -a. Inventory fields require you to enter a **[title]{.smallcaps}** (name) and select a **[type]{.smallcaps}**.^[[Inventory field types](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)] +a. Inventory fields require you to enter a **[title]{.smallcaps}** (name), select a field **[type]{.smallcaps}**,^[[Inventory field types](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] and indicate what **[inventory record types]{.smallcaps}**^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] the field is available on. a. Include optional information for your field: - Enter a custom field **[key]{.smallcaps}**.^[If left blank, a key will be automatically generated in `camelCase` format.] - Enter a **[description]{.smallcaps}** to indicate the purpose of the field displayed on the list of fields. - Enter **[help text]{.smallcaps}** to provide guidance to users on how best to fill out that field. - - Check off whether or not the field should be **[required on new model registration]{.smallcaps}**. - - Assign a field to a **[group]{.smallcaps}**.^[Ungrouped fields will be listed under No Group: [Add inventory field groups](/guide/model-inventory/manage-model-inventory-fields.qmd#add-inventory-field-groups)] - - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by model stakeholder types or user roles. Leave this field blank for default permissions where only the [{{< fa hand >}} Customer Admin]{.bubble} role has write access.[^edit-fields] + - Check off whether or not the field should be **Required on Inventory Record registration**. + - Assign a field to a **[group]{.smallcaps}**.^[Ungrouped fields will be listed under No Group: [Add inventory field groups](/guide/inventory/manage-inventory-fields.qmd#add-inventory-field-groups)] + - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by inventory record stakeholder types or user roles. Leave this field blank for default permissions where only the [{{< fa hand >}} Customer Admin]{.bubble} role has write access.[^edit-fields] a. When you are satisfied with the setup of your inventory field, click **Save**. -{{< include /guide/model-inventory/_example-next-review-date-and-days-remaining.qmd >}} +{{< include /guide/inventory/_example-next-review-date-and-days-remaining.qmd >}} ### Edit inventory fields @@ -31,29 +31,29 @@ a. When you are satisfied with the setup of your inventory field, click **Save** Default Fields are fields created by default by {{< var vm.product >}}.[^default-fields] To modify a default field: -a. Under the Default Fields grouping, click on the inventory field you would like to edit. +a. Under the Default Fields grouping, click on the inventory field you want to edit. - Expand any inventory field group to see more fields.^[[Add inventory field groups](/guide/model-inventory/manage-model-inventory-fields.qmd#add-inventory-field-groups)] + Expand any inventory field group to see more fields.^[[Add inventory field groups](/guide/inventory/manage-inventory-fields.qmd#add-inventory-field-groups)] a. Toggle the following options on or off: - - **[disable field]{.smallcaps}** — Hide this field from all models in your inventory.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)] - - **[show on registration]{.smallcaps}** — Show this field when registering models in your inventory.^[[Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)] - - **[require on registration]{.smallcaps}** — Require input in this field when registering models in your inventory. + - **[disable field]{.smallcaps}** — Hide this field from all records in your inventory.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] + - **[show on registration]{.smallcaps}** — Show this field during record registration.^[[Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)] + - **[require on registration]{.smallcaps}** — Require input in this field during record registration. a. Click **Save Configuration** to apply your changes. #### Edit custom inventory fields -Custom inventory fields are fields created by your organization. Expand any inventory field group to see more fields.^[[Add inventory field groups](/guide/model-inventory/manage-model-inventory-fields.qmd#add-inventory-field-groups)] +Custom inventory fields are fields created by your organization. Expand any inventory field group to see more fields.^[[Add inventory field groups](/guide/inventory/manage-inventory-fields.qmd#add-inventory-field-groups)] To edit an existing custom inventory field: -a. Click on the custom inventory field you would like to edit. +a. Click on the custom inventory field you want to edit. a. Make your desired changes to your inventory field, then click **Save**. - Field keys for custom inventory field can be renamed under the **[actions]{.smallcaps}** column.^[[Rename custom field keys](/guide/model-inventory/manage-model-inventory-fields.qmd#rename-custom-field-keys)] + Field keys for custom inventory field can be renamed under the **[actions]{.smallcaps}** column.^[[Rename custom field keys](/guide/inventory/manage-inventory-fields.qmd#rename-custom-field-keys)] @@ -67,8 +67,8 @@ a. Make your desired changes to your inventory field, then click **Save**. ::: {.callout} ## All other users will have read-only access unless specified under the **[write permissions]{.smallcaps}**. - - [**Model Stakeholders**](/guide/configuration/manage-model-stakeholder-types.qmd) — Write permissions on a per model basis. - - [**Application Roles**](/guide/configuration/manage-roles.qmd) — Write permissions on a per field basis across all models. + - [**Inventory Record Stakeholders**](/guide/configuration/manage-record-stakeholder-types.qmd) — Write permissions on a per record basis. + - [**Organization Roles**](/guide/configuration/manage-roles.qmd) — Write permissions on a per field basis across all inventory records. ::: @@ -90,21 +90,21 @@ a. Make your desired changes to your inventory field, then click **Save**. :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. Here you can edit existing inventory fields, or add a new custom one: +1. Under {{< fa cube >}} Inventory, select **Inventory Record Fields**. Here you can edit existing inventory fields, or add a new custom one: - Click **{{< fa plus >}} Add Field** to add a new field. - Click on an existing field to edit that field. -1. Custom inventory fields require you to enter a **[title]{.smallcaps}** (name) and select a **[type]{.smallcaps}**. +1. Inventory fields require you to enter a **[title]{.smallcaps}** (name), select a field **[type]{.smallcaps}**, and indicate what **[inventory record types]{.smallcaps}** the field is available on. 1. Include optional information for your field: - Enter a custom field **[key]{.smallcaps}**. If left blank, a key will be automatically generated in `camelCase` format. - Enter a **[description]{.smallcaps}** to indicate the purpose of the field displayed on the list of fields. - Enter **[help text]{.smallcaps}** to provide guidance to users on how best to fill out that field. - - Check off whether or not the field should be **[required on new model registration]{.smallcaps}**. + - Check off whether or not the field should be **Required on Inventory Record registration**. - Assign a field to a **[group]{.smallcaps}**. Ungrouped fields will be listed under No Group. - - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by model stakeholder types or user roles. Leave this field blank for default permissions where only the [{{< fa hand >}} Customer Admin]{.bubble} role has write access. + - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by inventory record stakeholder types or user roles. Leave this field blank for default permissions where only the [{{< fa hand >}} Customer Admin]{.bubble} role has write access. 1. When you are satisfied with the setup of your inventory field, click **Save** for custom fields and **Save Configuration** for {{< var vm.product >}} default fields. diff --git a/site/guide/inventory/_add-edit-record-types.qmd b/site/guide/inventory/_add-edit-record-types.qmd new file mode 100644 index 0000000000..daadf34dd8 --- /dev/null +++ b/site/guide/inventory/_add-edit-record-types.qmd @@ -0,0 +1,65 @@ + + + + +:::: {.content-visible unless-format="revealjs"} +::: {.panel-tabset} +### Add record types + +a. Click **{{< fa plus >}} Add Inventory Record Type**. + +b. Enter a **[name]{.smallcaps}** for your record type. + +c. Include optional information for your record type: + + - Enter a **[description]{.smallcaps}** to indicate the purpose of the record type displayed on the list of record types. + - Enter a URL-safe **[slug]{.smallcaps}** where a list of records of this type will be accessible in your {{< var validmind.platform >}} URL under the inventory path.[^url-slug] + - Select the **[document types]{.smallcaps}** available to be created for this record type.^[[Manage document types](/guide/templates/manage-document-types.qmd)] + - Select the **[artifact types]{.smallcaps}** available to be logged on this record type.^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] + - Select the **[stakeholder types]{.smallcaps}** that should be displayed on this record type.^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] + - Select the **[default stakeholder types]{.smallcaps}** that should be displayed by default on this record type. + +d. When you are satisfied with the setup of your record type, click **Create**. + +### Edit record types + +To edit an existing record type: + +a. Click on the record type you want to edit. + +b. Make your desired changes to your record type, then click **Update**. + +::: + +:::: + + + +[^url-slug]: + + - For example, `ai-agents` would be accessible at `/model-inventory/ai-agents`. + - If left blank, a slug will be automatically generated in `kebab-case` format. + + + +:::: {.content-hidden unless-format="revealjs"} + +- To add: Click **{{< fa plus >}} Add Inventory Record Type**, enter in the record type details, then click **Create**. +- To edit: Click on an existing record type, update the record type details, then click **Update**. + +#### Record type details + +a. Inventory record types require you to enter a **[name]{.smallcaps}** for your record type. + +b. Include optional information for your record type: + + - Enter a **[description]{.smallcaps}** to indicate the purpose of the record type displayed on the list of record types. + - Enter a URL-safe **[slug]{.smallcaps}** where a list of records of this type will be accessible in your {{< var validmind.platform >}} URL under the inventory path. If left blank, a slug will be automatically generated in `kebab-case` format + - Select the [**[document types]{.smallcaps}**](/guide/templates/manage-document-types.qmd){target="_blank"} available to be created for this record type. + - Select the [**[artifact types]{.smallcaps}**](/guide/model-validation/manage-artifact-types.qmd){target="_blank"} available to be logged on this record type. + - Select the [**[stakeholder types]{.smallcaps}**](/guide/configuration/manage-record-stakeholder-types.qmd){target="_blank"} that should be displayed on this record type. + - Select the **[default stakeholder types]{.smallcaps}** that should be displayed by default on this record type. + +:::: \ No newline at end of file diff --git a/site/guide/inventory/_enable-disable-record-types.qmd b/site/guide/inventory/_enable-disable-record-types.qmd new file mode 100644 index 0000000000..204909fd2d --- /dev/null +++ b/site/guide/inventory/_enable-disable-record-types.qmd @@ -0,0 +1,36 @@ + + + + +:::: {.content-visible unless-format="revealjs"} +To hide or show record types from the inventory: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa cube >}} Inventory, select **Inventory Record Types**. + +3. Click on the record type you want to enable or disable: + + - Toggle **[disabled]{.smallcaps}** to hide the record type from the inventory.^[Disabling a record type will hide the record type from the inventory and prevent new records of that type from being created.] + - Untoggle **[disabled]{.smallcaps}** to show the record type in the inventory. + +4. Click **Update** to save your changes. + +:::: + + + +:::: {.content-hidden unless-format="revealjs"} + +Disabling a record type will hide the record type from the inventory and prevent new records of that type from being created. + +a. Click on the record type you want to enable or disable: + + - Toggle **[disabled]{.smallcaps}** to hide the record type from the inventory. + - Untoggle **[disabled]{.smallcaps}** to show the record type in the inventory. + +b. Click **Update** to save your changes. + +:::: \ No newline at end of file diff --git a/site/guide/model-inventory/_example-next-review-date-and-days-remaining.qmd b/site/guide/inventory/_example-next-review-date-and-days-remaining.qmd similarity index 95% rename from site/guide/model-inventory/_example-next-review-date-and-days-remaining.qmd rename to site/guide/inventory/_example-next-review-date-and-days-remaining.qmd index 187aba895b..d469087fd7 100644 --- a/site/guide/model-inventory/_example-next-review-date-and-days-remaining.qmd +++ b/site/guide/inventory/_example-next-review-date-and-days-remaining.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ### Example — Next review date & days remaining -Combining different inventory field types provides a flexible way to automatically track model review schedules. This example creates fields that calculate the next review date based on approval date and validation frequency, adjusted by risk tier, and then computes the days remaining until that review. +Combining different inventory field types provides a flexible way to automatically track record review schedules. This example creates fields that calculate the next review date based on approval date and validation frequency, adjusted by risk tier, and then computes the days remaining until that review. Common date and time field types available in your formulas include: diff --git a/site/guide/model-inventory/_field-types.qmd b/site/guide/inventory/_field-types.qmd similarity index 80% rename from site/guide/model-inventory/_field-types.qmd rename to site/guide/inventory/_field-types.qmd index 677fa30897..9c3d46d5bd 100644 --- a/site/guide/model-inventory/_field-types.qmd +++ b/site/guide/inventory/_field-types.qmd @@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible when-format="html" when-meta="includes.inventory"} Aggregation -: Automatically compute a read-only value from downstream artifacts^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] linked to this model. +: Automatically compute a read-only value from downstream artifacts^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] linked to this record. 1. Select the type of **[artifacts]{.smallcaps}** to aggregate from.^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] @@ -24,26 +24,26 @@ Aggregation ### Example — Aggregation use cases -##### Open validation issue count +##### Open Validation Issue count -For an aggregation field that returns a count of open validation issues on the related model: +For an aggregation field that returns a count of open Validation Issues on the related record: - **[artifacts]{.smallcaps}** — Validation Issue - **[aggregation function]{.smallcaps}** — COUNT - Count matching entities - **[filters]{.smallcaps}** — Status IN `open` -##### Earliest logged model limitation +##### Earliest logged Model Limitation -For an aggregation field that returns the earliest date a model limitation was first logged: +For an aggregation field that returns the earliest date a Model Limitation was first logged: - **[artifacts]{.smallcaps}** — Model Limitation - **[aggregation function]{.smallcaps}** — MIN - Earliest/minimum value - **[artifact field]{.smallcaps}** — Created At -##### Most recent policy exception +##### Most recent Policy Exception -For an aggregation field that returns the most recent date a policy exception was updated: +For an aggregation field that returns the most recent date a Policy Exception was updated: - **[artifacts]{.smallcaps}** — Policy Exception - **[aggregation function]{.smallcaps}** — MAX - Latest/maximum value @@ -57,19 +57,19 @@ For an aggregation field that returns the most recent date a policy exception wa :::: {.content-visible when-format="html" when-meta="includes.inventory"} Attachments -: Upload supporting files for your model.^[[Manage supporting documentation](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-supporting-documentation)] Files must be less than 50 MB each in size. +: Upload supporting files for your record.^[[Manage attachments on records](/guide/inventory/edit-inventory-fields.qmd#manage-attachments)] Files must be less than 50 MB each in size. :::: :::: {.content-visible when-format="html" when-meta="includes.artifacts"} Attachments -: Upload supporting files for your artifact.^[[Manage supporting documentation](/guide/model-validation/add-manage-artifacts.qmd#manage-supporting-documentation)] Files must be less than 50 MB each in size. +: Upload supporting files for your artifact.^[[Manage attachments on artifacts](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments)] Files must be less than 50 MB each in size. :::: Calculation -: Define a `formula(params)` function that automatically calculates and returns a read-only value based on the params dictionary, which includes selected custom field keys retrieved from your other inventory model fields. +: Define a `formula(params)` function that automatically calculates and returns a read-only value based on the params dictionary, which includes selected custom field keys retrieved from your other inventory record fields. :::: {.content-visible when-format="html" when-meta="includes.inventory"} -1. Select from the drop-down of **[available model fields]{.smallcaps}** to allow your formula access to the field's values.^[Fields are grouped by field type.] +1. Select from the drop-down of **[available record fields]{.smallcaps}** to allow your formula access to the field's values.^[Fields are grouped by field type.] 2. Replace the demonstration formula with your own in the code box provided.^[**Stick to basic operations**.
    Keep your code simple and avoid complex logic and imports.] 3. Click **Test Calculation {{< fa angle-down >}}** to open the testing area. 4. Enter sample values in the testing area then click **{{< fa play >}} Test Calculation** to validate your formula. @@ -80,7 +80,7 @@ Calculation ### Example — Risk tier calculation -You have numeric model inventory fields of `materiality` and `complexity`, where a larger value indicates a lower risk. +You have numeric inventory fields of `materiality` and `complexity`, where a larger value indicates a lower risk. ##### Example formula @@ -100,7 +100,7 @@ You want a calculated field that automatically returns a risk score based on `ma ##### Example Calculation field configuration -Your calculated field is grouped under `Model Risk` inventory fields, and can only be manually overridden by that model's Model Validators: +Your calculated field is grouped under `Model Risk` inventory fields, and can only be manually overridden by that record's Validators: ![Adding a calculation type field that automatically calculates risk tier](calculation-field.png){fig-alt="A screenshot showing the screen for adding a calculation type field that automatically calculates risk tier" width=90% .screenshot} @@ -110,7 +110,7 @@ Your calculated field is grouped under `Model Risk` inventory fields, and can on :::: :::: {.content-visible when-format="html" when-meta="includes.artifacts"} -1. Select from the drop-down of **[available artifact fields]{.smallcaps}** and **[model fields available via]{.smallcaps} `params.model`** to allow your formula access to the field's values.^[Fields are grouped by field type.] +1. Select from the drop-down of **[available artifact fields]{.smallcaps}** and **[record fields available via]{.smallcaps} `params.model`** to allow your formula access to the field's values.^[Fields are grouped by field type.] 2. Replace the demonstration formula with your own in the code box provided.^[**Stick to basic operations**.
    Keep your code simple and avoid complex logic and imports.] 4. Click **Test Calculation {{< fa angle-down >}}** to open the testing area. 5. Enter in sample values in the testing area then click **{{< fa play >}} Test Calculation** to validate your formula. @@ -164,10 +164,10 @@ else: return base_days * urgency_multiplier ``` -#### Custom fields & parent model data +#### Custom fields & parent record data ```python -# Combine artifact types with custom fields and parent model data +# Combine artifact types with custom fields and parent record data risk_factor = custom_field_risk_score or 1.0 model_criticality = params.model.get("criticality_level", "medium") @@ -217,13 +217,13 @@ Number ::: {.w-50-ns} -![Simple number field type](/guide/model-inventory/number-simple.png){fig-alt="A screenshot showing a simple number field type" .screenshot group="number"} +![Simple number field type](/guide/inventory/number-simple.png){fig-alt="A screenshot showing a simple number field type" .screenshot group="number"} ::: ::: {.w-40-ns} -![Currency number field type](/guide/model-inventory/number-currency.png){fig-alt="A screenshot showing a currency number field type" .screenshot group="number"} +![Currency number field type](/guide/inventory/number-currency.png){fig-alt="A screenshot showing a currency number field type" .screenshot group="number"} ::: @@ -248,12 +248,12 @@ User :::: {.content-hidden unless-format="revealjs"} Attachments -: Upload supporting files for your [model](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-supporting-documentation){target="_blank"} or [artifact](/guide/model-validation/add-manage-artifacts.qmd#manage-supporting-documentation){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/model-validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. Files must be less than 50 MB each in size. Calculation -: Define a `formula(params)` function that automatically calculates and returns a read-only value based on the params dictionary, which includes selected custom field keys retrieved from your other inventory model fields. +: Define a `formula(params)` function that automatically calculates and returns a read-only value based on the params dictionary, which includes selected custom field keys retrieved from your other inventory record fields. - 1. Select from the drop-down of **[available model fields]{.smallcaps}** (model inventory fields), or **[available artifact fields]{.smallcaps}** and **[model fields available via]{.smallcaps} `params.model`** (artifact fields) to allow your formula access to the field's values. + 1. Select from the drop-down of **[available record fields]{.smallcaps}**, or **[available artifact fields]{.smallcaps}** and **[record fields available via]{.smallcaps} `params.model`** (artifact fields) to allow your formula access to the field's values. 2. Replace the demonstration formula with your own in the code box provided. 4. Click **Test Calculation {{< fa angle-down >}}** to open the testing area. 5. Enter in sample values in the testing area then click **{{< fa play >}} Test Calculation** to validate your formula. diff --git a/site/guide/model-inventory/_model-inventory-fields.qmd b/site/guide/inventory/_inventory-fields.qmd similarity index 52% rename from site/guide/model-inventory/_model-inventory-fields.qmd rename to site/guide/inventory/_inventory-fields.qmd index b9199d717f..c3a0eb2435 100644 --- a/site/guide/model-inventory/_model-inventory-fields.qmd +++ b/site/guide/inventory/_inventory-fields.qmd @@ -2,4 +2,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -Manage the fields that appear on all models in your model inventory. Choose from an array of field types with different properties and use cases. +Manage the fields that appear on records in your inventory across your organization’s record types. Choose from an array of field types with different properties and use cases. diff --git a/site/guide/inventory/_inventory-record-types.qmd b/site/guide/inventory/_inventory-record-types.qmd new file mode 100644 index 0000000000..117430be88 --- /dev/null +++ b/site/guide/inventory/_inventory-record-types.qmd @@ -0,0 +1,5 @@ + + +Configure the record types available in your inventory. Each record type has associated fields and stakeholder types that can be customized for your organization's unique requirements. \ No newline at end of file diff --git a/site/guide/model-inventory/_reference-field-values.qmd b/site/guide/inventory/_reference-field-values.qmd similarity index 93% rename from site/guide/model-inventory/_reference-field-values.qmd rename to site/guide/inventory/_reference-field-values.qmd index e0629c1109..d091e30af0 100644 --- a/site/guide/model-inventory/_reference-field-values.qmd +++ b/site/guide/inventory/_reference-field-values.qmd @@ -11,7 +11,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs" when-meta="includes.inventory"} ::: {.callout-button .pl4 .nt4} ::: {.callout collapse="true" appearance="minimal"} -## Reference inventory field values in your content blocks within documents and library text blocks. +## Reference record field values in your content blocks within documents and library text blocks. :::: {.flex .flex-wrap .justify-around} diff --git a/site/guide/model-inventory/_remove-attachments.qmd b/site/guide/inventory/_remove-attachments.qmd similarity index 64% rename from site/guide/model-inventory/_remove-attachments.qmd rename to site/guide/inventory/_remove-attachments.qmd index d3c5f4043e..0adedfad1b 100644 --- a/site/guide/model-inventory/_remove-attachments.qmd +++ b/site/guide/inventory/_remove-attachments.qmd @@ -2,15 +2,15 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -1. Locate the file you want to remove, and click on the **{{< fa ellipsis-vertical >}}** menu. +2. Locate the file you want to remove, and click on the **{{< fa ellipsis-vertical >}}** menu. - Select **{{< fa trash-can>}} Delete File** to remove the file. Click **Yes, Delete File** to confirm permanent deletion of that file. - Select **Remove Notes** to delete any notes. Removal of notes is saved automatically. -1. Click **Save** to apply the deletion. +3. Click **Save** to apply the deletion. After you save, the attachment or notes will be removed permanently. - ![Deleting attachment notes and attachments](/guide/model-inventory/delete-attachments.gif){fig-alt="An animated gif demonstrating how to delete attachment notes and attachments" .screenshot} + ![Deleting attachment notes and attachments](/guide/inventory/delete-attachments.gif){fig-alt="An animated gif demonstrating how to delete attachment notes and attachments" .screenshot} diff --git a/site/guide/inventory/_remove-layout-view.qmd b/site/guide/inventory/_remove-layout-view.qmd new file mode 100644 index 0000000000..8401ffa09e --- /dev/null +++ b/site/guide/inventory/_remove-layout-view.qmd @@ -0,0 +1,44 @@ + + + + + + +:::: {.content-visible when-format="html" when-meta="includes.inventory"} +2. Select the **[record type]{.smallcaps}** you want to remove a view for from the drop-down menu. + +3. Click **{{< fa bookmark >}} Select View**. + +4. Hover over the view you want to modify. + +5. When the **{{< fa ellipsis-vertical >}}** appears, click on it to edit the name or description or to delete the view: + + - To edit a view, select **{{< fa pencil >}} Edit View**. Make your edits then click **Save Changes** to apply your adjustments. + - To remove a view, select [**{{< fa trash-can >}} Remove View**]{.red}. Click **Yes, Delete View** to confirm permanent deletion of that view. + +:::: + + + +:::: {.content-visible when-format="html" unless-meta="includes.inventory"} +3. Click **{{< fa bookmark >}} Select View**. + +4. Hover over the view you want to modify. + +5. When the **{{< fa ellipsis-vertical >}}** appears, click on it to edit the name or description or to delete the view: + + - To edit a view, select **{{< fa pencil >}} Edit View**. Make your edits then click **Save Changes** to apply your adjustments. + - To remove a view, select [**{{< fa trash-can >}} Remove View**]{.red}. Click **Yes, Delete View** to confirm permanent deletion of that view. + +:::: + diff --git a/site/guide/model-inventory/_rename-field-keys.qmd b/site/guide/inventory/_rename-field-keys.qmd similarity index 100% rename from site/guide/model-inventory/_rename-field-keys.qmd rename to site/guide/inventory/_rename-field-keys.qmd diff --git a/site/guide/model-inventory/_save-layout-view.qmd b/site/guide/inventory/_save-layout-view.qmd similarity index 55% rename from site/guide/model-inventory/_save-layout-view.qmd rename to site/guide/inventory/_save-layout-view.qmd index 0095bac1dc..ea195d16d1 100644 --- a/site/guide/model-inventory/_save-layout-view.qmd +++ b/site/guide/inventory/_save-layout-view.qmd @@ -2,15 +2,20 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -1. Click **{{< fa bookmark >}} Save View** to save your first view. + + +2. Click **{{< fa bookmark >}} Save View** to save your first view. To add subsequent saved views, click **{{< fa bookmark >}} Select View**. -1. Select **{{< fa bookmark >}} Save New View**. +3. Select **{{< fa bookmark >}} Save New View**. -1. On the Add New View modal that appears, enter the: +4. On the Add New View modal that appears, enter the: - **[view name]{.smallcaps}** - **[description]{.smallcaps}** (optional) -1. Click **Add New View** to create your saved view. \ No newline at end of file +5. Click **Add New View** to create your saved view. + + + diff --git a/site/guide/inventory/_view-record-activity-overview.qmd b/site/guide/inventory/_view-record-activity-overview.qmd new file mode 100644 index 0000000000..112e2dc2fb --- /dev/null +++ b/site/guide/inventory/_view-record-activity-overview.qmd @@ -0,0 +1,29 @@ + + +The **{{< fa wifi >}} Activity** page shows a record of activities for the selected inventory record, including actions performed by users in your organization, activity from automated workflows, and updates generated via the {{< var validmind.developer >}}, such as: + +:::: {.content-visible unless-format="revealjs"} +- Fields updated^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] +- Stage transitions^[[Manage model stages](/guide/workflows/manage-model-stages.qmd)] +- Updates to documents: documentation,^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] validation reports,^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)] ongoing monitoring reports^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)], or custom documents +- Test results or metrics added via the {{< var vm.developer >}}^[[{{< var validmind.developer >}}](/developer/validmind-library.qmd)] +- Artifacts added, updated, or removed^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] +- User comment creation and replies on documents^[[Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#commenting)] +- Stakeholders added or removed^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd#manage-stakeholder-types-on-records)] +- Workflow activity^[[Working with workflows](/guide/workflows/working-with-workflows.qmd)] + +:::: + +:::: {.content-hidden unless-format="revealjs"} +- Fields updated +- Stage transitions +- Updates to documents: documentation, validation reports, ongoing monitoring reports, or custom documents +- Test results or metrics added via the {{< var vm.developer >}} +- Artifacts added, updated, or removed +- User comment creation and replies on documents +- Stakeholders added or removed +- Workflow activity + +:::: \ No newline at end of file diff --git a/site/guide/inventory/_view-record-activity-steps.qmd b/site/guide/inventory/_view-record-activity-steps.qmd new file mode 100644 index 0000000000..2d2c7f7ea9 --- /dev/null +++ b/site/guide/inventory/_view-record-activity-steps.qmd @@ -0,0 +1,29 @@ + + +To view record activity: + +:::: {.content-visible unless-format="revealjs"} +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +1. Under the [record type]{.smallcaps} drop-down, select the type of record you want view activity for.^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] + +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. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. + +:::: + +:::: {.content-hidden unless-format="revealjs"} +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +1. Under the [record type]{.smallcaps} drop-down, select the [type of record](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} you want view activity for. + +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. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. + +:::: + + diff --git a/site/guide/model-inventory/add-attachment-note.gif b/site/guide/inventory/add-attachment-note.gif similarity index 100% rename from site/guide/model-inventory/add-attachment-note.gif rename to site/guide/inventory/add-attachment-note.gif diff --git a/site/guide/inventory/archive-delete-records.qmd b/site/guide/inventory/archive-delete-records.qmd new file mode 100644 index 0000000000..9b87df9af2 --- /dev/null +++ b/site/guide/inventory/archive-delete-records.qmd @@ -0,0 +1,117 @@ +--- +# 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: "Archive and delete records" +date: last-modified +aliases: + - /guide/model-inventory/archive-delete-models.html + - /guide/inventory/archive-delete-models.html +--- + +Archive records within the {{< var vm.product >}} inventory when they are decommissioned or delete records that you no need to track, keeping your inventory accurate and up to date with your organization's current resources. + +::: {.callout} +## By default, only the Customer Admin role[^1] can access archived records. + +- Archived records are read-only, and do not contribute to sub-data, statistics or reports. +- Artifacts from archived records will not be displayed, and reports will not include data from archived records. +::: + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] There are records registered in the inventory.[^2] +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] + +::: + +## Change record stages + +::: {.callout} +## Instead of manually modifying your records' stages,[^4] we recommend manipulating stages via customized workflows.[^5] + +Workflows increase oversight over the stage transitions of records by providing a more extensive audit history,[^6] and also allow you to wrap other organization policies into your transitions — such as inclusion of specific stakeholder approval. +::: + +The inventory within the {{< var validmind.platform >}} should reflect the state of governed records within your organization: + +- If you decommission a record, you can archive it in the inventory. +- Conversely, if there is renewed business need for an archived record, you can activate it again. + +To change a record's stage: + +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Under the [record type]{.smallcaps} drop-down, select the type of record you want change the stage for.[^7] + +3. Select a record or find your record by applying a filter or searching for it.[^8] + +4. Click on the [{record} stage]{.smallcaps} section where `{record}` is the type of record. + +5. You can then select the appropriate stage for the record. + +6. Click **Save** to transition the record into your selected stage. + +::: {.panel-tabset} + +#### Archive records + +a. Select **Archived** from the [{record} stage]{.smallcaps} drop-down menu where `{record}` is the type of record. + +b. Click **Save** to proceed with archival. + +c. Click **Yes, Archive Record** to confirm archival of that record. + +Archived records can be reactivated to make them available for use again in the inventory. + +#### Activate records + +a. Select any stage other than Archived from the [{record} stage]{.smallcaps} drop-down menu where `{record}` is the type of record. + +b. Click **Save** to proceed with activation. + +::: + +## Delete records + +If a record was created in error, or you otherwise no longer require a record to be tracked in the inventory, you can delete it. + +::: {.callout-important} +## Record deletion is also permanent and cannot be undone. +::: + +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Under the [record type]{.smallcaps} drop-down, select the type of record you want delete.[^9] + +3. Select a record or find your record by applying a filter or searching for it.[^10] + +4. Under the [{record} stage]{.smallcaps} section where `{record}` is the type of record, select **Deleted**. + +5. Click **Yes, Delete Record** to confirm permanent deletion of that record. + + + + +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^2]: [Register records in the inventory](register-records-in-inventory.qmd) + +[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^4]: [Manage model stages](/guide/workflows/manage-model-stages.qmd) + +[^5]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) + +[^6]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) + +[^7]: [Manage inventory record types](manage-inventory-record-types.qmd) + +[^8]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^9]: [Manage inventory record types](manage-inventory-record-types.qmd) + +[^10]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/model-inventory/calculation-field-days-remaining.png b/site/guide/inventory/calculation-field-days-remaining.png similarity index 100% rename from site/guide/model-inventory/calculation-field-days-remaining.png rename to site/guide/inventory/calculation-field-days-remaining.png diff --git a/site/guide/model-inventory/calculation-field-next-review-date.png b/site/guide/inventory/calculation-field-next-review-date.png similarity index 100% rename from site/guide/model-inventory/calculation-field-next-review-date.png rename to site/guide/inventory/calculation-field-next-review-date.png diff --git a/site/guide/model-inventory/calculation-field.png b/site/guide/inventory/calculation-field.png similarity index 100% rename from site/guide/model-inventory/calculation-field.png rename to site/guide/inventory/calculation-field.png diff --git a/site/guide/inventory/configure-record-interdependencies.qmd b/site/guide/inventory/configure-record-interdependencies.qmd new file mode 100644 index 0000000000..8adb69d1fa --- /dev/null +++ b/site/guide/inventory/configure-record-interdependencies.qmd @@ -0,0 +1,99 @@ +--- +# 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: "Configure record interdependencies" +date: last-modified +aliases: + - /guide/model-inventory/configure-model-interdependencies.html + - /guide/inventory/configure-model-interdependencies.html +--- + +Link two or more records in your {{< var vm.product >}} inventory together. Dependencies are useful to understand how a record is +affected by or affects other records in your inventory. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] There are two or more records registered in the inventory.[^1] +- [x] You are the record owner[^2] for the record you want to set interdependencies for, a [{{< fa code >}} Developer]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] + +::: + +## View interdependencies + +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Under the [record type]{.smallcaps} drop-down, select the type of record you want view interdependencies for.[^4] + +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: + + - 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**. + +2. Under the [record type]{.smallcaps} drop-down, select the type of record you want edit interdependencies for.[^6] + +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. + +5. 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: + + - **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. + +7. 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"} + +::: + +:::: + + + + +[^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) + +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^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) diff --git a/site/guide/model-inventory/customize-model-inventory-layout.qmd b/site/guide/inventory/customize-inventory-layout.qmd similarity index 65% rename from site/guide/model-inventory/customize-model-inventory-layout.qmd rename to site/guide/inventory/customize-inventory-layout.qmd index 58a9cb458b..b846b0bff4 100644 --- a/site/guide/model-inventory/customize-model-inventory-layout.qmd +++ b/site/guide/inventory/customize-inventory-layout.qmd @@ -2,20 +2,24 @@ # 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: "Customize model inventory layout" +title: "Customize inventory layout" date: last-modified aliases: - /guide/customize-model-inventory-layout.html + - /guide/model-inventory/customize-model-inventory-layout.html + - /guide/inventory/customize-model-inventory-layout.html +includes: + inventory: true --- -Swap between inventory views or configure the information that displays by default on the model inventory. +Swap between inventory views or configure the information that displays by default on the {{< var vm.product >}} inventory. ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] +- [x] There are records registered in the inventory.[^1] ::: @@ -31,7 +35,7 @@ In the left sidebar, click **{{< fa cubes >}} Inventory**: #### Card view - To display the inventory in card view, click **{{< fa grip >}} Display Cards**. -- By default, the model name, purpose, tier, owner, and status are displayed on each card. +- By default, the record name, purpose, tier, owner, and status are displayed on each card. #### Table view - To display the inventory in table view, click **{{< fa table >}} Display Table**. @@ -53,23 +57,28 @@ In addition to sorting and filtering the inventory,[^3] you can add or remove co - Search for a column name in the list to narrow down results. - Toggle visibility for each item and drag each option to change the order. - - Available columns are determined by your model inventory fields.[^5] + - Available columns are determined by your inventory fields.[^5] -Once customized, you can save a view for later application.[^6] +Once customized, you can save views for later application for each type of record in your inventory.[^6] ### Manage custom inventory views -:::{.callout} -Saved views are unique to you and do not display for other users in your organization. +:::{.callout title="Saved views are unique to you and do not display for other users in your organization."} + +While customizations to table views apply across all record types, saving a view only applies to that record type. + ::: ::: {.panel-tabset} #### Save inventory views + + + You can save custom table configurations as a view to reapply at any time: -1. Customize a table view.[^7] +1. Customize a table view for the **[record type]{.smallcaps}** you want to save a view for.[^7] You can also apply filters or sorting before saving your view to include them in the view.[^8] @@ -90,18 +99,18 @@ Deletion of saved views is permanent. -[^1]: [Register models in the inventory](register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](register-records-in-inventory.qmd) [^2]: [Customize table view](#customize-table-view) -[^3]: [Working with the model inventory](working-with-model-inventory.qmd) +[^3]: [Working with the inventory](working-with-the-inventory.qmd) [^4]: [Swap between views](#swap-between-views) -[^5]: [Manage model inventory fields](manage-model-inventory-fields.qmd) +[^5]: [Manage inventory fields](manage-inventory-fields.qmd) [^6]: [Manage custom inventory views](#manage-custom-inventory-views) [^7]: [Customize table view](#customize-table-view) -[^8]: [Working with the model inventory](working-with-model-inventory.qmd) \ No newline at end of file +[^8]: [Working with the inventory](working-with-the-inventory.qmd) \ No newline at end of file diff --git a/site/guide/inventory/customize-record-overview-page.qmd b/site/guide/inventory/customize-record-overview-page.qmd new file mode 100644 index 0000000000..b213c53ddc --- /dev/null +++ b/site/guide/inventory/customize-record-overview-page.qmd @@ -0,0 +1,66 @@ +--- +# 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: "Customize record overview page" +date: last-modified +aliases: + - /guide/model-inventory/customize-model-overview-page.html + - /guide/inventory/customize-model-overview-page.html +--- + +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. + +::: + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] There are records registered in the inventory.[^1] + +::: + +## 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: + +- Record Stakeholders +- Interdependencies +- Artifacts +- Recent Activity +::: + +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. Select a record or find your record by applying a filter or searching for it.[^3] + +3. Click on **{{< fa wrench >}} Customize Layout**. + +4. On the Customize Layout modal that appears, configure the inventory fields[^4] that appear: + + - 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. + + To narrow down your list of fields, search via the **{{< fa filter >}} Filter** bar. + +5. Click **Save Layout** to apply your changes to all record overview pages for that layout scope. + + + + +[^1]: [Register records in the inventory](register-records-in-inventory.qmd) + +[^2]: [Manage inventory record types](manage-inventory-record-types.qmd) + +[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^4]: [Manage inventory fields](manage-inventory-fields.qmd#inventory-field-types) + diff --git a/site/guide/model-inventory/delete-attachments.gif b/site/guide/inventory/delete-attachments.gif similarity index 100% rename from site/guide/model-inventory/delete-attachments.gif rename to site/guide/inventory/delete-attachments.gif diff --git a/site/guide/model-inventory/downstream-model.png b/site/guide/inventory/downstream-record.png similarity index 100% rename from site/guide/model-inventory/downstream-model.png rename to site/guide/inventory/downstream-record.png diff --git a/site/guide/inventory/edit-inventory-fields.qmd b/site/guide/inventory/edit-inventory-fields.qmd new file mode 100644 index 0000000000..0085fd894a --- /dev/null +++ b/site/guide/inventory/edit-inventory-fields.qmd @@ -0,0 +1,136 @@ +--- +# 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: "Edit inventory fields" +date: last-modified +aliases: + - /guide/edit-model-inventory-fields.html + - /guide/model-inventory/edit-model-inventory-fields.html + - /guide/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. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] The record 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] + +::: + +## Edit inventory record fields + +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. Select a record or find your record by applying a filter or searching for it.[^5] + +3. On the record details page, click on an inventory field to make your changes.[^6] + +4. Click **Save** to apply your changes. + +Changes you make to inventory fields are automatically logged to that record’s activity.[^7] + +
    + +{{< include /guide/inventory/_reference-field-values.qmd >}} + +### Manage inventory record stakeholders + +::: {.panel-tabset} + +### Manage stakeholder types on records + +{{< include /guide/configuration/_manage-stakeholders-on-records.qmd >}} + +### Add or remove stakeholders + +1. On the record's detail page, click on the inventory record stakeholder type[^8] you'd like to add users to. + +2. Select your desired users from the drop-down menu. + + To remove a user from a stakeholder type, click on the **{{< fa x >}}** to the right of their name. + +3. Click **Save** to apply your changes. + +::: + + + +### 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.[^9] +- Select attachments in `.pdf` format as context documents when generating text blocks with AI within your documents.[^10] +::: + +:::: + +:::: {.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.[^9] +::: + +:::: + +::: {.panel-tabset} + +#### Add attachments to a record + +1. On the record's detail page, 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. + +{{< include _remove-attachments.qmd >}} + +::: + + + + +[^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) + +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^6]: + + ::: {.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){.button .button-green} + + ::: + +[^7]: [View record activity](view-record-activity.qmd) + +[^8]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) + +[^9]: [Manage inventory fields](manage-inventory-fields.qmd#inventory-field-types) + +:::: {.content-visible when-format="html" when-meta="includes.pdf-context"} +[^10]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#generate-content) + +:::: + + diff --git a/site/guide/model-inventory/manage-model-inventory-fields.qmd b/site/guide/inventory/manage-inventory-fields.qmd similarity index 73% rename from site/guide/model-inventory/manage-model-inventory-fields.qmd rename to site/guide/inventory/manage-inventory-fields.qmd index 6438d9875f..4f2286b4ce 100644 --- a/site/guide/model-inventory/manage-model-inventory-fields.qmd +++ b/site/guide/inventory/manage-inventory-fields.qmd @@ -2,16 +2,18 @@ # 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: "Manage model inventory fields" +title: "Manage inventory fields" date: last-modified aliases: - manage-inventory-custom-fields.html - /guide/manage-inventory-custom-fields.html + - /guide/model-inventory/manage-model-inventory-fields.html + - /guide/inventory/manage-model-inventory-fields.html includes: inventory: true --- -{{< include /guide/model-inventory/_model-inventory-fields.qmd >}} +{{< include /guide/inventory/_inventory-fields.qmd >}} ::: {.attn} @@ -24,24 +26,24 @@ includes: ## Inventory field types -{{< include /guide/model-inventory/_field-types.qmd >}} +{{< include /guide/inventory/_field-types.qmd >}} ## View, search, and filter inventory fields 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Inventory, select **Inventory Record Fields**. - Displayed in groups[^2] as lists are the inventory fields available to models in your organization with a quick view of:[^3] + Displayed in groups[^2] as lists are the inventory fields available to records in your organization with a quick view of:[^3] - Number of workflows that field is used in[^4] - The field key - The field type[^6] - Field description - - Whether or not the field is required when creating models + - Whether or not the field is required when creating new records - Quick actions you can take on the inventory field -3. Narrow down existing inventory fields available to your models by searching or filtering for results: +3. Narrow down existing inventory fields available to your organization by searching or filtering for results: ::: {.panel-tabset} @@ -59,11 +61,11 @@ c. Click **Search** to narrow down your results by your entered keywords. a. Click **{{< fa filter >}} Filter** to filter fields by any of the following criteria: - - **[required on creation]{.smallcaps}** — Whether or not the field was set up as required on model registration. + - **[required on creation]{.smallcaps}** — Whether or not the field was set up as required during registration. - **[types]{.smallcaps}** — What type of field it is. - **[used in workflows]{.smallcaps}** — What workflows are using this field.[^5] - **[workflow triggered by field]{.smallcaps}** — What workflows are initiated when this field is edited.[^7] - - **[write permissions]{.smallcaps}** — Which model stakeholder types have permissions to edit this field.[^8] + - **[write permissions]{.smallcaps}** — Which inventory record stakeholder types have permissions to edit this field.[^8] b. Click **Apply Filters** to narrow down your results by your configured criteria. @@ -80,25 +82,25 @@ For example, if you first search by keyword for `date` under **Title** without c 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Inventory, select **Inventory Record Fields**. Here you can edit existing inventory fields, or add a new one: -{{< include /guide/model-inventory/_add-edit-inventory-fields.qmd >}} +{{< include /guide/inventory/_add-edit-inventory-fields.qmd >}} ### Rename custom field keys To rename the field keys for custom inventory fields: -{{< include /guide/model-inventory/_rename-field-keys.qmd >}} +{{< include /guide/inventory/_rename-field-keys.qmd >}} ## Add inventory field groups -To group model inventory fields, first create an inventory field group: +To group inventory fields, first create an inventory field group: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Inventory, select **Inventory Record Fields**. 3. Click **{{< fa folder-plus >}} Add Group** and enter in a **[name]{.smallcaps}** and a optional **[description]{.smallcaps}** for the group. @@ -109,12 +111,12 @@ To group model inventory fields, first create an inventory field group: ## Delete inventory fields ::: {.callout-important title="Inventory field deletion is permanent."} -Deleting an inventory field will remove it from all models using that field, even if the field has been populated on a model. +Deleting an inventory field will remove it from all records using that field, even if the field has been populated. ::: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Inventory, select **Inventory Record Fields**. 3. Hover over the field you would like to delete. @@ -147,6 +149,6 @@ Deleting an inventory field will remove it from all models using that field, eve [^7]: [Configure workflows](/guide/workflows/configure-workflows.qmd) -[^8]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) +[^8]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) [^9]: [Add or edit inventory fields](#add-or-edit-inventory-fields) \ No newline at end of file diff --git a/site/guide/inventory/manage-inventory-record-types.qmd b/site/guide/inventory/manage-inventory-record-types.qmd new file mode 100644 index 0000000000..e1f44f8017 --- /dev/null +++ b/site/guide/inventory/manage-inventory-record-types.qmd @@ -0,0 +1,39 @@ +--- +# 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: "Manage inventory record types" +date: last-modified +--- + +{{< include /guide/inventory/_inventory-record-types.qmd >}} + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1] + +::: + +## Add or edit record types + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa cube >}} Inventory, select **Inventory Record Types**. + + Here you can edit existing inventory record types, or add a new one: + +{{< include /guide/inventory/_add-edit-record-types.qmd >}} + +## Enable or disable record types + +{{< include /guide/inventory/_enable-disable-record-types.qmd >}} + + + + +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + + diff --git a/site/guide/inventory/managing-the-inventory.qmd b/site/guide/inventory/managing-the-inventory.qmd new file mode 100644 index 0000000000..f7c5356961 --- /dev/null +++ b/site/guide/inventory/managing-the-inventory.qmd @@ -0,0 +1,32 @@ +--- +# 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: "Managing the inventory" +date: last-modified +listing: + - id: inventory-management + type: grid + grid-columns: 2 + max-description-length: 250 + sort: false + fields: [title, description] + contents: + - configure-record-interdependencies.qmd + - archive-delete-records.qmd +aliases: + - /guide/model-inventory/managing-model-inventory.html + - /guide/inventory/managing-model-inventory.html +--- + +Once you're familiar with the {{< var vm.product >}} inventory, dive into more advanced features like managing record interdependencies, and manually changing the stage of records. + +:::{#inventory-management} +::: + +
    + +## What's next + +- [Working with the inventory](working-with-the-inventory.qmd) +- [View record activity](view-record-activity.qmd) diff --git a/site/guide/model-inventory/number-currency.png b/site/guide/inventory/number-currency.png similarity index 100% rename from site/guide/model-inventory/number-currency.png rename to site/guide/inventory/number-currency.png diff --git a/site/guide/model-inventory/number-simple.png b/site/guide/inventory/number-simple.png similarity index 100% rename from site/guide/model-inventory/number-simple.png rename to site/guide/inventory/number-simple.png diff --git a/site/guide/model-inventory/model-interdependencies.png b/site/guide/inventory/record-interdependencies.png similarity index 100% rename from site/guide/model-inventory/model-interdependencies.png rename to site/guide/inventory/record-interdependencies.png diff --git a/site/guide/inventory/register-records-in-inventory.qmd b/site/guide/inventory/register-records-in-inventory.qmd new file mode 100644 index 0000000000..e593ea3930 --- /dev/null +++ b/site/guide/inventory/register-records-in-inventory.qmd @@ -0,0 +1,94 @@ +--- +# 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: "Register records in the inventory" +date: last-modified +aliases: + - /guide/register-models-in-model-inventory.html + - /guide/model-inventory/register-models-in-inventory.html + - /guide/inventory/register-models-in-inventory.html +tbl-cap-location: bottom +--- + +Register records with {{< var vm.product >}} as the first step towards streamlining your organization's risk management oversight. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are the record owner.[^1] +- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2] + +::: + +## Register new 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 register.[^3] + +3. Click **Register {Record}** to create a new entry in the inventory where `{Record}` is the type of record you are registering. + +4. Depending on whether or not your organization has additional fields[^4] required on record registration, input the following information: + +::: {.panel-tabset} + +#### 1. Basic Record Information + +If no additional fields are required on creation for your records: + +a. Provide the information outlined in the basic record information fields table below: + + | Field | Description | + |---:|---| + | [record name]{.smallcaps} | The name of your record. | + | [group]{.smallcaps} | (conditional) If you belong to multiple user groups,[^5] select the group that can see the record. | + | [business unit]{.smallcaps} | Business unit[^6] associated with the record. | + | [is it a vendor record]{.smallcaps}[?]{.smallercaps} (optional) | Toggle whether or not the record is a vendor record.[^7] | + | [purpose]{.smallcaps} | Explain what the record will be used for. | + | [preliminary risk tier]{.smallcaps} | Assign a preliminary risk tier. | + : **Basic record information** fields {.hover tbl-colwidths="[30,70]"} + +b. Click **Next {{< fa angle-right >}}** to continue to assignment of record stakeholders.[^8] + +#### 2. Record Stakeholders + +a. Select the record stakeholders to add to the record upon registration. + + - By default, only **[owner]{.smallcaps}**s are required. + - Additional optional or required record stakeholders can be configured by your customer admin. + +b. Click **Next {{< fa angle-right >}}** to continue to additional record information (if required), or **Register {Record}** to create a new entry in the inventory where `{Record}` is the type of record you are registering. + +#### 3. Additional Record Information + +If additional fields are required on record registration for your organization: + +a. First enter the basic record information and assign record stakeholders, then click **Next {{< fa chevron-right >}}**. + +b. Fill in your organization's required additional fields. + +c. Click or **Register {Record}** to create a new entry in the inventory where `{Record}` is the type of record you are registering. + +::: + + + + +[^1]: [Manage inventory record stakeholders](/guide/inventory/edit-inventory-fields.qmd#manage-inventory-record-stakeholders) + +[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^3]: [Manage inventory record types](manage-inventory-record-types.qmd) + +[^4]: [Manage inventory fields](manage-inventory-fields.qmd) + +[^5]: [Manage groups](/guide/configuration/manage-groups.qmd) + +[^6]: [Manage business units](/guide/configuration/set-up-your-organization.qmd#manage-business-units) + +[^7]: [Vendor record](/about/glossary/glossary.qmd#vendor-model) + +[^8]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) diff --git a/site/guide/inventory/setting-up-the-inventory.qmd b/site/guide/inventory/setting-up-the-inventory.qmd new file mode 100644 index 0000000000..c20d47de4c --- /dev/null +++ b/site/guide/inventory/setting-up-the-inventory.qmd @@ -0,0 +1,27 @@ +--- +# 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: "Setting up the inventory" +date: last-modified +listing: + - id: setup-inventory + type: grid + max-description-length: 250 + grid-columns: 2 + sort: false + fields: [title, description] + contents: + - manage-inventory-record-types.qmd + - manage-inventory-fields.qmd +--- + +Set up the {{< var validmind.platform >}} to support your organization's requirements by customizing what record types and associated fields are available in the inventory. + +:::{#setup-inventory} +::: + +## What's next + +- [Working with the inventory](working-with-the-inventory.qmd) +- [Managing the inventory](managing-the-inventory.qmd) \ No newline at end of file diff --git a/site/guide/model-inventory/upstream-model.png b/site/guide/inventory/upstream-record.png similarity index 100% rename from site/guide/model-inventory/upstream-model.png rename to site/guide/inventory/upstream-record.png diff --git a/site/guide/inventory/view-record-activity.qmd b/site/guide/inventory/view-record-activity.qmd new file mode 100644 index 0000000000..7dd4d5b50b --- /dev/null +++ b/site/guide/inventory/view-record-activity.qmd @@ -0,0 +1,146 @@ +--- +# 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: "View record activity" +date: last-modified +aliases: + - /guide/model-documentation/view-documentation-activity.html + - /guide/view-documentation-activity.html + - /guide/model-inventory/view-model-activity.html + - /guide/inventory/view-model-activity.html +--- + +Use the audit trail functionality in the {{< var validmind.platform >}} to track or audit all the information events associated with a specific record. See a record of comments, workflow status changes, and updates made to the record. + + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] There are records registered in the inventory.[^1] + +::: + +## View record activity + +{{< include _view-record-activity-overview.qmd >}} + +{{< include _view-record-activity-steps.qmd >}} + +### View individual field activity + +To view activity for individual inventory fields:[^2] + +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Under the [record type]{.smallcaps} drop-down, select the type of record you want view field activity for.[^3] + +3. Select a record or find your record by applying a filter or searching for it.[^5] + +4. Hover over the field whose individual activity you want to view until the **{{< fa circle-info >}}** icon appears. + +5. Hover over **{{< fa circle-info >}}** to view individual activity for that field. + +## Filter record activity + +Filter to narrow down record activity by category or specific values: + +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Under the [record type]{.smallcaps} drop-down, select the type of record you want filter activity for.[^4] + +3. Select a record or find your record by applying a filter or searching for it.[^5] + +4. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. + +5. Click **{{< fa filter >}} Filter** to open the filter popover. + +6. Click **{{< fa plus >}} Add Rule** to add a filter condition. + +7. From the **Select category** dropdown, choose your filter options: + + ::: {.panel-tabset} + + ### Event Category + + Shows all events in a category: + + - **Logged Artifacts**[^6] — Artifacts logged on the record, by type.[^7] Only types of artifacts logged on the record will appear for selection. + - **Logged Metrics**[^8] — Metrics over time logged on the record. + - **Record Stakeholders**[^9] — Stakeholders added or removed from the record. + - **Record Fields**[^10] — Inventory fields updated on the record *(label reflects current UI)*. + - **Record Documents**[^11] — Updates made to documents on the record, including any logged test results from the {{< var validmind.developer >}}.[^12] + - **Record Lifecycle**[^13] — Record stage transitions. + - **Record Workflows**[^14] — Workflow activity on the record. + + ### Filter by Value + + Shows events for specific values in a category you select. Select a value key, then choose one or more specific values from the secondary dropdown: + + - **Logged Artifacts**[^15] — Artifacts logged on the record, by type.[^16] Only types of artifacts logged on the record will appear for selection. + - **Record Fields**[^17] — Inventory fields updated on the record. Only inventory fields populated on the record will appear for selection. + - **Record Documents**[^18] — Updates made to documents on the record, including any logged test results from the {{< var validmind.developer >}}.[^19] Only documents with activity will appear for selection. + - **Record Workflows**[^20] — Workflow activity on the record. Only workflows applied to the record will appear for selection. + - **User**[^21] — Events performed by user. Only users with activity on the record will appear for selection. + + ::: + + (Optional) Add more rules by repeating steps 5 and 6. Multiple rules combine with AND logic.[^22] + +6. Click **Apply Filters** to apply your filter rules. + +#### Remove active filters + +After applying filters, active conditions appear as chips below the header. Click {{< fa xmark >}} on any chip to remove that filter, or click **Clear All Filters** to reset. + +#### Share filtered views + +Filters persist in the URL, so you can share or bookmark a filtered view. + + + +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) + +[^2]: [Edit inventory fields](edit-inventory-fields.qmd) + +[^3]: [Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd) + +[^4]: [Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd) + +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^6]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) + +[^7]: For example, selecting **Artifacts: Validation Issue** shows all validation issue artifact type events. + +[^8]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd) + +[^9]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd#manage-stakeholder-types-on-records) + +[^10]: [Edit inventory fields](edit-inventory-fields.qmd) + +[^11]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) + +[^12]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) + +[^13]: [Manage model stages](/guide/workflows/manage-model-stages.qmd) + +[^14]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) + +[^15]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) + +[^16]: For example, selecting **Artifacts: Validation Issue** shows a secondary selection for the names of validation issue artifact type events. + +[^17]: [Edit inventory fields](edit-inventory-fields.qmd) + +[^18]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) + +[^19]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) + +[^20]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) + +[^21]: [Manage users](/guide/configuration/manage-users.qmd) + +[^22]: For example, filter by an event category AND a specific user to see only that user's activity in that category. diff --git a/site/guide/model-inventory/working-with-model-inventory.qmd b/site/guide/inventory/working-with-the-inventory.qmd similarity index 55% rename from site/guide/model-inventory/working-with-model-inventory.qmd rename to site/guide/inventory/working-with-the-inventory.qmd index 55ebe9d87b..3e35086c7f 100644 --- a/site/guide/model-inventory/working-with-model-inventory.qmd +++ b/site/guide/inventory/working-with-the-inventory.qmd @@ -2,47 +2,50 @@ # 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: "Working with the model inventory" +title: "Working with the inventory" date: last-modified listing: - - id: model-inventory + - id: working-with-the-inventory type: grid max-description-length: 250 grid-columns: 2 sort: false fields: [title, description] contents: - - register-models-in-inventory.qmd - - customize-model-inventory-layout.qmd - - edit-model-inventory-fields.qmd - - customize-model-overview-page.qmd + - register-records-in-inventory.qmd + - customize-inventory-layout.qmd + - edit-inventory-fields.qmd + - customize-record-overview-page.qmd aliases: - /guide/working-with-model-inventory.html + - /guide/model-inventory/working-with-model-inventory.html + - /guide/inventory/working-with-model-inventory.html includes: inventory: true --- -Get started with the {{< var vm.product >}} inventory, which tracks comprehensive details for all your models throughout the model lifecycle. The model inventory is customizable and extensible, with a layout that can be configured to suit each user's needs. +Use the {{< var vm.product >}} inventory to track comprehensive details for all your records throughout their lifecycles. The inventory is customizable and extensible, with a layout that can be configured to suit each user's needs. ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] +- [x] There is at least one record in the inventory.[^1] ::: -## Search, filter, and sort models +## Search, filter, and sort records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Use the top buttons to narrow down models and organize the model inventory to your preference: +2. Under the [record type]{.smallcaps} drop-down, select the type of records you want to view.[^2] - - **{{< fa magnifying-glass >}} Search** — Search for models using keywords in the model name. - - **{{< fa filter >}} Filter** — Filter models using different criteria. - - - **{{< fa arrow-up-wide-short >}} Sort** — Reorder the list using different criteria in ascending or descending order.[^2] +3. Use the top buttons to narrow down records and organize the inventory to your preference: + + - **{{< fa magnifying-glass >}} Search** — Search for records using keywords in the record name. + - **{{< fa filter >}} Filter** — Filter records using different criteria. + - **{{< fa arrow-up-wide-short >}} Sort** — Reorder the list using different criteria in ascending or descending order.[^3] ::: {.callout-button .pl4 .nt4} ::: {.callout collapse="true" appearance="minimal"} @@ -58,22 +61,24 @@ Changes are automatically saved and affect only your account. For example, if you first search by keyword for `ValidMind` without clearing that search, any additional filtering and sorting applied will only apply to the results returned by the previous criteria. ::: -## {{< var vm.product >}} model inventory +## Using the {{< var vm.product >}} inventory -:::{#model-inventory} +:::{#working-with-the-inventory} ::: ## What's next -- [Managing the model inventory](managing-model-inventory.qmd) -- [View model activity](view-model-activity.qmd) +- [Managing the inventory](managing-the-inventory.qmd) +- [View record activity](view-record-activity.qmd) -[^1]: [Register models in the inventory](register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](register-records-in-inventory.qmd) + +[^2]: [Manage inventory record types](manage-inventory-record-types.qmd) -[^2]: +[^3]: - **[name]{.smallcaps}** - [**[business unit]{.smallcaps}**](/guide/configuration/set-up-your-organization.qmd#manage-business-units) diff --git a/site/guide/model-documentation/_add-content-blocks.qmd b/site/guide/model-documentation/_add-content-blocks.qmd index ded6bb85de..99a824a9a5 100644 --- a/site/guide/model-documentation/_add-content-blocks.qmd +++ b/site/guide/model-documentation/_add-content-blocks.qmd @@ -5,7 +5,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] diff --git a/site/guide/model-documentation/_add-test-results.qmd b/site/guide/model-documentation/_add-test-results.qmd index 30f5af8588..b039603c16 100644 --- a/site/guide/model-documentation/_add-test-results.qmd +++ b/site/guide/model-documentation/_add-test-results.qmd @@ -5,7 +5,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] diff --git a/site/guide/model-documentation/_check-model-documents.qmd b/site/guide/model-documentation/_check-model-documents.qmd index 2da276ca22..098dd66d20 100644 --- a/site/guide/model-documentation/_check-model-documents.qmd +++ b/site/guide/model-documentation/_check-model-documents.qmd @@ -7,7 +7,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. In the left sidebar, click **{{< fa cubes >}} Inventory**. -a. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +a. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] a. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] @@ -89,7 +89,7 @@ To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Docume :::: {.content-visible when-format="revealjs" when-meta="includes.developer"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. 1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Development**. @@ -143,7 +143,7 @@ To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Docume :::: {.content-visible when-format="revealjs" unless-meta="includes.developer"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. 1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Validation**. diff --git a/site/guide/model-documentation/_document-overview.qmd b/site/guide/model-documentation/_document-overview.qmd index 70d56c5e65..ba3fc8f57a 100644 --- a/site/guide/model-documentation/_document-overview.qmd +++ b/site/guide/model-documentation/_document-overview.qmd @@ -12,7 +12,7 @@ The **Document Overview** shows a section-by-section outline of your model's doc - Any unresolved conversations^[[Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)] - The number of model artifacts^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] - The completion status for your model's documentation^[[Assign section statuses](/guide/model-documentation/assign-documentation-section-statuses.qmd)] -- Recent activity on your model^[[View model activity](/guide/model-inventory/view-model-activity.qmd)] +- Recent activity on your model^[[View record activity](/guide/inventory/view-record-activity.qmd)] :::: diff --git a/site/guide/model-documentation/_locate-document-overview.qmd b/site/guide/model-documentation/_locate-document-overview.qmd index 7b03b39d41..c8dc37038e 100644 --- a/site/guide/model-documentation/_locate-document-overview.qmd +++ b/site/guide/model-documentation/_locate-document-overview.qmd @@ -7,7 +7,7 @@ To locate your document overview for a model: :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] @@ -18,7 +18,7 @@ To locate your document overview for a model: :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="blank"}. +1. Select a model or [find your model by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="blank"}. 1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Development**. diff --git a/site/guide/model-documentation/assign-documentation-section-statuses.qmd b/site/guide/model-documentation/assign-documentation-section-statuses.qmd index b0df632ad8..685d36f4f1 100644 --- a/site/guide/model-documentation/assign-documentation-section-statuses.qmd +++ b/site/guide/model-documentation/assign-documentation-section-statuses.qmd @@ -47,11 +47,11 @@ The documentation completion status summary will then be updated on your Documen [^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) -[^2]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/model-documentation/check-documents-for-compliance.qmd b/site/guide/model-documentation/check-documents-for-compliance.qmd index cbaae4018f..a75e7feaed 100644 --- a/site/guide/model-documentation/check-documents-for-compliance.qmd +++ b/site/guide/model-documentation/check-documents-for-compliance.qmd @@ -44,7 +44,7 @@ Use the {{< var validmind.checker >}} to analyze your completed documents by com ::: -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Customize {{< var validmind.checker >}}](/guide/templates/customize-document-checker.qmd) diff --git a/site/guide/model-documentation/collaborate-with-others.qmd b/site/guide/model-documentation/collaborate-with-others.qmd index 356bfa08fa..dd15b0972e 100644 --- a/site/guide/model-documentation/collaborate-with-others.qmd +++ b/site/guide/model-documentation/collaborate-with-others.qmd @@ -151,7 +151,7 @@ To delete a comment in a resolved thread, follow the same steps but click the ** [^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) -[^2]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^3]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) diff --git a/site/guide/model-documentation/content_blocks/_generate-with-ai.qmd b/site/guide/model-documentation/content_blocks/_generate-with-ai.qmd index d3514c13cd..85423462ed 100644 --- a/site/guide/model-documentation/content_blocks/_generate-with-ai.qmd +++ b/site/guide/model-documentation/content_blocks/_generate-with-ai.qmd @@ -10,7 +10,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible when-format="html" when-meta="includes.pdf-context"} - You can also include model attachments in `.pdf` format^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-supporting-documentation)] as context documents: + You can also include model attachments in `.pdf` format^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd#manage-attachments)] as context documents: a. Click **{{< fa square-plus >}}** and select **{{< fa file-circle-plus >}} Add Document to Context**. a. Check off the attachment files you would like to include as extra context. @@ -36,7 +36,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Enter in a custom prompt and click **Send**, or click **Generate Content** to compose a draft for review. :::: {.content-visible when-format="revealjs" when-meta="includes.pdf-context"} - You can also include [model attachments in `.pdf` format](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-supporting-documentation){target="_blank"} as context documents: + You can also include [model attachments in `.pdf` format](/guide/inventory/edit-inventory-fields.qmd#manage-attachments){target="_blank"} as context documents: a. Click **{{< fa square-plus >}}** and select **{{< fa file-circle-plus >}} Add Document to Context**. a. Check off the attachment files you would like to include as extra context. diff --git a/site/guide/model-documentation/content_blocks/_reference-field-values.qmd b/site/guide/model-documentation/content_blocks/_reference-field-values.qmd index f0cbe1c729..34a0ab0bd0 100644 --- a/site/guide/model-documentation/content_blocks/_reference-field-values.qmd +++ b/site/guide/model-documentation/content_blocks/_reference-field-values.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ``` --> :::: {.content-visible unless-format="revealjs" when-meta="includes.blocks"} -- The associated model's inventory fields^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] +- The associated model's inventory fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] - Fields from artifacts logged on the associated model^[[Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd)] 1. Click **{ } Insert Variable {{< fa angle-down >}}** in the toolbar while editing a content block. @@ -32,7 +32,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs" unless-meta="includes.blocks"} a. Click **{ } Insert Variable {{< fa angle-down >}}** in the toolbar while editing a content block. -b. Select the **Model {{< fa arrow-right >}}** variable you want to reference from the drop-down menu.^[Model inventory field values: [Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] +b. Select the **Model {{< fa arrow-right >}}** variable you want to reference from the drop-down menu.^[Model inventory field values: [Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] c. Click away from the content block to apply your changes, and confirm that the correct variable value is displayed in the content block as expected. diff --git a/site/guide/model-documentation/submit-for-approval.qmd b/site/guide/model-documentation/submit-for-approval.qmd index 5a133cccd8..63dd86eec4 100644 --- a/site/guide/model-documentation/submit-for-approval.qmd +++ b/site/guide/model-documentation/submit-for-approval.qmd @@ -34,7 +34,7 @@ aliases: -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Configure workflows](/guide/workflows/configure-workflows.qmd) diff --git a/site/guide/model-documentation/view-documentation-guidelines.qmd b/site/guide/model-documentation/view-documentation-guidelines.qmd index 8b088120aa..e9affee120 100644 --- a/site/guide/model-documentation/view-documentation-guidelines.qmd +++ b/site/guide/model-documentation/view-documentation-guidelines.qmd @@ -48,11 +48,11 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss [^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) -[^2]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/model-documentation/work-with-content-blocks.qmd b/site/guide/model-documentation/work-with-content-blocks.qmd index 01dfdafad9..81a70d1ea1 100644 --- a/site/guide/model-documentation/work-with-content-blocks.qmd +++ b/site/guide/model-documentation/work-with-content-blocks.qmd @@ -7,7 +7,7 @@ date: last-modified aliases: - /guide/work-with-content-blocks.html includes: - pdf-context: false + pdf-context: true blocks: true --- @@ -165,7 +165,7 @@ Test-driven or metric over time blocks can be re-added later on but **text block 5. Click on a section header to expand that section and remove content. -6. Locate the block you wish to remove, and hover over it until the block's toolbar appears in the top right-hand corner. +6. Locate the block you want to remove, and hover over it until the block's toolbar appears in the top right-hand corner. 7. Select **{{< fa trash >}} Delete** to remove the block. @@ -182,7 +182,7 @@ Test-driven or metric over time blocks can be re-added later on but **text block [^4]: [Collaborate with others](collaborate-with-others.qmd) -[^5]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^5]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^6]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) @@ -202,9 +202,9 @@ Test-driven or metric over time blocks can be re-added later on but **text block [^14]: [Run tests and test suites](/developer/how-to/testing-overview.qmd) -[^15]: [View model activity](/guide/model-inventory/view-model-activity.qmd) +[^15]: [View model activity](/guide/inventory/view-record-activity.qmd) -[^16]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^16]: [Working with the model inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-models) [^17]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/model-documentation/work-with-document-versions.qmd b/site/guide/model-documentation/work-with-document-versions.qmd index c8a9c04ec3..ef70f87705 100644 --- a/site/guide/model-documentation/work-with-document-versions.qmd +++ b/site/guide/model-documentation/work-with-document-versions.qmd @@ -52,17 +52,17 @@ If you save another version before 5 minutes is up, you'll receive a warning toa -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^5]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) -[^6]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^7]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) diff --git a/site/guide/model-documentation/work-with-test-results.qmd b/site/guide/model-documentation/work-with-test-results.qmd index 08c75e83c8..cfa20b64e5 100644 --- a/site/guide/model-documentation/work-with-test-results.qmd +++ b/site/guide/model-documentation/work-with-test-results.qmd @@ -101,7 +101,7 @@ Filters can be removed from the list of test result metadata by clicking on the [^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) -[^2]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^3]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) @@ -118,7 +118,7 @@ Filters can be removed from the list of test result metadata by clicking on the ::: -[^6]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^7]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/model-documentation/working-with-model-documentation.qmd b/site/guide/model-documentation/working-with-model-documentation.qmd index 49631bb8ec..8f491dd228 100644 --- a/site/guide/model-documentation/working-with-model-documentation.qmd +++ b/site/guide/model-documentation/working-with-model-documentation.qmd @@ -126,7 +126,7 @@ Wrap up your model documentation, collaborate with other stakeholders, and submi -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) diff --git a/site/guide/model-inventory/_remove-layout-view.qmd b/site/guide/model-inventory/_remove-layout-view.qmd deleted file mode 100644 index e30d0574d1..0000000000 --- a/site/guide/model-inventory/_remove-layout-view.qmd +++ /dev/null @@ -1,12 +0,0 @@ - - -1. Click **{{< fa bookmark >}} Select View**. - -1. Hover over the view you want to modify. - -1. When the **{{< fa ellipsis-vertical >}}** appears, click on it to edit the name or description or to delete the view: - - - To edit a view, select **{{< fa pencil >}} Edit View**. Make your edits then click **Save Changes** to apply your adjustments. - - To remove a view, select [**{{< fa trash-can >}} Remove View**]{.red}. Click **Yes, Delete View** to confirm permanent deletion of that view. \ No newline at end of file diff --git a/site/guide/model-inventory/_view-model-activity-overview.qmd b/site/guide/model-inventory/_view-model-activity-overview.qmd deleted file mode 100644 index 5d5f44651a..0000000000 --- a/site/guide/model-inventory/_view-model-activity-overview.qmd +++ /dev/null @@ -1,29 +0,0 @@ - - -The **{{< fa wifi >}} Model Activity** page shows a record of all activities, including actions performed by users in your organization, activity from automated workflows, and updates generated via the {{< var validmind.developer >}} on a per model basis, such as: - -:::: {.content-visible unless-format="revealjs"} -- Inventory fields updated^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] -- Model stage transitions^[[Manage model stages](/guide/workflows/manage-model-stages.qmd)] -- Updates to documents: model documentation,^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] validation reports,^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)] ongoing monitoring reports^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)], or custom documents -- Test results or metrics added via the {{< var vm.developer >}}^[[{{< var validmind.developer >}}](/developer/validmind-library.qmd)] -- Artifacts added, updated, or removed^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] -- User comment creation and replies^[[Commenting](/guide/model-documentation/collaborate-with-others.qmd#commenting)] -- Model stakeholders added or removed^[[Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd#manage-stakeholder-types-on-models)] -- Workflow activity^[[Working with workflows](/guide/workflows/working-with-workflows.qmd)] - -:::: - -:::: {.content-hidden unless-format="revealjs"} -- Inventory fields updated -- Model stage transitions -- Updates to documents: model documentation, validation reports, ongoing monitoring reports, or custom documents -- Test results or metrics added via the {{< var vm.developer >}} -- Artifacts added, updated, or removed -- User comment creation and replies -- Model stakeholders added or removed -- Workflow activity - -:::: \ No newline at end of file diff --git a/site/guide/model-inventory/_view-model-activity-steps.qmd b/site/guide/model-inventory/_view-model-activity-steps.qmd deleted file mode 100644 index dd5bbf699f..0000000000 --- a/site/guide/model-inventory/_view-model-activity-steps.qmd +++ /dev/null @@ -1,24 +0,0 @@ - - -To view model activity: - -:::: {.content-visible unless-format="revealjs"} -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] - -1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. - -:::: - -:::: {.content-hidden unless-format="revealjs"} -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -1. Select a model or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. - -1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. -:::: - - diff --git a/site/guide/model-inventory/archive-delete-models.qmd b/site/guide/model-inventory/archive-delete-models.qmd deleted file mode 100644 index 6fdf5f82f6..0000000000 --- a/site/guide/model-inventory/archive-delete-models.qmd +++ /dev/null @@ -1,106 +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: "Archive and delete models" -date: last-modified ---- - -Archive models within the model inventory when they are decommissioned or delete models that you no longer require records of, keeping your inventory accurate and up to date with your organization's current resources. - -::: {.callout} -## By default, only the Customer Admin role[^1] can access archived models. - -- Archived models are read-only, and do not contribute to sub-data, statistics or reports. -- Artifacts from archived models will not be displayed, and reports will not include data from archived models. -::: - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^2] -- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] - -::: - -## Change model stages - -::: {.callout} -## Instead of manually modifying your models' stages,[^4] we recommend manipulating stages via customized workflows.[^5] - -Workflows increase oversight over the stage transitions of models by providing a more extensive audit history,[^6] and also allow you to wrap other organization policies into your transitions — such as inclusion of specific stakeholder approval. -::: - -The model inventory within the {{< var validmind.platform >}} should reflect the state of models within your organization: - -- If you decomission a model, you can archive it within the model inventory. -- Conversely, if there is a renewed business need for a model that has been archived, you can activate it again. - -To change a model's stage: - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a model or find your model by applying a filter or searching for it.[^7] - -3. Click on the [model stage]{.smallcaps} section. - -4. You can then select the appropriate stage for the model. - -5. Click **Save** to transition the model into your selected stage. - -::: {.panel-tabset} - -#### Archive models - -a. Select **Archived** from the [model stage]{.smallcaps} drop-down menu. - -b. Click **Save** to proceed with archival. - -c. Click **Yes, Archive Model** to confirm archival of that model. - -Archived models can be reactivated to make them available for use again in the inventory. - -#### Activate models - -a. Select any stage other than Archived from the [model stage]{.smallcaps} drop-down menu. - -b. Click **Save** to proceed with activation. - -::: - -## Delete models - -If a model was created in error, or you otherwise no longer require a model to be tracked in the model inventory, you can delete it. - -::: {.callout-important} -## Model deletion is also permanent and cannot be undone. -::: - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a model or find your model by applying a filter or searching for it.[^8] - -3. Under the [model stage]{.smallcaps} section, select **Deleted**. - -4. Click **Yes, Delete Model** to confirm permanent deletion of that model. - - - - -[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^2]: [Register models in the inventory](register-models-in-inventory.qmd) - -[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^4]: [Manage model stages](/guide/workflows/manage-model-stages.qmd) - -[^5]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) - -[^6]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) - -[^7]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) - -[^8]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) diff --git a/site/guide/model-inventory/configure-model-interdependencies.qmd b/site/guide/model-inventory/configure-model-interdependencies.qmd deleted file mode 100644 index 1cfae56f29..0000000000 --- a/site/guide/model-inventory/configure-model-interdependencies.qmd +++ /dev/null @@ -1,88 +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: "Configure model interdependencies" -date: last-modified ---- - -Link two or more models in your {{< var vm.product >}} model inventory together. Dependencies are useful to understand how a model is -affected by or affects other models in your inventory. - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] There are two or more models registered in the model inventory.[^1] -- [x] You are the model owner[^2] for the model you want to set interdependencies for, a [{{< fa code >}} Developer]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] - -::: - -## View interdependencies - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a model or find your model by applying a filter or searching for it.[^4] - -3. Any existing model interdependencies are shown under the Model Interdependencies section. - - On the interactive flowchart, the currently viewed model is highlighted: - - - 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 model interdependencies](model-interdependencies.png){fig-alt="A screenshot showing example model interdependencies" .screenshot} - -## Edit interdependencies - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a model or find your model by applying a filter or searching for it.[^5] - -3. Click **{{< fa square-plus >}} Manage Dependencies** to open up the model interdependencies detail menu. - -4. Select either the **{{< fa arrow-up >}} Upstream** or **{{< fa arrow-down >}} Downstream** tab: - - - **Upstream models** — Provides input or intermediate results to another model. - - **Downstream models** — 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. - -5. On your list of models populated by the model inventory, add or remove interdependencies as desired: - - - **Add** — Check off any models that are either upstream or downstream dependent on this current model. - - **Remove** — Uncheck any models previously linked as upstream or downstream dependent on this current model. - -6. Click **Save** to apply your changes. - -Once applied, model interdependencies will populate on all models linked together. - -:::: {.flex .flex-wrap .justify-around} - -::: {.w-40-ns} - -![Upstream Model linked to the downstream Current Model](upstream-model.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-model.png){fig-alt="A screenshot showing the Downstream Model linked to the upstream Current Model" .screenshot group="interdependency"} - -::: - -:::: - - - - -[^1]: [Register models in the inventory](register-models-in-inventory.qmd) - -[^2]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders) - -[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) - -[^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) diff --git a/site/guide/model-inventory/customize-model-overview-page.qmd b/site/guide/model-inventory/customize-model-overview-page.qmd deleted file mode 100644 index 6728aef3e9..0000000000 --- a/site/guide/model-inventory/customize-model-overview-page.qmd +++ /dev/null @@ -1,55 +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: "Customize model overview page" -date: last-modified ---- - -Configure what and how model inventory fields appear when you pull up a model'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 models in your inventory. - -::: - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] - -::: - -## Show or hide fields - -::: {.callout title="Only custom inventory fields can be shown or hidden."} -Default fields will always appear on your model overview pages and are represented by by faded cells. Their positions cannot be adjusted. -::: - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a model or find your model by applying a filter or searching for it.[^2] - -3. Click on **{{< fa table-cells-large >}} Customize Layout**. - -4. On the Customize Section Layout modal that appears, configure the model inventory fields[^3] that appear: - - - Toggle optional model 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.[^4] - - To narrow down your list of fields, search via the **{{< fa filter >}} Filter** bar. - -5. Click **Save Layout** to apply your changes to all model overview pages. - - - - -[^1]: [Register models in the inventory](register-models-in-inventory.qmd) - -[^2]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) - -[^3]: [Manage model inventory fields](manage-model-inventory-fields.qmd#inventory-field-types) - -[^4]: `Attachments` or `Long Text` type fields can only be placed in the Main Column. diff --git a/site/guide/model-inventory/edit-model-inventory-fields.qmd b/site/guide/model-inventory/edit-model-inventory-fields.qmd deleted file mode 100644 index 8c62a34457..0000000000 --- a/site/guide/model-inventory/edit-model-inventory-fields.qmd +++ /dev/null @@ -1,118 +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: "Edit model inventory fields" -date: last-modified -aliases: - - /guide/edit-model-inventory-fields.html -includes: - pdf-context: false - inventory: true ---- - -Edit individual detail fields on a model to ensure that model details are accurate and up-to-date. - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] -- [x] You are the model owner[^2] for the model you would like edit the details of, a [{{< fa hand >}} Customer Admin]{.bubble}, or assigned another role or stakeholder type with sufficient permissions to perform the tasks in this guide.[^3] - -::: - -## Steps - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a model or find your model by applying a filter or searching for it.[^4] - -3. On the model details page, click on an inventory field to make your changes.[^5] - -4. Click **Save** to apply your changes. - -Changes you make to model inventory fields are automatically logged to your model's activity.[^6] - -
    - -{{< include /guide/model-inventory/_reference-field-values.qmd >}} - -### Manage model stakeholders - -1. On the model's detail page, click on the model stakeholder type[^7] you'd like to add users to. - -2. Select your desired users from the drop-down menu. - - To remove a user from a stakeholder type, click on the **{{< fa x >}}** to the right of their name. - -3. Click **Save** to apply your changes. - -### Manage supporting documentation - - - -:::: {.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 models, first add an attachment inventory field.[^8] -- Select model attachments in `.pdf` format as context documents when generating text blocks with AI within your documents.[^9] -::: - -:::: - -:::: {.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 models, first add an attachment inventory field.[^8] -::: - -:::: - -::: {.panel-tabset} - -#### Add attachments to a model - -1. On the model's detail page, click on the header of your attachment field. - -{{< include _add-attachments.qmd >}} - -#### Remove attachments from a model - -1. On the model's detail page, click on the header of your attachment field. - -{{< include _remove-attachments.qmd >}} - -::: - - - - -[^1]: [Register models in the inventory](register-models-in-inventory.qmd) - -[^2]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders) - -[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) - -[^5]: - - ::: {.callout title="Aggregation and Calculation field types are auto-computed and read-only."} - To modify how these fields are calculated, update their configuration.

    - - [Manage model inventory fields](manage-model-inventory-fields.qmd#inventory-field-types){.button .button-green} - - ::: - -[^6]: [View model activity](view-model-activity.qmd) - -[^7]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) - -[^8]: [Manage model inventory fields](manage-model-inventory-fields.qmd#inventory-field-types) - -:::: {.content-visible when-format="html" when-meta="includes.pdf-context"} -[^9]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#generate-content) - -::: - - diff --git a/site/guide/model-inventory/managing-model-inventory.qmd b/site/guide/model-inventory/managing-model-inventory.qmd deleted file mode 100644 index a7d7f0e961..0000000000 --- a/site/guide/model-inventory/managing-model-inventory.qmd +++ /dev/null @@ -1,29 +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: "Managing the model inventory" -date: last-modified -listing: - - id: model-inventory-management - type: grid - max-description-length: 250 - sort: false - fields: [title, description] - contents: - - configure-model-interdependencies.qmd - - manage-model-inventory-fields.qmd - - archive-delete-models.qmd ---- - -Once you're familiar with the inventory, dive into more advanced features like managing model interdependencies, customizing what's shown on the model inventory to support your organization's requirements, and manually changing the stage of models. - -:::{#model-inventory-management} -::: - -
    - -## What's next - -- [Working with the model inventory](working-with-model-inventory.qmd) -- [View model activity](view-model-activity.qmd) diff --git a/site/guide/model-inventory/register-models-in-inventory.qmd b/site/guide/model-inventory/register-models-in-inventory.qmd deleted file mode 100644 index 5209e81bde..0000000000 --- a/site/guide/model-inventory/register-models-in-inventory.qmd +++ /dev/null @@ -1,93 +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: "Register models in the inventory" -date: last-modified -aliases: - - /guide/register-models-in-model-inventory.html ---- - -Register models with {{< var vm.product >}} as the first step towards streamlining your model documentation and validation workflow. - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] You are the model owner.[^1] -- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2] - -::: - -## Steps - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Click **{{< fa plus >}} Register Model**. - -3. Depending on whether or not your organization has additional fields[^3] required on model registration, input the information on the Register New Model panel. - -::: {.panel-tabset} - -#### 1. Basic Model Information - -If no additional fields are required on creation for your models: - -a. Provide the information outlined in the basic model information fields table below. - -b. Click **Register Model** to create a new entry in the model inventory. - -c. Click **Next {{< fa angle-right >}}** to continue to assignment of model stakeholders.[^4] - -| Field | Description | -|---:|---| -| [model name]{.smallcaps} | The name of your model. | -| [group]{.smallcaps} | (conditional) If you belong to multiple user groups,[^5] select the group that can see the model. | -| [business unit]{.smallcaps} | Business unit[^6] associated with the model. | -| [use case]{.smallcaps} | The model's use case.[^7] | -| [is it a vendor model]{.smallcaps}[?]{.smallercaps} (optional) | If the model is a vendor model, toggle **Is Vendor Model**.[^8] | -| [vendor name]{.smallcaps} (conditional) | If the model is a vendor model, provide the vendor's name. | -| [purpose]{.smallcaps} | Explain what the model will be used for. | -| [preliminary risk tier]{.smallcaps} | Assign a preliminary risk tier. | -: **Basic model information** fields {.hover tbl-colwidths="[30,70]"} - -#### 2. Model Stakeholders - -a. Select the model stakeholders to add to the model upon registration. - - - By default, only **[model owner]{.smallcaps}**s are required. - - Additional optional or required model stakeholders can be configured by your customer admin. - -b. Click **Next {{< fa angle-right >}}** to continue to additional model information (if required), or **Register Model** to create a new entry in the model inventory. - -#### 3. Additional Model Information - -If additional fields are required on model registration for your organization: - -a. First enter the basic model information and assign model stakeholders, then click **Next {{< fa chevron-right >}}**. - -b. Fill in your organization's required additional fields. - -c. Click **Register Model** to create a new entry in the model inventory. - -::: - - - - -[^1]: [Manage model stakeholders](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-model-stakeholders) - -[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^3]: [Manage model inventory fields](manage-model-inventory-fields.qmd) - -[^4]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) - -[^5]: [Manage groups](/guide/configuration/manage-groups.qmd) - -[^6]: [Manage business units](/guide/configuration/set-up-your-organization.qmd#manage-business-units) - -[^7]: [Manage use cases](/guide/configuration/set-up-your-organization.qmd#manage-use-cases) - -[^8]: [Vendor model](/about/glossary/glossary.qmd#vendor-model) diff --git a/site/guide/model-inventory/view-model-activity.qmd b/site/guide/model-inventory/view-model-activity.qmd deleted file mode 100644 index 43c4697cca..0000000000 --- a/site/guide/model-inventory/view-model-activity.qmd +++ /dev/null @@ -1,136 +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: "View model activity" -date: last-modified -aliases: - - /guide/model-documentation/view-documentation-activity.html - - /guide/view-documentation-activity.html ---- - -Use the audit trail functionality in the {{< var validmind.platform >}} to track or audit all the information events associated with a specific model. See a record of comments, workflow status changes, and updates made to the model. - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] - -::: - -## View all model activity - -{{< include _view-model-activity-overview.qmd >}} - -{{< include _view-model-activity-steps.qmd >}} - -## Filter all model activity - -Filter to narrow down all model activity per model by category or specific values: - -1. Select a model or find your model by applying a filter or searching for it.[^2] - -2. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. - -3. Click **{{< fa filter >}} Filter** to open the filter popover. - -4. Click **{{< fa plus >}} Add Rule** to add a filter condition. - -5. From the **Select category** dropdown, choose your filter options: - - ::: {.panel-tabset} - - ### Event Category - - Shows all events in a category: - - - **Artifacts**[^3] — Artifacts logged on the model, by type.[^4] Only types of artifacts logged on the model will appear for selection. - - **Model Metrics**[^5] — Metrics over time logged on the model. - - **Model Stakeholders**[^6] — Stakeholders added or removed from the model. - - **Model Inventory Fields**[^7] — Inventory fields updated on the model. - - **Model Documents**[^8] — Updates made to documents on the model, including any logged test results from the {{< var validmind.developer >}}.[^9] - - **Model Lifecycle**[^10] — Model stage transitions. - - **Workflows**[^11] — Workflow activity on the model. - - ### Filter by Value - - Shows events for specific values in a category you select. Select a value key, then choose one or more specific values from the secondary dropdown: - - - **Artifacts**[^12] — Artifacts logged on the model, by type.[^13] Only types of artifacts logged on the model will appear for selection. - - **Model Inventory Fields**[^14] — Inventory fields updated on the model. Only inventory fields populated on the model will appear for selection. - - **Model Documents**[^15] — Updates made to documents on the model, including any logged test results from the {{< var validmind.developer >}}.[^16] Only documents with activity will appear for selection. - - **Workflows**[^17] — Workflow activity on the model. Only workflows applied to the model will appear for selection. - - **User**[^18] — Events performed by user. Only users with activity on the model will appear for selection. - - ::: - - (Optional) Add more rules by repeating steps 5 and 6. Multiple rules combine with AND logic.[^19] - -6. Click **Apply Filters** to apply your filter rules. - -#### Remove active filters - -After applying filters, active conditions appear as chips below the header. Click {{< fa xmark >}} on any chip to remove that filter, or click **Clear All Filters** to reset. - -#### Share filtered views - -Filters persist in the URL, so you can share or bookmark a filtered view. - -## View individual model field activity - -To view activity for individual model inventory fields:[^20] - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -1. Select a model or find your model by applying a filter or searching for it.[^21] - -1. Hover over the field whose individual activity you want to view until the **{{< fa circle-info >}}** icon appears. - -1. Hover over **{{< fa circle-info >}}** to view individual activity for that field. - - - - -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) - -[^2]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) - -[^3]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) - -[^4]: For example, selecting **Artifacts: Validation Issue** shows all validation issue artifact type events. - -[^5]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd) - -[^6]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd#manage-stakeholder-types-on-models) - -[^7]: [Edit model inventory fields](edit-model-inventory-fields.qmd) - -[^8]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) - -[^9]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) - -[^10]: [Manage model stages](/guide/workflows/manage-model-stages.qmd) - -[^11]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) - -[^12]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) - -[^13]: For example, selecting **Artifacts: Validation Issue** shows a secondary selection for the names of validation issue artifact type events. - -[^14]: [Edit model inventory fields](edit-model-inventory-fields.qmd) - -[^15]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) - -[^16]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) - -[^17]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) - -[^18]: [Manage users](/guide/configuration/manage-users.qmd) - -[^19]: For example, filter by an event category AND a specific user to see only that user's activity in that category. - -[^20]: [Edit model inventory fields](edit-model-inventory-fields.qmd) - -[^21]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) diff --git a/site/guide/model-validation/_add-artifacts-on-documentation.qmd b/site/guide/model-validation/_add-artifacts-on-documentation.qmd index 41fe565374..04717e789c 100644 --- a/site/guide/model-validation/_add-artifacts-on-documentation.qmd +++ b/site/guide/model-validation/_add-artifacts-on-documentation.qmd @@ -5,7 +5,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] @@ -25,14 +25,14 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. When you are done, click **Save** to submit the artifact. - Once created, you can then add supporting documentation to your artifact.^[[Manage supporting documentation](/guide/model-validation/add-manage-artifacts.qmd#manage-supporting-documentation)] + Once created, you can then add supporting documentation to your artifact.^[[Manage attachments on artifacts](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments)] :::: :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or [find your model by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. 1. In the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. @@ -50,7 +50,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. When you are done, click **Save** to submit the artifact. - Once created, you can then [add supporting documentation to your artifact](/guide/model-validation/add-manage-artifacts.qmd#manage-supporting-documentation){target="_blank"}. + Once created, you can then [add supporting documentation to your artifact](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. :::: diff --git a/site/guide/model-validation/_add-edit-artifact-fields.qmd b/site/guide/model-validation/_add-edit-artifact-fields.qmd index ea7d666efd..11c04234cb 100644 --- a/site/guide/model-validation/_add-edit-artifact-fields.qmd +++ b/site/guide/model-validation/_add-edit-artifact-fields.qmd @@ -29,7 +29,7 @@ Expand any inventory field group to see more fields.^[[Add artifact field groups To edit an existing artifact field: -a. Click on the artifact field you would like to edit. +a. Click on the artifact field you want to edit. a. Make your desired changes to your artifact field, then click **Save**. @@ -44,7 +44,7 @@ a. Make your desired changes to your artifact field, then click **Save**. ::: {.callout} ## All other users will have read-only access unless specified under the **[write permissions]{.smallcaps}**. - - [**Model Stakeholders**](/guide/configuration/manage-model-stakeholder-types.qmd) — Write permissions on a per model basis. + - [**Model Stakeholders**](/guide/configuration/manage-record-stakeholder-types.qmd) — Write permissions on a per model basis. - [**Application Roles**](/guide/configuration/manage-roles.qmd) — Write permissions on a per field basis across all artifacts. ::: diff --git a/site/guide/model-validation/_add-edit-artifact-types.qmd b/site/guide/model-validation/_add-edit-artifact-types.qmd index dd003097f9..02faa08d61 100644 --- a/site/guide/model-validation/_add-edit-artifact-types.qmd +++ b/site/guide/model-validation/_add-edit-artifact-types.qmd @@ -20,7 +20,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 7. Enter in the artifact type's details: - **[fields]{.smallcaps}** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^add-fields-callout] - - **[model fields display]{.smallcaps}**[^add-model-fields-config] — Select which upstream model inventory fields^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] to display as read-only under the Model Information section on artifacts of this type and click **Save Model Fields Configuration** to apply your changes. + - **[model fields display]{.smallcaps}**[^add-model-fields-config] — Select which upstream model inventory fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Model Information section on artifacts of this type and click **Save Model Fields Configuration** to apply your changes. - **[artifact statuses]{.smallcaps}** — Configure the statuses available to this artifact type.^[[Manage artifact type statuses](#manage-artifact-type-statuses)] 8. Select the artifact type's permissions: @@ -41,7 +41,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> - **[name]{.smallcaps}** - **[description]{.smallcaps}** - **[fields]{.smallcaps}** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^edit-fields-callout] - - **[model fields display]{.smallcaps}**[^edit-model-fields-config] — Select which upstream model inventory fields^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] to display as read-only under the Model Information section on artifacts of this type and click **Save Model Fields Configuration** to apply your changes. + - **[model fields display]{.smallcaps}**[^edit-model-fields-config] — Select which upstream model inventory fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Model Information section on artifacts of this type and click **Save Model Fields Configuration** to apply your changes. - **[artifact statuses]{.smallcaps}** — Configure the statuses available to this artifact type.^[[Manage artifact type statuses](#manage-artifact-type-statuses)] 5. Make your desired changes to the artifact type's permissions: @@ -67,7 +67,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> [^add-permissions]: - - [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) + - [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) - [Manage roles](/guide/configuration/manage-roles.qmd) [^edit-fields-callout]: @@ -84,7 +84,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> [^edit-permissions]: - - [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) + - [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) - [Manage roles](/guide/configuration/manage-roles.qmd) diff --git a/site/guide/model-validation/_link-artifacts-to-reports.qmd b/site/guide/model-validation/_link-artifacts-to-reports.qmd index 542f725eee..d602b98441 100644 --- a/site/guide/model-validation/_link-artifacts-to-reports.qmd +++ b/site/guide/model-validation/_link-artifacts-to-reports.qmd @@ -5,11 +5,11 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] -1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-report-overview)] +1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview)] 1. Expand any subsection of the validation report you would like to work with. diff --git a/site/guide/model-validation/_link-validator-evidence.qmd b/site/guide/model-validation/_link-validator-evidence.qmd index d629572d86..869047e461 100644 --- a/site/guide/model-validation/_link-validator-evidence.qmd +++ b/site/guide/model-validation/_link-validator-evidence.qmd @@ -9,11 +9,11 @@ To link validator evidence to a report, you must first log tests as a validator 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] -1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-report-overview)] +1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview)] You can now expand any subsection of the validation report you would like to work with. diff --git a/site/guide/model-validation/_provide-compliance-assessments.qmd b/site/guide/model-validation/_provide-compliance-assessments.qmd index a31799f460..6f9ccc9406 100644 --- a/site/guide/model-validation/_provide-compliance-assessments.qmd +++ b/site/guide/model-validation/_provide-compliance-assessments.qmd @@ -9,11 +9,11 @@ Your organization can customize these options to match its own assessment framew 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] -1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-report-overview)] +1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview)] Expand any subsection of the validation report you would like to work with. diff --git a/site/guide/model-validation/_track-artifact-resolution.qmd b/site/guide/model-validation/_track-artifact-resolution.qmd index 80975b696c..0848e7b02b 100644 --- a/site/guide/model-validation/_track-artifact-resolution.qmd +++ b/site/guide/model-validation/_track-artifact-resolution.qmd @@ -7,7 +7,7 @@ As you prepare your validation report, review open or past due artifacts, close 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] ::: {.panel-tabset} @@ -59,7 +59,7 @@ a. Track open artifacts until all artifacts are resolved or plans are in place f :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. #### Track resolution of validation issues diff --git a/site/guide/model-validation/_view-all-artifacts.qmd b/site/guide/model-validation/_view-all-artifacts.qmd index c77f7d8fe8..ff0acbd4c4 100644 --- a/site/guide/model-validation/_view-all-artifacts.qmd +++ b/site/guide/model-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/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts)] or toggle visibilty for column headers.^[[Customize artifact layouts](/guide/model-validation/customize-artifact-layouts.qmd)] -- Click on any validation issue for more information, including the proposed remediation plan and any supporting attachments.^[[Manage supporting documentation](/guide/model-validation/add-manage-artifacts.qmd#manage-supporting-documentation)] +- Click on any validation issue for more information, including the proposed remediation plan and any supporting attachments.^[[Manage attachments on artifacts](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments)] Attachments are listed with the following information: @@ -53,7 +53,7 @@ To view a list of validation issues across all models: [Filter this list](/guide/model-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/model-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/model-validation/add-manage-artifacts.qmd#manage-supporting-documentation){target="_blank"}. +1. Click on any validation issue for more information, including the proposed remediation plan and [any supporting attachments](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. Attachments are listed with the following information: diff --git a/site/guide/model-validation/add-manage-artifacts.qmd b/site/guide/model-validation/add-manage-artifacts.qmd index 0f21add45e..666b903de6 100644 --- a/site/guide/model-validation/add-manage-artifacts.qmd +++ b/site/guide/model-validation/add-manage-artifacts.qmd @@ -11,7 +11,7 @@ aliases: Add artifacts at the model 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/model-inventory/_reference-field-values.qmd >}} +{{< include /guide/inventory/_reference-field-values.qmd >}} ::: {.attn} @@ -71,7 +71,9 @@ Most updates are applied immediately but you must click **Save** to make changes {{< include _track-artifact-resolution.qmd >}} -### Manage supporting documentation + + +### Manage attachments on artifacts After an artifact is created, you're able to add supporting documentation to it. @@ -85,20 +87,20 @@ 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/model-inventory/_add-attachments.qmd >}} +{{< include /guide/inventory/_add-attachments.qmd >}} #### Remove attachments from artifacts 1. On the artifacts detail page, click on the **[attachments]{.smallcaps}** header. -{{< include /guide/model-inventory/_remove-attachments.qmd >}} +{{< 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 >}} Model Activity,[^11] deleted artifacts cannot be retrieved. +- While artifact deletion will be logged under your {{< fa wifi >}} Activity,[^11] deleted artifacts cannot be retrieved. - Deleting an artifact will also remove it from any validation reports[^12] it was previously attached to. ::: @@ -114,7 +116,7 @@ If you logged an artifact in error or otherwise no longer need to track that art -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) @@ -124,17 +126,17 @@ If you logged an artifact in error or otherwise no longer need to track that art [^5]: [Link artifacts to reports](/guide/model-validation/assess-compliance.qmd#link-artifacts-to-reports) -[^6]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^7]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) -[^8]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-report-overview) +[^8]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview) [^9]: [Manage artifact types](manage-artifact-types.qmd) [^10]: [View and filter artifacts](view-filter-artifacts.qmd) -[^11]: [View model activity](/guide/model-inventory/view-model-activity.qmd) +[^11]: [View record activity](/guide/inventory/view-record-activity.qmd) [^12]: [Link artifacts to reports](/guide/model-validation/assess-compliance.qmd#link-artifacts-to-reports) diff --git a/site/guide/model-validation/assess-compliance.qmd b/site/guide/model-validation/assess-compliance.qmd index 5887d6baab..e730b3d153 100644 --- a/site/guide/model-validation/assess-compliance.qmd +++ b/site/guide/model-validation/assess-compliance.qmd @@ -77,7 +77,7 @@ To link evidence logged by developers^[[{{< var validmind.developer >}}](/develo [^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) -[^2]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^3]: [Submit for approval](/guide/model-documentation/submit-for-approval.qmd) @@ -85,8 +85,8 @@ To link evidence logged by developers^[[{{< var validmind.developer >}}](/develo [^5]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^6]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^7]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) -[^8]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-report-overview) +[^8]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview) diff --git a/site/guide/model-validation/customize-artifact-layouts.qmd b/site/guide/model-validation/customize-artifact-layouts.qmd index 06100e960f..e951af0cb8 100644 --- a/site/guide/model-validation/customize-artifact-layouts.qmd +++ b/site/guide/model-validation/customize-artifact-layouts.qmd @@ -4,7 +4,7 @@ # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Customize artifact layouts" date: last-modified -aliases: +aliases: - customize-model-findings-layouts.qmd --- @@ -78,7 +78,7 @@ You can save custom artifact configurations as a view to reapply at any time for You can also apply filters or sorting before saving your view to include them in the view.[^8] -{{< include /guide/model-inventory/_save-layout-view.qmd >}} +{{< include /guide/inventory/_save-layout-view.qmd >}} ### Edit or remove saved artifact views @@ -94,27 +94,25 @@ To modify a saved validation issues view: 1. In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** for a list of validation issues across all models. -{{< include /guide/model-inventory/_remove-layout-view.qmd >}} +{{< include /guide/inventory/_remove-layout-view.qmd >}} #### Edit or remove all other artifact type views To modify a saved view for all other artifact types: -1. In the left sidebar, click **{{< fa border-all >}} Artifacts** for lists of other artifact types across all models. +1. In the left sidebar, click **{{< fa border-all >}} Artifacts** for lists of other artifact types across all models, then select an artifact type[^9] for a list of that artifact type: -2. Select an artifact type[^9] for a list of that artifact type: + - Policy Exception + - Model Limitation - - Policy Exception - - Model Limitation - -{{< include /guide/model-inventory/_remove-layout-view.qmd >}} +{{< include /guide/inventory/_remove-layout-view.qmd >}} ::: -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Add and manage artifacts](add-manage-artifacts.qmd) diff --git a/site/guide/model-validation/customize-artifact-overview-page.qmd b/site/guide/model-validation/customize-artifact-overview-page.qmd index 17f5e6e263..bf75d10b68 100644 --- a/site/guide/model-validation/customize-artifact-overview-page.qmd +++ b/site/guide/model-validation/customize-artifact-overview-page.qmd @@ -33,12 +33,12 @@ Default fields will always appear on your artifact overview pages and are repres 1. Open an artifact logged on any model.[^3] -2. Click on **{{< fa table-cells-large >}} Customize Layout**. +2. Click on **{{< fa wrench >}} Customize Layout**. -3. On the Customize Section Layout modal that appears, configure the artifact fields[^4] that appear: +3. On the Customize Layout modal that appears, configure the artifact fields[^4] that appear: - 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.[^5] + - 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 narrow down your list of fields, search via the **{{< fa filter >}} Filter** bar. @@ -47,12 +47,10 @@ Default fields will always appear on your artifact overview pages and are repres -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Add and manage artifacts](add-manage-artifacts.qmd) [^3]: [View and filter artifacts](view-filter-artifacts.qmd) [^4]: [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd#artifact-field-types) - -[^5]: `Attachments` or `Long Text` type fields can only be placed in the Main Column. diff --git a/site/guide/model-validation/manage-artifact-fields.qmd b/site/guide/model-validation/manage-artifact-fields.qmd index f259950b2f..398805b261 100644 --- a/site/guide/model-validation/manage-artifact-fields.qmd +++ b/site/guide/model-validation/manage-artifact-fields.qmd @@ -23,7 +23,7 @@ includes: ## Artifact field types -{{< include /guide/model-inventory/_field-types.qmd >}} +{{< include /guide/inventory/_field-types.qmd >}} ## View, search, and filter artifacts fields @@ -88,7 +88,7 @@ For example, if you first search by keyword for `Regression` under **Title** wit To rename the field keys for artifact fields: -{{< include /guide/model-inventory/_rename-field-keys.qmd >}} +{{< include /guide/inventory/_rename-field-keys.qmd >}} ## Add artifact field groups @@ -143,6 +143,6 @@ Deleting an artifact field will remove it from all artifacts using that field, e [^6]: [Configure workflows](/guide/workflows/configure-workflows.qmd) -[^7]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) +[^7]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) [^8]: [Add or edit artifact fields](#add-or-edit-artifact-fields) diff --git a/site/guide/model-validation/manage-artifact-severities.qmd b/site/guide/model-validation/manage-artifact-severities.qmd index af178a353c..5d21938ab5 100644 --- a/site/guide/model-validation/manage-artifact-severities.qmd +++ b/site/guide/model-validation/manage-artifact-severities.qmd @@ -29,7 +29,7 @@ aliases: 2. Under {{< fa expand >}} Artifacts, select **Artifact Severities**. -3. Hover over the severity you would like to edit. +3. Hover over the severity you want to edit. 4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pencil >}} Edit Severity**. diff --git a/site/guide/model-validation/preparing-validation-reports.qmd b/site/guide/model-validation/preparing-validation-reports.qmd index dd35bcdbbd..ead792d2fc 100644 --- a/site/guide/model-validation/preparing-validation-reports.qmd +++ b/site/guide/model-validation/preparing-validation-reports.qmd @@ -105,7 +105,7 @@ Modify the contents of the **Latest** version of your validation report:[^11] 2. Add **Risk Assessment Notes**, as well as assess compliance for each section of your validation report: - Validation guidelines are displayed under the header of each section of your report to help ensure that you are compliant with your organization's requirements.[^12] - - Whenever you make a change, a log of the action is recorded under **{{< fa wifi >}} Model Activity**.[^13] + - Whenever you make a change, a log of the action is recorded under **{{< fa wifi >}} Activity**.[^13] 3. For any **Risk Assessment Notes**, save your edits to retain your changes: @@ -136,7 +136,7 @@ Wrap up your report, collaborate with other stakeholders, and submit your work f -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) @@ -148,7 +148,7 @@ Wrap up your report, collaborate with other stakeholders, and submit your work f [^6]: [Assess compliance](/guide/model-validation/assess-compliance.qmd) -[^7]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^8]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) @@ -160,7 +160,7 @@ Wrap up your report, collaborate with other stakeholders, and submit your work f [^12]: [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd) -[^13]: [View model activity](/guide/model-inventory/view-model-activity.qmd) +[^13]: [View record activity](/guide/inventory/view-record-activity.qmd) [^14]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd) diff --git a/site/guide/model-validation/review-model-documentation.qmd b/site/guide/model-validation/review-model-documentation.qmd index 0abf8f1647..c74bd4ea5d 100644 --- a/site/guide/model-validation/review-model-documentation.qmd +++ b/site/guide/model-validation/review-model-documentation.qmd @@ -51,7 +51,7 @@ The **{{< fa check >}} #/# Done** indicator reflects the completion status of yo At the bottom of the Document Overview page, you will also see quick view of any recent documentation activity. - Use the top tabs to narrow down the recent activity. -- Click on **{{< fa eye >}} See All Activity** to be taken to the **{{< fa wifi >}} Model Activity** page. +- Click on **{{< fa eye >}} See All Activity** to be taken to the **{{< fa wifi >}} Activity** page. diff --git a/site/guide/model-validation/view-filter-artifacts.qmd b/site/guide/model-validation/view-filter-artifacts.qmd index d90e42a0f3..f17e69189d 100644 --- a/site/guide/model-validation/view-filter-artifacts.qmd +++ b/site/guide/model-validation/view-filter-artifacts.qmd @@ -141,15 +141,15 @@ Changes are automatically saved to your account and do not affect other users. [^1]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) -[^2]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^3]: [Add and manage artifacts](add-manage-artifacts.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^6]: [Manage supporting documentation](add-manage-artifacts.qmd#manage-supporting-documentation) +[^6]: [Add and manage artifacts](add-manage-artifacts.qmd#manage-attachments) [^7]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) diff --git a/site/guide/monitoring/enable-monitoring.qmd b/site/guide/monitoring/enable-monitoring.qmd index e547b47c2a..086ff75e2e 100644 --- a/site/guide/monitoring/enable-monitoring.qmd +++ b/site/guide/monitoring/enable-monitoring.qmd @@ -138,15 +138,15 @@ After you have enabled ongoing monitoring and run your code to generate some out [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^2]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^4]: Selecting a **[document]{.smallcaps}** to connect to requires {{< var validmind.developer >}} version >=2.12.0. [^5]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd) -[^6]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^7]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/monitoring/review-monitoring-results.qmd b/site/guide/monitoring/review-monitoring-results.qmd index 00f8cedd1f..c957c6a5bd 100644 --- a/site/guide/monitoring/review-monitoring-results.qmd +++ b/site/guide/monitoring/review-monitoring-results.qmd @@ -113,7 +113,7 @@ The final assessment is that the model requires attention: -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Enable monitoring](enable-monitoring.qmd) @@ -121,7 +121,7 @@ The final assessment is that the model requires attention: [^4]: [Enable monitoring](enable-monitoring.qmd) -[^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^6]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/monitoring/work-with-metrics-over-time.qmd b/site/guide/monitoring/work-with-metrics-over-time.qmd index 72aa9c2fef..b76c8f4468 100644 --- a/site/guide/monitoring/work-with-metrics-over-time.qmd +++ b/site/guide/monitoring/work-with-metrics-over-time.qmd @@ -94,13 +94,13 @@ After you have added metrics over time to your document, you can view the follow -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Log metrics over time](/notebooks/how_to/metrics/log_metrics_over_time.ipynb) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) @@ -108,7 +108,7 @@ After you have added metrics over time to your document, you can view the follow [^7]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd) -[^8]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^8]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^9]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/reporting/_create-a-visualization.qmd b/site/guide/reporting/_create-a-visualization.qmd index 4d26628c49..0e5bb2d3b6 100644 --- a/site/guide/reporting/_create-a-visualization.qmd +++ b/site/guide/reporting/_create-a-visualization.qmd @@ -26,7 +26,7 @@ a. Select a **[dataset]{.smallcaps}**: - **Artifact - Model Limitations** — Logged Model Limitation type artifacts only.^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] - **Artifact - Policy Exceptions** — Logged Policy Exception type artifacts only.^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] - **Artifact - Validation Issues** — Logged Validation Issue type artifacts only. - - **Inventory Models** — Models logged in your inventory.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)] + - **Inventory Models** — Models logged in your inventory.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] a. Select the visualization configuration options to apply to the dataset.^[[Visualization configuration options](/guide/reporting/manage-custom-reports.qmd#visualization-configuration-options)] @@ -50,7 +50,7 @@ a. Select a **[dataset]{.smallcaps}**: - **Artifact - Model Limitations** — Logged Model Limitation type [artifacts](/guide/model-validation/working-with-artifacts.qmd){target="_blank"}. only. - **Artifact - Policy Exceptions** — Logged Policy Exception type artifacts only. - **Artifact - Validation Issues** — Logged Validation Issue type artifacts only. - - **Inventory Models** — [Models logged in your inventory](/guide/model-inventory/working-with-model-inventory.qmd){target="_blank"}. + - **Inventory Models** — [Models logged in your inventory](/guide/inventory/working-with-the-inventory.qmd){target="_blank"}. a. Select the [visualization configuration options](/guide/reporting/manage-custom-reports.qmd#visualization-configuration-options){target="_blank"} to apply to the dataset. diff --git a/site/guide/reporting/_view-report-data.qmd b/site/guide/reporting/_view-report-data.qmd index 48d88477a3..dd2ac4f4ed 100644 --- a/site/guide/reporting/_view-report-data.qmd +++ b/site/guide/reporting/_view-report-data.qmd @@ -4,7 +4,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} ::: {.callout} -Reports will not include data or artifacts from archived models.^[[Archive and delete models](/guide/model-inventory/archive-delete-models.qmd)] +Reports will not include data or artifacts from archived models.^[[Archive and delete models](/guide/inventory/archive-delete-records.qmd)] ::: 1. In the left sidebar, click **{{< fa square-poll-vertical >}} Analytics**. diff --git a/site/guide/reporting/export-analytics.qmd b/site/guide/reporting/export-analytics.qmd index 7e9bb4d7c2..c543c29019 100644 --- a/site/guide/reporting/export-analytics.qmd +++ b/site/guide/reporting/export-analytics.qmd @@ -34,7 +34,7 @@ Export analytics widgets as comma-delimited tables (`.csv`). -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) diff --git a/site/guide/reporting/export-artifacts.qmd b/site/guide/reporting/export-artifacts.qmd index c1eb5d1791..b2772655b4 100644 --- a/site/guide/reporting/export-artifacts.qmd +++ b/site/guide/reporting/export-artifacts.qmd @@ -60,7 +60,7 @@ Export tracked model artifacts as comma-delimited tables (`.csv`). -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) diff --git a/site/guide/reporting/export-documents.qmd b/site/guide/reporting/export-documents.qmd index 786e2976d6..03bb65549c 100644 --- a/site/guide/reporting/export-documents.qmd +++ b/site/guide/reporting/export-documents.qmd @@ -63,13 +63,13 @@ Documents exported from {{< var vm.product >}} are compatible with Word 365, Wor -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/reporting/export-inventory.qmd b/site/guide/reporting/export-inventory.qmd index 8cb9291b0a..38aa9d2a92 100644 --- a/site/guide/reporting/export-inventory.qmd +++ b/site/guide/reporting/export-inventory.qmd @@ -33,9 +33,9 @@ Export lists of models tracked in the inventory as comma-delimited tables (`.csv -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^2]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^3]: [Customize model inventory layout](/guide/model-inventory/customize-model-inventory-layout.qmd#customize-table-view) +[^3]: [Customize inventory layout](/guide/inventory/customize-inventory-layout.qmd#customize-table-view) diff --git a/site/guide/reporting/view-report-data.qmd b/site/guide/reporting/view-report-data.qmd index 4b9e764d33..bdea93b40d 100644 --- a/site/guide/reporting/view-report-data.qmd +++ b/site/guide/reporting/view-report-data.qmd @@ -25,6 +25,6 @@ Review detailed data on your models or artifacts within the {{< var validmind.pl -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Add and manage artifacts](/guide/model-validation/add-manage-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 37efc01dbe..7dbcdd4139 100644 --- a/site/guide/reporting/working-with-analytics.qmd +++ b/site/guide/reporting/working-with-analytics.qmd @@ -135,7 +135,7 @@ Rearrange report widgets on your analytics pages, including your custom pages:[^ -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) diff --git a/site/guide/shared/_work-with-filters.qmd b/site/guide/shared/_work-with-filters.qmd index 9ee26d72d8..f98eda71a2 100644 --- a/site/guide/shared/_work-with-filters.qmd +++ b/site/guide/shared/_work-with-filters.qmd @@ -42,9 +42,9 @@ Value editor 2. From the field selector dropdown, select one of: :::: {.content-visible when-format="html" when-meta="includes.inventory"} -- **[model information]{.smallcaps}** — One of the model inventory fields always created by {{< var vm.product >}}, such as the Business Unit. -- **[stakeholders]{.smallcaps}** — Owner, Developer, or Validator, or custom stakeholders if applicable. -- **[model inventory fields]{.smallcaps}** — One of the organization-specific model inventory fields you added for your own use. +- **[record information]{.smallcaps}** — One of the inventory record fields always created by {{< var vm.product >}}, such as the Business Unit. +- **[stakeholders]{.smallcaps}** — Record Owner, Record Developer, or Record Validator, or custom stakeholders if applicable. +- **[record fields]{.smallcaps}** — One of the organization-specific inventory record fields you added for your own use. :::: @@ -64,11 +64,11 @@ Value editor :::: {.columns} ::: {.column width="50%" .pl4 .pr2} -[Model Inventory Filters]{.small-text} +[Inventory Filters]{.small-text} -- **[model information]{.smallcaps}** — One of the model inventory fields always created by {{< var vm.product >}}, such as the Business Unit. -- **[stakeholders]{.smallcaps}** — Owner, Developer, or Validator, or custom stakeholders if applicable. -- **[model inventory fields]{.smallcaps}** — One of the organization-specific model inventory fields you added for your own use. +- **[record information]{.smallcaps}** — One of the inventory record fields always created by {{< var vm.product >}}, such as the Business Unit. +- **[stakeholders]{.smallcaps}** — Record Owner, Record Developer, or Record Validator, or custom stakeholders if applicable. +- **[record fields]{.smallcaps}** — One of the organization-specific inventory record fields you added for your own use. ::: ::: {.column width="50%" .pl4 .pr3} @@ -143,7 +143,7 @@ Select/multi-select ::: {.column width="30%" .pl3} Entity fields -: Dropdown with search for users or models +: Dropdown with search for users or records ::: :::: @@ -224,13 +224,13 @@ Click the {{< fa xmark >}} icon on any filter chip to remove that specific filte ### Simple single rule -Show models where _Model Inventory Field: `Risk Level` is `High`_ (requires that you have a custom select field called `Risk Level`): +Show records where _Record Field: `Risk Level` is `High`_ (requires that you have a custom select field called `Risk Level`): 1. On the Inventory page, click **{{< fa filter >}} Filter**. 2. Click **{{< fa plus >}} Add Rule**: - - Field = `Model Inventory Field: Risk Level` + - Field = `Record Field: Risk Level` - Operator = `equals` - Value = `High` @@ -238,13 +238,13 @@ Show models where _Model Inventory Field: `Risk Level` is `High`_ (requires that ### Simple AND query -Show models that are _Model Stage: In Production AND in Business Unit: Risk Management_: +Show records that are _Stage: In Production AND in Business Unit: Risk Management_: 1. On the Inventory page, click **{{< fa filter >}} Filter**. 2. On the Select Your Filters dialog that opens, click **{{< fa plus >}} Add Rule**: - - Field = `Model Stage` + - Field = `Stage` - Operator = `in` - Value = `In Production` @@ -258,14 +258,14 @@ Show models that are _Model Stage: In Production AND in Business Unit: Risk Mana ### OR query with groups -Show models that are _(Model Stage: In Production AND in Business Unit: Risk Management) OR (Model Stage: In Production AND in Use: Attrition/Churn Management)_: +Show records that are _(Stage: In Production AND in Business Unit: Risk Management) OR (Stage: In Production AND in Use: Attrition/Churn Management)_: 1. On the Inventory page, click **{{< fa filter >}} Filter**. 2. Click **{{< fa plus >}} Add Rule** to add your rules: a. First rule: - - Field = `Model Stage` + - Field = `Stage` - Operator = `in` - Value = `In Production` b. Second rule: @@ -279,7 +279,7 @@ Show models that are _(Model Stage: In Production AND in Business Unit: Risk Man b. In the new group, click **{{< fa plus >}} Add Rule** to add: i. First rule: - - Field = `Model Stage` + - Field = `Stage` - Operator = `in` - Value = `In Production` ii. Second rule: @@ -291,18 +291,18 @@ Show models that are _(Model Stage: In Production AND in Business Unit: Risk Man ### Complex nested query -Show models where _(Model Stage: Active OR In Periodic Review) AND (Risk Level: High OR Medium) AND Owner: John Doe_: +Show records where _(Stage: Active OR In Periodic Review) AND (Risk Level: High OR Medium) AND Owner: John Doe_: 1. On the Inventory page, click **{{< fa filter >}} Filter**. 2. Click **{{< fa folder-plus >}} Add Group** to add your groups: a. First group: - - Field = `Model Stage` + - Field = `Stage` - Operator = `in` - Value = `In Production`, `In Periodic Review` b. Second group: - - Field = `Model Inventory Field: Risk Level` + - Field = `Record Field: Risk Level` - Operator = `equals` - Value = `High`, `Medium` @@ -318,7 +318,7 @@ Show models where _(Model Stage: Active OR In Periodic Review) AND (Risk Level: ### Date range filter -Show models _implemented between January 1, 2025 and January 31, 2025_: +Show records _implemented between January 1, 2025 and January 31, 2025_: 1. On the Inventory page, click **{{< fa filter >}} Filter**. @@ -334,7 +334,7 @@ Show models _implemented between January 1, 2025 and January 31, 2025_: ### Filter by owner and PDF attachments -Show _models owned by a specific user that have `.pdf` attachments_: +Show _records owned by a specific user that have `.pdf` attachments_: 1. On the Inventory page, click **{{< fa filter >}} Filter**. diff --git a/site/guide/shared/work-with-filters.qmd b/site/guide/shared/work-with-filters.qmd index 76d4584744..9f8ace4ba7 100644 --- a/site/guide/shared/work-with-filters.qmd +++ b/site/guide/shared/work-with-filters.qmd @@ -10,7 +10,7 @@ aliases: - select-your-filters.html # NR This page exists only to provide a page we can link to from the filter modal in the product. # The page is intentionally not included in the sidebar because the docs for the filter modal are already embedded in the correct context: -# - /guide/model-inventory/working-with-model-inventory.qmd +# - /guide/inventory/working-with-the-inventory.qmd # - /guide/model-validation/view-filter-artifacts.qmd --- diff --git a/site/guide/templates/_customize-document-templates.qmd b/site/guide/templates/_customize-document-templates.qmd index ce50f24704..cb90ab3659 100644 --- a/site/guide/templates/_customize-document-templates.qmd +++ b/site/guide/templates/_customize-document-templates.qmd @@ -45,7 +45,7 @@ Editing outlines for templates on documents will only apply changes to that docu 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] @@ -72,7 +72,7 @@ Edit outlines for templates directly on documents to only apply changes to that 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] diff --git a/site/guide/templates/_template-schema-generated.qmd b/site/guide/templates/_template-schema-generated.qmd index 8edc74c349..d612d7a795 100644 --- a/site/guide/templates/_template-schema-generated.qmd +++ b/site/guide/templates/_template-schema-generated.qmd @@ -1,12 +1,6 @@ +SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ```{=html} diff --git a/site/guide/templates/manage-document-templates.qmd b/site/guide/templates/manage-document-templates.qmd index 7fee8ead4c..dd25d3aa8a 100644 --- a/site/guide/templates/manage-document-templates.qmd +++ b/site/guide/templates/manage-document-templates.qmd @@ -135,7 +135,7 @@ Delete templates no longer required by your organization: [^3]: [Manage document types](/guide/templates/manage-document-types.qmd) -[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/templates/manage-document-types.qmd b/site/guide/templates/manage-document-types.qmd index 35f06dece4..420a6f7ae1 100644 --- a/site/guide/templates/manage-document-types.qmd +++ b/site/guide/templates/manage-document-types.qmd @@ -91,7 +91,7 @@ In order to delete a document type, there must be no models using that document [^2]: Select a template to be assigned as default from the drop-down menu. -[^3]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) +[^3]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) [^4]: [Manage model documents](manage-model-documents.qmd#edit-model-documents) diff --git a/site/guide/templates/manage-model-documents.qmd b/site/guide/templates/manage-model-documents.qmd index f52b4aad4a..772e0d7c53 100644 --- a/site/guide/templates/manage-model-documents.qmd +++ b/site/guide/templates/manage-model-documents.qmd @@ -180,7 +180,7 @@ Learn more about how to work with the default document types within the {{< var -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Manage document types](manage-document-types.qmd) @@ -188,7 +188,7 @@ Learn more about how to work with the default document types within the {{< var [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^6]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) @@ -225,13 +225,13 @@ Learn more about how to work with the default document types within the {{< var [^14]: [Add model documents](#add-model-documents) -[^15]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^15]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^16]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) [^17]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd) -[^18]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^18]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^19]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/templates/manage-text-block-library.qmd b/site/guide/templates/manage-text-block-library.qmd index d80d979ea0..32208ab8cf 100644 --- a/site/guide/templates/manage-text-block-library.qmd +++ b/site/guide/templates/manage-text-block-library.qmd @@ -94,7 +94,7 @@ To remove an existing text block from your block library: [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^2]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^2]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^3]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) diff --git a/site/guide/workflows/_abort-workflows.qmd b/site/guide/workflows/_abort-workflows.qmd index 6897a6082f..ad823844ed 100644 --- a/site/guide/workflows/_abort-workflows.qmd +++ b/site/guide/workflows/_abort-workflows.qmd @@ -15,7 +15,7 @@ To cancel a run of a workflow: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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 model, locate the [active workflows]{.smallcaps} section. @@ -49,7 +49,7 @@ To cancel a run of a workflow: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [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 model, locate the [active workflows]{.smallcaps} section. diff --git a/site/guide/workflows/_add-model-stages.qmd b/site/guide/workflows/_add-model-stages.qmd index 3c482342c1..aab302d79c 100644 --- a/site/guide/workflows/_add-model-stages.qmd +++ b/site/guide/workflows/_add-model-stages.qmd @@ -4,7 +4,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under {{< fa cube >}} Model Inventory, select **Model Stages**: +1. Under {{< fa cube >}} Inventory, select **Model Stages**: - To add a stage, click **{{< fa plus >}} Add Model Stage**. - To edit a stage, click on the stage itself. diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd index 771408300d..e010c5c9ae 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -13,7 +13,7 @@ c. Click **{{< fa plus >}} Add Workflow**. d. Select the [workflow target]{.smallcaps} type to add: - - **Inventory Model** — Workflows that apply to models in your inventory.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)] + - **Inventory Model** — Workflows that apply to models in your inventory.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] - **Artifact** — Workflows that apply to logged artifacts.^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] ::: {.panel-tabset} @@ -62,7 +62,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 model registration."}
    - [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd){.button} + [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd){.button} ::: @@ -76,7 +76,7 @@ vi. Click **Save Draft** to save your blank workflow, and then [configure your w [^on-field-change]: - [Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd) + [Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)

    When selecting date or date time fields, check **Schedule workflow start for this date** to set the workflow to trigger on the existing date captured in the field rather than when its value changes. diff --git a/site/guide/workflows/_conditional-requirements.qmd b/site/guide/workflows/_conditional-requirements.qmd index 901bd0cbc1..6879e4a530 100644 --- a/site/guide/workflows/_conditional-requirements.qmd +++ b/site/guide/workflows/_conditional-requirements.qmd @@ -58,7 +58,7 @@ Conditional requirements are required or optional for the following step types:^ ### {{< fa users >}} Approval [required]{.smallercaps .pink} -1. Under **[approval group]{.smallcaps}**, click **{{< fa plus >}} Add Individual Approver** to set an individual approver selected from **User Roles**,^[[Manage roles](/guide/configuration/manage-roles.qmd)] **Model Stakeholder Types**,^[[Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd)] or **User** type model inventory fields:^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)] +1. Under **[approval group]{.smallcaps}**, click **{{< fa plus >}} Add Individual Approver** to set an individual approver selected from **User Roles**,^[[Manage roles](/guide/configuration/manage-roles.qmd)] **Model Stakeholder Types**,^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] or **User** type model inventory fields:^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] - Click **{{< fa plus >}} Add Rule** to add an individual rule. - Click **{{< fa square-plus >}} Add Group** to add a group of rules. @@ -77,7 +77,7 @@ Conditional requirements are required or optional for the following step types:^ ### {{< fa bullhorn >}} Broadcast [required]{.smallercaps .pink} -Select from either **Model Stakeholder Types**^[[Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd)] or **User Roles**.^[[Manage roles](/guide/configuration/manage-roles.qmd)] +Select from either **Model Stakeholder Types**^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] or **User Roles**.^[[Manage roles](/guide/configuration/manage-roles.qmd)] ### {{< fa maximize >}} Condition Branch [required]{.smallercaps .pink} @@ -105,11 +105,11 @@ Set a time to **[wait until]{.smallcaps}** as defined by a specific timestamp. #### At Specified Date on Custom Field -Set the **[model field]{.smallcaps}**^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)] with a valid `Date` or `Date Time` type model inventory field that defines the specific timestamp on a per model basis. +Set the **[model field]{.smallcaps}**^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] with a valid `Date` or `Date Time` type model inventory field that defines the specific timestamp on a per model basis. #### Time Delta from Specified Date on Custom Field -a. Set the **[model field]{.smallcaps}**^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)] to a valid `Date` or `Date Time` type model inventory field that defines the specific timestamp on a per model basis. +a. Set the **[model field]{.smallcaps}**^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] to a valid `Date` or `Date Time` type model inventory field that defines the specific timestamp on a per model basis. b. Select a **[time delta direction]{.smallcaps}** relative to your selected field. @@ -158,7 +158,7 @@ To avoid storing credentials in plaintext, use `{{secret:name}}` syntax to refer [^request-fields]: - - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) + - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd) diff --git a/site/guide/workflows/_configure-model-stages.qmd b/site/guide/workflows/_configure-model-stages.qmd index 7eed4b7ab4..8f9c8aba6e 100644 --- a/site/guide/workflows/_configure-model-stages.qmd +++ b/site/guide/workflows/_configure-model-stages.qmd @@ -9,7 +9,7 @@ Configure the model stages available to the models in your model inventory. Mode - You can add, edit, remove, and define your own custom stages. ::: {.callout} -`Archived` and `Deleted` are [Reserved]{.bubble} stages,^[[Archive and delete models](/guide/model-inventory/archive-delete-models.qmd)] meaning they cannot be modified or removed. +`Archived` and `Deleted` are [Reserved]{.bubble} stages,^[[Archive and delete models](/guide/inventory/archive-delete-records.qmd)] meaning they cannot be modified or removed. ::: :::: diff --git a/site/guide/workflows/_configure-workflow-steps.qmd b/site/guide/workflows/_configure-workflow-steps.qmd index 8c3bcfc596..f76ffbfeba 100644 --- a/site/guide/workflows/_configure-workflow-steps.qmd +++ b/site/guide/workflows/_configure-workflow-steps.qmd @@ -29,7 +29,7 @@ Refer to [Introduction to workflows](/guide/workflows/introduction-to-workflows. [^on-webhook]: 1. Click **{{< fa copy >}} Copy** to the right of URL to copy the webhook URL to your clipboard. This webhook URL is where you should send your `POST` request. - 2. Under [select target model for payload]{.smallcaps}, choose a model from [your inventory](/guide/model-inventory/working-with-model-inventory.qmd) to populate the target for the payload. + 2. Under [select target model for payload]{.smallcaps}, choose a model from [your inventory](/guide/inventory/working-with-the-inventory.qmd) to populate the target for the payload. 3. Click **{{< fa copy >}} Copy** to the right of Payload to copy the payload to include in your `POST` request to your clipboard. 4. Click **{{< fa copy >}}** to the right of `x-api-key` and `x-api-secret` and their values to copy them to your clipboard. 5. Send your `POST` request to the webhook URL and include these headers with your request to authenticate your call. diff --git a/site/guide/workflows/_initiate-workflows.qmd b/site/guide/workflows/_initiate-workflows.qmd index 5053cdfbf0..a2d898002b 100644 --- a/site/guide/workflows/_initiate-workflows.qmd +++ b/site/guide/workflows/_initiate-workflows.qmd @@ -15,7 +15,7 @@ To initiate workflows manually:[^initiate-workflows] 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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 model, locate the Workflows section. @@ -64,7 +64,7 @@ To initiate workflows manually: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [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 model, locate the Workflows section. diff --git a/site/guide/workflows/_reset-workflows.qmd b/site/guide/workflows/_reset-workflows.qmd index 9a770911ca..a2883770a6 100644 --- a/site/guide/workflows/_reset-workflows.qmd +++ b/site/guide/workflows/_reset-workflows.qmd @@ -15,7 +15,7 @@ To reset a workflow to the beginning: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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 model, locate the [active workflows]{.smallcaps} section. @@ -49,7 +49,7 @@ To reset a workflow to the beginning: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [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 model, locate the [active workflows]{.smallcaps} section. diff --git a/site/guide/workflows/_review-active-workflows.qmd b/site/guide/workflows/_review-active-workflows.qmd index 1a4bfd75b2..cf69b4121b 100644 --- a/site/guide/workflows/_review-active-workflows.qmd +++ b/site/guide/workflows/_review-active-workflows.qmd @@ -13,7 +13,7 @@ To review details for workflows currently active: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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 model, locate the [active workflows]{.smallcaps} section. @@ -59,7 +59,7 @@ To review details for workflows currently active on models: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [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 model, locate the [active workflows]{.smallcaps} section. @@ -82,7 +82,7 @@ To review details for workflows currently active: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [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 model, locate the [active workflows]{.smallcaps} section. diff --git a/site/guide/workflows/_review-workflow-history.qmd b/site/guide/workflows/_review-workflow-history.qmd index e018c9f896..39b1c7d841 100644 --- a/site/guide/workflows/_review-workflow-history.qmd +++ b/site/guide/workflows/_review-workflow-history.qmd @@ -11,7 +11,7 @@ Review timelines of workflows running or previously run: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +2. Select a model or find your model 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 model, locate the Workflows section that shows a timeline of workflows associated with that model. @@ -105,7 +105,7 @@ Review timelines of workflows running or previously run: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +2. Select a model or find your model [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 model, locate the Workflows section that shows a timeline of workflows associated with that model. diff --git a/site/guide/workflows/_transition-workflows.qmd b/site/guide/workflows/_transition-workflows.qmd index 0fcfcab40c..507a58e618 100644 --- a/site/guide/workflows/_transition-workflows.qmd +++ b/site/guide/workflows/_transition-workflows.qmd @@ -17,14 +17,14 @@ To transition a workflow into next steps: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a model or find your model 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 model, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. 1. If an action is available to your role, you'll see it listed under that workflow: - Click **{{< fa arrow-right >}}** to open up the transition panel for your selected action. This arrow will be followed by the action name. - - Enter your **[notes]{.smallcaps}** and/or any other additional inventory fields^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)]. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**.[^submission-drafts] + - Enter your **[notes]{.smallcaps}** and/or any other additional inventory fields^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)]. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**.[^submission-drafts] 1. Click **{action}** where `action` is the name of your custom user action to submit the entered information and transition the workflow into its next state. @@ -36,7 +36,7 @@ To transition a workflow into next steps: 1. If an action is available to your role, you'll see it listed under that workflow: - Click **{{< fa arrow-right >}}** to open up the transition panel for your selected action. This arrow will be followed by the action name. - - Enter your **[notes]{.smallcaps}** and/or any other additional inventory fields^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)]. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**.[^submission-drafts] + - Enter your **[notes]{.smallcaps}** and/or any other additional inventory fields^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)]. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**.[^submission-drafts] 1. Click **{action}** where `action` is the name of your custom user action to submit the entered information and transition the workflow into its next state. @@ -47,7 +47,7 @@ To transition a workflow into next steps: [^submission-drafts]: - - Working copies are tracked under model activity: [View model activity](/guide/model-inventory/view-model-activity.qmd) + - Working copies are tracked under model activity: [View model activity](/guide/inventory/view-record-activity.qmd) - Working copies can be viewed, edited, and submitted by any other users with permissions to transition the workflow into its next state. - Fields values updated via working copies will reflect on the field itself. @@ -58,7 +58,7 @@ To transition a workflow into next steps on models: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [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 model, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. @@ -80,7 +80,7 @@ To transition a workflow into next steps: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models){target="_blank"}. +1. Select a model or find your model [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 model, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. diff --git a/site/guide/workflows/_workflow-step-types.qmd b/site/guide/workflows/_workflow-step-types.qmd index af7c86bcba..9fa5825079 100644 --- a/site/guide/workflows/_workflow-step-types.qmd +++ b/site/guide/workflows/_workflow-step-types.qmd @@ -130,7 +130,7 @@ When a workflow reaches a webhook step, the workflow will pause. Listen for a `P #### 2. Configure and copy payload -1. Under [select target model for payload]{.smallcaps}, choose a model from your inventory^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)] to populate the target for the payload. +1. Under [select target model for payload]{.smallcaps}, choose a model from your inventory^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] to populate the target for the payload. 2. Click **{{< fa copy >}} Copy** to the right of Payload to copy the payload to your clipboard. @@ -177,7 +177,7 @@ Sends a HTTP request with optional additional conditions.^[[Conditional requirem Select from the drop-down to add it to your User Action step. Users must have write permissions for the field in order to enter values.

    - - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) + - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd) [^approval-1]: **[Configure workflows](/guide/workflows/configure-workflows.qmd#create-custom-workflows):**

    @@ -189,7 +189,7 @@ Sends a HTTP request with optional additional conditions.^[[Conditional requirem [^approval-2]: - - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) + - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd) [^broadcast]: Use the rich text editor to compose your **[subject]{.smallcaps}** and **[message]{.smallcaps}**: @@ -199,7 +199,7 @@ Sends a HTTP request with optional additional conditions.^[[Conditional requirem [^wait]: - - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types) + - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types) - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd#artifact-field-types) [^request-types]: `PUT` and `POST` requests have additional configuration fields: diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index 2e9ce9b56f..619c1cd768 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -184,7 +184,7 @@ Deleting workflow steps on workflows active on models may result in malfunctioni [^6]: [Manage workflows](/guide/workflows/manage-workflows.qmd#update-workflow-versions) -[^7]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^8]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts) diff --git a/site/guide/workflows/manage-model-stages.qmd b/site/guide/workflows/manage-model-stages.qmd index 6b762c7d49..c90ccfaa7f 100644 --- a/site/guide/workflows/manage-model-stages.qmd +++ b/site/guide/workflows/manage-model-stages.qmd @@ -29,7 +29,7 @@ aliases: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa cube >}} Model Inventory, select **Model Stages**. +2. Under {{< fa cube >}} Inventory, select **Model Stages**. 3. Hover over the stage you'd like to modify. diff --git a/site/guide/workflows/manage-workflow-tasks.qmd b/site/guide/workflows/manage-workflow-tasks.qmd index 2592b14e38..2bb9e20101 100644 --- a/site/guide/workflows/manage-workflow-tasks.qmd +++ b/site/guide/workflows/manage-workflow-tasks.qmd @@ -68,9 +68,9 @@ Once completed, tasks will be removed from your view. [^2]: [Manage roles](/guide/configuration/manage-roles.qmd) -[^3]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) +[^3]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) -[^4]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^4]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^5]: [Manage model stages](manage-model-stages.qmd) @@ -84,4 +84,4 @@ Once completed, tasks will be removed from your view. [^10]: [Transition workflows](transition-workflows.qmd) -[^11]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) \ No newline at end of file +[^11]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) \ No newline at end of file diff --git a/site/guide/workflows/manage-workflows.qmd b/site/guide/workflows/manage-workflows.qmd index a0dae5f127..e5c8d8f2a1 100644 --- a/site/guide/workflows/manage-workflows.qmd +++ b/site/guide/workflows/manage-workflows.qmd @@ -121,7 +121,7 @@ To adjust the expected end date for a workflow: -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Configure workflows](configure-workflows.qmd) @@ -129,7 +129,7 @@ To adjust the expected end date for a workflow: [^4]: [Conditional requirements](conditional-requirements.qmd#wait) -[^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^6]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts) @@ -139,6 +139,6 @@ To adjust the expected end date for a workflow: [^9]: [Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows) -[^10]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) +[^10]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) [^11]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts) \ No newline at end of file diff --git a/site/guide/workflows/transition-workflows.qmd b/site/guide/workflows/transition-workflows.qmd index 2e49744b0f..74d4a94c26 100644 --- a/site/guide/workflows/transition-workflows.qmd +++ b/site/guide/workflows/transition-workflows.qmd @@ -33,7 +33,7 @@ Transition a model's or artifact's workflow into its next state, or reset a work -[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd) +[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Manage model stages](manage-model-stages.qmd) diff --git a/site/guide/workflows/workflow-configuration-examples.qmd b/site/guide/workflows/workflow-configuration-examples.qmd index 63d23581f6..212ac3841d 100644 --- a/site/guide/workflows/workflow-configuration-examples.qmd +++ b/site/guide/workflows/workflow-configuration-examples.qmd @@ -313,14 +313,14 @@ In this example, the workflow is designated to stop after running an additional [^13]: [Workflow states](workflow-states.qmd) -[^14]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types) +[^14]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types) -[^15]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) +[^15]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) [^16]: [Manage roles](/guide/configuration/manage-roles.qmd) -[^17]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) +[^17]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) [^18]: [{{< fa users >}} Approval](#approval) -[^19]: [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd) \ No newline at end of file +[^19]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) \ No newline at end of file diff --git a/site/index.qmd b/site/index.qmd index 2b84df55b0..ac83bb25e9 100644 --- a/site/index.qmd +++ b/site/index.qmd @@ -2,7 +2,7 @@ # 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 -pagetitle: "Welcome to our documentation" +pagetitle: "Welcome to our documentation ..." page-layout: full sidebar: false repo-actions: false diff --git a/site/releases/2023/2023-nov-09/highlights.qmd b/site/releases/2023/2023-nov-09/highlights.qmd index ae433a0d82..f1c7e0e7be 100644 --- a/site/releases/2023/2023-nov-09/highlights.qmd +++ b/site/releases/2023/2023-nov-09/highlights.qmd @@ -106,7 +106,7 @@ We've introduced new display options for the **{{< fa cubes >}} Inventory** page ::: {.w-30-ns} -[Inventory display views](/guide/model-inventory/customize-model-inventory-layout.qmd#inventory-display-views){.button .button-green} +[Inventory display views](/guide/inventory/customize-inventory-layout.qmd#inventory-display-views){.button .button-green} ::: diff --git a/site/releases/2023/release-notes-2023-jul-24.qmd b/site/releases/2023/release-notes-2023-jul-24.qmd index 57ab2ac9d3..4789effe05 100644 --- a/site/releases/2023/release-notes-2023-jul-24.qmd +++ b/site/releases/2023/release-notes-2023-jul-24.qmd @@ -116,9 +116,9 @@ We've now enhanced the flexibility of documenting models by allowing you to swap ::: ::: {.w-40-ns .tc} -[View model activity](/guide/model-inventory/view-model-activity.qmd){.button .button-green} +[View record activity](/guide/inventory/view-record-activity.qmd){.button .button-green} -[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd){.button .button-green} +[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd){.button .button-green} ::: diff --git a/site/releases/2024/2024-aug-13/release-notes.qmd b/site/releases/2024/2024-aug-13/release-notes.qmd index 5a1fa8d773..0110c52e8e 100644 --- a/site/releases/2024/2024-aug-13/release-notes.qmd +++ b/site/releases/2024/2024-aug-13/release-notes.qmd @@ -185,7 +185,7 @@ Manage both upstream and downstream model interdependencies: ![Model interdependencies diagram](model-dependencies.png){fig-alt="A diagram of model interdependencies" .screenshot group="interdependencies"} ::: {.tc} -[Configure model interdependencies](/guide/model-inventory/configure-model-interdependencies.qmd){.button} +[Configure model interdependencies](/guide/inventory/configure-record-interdependencies.qmd){.button} ::: ::: diff --git a/site/releases/2024/2024-dec-06/release-notes.qmd b/site/releases/2024/2024-dec-06/release-notes.qmd index 464cceed00..9bb5c34842 100644 --- a/site/releases/2024/2024-dec-06/release-notes.qmd +++ b/site/releases/2024/2024-dec-06/release-notes.qmd @@ -558,13 +558,13 @@ Custom model inventory fields are now more flexible than ever — introducing th ::: ::: {.w-30-ns .tc} -[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#calculation){.button} +[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#calculation){.button} ::: :::: -![Adding a calculation type field](/guide/model-inventory/calculation-field.png){fig-alt="A screenshot showing the screen for adding a calculation type field" width=90% .screenshot} +![Adding a calculation type field](/guide/inventory/calculation-field.png){fig-alt="A screenshot showing the screen for adding a calculation type field" width=90% .screenshot} ::: {.column-margin} **Example formula:** @@ -597,7 +597,7 @@ You can now annotate attachments uploaded to both models or model findings, allo ::: ::: {.w-40-ns .tc} -[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-supporting-documentation){.button} +[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd#manage-supporting-documentation){.button} [Add and manage model findings](/guide/model-validation/add-manage-artifacts.qmd#manage-supporting-documentation){.button} @@ -605,7 +605,7 @@ You can now annotate attachments uploaded to both models or model findings, allo :::: -![Adding attachment notes](/guide/model-inventory/add-attachment-note.gif){ fig-alt="An animated gif demonstrating how to add attachment notes" .screenshot width=90%} +![Adding attachment notes](/guide/inventory/add-attachment-note.gif){ fig-alt="An animated gif demonstrating how to add attachment notes" .screenshot width=90%} - - - - When you're done, click [{{< fa chevron-right >}}]() to continue. :::: @@ -387,7 +434,7 @@ Manage artifact fields ::: {.f4} -{{< include /guide/model-inventory/_field-types.qmd >}} +{{< include /guide/inventory/_field-types.qmd >}} ::: diff --git a/site/training/administrator-fundamentals/onboarding-your-organization.qmd b/site/training/administrator-fundamentals/onboarding-your-organization.qmd index b709132c53..e5024bcd92 100644 --- a/site/training/administrator-fundamentals/onboarding-your-organization.qmd +++ b/site/training/administrator-fundamentals/onboarding-your-organization.qmd @@ -530,5 +530,5 @@ In this first module, you learned how to: Continue your {{< var vm.platform >}} administration journey with:

    -[Customizing Your Model Inventory](customizing-your-model-inventory.html){.button target="_blank"} +[Customizing Your Model Inventory](customizing-your-inventory.html){.button target="_blank"} ::: \ No newline at end of file diff --git a/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd b/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd index 7255293ad0..68bd39d8e0 100644 --- a/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd +++ b/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd @@ -49,7 +49,7 @@ This final module is part of a four-part series: ## Module 4 — Contents {.center} ::: {.f2} -1. [Audit model activity](#audit-model-activity) +1. [Audit record activity](#audit-model-activity) 2. [Audit workflows](#audit-workflows) 3. [Work with analytics](#work-with-analytics) @@ -78,7 +78,7 @@ To continue, you need to have been [onboarded](administrator-fundamentals-regist ::: ::: {.column width="30%"} ::: {.tc} -[Module 2](customizing-your-model-inventory.html){.button target="_blank"} +[Module 2](customizing-your-inventory.html){.button target="_blank"} ::: ::: @@ -100,7 +100,7 @@ Already logged in and refreshed this module? Click [{{< fa chevron-right >}}]() ::: -# Audit model activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} +# Audit record activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} {{< include /training/common-slides/_track-changes-updates.qmd >}} @@ -194,7 +194,7 @@ View report data
    Try it **live** on the next page. {{< fa hand-point-right >}} :::: {.f4 .pr3 .pl3 .mt4 .embed} -Reports will not include data or artifacts from [archived models](/guide/model-inventory/archive-delete-models.qmd){target="_blank"}. +Reports will not include data or artifacts from [archived models](/guide/inventory/archive-delete-records.qmd){target="_blank"}. ::: ::: 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 e77718332d..29e863698d 100644 --- a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd +++ b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd @@ -85,7 +85,7 @@ To continue, you need to have been [onboarded](administrator-fundamentals-regist ::: ::: {.column width="50%"} ::: {.tc} -[Customizing Your Model Inventory](customizing-your-model-inventory.html){.button target="_blank"} +[Customizing Your Model Inventory](customizing-your-inventory.html){.button target="_blank"} ::: ::: diff --git a/site/training/common-slides/_review-model-activity.qmd b/site/training/common-slides/_review-model-activity.qmd index d66d5b8b85..134da303d6 100644 --- a/site/training/common-slides/_review-model-activity.qmd +++ b/site/training/common-slides/_review-model-activity.qmd @@ -6,12 +6,12 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.slideover--b .auto-collapse-10} ::: {.tc} -**Review model activity** +**Review record activity** ::: -1. Select the name of your model you registered for this course to open up the model details page. -2. In the left sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. -3. Confirm activity logged on the model reflects your activities from this training course. +1. Select the name of your record you registered for this course to open up the recird details page. +2. In the left sidebar that appears for your record, click **{{< fa wifi >}} Activity**. +3. Confirm activity logged on the record reflects your activities from this training course. 4. (Optional) Filter the activity by category or specific values to narrow down results. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/common-slides/_track-changes-updates.qmd b/site/training/common-slides/_track-changes-updates.qmd index a1b2c66bff..b7041942a3 100644 --- a/site/training/common-slides/_track-changes-updates.qmd +++ b/site/training/common-slides/_track-changes-updates.qmd @@ -9,18 +9,18 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> Track changes & updates ::: {.tc} -[Learn more ...](/guide/model-inventory/view-model-activity.qmd){.button target="_blank"} +[Learn more ...](/guide/inventory/view-record-activity.qmd){.button target="_blank"} :::
    Try it **live** on the next page. {{< fa hand-point-right >}} ::: ::: {.column width="70%" .bl .pl4 .f4} -#### View model activity +#### View record activity -{{< include /guide/model-inventory/_view-model-activity-overview.qmd >}} +{{< include /guide/inventory/_view-record-activity-overview.qmd >}} -{{< include /guide/model-inventory/_view-model-activity-steps.qmd >}} +{{< include /guide/inventory/_view-record-activity-steps.qmd >}} ::: diff --git a/site/training/developer-fundamentals/developer-fundamentals-register.qmd b/site/training/developer-fundamentals/developer-fundamentals-register.qmd index 80a39b75ad..9cc70cb7df 100644 --- a/site/training/developer-fundamentals/developer-fundamentals-register.qmd +++ b/site/training/developer-fundamentals/developer-fundamentals-register.qmd @@ -33,13 +33,13 @@ listing: title: "Implementing Custom Tests" subtitle: "Module 3" description: "{{< fa check >}} Implement, run, and log custom inline and reusable tests
    {{< fa check >}} Refresh your template to include inserted test-driven blocks
    {{< fa check >}} Configure your template to include custom tests" - reading-time: "45" + reading-time: "60" author: "{{< var vm.product >}}" - path: finalizing-model-documentation.html title: "Finalizing Model Documentation" subtitle: "Module 4" description: "{{< fa check >}} Refine your model documentation
    {{< fa check >}} Submit your model documentation for approval
    {{< fa check >}} Track changes and other updates to your model" - reading-time: "20" + reading-time: "30" author: "{{< var vm.product >}}" fields: [title, subtitle, description, reading-time] --- @@ -60,7 +60,7 @@ Learn how to use {{< var vm.product >}} as a **developer** to generate model doc ::: {.w-50-ns .pr3} #### Total duration -120 minutes +150 minutes ::: diff --git a/site/training/developer-fundamentals/finalizing-model-documentation.qmd b/site/training/developer-fundamentals/finalizing-model-documentation.qmd index 61e23c7122..4ccc095fdf 100644 --- a/site/training/developer-fundamentals/finalizing-model-documentation.qmd +++ b/site/training/developer-fundamentals/finalizing-model-documentation.qmd @@ -54,7 +54,7 @@ This final module is part of a four-part series: 1. [Refine model documentation](#refine-model-documentation) 3. [Submit documentation for approval](#submit-documentation-for-approval) 4. [Collaborate with others](#collaborate-with-others) -5. [Track model activity](#track-model-activity) +5. [Track record activity](#track-model-activity) 6. [View analytics](#view-analytics) ::: @@ -321,7 +321,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. :::: -# Track model activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} +# Track record activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} {{< include /training/common-slides/_track-changes-updates.qmd >}} diff --git a/site/training/program/learning-paths.qmd b/site/training/program/learning-paths.qmd index 2e3550d866..cb3a24e2e8 100644 --- a/site/training/program/learning-paths.qmd +++ b/site/training/program/learning-paths.qmd @@ -43,9 +43,9 @@ Learn how to use {{< var vm.product >}} as an **administrator** to onboard your ::: ::: {.w-50-ns} -#### Module 2
    Customizing Your Model Inventory +#### Module 2
    Customizing Your Inventory -- Configure model inventory & artifact (finding) fields +- Configure your inventory & artifacts - Customize document templates - Configure reusable blocks @@ -66,7 +66,7 @@ Learn how to use {{< var vm.product >}} as an **administrator** to onboard your ::: {.w-50-ns} #### Module 4
    Organizational Oversight & Reporting -- Audit model activity +- Audit record activity - Audit workflows - View and customize analytics diff --git a/site/training/program/training-faq.qmd b/site/training/program/training-faq.qmd index 85fdd0fa3c..f8509eda3e 100644 --- a/site/training/program/training-faq.qmd +++ b/site/training/program/training-faq.qmd @@ -19,7 +19,7 @@ Here's what we have been asked about {{< var vm.product >}} during training sess ::: ::: {.w-40-ns .nb3 .pl2} -[{{< fa graduation-cap >}} training](/training/administrator-fundamentals/customizing-your-model-inventory.html#/section-3){.button-small} [{{< fa book-open >}} docs](/guide/model-inventory/manage-model-inventory-fields.qmd){.button-small} +[{{< fa graduation-cap >}} training](/training/administrator-fundamentals/customizing-your-inventory.html#/section-3){.button-small} [{{< fa book-open >}} docs](/guide/inventory/manage-inventory-fields.qmd){.button-small} ::: :::: @@ -31,7 +31,7 @@ Here's what we have been asked about {{< var vm.product >}} during training sess ::: ::: {.w-40-ns .nb3 .pl2} -[{{< fa graduation-cap >}} training](/training/administrator-fundamentals/customizing-your-model-inventory.html#/section-3){.button-small} [{{< fa book-open >}} docs](/guide/model-inventory/manage-model-inventory-fields.qmd){.button-small} +[{{< fa graduation-cap >}} training](/training/administrator-fundamentals/customizing-your-inventory.html#/section-3){.button-small} [{{< fa book-open >}} docs](/guide/inventory/manage-inventory-fields.qmd){.button-small} ::: :::: @@ -133,7 +133,7 @@ Here's what we have been asked about {{< var vm.product >}} during training sess ::: ::: {.w-40-ns .nb3 .pl2} -[{{< fa graduation-cap >}} training](/training/administrator-fundamentals/customizing-your-model-inventory.html#/section-11){.button-small} [{{< fa book-open >}} docs](/guide/templates/customize-document-templates.qmd){.button-small} +[{{< fa graduation-cap >}} training](/training/administrator-fundamentals/customizing-your-inventory.html#/section-11){.button-small} [{{< fa book-open >}} docs](/guide/templates/customize-document-templates.qmd){.button-small} ::: :::: @@ -171,7 +171,7 @@ Here's what we have been asked about {{< var vm.product >}} during training sess ::: ::: {.w-40-ns .nb3 .pl2} -[{{< fa graduation-cap >}} training](/training/developer-fundamentals/using-validmind-for-model-development.html#/register-a-model){.button-small} [{{< fa book-open >}} docs](/guide/model-inventory/register-models-in-inventory.qmd){.button-small} +[{{< fa graduation-cap >}} training](/training/developer-fundamentals/using-validmind-for-model-development.html#/register-a-model){.button-small} [{{< fa book-open >}} docs](/guide/inventory/register-records-in-inventory.qmd){.button-small} ::: :::: diff --git a/site/training/validator-fundamentals/finalizing-validation-reports.qmd b/site/training/validator-fundamentals/finalizing-validation-reports.qmd index 26e95d307c..c3a514ca25 100644 --- a/site/training/validator-fundamentals/finalizing-validation-reports.qmd +++ b/site/training/validator-fundamentals/finalizing-validation-reports.qmd @@ -64,7 +64,7 @@ This final module is part of a four-part series: ### Section 2 - [Collaborate with others](#collaborate-with-others) -- [Track model activity](#track-model-activity) +- [Track record activity](#track-record-activity) - [View analytics](#view-analytics) ::: @@ -486,7 +486,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. :::: -# Track model activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} +# Track record activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} {{< include /training/common-slides/_track-changes-updates.qmd >}} diff --git a/site/training/validator-fundamentals/validator-fundamentals-register.qmd b/site/training/validator-fundamentals/validator-fundamentals-register.qmd index ec6b558436..4fad4463fc 100644 --- a/site/training/validator-fundamentals/validator-fundamentals-register.qmd +++ b/site/training/validator-fundamentals/validator-fundamentals-register.qmd @@ -21,7 +21,7 @@ listing: title: "Using {{< var vm.product >}} for Model Validation" subtitle: "Module 1" description: "{{< fa check >}} Install the {{< var validmind.developer >}} in your environment
    {{< fa check >}} Connect to a champion model as a validator
    {{< fa check >}} Preview the model's validation report template
    {{< fa check >}} Review submitted model documentation" - reading-time: "20" + reading-time: "30" author: "{{< var vm.product >}}" - path: running-data-quality-tests.html title: "Running Data Quality Tests" @@ -33,13 +33,13 @@ listing: title: "Developing Challenger Models" subtitle: "Module 3" description: "{{< fa check >}} Initialize models for use with the {{< var validmind.developer >}}
    {{< fa check >}} Run and log out-of-the box and custom tests for your models
    {{< fa check >}} Use the results of tests to log model artifacts (findings)" - reading-time: "60" + reading-time: "75" author: "{{< var vm.product >}}" - path: finalizing-validation-reports.html title: "Finalizing Validation Reports" subtitle: "Module 4" description: "{{< fa check >}} Make qualitative edits to your validation report
    {{< fa check >}} Submit your validation report for approval
    {{< fa check >}} Track artifact resolution and other updates to your model" - reading-time: "25" + reading-time: "30" author: "{{< var vm.product >}}" fields: [title, subtitle, description, reading-time] --- @@ -60,7 +60,7 @@ Learn how to use {{< var vm.product >}} as a **validator** to generate validatio ::: {.w-50-ns .pr3} #### Total duration -150 minutes +180 minutes ::: diff --git a/site/training/what-is-validmind/what-is-validmind.qmd b/site/training/what-is-validmind/what-is-validmind.qmd index 7ae9832d20..6cccc4681c 100644 --- a/site/training/what-is-validmind/what-is-validmind.qmd +++ b/site/training/what-is-validmind/what-is-validmind.qmd @@ -212,7 +212,7 @@ The [{{< var vm.product >}} Inventory]{style="background-color: #eaf9fb; padding ::: {.slideover--b .auto-collapse} ::: {.tc} -[[{{< fa circle-info >}} How do I use the {{< var vm.product >}} Inventory?]{.button .button-light-green .shadow-5-ns}](/guide/model-inventory/working-with-model-inventory.qmd){target="_blank"} +[[{{< fa circle-info >}} How do I use the {{< var vm.product >}} Inventory?]{.button .button-light-green .shadow-5-ns}](/guide/inventory/working-with-the-inventory.qmd){target="_blank"} ::: ::: @@ -259,7 +259,7 @@ For example, you can require users to [identify AI applications]{.b} so that the ::: {.slideover--b .auto-collapse} ::: {.tc} -[[{{< fa circle-info >}} How do I register items in the {{< var vm.product >}} Inventory?]{.button .button-light-green .shadow-5-ns}](/guide/model-inventory/register-models-in-inventory.qmd){target="_blank"} +[[{{< fa circle-info >}} How do I register items in the {{< var vm.product >}} Inventory?]{.button .button-light-green .shadow-5-ns}](/guide/inventory/register-records-in-inventory.qmd){target="_blank"} ::: :::