diff --git a/.github/workflows/merge-main-into-staging.yaml b/.github/workflows/merge-main-into-staging.yaml index d695decdeb..fd825af4e6 100644 --- a/.github/workflows/merge-main-into-staging.yaml +++ b/.github/workflows/merge-main-into-staging.yaml @@ -26,9 +26,16 @@ jobs: git config --global user.name "github-actions[bot]" git config --global user.email "github-actions[bot]@users.noreply.github.com" - - name: Merge in main branch + - name: Merge in main branch (prefer main on conflicts) run: | - git merge --no-ff origin/main + if ! git merge -X theirs --no-edit origin/main; then + echo "::warning::Merge reported conflicts; taking main's version for unresolved paths." + git diff --name-only --diff-filter=U | while IFS= read -r file; do + git checkout --theirs -- "$file" + git add -- "$file" + done + git commit --no-edit + fi # NEW: detect the PR that triggered this push to main (if any) - name: Determine source PR (if any) diff --git a/site/_quarto.yml b/site/_quarto.yml index 977562cd82..9cdad331c7 100644 --- a/site/_quarto.yml +++ b/site/_quarto.yml @@ -20,7 +20,7 @@ metadata-files: - installation/_sidebar.yaml website: - # announcement: + # announcement: # content: '[**{{< fa book-open-reader >}} EU AI Act Compliance**](https://validmind.com/download-whitepaper-the-eu-ai-act/) — Read our original regulation brief on how the EU AI Act aims to balance innovation with safety and accountability, setting standards for responsible AI use' # position: above-navbar favicon: favicon.svg @@ -29,7 +29,7 @@ website: type: express style: simple position: center - google-analytics: + google-analytics: tracking-id: "G-S46CKWPNSS" anonymize-ip: true show-item-context: true @@ -37,7 +37,7 @@ website: repo-url: https://github.com/validmind/documentation/ repo-subdir: site/ repo-actions: [edit, issue] - + navbar: collapse-below: xl logo: logo.svg @@ -136,18 +136,21 @@ website: contents: - text: "Access & permissions" file: faq/faq-organizations.qmd - - faq/faq-workflows.qmd - - text: "Inventory & activity" - file: faq/faq-inventory.qmd + - text: "Integrations & support" + file: faq/faq-integrations.qmd + - text: "Workflows & lifecycles" + file: faq/faq-workflows.qmd + - faq/faq-inventory.qmd - text: "Documents & templates" file: faq/faq-documentation.qmd + - faq/faq-testing.qmd - text: "Validation & artifacts" file: faq/faq-validation.qmd - faq/faq-collaboration.qmd - - text: "Monitoring & reporting" + - text: "Reporting & monitoring" file: faq/faq-reporting.qmd - - faq/faq-testing.qmd - - faq/faq-integrations.qmd + - text: "Attestations" + file: faq/faq-attestations.qmd - text: "Data & privacy" file: faq/faq-privacy.qmd @@ -207,7 +210,7 @@ website:
  • Documents & templates
  • Documentation
  • Validation
    • -
  • Reporting
    • +
  • Reporting & auditing
  • Monitoring
  • Attestation
    • @@ -236,7 +239,7 @@ website:
    Training
    diff --git a/site/about/contributing/style-guide/conventions.qmd b/site/about/contributing/style-guide/conventions.qmd index 17fc6e2c78..708a1c1b38 100644 --- a/site/about/contributing/style-guide/conventions.qmd +++ b/site/about/contributing/style-guide/conventions.qmd @@ -47,7 +47,7 @@ In general, follow sentence-style capitalization[^3] to minimize the confusion o | Get started with {{< var vm.product >}} | Get Started with {{< var vm.product >}} | | In the left sidebar, click **{{< fa cubes >}} Inventory**. | In the left sidebar, click **{{< fa cubes >}} inventory**. | | [Honor the Human with {{< var vm.product >}}](https://validmind.com/honor-the-human-with-validmind/) | [Honor the human with {{< var vm.product >}}](https://validmind.com/honor-the-human-with-validmind/) | -| `On the landing page of your model, locate the [model status]{.smallcaps} section:` | `On the landing page of your model, locate the MODEL STATUS section:` | +| Adjust the **[relevance threshold]{.smallcaps}** slider — lower values return more results while higher values show only the most relevant matches. | Adjust the **Relevance Threshold** slider — lower values return more results while higher values show only the most relevant matches. | : **Sentence case** examples {.hover} ### Headings @@ -139,7 +139,7 @@ Change any Markdown link into one of our theme-styled buttons by appending `{.bu ``` ::: {.callout} -Using a markdown button also enables you to link to to the `.qmd` path instead of the rendered `.html` file. +Using a markdown button also enables you to link to the `.qmd` path instead of the rendered `.html` file. ::: ::: @@ -346,7 +346,7 @@ Use backticks to enclose keyboard commands, parameters, field values, and file n |------|-----| | Learn how to store record identifier credentials in a `.env` file instead of using inline credentials. | Learn how to store record identifier credentials in a ".env" file instead of using inline credentials. | | For example, the `classifier_full_suite` test suite runs tests from the `tabular_dataset` and `classifier` test suites to fully document the data and model sections for binary classification model use cases. | For example, the "classifier_full_suite" test suite runs tests from the "tabular_dataset" and "classifier" test suites to fully document the data and model sections for binary classification model use cases. | -| Under When these conditions are met, you are able to set both `AND` and `OR` conditions. | Under When these conditions are met, you are able to set both "AND" and "OR" conditions.| +| Under When These Conditions Are Met, you are able to set both `AND` and `OR` conditions. | Under When These Conditions Are Met, you are able to set both "AND" and "OR" conditions.| : **Backtick** examples {.hover} #### Mathematics diff --git a/site/about/deployment/deployment-options.qmd b/site/about/deployment/deployment-options.qmd index acb49defa8..bbdcb0dde9 100644 --- a/site/about/deployment/deployment-options.qmd +++ b/site/about/deployment/deployment-options.qmd @@ -22,6 +22,11 @@ Choose the {{< var vm.product >}} deployment option that best suits your organiz {{< include _deployment-available-options.qmd >}} +Learn more about each option: + +:::{#validmind-deployment-options} +::: + ## Architecture overview ![{{< var vm.product >}} architecture overview](validmind-architecture-overview.png){fig-alt="An image showing the ValidMind architecture"} @@ -54,15 +59,10 @@ Deployments support secure access via private link, giving you full control over Additionally, all connections are secured with HTTPS/SSL to ensure encrypted communication. -## What's next - -:::{#validmind-deployment-options} -::: - [^1]: [Managing users](/guide/configuration/managing-users.qmd) [^2]: [Data privacy policy](/about/fine-print/data-privacy-policy.qmd) [^3]: [Configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd) [^4]: [Configure Google Cloud Private Service Connect](/guide/configuration/configure-google-private-service-connect.qmd) -[^5]: [Configure Azure Private Link](//guide/configuration/configure-azure-private-link.qmd) +[^5]: [Configure Azure Private Link](/guide/configuration/configure-azure-private-link.qmd) diff --git a/site/about/using-the-documentation.qmd b/site/about/using-the-documentation.qmd index 39f59870e6..b315faa772 100644 --- a/site/about/using-the-documentation.qmd +++ b/site/about/using-the-documentation.qmd @@ -54,10 +54,10 @@ Step-by-step instructions for platform tasks, organized by feature area. | [Integrations](/guide/integrations/managing-integrations.qmd) | Connecting {{< var vm.product >}} to external systems | Manage secrets, configure connections, link external records (models) | | [Workflows](/guide/guides.qmd#workflows) | Automating lifecycle processes | Configure workflow steps, manage transitions, set up approvals | | [Inventory](/guide/guides.qmd#inventory) | Managing your records (models) and record inventory | Register records, edit fields, configure interdependencies | -| [Documents & templates](/guide/templates/working-with-documents.qmd) | Creating and customizing documentation | Manage document types, customize templates, use the text block library | +| [Documents & templates](/guide/templates/managing-documents.qmd) | Creating and customizing documentation | Manage document types, customize templates, use the text block library | | [Documentation](/guide/guides.qmd#documentation) | Authoring and collaborating on documents | Edit content blocks, add test results, manage versions, submit for approval | | [Validation](/guide/guides.qmd#validation) | Reviewing and validating records (models) | Review documentation, assess compliance, manage findings and artifacts | -| [Reporting](/guide/guides.qmd#reporting) | Analyzing and exporting data | View reports, create custom analytics, export inventory and documents | +| [Reporting & auditing](/guide/guides.qmd#reporting-auditing) | Analyzing, exporting, and auditing data | View reports, track organization activity, create custom analytics, export inventory and documents | | [Monitoring](/guide/guides.qmd#monitoring) | Tracking record (model) performance over time | Enable monitoring, review results, set thresholds and alerts | | [Attestation](/guide/guides.qmd#attestation) | Managing formal attestations | Create, submit, review, and approve attestations | diff --git a/site/developer/quickstart/install-and-initialize-validmind-library.qmd b/site/developer/quickstart/install-and-initialize-validmind-library.qmd index e0eb1656f6..a09c2cf6d2 100644 --- a/site/developer/quickstart/install-and-initialize-validmind-library.qmd +++ b/site/developer/quickstart/install-and-initialize-validmind-library.qmd @@ -60,18 +60,18 @@ Retrieve your code snippet for your record's selected document from the {{< var 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 retrieve the code snippet for.[^4] +2. Select the type of `{Record}` you want to retrieve the code snippet for by clicking on **{Record} Inventory**.[^4] 3. Select a record by clicking on it or find your record by applying a filter or searching for it.[^5] 4. In the left sidebar that appears for your record, click **{{< fa rocket >}} Getting Started**. -5. Select the **[document]{.smallcaps}** you want to automatically upload test results to.[^6] +5. Select the **Document** you want to automatically upload test results to.[^6] 6. Click **{{< fa regular copy >}} Copy snippet to clipboard**. ::: {.callout} -## Selecting a **[document]{.smallcaps}** to connect to requires {{< var validmind.developer >}} version >=2.12.0.[^7] +## Selecting a **Document** to connect to requires {{< var validmind.developer >}} version >=2.12.0.[^7] A template must already be applied to your selected document to populate test results in the {{< var validmind.platform >}}. Attempting to initialize the {{< var vm.developer >}} with a document that does not have a template applied will result in an error. @@ -159,7 +159,7 @@ Version: 2.11.0 [^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^6]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^6]: [Managing documents](/guide/templates/managing-documents.qmd) [^7]: [Upgrade the {{< var validmind.developer >}}](#upgrade-validmind) diff --git a/site/developer/quickstart/store-credentials-in-env-file.qmd b/site/developer/quickstart/store-credentials-in-env-file.qmd index c59d30396e..44e85fb267 100644 --- a/site/developer/quickstart/store-credentials-in-env-file.qmd +++ b/site/developer/quickstart/store-credentials-in-env-file.qmd @@ -59,13 +59,13 @@ In the {{< var validmind.platform >}}, retrieve the code snippet for your record i. In the left sidebar, click **{{< fa cubes >}} Inventory**. -ii. Under the [record type]{.smallcaps} drop-down, select the type of record you want to retrieve the code snippet for.[^3] +ii. Select the type of `{Record}` you want to retrieve the code snippet for by clicking on **{Record} Inventory**.[^3] iii. Select a record by clicking on it or find your record by applying a filter or searching for it.[^4] iv. In the left sidebar that appears for your record, click **{{< fa rocket >}} Getting Started**. -v. Select the **[document]{.smallcaps}** you want to automatically upload test results to.[^5] +v. Select the **Document** you want to automatically upload test results to.[^5] vi. Click **{{< fa regular copy >}} Copy snippet to clipboard**. @@ -164,7 +164,7 @@ c. Run the cell. [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^5]: [Managing documents](/guide/templates/managing-documents.qmd) [^6]: diff --git a/site/faq/_faq-document-checker.qmd b/site/faq/_faq-document-checker.qmd new file mode 100644 index 0000000000..261f6c9c88 --- /dev/null +++ b/site/faq/_faq-document-checker.qmd @@ -0,0 +1,9 @@ + + +## How does {{< var vm.product >}} help me create compliant documentation? + +Use the {{< var validmind.checker >}} to analyze your completed documents by comparing them against regulatory standards.^[[Check documents for compliance](/guide/documentation/check-documents-for-compliance.qmd)] + +{{< include /guide/documentation/_document-checker.qmd >}} \ No newline at end of file diff --git a/site/faq/_faq-record-updates.qmd b/site/faq/_faq-document-updates.qmd similarity index 79% rename from site/faq/_faq-record-updates.qmd rename to site/faq/_faq-document-updates.qmd index 739040675e..1ed751f0f6 100644 --- a/site/faq/_faq-record-updates.qmd +++ b/site/faq/_faq-document-updates.qmd @@ -2,8 +2,8 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -## How does {{< var vm.product >}} manage updates to records? +## How are updates to test results on documents managed? -1. {{< var vm.product >}} allows developers to re-run documentation functions with the {{< var validmind.developer >}}^[[{{< var validmind.developer >}}](/developer/validmind-library.qmd)] to capture changes in the record (such as a model), such as changes in the number of features or hyperparameters. -2. After a developer has made a change in their development environment, such as to a Jupyter Notebook,^[[Code samples](/developer/samples-jupyter-notebooks.qmd)] they can execute the relevant {{< var vm.product >}} documentation function to update the corresponding documentation section. -3. {{< var vm.product >}} will then automatically recreate the relevant figures and tables and update them in the online documentation. \ No newline at end of file +1. {{< var vm.product >}} allows developers to re-run documentation functions with the {{< var validmind.developer >}}^[[{{< var validmind.developer >}}](/developer/validmind-library.qmd)] to capture changes in the record (such as a model), such as changes in the number of features or hyperparameters. +2. After a developer has made a change in their development environment, such as to a Jupyter Notebook,^[[Code samples](/developer/samples-jupyter-notebooks.qmd)] they can execute the relevant {{< var vm.product >}} documentation function to update the corresponding documentation section. +3. {{< var vm.product >}} will then automatically recreate the relevant figures and tables and update them in the online documentation.^[[Work with test results](/guide/documentation/work-with-test-results.qmd)] diff --git a/site/faq/_faq-exporting.qmd b/site/faq/_faq-exporting.qmd index 67f93679ac..ad2732d614 100644 --- a/site/faq/_faq-exporting.qmd +++ b/site/faq/_faq-exporting.qmd @@ -2,6 +2,12 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -## Can documents be exported? +## What export options are available in {{< var vm.product >}}? + +- Inventory records can be exported as comma-delimited tables (`.csv`)^[[Export inventory](/guide/reporting/export-inventory.qmd)] +- Documents can be exported as Word (.docx) or Portable Document Format (.pdf) files^[[Export documents](/guide/reporting/export-documents.qmd)] +- Artifacts can be exported as comma-delimited tables (`.csv`)^[[Export artifacts](/guide/reporting/export-artifacts.qmd)] +- Analytics can be exported as comma-delimited tables (`.csv`)^[[Export analytics](/guide/reporting/export-analytics.qmd)] + +{{< var vm.product >}} also allows you to export analytics datasets on a schedule to cloud storage, such as Amazon S3, Google Cloud Storage, or Azure Blob Storage.^[[Configure data exports](/guide/integrations/configure-data-exports.qmd)] -Yes, {{< var vm.product >}} currently supports exporting documents in Word (.docx) format.^[Depending on the integration requirements of the systems used by your validation teams, such as connectivity via API, SharePoint, and more, {{< var vm.product >}} can work with you to automate the export and storage of documents into these systems.] \ No newline at end of file diff --git a/site/faq/_faq-progress-workflow.qmd b/site/faq/_faq-progress-workflow.qmd index dd9e0f62b3..4e49b576e9 100644 --- a/site/faq/_faq-progress-workflow.qmd +++ b/site/faq/_faq-progress-workflow.qmd @@ -4,6 +4,6 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ## How do I progress a record along in its lifecycle within {{< var vm.product >}}? -Transition a record (such as a model) along in the workflow, for example for review with the next set of stakeholders, by changing a record's status. +Transition a record (such as a model) along in the workflow, for example for review with the next set of stakeholders, by changing a record's stage. {{< include /guide/workflows/_transition-workflow-examples.qmd >}} \ No newline at end of file diff --git a/site/faq/_faq-activity.qmd b/site/faq/_faq-record-activity.qmd similarity index 54% rename from site/faq/_faq-activity.qmd rename to site/faq/_faq-record-activity.qmd index 42dee4c34c..80a3eea347 100644 --- a/site/faq/_faq-activity.qmd +++ b/site/faq/_faq-record-activity.qmd @@ -2,7 +2,7 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -## Is activity on records, documents, etc. logged? +## Is activity on records, documents, and artifacts logged? - Yes, the {{< var validmind.platform >}}^[[Accessing {{< var vm.product >}}](/guide/access/accessing-validmind.qmd)] provides an audit trail functionality, enabling you to track or audit all the events associated with a specific record (such as a model). -- You can review a full record of comments, workflow status changes, and any other updates made to the record, including modifications to documents or test results. \ No newline at end of file +- You can review a full history of updates to a record, such as changes to record fields and stakeholders, workflow activity and stage transitions, modifications to documents, artifacts, and test results or metrics, and comment thread activity.^[[View record activity](/guide/reporting/view-record-activity.qmd)] diff --git a/site/faq/_faq-settings-activity.qmd b/site/faq/_faq-settings-activity.qmd new file mode 100644 index 0000000000..b93f48176e --- /dev/null +++ b/site/faq/_faq-settings-activity.qmd @@ -0,0 +1,8 @@ + + +## Are updates to organization settings or configuration tracked? + +- Yes, the {{< var validmind.platform >}} provides an audit trail functionality, enabling you to track or audit all the events associated with a specific organization's settings. +- You can review a full history of updates to organization settings, such as changes to users and groups, permissions and roles, inventory record or artifact settings, document settings, governance settings, workflow and integration setup, and more.^[[View settings activity](/guide/reporting/view-settings-activity.qmd)] diff --git a/site/faq/_faq-tracking.qmd b/site/faq/_faq-tracking.qmd index 2a8c460248..df96d14577 100644 --- a/site/faq/_faq-tracking.qmd +++ b/site/faq/_faq-tracking.qmd @@ -4,5 +4,5 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ## Can I use {{< var vm.product >}} to track milestone dates? -- Yes, the {{< var validmind.platform >}} includes support for custom inventory fields, including those for dates and date time — allowing you to track important dates throughout the risk management lifecycle unique to your workflow. -- In addition, calculation type custom inventory fields can draw upon date and date time values, allowing you to automatically calculate next review, revalidation, ongoing monitoring deadlines, or any other desired date. +- Yes, the {{< var validmind.platform >}} includes support for custom inventory fields,^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)] including those for dates and date time — allowing you to track important dates throughout the risk management lifecycle unique to your workflow. +- In addition, calculation type custom inventory fields can draw upon date and date time values, allowing you to automatically calculate next review, revalidation, ongoing monitoring deadlines, or any other desired date. diff --git a/site/faq/faq-attestations.qmd b/site/faq/faq-attestations.qmd new file mode 100644 index 0000000000..1f975d7316 --- /dev/null +++ b/site/faq/faq-attestations.qmd @@ -0,0 +1,118 @@ +--- +# 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: "Attestations" +date: last-modified +listing: + - id: faq-attestations + type: grid + grid-columns: 2 + max-description-length: 250 + sort: false + fields: [title, description] + contents: + - ../guide/attestation/working-with-attestations.qmd +categories: ["attestations", "governance", "auditing", "activity"] +--- + +## Who can submit, review, and approve attestations? + +- Submitters are selected from inventory record stakeholders,[^1] such as Record Owner, Record Developer, or Record Validator. +- Reviewers and approvers are selected from roles,[^2] and their access is scoped to the groups they are responsible for.[^3] + +## Why aren't attestations displayed right after I create them? + +The {{< fa clipboard-check >}} Attestations dashboard and attestation period selectors only show active or past periods. If the only periods you have configured are future-dated (start date in the future), nothing appears there until the start date — this is expected behavior, not a configuration error. + +After you configure attestation templates and periods,[^4] participants are notified when the period begins. + +## Why are my attestations split into multiple submissions? + +Attestations are organized by both record owner and group.[^5] + +If you own records across multiple groups, you may receive separate submissions so each group's reviewer or approver can act only on the records they are permitted to govern. + +## Can I schedule recurring attestation periods? + +No. Attestation periods must be scheduled individually. You can create quarterly, annual, or other periods, but each period needs its own start and end date. + +## Can I start an attestation period in the past? + +No. The start date must be today or a future date. You cannot backdate an attestation period to trigger attestations retroactively. + +## What happens when an attestation period starts? + +1. When the period begins, {{< var validmind.platform >}} captures a snapshot of the included records,[^6] validation issues, and other artifacts.[^7] + +2. Participants are notified that their attestation tasks are ready, and they can access them from **{{< fa inbox >}} My Inbox**[^8] or the **{{< fa clipboard-check >}} Attestations** dashboard. + +## What information is captured in an attestation snapshot? + +The snapshot captures the records included in the attestation scope, selected inventory fields for relevant records,[^9] open validation issues, and other artifacts[^10] at the time the period starts. + +When the period is completed, {{< var validmind.platform >}} captures a final snapshot for before-and-after comparison. + +## Can I change an attestation after signing off? + +No. Attestation sign-offs are permanent. After an approver signs off, the attestation is recorded in the record's history as part of the audit trail.[^11] + +## What happens if a reviewer rejects an attestation? + +1. The attestation returns to the submitter for revisions.[^12] + +2. The submitter updates their responses and resubmits the questionnaire for review.[^13] {{< var validmind.platform >}} keeps a history of the status changes and notes.[^14] + +## Can I complete a period before all submissions are signed off? + +Yes. Administrators can manually complete an active period before all submissions are finished. After completion, no further actions can be taken on any submissions in that period.[^15] + +## Why can't I delete an attestation template? + +You cannot delete a template while it has active attestation periods. Complete or cancel any active periods first, then delete the template.[^16] + +## Can I export attestation responses and snapshots? + +Yes. From the Attestations dashboard, you can export data from the Progress, Responses, Inventory, Validation Issues, and Artifacts tabs in comma-separated values (`.csv`) or Excel (`.xlsx`) format.[^17] + +## Learn more + +:::{#faq-attestations} +::: + + + + +[^1]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) + +[^2]: [Manage roles](/guide/configuration/manage-roles.qmd) + +[^3]: [Manage groups](/guide/configuration/manage-groups.qmd) + +[^4]: [Manage attestations](/guide/attestation/manage-attestations.qmd) + +[^5]: [Manage groups](/guide/configuration/manage-groups.qmd) + +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) + +[^7]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) + +[^8]: [Manage platform notifications](/guide/configuration/manage-platform-notifications.qmd#view-platform-notifications) + +[^9]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) + +[^10]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) + +[^11]: [Approve attestations](/guide/attestation/approve-attestations.qmd) + +[^12]: [Review attestations](/guide/attestation/review-attestations.qmd) + +[^13]: [Submit attestations](/guide/attestation/submit-attestations.qmd) + +[^14]: [View record activity](/guide/reporting/view-record-activity.qmd) + +[^15]: [Manage attestations](/guide/attestation/manage-attestations.qmd#complete-attestation-periods) + +[^16]: [Manage attestations](/guide/attestation/manage-attestations.qmd#delete-attestation-templates) + +[^17]: [Manage attestations](/guide/attestation/manage-attestations.qmd#export-attestation-data) diff --git a/site/faq/faq-collaboration.qmd b/site/faq/faq-collaboration.qmd index 76e1dd16ac..07f9c2ff12 100644 --- a/site/faq/faq-collaboration.qmd +++ b/site/faq/faq-collaboration.qmd @@ -12,34 +12,29 @@ listing: sort: false fields: [title, description] contents: - - ../guide/inventory/view-record-activity.qmd - ../guide/documentation/collaborate-with-others.qmd - ../guide/workflows/working-with-workflows.qmd -categories: ["real-time collaboration", "documents","documentation", "record activity", "auditing", "workflows", "lifecycle", "validmind platform"] + - ../guide/reporting/tracking-organization-activity.qmd +categories: ["real-time collaboration", "documents", "documentation", "activity", "auditing", "workflows", "lifecycle", "validmind platform"] --- -{{< include _faq-activity.qmd >}} - ## What real-time collaboration features does {{< var vm.product >}} offer? - You can simultaneously edit documents, leave and respond to comments or suggestions all within the {{< var validmind.platform >}}. - You can also save named versions of edits to retain specific revisions, and any changes to documents are automatically logged on your record's activity feed. ::: {.callout} -## Multiple users are able to simultaneously edit documents in the {{< var validmind.platform >}}. +## Multiple users are able to simultaneously edit documents in the {{< var validmind.platform >}}. -If two users are editing the same cell within {{< var vm.platform >}}, the most recently saved version of the content will prevail. +If two users are editing the same cell within {{< var vm.platform >}}, the most recently saved version of the content will prevail. ::: {{< include _faq-progress-workflow.qmd >}} +{{< include _faq-record-activity.qmd >}} - - - ## Learn more diff --git a/site/faq/faq-documentation.qmd b/site/faq/faq-documentation.qmd index bd78fd0859..5386d02b7a 100644 --- a/site/faq/faq-documentation.qmd +++ b/site/faq/faq-documentation.qmd @@ -9,14 +9,15 @@ aliases: listing: - id: faq-documentation type: grid - grid-columns: 2 + grid-columns: 3 max-description-length: 250 sort: false fields: [title, description] contents: + - ../guide/templates/managing-documents.qmd - ../guide/templates/working-with-document-templates.qmd - ../guide/documentation/working-with-documentation.qmd -categories: ["templates", "documents", "documentation","customization", "images", "validmind platform", "validmind library"] +categories: ["templates", "documents", "documentation", "customization", "images", "attachments","validmind platform", "validmind library"] --- ## What kind of templates are provided by {{< var vm.product >}}? @@ -27,31 +28,38 @@ categories: ["templates", "documents", "documentation","customization", "images" - Validation (validation reports) - Monitoring (ongoing monitoring reports) -You can also create custom document types and associated templates to suit your organization's unique needs. +You can also create custom document types and associated templates to suit your organization's unique needs.[^2] ## Can templates be customized for our use cases? -Yes, the {{< var validmind.platform >}}[^2] allows you to configure versioned templates based on document requirements for each record (such as a model) or lifecycle use case. +Yes, the {{< var validmind.platform >}}[^3] allows you to configure versioned templates based on document requirements for each record (such as a model) or lifecycle use case. -- {{< var vm.product >}}'s templates are fully customizable,[^3] and are complemented by the ability to manage validation guidelines. -- You can swap between different versions of templates or apply another version of the current template.[^4] +- {{< var vm.product >}}'s templates are fully customizable,[^4] and are complemented by the ability to manage validation guidelines. +- You can swap between different versions of templates or apply another version of the current template.[^5] - Template outlines can be modified right in the {{< var validmind.platform >}}. We also offer an advanced raw YAML editor, enabling you to make detailed changes. -By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^5] has sufficient permissions to manage document templates, and you must be a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble} to be able to swap document templates. +By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^6] has sufficient permissions to manage document templates, and you must be a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble} to be able to swap document templates. + +## Is content from existing documents or templates reusable? + +Yes, you can reuse content from existing documents or templates: + +- Build a library of reusable text blocks to insert into your documents, including content from existing documents.[^13] +- Duplicate document templates to create new templates with the same content, then edit those duplicates to fit your needs.[^14] ## Can documents be created right in the {{< var validmind.platform >}}? -Yes, you can work with documentation, validation reports, ongoing monitoring reports, or any other document type directly in the {{< var validmind.platform >}}, without having to first generate anything using the {{< var validmind.developer >}}.[^6] +Yes, you can work with documentation, validation reports, ongoing monitoring reports, or any other document type directly in the {{< var validmind.platform >}}, without having to first generate anything using the {{< var validmind.developer >}}.[^7] -1. Add and edit text on any document within the {{< var vm.platform >}} using our content editing toolbar.[^7] -2. Using the {{< var vm.developer >}}, execute test suites and generate the corresponding supporting results. These results can then be added to your documents within the {{< var vm.platform >}}.[^8] +1. Add and edit text on any document within the {{< var vm.platform >}} using our content editing toolbar.[^8] +2. Using the {{< var vm.developer >}}, execute test suites and generate the corresponding supporting results. These results can then be added to your documents within the {{< var vm.platform >}}.[^9] ## Can I run tests and log documentation without a record? Yes! If you do not have a record (such as a model) ready, or your record can't be loaded directly, or you only have access to predictions, you can still run tests and log documentation using the {{< var validmind.developer >}} as long as you're able to load the predictions. -- Use `assign_predictions()`[^9] to load predictions from a separate file or a dataset with predictions. -- Call `init_model()`[^10] to create a model object, but instead of a trained instance, pass an `input_id` and model metadata. `ModelMetadata()`[^11] will use the provided metadata instead of trying to calculate it from the model's library. +- Use `assign_predictions()`[^10] to load predictions from a separate file or a dataset with predictions. +- Call `init_model()`[^11] to create a model object, but instead of a trained instance, pass an `input_id` and model metadata. `ModelMetadata()`[^12] will use the provided metadata instead of trying to calculate it from the model's library. ::: {.column-margin} @@ -75,18 +83,18 @@ Yes! If you do not have a record (such as a model) ready, or your record can't b {{< include _faq-images.qmd >}} -{{< include _faq-exporting.qmd >}} +{{< include _faq-document-updates.qmd >}} - +## Can we leverage content from historical or external documents? - +{{< include _faq-exporting.qmd >}} ## Learn more @@ -98,22 +106,30 @@ These features are currently on the roadmap and under research, no release sched [^1]: [Manage document templates](/guide/templates/manage-document-templates.qmd) -[^2]: [Accessing {{< var vm.product >}}](/guide/access/accessing-validmind.qmd) +[^2]: [Manage document types](/guide/templates/manage-document-types.qmd) + +[^3]: [Accessing {{< var vm.product >}}](/guide/access/accessing-validmind.qmd) + +[^4]: [Customize document templates](/guide/templates/customize-document-templates.qmd) + +[^5]: [Manage document templates](/guide/templates/manage-document-templates.qmd) + +[^6]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^3]: [Customize document templates](/guide/templates/customize-document-templates.qmd) +[^7]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) -[^4]: [Manage document templates](/guide/templates/manage-document-templates.qmd) +[^8]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd) -[^5]: [Manage permissions](/guide/configuration/manage-permissions.qmd) +[^9]: [Work with test results](/guide/documentation/work-with-test-results.qmd) -[^6]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) +[^10]: [`assign_predictions()`](/validmind/validmind/vm_models.qmd#assign_predictions) -[^7]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd) +[^11]: [`init_model()`](/validmind/validmind.qmd#init_model) -[^8]: [Work with test results](/guide/documentation/work-with-test-results.qmd) +[^12]: [`ModelMetadata()`](/validmind/validmind/tests/model_validation/ModelMetadata.qmd#modelmetadata) -[^9]: [`assign_predictions()`](/validmind/validmind/vm_models.qmd#assign_predictions) +[^13]: [Manage text block library](/guide/templates/manage-text-block-library.qmd) -[^10]: [`init_model()`](/validmind/validmind.qmd#init_model) +[^14]: [Manage document templates](/guide/templates/manage-document-templates.qmd) -[^11]: [`ModelMetadata()`](/validmind/validmind/tests/model_validation/ModelMetadata.qmd#modelmetadata) +[^15]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) diff --git a/site/faq/faq-integrations.qmd b/site/faq/faq-integrations.qmd index e1be635668..d409a7f831 100644 --- a/site/faq/faq-integrations.qmd +++ b/site/faq/faq-integrations.qmd @@ -9,7 +9,7 @@ aliases: listing: - id: faq-integrations type: grid - grid-columns: 3 + grid-columns: 2 max-description-length: 250 sort: false fields: [title, description] @@ -17,6 +17,7 @@ listing: - ../developer/supported-records-and-frameworks.qmd - ../about/overview-llm-features.qmd - ../about/deployment/deployment-options.qmd + - ../guide/integrations/managing-integrations.qmd categories: ["supported libraries", "supported languages", "integrations", "images", "large language models", "explainability", "deployment options", "validmind library"] --- @@ -42,7 +43,7 @@ Support for commercial and closed-source programming languages such as SAS and M ## What large language model (LLM) features are offered? {{< var vm.product >}} offers several specialized features that use large language models (LLMs) to streamline risk management and ensure regulatory compliance: - + - **Test interpretation** — Interprets results from tests run within {{< var vm.product >}}. - **Qualitative checks** — Leverages metadata from the inventory, test outcomes, and additional data provided to create qualitative sections within documentation. - **Risk assessment** — Using data from test results, generates a tailored risk assessment for each section of documentation. @@ -54,6 +55,22 @@ Support for commercial and closed-source programming languages such as SAS and M {{< include /about/deployment/_deployment-available-options.qmd >}} +## What third-party integrations are supported by {{< var vm.product >}}? + +{{< var vm.product >}} supports integrations across inventory synchronization, workflow automation, data exports, service integrations, API access, testing and documentation, and AI assistants.[^9] + +Supported connections include:[^10] + +- **Inventory and model registries** — AWS SageMaker,[^11] AWS Bedrock,[^12] Databricks,[^13] MLflow, GitLab,[^14] and custom integrations.[^15] +- **Service and ticketing systems** — Atlassian Jira[^16] and ServiceNow.[^17] +- **Analytics and reporting** — Microsoft Power BI, plus scheduled data exports to cloud storage for use with external BI and reporting tools.[^18] +- **Workflow automation** — HTTP requests from {{< var vm.product >}} to external services and webhooks from external systems into {{< var vm.product >}}.[^19] +- **Testing and documentation** — {{< var validmind.developer >}} integrations with development platforms, including MLflow and AWS SageMaker.[^20] +- **AI assistants** — Claude Desktop and Cursor IDE through the Model Context Protocol (MCP).[^21] + +If your system isn't supported out-of-the-box, you can build a custom integration that implements the {{< var vm.product >}} reference API.[^22] + + ## Learn more :::{#faq-integrations} @@ -76,4 +93,32 @@ Support for commercial and closed-source programming languages such as SAS and M [^7]: [Do you include explainability-related testing and documentation?](#explainability) -[^8]: [Customize {{< var validmind.checker >}}](/guide/templates/customize-document-checker.qmd) \ No newline at end of file +[^8]: [Customize {{< var validmind.checker >}}](/guide/templates/customize-document-checker.qmd) + +[^9]: [Managing integrations](/guide/integrations/managing-integrations.qmd) + +[^10]: [Configure connections](/guide/integrations/configure-connections.qmd) + +[^11]: [Synchronize records with AWS SageMaker](/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd) + +[^12]: [Synchronize records with AWS Bedrock](/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd) + +[^13]: [Synchronize with Databricks](/guide/integrations/integrations-examples/synchronize-with-databricks.qmd) + +[^14]: [Synchronize records with GitLab](/guide/integrations/integrations-examples/synchronize-gitlab.qmd) + +[^15]: [Implement custom integrations](/guide/integrations/implement-custom-integrations.qmd) + +[^16]: [Create a Jira ticket](/guide/integrations/integrations-examples/create-jira-ticket.qmd) + +[^17]: [Create a ServiceNow incident](/guide/integrations/integrations-examples/create-servicenow-incident.qmd) + +[^18]: [Configure data exports](/guide/integrations/configure-data-exports.qmd) + +[^19]: [Use webhooks with workflows](/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd) + +[^20]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) + +[^21]: [Connect AI assistants via MCP](/guide/mcp/connect-ai-assistants-via-mcp.qmd) + +[^22]: [Implement custom integrations](/guide/integrations/implement-custom-integrations.qmd) \ No newline at end of file diff --git a/site/faq/faq-inventory.qmd b/site/faq/faq-inventory.qmd index 3cb987a699..cbe623d9dd 100644 --- a/site/faq/faq-inventory.qmd +++ b/site/faq/faq-inventory.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 -title: "Inventory and activity" +title: "Inventory" date: last-modified aliases: - /guide/faq-inventory.html @@ -14,14 +14,12 @@ listing: sort: false fields: [title, description] contents: - - ../guide/inventory/view-record-activity.qmd + - ../guide/inventory/setting-up-the-inventory.qmd - ../guide/inventory/working-with-the-inventory.qmd - ../guide/inventory/managing-the-inventory.qmd -categories: ["inventory", "inventory registration", "inventory customization", "inventory interdependencies", "activity", "auditing", "exports", "validmind platform"] +categories: ["inventory", "record registration", "inventory customization", "record interdependencies", "exports", "validmind platform"] --- -{{< include _faq-activity.qmd >}} - ## How do I register records with {{< var vm.product >}}? - Register records (such as models) within the {{< var validmind.platform >}} via the inventory as the first step towards streamlining your documentation and validation workflow. @@ -38,29 +36,31 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has sufficient pe ## Can the {{< var vm.product >}} inventory be customized? -- Yes, information that is displayed on the inventory is configurable on a per user basis. -- You can also search, filter, and sort records (such as models) to narrow down results. -- Fields that appear on all records for all users can also be customized. - - By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has sufficient permissions to manage inventory fields. +- Yes, information that is displayed on the inventory is configurable.[^4] +- You can also search, filter, and sort records (such as models) to narrow down results.[^5] +- Fields that appear on records can also be customized.[^6] + +{{< include _faq-document-updates.qmd >}} ## Can I archive or delete records within {{< var vm.product >}}? -Yes, records (such as models) can be archived within the {{< var validmind.platform >}} inventory to keep your inventory accurate and up to date with your organization’s current resources.[^4] +Yes, records (such as models) can be archived within the {{< var validmind.platform >}} inventory to keep your inventory accurate and up to date with your organization’s current resources.[^7] By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has sufficient permissions to archive and delete records. ## Can I track interdependencies within the inventory? -- Yes, the {{< var validmind.platform >}} allows you to connect two or more records (models) together in your inventory.[^5] +- Yes, the {{< var validmind.platform >}} allows you to connect two or more records (models) together in your inventory.[^8] - You can note both upstream and downstream records. By default, the [{{< fa code >}} Developer]{.bubble} role has sufficient permissions to edit record interdependencies. -{{< include _faq-record-updates.qmd >}} - {{< include _faq-tracking.qmd >}} +{{< include _faq-record-activity.qmd >}} + +{{< include _faq-exporting.qmd >}} + ## Learn more :::{#faq-inventory} @@ -75,6 +75,12 @@ By default, the [{{< fa code >}} Developer]{.bubble} role has sufficient permiss [^3]: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) -[^4]: [Archive and delete records](/guide/inventory/archive-delete-records.qmd) +[^4]: [Customize inventory layout](/guide/inventory/customize-inventory-layout.qmd) + +[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^6]: [Customize record overview page](/guide/inventory/customize-record-overview-page.qmd) + +[^7]: [Archive and delete records](/guide/inventory/archive-delete-records.qmd) -[^5]: [Configure record interdependencies](/guide/inventory/configure-record-interdependencies.qmd) \ No newline at end of file +[^8]: [Configure record interdependencies](/guide/inventory/configure-record-interdependencies.qmd) \ No newline at end of file diff --git a/site/faq/faq-organizations.qmd b/site/faq/faq-organizations.qmd index 4709d309a5..bbbc1395fd 100644 --- a/site/faq/faq-organizations.qmd +++ b/site/faq/faq-organizations.qmd @@ -44,12 +44,12 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^5] has sufficien - User roles, user groups, and access permissions are configured during initial onboarding and can be updated at any time. - In addition, {{< var vm.product >}} also offers support for Single Sign-On (SSO) integration. -## How do user roles, user groups, and access permissions work? +## How do user roles, user groups, and access permissions work? - - Users belong to groups which determine which records (such as models) they can see, and have roles with attached permissions which define the level of access they have to features. - - Groups are segments of users with the ability to view records associated with that group. Access to granular features in the {{< var vm.platform >}} within a group’s set of records is further defined by roles and permissions. - - Roles are a named set of permissions that determine your users’ access to features within the {{< var vm.platform >}} based on your organization’s structure. - - Permissions dictate user access controls within the {{< var vm.platform >}}, and are associated with specific roles. + - Users belong to groups which determine which records (such as models) they can see, and have roles with attached permissions which define the level of access they have to features.[^8] + - Groups are segments of users with the ability to view records associated with that group. Access to granular features in the {{< var vm.platform >}} within a group’s set of records is further defined by roles and permissions.[^9] + - Roles are a named set of permissions that determine your users’ access to features within the {{< var vm.platform >}} based on your organization’s structure.[^10] + - Permissions dictate user access controls within the {{< var vm.platform >}}, and are associated with specific roles.[^11] By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has sufficient permissions to manage access permissions for users, groups, and roles. @@ -74,3 +74,11 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has sufficient pe [^6]: [Manage roles](/guide/configuration/manage-roles.qmd) [^7]: [Manage groups](/guide/configuration/manage-groups.qmd) + +[^8]: [Manage users](/guide/configuration/manage-users.qmd) + +[^9]: [Manage groups](/guide/configuration/manage-groups.qmd) + +[^10]: [Manage roles](/guide/configuration/manage-roles.qmd) + +[^11]: [Manage permissions](/guide/configuration/manage-permissions.qmd) diff --git a/site/faq/faq-privacy.qmd b/site/faq/faq-privacy.qmd index b2468c25e0..f281326517 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/inventory/view-record-activity.qmd -categories: ["data handling", "privacy", "confidentiality", "record activity", "auditing", "validmind platform", "validmind library"] + - ../guide/reporting/tracking-organization-activity.qmd +categories: ["data handling", "privacy", "confidentiality", "activity", "auditing", "validmind platform", "validmind library"] --- ## How does {{< var vm.product >}} handle the processing of PII? @@ -40,22 +40,22 @@ Access to the {{< var validmind.platform >}} is facilitated through AWS PrivateL ## How is data retained within {{< var vm.product >}}? - {{< var vm.product >}} is a multi-tenant or single-tenant solution hosted on cloud providers. -- With multi-tenant deployments, infrastructure is shared but with strict data isolation protocols that ensure that no tenant can access another's sensitive information. +- With multi-tenant deployments, infrastructure is shared but with strict data isolation protocols that ensure that no tenant can access another's sensitive information. ::: {.callout} -## For organizations requiring the highest degree of data security, {{< var vm.product >}} offers a {{< var validmind.vpv >}} (VPV)[^3] option to host the solution in a dedicated single-tenant cloud instance on the {{< var vm.product >}} cloud account. +## For organizations requiring the highest degree of data security, {{< var vm.product >}} offers a {{< var validmind.vpv >}} (VPV)[^3] option to host the solution in a dedicated single-tenant cloud instance on the {{< var vm.product >}} cloud account. Furthermore, {{< var vm.product >}}'s data retention policy complies with the SOC 2 security standard. ::: ## What about the confidentiality or size of data sent to {{< var vm.product >}}? -- {{< var vm.product >}} does not send datasets outside the client's environment. +- {{< var vm.product >}} does not send datasets outside the client's environment. - The {{< var validmind.developer >}} executes test suites and functions locally in your environment and is not limited by dataset size. -{{< include _faq-activity.qmd >}} +{{< include _faq-record-activity.qmd >}} -{{< include _faq-record-updates.qmd >}} +{{< include _faq-settings-activity.qmd >}} ## Learn more diff --git a/site/faq/faq-reporting.qmd b/site/faq/faq-reporting.qmd index c672652c5f..44f194fbe8 100644 --- a/site/faq/faq-reporting.qmd +++ b/site/faq/faq-reporting.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 -title: "Ongoing monitoring and reporting" +title: "Reporting and ongoing monitoring" date: last-modified listing: - id: faq-reporting @@ -12,21 +12,34 @@ listing: sort: false fields: [title, description] contents: - - ../guide/reporting/export-documents.qmd - ../guide/reporting/working-with-analytics.qmd + - ../guide/reporting/generating-exports.qmd - ../guide/monitoring/ongoing-monitoring.qmd -categories: ["exports", "analytics", "reports", "ongoing monitoring", "validmind platform"] +categories: ["exports", "analytics", "reports", "ongoing monitoring", "validmind platform", "activity", "auditing"] --- -{{< include _faq-exporting.qmd >}} +{{< include _faq-record-activity.qmd >}} + +{{< include _faq-settings-activity.qmd >}} ## What analytic features are offered by {{< var vm.product >}}? -- Out-of-the-box reports within the {{< var validmind.platform >}}[^1] are broken down by data on records (such as models) and data on artifacts. +- Out-of-the-box reports within the {{< var validmind.platform >}}[^1] are broken down by data on model-type records and data on validation issue artifacts. - For each of the bar charts, you can hover for numerical breakdowns or click on individual bars to get a more detailed view.[^2] -- You're also able to add custom report pages and analytic widgets to supplement the out-of-the-box reports provided.[^3] +- You're also able to add custom report pages and analytic widgets to supplement the out-of-the-box reports provided.[^3] + +By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^4] has sufficient permissions to manage custom reporting. + +{{< include _faq-exporting.qmd >}} + +## How can I export platform data on a schedule to cloud storage? -By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^4] has sufficient permissions to manage custom reporting. +{{< var vm.product >}} allows you to configure data exports for platform datasets on a schedule to cloud storage, such as Amazon S3, Google Cloud Storage, or Azure Blob Storage.[^5] These exports include: + +- Inventory record datasets, including custom inventory record types.[^6] +- Artifact datasets, including validation issues, limitations, policy exceptions, and custom artifact types.[^7] +- Record Activity logs, such as comments, workflow status changes, field updates, document changes, artifact updates, and test-result updates.[^8] +- Settings Activity logs, such as changes to roles, users, workflows, record configuration, artifact configuration, governance settings, document settings, webhook secrets, and page layouts.[^9] {{< include _faq-monitoring.qmd >}} @@ -45,3 +58,13 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^4] has sufficien [^3]: [Manage custom reports](/guide/reporting/manage-custom-reports.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^5]: [Configure data exports](/guide/integrations/configure-data-exports.qmd) + +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) + +[^7]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) + +[^8]: [View record activity](/guide/reporting/view-record-activity.qmd) + +[^9]: [View settings activity](/guide/reporting/view-settings-activity.qmd) diff --git a/site/faq/faq-testing.qmd b/site/faq/faq-testing.qmd index 6f82ab1694..929ddb7f0f 100644 --- a/site/faq/faq-testing.qmd +++ b/site/faq/faq-testing.qmd @@ -9,11 +9,12 @@ aliases: listing: - id: faq-testing type: grid - grid-columns: 3 + grid-columns: 2 max-description-length: 250 sort: false fields: [title, description] contents: + - ../developer/validmind-library.qmd - ../developer/how-to/testing-overview.qmd - title: "{{< var vm.product >}} test sandbox" description: "Tests that are available as part of the {{< var validmind.developer >}}, grouped by type of validation or monitoring test." diff --git a/site/faq/faq-validation.qmd b/site/faq/faq-validation.qmd index a188986d28..a390ba2994 100644 --- a/site/faq/faq-validation.qmd +++ b/site/faq/faq-validation.qmd @@ -12,7 +12,7 @@ listing: sort: false fields: [title, description] contents: - - ../guide/validation/manage-validation-guidelines.qmd + - ../guide/validation/managing-validation.qmd - ../guide/validation/preparing-validation-reports.qmd - ../guide/validation/working-with-artifacts.qmd categories: ["validation", "validation guidelines", "artifacts", "findings", "documentation", "templates", "compliance", "validmind platform"] @@ -20,47 +20,58 @@ categories: ["validation", "validation guidelines", "artifacts", "findings", "do ## Can I set up custom validation guidelines for use in templates? -Yes, {{< var vm.product >}} supports the implementation of custom validation guidelines from within the {{< var validmind.platform >}}:[^1] +Yes, {{< var vm.product >}} supports the implementation of custom validation guidelines from within the {{< var validmind.platform >}}:[^1] -1. After you set up risk areas for your organization, you can then add guidelines to each risk area. -2. Once guidelines are available, add them to the desired validation report templates. +1. After you set up risk areas for your organization, you can then add guidelines to each risk area.[^2] +2. Once guidelines are available, add them to the desired validation report templates. -By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^2] has sufficient permissions to manage validation guidelines. +By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^3] has sufficient permissions to manage validation guidelines. ## How does {{< var vm.product >}} help with assessing compliance? -Use {{< var vm.product >}} to assess compliance of your records (such as models) with guidelines based on analyzing evidence and artifacts (findings),[^3] providing an unbiased starting point that enables more efficient discussions between validators and developers. +Use {{< var vm.product >}} to assess compliance of your records (such as models) with guidelines based on analyzing evidence and artifacts (findings),[^4] providing an unbiased starting point that enables more efficient discussions between validators and developers. Without leaving the {{< var validmind.platform >}}, you're able to: -1. Link logged evidence to validation reports -2. Link tracked artifacts to validation reports -3. Provide granular compliance assessments for each section of your validation report +1. Link logged evidence to validation reports. +2. Link tracked artifacts to validation reports. +3. Provide granular compliance assessments for each section of your validation report. By default, the [{{< fa circle-check >}} Validator]{.bubble} role has sufficient permissions to assess compliance on validation reports. +{{< include _faq-document-checker.qmd >}} + ## What support does {{< var vm.product >}} offer for artifacts? -- Within the {{< var validmind.platform >}}, you're able to log artifacts at the record (model) or the documentation section level.[^4] -- On each artifact, you're able to outline proposed remediation plans, attach supporting documentation, track the artifact's status, attach the artifact to a risk area and/or documentation section, designate a due date, and assign a resolution owner. -- You can also access a complete list of filterable artifacts logged across all your records, or look at only artifacts linked to a specific record.[^5] +- Within the {{< var validmind.platform >}}, you're able to log artifacts at the record (model) level, or optionally attach an artifact to a documentation section if that option has been enabled for that artifact type.[^5] +- On each artifact are attached artifact fields. Default artifact types provided by {{< var vm.product >}} include default artifact fields[^6] — you can also create custom artifact fields to track additional information for your artifacts.[^7] + +- You can also access a complete list of filterable artifacts logged across all your records, or look at only artifacts linked to a specific record.[^8] By default, the [{{< fa circle-check >}} Validator]{.bubble} role has sufficient permissions to manage artifacts. ## Can I create custom artifact types? -Yes, you can create custom artifact types to track categories of observations beyond the default types (Validation Issue, Policy Exception, Limitation).[^6] - -Common examples include: +Yes, you can create custom artifact types to track categories of observations beyond the default types of:[^9] -- Change Management Record -- Audit Finding -- Enhancement Request +- Validation Issue +- Policy Exception +- Limitation Custom artifact types support the same features as default types, including custom statuses, fields, and workflow triggers. +## Can {{< var vm.product >}} artifact lists and layouts be customized? + +- Yes, information that is displayed on artifact lists is configurable.[^10] +- You can also search, filter, and sort artifacts to narrow down results.[^11] +- Fields that appear on artifacts can also be customized.[^12] + {{< include _faq-attachments.qmd >}} +{{< include _faq-record-activity.qmd >}} + +{{< include _faq-exporting.qmd >}} + ## Learn more :::{#faq-validation} @@ -71,12 +82,24 @@ Custom artifact types support the same features as default types, including cust [^1]: [Accessing {{< var vm.product >}}](/guide/access/accessing-validmind.qmd) -[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) +[^2]: [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd) + +[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^4]: [Assess compliance](/guide/validation/assess-compliance.qmd) + +[^5]: [Log artifacts](/guide/validation/log-artifacts.qmd) + +[^6]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) + +[^7]: [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) + +[^8]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd) -[^3]: [Assess compliance](/guide/validation/assess-compliance.qmd) +[^9]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) -[^4]: [Log artifacts](/guide/validation/log-artifacts.qmd) +[^10]: [Customize artifact layouts](/guide/validation/customize-artifact-layouts.qmd) -[^5]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd) +[^11]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd) -[^6]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) \ No newline at end of file +[^12]: [Customize artifact overview page](/guide/validation/customize-artifact-overview-page.qmd) \ No newline at end of file diff --git a/site/faq/faq-workflows.qmd b/site/faq/faq-workflows.qmd index 5b9a1424c6..d337a8b37e 100644 --- a/site/faq/faq-workflows.qmd +++ b/site/faq/faq-workflows.qmd @@ -2,56 +2,53 @@ # 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: "Workflows" +title: "Workflows and lifecycles" date: last-modified aliases: - /guide/faq-workflows.html listing: - id: faq-workflows type: grid - grid-columns: 2 + grid-columns: 3 max-description-length: 250 sort: false fields: [title, description] contents: + - ../guide/workflows/introduction-to-workflows.qmd + - ../guide/workflows/setting-up-workflows.qmd - ../guide/workflows/working-with-workflows.qmd - - ../guide/workflows/manage-record-stages.qmd - - ../guide/inventory/manage-inventory-fields.qmd - - ../guide/attestation/working-with-attestations.qmd -categories: ["workflows", "lifecycle", "lifecycle statuses", "attestations", "validmind platform", "validmind library"] +categories: ["workflows", "lifecycles", "record stages", "validmind platform", "validmind library"] --- ## Can I customize workflows within {{< var vm.product >}}? -- Yes, you can create custom workflows for the review and approval of records (such as models) throughout their lifecycles with {{< var validmind.platform >}},[^1] enabling you to more easily oversee your organization's unique risk management process. +- Yes, you can create custom workflows for the review and approval of records (such as models) throughout their lifecycles with {{< var validmind.platform >}},[^1] enabling you to more easily oversee your organization's unique risk management process. - For example, workflows can be configured to include any number of review stages involving different sets of stakeholders — at any point in the process. By default, the [{{< fa hand >}} Customer Admin]{.bubble} role[^2] has sufficient permissions to manage workflows. -## What statuses are available for use in workflows? +## What record stages are available for use in workflows? -- Lifecycle statuses are manipulated via workflow transitions and can also be fully customized within the {{< var validmind.platform >}}. -- Default statuses are provided for you as suggestions. You can add, edit, remove, and define your own custom statuses. +- Record stages,[^3] used to track the progress of your records through your organization's lifecycles, are manipulated via workflow transitions and can also be fully customized within the {{< var validmind.platform >}}. +- Default stages are provided for you as suggestions. You can add, edit, remove, and define your own custom stages. -By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has sufficient permissions to manage lifecycle statuses. +By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has sufficient permissions to manage record stages. {{< include _faq-progress-workflow.qmd >}} ## Can we work with disconnected workflows? -Yes, {{< var vm.product >}} supports disconnected workflows natively at the data-collection level since the {{< var validmind.developer >}}[^3] creates individual test runs every time a new test iteration is executed. +Yes, {{< var vm.product >}} supports disconnected workflows natively at the data-collection level since the {{< var validmind.developer >}}[^4] creates individual test runs every time a new test iteration is executed. - This allows for running parallel/disconnected tests that individually send results to the {{< var validmind.platform >}}. - Visualizing the disconnected workflow in terms of testing and documentation will depend on requirements at the use-case level. ::: {.callout} -## You can also leverage the {{< var validmind.developer >}} once you are ready to document a specific record (model) for review and validation. +## You can also leverage the {{< var validmind.developer >}} once you are ready to document a specific record (model) for review and validation. You do not need to use the {{< var validmind.platform >}} while you are in the exploration or R&D phase of development. ::: -{{< include _faq-attestations.qmd >}} - {{< include _faq-tracking.qmd >}} ## Learn more @@ -66,8 +63,6 @@ You do not need to use the {{< var validmind.platform >}} while you are in the e [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^3]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) - -[^4]: [Manage attestations](/guide/attestation/manage-attestations.qmd) +[^3]: [Manage record stages](/guide/workflows/manage-record-stages.qmd) -[^5]: [Working with attestations](/guide/attestation/working-with-attestations.qmd) \ No newline at end of file +[^4]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) \ No newline at end of file diff --git a/site/faq/faq.qmd b/site/faq/faq.qmd index 50a718ba8e..b7f878f891 100644 --- a/site/faq/faq.qmd +++ b/site/faq/faq.qmd @@ -15,22 +15,23 @@ listing: contents: - path: faq-organizations.qmd title: "Access and permissions" + - path: faq-integrations.qmd + title: "Integrations and support" - path: faq-workflows.qmd - title: "Workflows" + title: "Workflows and lifecycles" - path: faq-inventory.qmd - title: "Inventory and activity" - path: faq-documentation.qmd title: "Documents and templates" + - path: faq-testing.qmd + title: "Testing" - path: faq-validation.qmd title: "Validation and artifacts" - path: faq-collaboration.qmd title: "Collaboration" - path: faq-reporting.qmd - title: "Ongoing monitoring and reporting" - - path: faq-testing.qmd - title: "Testing" - - path: faq-integrations.qmd - title: "Integrations and support" + title: "Reporting and ongoing monitoring" + - path: faq-attestations.qmd + title: "Attestations" - path: faq-privacy.qmd title: "Data handling and privacy" --- diff --git a/site/get-started/common-steps/_get-your-code-snippet.qmd b/site/get-started/common-steps/_get-your-code-snippet.qmd index 7c95e6c25d..335faf663d 100644 --- a/site/get-started/common-steps/_get-your-code-snippet.qmd +++ b/site/get-started/common-steps/_get-your-code-snippet.qmd @@ -8,7 +8,7 @@ Before we move on, let's also retrieve the unique *code snippet* for your model :::: {.content-visible unless-format="revealjs" when-meta="includes.developer"} a. In the left sidebar that appears for your model, click **{{< fa rocket >}} Getting Started**. -a. Select `Development` from the **[document]{.smallcaps}** drop-down menu. +a. Select `Development` from the **Document** drop-down menu. a. Click **{{< fa regular copy >}} Copy snippet to clipboard**. @@ -20,7 +20,7 @@ a. Click **{{< fa regular copy >}} Copy snippet to clipboard**. :::: {.content-visible unless-format="revealjs" unless-meta="includes.developer"} a. In the left sidebar that appears for your model, click **{{< fa rocket >}} Getting Started**. -a. Select `Validation` from the **[document]{.smallcaps}** drop-down menu. +a. Select `Validation` from the **Document** drop-down menu. a. Click **{{< fa regular copy >}} Copy snippet to clipboard**. diff --git a/site/get-started/common-steps/_register-your-first-model.qmd b/site/get-started/common-steps/_register-your-first-model.qmd index 332c9ca023..8ed3b07849 100644 --- a/site/get-started/common-steps/_register-your-first-model.qmd +++ b/site/get-started/common-steps/_register-your-first-model.qmd @@ -5,18 +5,18 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs" when-meta="includes.developer"} a. In the left sidebar, click **{{< fa cubes >}} Inventory**. -a. Under the [record type]{.smallcaps} drop-down, select `Model`.^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] +a. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record.^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] a. Click **{{< fa plus >}} Register Model**. -a. Enter the **[model name]{.smallcaps}** and select any option for the following required fields: +a. Enter the **Record Name** and select any option for the following required fields: - - **[business unit]{.smallcaps}** — For example: `Finance` - - **[prelimnary risk tier]{.smallcaps}** — For example: `1` + - **Business Unit** — For example: `Finance` + - **Preliminary Risk Tier** — For example: `1` a. Click **Next {{< fa angle-right >}}** to continue to assignment of inventory record stakeholders. -a. Select your own name under the **[record owner]{.smallcaps}** drop-down. +a. Select your own name under the **Record Owner** drop-down. a. Click **Register Model** to add the model to your inventory. @@ -43,18 +43,18 @@ a. Click **Register Model** to add the model to your inventory. :::: {.content-visible unless-format="revealjs" unless-meta="includes.developer"} a. In the left sidebar, click **{{< fa cubes >}} Inventory**. -a. Under the [record type]{.smallcaps} drop-down, select `Model`.^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] +a. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record.^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] a. Click **{{< fa plus >}} Register Model**. -a. Enter the **[model name]{.smallcaps}** and select any option for the following required fields: +a. Enter the **Record Name** and select any option for the following required fields: - - **[business unit]{.smallcaps}** — For example: `Finance` - - **[prelimnary risk tier]{.smallcaps}** — For example: `1` + - **Business Unit** — For example: `Finance` + - **Preliminary Risk Tier** — For example: `1` a. Click **Next {{< fa angle-right >}}** to continue to assignment of inventory record stakeholders. -a. Select your own name under the **[record owner]{.smallcaps}** drop-down — don't worry, we'll adjust these permissions next for validation. +a. Select your own name under the **Record Owner** drop-down — don't worry, we'll adjust these permissions next for validation. a. Click **Register Model** to add the model to your inventory. diff --git a/site/get-started/common-steps/_select-template.qmd b/site/get-started/common-steps/_select-template.qmd index 598a50ebde..6a1f2b42ab 100644 --- a/site/get-started/common-steps/_select-template.qmd +++ b/site/get-started/common-steps/_select-template.qmd @@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Development**. -b. Under [create document]{.smallcaps}, choose **From {{< var vm.product >}} Template** and then select `Binary classification` from the **[template]{.smallcaps}** drop-down menu. +b. Under **Create Document**, choose **From {{< var vm.product >}} Template** and then select `Binary classification` from the **Template** drop-down menu. c. Click **Use Template** to apply the template. @@ -25,7 +25,7 @@ If you cannot locate your Development document, make sure Development type docum :::: {.content-visible unless-format="revealjs" unless-meta="includes.developer"} a. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Validation**. -b. Under [create document]{.smallcaps}, choose **From {{< var vm.product >}} Template** and then select `Generic Validation Report` from the **[template]{.smallcaps}** drop-down menu. +b. Under **Create Document**, choose **From {{< var vm.product >}} Template** and then select `Generic Validation Report` from the **Template** drop-down menu. c. Click **Use Template** to apply the template. diff --git a/site/get-started/validator/quickstart-validator.qmd b/site/get-started/validator/quickstart-validator.qmd index 261be08722..395d926745 100644 --- a/site/get-started/validator/quickstart-validator.qmd +++ b/site/get-started/validator/quickstart-validator.qmd @@ -41,23 +41,23 @@ On the model details page after you've registered your model: #### Remove yourself as owner -a. Click on the **[owners]{.smallcaps}** tile, then click on the **x** next to your name. +a. Click on the **Owners** tile, then click on the **x** next to your name. b. Click **Save** to apply your changes to that role. #### Remove yourself as developer -a. Click on the **[developers]{.smallcaps}** tile, then click on the **x** next to your name. +a. Click on the **Developers** tile, then click on the **x** next to your name. b. Click **Save** to apply your changes to that role. #### Add yourself as validator -a. Click on the **[validators]{.smallcaps}** tile, and select your name from the drop-down menu. +a. Click on the **Validators** tile, and select your name from the drop-down menu. b. Click **Save** to apply your changes to that role. ::: ::: {.column-margin} -![Inventory record stakeholders with only the [validators]{.smallcaps} assigned](model-stakeholders.png){width=90% fig-alt="A screenshot showing the inventory record stakeholders with only validators assigned" .screenshot} +![Inventory record stakeholders with only the Validators assigned](model-stakeholders.png){width=90% fig-alt="A screenshot showing the inventory record stakeholders with only Validators assigned" .screenshot} ::: #### 3. Select a report template diff --git a/site/guide/_sidebar.yaml b/site/guide/_sidebar.yaml index ea6b1e5024..c9860201bc 100644 --- a/site/guide/_sidebar.yaml +++ b/site/guide/_sidebar.yaml @@ -22,6 +22,9 @@ website: - file: guide/configuration/managing-your-organization.qmd contents: - guide/configuration/set-up-your-organization.qmd + - guide/configuration/manage-platform-notifications.qmd + - file: guide/configuration/configuring-private-connectivity.qmd + contents: - guide/configuration/configure-aws-privatelink.qmd - text: "Configure Google PSC" file: guide/configuration/configure-google-private-service-connect.qmd @@ -37,7 +40,6 @@ website: contents: - guide/configuration/manage-your-profile.qmd - guide/configuration/customize-your-dashboard.qmd - - guide/configuration/manage-platform-notifications.qmd - text: "---" - section: "Integrations" contents: @@ -46,9 +48,9 @@ website: - guide/integrations/manage-secrets.qmd - guide/integrations/configure-connections.qmd - guide/integrations/implement-custom-integrations.qmd - - guide/integrations/link-external-models.qmd + - guide/integrations/link-external-records.qmd - guide/mcp/connect-ai-assistants-via-mcp.qmd - - guide/integrations/configure-analytics-exports.qmd + - guide/integrations/configure-data-exports.qmd - file: guide/integrations/integrations-examples.qmd contents: - guide/integrations/integrations-examples/create-jira-ticket.qmd @@ -96,20 +98,19 @@ website: contents: - guide/inventory/configure-record-interdependencies.qmd - guide/inventory/archive-delete-records.qmd - - guide/inventory/view-record-activity.qmd - text: "---" - section: "Documents & templates" contents: - - file: guide/templates/working-with-documents.qmd - contents: - - guide/templates/manage-document-types.qmd - - guide/templates/manage-documents.qmd - text: "Working with templates" file: guide/templates/working-with-document-templates.qmd contents: - guide/templates/customize-document-templates.qmd - guide/templates/manage-document-templates.qmd - - guide/templates/manage-text-block-library.qmd + - guide/templates/manage-text-block-library.qmd + - file: guide/templates/managing-documents.qmd + contents: + - guide/templates/manage-document-types.qmd + - guide/templates/manage-documents.qmd - text: "Customize document checker" file: guide/templates/customize-document-checker.qmd - text: "---" @@ -157,8 +158,12 @@ website: - guide/validation/update-artifacts.qmd - guide/validation/customize-artifact-overview-page.qmd - text: "---" - - section: "Reporting" + - section: "Reporting & auditing" contents: + - file: guide/reporting/tracking-organization-activity.qmd + contents: + - guide/reporting/view-record-activity.qmd + - guide/reporting/view-settings-activity.qmd - file: guide/reporting/working-with-analytics.qmd contents: - guide/reporting/view-report-data.qmd diff --git a/site/guide/access/_validmind-public-internet.qmd b/site/guide/access/_validmind-public-internet.qmd index 8f825adf5e..fe143dd021 100644 --- a/site/guide/access/_validmind-public-internet.qmd +++ b/site/guide/access/_validmind-public-internet.qmd @@ -2,7 +2,7 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -1. In a web browser, open one of the the URLs for the {{< var validmind.platform >}}: +1. In a web browser, open one of the URLs for the {{< var validmind.platform >}}: | Name | Provider | Region | URL | |--|--|--|----------| diff --git a/site/guide/access/accessing-validmind.qmd b/site/guide/access/accessing-validmind.qmd index 8aa90d6e49..6b4c14d69f 100644 --- a/site/guide/access/accessing-validmind.qmd +++ b/site/guide/access/accessing-validmind.qmd @@ -22,12 +22,12 @@ aliases: To use {{< var vm.product >}} to track your records and oversee your risk management processes, you'll need to first sign up and then log in to the {{< var vm.platform >}}. -:::{#guides-access} +:::{#guides-access .intro-listing} ::: -
    - ## What's next +- [Access and permissions FAQ](/faq/faq-organizations.qmd) - [Managing your organization](/guide/configuration/managing-your-organization.qmd) -- [Managing users](/guide/configuration/managing-users.qmd) \ No newline at end of file + + diff --git a/site/guide/access/sign-up-via-aws-marketplace.qmd b/site/guide/access/sign-up-via-aws-marketplace.qmd index e0cec28b5a..7720c4719a 100644 --- a/site/guide/access/sign-up-via-aws-marketplace.qmd +++ b/site/guide/access/sign-up-via-aws-marketplace.qmd @@ -1,15 +1,15 @@ --- # 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 +# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Sign up via AWS Marketplace" date: last-modified listing: - id: product-tour type: grid - grid-columns: 2 + grid-columns: 1 max-description-length: 500 - image-height: 300px + image-height: 125px sort: false contents: - path: ../../training/what-is-validmind/what-is-validmind-register.qmd @@ -18,7 +18,7 @@ listing: fields: [image, title, description] - id: use-cases type: grid - grid-columns: 2 + grid-columns: 1 max-description-length: 250 sort: false contents: @@ -29,7 +29,6 @@ listing: Sign up for {{< var vm.product >}} through AWS Marketplace to streamline billing and take advantage of your existing AWS relationship. - :::: {.columns} ::: {.column width="70%" .pr3} @@ -63,7 +62,7 @@ When you subscribe to {{< var vm.product >}} via AWS Marketplace, your usage is 4. You are redirected to the {{< var vm.product >}} onboarding page with a one-time identifier that validates your Marketplace purchase: -![{{< var vm.product >}} onboarding page](validmind-onboarding-page.png){width=80% fig-alt="Screenshot of the ValidMind signup welcome screen where you onboard with your one-time identifier." .screenshot} +![{{< var vm.product >}} onboarding page](validmind-onboarding-page.png){width=80% fig-alt="Screenshot of the ValidMind signup welcome screen where you onboard with your one-time identifier." .screenshot} 5. Enter your details and complete registration. @@ -81,18 +80,30 @@ When you subscribe to {{< var vm.product >}} via AWS Marketplace, your usage is ## New to {{< var vm.product >}}? -Take a guided tour of {{< var vm.product >}} and discover how the platform helps you implement governance and oversight through automated documentation, comprehensive testing, and streamlined workflows. +::::: {.columns} + +:::: {.column width="50%" .pr3} +Take a guided tour of {{< var vm.product >}} and discover how the platform helps you implement governance and oversight through automated documentation, comprehensive testing, and streamlined workflows: :::{#product-tour} ::: -## What's next +:::: + +:::: {.column width="50%" .pl3} + +Explore common {{< var vm.product >}} use cases for AI governance and model risk management: :::{#use-cases} ::: +:::: + +::::: + + [^1]: [{{< var vm.product >}} on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-btq2yylkfmqgq) -[^2]: [Log in to {{< var vm.product >}}](/guide/access/log-in-to-validmind.qmd) \ No newline at end of file +[^2]: [Log in to {{< var vm.product >}}](/guide/access/log-in-to-validmind.qmd) diff --git a/site/guide/attestation/_add-attestations.qmd b/site/guide/attestation/_add-attestations.qmd index 9e595c0d3f..9ab66e59a3 100644 --- a/site/guide/attestation/_add-attestations.qmd +++ b/site/guide/attestation/_add-attestations.qmd @@ -9,7 +9,9 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Click **{{< fa plus >}} Add Attestation Template**. -1. Enter a **[name]{.smallcaps}** and **[description]{.smallcaps}** for the attestation template. +1. Enter a **Name** and **Description** for the attestation template. + +1. Select the **Inventory Record Type** this attestation template applies to. 1. Click **Add Attestation Template**. @@ -26,7 +28,9 @@ a. Under {{< fa shield >}} Governance, select **Attestation Templates**. a. Click **{{< fa plus >}} Add Attestation Template**. -a. Enter a **[name]{.smallcaps}** and **[description]{.smallcaps}** for the attestation template. +a. Enter a **Name** and **Description** for the attestation template. + +a. Select the **Inventory Record Type** this attestation template applies to. a. Click **Add Attestation Template**. diff --git a/site/guide/attestation/_configure-attestations.qmd b/site/guide/attestation/_configure-attestations.qmd index 9fe22985f3..8d49054c7e 100644 --- a/site/guide/attestation/_configure-attestations.qmd +++ b/site/guide/attestation/_configure-attestations.qmd @@ -31,17 +31,17 @@ Attestation periods reflect the time zone of the user setting up attestation and a. Click **{{< fa plus >}} Add Attestation Period**. -b. Enter a **[name]{.smallcaps}** for the attestation period, such as `Quarterly attestation`. +b. Enter a **Name** for the attestation period, such as `Quarterly attestation`. -c. Set the **[start date]{.smallcaps}** for the attestation period. +c. Set the **Start Date** for the attestation period. -d. Set the **[end date]{.smallcaps}** when the attestation period ends. +d. Set the **End Date** when the attestation period ends. -e. Optional: Toggle **[email reminders]{.smallcaps}** to send reminders to Submitters, Reviewers, and Approvers: +e. (Optional) Toggle **Email Reminders** to send reminders to Submitters, Reviewers, and Approvers: - - **[days before end]{.smallcaps}** — How many days before the end date to send the reminder. - - **[subject]{.smallcaps}** — The email subject line. - - **[body]{.smallcaps}** — The email body with dynamic variables. + - **Days Before End** — How many days before the end date to send the reminder. + - **Subject** — The email subject line. + - **Body** — The email body with dynamic variables. Available template variables: `{{Recipient Name}}`, `{{Attestation Name}}`, `{{Reminder Reason}}`, `{{Start Date}}`, `{{End Date}}`, `{{Schedule Name}}`, `{{Status Text}}`. @@ -66,15 +66,15 @@ ___ Attestation submissions are organized by owner and group. This approach ensures reviewers and approvers have appropriate permissions for records in their groups. ::: -a. Under Attestation Participants, select the **[submitter]{.smallcaps}** from the inventory record stakeholders: +a. Under Attestation Participants, select the **Submitter** from the inventory record stakeholders: - Record Owner - Record Developer - Record Validator -b. Select the **[reviewer]{.smallcaps}** from the roles dropdown. +b. Select the **Reviewer** from the roles dropdown. -c. Select the **[approver]{.smallcaps}** from the roles dropdown. +c. Select the **Approver** from the roles dropdown. d. Click **Save**. @@ -94,7 +94,7 @@ a. Under Inventory Scope, click **{{< fa plus >}} Add Rule** to add a filter con b. Click **Save**. -c. Optional: Click **View Records** to preview which records match your filter criteria. +c. (Optional) Click **View Records** to preview which records match your filter criteria. ::: {.embed-tip} ### How do I filter for groups? @@ -113,7 +113,7 @@ a. Under Relevant Attestation Fields, drag inventory record fields between colum - **Inventory Record Fields** — Available fields from the inventory - **Relevant Attestation Fields** — Selected fields to display in record snapshots -b. Optional: Reorder the fields to change how they display in the attestation. +b. (Optional) Reorder the fields to change how they display in the attestation. ### 5. Add questionnaire fields @@ -134,23 +134,23 @@ a. Under Questionnaires, click **{{< fa plus >}} Add Field**. b. Configure the field: - - **[field type]{.smallcaps}** — Select the input type: + - **Field Type** — Select the input type: - Single Line Text - Multi Line Text - Checkbox - Dropdown - Number - Date - - **[field label]{.smallcaps}** — Enter the question or prompt shown to submitters - - **[description]{.smallcaps}** — Optional context about the field - - **[help text]{.smallcaps}** — Optional guidance displayed to users - - **[required field]{.smallcaps}** — Toggle to require submitters to complete this field before submission + - **Field Label** — Enter the question or prompt shown to submitters + - **Description** — Optional context about the field + - **Help Text** — Optional guidance displayed to users + - **Required Field** — Toggle to require submitters to complete this field before submission c. Click **Add Field**. d. Repeat to add additional fields as needed. -e. Optional: Reorder fields by dragging them to change the order in which they appear to submitters. +e. (Optional) Reorder fields by dragging them to change the order in which they appear to submitters. Questionnaire fields are available immediately for new attestation instances. Submitters see structured inputs for each field, and responses are collected consistently across all submissions. @@ -165,21 +165,21 @@ Questionnaire fields are available immediately for new attestation instances. Su a. Click **{{< fa plus >}} Add Attestation Period**. -a. Enter a **[name]{.smallcaps}** for the attestation period, such as `Quarterly attestation`. +a. Enter a **Name** for the attestation period, such as `Quarterly attestation`. -a. Set the **[start date]{.smallcaps}** for the attestation period. +a. Set the **Start Date** for the attestation period. -a. Set the **[end date]{.smallcaps}** when the attestation period ends. +a. Set the **End Date** when the attestation period ends. a. Click **Add Period**. #### Assign attestation participants -a. Under Attestation Participants, select the **[submitter]{.smallcaps}** from the inventory record stakeholders. +a. Under Attestation Participants, select the **Submitter** from the inventory record stakeholders. -a. Select the **[reviewer]{.smallcaps}** from the roles dropdown. +a. Select the **Reviewer** from the roles dropdown. -a. Select the **[approver]{.smallcaps}** from the roles dropdown. +a. Select the **Approver** from the roles dropdown. a. Click **Save**. @@ -198,7 +198,7 @@ a. Under Relevant Attestation Fields, drag inventory record fields between colum - **Inventory Record Fields** — Available fields from the inventory - **Relevant Attestation Fields** — Selected fields to display in record snapshots -a. Optional: Reorder the fields to change how they display in the attestation. +a. (Optional) Reorder the fields to change how they display in the attestation. #### Add questionnaire fields diff --git a/site/guide/attestation/manage-attestations.qmd b/site/guide/attestation/manage-attestations.qmd index 1074b92d41..1675cec2ba 100644 --- a/site/guide/attestation/manage-attestations.qmd +++ b/site/guide/attestation/manage-attestations.qmd @@ -50,7 +50,7 @@ For testing purposes only, you can trigger the attestation process: 3. Under **Attestation Periods**, hover over an attestation period. -4. When **{{< fa ellipsis-vertical >}}** appears, select **{{< fa play >}} Start Now**. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, select **{{< fa play >}} Start Now**. 5. Click **Confirm**. @@ -64,13 +64,13 @@ After starting the schedule, attestation participants are notified via My Inbox 3. Under **Attestation Periods**, hover over an attestation period. -4. When **{{< fa ellipsis-vertical >}}** appears, select **{{< fa pencil >}} Edit**. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, select **{{< fa pencil >}} Edit**. 5. Make your desired changes to the following: - - **[name]{.smallcaps}** - - **[start date]{.smallcaps}** - - **[end date]{.smallcaps}** + - **Name** + - **Start Date** + - **End Date** 6. Click **Save Period**. @@ -88,7 +88,7 @@ This action cannot be undone. The history of previous attestation periods is una 3. Under **Attestation Periods**, hover over an attestation period. -4. When **{{< fa ellipsis-vertical >}}** appears, select [**{{< fa trash >}} Cancel Period**]{.red}. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, select [**{{< fa trash >}} Cancel Period**]{.red}. 5. Click **Confirm** to cancel the period. @@ -184,7 +184,7 @@ To manually complete an attestation period: 3. Under **Attestation Periods**, hover over an active attestation period. -4. When **{{< fa ellipsis-vertical >}}** appears, select **{{< fa check >}} Complete Period**. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, select **{{< fa check >}} Complete Period**. 5. Click **Confirm**. @@ -204,7 +204,7 @@ You cannot delete an attestation template if it has any active attestation perio 3. Locate the template to delete and hover over it. -4. When **{{< fa ellipsis-vertical >}}** appears, select [**{{< fa trash >}} Delete**]{.red}. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, select [**{{< fa trash >}} Delete**]{.red}. 5. Click **Confirm** to delete the template. diff --git a/site/guide/attestation/review-attestations.qmd b/site/guide/attestation/review-attestations.qmd index be23ac1952..967e87e496 100644 --- a/site/guide/attestation/review-attestations.qmd +++ b/site/guide/attestation/review-attestations.qmd @@ -37,7 +37,7 @@ As a reviewer, you assess the submitter's attestation, including ownership, usag - **Validation Issues** — Shows open validation issues at the time of the snapshot. - **Artifacts** — Shows artifacts (findings) captured in the snapshot. -4. Optional: Click **Activity** to review the attestation history: +4. (Optional) Click **Activity** to review the attestation history: - Who completed the different status changes. - When the attestation status changed. diff --git a/site/guide/attestation/working-with-attestations.qmd b/site/guide/attestation/working-with-attestations.qmd index ccf3095924..d549e08ba2 100644 --- a/site/guide/attestation/working-with-attestations.qmd +++ b/site/guide/attestation/working-with-attestations.qmd @@ -20,24 +20,15 @@ listing: {{< include /guide/attestation/_attestations.qmd >}} -::: {.attn} - -## Prerequisites +## Key concepts -- [x] {{< var link.login >}} -- [x] Records registered in the inventory require attestation.[^1] -- [x] If applicable, artifacts (findings) have been documented.[^2] -- [x] You are assigned a role with sufficient permissions to perform attestation tasks:[^3] - - [{{< fa hand >}} Customer Admin]{.bubble} — Sets up attestations - - [Submitter]{.bubble} — Stakeholder who submits attestation questionnaires - - [Reviewer]{.bubble} — Organizational role that reviews attestation questionnaires - - [Approver]{.bubble} — Organizational role that approves attestation questionnaires +{{< include /about/glossary/_attestation.qmd >}} +::: {.column-margin} +::: {#attestation-faq} ::: -## Key concepts - -{{< include /about/glossary/_attestation.qmd >}} +::: ### Where do I access attestations? @@ -55,7 +46,7 @@ When an attestation period is active or has been completed in the past, **{{< fa Attestation participants can also access their individual tasks via **{{< fa inbox >}} My Inbox** in the left sidebar, where tasks appear under the Tasks tab with the current attestation status. -::: {.callout-note} +::: {.callout} The Attestations sidebar item appears only when there is _at least one_ active or completed attestation period. If your organization has not yet configured attestations, this option is not visible. If you have configured attestations but every period has a _future_ start date, the Attestations area stays empty until the first period becomes active. ::: @@ -72,12 +63,12 @@ graph LR A["**Not Started**"] --> B["**In Progress**"] B --> C["**Ready for Review**"] end - + subgraph Reviewer C --> D["**Reviewed**"] D -.-> B end - + subgraph Approver D --> E["**Signed Off**"] end @@ -109,7 +100,7 @@ If attestations were organized by owner alone, neither Emma nor Kam would have p This approach ensures 100% accountability per group, where Emma approves all Fraud records and Kam approves all KYC records. If Fraud has two co-leads (Emma and Andres), either can approve. ::: -## How do I create meaningful attestation questionnaires? +### How do I create meaningful attestation questionnaires? Attestation questionnaires are typically used in risk management to confirm that key controls, governance processes and documentation requirements have been followed throughout a record's lifecycle. These questionnaires are part of a broader effort to ensure accountability and regulatory compliance. @@ -131,15 +122,36 @@ Areas typically covered in the questionnaire: Work with your risk management team to create a template that accurately reflects your organization's attestation requirements. +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] Records registered in the inventory require attestation.[^1] +- [x] If applicable, artifacts (findings) have been documented.[^2] +- [x] You are assigned a role with sufficient permissions to perform attestation tasks:[^3] + - [{{< fa hand >}} Customer Admin]{.bubble} — Sets up attestations + - [Submitter]{.bubble} — Stakeholder who submits attestation questionnaires + - [Reviewer]{.bubble} — Organizational role that reviews attestation questionnaires + - [Approver]{.bubble} — Organizational role that approves attestation questionnaires + +::: + ## Manage attestations ::: {#attestation-listing} ::: +## What's next + +- [Attestation FAQ](/faq/faq-attestations.qmd) +- [Working with analytics](/guide/reporting/working-with-analytics.qmd) + + [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) [^2]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) -[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) \ No newline at end of file +[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) \ No newline at end of file diff --git a/site/guide/configuration/_add-business-units.qmd b/site/guide/configuration/_add-business-units.qmd index ddc3be0ff2..ea8a47bd4e 100644 --- a/site/guide/configuration/_add-business-units.qmd +++ b/site/guide/configuration/_add-business-units.qmd @@ -7,7 +7,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Click **{{< fa plus >}} Add Business Unit** under Business Units. -1. Enter your **[business unit name]{.smallcaps}**. +1. Enter your **Business Unit Name**. 1. Click **Add Business Unit** to save your changes. @@ -18,7 +18,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs" unless-meta="includes.quickstart"} a. Click **{{< fa plus >}} Add Business Unit** under Business Units. -a. Enter your **[business unit name]{.smallcaps}**. +a. Enter your **Business Unit Name**. a. Click **Add Business Unit** to save your changes. @@ -35,7 +35,7 @@ a. Under {{< fa building >}} Organization, select **Organization**. a. Click **{{< fa plus >}} Add Business Unit** under Business Units. -a. Enter your **[business unit name]{.smallcaps}**. +a. Enter your **Business Unit Name**. a. Click **Add Business Unit** to save your changes. diff --git a/site/guide/configuration/_add-groups.qmd b/site/guide/configuration/_add-groups.qmd index e89a39acae..44edd7bee3 100644 --- a/site/guide/configuration/_add-groups.qmd +++ b/site/guide/configuration/_add-groups.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Click **{{< fa plus >}} Create Group**. -1. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**. +1. Enter a **Group Name** and **Group Description** for the new group and click **Continue**. 1. Select users from the list to add them to the group. @@ -23,7 +23,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-hidden unless-format="revealjs"} 1. Click **{{< fa plus >}} Create Group**. -1. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**. +1. Enter a **Group Name** and **Group Description** for the new group and click **Continue**. 1. Select users from the list to add them to the group. diff --git a/site/guide/configuration/_add-remove-group-members.qmd b/site/guide/configuration/_add-remove-group-members.qmd index c111aab92d..0893758701 100644 --- a/site/guide/configuration/_add-remove-group-members.qmd +++ b/site/guide/configuration/_add-remove-group-members.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ::: {.panel-tabset} -#### Add members +### Add members a. Click on the group you want to add members to. @@ -21,17 +21,26 @@ a. Click **Add # User(s) Group**. Confirm that the new members are added to the correct group. -#### Remove members +### Remove members -a. Click on the group you want to remove members from. +Click on the group you want to remove members from to remove one or multiple members from that group: -a. Select members to be removed from the group by checking the boxes next to their names. +#### Remove a single member + +a. Hover over the member you want to remove from that group. + +a. Under the Actions column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa user-minus >}} Remove Member**. + +a. Click **{{< fa user-minus >}} Remove 1 member** to confirm removal of the selected member from that group. + +#### Remove multiple members + +a. Select several members to be removed from the group by checking the boxes next to their names. a. Review the number of selected members to be removed, then click **{{< fa user-minus >}} Remove**. a. Click **{{< fa user-minus >}} Remove # member(s)** to confirm removal of selected members from that group. - ::: :::: diff --git a/site/guide/configuration/_add-roles.qmd b/site/guide/configuration/_add-roles.qmd index b0fefe8934..1e9d4bd3b6 100644 --- a/site/guide/configuration/_add-roles.qmd +++ b/site/guide/configuration/_add-roles.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Click **{{< fa plus >}} Add Role**. -1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.^[Role names and inventory record stakeholder type names cannot be duplicated to reduce confusion.] +1. Enter the unique **Name** and **Description** for the role.^[Role names and inventory record stakeholder type names cannot be duplicated to reduce confusion.] 1. Once you click **Add Role**, you can proceed with managing the user permissions and users associated with that role. :::: @@ -22,7 +22,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Click **{{< fa plus >}} Add Role**. -1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.^[Role names and inventory record stakeholder type names cannot be duplicated to reduce confusion.] +1. Enter the unique **Name** and **Description** for the role.^[Role names and inventory record stakeholder type names cannot be duplicated to reduce confusion.] 1. Once you click **Add Role**, you can proceed with managing the user permissions associated with that role. @@ -35,7 +35,7 @@ a. Under {{< fa users >}} Users & Access, select **Roles**. a. Click **{{< fa plus >}} Add Role**. -a. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role. +a. Enter the unique **Name** and **Description** for the role. a. Once you click **Add Role**, you can proceed with managing the user permissions associated with that role. :::: \ No newline at end of file diff --git a/site/guide/configuration/_add-stakeholder-types.qmd b/site/guide/configuration/_add-stakeholder-types.qmd index 38eb988b03..29a63230e1 100644 --- a/site/guide/configuration/_add-stakeholder-types.qmd +++ b/site/guide/configuration/_add-stakeholder-types.qmd @@ -9,11 +9,11 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 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. Enter the unique **Name** and **Description** 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. Select the **Inventory Record Types**^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] this stakeholder type is available on. - (Optional) Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. + (Optional) Under **Default on Inventory Record Types**, select which inventory record types should display this stakeholder type by default. 1. Once you click **Add Stakeholder Type**, you can: @@ -29,11 +29,11 @@ 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. Enter the unique **Name** and **Description** 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. Select the [**Inventory Record Types**](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} this stakeholder type is available on. - (Optional)Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. + (Optional)Under **Default on Inventory Record Types**, select which inventory record types should display this stakeholder type by default. a. Once you click **Add Stakeholder Type**, you can: diff --git a/site/guide/configuration/_add-use-cases.qmd b/site/guide/configuration/_add-use-cases.qmd index f24f9799bd..c8ff4bebd1 100644 --- a/site/guide/configuration/_add-use-cases.qmd +++ b/site/guide/configuration/_add-use-cases.qmd @@ -25,7 +25,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> To add an individual use case option: -a. Type in your use case name under **[options and groups]{.smallcaps}**. +a. Type in your use case name under **Options And Groups**. a. Click **{{< fa plus >}} Add Option** to add the use case to the list. @@ -37,7 +37,7 @@ a. Click **Save Configuration** to save the inserted use case. To add a grouping for use cases: -a. Type in your group title under **[options and groups]{.smallcaps}**. +a. Type in your group title under **Options And Groups**. a. Click **{{< fa chevron-down >}}** next to {{< fa plus >}} Add Option. diff --git a/site/guide/configuration/_invite-users.qmd b/site/guide/configuration/_invite-users.qmd index e475048f27..673fe03074 100644 --- a/site/guide/configuration/_invite-users.qmd +++ b/site/guide/configuration/_invite-users.qmd @@ -5,9 +5,9 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} a. Under Invite By Email: - - Enter the user's **[email]{.smallcaps}** address. - - Assign the user to a group from the **[group]{.smallcaps}** dropdown menu. - - Click **{{< fa plus >}}** under [role (optional)]{.smallcaps} to assign roles to that user: + - Enter the user's **Email** address. + - Assign the user to a group from the **Group** dropdown menu. + - Click **{{< fa plus >}}** under **Role** to assign roles to that user: 1. Click **{{< fa plus >}}** next to the role for each role to be assigned. 2. Click **Assign Additional Roles (Optional)**.[^basic-user-role] @@ -30,9 +30,9 @@ b. Click **{{< fa envelope >}} Send Invite**. :::: {.content-hidden unless-format="revealjs"} a. Under Invite By Email: - - Enter the user's **[email]{.smallcaps}** address. - - Assign the user to a group from the **[group]{.smallcaps}** dropdown menu. - - Click **{{< fa plus >}}** under [role (optional)]{.smallcaps} to assign roles to that user: + - Enter the user's **Email** address. + - Assign the user to a group from the **Group** dropdown menu. + - Click **{{< fa plus >}}** under **Role** to assign roles to that user: 1. Click **{{< fa plus >}}** next to the role for each role to be assigned. 2. Click **Assign Additional Roles (Optional)**. diff --git a/site/guide/configuration/_manage-role-permissions.qmd b/site/guide/configuration/_manage-role-permissions.qmd index 7b1a1e2084..463cc864b3 100644 --- a/site/guide/configuration/_manage-role-permissions.qmd +++ b/site/guide/configuration/_manage-role-permissions.qmd @@ -10,7 +10,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> - **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 record fields^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)] and artifact fields.^[[Manage artifact fields](/guide/validation/manage-artifact-fields.qmd)] -1. Select **Edit Permissions** to to add or remove user permissions to or from that role. +1. Select **Edit Permissions** to add or remove user permissions to or from that role. 1. Toggle specific user permissions for that role by checking or unchecking the boxes next to the permission. @@ -24,7 +24,7 @@ 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 [inventory fields](/guide/inventory/manage-inventory-fields.qmd){target="_blank"} and [artifact fields](/guide/validation/manage-artifact-fields.qmd){target="_blank"}. -a. Select **Edit Permissions** to to add or remove user permissions to or from that role. +a. Select **Edit Permissions** to add or remove user permissions to or from that role. a. Toggle specific user permissions for that role by checking or unchecking the boxes next to the permission. diff --git a/site/guide/configuration/_monitor-invitations.qmd b/site/guide/configuration/_monitor-invitations.qmd index b8397530b2..9019ca958b 100644 --- a/site/guide/configuration/_monitor-invitations.qmd +++ b/site/guide/configuration/_monitor-invitations.qmd @@ -4,7 +4,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} Pending Invites -: Monitor the status of invitations in the Pending Invites section. Under the [actions]{.smallcaps} column, click **{{< fa ellipsis-vertical >}}** to: +: Monitor the status of invitations in the Pending Invites section. Under the **Actions** column, click **{{< fa ellipsis-vertical >}}** to: - **{{< fa copy >}} Copy Invite Link** — Copy the invitation link for this user to your clipboard. - [**{{< fa trash-can >}} Cancel Invitation**]{.red} — Revoke the pending invitation for this user. @@ -19,7 +19,7 @@ Invite History :::: {.content-hidden unless-format="revealjs"} #### Pending Invites -Monitor the status of invitations in the Pending Invites section. Under the [actions]{.smallcaps} column, click **{{< fa ellipsis-vertical >}}** to: +Monitor the status of invitations in the Pending Invites section. Under the **Actions** column, click **{{< fa ellipsis-vertical >}}** to: - **{{< fa copy >}} Copy Invite Link** — Copy the invitation link for this user to your clipboard. - [**{{< fa trash-can >}} Cancel Invitation**]{.red} — Revoke the pending invitation for this user. diff --git a/site/guide/configuration/_stakeholder-type-on-registration.qmd b/site/guide/configuration/_stakeholder-type-on-registration.qmd index c2d37b970e..605af41cb2 100644 --- a/site/guide/configuration/_stakeholder-type-on-registration.qmd +++ b/site/guide/configuration/_stakeholder-type-on-registration.qmd @@ -10,9 +10,9 @@ By default, only the selection of **Record Owner**s is required when records are To include selection of additional stakeholder types during record 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 Record Registration**^[[Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)] to display user selection for that stakeholder type. -1. (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**. Changes are saved automatically. @@ -23,9 +23,9 @@ To include selection of additional stakeholder types [during record registration a. Click on the stakeholder type you want to select users for during registration. -a. Toggle **[available on record registration]{.smallcaps}** to display user selection for that stakeholder type. +a. Toggle **Available on Record Registration** to display user selection for that stakeholder type. - (Optional) To make user selection for that stakeholder type mandatory, also toggle **[make it required]{.smallcaps}**. + (Optional) To make user selection for that stakeholder type mandatory, also toggle **Make It Required**. Changes are saved automatically. :::: \ No newline at end of file diff --git a/site/guide/configuration/configure-google-private-service-connect.qmd b/site/guide/configuration/configure-google-private-service-connect.qmd index 088d74bc01..e88c3d9703 100644 --- a/site/guide/configuration/configure-google-private-service-connect.qmd +++ b/site/guide/configuration/configure-google-private-service-connect.qmd @@ -77,7 +77,7 @@ Create a private subnet in a supported GCP region that can be used to expose {{< c. Configure the IP address range to ensure it includes at least a `/28` of usable private IP address space. d. Click **Create**. -2. Optional: Enable Private Google Access to provide access to Google APIs and services.[^2] +2. (Optional) Enable Private Google Access to provide access to Google APIs and services.[^2] 3. Provision two IP addresses in this subnet for later use: diff --git a/site/guide/configuration/configuring-private-connectivity.qmd b/site/guide/configuration/configuring-private-connectivity.qmd new file mode 100644 index 0000000000..a32e98ce96 --- /dev/null +++ b/site/guide/configuration/configuring-private-connectivity.qmd @@ -0,0 +1,29 @@ +--- +# 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: "Configuring private connectivity" +date: last-modified +listing: + - id: guides-connections + type: grid + max-description-length: 250 + grid-columns: 3 + sort: false + fields: [title, description] + contents: + - configure-aws-privatelink.qmd + - configure-google-private-service-connect.qmd + - configure-azure-private-link.qmd +--- + +Configure private connectivity between your cloud environment and {{< var validmind.platform >}} to keep network traffic private and reduce exposure to the public internet. + +:::{#guides-connections .intro-listing} +::: + +## What's next + +- [Integrations and support FAQ](/faq/faq-integrations.qmd) +- [Managing users](/guide/configuration/managing-users.qmd) + diff --git a/site/guide/configuration/customize-your-dashboard.qmd b/site/guide/configuration/customize-your-dashboard.qmd index d86acb88af..4851604e3d 100644 --- a/site/guide/configuration/customize-your-dashboard.qmd +++ b/site/guide/configuration/customize-your-dashboard.qmd @@ -28,12 +28,12 @@ Dashboards allow you to use widgets to quickly review and access information by 1. In the left sidebar, click **{{< fa home >}} Dashboard**. -2. Click **{{< fa plus>}} Add Dashboard**. +2. Click **{{< fa plus >}} Add Dashboard**. -3. On the Add New Dasboard modal that appears, enter the: +3. On the Add New Dashboard modal that appears, enter the: - - **[dashboard name]{.smallcaps}** - - **[description]{.smallcaps}** (optional) + - **Dashboard Name** + - **Description** (optional) 4. Click **Add New Dashboard** to create your dashboard. @@ -56,7 +56,7 @@ Deletion of dashboards is permanent. #### Edit dashboard details -a. Select **{{< fa pencil >}} Details** to edit a **[dashboard name]{.smallcaps}** or **[description]{.smallcaps}**. +a. Select **{{< fa pencil >}} Details** to edit a **Dashboard Name** or **Description**. b. Make your edits then click **Save Changes** to apply your adjustments. @@ -99,11 +99,11 @@ Retrieve a list of the latest artifacts[^5] or recent activity.[^6] 3. Click **{{< fa pencil >}} Edit Dashboard**. -4. Hover over the title of a widget until the **{{< fa hand>}}** appears. +4. Hover over the title of a widget until the **{{< fa hand >}}** appears. 5. Click and drag to position your widget as desired. - To resize a widget, hover over the bottom-right corner of a widget until the **{{< fa hand>}}** appears, then adjust the dimensions to your liking. + To resize a widget, hover over the bottom-right corner of a widget until the **{{< fa hand >}}** appears, then adjust the dimensions to your liking. 6. Click **Done Editing** to exit the editor. @@ -130,25 +130,25 @@ Retrieve a list of the latest artifacts[^5] or recent activity.[^6] #### {{< fa cubes >}} Inventory Records View -a. Select a **[record type]{.smallcaps}**. -b. Select a **[view name]{.smallcaps}**. +a. Select a **Record Type**. +b. Select a **View Name**. c. Click **Add Inventory Records View** to insert the view as a widget onto your dashboard. #### {{< fa warning >}} Artifacts View -a. Select an **[artifact type]{.smallcaps}**. -b. Select a **[view name]{.smallcaps}**. +a. Select an **Artifact Type**. +b. Select a **View Name**. c. Click **Add Artifacts View** to insert the view as a widget onto your dashboard. #### {{< fa square-poll-vertical >}} Analytics Visualization -a. Select an **[analytics page]{.smallcaps}** -b. Select a **[visualization]{.smallcaps}**. +a. Select an **Analytics Page** +b. Select a **Visualization**. c. Click **Add Visualization** to insert the visualization as a widget onto your dashboard. #### {{< fa flask >}} Other -a. Select one of the **[widgets]{.smallcaps}**. +a. Select one of the **Widgets**. b. Click **Add Widget** to insert the widget onto your dashboard. ::: @@ -174,7 +174,7 @@ Removing a widget from a dashboard will not delete the linked view or analytics 4. Hover over the widget you would like to remove. -5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Remove**]{.red}. +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can >}} Remove**]{.red}. 6. Click **Yes, Delete Widget** to confirm permanent deletion of the widget from that dashboard. @@ -193,7 +193,7 @@ Removing a widget from a dashboard will not delete the linked view or analytics [^5]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) -[^6]: [View record activity](/guide/inventory/view-record-activity.qmd) +[^6]: [View record activity](/guide/reporting/view-record-activity.qmd) [^7]: [Widget types](#widget-types) diff --git a/site/guide/configuration/manage-platform-notifications.qmd b/site/guide/configuration/manage-platform-notifications.qmd index d4c0bc62d9..ad1129245d 100644 --- a/site/guide/configuration/manage-platform-notifications.qmd +++ b/site/guide/configuration/manage-platform-notifications.qmd @@ -63,7 +63,7 @@ To mark an individual update as read: a. Hover over the update you want to mark as read. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa envelope >}} Mark as Read**. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa envelope >}} Mark as Read**. To mark multiple updates as read: @@ -79,7 +79,7 @@ To dismiss an individual update: a. Hover over the update you want to dismiss. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa bell-slash >}} Dismiss**. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa bell-slash >}} Dismiss**. To dismiss all updates: @@ -118,7 +118,6 @@ Enable or disable email notifications for specific events across your organizati 4. Click **Save Changes** to apply your adjustments. - [^1]: [Available update filters](#available-update-filters) diff --git a/site/guide/configuration/manage-record-stakeholder-types.qmd b/site/guide/configuration/manage-record-stakeholder-types.qmd index 5eb986ae4f..5e0122d89d 100644 --- a/site/guide/configuration/manage-record-stakeholder-types.qmd +++ b/site/guide/configuration/manage-record-stakeholder-types.qmd @@ -26,7 +26,7 @@ aliases: ## 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. +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 modified. ::: 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -37,17 +37,17 @@ Please note that the stock **Record Developer**, **Record Owner**, and **Record 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. + - **Name** — Click on the name to edit, then click **Save** to apply your changes. + - **Description** — 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. +1. Under **Inventory Record Types**, 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. +2. Under **Default on Inventory Record Types**, select which inventory record types should display this stakeholder type by default. 3. Click **Save Inventory Record Type Links** to apply your changes. diff --git a/site/guide/configuration/manage-your-profile.qmd b/site/guide/configuration/manage-your-profile.qmd index 1d5d892347..aeb84622bb 100644 --- a/site/guide/configuration/manage-your-profile.qmd +++ b/site/guide/configuration/manage-your-profile.qmd @@ -40,7 +40,7 @@ Access your profile via two methods: 1. In the left sidebar, locate your name near the bottom. -2. Click **{{< fa ellipsis-vertical >}}** and select **{{< fa user >}} See my profile**. +2. Click **{{< fa ellipsis-vertical >}}** and select **{{< fa user >}} View my Profile**. #### Via your settings @@ -58,15 +58,15 @@ The {{< var vm.platform >}} provides an interactive onboarding journey right in #### Getting started guide -- Toggle [**getting started guide**]{.smallcaps} on to display the interactive onboarding guide. +- Toggle **Getting Started Guide** on to display the interactive onboarding guide. -- Toggle [**getting started guide**]{.smallcaps} off to disable the interactive onboarding guide. +- Toggle **Getting Started Guide** off to disable the interactive onboarding guide. #### Restart onboarding To restart onboarding after you've fully completed the getting started guide: -1. Under Onboarding, ensure that [**getting started guide**]{.smallcaps} is toggled on. +1. Under Onboarding, ensure that **Getting Started Guide** is toggled on. 2. Click **Restart** to reset your onboarding progress. @@ -76,9 +76,9 @@ To restart onboarding after you've fully completed the getting started guide: Under User Interface Preferences, you can switch between the dark and light modes of the {{< var validmind.platform >}}: -- Toggle [**enable dark mode**]{.smallcaps} on to use dark mode. +- Toggle **Enable Dark Mode** on to use dark mode. -- Toggle [**enable dark mode**]{.smallcaps} off to use light mode. +- Toggle **Enable Dark Mode** off to use light mode. The selected theme setting is saved to your user profile and applied across all devices where you log in. @@ -88,19 +88,19 @@ Review or accept our terms and conditions and AI terms of use.[^1] ### Localization -Set the **[date format]{.smallcaps}** for date and date time fields[^2] under localization. +Set the **Date Format** for date and date time fields[^2] under localization. ### Access Keys -View your [api key]{.smallcaps} and [secret key]{.smallcaps} under Access Keys: +View your **API Key** and **Secret Key** under Access Keys: ::: {.panel-tabset} -#### [api key]{.smallcaps} +#### API Key To copy your API key, click **{{< fa clipboard >}} Copy to Clipboard**. -#### [secret key]{.smallcaps} +#### Secret Key - To copy your secret key, click **{{< fa clipboard >}} Copy to Clipboard**. @@ -120,7 +120,7 @@ When you refresh your API and secret keys,[^3] any instances using your old keys To change your password: -1. Enter a new password in **[new password]{.smallcaps}**, or click **Generate strong password** to automatically generate a suggested password. +1. Enter a new password in **New Password**, or click **Generate Strong Password** to automatically generate a suggested password. 2. Click **Update Password** to apply the new password. @@ -134,7 +134,7 @@ Set a custom base URL for links to the ValidMind Platform sent in notification e Setting a custom base URL affects only you. ::: -1. Enter your custom URL in **[custom base url]{.smallcaps}**. +1. Enter your custom URL in **Custom Base URL**. Review the URL preview to confirm that the URL is correct. diff --git a/site/guide/configuration/managing-users.qmd b/site/guide/configuration/managing-users.qmd index 52bed3a7f8..2324457094 100644 --- a/site/guide/configuration/managing-users.qmd +++ b/site/guide/configuration/managing-users.qmd @@ -5,7 +5,7 @@ title: "Managing users" date: last-modified listing: - - id: whats-next-listing + - id: user-management type: grid grid-columns: 3 max-description-length: 250 @@ -67,5 +67,10 @@ customer admin ## User management -:::{#whats-next-listing} +:::{#user-management} ::: + +## What's next + +- [Access and permissions FAQ](/faq/faq-organizations.qmd) +- [Managing integrations](/guide/integrations/managing-integrations.qmd) \ No newline at end of file diff --git a/site/guide/configuration/managing-your-organization.qmd b/site/guide/configuration/managing-your-organization.qmd index 32813a5e18..0b282448d8 100644 --- a/site/guide/configuration/managing-your-organization.qmd +++ b/site/guide/configuration/managing-your-organization.qmd @@ -13,9 +13,7 @@ listing: fields: [title, description] contents: - set-up-your-organization.qmd - - configure-aws-privatelink.qmd - - configure-google-private-service-connect.qmd - - configure-azure-private-link.qmd + - manage-platform-notifications.qmd --- Access to the {{< var validmind.platform >}} is associated with an organization, which encompasses all your users, groups, and business units. As a user, you can belong to multiple organizations. @@ -64,42 +62,17 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss 3. Under **Organization Name**, type in your new name and click **Update** to save your changes. -## Manage document defaults - -::: {.panel-tabset} - -### Tracked changes - -::: {.callout-important} -Enabling tracked changes by default for your organization will disable the following within simple text blocks:[^5] - -- The ability to reference field values in the form of variables -- Content draft generation with AI +## Manage your organization +:::{#guides-configuration} ::: -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa building >}} Organization, select **Organization**. -3. Under Document Defaults, toggle whether you would like to **Enable Track Changes by default**[^6] for all content blocks within documents for your current active organization. +## What's next -### Numbered table and figure captions - -1. In the left sidebar, click **{{< fa gear >}} Settings**. +- [Access and permissions FAQ](/faq/faq-organizations.qmd) +- [Managing users](/guide/configuration/managing-users.qmd) -2. Under {{< fa building >}} Organization, select **Organization**. - -3. Under Document Defaults, toggle whether you would like to **Enable numbered table and figure captions** for test results inserted within documents[^7] for your current active organization. - - -::: - - -## Organization setup - -:::{#guides-configuration} -::: @@ -114,8 +87,5 @@ Enabling tracked changes by default for your organization will disable the follo [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^5]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#add-content-blocks) -[^6]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd#tracking-changes) -[^7]: [Work with test results](/guide/documentation/work-with-test-results.qmd) diff --git a/site/guide/configuration/set-up-your-organization.qmd b/site/guide/configuration/set-up-your-organization.qmd index d69ae6b862..11a335e84f 100644 --- a/site/guide/configuration/set-up-your-organization.qmd +++ b/site/guide/configuration/set-up-your-organization.qmd @@ -39,7 +39,7 @@ This task involves managing organizations within {{< var vm.product >}}, allowin a. Hover over the business unit you want to rename. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pencil >}} Edit Details** to rename the business unit. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil >}} Edit Details** to rename the business unit. c. Click **Save** to apply your changes. @@ -51,7 +51,7 @@ In order to delete a business unit, there must be no records attached to that un a. Hover over the business unit you want to delete. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Delete Business Unit**]{.red} to remove the business unit. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can >}} Delete Business Unit**]{.red} to remove the business unit. ::: {.callout-important} In order to delete a business unit, there must be no records attached to that unit. @@ -98,13 +98,6 @@ b. If you are sure you want to remove the use case, click **{{< fa trash-can >}} [Set up validation guidelines](/guide/validation/manage-validation-guidelines.qmd#set-up-validation-guidelines){.button} ::: -## What's next - -- [Managing users](managing-users.qmd) -- [Personalizing {{< var vm.product >}}](personalizing-validmind.qmd) -- [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd) - - [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) diff --git a/site/guide/documentation/_add-content-blocks.qmd b/site/guide/documentation/_add-content-blocks.qmd index 6a694403e6..3fe25621f0 100644 --- a/site/guide/documentation/_add-content-blocks.qmd +++ b/site/guide/documentation/_add-content-blocks.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on the document file you want to add a content block to.^[[Working with documents](/guide/templates/working-with-documents.qmd)] +1. Click on the document file you want to add a content block to.^[[Managing documents](/guide/templates/managing-documents.qmd)] 1. Click on a section header to expand that section and add content. diff --git a/site/guide/documentation/_add-test-results.qmd b/site/guide/documentation/_add-test-results.qmd index bf9e22965e..b1f831230b 100644 --- a/site/guide/documentation/_add-test-results.qmd +++ b/site/guide/documentation/_add-test-results.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on the document file you want to add test results to.^[[Working with documents](/guide/templates/working-with-documents.qmd)] +1. Click on the document file you want to add test results to.^[[Managing documents](/guide/templates/managing-documents.qmd)] 1. Click on a section header to expand that section and add content. @@ -17,11 +17,11 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ![Adding a content block in the {{< var validmind.platform >}}](add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the ValidMind Platform" .screenshot} -1. Click {{< fa square-plus >}} and then select **Test-Driven**^[[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd)] under [from library]{.smallcaps}. +1. Click {{< fa square-plus >}} and then select **Test-Driven**^[[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd)] under From Library. 1. Select test results: - - Choose from available **VM Library** (out-of-the-box) or **Custom** tests under [test-driven]{.smallcaps} in the left sidebar of the test selection modal. + - Choose from available **VM Library** (out-of-the-box) or **Custom** tests under Test-Driven in the left sidebar of the test selection modal. - Use **{{}} Search by name** on the top-left to locate specific test results. ![Test-driven blocks that have been selected for insertion](/guide/documentation/test-driven-block-menu.png){fig-alt="A screenshot showing several test-driven blocks that have been selected for insertion" .screenshot} @@ -46,9 +46,9 @@ With the test results logged, let's head to the model we connected to at the beg 1. Hover under the Pearson Correlation Matrix content block until a horizontal line with a **{{< fa plus >}}** button appears, indicating that you can insert a new block. -1. Click **{{< fa plus >}}** and then select **Test-Driven Block** under [from library]{.smallcaps}: +1. Click **{{< fa plus >}}** and then select **Test-Driven Block** under From Library: - - Click on **VM Library** under [test-driven]{.smallcaps} in the left sidebar. + - Click on **VM Library** under Test-Driven in the left sidebar. - In the search bar, type in `HighPearsonCorrelation`. - Select `HighPearsonCorrelation:balanced_raw_dataset` as the test. diff --git a/site/guide/documentation/_check-documents.qmd b/site/guide/documentation/_check-documents.qmd index af38364c4d..42fac128c1 100644 --- a/site/guide/documentation/_check-documents.qmd +++ b/site/guide/documentation/_check-documents.qmd @@ -11,7 +11,7 @@ a. Select a record or find your record by applying a filter or searching for it. a. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -a. Click on the file you want to check:^[[Working with documents](/guide/templates/working-with-documents.qmd)] +a. Click on the file you want to check:^[[Managing documents](/guide/templates/managing-documents.qmd)] ::: {.panel-tabset} @@ -31,9 +31,9 @@ a. Proceed with selecting a regulation to check your document against. ### 2. Select a regulation -a. In the {{< var vm.checker >}} modal, select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to check your document against: +a. In the {{< var vm.checker >}} modal, select a **Regulation or Policy** and an associated **Assessment** from the drop-down menus to check your document against: - ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} + ![Example **Regulation or Policy** and **Assessment** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the Regulation or Policy and Assessment dropdowns in the Document Checker" .screenshot} A list of regulation-based questions appears for your review. @@ -99,9 +99,9 @@ To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Docume #### 1. Select regulation -a. In the {{< var vm.checker >}} modal, select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to check your document against: +a. In the {{< var vm.checker >}} modal, select a **Regulation or Policy** and an associated **Assessment** from the drop-down menus to check your document against: - ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} + ![Example **Regulation or Policy** and **Assessment** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the Regulation or Policy and Assessment dropdowns in the Document Checker" .screenshot} A list of regulation-based questions appears for your review. @@ -153,9 +153,9 @@ To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Docume #### 1. Select regulation -a. In the {{< var vm.checker >}} modal, select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to check your document against: +a. In the {{< var vm.checker >}} modal, select a **Regulation or Policy** and an associated **Assessment** from the drop-down menus to check your document against: - ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} + ![Example **Regulation or Policy** and **Assessment** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the Regulation or Policy and Assessment dropdowns in the Document Checker" .screenshot} A list of regulation-based questions appears for your review. diff --git a/site/guide/documentation/_document-checker.qmd b/site/guide/documentation/_document-checker.qmd index 54919af981..bd34530c4a 100644 --- a/site/guide/documentation/_document-checker.qmd +++ b/site/guide/documentation/_document-checker.qmd @@ -4,7 +4,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> The {{< var validmind.checker >}} is a compliance tool that reviews documents against a selected regulatory standard. Use the {{< var vm.checker >}} to identify gaps, generate actionable recommendations, and focus your efforts on areas that require attention. The {{< var vm.checker >}} uses a structured checklist to: -- Assess whether required information or evidence is clearly documented or attached -- Identify missing or weak areas in the document -- Offer guidance on how to improve clarity, completeness, and compliance -- Ensure consistency with regulatory expectations for risk and governance \ No newline at end of file +- Assess whether required information or evidence is clearly documented or attached. +- Identify missing or weak areas in the document. +- Offer guidance on how to improve clarity, completeness, and compliance. +- Ensure consistency with regulatory expectations for risk and governance. \ No newline at end of file diff --git a/site/guide/documentation/_document-overview.qmd b/site/guide/documentation/_document-overview.qmd index 2a62793a50..4b6393e23c 100644 --- a/site/guide/documentation/_document-overview.qmd +++ b/site/guide/documentation/_document-overview.qmd @@ -12,7 +12,7 @@ The **Document Overview** shows a section-by-section outline of your record's do - Any unresolved conversations^[[Collaborate with others](/guide/documentation/collaborate-with-others.qmd)] - The number of associated artifacts^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)] - The completion status for your documentation^[[Assign section statuses](/guide/documentation/assign-development-section-statuses.qmd)] -- Recent activity on your record^[[View record activity](/guide/inventory/view-record-activity.qmd)] +- Recent activity on your record^[[View record activity](/guide/reporting/view-record-activity.qmd)] :::: diff --git a/site/guide/documentation/_locate-document-overview.qmd b/site/guide/documentation/_locate-document-overview.qmd index af25cd9fec..62f839f6e6 100644 --- a/site/guide/documentation/_locate-document-overview.qmd +++ b/site/guide/documentation/_locate-document-overview.qmd @@ -11,7 +11,7 @@ To locate your document overview for a record: 1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on a Development type file.^[[Working with documents](/guide/templates/working-with-documents.qmd)] +1. Click on a Development type file.^[[Managing documents](/guide/templates/managing-documents.qmd)] :::: diff --git a/site/guide/documentation/collaborate-with-others.qmd b/site/guide/documentation/collaborate-with-others.qmd index a8f9bf43a3..7625c8eb8a 100644 --- a/site/guide/documentation/collaborate-with-others.qmd +++ b/site/guide/documentation/collaborate-with-others.qmd @@ -81,7 +81,7 @@ While working with content blocks in documents,[^7] you can save named versions a. Click **{{< fa clock-rotate-left >}} Revision history** and select **Open revision history** to view a history of all saved versions as well as your current version. -b. To see the the change made with each version, select the version in the right sidebar. +b. To see the change made with each version, select the version in the right sidebar. - Changes made in that version are highlighted. - Hover over the highlighted content to see who made the change. @@ -94,7 +94,7 @@ b. Click on the version you would like to compare another version to. c. Hover over the other version to compare with your first version. -d. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **Compare against selected**. +d. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **Compare against selected**. ### Rename a version @@ -138,6 +138,9 @@ To edit a comment in a resolved thread, follow the same steps but click the **{{ To delete a comment in a resolved thread, follow the same steps but click the **{{< fa comments >}} Comments archive** button first to access the resolved thread. +## Learn more + +- [Collaboration FAQ](/faq/faq-collaboration.qmd) @@ -146,12 +149,12 @@ To delete a comment in a resolved thread, follow the same steps but click the ** [^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^3]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^3]: [Managing documents](/guide/templates/managing-documents.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) [^5]: [Work with content blocks](work-with-content-blocks.qmd) -[^6]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults) +[^6]: [Managing documents](/guide/templates/managing-documents.qmd#manage-document-defaults) [^7]: [Work with content blocks](work-with-content-blocks.qmd) \ No newline at end of file diff --git a/site/guide/documentation/content_blocks/_reference-field-values.qmd b/site/guide/documentation/content_blocks/_reference-field-values.qmd index 4f94daea30..cceec5b9e8 100644 --- a/site/guide/documentation/content_blocks/_reference-field-values.qmd +++ b/site/guide/documentation/content_blocks/_reference-field-values.qmd @@ -16,8 +16,8 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Select the variable you want to reference from the drop-down menus: - - **[record]{.smallcaps}** — Record field values by field group. - - **[{artifact type}]{.smallcaps}** — Artifact field values grouped by artifact type, where `{artifact type}` represents the name of your artifact type. Only types of artifacts already logged on the associated record will appear in this selection. + - **Record** — Record field values by field group. + - **{artifact-type}** — Artifact field values grouped by artifact type, where `{artifacttype}` represents the name of your artifact type. Only types of artifacts already logged on the associated record will appear in this selection. 1. 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/documentation/work-with-content-blocks.qmd b/site/guide/documentation/work-with-content-blocks.qmd index 6ec599dbae..599d729883 100644 --- a/site/guide/documentation/work-with-content-blocks.qmd +++ b/site/guide/documentation/work-with-content-blocks.qmd @@ -73,12 +73,12 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener ::: {.panel-tabset} - #### [new]{.smallcaps} + #### New Text Block : Adds a new section with a blank content block. - #### [from library]{.smallcaps} + #### From Library Text Block : Inserts a text block from a template in your block library:[^10] a. Select the reusable blocks you want to add. @@ -218,7 +218,7 @@ Test-driven or metric over time blocks can be re-added later on but **text block [^7]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^8]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^8]: [Managing documents](/guide/templates/managing-documents.qmd) [^9]: [Manage permissions](/guide/configuration/manage-permissions.qmd) @@ -230,13 +230,13 @@ Test-driven or metric over time blocks can be re-added later on but **text block [^13]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd) -[^14]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults) +[^14]: [Managing documents](/guide/templates/managing-documents.qmd#manage-document-defaults) -[^15]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults) +[^15]: [Managing documents](/guide/templates/managing-documents.qmd#manage-document-defaults) [^16]: [Run tests and test suites](/developer/how-to/testing-overview.qmd) -[^17]: [View record activity](/guide/inventory/view-record-activity.qmd) +[^17]: [View record activity](/guide/reporting/view-record-activity.qmd) [^18]: [Export documents](/guide/reporting/export-documents.qmd) @@ -244,4 +244,4 @@ Test-driven or metric over time blocks can be re-added later on but **text block [^20]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^21]: [Working with documents](/guide/templates/working-with-documents.qmd) \ No newline at end of file +[^21]: [Managing documents](/guide/templates/managing-documents.qmd) \ No newline at end of file diff --git a/site/guide/documentation/work-with-document-versions.qmd b/site/guide/documentation/work-with-document-versions.qmd index 15ee59055d..a6b6487f90 100644 --- a/site/guide/documentation/work-with-document-versions.qmd +++ b/site/guide/documentation/work-with-document-versions.qmd @@ -33,7 +33,7 @@ Save read-only versions of your documents in the {{< var validmind.platform >}} 5. On the document overview page, click **{{< fa bookmark >}} Save Version**. -6. Enter your **[notes]{.smallcaps}** for the version. +6. Enter your **Notes** for the version. 7. Click **Save Version** to create a read-only version of that document that captures the contents in the current state. @@ -56,15 +56,15 @@ If you save another version before 5 minutes is up, you'll receive a warning toa [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^2]: [Managing documents](/guide/templates/managing-documents.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^5]: [Managing documents](/guide/templates/managing-documents.qmd) [^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^7]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^7]: [Managing documents](/guide/templates/managing-documents.qmd) diff --git a/site/guide/documentation/work-with-test-results.qmd b/site/guide/documentation/work-with-test-results.qmd index 778e152aaf..4276b0cc40 100644 --- a/site/guide/documentation/work-with-test-results.qmd +++ b/site/guide/documentation/work-with-test-results.qmd @@ -42,8 +42,6 @@ You can only upload and work with test results for PDFs converted to editable do ## Add test results - - {{< include _add-test-results.qmd >}} ### Configure test result displays @@ -54,11 +52,11 @@ Once added to your documents, configure how the logged test results are displaye 2. Select **{{< fa gear >}} Configure** and toggle the following options on or off as desired:[^5] - - **[hide title]{.smallcaps}** — Title - - **[hide text]{.smallcaps}** — Description - - **[hide parameters]{.smallcaps}** — Parameters - - **[hide tables]{.smallcaps}** — Tables - - **[hide figures]{.smallcaps}** — Figures + - **Hide Title** — Title + - **Hide Text** — Description + - **Hide Parameters** — Parameters + - **Hide Tables** — Tables + - **Hide Figures** — Figures ## View test result metadata @@ -97,6 +95,11 @@ Filters can be removed from the list of test result metadata by clicking on the +## Learn more + +- [Testing FAQ](/faq/faq-testing.qmd) +- [{{< var validmind.developer >}}](/developer/validmind-library.qmd) + @@ -123,4 +126,4 @@ Filters can be removed from the list of test result metadata by clicking on the [^7]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^8]: [Working with documents](/guide/templates/working-with-documents.qmd) \ No newline at end of file +[^8]: [Managing documents](/guide/templates/managing-documents.qmd) \ No newline at end of file diff --git a/site/guide/documentation/working-with-documentation.qmd b/site/guide/documentation/working-with-documentation.qmd index d5ada74553..b6bd56e7ae 100644 --- a/site/guide/documentation/working-with-documentation.qmd +++ b/site/guide/documentation/working-with-documentation.qmd @@ -39,18 +39,7 @@ After you upload initial documentation through the {{< var validmind.developer > This section describes how to work with Development type documents[^1] (for example, model documentation) in the {{< var validmind.platform >}}. Typically, you perform the tasks described here **after you have uploaded some initial documentation** with the {{< var validmind.developer >}}. -[Learn more about the {{< var validmind.developer >}} {{< fa hand-point-right>}}](/developer/validmind-library.qmd){.button .button-green} -::: - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] The record you are documenting is registered in the inventory.[^2] -- [x] You have provided some content for the documentation, either by uploading it through the {{< var vm.developer >}}[^3] or via the {{< var vm.platform >}}. -- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] - +[Learn more about the {{< var validmind.developer >}} {{< fa hand-point-right >}}](/developer/validmind-library.qmd){.button .button-green} ::: ## Key concepts @@ -80,6 +69,17 @@ This section describes how to work with Development type documents[^1] (for exam :::: +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] The record you are documenting is registered in the inventory.[^2] +- [x] You have provided some content for the documentation, either by uploading it through the {{< var vm.developer >}}[^3] or via the {{< var vm.platform >}}. +- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] + +::: + ## Document Overview {{< include _document-overview.qmd >}} @@ -106,12 +106,6 @@ Modify the contents of the **Latest** version of your document:[^6] b. Select **Save current revision** and enter a name. c. Click {{< fa check >}} to save the current revision. - - ## Prepare documentation Draft, edit, and refine your documentation, complete with supporting test results: @@ -124,6 +118,11 @@ Wrap up your documentation, collaborate with other stakeholders, and submit your :::{#complete-documentation} ::: +## What's next + +- [Documents and templates FAQ](/faq/faq-documentation.qmd) +- [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) + diff --git a/site/guide/guides.qmd b/site/guide/guides.qmd index 4a14c93ebf..b5d36744f1 100644 --- a/site/guide/guides.qmd +++ b/site/guide/guides.qmd @@ -24,9 +24,9 @@ listing: fields: [title, description] contents: - configuration/managing-your-organization.qmd + - configuration/configuring-private-connectivity.qmd - configuration/managing-users.qmd - configuration/personalizing-validmind.qmd - - configuration/manage-platform-notifications.qmd - id: integrations type: grid max-description-length: 250 @@ -45,7 +45,7 @@ listing: - workflows/working-with-workflows.qmd - id: inventory type: grid - grid-columns: 2 + grid-columns: 3 max-description-length: 250 sort: false fields: [title, description] @@ -53,17 +53,15 @@ listing: - 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 + grid-columns: 3 max-description-length: 250 sort: false fields: [title, description] contents: - - templates/working-with-documents.qmd - templates/working-with-document-templates.qmd - - templates/manage-text-block-library.qmd + - templates/managing-documents.qmd - templates/customize-document-checker.qmd - id: documentation type: grid @@ -87,6 +85,7 @@ listing: sort: false fields: [title, description] contents: + - reporting/tracking-organization-activity.qmd - reporting/working-with-analytics.qmd - reporting/generating-exports.qmd - id: monitoring @@ -154,7 +153,7 @@ Our guides offer step-by-step instructions for frequent tasks you perform within :::{#validation} ::: -## Reporting +## Reporting & auditing :::{#reporting} ::: diff --git a/site/guide/integrations/configure-analytics-export-step-1.png b/site/guide/integrations/configure-analytics-export-step-1.png deleted file mode 100644 index 55b5b742ba..0000000000 Binary files a/site/guide/integrations/configure-analytics-export-step-1.png and /dev/null differ diff --git a/site/guide/integrations/configure-analytics-export-step-2.png b/site/guide/integrations/configure-analytics-export-step-2.png deleted file mode 100644 index 7b4e6ce3af..0000000000 Binary files a/site/guide/integrations/configure-analytics-export-step-2.png and /dev/null differ diff --git a/site/guide/integrations/configure-analytics-export-step-3.png b/site/guide/integrations/configure-analytics-export-step-3.png deleted file mode 100644 index cb11c4aecc..0000000000 Binary files a/site/guide/integrations/configure-analytics-export-step-3.png and /dev/null differ diff --git a/site/guide/integrations/configure-analytics-exports.qmd b/site/guide/integrations/configure-analytics-exports.qmd deleted file mode 100644 index 24ca319819..0000000000 --- a/site/guide/integrations/configure-analytics-exports.qmd +++ /dev/null @@ -1,172 +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 analytics exports" -date: last-modified ---- - - -Configure scheduled exports of analytics datasets to cloud storage so that BI tools such as Tableau, Snowflake, and Looker can consume models, findings, workflow metrics, and activity events. - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] You can manage workspace settings, including integrations.[^1] -- [x] For cloud destinations, the required credentials exist in Integration Secrets (example: AWS access keys).[^2] - -::: - -## Create analytics exports - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. - -3. On the Analytics Exports page, click **{{< fa plus >}} Create Analytics Export**. - -4. From the **[datasets]{.smallcaps}** dropdown, choose which analytics datasets to export. For example: - - - Artifact - Model Limitation - - Artifact - Policy Exception - - Artifact - Validation Issue - - Inventory Models - - Model Activity[^4] - - Custom artifact types[^3] - - Custom inventory record types - - ::: {.callout title="Model Activity exports"} - Model Activity exports audit events — comments, workflow status changes, and field updates on inventory records. Use this dataset for compliance reporting or audit trails. Model Activity respects the same export scope (organization, workspace, or selected models) and supports 30, 60, or 90-day window filtering. - ::: - - ::: {.callout title="Custom types"} - Any custom artifact types or custom inventory record types defined for your organization also appear in the datasets dropdown and can be exported. - ::: - -::: {.column-margin} -![Selecting datasets](configure-analytics-export-step-1.png){fig-alt="Create Analytics Export modal showing Select Datasets step and datasets dropdown." .screenshot} -::: - -5. Click **Next** {{< fa angle-right >}}. - -6. Configure the cloud storage destination and output settings: - - - **[destination type]{.smallcaps}** — Choose **Amazon S3**, **Google Cloud Storage**, or **Azure Blob Storage** (when available). - - **[access key id]{.smallcaps}** — Select the secret that holds the access key or equivalent credential. - - **[secret access key]{.smallcaps}** — Select the secret that holds the secret key or equivalent credential. - - **[bucket]{.smallcaps}** — Enter the bucket or container name (example: `my-analytics-bucket`). - - **[output path]{.smallcaps}** — Optionally edit the path template. The default `exports/{dataset}/{year}/{month}/{day}/{timestamp}` produces paths like `exports/models/2026/02/13/1771000840.parquet`. - - **[format]{.smallcaps}** — Choose **Parquet**, **CSV**, or **JSON Lines**. - - **[test connection]{.smallcaps}** (optional) — Click to verify the destination can be accessed. - - -::: {.column-margin} -![Configuring your cloud storage destination](configure-analytics-export-step-2.png){fig-alt="Create Analytics Export modal showing Configure Destination step with cloud storage and output settings." .screenshot} -::: - -7. Click **Next** {{< fa angle-right >}}. - -8. Set how often to export: - - - **[schedule]{.smallcaps}** — Choose the frequency: **Every hour**, **Every 12 hours**, **Daily**, or **Weekly**. - - **[time (utc)]{.smallcaps}** — Choose the time of day in UTC (example: `12:00 AM`). - - -::: {.column-margin} -![Setting the schedule](configure-analytics-export-step-3.png){fig-alt="Create Analytics Export modal showing Set Schedule step with Daily schedule and 12:00 am UTC." .screenshot} -::: - -9. Click **Create Analytics Export**. - -The export is created and runs on the schedule you set. Data is written to the configured path in your cloud storage so BI tools can read it. - -## View details - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. - -3. Click the export row you want to view, or hover over it and when the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa eye >}} View Details**. - -You see the destination, schedule, datasets, and next run for that export. - -## Edit analytics exports - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. - -3. Hover over the export you want to change. - -4. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa pen >}} Edit**. - -5. In the modal, adjust datasets, destination, or schedule, then click **Save Changes**. - -## Run analytics exports manually - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. - -3. Hover over the export you want to run. - -4. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa play >}} Run Now**. - -A one-off export runs in addition to the scheduled runs. The status for a run is shown on the export configuration row or in the run history. - -## View run history - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. - -3. Hover over the export you want to inspect. - -4. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa history >}} View Run History**. - -You see past runs with their status, start time, duration, rows exported, and files written. - -## Disable or enable analytics exports - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. - -3. Hover over the export you want to pause. - -4. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa bolt >}} Disable** or **{{< fa bolt >}} Enable**, depending on the current setting. - -The export stops or starts running depending on the action you take. - -## Delete analytics export configurations - -::: {.callout-warning title="Deleting an analytics export configuration is permanent."} -Data you exported previously will remain in the cloud storage destination unchanged. -::: - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. - -3. Hover over the export you want to remove. - -4. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **Delete**. - -5. In the confirmation dialog, click **Yes, Delete Export** to confirm deletion. - -## What's next - -- Use your BI tool to connect to the same bucket and path to build reports from the exported datasets. -- Ensure credentials stay valid by rotating secrets when required and updating the export configuration if you change secrets.[^2] - - - -[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^2]: [Manage secrets](/guide/integrations/manage-secrets.qmd) - -[^3]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) - -[^4]: [View record activity](/guide/inventory/view-record-activity.qmd) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index 2bca5f107e..f6f2966a35 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -6,75 +6,64 @@ title: "Configure connections" date: last-modified --- -Connections link {{< var vm.product >}} with the external systems your teams already use. +Connections link {{< var vm.product >}} with the external systems your teams already use. Each connection enables you to authenticate and keep events flowing between platforms such as Jira, ServiceNow, Amazon Bedrock and SageMaker, MLflow, and GitLab. -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] You can manage workspace settings.[^1] -- [x] The integration's required secrets already exist in integration secrets.[^2] -- [x] You coordinated with the external system owner to obtain the required credentials and configuration details for the connection. - -::: - ## Supported connections :::: {.panel-tabset} ### Jira -A project tracking tool that teams use to plan work, track progress, and manage issues across a project lifecycle. +A project tracking tool that teams use to plan work, track progress, and manage issues across a project lifecycle. Required configuration details: -**[jira instance url]{.smallcaps}** +**Jira Instance URL** : The base URL for your Cloud or Server deployment, such as `https://yourcompany.atlassian.net`. -**[personal access token]{.smallcaps}** +**Personal Access Token** : The secret that stores a Jira PAT with `read:jira-work` and `write:jira-work` scopes. -**[jql query]{.smallcaps}** (optional) +**JQL Query** (optional) : Limits synced issues by project, status, or labels. Leave blank to sync all tickets. ### ServiceNow -An IT service management platform that helps teams handle requests incidents assets and other operational workflows. +An IT service management platform that helps teams handle requests, incidents, assets, and other operational workflows. Required configuration details: -**[servicenow instance url]{.smallcaps}** +**Servicenow Instance URL** : The base URL for your ServiceNow environment. -**[authentication method]{.smallcaps}** +**Authentication Method** : Username and password or another supported method, such as OAuth. -**[username]{.smallcaps}** +**Username** : The ServiceNow username. -**[password]{.smallcaps}** -: The secret that stores the ServiceNow password. +**Password** +: The secret that stores the ServiceNow password. -**[servicenow board]{.smallcaps}** +**Servicenow Board** : The board or table that receives linked tickets. ### Amazon SageMaker -An ML development service that lets teams build train and deploy models at scale. +An ML development service that lets teams build, train, and deploy models at scale. Required configuration details: -**[aws region]{.smallcaps}** +**AWS Region** : The primary region where your SageMaker model registry lives, for example `us-west-2`. -**[aws access key id]{.smallcaps}** -: The secret generated by AWS IAM with permissions to read the model registry. +**AWS Access Key ID** +: The secret generated by AWS IAM with permissions to read the SageMaker model registry. -**[aws secret access key]{.smallcaps}** -: The secret generated by AWS IAM with permissions to read the model registry. +**AWS Secret Access Key** +: The secret generated by AWS IAM with permissions to read the SageMaker model registry. ### Amazon Bedrock @@ -82,43 +71,43 @@ A managed service that provides access to foundation models and tools for buildi Required configuration details: -**[aws region]{.smallcaps}** +**AWS Region** : The primary region where your Bedrock resources are deployed, for example `us-east-1`. -**[aws access key id]{.smallcaps}** +**AWS Access Key ID** : The secret generated by AWS IAM with permissions to access Bedrock. -**[aws secret access key]{.smallcaps}** +**AWS Secret Access Key** : The secret generated by AWS IAM with permissions to access Bedrock. ### MLflow -An open-source toolset that tracks experiments packages models and manages their deployment. +An open-source toolset that tracks experiments, packages models, and manages their deployment. Required configuration details: -**[tracking uri]{.smallcaps}** +**Tracking URI** : The tracking server endpoint, such as `https://mlflow.example.com:5000`. -**[username]{.smallcaps}** +**Username** : The MLflow username. -**[password]{.smallcaps}** +**Password** : The secret that stores the MLflow password. ### GitLab -Synchronize GitLab model registry with ValidMind model inventory for comprehensive model tracking. +Synchronize your GitLab model registry with the {{< var vm.product >}} inventory for comprehensive record tracking. Required configuration details: -**[project id]{.smallcaps}** +**Project ID** : The GitLab project ID or path containing ML models (required). -**[gitlab instance url]{.smallcaps}** (optional) +**Gitlab Instance URL** (optional) : Leave empty to use GitLab.com, or enter your self-hosted GitLab URL. -**[personal access token]{.smallcaps}** +**Personal Access Token** : Select a secret containing your GitLab Personal Access Token with `api` or `read_api` scope. ### Databricks @@ -127,34 +116,61 @@ A unified analytics platform for data engineering, data science, and machine lea Required configuration details: -**[databricks host]{.smallcaps}** +**Databricks Host** : The URL of your Databricks workspace, such as `https://yourcompany.cloud.databricks.com`. -**[client id]{.smallcaps}** +**Client ID** : The ID of your SQL Warehouse (found in Databricks SQL Warehouses settings). -**[client secret]{.smallcaps}** +**Client Secret** : The secret that stores your Databricks personal access token (PAT). ### Custom A user-defined connection to a third-party system that implements the {{< var vm.product >}} reference API.[^4] -Use custom integrations to connect internal model registries, proprietary platforms, or any service that exposes data through a compatible API. +Use custom integrations to connect internal inventory registries, proprietary platforms, or any service that exposes data through a compatible API. Required configuration details: -**[endpoint url]{.smallcaps}** +**Endpoint URL** : The base URL of your deployed integration that implements the reference API. -**[api key]{.smallcaps}** +**API Key** : A secret containing the API key for authenticating with your integration. -**[integration types]{.smallcaps}** -: Select which types of objects this integration provides — Model Registry and/or Artifact / Ticket Source. +**Integration Types** +: Select which types of objects this integration provides — Record Registry and/or Artifact / Ticket Source. :::: +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You can manage workspace settings.[^1] +- [x] The integration's required secrets already exist in integration secrets.[^2] +- [x] You coordinated with the external system owner to obtain the required credentials and configuration details for the connection. + +::: + +## View connection details + +The connection detail page provides a dashboard-style view for managing a connection, its linked records, and metric sources. + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. + +3. Click the connection you want to view. + +The connection detail page displays: + +- **Connection status** — Shows whether the connection is operational, disabled, or experiencing issues. +- **Linked records** — Lists all {{< var vm.product >}} inventory records linked to resources in this integration. +- **Monitoring** — For integrations that provide metrics (such as Amazon Bedrock), shows configured metric sources and their sync status. + ## Add connections 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -167,32 +183,49 @@ Required configuration details: 5. Enter the following: - - **[integration name]{.smallcaps}** — How other admins can identify the connection. - - **[description]{.smallcaps}** (optional) — The intended usage or additional details. + - **Integration Name** — How other admins can identify the connection. + - **Description** (optional) — The intended usage or additional details. - **Connection-specific fields**,[^3] such as: - - **[tracking uri]{.smallcaps}** — The identifiers needed for the connection. - - **[password]{.smallcaps}** — The secret that stores the secret key, password, or token required by the external service. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. + - **Tracking URI** — The identifiers needed for the connection. + - **Password** — The secret that stores the secret key, password, or token required by the external service. + - **Initial Status** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. -6. Click **Save Integration**. +6. Click **Save Integration**. You can now [test the connection](#test-connections) to ensure it is working as expected. -## View connection details +## Edit connections -The connection detail page provides a dashboard-style view for managing a connection, its linked models, and metric sources. +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. + +3. Click the connection you want to edit. + +4. In the modal that appears, click **Edit Connection**. + +5. Make your changes. For example: + + - **Tracking URI** — Change the URI needed for the connection. + - **Password** — Change the secret that stores the secret key, password, or token required by the external service. + +6. Click **Update Integration** to save your changes. + +## Test connections 1. In the left sidebar, click **{{< fa gear >}} Settings**. 2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. -3. Click the connection you want to view. +3. Hover over the connection you want to test. -The connection detail page displays: +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. -- **Connection status** — Shows whether the connection is operational, disabled, or experiencing issues. -- **Linked models** — Lists all {{< var vm.product >}} inventory records linked to resources in this integration. -- **Monitoring** — For integrations that provide metrics (such as Amazon Bedrock), shows configured metric sources and their sync status. +If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. + +## Monitor connections + +::: {.panel-tabset} ## Monitor connection health @@ -215,9 +248,9 @@ Connections with errors or warnings display a status indicator, such as [{{< fa 3. Verify the external service is accessible. 4. Test the connection after making changes. -### View linked models +### View linked records -To see which models use a specific connection: +To see which records (models) use a specific connection: 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -225,7 +258,7 @@ To see which models use a specific connection: 3. Click the connection to open its details page. -4. Review the linked models table, which shows the **VM Model** ({{< var vm.product >}} inventory record) and **External Name** (the linked external model) for each connection. +4. Review the linked records table, which shows the **VM Model** ({{< var vm.product >}} inventory record) and **External Name** (the linked external record) for each connection. ### View metric sources @@ -235,40 +268,41 @@ For connections that provide monitoring metrics, such as Amazon Bedrock: 2. Review the Metric Sources section to see available metrics. -3. These metrics can be added to monitoring documents for models linked to this connection.[^5] - -## Edit connections +3. These metrics can be added to monitoring documents for records linked to this connection.[^5] -1. In the left sidebar, click **{{< fa gear >}} Settings**. +## View monitoring data -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. +Some integrations, such as Amazon Bedrock, can provide metrics that sync into {{< var vm.product >}} for use in monitoring documents. Metric sources define which external evaluations or metrics are available for a linked record. -3. Click the connection you want to edit. +### How do metric sources work? -4. In the modal that appears, click **Edit Connection**. +When a record in the {{< var vm.product >}} inventory is linked to an external resource, such as a Bedrock agent, available evaluations from that resource become metric sources. These metrics: -5. Make your changes. For example: - - - **[tracking uri]{.smallcaps}** — Change the URI needed for the connection. - - **[password]{.smallcaps}** — Change the secret that stores the secret key, password, or token required by the external service. +- Sync automatically on a scheduled interval. +- Appear in the **From Integration** tab when adding metrics over time to monitoring documents.[^6] +- Support threshold configuration for alerting when values exceed acceptable limits. -6. Click **Update Integration** to save your changes. +::: {.callout title="Bedrock Agent Evaluations"} +For Amazon Bedrock connections, metric sources include agent evaluation results such as accuracy, helpfulness, and other assessment metrics. Link a record to a Bedrock agent to enable these metrics.[^7] +::: -## Test connections +### Access the Monitoring tab 1. In the left sidebar, click **{{< fa gear >}} Settings**. 2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. -3. Hover over the connection you want to test. +3. Click on a connection that supports metric sources, for example a **Bedrock** connection. -4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. +4. On the connection detail page, select the **Monitoring** tab. -If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. + This section lists all configured metric sources, their sync status, and when they last synced. + +::: ## Delete connections -::: {.callout-warning title="Deleting a connection is permanent."} +::: {.callout-important title="Deleting a connection is permanent and cannot be undone."} ::: 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -281,34 +315,6 @@ If the test is successful, the message **{{< fa check-circle >}} Connection succ 5. In the confirmation dialog, select **OK** to confirm deletion. -## View monitoring data - -Some integrations, such as Amazon Bedrock, can provide metrics that sync into {{< var vm.product >}} for use in monitoring documents. Metric sources define which external evaluations or metrics are available for a linked model. - -### Access the Monitoring tab - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. - -3. Click on a connection that supports metric sources, for example a **Bedrock** connection. - -4. On the connection detail page, select the **Monitoring** tab. - - This section lists all configured metric sources, their sync status, and when they last synced. - -### How metric sources work - -When a model in the {{< var vm.product >}} inventory is linked to an external resource, such as a Bedrock agent, available evaluations from that resource become metric sources. These metrics: - -- Sync automatically on a scheduled interval. -- Appear in the **From Integration** tab when adding metrics over time to monitoring documents.[^5] -- Support threshold configuration for alerting when values exceed acceptable limits. - -::: {.callout title="Bedrock Agent Evaluations"} -For Amazon Bedrock connections, metric sources include agent evaluation results such as accuracy, helpfulness, and other assessment metrics. Link a model to a Bedrock agent to enable these metrics.[^6] -::: - [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) @@ -319,6 +325,8 @@ For Amazon Bedrock connections, metric sources include agent evaluation results [^4]: [Implement custom integrations](implement-custom-integrations.qmd) -[^5]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd#add-integration-metrics) +[^5]: [Link external records](link-external-records.qmd) + +[^6]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd#add-integration-metrics) -[^6]: [Link external models](link-external-models.qmd) +[^7]: [Synchronize records with AWS Bedrock](integrations-examples/synchronize-aws-bedrock.qmd) diff --git a/site/guide/integrations/configure-data-exports.qmd b/site/guide/integrations/configure-data-exports.qmd new file mode 100644 index 0000000000..c91ed34a8f --- /dev/null +++ b/site/guide/integrations/configure-data-exports.qmd @@ -0,0 +1,176 @@ +--- +# 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 data exports" +date: last-modified +aliases: + - /guide/integrations/configure-analytics-exports.html +--- + + +Configure scheduled exports of platform datasets to cloud storage so that BI tools such as Tableau, Snowflake, and Looker can consume records (models), artifacts (findings), workflow metrics, and activity events. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You can manage workspace settings, including integrations.[^1] +- [x] For cloud destinations, the required credentials exist in Integration Secrets (example: AWS access keys).[^2] + +::: + +## View data exports + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Data Exports** to view existing export configuration details or export run history: + +::: {.panel-tabset} + +### View export details + +Click the export row you want to view, or hover over it and when the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa eye >}} View Details**. + +Review the destination, schedule, datasets, and next run for that export. + +### View export run history + +a. Hover over the export you want to inspect. + +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa history >}} View Run History**. + +Review past runs with their status, start time, duration, rows exported, and files written. + +::: + +## Create data exports + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Data Exports**. + +3. On the Data Exports page, click **{{< fa plus >}} Create Data Export**. + +4. From the **Datasets** dropdown, choose which analytics datasets to export: + + - Artifact - Limitation + - Artifact - Policy Exception + - Artifact - Validation Issue + - Custom artifact types[^3] + - Inventory Records + - Custom inventory record types[^4] + - Record Activity[^5] + - Settings Activity[^6] + +5. For Record Activity or Settings Activity exports, choose a rolling activity window: **Last 30 days**, **Last 60 days**, or **Last 90 days**. + +6. Click **Next** {{< fa angle-right >}}. + +7. Configure the cloud storage destination and output settings: + + - **Destination Type** — Choose **Amazon S3**, **Google Cloud Storage**, or **Azure Blob Storage** (when available). + - **Access Key ID** — Select the secret that holds the access key or equivalent credential. + - **Secret Access Key** — Select the secret that holds the secret key or equivalent credential. + - **Bucket** — Enter the bucket or container name (example: `my-analytics-bucket`). + - **Output Path** — Optionally edit the path template. The default `exports/{dataset}/{year}/{month}/{day}/{timestamp}` produces paths like `exports/models/2026/02/13/1771000840.parquet`. + - **Format** — Choose **Parquet**, **CSV**, or **JSON Lines**. + - **Test Connection** (optional) — Click to verify the destination can be accessed. + +8. Click **Next** {{< fa angle-right >}}. + +9. Set how often to export: + + - **Schedule** — Choose the frequency: **Every hour**, **Every 12 hours**, **Daily**, or **Weekly**. + - **Time (UTC)** — Choose the time of day in UTC (example: `12:00 AM`). + +10. Click **Create Data Export**. + +The export is created and runs on the schedule you set. Data is written to the configured path in your cloud storage so BI tools can read it. + +## Manage data exports + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Data Exports** to edit existing export configurations, disable or enable exports, or delete configured exports: + +::: {.panel-tabset} + +### Edit exports + +a. Hover over the export you want to change. + +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa pen >}} Edit**. + +c. Adjust selected datasets, export destination, or export schedule, then click **Save Changes**. + +### Disable or enable exports + +a. Hover over the export you want to pause or restart. + +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa bolt >}} Disable** or **{{< fa bolt >}} Enable**, depending on the current setting. + +The export stops or starts running depending on the action you take. + +### Delete configured exports + +::: {.callout-important title="Deleting a data export configuration is permanent."} +Data you exported previously will remain in the cloud storage destination unchanged. +::: + +a. Hover over the export you want to remove. + +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **Delete**. + +c. In the confirmation dialog, click **Yes, Delete Export** to confirm deletion. + +::: + +## Run data exports manually + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Data Exports**. + +3. Hover over the export you want to run. + +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa play >}} Run Now**. + +A one-off export runs in addition to the scheduled runs. The status for a run is shown on the export configuration row or in the run history. + +## What's next + +- Use your BI tool to connect to the same bucket and path to build reports from the exported datasets. +- Ensure credentials stay valid by rotating secrets when required and updating the export configuration if you change secrets.[^2] + + + + +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^2]: [Manage secrets](/guide/integrations/manage-secrets.qmd) + +[^3]: + + Any custom artifact types defined for your organization also appear in the datasets dropdown and can be exported. +

    + **Learn more:** [Manage artifact types](/guide/validation/manage-artifact-types.qmd) + +[^4]: + + Any custom inventory record types defined for your organization also appear in the datasets dropdown and can be exported. +

    + **Learn more:** [Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd) + +[^5]: + + Record Activity exports record-level audit events, such as comments, workflow status changes, field updates, document changes, artifact updates, and test-result updates. Use this dataset for compliance reporting or record audit trails. Record Activity supports **Last 30 days**, **Last 60 days**, or **Last 90 days** window filtering. +

    + **Learn more:** [View record activity](/guide/reporting/view-record-activity.qmd) + +[^6]: + + Settings Activity exports organization-level settings and configuration audit events as CSV files, such as changes to roles, users, workflows, record configuration, artifact configuration, governance settings, document settings, webhook secrets, and page layouts. Settings Activity requires a **Last 30 days**, **Last 60 days**, or **Last 90 days** window so scheduled runs do not export the full audit history each time. +

    + **Learn more:** [View settings activity](/guide/reporting/view-settings-activity.qmd) diff --git a/site/guide/integrations/implement-custom-integrations.qmd b/site/guide/integrations/implement-custom-integrations.qmd index 48a764effd..3e70eba645 100644 --- a/site/guide/integrations/implement-custom-integrations.qmd +++ b/site/guide/integrations/implement-custom-integrations.qmd @@ -8,28 +8,16 @@ date: last-modified Connect {{< var vm.product >}} to third-party systems that aren't supported out of the box by building custom integrations using our reference API. -Custom integrations let you link resources, such as AI systems or models, from internal registries, proprietary platforms, or any service you control to the {{< var vm.product >}} model inventory. +Custom integrations let you link resources, such as AI systems or records such as models, from internal registries, proprietary platforms, or any service you control to the {{< var vm.product >}} inventory. -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] You can manage permissions.[^1] -- [x] Your integration service is deployed and accessible from {{< var vm.product >}}. -- [x] You have the endpoint URL and API key for your integration service. -- [x] A secret containing your API key exists in integration secrets.[^2] - -::: - -## How custom integrations work +## How do custom integrations work? To create a custom integration, you build a service that implements the reference API endpoints: 1. Build a service that implements the required endpoints and connects to your data sources. 2. Deploy your service at a URL accessible to {{< var vm.product >}}. 3. Configure a custom integration in {{< var vm.product >}} that points to your service URL. -4. After implementation, your users can browse and link resources from your system to records in the model inventory. +4. After implementation, your users can browse and link resources from your system to records in the {{< var vm.product >}} inventory. Data flows bidirectionally — {{< var vm.product >}} reads your data and can write back metadata to enable linking. @@ -38,28 +26,41 @@ flowchart LR VM[ValidMind Platform] API[Your API service] DATA[Your data sources] - + VM <-->|Reference API| API API <--> DATA ``` +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are assigned a role that can manage permissions.[^1] +- [x] Your integration service is deployed and accessible from {{< var vm.product >}}. +- [x] You have the endpoint URL and API key for your integration service. +- [x] A secret containing your API key exists in integration secrets.[^2] + +::: + ## Reference API The reference API defines the HTTP endpoints your service must implement. {{< var vm.product >}} calls these endpoints to discover and synchronize resources. -::: {.callout title="Reference implementation"} -A reference implementation with sample code is available. Contact your ValidMind representative for access. -::: +Bidirectional sync +: When linking resources, {{< var vm.product >}} can write metadata back to your system via `PUT` requests. This bidirectional sync enables you to store the {{< var vm.product >}} record identifier (`vm_cuid`) alongside your external records, creating a two-way link between systems. + +::: {.panel-tabset} ### Required endpoints Your service must expose these endpoints at the `/api/v1` base path: **List models** -: `GET /models` — Returns all models from your system. Supports optional `?resource_type=` filter. +: `GET /models` — Returns all records from your system. Supports optional `?resource_type=` filter. **Get model** -: `GET /models/{id}` — Returns a specific model by its unique identifier. +: `GET /models/{id}` — Returns a specific record by its unique identifier. **Update model** (optional) : `PUT /models/{id}` — Accepts metadata updates from {{< var vm.product >}}, enabling bidirectional sync. @@ -81,9 +82,9 @@ Your service must expose these endpoints at the `/api/v1` base path: **Resource types** : `GET /resource-types` — Returns available resource categories for filtering in the UI. -### Model response format +### `/models` response format -Your models endpoint should return objects with these fields: +Your `/models` (records) endpoint should return objects with these fields: | Field | Required | Description | |-------|----------|-------------| @@ -99,13 +100,13 @@ Your models endpoint should return objects with these fields: {{< var vm.product >}} authenticates requests using the `X-API-Key` header. Your service should validate this key and return `401 Unauthorized` if invalid or missing. -### Bidirectional sync +::: -When linking resources, {{< var vm.product >}} can write metadata back to your system via `PUT` requests. This bidirectional sync enables you to store the {{< var vm.product >}} model identifier (`vm_cuid`) alongside your external records, creating a two-way link between systems. +### Code examples -::: {.callout collapse="true" title="Code examples"} +::: {.panel-tabset} -**GET /models response** +#### `GET /models` response ```json [ @@ -124,7 +125,9 @@ When linking resources, {{< var vm.product >}} can write metadata back to your s ] ``` -**PUT /models/{id} request body** (what {{< var vm.product >}} sends) +#### `PUT /models/{id}` request body + +What {{< var vm.product >}} sends: ```json { @@ -132,7 +135,7 @@ When linking resources, {{< var vm.product >}} can write metadata back to your s } ``` -**Health check response** +#### Health check response ```json { @@ -140,7 +143,7 @@ When linking resources, {{< var vm.product >}} can write metadata back to your s } ``` -**Error response format** +#### Error response format ```json { @@ -150,76 +153,119 @@ When linking resources, {{< var vm.product >}} can write metadata back to your s ::: +::: {.callout title="Reference implementation"} +A reference implementation with sample code is available. Contact your {{< var vm.product >}} representative for access. +::: + ## Set up custom integrations -### Best practices +::: {.panel-tabset} -**Secure your service** -: Deploy your integration service behind HTTPS. Validate the API key on every request. +## 1. Add custom integration -**Handle errors gracefully** -: Return appropriate HTTP status codes (`400`, `401`, `404`, `500`) and error messages so users can troubleshoot connection issues. +a. In the left sidebar, click **{{< fa gear >}} Settings**. -**Paginate large responses** -: If your external system contains many resources, implement pagination to keep responses fast. +b. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. -**Monitor availability** -: Track the health of your integration service. {{< var vm.product >}} displays connection status in the UI, so users notice outages quickly. +c. Click **{{< fa plus >}} Add Connection**. -**Version your API** -: Include version information in your API path (`/api/v1/`) to support future changes without breaking existing integrations. +d. In the modal that opens, select **Custom Integration**. + +e. Enter the: + + - **Integration Name** -- A display name to identify this integration. + - **Description** (optional) -- Additional details about the intended usage. + - **Endpoint URL** -- The base URL of your deployed integration that implements the reference API. + - **API Key** -- Select a secret containing the API key for authenticating with your integration. + - **Integration Types** -- Select which types of objects this integration provides: + - **Record Registry** -- Sync models from your external system. + - **Artifact / Ticket Source** -- Sync artifacts or tickets from your external system. + - **Initial Status** -- Set to `Operational` to enable immediately or `Disabled` to finish setup later. + +f. Click **Save Integration**. + +g. Test the connection to verify your service is reachable: + + i. Hover over the custom integration you created. + ii. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa circle-check >}} Test Connection**. + + If the test succeeds, the message **{{< fa check-circle >}} Connection successful** is displayed. + +## 2. Link resources + +After configuring your custom integration, link resources to inventory records or artifacts: + +### Link inventory records to models + +a. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +b. Select a record or find your record by applying a filter or searching for it.[^3] + +c. Click the **Integrations** tab. + +d. Select your custom integration connection. -### Add a custom integration +e. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa link >}} Link Model**: -1. In the left sidebar, click **{{< fa gear >}} Settings**. + - Select the external model to link.[^4] + - Select a **Sync Frequency**. + - Click **Test Connection** to verify the binding configuration. -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. +f. Click **Link Model**. -3. Click **{{< fa plus >}} Add Connection**. +### Link artifacts to tickets -4. In the modal that opens, select **Custom Integration**. +a. Locate the artifact you want to link to a ticket.[^5] -5. Enter the: +b. Click the **Integrations** tab. - - **[integration name]{.smallcaps}** — A display name to identify this integration. - - **[description]{.smallcaps}** (optional) — Additional details about the intended usage. - - **[endpoint url]{.smallcaps}** — The base URL of your deployed integration that implements the reference API. - - **[api key]{.smallcaps}** — Select a secret containing the API key for authenticating with your integration. - - **[integration types]{.smallcaps}** — Select which types of objects this integration provides: - - **Model Registry** — Sync models from your external system. - - **Artifact / Ticket Source** — Sync artifacts or tickets from your external system. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` to finish setup later. +c. Select your custom integration connection. -6. Click **Save Integration**. +d. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa link >}} Link Artifact**: -7. Test the connection to verify your service is reachable: + - Search for or select the external ticket to link.[^6] + - Select a **Sync Frequency**. + - Click **Test Connection** to verify the binding configuration. - a. Hover over the custom integration you created. - - b. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa circle-check >}} Test Connection**. - - If the test succeeds, the message **{{< fa check-circle >}} Connection successful** displays. +e. Click **Link Ticket**. -### Link resources +::: -After configuring your custom integration, link resources to models in the inventory: +
    -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. +::: {.callout-button .pl4 .nt4} +::: {.callout collapse="true" appearance="minimal"} +### What are some best practices for implementing custom integrations? -2. Select a model by clicking on it. +**Secure your service** +: Deploy your integration service behind HTTPS. Validate the API key on every request. -3. In the right sidebar, locate your custom integration connection. +**Handle errors gracefully** +: Return appropriate HTTP status codes (`400`, `401`, `404`, `500`) and error messages so users can troubleshoot connection issues. -4. Hover over the connection. +**Paginate large responses** +: If your external system contains many resources, implement pagination to keep responses fast. + +**Monitor availability** +: Track the health of your integration service. {{< var vm.product >}} displays connection status in the UI, so users notice outages quickly. -5. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa link >}} Link Model**. +**Version your API** +: Include version information in your API path (`/api/v1/`) to support future changes without breaking existing integrations. -6. In the modal that opens, select the resource from your external system. +::: +::: -7. Click **Link Model**. [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) [^2]: [Manage secrets](manage-secrets.qmd) + +[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^4]: If your integration exposes multiple resource types, select the resource type first to filter the available models. + +[^5]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd) + +[^6]: If the ticket isn't available in the list, enter the ticket or issue ID from the external system. diff --git a/site/guide/integrations/integrations-examples/_add-workflow-example.qmd b/site/guide/integrations/integrations-examples/_add-workflow-example.qmd new file mode 100644 index 0000000000..d93c4420e1 --- /dev/null +++ b/site/guide/integrations/integrations-examples/_add-workflow-example.qmd @@ -0,0 +1,17 @@ + + +a. In the left sidebar, click **{{< fa gear >}} Settings**. + +b. Under {{< fa shield >}} Governance, select **Workflows**. + +c. Click **{{< fa plus >}} Add Workflow**:^[[Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows)] + + - Under **Workflow Target** type, select **Inventory Record**. + - Enter a **Title** and a **Description** for the workflow. + - Select the **Record Type** this workflow applies to. + - Under **Workflow Start**, select when the workflow should be initiated. + - Under **Workflow Expected Duration**, define the SLA for the workflow based on the start date in days, weeks, months, or years. + +d. Click **Save Draft** to save your blank workflow. diff --git a/site/guide/integrations/integrations-examples/_configure-workflow-http-step.qmd b/site/guide/integrations/integrations-examples/_configure-workflow-http-step.qmd new file mode 100644 index 0000000000..33cd738f37 --- /dev/null +++ b/site/guide/integrations/integrations-examples/_configure-workflow-http-step.qmd @@ -0,0 +1,79 @@ + + +a. Configure the rest of your workflow steps, then drag and drop an **{{< fa cloud-arrow-up >}} HTTP Request** step^[[Workflow step types](/guide/workflows/workflow-step-types.qmd#http-request)] onto the canvas and connect it to your workflow. + +b. Double-click the step to open the **Configure HTTP Request** modal. + +:::: {.content-visible when-format="html" when-meta="includes.jira"} +c. Configure the required fields for Jira,[^configure-jira] replacing the placeholder values with your own: + + - **URL** — `https://yourcompany.atlassian.net/rest/api/3/issue` + - **Method** — POST + - **Headers** — Add: + - `Content-Type`: `application/json` + - `Authorization`: `Bearer {{Jira Personal Access Token}}` + + ::: {.callout title="Use webhook secrets for credentials"} + Instead of entering credentials in plaintext, use a webhook secret: `Bearer {{secret:jira_pat}}`. To learn more, refer to [Manage secrets](/guide/integrations/manage-secrets.qmd#webhook-secrets). + ::: + + - **Body Type** — JSON + - **Body** — Use the following JSON payload: + + ```json + { + "fields": { + "project": { + "key": "MODEL" + }, + "summary": "Model validation failed: {{Model Name}}", + "description": "The model [{{Model Name}}|{{Model URL}}] failed validation. Review artifacts in ValidMind.", + "issuetype": { + "name": "Bug" + } + } + } + ``` + +d. Click **Update Step** to save your configuration. + +[^configure-jira]: + + ![Create a Jira issue](integrations-examples-http-request-open-jira-ticket.png){width=80% fig-alt="Screenshot of the HTTP request step configured to create a Jira ticket, showing the required fields described in step 12." .screenshot} + +:::: + +:::: {.content-visible when-format="html" unless-meta="includes.jira"} +c. Configure the required fields for ServiceNow,[^configure-servicenow] replacing the placeholder values with your own: + + - **URL** — `https://yourinstance.service-now.com/api/now/table/incident` + - **Method** — POST + - **Headers** — Add: + - `Content-Type`: `application/json` + - `Authorization`: `Basic {{ServiceNow Credentials}}` + + ::: {.callout title="Use webhook secrets for credentials"} + Instead of entering credentials in plaintext, use a webhook secret: `Basic {{secret:servicenow_creds}}`. To learn more, refer to [Manage secrets](/guide/integrations/manage-secrets.qmd#webhook-secrets). + ::: + + - **Body Type** — JSON + - **Body** — Use the following JSON payload: + + ```json + { + "short_description": "Data drift issue detected: {{Model Name}}", + "description": "A potential issue has been identified for model {{Model Name}} (link: [{{Model URL}}]({{Model URL}})). Please review the ongoing monitoring documentation in ValidMind.", + "urgency": "2", + "category": "Model Risk" + } + ``` + +d. Click **Update Step** to save your configuration. + +[^configure-servicenow]: + + ![Create a ServiceNow incident](integrations-examples-http-request-open-servicenow-incident.png){width=80% fig-alt="Screenshot of the HTTP request step configured to create a ServiceNow incident, showing the required fields described in step 12." .screenshot} + +:::: diff --git a/site/guide/integrations/integrations-examples/_publish-workflow-example.qmd b/site/guide/integrations/integrations-examples/_publish-workflow-example.qmd new file mode 100644 index 0000000000..8f666708c2 --- /dev/null +++ b/site/guide/integrations/integrations-examples/_publish-workflow-example.qmd @@ -0,0 +1,9 @@ + + +a. Configure and link any additional workflow steps.^[[Configure workflows](/guide/workflows/configure-workflows.qmd#link-workflow-together)] + +b. Save your workflow to apply your changes. + +c. Publish your workflow to make it available for use. diff --git a/site/guide/integrations/integrations-examples/create-jira-ticket.qmd b/site/guide/integrations/integrations-examples/create-jira-ticket.qmd index 975f31de73..dfa5df8fa0 100644 --- a/site/guide/integrations/integrations-examples/create-jira-ticket.qmd +++ b/site/guide/integrations/integrations-examples/create-jira-ticket.qmd @@ -4,9 +4,11 @@ # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Create a Jira ticket" date: last-modified +includes: + jira: true --- -Create a Jira ticket when model validation requires attention using an HTTP request workflow step. +Create a Jira ticket when validation requires attention using an HTTP request workflow step. ::: {.attn} @@ -20,66 +22,31 @@ Create a Jira ticket when model validation requires attention using an HTTP requ ::: -## Configure the workflow step +## Configure workflow step for Jira ticket creation -::: {.column-margin} -![Create a Jira issue](integrations-examples-http-request-open-jira-ticket.png){width=80% fig-alt="Screenshot of the HTTP request step configured to create a Jira ticket, showing the required fields described in step 4." .screenshot} -::: +::: {.panel-tabset} + +### 1. Add Inventory Record workflow + +{{< include /guide/integrations/integrations-examples/_add-workflow-example.qmd >}} + +### 2. Configure workflow step + +{{< include /guide/integrations/integrations-examples/_configure-workflow-http-step.qmd >}} -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa shield >}} Governance, select **Workflows**. - -3. Select the **Model Workflows** tab. - -4. Click on a workflow to modify or click **{{< fa plus >}} Add Model Workflow**[^4] to create a new workflow. - -5. From the **Workflow Steps** modal, drag and drop an **HTTP Request** step[^5] onto the canvas, then connect it to your workflow. - -6. Double-click the step to open the **Configure HTTP Request** modal. - -7. Configure the required fields, replacing the placeholder values with your own: - - - **[url]{.smallcaps}** — `https://yourcompany.atlassian.net/rest/api/3/issue` - - **[method]{.smallcaps}** — POST - - **[headers]{.smallcaps}** — Add: - - `Content-Type`: `application/json` - - `Authorization`: `Bearer {{Jira Personal Access Token}}` - - ::: {.callout-tip title="Use webhook secrets for credentials"} - Instead of entering credentials in plaintext, use a webhook secret: `Bearer {{secret:jira_pat}}`. See [Manage secrets](../manage-secrets.qmd#webhook-secrets). - ::: - - - **[body type]{.smallcaps}** — JSON - - **[body]{.smallcaps}** — Use the following JSON payload: - - ```json - { - "fields": { - "project": { - "key": "MODEL" - }, - "summary": "Model validation failed: {{Model Name}}", - "description": "The model [{{Model Name}}|{{Model URL}}] failed validation. Review artifacts in ValidMind.", - "issuetype": { - "name": "Bug" - } - } - } - ``` - -8. Click **Update Step** to save your configuration. +### 3. Publish workflow + +{{< include /guide/integrations/integrations-examples/_publish-workflow-example.qmd >}} The HTTP request to create the Jira ticket is sent when the workflow executes the step. - +::: -[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) -[^2]: [Introduction to workflows](../../workflows/introduction-to-workflows.qmd) + -[^3]: [Manage secrets](../manage-secrets.qmd) +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Add new workflows](../../workflows/configure-workflows.qmd#add-new-workflows) +[^2]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) -[^5]: [Workflow step types](../../workflows/workflow-step-types.qmd#http-request) +[^3]: [Manage secrets](/guide/integrations/manage-secrets.qmd) diff --git a/site/guide/integrations/integrations-examples/create-servicenow-incident.qmd b/site/guide/integrations/integrations-examples/create-servicenow-incident.qmd index 7ecde2eadf..6d6e8db531 100644 --- a/site/guide/integrations/integrations-examples/create-servicenow-incident.qmd +++ b/site/guide/integrations/integrations-examples/create-servicenow-incident.qmd @@ -20,58 +20,31 @@ Create a ServiceNow incident when a data drift issue is detected during ongoing ::: -## Configure the workflow step +## Configure workflow step for ServiceNow incident creation -1. In the left sidebar, click **{{< fa gear >}} Settings**. +::: {.panel-tabset} -2. Under {{< fa shield >}} Governance, select **Workflows**. +### 1. Add Inventory Record workflow -3. Select the **Model Workflows** tab. +{{< include /guide/integrations/integrations-examples/_add-workflow-example.qmd >}} -4. Click on a workflow to modify or click **{{< fa plus >}} Add Model Workflow**[^4] to create a new workflow. +### 2. Configure workflow step -5. From the **Workflow Steps** modal, drag and drop an **HTTP Request** step[^5] onto the canvas, then connect it to your workflow. +{{< include /guide/integrations/integrations-examples/_configure-workflow-http-step.qmd >}} -6. Double-click the step to open the **Configure HTTP Request** modal. +### 3. Publish workflow -7. Configure the required fields, replacing the placeholder values with your own: +{{< include /guide/integrations/integrations-examples/_publish-workflow-example.qmd >}} - - **[url]{.smallcaps}** — `https://yourinstance.service-now.com/api/now/table/incident` - - **[method]{.smallcaps}** — POST - - **[headers]{.smallcaps}** — Add: - - `Content-Type`: `application/json` - - `Authorization`: `Basic {{ServiceNow Credentials}}` - - ::: {.callout-tip title="Use webhook secrets for credentials"} - Instead of entering credentials in plaintext, use a webhook secret: `Basic {{secret:servicenow_creds}}`. See [Manage secrets](../manage-secrets.qmd#webhook-secrets). - ::: - - - **[body type]{.smallcaps}** — JSON - - **[body]{.smallcaps}** — Use the following JSON payload: - - ```json - { - "short_description": "Data drift issue detected: {{Model Name}}", - "description": "A potential issue has been identified for model {{Model Name}} (link: [{{Model URL}}]({{Model URL}})). Please review the ongoing monitoring documentation in ValidMind.", - "urgency": "2", - "category": "Model Risk" - } - ``` +The HTTP request to create the ServiceNow incident is sent when the workflow executes the step. -::: {.column-margin} -![Create a ServiceNow incident](integrations-examples-http-request-open-servicenow-incident.png){width=80% fig-alt="Screenshot of the HTTP request step configured to create a ServiceNow incident, showing the required fields described in step 4." .screenshot} ::: -The HTTP request to create the ServiceNow incident is sent when the workflow executes the step. -[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) - -[^2]: [Introduction to workflows](../../workflows/introduction-to-workflows.qmd) - -[^3]: [Manage secrets](../manage-secrets.qmd) +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Add new workflows](../../workflows/configure-workflows.qmd#add-new-workflows) +[^2]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) -[^5]: [Workflow step types](../../workflows/workflow-step-types.qmd#http-request) +[^3]: [Manage secrets](/guide/integrations/manage-secrets.qmd) diff --git a/site/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd b/site/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd index ef136a1d60..d233f8b56b 100644 --- a/site/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd +++ b/site/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd @@ -2,11 +2,19 @@ # 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: "Synchronize models with AWS Bedrock" +title: "Synchronize records with AWS Bedrock" date: last-modified --- -Link {{< var vm.product >}} models to foundation models and generative AI agents in Amazon Bedrock, supporting governance across your AI/ML ecosystem. +Link {{< var vm.product >}} records to foundation models and generative AI agents in Amazon Web Services (AWS) Bedrock, supporting governance across your AI/ML ecosystem. + +## How does the integration with AWS Bedrock work? + +AWS Bedrock exposes two primary integration surfaces: + +- **Foundation model layer** — Access to AWS-hosted and custom foundation models through the Bedrock model catalog (Discover and Tune views). + +- **Application layer** — Bedrock primitives such as agents, flows, and knowledge bases that represent built generative AI applications and workflows. ::: {.attn} @@ -18,65 +26,53 @@ Link {{< var vm.product >}} models to foundation models and generative AI agents ::: -AWS Bedrock exposes two primary integration surfaces: +## Sync {{< var vm.product >}} records with AWS Bedrock -- **Foundation model layer** — Access to AWS-hosted and custom foundation models through the Bedrock model catalog (Discover and Tune views). - -- **Application layer** — Bedrock primitives such as agents, flows, and knowledge bases that represent built generative AI applications and workflows. +::: {.panel-tabset} -## Configure the connection +### 1. Configure Bedrock connection -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. +b. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. -3. Click **{{< fa plus >}} Add Connection**. +c. Click **{{< fa plus >}} Add Connection**. -4. In the modal that opens, select **AWS Bedrock**. +d. In the modal that opens, select **AWS Bedrock**. -5. Complete: +e. Complete: - - **[integration name]{.smallcaps}** — How other admins can identify the connection. - - **[description]{.smallcaps}** (optional) — The intended usage or additional details. - - **[aws region]{.smallcaps}** — The primary region where your Bedrock resources are deployed, for example `us-east-1`. - - **[aws access key id]{.smallcaps}** — The secret generated by AWS IAM with permissions to access Bedrock. - - **[aws secret access key]{.smallcaps}** — The secret generated by AWS IAM with permissions to access Bedrock. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. + - **Integration Name** — How other admins can identify the connection. + - **Description** (optional) — The intended usage or additional details. + - **AWS Region** — The primary region where your Bedrock resources are deployed, for example `us-east-1`. + - **AWS Access Key ID** — The secret generated by AWS IAM with permissions to access Bedrock. + - **AWS Secret Access Key** — The secret generated by AWS IAM with permissions to access Bedrock. + - **Initial Status** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. -6. Click **Save Integration**. +f. Click **Save Integration**. -7. Test the connection: +g. Test the connection: - a. Hover over the AWS Bedrock connection you just created. - b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. + i. Hover over the AWS Bedrock connection you just created. + ii. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. -## Link models from Bedrock +### 2. Link records to Bedrock -Once the connection is configured, you can link {{< var vm.product >}} models to your Bedrock resources: +Once the connection is configured, you can link {{< var vm.product >}} records to your Bedrock resources: -::: {.callout title="Model dependencies"} -Bedrock agents, flows, and runtimes typically call foundation models (LLMs) under the hood. When you link these application-layer resources to {{< var vm.product >}}, consider also registering their underlying foundation models and creating dependency relationships between them. +a. In the left sidebar, click **{{< fa cubes >}} Inventory**. -This builds a complete dependency graph showing how your AI applications relate to underlying models. Benefits include: +b. Select a record or find your record by applying a filter or searching for it.[^2] -- **Impact analysis** — See which applications are affected if a foundation model is deprecated or has compliance issues. -- **Full audit trails** — Documentation and risk assessments capture the entire model stack, not just the top-level application. -- **Governance visibility** — Track model versions and changes across your AI ecosystem. -::: - -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^2] - -3. Scroll down until you locate the **Amazon Bedrock** connection box in the right sidebar. +c. Scroll down until you locate the **Amazon Bedrock** connection box in the right sidebar. -4. Hover over the Amazon Bedrock box. +d. Hover over the Amazon Bedrock box. -5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. +e. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. -6. In the modal that opens, use the tabs to filter by resource type: +f. In the modal that opens, use the tabs to filter by resource type: - **All** — View all available Bedrock resources. - **Foundation Models** — AWS-hosted and custom foundation models from the Bedrock catalog. @@ -84,16 +80,28 @@ This builds a complete dependency graph showing how your AI applications relate - **Flows** — Prompt flows and orchestration workflows. - **AgentCore Runtimes** — Agent runtime environments. -7. Click **[select model]{.smallcaps}** to choose the specific Bedrock resource to link. +g. Click **Select Model** to choose the specific Bedrock resource to link. + +h. (Optional) Click **Test Connection** to ensure the connection is working as expected. + + If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** is displayed. + +i. Click **Link Model**. -8. Optional: Click **Test Connection** to ensure the connection is working as expected. +::: {.callout title="On record dependencies"} +Bedrock agents, flows, and runtimes typically call foundation models (LLMs) under the hood. When you link these application-layer resources to {{< var vm.product >}}, consider also registering their underlying foundation models and creating dependency relationships between them: [Configure record interdependencies](/guide/inventory/configure-record-interdependencies.qmd) - If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. +This builds a complete dependency graph showing how your AI applications relate to underlying models. Benefits include: -9. Click **Link Model**. +- **Impact analysis** — See which applications are affected if a foundation model is deprecated or has compliance issues. +- **Full audit trails** — Documentation and risk assessments capture the entire model stack, not just the top-level application. +- **Governance visibility** — Track model versions and changes across your AI ecosystem. +::: + +::: -[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^2]: [Working with the inventory](../../inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^2]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd b/site/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd index cc87f119f5..bbdf15141f 100644 --- a/site/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd +++ b/site/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd @@ -2,11 +2,11 @@ # 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: "Synchronize models with AWS SageMaker" +title: "Synchronize records with AWS SageMaker" date: last-modified --- -Synchronize models registered in the {{< var vm.product >}} model inventory with AWS SageMaker models. +Synchronize records registered in the {{< var vm.product >}} inventory with Amazon Web Services (AWS) SageMaker models. ::: {.attn} @@ -18,65 +18,67 @@ Synchronize models registered in the {{< var vm.product >}} model inventory with ::: -## Configure the connection +## Sync {{< var vm.product >}} records with AWS SageMaker -::: {.column-margin} -![Connect with AWS SageMaker](integrations-examples-aws-sagemaker.png){width=80% fig-alt="Screenshot of the AWS Sagemaker connection configured to synchronize models, showing the required fields described in step 5." .screenshot} -::: +::: {.panel-tabset} -::: {.column-margin} -![A linked AWS SageMaker model](integrations-examples-aws-sagemaker-linked-model.png){width=60% fig-alt="Screenshot of the model linked to AWS SageMaker, showing the required fields described in step 4." .screenshot} -::: +### 1. Configure AWS SageMaker connection -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. +b. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. -3. Click **{{< fa plus >}} Add Connection**. +c. Click **{{< fa plus >}} Add Connection**. -4. In the modal that opens, select **AWS Sagemaker**. +d. In the modal that opens, select **AWS SageMaker**.[^2] -5. Complete: +e. Complete: - - **[integration name]{.smallcaps}** — How other admins can identify the connection. - - **[description]{.smallcaps}** (optional) — The intended usage or additional details. - - **[aws region]{.smallcaps}** - The primary region where your SageMaker model registry lives, for example `us-west-2`. - - **[aws access key id]{.smallcaps}** — The secret generated by AWS IAM with permissions to read the model registry. - - **[aws secret access key]{.smallcaps}** — The secret generated by AWS IAM with permissions to read the model registry. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. + - **Integration Name** — How other admins can identify the connection. + - **Description** (optional) — The intended usage or additional details. + - **AWS Region** - The primary region where your SageMaker model registry lives, for example `us-west-2`. + - **AWS Access Key ID** — The secret generated by AWS IAM with permissions to read the SageMaker model registry. + - **AWS Secret Access Key** — The secret generated by AWS IAM with permissions to read the SageMaker model registry. + - **Initial Status** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. -6. Click **Save Integration**. +f. Click **Save Integration**. -7. Test the connection: - - a. Hover over the AWS SageMaker connection you just created. - b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. +g. Test the connection: - If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. + i. Hover over the AWS SageMaker connection you just created. + ii. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. + If the test is successful, the message **{{< fa check-circle >}} Connection successful** is displayed. -## Link the models -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. +### 2. Link records to AWS SageMaker -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^2] +a. In the left sidebar, click **{{< fa cubes >}} Inventory**. -3. Scroll down until you locate the **Amazon Sagemaker** connection box in the right sidebar. +b. Select a record or find your record by applying a filter or searching for it.[^3] -4. Hover over the Amazon SageMaker box. +c. Scroll down until you locate the **Amazon SageMaker** connection box in the right sidebar. -5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. +d. Hover over the Amazon SageMaker box. -6. In the modal that opens, click the [select model]{.smallcaps} dropdown to pick the AWS SageMaker model to link. +e. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. -7. Optional: Click **Test Connection** to ensure the connection is working as expected. +f. In the modal that opens, click the **Select Model** dropdown to pick the AWS SageMaker model to link. - If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. +g. (Optional) Click **Test Connection** to ensure the connection is working as expected. -8. Click **Link Model**. + If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** is displayed. + +h. Click **Link Model**. + +::: -[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^2]: + + ![Connect with AWS SageMaker](integrations-examples-aws-sagemaker.png){width=80% fig-alt="Screenshot of the AWS Sagemaker connection configured to synchronize models, showing the required fields described in step 5." .screenshot} -[^2]: [Working with the inventory](../../inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/integrations-examples/synchronize-gitlab.qmd b/site/guide/integrations/integrations-examples/synchronize-gitlab.qmd index c8a9095ee4..f6e7c71b2f 100644 --- a/site/guide/integrations/integrations-examples/synchronize-gitlab.qmd +++ b/site/guide/integrations/integrations-examples/synchronize-gitlab.qmd @@ -2,11 +2,11 @@ # 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: "Synchronize models with GitLab" +title: "Synchronize records with GitLab" date: last-modified --- -Synchronize GitLab model registry with ValidMind model inventory for comprehensive model tracking. +Synchronize your GitLab model registry with the {{< var vm.product >}} inventory for comprehensive tracking. ::: {.attn} @@ -19,62 +19,70 @@ Synchronize GitLab model registry with ValidMind model inventory for comprehensi ::: -## Configure the connection +## Sync {{< var vm.product >}} records with GitLab -::: {.column-margin} -![Configure GitLab connection](integrations-examples-gitlab.png){width=80% fig-alt="Screenshot of the Configure GitLab dialog showing fields for integration name, description, project ID, GitLab instance URL, personal access token, and initial status." .screenshot} -::: +::: {.panel-tabset} + +### 1. Configure GitLab connection + +a. In the left sidebar, click **{{< fa gear >}} Settings**. + +b. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. -1. In the left sidebar, click **{{< fa gear >}} Settings**. +c. Click **{{< fa plus >}} Add Connection**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. +d. In the modal that opens, select **GitLab**.[^3] -3. Click **{{< fa plus >}} Add Connection**. +e. Complete: -4. In the modal that opens, select **GitLab**. + - **Integration Name** — How other admins can identify the connection. + - **Description** (optional) — The intended usage or additional details. + - **Project ID** — The GitLab project ID or path containing ML models (required). + - **Gitlab Instance URL** (optional) — Leave empty to use GitLab.com, or enter your self-hosted GitLab URL. + - **Personal Access Token** — Select a secret containing your GitLab Personal Access Token with `api` or `read_api` scope. + - **Initial Status** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. -5. Complete: +f. Click **Save Integration**. - - **[integration name]{.smallcaps}** — How other admins can identify the connection. - - **[description]{.smallcaps}** (optional) — The intended usage or additional details. - - **[project id]{.smallcaps}** — The GitLab project ID or path containing ML models (required). - - **[gitlab instance url]{.smallcaps}** (optional) — Leave empty to use GitLab.com, or enter your self-hosted GitLab URL. - - **[personal access token]{.smallcaps}** — Select a secret containing your GitLab Personal Access Token with `api` or `read_api` scope. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. +g. Test the connection: -6. Click **Save Integration**. + i. Hover over the GitLab connection you just created. + ii. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. -7. Test the connection: + If the test is successful, the message **{{< fa check-circle >}} Connection successful** is displayed. - a. Hover over the GitLab connection you just created. - b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. +### 2. Link records to GitLab - If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. +a. In the left sidebar, click **{{< fa cubes >}} Inventory**. -## Link the models +b. Select a record or find your record by applying a filter or searching for it.[^4] -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. +c. Scroll down until you locate the **GitLab** connection box in the right sidebar. -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^3] +d. Hover over the GitLab box. -3. Scroll down until you locate the **GitLab** connection box in the right sidebar. +e. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. -4. Hover over the GitLab box. +f. In the modal that opens, click the **Select Model** dropdown to pick the GitLab model to link. -5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. +g. (Optional) Click **Test Connection** to ensure the connection is working as expected. -6. In the modal that opens, click the [select model]{.smallcaps} dropdown to pick the GitLab model to link. + If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** is displayed. -7. Optional: Click **Test Connection** to ensure the connection is working as expected. +h. Click **Link Model**. - If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. +::: -8. Click **Link Model**. -[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^2]: [Manage secrets](/guide/integrations/manage-secrets.qmd) + +[^3]: + + ![Configure GitLab connection](integrations-examples-gitlab.png){width=80% fig-alt="Screenshot of the Configure GitLab dialog showing fields for integration name, description, project ID, GitLab instance URL, personal access token, and initial status." .screenshot} -[^2]: [Manage secrets](../manage-secrets.qmd) -[^3]: [Working with the inventory](../../inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/integrations-examples/synchronize-with-databricks.qmd b/site/guide/integrations/integrations-examples/synchronize-with-databricks.qmd index ec2c3eb2b4..61e93d5b33 100644 --- a/site/guide/integrations/integrations-examples/synchronize-with-databricks.qmd +++ b/site/guide/integrations/integrations-examples/synchronize-with-databricks.qmd @@ -17,22 +17,10 @@ listing: description: "Install the {{< var validmind.developer >}}, load data from a Unity Catalog table via Spark, train a simple classification model, and run ValidMind tests to send results to the {{< var validmind.platform >}}." --- -Link {{< var vm.product >}} inventory records to models, datasets, and agents in Databricks Unity Catalog for governance across your ML ecosystem and bidirectional metadata synchronization. +Link {{< var vm.product >}} inventory records to models, datasets, and agents in Databricks Unity Catalog for governance across your ML ecosystem and bidirectional metadata synchronization. You can also run validation notebooks directly against Databricks-hosted data. -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to configure connections.[^1] -- [x] A secret is configured for your Databricks Personal Access Token.[^2] -- [x] You have admin access to your Databricks workspace. - -::: - - ## How does the integration with Databricks work? Databricks Unity Catalog provides a unified governance solution for all data and AI assets across your Databricks workspaces. The integration exposes three Unity Catalog resource types: @@ -68,72 +56,88 @@ flowchart LR ``` -## Configure the connection +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to configure connections.[^1] +- [x] A secret is configured for your Databricks Personal Access Token.[^2] +- [x] You have admin access to your Databricks workspace. -::: {.column-margin .pt6} -![Configure the Databricks connection](configure-databricks.png){width=80% fig-alt="Screenshot of the Configure Databricks connection dialog showing the required fields described in step 5." .screenshot} ::: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +## Sync {{< var vm.product >}} records with Databricks -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. +::: {.panel-tabset} -3. Click **{{< fa plus >}} Add Connection**. +### 1. Configure Databricks connection -4. In the modal that opens, select **Databricks**. +a. In the left sidebar, click **{{< fa gear >}} Settings**. -5. Complete: +b. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. - - **[integration name]{.smallcaps}** — How other admins can identify the connection. - - **[description]{.smallcaps}** (optional) — The intended usage or additional details. - - **[workspace url]{.smallcaps}** — Your Databricks workspace URL, found in the browser address bar, such as `https://adb-1234567890.azuredatabricks.net`. - - **[sql warehouse id]{.smallcaps}** — The ID of your SQL Warehouse, found in SQL Warehouses settings. - - **[personal access token]{.smallcaps}** — Select a secret containing your Databricks Personal Access Token. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. +c. Click **{{< fa plus >}} Add Connection**. -6. Click **Save Integration**. +d. In the modal that opens, select **Databricks**.[^3] -7. Test the connection: +e. Complete: - a. Hover over the Databricks connection you just created. - b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. + - **Integration Name** — How other admins can identify the connection. + - **Description** (optional) — The intended usage or additional details. + - **Workspace URL** — Your Databricks workspace URL, found in the browser address bar, such as `https://adb-1234567890.azuredatabricks.net`. + - **SQL Warehouse ID** — The ID of your SQL Warehouse, found in SQL Warehouses settings. + - **Personal Access Token** — Select a secret containing your Databricks Personal Access Token. + - **Initial Status** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. - If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. +f. Click **Save Integration**. -## Link records to Databricks +g. Test the connection: -Once the connection is configured, you can link {{< var vm.product >}} inventory records to your Databricks Unity Catalog resources: + i. Hover over the Databricks connection you just created. + ii. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. + + If the test is successful, the message **{{< fa check-circle >}} Connection successful** is displayed. -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. +### 2. Link records to Databricks -2. Select a record by clicking on it or find your record by applying a filter or searching for it.[^3] +Once the connection is configured, you can link {{< var vm.product >}} inventory records to your Databricks Unity Catalog resources: + +a. In the left sidebar, click **{{< fa cubes >}} Inventory**. -3. Scroll down until you locate the **Databricks** connection box in the right sidebar. +b. Select a record by clicking on it or find your record by applying a filter or searching for it.[^4] -4. Hover over the Databricks box. +c. Scroll down until you locate the **Databricks** connection box in the right sidebar. -5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. +d. Hover over the Databricks box. -6. In the modal that opens: +e. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. - - **[select model]{.smallcaps}** — Choose the Databricks model to link from the dropdown. - - **[sync frequency]{.smallcaps}** — Set how often ValidMind automatically syncs data from the external system. +f. In the modal that opens: -7. Click **Link Model** to complete the link. + - **Select Model** — Choose the Databricks model to link from the dropdown. + - **Sync Frequency** — Set how often ValidMind automatically syncs data from the external system. -8. Click **Link Model**. +g. Click **Link Model** to complete the link. After linking, metadata from the Unity Catalog resource syncs to {{< var vm.product >}}. You can use linked fields in custom calculated fields to surface Databricks metadata directly in your inventory views. +::: + ## What's next :::{#whats-next} ::: + -[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^2]: [Manage secrets](/guide/integrations/manage-secrets.qmd) + +[^3]: -[^2]: [Manage secrets](../manage-secrets.qmd) + ![Configure the Databricks connection](configure-databricks.png){width=80% fig-alt="Screenshot of the Configure Databricks connection dialog showing the required fields described in step 5." .screenshot} -[^3]: [Working with the inventory](../../inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd b/site/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd index ea216d903f..87646d3deb 100644 --- a/site/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd +++ b/site/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd @@ -25,18 +25,18 @@ Start a {{< var vm.product >}} workflow from an external system by sending a POS ::: {.panel-tabset} -### a. Configure workflow in {{< var vm.product >}} +### 1. Configure workflow in {{< var vm.product >}} -1. Add a new workflow, selecting the **Via Webhook** workflow start option.[^3] +a. Add a new workflow, selecting the **Via Webhook** workflow start option.[^3] -2. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^4] onto the canvas, then connect it to your workflow. +b. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^4] onto the canvas, then connect it to your workflow. -3. Double-click the step to open the **Webhook Step Trigger** modal. +c. Double-click the step to open the **Webhook Step Trigger** modal. -4. Copy or select the webhook details: +d. Copy or select the webhook details: - **URL** — Click **{{< fa regular copy >}} Copy** for the unique POST webhook URL to use when configuring your external system. - - **[select target {record-type} record for payload]{.smallcaps}** — Select the record that is associated with the webhook payload from the dropdown. + - **Select Target {record-type} Record for Payload** — Select the record that is associated with the webhook payload from the dropdown. - **Payload** — Click **{{< fa regular copy >}} Copy** for the JSON payload that external systems must send in their POST request, where the value for `target_cuid` is shown after you select a target: ```json @@ -50,16 +50,16 @@ Start a {{< var vm.product >}} workflow from an external system by sending a POS - For the required authentication headers, click **{{< fa regular copy >}} Copy** for each of the following key-value pairs and paste them into your external system: - `x-api-key`: `{{API Key}}` - `x-api-secret`: `{{API Secret}}` - - **[wait for webhook trigger when reached]{.smallcaps}** — When enabled, the workflow pauses execution when it reaches this step and waits for the external system to send the POST request. + - **Wait for Webhook Trigger When Reached** — When enabled, the workflow pauses execution when it reaches this step and waits for the external system to send the POST request. -5. Click **Save**. +e. Click **Save**. -### b. Start workflow from external system +### 2. Start workflow from external system -Send a POST request to the webhook URL with a JSON payload that includes the `run_workflow` action for the target model CUID: +Send a POST request to the webhook URL with a JSON payload that includes the `run_workflow` action for the target record (model) CUID: ```bash -curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxxxxxxxxxxxx/xxxx -H 'Content-Type`: `application/json' -H 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -H 'x-api-secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --data '{ +curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxxxxxxxxxxxx/xxxx -H 'Content-Type: application/json' -H 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -H 'x-api-secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --data '{ "action": "run_workflow", "target": "", "entity_name": "InventoryModel" @@ -73,18 +73,18 @@ Trigger a waiting {{< var vm.product >}} workflow step to continue from an exter ::: {.panel-tabset} -### a. Configure workflow in {{< var vm.product >}} +### 1. Configure workflow in {{< var vm.product >}} -1. Open the workflow you want to configure, or add a new workflow.[^3] +a. Open the workflow you want to configure, or add a new workflow.[^3] -2. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^4] onto the canvas, then connect the step to your workflow. +b. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^4] onto the canvas, then connect the step to your workflow. -3. Double-click the step to open the **Webhook Step Trigger** modal. +c. Double-click the step to open the **Webhook Step Trigger** modal. -4. Copy or select the webhook details: +d. Copy or select the webhook details: - **URL** — Click **{{< fa regular copy >}} Copy** for the unique POST webhook URL to use when configuring your external system. - - **[select target {record-type} record for payload]{.smallcaps}** — Select the record that is associated with the webhook payload from the dropdown. + - **Select Target {record-type} Record for Payload** — Select the record that is associated with the webhook payload from the dropdown. - **Payload** — Click **{{< fa regular copy >}} Copy** for the JSON payload that external systems must send in their POST request, where the value for `target_cuid` is shown after you select a target: ```json @@ -99,16 +99,16 @@ Trigger a waiting {{< var vm.product >}} workflow step to continue from an exter - `x-api-key`: `{{API Key}}` - `x-api-secret`: `{{API Secret}}` -5. Click **Update Step** to save your configuration. +e. Click **Update Step** to save your configuration. When the workflow reaches this step, it pauses and waits for the external system. -### b. Trigger workflow to continue from external system +### 2. Trigger workflow to continue from external system -Send a POST request to the webhook URL with a JSON payload containing the `run_step` action for the model CUID: +Send a POST request to the webhook URL with a JSON payload containing the `run_step` action for the target record (model) CUID: ```bash -curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxxxxxxxxxxxx/xxxx -H 'Content-Type`: `application/json' -H 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -H 'x-api-secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --data '{ +curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxxxxxxxxxxxx/xxxx -H 'Content-Type: application/json' -H 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -H 'x-api-secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --data '{ "action": "run_step", "target": "", "entity_name": "InventoryModel" @@ -119,10 +119,10 @@ curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxx -[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^2]: [Introduction to workflows](../../workflows/introduction-to-workflows.qmd) +[^2]: [Introduction to workflows](/guide/workflows/introduction-to-workflows.qmd) -[^3]: [Add new workflows](../../workflows/configure-workflows.qmd#add-new-workflows) +[^3]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) -[^4]: [Workflow step types](../../workflows/workflow-step-types.qmd#webhook) +[^4]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#webhook) diff --git a/site/guide/integrations/link-external-models.qmd b/site/guide/integrations/link-external-records.qmd similarity index 54% rename from site/guide/integrations/link-external-models.qmd rename to site/guide/integrations/link-external-records.qmd index 202bbd3de5..ebdb984073 100644 --- a/site/guide/integrations/link-external-models.qmd +++ b/site/guide/integrations/link-external-records.qmd @@ -2,13 +2,14 @@ # 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: "Linking external models" +title: "Link external records" date: last-modified aliases: - /guide/integrations/linking-external-models.html + - /guide/integrations/link-external-models.html --- -Link models in the {{< var vm.product >}} model inventory to external systems to keep model information synchronized. +Link records (models) tracked in {{< var vm.product >}} to external systems to keep your inventories synchronized. You can link, refresh, edit, and remove these connections as needed. @@ -17,49 +18,39 @@ You can link, refresh, edit, and remove these connections as needed. ## Prerequisites - [x] {{< var link.login >}} -- [x] The record you want to link external models for is registered in the inventory.[^1] +- [x] The record you want to link external records for is registered in the inventory.[^1] - [x] A connection is configured for the external system you want to link to.[^2] -- [x] You are assigned a role with sufficient permissions to manage model links, such as [{{< fa hand >}} Customer Admin]{.bubble}.[^3] +- [x] You are assigned a role with sufficient permissions to manage record links, such as [{{< fa hand >}} Customer Admin]{.bubble}.[^3] ::: -## Link models +## Link records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^4] +2. Select a record or find your record by applying a filter or searching for it.[^4] -3. Scroll down until you locate the available connections for integrations in the right sidebar. - - For example, **MLflow** or **Amazon SageMaker**. - -::: {.column-margin} -![Connections for MLflow and AWS SageMaker](linking-models-available-connections.png){fig-alt="Screenshot of the available connections to link to, showing the required fields described in step 3." .screenshot} -::: - -::: {.column-margin} -![A linked AWS SageMaker model](integrations-examples-aws-sagemaker-linked-model.png){width=60% fig-alt="Screenshot of the model linked to AWS SageMaker, showing the required fields described in step 4." .screenshot} -::: +3. Scroll down until you locate the available connections for integrations in the right sidebar. 4. Hover over the connection. 5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. -6. In the modal that opens, pick the external model from the [select model]{.smallcaps} dropdown. +6. In the modal that opens, pick the external record from the **Select Model** dropdown. -7. Optional: Click **Test Connection** to ensure the connection is working as expected. +7. (Optional) Click **Test Connection** to ensure the connection is working as expected. If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. 8. Click **Link Model**. -After linking, the message **Pending initial sync** displays. This means that the model is linked to the external system, but data hasn't been synchronized yet. If necessary, you can refresh the model data.[^5] +After linking, the message **Pending initial sync** displays. This means that the record is linked to the external system, but data hasn't been synchronized yet. If necessary, you can refresh the record data.[^5] -## Refresh model data +## Refresh record data 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^6] +2. Select a record or find your record by applying a filter or searching for it.[^4] 3. Scroll down until you locate the connection you want to edit in the right sidebar. For example, **Amazon SageMaker**. @@ -67,11 +58,11 @@ After linking, the message **Pending initial sync** displays. This means that th 5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa sync >}} Refresh**. -## Edit model links +## Edit record links 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^6] +2. Select a record or find your record by applying a filter or searching for it.[^4] 3. Scroll down until you locate the connection you want to edit in the right sidebar. For example, **Amazon SageMaker**. @@ -79,15 +70,15 @@ After linking, the message **Pending initial sync** displays. This means that th 5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Edit Link**. -6. In the modal that opens, make your changes. For example, select a different model from the **[select model]{.smallcaps}** dropdown. +6. In the modal that opens, make your changes. For example, select a different record from the **Select Model** dropdown. -8. Click **Update Link** to save your changes. +7. Click **Update Link** to save your changes. -## Remove model links +## Remove record links 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^7] +2. Select a record or find your record by applying a filter or searching for it.[^4] 3. Scroll down until you locate the integration box (for example, **MLflow** or **Amazon SageMaker**) in the right sidebar. @@ -97,8 +88,6 @@ After linking, the message **Pending initial sync** displays. This means that th 6. Click **Yes, Unlink Integration** to confirm removal of the link. -The model is unlinked from the external system. - [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) @@ -109,8 +98,4 @@ The model is unlinked from the external system. [^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 inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^5]: [Refresh record data](#refresh-record-data) diff --git a/site/guide/integrations/manage-secrets.qmd b/site/guide/integrations/manage-secrets.qmd index 1b662bf52e..af0535c274 100644 --- a/site/guide/integrations/manage-secrets.qmd +++ b/site/guide/integrations/manage-secrets.qmd @@ -24,171 +24,182 @@ You store each secret once and then reuse it across supported integrations. Integration secrets authenticate persistent connections to external platforms. You store each secret once and then reuse it across supported integrations by selecting it from a dropdown when configuring a connection. -### Add integration secrets - 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab. +2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then click the **Integration Secrets** tab to view, add, edit, revoke, or delete integration secrets: -3. Click **{{< fa plus >}} Add Secret**. +### View integration secret details -4. Fill in the details: +Click the secret you want to view. - - **[secret name]{.smallcaps}** — Enter an easily identifiable label that indicates which system the secret belongs to. - - **[description]{.smallcaps}** (optional) — Summarize when to use the secret or who owns it so other admins know whether it is safe to re-use. - - **[secret value]{.smallcaps}** — Paste the credential exactly as issued by the external system. The value is encrypted and never displayed in plaintext again. - - **[expiration date]{.smallcaps}** (optional) — Set a rotation reminder if the external system enforces key expiry. +### Add or edit integration secrets -5. Click **Create Secret**. +::: {.panel-tabset} -The secret can now be selected when configuring connections.[^2] +### Add integration secrets -::: {.column-margin} -::: {.callout-tip title="For secrets with expiration dates"} -Recommended: Create a new secret and update integrations that should use it.

    Or, to continue using the same secret, extend the expiration date. -::: -::: +a. Click **{{< fa plus >}} Add Secret**. -### View integration secret details +b. Fill in the details: -1. In the left sidebar, click **{{< fa gear >}} Settings**. + - **Secret Name** — Enter an easily identifiable label that indicates which system the secret belongs to. + - **Description** (optional) — Summarize when to use the secret or who owns it so other admins know whether it is safe to re-use. + - **Secret Value** — Paste the credential exactly as issued by the external system. The value is encrypted and never displayed in plaintext again. + - **Expiration Date** (optional) — Set a rotation reminder if the external system enforces key expiry. -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab. +c. Click **Create Secret**. -3. Click the secret you want to view. +The secret can now be selected when configuring connections.[^2] ### Edit integration secrets -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. Click the secret you want to modify. -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab. +b. In the modal that appears, click **Edit Secret**. -3. Click the secret you want to change. +c. Make your changes. For example: -4. In the modal that appears, click **Edit Secret**. + - **Secret Value** — Paste a new value if the external platform issued a replacement token. + - **Expiration Date** (optional) — Extend the expiry window if you want to keep the secret active for longer. -5. Make your changes. For example: +d. Click **Update Secret** to save your changes. - - **[secret value]{.smallcaps}** — Paste a new value if the external platform issued a replacement token. - - **[expiration date]{.smallcaps}** (optional) — Extend the expiry window if you want to keep the secret active for longer. +::: -6. Click **Update Secret** to save your changes. -### Revoke integration secrets +### Revoke or delete integration secrets -1. In the left sidebar, click **{{< fa gear >}} Settings**. +::: {.panel-tabset} -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab. +### Revoke integration secrets -3. Hover over the secret you want to change. +a. Hover over the secret you want to revoke. -4. When **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa triangle-exclamation >}} Revoke**. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa triangle-exclamation >}} Revoke**. -5. On the confirmation dialogue that appears, select **OK** to confirm revocation. +c. On the confirmation dialogue that appears, select **OK** to confirm revocation. Revocation immediately disables the secret so it can no longer be used, but does not remove it. ### Delete integration secrets -::: {.callout-warning title="Deleting a secret is permanent."} +::: {.callout-important title="Deleting a secret is permanent."} Be sure to update any connections that depend on this secret before deleting it. ::: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. Hover over the secret you want to remove. + +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click it, then select **{{< fa trash >}} Delete**. + +c. In the confirmation dialog, select **OK** to confirm deletion. + +::: -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab. -3. Hover over the secret you want to remove. +
    -4. When **{{< fa ellipsis-vertical >}}** appears, click it, then select **{{< fa trash >}} Delete**. +::: {.callout-button .pl4 .nt4} +::: {.callout collapse="true" appearance="minimal"} +### How should I manage secrets with expiration dates? -5. In the confirmation dialog, select **OK** to confirm deletion. +(Recommended) Create a new secret and update integrations that should use it. + +Or, to continue using the same secret, extend the expiration date. + +::: +::: ## Webhook secrets Webhook secrets authenticate outgoing HTTP requests in workflows. Instead of hardcoding credentials directly into HTTP Request step header values, you store secrets once and reference them using `{{secret:name}}` syntax. HTTPS is enforced when secrets are used. -### Add webhook secrets - 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab. +2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then click the **Webhook Secrets** tab to view, add, edit, revoke, or delete webhook secrets: -3. Click **{{< fa plus >}} Add Secret**. +### View webhook secret details + +Click the secret you want to view. + +### Add or edit webhook secrets + +::: {.panel-tabset} + +### Add webhook secrets + +a. Click **{{< fa plus >}} Add Secret**. -4. Fill in the details: +b. Fill in the details: - - **[secret name]{.smallcaps}** — Enter an easily identifiable label. Use this name to reference the secret: `{{secret:secret_name}}`. - - **[description]{.smallcaps}** (optional) — Summarize what the secret is used for. - - **[secret value]{.smallcaps}** — Paste the credential. The value is encrypted at rest and never displayed in plaintext again. - - **[expiration date]{.smallcaps}** (optional) — Set a rotation reminder if the credential expires. + - **Secret Name** — Enter an easily identifiable label. Use this name to reference the secret: `{{secret:secret_name}}`. + - **Description** (optional) — Summarize what the secret is used for. + - **Secret Value** — Paste the credential. The value is encrypted at rest and never displayed in plaintext again. + - **Expiration Date** (optional) — Set a rotation reminder if the credential expires. -5. Click **Create Secret**. +c. Click **Create Secret**. The secret can now be referenced in HTTP Request step headers using `{{secret:secret_name}}` syntax. -#### Usage example +
    + +::: {.callout-button .pl4 .nt4} +::: {.callout collapse="true" appearance="minimal"} +### Webhook secret usage example + In a workflow HTTP Request step, add a header: -- **Header Name**: `Authorization` +- **Header Name**: `Authorization` - **Header Value**: `Bearer {{secret:jira_pat}}` At runtime, the workflow engine replaces `{{secret:jira_pat}}` with the stored value and sends the request over HTTPS. -### View webhook secret details - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab. - -3. Click the secret you want to view. +::: +::: ### Edit webhook secrets -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab. +a. Click the secret you want to modify. -3. Click the secret you want to change. +b. Make your changes. For example: -4. Make your changes. For example: + - **Secret Value** — Paste a new value if the credential was rotated. + - **Expiration Date** (optional) — Extend the expiry window. - - **[secret value]{.smallcaps}** — Paste a new value if the credential was rotated. - - **[expiration date]{.smallcaps}** (optional) — Extend the expiry window. +c. Click **Update Secret** to save your changes. -5. Click **Update Secret** to save your changes. +::: -### Revoke webhook secrets +### Revoke or delete webhook secrets -1. In the left sidebar, click **{{< fa gear >}} Settings**. +::: {.panel-tabset} -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab. +### Revoke webhook secrets -3. Hover over the secret you want to revoke. +a. Hover over the secret you want to revoke. -4. When **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa triangle-exclamation >}} Revoke**. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa triangle-exclamation >}} Revoke**. -5. On the confirmation dialogue that appears, select **OK** to confirm revocation. +c. On the confirmation dialogue that appears, select **OK** to confirm revocation. Revocation immediately disables the secret. Any HTTP Request workflow steps referencing it will fail until you update them to use an active secret. ### Delete webhook secrets -::: {.callout-warning title="Deleting a secret is permanent."} +::: {.callout-important title="Deleting a secret is permanent."} Be sure to update any HTTP Request workflow steps that depend on this secret before deleting it. ::: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +a. Hover over the secret you want to remove. -2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click it, then select **{{< fa trash >}} Delete**. -3. Hover over the secret you want to remove. +c. In the confirmation dialog, select **OK** to confirm deletion. -4. When **{{< fa ellipsis-vertical >}}** appears, click it, then select **{{< fa trash >}} Delete**. +::: -5. In the confirmation dialog, select **OK** to confirm deletion. [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + [^2]: [Configure connections](/guide/integrations/configure-connections.qmd) diff --git a/site/guide/integrations/managing-integrations.qmd b/site/guide/integrations/managing-integrations.qmd index 4b251ae341..741d4a8caf 100644 --- a/site/guide/integrations/managing-integrations.qmd +++ b/site/guide/integrations/managing-integrations.qmd @@ -12,29 +12,55 @@ listing: sort: false fields: [title, description] contents: - - manage-secrets.qmd + - manage-secrets.qmd - configure-connections.qmd - - configure-analytics-exports.qmd + - configure-data-exports.qmd - implement-custom-integrations.qmd - - link-external-models.qmd + - link-external-records.qmd - integrations-examples.qmd --- Integrations connect the {{< var validmind.platform >}} with external systems or services, enabling bidirectional data synchronization, workflow automation, and API access. -## What can I do with integrations? +## Key concepts + + + +:::: {.flex .flex-wrap .justify-around} + +::: {.w-50-ns .pr3} + +{{< include /about/glossary/integrations/_integration.qmd >}} + +{{< include /about/glossary/integrations/_secret.qmd >}} + +{{< include /about/glossary/integrations/_connection.qmd >}} + +::: + +::: {.w-50-ns .pl3} + +{{< include /about/glossary/integrations/_http-request.qmd >}} + +{{< include /about/glossary/integrations/_webhook.qmd >}} + +::: + +:::: + +### What can I do with integrations? ```{mermaid} graph TD A[ValidMind Platform] B[Analytics and reporting] - C[Model inventory] + C[Inventory] D[Workflows] E[Public REST API] F[Testing & documentation] G[Service integration] H[AI assistants] - + A <--> B A <--> C A <--> D @@ -46,9 +72,11 @@ graph TD +::: {.panel-tabset} + ### Analytics and reporting -Access built-in analytics and dashboards. Or, import analytics data into external reporting tools to build unified reports that combine {{< var vm.product >}} insights with other sources. Schedule exports of analytics datasets to cloud storage for BI tools like Tableau, Snowflake, and Looker.[^1][^6] +Access built-in analytics and dashboards.[^1] Or, import platform data into external reporting tools to build unified reports that combine {{< var vm.product >}} insights with other sources. Schedule data exports to cloud storage for BI tools like Tableau, Snowflake, and Looker.[^2] **Supported** @@ -70,9 +98,9 @@ Access built-in analytics and dashboards. Or, import analytics data into externa --- -### Model inventory +### Inventory -Link to models in external registries and development platforms and keep inventories synced with versions, inventory fields, and other metadata.[^2] +Link to records (such as models) in external registries and development platforms and keep inventories synced with versions, inventory fields, and other metadata.[^3] **Supported** @@ -132,17 +160,17 @@ Link to models in external registries and development platforms and keep invento ![Workflow integration example](simple-integrations-workflow.png){width=80% fig-alt="A workflow showing an automation sequence. A green start node runs an HTTP request that sends a POST to https://some.example.com/request. The workflow then moves to a webhook step that pauses until a webhook call is received. Once the webhook arrives, the flow continues to a red end node." .screenshot} ::: -Manage model lifecycles by configuring workflows to transition models through your organization’s custom model stages.[^3] +Manage record lifecycles by configuring workflows to transition records through your organization’s custom record stages.[^4] :::: {.flex .flex-wrap .justify-around} ::: {.w-50 .pr5} -**From {{< var vm.product >}}** -Send HTTP requests to external services when a model reaches a specific state or to trigger updates in other systems. +**From {{< var vm.product >}}** +Send HTTP requests to external services when a record reaches a specific stage or to trigger updates in other systems. ::: ::: {.w-50 .pl3 .pr3} -**From external systems** +**From external systems** Send webhooks (POST requests) into {{< var vm.product >}} to start workflows or to resume workflows that are paused and waiting for input. ::: @@ -152,14 +180,14 @@ Send webhooks (POST requests) into {{< var vm.product >}} to start workflows or ### Public REST API -Gain programmatic access to platform resources. The API supports integration with custom scripts, automation tools, and external platforms that need direct access to {{< var vm.product >}}.[^4] +Gain programmatic access to platform resources. The API supports integration with custom scripts, automation tools, and external platforms that need direct access to {{< var vm.product >}}.[^5] **CRUD examples** :::: {.flex .flex-wrap .justify-around} ::: {.w-33-ns} -- Create models +- Create records (models) ::: ::: {.w-33-ns} @@ -167,7 +195,7 @@ Gain programmatic access to platform resources. The API supports integration wit ::: ::: {.w-33-ns} -- Manage model inventory +- Manage your inventory ::: :::: @@ -176,7 +204,7 @@ Gain programmatic access to platform resources. The API supports integration wit ### Testing & documentation -Integrate the {{< var validmind.developer >}} with other development platforms to run tests and test suites, generate documentation, and support ongoing monitoring. See the results locally or upload them to the {{< var validmind.platform >}}.[^5] +Integrate the {{< var validmind.developer >}} with other development platforms to run tests and test suites, generate documentation, and support ongoing monitoring. See the results locally or upload them to the {{< var validmind.platform >}}.[^6] **Supported** @@ -224,7 +252,7 @@ Link to tickets in external systems and keep them synchronized. Attach tickets t ### AI assistants -Connect AI assistants to {{< var vm.product >}} using the Model Context Protocol (MCP). Query and manage your model inventory through natural language conversations.[^7] +Connect AI assistants to {{< var vm.product >}} using the Model Context Protocol (MCP). Query and manage your inventory through natural language conversations.[^7] **Supported** @@ -244,43 +272,31 @@ Connect AI assistants to {{< var vm.product >}} using the Model Context Protocol :::: -## Key concepts - - - -:::: {.flex .flex-wrap .justify-around} +::: -::: {.w-50-ns .pr3} +## Manage integrations -{{< include /about/glossary/integrations/_integration.qmd >}} +:::{#integrations-listing} +::: -{{< include /about/glossary/integrations/_secret.qmd >}} +## What's next -{{< include /about/glossary/integrations/_connection.qmd >}} +- [Integrations and support FAQ](/faq/faq-integrations.qmd) +- [Setting up workflows](/guide/workflows/introduction-to-workflows.qmd) -::: -::: {.w-50-ns .pl3} + -{{< include /about/glossary/integrations/_http-request.qmd >}} +[^1]: [Analytics and reporting](/guide/reporting/working-with-analytics.qmd) -{{< include /about/glossary/integrations/_webhook.qmd >}} +[^2]: [Configure data exports](/guide/integrations/configure-data-exports.qmd) -::: +[^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) -:::: +[^4]: [Introduction to workflows](/guide/workflows/introduction-to-workflows.qmd) -## Manage integrations - -:::{#integrations-listing} -::: +[^5]: [Public REST API](/reference/validmind-rest-api-vm.qmd) - +[^6]: [Testing & documentation](/developer/validmind-library.qmd) -[^1]: [Analytics and reporting](/guide/reporting/working-with-analytics.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) -[^6]: [Configure analytics exports](/guide/integrations/configure-analytics-exports.qmd) [^7]: [Connect AI assistants](/guide/mcp/connect-ai-assistants-via-mcp.qmd) \ No newline at end of file diff --git a/site/guide/inventory/_add-attachments.qmd b/site/guide/inventory/_add-attachments.qmd index c979532fad..d5a7e001b4 100644 --- a/site/guide/inventory/_add-attachments.qmd +++ b/site/guide/inventory/_add-attachments.qmd @@ -4,8 +4,8 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 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. + - Add a **Note** to the file by clicking on the **{{< fa ellipsis-vertical >}}** menu, then select **{{< fa file-medical >}} Add Note**. + - Update a **Note** by making your changes in the existing text field. 3. Click **Save** to submit the upload. diff --git a/site/guide/inventory/_add-edit-inventory-fields.qmd b/site/guide/inventory/_add-edit-inventory-fields.qmd index f8e395e038..8d4c771e6a 100644 --- a/site/guide/inventory/_add-edit-inventory-fields.qmd +++ b/site/guide/inventory/_add-edit-inventory-fields.qmd @@ -10,16 +10,16 @@ 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), 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. Inventory fields require you to enter a **Title** (name), select a field **Type**,^[[Inventory field types](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] and indicate what **Inventory Record Types**^[[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. + - Enter a custom field **Key**.^[If left blank, a key will be automatically generated in `camelCase` format.] + - Enter a **Description** to indicate the purpose of the field displayed on the list of fields. + - Enter **Help Text** to provide guidance to users on how best to fill out that field. - 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] + - Assign a field to a **Group**.^[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** 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**. @@ -37,9 +37,9 @@ a. Under the Default Fields grouping, click on the inventory field you want to e a. Toggle the following options on or off: - - **[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. + - **Disable Field** — Hide this field from all records in your inventory.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] + - **Show on Registration** — Show this field during record registration.^[[Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)] + - **Require on Registration** — Require input in this field during record registration. a. Click **Save Configuration** to apply your changes. @@ -53,7 +53,7 @@ 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/inventory/manage-inventory-fields.qmd#rename-custom-field-keys)] + Field keys for custom inventory field can be renamed under the **Actions** column.^[[Rename custom field keys](/guide/inventory/manage-inventory-fields.qmd#rename-custom-field-keys)] @@ -65,7 +65,7 @@ a. Make your desired changes to your inventory field, then click **Save**. [^edit-fields]: ::: {.callout} - ## All other users will have read-only access unless specified under the **[write permissions]{.smallcaps}**. + ## All other users will have read-only access unless specified under the **Write Permissions**. - [**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. @@ -95,16 +95,16 @@ a. Make your desired changes to your inventory field, then click **Save**. - Click **{{< fa plus >}} Add Field** to add a new field. - Click on an existing field to edit that field. -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. Inventory fields require you to enter a **Title** (name), select a field **Type**, and indicate what **Inventory Record Types** 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. + - Enter a custom field **Key**. If left blank, a key will be automatically generated in `camelCase` format. + - Enter a **Description** to indicate the purpose of the field displayed on the list of fields. + - Enter **Help Text** to provide guidance to users on how best to fill out that field. - 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 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. + - Assign a field to a **Group**. Ungrouped fields will be listed under No Group. + - Assign **Write Permissions** 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 index 21416b69e7..e7cc4cff0c 100644 --- a/site/guide/inventory/_add-edit-record-types.qmd +++ b/site/guide/inventory/_add-edit-record-types.qmd @@ -10,16 +10,16 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. Click **{{< fa plus >}} Add Inventory Record Type**. -b. Enter a **[name]{.smallcaps}** for your record type. +b. Enter a **Name** 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/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. + - Enter a **Description** to indicate the purpose of the record type displayed on the list of record types. + - Enter a URL-safe **Slug** 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** available to be created for this record type.^[[Manage document types](/guide/templates/manage-document-types.qmd)] + - Select the **Artifact Types** available to be logged on this record type.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] + - Select the **Stakeholder Types** that should be displayed on this record type.^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] + - Select the **Default Stakeholder Types** that should be displayed by default on this record type. d. When you are satisfied with the setup of your record type, click **Create**. @@ -51,15 +51,15 @@ b. Make your desired changes to your record type, then click **Update**. #### Record type details -a. Inventory record types require you to enter a **[name]{.smallcaps}** for your record type. +a. Inventory record types require you to enter a **Name** 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/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. + - Enter a **Description** to indicate the purpose of the record type displayed on the list of record types. + - Enter a URL-safe **Slug** 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**](/guide/templates/manage-document-types.qmd){target="_blank"} available to be created for this record type. + - Select the [**Artifact Types**](/guide/validation/manage-artifact-types.qmd){target="_blank"} available to be logged on this record type. + - Select the [**Stakeholder Types**](/guide/configuration/manage-record-stakeholder-types.qmd){target="_blank"} that should be displayed on this record type. + - Select the **Default Stakeholder Types** 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 index 204909fd2d..83139f1c8e 100644 --- a/site/guide/inventory/_enable-disable-record-types.qmd +++ b/site/guide/inventory/_enable-disable-record-types.qmd @@ -13,8 +13,8 @@ To hide or show record types from the inventory: 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. + - Toggle **Disabled** 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** to show the record type in the inventory. 4. Click **Update** to save your changes. @@ -28,8 +28,8 @@ Disabling a record type will hide the record type from the inventory and prevent 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. + - Toggle **Disabled** to hide the record type from the inventory. + - Untoggle **Disabled** to show the record type in the inventory. b. Click **Update** to save your changes. diff --git a/site/guide/inventory/_field-types.qmd b/site/guide/inventory/_field-types.qmd index b83cb256c8..3b721aa398 100644 --- a/site/guide/inventory/_field-types.qmd +++ b/site/guide/inventory/_field-types.qmd @@ -8,15 +8,15 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> Aggregation : Automatically compute a read-only value from downstream artifacts^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)] linked to this record. -1. Select the type of **[artifacts]{.smallcaps}** to aggregate from.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] +1. Select the type of **Artifacts** to aggregate from.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] -2. Select an **[aggregation function]{.smallcaps}**:^[For MIN or MAX, also select the Date type **[artifact field]{.smallcaps}** to aggregate on.] +2. Select an **Aggregation Function**:^[For MIN or MAX, also select the Date type **Artifact Field** to aggregate on.] - **COUNT - Count matching entities** — Count the number of matching artifacts for that type. - **MIN - Earliest/minimum value** — Return the least recent value from a selected Date type artifact field for that type. - **MAX - Latest/maximum value** — Return the most recent value from a selected Date type artifact field for that type. -4. (Optional) Click **{{< fa plus >}} Add Rule** under [filters]{.smallcaps} to narrow which artifacts are included in the aggregation. +4. (Optional) Click **{{< fa plus >}} Add Rule** under **Filters** to narrow which artifacts are included in the aggregation. ::: {.callout-button .pl4 .nt4} @@ -28,26 +28,26 @@ Aggregation 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` +- **Artifacts** — Validation Issue +- **Aggregation Function** — COUNT - Count matching entities +- **Filters** — Status IN `open` ##### Earliest logged Model Limitation 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 +- **Artifacts** — Model Limitation +- **Aggregation Function** — MIN - Earliest/minimum value +- **Artifact Field** — Created At ##### Most recent Policy Exception 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 -- **[artifact field]{.smallcaps}** — Updated At +- **Artifacts** — Policy Exception +- **Aggregation Function** — MAX - Latest/maximum value +- **Artifact Field** — Updated At ::: ::: @@ -73,7 +73,7 @@ Calculation ::: :::: {.content-visible when-format="html" when-meta="includes.inventory"} -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.] +1. Select from the drop-down of **Available Record Fields** 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.^[Reference fields with dictionary-style access — `params["fieldKey"]` — and use the available helpers for date and number work.] 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. @@ -105,7 +105,7 @@ def formula(params): :::: :::: {.content-visible when-format="html" when-meta="includes.artifacts"} -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.] +1. Select from the drop-down of **Available Artifact Fields** and **Record Fields Available Via** `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.^[Reference fields with dictionary-style access — `params["fieldKey"]` and `params["model"]["fieldKey"]` for parent inventory record data — and use the available helpers for date and number work.] 3. Click **Test Calculation {{< fa angle-down >}}** to open the testing area. 4. Enter in sample values in the testing area then click **{{< fa play >}} Test Calculation** to validate your formula. @@ -245,12 +245,12 @@ Checkbox Date : - Date value in `yyyy-mm-dd` format. - Selection is in the current user's timezone; other users viewing this field will see the value automatically in their timezone. -- Set the [date format]{.smallcaps} for date fields under your profile.^[[Manage your profile](/guide/configuration/manage-your-profile.qmd#localization)] +- Set the **Date Format** for date fields under your profile.^[[Manage your profile](/guide/configuration/manage-your-profile.qmd#localization)] Date Time : - Date value in `yyyy-mm-dd, 24hr` format. - Selection is in the current user's timezone; other users viewing this field will see the value automatically in their timezone. -- Set the [date format]{.smallcaps} for date time fields under your profile.^[[Manage your profile](/guide/configuration/manage-your-profile.qmd#localization)] +- Set the **Date Format** for date time fields under your profile.^[[Manage your profile](/guide/configuration/manage-your-profile.qmd#localization)] Email : Text value in valid email (`user@domain.com`) format. @@ -262,10 +262,10 @@ Multiple Select : Click **{{< fa plus >}} Add Option** to define a list of options. Number -: Text value in valid number format. Number display (comma, fullstop, etc.) is determined by your browser's locale. Select a **[number type]{.smallcaps}**: +: Text value in valid number format. Number display (comma, fullstop, etc.) is determined by your browser's locale. Select a **Number Type**: -- **Simple** — Define the [decimal places]{.smallcaps} that the number should be displayed up to and any [large number abbreviation]{.smallcaps}s. -- **Currency** — Define the [currency]{.smallcaps} you would like the field to display in, as well as the [decimal places]{.smallcaps} that the number should be displayed up to and any [large number abbreviation]{.smallcaps}s. +- **Simple** — Define the **Decimal Places** that the number should be displayed up to and any **Large Number Abbreviation**s. +- **Currency** — Define the **Currency** you would like the field to display in, as well as the **Decimal Places** that the number should be displayed up to and any **Large Number Abbreviation**s. :::: {.flex .flex-wrap .justify-around} @@ -295,7 +295,7 @@ URL User : - Select list pre-populated with users from your {{< fa book-open >}} User Directory.^[[Manage users](/guide/configuration/manage-users.qmd)] -- Toggle [allow linking to multiple records]{.smallcaps} on to allow multi-selection of users. +- Toggle **Allow Linking to Multiple Records** on to allow multi-selection of users. :::: @@ -307,7 +307,7 @@ Attachments Calculation : Define a `formula(params)` function that reads field values from the `params` dictionary (`params["fieldKey"]`) and returns a read-only value. Formulas are written in Starlark and have access to a set of built-in helpers for dates, numbers, and lists. - 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. + 1. Select from the drop-down of **Available Record Fields**, or **Available Artifact Fields** and **Record Fields Available Via** `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 sample values in the testing area then click **{{< fa play >}} Test Calculation** to validate your formula. @@ -333,10 +333,10 @@ Multiple Select : Click **{{< fa plus >}} Add Option** to define a list of options. Number -: Text value in valid number format. Number display (comma, fullstop, etc.) is determined by your browser's locale. Select a **[number type]{.smallcaps}**: +: Text value in valid number format. Number display (comma, fullstop, etc.) is determined by your browser's locale. Select a **Number Type**: - - **Simple** — Define the [decimal places]{.smallcaps} that the number should be displayed up to and any [large number abbreviation]{.smallcaps}s. - - **Currency** — Define the [currency]{.smallcaps} you would like the field to display in, as well as the [decimal places]{.smallcaps} that the number should be displayed up to and any [large number abbreviation]{.smallcaps}s. + - **Simple** — Define the **Decimal Places** that the number should be displayed up to and any **Large Number Abbreviation**s. + - **Currency** — Define the **Currency** you would like the field to display in, as well as the **Decimal Places** that the number should be displayed up to and any **Large Number Abbreviation**s. Single Line Text : Simple text value. @@ -350,6 +350,6 @@ URL User : - Select list pre-populated with users from your [{{< fa book-open >}} User Directory](/guide/configuration/manage-users.qmd){target="_blank"}. -- Toggle [allow linking to multiple records]{.smallcaps} on to allow multi-selection of users. +- Toggle **Allow Linking to Multiple Records** on to allow multi-selection of users. :::: diff --git a/site/guide/inventory/_remove-attachments.qmd b/site/guide/inventory/_remove-attachments.qmd index 0adedfad1b..0307be89af 100644 --- a/site/guide/inventory/_remove-attachments.qmd +++ b/site/guide/inventory/_remove-attachments.qmd @@ -4,7 +4,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 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 **{{< 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. 3. Click **Save** to apply the deletion. diff --git a/site/guide/inventory/_rename-field-keys.qmd b/site/guide/inventory/_rename-field-keys.qmd index c72fd1ca25..237f232a4b 100644 --- a/site/guide/inventory/_rename-field-keys.qmd +++ b/site/guide/inventory/_rename-field-keys.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. Hover over the **[actions]{.smallcaps}** column on the far-right for the field whose key you want to rename. +1. Hover over the **Actions** column on the far-right for the field whose key you want to rename. -1. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pen-to-square >}} Rename Key**. +1. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pen-to-square >}} Rename Key**. -1. Enter the [new key]{.smallcaps} and click **Check Availability**. +1. Enter the **New Key** and click **Check Availability**. 1. If the key is not already in use, you'll be presented with a list of dependencies to review. diff --git a/site/guide/inventory/_view-record-activity-overview.qmd b/site/guide/inventory/_view-record-activity-overview.qmd deleted file mode 100644 index a238d728bf..0000000000 --- a/site/guide/inventory/_view-record-activity-overview.qmd +++ /dev/null @@ -1,29 +0,0 @@ - - -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 record stages](/guide/workflows/manage-record-stages.qmd)] -- Updates to documents: documentation,^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)] validation reports,^[[Preparing validation reports](/guide/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/validation/working-with-artifacts.qmd)] -- User comment creation and replies on documents^[[Collaborate with others](/guide/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/archive-delete-records.qmd b/site/guide/inventory/archive-delete-records.qmd index 6e665792b9..93d98b8254 100644 --- a/site/guide/inventory/archive-delete-records.qmd +++ b/site/guide/inventory/archive-delete-records.qmd @@ -8,7 +8,7 @@ aliases: - /guide/model-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. +Archive records within the {{< var vm.product >}} inventory when they are decommissioned or delete records that you no longer 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. @@ -30,7 +30,7 @@ Archive records within the {{< var vm.product >}} inventory when they are decomm ## Change record stages ::: {.callout} -## Instead of manually modifying your records' stages,[^4] we recommend manipulating stages via customized workflows.[^5] +## 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. ::: @@ -44,11 +44,11 @@ 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] +2. Select the type of `{Record}` you want to change the stage for by clicking on **{Record} Inventory**.[^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. +4. Click on the **{Record} Stage** section where `{Record}` is the type of record. 5. You can then select the appropriate stage for the record. @@ -58,7 +58,7 @@ To change a record's stage: #### Archive records -a. Select **Archived** from the [{record} stage]{.smallcaps} drop-down menu where `{record}` is the type of record. +a. Select **Archived** from the **{Record} Stage** drop-down menu where `{Record}` is the type of record. b. Click **Save** to proceed with archival. @@ -68,7 +68,7 @@ Archived records can be reactivated to make them available for use again in the #### Activate records -a. Select any stage other than Archived from the [{record} stage]{.smallcaps} drop-down menu where `{record}` is the type of record. +a. Select any stage other than Archived from the **{Record} Stage** drop-down menu where `{Record}` is the type of record. b. Click **Save** to proceed with activation. @@ -84,11 +84,11 @@ If a record was created in error, or you otherwise no longer require a record to 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] +2. Select the type of `{Record}` you want to delete by clicking on **{Record} Inventory**.[^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**. +4. Under the **{Record} Stage** section where `{Record}` is the type of record, select **Deleted**. 5. Click **Yes, Delete Record** to confirm permanent deletion of that record. diff --git a/site/guide/inventory/configure-record-interdependencies.qmd b/site/guide/inventory/configure-record-interdependencies.qmd index 08cd2a9550..014922573f 100644 --- a/site/guide/inventory/configure-record-interdependencies.qmd +++ b/site/guide/inventory/configure-record-interdependencies.qmd @@ -25,7 +25,7 @@ affected by or affects other records in your inventory. 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] +2. Select the type of `{Record}` you want to view interdependencies for by clicking on **{Record} Inventory**.[^4] 3. Select a record or find your record by applying a filter or searching for it.[^5] @@ -39,7 +39,7 @@ affected by or affects other records in your inventory. 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] +2. Select the type of `{Record}` you want to edit interdependencies for by clicking on **{Record} Inventory**.[^6] 3. Select a record or find your record by applying a filter or searching for it.[^7] diff --git a/site/guide/inventory/customize-inventory-layout.qmd b/site/guide/inventory/customize-inventory-layout.qmd index 250efa80e5..0a5bc8ec8f 100644 --- a/site/guide/inventory/customize-inventory-layout.qmd +++ b/site/guide/inventory/customize-inventory-layout.qmd @@ -66,11 +66,11 @@ You can save custom table configurations as a view to reapply at any time: #### Manage personal inventory views -{{< include /guide/shared/manage-views/_personal-views.qmd >}} +{{< include /guide/shared/manage-views/_personal-table-views.qmd >}} #### Manage organization inventory views -{{< include /guide/shared/manage-views/_organization-views.qmd >}} +{{< include /guide/shared/manage-views/_organization-table-views.qmd >}} diff --git a/site/guide/inventory/customize-record-overview-page.qmd b/site/guide/inventory/customize-record-overview-page.qmd index b7356b0937..07090481f7 100644 --- a/site/guide/inventory/customize-record-overview-page.qmd +++ b/site/guide/inventory/customize-record-overview-page.qmd @@ -6,6 +6,8 @@ title: "Customize record overview page" date: last-modified aliases: - /guide/model-inventory/customize-model-overview-page.html +includes: + inventory: true --- Configure what and how inventory fields appear when you open a record’s details in the inventory. @@ -28,7 +30,7 @@ Customizations will apply to all records of the same type in your inventory. 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 the type of `{Record}` you want to customize the overview page for by clicking on **{Record} Inventory**.[^2] 3. Select a record or find your record by applying a filter or searching for it.[^3] @@ -42,9 +44,9 @@ Customizations will apply to all records of the same type in your inventory. Under Show {#} Columns, click {{< fa chevron-up >}} increase or {{< fa chevron-down >}} to decrease the number of columns shown. - #### {{< fa chart-bar >}} Change fields display + #### {{< fa chart-bar >}} Change Field Configuration - a. Click **{{< fa chart-bar >}} Change fields display** to configure the inventory fields[^4] that appear: + a. Click **{{< fa chart-bar >}} Change Field Configuration** to configure the inventory fields[^4] that appear: - To hide fields or field groups from view: Hover over an inventory field, then click {{< fa eye >}}. - To show previously hidden fields or field groups: Hover over an inventory field, then click {{< fa eye-slash >}}. @@ -55,10 +57,12 @@ Customizations will apply to all records of the same type in your inventory. To narrow down your list of fields: - Click **{{< fa filter >}} Search by group or field name** to search for specific inventory fields. - - To show only highlighted fields, click **Show only highlighted in overview**. + - To show only highlighted fields, click **Show only highlighted in overview {{< fa star >}}**. ::: - b. Click **Save Configuration** to apply your changes to all overview pages for that record type. + b. Click **Apply Configuration** to apply your changes to all overview pages for that record type. + + Your layout will be saved locally to your browser's session.[^6] ::: @@ -68,9 +72,9 @@ To pin inventory record fields to the **Overview** tab for quick access: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Under the [record type]{.smallcaps} drop-down, select the type of record you want to edit fields for.[^6] +2. Select the type of `{Record}` you want to edit fields for by clicking on **{Record} Inventory**.[^7] -3. Select a record or find your record by applying a filter or searching for it.[^7] +3. Select a record or find your record by applying a filter or searching for it.[^8] 4. On the record details page, select either the **Overview** or **Inventory Fields** tab: @@ -79,11 +83,11 @@ To pin inventory record fields to the **Overview** tab for quick access: #### **Overview** tab - If there are no highlighted fields: Click on **{{< fa star >}} Highlight fields**. - - If there are already highlighted fields: Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change fields display**. + - If there are already highlighted fields: Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change Field Configuration**. #### **Inventory Fields** tab - Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change fields display**. + Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change Field Configuration**. ::: @@ -97,6 +101,30 @@ To pin inventory record fields to the **Overview** tab for quick access: 6. Confirm that the right inventory fields are pinned to the **Overview** tab with the correct highlight tone. +## Manage record field layouts + +You can save custom record field layouts to reapply at any time for each record type: + +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Select the type of `{Record}` you want to save a personal layout for by clicking on **{Record} Inventory**.[^9] + +3. Select a record or find your record by applying a filter or searching for it.[^10] + +4. On the record details page, click the **Inventory Fields** tab. + +5. Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change Field Configuration** to organize, show, or hide record fields as desired.[^11] + +6. Save a personal or publish a shared organization record field layout: + +### Manage personal record field layouts + +{{< include /guide/shared/manage-views/_personal-field-views.qmd >}} + +### Manage organization record field layouts + +{{< include /guide/shared/manage-views/_organization-field-views.qmd >}} + @@ -110,6 +138,14 @@ To pin inventory record fields to the **Overview** tab for quick access: [^5]: [Highlight inventory record fields](#highlight-inventory-record-fields) -[^6]: [Manage inventory record types](manage-inventory-record-types.qmd) +[^6]: To save a named layout for reuse or sharing, refer to: [Manage record field layouts](#manage-record-field-layouts) + +[^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) -[^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) \ No newline at end of file +[^11]: [Organize, show, or hide record fields](#organize-show-or-hide-record-fields) \ No newline at end of file diff --git a/site/guide/inventory/edit-inventory-fields.qmd b/site/guide/inventory/edit-inventory-fields.qmd index ab5194624d..0f57706c61 100644 --- a/site/guide/inventory/edit-inventory-fields.qmd +++ b/site/guide/inventory/edit-inventory-fields.qmd @@ -35,7 +35,7 @@ Learn more: [Work with content blocks](/guide/documentation/work-with-content-bl 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.[^5] +2. Select the type of `{Record}` you want to edit fields for by clicking on **{Record} Inventory**.[^5] 3. Select a record or find your record by applying a filter or searching for it.[^6] @@ -136,7 +136,7 @@ In addition to editing individual fields on a per record basis, you can edit fie -[^1]: [View record activity](view-record-activity.qmd) +[^1]: [View record activity](/guide/reporting/view-record-activity.qmd) [^2]: [Register records in the inventory](register-records-in-inventory.qmd) diff --git a/site/guide/inventory/manage-inventory-fields.qmd b/site/guide/inventory/manage-inventory-fields.qmd index b810431c5c..f0f91bf709 100644 --- a/site/guide/inventory/manage-inventory-fields.qmd +++ b/site/guide/inventory/manage-inventory-fields.qmd @@ -60,11 +60,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 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 inventory record stakeholder types have permissions to edit this field.[^8] + - **Required on Creation** — Whether or not the field was set up as required during registration. + - **Types** — What type of field it is. + - **Used in Workflows** — What workflows are using this field.[^5] + - **Workflow Triggered by Field** — What workflows are initiated when this field is edited.[^7] + - **Write Permissions** — 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. @@ -101,7 +101,7 @@ To group inventory fields, first create an inventory field group: 2. Under {{< fa cube >}} Inventory, select **Inventory Record Fields**. -3. Click **{{< fa folder-plus >}} Add Group** and enter a **[name]{.smallcaps}** and an optional **[description]{.smallcaps}** for the group. +3. Click **{{< fa folder-plus >}} Add Group** and enter a **Name** and an optional **Description** for the group. 4. Click **Create Group** to add the new group. @@ -119,7 +119,7 @@ Deleting an inventory field will remove it from all records using that field, ev 3. Hover over the field you would like to delete. -4. When the **{{< fa ellipsis-vertical >}}** appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete Field**]{.red}. +4. When the **{{< fa ellipsis-vertical >}}** menu appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete Field**]{.red}. 5. Click **Yes, Delete Field** to confirm permanent deletion. diff --git a/site/guide/inventory/managing-the-inventory.qmd b/site/guide/inventory/managing-the-inventory.qmd index b5095eebb4..f975f8e4fa 100644 --- a/site/guide/inventory/managing-the-inventory.qmd +++ b/site/guide/inventory/managing-the-inventory.qmd @@ -20,12 +20,10 @@ aliases: 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} +:::{#inventory-management .intro-listing} ::: -
    - ## What's next -- [Working with the inventory](working-with-the-inventory.qmd) -- [View record activity](view-record-activity.qmd) +- [Inventory FAQ](/faq/faq-inventory.qmd) +- [Tracking organization activity](/guide/reporting/tracking-organization-activity.qmd) \ No newline at end of file diff --git a/site/guide/inventory/register-records-in-inventory.qmd b/site/guide/inventory/register-records-in-inventory.qmd index 5bc0d1ea7d..b535f7ac49 100644 --- a/site/guide/inventory/register-records-in-inventory.qmd +++ b/site/guide/inventory/register-records-in-inventory.qmd @@ -26,9 +26,9 @@ Register records with {{< var vm.product >}} as the first step towards streamlin 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] +2. Select the type of `{Record}` you want to register by clicking on **{Record} Inventory**.[^3] -3. Click **Register {Record}** to create a new entry in the inventory where `{Record}` is the type of record you are registering. +3. Click **Register {Record}** to create a new entry in the inventory. 4. Depending on whether or not your organization has additional fields[^4] required on record registration, input the following information: @@ -42,12 +42,12 @@ a. Provide the information outlined in the basic record information fields tabl | 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. | + | **Record Name** | The name of your record. | + | **Group** | (conditional) If you belong to multiple user groups,[^5] select the group that can see the record. | + | **Business Unit** | Business unit[^6] associated with the record. | + | **Is it a Vendor Record?** (optional) | Toggle whether or not the record is a vendor record.[^7] | + | **Purpose** | Explain what the record will be used for. | + | **Preliminary Risk Tier** | 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] @@ -56,10 +56,10 @@ b. Click **Next {{< fa angle-right >}}** to continue to assignment of record sta a. Select the record stakeholders to add to the record upon registration. - - By default, only **[owner]{.smallcaps}**s are required. + - By default, only **Owner**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. +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. #### 3. Additional Record Information @@ -69,7 +69,7 @@ a. First enter the basic record information and assign record stakeholders, then 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. +c. Click **Register {Record}** to create a new entry in the inventory. ::: diff --git a/site/guide/inventory/setting-up-the-inventory.qmd b/site/guide/inventory/setting-up-the-inventory.qmd index c20d47de4c..e108b251d1 100644 --- a/site/guide/inventory/setting-up-the-inventory.qmd +++ b/site/guide/inventory/setting-up-the-inventory.qmd @@ -18,10 +18,10 @@ listing: 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} +:::{#setup-inventory .intro-listing} ::: ## What's next +- [Inventory FAQ](/faq/faq-inventory.qmd) - [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/inventory/working-with-the-inventory.qmd b/site/guide/inventory/working-with-the-inventory.qmd index 45bf466ba2..5bed54c6b6 100644 --- a/site/guide/inventory/working-with-the-inventory.qmd +++ b/site/guide/inventory/working-with-the-inventory.qmd @@ -38,13 +38,13 @@ Use the {{< var vm.product >}} inventory to track comprehensive details for all 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Under the [record type]{.smallcaps} drop-down, select the type of records you want to view.[^2] +2. Select the type of `{Record}` you want to view by clicking on **{Record} Inventory**.[^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] + - **{{< fa arrow-up-wide-short >}} Sort** — Reorder the list using different criteria in ascending or descending order. ::: {.callout-button .pl4 .nt4} ::: {.callout collapse="true" appearance="minimal"} @@ -67,24 +67,12 @@ For example, if you first search by keyword for `ValidMind` without clearing tha ## What's next +- [Inventory FAQ](/faq/faq-inventory.qmd) - [Managing the inventory](managing-the-inventory.qmd) -- [View record activity](view-record-activity.qmd) [^1]: [Register records in the inventory](register-records-in-inventory.qmd) -[^2]: [Manage inventory record types](manage-inventory-record-types.qmd) - -[^3]: - -- **[name]{.smallcaps}** -- [**[business unit]{.smallcaps}**](/guide/configuration/set-up-your-organization.qmd#manage-business-units) -- [**[use]{.smallcaps}**](/guide/configuration/set-up-your-organization.qmd#manage-use-cases) -- **[tier]{.smallcaps}** -- [**[stage]{.smallcaps}**](/guide/workflows/manage-record-stages.qmd) -- **[creation date]{.smallcaps}** -- [**[vendor name]{.smallcaps}**](/about/glossary/glossary.qmd#vendor-model) -- **[updated date]{.smallcaps}** -- [**[documentation updated date]{.smallcaps}**](/guide/documentation/working-with-documentation.qmd) \ No newline at end of file +[^2]: [Manage inventory record types](manage-inventory-record-types.qmd) \ No newline at end of file diff --git a/site/guide/mcp/connect-ai-assistants-via-mcp.qmd b/site/guide/mcp/connect-ai-assistants-via-mcp.qmd index a2e66f0717..36c22559a5 100644 --- a/site/guide/mcp/connect-ai-assistants-via-mcp.qmd +++ b/site/guide/mcp/connect-ai-assistants-via-mcp.qmd @@ -6,20 +6,7 @@ title: "Connect AI assistants via MCP" date: last-modified --- -The {{< var vm.product >}} MCP (Model Context Protocol) server enables AI assistants to query and manage your model inventory through natural language, providing seamless access to models, artifacts, templates, and custom fields. - - -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] You have your API key and secret.[^1] -- [x] You have a compatible AI assistant installed: - - Cursor IDE[^2] - - Claude Code[^3] - -::: +The {{< var vm.product >}} MCP (Model Context Protocol) server enables AI assistants to query and manage your inventory through natural language, providing seamless access to records (models), artifacts (findings), templates, and custom fields. ## Key concepts @@ -61,28 +48,22 @@ Your AI assistant sends natural language queries through the MCP protocol. The { ### What can I do with {{< var vm.product >}} MCP? -The MCP server exposes tools for working with your model inventory: +The MCP server exposes tools for working with your {{< var vm.product >}} inventory: -:::: {.flex .flex-wrap .justify-around} - -::: {.w-50-ns .pr3} +::: {.panel-tabset} -**Model and artifact operations** +#### Record and artifact operations -- List and get models -- List and get artifacts +- List and get records (models) +- List and get artifacts (findings) - Filter by risk level, deployment region, or ownership -**Custom field operations** +#### Custom field operations -- List custom fields for models and artifacts +- List custom fields for records and artifacts - Update custom field values -::: - -::: {.w-50-ns .pl3} - -**Template operations** +#### Template operations - List available templates - Get template details @@ -91,15 +72,26 @@ The MCP server exposes tools for working with your model inventory: ::: -:::: - -**Example queries you can ask:** - -- "Show me all models that are high risk" -- "Find all the models I am an owner for" +::: {.callout title="Example queries you can ask"} +- "Show me all model-type records that are high risk" +- "Find all the records I am an owner for" - "List my validation artifacts" - "What templates are available for credit risk models?" +::: + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You have your API key and secret.[^1] +- [x] You have a compatible AI assistant installed: + - Cursor IDE[^2] + - Claude Code[^3] + +::: + ## Configure your AI assistant ::: {.panel-tabset} @@ -134,9 +126,9 @@ The MCP server exposes tools for working with your model inventory: 7. Try asking Cursor questions like: - - "What models do I own?" - - "Show me all tier 1 models" - - "Register a new model called Customer Churn" + - "What records do I own?" + - "Show me all tier 1 model-type records" + - "Register a new model-type record called Customer Churn" ### Claude Code @@ -160,9 +152,9 @@ The MCP server exposes tools for working with your model inventory: 4. Start Claude Code and try asking questions like: - - "What models do I own?" - - "Show me all tier 1 models" - - "Register a new model called Customer Churn" + - "What records do I own?" + - "Show me all tier 1 model-type records" + - "Register a new model-type record called Customer Churn" ::: diff --git a/site/guide/monitoring/enable-monitoring.qmd b/site/guide/monitoring/enable-monitoring.qmd index 07e64065a2..0d2965d6f3 100644 --- a/site/guide/monitoring/enable-monitoring.qmd +++ b/site/guide/monitoring/enable-monitoring.qmd @@ -38,8 +38,8 @@ a. In the {{< var validmind.platform >}}, either register a new record[^2] or lo b. Copy the code snippet for your record: - In the left sidebar that appears for your record, click **{{< fa rocket >}} Getting Started**. - - Select a Monitoring document type from the **[document]{.smallcaps}** drop-down menu.[^4] - - Set **[enable monitoring]{.smallcaps}[?]{.smallercaps}** to true. + - Select a Monitoring document type from the **Document** drop-down menu.[^4] + - Set **Enable Monitoring?** to true. - Click **{{< fa regular copy >}} Copy snippet to clipboard**. ### 2. Select monitoring template @@ -54,12 +54,12 @@ c. In the left sidebar that appears for your record, click **{{< fa file >}} Doc d. Click on a Monitoring type file.[^8] -e. From the **[template]{.smallcaps}** drop-down, select one of the available monitoring templates. +e. From the **Template** drop-down, select one of the available monitoring templates. f. Click **Use Template** to apply your desired template. - After you select a template, the initial document where your ongoing monitoring results will be stored becomes available. - - Review this documents structure to confirm that it meets your requirements, then start running your code to populate the template with monitoring results. + - Review this document's structure to confirm that it meets your requirements, then start running your code to populate the template with monitoring results. ### 3. Run code snippet @@ -142,7 +142,7 @@ After you have enabled ongoing monitoring and run your code to generate some out [^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. +[^4]: Selecting a **Document** to connect to requires {{< var validmind.developer >}} version >=2.12.0. [^5]: [Install and initialize the {{< var validmind.developer >}}](/developer/quickstart/install-and-initialize-validmind-library.qmd) @@ -150,6 +150,6 @@ After you have enabled ongoing monitoring and run your code to generate some out [^7]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^8]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^8]: [Managing documents](/guide/templates/managing-documents.qmd) [^9]: [Review monitoring results](review-monitoring-results.qmd) \ No newline at end of file diff --git a/site/guide/monitoring/ongoing-monitoring.qmd b/site/guide/monitoring/ongoing-monitoring.qmd index 6f3ad83e14..dc19667935 100644 --- a/site/guide/monitoring/ongoing-monitoring.qmd +++ b/site/guide/monitoring/ongoing-monitoring.qmd @@ -152,6 +152,11 @@ To try out monitoring, check out the code sample for ongoing monitoring of model :::{#ongoing-monitoring-tests} ::: +## What's next + +- [Reporting and ongoing monitoring FAQ](/faq/faq-reporting.qmd) +- [Working with analytics](/guide/reporting/working-with-analytics.qmd) + [^1]: [Regulatory requirements](/about/use-cases/model-risk-management.qmd#regulatory-frameworks) diff --git a/site/guide/monitoring/review-monitoring-results.qmd b/site/guide/monitoring/review-monitoring-results.qmd index 5897073034..994a67ed7c 100644 --- a/site/guide/monitoring/review-monitoring-results.qmd +++ b/site/guide/monitoring/review-monitoring-results.qmd @@ -125,5 +125,5 @@ The final assessment is that the model requires attention: [^6]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^7]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^7]: [Managing documents](/guide/templates/managing-documents.qmd) diff --git a/site/guide/monitoring/work-with-metrics-over-time.qmd b/site/guide/monitoring/work-with-metrics-over-time.qmd index 09ba39ddc2..4c6e3acdad 100644 --- a/site/guide/monitoring/work-with-metrics-over-time.qmd +++ b/site/guide/monitoring/work-with-metrics-over-time.qmd @@ -50,11 +50,11 @@ Learn how to log metrics over time, set thresholds, and analyze record performan ![Adding a content block in the UI](/guide/documentation/add-content-block.gif){fig-alt="A gif showing the process of adding a content block in the UI" .screenshot} -7. Click {{< fa square-plus >}} and then select **Metric Over Time**[^7] under [from library]{.smallcaps}. +7. Click {{< fa square-plus >}} and then select **Metric Over Time**[^7] under From Library. 8. Select metric over time results: - - Choose from available **VM Library** (out-of-the-box) or **Custom** tests under [metric over time]{.smallcaps} in the left sidebar of the test selection modal. + - Choose from available **VM Library** (out-of-the-box) or **Custom** tests under Metric Over Time in the left sidebar of the test selection modal. - Use **{{}} Search by name** on the top-left to locate specific metric results. ![Metric Over Time blocks that have been selected for insertion](metrics-over-time-menu.png){fig-alt="A screenshot showing several Metric Over Time blocks that have been selected for insertion" .screenshot group="time-metric"} @@ -87,13 +87,13 @@ Before you can add metrics from an integration, ensure that the connection is co 6. In the modal that opens, select the **From Integration** tab. -7. Select your integration under [integration source]{.smallcaps}, then choose from the **Evaluators** list — such as Goal Success Rate, Correctness, or Helpfulness. +7. Select your integration under Integration Source, then choose from the **Evaluators** list — such as Goal Success Rate, Correctness, or Helpfulness. 8. Select one or more evaluation metrics to add. For each metric, you can optionally configure: - - **[threshold (lower)]{.smallcaps}** — Set a lower threshold value to flag when metrics fall below acceptable limits. - - **[threshold (upper)]{.smallcaps}** — Set an upper threshold value to flag when metrics exceed acceptable limits. - - **[time range]{.smallcaps}** — Define the time range for querying metric data. Choose to inherit from the document, use a relative preset, or specify a custom date range. + - **Threshold (lower)** — Set a lower threshold value to flag when metrics fall below acceptable limits. + - **Threshold (upper)** — Set an upper threshold value to flag when metrics exceed acceptable limits. + - **Time Range** — Define the time range for querying metric data. Choose to inherit from the document, use a relative preset, or specify a custom date range. 9. Click **Insert # Metric(s) Over Time to Document** when you are ready. @@ -152,7 +152,7 @@ After you have added metrics over time to your document, you can view the follow [^5]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^6]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^6]: [Managing documents](/guide/templates/managing-documents.qmd) [^7]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd) @@ -160,8 +160,8 @@ After you have added metrics over time to your document, you can view the follow [^9]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^10]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^10]: [Managing documents](/guide/templates/managing-documents.qmd) -[^11]: [Configure connections](/guide/integrations/configure-connections.qmd) and [Link external models](/guide/integrations/link-external-models.qmd) +[^11]: [Configure connections](/guide/integrations/configure-connections.qmd) and [Link external records](/guide/integrations/link-external-records.qmd) [^12]: [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/reporting/_create-a-visualization.qmd b/site/guide/reporting/_create-a-visualization.qmd index 517c4b9deb..96703593c6 100644 --- a/site/guide/reporting/_create-a-visualization.qmd +++ b/site/guide/reporting/_create-a-visualization.qmd @@ -13,15 +13,15 @@ a. Click **{{< fa pencil >}} Edit Dashboard**. a. Select **{{< fa plus >}} Add Widget** then **{{< fa plus >}} Add Visualization**. -a. On the Add Visualization panel, enter your **[title]{.smallcaps}**. +a. On the Add Visualization panel, enter your **Title**. -a. Select a **[visualization type]{.smallcaps}**: +a. Select a **Visualization Type**: - **{{< fa chart-simple >}} Bar Chart** - **{{< fa chart-pie >}} Pie Chart** - **{{< fa hashtag >}} Counter** -a. Select a **[dataset]{.smallcaps}**: +a. Select a **Dataset**: - **Artifact - Limitations** — Logged Limitation type artifacts only.^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)] - **Artifact - Policy Exceptions** — Logged Policy Exception type artifacts only.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] @@ -37,15 +37,15 @@ a. When you are done configuring your dataset, click **Add Visualization** to in :::: {.content-hidden unless-format="revealjs"} a. Select **{{< fa plus >}} Add Widget** then **{{< fa plus >}} Add Visualization**. -a. On the Add Visualization panel, enter your **[title]{.smallcaps}**. +a. On the Add Visualization panel, enter your **Title**. -a. Select a **[visualization type]{.smallcaps}**: +a. Select a **Visualization Type**: - **{{< fa chart-simple >}} Bar Chart** - **{{< fa chart-pie >}} Pie Chart** - **{{< fa hashtag >}} Counter** -a. Select a **[dataset]{.smallcaps}**: +a. Select a **Dataset**: - **Artifact - Limitations** — Logged Limitation type [artifacts](/guide/validation/working-with-artifacts.qmd){target="_blank"}. only. - **Artifact - Policy Exceptions** — Logged Policy Exception type artifacts only. diff --git a/site/guide/reporting/_create-an-analytics-page.qmd b/site/guide/reporting/_create-an-analytics-page.qmd index 5a5ee949ac..a8a03ee0c2 100644 --- a/site/guide/reporting/_create-an-analytics-page.qmd +++ b/site/guide/reporting/_create-an-analytics-page.qmd @@ -8,7 +8,7 @@ a. Click **{{< fa plus >}} Add Page**. a. On the Add New Page module, enter the following: - - **[page name]{.smallcaps}** - - **[description]{.smallcaps}** (optional) + - **Page Name** + - **Description** (optional) a. Click **Add New Page** to create your custom analytics page. \ No newline at end of file diff --git a/site/guide/reporting/_reports-filtering.qmd b/site/guide/reporting/_reports-filtering.qmd index 944acfa6c8..162e314f19 100644 --- a/site/guide/reporting/_reports-filtering.qmd +++ b/site/guide/reporting/_reports-filtering.qmd @@ -2,7 +2,7 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -[filtering]{.smallcaps} +**Filtering** : The filters that the visualization should apply to the retrieved data. You are able to set both `AND` or `OR` conditions. - Click **{{< fa plus >}} Rule** to add an independent rule. diff --git a/site/guide/reporting/_reports-grouping.qmd b/site/guide/reporting/_reports-grouping.qmd index 236c5e39d5..caef2b81cb 100644 --- a/site/guide/reporting/_reports-grouping.qmd +++ b/site/guide/reporting/_reports-grouping.qmd @@ -2,5 +2,5 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -[grouping]{.smallcaps} +**Grouping** : The record or artifact fields that the visualization should group the data by. \ No newline at end of file diff --git a/site/guide/reporting/_reports-metrics.qmd b/site/guide/reporting/_reports-metrics.qmd index 57a62bccc0..2e6c9df79a 100644 --- a/site/guide/reporting/_reports-metrics.qmd +++ b/site/guide/reporting/_reports-metrics.qmd @@ -2,7 +2,7 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -[metrics]{.smallcaps} +**Metrics** : The record or artifact field that the visualization should retrieve data for: - For `string` type fields, you can retrieve a `Count` or `Count %`. diff --git a/site/guide/reporting/_view-record-activity-overview.qmd b/site/guide/reporting/_view-record-activity-overview.qmd new file mode 100644 index 0000000000..9884a359cd --- /dev/null +++ b/site/guide/reporting/_view-record-activity-overview.qmd @@ -0,0 +1,15 @@ + + +The record **{{< fa wifi >}} Activity** page shows a history 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: + +- 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 + diff --git a/site/guide/inventory/_view-record-activity-steps.qmd b/site/guide/reporting/_view-record-activity-steps.qmd similarity index 73% rename from site/guide/inventory/_view-record-activity-steps.qmd rename to site/guide/reporting/_view-record-activity-steps.qmd index 2d2c7f7ea9..4641f3dee4 100644 --- a/site/guide/inventory/_view-record-activity-steps.qmd +++ b/site/guide/reporting/_view-record-activity-steps.qmd @@ -7,7 +7,7 @@ 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 the type of `{Record}` you want to view activity for by clicking on **{Record} Inventory**.^[[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)] @@ -18,7 +18,7 @@ To view record 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 the [type of `{Record}`](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} you want to view activity for by clicking on **{Record} Inventory**. 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"}. diff --git a/site/guide/reporting/_view-settings-activity-overview.qmd b/site/guide/reporting/_view-settings-activity-overview.qmd new file mode 100644 index 0000000000..3b89b8e2db --- /dev/null +++ b/site/guide/reporting/_view-settings-activity-overview.qmd @@ -0,0 +1,15 @@ + + +The organization **{{< fa bolt >}} Activity** page shows a history of updates to configuration settings for the selected organization, such as activity related to: + +- Organization settings, including management of business units, authentication configuration, email notifications, and general settings for documents +- Management of groups and group membership, users and invitations, permissions and roles +- Inventory record settings, including management of inventory record types and record fields +- Artifact settings, including management of artifact types, severities, and fields +- Document settings, including management of document types, templates, and library blocks +- Governance settings, including management of regulations or polices and related assessments, as well as risk areas and validation guidelines +- Workflow settings, including workflow creations, publications, and deletions +- Integration settings, including integration setup and secret management +- Webhook settings, including webhook secret management \ No newline at end of file diff --git a/site/guide/reporting/_view-settings-activity-steps.qmd b/site/guide/reporting/_view-settings-activity-steps.qmd new file mode 100644 index 0000000000..2dc8b5bc4b --- /dev/null +++ b/site/guide/reporting/_view-settings-activity-steps.qmd @@ -0,0 +1,55 @@ + + +To review settings activity for your organization: + +:::: {.content-visible unless-format="revealjs"} +1. In the left sidebar, click **{{< fa wifi >}} Activity**. + +2. Select the **Settings Activity** tab. + + ::: {.panel-tabset} + + ### Filter settings activity by category + + To narrow down settings activity by category: + + 1. Click **{{< fa filter >}} Filter** to open the filter popover. + + 2. Select the **Event Type**s you want to filter by from the drop-down menu: + + - **Artifacts** to view activity related to creation of, updates to, and deletions of artifact types,^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] severities,^[[Manage artifact severities](/guide/validation/manage-artifact-severities.qmd)] and fields.^[[Manage artifact fields](/guide/validation/manage-artifact-fields.qmd)] + - **Business Units** to view activity related to business unit creation, updates, and deletions.^[[Set up your organization](/guide/configuration/set-up-your-organization.qmd#manage-business-units)] + - **Documents** to view activity related to creation of, updates to, and deletions of document types,^[[Manage document types](/guide/templates/manage-document-types.qmd)] templates,^[[Manage document templates](/guide/templates/manage-document-templates.qmd)] and library blocks.^[[Manage text block library](/guide/templates/manage-text-block-library.qmd)] + - **Governance** to view activity related to creation of, updates to, and deletions of regulations or policies,^[[Customize {{< var validmind.checker >}}](/guide/templates/customize-document-checker.qmd)] as well as risk areas and validation guidelines.^[[Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd)] + - **Groups** to view activity related to group creation, updates, deletions, and group membership changes.^[[Manage groups](/guide/configuration/manage-groups.qmd)] + - **Integration Connections** to view activity related to integration connection creation, update, and removal.^[[Managing integrations](/guide/integrations/managing-integrations.qmd)] + - **Integration Secrets** to view activity related to integration secret creation, revocation, and deletion. + - **Inventory Records** to view activity related to inventory record type^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] or record field^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)] creation, updates, and deletions. + - **Organization Settings** to view activity related to authentication configuration, email notifications,^[[Manage platform notifications](/guide/configuration/manage-platform-notifications.qmd#customize-email-notifications)] and general settings for documents.^[[Managing documents](/guide/templates/managing-documents.qmd#manage-document-defaults)] + - **Permissions** to view activity related to permission changes on roles.^[[Manage permissions](/guide/configuration/manage-permissions.qmd)] + - **Roles** to view activity related to role creation, updates, deletions, and user role assignments.^[[Manage roles](/guide/configuration/manage-roles.qmd)] + - **Users** to view activity related to user information updates and user invitations.^[[Manage users](/guide/configuration/manage-users.qmd)] + - **Webhook Secrets** to view activity related to webhook secret creation, revocation, and deletion.^[[Manage secrets](/guide/integrations/manage-secrets.qmd#webhook-secrets)] + - **Workflows** to view activity related to workflow creation, publications, and deletions.^[[Setting up workflows](/guide/workflows/setting-up-workflows.qmd)] + + ### View more details about specific activity + + Click **{{< fa chevron-down >}} View Details** to reveal more details about the activity when the option is available on an entry. + + ::: + + + +:::: + + +:::: {.content-hidden unless-format="revealjs"} +1. In the left sidebar, click **{{< fa wifi >}} Activity**. +2. Select the **Settings Activity** tab: + +- Click **{{< fa filter >}} Filter** to open the filter popover and select the **Event Type**s you want to filter by from the drop-down menu. + - Click **{{< fa chevron-down >}} View Details** to reveal more details about the activity when the option is available on an entry. + +:::: diff --git a/site/guide/reporting/export-analytics.qmd b/site/guide/reporting/export-analytics.qmd index d90abd1788..92071d5965 100644 --- a/site/guide/reporting/export-analytics.qmd +++ b/site/guide/reporting/export-analytics.qmd @@ -26,7 +26,7 @@ Export analytics widgets as comma-delimited tables (`.csv`). 3. Hover over the widget you would like to export. -4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa download >}} Export CSV**. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa download >}} Export CSV**. 5. After the `.csv` file downloads automatically, open the file to confirm that the data exported is correct and is as expected. diff --git a/site/guide/reporting/export-documents.qmd b/site/guide/reporting/export-documents.qmd index 4d698115a9..f84a63a4bd 100644 --- a/site/guide/reporting/export-documents.qmd +++ b/site/guide/reporting/export-documents.qmd @@ -60,12 +60,11 @@ Documents exported from {{< var vm.product >}} are compatible with Word 365, Wor 8. Click **{{< fa file-arrow-down >}} Download File** to download the file locally on your machine. - [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^2]: [Managing documents](/guide/templates/managing-documents.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) @@ -87,7 +86,11 @@ Documents exported from {{< var vm.product >}} are compatible with Word 365, Wor [^12]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd#commenting) -[^13]: If your organization [enabled numbered table and figure captions](/guide/configuration/managing-your-organization.qmd#numbered-table-and-figure-captions), this option adds an appendix that includes tables, charts, and figures that use captions in the document. If the organization setting is off, the checkbox cannot be selected. +[^13]: + + If your organization enabled numbered table and figure captions, this option adds an appendix that includes tables, charts, and figures that use captions in the document. If the organization setting is off, the checkbox cannot be selected. +

    + **Learn more:** [Managing documents](/guide/templates/managing-documents.qmd#numbered-table-and-figure-captions) [^14]: To update the table of contents, click **Yes** when Word prompts you to update fields. diff --git a/site/guide/reporting/generating-exports.qmd b/site/guide/reporting/generating-exports.qmd index f3e0420e83..6a4bdc2a02 100644 --- a/site/guide/reporting/generating-exports.qmd +++ b/site/guide/reporting/generating-exports.qmd @@ -5,7 +5,7 @@ title: "Generating exports" date: last-modified listing: - - id: reports + - id: exports type: grid max-description-length: 250 sort: false @@ -18,4 +18,12 @@ listing: - export-analytics.qmd --- -Export your documents, inventory, artifacts, and analytics for use outside of the {{< var validmind.platform >}}. \ No newline at end of file +Export your documents, inventory, artifacts, and analytics for use outside of the {{< var validmind.platform >}}. + +:::{#exports .intro-listing} +::: + +## What's next + +- [Reporting and ongoing monitoring FAQ](/faq/faq-reporting.qmd) +- [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) diff --git a/site/guide/reporting/manage-custom-reports.qmd b/site/guide/reporting/manage-custom-reports.qmd index 6ab7aa843e..c12d1fc6f6 100644 --- a/site/guide/reporting/manage-custom-reports.qmd +++ b/site/guide/reporting/manage-custom-reports.qmd @@ -25,10 +25,10 @@ Add, edit, or remove custom data to your analytics within the {{< var validmind. {{< include _reports-filtering.qmd >}} -[sorting]{.smallcaps} +**Sorting** : Sort your data by your chosen metric or grouping in descending or ascending order. -[bar chart grouping style]{.smallcaps} +**Bar Chart Grouping Style** : Configure how the groupings are displayed: - **{{< fa layer-group >}} Stacked** — Groups will display stacked in one vertical column. @@ -53,7 +53,7 @@ Add, edit, or remove custom data to your analytics within the {{< var validmind. {{< include _reports-filtering.qmd >}} -[color]{.smallcaps} +**Color** : Set the display color for the counter. ::: diff --git a/site/guide/reporting/tracking-organization-activity.qmd b/site/guide/reporting/tracking-organization-activity.qmd new file mode 100644 index 0000000000..0bd0f7791d --- /dev/null +++ b/site/guide/reporting/tracking-organization-activity.qmd @@ -0,0 +1,28 @@ +--- +# 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: "Tracking organization activity" +date: last-modified +listing: + - id: activity + type: grid + max-description-length: 250 + sort: false + grid-columns: 2 + fields: [title, description] + contents: + - view-record-activity.qmd + - view-settings-activity.qmd +--- + +Review activity logs for your organization relating to records and settings configurations. + +::::{#activity .intro-listing} +:::: + + +## What's next + +- [Reporting and ongoing monitoring FAQ](/faq/faq-reporting.qmd) +- [Working with analytics](/guide/reporting/working-with-analytics.qmd) diff --git a/site/guide/inventory/view-record-activity.qmd b/site/guide/reporting/view-record-activity.qmd similarity index 88% rename from site/guide/inventory/view-record-activity.qmd rename to site/guide/reporting/view-record-activity.qmd index b710fd5959..7e06020806 100644 --- a/site/guide/inventory/view-record-activity.qmd +++ b/site/guide/reporting/view-record-activity.qmd @@ -8,10 +8,14 @@ aliases: - /guide/documentation/view-documentation-activity.html - /guide/view-documentation-activity.html - /guide/model-inventory/view-model-activity.html + - /guide/inventory/view-record-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. +Track information events associated with a specific record. Audit a history of updates made to the record, including stage or workflow transitions, updates on associated documents, activity on logged artifacts, and more. +## What is tracked on record activity? + +{{< include _view-record-activity-overview.qmd >}} ::: {.attn} @@ -24,8 +28,6 @@ Use the audit trail functionality in the {{< var validmind.platform >}} to track ## View record activity -{{< include _view-record-activity-overview.qmd >}} - {{< include _view-record-activity-steps.qmd >}} ### View individual field activity @@ -34,7 +36,7 @@ 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] +2. Select the type of `{Record}` you want to view field activity for by clicking on **{Record} Inventory**.[^3] 3. Select a record or find your record by applying a filter or searching for it.[^5] @@ -48,7 +50,7 @@ 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] +2. Select the type of `{Record}` you want to filter activity for by clicking on **{Record} Inventory**.[^4] 3. Select a record or find your record by applying a filter or searching for it.[^5] @@ -102,7 +104,7 @@ 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) +[^2]: [Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd) [^3]: [Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd) @@ -118,7 +120,7 @@ Filters persist in the URL, so you can share or bookmark a filtered view. [^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) +[^10]: [Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd) [^11]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) @@ -132,7 +134,7 @@ Filters persist in the URL, so you can share or bookmark a filtered view. [^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) +[^17]: [Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd) [^18]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) diff --git a/site/guide/reporting/view-settings-activity.qmd b/site/guide/reporting/view-settings-activity.qmd new file mode 100644 index 0000000000..c73a1aa8c3 --- /dev/null +++ b/site/guide/reporting/view-settings-activity.qmd @@ -0,0 +1,31 @@ +--- +# 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 settings activity" +date: last-modified +--- + +Track information events associated with your organization's settings. Audit a history of administrative updates made on your organization, including changes to users and permissions, workflows and integrations, customization options, and more. + +## What is tracked on settings activity? + +{{< include _view-settings-activity-overview.qmd >}} + +:::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to view organization settings activity.[^1] + +:::: + +## View settings activity + +{{< include _view-settings-activity-steps.qmd >}} + + + + +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) diff --git a/site/guide/reporting/working-with-analytics.qmd b/site/guide/reporting/working-with-analytics.qmd index b1f644060c..db51cb6f22 100644 --- a/site/guide/reporting/working-with-analytics.qmd +++ b/site/guide/reporting/working-with-analytics.qmd @@ -20,9 +20,11 @@ listing: - export-analytics.qmd --- -Analytical reports allow you to gain quick insights into your validation efforts. Reports detail critical artifacts, risk exposure, and compliance status to ensure effective oversight and management of risk. +View, manage, and export analytics that allow you to gain quick insights into your risk governance efforts across your organization. -#### Typical uses for reports +## Typical uses for reports + +Reports detail critical artifacts, risk exposure, and compliance status to ensure effective oversight and management of risk. - **Executive summaries** — Gain a high-level overview of validation activities, focusing on critical artifacts and risk exposure. - **Record (model) tracking** — Get quick insights into each record's validation artifacts, highlighting any major issues or deficiencies. @@ -32,17 +34,7 @@ Analytical reports allow you to gain quick insights into your validation efforts Reports are primarily designed for validators or Chief Risk Officers (CROs) who require an understanding of artifacts related to validation activities. -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] There are records registered in the inventory.[^1] -- [x] There are Validation Issues logged on any record.[^2] - -::: - -## Default report pages +### Default report pages The {{< var validmind.platform >}} provides two default report pages to get you started with analytics: @@ -56,7 +48,7 @@ The {{< var validmind.platform >}} provides two default report pages to get you ::: ::: {.w-40-ns} -2. **Validation Issues** +2. **Validation Issues** ![Analytics `Validation Issues` report page](analytics-validation_issues.png){fig-alt="Screenshot of the Analytics `Validation Issues` report page" .screenshot group="reports"} @@ -78,7 +70,7 @@ Total Models : Count of your total models registered with {{< var vm.product >}}. Number of Models by Business Unit and Tier -: Count of your model volume by business unit[^4] further broken down by risk tier. Assists you in pinpointing where in the organization resources should be concentrated on, along with the materiality of risk that unit may pose based on the models they are responsible for. +: Count of your model volume by business unit[^4] further broken down by risk tier. Assists you in pinpointing where in the organization resources should be concentrated on, along with the materiality of risk that unit may pose based on the models they are responsible for. Number of Models by Stage and Business Unit : Count of your model volume by stage[^5] further broken down by business unit. Assists you in pinpointing where in the organization resources may need to be focused, based on the progress and severity of artifacts. @@ -107,6 +99,16 @@ Validation Issues by Model ::: +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] There are records registered in the inventory.[^1] +- [x] There are Validation Issues logged on any record.[^2] + +::: + ## Arrange report widgets :::{.callout-important title="Changes are automatically saved and will affect all other users in your organization."} @@ -136,6 +138,11 @@ Rearrange report widgets on your analytics pages, including your custom pages:[^ :::{#reports} ::: +## What's next + +- [Reporting and ongoing monitoring FAQ](/faq/faq-reporting.qmd) +- [Generating exports](/guide/reporting/generating-exports.qmd) + @@ -149,7 +156,7 @@ Rearrange report widgets on your analytics pages, including your custom pages:[^ [^5]: [Manage record stages](/guide/workflows/manage-record-stages.qmd) -[^6]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd#available-artifact-types) +[^6]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd#artifact-types) [^7]: [Customize your dashboard](/guide/configuration/customize-your-dashboard.qmd#manage-widgets) diff --git a/site/guide/shared/manage-views/_organization-field-views.qmd b/site/guide/shared/manage-views/_organization-field-views.qmd new file mode 100644 index 0000000000..4c9c98f28a --- /dev/null +++ b/site/guide/shared/manage-views/_organization-field-views.qmd @@ -0,0 +1,103 @@ + + +:::: {.content-visible when-format="html" when-meta="includes.inventory"} +::: {.callout} +To publish a saved personal layout to your organization, you must have permissions to manage shared inventory record field layouts.^[[Manage permissions](/guide/configuration/manage-permissions.qmd)] + +::: + +:::: + +:::: {.content-visible when-format="html" when-meta="includes.artifacts"} +::: {.callout} +To publish a saved personal layout to your organization, you must have permissions to manage shared artifact field layouts.^[[Manage permissions](/guide/configuration/manage-permissions.qmd)] + +::: + +:::: + +::: {.panel-tabset} + +### Share layouts + +:::: {.content-visible when-format="html" when-meta="includes.inventory"} +1. Save a personal record field layout.^[[Organize, show, or hide record fields](/guide/inventory/customize-record-overview-page.qmd#organize-show-or-hide-record-fields)] + +:::: + +:::: {.content-visible when-format="html" when-meta="includes.artifacts"} +1. Save a personal artifact field layout.^[[Organize, show, or hide artifact fields](/guide/validation/customize-artifact-overview-page.qmd#organize-show-or-hide-artifact-fields)] + +:::: + +2. Click **{{< fa bookmark >}} {Layout Name}** where `{Layout Name}` is the name of your currently active layout. + +3. Click **My Configurations (#)**. + +4. Hover over the name of the layout you want to share with your organization. + +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa upload >}} Publish to Organization**. + +6. (Optional) Edit the **Layout Name** and **Description** for your shared layout. + +7. Click **{{< fa upload >}} Publish Layout** to share your layout with your organization. + +### Unpublish or remove shared layouts + +#### Unpublish shared organization layouts + +To unshare a saved organization layout: + +1. Click **{{< fa bookmark >}} {Layout Name}** where `{Layout Name}` is the name of your currently active layout. + +2. Select **Organization (#)**. + +3. Hover over the layout you want to remove from shared organization access. + +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa download >}} Unpublish**. + +5. Click **Yes, Unpublish Layout** to confirm removal of the layout from shared organization access. + +#### Remove shared organization layouts + +To remove a saved organization layout: + +::: {.callout-important} +Deletion of saved layouts is permanent. +::: + +1. Click **{{< fa bookmark >}} {Layout Name}** where `{Layout Name}` is the name of your currently active layout. + +2. Select **Organization (#)**. + +3. Hover over the layout you want to remove from your organization. + +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa trash-can >}} Delete Layout**. + +5. Click **Yes, Delete Layout** to confirm permanent deletion of that layout. + +### Edit shared layouts + +Editing while a shared layout is active updates your personal default layout instead of modifying the organization layout. To edit a shared organization layout: + +1. Unpublish the shared layout from your organization. + +2. Make the desired changes to your personal layout. + +3. Share the edited layout with your organization. + +### Set shared layout as default + +Only one layout can be set as the organization default. + +1. Click **{{< fa bookmark >}} {Layout Name}** where `{Layout Name}` is the name of your currently active layout. + +2. Click **Organization (#)**. + +3. Hover over the name of the layout you want to set as the organization default. + +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa star >}} Set as Organization Default**. + +::: diff --git a/site/guide/shared/manage-views/_organization-views.qmd b/site/guide/shared/manage-views/_organization-table-views.qmd similarity index 58% rename from site/guide/shared/manage-views/_organization-views.qmd rename to site/guide/shared/manage-views/_organization-table-views.qmd index 1c866adb5a..fbb3fdfec1 100644 --- a/site/guide/shared/manage-views/_organization-views.qmd +++ b/site/guide/shared/manage-views/_organization-table-views.qmd @@ -2,13 +2,33 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> +:::: {.content-visible when-format="html" when-meta="includes.workflow.view"} ::: {.callout} To publish a saved personal view to your organization, you must have permissions to manage shared workflow timeline views.^[[Manage permissions](/guide/configuration/manage-permissions.qmd)] + ::: +:::: + +:::: {.content-visible when-format="html" when-meta="includes.inventory"} +::: {.callout} +To publish a saved personal view to your organization, you must have permissions to manage shared inventory layout views.^[[Manage permissions](/guide/configuration/manage-permissions.qmd)] + +::: + +:::: + +:::: {.content-visible when-format="html" when-meta="includes.artifacts"} +::: {.callout} +To publish a saved personal view to your organization, you must have permissions to manage shared artifact layout views.^[[Manage permissions](/guide/configuration/manage-permissions.qmd)] + +::: + +:::: + ::: {.panel-tabset} -### Share views with your organization +### Share views :::: {.content-visible when-format="html" when-meta="includes.workflow.view"} 1. Save a personal workflow timeline view.^[[Manage personal timeline views](/guide/workflows/working-with-workflows.qmd#manage-personal-timeline-views)] @@ -31,15 +51,15 @@ To publish a saved personal view to your organization, you must have permissions 4. Hover over the name of the view you want to share with your organization. -5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa upload >}} Publish to Organization**. +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa upload >}} Publish to Organization**. -6. (Optional) Edit the [view name]{.smallcaps} and [description]{.smallcaps} for your shared view. +6. (Optional) Edit the **View Name** and **Description** for your shared view. 7. Click **{{< fa upload >}} Publish View** to share your view with your organization. -### Unshare or remove saved organization views +### Unpublish or remove shared views -#### Unshare saved organization views +#### Unpublish shared organization views To unshare a saved organization view: @@ -49,26 +69,37 @@ To unshare a saved organization view: 3. Hover over the view you want to remove from shared organization access. -4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa download >}} Unpublish**. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa download >}} Unpublish**. 5. Click **Yes, Unpublish View** to confirm removal of the view from shared organization access. -#### Remove saved organization views - -To remove a saved organization view: +#### Remove shared organization views ::: {.callout-important} Deletion of saved views is permanent. ::: + +To remove a saved organization view: + 1. Click on the name of your saved view, or **{{< fa bookmark >}} Select View** if you are not currently displaying a saved view. 2. Select **Organization (#)**. 3. Hover over the view you want to remove from your organization. -4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa trash-can >}} Remove View**. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa trash-can >}} Remove View**. 5. Click **Yes, Remove View** to confirm permanent deletion of that view. -::: \ No newline at end of file +### Edit shared views + +Editing while a shared view is active updates your personal default view instead of modifying the organization view. To edit a shared organization view: + +1. Unpublish the shared view from your organization. + +2. Make the desired changes to your personal view. + +3. Share the edited view with your organization. + +::: diff --git a/site/guide/shared/manage-views/_personal-field-views.qmd b/site/guide/shared/manage-views/_personal-field-views.qmd new file mode 100644 index 0000000000..c5d521f879 --- /dev/null +++ b/site/guide/shared/manage-views/_personal-field-views.qmd @@ -0,0 +1,60 @@ + + +::: {.panel-tabset} + +### Save personal layouts + +#### Save your first layout + +1. Click **{{< fa bookmark >}} Select Layout** and select **My Configurations (#)**. + +2. Click **Save as New Configuration** to save changes as a new layout. Enter the: + + - **Layout Name** + - (Optional) **Description** + +3. Click **Save New Layout** to create your new layout. + +#### Save additional layouts + +1. Click **{{< fa bookmark >}} {Layout Name}*** where `{Layout Name}` is the name of your currently active layout. + +2. Click **My Configurations (#)**. + +3. Select: + + - **Update Configuration** to save changes to the layout you are currently editing. Select **Yes, Update Layout** to apply your changes. + - **Save as New Configuration** to save changes as a new layout. Edit the **Layout Name** and (Optional) **Description** for your new layout. Click **Save New Layout** to create your new layout. + +### Edit or remove personal layouts + +::: {.callout-important} +Deletion of saved layouts is permanent. +::: + +1. Click **{{< fa bookmark >}} {Layout Name}*** where `{Layout Name}` is the name of your currently active layout. + +2. Click **My Configurations (#)**. + +3. Hover over the name of the layout you want to edit or remove. + +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select: + + - **{{< fa pencil >}} Edit Configuration** to edit the **Layout Name** and **Description**. Click **Save Changes** to apply your edits. + - [**{{< fa trash-can >}} Remove Layout**]{.red} to delete the layout. Click **Yes, Delete Layout** to confirm permanent deletion of that layout. + +### Set saved personal layout as default + +Setting a personal layout as default will override your organization default for only you. Only one layout can be set as your personal default. + +1. Click **{{< fa bookmark >}} {Layout Name}*** where `{Layout Name}` is the name of your currently active layout. + +2. Click **My Configurations (#)**. + +3. Hover over the name of the layout you want to set as your personal default. + +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa star >}} Set as My Default**. + +::: diff --git a/site/guide/shared/manage-views/_personal-views.qmd b/site/guide/shared/manage-views/_personal-table-views.qmd similarity index 88% rename from site/guide/shared/manage-views/_personal-views.qmd rename to site/guide/shared/manage-views/_personal-table-views.qmd index 3d81b810e4..f911ec1e57 100644 --- a/site/guide/shared/manage-views/_personal-views.qmd +++ b/site/guide/shared/manage-views/_personal-table-views.qmd @@ -12,7 +12,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: :::: {.content-visible when-format="html" when-meta="includes.inventory"} -1. Customize a table view for the **[record type]{.smallcaps}** you want to save a view for.^[[Customize table view](/guide/inventory/customize-inventory-layout.qmd#customize-table-view)] +1. Select the type of `{Record}` you want to save a view for by clicking on **{Record} Inventory**, then customize the table view.^[[Customize table view](/guide/inventory/customize-inventory-layout.qmd#customize-table-view)] You can also apply filters or sorting before saving your view to include them in the view.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] @@ -29,7 +29,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 3. Select **My Views (#)** and click on **{{< fa bookmark >}} Save New View** to create your saved view. -4. Enter the **[view name]{.smallcaps}** and **[description]{.smallcaps}** for your saved view. +4. Enter the **View Name** and **Description** for your saved view. 5. Click **Add New View** to save your saved view. @@ -63,9 +63,9 @@ Deletion of saved views is permanent. 3. Hover over the name of the view you want to edit or remove. -4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select: +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select: - - **{{< fa pencil >}} Edit View** to edit the [view name]{.smallcaps} and [description]{.smallcaps}. Click **Save Changes** to apply your edits. + - **{{< fa pencil >}} Edit View** to edit the **View Name** and **Description**. Click **Save Changes** to apply your edits. - [**{{< fa trash-can >}} Remove View**]{.red} to delete the view. Click **Yes, Delete View** to confirm permanent deletion of that view. :::: @@ -93,4 +93,4 @@ To modify a saved view for all other artifact types: :::: -::: \ No newline at end of file +::: diff --git a/site/guide/templates/_add-assessment-questions.qmd b/site/guide/templates/_add-assessment-questions.qmd index 87d2b971c6..4c93032c54 100644 --- a/site/guide/templates/_add-assessment-questions.qmd +++ b/site/guide/templates/_add-assessment-questions.qmd @@ -9,7 +9,7 @@ Manually add assessment questions, or generate questions from a PDF upload for D a. Click **{{< fa plus >}} Add Question** to create a new question. -a. Enter the **[questions]{.smallcaps}**: +a. Enter the **Questions**: - Each line without a break (enter) is considered one complete question.^[Empty lines will be ignored.] - To add a separate question, press enter to start a new line. @@ -44,7 +44,7 @@ Select the assessment you want to add questions to by clicking on it: 1. Click **{{< fa plus >}} Add Question** to create a new question. -1. Enter the **[questions]{.smallcaps}**: +1. Enter the **Questions**: - Each line without a break (enter) is considered one complete question. Empty lines will be ignored. - To add a separate question, press enter to start a new line. diff --git a/site/guide/templates/_add-assessments.qmd b/site/guide/templates/_add-assessments.qmd index f0b08019a0..ca0225fa55 100644 --- a/site/guide/templates/_add-assessments.qmd +++ b/site/guide/templates/_add-assessments.qmd @@ -7,10 +7,10 @@ a. Click **{{< fa plus >}} Add Assessment** to create a new assessment. a. Provide the details for your assessment: - - **[assessment name]{.smallcaps}** - - **[assessment type]{.smallcaps}** — Development^[Development type assessments are available for Development, Monitoring, and custom document types.] or Validation^[Validation type assessments are only available for Validation type document types.] - - **[document type]{.smallcaps}** — Select the document types^[[Manage document types](/guide/templates/manage-document-types.qmd)] that this assessment should be available for. - - (Optional) **[description]{.smallcaps}** + - **Assessment Name** + - **Assessment Type** — Development^[Development type assessments are available for Development, Monitoring, and custom document types.] or Validation^[Validation type assessments are only available for Validation type document types.] + - **Document Type** — Select the document types^[[Manage document types](/guide/templates/manage-document-types.qmd)] that this assessment should be available for. + - (Optional) **Description** a. Click **Add Assessment** to create your assessment. @@ -25,10 +25,10 @@ a. Once created, add or edit the assessment questions.^[[Add or edit assessment 5. Provide the details for your assessment: - - **[assessment name]{.smallcaps}** - - **[assessment type]{.smallcaps}** — Development (Development, Monitoring, and custom document types) or Validation (Validation type documents only) - - **[document type]{.smallcaps}** — Select the [document types](/guide/templates/manage-document-types.qmd){target="_blank"} that this assessment should be available for. - - (Optional) **[description]{.smallcaps}** + - **Assessment Name** + - **Assessment Type** — Development (Development, Monitoring, and custom document types) or Validation (Validation type documents only) + - **Document Type** — Select the [document types](/guide/templates/manage-document-types.qmd){target="_blank"} that this assessment should be available for. + - (Optional) **Description** 6. Click **Add Assessment** to create your assessment. diff --git a/site/guide/templates/_add-regulations-policies.qmd b/site/guide/templates/_add-regulations-policies.qmd index 163f69af38..e64795ea1c 100644 --- a/site/guide/templates/_add-regulations-policies.qmd +++ b/site/guide/templates/_add-regulations-policies.qmd @@ -7,8 +7,8 @@ a. Click **{{< fa plus >}} Add Regulation or Policy** to create a new regulation a. Provide the details for your regulation or policy: - - **[regulation or policy name]{.smallcaps}** - - (Optional) **[description]{.smallcaps}** + - **Regulation Or Policy Name** + - (Optional) **Description** a. Click **Add Regulation or Policy** to create your regulation or policy. @@ -22,8 +22,8 @@ a. Once created, manage your regulation or policy assessments.^[[Manage assessme 4. Provide the details for your regulation or policy: - - **[regulation or policy name]{.smallcaps}** - - (Optional) **[description]{.smallcaps}** + - **Regulation Or Policy Name** + - (Optional) **Description** 5. Click **Add Regulation or Policy** to create your regulation or policy. diff --git a/site/guide/templates/_add-text-blocks.qmd b/site/guide/templates/_add-text-blocks.qmd index 1112ab6430..e660f81f70 100644 --- a/site/guide/templates/_add-text-blocks.qmd +++ b/site/guide/templates/_add-text-blocks.qmd @@ -14,9 +14,9 @@ To create a new text block via the block library: 3. Click **Add Block** and enter: - - The **[name]{.smallcaps}** of your text block - - (Optional) A **[description]{.smallcaps}** for your text block - - The templated **[content]{.smallcaps}** for your text block + - The **Name** of your text block + - (Optional) A **Description** for your text block + - The templated **Content** for your text block @@ -37,7 +37,7 @@ While composing content for a library text block, you can insert math equations -4. Select a **[sharing]{.smallcaps}** option: +4. Select a **Sharing** option: - **Private** — Visible only to you - **Shared** — Accessible across your organization @@ -58,11 +58,11 @@ To create a new text block via the block library: 1. Click **Add Block** and enter: - - The **[name]{.smallcaps}** of your text block - - (Optional) A **[description]{.smallcaps}** for your text block - - The templated **[content]{.smallcaps}** for your text block + - The **Name** of your text block + - (Optional) A **Description** for your text block + - The templated **Content** for your text block -1. Select a **[sharing]{.smallcaps}** option: +1. Select a **Sharing** option: - **Private** — Visible only to you - **Shared** — Accessible across your organization diff --git a/site/guide/templates/_customize-document-templates.qmd b/site/guide/templates/_customize-document-templates.qmd index 1f37129c2e..cdc0df9a6f 100644 --- a/site/guide/templates/_customize-document-templates.qmd +++ b/site/guide/templates/_customize-document-templates.qmd @@ -27,14 +27,14 @@ Editing outlines for document templates from **{{< fa gear >}} Settings** will c - **Development**^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)] - **Validation**^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)] - **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)] - - **Custom**^[[Working with documents](/guide/templates/working-with-documents.qmd)] + - **Custom**^[[Managing documents](/guide/templates/managing-documents.qmd)] 1. Click the template to edit and on the template details page, select **{{< fa pencil >}} Edit Outline**. {{< include /guide/templates/_outline-editing-mode.qmd >}} 1. When you're done, click **Create New Version** to view a side-by-side comparison of your changes with the previous version: - - Add a description in **[version notes]{.smallcaps}** to track your changes. + - Add a description in **Version Notes** to track your changes. - Click **Save** to save the new version. Once saved, your new template version becomes available for use. @@ -49,7 +49,7 @@ Editing outlines for templates on documents will only apply changes to that docu 1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on the document you would like to customize the template outline for.^[[Working with documents](/guide/templates/working-with-documents.qmd)] +1. Click on the document you would like to customize the template outline for.^[[Managing documents](/guide/templates/managing-documents.qmd)] 1. On the template details page, click **{{< fa pencil >}} Edit Outline**. @@ -76,7 +76,7 @@ Edit outlines for templates directly on documents to only apply changes to that 1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on the document you would like to customize the template outline for.^[[Working with documents](/guide/templates/working-with-documents.qmd)] +1. Click on the document you would like to customize the template outline for.^[[Managing documents](/guide/templates/managing-documents.qmd)] 1. On the template details page, click **{{< fa pencil >}} Edit Outline**. @@ -117,7 +117,7 @@ Customize {{< var vm.product >}}'s templates for documents to fit your specific - To add a section above the current section, select **{{< fa arrow-up >}} Section Before**. - To add a section below the current section, select **{{< fa arrow-down >}} Section After**. - To add a subsection within the current section, select **{{< fa arrow-right >}} Subsection**. - a. **Add content to sections** — In any section of a template that does not have child sections, click **{{< fa plus >}}** to add additional [content]{.smallcaps}: + a. **Add content to sections** — In any section of a template that does not have child sections, click **{{< fa plus >}}** to add additional **Content**: - **{{< fa align-justify >}} Summary Block** [validation reports only]{.smallercaps .pink} - [**{{< fa circle-check >}} Guideline Block**](/guide/validation/manage-validation-guidelines.qmd#add-guidelines-to-templates){target="_blank"} [validation reports only]{.smallercaps .pink} - [**{{< fa align-left >}} Text Block**](/guide/templates/customize-document-templates.qmd#add-text-blocks-via-template-outlines){target="_blank"} @@ -125,7 +125,7 @@ Customize {{< var vm.product >}}'s templates for documents to fit your specific ::: 1. When you're done, click **Create New Version** to view a side-by-side comparison of your changes with the previous version: - - Add a description in **[version notes]{.smallcaps}** to track your changes. + - Add a description in **Version Notes** to track your changes. - Click **Save** to save the new version. Once saved, your new template version becomes available for use. diff --git a/site/guide/templates/_duplicate-template.qmd b/site/guide/templates/_duplicate-template.qmd index f2f3c0420f..0392e8fa6b 100644 --- a/site/guide/templates/_duplicate-template.qmd +++ b/site/guide/templates/_duplicate-template.qmd @@ -14,11 +14,11 @@ To duplicate an existing template and start with version one of that new templat - **Development**^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)] - **Validation**^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)] - **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)] - - **Custom**^[[Working with documents](/guide/templates/working-with-documents.qmd)] + - **Custom**^[[Managing documents](/guide/templates/managing-documents.qmd)] 1. Click on the template to duplicate and on the template details page, select **{{< fa copy >}} Duplicate Template**. -1. In the Duplicate Template modal that opens, give your copy a **[template name]{.smallcaps}** and a **[template description]{.smallcaps}**. +1. In the Duplicate Template modal that opens, give your copy a **Template Name** and a **Template Description**. 1. Click **Duplicate Template** to create a copy of your template. @@ -34,11 +34,11 @@ To duplicate an existing template and start with version one of that new templat 1. Under {{< fa file >}} Documents, select **Templates**. -1. Select one of the tabs for the [type of template you want to duplicate](/guide/templates/working-with-documents.qmd){target="_blank"}. +1. Select one of the tabs for the [type of template you want to duplicate](/guide/templates/managing-documents.qmd){target="_blank"}. 1. Click on the template to duplicate and on the template details page, select **{{< fa copy >}} Duplicate Template**. -1. In the Duplicate Template modal that opens, give your copy a **[template name]{.smallcaps}** and a **[template description]{.smallcaps}**. +1. In the Duplicate Template modal that opens, give your copy a **Template Name** and a **Template Description**. 1. Click **Duplicate Template** to create a copy of your template. diff --git a/site/guide/templates/_duplicate-text-blocks.qmd b/site/guide/templates/_duplicate-text-blocks.qmd index 8ab45ebe2c..8bc571999f 100644 --- a/site/guide/templates/_duplicate-text-blocks.qmd +++ b/site/guide/templates/_duplicate-text-blocks.qmd @@ -12,9 +12,9 @@ To make a copy of an existing text block in your block library: 1. Make your desired changes to the following fields: - - The **[name]{.smallcaps}** of your text block - - (Optional) A **[description]{.smallcaps}** for your text block - - The templated **[content]{.smallcaps}** for your text block - - Whether the block **[sharing]{.smallcaps}** permissions are **Private** or **Shared** + - The **Name** of your text block + - (Optional) A **Description** for your text block + - The templated **Content** for your text block + - Whether the block **Sharing** permissions are **Private** or **Shared** 1. Click **Duplicate Block** to save the copy of your text block. \ No newline at end of file diff --git a/site/guide/templates/_outline-editing-mode.qmd b/site/guide/templates/_outline-editing-mode.qmd index 87725dfd4f..046f7a4374 100644 --- a/site/guide/templates/_outline-editing-mode.qmd +++ b/site/guide/templates/_outline-editing-mode.qmd @@ -32,7 +32,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> - To add a subsection within the current section, select **{{< fa arrow-right >}} Subsection**. Add content to sections - : In any section of a template that does not have child sections, click **{{< fa plus >}}** to add additional [content]{.smallcaps}: + : In any section of a template that does not have child sections, click **{{< fa plus >}}** to add additional **Content**: - **{{< fa align-justify >}} Summary Block** [validation reports only]{.smallercaps .pink} - **{{< fa circle-check >}} Guideline Block**^[[Add guidelines to templates](/guide/validation/manage-validation-guidelines.qmd#add-guidelines-to-templates)] [validation reports only]{.smallercaps .pink} - **{{< fa align-left >}} Text Block**^[[Add text blocks via template outlines](/guide/templates/customize-document-templates.qmd#add-text-blocks-via-template-outlines)] diff --git a/site/guide/templates/_template-schema-generated.qmd b/site/guide/templates/_template-schema-generated.qmd index 2deebf3d2b..c02e65ef2c 100644 --- a/site/guide/templates/_template-schema-generated.qmd +++ b/site/guide/templates/_template-schema-generated.qmd @@ -1137,7 +1137,7 @@ Source: backend/src/backend/templates/documentation/model_documentation/mdd_temp ``` diff --git a/site/guide/templates/_view-document-templates.qmd b/site/guide/templates/_view-document-templates.qmd index a2bc6d93ea..830f2a6ec1 100644 --- a/site/guide/templates/_view-document-templates.qmd +++ b/site/guide/templates/_view-document-templates.qmd @@ -14,7 +14,7 @@ To review the existing templates available to your organization: - **Development**^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)] - **Validation**^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)] - **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)] - - **Custom**^[[Working with documents](/guide/templates/working-with-documents.qmd)] + - **Custom**^[[Managing documents](/guide/templates/managing-documents.qmd)] Displayed in list view is an overview of information for templates under that specific document type. @@ -55,7 +55,7 @@ To review the existing templates available to your organization: [^template-info]: - **Versions & outlines:** [Customize document templates](/guide/templates/customize-document-templates.qmd#edit-template-outlines) - - **Types:** [Working with documents](/guide/templates/working-with-documents.qmd) + - **Types:** [Managing documents](/guide/templates/managing-documents.qmd) :::: @@ -65,7 +65,7 @@ To review the existing templates available to your organization: 1. Under {{< fa file >}} Documents, select **Templates**. -1. Select one of the tabs for [the document type with the templates you want to view](/guide/templates/working-with-documents.qmd){target="_blank"}. +1. Select one of the tabs for [the document type with the templates you want to view](/guide/templates/managing-documents.qmd){target="_blank"}. 1. Select one of the available templates to view detailed information about the template. diff --git a/site/guide/templates/customize-document-checker.qmd b/site/guide/templates/customize-document-checker.qmd index 535c206cf0..44e4cc40b5 100644 --- a/site/guide/templates/customize-document-checker.qmd +++ b/site/guide/templates/customize-document-checker.qmd @@ -57,10 +57,10 @@ Default regulations provided by {{< var vm.product >}} cannot be edited.[^2] a. Hover over the regulation or policy you want to edit. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pencil >}} Edit** to make changes to the: +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil >}} Edit** to make changes to the: - - **[regulation or policy name]{.smallcaps}** - - (Optional) **[description]{.smallcaps}** + - **Regulation or Policy Name** + - (Optional) **Description** c. Click **Update Regulation or Policy** to save your edits. @@ -106,10 +106,10 @@ Cloned assessments are the same assessment type and are available to the same do a. Hover over the assessment you want to clone. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa copy >}} Clone Assessment** to make changes to the: +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa copy >}} Clone Assessment** to make changes to the: - - **[regulation or policy name]{.smallcaps}** - - (Optional) **[description]{.smallcaps}** + - **Regulation or Policy Name** + - (Optional) **Description** c. Click **Clone Assessment** to save a copy of the assessment. @@ -144,7 +144,7 @@ Click **{{}} Search** to enter your keywords, then press * a. Hover over the question you want to edit. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pencil >}} Edit** to make changes to the **[question]{.smallcaps}**. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil >}} Edit** to make changes to the **Question**. c. Click **Update Question** to save your changes. diff --git a/site/guide/templates/customize-document-templates.qmd b/site/guide/templates/customize-document-templates.qmd index bcecfcba72..c1c063ea56 100644 --- a/site/guide/templates/customize-document-templates.qmd +++ b/site/guide/templates/customize-document-templates.qmd @@ -27,7 +27,7 @@ Customize templates for document types to fit your specific case-by-case needs, - [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2] ::: {.callout title="Not sure which template or which version of a template your document is using?"} -Check the [document template]{.smallcaps} section[^3] in the right sidebar. +Check the **Document Template** section[^3] in the right sidebar. ::: ::: @@ -66,7 +66,7 @@ Check the [document template]{.smallcaps} section[^3] in the right sidebar. 6. Once you're finished editing, click **Continue** to view a side-by-side comparison of your changes with the previous version of the template. 7. On the Review Changes screen: - - Add a description in **[version notes]{.smallcaps}** to track your changes. + - Add a description in **Version Notes** to track your changes. - Click **Save Version #** to save the new version. ![Editing the raw YAML behind a template](edit-yaml-template.gif){fig-alt="A gif demonstrating editing the raw YAML behind a template" .screenshot width=90%} @@ -111,7 +111,7 @@ c. Select **Shared Blocks** and click **{{< fa ellipsis-vertical >}}** under the d. Select **{{< fa pencil >}} Edit Details** and review the details for that block. -e. To the right of the [key]{.smallcaps}, click **{{< fa copy >}}** to copy the key to your clipboard. +e. To the right of the **Key**, click **{{< fa copy >}}** to copy the key to your clipboard. #### 2. Insert block keys into YAML templates @@ -156,7 +156,7 @@ c. Finish editing your template, then save a new version. [^4]: [validation report templates only]{.smallcaps .pink} -[^5]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^5]: [Managing documents](/guide/templates/managing-documents.qmd) [^6]: [Template schema](#template-schema) diff --git a/site/guide/templates/manage-document-templates.qmd b/site/guide/templates/manage-document-templates.qmd index da5aee54a7..43eed06b3d 100644 --- a/site/guide/templates/manage-document-templates.qmd +++ b/site/guide/templates/manage-document-templates.qmd @@ -66,7 +66,7 @@ Switch a document to a completely different template, or apply another version o ::: --> -5. On your document's detail page, locate [document template]{.smallcaps}. +5. On your document's detail page, locate **Document Template**. 6. View the currently applied template and version, or swap to another template or version: @@ -84,8 +84,8 @@ a. Click on the named version of the template. b. Select **{{< fa sync >}} Update Document Template** to swap to a different template or template version: - - Under **[template]{.smallcaps}**, choose a new template to switch to. - - Under **[version]{.smallcaps}**, choose a different version of the same template to switch to. + - Under **Template**, choose a new template to switch to. + - Under **Version**, choose a different version of the same template to switch to. c. Review the differences between the switched templates or template versions to confirm that you want to apply those changes. @@ -141,10 +141,10 @@ Delete templates no longer required by your organization: [^6]: - - **[title]{.smallcaps}** — Sort by title alphabetically. - - **[type]{.smallcaps}** — Sort by document type alphabetically. - - **[date created]{.smallcaps}** — Sort by creation date. - - **[date updated]{.smallcaps}** — Sort by last update date. + - **Title** — Sort by title alphabetically. + - **Type** — Sort by document type alphabetically. + - **Date Created** — Sort by creation date. + - **Date Updated** — Sort by last update date. **Searching and sorting of fields stack.**
    @@ -158,7 +158,7 @@ Delete templates no longer required by your organization: [^10]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) -[^11]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^11]: [Managing documents](/guide/templates/managing-documents.qmd) [^12]: @@ -166,5 +166,5 @@ Delete templates no longer required by your organization: **To delete a template without reviewing template details:**

    - a. Hover over the template until the **{{< fa ellipsis-vertical >}}** appears, then click on it. + a. Hover over the template until the **{{< fa ellipsis-vertical >}}** menu appears, then click on it. b. Select [**{{< fa trash-can >}} Delete**]{.red}. \ No newline at end of file diff --git a/site/guide/templates/manage-document-types.qmd b/site/guide/templates/manage-document-types.qmd index dfc5752195..a9da900f0b 100644 --- a/site/guide/templates/manage-document-types.qmd +++ b/site/guide/templates/manage-document-types.qmd @@ -36,13 +36,13 @@ These stock document types cannot be deleted, only edited: 4. Enter the document type details: - - Provide a **[name]{.smallcaps}** and an optional **[description]{.smallcaps}**. - - Toggle whether this document type should be automatically created **[when record is registered]{.smallcaps}**. - - Select the **[inventory record types]{.smallcaps}** that should have access to this document type.[^2] - - (Optional) Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this document type by default. - - (Optional) Toggle a **[default template]{.smallcaps}** for this document type.[^3] - - Select the inventory record stakeholder types[^4] that should have **[update document]{.smallcaps}** permissions for this document type.[^5] - - (Optional) Select the inventory record stakeholder types that should have **[update document outline]{.smallcaps}** permissions for this document type.[^6] + - Provide a **Name** and an optional **Description**. + - Toggle whether this document type should be automatically created **When Record is Registered**. + - Select the **Inventory Record Types** that should have access to this document type.[^2] + - (Optional) Under **Default on Inventory Record Types**, select which inventory record types should display this document type by default. + - (Optional) Toggle **Enable Default Template** for this document type to select a default template.[^3] + - Select the inventory record stakeholder types[^4] that should have **Update Document** permissions for this document type.[^5] + - (Optional) Select the inventory record stakeholder types that should have **Update Document Outline** permissions for this document type.[^6] 5. Click **Create Document Type** to add your document type. @@ -65,7 +65,7 @@ Once created, customize the available templates for your document type.[^7] a. Hover over the document type you want to edit. -b. When the **{{< fa ellipsis-vertical >}}** appears under the Actions column, click on it and select **{{< fa pencil >}} Edit** to change your document type's details. +b. When the **{{< fa ellipsis-vertical >}}** menu appears under the Actions column, click on it and select **{{< fa pencil >}} Edit** to change your document type's details. c. Click **Update Document Type** to apply your changes. @@ -73,7 +73,7 @@ c. Click **Update Document Type** to apply your changes. a. Hover over the document type you want to delete. -b. When the **{{< fa ellipsis-vertical >}}** appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete**]{.red} to remove the document type. +b. When the **{{< fa ellipsis-vertical >}}** menu appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete**]{.red} to remove the document type. c. Click **Yes, Delete Document Type** to confirm permanent deletion of that document type. @@ -100,7 +100,7 @@ In order to delete a document type, there must be no records using that document [^6]: - - At least one inventory record stakeholder type must be assigned to **[update document]{.smallcaps}** permissions in order to adjust **[update document outline]{.smallcaps}** permissions. + - At least one inventory record stakeholder type must be assigned to **Update Document** permissions in order to adjust **Update Document Outline** permissions. - [Manage document templates](/guide/templates/manage-document-templates.qmd#edit-document-template-outlines) [^7]: [Customize document templates](customize-document-templates.qmd) diff --git a/site/guide/templates/manage-documents.qmd b/site/guide/templates/manage-documents.qmd index d06e02b407..1d15035b12 100644 --- a/site/guide/templates/manage-documents.qmd +++ b/site/guide/templates/manage-documents.qmd @@ -33,8 +33,8 @@ Add or delete documents available on individual records in your inventory. 5. Enter the document details: - - **[document title]{.smallcaps}** — Title of your document.[^7] - - **[document type]{.smallcaps}**[^8] — The type of your document. + - **Document Title** — Title of your document.[^7] + - **Document Type**[^8] — The type of your document. 6. Click **Create Document** to select from a document template within the {{< var validmind.platform >}},[^9] or upload an existing PDF:[^10] @@ -42,9 +42,9 @@ Add or delete documents available on individual records in your inventory. #### Create document from {{< var vm.product >}} template -a. Under [create document]{.smallcaps}, select **From {{< var vm.product >}} Template**. +a. Under **Create Document**, select **From {{< var vm.product >}} Template**. -b. Select your desired **[template]{.smallcaps}** from the drop-down menu. +b. Select your desired **Template** from the drop-down menu. c. Click **Use Template** to apply the template. @@ -56,13 +56,13 @@ Convert a Portable Document Format `.pdf` file (PDF) into an editable document i To upload a PDF: -a. Under [create document]{.smallcaps}, select **From PDF Upload**. +a. Under **Create Document**, select **From PDF Upload**. b. Drag and drop a `.pdf` file into the upload area, or click **choose a file** to select from your file explorer.[^12] c. Choose to: - - **Upload as Static Document** — The uploaded PDF is stored as a static file. You can view it within {{< var validmind.platform >}} but you cannot modify its structure or contents. + - **Upload as Static Document** — The uploaded PDF is stored as a static file. You can view it within the {{< var validmind.platform >}} but you cannot modify its structure or contents. - **Upload & Convert to Editable Document** — Track conversion progress in the banner that appears at the top of the document page. When conversion completes, the page automatically refreshes to display your document as an editable template with the content extracted from the PDF. If you need to stop an in-progress PDF conversion: @@ -158,7 +158,7 @@ Deletion of documents on records is permanent and cannot be undone. 4. Hover over the document you want to delete. -5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Delete**]{.red} to remove the document. +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can >}} Delete**]{.red} to remove the document. 6. Click **Yes, Delete Document** to confirm permanent deletion of that document from the record. diff --git a/site/guide/templates/manage-text-block-library.qmd b/site/guide/templates/manage-text-block-library.qmd index b43d1ac6cc..b0ed704861 100644 --- a/site/guide/templates/manage-text-block-library.qmd +++ b/site/guide/templates/manage-text-block-library.qmd @@ -36,10 +36,10 @@ To transform an existing text block into a reusable block: 6. Hover your mouse over the text block you want to add to your block library, and click **{{< fa plus >}} Add to Library** to enter the details for your block: - - The **[name]{.smallcaps}** of your text block - - (Optional) A **[description]{.smallcaps}** for your text block - - The templated **[content]{.smallcaps}** for your text block - - Whether the block **[sharing]{.smallcaps}** permissions are **Private** or **Shared** + - The **Name** of your text block + - (Optional) A **Description** for your text block + - The templated **Content** for your text block + - Whether the block **Sharing** permissions are **Private** or **Shared** 7. Click **Add Block** to save your text block. @@ -66,10 +66,10 @@ To modify an existing text block in your block library: 4. Make your desired changes to the following fields: - - The **[name]{.smallcaps}** of your text block - - (Optional) A **[description]{.smallcaps}** for your text block - - The templated **[content]{.smallcaps}** for your text block - - Whether the block **[sharing]{.smallcaps}** permissions are **Private** or **Shared** + - The **Name** of your text block + - (Optional) A **Description** for your text block + - The templated **Content** for your text block + - Whether the block **Sharing** permissions are **Private** or **Shared** 5. Click **Save Block** to apply your changes. @@ -98,7 +98,7 @@ To remove an existing text block from your block library: [^3]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^4]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^4]: [Managing documents](/guide/templates/managing-documents.qmd) [^5]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#add-content-blocks) diff --git a/site/guide/templates/managing-documents.qmd b/site/guide/templates/managing-documents.qmd new file mode 100644 index 0000000000..9bf2cc57d9 --- /dev/null +++ b/site/guide/templates/managing-documents.qmd @@ -0,0 +1,69 @@ +--- +# 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 documents" +date: last-modified +listing: + - id: documents + type: grid + grid-columns: 2 + max-description-length: 250 + sort: false + fields: [title, description] + contents: + - manage-document-types.qmd + - manage-documents.qmd +aliases: + - /guide/templates/working-with-documents.html + - /guide/templates/working-with-model-documents.html +--- + +Set up and manage documents and document types, categories of record-related content, for use on records across your organization within the {{< var validmind.platform >}}. + +## Manage document defaults + +To change the default settings for all documents within your organization: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa file >}} Documents, select **General** to enable or disable tracked changes by default or numbered table and figure captions: + + :::: {.panel-tabset} + + ### Tracked changes + + ::: {.callout-important} + Enabling tracked changes by default for your organization will disable the following within simple text blocks:[^1] + + - The ability to reference field values in the form of variables + - Content draft generation with AI + + ::: + + Under Document Defaults, toggle whether you would like to **Enable Track Changes by Default**[^2] for all content blocks within documents for your current active organization. + + ### Numbered table and figure captions + + Under Document Defaults, toggle whether you would like to **Enable Numbered Table and Figure Captions** for test results inserted within documents[^3] for your current active organization. + + :::: + +## Manage document types and documents + +:::: {#documents} +:::: + +## What's next + +- [Documents and templates FAQ](/faq/faq-documentation.qmd) +- [Customize {{< var validmind.checker >}}](customize-document-checker.qmd) + + + + +[^1]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#add-content-blocks) + +[^2]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd#tracking-changes) + +[^3]: [Work with test results](/guide/documentation/work-with-test-results.qmd) diff --git a/site/guide/templates/working-with-document-templates.qmd b/site/guide/templates/working-with-document-templates.qmd index 57aed31def..00078640b2 100644 --- a/site/guide/templates/working-with-document-templates.qmd +++ b/site/guide/templates/working-with-document-templates.qmd @@ -7,13 +7,14 @@ date: last-modified listing: - id: document-templates type: grid - grid-columns: 2 + grid-columns: 3 max-description-length: 250 sort: false fields: [title, description] contents: - customize-document-templates.qmd - manage-document-templates.qmd + - manage-text-block-library.qmd aliases: - /guide/working-with-document-templates.html - /guide/documentation/working-with-document-templates.html @@ -23,12 +24,10 @@ aliases: {{< include /guide/templates/_document-templates.qmd >}} -:::{#document-templates} +:::{#document-templates .intro-listing} ::: -
    - ## What's next -- [Working with documents](working-with-documents.qmd) -- [Manage text block library](manage-text-block-library.qmd) \ No newline at end of file +- [Documents and templates FAQ](/faq/faq-documentation.qmd) +- [Managing documents](managing-documents.qmd) \ No newline at end of file diff --git a/site/guide/templates/working-with-documents.qmd b/site/guide/templates/working-with-documents.qmd deleted file mode 100644 index e598a9a236..0000000000 --- a/site/guide/templates/working-with-documents.qmd +++ /dev/null @@ -1,33 +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: "Working with documents" -date: last-modified -listing: - - id: documents - type: grid - grid-columns: 2 - max-description-length: 250 - sort: false - fields: [title, description] - contents: - - manage-document-types.qmd - - manage-documents.qmd -aliases: - - /guide/templates/working-with-model-documents.html ---- - -Set up document types, categories of record-related content, for use on records across your organization, and the regulations and policies that oversee your documents within the {{< var validmind.platform >}}. - - -:::{#documents} -::: - -
    - -## What's next - -- [Working with document templates](working-with-document-templates.qmd) -- [Manage text block library](manage-text-block-library.qmd) -- [Customize {{< var validmind.checker >}}](customize-document-checker.qmd) diff --git a/site/guide/validation/_add-artifact-severities.qmd b/site/guide/validation/_add-artifact-severities.qmd index a09b569fa7..87752e0b67 100644 --- a/site/guide/validation/_add-artifact-severities.qmd +++ b/site/guide/validation/_add-artifact-severities.qmd @@ -13,7 +13,7 @@ To add additional severities: 1. Click **{{< fa plus >}} Add Artifact Severity**. -1. Enter a **[name]{.smallcaps}** and select a **[color]{.smallcaps}** for the severity. +1. Enter a **Name** and select a **Color** for the severity. 1. Click **Add Severity** to create the severity. @@ -33,7 +33,7 @@ To add additional severities: 1. Click **{{< fa plus >}} Add Artifact Severity**. -1. Enter a **[name]{.smallcaps}** and select a **[color]{.smallcaps}** for the severity. +1. Enter a **Name** and select a **Color** for the severity. 1. Click **Add Severity** to create the severity. diff --git a/site/guide/validation/_add-edit-artifact-fields.qmd b/site/guide/validation/_add-edit-artifact-fields.qmd index 8a581a02f2..98ba6d61b0 100644 --- a/site/guide/validation/_add-edit-artifact-fields.qmd +++ b/site/guide/validation/_add-edit-artifact-fields.qmd @@ -10,16 +10,16 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> To add a new artifact field, click **{{< fa plus >}} Add Field**: -a. Artifact fields require you to enter a **[title]{.smallcaps}** (name), select a field **[type]{.smallcaps}**,^[[Artifact field types](/guide/validation/manage-artifact-fields.qmd#artifact-field-types)] and indicate what **[artifact types]{.smallcaps}**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] the field is available on. +a. Artifact fields require you to enter a **Title** (name), select a field **Type**,^[[Artifact field types](/guide/validation/manage-artifact-fields.qmd#artifact-field-types)] and indicate what **Artifact Types**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] the field is available on. a. Include optional information for your artifact 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 artifact creation]{.smallcaps}**. - - Assign a field to a **[group{.smallcaps}]**.^[Ungrouped fields will be listed under No Group: [Add artifact field groups](/guide/validation/manage-artifact-fields.qmd#add-artifact-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-artifact-fields] + - Enter a custom field **Key**.^[If left blank, a key will be automatically generated in `camelCase` format.] + - Enter a **Description** to indicate the purpose of the field displayed on the list of fields. + - Enter **Help Text** to provide guidance to users on how best to fill out that field. + - Check off whether or not the field should be **Required On Artifact Creation**. + - Assign a field to a **Group**.^[Ungrouped fields will be listed under No Group: [Add artifact field groups](/guide/validation/manage-artifact-fields.qmd#add-artifact-field-groups)] + - Assign **Write Permissions** 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-artifact-fields] a. When you are satisfied with the setup of your artifact field, click **Save**. @@ -33,7 +33,7 @@ a. Click on the artifact field you want to edit. a. Make your desired changes to your artifact field, then click **Save**. - Field keys for artifact fields can be renamed under the **[actions]{.smallcaps}** column.^[[Rename artifact field keys](/guide/validation/manage-artifact-fields.qmd#rename-artifact-field-keys)] + Field keys for artifact fields can be renamed under the **Actions** column.^[[Rename artifact field keys](/guide/validation/manage-artifact-fields.qmd#rename-artifact-field-keys)] ::: @@ -42,7 +42,7 @@ a. Make your desired changes to your artifact field, then click **Save**. [^edit-artifact-fields]: ::: {.callout} - ## All other users will have read-only access unless specified under the **[write permissions]{.smallcaps}**. + ## All other users will have read-only access unless specified under the **Write Permissions**. - [**Record Stakeholders**](/guide/configuration/manage-record-stakeholder-types.qmd) — Write permissions on a per record basis. - [**Application Roles**](/guide/configuration/manage-roles.qmd) — Write permissions on a per field basis across all artifacts. @@ -60,16 +60,16 @@ a. Make your desired changes to your artifact field, then click **Save**. - Click **{{< fa plus >}} Add Field** to add a new field. - Click on an existing field to edit that field. -1. Artifact fields require you to enter a **[title]{.smallcaps}** (name), select a field **[type]{.smallcaps}**, and indicate what **[artifact types]{.smallcaps}** the field is available on. +1. Artifact fields require you to enter a **Title** (name), select a field **Type**, and indicate what **Artifact Types** the field is available on. 1. Include optional information for your artifact 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 artifact creation]{.smallcaps}**. - - 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 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. + - Enter a custom field **Key**. If left blank, a key will be automatically generated in `camelCase` format. + - Enter a **Description** to indicate the purpose of the field displayed on the list of fields. + - Enter **Help Text** to provide guidance to users on how best to fill out that field. + - Check off whether or not the field should be **Required On Artifact Creation**. + - Assign a field to a **Group**. Ungrouped fields will be listed under No Group. + - Assign **Write Permissions** 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 artifact field, click **Save**. diff --git a/site/guide/validation/_add-edit-artifact-statuses.qmd b/site/guide/validation/_add-edit-artifact-statuses.qmd index 25797b00e9..16a318235d 100644 --- a/site/guide/validation/_add-edit-artifact-statuses.qmd +++ b/site/guide/validation/_add-edit-artifact-statuses.qmd @@ -8,7 +8,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. Click **{{< fa plus >}} Add Status**. -b. Enter a **[status name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. +b. Enter a **Status Name** and assign a **Color** to your artifact status. c. When you are done, click **Add Status** to create your new status. @@ -16,9 +16,9 @@ c. When you are done, click **Add Status** to create your new status. a. Hover over the artifact status you'd like to modify. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select: +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select: - - **{{< fa pencil >}} Edit Details** to change the **[status name]{.smallcaps}** or **[color]{.smallcaps}** of the status, then click **Update Status** to apply your changes. + - **{{< fa pencil >}} Edit Details** to change the **Status Name** or **Color** of the status, then click **Update Status** to apply your changes. - [**{{< fa trash-can >}} Delete Status**]{.red} to remove the status. Click **OK** to confirm permanent deletion of that status. ::: {.callout-important title="Artifact status deletion is permanent and cannot be undone."} @@ -36,7 +36,7 @@ Artifact statuses cannot be deleted if in use on an artifact. Ensure that the st a. Click **{{< fa plus >}} Add Status**. -b. Enter a **[status name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. +b. Enter a **Status Name** and assign a **Color** to your artifact status. c. When you are done, click **Add Status** to create your new status. @@ -48,7 +48,7 @@ c. When you are done, click **Add Status** to create your new status. a. Hover over the artifact status you'd like to modify. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pencil >}} Edit Details** to change the **[status name]{.smallcaps}** or **[color]{.smallcaps}** of the status. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil >}} Edit Details** to change the **Status Name** or **Color** of the status. c. Click **Update Status** to apply your changes. diff --git a/site/guide/validation/_add-edit-artifact-types.qmd b/site/guide/validation/_add-edit-artifact-types.qmd index de814dd5b1..82be0f5cf1 100644 --- a/site/guide/validation/_add-edit-artifact-types.qmd +++ b/site/guide/validation/_add-edit-artifact-types.qmd @@ -11,7 +11,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 3. Click **{{< fa plus >}} Add Artifact Type**. -4. Enter a [name]{.smallcaps} and an optional [description]{.smallcaps} for your artifact type. +4. Enter a **Name** and an optional **Description** for your artifact type. 5. Click **Create** to create your new artifact type. @@ -19,14 +19,14 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 7. Enter 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] - - **[record fields display]{.smallcaps}**[^add-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record 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)] + - **Fields** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^add-fields-callout] + - **Record Fields Display**[^add-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record Fields Configuration** to apply your changes. + - **Artifact Statuses** — Configure the statuses available to this artifact type.^[[Manage artifact type statuses](#manage-artifact-type-statuses)] 8. Select the artifact type's permissions: - - **[create artifact]{.smallcaps}** — Inventory record stakeholder types or user roles[^add-permissions] that can create this type of artifact. - - **[update artifact]{.smallcaps}** — Inventory record stakeholder types or user roles that can update existing artifacts of this type. + - **Create Artifact** — Inventory record stakeholder types or user roles[^add-permissions] that can create this type of artifact. + - **Update Artifact** — Inventory record stakeholder types or user roles that can update existing artifacts of this type. ## Edit artifact types @@ -38,16 +38,16 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 4. Make your desired changes to the artifact type's details: - - **[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] - - **[record fields display]{.smallcaps}**[^edit-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record 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)] + - **Name** + - **Description** + - **Fields** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^edit-fields-callout] + - **Record Fields Display**[^edit-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record Fields Configuration** to apply your changes. + - **Artifact Statuses** — 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: - - **[create artifact]{.smallcaps}** — Inventory record stakeholder types or user roles[^edit-permissions] that can create this type of artifact. - - **[update artifact]{.smallcaps}** — Inventory record stakeholder types or user roles that can update existing artifacts of this type. + - **Create Artifact** — Inventory record stakeholder types or user roles[^edit-permissions] that can create this type of artifact. + - **Update Artifact** — Inventory record stakeholder types or user roles that can update existing artifacts of this type. :::: @@ -95,7 +95,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. Click **{{< fa plus >}} Add Artifact Type**. -b. Enter a [name]{.smallcaps} and an optional [description]{.smallcaps} for your artifact type. +b. Enter a **Name** and an optional **Description** for your artifact type. c. Click **Create** to create your new artifact type. @@ -103,8 +103,8 @@ d. Click on your newly created artifact type to edit its details and permissions Most changes are saved automatically. - - For **[fields]{.smallcaps}** configuration, click **Save Fields** to apply changes. - - For **[record fields display]{.smallcaps}** configuration, click **Save Record Fields Configuration** to apply changes. + - For **Fields** configuration, click **Save Fields** to apply changes. + - For **Record Fields Display** configuration, click **Save Record Fields Configuration** to apply changes. #### Edit artifact types @@ -114,8 +114,8 @@ b. Make your desired changes to the artifact type's details and permissions. Most changes are saved automatically. - - For **[fields]{.smallcaps}** configuration, click **Save Fields** to apply changes. - - For **[record fields display]{.smallcaps}** configuration, click **Save Record Fields Configuration** to apply changes. + - For **Fields** configuration, click **Save Fields** to apply changes. + - For **Record Fields Display** configuration, click **Save Record Fields Configuration** to apply changes. :::: diff --git a/site/guide/validation/_add-risk-areas.qmd b/site/guide/validation/_add-risk-areas.qmd index 13ab78e8bb..4c40b6a1bd 100644 --- a/site/guide/validation/_add-risk-areas.qmd +++ b/site/guide/validation/_add-risk-areas.qmd @@ -5,7 +5,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} a. Click **{{< fa plus >}} Add Risk Area**. -a. Provide a **[name]{.smallcaps}** and **[description]{.smallcaps}** for your risk area. +a. Provide a **Name** and **Description** for your risk area. a. Click **Add Risk Area** to create your risk area. @@ -18,7 +18,7 @@ a. Click **Add Risk Area** to create your risk area. a. Click **{{< fa plus >}} Add Risk Area**. -a. Provide a **[name]{.smallcaps}** and **[description]{.smallcaps}** for your risk area. +a. Provide a **Name** and **Description** for your risk area. a. Click **Add Risk Area** to create your risk area. diff --git a/site/guide/validation/_add-validation-guidelines.qmd b/site/guide/validation/_add-validation-guidelines.qmd index 6f8e9b9142..52809a07e5 100644 --- a/site/guide/validation/_add-validation-guidelines.qmd +++ b/site/guide/validation/_add-validation-guidelines.qmd @@ -7,7 +7,7 @@ a. Hover over the risk area you want to add a guideline to. a. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa plus >}} Add Guideline**. -a. Provide a **[title]{.smallcaps}** and **[description]{.smallcaps}** for your guideline. +a. Provide a **Title** and **Description** for your guideline. a. Click **Add Guideline** to insert your guideline to that risk area. @@ -21,7 +21,7 @@ a. Hover over the risk area you want to add a guideline to. a. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa plus >}} Add Guideline**. -a. Provide a **[title]{.smallcaps}** and **[description]{.smallcaps}** for your guideline. +a. Provide a **Title** and **Description** for your guideline. a. Click **Add Guideline** to insert your guideline to that risk area. diff --git a/site/guide/validation/_link-artifacts-to-reports.qmd b/site/guide/validation/_link-artifacts-to-reports.qmd index 5020d2b7b7..b4c079aa4b 100644 --- a/site/guide/validation/_link-artifacts-to-reports.qmd +++ b/site/guide/validation/_link-artifacts-to-reports.qmd @@ -43,10 +43,10 @@ d. Click **Update Linked Artifacts**. 1. Click **{{< fa plus >}} Add Validation Issue** and enter the details for your validation issue, for example: - - **[title]{.smallcaps}** — Champion Logistic Regression Model Fails Minimum Accuracy Threshold - - **[risk area]{.smallcaps}** — Model Performance - - **[documentation section]{.smallcaps}** — 3.2. Model Evaluation - - **[description]{.smallcaps}** — The logistic regression champion model was subjected to a Minimum Accuracy test to determine whether its predictive accuracy meets the predefined performance threshold of 0.7. The model achieved an accuracy score of 0.6136, which falls below the required minimum. As a result, the test produced a Fail outcome. + - **Title** — Champion Logistic Regression Model Fails Minimum Accuracy Threshold + - **Risk Area** — Model Performance + - **Documentation Section** — 3.2. Model Evaluation + - **Description** — The logistic regression champion model was subjected to a Minimum Accuracy test to determine whether its predictive accuracy meets the predefined performance threshold of 0.7. The model achieved an accuracy score of 0.6136, which falls below the required minimum. As a result, the test produced a Fail outcome. 1. Click **Add Validation Issue** to submit the validation issue. diff --git a/site/guide/validation/_remove-artifact-view.qmd b/site/guide/validation/_remove-artifact-view.qmd index 6fa4ae1767..18ed11ec49 100644 --- a/site/guide/validation/_remove-artifact-view.qmd +++ b/site/guide/validation/_remove-artifact-view.qmd @@ -8,7 +8,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 4. Hover over the name of the view you want to edit or remove. -5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select: +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select: - - **{{< fa pencil >}} Edit View** to edit the [view name]{.smallcaps} and [description]{.smallcaps}. Click **Save Changes** to apply your edits. + - **{{< fa pencil >}} Edit View** to edit the **View Name** and **Description**. Click **Save Changes** to apply your edits. - [**{{< fa trash-can >}} Remove View**]{.red} to delete the view. Click **Yes, Delete View** to confirm permanent deletion of that view. \ No newline at end of file diff --git a/site/guide/validation/_track-artifact-resolution.qmd b/site/guide/validation/_track-artifact-resolution.qmd index 844d65efa4..bc2b3990a2 100644 --- a/site/guide/validation/_track-artifact-resolution.qmd +++ b/site/guide/validation/_track-artifact-resolution.qmd @@ -18,7 +18,7 @@ a. Go through the open validation issues one-by-one: - **If the validation issue has been addressed** — - Add any final comments to assess how the issue was resolved.^[[Comment on artifacts](/guide/validation/update-artifacts.qmd#comment-on-artifacts)] - - Under **[status]{.smallcaps}**, select `Closed`. + - Under **Status**, select `Closed`. - **If part or all of the validation issue remains to be addressed** — @@ -41,7 +41,7 @@ a. Go through the open artifacts one-by-one: - **If the artifact has been addressed** — - Add any final comments to assess how the issue was resolved.^[[Comment on artifacts](/guide/validation/update-artifacts.qmd#comment-on-artifacts)] - - Under **[status]{.smallcaps}**, select `Closed`. + - Under **Status**, select `Closed`. - **If part or all of the artifact remains to be addressed** — @@ -68,7 +68,7 @@ a. Go through the open validation issues one-by-one: - **If the validation issue has been addressed** — - Add any final comments to assess how the issue was resolved. - - Under **[status]{.smallcaps}**, select `Closed`. + - Under **Status**, select `Closed`. - **If part or all of the validation issue remains to be addressed** — @@ -91,7 +91,7 @@ a. Go through the open artifacts one-by-one: - **If the artifact has been addressed** — - Add any final comments to assess how the issue was resolved. - - Under **[status]{.smallcaps}**, select `Closed`. + - Under **Status**, select `Closed`. - **If part or all of the artifact remains to be addressed** — diff --git a/site/guide/validation/configure-assessment-options.qmd b/site/guide/validation/configure-assessment-options.qmd index bd0bce9097..f388b7a043 100644 --- a/site/guide/validation/configure-assessment-options.qmd +++ b/site/guide/validation/configure-assessment-options.qmd @@ -46,9 +46,9 @@ a. Click **{{< fa plus >}} Add Assessment Option**. b. Provide the details for your assessment option: - - **[name]{.smallcaps}** (required) — A short label for the option, between 2 and 50 characters. - - **[description]{.smallcaps}** (optional) — A longer explanation of what the option means. - - **[color]{.smallcaps}** (required) — Select a color from the color palette to visually distinguish this option. + - **Name** (required) — A short label for the option, between 2 and 50 characters. + - **Description** (optional) — A longer explanation of what the option means. + - **Color** (required) — Select a color from the color palette to visually distinguish this option. c. Click **Add Option** to insert the new option into that validation report template. @@ -56,13 +56,13 @@ c. Click **Add Option** to insert the new option into that validation report tem a. Hover over the assessment option you want to edit. -b. When **{{< fa ellipsis-vertical >}}** appears, select **{{< fa pencil >}} Edit Option**. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, select **{{< fa pencil >}} Edit Option**. c. Update the details for your assessment option: - - **[name]{.smallcaps}** (required) — A short label for the option, between 2 and 50 characters. - - **[description]{.smallcaps}** (optional) — A longer explanation of what the option means. - - **[color]{.smallcaps}** (required) — Select a color from the color palette to visually distinguish this option. + - **Name** (required) — A short label for the option, between 2 and 50 characters. + - **Description** (optional) — A longer explanation of what the option means. + - **Color** (required) — Select a color from the color palette to visually distinguish this option. d. Click **Update Option** to apply your changes. @@ -75,7 +75,7 @@ Assessment options can only be deleted if they are not assigned to sections in a a. Hover over the assessment option you want to edit. -b. When **{{< fa ellipsis-vertical >}}** appears, select [**{{< fa trash-can >}} Delete Option**]{.red}. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, select [**{{< fa trash-can >}} Delete Option**]{.red}. c. Click **Delete Assessment Option** to confirm removal of that option. diff --git a/site/guide/validation/customize-artifact-layouts.qmd b/site/guide/validation/customize-artifact-layouts.qmd index 57398ec6f5..fa6cab2ccf 100644 --- a/site/guide/validation/customize-artifact-layouts.qmd +++ b/site/guide/validation/customize-artifact-layouts.qmd @@ -70,13 +70,13 @@ Once customized, you can save a view for later application.[^7] You can save custom artifact configurations as a view to reapply at any time for each artifact type: -#### Manage personal artifact views +### Manage personal artifact views -{{< include /guide/shared/manage-views/_personal-views.qmd >}} +{{< include /guide/shared/manage-views/_personal-table-views.qmd >}} -#### Manage organization artifact views +### Manage organization artifact views -{{< include /guide/shared/manage-views/_organization-views.qmd >}} +{{< include /guide/shared/manage-views/_organization-table-views.qmd >}} diff --git a/site/guide/validation/customize-artifact-overview-page.qmd b/site/guide/validation/customize-artifact-overview-page.qmd index b5aa01d4a2..928aad68b1 100644 --- a/site/guide/validation/customize-artifact-overview-page.qmd +++ b/site/guide/validation/customize-artifact-overview-page.qmd @@ -7,6 +7,8 @@ date: last-modified aliases: - customize-finding-overview-page.html - /guide/model-validation/customize-artifact-overview-page.html +includes: + artifacts: true --- Configure what and how artifact fields appear when you pull up artifacts logged on records. @@ -40,9 +42,9 @@ Customizations will apply to all artifacts of the same type in your inventory. Under Show {#} Columns, click {{< fa chevron-up >}} increase or {{< fa chevron-down >}} to decrease the number of columns shown. - #### {{< fa chart-bar >}} Change fields display + #### {{< fa chart-bar >}} Change Field Configuration - a. Click **{{< fa chart-bar >}} Change fields display** to configure the artifact fields[^4] that appear: + a. Click **{{< fa chart-bar >}} Change Field Configuration** to configure the artifact fields[^4] that appear: - To hide fields or field groups from view: Hover over an artifact field, then click {{< fa eye >}}. - To show previously hidden fields or field groups: Hover over an artifact field, then click {{< fa eye-slash >}}. @@ -53,18 +55,20 @@ Customizations will apply to all artifacts of the same type in your inventory. To narrow down your list of fields: - Click **{{< fa filter >}} Search by group or field name** to search for specific artifact fields. - - To show only highlighted fields, click **Show only highlighted in overview**. + - To show only highlighted fields, click **Show only highlighted in overview {{< fa star >}}**. ::: b. Click **Save Configuration** to apply your changes to all overview pages for that artifact type. + Your layout will be saved locally to your browser's session.[^6] + ::: ### Highlight artifact fields To pin artifact fields to the **Overview** tab for quick access: -1. Open an artifact logged on any record.[^6] +1. Open an artifact logged on any record.[^7] 2. On the artifact details page, select either the **Overview** or **Artifact Fields** tab: @@ -73,11 +77,11 @@ To pin artifact fields to the **Overview** tab for quick access: #### **Overview** tab - If there are no highlighted fields: Click on **{{< fa star >}} Highlight fields**. - - If there are already highlighted fields: Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change fields display**. + - If there are already highlighted fields: Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change Field Configuration**. #### **Artifact Fields** tab - Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change fields display**. + Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change Field Configuration**. ::: @@ -91,6 +95,26 @@ To pin artifact fields to the **Overview** tab for quick access: 4. Confirm that the right artifact fields are pinned to the **Overview** tab with the correct highlight tone. +## Manage artifact field layouts + +You can save custom artifact field layouts to reapply at any time for each artifact type: + +1. Open an artifact logged on any record.[^8] + +2. On the artifact details page, click the **Artifact Fields** tab. + +3. Click on **{{< fa pencil >}} Manage Fields** and select **{{< fa chart-bar >}} Change Field Configuration** to organize, show, or hide artifact fields as desired.[^9] + +4. Save a personal or publish a shared organization artifact field layout: + +### Manage personal artifact field layouts + +{{< include /guide/shared/manage-views/_personal-field-views.qmd >}} + +### Manage organization artifact field layouts + +{{< include /guide/shared/manage-views/_organization-field-views.qmd >}} + @@ -104,4 +128,10 @@ To pin artifact fields to the **Overview** tab for quick access: [^5]: [Highlight artifact fields](#highlight-artifact-fields) -[^6]: [View and filter artifacts](view-filter-artifacts.qmd) +[^6]: To save a named layout for reuse or sharing, refer to: [Manage artifact field layouts](#manage-artifact-field-layouts) + +[^7]: [View and filter artifacts](view-filter-artifacts.qmd) + +[^8]: [View and filter artifacts](view-filter-artifacts.qmd) + +[^9]: [Organize, show, or hide artifact fields](#organize-show-or-hide-artifact-fields) diff --git a/site/guide/validation/manage-artifact-fields.qmd b/site/guide/validation/manage-artifact-fields.qmd index 8d20312dd7..1536d91b8b 100644 --- a/site/guide/validation/manage-artifact-fields.qmd +++ b/site/guide/validation/manage-artifact-fields.qmd @@ -59,11 +59,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: - - **[artifact types]{.smallcaps}** — The types of artifacts that use this field. - - **[required on creation]{.smallcaps}** — Whether or not the field was set up as required on artifact creation. - - **[types]{.smallcaps}** — What type of field it is. - - **[workflow triggered by field]{.smallcaps}** — What workflows are initiated when this field is edited.[^6] - - **[write permissions]{.smallcaps}** — Which inventory record stakeholder types have permissions to edit this field.[^7] + - **Artifact Types** — The types of artifacts that use this field. + - **Required On Creation** — Whether or not the field was set up as required on artifact creation. + - **Types** — What type of field it is. + - **Workflow Triggered By Field** — What workflows are initiated when this field is edited.[^6] + - **Write Permissions** — Which inventory record stakeholder types have permissions to edit this field.[^7] b. Click **Apply Filters** to narrow down your results by your configured criteria. @@ -99,7 +99,7 @@ To group artifact fields, first create an artifact field group: 2. Under {{< fa expand >}} Artifacts, select **Artifact Fields**. -3. Click **{{< fa plus >}} Add Group** and enter a **[name]{.smallcaps}** and a **[description]{.smallcaps}** for the group. +3. Click **{{< fa plus >}} Add Group** and enter a **Name** and a **Description** for the group. 4. Click **Create Group** to add the new group. @@ -117,7 +117,7 @@ Deleting an artifact field will remove it from all artifacts using that field, e 3. Hover over the field you would like to delete. -4. When the **{{< fa ellipsis-vertical >}}** appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete Field**]{.red}. +4. When the **{{< fa ellipsis-vertical >}}** menu appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete Field**]{.red}. 5. Click **Yes, Delete Field** to confirm permanent deletion. diff --git a/site/guide/validation/manage-artifact-severities.qmd b/site/guide/validation/manage-artifact-severities.qmd index bba73efccd..3b9b53dfb5 100644 --- a/site/guide/validation/manage-artifact-severities.qmd +++ b/site/guide/validation/manage-artifact-severities.qmd @@ -32,9 +32,9 @@ aliases: 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**. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil >}} Edit Severity**. -5. Make your changes to the **[name]{.smallcaps}** and **[color]{.smallcaps}** of the severity. +5. Make your changes to the **Name** and **Color** of the severity. 6. Click **Update Severity** to apply your edits. @@ -56,7 +56,7 @@ Severities can only be deleted if they are not in use by any artifacts. 3. Hover over the severity you would like to delete. -4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Delete Severity**]{.red}. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can >}} Delete Severity**]{.red}. 5. Click **Delete Artifact Severity** to confirm permanent deletion. diff --git a/site/guide/validation/manage-artifact-types.qmd b/site/guide/validation/manage-artifact-types.qmd index f7ad85c26f..ca670618a8 100644 --- a/site/guide/validation/manage-artifact-types.qmd +++ b/site/guide/validation/manage-artifact-types.qmd @@ -42,7 +42,7 @@ Audit findings Enhancement requests : Log suggested improvements that don't rise to the level of a validation issue. Helps capture ideas for future record iterations without cluttering the validation issue backlog. -Custom artifact types support the same features as default types, including statuses, fields, permissions, workflow triggers, and analytics exports. +Custom artifact types support the same features as default types, including statuses, fields, permissions, workflow triggers, and data exports. ::: ::: @@ -87,7 +87,7 @@ Custom artifact types support the same features as default types, including stat 3. Hover over the artifact type you want to archive or delete. -5. When the **{{< fa ellipsis-vertical >}}** appears, click [**{{< fa box-archive >}} Archive Artifact Type**]{.red} under the Actions column. +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click [**{{< fa box-archive >}} Archive Artifact Type**]{.red} under the Actions column. 6. Click **Yes, Archive Artifact Type** to confirm archival. @@ -103,13 +103,13 @@ Only artifact types with no active artifact records can be deleted. ::: a. Hover over the artifact type you want to delete. -b. When the **{{< fa ellipsis-vertical >}}** appears, click [**{{< fa trash-can >}} Delete**]{.red} under the Actions column. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click [**{{< fa trash-can >}} Delete**]{.red} under the Actions column. c. Click **Yes, Delete Artifact Type** to confirm permanent deletion. #### Restore artifact types a. Hover over the artifact type you want to restore. -b. When the **{{< fa ellipsis-vertical >}}** appears, click **{{< fa undo >}} Restore** under the Actions column. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click **{{< fa undo >}} Restore** under the Actions column. c. Click **Yes, Restore Artifact Type** to confirm restoration. ::: diff --git a/site/guide/validation/manage-validation-guidelines.qmd b/site/guide/validation/manage-validation-guidelines.qmd index aba8522672..02c747bad5 100644 --- a/site/guide/validation/manage-validation-guidelines.qmd +++ b/site/guide/validation/manage-validation-guidelines.qmd @@ -55,9 +55,9 @@ To set up validation guidelines, you'll need to complete these two steps in sequ a. Hover over the risk area you want to edit. -b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil>}} Edit Risk Area**. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil >}} Edit Risk Area**. -c. Make your desired changes to the risk area's **[name]{.smallcaps}** and **[description]{.smallcaps}**. +c. Make your desired changes to the risk area's **Name** and **Description**. d. Click **Save Risk Area** to apply your changes. @@ -69,7 +69,7 @@ Any guidelines associated with a risk area will need to be deleted before the ri a. Hover over the risk area you want to remove. -b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can>}} Delete Risk Area**]{.red}. +b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can >}} Delete Risk Area**]{.red}. c. Click **Yes, Delete Risk Area** to confirm permanent deletion of that risk area. @@ -95,9 +95,9 @@ a. Expand the menu for a risk area by clicking **{{< fa chevron-down >}}**. b. Hover over the guideline you want to edit. -c. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil>}} Edit Guideline**. +c. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil >}} Edit Guideline**. -d. Make your desired changes to the risk area's **[title]{.smallcaps}** and **[description]{.smallcaps}**. +d. Make your desired changes to the risk area's **Title** and **Description**. e. Click **Save Guideline** to apply your changes. @@ -111,7 +111,7 @@ a. Expand the menu for a risk area by clicking **{{< fa chevron-down >}}**. b. Hover over the guideline you want to delete. -c. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can>}} Delete Guideline**]{.red}. +c. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can >}} Delete Guideline**]{.red}. d. Click **Yes, Delete Guideline** to confirm permanent deletion of that guideline. @@ -131,12 +131,12 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has all these per 4. On the template details page, click **{{< fa pencil >}} Edit Outline**. -5. For the section you'd like to add a guideline to,[^6] click **{{< fa plus >}}** and select **{{< fa circle-check >}} Guideline Block** under [content]{.smallcaps}. +5. For the section you'd like to add a guideline to,[^6] click **{{< fa plus >}}** and select **{{< fa circle-check >}} Guideline Block** under **Content**. 6. Select the guidelines you'd like to add to that section, then click **{{< fa plus >}} Add # Guideline(s)** to save your changes. 7. When you're done, click **Create New Version** to view a side-by-side comparison of your changes with the previous version: - - Add a description in **[version notes]{.smallcaps}** to track your changes. + - Add a description in **Version Notes** to track your changes. - Click **Save** to create the new version. Once saved, your new template version with the modified guidelines becomes available for use with your validation reports. diff --git a/site/guide/validation/managing-validation.qmd b/site/guide/validation/managing-validation.qmd index c42a5853b0..1c5e1c857f 100644 --- a/site/guide/validation/managing-validation.qmd +++ b/site/guide/validation/managing-validation.qmd @@ -40,9 +40,8 @@ Enable your organization to use the {{< var validmind.platform >}} for validatio :::{#artifacts} ::: -
    - ## What's next -- [Working with artifacts](working-with-artifacts.qmd) +- [Validation and artifacts FAQ](/faq/faq-validation.qmd) - [Preparing validation reports](preparing-validation-reports.qmd) + diff --git a/site/guide/validation/preparing-validation-reports.qmd b/site/guide/validation/preparing-validation-reports.qmd index df1dc864ee..a1c77f8c6b 100644 --- a/site/guide/validation/preparing-validation-reports.qmd +++ b/site/guide/validation/preparing-validation-reports.qmd @@ -34,18 +34,6 @@ aliases: Use the {{< var validmind.platform >}} to prepare detailed validation reports in adherence with your organization's guidelines. Link evidence and artifacts to your reports and assess compliance status at a granular level. -::: {.attn} - -## Prerequisites - -- [x] {{< var link.login >}} -- [x] The record you are validating is registered in the inventory.[^1] -- [x] Documentation has been submitted to you for validation.[^2] -- [x] Validation guidelines are aligned with your organization's requirements and added to the correct validation templates.[^3] -- [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] - -::: - ## Key concepts @@ -78,6 +66,18 @@ Use the {{< var validmind.platform >}} to prepare detailed validation reports in :::: +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] The record you are validating is registered in the inventory.[^1] +- [x] Documentation has been submitted to you for validation.[^2] +- [x] Validation guidelines are aligned with your organization's requirements and added to the correct validation templates.[^3] +- [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] + +::: + ## Validation Overview ::: {.callout title="Static PDF uploads do not include a Document Overview."} @@ -136,6 +136,7 @@ Wrap up your report, collaborate with other stakeholders, and submit your work f ## What's next +- [Validation and artifacts FAQ](/faq/faq-validation.qmd) - [Working with artifacts](working-with-artifacts.qmd) @@ -157,7 +158,7 @@ Wrap up your report, collaborate with other stakeholders, and submit your work f [^8]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^9]: [Working with documents](/guide/templates/working-with-documents.qmd) +[^9]: [Managing documents](/guide/templates/managing-documents.qmd) [^10]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) @@ -165,7 +166,7 @@ Wrap up your report, collaborate with other stakeholders, and submit your work f [^12]: [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd) -[^13]: [View record activity](/guide/inventory/view-record-activity.qmd) +[^13]: [View record activity](/guide/reporting/view-record-activity.qmd) [^14]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd) diff --git a/site/guide/validation/review-documentation.qmd b/site/guide/validation/review-documentation.qmd index f9a0b5b88c..8bb4bd4b2d 100644 --- a/site/guide/validation/review-documentation.qmd +++ b/site/guide/validation/review-documentation.qmd @@ -11,6 +11,10 @@ aliases: Use the {{< var validmind.platform >}} to review the documentation provided by developers as part of the formal validation process. +## Key concepts + +{{< include /about/glossary/validation_reports/_review.qmd >}} + ::: {.attn} ## Prerequisites @@ -21,10 +25,6 @@ Use the {{< var validmind.platform >}} to review the documentation provided by d ::: -## Key concepts - -{{< include /about/glossary/validation_reports/_review.qmd >}} - ## Document Overview {{< include /guide/documentation/_document-overview.qmd >}} diff --git a/site/guide/validation/update-artifacts.qmd b/site/guide/validation/update-artifacts.qmd index 34894b1c6f..45bad46e16 100644 --- a/site/guide/validation/update-artifacts.qmd +++ b/site/guide/validation/update-artifacts.qmd @@ -136,7 +136,7 @@ If you logged an artifact in error or otherwise no longer need to track that art [^7]: [View and filter artifacts](view-filter-artifacts.qmd) -[^8]: [View record activity](/guide/inventory/view-record-activity.qmd) +[^8]: [View record activity](/guide/reporting/view-record-activity.qmd) [^9]: [Link artifacts to reports](/guide/validation/assess-compliance.qmd#link-artifacts-to-reports) diff --git a/site/guide/validation/working-with-artifacts.qmd b/site/guide/validation/working-with-artifacts.qmd index ddbb30535f..ba6b515764 100644 --- a/site/guide/validation/working-with-artifacts.qmd +++ b/site/guide/validation/working-with-artifacts.qmd @@ -70,7 +70,7 @@ residual analysis :::{#artifacts} ::: - ## What's next -- [Preparing validation reports](preparing-validation-reports.qmd) \ No newline at end of file +- [Validation and artifacts FAQ](/faq/faq-validation.qmd) +- [Working with analytics](/guide/reporting/working-with-analytics.qmd) diff --git a/site/guide/workflows/_abort-workflows.qmd b/site/guide/workflows/_abort-workflows.qmd index ec1edefcfd..c7e64b3469 100644 --- a/site/guide/workflows/_abort-workflows.qmd +++ b/site/guide/workflows/_abort-workflows.qmd @@ -17,23 +17,23 @@ To cancel a run of a workflow: 1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the **Active Workflows** section. 1. Click on the name of the workflow you'd like to abort to open that specific workflow's details. 1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -1. On the confirmation page, make sure **[restart workflow after aborting]{.smallcaps}** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow. +1. On the confirmation page, make sure **Restart Workflow After Aborting** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow. #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the **Active Workflows** section. 1. Click on the name of the workflow you'd like to abort to open that specific workflow's details. 1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -1. On the confirmation page, make sure **[restart workflow after aborting]{.smallcaps}** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow. +1. On the confirmation page, make sure **Restart Workflow After Aborting** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow. ::: @@ -51,22 +51,22 @@ To cancel a run of a workflow: 1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the **Active Workflows** section. 1. Click on the name of the workflow you'd like to abort to open that specific workflow's details. 1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -1. On the confirmation page, make sure **[restart workflow after aborting]{.smallcaps}** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow. +1. On the confirmation page, make sure **Restart Workflow After Aborting** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow. #### On artifacts -1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the **Active Workflows** section. 1. Click on the name of the workflow you'd like to abort to open that specific workflow's details. 1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -1. On the confirmation page, make sure **[restart workflow after aborting]{.smallcaps}** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow. +1. On the confirmation page, make sure **Restart Workflow After Aborting** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow. :::: \ No newline at end of file diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd index ac5d47bc71..42736c059c 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -11,7 +11,7 @@ b. Under {{< fa shield >}} Governance, select **Workflows**. c. Click **{{< fa plus >}} Add Workflow**. -d. Select the [workflow target]{.smallcaps} type to add: +d. Select the **Workflow Target** type to add: - **Inventory Record** — Workflows that apply to records 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/validation/working-with-artifacts.qmd)] @@ -20,36 +20,36 @@ d. Select the [workflow target]{.smallcaps} type to add: #### Add record workflows -i. Enter a **[title]{.smallcaps}** and a **[description]{.smallcaps}** for the workflow. +i. Enter a **Title** and a **Description** for the workflow. -ii. Select the **[record type]{.smallcaps}**^[[Manage record types](/guide/inventory/manage-inventory-record-types.qmd)] this workflow applies to. +ii. Select the **Record Type**^[[Manage record types](/guide/inventory/manage-inventory-record-types.qmd)] this workflow applies to. -iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: +iii. Under **Workflow Start**, select when the workflow should be initiated: - **Manually** — Start this workflow manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] - **On Inventory Record Registration** — Start this workflow when a record is registered in your inventory.[^on-registration] -- **On Field Change** — Start this workflow on a change to a specific record inventory field.[^on-field-change] To configure, select a field under **[inventory record field to monitor]{.smallcaps}**. +- **On Field Change** — Start this workflow on a change to a specific record inventory field.[^on-field-change] To configure, select a field under **Inventory Record Field To Monitor**. - **Via Webhook** — Start this workflow when a webhook event is received. -iv. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. +iv. Under **Workflow Expected Duration**, define the SLA for the workflow based on the start date in days, weeks, months, or years. v. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). #### Add artifact workflows -i. Enter a **[title]{.smallcaps}** and a **[description]{.smallcaps}** for the workflow. +i. Enter a **Title** and a **Description** for the workflow. -ii. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] this workflow applies to. +ii. Select the **Artifact Type**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] this workflow applies to. -iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: +iii. Under **Workflow Start**, select when the workflow should be initiated: - **Manually** — Start this workflow manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] - **On Artifact Registration** — Start this workflow when an artifact is logged on a record.[^on-artifact-registration] - **Via Webhook** — Start this workflow when a webhook event is received. -iv. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] this workflow applies to. +iv. Select the **Artifact Type**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] this workflow applies to. -v. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. +v. Under **Workflow Expected Duration**, define the SLA for the workflow based on the start date in days, weeks, months, or years. vi. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). @@ -90,42 +90,42 @@ b. Under {{< fa shield >}} Governance, select **Workflows**. c. Click **{{< fa plus >}} Add Workflow**. -d. Select the [workflow target]{.smallcaps} type to add: +d. Select the **Workflow Target** type to add: - **Inventory Record** — Workflows that apply to records in your inventory. - **Artifact** — Workflows that apply to logged artifacts. #### Add record workflows -i. Enter a **[title]{.smallcaps}** and a **[description]{.smallcaps}** for the workflow. +i. Enter a **Title** and a **Description** for the workflow. -ii. Select the [**[record type]{.smallcaps}**](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} this workflow applies to. +ii. Select the [**Record Type**](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} this workflow applies to. -iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: +iii. Under **Workflow Start**, select when the workflow should be initiated: - **Manually** — Start this workflow manually. - **On Inventory Record Registration** — Start this workflow when a record is registered in your inventory. -- **On Field Change** — Start this workflow on a change to a specific record inventory field. To configure, select a field under **[inventory record field to monitor]{.smallcaps}**. +- **On Field Change** — Start this workflow on a change to a specific record inventory field. To configure, select a field under **Inventory Record Field To Monitor**. - **Via Webhook** — Start this workflow when a webhook event is received. -iv. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. +iv. Under **Workflow Expected Duration**, define the SLA for the workflow based on the start date in days, weeks, months, or years. v. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. #### Add artifact workflows -i. Enter a **[title]{.smallcaps}** and a **[description]{.smallcaps}** for the workflow. +i. Enter a **Title** and a **Description** for the workflow. -ii. Select the [**[artifact type]{.smallcaps}**](/guide/validation/manage-artifact-types.qmd){target="_blank"} this workflow applies to. +ii. Select the [**Artifact Type**](/guide/validation/manage-artifact-types.qmd){target="_blank"} this workflow applies to. -iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: +iii. Under **Workflow Start**, select when the workflow should be initiated: - **Manually** — Start this workflow manually. - **On Artifact Registration** — Start this workflow when an artifact is logged on a record. -iv. Select the **[artifact type]{.smallcaps}** +iv. Select the **Artifact Type** -v. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. +v. Under **Workflow Expected Duration**, define the SLA for the workflow based on the start date in days, weeks, months, or years. vi. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. diff --git a/site/guide/workflows/_add-record-stages.qmd b/site/guide/workflows/_add-record-stages.qmd index 6b10420484..3835640606 100644 --- a/site/guide/workflows/_add-record-stages.qmd +++ b/site/guide/workflows/_add-record-stages.qmd @@ -11,7 +11,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Click **{{< fa plus >}} Add Stage**. -1. Provide a stage **[name]{.smallcaps}** and a stage **[description]{.smallcaps}**, then assign a **[color]{.smallcaps}** to the stage. +1. Provide a stage **Name** and a stage **Description**, then assign a **Color** to the stage. 1. When you are done, click **Save** to apply your changes. @@ -27,7 +27,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Click **{{< fa plus >}} Add Stage**. -1. Provide a stage **[name]{.smallcaps}** and a stage **[description]{.smallcaps}**, then assign a **[color]{.smallcaps}** to the stage. +1. Provide a stage **Name** and a stage **Description**, then assign a **Color** to the stage. 1. When you are done, click **Save** to apply your changes. diff --git a/site/guide/workflows/_conditional-requirements.qmd b/site/guide/workflows/_conditional-requirements.qmd index 73e8597962..609183e810 100644 --- a/site/guide/workflows/_conditional-requirements.qmd +++ b/site/guide/workflows/_conditional-requirements.qmd @@ -8,7 +8,7 @@ Conditional requirements are required or optional for the following step types:^ ### {{< fa cube >}} Inventory Record Stage Change [optional]{.smallercaps .pink} -1. Under **[when these conditions are met]{.smallcaps}**, set your `AND` and `OR` conditions. +1. Under **When These Conditions Are Met**, set your `AND` and `OR` conditions. 2. Add a single independent rule or a linked condition group. These rules and groups can be nested if desired: - Click **{{< fa plus >}} Add Rule** to add an independent rule. @@ -17,7 +17,7 @@ Conditional requirements are required or optional for the following step types:^ ### {{< fa tag >}} Artifact Status Change -1. Under **[when these conditions are met]{.smallcaps}**, set your `AND` and `OR` conditions. +1. Under **When These Conditions Are Met**, set your `AND` and `OR` conditions. 2. Add a single independent rule or a linked condition group. These rules and groups can be nested if desired: - Click **{{< fa plus >}} Add Rule** to add an independent rule. @@ -30,7 +30,7 @@ Conditional requirements are required or optional for the following step types:^ #### User display rules -1. Under **[display action button when]{.smallcaps}**, set your `AND` and `OR` conditions. +1. Under **Display Action Button When**, set your `AND` and `OR` conditions. 2. Add a single independent rule or a linked condition group. These rules and groups can be nested if desired: @@ -39,26 +39,26 @@ Conditional requirements are required or optional for the following step types:^ #### Request record or artifact fields -- Select any **[requested fields]{.smallcaps}**[^request-fields] to be entered by users during the action. +- Select any **Requested Fields**[^request-fields] to be entered by users during the action. **Toggle Optional** to ON if the field should be optional and not required. - (Optional) Present these requested fields to users in steps: i. Click **{{< fa plus >}} Add Step** to add a step. - ii. On the Add Step modal that appears, enter the step **[title]{.smallcaps}** and provide an optional **[description]{.smallcaps}**. + ii. On the Add Step modal that appears, enter the step **Title** and provide an optional **Description**. iii. Click **Save** to insert the step. iv. Drag request fields into a step to add them to that step. #### Enable user action deadline -1. Toggle **Enable deadline** on to configure a **[user action deadline]{.smallcaps}** for when users should complete this action by. +1. Toggle **Enable deadline** on to configure a **User Action Deadline** for when users should complete this action by. -2. Then, under **[end action]{.smallcaps}**, select the type of deadline: - - **After Time Interval** — Set the **[amount]{.smallcaps}** and **[unit]{.smallcaps}** of the deadline. - - **At Specified Date** — Set the date and time the action should [wait until]{.smallcaps}. - - **At Specified Date on Custom Field** — Select a date, date time, or calculated **[record field]{.smallcaps}** that defines the deadline. - - **Time Delta from Specified Date on Custom Field** — Select a date, date time, or calculated **[record field]{.smallcaps}** to calculate a deadline from, then set a **[time delta direction]{.smallcaps}** and **[wait duration]{.smallcaps}**. +2. Then, under **End Action**, select the type of deadline: + - **After Time Interval** — Set the **Amount** and **Unit** of the deadline. + - **At Specified Date** — Set the date and time the action should **Wait Until**. + - **At Specified Date on Custom Field** — Select a date, date time, or calculated **Record Field** that defines the deadline. + - **Time Delta from Specified Date on Custom Field** — Select a date, date time, or calculated **Record Field** to calculate a deadline from, then set a **Time Delta Direction** and **Wait Duration**. ::: @@ -67,7 +67,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)] **Inventory Record Stakeholder Types**,^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] or **Inventory Record Fields — User**:^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] +1. Under **Approval Group**, click **{{< fa plus >}} Add Individual Approver** to set an individual approver selected from **User Roles**,^[[Manage roles](/guide/configuration/manage-roles.qmd)] **Inventory Record Stakeholder Types**,^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] or **Inventory Record Fields — User**:^[[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. @@ -79,9 +79,9 @@ Conditional requirements are required or optional for the following step types:^ If you've set multiple individual approvers, select whether they are `AND` or `OR` conditions. -3. Select the **[fields to review]{.smallcaps}** shown to your [approval group]{.smallcaps}s as read-only fields. +3. Select the **Fields to Review** shown to your **Approval Group**s as read-only fields. - + ### {{< fa bullhorn >}} Broadcast [required]{.smallercaps .pink} @@ -91,7 +91,7 @@ Select from either **Inventory Record Stakeholder Types**^[[Manage record stakeh ### {{< fa maximize >}} Condition Branch [required]{.smallercaps .pink} -1. Under each branch's **[conditions]{.smallcaps}**, set your `AND` and `OR` conditions. +1. Under each branch's **Conditions**, set your `AND` and `OR` conditions. 2. Add a single independent rule or a linked condition group. These rules and groups can be nested if desired: - Click **{{< fa plus >}} Add Rule** to add an independent rule. @@ -100,29 +100,29 @@ Select from either **Inventory Record Stakeholder Types**^[[Manage record stakeh ### {{< fa clock >}} Wait [required]{.smallercaps .pink} -Select when you would like to [resume workflow]{.smallcaps}: +Select when you would like to **Resume Workflow**: ::: {.panel-tabset} #### **After Time Interval** -Set the **[wait duration]{.smallcaps}** in minutes, hours, or days. +Set the **Wait Duration** in minutes, hours, or days. #### At Specified Date -Set a time to **[wait until]{.smallcaps}** as defined by a specific timestamp. +Set a time to **Wait Until** as defined by a specific timestamp. #### At Specified Date on Custom Field -Set the **[record field]{.smallcaps}**^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] with a valid `Date` or `Date Time` type record field that defines the specific timestamp on a per record basis. +Set the **Record Field**^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] with a valid `Date` or `Date Time` type record field that defines the specific timestamp on a per record basis. #### Time Delta from Specified Date on Custom Field -a. Set the **[record field]{.smallcaps}**^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] to a valid `Date` or `Date Time` type record field that defines the specific timestamp on a per record basis. +a. Set the **Record Field**^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] to a valid `Date` or `Date Time` type record field that defines the specific timestamp on a per record basis. -b. Select a **[time delta direction]{.smallcaps}** relative to your selected field. +b. Select a **Time Delta Direction** relative to your selected field. -c. Enter a **[wait duration]{.smallcaps}** in minutes, hours, days, or months for the delta. +c. Enter a **Wait Duration** in minutes, hours, days, or months for the delta. ::: @@ -134,7 +134,7 @@ c. Enter a **[wait duration]{.smallcaps}** in minutes, hours, days, or months fo #### Request timeout -- Enter a request timeout in seconds under **[timeout (seconds)]{.smallcaps}**. +- Enter a request timeout in seconds under **Timeout (seconds)**. - Max 300 seconds, or enter `0` to disable timeout. @@ -142,19 +142,21 @@ c. Enter a **[wait duration]{.smallcaps}** in minutes, hours, days, or months fo Toggle the following request options on or off: -- **[fail on non-]{.smallcaps}[2]{.smallercaps}[xx]{.smallcaps}** — Whether or not the request will be considered failed if the response status code is not in the `2xx` range. +- **Fail on Non-2xx** — Whether or not the request will be considered failed if the response status code is not in the `2xx` range. -- **[allow invalid certificates]{.smallcaps}** — Whether or not the request will be allowed to use invalid certificates. +- **Allow Invalid Certificates** — Whether or not the request will be allowed to use invalid certificates. -- **[follow redirects]{.smallcaps}** — Whether or not the request will follow redirects. +- **Follow Redirects** — Whether or not the request will follow redirects. -- **[require https]{.smallcaps}** — Whether or not the request will require HTTPS. +- **Require HTTPS** — Whether or not the request will require HTTPS. + +- **Save Response to Context** — Store the response so downstream nodes can reference it. #### Request headers Enter optional headers to include with your request: -1. Click **{{< fa plus >}} Add Header** under [headers]{.smallcaps} to enter a header. +1. Click **{{< fa plus >}} Add Header** under **Headers** to enter a header. 2. Provide a **Header Name** and **Header Value**. diff --git a/site/guide/workflows/_configure-workflow-steps.qmd b/site/guide/workflows/_configure-workflow-steps.qmd index 919c8d5484..fdd273e1da 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 {record-type} record for payload]{.smallcaps}, choose a record from [your inventory](/guide/inventory/working-with-the-inventory.qmd) to populate the target for the payload. + 2. Under **Select Target {record-type} Record for Payload**, choose a record 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 3ebf2cf1d1..362d9e4d11 100644 --- a/site/guide/workflows/_initiate-workflows.qmd +++ b/site/guide/workflows/_initiate-workflows.qmd @@ -21,7 +21,7 @@ To initiate workflows manually:[^initiate-workflows] 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. -1. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you'd like to initiate, then select your desired **[workflow start]{.smallcaps}** option: +1. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you'd like to initiate, then select your desired **Workflow Start** option: - **Run Now** — Workflow starts instantly. - **Scheduled Run** — Set a future date to run the workflow. @@ -34,7 +34,7 @@ To initiate workflows manually:[^initiate-workflows] 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. -1. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you'd like to initiate, then select your desired **[workflow start]{.smallcaps}** option: +1. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you'd like to initiate, then select your desired **Workflow Start** option: - **Run Now** — Workflow starts instantly. - **Scheduled Run** — Set a future date to run the workflow. @@ -70,7 +70,7 @@ To initiate workflows manually: 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. -1. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you'd like to initiate, then select your desired **[workflow start]{.smallcaps}** option: +1. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you'd like to initiate, then select your desired **Workflow Start** option: - **Run Now** — Workflow starts instantly. - **Scheduled Run** — Set a future date to run the workflow. @@ -83,7 +83,7 @@ To initiate workflows manually: 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. -1. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you'd like to initiate, then select your desired **[workflow start]{.smallcaps}** option: +1. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you'd like to initiate, then select your desired **Workflow Start** option: - **Run Now** — Workflow starts instantly. - **Scheduled Run** — Set a future date to run the workflow. diff --git a/site/guide/workflows/_link-workflow-together.qmd b/site/guide/workflows/_link-workflow-together.qmd index 07f417b302..94c3c741d8 100644 --- a/site/guide/workflows/_link-workflow-together.qmd +++ b/site/guide/workflows/_link-workflow-together.qmd @@ -35,8 +35,8 @@ i. First, configure an **{{< fa users >}} Approval** step. ii. Then, drag two **{{< fa cube >}} Inventory Record Stage Change** steps onto the canvas: - - Assign a stage associated with rejection to one in the **[set inventory record stage to]{.smallcaps}** field. - - Assign a stage associated with approval to the other in the **[set inventory record stage to]{.smallcaps}** field. + - Assign a stage associated with rejection to one in the **Set Inventory Record Stage To** field. + - Assign a stage associated with approval to the other in the **Set Inventory Record Stage To** field. iii. Then, from the bottom of your **{{< fa users >}} Approval** step: diff --git a/site/guide/workflows/_publish-workflows.qmd b/site/guide/workflows/_publish-workflows.qmd index 8a7c98416f..77e95200f3 100644 --- a/site/guide/workflows/_publish-workflows.qmd +++ b/site/guide/workflows/_publish-workflows.qmd @@ -18,7 +18,7 @@ b. Under {{< fa shield >}} Governance, select **Workflows**. c. Hover over the workflow you want to publish. -d. Under the [actions]{.smallcaps} column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. +d. Under the **Actions** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. e. Click **Yes, Publish** to confirm the publication of the workflow. diff --git a/site/guide/workflows/_reset-workflows.qmd b/site/guide/workflows/_reset-workflows.qmd index 8b37a9edf5..13123e68e9 100644 --- a/site/guide/workflows/_reset-workflows.qmd +++ b/site/guide/workflows/_reset-workflows.qmd @@ -17,23 +17,23 @@ To reset a workflow to the beginning: 1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the **Active Workflows** section. 1. Click on the name of the workflow you'd like to reset to open that specific workflow's details. 1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -1. On the confirmation page, toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. +1. On the confirmation page, toggle **Restart Workflow After Aborting** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the **Active Workflows** section. 1. Click on the name of the workflow you'd like to reset to open that specific workflow's details. 1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -1. On the confirmation page, toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. +1. On the confirmation page, toggle **Restart Workflow After Aborting** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. ::: @@ -51,22 +51,22 @@ To reset a workflow to the beginning: 1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the **Active Workflows** section. 1. Click on the name of the workflow you'd like to reset to open that specific workflow's details. 1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -1. On the confirmation page, toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. +1. On the confirmation page, toggle **Restart Workflow After Aborting** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. #### On artifacts -1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the **Active Workflows** section. 1. Click on the name of the workflow you'd like to reset to open that specific workflow's details. 1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -1. On the confirmation page, toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. +1. On the confirmation page, toggle **Restart Workflow After Aborting** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. :::: \ No newline at end of file diff --git a/site/guide/workflows/_review-active-workflows.qmd b/site/guide/workflows/_review-active-workflows.qmd index 5617b67f7d..f422e8c600 100644 --- a/site/guide/workflows/_review-active-workflows.qmd +++ b/site/guide/workflows/_review-active-workflows.qmd @@ -15,7 +15,7 @@ To review details for workflows currently active: 1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the **Active Workflows** section. 1. Click on the name of any active workflow to review that specific workflow's details. @@ -28,7 +28,7 @@ To review details for workflows currently active: #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the **Active Workflows** section. 1. Click on the name of any active workflow to review that specific workflow's details. @@ -61,7 +61,7 @@ To review details for workflows currently active on records: 1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the **Active Workflows** section. 1. Click on the name of any active workflow to review that specific workflow's details. @@ -84,7 +84,7 @@ To review details for workflows currently active: 1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the **Active Workflows** section. 1. Click on the name of any active workflow to review that specific workflow's details. @@ -97,7 +97,7 @@ To review details for workflows currently active: #### On artifacts -1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the **Active Workflows** section. 1. Click on the name of any active workflow to review that specific workflow's details. diff --git a/site/guide/workflows/_transition-workflows.qmd b/site/guide/workflows/_transition-workflows.qmd index a94ba254d3..fcc6731157 100644 --- a/site/guide/workflows/_transition-workflows.qmd +++ b/site/guide/workflows/_transition-workflows.qmd @@ -19,24 +19,24 @@ To transition a workflow into next steps: 1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. +1. On the landing page of your record, locate the **Active Workflows** 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 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] + - Enter your **Notes** 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. #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the **Active Workflows** section. 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 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] + - Enter your **Notes** 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 record activity: [View record activity](/guide/inventory/view-record-activity.qmd) + - Working copies are tracked under record activity: [View record activity](/guide/reporting/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. @@ -60,12 +60,12 @@ To transition a workflow into next steps on records: 1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. +1. On the landing page of your record, locate the **Active Workflows** 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 then click **{action}** where `action` is the name of your custom user action. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**. + - Enter your **Notes** and/or any other additional inventory fields then click **{action}** where `action` is the name of your custom user action. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**. 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. @@ -82,24 +82,24 @@ To transition a workflow into next steps: 1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. +1. On the landing page of your record, locate the **Active Workflows** 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 then click **{action}** where `action` is the name of your custom user action. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**. + - Enter your **Notes** and/or any other additional inventory fields then click **{action}** where `action` is the name of your custom user action. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**. 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. #### On artifacts -1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the **Active Workflows** section. 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 then click **{action}** where `action` is the name of your custom user action. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**. + - Enter your **Notes** and/or any other additional inventory fields then click **{action}** where `action` is the name of your custom user action. To save a working copy of the entered information without transitioning the workflow into its next state, click **Save**. 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. diff --git a/site/guide/workflows/_view-workflow-executions.qmd b/site/guide/workflows/_view-workflow-executions.qmd index bb7381c58d..5427293dac 100644 --- a/site/guide/workflows/_view-workflow-executions.qmd +++ b/site/guide/workflows/_view-workflow-executions.qmd @@ -7,10 +7,10 @@ Monitor every workflow execution across your organization on a single timeline:^ 1. In the left sidebar, click **{{< fa arrow-right-arrow-left >}} Workflows**. -2. Under the [record type]{.smallcaps} drop-down, select the type of record you want to view all workflow executions for:^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] +2. Under the **Inventory Record Type** drop-down, select the type of record you want to view all workflow executions for:^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] - In the left column, workflows are grouped by inventory record. - - Workflows past their [expected end date]{.smallcaps} are color-coded in [red]{.red}.^[[Manage workflows](/guide/workflows/manage-workflows.qmd#edit-workflow-end-dates)] + - Workflows past their **Expected End Date** are color-coded in [red]{.red}.^[[Manage workflows](/guide/workflows/manage-workflows.qmd#edit-workflow-end-dates)] - Use the buttons or keyboard shortcuts[^timeline-shortcuts-all] to control the timeline: - **{{< fa magnifying-glass-plus >}}** — Zoom in - **{{< fa magnifying-glass-minus >}}** — Zoom out @@ -74,10 +74,10 @@ Monitor every workflow execution across your organization on a single timeline: 1. In the left sidebar, click **{{< fa arrow-right-arrow-left >}} Workflows**. -2. Under the [record type]{.smallcaps} drop-down, select the type of record you want to view all workflow executions for: +2. Under the **Inventory Record Type** drop-down, select the type of record you want to view all workflow executions for: - In the left column, workflows are grouped by inventory record. - - Workflows past their [expected end date]{.smallcaps} are color-coded in [red]{.red}. + - Workflows past their **Expected End Date** are color-coded in [red]{.red}. ::: {.panel-tabset} diff --git a/site/guide/workflows/_workflow-states.qmd b/site/guide/workflows/_workflow-states.qmd index 1604c17eaf..33956a2226 100644 --- a/site/guide/workflows/_workflow-states.qmd +++ b/site/guide/workflows/_workflow-states.qmd @@ -20,7 +20,7 @@ Add workflow states either while configuring a **{{< fa wifi >}} Workflow State 1. Click **{{< fa plus >}} Add Workflow State**. -1. Enter a **[name]{.smallcaps}** and a **[description]{.smallcaps}**, then select a **[color]{.smallcaps}** for your workflow state. +1. Enter a **Name** and a **Description**, then select a **Color** for your workflow state. 1. Click **Save** to create the workflow state. @@ -37,11 +37,11 @@ Add workflow states either while configuring a **{{< fa wifi >}} Workflow State 1. Click on the workflow you'd like to edit the states for. -1. Hover over the workflow state you want to edit until the **{{< fa ellipsis-vertical >}}** appears, then click on it. +1. Hover over the workflow state you want to edit until the **{{< fa ellipsis-vertical >}}** menu appears, then click on it. 1. Select **{{< fa pencil >}} Edit Details**. -1. Make your changes to the **[name]{.smallcaps}**, **[description]{.smallcaps}**, and **[color]{.smallcaps}** for your workflow state. +1. Make your changes to the **Name**, **Description**, and **Color** for your workflow state. 1. Click **Save** to apply your changes. @@ -62,7 +62,7 @@ If a state is or was previously in use on a workflow within a {{< fa wifi >}} W 1. Click on the workflow you'd like to delete workflow states for. -1. Hover over the workflow state you want to delete until the **{{< fa ellipsis-vertical >}}** appears, then click on it. +1. Hover over the workflow state you want to delete until the **{{< fa ellipsis-vertical >}}** menu appears, then click on it. 1. Select [**{{< fa trash-can >}} Delete Workflow State**]{.red}. diff --git a/site/guide/workflows/_workflow-step-types.qmd b/site/guide/workflows/_workflow-step-types.qmd index 17ea416006..abd92165b7 100644 --- a/site/guide/workflows/_workflow-step-types.qmd +++ b/site/guide/workflows/_workflow-step-types.qmd @@ -12,8 +12,8 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> | Field | Description | |---:|---| -| [when these conditions are met]{.smallcaps} (optional) | Add conditional requirements to qualify for this step.^[ [Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#record-stage-change)] | -| [set inventory record stage to]{.smallcaps} | Select the record stage to transition to. | +| **When These Conditions Are Met** (optional) | Add conditional requirements to qualify for this step.^[ [Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#record-stage-change)] | +| **Set Inventory Record Stage To** | Select the record stage to transition to. | : **{{< fa cube >}} Inventory Record Stage Change** step configuration {.hover tbl-colwidths="[40,60]"} ### {{< fa tag >}} Artifact Status Change @@ -24,8 +24,8 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> | Field | Description | |---:|---| -| [when these conditions are met]{.smallcaps} (optional) | Add conditional requirements to qualify for this step.^[ [Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#artifact-status-change)] | -| [set artifact status to]{.smallcaps} | Select the artifact type status to transition to. | +| **When These Conditions Are Met** (optional) | Add conditional requirements to qualify for this step.^[ [Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#artifact-status-change)] | +| **Set Artifact Status To** | Select the artifact type status to transition to. | : **{{< fa tag >}} Artifact Status Change** step configuration {.hover tbl-colwidths="[40,60]"} ### {{< fa wifi >}} Workflow State Change @@ -35,10 +35,21 @@ Transitions the workflow into another workflow state.^[[Workflow states](/guide/ | Field | Description | |---:|---| -| [set workflow state to]{.smallcaps} | Select or add^[Click **{{< fa plus >}} Add New State** to create a new state unique to this workflow.] the workflow state to transition the workflow to. | -| [progress]{.smallcaps} | Indicate the progress of the workflow at this transition into the next state. | +| **Set Workflow State To** | Select or add^[Click **{{< fa plus >}} Add New State** to create a new state unique to this workflow.] the workflow state to transition the workflow to. | +| **Progress** | Indicate the progress of the workflow at this transition into the next state. | : **{{< fa wifi >}} Workflow State Change** step configuration {.hover tbl-colwidths="[30,70]"} +### {{< fa pen-to-square >}} Set Field + + +Automatically sets an inventory record or artifact field value.[^set-field] + +| Field | Description | +|---:|---| +| Target Field | Select a field to update with a given value,^[From the **{field name}** drop-down, where `{field name}` is the name of the field you want to update, select the value you want to automatically set.] or check **Clear field (set to empty)** to remove the existing field value. | +| {{< fa plus >}} Set another field value | Click **{{< fa plus >}} Set another field value** to add another field to update with a given value. | +: **{{< fa pen-to-square >}} Set Field** step configuration {.hover tbl-colwidths="[30,70]"} + ### {{< fa arrow-pointer >}} User Action @@ -46,26 +57,26 @@ Creates a button that performs an action on behalf of the user. | Field | Description | |---:|---| -| [display action button when]{.smallcaps} (optional) | Add conditional requirements for displaying this step.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#user-action)] | -| [step title]{.smallcaps} (optional) | Text that displays at the top of the modal that opens when users click the action button. | -| [action button label]{.smallcaps} | Text that displays on your action button. | -| [requested fields]{.smallcaps} (optional) | Include record or artifact fields alongside your action.[^user-action] | -| [user action deadline]{.smallcaps} (optional) | Include a deadline for when users should complete this action by.^[Toggle **Enable deadline** on to configure a deadline.] | +| **Display Action Button When** (optional) | Add conditional requirements for displaying this step.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#user-action)] | +| **Step Title** (optional) | Text that displays at the top of the modal that opens when users click the action button. | +| **Action Button Label** | Text that displays on your action button. | +| **Requested Fields** (optional) | Include record or artifact fields alongside your action.[^user-action] | +| **User Action Deadline** (optional) | Include a deadline for when users should complete this action by.^[Toggle **Enable deadline** on to configure a deadline.] | : **{{< fa arrow-pointer >}} User Action** step configuration {.hover tbl-colwidths="[40,60]"} ### {{< fa users >}} Approval -Display a preconfigured message to users in the selected **[approval group]{.smallcaps}**. +Display a preconfigured message to users in the selected **Approval Group**. - Select from either **User Roles**, **Inventory Record Stakeholder Types**, or either **User Role** or **User Type** inventory field.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#approval-required)] - Must be connected to both a rejection and approval {{< fa cube >}} Inventory Record Stage Change step.[^approval-1] | Field | Description | |---:|---| -| [approval group]{.smallcaps} | Select the roles, stakeholders, or user fields responsible for approval. | -| [fields to review]{.smallcaps} (optional) | Select the record or artifact fields shown to approvers for read-only review.[^approval-2] | -| Approval Message | When your workflow reaches this {{< fa users >}} Approval step, the selected [approval group]{.smallcaps} is shown this message.^[Enter a **[title]{.smallcaps}** and a **[message]{.smallcaps}** to display.] | +| **Approval Group** | Select the roles, stakeholders, or user fields responsible for approval. | +| **Fields to Review** (optional) | Select the record or artifact fields shown to approvers for read-only review.[^approval-2] | +| Approval Message | When your workflow reaches this {{< fa users >}} Approval step, the selected **Approval Group** is shown this message.^[Enter a **Title** and a **Message** to display.] | : **{{< fa users >}} Approval** step configuration {.hover tbl-colwidths="[35,65]"} ### {{< fa bullhorn >}} Broadcast @@ -77,8 +88,8 @@ Display a preconfigured message to users in the selected **[approval group]{.sma | Field | Description | |---:|---| | Select roles | Select the **Inventory Record Stakeholder Types** or **User Roles** to receive the email. | -| [subject]{.smallcaps} | Enter the subject of the email.[^broadcast] | -| [message]{.smallcaps} | Enter the body of the email. | +| **Subject** | Enter the subject of the email.[^broadcast] | +| **Message** | Enter the body of the email. | : **{{< fa bullhorn >}} Broadcast** step configuration {.hover tbl-colwidths="[25,75]"} ### {{< fa maximize >}} Condition Branch @@ -94,7 +105,7 @@ Workflows cannot be saved until condition branches are connected to other steps. To configure a condition branch: 1. On the Configure Condition Branch modal, click **{{< fa plus >}} Add Branch**. -2. Enter the **[path name]{.smallcaps}** and designate the **[conditions]{.smallcaps}**^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#condition-branch-required)] that apply to this path. +2. Enter the **Path Name** and designate the **Conditions**^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#condition-branch-required)] that apply to this path. 3. Continue with steps 1 and 2 until your conditional branch logic is complete. To remove a path, click **{{< fa ellipsis-vertical >}}** and select **{{< fa trash-can >}} Remove Path**. @@ -113,20 +124,20 @@ Other users viewing those fields or the workflow will see the value automaticall ::: -To configure a wait step, select when you would like to [resume workflow]{.smallcaps} +To configure a wait step, select when you would like to **Resume Workflow** | Option | Required field(s) | Description | |---:|---|---| -| After Time Interval | [wait duration]{.smallcaps} | Wait for a set amount of time. Applies to all records or artifacts under the workflow. | -| At Specified Date | [wait until]{.smallcaps} | Wait until a specific timestamp. Applies to all records or artifacts under the workflow. If the milestone date inputted is in the past, the next workflow step will display immediately. | -| At Specified Date on Custom Field | [custom field]{.smallcaps}[^wait] | Wait until a specific timestamp as defined by a record or artifact field on a per record or per artifact basis. If the selected field is empty^[Make record or artifact fields required on registration to ensure necessary fields have valid values.] or the milestone date inputted is in the past, the next workflow step will display immediately. | -| Time Delta from Specified Date on Custom Field | [custom field]{.smallcaps}, [time delta direction]{.smallcaps}, [wait duration]{.smallcaps} | Wait for a calculated time relative to a date in a record or artifact field on a per record or per artifact basis. If the selected field is empty^[Make record or artifact fields required on registration to ensure necessary fields have valid values.] or the milestone date inputted is in the past, the next workflow step will display immediately. | +| After Time Interval | **Wait Duration** | Wait for a set amount of time. Applies to all records or artifacts under the workflow. | +| At Specified Date | **Wait Until** | Wait until a specific timestamp. Applies to all records or artifacts under the workflow. If the milestone date inputted is in the past, the next workflow step will display immediately. | +| At Specified Date on Custom Field | **Custom Field**[^wait] | Wait until a specific timestamp as defined by a record or artifact field on a per record or per artifact basis. If the selected field is empty^[Make record or artifact fields required on registration to ensure necessary fields have valid values.] or the milestone date inputted is in the past, the next workflow step will display immediately. | +| Time Delta from Specified Date on Custom Field | **Custom Field**, **Time Delta Direction**, **Wait Duration** | Wait for a calculated time relative to a date in a record or artifact field on a per record or per artifact basis. If the selected field is empty^[Make record or artifact fields required on registration to ensure necessary fields have valid values.] or the milestone date inputted is in the past, the next workflow step will display immediately. | : **{{< fa clock >}} Wait** step configuration {.hover tbl-colwidths="[30,15,45]"} ### {{< fa arrow-right-arrow-left >}} Run Workflow -Triggers another workflow indicated by **[select workflow to run]{.smallcaps}**, allowing you to chain workflows. +Triggers another workflow indicated by **Select Workflow To Run**, allowing you to chain workflows. ### {{< fa circle-nodes >}} Webhook @@ -143,7 +154,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 {record-type} record for payload]{.smallcaps}, choose a record from your inventory^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] to populate the target for the payload. +1. Under **Select Target {record-type} Record for Payload**, choose a record 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. @@ -166,14 +177,15 @@ Sends a HTTP request with optional additional conditions.^[[Conditional step req | Field | Description | |---:|---| -| [url]{.smallcaps} | Enter the URL to send the HTTP request to. | -| [method]{.smallcaps} | Select the HTTP request method: `GET`, `POST`, `PUT`, `DELETE`[^request-types] | -| [timeout (seconds)]{.smallcaps} | Enter a request timeout in seconds.[^request-timeout] | -| [fail on non-]{.smallcaps}[2]{.smallercaps}[xx]{.smallcaps} (optional) | Toggle whether or not the request will be considered failed if the response status code is not in the `2xx` range. | -| [allow invalid certificates]{.smallcaps} (optional) | Toggle whether or not the request will be allowed to use invalid certificates. | -| [follow redirects]{.smallcaps} (optional) | Toggle whether or not the request will follow redirects. | -| [require https]{.smallcaps} (optional) | Toggle whether or not the request will require HTTPS. | -| [headers]{.smallcaps} (optional) | Include headers with your request.[^request-headers] | +| **URL** | Enter the URL to send the HTTP request to. | +| **Method** | Select the HTTP request method: `GET`, `POST`, `PUT`, `DELETE`[^request-types] | +| **Timeout (seconds)** | Enter a request timeout in seconds.[^request-timeout] | +| **Fail on Non-2xx** (optional) | Toggle whether or not the request will be considered failed if the response status code is not in the `2xx` range. | +| **Allow Invalid Certificates** (optional) | Toggle whether or not the request will be allowed to use invalid certificates. | +| **Follow Redirects** (optional) | Toggle whether or not the request will follow redirects. | +| **Require Https** (optional) | Toggle whether or not the request will require HTTPS. | +| **Save Response to Context** (optional) | Store the response so downstream nodes can reference it. | +| **Headers** (optional) | Include headers with your request.[^request-headers] | : **{{< fa cloud-arrow-up >}} HTTP Request** step configuration {.hover tbl-colwidths="[30,70]"} @@ -185,9 +197,14 @@ Sends a HTTP request with optional additional conditions.^[[Conditional step req +[^set-field]: + + - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) + - [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) + [^user-action]: - Select a field from the the drop-down to add it to your User Action step — click **Add all** to add all fields in that group. Users must have write permissions for the field in order to enter values. + Select a field from the drop-down to add it to your User Action step — click **Add All** to add all fields in that group. Users must have write permissions for the field in order to enter values.

    - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) @@ -205,10 +222,10 @@ Sends a HTTP request with optional additional conditions.^[[Conditional step req - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) - [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) -[^broadcast]: Use the rich text editor to compose your **[subject]{.smallcaps}** and **[message]{.smallcaps}**: +[^broadcast]: Use the rich text editor to compose your **Subject** and **Message**: 1. Include optional details about the record or artifact the workflow is running on using the **{ } Insert Variable** drop-down. - 2. Click on the **Preview** tab and choose a record or artifact under **[select {inventory record/artifact} for preview]{.smallcaps}** to confirm how the notification will appear when rendered. + 2. Click on the **Preview** tab and choose a record or artifact under **Select {inventory record/artifact} for Preview** to confirm how the notification will appear when rendered. [^wait]: @@ -217,8 +234,8 @@ Sends a HTTP request with optional additional conditions.^[[Conditional step req [^request-types]: `PUT` and `POST` requests have additional configuration fields: - - **[body type]{.smallcaps}** — Select whether the body is `JSON` or `Text`. - - **[body]{.smallcaps}** — Enter your payload. + - **Body Type** — Select whether the body is `JSON` or `Text`. + - **Body** — Enter your payload. [^request-timeout]: Max 300 seconds, or enter `0` to disable timeout. @@ -229,13 +246,9 @@ Sends a HTTP request with optional additional conditions.^[[Conditional step req To avoid storing credentials in plaintext, use webhook secrets: enter `{{secret:name}}` as the header value. At runtime, the workflow engine replaces the placeholder with the stored secret value. See [Manage secrets](/guide/integrations/manage-secrets.qmd#webhook-secrets). - - :::: - - :::: {.content-hidden unless-format="revealjs"} #### {{< fa cube >}} Inventory Record Stage Change @@ -250,13 +263,17 @@ Transitions an artifact into another status. Transitions the workflow into another workflow state. +#### {{< fa pen-to-square >}} Set Field + +Automatically sets an inventory record or artifact field value + #### {{< fa arrow-pointer >}} User Action Creates a button that performs an action on behalf of the user. #### {{< fa users >}} Approval -Display a preconfigured message users in the selected **[approval group]{.smallcaps}**. +Display a preconfigured message users in the selected **Approval Group**. #### {{< fa bullhorn >}} Broadcast @@ -272,7 +289,7 @@ Creates a time condition for displaying next available action. #### {{< fa arrow-right-arrow-left >}} Run Workflow -Triggers another workflow indicated by **[select workflow to run]{.smallcaps}**, allowing you to chain workflows. +Triggers another workflow indicated by **Select Workflow To Run**, allowing you to chain workflows. #### {{< fa circle-nodes >}} Webhook diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index 6ef4eb217b..fbf439396d 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -65,9 +65,9 @@ To create a copy of an existing workflow as a new draft workflow:[^3] 2. Hover over the workflow you'd like to clone.[^4] -3. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa copy >}} Clone Workflow**. +3. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa copy >}} Clone Workflow**. -4. Make your changes to the workflow's **[title]{.smallcaps}** and **[workflow type]{.smallcaps}**. +4. Make your changes to the workflow's **Title** and **Workflow Type**. Additional changes can be made to the cloned workflow after cloning by editing. @@ -100,7 +100,7 @@ You can edit a workflow in several ways: 2. Select a record or find your record by applying a filter or searching for it.[^7] -3. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +3. On the landing page of your record, locate the **Active Workflows** section. 4. Click on the name of the workflow you'd like to edit to open that specific workflow's details. @@ -108,7 +108,7 @@ You can edit a workflow in several ways: #### Via workflows applied to artifacts -1. On the details page of your artifact,[^8] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,[^8] locate the **Active Workflows** section. 2. Click on the name of the workflow you'd like to edit to open that specific workflow's details. @@ -120,7 +120,7 @@ a. Make your desired changes to step configuration[^9] and step relationships[^1 b. When you are finished, click **Save New Version** to apply your changes. -c. Enter your **[version notes]{.smallcaps}** to describe your changes. +c. Enter your **Version Notes** to describe your changes. ### Delete workflow steps @@ -160,14 +160,14 @@ Deleting workflow steps on workflows active on records may result in malfunction 3. Hover over the workflow you would like to remove.[^11] -4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa trash-can >}} Delete Workflow**. +4. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa trash-can >}} Delete Workflow**. 5. Click **Yes, Delete Workflow** to permanently remove that workflow and make it inaccessible for any future runs. -## What's next +## Learn more - [Workflows FAQ](/faq/faq-workflows.qmd) -- [Work with workflows](working-with-workflows.qmd) +- [Working with workflows](working-with-workflows.qmd) @@ -176,7 +176,7 @@ Deleting workflow steps on workflows active on records may result in malfunction [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^3]: If a cloned workflow's [workflow start]{.smallcaps} trigger conflicts with an existing workflow, the cloned workflow will be set to manual initiation instead. +[^3]: If a cloned workflow's **Workflow Start** trigger conflicts with an existing workflow, the cloned workflow will be set to manual initiation instead. [^4]: [Setting up workflows](setting-up-workflows.qmd#view-sort-and-filter-workflows) diff --git a/site/guide/workflows/introduction-to-workflows.qmd b/site/guide/workflows/introduction-to-workflows.qmd index a233b9b39e..2b69586fd6 100644 --- a/site/guide/workflows/introduction-to-workflows.qmd +++ b/site/guide/workflows/introduction-to-workflows.qmd @@ -30,8 +30,8 @@ A workflow is comprised of an interplay of these elements: ## What's next +- [Workflows and lifecycles FAQ](/faq/faq-workflows.qmd) - [Setting up workflows](setting-up-workflows.qmd) -- [Working with workflows](working-with-workflows.qmd) diff --git a/site/guide/workflows/manage-record-stages.qmd b/site/guide/workflows/manage-record-stages.qmd index ce49222348..3ca76a1bc9 100644 --- a/site/guide/workflows/manage-record-stages.qmd +++ b/site/guide/workflows/manage-record-stages.qmd @@ -36,7 +36,7 @@ aliases: 4. Hover over the stage you'd like to modify. -5. When the **{{< fa ellipsis-vertical >}}** appears, click on it: +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it: - Select **{{< fa pencil >}} Edit Details** to modify that stage. - Select **{{< fa trash-can >}} Delete Stage**. On the confirmation dialogue that appears, select **OK** to confirm deletion. diff --git a/site/guide/workflows/manage-workflow-tasks.qmd b/site/guide/workflows/manage-workflow-tasks.qmd index 8be6552401..df1ada1035 100644 --- a/site/guide/workflows/manage-workflow-tasks.qmd +++ b/site/guide/workflows/manage-workflow-tasks.qmd @@ -55,7 +55,7 @@ To view the details of a record or artifact attached to a workflow task, click t If an action is available to your role,[^10] you'll see it appear as an action button under a workflow task: - 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 any other additional inventory fields[^11] then click **Submit**. +- Enter your **Notes** and any other additional inventory fields[^11] then click **Submit**. Once completed, tasks will be removed from your view. diff --git a/site/guide/workflows/manage-workflows.qmd b/site/guide/workflows/manage-workflows.qmd index e4cde3c1c9..ed9cf779af 100644 --- a/site/guide/workflows/manage-workflows.qmd +++ b/site/guide/workflows/manage-workflows.qmd @@ -48,7 +48,7 @@ To manually resume a workflow in a {{< fa clock >}} Wait state:[^5] 1. Select a record or find your record by applying a filter or searching for it.[^6] -1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the **Active Workflows** section. 1. For the workflow you'd like to manually advance, click **{{< fa arrow-right-arrow-left >}} Resume Workflow** to open up the workflow's step overview. @@ -56,7 +56,7 @@ To manually resume a workflow in a {{< fa clock >}} Wait state:[^5] #### On artifacts -1. On the details page of your artifact,[^7] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,[^7] locate the **Active Workflows** section. 1. For the workflow you'd like to manually advance, click **{{< fa arrow-right-arrow-left >}} Resume Workflow** to open up the workflow's step overview. @@ -91,25 +91,25 @@ To adjust the expected end date for a workflow: 2. Select a record or find your record by applying a filter or searching for it.[^11] -3. On the landing page of your record, locate the [active workflows]{.smallcaps} section. +3. On the landing page of your record, locate the **Active Workflows** section. 4. Click on the name of the workflow you'd like to edit the end date for to open that specific workflow's details. 5. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa calendar >}} Edit Expected End Date**. -6. Enter the new [expected end date]{.smallcaps} for the workflow. +6. Enter the new **Expected End Date** for the workflow. 7. Click **Save Expected End Date** to apply the new date. #### On artifacts -1. On the details page of your artifact,[^12] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,[^12] locate the **Active Workflows** section. 2. Click on the name of the workflow you'd like to edit the end date for to open that specific workflow's details. 3. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa calendar >}} Edit Expected End Date**. -4. Enter the new [expected end date]{.smallcaps} for the workflow. +4. Enter the new **Expected End Date** for the workflow. 5. Click **Save Expected End Date** to apply the new date. diff --git a/site/guide/workflows/setting-up-workflows.qmd b/site/guide/workflows/setting-up-workflows.qmd index 6b5d25cdc4..9a567a45d2 100644 --- a/site/guide/workflows/setting-up-workflows.qmd +++ b/site/guide/workflows/setting-up-workflows.qmd @@ -71,4 +71,6 @@ Click **{{< fa filter >}} Filter** to filter for workflows using different [work ## What's next +- [Workflows and lifecycles FAQ](/faq/faq-workflows.qmd) - [Working with workflows](working-with-workflows.qmd) + diff --git a/site/guide/workflows/workflow-configuration-examples.qmd b/site/guide/workflows/workflow-configuration-examples.qmd index 770d0c5128..7dcf7a8ee9 100644 --- a/site/guide/workflows/workflow-configuration-examples.qmd +++ b/site/guide/workflows/workflow-configuration-examples.qmd @@ -42,7 +42,7 @@ This workflow is initiated manually[^4] — in this case via {{< fa arrow-right- ### On deployment -This workflow is initiated when a field is populated — in this case, when the model is slated for deployment by entering value into the [deployment scheduled]{.smallcaps} date time field.[^8] +This workflow is initiated when a field is populated — in this case, when the model is slated for deployment by entering value into the **Deployment Scheduled** date time field.[^8] - The workflow will wait until the timestamp indicated in the scheduled deployment date before revealing the next available action in the workflow — in this case, the option to deploy the model and enter a concrete date the model was initially pushed to production. - After a model is deployed via this workflow, an email notification is sent to users notifying them of the completed implementation. @@ -107,7 +107,7 @@ In this example, the workflow transitions into a state[^13] called [Model In Dev #### {{< fa arrow-pointer >}} User Action -In this example, the user is presented with an action button labelled **{{< fa arrow-right >}} Submit Documentation For Review** that requires them to include a model export in a [model export]{.smallcaps} attachment type field, then input the date the model was **Submitted for Initial Validation On**.[^14] +In this example, the user is presented with an action button labelled **{{< fa arrow-right >}} Submit Documentation For Review** that requires them to include a model export in a **Model Export** attachment type field, then input the date the model was **Submitted for Initial Validation On**.[^14] :::: {.flex .flex-wrap .justify-around} @@ -139,7 +139,7 @@ In this example, the user is presented with an action button labelled **{{< fa a #### {{< fa users >}} Approval -In this example, the [peer reviewers]{.smallcaps} inventory record stakeholders[^15] assigned to the model are presented with an approval message and a `Data Sources` field to review: +In this example, the **Peer Reviewers** inventory record stakeholders[^15] assigned to the model are presented with an approval message and a `Data Sources` field to review: :::: {.flex .flex-wrap .justify-around} @@ -183,7 +183,7 @@ In this example, the [Customer Admin]{.bubble} user role[^16] is sent an email n #### {{< fa maximize >}} Condition Branch -In this example, models where the field [genai model]{.smallcaps} is set to true undergo a special [legal review]{.smallcaps} inventory record stakeholder[^17] approval process:[^18] +In this example, models where the field **Genai Model** is set to true undergo a special **Legal Review** inventory record stakeholder[^17] approval process:[^18] :::: {.flex .flex-wrap .justify-around} @@ -203,7 +203,7 @@ In this example, models where the field [genai model]{.smallcaps} is set to true #### {{< fa clock >}} Wait -In this example, the next step on the workflow waits until the timestamp indicated in a [deployment scheduled]{.smallcaps} date time field:[^19] +In this example, the next step on the workflow waits until the timestamp indicated in a **Deployment Scheduled** date time field:[^19] :::: {.flex .flex-wrap .justify-around} diff --git a/site/guide/workflows/working-with-workflows.qmd b/site/guide/workflows/working-with-workflows.qmd index b98a909e97..1a1d8e682a 100644 --- a/site/guide/workflows/working-with-workflows.qmd +++ b/site/guide/workflows/working-with-workflows.qmd @@ -45,11 +45,11 @@ Save searches and filters applied to the workflow timeline as a view to reapply #### Manage personal timeline views -{{< include /guide/shared/manage-views/_personal-views.qmd >}} +{{< include /guide/shared/manage-views/_personal-table-views.qmd >}} #### Manage organization timeline views -{{< include /guide/shared/manage-views/_organization-views.qmd >}} +{{< include /guide/shared/manage-views/_organization-table-views.qmd >}} ## Work with workflows @@ -57,6 +57,11 @@ Save searches and filters applied to the workflow timeline as a view to reapply :::{#workflows} ::: +## What's next + +- [Workflows and lifecycles FAQ](/faq/faq-workflows.qmd) +- [Tracking organization activity](/guide/reporting/tracking-organization-activity.qmd) + diff --git a/site/index.qmd b/site/index.qmd index 711d89c7f1..b01cbe7a87 100644 --- a/site/index.qmd +++ b/site/index.qmd @@ -339,6 +339,17 @@ td { vertical-align: top; } +.academy-features-row { + display: grid; + grid-template-columns: 1fr 1fr; + gap: 6.67%; + width: 100%; +} + +.academy-features-col { + min-width: 0; +} + /* Add after existing styles */ @media (max-width: 768px) { @@ -377,6 +388,11 @@ td { padding-left: 1rem !important; padding-right: 1rem !important; } + + .academy-features-row { + grid-template-columns: 1fr; + gap: 1.5rem; + } .w-30-ns { display: none; /* Hide filler columns on mobile */ @@ -559,9 +575,9 @@ Use [cases]{.pink} ::: -::: {.w-100-ns .flex .flex-wrap .justify-around} +::: {.w-100-ns .academy-features-row} -::: {.w-40-ns .pl4} +::: {.academy-features-col} ::: {.f3 .b} {{< var vm.product >}} [Academy]{.pink} @@ -575,18 +591,15 @@ Use [cases]{.pink} ::: -::: {.w-10-ns} - -::: - -::: {.w-40-ns .pr4} +::: {.academy-features-col} ::: {.f3 .b} + Latest Features ::: -::: {.pl4 .nb2 .mid-gray} +::: {.nb2 .mid-gray} ::: {#index-releases} ::: diff --git a/site/llm/chatbot-product-map-frontend-snapshot.json b/site/llm/chatbot-product-map-frontend-snapshot.json index 4ee66823a6..b1609bea51 100644 --- a/site/llm/chatbot-product-map-frontend-snapshot.json +++ b/site/llm/chatbot-product-map-frontend-snapshot.json @@ -1,6 +1,6 @@ { "version": 1, - "generated_at": "2026-05-23T01:45:21.129000+00:00", + "generated_at": "2026-06-09T21:25:44.848926+00:00", "settings": [ { "path": "/settings/profile", @@ -91,7 +91,7 @@ }, { "path": "/settings/integrations/data-exports", - "label": "Analytics Exports", + "label": "Data Exports", "group": "Integrations", "primary_docs": [] }, @@ -125,6 +125,12 @@ "group": "Governance", "primary_docs": [] }, + { + "path": "/settings/risk-tier-templates", + "label": "Risk Tier Templates", + "group": "Governance", + "primary_docs": [] + }, { "path": "/settings/workflows", "label": "Workflows", @@ -143,6 +149,12 @@ "group": "Governance", "primary_docs": [] }, + { + "path": "/settings/documents/general", + "label": "General", + "group": "Documents", + "primary_docs": [] + }, { "path": "/settings/document-types", "label": "Document Types", @@ -193,6 +205,12 @@ "group": "Main navigation", "primary_docs": [] }, + { + "path": "/activity", + "label": "Activity", + "group": "Main navigation", + "primary_docs": [] + }, { "path": "/analytics", "label": "sidebar.analytics", diff --git a/site/llm/chatbot-product-map.md b/site/llm/chatbot-product-map.md index c2abf3e499..04f5bd8bdd 100644 --- a/site/llm/chatbot-product-map.md +++ b/site/llm/chatbot-product-map.md @@ -13,7 +13,7 @@ **Docs (primary):** - `/guide/configuration/managing-users.html` - - Sections: Key concepts; Key terms; Default roles; User management + - Sections: Key concepts; Key terms; Default roles; User management; What's next ### Governance @@ -21,6 +21,8 @@ **Docs (related):** +- `/faq/faq-attestations.html` + - Sections: Who can submit, review, and approve attestations?; Why aren't attestations displayed right after I create them?; Why are my attestations split into multiple submissions?; Can I schedule recurring attestation periods?; Can I start an attestation period in the past?; What happens when an attestation period starts?; What information is captured in an attestation snapshot?; Can I change an attestation after signing off? - `/guide/attestation/approve-attestations.html` - Sections: Prerequisites; Steps - `/guide/attestation/manage-attestations.html` @@ -30,9 +32,7 @@ - `/guide/attestation/submit-attestations.html` - Sections: Prerequisites; Steps - `/guide/attestation/working-with-attestations.html` - - Sections: Prerequisites; Key concepts; Where do I access attestations?; How does the attestation process work?; How are attestation submissions organized?; How do I create meaningful attestation questionnaires?; Manage attestations -- `/guide/templates/customize-document-checker.html` - - Sections: Prerequisites; Manage regulations and policies; Manage assessments; Default assessments provided by } cannot be edited, only cloned.; Add or clone assessments; Add or edit assessment questions; Add assessment questions; Edit assessment questions + - Sections: Key concepts; Where do I access attestations?; How does the attestation process work?; How are attestation submissions organized?; How do I create meaningful attestation questionnaires?; Prerequisites; Manage attestations; What's next - *No direct help link in frontend; related docs inferred from keywords.* @@ -48,6 +48,8 @@ **Docs (related):** +- `/faq/faq-attestations.html` + - Sections: Who can submit, review, and approve attestations?; Why aren't attestations displayed right after I create them?; Why are my attestations split into multiple submissions?; Can I schedule recurring attestation periods?; Can I start an attestation period in the past?; What happens when an attestation period starts?; What information is captured in an attestation snapshot?; Can I change an attestation after signing off? - `/guide/attestation/approve-attestations.html` - Sections: Prerequisites; Steps - `/guide/attestation/review-attestations.html` @@ -55,7 +57,7 @@ - `/guide/attestation/submit-attestations.html` - Sections: Prerequisites; Steps - `/guide/attestation/working-with-attestations.html` - - Sections: Prerequisites; Key concepts; Where do I access attestations?; How does the attestation process work?; How are attestation submissions organized?; How do I create meaningful attestation questionnaires?; Manage attestations + - Sections: Key concepts; Where do I access attestations?; How does the attestation process work?; How are attestation submissions organized?; How do I create meaningful attestation questionnaires?; Prerequisites; Manage attestations; What's next ### Organization @@ -69,7 +71,7 @@ **Docs (related):** - `/guide/configuration/managing-your-organization.html` - - Sections: Prerequisites; Switch between organizations; Change names of organizations; Manage document defaults; Tracked changes; Numbered table and figure captions; Organization setup + - Sections: Prerequisites; Switch between organizations; Change names of organizations; Manage your organization; What's next ### Documents @@ -92,8 +94,8 @@ - Sections: Prerequisites; Add document types; Edit or delete document types; Development, Validation, and Monitoring document types are stock types and cannot be deleted. - `/guide/templates/manage-documents.html` - Sections: Prerequisites; Add record documents; How do I get the best results when converting PDFs into editable documents?; How can I trust that the conversion is accurate?; Troubleshooting; My PDF conversion is stuck. What can I do?; Edit record documents; Delete record documents -- `/guide/templates/working-with-document-templates.html` - - Sections: What's next +- `/guide/templates/managing-documents.html` + - Sections: Manage document defaults; Manage document types and documents; What's next ### Main navigation @@ -125,8 +127,27 @@ - Sections: Prerequisites; Add record documents; How do I get the best results when converting PDFs into editable documents?; How can I trust that the conversion is accurate?; Troubleshooting; My PDF conversion is stuck. What can I do?; Edit record documents; Delete record documents - `/guide/templates/manage-text-block-library.html` - Sections: Prerequisites; Add text blocks; Add existing text blocks to library; Duplicate text blocks; Edit text blocks; Delete text blocks -- `/guide/templates/working-with-document-templates.html` - - Sections: What's next +- `/guide/templates/managing-documents.html` + - Sections: Manage document defaults; Manage document types and documents; What's next + +#### `/settings/documents/general` — General + +**Docs (related):** + +- `/guide/templates/customize-document-checker.html` + - Sections: Prerequisites; Manage regulations and policies; Manage assessments; Default assessments provided by } cannot be edited, only cloned.; Add or clone assessments; Add or edit assessment questions; Add assessment questions; Edit assessment questions +- `/guide/templates/customize-document-templates.html` + - Sections: Prerequisites; Edit template outlines; Configure assessment options[^4]; Edit YAML templates; Template schema; Troubleshooting YAML templates; Add text blocks to templates; Add text blocks via template outlines +- `/guide/templates/manage-document-templates.html` + - Sections: Prerequisites; View document templates; Edit document template outlines; Swap document templates; View currently applied templates; Swap between templates; Duplicate document templates; Delete document templates +- `/guide/templates/manage-document-types.html` + - Sections: Prerequisites; Add document types; Edit or delete document types; Development, Validation, and Monitoring document types are stock types and cannot be deleted. +- `/guide/templates/manage-documents.html` + - Sections: Prerequisites; Add record documents; How do I get the best results when converting PDFs into editable documents?; How can I trust that the conversion is accurate?; Troubleshooting; My PDF conversion is stuck. What can I do?; Edit record documents; Delete record documents +- `/guide/templates/manage-text-block-library.html` + - Sections: Prerequisites; Add text blocks; Add existing text blocks to library; Duplicate text blocks; Edit text blocks; Delete text blocks + +- *No direct help link in frontend; related docs inferred from keywords.* ### Organization @@ -140,7 +161,7 @@ **Docs (related):** - `/guide/configuration/managing-your-organization.html` - - Sections: Prerequisites; Switch between organizations; Change names of organizations; Manage document defaults; Tracked changes; Numbered table and figure captions; Organization setup + - Sections: Prerequisites; Switch between organizations; Change names of organizations; Manage your organization; What's next ### Artifacts @@ -224,7 +245,7 @@ - `/guide/configuration/manage-users.html` - Sections: Prerequisites; View and search for users; Manage user invitations; Invite new users; Monitor user invitations; Manage user roles - `/guide/configuration/managing-users.html` - - Sections: Key concepts; Key terms; Default roles; User management + - Sections: Key concepts; Key terms; Default roles; User management; What's next ### Integrations @@ -233,34 +254,34 @@ **Docs (related):** - `/faq/faq-integrations.html` - - Sections: Which languages, libraries, and environments do you support?; Currently, we support **Python }** and the most popular AI/ML and data science libraries.; What test ingestion or modeling techniques are supported?; What large language model (LLM) features are offered?; What deployment options are supported by }?; Learn more + - Sections: Which languages, libraries, and environments do you support?; Currently, we support **Python }** and the most popular AI/ML and data science libraries.; What test ingestion or modeling techniques are supported?; What large language model (LLM) features are offered?; What deployment options are supported by }?; What third-party integrations are supported by }?; Learn more - `/guide/configuration/configure-aws-privatelink.html` - Sections: Prerequisites; VPC service information; Steps; What's next - `/guide/configuration/configure-azure-private-link.html` - Sections: Prerequisites; VNet service information; Steps; What's next - `/guide/configuration/configure-google-private-service-connect.html` - Sections: Prerequisites; VPC service information; Configure your Google Cloud Platform project; Request access from }; Prepare your network for connection; Create an endpoint to connect to }; Steps; Create an endpoint to connect to the } authentication service +- `/guide/configuration/configuring-private-connectivity.html` + - Sections: What's next - `/guide/configuration/customize-your-dashboard.html` - Sections: Prerequisites; Manage dashboards; Add dashboards; Edit or remove dashboards; Manage widgets; Arrange widgets; Add widgets; Remove widgets -- `/guide/configuration/manage-groups.html` - - Sections: Prerequisites; View group details; Add new groups; Remove groups; Add or remove group members - *No direct help link in frontend; related docs inferred from keywords.* -#### `/settings/integrations/data-exports` — Analytics Exports +#### `/settings/integrations/data-exports` — Data Exports **Docs (related):** - `/faq/faq-integrations.html` - - Sections: Which languages, libraries, and environments do you support?; Currently, we support **Python }** and the most popular AI/ML and data science libraries.; What test ingestion or modeling techniques are supported?; What large language model (LLM) features are offered?; What deployment options are supported by }?; Learn more -- `/faq/faq-reporting.html` - - Sections: What analytic features are offered by }?; Learn more + - Sections: Which languages, libraries, and environments do you support?; Currently, we support **Python }** and the most popular AI/ML and data science libraries.; What test ingestion or modeling techniques are supported?; What large language model (LLM) features are offered?; What deployment options are supported by }?; What third-party integrations are supported by }?; Learn more - `/guide/configuration/configure-aws-privatelink.html` - Sections: Prerequisites; VPC service information; Steps; What's next - `/guide/configuration/configure-azure-private-link.html` - Sections: Prerequisites; VNet service information; Steps; What's next - `/guide/configuration/configure-google-private-service-connect.html` - Sections: Prerequisites; VPC service information; Configure your Google Cloud Platform project; Request access from }; Prepare your network for connection; Create an endpoint to connect to }; Steps; Create an endpoint to connect to the } authentication service +- `/guide/configuration/configuring-private-connectivity.html` + - Sections: What's next - `/guide/configuration/customize-your-dashboard.html` - Sections: Prerequisites; Manage dashboards; Add dashboards; Edit or remove dashboards; Manage widgets; Arrange widgets; Add widgets; Remove widgets @@ -271,17 +292,17 @@ **Docs (related):** - `/faq/faq-integrations.html` - - Sections: Which languages, libraries, and environments do you support?; Currently, we support **Python }** and the most popular AI/ML and data science libraries.; What test ingestion or modeling techniques are supported?; What large language model (LLM) features are offered?; What deployment options are supported by }?; Learn more + - Sections: Which languages, libraries, and environments do you support?; Currently, we support **Python }** and the most popular AI/ML and data science libraries.; What test ingestion or modeling techniques are supported?; What large language model (LLM) features are offered?; What deployment options are supported by }?; What third-party integrations are supported by }?; Learn more - `/guide/configuration/configure-aws-privatelink.html` - Sections: Prerequisites; VPC service information; Steps; What's next - `/guide/configuration/configure-azure-private-link.html` - Sections: Prerequisites; VNet service information; Steps; What's next - `/guide/configuration/configure-google-private-service-connect.html` - Sections: Prerequisites; VPC service information; Configure your Google Cloud Platform project; Request access from }; Prepare your network for connection; Create an endpoint to connect to }; Steps; Create an endpoint to connect to the } authentication service +- `/guide/configuration/configuring-private-connectivity.html` + - Sections: What's next - `/guide/configuration/customize-your-dashboard.html` - Sections: Prerequisites; Manage dashboards; Add dashboards; Edit or remove dashboards; Manage widgets; Arrange widgets; Add widgets; Remove widgets -- `/guide/configuration/manage-groups.html` - - Sections: Prerequisites; View group details; Add new groups; Remove groups; Add or remove group members - *No direct help link in frontend; related docs inferred from keywords.* @@ -292,7 +313,7 @@ **Docs (primary):** - `/guide/configuration/managing-users.html` - - Sections: Key concepts; Key terms; Default roles; User management + - Sections: Key concepts; Key terms; Default roles; User management; What's next - `/guide/configuration/manage-users.html` (section: #manage-user-invitations) - Sections: Prerequisites; View and search for users; Manage user invitations; Invite new users; Monitor user invitations; Manage user roles @@ -303,7 +324,7 @@ **Docs (primary):** - `/guide/configuration/managing-your-organization.html` - - Sections: Prerequisites; Switch between organizations; Change names of organizations; Manage document defaults; Tracked changes; Numbered table and figure captions; Organization setup + - Sections: Prerequisites; Switch between organizations; Change names of organizations; Manage your organization; What's next ### Users & Access @@ -319,7 +340,7 @@ - `/guide/configuration/manage-users.html` - Sections: Prerequisites; View and search for users; Manage user invitations; Invite new users; Monitor user invitations; Manage user roles - `/guide/configuration/managing-users.html` - - Sections: Key concepts; Key terms; Default roles; User management + - Sections: Key concepts; Key terms; Default roles; User management; What's next ### Main navigation @@ -367,6 +388,25 @@ - `/guide/model-validation/manage-validation-guidelines.html` - Note: no matching `.qmd` source found +#### `/settings/risk-tier-templates` — Risk Tier Templates + +**Docs (related):** + +- `/guide/templates/customize-document-checker.html` + - Sections: Prerequisites; Manage regulations and policies; Manage assessments; Default assessments provided by } cannot be edited, only cloned.; Add or clone assessments; Add or edit assessment questions; Add assessment questions; Edit assessment questions +- `/guide/templates/customize-document-templates.html` + - Sections: Prerequisites; Edit template outlines; Configure assessment options[^4]; Edit YAML templates; Template schema; Troubleshooting YAML templates; Add text blocks to templates; Add text blocks via template outlines +- `/guide/templates/manage-document-templates.html` + - Sections: Prerequisites; View document templates; Edit document template outlines; Swap document templates; View currently applied templates; Swap between templates; Duplicate document templates; Delete document templates +- `/guide/templates/manage-document-types.html` + - Sections: Prerequisites; Add document types; Edit or delete document types; Development, Validation, and Monitoring document types are stock types and cannot be deleted. +- `/guide/templates/manage-documents.html` + - Sections: Prerequisites; Add record documents; How do I get the best results when converting PDFs into editable documents?; How can I trust that the conversion is accurate?; Troubleshooting; My PDF conversion is stuck. What can I do?; Edit record documents; Delete record documents +- `/guide/templates/manage-text-block-library.html` + - Sections: Prerequisites; Add text blocks; Add existing text blocks to library; Duplicate text blocks; Edit text blocks; Delete text blocks + +- *No direct help link in frontend; related docs inferred from keywords.* + ### Users & Access #### `/settings/roles` — Roles @@ -374,7 +414,7 @@ **Docs (primary):** - `/guide/configuration/managing-users.html` - - Sections: Key concepts; Key terms; Default roles; User management + - Sections: Key concepts; Key terms; Default roles; User management; What's next - `/guide/configuration/manage-roles.html` - Sections: Prerequisites; Add or update roles; Two special default roles provided by } have unique characteristics.; Manage role permissions; Manage role users; Rename existing roles @@ -420,8 +460,8 @@ - Sections: Prerequisites; Add record documents; How do I get the best results when converting PDFs into editable documents?; How can I trust that the conversion is accurate?; Troubleshooting; My PDF conversion is stuck. What can I do?; Edit record documents; Delete record documents - `/guide/templates/manage-text-block-library.html` - Sections: Prerequisites; Add text blocks; Add existing text blocks to library; Duplicate text blocks; Edit text blocks; Delete text blocks -- `/guide/templates/working-with-document-templates.html` - - Sections: What's next +- `/guide/templates/managing-documents.html` + - Sections: Manage document defaults; Manage document types and documents; What's next ### Your Account @@ -436,7 +476,7 @@ **Docs (primary):** - `/guide/configuration/managing-users.html` - - Sections: Key concepts; Key terms; Default roles; User management + - Sections: Key concepts; Key terms; Default roles; User management; What's next - `/guide/configuration/manage-users.html` - Sections: Prerequisites; View and search for users; Manage user invitations; Invite new users; Monitor user invitations; Manage user roles @@ -452,9 +492,9 @@ **Docs (related):** - `/faq/faq-workflows.html` - - Sections: Can I customize workflows within }?; What statuses are available for use in workflows?; Can we work with disconnected workflows?; You can also leverage the } once you are ready to document a specific record (model) for review and validation.; Learn more + - Sections: Can I customize workflows within }?; What record stages are available for use in workflows?; Can we work with disconnected workflows?; You can also leverage the } once you are ready to document a specific record (model) for review and validation.; Learn more - `/guide/integrations/integrations-examples/use-webhooks-with-workflows.html` - - Sections: Prerequisites; Start a workflow via webhook; a. Configure workflow in }; b. Start workflow from external system; Trigger a paused workflow to continue; a. Configure workflow in }; b. Trigger workflow to continue from external system + - Sections: Prerequisites; Start a workflow via webhook; 1. Configure workflow in }; 2. Start workflow from external system; Trigger a paused workflow to continue; 1. Configure workflow in }; 2. Trigger workflow to continue from external system - `/guide/workflows/conditional-step-requirements.html` - Sections: Prerequisites; Configure conditional requirements - `/guide/workflows/configure-workflows.html` @@ -474,9 +514,9 @@ **Docs (related):** - `/faq/faq-workflows.html` - - Sections: Can I customize workflows within }?; What statuses are available for use in workflows?; Can we work with disconnected workflows?; You can also leverage the } once you are ready to document a specific record (model) for review and validation.; Learn more + - Sections: Can I customize workflows within }?; What record stages are available for use in workflows?; Can we work with disconnected workflows?; You can also leverage the } once you are ready to document a specific record (model) for review and validation.; Learn more - `/guide/integrations/integrations-examples/use-webhooks-with-workflows.html` - - Sections: Prerequisites; Start a workflow via webhook; a. Configure workflow in }; b. Start workflow from external system; Trigger a paused workflow to continue; a. Configure workflow in }; b. Trigger workflow to continue from external system + - Sections: Prerequisites; Start a workflow via webhook; 1. Configure workflow in }; 2. Start workflow from external system; Trigger a paused workflow to continue; 1. Configure workflow in }; 2. Trigger workflow to continue from external system - `/guide/workflows/conditional-step-requirements.html` - Sections: Prerequisites; Configure conditional requirements - `/guide/workflows/configure-workflows.html` @@ -488,12 +528,16 @@ ## Main application +#### `/activity` — Activity + +- *No direct help link; content may be covered under scattered guide sections.* + #### `/analytics` — sidebar.analytics **Docs (related):** - `/faq/faq-reporting.html` - - Sections: What analytic features are offered by }?; Learn more + - Sections: What analytic features are offered by }?; How can I export platform data on a schedule to cloud storage?; Learn more - `/guide/monitoring/enable-monitoring.html` - Sections: Prerequisites; Steps; 1. Get monitoring code snippet; 2. Select monitoring template; 3. Run code snippet; A template must already be applied to your selected document to populate monitoring test results in the }.; What's next - `/guide/monitoring/ongoing-monitoring.html` @@ -530,6 +574,8 @@ **Docs (related):** +- `/faq/faq-attestations.html` + - Sections: Who can submit, review, and approve attestations?; Why aren't attestations displayed right after I create them?; Why are my attestations split into multiple submissions?; Can I schedule recurring attestation periods?; Can I start an attestation period in the past?; What happens when an attestation period starts?; What information is captured in an attestation snapshot?; Can I change an attestation after signing off? - `/guide/attestation/approve-attestations.html` - Sections: Prerequisites; Steps - `/guide/attestation/manage-attestations.html` @@ -539,7 +585,7 @@ - `/guide/attestation/submit-attestations.html` - Sections: Prerequisites; Steps - `/guide/attestation/working-with-attestations.html` - - Sections: Prerequisites; Key concepts; Where do I access attestations?; How does the attestation process work?; How are attestation submissions organized?; How do I create meaningful attestation questionnaires?; Manage attestations + - Sections: Key concepts; Where do I access attestations?; How does the attestation process work?; How are attestation submissions organized?; How do I create meaningful attestation questionnaires?; Prerequisites; Manage attestations; What's next - *No direct help link in frontend; related docs inferred from keywords.* @@ -561,9 +607,9 @@ **Docs (related):** - `/faq/faq-workflows.html` - - Sections: Can I customize workflows within }?; What statuses are available for use in workflows?; Can we work with disconnected workflows?; You can also leverage the } once you are ready to document a specific record (model) for review and validation.; Learn more + - Sections: Can I customize workflows within }?; What record stages are available for use in workflows?; Can we work with disconnected workflows?; You can also leverage the } once you are ready to document a specific record (model) for review and validation.; Learn more - `/guide/integrations/integrations-examples/use-webhooks-with-workflows.html` - - Sections: Prerequisites; Start a workflow via webhook; a. Configure workflow in }; b. Start workflow from external system; Trigger a paused workflow to continue; a. Configure workflow in }; b. Trigger workflow to continue from external system + - Sections: Prerequisites; Start a workflow via webhook; 1. Configure workflow in }; 2. Start workflow from external system; Trigger a paused workflow to continue; 1. Configure workflow in }; 2. Trigger workflow to continue from external system - `/guide/workflows/conditional-step-requirements.html` - Sections: Prerequisites; Configure conditional requirements - `/guide/workflows/configure-workflows.html` diff --git a/site/notebooks.zip b/site/notebooks.zip index d9486a6875..d9c822d2da 100644 Binary files a/site/notebooks.zip and b/site/notebooks.zip differ diff --git a/site/notebooks/EXECUTED/development/1-set_up_validmind.ipynb b/site/notebooks/EXECUTED/development/1-set_up_validmind.ipynb index 9ba5431049..158cf4c7a5 100644 --- a/site/notebooks/EXECUTED/development/1-set_up_validmind.ipynb +++ b/site/notebooks/EXECUTED/development/1-set_up_validmind.ipynb @@ -216,13 +216,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "a48cd34d" }, @@ -240,7 +242,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -256,7 +258,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/EXECUTED/development/2-start_development_process.ipynb b/site/notebooks/EXECUTED/development/2-start_development_process.ipynb index 4016e2a97a..ed1190a2ef 100644 --- a/site/notebooks/EXECUTED/development/2-start_development_process.ipynb +++ b/site/notebooks/EXECUTED/development/2-start_development_process.ipynb @@ -94,7 +94,7 @@ "\n", "First, let's connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/EXECUTED/development/3-integrate_custom_tests.ipynb b/site/notebooks/EXECUTED/development/3-integrate_custom_tests.ipynb index 7f32f3e454..14f1102790 100644 --- a/site/notebooks/EXECUTED/development/3-integrate_custom_tests.ipynb +++ b/site/notebooks/EXECUTED/development/3-integrate_custom_tests.ipynb @@ -108,7 +108,7 @@ "\n", "As usual, let's first connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/EXECUTED/development/4-finalize_testing_documentation.ipynb b/site/notebooks/EXECUTED/development/4-finalize_testing_documentation.ipynb index 0dbc8d3be1..f7b1a2822d 100644 --- a/site/notebooks/EXECUTED/development/4-finalize_testing_documentation.ipynb +++ b/site/notebooks/EXECUTED/development/4-finalize_testing_documentation.ipynb @@ -106,7 +106,7 @@ "\n", "As usual, let's first connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/EXECUTED/validation/1-set_up_validmind_for_validation.ipynb b/site/notebooks/EXECUTED/validation/1-set_up_validmind_for_validation.ipynb index feda59a354..72ccaa027d 100644 --- a/site/notebooks/EXECUTED/validation/1-set_up_validmind_for_validation.ipynb +++ b/site/notebooks/EXECUTED/validation/1-set_up_validmind_for_validation.ipynb @@ -184,13 +184,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down — don’t worry, we’ll adjust these permissions next for validation.\n", + "6. Select your own name under the **Record Owner** drop-down — don’t worry, we’ll adjust these permissions next for validation.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "609fe59b" }, @@ -206,19 +208,19 @@ "\n", "1. Remove yourself as an owner:\n", "\n", - " - Click on the **OWNERS** tile.\n", + " - Click on the **Owners** tile.\n", " - Click the **x** next to your name to remove yourself from that model's role.\n", " - Click **Save** to apply your changes to that role.\n", "\n", "2. Remove yourself as a developer:\n", "\n", - " - Click on the **DEVELOPERS** tile.\n", + " - Click on the **Developers** tile.\n", " - Click the **x** next to your name to remove yourself from that model's role.\n", " - Click **Save** to apply your changes to that role.\n", "\n", "3. Add yourself as a validator:\n", "\n", - " - Click on the **VALIDATORS** tile.\n", + " - Click on the **Validators** tile.\n", " - Select your name from the drop-down menu.\n", " - Click **Save** to apply your changes to that role." ], @@ -238,7 +240,7 @@ "\n", "1. In the left sidebar that appears for your model, click **Documents** and select **Documentation**.\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -258,7 +260,7 @@ "\n", " If you cannot locate your Validation document, make sure Validation type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Generic Validation Report`.\n", + "2. Under **Template**, select `Generic Validation Report`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -310,7 +312,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/EXECUTED/validation/2-start_validation_process.ipynb b/site/notebooks/EXECUTED/validation/2-start_validation_process.ipynb index a0d4440e6c..081475e3c1 100644 --- a/site/notebooks/EXECUTED/validation/2-start_validation_process.ipynb +++ b/site/notebooks/EXECUTED/validation/2-start_validation_process.ipynb @@ -97,7 +97,7 @@ "\n", "First, let's connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/EXECUTED/validation/3-developing_potential_challenger.ipynb b/site/notebooks/EXECUTED/validation/3-developing_potential_challenger.ipynb index 2ed29a195f..4db8d26dfb 100644 --- a/site/notebooks/EXECUTED/validation/3-developing_potential_challenger.ipynb +++ b/site/notebooks/EXECUTED/validation/3-developing_potential_challenger.ipynb @@ -102,7 +102,7 @@ "\n", "As usual, let's first connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", @@ -628,10 +628,10 @@ "\n", "6. Click **+ Add Validation Issue** and enter in the details for your validation issue, for example:\n", "\n", - " - **TITLE** — Champion Logistic Regression Model Fails Minimum Accuracy Threshold\n", - " - **RISK AREA** — Model Performance\n", - " - **DOCUMENTATION SECTION** — 3.2. Model Evaluation\n", - " - **DESCRIPTION** — The logistic regression champion model was subjected to a Minimum Accuracy test to determine whether its predictive accuracy meets the predefined performance threshold of 0.7. The model achieved an accuracy score of 0.6136, which falls below the required minimum. As a result, the test produced a Fail outcome.\n", + " - **Title** — Champion Logistic Regression Model Fails Minimum Accuracy Threshold\n", + " - **Risk Area** — Model Performance\n", + " - **Documentation Section** — 3.2. Model Evaluation\n", + " - **Description** — The logistic regression champion model was subjected to a Minimum Accuracy test to determine whether its predictive accuracy meets the predefined performance threshold of 0.7. The model achieved an accuracy score of 0.6136, which falls below the required minimum. As a result, the test produced a Fail outcome.\n", "\n", "7. Click **Add Validation Issue** to submit the validation issue.\n", "\n", diff --git a/site/notebooks/EXECUTED/validation/4-finalize_validation_reporting.ipynb b/site/notebooks/EXECUTED/validation/4-finalize_validation_reporting.ipynb index 32d46c6e2d..954f340472 100644 --- a/site/notebooks/EXECUTED/validation/4-finalize_validation_reporting.ipynb +++ b/site/notebooks/EXECUTED/validation/4-finalize_validation_reporting.ipynb @@ -112,7 +112,7 @@ "\n", "As usual, let's first connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", @@ -1149,7 +1149,7 @@ "\n", "- **Adding risk assessment notes:** Click under **Risk Assessment Notes** in any validation report section to access the text editor and content editing toolbar, including an option to generate a draft with AI. Once generated, edit your ValidMind-generated test descriptions to adhere to your organization's requirements. (Learn more: [Work with content blocks](https://docs.validmind.ai/guide/documentation/work-with-content-blocks.html#content-editing-toolbar))\n", "\n", - "- **Assessing compliance:** Under the Guideline for any validation report section, click **ASSESSMENT** and select the compliance status from the drop-down menu. (Learn more: [Assign compliance assessments](https://docs.validmind.ai/guide/validation/assess-compliance.html#assign-compliance-assessments))\n", + "- **Assessing compliance:** Under the Guideline for any validation report section, click **Assessment** and select the compliance status from the drop-down menu. (Learn more: [Assign compliance assessments](https://docs.validmind.ai/guide/validation/assess-compliance.html#assign-compliance-assessments))\n", "\n", "- **Collaborate with other stakeholders:** Use the ValidMind Platform's real-time collaborative features to work seamlessly together with the rest of your organization, including developers. Propose suggested changes in the documentation, work with versioned history, and use comments to discuss specific portions of the documentation. (Learn more: [Collaborate with others](https://docs.validmind.ai/guide/documentation/collaborate-with-others.html))\n", "\n", diff --git a/site/notebooks/how_to/data_and_datasets/dataset_inputs/configure_dataset_features.ipynb b/site/notebooks/how_to/data_and_datasets/dataset_inputs/configure_dataset_features.ipynb index 1b9ab41dab..3b470c858f 100644 --- a/site/notebooks/how_to/data_and_datasets/dataset_inputs/configure_dataset_features.ipynb +++ b/site/notebooks/how_to/data_and_datasets/dataset_inputs/configure_dataset_features.ipynb @@ -162,13 +162,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -185,7 +187,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -200,7 +202,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/data_and_datasets/dataset_inputs/load_datasets_predictions.ipynb b/site/notebooks/how_to/data_and_datasets/dataset_inputs/load_datasets_predictions.ipynb index a98ff348bc..f9d73f8974 100644 --- a/site/notebooks/how_to/data_and_datasets/dataset_inputs/load_datasets_predictions.ipynb +++ b/site/notebooks/how_to/data_and_datasets/dataset_inputs/load_datasets_predictions.ipynb @@ -182,13 +182,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -205,7 +207,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -220,7 +222,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/data_and_datasets/use_dataset_model_objects.ipynb b/site/notebooks/how_to/data_and_datasets/use_dataset_model_objects.ipynb index 7102ad6de1..7c6a2535f7 100644 --- a/site/notebooks/how_to/data_and_datasets/use_dataset_model_objects.ipynb +++ b/site/notebooks/how_to/data_and_datasets/use_dataset_model_objects.ipynb @@ -177,13 +177,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -200,7 +202,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -215,7 +217,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/metrics/log_metrics_over_time.ipynb b/site/notebooks/how_to/metrics/log_metrics_over_time.ipynb index 7e8d1faef8..f2fcf772bf 100644 --- a/site/notebooks/how_to/metrics/log_metrics_over_time.ipynb +++ b/site/notebooks/how_to/metrics/log_metrics_over_time.ipynb @@ -179,13 +179,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -202,7 +204,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Credit Risk Scorecard`.\n", + "2. Under **Template**, select `Credit Risk Scorecard`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -217,7 +219,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/metrics/run_unit_metrics.ipynb b/site/notebooks/how_to/metrics/run_unit_metrics.ipynb index bc562eba99..9b0783b2a4 100644 --- a/site/notebooks/how_to/metrics/run_unit_metrics.ipynb +++ b/site/notebooks/how_to/metrics/run_unit_metrics.ipynb @@ -164,13 +164,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -187,7 +189,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -202,7 +204,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/qualitative_text/qualitative_text_generation.ipynb b/site/notebooks/how_to/qualitative_text/qualitative_text_generation.ipynb index f2c72ce7b3..9f218c90c2 100644 --- a/site/notebooks/how_to/qualitative_text/qualitative_text_generation.ipynb +++ b/site/notebooks/how_to/qualitative_text/qualitative_text_generation.ipynb @@ -206,13 +206,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -230,7 +232,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -246,7 +248,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/scoring/assign_scores_complete_tutorial.ipynb b/site/notebooks/how_to/scoring/assign_scores_complete_tutorial.ipynb index 599024f471..55ec2095d4 100644 --- a/site/notebooks/how_to/scoring/assign_scores_complete_tutorial.ipynb +++ b/site/notebooks/how_to/scoring/assign_scores_complete_tutorial.ipynb @@ -166,13 +166,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -189,7 +191,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -204,7 +206,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/custom_tests/implement_custom_tests.ipynb b/site/notebooks/how_to/tests/custom_tests/implement_custom_tests.ipynb index 38ad4a3086..e72782b252 100644 --- a/site/notebooks/how_to/tests/custom_tests/implement_custom_tests.ipynb +++ b/site/notebooks/how_to/tests/custom_tests/implement_custom_tests.ipynb @@ -174,13 +174,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -197,7 +199,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -212,7 +214,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/custom_tests/integrate_external_test_providers.ipynb b/site/notebooks/how_to/tests/custom_tests/integrate_external_test_providers.ipynb index df995d23ae..a5739acebc 100644 --- a/site/notebooks/how_to/tests/custom_tests/integrate_external_test_providers.ipynb +++ b/site/notebooks/how_to/tests/custom_tests/integrate_external_test_providers.ipynb @@ -183,13 +183,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -206,7 +208,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -221,7 +223,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/run_tests/1-run_dataset-based_tests.ipynb b/site/notebooks/how_to/tests/run_tests/1-run_dataset-based_tests.ipynb index ae4b200aa6..5329402203 100644 --- a/site/notebooks/how_to/tests/run_tests/1-run_dataset-based_tests.ipynb +++ b/site/notebooks/how_to/tests/run_tests/1-run_dataset-based_tests.ipynb @@ -196,13 +196,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "451c5a1b" }, @@ -220,7 +222,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -236,7 +238,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/run_tests/2-run_comparison_tests.ipynb b/site/notebooks/how_to/tests/run_tests/2-run_comparison_tests.ipynb index 1766a413fe..9ef6978dd3 100644 --- a/site/notebooks/how_to/tests/run_tests/2-run_comparison_tests.ipynb +++ b/site/notebooks/how_to/tests/run_tests/2-run_comparison_tests.ipynb @@ -208,13 +208,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "d3e3302f" }, @@ -232,7 +234,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -248,7 +250,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/run_tests/configure_tests/configure_judge_llms.ipynb b/site/notebooks/how_to/tests/run_tests/configure_tests/configure_judge_llms.ipynb index bde5200a41..4a06b0283b 100644 --- a/site/notebooks/how_to/tests/run_tests/configure_tests/configure_judge_llms.ipynb +++ b/site/notebooks/how_to/tests/run_tests/configure_tests/configure_judge_llms.ipynb @@ -1,828 +1,774 @@ { - "cells": [ - { - "cell_type": "markdown", - "id": "0935afb5", - "metadata": {}, - "source": [ - "# Configure judge LLM and judge embeddings\n", - "\n", - "This notebook shows how to configure and validate the default judge LLM and judge embeddings used by the ValidMind Library for LLM-focused tests.\n", - "\n", - "It exercises three important paths:\n", - "1. Prompt-validation tests, which depend on the default judge LLM.\n", - "2. RAGAS-based tests, which depend on both the default judge LLM and the default judge embeddings model.\n", - "3. DeepEval scorers, which depend on the default local scorer model path.\n", - "\n", - "The notebook automatically selects the available provider from your environment, with OpenAI taking precedence when both OpenAI and Gemini keys are set, to match the library's default-provider logic." - ] - }, - { - "cell_type": "markdown", - "id": "1f2befa6", - "metadata": {}, - "source": [ - "::: {.content-hidden when-format=\"html\"}\n", - "## Contents\n", - "- [Introduction](#toc1__)\n", - "- [About ValidMind](#toc2__)\n", - " - [Before you begin](#toc2_1__)\n", - " - [New to ValidMind?](#toc2_2__)\n", - " - [Key concepts](#toc2_3__)\n", - "- [Setting up](#toc3__)\n", - " - [Install the ValidMind Library](#toc3_1__)\n", - " - [Connect to the ValidMind Platform](#toc3_2__)\n", - " - [Register or select a model](#toc3_2_1__)\n", - " - [Choose a documentation template](#toc3_2_2__)\n", - " - [Get your code snippet](#toc3_2_3__)\n", - " - [Initialize the notebook environment](#toc3_3__)\n", - "- [Getting to know ValidMind](#toc4__)\n", - " - [Preview the documentation template](#toc4_1__)\n", - " - [View model documentation in the ValidMind Platform](#toc4_2__)\n", - "- [Configure the judge provider](#toc5__)\n", - "- [Prompt-validation tests](#toc6__)\n", - "- [RAGAS tests](#toc7__)\n", - "- [DeepEval scorers](#toc8__)\n", - "- [In summary](#toc9__)\n", - "- [Next steps](#toc10__)\n", - " - [Discover more learning resources](#toc10_1__)\n", - "- [Upgrade ValidMind](#toc11__)\n", - "\n", - ":::\n", - "\n", - "" - ] - }, - { - "cell_type": "markdown", - "id": "b77005b8", - "metadata": {}, - "source": [ - "\n", - "\n", - "## Introduction\n", - "\n", - "This notebook shows how to configure and validate the default judge LLM and judge embeddings used by the ValidMind Library for LLM-focused tests.\n", - "\n", - "It walks through the provider configuration used by three important evaluation paths:\n", - "- prompt-validation tests\n", - "- RAGAS-based tests\n", - "- DeepEval scorers\n", - "\n", - "Along the way, you will initialize ValidMind model and dataset objects, inspect the resolved judge configuration, run representative tests, and optionally log the results to the ValidMind Platform. By the end of the notebook, you will have a practical reference for configuring judge models and understanding how those settings affect different LLM evaluation workflows." - ] - }, - { - "cell_type": "markdown", - "id": "56ecff8d", - "metadata": {}, - "source": [ - "\n", - "\n", - "## About ValidMind\n", - "\n", - "ValidMind is a suite of tools for managing model risk, including risk associated with AI and statistical models. \n", - "\n", - "You use the ValidMind Library to automate documentation and validation tests, and then use the ValidMind Platform to collaborate on model documentation. Together, these products simplify model risk management, facilitate compliance with regulations and institutional standards, and enhance collaboration between yourself and model validators." - ] - }, - { - "cell_type": "markdown", - "id": "e8743d30", - "metadata": {}, - "source": [ - "\n", - "\n", - "### Before you begin\n", - "\n", - "Before running this notebook, make sure you have:\n", - "- a Python environment with the ValidMind Library and its LLM dependencies installed\n", - "- access to a ValidMind account if you want to log results to the ValidMind Platform\n", - "- credentials for one supported judge provider in your environment\n", - "\n", - "This notebook supports:\n", - "- OpenAI via `OPENAI_API_KEY`, with optional `OPENAI_MODEL` and `OPENAI_EMBEDDINGS_MODEL` overrides. The current default judge model is `gpt-4.1` and the default embeddings model is `text-embedding-3-small`.\n", - "- Gemini via `GOOGLE_API_KEY` or `GEMINI_API_KEY`, with optional `GEMINI_MODEL` and `GEMINI_EMBEDDINGS_MODEL` overrides. The current defaults are `gemini-2.5-pro` and `models/text-embedding-004`.\n", - "- Azure OpenAI via `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT`, and `AZURE_OPENAI_MODEL`. The current default embeddings model is `text-embedding-3-small`.\n", - "\n", - "You can still run the notebook locally without connecting to the ValidMind Platform, but connecting a model document makes it easier to review and share results after the tests complete." - ] - }, - { - "cell_type": "markdown", - "id": "ee479eb5", - "metadata": {}, - "source": [ - "\n", - "\n", - "### New to ValidMind?\n", - "\n", - "If you are new to the ValidMind Library, start with the [ValidMind Library overview](https://docs.validmind.ai/developer/validmind-library.html). It introduces the core workflow for initializing models and datasets, running tests, and logging outputs back to the ValidMind Platform.\n", - "\n", - "
    You only need a ValidMind account if you want to log results to the ValidMind Platform.\n", - "

    \n", - "Register with ValidMind
    " - ] - }, - { - "cell_type": "markdown", - "id": "689e55db", - "metadata": {}, - "source": [ - "\n", - "\n", - "### Key concepts\n", - "\n", - "**Judge LLM**: The language model used by ValidMind to evaluate prompts, answers, contexts, and other LLM outputs.\n", - "\n", - "**Judge embeddings**: The embeddings model used when a test requires semantic similarity or retrieval-based comparison.\n", - "\n", - "**Provider credentials**: Environment variables that tell ValidMind which provider to use for judge evaluation. In this notebook, the provider is resolved automatically from the credentials available in your environment.\n", - "\n", - "**ValidMind dataset**: A dataset initialized with [`vm.init_dataset()`](https://docs.validmind.ai/validmind/validmind.html#init_dataset). Wrapping a pandas DataFrame this way lets you pass the dataset into ValidMind tests with the metadata those tests expect.\n", - "\n", - "**ValidMind model**: A model initialized with [`vm.init_model()`](https://docs.validmind.ai/validmind/validmind.html#init_model). In this notebook, we use a lightweight model object to run prompt-validation tests against a prompt template.\n", - "\n", - "**Prompt-validation tests**: Tests that evaluate prompt quality and instructions, such as clarity or bias, using a judge LLM.\n", - "\n", - "**RAGAS tests**: Retrieval-augmented generation tests that can rely on both a judge LLM and judge embeddings.\n", - "\n", - "**DeepEval scorers**: LLM-based scorers used for tasks such as answer relevancy and hallucination detection. These use the evaluation model path but do not require judge embeddings." - ] - }, - { - "cell_type": "markdown", - "id": "322b05cc", - "metadata": {}, - "source": [ - "\n", - "\n", - "## Setting up" - ] - }, - { - "cell_type": "markdown", - "id": "8d6a8300", - "metadata": {}, - "source": [ - "\n", - "\n", - "### Install the ValidMind Library\n", - "\n", - "
    Recommended Python versions\n", - "

    \n", - "Python 3.8 <= x <= 3.14
    \n", - "\n", - "Install the ValidMind Library with the optional LLM dependencies so the notebook can run prompt-validation tests, RAGAS tests, and DeepEval scorers:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "da644666", - "metadata": {}, - "outputs": [], - "source": [ - "%pip install -q \"validmind[llm]\"" - ] - }, - { - "cell_type": "markdown", - "id": "17c1c7d2", - "metadata": {}, - "source": [ - "\n", - "\n", - "### Connect to the ValidMind Platform\n", - "\n", - "If you want to log notebook outputs to the ValidMind Platform, start by selecting an existing model in your inventory or registering a new one. This notebook can run without platform connectivity, but linking it to a model document gives you a place to review the results after the examples finish.\n", - "\n", - "\n", - "\n", - "#### Register or select a model\n", - "\n", - "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/configuration/log-in-to-validmind.html).\n", - "2. Open **Inventory** and either select an existing model or click **+ Register Model**.\n", - "3. Complete the model details and stakeholder assignments if you are registering a new model.\n", - "4. Open the document where you want notebook results to be logged.\n", - "\n", - "Using a real model document is especially helpful in this notebook because it lets you compare the locally executed tests with the sections available in your template." - ] - }, - { - "cell_type": "markdown", - "id": "dc628c6c", - "metadata": {}, - "source": [ - "\n", - "\n", - "#### Choose a documentation template\n", - "\n", - "If you plan to log results from this notebook, make sure your model document uses a template that includes sections for the LLM evaluation results you want to capture.\n", - "\n", - "This is important because tests that are not included in the selected template will not appear automatically in the Platform document, even if you run and log them successfully from the notebook. If you want to document those results as well, you can add the relevant sections or tests manually in the Platform.\n", - "\n", - "Before running the notebook, preview the template structure and confirm that the document has the sections you expect for your workflow." - ] - }, - { - "cell_type": "markdown", - "id": "702f5196", - "metadata": {}, - "source": [ - "\n", - "\n", - "#### Get your code snippet\n", - "\n", - "Initialize the ValidMind Library with the code snippet associated with your model document so that test results are uploaded to the correct destination in the ValidMind Platform.\n", - "\n", - "1. In the model sidebar, open **Getting Started**.\n", - "2. Select the document you want to update.\n", - "3. Copy the generated code snippet.\n", - "4. Load the values from an `.env` file or replace the placeholders in the example below with your own values.\n", - "\n", - "Using environment variables is usually the easiest way to keep the notebook portable across environments and avoid hard-coding connection details in the notebook itself." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "c52a42d0", - "metadata": {}, - "outputs": [], - "source": [ - "# Load your model identifier credentials from an `.env` file\n", - "\n", - "%load_ext dotenv\n", - "%dotenv .env\n", - "\n", - "# Or replace with your code snippet\n", - "\n", - "import validmind as vm\n", - "\n", - "vm.init(\n", - " api_host=\"https://app.prod.validmind.ai/api/v1/tracking\",\n", - " api_key=\"...\",\n", - " api_secret=\"...\",\n", - " document=\"documentation\", # requires library >=2.12.0\n", - " model=\"...\",\n", - ")" - ] - }, - { - "cell_type": "markdown", - "id": "3657a7a4", - "metadata": {}, - "source": [ - "\n", - "\n", - "### Initialize the notebook environment\n", - "\n", - "Load environment variables and prepare the notebook session. In the execution cells that follow, you will import the libraries needed for this walkthrough, inspect the configured judge provider, and create the ValidMind objects used by the example tests.\n", - "\n", - "This section is also where the notebook becomes reproducible: once your credentials and dependencies are in place, the remaining sections can be run top to bottom." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "979988a9", - "metadata": {}, - "outputs": [], - "source": [ - "import os\n", - "\n", - "import pandas as pd\n", - "\n", - "from validmind.ai import utils as ai_utils\n", - "from validmind.models import Prompt\n", - "from validmind.tests import run_test" - ] - }, - { - "cell_type": "markdown", - "id": "3db58d74", - "metadata": {}, - "source": [ - "\n", - "\n", - "## Getting to know ValidMind" - ] - }, - { - "cell_type": "markdown", - "id": "45450d55", - "metadata": {}, - "source": [ - "\n", - "\n", - "### Preview the documentation template\n", - "\n", - "If you have already connected this notebook to a model document, you can preview the active template structure directly from the library.\n", - "\n", - "This is useful for confirming where logged results will appear before you run the prompt-validation, RAGAS, and DeepEval examples below. It also helps you spot gaps early if a test you plan to run is not represented in the current template:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "98f0b602", - "metadata": {}, - "outputs": [], - "source": [ - "vm.preview_template()" - ] - }, - { - "cell_type": "markdown", - "id": "58e1d75f", - "metadata": {}, - "source": [ - "\n", - "\n", - "### View model documentation in the ValidMind Platform\n", - "\n", - "After you run the notebook and log results, open your model document in the ValidMind Platform to review how the test outputs were added.\n", - "\n", - "Comparing the template preview with the rendered document is a good way to confirm that your notebook is writing results to the expected sections. If a result does not appear automatically, check whether the corresponding test is part of the selected template before troubleshooting the notebook run itself." - ] - }, - { - "cell_type": "markdown", - "id": "86038351", - "metadata": {}, - "source": [ - "\n", - "\n", - "## Configure the judge provider\n", - "\n", - "The next cells load your environment variables, resolve the judge provider from the credentials available in your session, and initialize the ValidMind Library for result logging.\n", - "\n", - "This notebook uses the same provider resolution logic as the library itself:\n", - "- OpenAI is selected when `OPENAI_API_KEY` is available, with `OPENAI_MODEL` as an optional override. The current default judge model is `gpt-4.1`.\n", - "- Azure OpenAI is selected when Azure credentials are available, using `AZURE_OPENAI_MODEL` for the judge model.\n", - "- Gemini is selected when `GOOGLE_API_KEY` or `GEMINI_API_KEY` is available, with optional `GEMINI_MODEL` and `GEMINI_EMBEDDINGS_MODEL` overrides. The current defaults are `gemini-2.5-pro` and `models/text-embedding-004`.\n", - "\n", - "If more than one provider is configured, OpenAI takes precedence to match the library default.\n", - "\n", - "This matters because the same default judge configuration is reused across multiple evaluation paths, so checking it once here makes the later test results easier to interpret." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "a3efda1f", - "metadata": {}, - "outputs": [], - "source": [ - "# Optional: override the default judge models for this notebook session.\n", - "# os.environ[\"OPENAI_MODEL\"] = \"gpt-4.1\"\n", - "# os.environ[\"GEMINI_MODEL\"] = \"gemini-2.5-pro\"\n", - "# os.environ[\"GEMINI_EMBEDDINGS_MODEL\"] = \"models/text-embedding-004\"" - ] - }, - { - "cell_type": "markdown", - "id": "f0438cf0", - "metadata": {}, - "source": [ - "The next cells import the required libraries, inspect the resolved provider configuration, and connect the notebook to the ValidMind Platform. Reading the printed provider and class names is a quick sanity check that your environment is using the judge setup you expect before any tests are executed." - ] - }, - { - "cell_type": "markdown", - "id": "089f10fa", - "metadata": {}, - "source": [ - "\n", - "\n", - "### Load credentials and resolve the provider\n", - "\n", - "Run the next cells to:\n", - "- import the libraries used in this notebook\n", - "- inspect the provider selected from your environment\n", - "- inspect the resolved judge LLM and judge embeddings classes\n", - "- initialize the ValidMind Library with your platform credentials\n", - "\n", - "If both OpenAI and Gemini credentials are available, OpenAI will be selected to match the default provider precedence used by the library.\n", - "\n", - "This section gives you a concrete view of the effective configuration that the later prompt-validation, RAGAS, and DeepEval examples will use." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "f1479922", - "metadata": {}, - "outputs": [], - "source": [ - "from validmind.ai.utils import get_client_and_model, get_judge_config\n", - "\n", - "client, model = get_client_and_model()\n", - "judge_llm, judge_embeddings = get_judge_config()\n", - "\n", - "print(\"resolved_model:\", model)\n", - "print(\"judge_llm_type:\", type(judge_llm).__name__)\n", - "print(\"judge_embeddings_type:\", type(judge_embeddings).__name__)\n", - "\n", - "# Useful for Gemini/OpenAI/Azure debugging\n", - "print(\"judge_llm:\", judge_llm)\n", - "print(\"judge_embeddings:\", judge_embeddings)" - ] - }, - { - "cell_type": "markdown", - "id": "e7868c71", - "metadata": {}, - "source": [ - "\n", - "\n", - "## Prompt-validation tests\n", - "\n", - "This section validates the default judge LLM path with two representative prompt-validation tests. For this smoke test, we use a simple prompt-only model because these tests evaluate the prompt template itself and do not require model predictions.\n", - "\n", - "The example below creates a ValidMind model with `vm.init_model()` and attaches a prompt template to it. That gives the tests a standard object to inspect, even though there is no real predictive model behind the example.\n", - "\n", - "- `Clarity` checks whether the prompt instructions are clear and well-scoped.\n", - "- `Bias` checks whether the prompt structure or examples could induce biased behavior." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "7cc07ba8", - "metadata": {}, - "outputs": [], - "source": [ - "system_prompt = \"\"\"\n", - "You are an AI assistant specialized in sentiment analysis for financial news.\n", - "You will classify each sentence as positive, negative, or neutral.\n", - "Respond only with the sentiment label.\n", - "\"\"\".strip()\n", - "\n", - "\n", - "def noop_predict(_):\n", - " return \"dummy\"\n", - "\n", - "\n", - "vm_prompt_model = vm.init_model(\n", - " input_id=\"judge_prompt_model\",\n", - " predict_fn=noop_predict,\n", - " prompt=Prompt(template=system_prompt, variables=[]),\n", - ")\n", - "\n", - "vm_prompt_model.prompt.template" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "40298f6b", - "metadata": {}, - "outputs": [], - "source": [ - "run_test(\n", - " test_id=\"validmind.prompt_validation.Clarity\",\n", - " inputs={\"model\": vm_prompt_model},\n", - ").log()" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "4180b0f1", - "metadata": {}, - "outputs": [], - "source": [ - "run_test(\n", - " test_id=\"validmind.prompt_validation.Bias\",\n", - " inputs={\"model\": vm_prompt_model},\n", - ").log()" - ] - }, - { - "cell_type": "markdown", - "id": "9935d075", - "metadata": {}, - "source": [ - "\n", - "\n", - "## RAGAS tests\n", - "\n", - "This section validates the default judge LLM plus default judge embeddings path. The selected tests are useful because they exercise the RAGAS integration that historically depended on the default OpenAI setup.\n", - "\n", - "The example data is wrapped with `vm.init_dataset()`, which turns the pandas DataFrame into a ValidMind dataset object that can be passed directly into these tests.\n", - "\n", - "- `ResponseRelevancy` exercises the judge LLM and embeddings path.\n", - "- `AnswerCorrectness` exercises semantic and factual comparison with judge embeddings.\n", - "- `Faithfulness` is a companion smoke test for the judge LLM path on RAG data.\n", - "\n", - "These tests produce Plotly figures, so this notebook focuses on running and logging the results rather than comparing visual output in detail." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "17cbf0e3", - "metadata": {}, - "outputs": [], - "source": [ - "rag_df = pd.DataFrame(\n", - " {\n", - " \"user_input\": [\n", - " \"What happened to the company's revenue guidance?\",\n", - " \"Why did the bank's stock decline?\",\n", - " \"What was the announced dividend decision?\",\n", - " ],\n", - " \"retrieved_contexts\": [\n", - " [\n", - " \"The company raised its full-year revenue guidance after reporting strong demand in the enterprise segment.\",\n", - " \"Management said the improved forecast was driven by larger-than-expected renewals.\",\n", - " ],\n", - " [\n", - " \"The bank's stock declined after it reported higher-than-expected credit losses in its consumer portfolio.\",\n", - " \"Executives also warned that provisions may remain elevated next quarter.\",\n", - " ],\n", - " [\n", - " \"The board announced that it would keep the quarterly dividend unchanged.\",\n", - " \"Management said capital return policy remains the same for now.\",\n", - " ],\n", - " ],\n", - " \"response\": [\n", - " \"The company increased its full-year revenue guidance after stronger enterprise demand.\",\n", - " \"The bank's stock fell because it disclosed higher-than-expected credit losses.\",\n", - " \"The company kept its dividend unchanged.\",\n", - " ],\n", - " \"reference\": [\n", - " \"The company raised its full-year revenue guidance because demand in the enterprise segment was strong.\",\n", - " \"The bank's shares dropped after it reported higher-than-expected credit losses.\",\n", - " \"The board decided to leave the quarterly dividend unchanged.\",\n", - " ],\n", - " }\n", - ")\n", - "\n", - "vm_rag_ds = vm.init_dataset(\n", - " dataset=rag_df,\n", - " input_id=\"judge_rag_dataset\",\n", - " text_column=\"user_input\",\n", - " target_column=\"reference\",\n", - ")" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "fcdb6232", - "metadata": {}, - "outputs": [], - "source": [ - "run_test(\n", - " test_id=\"validmind.model_validation.ragas.ResponseRelevancy\",\n", - " inputs={\"dataset\": vm_rag_ds},\n", - ").log()" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "25124a2f", - "metadata": {}, - "outputs": [], - "source": [ - "run_test(\n", - " test_id=\"validmind.model_validation.ragas.AnswerCorrectness\",\n", - " inputs={\"dataset\": vm_rag_ds},\n", - ").log()" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "3a58bd42", - "metadata": {}, - "outputs": [], - "source": [ - "run_test(\n", - " test_id=\"validmind.model_validation.ragas.Faithfulness\",\n", - " inputs={\"dataset\": vm_rag_ds},\n", - ").log()" - ] - }, - { - "cell_type": "markdown", - "id": "8b65420f", - "metadata": {}, - "source": [ - "\n", - "\n", - "## DeepEval scorers\n", - "\n", - "This section validates the default local scorer model path used by DeepEval-based scorers in `validmind.scorers.llm.deepeval`.\n", - "\n", - "As in the RAGAS example, we create a ValidMind dataset with `vm.init_dataset()` so the scorer workflow runs against the same kind of object customers would use in their own notebooks.\n", - "\n", - "These scorers do not use the judge embeddings object. For this notebook, we use two representative examples:\n", - "- `AnswerRelevancy`\n", - "- `Hallucination`\n", - "\n", - "They are included here so the notebook covers all three LLM evaluation surfaces:\n", - "- prompt-validation\n", - "- RAGAS\n", - "- DeepEval scorers" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "c34f2484", - "metadata": {}, - "outputs": [], - "source": [ - "deepeval_df = pd.DataFrame(\n", - " {\n", - " \"input\": [\n", - " \"What is the capital of France?\",\n", - " \"Why did the company raise its full-year guidance?\",\n", - " \"What did the board decide about the quarterly dividend?\",\n", - " ],\n", - " \"actual_output\": [\n", - " \"The capital of France is Paris.\",\n", - " \"The company raised guidance because enterprise demand was stronger than expected.\",\n", - " \"The board kept the quarterly dividend unchanged.\",\n", - " ],\n", - " \"context\": [\n", - " [\"France's capital city is Paris.\"],\n", - " [\n", - " \"Management raised its full-year guidance after reporting stronger-than-expected demand in the enterprise segment.\"\n", - " ],\n", - " [\n", - " \"The board announced that the quarterly dividend would remain unchanged.\"\n", - " ],\n", - " ],\n", - " }\n", - ")\n", - "\n", - "vm_deepeval_ds = vm.init_dataset(\n", - " dataset=deepeval_df,\n", - " input_id=\"judge_deepeval_dataset\",\n", - " text_column=\"input\",\n", - " target_column=\"actual_output\",\n", - ")\n", - "\n", - "deepeval_df" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "9a3cdae0", - "metadata": {}, - "outputs": [], - "source": [ - "vm_deepeval_ds.assign_scores(metrics=[\n", - " \"validmind.scorers.llm.deepeval.Hallucination\",\n", - " \"validmind.scorers.llm.deepeval.AnswerRelevancy\"\n", - "])" - ] - }, - { - "cell_type": "markdown", - "id": "d86a90ab", - "metadata": {}, - "source": [ - "\n", - "\n", - "## In summary\n", - "\n", - "In this notebook, you learned how to:\n", - "- [x] configure the judge provider from environment credentials\n", - "- [x] override the default judge LLM and judge embeddings models\n", - "- [x] initialize ValidMind model and dataset objects for LLM evaluation workflows\n", - "- [x] run prompt-validation tests that use the judge LLM\n", - "- [x] run RAGAS tests that use the judge LLM and judge embeddings\n", - "- [x] run DeepEval scorers that use the local scorer model path" - ] - }, - { - "cell_type": "markdown", - "id": "c7b72b3e", - "metadata": {}, - "source": [ - "\n", - "\n", - "## Next steps\n", - "\n", - "You can use this notebook as a starting point for your own LLM evaluation workflows. A few practical follow-ups are:\n", - "- replace the sample prompt and datasets with your own evaluation inputs\n", - "- set `OPENAI_MODEL` / `OPENAI_EMBEDDINGS_MODEL` when you want to override the OpenAI judge pair, or `GEMINI_MODEL` / `GEMINI_EMBEDDINGS_MODEL` when you want to standardize the Gemini judge pair used across notebooks or environments\n", - "- expand the set of tests and scorers based on your use case" - ] - }, - { - "cell_type": "markdown", - "id": "e5eb12d8", - "metadata": {}, - "source": [ - "\n", - "\n", - "### Discover more learning resources\n", - "\n", - "To continue learning about testing and evaluation with the ValidMind Library, explore:\n", - "\n", - "- [Run tests and test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n", - "- [ValidMind Library overview](https://docs.validmind.ai/developer/validmind-library.html)\n", - "- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n", - "- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n", - "\n", - "You can also visit the [ValidMind documentation](https://docs.validmind.ai/) for broader guidance on configuration, testing workflows, and model documentation." - ] - }, - { - "cell_type": "markdown", - "id": "99a11a0e", - "metadata": {}, - "source": [ - "\n", - "\n", - "## Upgrade ValidMind\n", - "\n", - "
    After installing ValidMind, periodically check that you are using a recent version so you can access the latest provider integrations, tests, and product improvements.
    \n", - "\n", - "Retrieve the information for the currently installed version of ValidMind:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "cfed92f5", - "metadata": {}, - "outputs": [], - "source": [ - "%pip show validmind" - ] - }, - { - "cell_type": "markdown", - "id": "58cc2437", - "metadata": {}, - "source": [ - "If the version returned is lower than the version indicated in our [production open-source code](https://github.com/validmind/validmind-library/blob/prod/validmind/__version__.py), restart your notebook and run:\n", - "\n", - "```bash\n", - "%pip install --upgrade validmind\n", - "```" - ] - }, - { - "cell_type": "markdown", - "id": "aa5c4672", - "metadata": {}, - "source": [ - "You may need to restart your kernel after running the upgrade package for changes to be applied." - ] - }, - { - "cell_type": "markdown", - "id": "copyright-fe0b013da3464949b043e9dbdd34b608", - "metadata": {}, - "source": [ - "\n", - "\n", - "\n", - "\n", - "***\n", - "\n", - "Copyright © 2023-2026 ValidMind Inc. All rights reserved.
    \n", - "Refer to [LICENSE](https://github.com/validmind/validmind-library/blob/main/LICENSE) for details.
    \n", - "SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial    " - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": ".venv-py31111", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.11.11" - } - }, - "nbformat": 4, - "nbformat_minor": 5 -} + "cells": [ + { + "cell_type": "markdown", + "id": "0935afb5", + "metadata": {}, + "source": "# Configure judge LLM and judge embeddings\n\nThis notebook shows how to configure and validate the default judge LLM and judge embeddings used by the ValidMind Library for LLM-focused tests.\n\nIt exercises three important paths:\n1. Prompt-validation tests, which depend on the default judge LLM.\n2. RAGAS-based tests, which depend on both the default judge LLM and the default judge embeddings model.\n3. DeepEval scorers, which use the judge LLM configured via `set_judge_config()`.\n\nThe notebook automatically selects the available provider from your environment, with OpenAI taking precedence when both OpenAI and Gemini keys are set, to match the library's default-provider logic." + }, + { + "cell_type": "markdown", + "id": "1f2befa6", + "metadata": {}, + "source": [ + "::: {.content-hidden when-format=\"html\"}\n", + "## Contents\n", + "- [Introduction](#toc1__)\n", + "- [About ValidMind](#toc2__)\n", + " - [Before you begin](#toc2_1__)\n", + " - [New to ValidMind?](#toc2_2__)\n", + " - [Key concepts](#toc2_3__)\n", + "- [Setting up](#toc3__)\n", + " - [Install the ValidMind Library](#toc3_1__)\n", + " - [Connect to the ValidMind Platform](#toc3_2__)\n", + " - [Register or select a model](#toc3_2_1__)\n", + " - [Choose a documentation template](#toc3_2_2__)\n", + " - [Get your code snippet](#toc3_2_3__)\n", + " - [Initialize the notebook environment](#toc3_3__)\n", + "- [Getting to know ValidMind](#toc4__)\n", + " - [Preview the documentation template](#toc4_1__)\n", + " - [View model documentation in the ValidMind Platform](#toc4_2__)\n", + "- [Configure the judge provider](#toc5__)\n", + "- [Prompt-validation tests](#toc6__)\n", + "- [RAGAS tests](#toc7__)\n", + "- [DeepEval scorers](#toc8__)\n", + "- [In summary](#toc9__)\n", + "- [Next steps](#toc10__)\n", + " - [Discover more learning resources](#toc10_1__)\n", + "- [Upgrade ValidMind](#toc11__)\n", + "\n", + ":::\n", + "\n", + "" + ] + }, + { + "cell_type": "markdown", + "id": "b77005b8", + "metadata": {}, + "source": [ + "\n", + "\n", + "## Introduction\n", + "\n", + "This notebook shows how to configure and validate the default judge LLM and judge embeddings used by the ValidMind Library for LLM-focused tests.\n", + "\n", + "It walks through the provider configuration used by three important evaluation paths:\n", + "- prompt-validation tests\n", + "- RAGAS-based tests\n", + "- DeepEval scorers\n", + "\n", + "Along the way, you will initialize ValidMind model and dataset objects, inspect the resolved judge configuration, run representative tests, and optionally log the results to the ValidMind Platform. By the end of the notebook, you will have a practical reference for configuring judge models and understanding how those settings affect different LLM evaluation workflows." + ] + }, + { + "cell_type": "markdown", + "id": "56ecff8d", + "metadata": {}, + "source": [ + "\n", + "\n", + "## About ValidMind\n", + "\n", + "ValidMind is a suite of tools for managing model risk, including risk associated with AI and statistical models. \n", + "\n", + "You use the ValidMind Library to automate documentation and validation tests, and then use the ValidMind Platform to collaborate on model documentation. Together, these products simplify model risk management, facilitate compliance with regulations and institutional standards, and enhance collaboration between yourself and model validators." + ] + }, + { + "cell_type": "markdown", + "id": "e8743d30", + "metadata": {}, + "source": [ + "\n", + "\n", + "### Before you begin\n", + "\n", + "Before running this notebook, make sure you have:\n", + "- a Python environment with the ValidMind Library and its LLM dependencies installed\n", + "- access to a ValidMind account if you want to log results to the ValidMind Platform\n", + "- credentials for one supported judge provider in your environment\n", + "\n", + "This notebook supports:\n", + "- OpenAI via `OPENAI_API_KEY`, with optional `OPENAI_MODEL` and `OPENAI_EMBEDDINGS_MODEL` overrides. The current default judge model is `gpt-4.1` and the default embeddings model is `text-embedding-3-small`.\n", + "- Gemini via `GOOGLE_API_KEY` or `GEMINI_API_KEY`, with optional `GEMINI_MODEL` and `GEMINI_EMBEDDINGS_MODEL` overrides. The current defaults are `gemini-2.5-pro` and `models/text-embedding-004`.\n", + "- Azure OpenAI via `AZURE_OPENAI_KEY`, `AZURE_OPENAI_ENDPOINT`, and `AZURE_OPENAI_MODEL`. The current default embeddings model is `text-embedding-3-small`.\n", + "\n", + "You can still run the notebook locally without connecting to the ValidMind Platform, but connecting a model document makes it easier to review and share results after the tests complete." + ] + }, + { + "cell_type": "markdown", + "id": "ee479eb5", + "metadata": {}, + "source": [ + "\n", + "\n", + "### New to ValidMind?\n", + "\n", + "If you are new to the ValidMind Library, start with the [ValidMind Library overview](https://docs.validmind.ai/developer/validmind-library.html). It introduces the core workflow for initializing models and datasets, running tests, and logging outputs back to the ValidMind Platform.\n", + "\n", + "
    You only need a ValidMind account if you want to log results to the ValidMind Platform.\n", + "

    \n", + "Register with ValidMind
    " + ] + }, + { + "cell_type": "markdown", + "id": "689e55db", + "metadata": {}, + "source": "\n\n### Key concepts\n\n**Judge LLM**: The language model used by ValidMind to evaluate prompts, answers, contexts, and other LLM outputs.\n\n**Judge embeddings**: The embeddings model used when a test requires semantic similarity or retrieval-based comparison.\n\n**Provider credentials**: Environment variables that tell ValidMind which provider to use for judge evaluation. In this notebook, the provider is resolved automatically from the credentials available in your environment.\n\n**ValidMind dataset**: A dataset initialized with [`vm.init_dataset()`](https://docs.validmind.ai/validmind/validmind.html#init_dataset). Wrapping a pandas DataFrame this way lets you pass the dataset into ValidMind tests with the metadata those tests expect.\n\n**ValidMind model**: A model initialized with [`vm.init_model()`](https://docs.validmind.ai/validmind/validmind.html#init_model). In this notebook, we use a lightweight model object to run prompt-validation tests against a prompt template.\n\n**Prompt-validation tests**: Tests that evaluate prompt quality and instructions, such as clarity or bias, using a judge LLM.\n\n**RAGAS tests**: Retrieval-augmented generation tests that can rely on both a judge LLM and judge embeddings.\n\n**DeepEval scorers**: LLM-based scorers used for tasks such as answer relevancy and hallucination detection. These use the judge LLM configured via `set_judge_config()` and do not require judge embeddings." + }, + { + "cell_type": "markdown", + "id": "322b05cc", + "metadata": {}, + "source": [ + "\n", + "\n", + "## Setting up" + ] + }, + { + "cell_type": "markdown", + "id": "8d6a8300", + "metadata": {}, + "source": [ + "\n", + "\n", + "### Install the ValidMind Library\n", + "\n", + "
    Recommended Python versions\n", + "

    \n", + "Python 3.8 <= x <= 3.14
    \n", + "\n", + "Install the ValidMind Library with the optional LLM dependencies so the notebook can run prompt-validation tests, RAGAS tests, and DeepEval scorers:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "da644666", + "metadata": {}, + "outputs": [], + "source": [ + "%pip install -q \"validmind[llm]\"" + ] + }, + { + "cell_type": "markdown", + "id": "17c1c7d2", + "metadata": {}, + "source": [ + "\n", + "\n", + "### Connect to the ValidMind Platform\n", + "\n", + "If you want to log notebook outputs to the ValidMind Platform, start by selecting an existing model in your inventory or registering a new one. This notebook can run without platform connectivity, but linking it to a model document gives you a place to review the results after the examples finish.\n", + "\n", + "\n", + "\n", + "#### Register or select a model\n", + "\n", + "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/access/log-in-to-validmind.html).\n", + "\n", + "2. In the left sidebar, select **Inventory**.\n", + "\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record.\n", + "\n", + "4. Either select an existing model from the list, or click **+ Register Model** to register a new one.\n", + "\n", + "5. Complete the model details and stakeholder assignments if you are registering a new model.\n", + "\n", + "6. Open the document where you want notebook results to be logged.\n", + "\n", + "Using a real model document is especially helpful in this notebook because it lets you compare the locally executed tests with the sections available in your template." + ] + }, + { + "cell_type": "markdown", + "id": "dc628c6c", + "metadata": {}, + "source": [ + "\n", + "\n", + "#### Choose a documentation template\n", + "\n", + "If you plan to log results from this notebook, make sure your model document uses a template that includes sections for the LLM evaluation results you want to capture.\n", + "\n", + "This is important because tests that are not included in the selected template will not appear automatically in the Platform document, even if you run and log them successfully from the notebook. If you want to document those results as well, you can add the relevant sections or tests manually in the Platform.\n", + "\n", + "Before running the notebook, preview the template structure and confirm that the document has the sections you expect for your workflow." + ] + }, + { + "cell_type": "markdown", + "id": "702f5196", + "metadata": {}, + "source": [ + "\n", + "\n", + "#### Get your code snippet\n", + "\n", + "Initialize the ValidMind Library with the code snippet associated with your model document so that test results are uploaded to the correct destination in the ValidMind Platform.\n", + "\n", + "1. In the model sidebar, open **Getting Started**.\n", + "2. Select the document you want to update.\n", + "3. Copy the generated code snippet.\n", + "4. Load the values from an `.env` file or replace the placeholders in the example below with your own values.\n", + "\n", + "Using environment variables is usually the easiest way to keep the notebook portable across environments and avoid hard-coding connection details in the notebook itself." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "c52a42d0", + "metadata": {}, + "outputs": [], + "source": [ + "# Load your model identifier credentials from an `.env` file\n", + "\n", + "%load_ext dotenv\n", + "%dotenv .env\n", + "\n", + "# Or replace with your code snippet\n", + "\n", + "import validmind as vm\n", + "\n", + "vm.init(\n", + " api_host=\"https://app.prod.validmind.ai/api/v1/tracking\",\n", + " api_key=\"...\",\n", + " api_secret=\"...\",\n", + " document=\"documentation\", # requires library >=2.12.0\n", + " model=\"...\",\n", + ")" + ] + }, + { + "cell_type": "markdown", + "id": "3657a7a4", + "metadata": {}, + "source": [ + "\n", + "\n", + "### Initialize the notebook environment\n", + "\n", + "Load environment variables and prepare the notebook session. In the execution cells that follow, you will import the libraries needed for this walkthrough, inspect the configured judge provider, and create the ValidMind objects used by the example tests.\n", + "\n", + "This section is also where the notebook becomes reproducible: once your credentials and dependencies are in place, the remaining sections can be run top to bottom." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "979988a9", + "metadata": {}, + "outputs": [], + "source": [ + "import os\n", + "\n", + "import pandas as pd\n", + "\n", + "from validmind.ai import utils as ai_utils\n", + "from validmind.models import Prompt\n", + "from validmind.tests import run_test" + ] + }, + { + "cell_type": "markdown", + "id": "3db58d74", + "metadata": {}, + "source": [ + "\n", + "\n", + "## Getting to know ValidMind" + ] + }, + { + "cell_type": "markdown", + "id": "45450d55", + "metadata": {}, + "source": [ + "\n", + "\n", + "### Preview the documentation template\n", + "\n", + "If you have already connected this notebook to a model document, you can preview the active template structure directly from the library.\n", + "\n", + "This is useful for confirming where logged results will appear before you run the prompt-validation, RAGAS, and DeepEval examples below. It also helps you spot gaps early if a test you plan to run is not represented in the current template:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "98f0b602", + "metadata": {}, + "outputs": [], + "source": [ + "vm.preview_template()" + ] + }, + { + "cell_type": "markdown", + "id": "58e1d75f", + "metadata": {}, + "source": [ + "\n", + "\n", + "### View model documentation in the ValidMind Platform\n", + "\n", + "After you run the notebook and log results, open your model document in the ValidMind Platform to review how the test outputs were added.\n", + "\n", + "Comparing the template preview with the rendered document is a good way to confirm that your notebook is writing results to the expected sections. If a result does not appear automatically, check whether the corresponding test is part of the selected template before troubleshooting the notebook run itself." + ] + }, + { + "cell_type": "markdown", + "id": "86038351", + "metadata": {}, + "source": [ + "\n", + "\n", + "## Configure the judge provider\n", + "\n", + "The next cells load your environment variables, resolve the judge provider from the credentials available in your session, and initialize the ValidMind Library for result logging.\n", + "\n", + "This notebook uses the same provider resolution logic as the library itself:\n", + "- OpenAI is selected when `OPENAI_API_KEY` is available, with `OPENAI_MODEL` as an optional override. The current default judge model is `gpt-4.1`.\n", + "- Azure OpenAI is selected when Azure credentials are available, using `AZURE_OPENAI_MODEL` for the judge model.\n", + "- Gemini is selected when `GOOGLE_API_KEY` or `GEMINI_API_KEY` is available, with optional `GEMINI_MODEL` and `GEMINI_EMBEDDINGS_MODEL` overrides. The current defaults are `gemini-2.5-pro` and `models/text-embedding-004`.\n", + "\n", + "If more than one provider is configured, OpenAI takes precedence to match the library default.\n", + "\n", + "This matters because the same default judge configuration is reused across multiple evaluation paths, so checking it once here makes the later test results easier to interpret." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "a3efda1f", + "metadata": {}, + "outputs": [], + "source": [ + "# Optional: override the default judge models for this notebook session.\n", + "# os.environ[\"OPENAI_MODEL\"] = \"gpt-4.1\"\n", + "# os.environ[\"GEMINI_MODEL\"] = \"gemini-2.5-pro\"\n", + "# os.environ[\"GEMINI_EMBEDDINGS_MODEL\"] = \"models/text-embedding-004\"" + ] + }, + { + "cell_type": "code", + "id": "e86433ec", + "source": "# Optional: explicitly set the judge LLM and embeddings using set_judge_config().\n#\n# This overrides automatic provider detection and applies to all three evaluation\n# paths in this notebook: prompt-validation tests, RAGAS tests, and DeepEval scorers.\n#\n# from langchain_google_genai import ChatGoogleGenerativeAI, GoogleGenerativeAIEmbeddings\n# from validmind.ai.utils import set_judge_config\n# set_judge_config(\n# judge_llm=ChatGoogleGenerativeAI(model=\"gemini-2.0-flash\"),\n# judge_embeddings=GoogleGenerativeAIEmbeddings(model=\"models/text-embedding-004\"),\n# )", + "metadata": {}, + "execution_count": null, + "outputs": [] + }, + { + "cell_type": "markdown", + "id": "f0438cf0", + "metadata": {}, + "source": [ + "The next cells import the required libraries, inspect the resolved provider configuration, and connect the notebook to the ValidMind Platform. Reading the printed provider and class names is a quick sanity check that your environment is using the judge setup you expect before any tests are executed." + ] + }, + { + "cell_type": "markdown", + "id": "089f10fa", + "metadata": {}, + "source": [ + "\n", + "\n", + "### Load credentials and resolve the provider\n", + "\n", + "Run the next cells to:\n", + "- import the libraries used in this notebook\n", + "- inspect the provider selected from your environment\n", + "- inspect the resolved judge LLM and judge embeddings classes\n", + "- initialize the ValidMind Library with your platform credentials\n", + "\n", + "If both OpenAI and Gemini credentials are available, OpenAI will be selected to match the default provider precedence used by the library.\n", + "\n", + "This section gives you a concrete view of the effective configuration that the later prompt-validation, RAGAS, and DeepEval examples will use." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "f1479922", + "metadata": {}, + "outputs": [], + "source": [ + "from validmind.ai.utils import get_client_and_model, get_judge_config\n", + "\n", + "client, model = get_client_and_model()\n", + "judge_llm, judge_embeddings = get_judge_config()\n", + "\n", + "print(\"resolved_model:\", model)\n", + "print(\"judge_llm_type:\", type(judge_llm).__name__)\n", + "print(\"judge_embeddings_type:\", type(judge_embeddings).__name__)\n", + "\n", + "# Useful for Gemini/OpenAI/Azure debugging\n", + "print(\"judge_llm:\", judge_llm)\n", + "print(\"judge_embeddings:\", judge_embeddings)" + ] + }, + { + "cell_type": "markdown", + "id": "e7868c71", + "metadata": {}, + "source": [ + "\n", + "\n", + "## Prompt-validation tests\n", + "\n", + "This section validates the default judge LLM path with two representative prompt-validation tests. For this smoke test, we use a simple prompt-only model because these tests evaluate the prompt template itself and do not require model predictions.\n", + "\n", + "The example below creates a ValidMind model with `vm.init_model()` and attaches a prompt template to it. That gives the tests a standard object to inspect, even though there is no real predictive model behind the example.\n", + "\n", + "- `Clarity` checks whether the prompt instructions are clear and well-scoped.\n", + "- `Bias` checks whether the prompt structure or examples could induce biased behavior." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "7cc07ba8", + "metadata": {}, + "outputs": [], + "source": [ + "system_prompt = \"\"\"\n", + "You are an AI assistant specialized in sentiment analysis for financial news.\n", + "You will classify each sentence as positive, negative, or neutral.\n", + "Respond only with the sentiment label.\n", + "\"\"\".strip()\n", + "\n", + "\n", + "def noop_predict(_):\n", + " return \"dummy\"\n", + "\n", + "\n", + "vm_prompt_model = vm.init_model(\n", + " input_id=\"judge_prompt_model\",\n", + " predict_fn=noop_predict,\n", + " prompt=Prompt(template=system_prompt, variables=[]),\n", + ")\n", + "\n", + "vm_prompt_model.prompt.template" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "40298f6b", + "metadata": {}, + "outputs": [], + "source": [ + "run_test(\n", + " test_id=\"validmind.prompt_validation.Clarity\",\n", + " inputs={\"model\": vm_prompt_model},\n", + ").log()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "4180b0f1", + "metadata": {}, + "outputs": [], + "source": [ + "run_test(\n", + " test_id=\"validmind.prompt_validation.Bias\",\n", + " inputs={\"model\": vm_prompt_model},\n", + ").log()" + ] + }, + { + "cell_type": "markdown", + "id": "9935d075", + "metadata": {}, + "source": [ + "\n", + "\n", + "## RAGAS tests\n", + "\n", + "This section validates the default judge LLM plus default judge embeddings path. The selected tests are useful because they exercise the RAGAS integration that historically depended on the default OpenAI setup.\n", + "\n", + "The example data is wrapped with `vm.init_dataset()`, which turns the pandas DataFrame into a ValidMind dataset object that can be passed directly into these tests.\n", + "\n", + "- `ResponseRelevancy` exercises the judge LLM and embeddings path.\n", + "- `AnswerCorrectness` exercises semantic and factual comparison with judge embeddings.\n", + "- `Faithfulness` is a companion smoke test for the judge LLM path on RAG data.\n", + "\n", + "These tests produce Plotly figures, so this notebook focuses on running and logging the results rather than comparing visual output in detail." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "17cbf0e3", + "metadata": {}, + "outputs": [], + "source": [ + "rag_df = pd.DataFrame(\n", + " {\n", + " \"user_input\": [\n", + " \"What happened to the company's revenue guidance?\",\n", + " \"Why did the bank's stock decline?\",\n", + " \"What was the announced dividend decision?\",\n", + " ],\n", + " \"retrieved_contexts\": [\n", + " [\n", + " \"The company raised its full-year revenue guidance after reporting strong demand in the enterprise segment.\",\n", + " \"Management said the improved forecast was driven by larger-than-expected renewals.\",\n", + " ],\n", + " [\n", + " \"The bank's stock declined after it reported higher-than-expected credit losses in its consumer portfolio.\",\n", + " \"Executives also warned that provisions may remain elevated next quarter.\",\n", + " ],\n", + " [\n", + " \"The board announced that it would keep the quarterly dividend unchanged.\",\n", + " \"Management said capital return policy remains the same for now.\",\n", + " ],\n", + " ],\n", + " \"response\": [\n", + " \"The company increased its full-year revenue guidance after stronger enterprise demand.\",\n", + " \"The bank's stock fell because it disclosed higher-than-expected credit losses.\",\n", + " \"The company kept its dividend unchanged.\",\n", + " ],\n", + " \"reference\": [\n", + " \"The company raised its full-year revenue guidance because demand in the enterprise segment was strong.\",\n", + " \"The bank's shares dropped after it reported higher-than-expected credit losses.\",\n", + " \"The board decided to leave the quarterly dividend unchanged.\",\n", + " ],\n", + " }\n", + ")\n", + "\n", + "vm_rag_ds = vm.init_dataset(\n", + " dataset=rag_df,\n", + " input_id=\"judge_rag_dataset\",\n", + " text_column=\"user_input\",\n", + " target_column=\"reference\",\n", + ")" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "fcdb6232", + "metadata": {}, + "outputs": [], + "source": [ + "run_test(\n", + " test_id=\"validmind.model_validation.ragas.ResponseRelevancy\",\n", + " inputs={\"dataset\": vm_rag_ds},\n", + ").log()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "25124a2f", + "metadata": {}, + "outputs": [], + "source": [ + "run_test(\n", + " test_id=\"validmind.model_validation.ragas.AnswerCorrectness\",\n", + " inputs={\"dataset\": vm_rag_ds},\n", + ").log()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3a58bd42", + "metadata": {}, + "outputs": [], + "source": [ + "run_test(\n", + " test_id=\"validmind.model_validation.ragas.Faithfulness\",\n", + " inputs={\"dataset\": vm_rag_ds},\n", + ").log()" + ] + }, + { + "cell_type": "markdown", + "id": "8b65420f", + "metadata": {}, + "source": "\n\n## DeepEval scorers\n\nThis section validates the DeepEval scorer path in `validmind.scorers.llm.deepeval`.\n\nDeepEval scorers use the judge LLM configured via `set_judge_config()` — the same model used by prompt-validation and RAGAS tests. This means any provider you configure above (OpenAI, Gemini, Azure, or Vertex AI via `langchain-google-vertexai`) is automatically picked up by scorers without any additional setup.\n\nAs in the RAGAS example, we create a ValidMind dataset with `vm.init_dataset()` so the scorer workflow runs against the same kind of object customers would use in their own notebooks.\n\nThese scorers do not use the judge embeddings object. For this notebook, we use two representative examples:\n- `AnswerRelevancy`\n- `Hallucination`\n\nThey are included here so the notebook covers all three LLM evaluation surfaces:\n- prompt-validation\n- RAGAS\n- DeepEval scorers" + }, + { + "cell_type": "code", + "execution_count": null, + "id": "c34f2484", + "metadata": {}, + "outputs": [], + "source": [ + "deepeval_df = pd.DataFrame(\n", + " {\n", + " \"input\": [\n", + " \"What is the capital of France?\",\n", + " \"Why did the company raise its full-year guidance?\",\n", + " \"What did the board decide about the quarterly dividend?\",\n", + " ],\n", + " \"actual_output\": [\n", + " \"The capital of France is Paris.\",\n", + " \"The company raised guidance because enterprise demand was stronger than expected.\",\n", + " \"The board kept the quarterly dividend unchanged.\",\n", + " ],\n", + " \"context\": [\n", + " [\"France's capital city is Paris.\"],\n", + " [\n", + " \"Management raised its full-year guidance after reporting stronger-than-expected demand in the enterprise segment.\"\n", + " ],\n", + " [\n", + " \"The board announced that the quarterly dividend would remain unchanged.\"\n", + " ],\n", + " ],\n", + " }\n", + ")\n", + "\n", + "vm_deepeval_ds = vm.init_dataset(\n", + " dataset=deepeval_df,\n", + " input_id=\"judge_deepeval_dataset\",\n", + " text_column=\"input\",\n", + " target_column=\"actual_output\",\n", + ")\n", + "\n", + "deepeval_df" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "9a3cdae0", + "metadata": {}, + "outputs": [], + "source": [ + "vm_deepeval_ds.assign_scores(metrics=[\n", + " \"validmind.scorers.llm.deepeval.Hallucination\",\n", + " \"validmind.scorers.llm.deepeval.AnswerRelevancy\"\n", + "])" + ] + }, + { + "cell_type": "markdown", + "id": "d86a90ab", + "metadata": {}, + "source": "\n\n## In summary\n\nIn this notebook, you learned how to:\n- [x] configure the judge provider from environment credentials\n- [x] override the default judge LLM and judge embeddings models\n- [x] use `set_judge_config()` to explicitly set the judge for any provider, including Vertex AI\n- [x] initialize ValidMind model and dataset objects for LLM evaluation workflows\n- [x] run prompt-validation tests that use the judge LLM\n- [x] run RAGAS tests that use the judge LLM and judge embeddings\n- [x] run DeepEval scorers that use the configured judge LLM" + }, + { + "cell_type": "markdown", + "id": "c7b72b3e", + "metadata": {}, + "source": "\n\n## Next steps\n\nYou can use this notebook as a starting point for your own LLM evaluation workflows. A few practical follow-ups are:\n- replace the sample prompt and datasets with your own evaluation inputs\n- set `OPENAI_MODEL` / `OPENAI_EMBEDDINGS_MODEL` when you want to override the OpenAI judge pair, or `GEMINI_MODEL` / `GEMINI_EMBEDDINGS_MODEL` when you want to standardize the Gemini judge pair used across notebooks or environments\n- use `set_judge_config()` to explicitly wire a specific judge LLM and embeddings model — this applies to all evaluation paths, including DeepEval scorers\n- expand the set of tests and scorers based on your use case" + }, + { + "cell_type": "markdown", + "id": "e5eb12d8", + "metadata": {}, + "source": [ + "\n", + "\n", + "### Discover more learning resources\n", + "\n", + "To continue learning about testing and evaluation with the ValidMind Library, explore:\n", + "\n", + "- [Run tests and test suites](https://docs.validmind.ai/developer/how-to/testing-overview.html)\n", + "- [ValidMind Library overview](https://docs.validmind.ai/developer/validmind-library.html)\n", + "- [Use ValidMind Library features](https://docs.validmind.ai/developer/how-to/feature-overview.html)\n", + "- [Code samples by use case](https://docs.validmind.ai/guide/samples-jupyter-notebooks.html)\n", + "\n", + "You can also visit the [ValidMind documentation](https://docs.validmind.ai/) for broader guidance on configuration, testing workflows, and model documentation." + ] + }, + { + "cell_type": "markdown", + "id": "99a11a0e", + "metadata": {}, + "source": [ + "\n", + "\n", + "## Upgrade ValidMind\n", + "\n", + "
    After installing ValidMind, periodically check that you are using a recent version so you can access the latest provider integrations, tests, and product improvements.
    \n", + "\n", + "Retrieve the information for the currently installed version of ValidMind:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "cfed92f5", + "metadata": {}, + "outputs": [], + "source": [ + "%pip show validmind" + ] + }, + { + "cell_type": "markdown", + "id": "58cc2437", + "metadata": {}, + "source": [ + "If the version returned is lower than the version indicated in our [production open-source code](https://github.com/validmind/validmind-library/blob/prod/validmind/__version__.py), restart your notebook and run:\n", + "\n", + "```bash\n", + "%pip install --upgrade validmind\n", + "```" + ] + }, + { + "cell_type": "markdown", + "id": "aa5c4672", + "metadata": {}, + "source": [ + "You may need to restart your kernel after running the upgrade package for changes to be applied." + ] + }, + { + "cell_type": "markdown", + "id": "copyright-fe0b013da3464949b043e9dbdd34b608", + "metadata": {}, + "source": [ + "\n", + "\n", + "\n", + "\n", + "***\n", + "\n", + "Copyright © 2023-2026 ValidMind Inc. All rights reserved.
    \n", + "Refer to [LICENSE](https://github.com/validmind/validmind-library/blob/main/LICENSE) for details.
    \n", + "SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial    " + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".venv-py31111", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.11" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} \ No newline at end of file diff --git a/site/notebooks/how_to/tests/run_tests/configure_tests/customize_test_result_descriptions.ipynb b/site/notebooks/how_to/tests/run_tests/configure_tests/customize_test_result_descriptions.ipynb index 9a0ae2e2dc..c8aa22b65f 100644 --- a/site/notebooks/how_to/tests/run_tests/configure_tests/customize_test_result_descriptions.ipynb +++ b/site/notebooks/how_to/tests/run_tests/configure_tests/customize_test_result_descriptions.ipynb @@ -119,13 +119,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -142,7 +144,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -157,7 +159,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/run_tests/configure_tests/enable_pii_detection.ipynb b/site/notebooks/how_to/tests/run_tests/configure_tests/enable_pii_detection.ipynb index bc07a3cffe..c5ee50f1bd 100644 --- a/site/notebooks/how_to/tests/run_tests/configure_tests/enable_pii_detection.ipynb +++ b/site/notebooks/how_to/tests/run_tests/configure_tests/enable_pii_detection.ipynb @@ -197,7 +197,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/run_tests/configure_tests/run_tests_that_require_multiple_datasets.ipynb b/site/notebooks/how_to/tests/run_tests/configure_tests/run_tests_that_require_multiple_datasets.ipynb index 6a4b81ba2d..c65f864943 100644 --- a/site/notebooks/how_to/tests/run_tests/configure_tests/run_tests_that_require_multiple_datasets.ipynb +++ b/site/notebooks/how_to/tests/run_tests/configure_tests/run_tests_that_require_multiple_datasets.ipynb @@ -172,13 +172,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -195,7 +197,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -210,7 +212,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/run_tests/documentation_tests/document_multiple_results_for_the_same_test.ipynb b/site/notebooks/how_to/tests/run_tests/documentation_tests/document_multiple_results_for_the_same_test.ipynb index fc7446d036..361c2ad0b5 100644 --- a/site/notebooks/how_to/tests/run_tests/documentation_tests/document_multiple_results_for_the_same_test.ipynb +++ b/site/notebooks/how_to/tests/run_tests/documentation_tests/document_multiple_results_for_the_same_test.ipynb @@ -179,13 +179,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -202,7 +204,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -217,7 +219,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/run_tests/documentation_tests/run_documentation_sections.ipynb b/site/notebooks/how_to/tests/run_tests/documentation_tests/run_documentation_sections.ipynb index 42ef742f8e..e000af92c6 100644 --- a/site/notebooks/how_to/tests/run_tests/documentation_tests/run_documentation_sections.ipynb +++ b/site/notebooks/how_to/tests/run_tests/documentation_tests/run_documentation_sections.ipynb @@ -170,13 +170,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -193,7 +195,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -208,7 +210,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/how_to/tests/run_tests/documentation_tests/run_documentation_tests_with_config.ipynb b/site/notebooks/how_to/tests/run_tests/documentation_tests/run_documentation_tests_with_config.ipynb index 48a3e439d8..1ea3fad26e 100644 --- a/site/notebooks/how_to/tests/run_tests/documentation_tests/run_documentation_tests_with_config.ipynb +++ b/site/notebooks/how_to/tests/run_tests/documentation_tests/run_documentation_tests_with_config.ipynb @@ -174,13 +174,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -197,7 +199,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -212,7 +214,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/quickstart/quickstart_documentation.Rmd b/site/notebooks/quickstart/quickstart_documentation.Rmd index d9bfdc2c56..f50f1505ff 100644 --- a/site/notebooks/quickstart/quickstart_documentation.Rmd +++ b/site/notebooks/quickstart/quickstart_documentation.Rmd @@ -47,13 +47,15 @@ Log in to the [ValidMind Platform](https://app.prod.validmind.ai) and register a 1. In the left sidebar, select **Inventory**. -2. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html)) +2. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html)) -3. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders. +3. Click **+ Register Model**. -4. Select your own name under the **RECORD OWNER** drop-down. +4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders. -5. Click **Register Model** to add the model to your inventory. +5. Select your own name under the **Record Owner** drop-down. + +6. Click **Register Model** to add the model to your inventory. #### Apply documentation template @@ -61,7 +63,7 @@ Once you've registered your model, let's select a documentation template. A temp 1. In the left sidebar that appears for your model, click **Documents** and select **Development**. -2. Under **TEMPLATE**, select `Binary classification`. +2. Under **Template**, select `Binary classification`. 3. Click **Use Template** to apply the template. @@ -69,7 +71,7 @@ Once you've registered your model, let's select a documentation template. A temp Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library. -1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu. +1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu. 2. Click **Copy snippet to clipboard**. Paste the snippet into an editor and make note of the credentials. diff --git a/site/notebooks/quickstart/quickstart_documentation.ipynb b/site/notebooks/quickstart/quickstart_documentation.ipynb index 033e023454..8b93353c9f 100644 --- a/site/notebooks/quickstart/quickstart_documentation.ipynb +++ b/site/notebooks/quickstart/quickstart_documentation.ipynb @@ -231,13 +231,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -255,7 +257,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -271,7 +273,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb b/site/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb index 9fff9205a5..f2de9aadac 100644 --- a/site/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb +++ b/site/notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb @@ -125,7 +125,7 @@ "\n", "
    For access to all features available in this notebook, you'll need access to a ValidMind account.\n", "

    \n", - "Register with ValidMind
    " + "Register with ValidMind" ] }, { @@ -224,15 +224,19 @@ "\n", "Let's first register a sample model for use with this notebook:\n", "\n", - "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/configuration/log-in-to-validmind.html).\n", + "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/access/log-in-to-validmind.html).\n", "\n", - "2. In the left sidebar, navigate to **Inventory** and click **+ Register Model**.\n", + "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Enter the model details and click **Next >** to continue to assignment of model stakeholders. ([Need more help?](https://docs.validmind.ai/guide/model-inventory/register-models-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record.\n", "\n", - "4. Select your own name under the **MODEL OWNER** drop-down.\n", + "4. Click **+ Register Model**.\n", "\n", - "5. Click **Register Model** to add the model to your inventory." + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders. ([Need more help?](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -248,7 +252,7 @@ "\n", "1. In the left sidebar that appears for your model, click **Documents** and select **Development**.\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -264,7 +268,7 @@ "\n", "Point the library at the correct **model** and **tracking API**, and supply OIDC **issuer** / **client_id** values your organization registered for device flow. If you see 401/403 responses after signing in at your IdP, verify **audience** and **scope** with your administrator.\n", "\n", - "1. In the ValidMind Platform, open your model → **Getting Started** → **DOCUMENT** `Development` so you can copy the **model CUID** (same identifier as in the API-key snippet).\n", + "1. In the ValidMind Platform, open your model → **Getting Started** → **Document** `Development` so you can copy the **model CUID** (same identifier as in the API-key snippet).\n", "2. Fill in `issuer`, `client_id`, `model`, and `api_host` below. Use optional `audience` / `scope` if your platform team specified them.\n", "3. Run the cell. Complete browser sign-in if prompted; when polling succeeds, continue with the rest of the notebook.\n", "\n", @@ -367,7 +371,7 @@ "\n", "Next, let's head to the ValidMind Platform to see the template in action:\n", "\n", - "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/configuration/log-in-to-validmind.html).\n", + "1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/access/log-in-to-validmind.html).\n", "\n", "2. In the left sidebar, navigate to **Inventory** and select the model you registered for this notebook.\n", "\n", @@ -782,7 +786,7 @@ "\n", "### Work with your model documentation\n", "\n", - "1. From the **Inventory** in the ValidMind Platform, go to the model you registered earlier. ([Need more help?](https://docs.validmind.ai/guide/model-inventory/working-with-model-inventory.html))\n", + "1. From the **Inventory** in the ValidMind Platform, go to the model you registered earlier. ([Need more help?](https://docs.validmind.ai/guide/inventory/working-with-the-inventory.html))\n", "\n", "2. In the left sidebar that appears for your model, click **Development** under Documents.\n", "\n", diff --git a/site/notebooks/quickstart/quickstart_validation.Rmd b/site/notebooks/quickstart/quickstart_validation.Rmd index b28d319a56..0e9f198bf5 100644 --- a/site/notebooks/quickstart/quickstart_validation.Rmd +++ b/site/notebooks/quickstart/quickstart_validation.Rmd @@ -49,11 +49,13 @@ For this exercise, log in to the [ValidMind Platform](https://app.prod.validmind 1. In the left sidebar, select **Inventory**. -2. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html)) +2. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html)) -3. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders. +3. Click **+ Register Model**. -4. Select your own name under the **RECORD OWNER** drop-down — don’t worry, we’ll adjust these permissions next for validation. +4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders. + +5. Select your own name under the **Record Owner** drop-down — don’t worry, we’ll adjust these permissions next for validation. 6. Click **Register Model** to add the model to your inventory. @@ -63,19 +65,19 @@ In order to log tests as a validator instead of as a developer, on the details p 1. Remove yourself as an owner: - - Click on the **OWNERS** tile. + - Click on the **Owners** tile. - Click the **x** next to your name to remove yourself from that role. - Click **Save** to apply your changes. 2. Remove yourself as a developer: - - Click on the **DEVELOPERS** tile. + - Click on the **Developers** tile. - Click the **x** next to your name to remove yourself from that role. - Click **Save** to apply your changes. 3. Add yourself as a validator: - - Click on the **VALIDATORS** tile. + - Click on the **Validators** tile. - Select your name from the drop-down menu. - Click **Save** to apply your changes. @@ -85,7 +87,7 @@ Next, let's select a validation report template. A template predefines sections 1. In the model's left sidebar, click **Documents** and select **Validation**. -2. Under **TEMPLATE**, select `Generic Validation Report`. +2. Under **Template**, select `Generic Validation Report`. 3. Click **Use Template** to apply the template. @@ -93,7 +95,7 @@ Next, let's select a validation report template. A template predefines sections Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library. -1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu. +1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu. 2. Click **Copy snippet to clipboard**. Paste the snippet into an editor and make note of the credentials. diff --git a/site/notebooks/quickstart/quickstart_validation.ipynb b/site/notebooks/quickstart/quickstart_validation.ipynb index 4d871e1226..e9c1ec814d 100644 --- a/site/notebooks/quickstart/quickstart_validation.ipynb +++ b/site/notebooks/quickstart/quickstart_validation.ipynb @@ -204,13 +204,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down — don’t worry, we’ll adjust these permissions next for validation.\n", + "6. Select your own name under the **Record Owner** drop-down — don’t worry, we’ll adjust these permissions next for validation.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "97d44f44" }, @@ -226,19 +228,19 @@ "\n", "1. Remove yourself as an owner:\n", "\n", - " - Click on the **OWNERS** tile.\n", + " - Click on the **Owners** tile.\n", " - Click the **x** next to your name to remove yourself from that model's role.\n", " - Click **Save** to apply your changes to that role.\n", "\n", "2. Remove yourself as a developer:\n", "\n", - " - Click on the **DEVELOPERS** tile.\n", + " - Click on the **Developers** tile.\n", " - Click the **x** next to your name to remove yourself from that model's role.\n", " - Click **Save** to apply your changes to that role.\n", "\n", "3. Add yourself as a validator:\n", "\n", - " - Click on the **VALIDATORS** tile.\n", + " - Click on the **Validators** tile.\n", " - Select your name from the drop-down menu.\n", " - Click **Save** to apply your changes to that role." ], @@ -258,7 +260,7 @@ "\n", " If you cannot locate your Validation document, make sure Validation type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Generic Validation Report`.\n", + "2. Under **Template**, select `Generic Validation Report`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -310,7 +312,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/tutorials/development/1-set_up_validmind.ipynb b/site/notebooks/tutorials/development/1-set_up_validmind.ipynb index 9ba5431049..158cf4c7a5 100644 --- a/site/notebooks/tutorials/development/1-set_up_validmind.ipynb +++ b/site/notebooks/tutorials/development/1-set_up_validmind.ipynb @@ -216,13 +216,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "a48cd34d" }, @@ -240,7 +242,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -256,7 +258,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/tutorials/development/2-start_development_process.ipynb b/site/notebooks/tutorials/development/2-start_development_process.ipynb index 4016e2a97a..ed1190a2ef 100644 --- a/site/notebooks/tutorials/development/2-start_development_process.ipynb +++ b/site/notebooks/tutorials/development/2-start_development_process.ipynb @@ -94,7 +94,7 @@ "\n", "First, let's connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/tutorials/development/3-integrate_custom_tests.ipynb b/site/notebooks/tutorials/development/3-integrate_custom_tests.ipynb index 7f32f3e454..14f1102790 100644 --- a/site/notebooks/tutorials/development/3-integrate_custom_tests.ipynb +++ b/site/notebooks/tutorials/development/3-integrate_custom_tests.ipynb @@ -108,7 +108,7 @@ "\n", "As usual, let's first connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/tutorials/development/4-finalize_testing_documentation.ipynb b/site/notebooks/tutorials/development/4-finalize_testing_documentation.ipynb index 0dbc8d3be1..f7b1a2822d 100644 --- a/site/notebooks/tutorials/development/4-finalize_testing_documentation.ipynb +++ b/site/notebooks/tutorials/development/4-finalize_testing_documentation.ipynb @@ -106,7 +106,7 @@ "\n", "As usual, let's first connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb b/site/notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb index feda59a354..72ccaa027d 100644 --- a/site/notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb +++ b/site/notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb @@ -184,13 +184,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down — don’t worry, we’ll adjust these permissions next for validation.\n", + "6. Select your own name under the **Record Owner** drop-down — don’t worry, we’ll adjust these permissions next for validation.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "609fe59b" }, @@ -206,19 +208,19 @@ "\n", "1. Remove yourself as an owner:\n", "\n", - " - Click on the **OWNERS** tile.\n", + " - Click on the **Owners** tile.\n", " - Click the **x** next to your name to remove yourself from that model's role.\n", " - Click **Save** to apply your changes to that role.\n", "\n", "2. Remove yourself as a developer:\n", "\n", - " - Click on the **DEVELOPERS** tile.\n", + " - Click on the **Developers** tile.\n", " - Click the **x** next to your name to remove yourself from that model's role.\n", " - Click **Save** to apply your changes to that role.\n", "\n", "3. Add yourself as a validator:\n", "\n", - " - Click on the **VALIDATORS** tile.\n", + " - Click on the **Validators** tile.\n", " - Select your name from the drop-down menu.\n", " - Click **Save** to apply your changes to that role." ], @@ -238,7 +240,7 @@ "\n", "1. In the left sidebar that appears for your model, click **Documents** and select **Documentation**.\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -258,7 +260,7 @@ "\n", " If you cannot locate your Validation document, make sure Validation type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Generic Validation Report`.\n", + "2. Under **Template**, select `Generic Validation Report`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -310,7 +312,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/tutorials/validation/2-start_validation_process.ipynb b/site/notebooks/tutorials/validation/2-start_validation_process.ipynb index a0d4440e6c..081475e3c1 100644 --- a/site/notebooks/tutorials/validation/2-start_validation_process.ipynb +++ b/site/notebooks/tutorials/validation/2-start_validation_process.ipynb @@ -97,7 +97,7 @@ "\n", "First, let's connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/tutorials/validation/3-developing_potential_challenger.ipynb b/site/notebooks/tutorials/validation/3-developing_potential_challenger.ipynb index 2ed29a195f..4db8d26dfb 100644 --- a/site/notebooks/tutorials/validation/3-developing_potential_challenger.ipynb +++ b/site/notebooks/tutorials/validation/3-developing_potential_challenger.ipynb @@ -102,7 +102,7 @@ "\n", "As usual, let's first connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", @@ -628,10 +628,10 @@ "\n", "6. Click **+ Add Validation Issue** and enter in the details for your validation issue, for example:\n", "\n", - " - **TITLE** — Champion Logistic Regression Model Fails Minimum Accuracy Threshold\n", - " - **RISK AREA** — Model Performance\n", - " - **DOCUMENTATION SECTION** — 3.2. Model Evaluation\n", - " - **DESCRIPTION** — The logistic regression champion model was subjected to a Minimum Accuracy test to determine whether its predictive accuracy meets the predefined performance threshold of 0.7. The model achieved an accuracy score of 0.6136, which falls below the required minimum. As a result, the test produced a Fail outcome.\n", + " - **Title** — Champion Logistic Regression Model Fails Minimum Accuracy Threshold\n", + " - **Risk Area** — Model Performance\n", + " - **Documentation Section** — 3.2. Model Evaluation\n", + " - **Description** — The logistic regression champion model was subjected to a Minimum Accuracy test to determine whether its predictive accuracy meets the predefined performance threshold of 0.7. The model achieved an accuracy score of 0.6136, which falls below the required minimum. As a result, the test produced a Fail outcome.\n", "\n", "7. Click **Add Validation Issue** to submit the validation issue.\n", "\n", diff --git a/site/notebooks/tutorials/validation/4-finalize_validation_reporting.ipynb b/site/notebooks/tutorials/validation/4-finalize_validation_reporting.ipynb index 32d46c6e2d..954f340472 100644 --- a/site/notebooks/tutorials/validation/4-finalize_validation_reporting.ipynb +++ b/site/notebooks/tutorials/validation/4-finalize_validation_reporting.ipynb @@ -112,7 +112,7 @@ "\n", "As usual, let's first connect up the ValidMind Library to our model we previously registered in the ValidMind Platform:\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", @@ -1149,7 +1149,7 @@ "\n", "- **Adding risk assessment notes:** Click under **Risk Assessment Notes** in any validation report section to access the text editor and content editing toolbar, including an option to generate a draft with AI. Once generated, edit your ValidMind-generated test descriptions to adhere to your organization's requirements. (Learn more: [Work with content blocks](https://docs.validmind.ai/guide/documentation/work-with-content-blocks.html#content-editing-toolbar))\n", "\n", - "- **Assessing compliance:** Under the Guideline for any validation report section, click **ASSESSMENT** and select the compliance status from the drop-down menu. (Learn more: [Assign compliance assessments](https://docs.validmind.ai/guide/validation/assess-compliance.html#assign-compliance-assessments))\n", + "- **Assessing compliance:** Under the Guideline for any validation report section, click **Assessment** and select the compliance status from the drop-down menu. (Learn more: [Assign compliance assessments](https://docs.validmind.ai/guide/validation/assess-compliance.html#assign-compliance-assessments))\n", "\n", "- **Collaborate with other stakeholders:** Use the ValidMind Platform's real-time collaborative features to work seamlessly together with the rest of your organization, including developers. Propose suggested changes in the documentation, work with versioned history, and use comments to discuss specific portions of the documentation. (Learn more: [Collaborate with others](https://docs.validmind.ai/guide/documentation/collaborate-with-others.html))\n", "\n", diff --git a/site/notebooks/use_cases/agents/document_agentic_ai.ipynb b/site/notebooks/use_cases/agents/document_agentic_ai.ipynb index 621fe8b171..65849a9a0e 100644 --- a/site/notebooks/use_cases/agents/document_agentic_ai.ipynb +++ b/site/notebooks/use_cases/agents/document_agentic_ai.ipynb @@ -237,13 +237,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "83d47d89" }, @@ -261,7 +263,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Agentic AI`.\n", + "2. Under **Template**, select `Agentic AI`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -292,7 +294,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/capital_markets/quickstart_option_pricing_models.ipynb b/site/notebooks/use_cases/capital_markets/quickstart_option_pricing_models.ipynb index 4b4ae386c0..4840bcb971 100644 --- a/site/notebooks/use_cases/capital_markets/quickstart_option_pricing_models.ipynb +++ b/site/notebooks/use_cases/capital_markets/quickstart_option_pricing_models.ipynb @@ -190,13 +190,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "e1865b8d" }, @@ -214,7 +216,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Capital markets`.\n", + "2. Under **Template**, select `Capital markets`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -230,7 +232,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/capital_markets/quickstart_option_pricing_models_quantlib.ipynb b/site/notebooks/use_cases/capital_markets/quickstart_option_pricing_models_quantlib.ipynb index eccfb8fc3b..7461158d32 100644 --- a/site/notebooks/use_cases/capital_markets/quickstart_option_pricing_models_quantlib.ipynb +++ b/site/notebooks/use_cases/capital_markets/quickstart_option_pricing_models_quantlib.ipynb @@ -247,13 +247,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ], "id": "c6f87017" }, @@ -271,7 +273,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Capital Markets`.\n", + "2. Under **Template**, select `Capital Markets`.\n", "\n", "3. Click **Use Template** to apply the template." ], @@ -302,7 +304,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/code_explainer/quickstart_code_explainer_demo.ipynb b/site/notebooks/use_cases/code_explainer/quickstart_code_explainer_demo.ipynb index 4f912501fe..c034c69b65 100644 --- a/site/notebooks/use_cases/code_explainer/quickstart_code_explainer_demo.ipynb +++ b/site/notebooks/use_cases/code_explainer/quickstart_code_explainer_demo.ipynb @@ -188,13 +188,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -211,7 +213,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Model Source Code Documentation`.\n", + "2. Under **Template**, select `Model Source Code Documentation`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -240,7 +242,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/credit_risk/application_scorecard_executive.ipynb b/site/notebooks/use_cases/credit_risk/application_scorecard_executive.ipynb index 50f2f0202e..7d3dd2764c 100644 --- a/site/notebooks/use_cases/credit_risk/application_scorecard_executive.ipynb +++ b/site/notebooks/use_cases/credit_risk/application_scorecard_executive.ipynb @@ -167,13 +167,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -190,7 +192,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **[template]{.smallcaps}**, select `Credit Risk Scorecard`.\n", + "2. Under **Template**, select `Credit Risk Scorecard`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -205,7 +207,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/credit_risk/application_scorecard_full_suite.ipynb b/site/notebooks/use_cases/credit_risk/application_scorecard_full_suite.ipynb index 2b857a03bc..f6a2ec990d 100644 --- a/site/notebooks/use_cases/credit_risk/application_scorecard_full_suite.ipynb +++ b/site/notebooks/use_cases/credit_risk/application_scorecard_full_suite.ipynb @@ -181,13 +181,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -204,7 +206,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Credit Risk Scorecard`.\n", + "2. Under **Template**, select `Credit Risk Scorecard`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -219,7 +221,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/credit_risk/application_scorecard_with_bias.ipynb b/site/notebooks/use_cases/credit_risk/application_scorecard_with_bias.ipynb index 6f6d23928e..f40c81e3ce 100644 --- a/site/notebooks/use_cases/credit_risk/application_scorecard_with_bias.ipynb +++ b/site/notebooks/use_cases/credit_risk/application_scorecard_with_bias.ipynb @@ -182,13 +182,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -205,7 +207,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Credit Risk Scorecard`.\n", + "2. Under **Template**, select `Credit Risk Scorecard`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -220,7 +222,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/credit_risk/application_scorecard_with_ml.ipynb b/site/notebooks/use_cases/credit_risk/application_scorecard_with_ml.ipynb index a735cbf5b1..42fcdcc560 100644 --- a/site/notebooks/use_cases/credit_risk/application_scorecard_with_ml.ipynb +++ b/site/notebooks/use_cases/credit_risk/application_scorecard_with_ml.ipynb @@ -194,13 +194,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -217,7 +219,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Credit Risk Scorecard`.\n", + "2. Under **Template**, select `Credit Risk Scorecard`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -232,7 +234,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/credit_risk/document_excel_application_scorecard.ipynb b/site/notebooks/use_cases/credit_risk/document_excel_application_scorecard.ipynb index fa8e86113a..b0642d541e 100644 --- a/site/notebooks/use_cases/credit_risk/document_excel_application_scorecard.ipynb +++ b/site/notebooks/use_cases/credit_risk/document_excel_application_scorecard.ipynb @@ -183,13 +183,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -206,7 +208,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Credit Risk Scorecard`.\n", + "2. Under **Template**, select `Credit Risk Scorecard`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -221,7 +223,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/nlp_and_llm/foundation_models_integration_demo.ipynb b/site/notebooks/use_cases/nlp_and_llm/foundation_models_integration_demo.ipynb index 583c0a1ea5..8acb1e3bee 100644 --- a/site/notebooks/use_cases/nlp_and_llm/foundation_models_integration_demo.ipynb +++ b/site/notebooks/use_cases/nlp_and_llm/foundation_models_integration_demo.ipynb @@ -135,13 +135,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -158,7 +160,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `LLM-based Text Classification`.\n", + "2. Under **Template**, select `LLM-based Text Classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -173,7 +175,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/nlp_and_llm/foundation_models_summarization_demo.ipynb b/site/notebooks/use_cases/nlp_and_llm/foundation_models_summarization_demo.ipynb index 759b0d733f..7430486f9f 100644 --- a/site/notebooks/use_cases/nlp_and_llm/foundation_models_summarization_demo.ipynb +++ b/site/notebooks/use_cases/nlp_and_llm/foundation_models_summarization_demo.ipynb @@ -131,13 +131,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -154,7 +156,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `LLM-based Text Summarization`.\n", + "2. Under **Template**, select `LLM-based Text Summarization`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -169,7 +171,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/nlp_and_llm/hugging_face_integration_demo.ipynb b/site/notebooks/use_cases/nlp_and_llm/hugging_face_integration_demo.ipynb index ceefd99f7d..82a1e1738a 100644 --- a/site/notebooks/use_cases/nlp_and_llm/hugging_face_integration_demo.ipynb +++ b/site/notebooks/use_cases/nlp_and_llm/hugging_face_integration_demo.ipynb @@ -132,13 +132,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -155,7 +157,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `NLP-based Text Classification`.\n", + "2. Under **Template**, select `NLP-based Text Classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -170,7 +172,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/nlp_and_llm/hugging_face_summarization_demo.ipynb b/site/notebooks/use_cases/nlp_and_llm/hugging_face_summarization_demo.ipynb index 5db308064b..f312bbcb49 100644 --- a/site/notebooks/use_cases/nlp_and_llm/hugging_face_summarization_demo.ipynb +++ b/site/notebooks/use_cases/nlp_and_llm/hugging_face_summarization_demo.ipynb @@ -129,13 +129,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -152,7 +154,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `NLP-based Text Classification`.\n", + "2. Under **Template**, select `NLP-based Text Classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -167,7 +169,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/nlp_and_llm/llm_summarization_demo.ipynb b/site/notebooks/use_cases/nlp_and_llm/llm_summarization_demo.ipynb index 14f7b1ee2c..de219c187f 100644 --- a/site/notebooks/use_cases/nlp_and_llm/llm_summarization_demo.ipynb +++ b/site/notebooks/use_cases/nlp_and_llm/llm_summarization_demo.ipynb @@ -163,13 +163,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -186,7 +188,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `LLM-based Text Summarization`.\n", + "2. Under **Template**, select `LLM-based Text Summarization`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -201,7 +203,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/nlp_and_llm/prompt_validation_demo.ipynb b/site/notebooks/use_cases/nlp_and_llm/prompt_validation_demo.ipynb index deeb8293e8..56b71fb7cb 100644 --- a/site/notebooks/use_cases/nlp_and_llm/prompt_validation_demo.ipynb +++ b/site/notebooks/use_cases/nlp_and_llm/prompt_validation_demo.ipynb @@ -163,13 +163,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -186,7 +188,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `LLM-based Text Classification`.\n", + "2. Under **Template**, select `LLM-based Text Classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -201,7 +203,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/nlp_and_llm/rag_benchmark_demo.ipynb b/site/notebooks/use_cases/nlp_and_llm/rag_benchmark_demo.ipynb index a224f1721f..7d380ebe2d 100644 --- a/site/notebooks/use_cases/nlp_and_llm/rag_benchmark_demo.ipynb +++ b/site/notebooks/use_cases/nlp_and_llm/rag_benchmark_demo.ipynb @@ -196,13 +196,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -219,7 +221,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Gen AI RAG`.\n", + "2. Under **Template**, select `Gen AI RAG`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -248,7 +250,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/nlp_and_llm/rag_documentation_demo.ipynb b/site/notebooks/use_cases/nlp_and_llm/rag_documentation_demo.ipynb index 7589bd17b7..8746f4eb28 100644 --- a/site/notebooks/use_cases/nlp_and_llm/rag_documentation_demo.ipynb +++ b/site/notebooks/use_cases/nlp_and_llm/rag_documentation_demo.ipynb @@ -171,12 +171,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -193,7 +196,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Gen AI RAG`.\n", + "2. Under **Template**, select `Gen AI RAG`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -222,7 +225,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/ongoing_monitoring/application_scorecard_ongoing_monitoring.ipynb b/site/notebooks/use_cases/ongoing_monitoring/application_scorecard_ongoing_monitoring.ipynb index 847417cf02..6b082196a8 100644 --- a/site/notebooks/use_cases/ongoing_monitoring/application_scorecard_ongoing_monitoring.ipynb +++ b/site/notebooks/use_cases/ongoing_monitoring/application_scorecard_ongoing_monitoring.ipynb @@ -174,13 +174,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -197,7 +199,7 @@ "\n", " If you cannot locate your Monitoring document, make sure Monitoring type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Ongoing Monitoring for Classification Models`.\n", + "2. Under **Template**, select `Ongoing Monitoring for Classification Models`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -212,7 +214,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Monitoring` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Monitoring` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/ongoing_monitoring/quickstart_customer_churn_ongoing_monitoring.ipynb b/site/notebooks/use_cases/ongoing_monitoring/quickstart_customer_churn_ongoing_monitoring.ipynb index 9be6aa92fe..8f03b59f80 100644 --- a/site/notebooks/use_cases/ongoing_monitoring/quickstart_customer_churn_ongoing_monitoring.ipynb +++ b/site/notebooks/use_cases/ongoing_monitoring/quickstart_customer_churn_ongoing_monitoring.ipynb @@ -172,13 +172,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -195,7 +197,7 @@ "\n", " If you cannot locate your Monitoring document, make sure Monitoring type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Ongoing Monitoring for Classification Models`.\n", + "2. Under **Template**, select `Ongoing Monitoring for Classification Models`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -210,7 +212,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Monitoring` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Monitoring` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/regression/quickstart_regression_full_suite.ipynb b/site/notebooks/use_cases/regression/quickstart_regression_full_suite.ipynb index 466da8019c..9f082cda1c 100644 --- a/site/notebooks/use_cases/regression/quickstart_regression_full_suite.ipynb +++ b/site/notebooks/use_cases/regression/quickstart_regression_full_suite.ipynb @@ -139,13 +139,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", - "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", - "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", - "\n", - "6. Click **Register Model** to add the model to your inventory." + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", + "\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "\n", + "6. Select your own name under the **Record Owner** drop-down.\n", + "\n", + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -162,7 +164,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -177,7 +179,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/time_series/quickstart_time_series_full_suite.ipynb b/site/notebooks/use_cases/time_series/quickstart_time_series_full_suite.ipynb index 300dbfeb09..ea1c106ad2 100644 --- a/site/notebooks/use_cases/time_series/quickstart_time_series_full_suite.ipynb +++ b/site/notebooks/use_cases/time_series/quickstart_time_series_full_suite.ipynb @@ -173,13 +173,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -196,7 +198,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Binary classification`.\n", + "2. Under **Template**, select `Binary classification`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -211,7 +213,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/time_series/quickstart_time_series_high_code.ipynb b/site/notebooks/use_cases/time_series/quickstart_time_series_high_code.ipynb index 1dfae1e06e..2c913dea13 100644 --- a/site/notebooks/use_cases/time_series/quickstart_time_series_high_code.ipynb +++ b/site/notebooks/use_cases/time_series/quickstart_time_series_high_code.ipynb @@ -174,13 +174,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down.\n", + "6. Select your own name under the **Record Owner** drop-down.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -197,7 +199,7 @@ "\n", " If you cannot locate your Development document, make sure Development type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Time Series Forecasting with ML`.\n", + "2. Under **Template**, select `Time Series Forecasting with ML`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -212,7 +214,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Development` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/notebooks/use_cases/validation/validate_application_scorecard.ipynb b/site/notebooks/use_cases/validation/validate_application_scorecard.ipynb index 563c622a21..78fe048a20 100644 --- a/site/notebooks/use_cases/validation/validate_application_scorecard.ipynb +++ b/site/notebooks/use_cases/validation/validate_application_scorecard.ipynb @@ -194,13 +194,15 @@ "\n", "2. In the left sidebar, select **Inventory**.\n", "\n", - "3. Under the **RECORD TYPE** drop-down, select `Model` and click **+ Register Model**. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + "3. Select `Model` by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. (Learn more: [Register records in the inventory](https://docs.validmind.ai/guide/inventory/register-records-in-inventory.html))\n", + + "4. Click **+ Register Model**.\n", "\n", - "4. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", + "5. Enter the model details and click **Next >** to continue to assignment of inventory record stakeholders.\n", "\n", - "5. Select your own name under the **RECORD OWNER** drop-down — don’t worry, we’ll adjust these permissions next for validation.\n", + "6. Select your own name under the **Record Owner** drop-down — don’t worry, we’ll adjust these permissions next for validation.\n", "\n", - "6. Click **Register Model** to add the model to your inventory." + "7. Click **Register Model** to add the model to your inventory." ] }, { @@ -215,19 +217,19 @@ "\n", "1. Remove yourself as an owner:\n", "\n", - " - Click on the **OWNERS** tile.\n", + " - Click on the **Owners** tile.\n", " - Click the **x** next to your name to remove yourself from that model's role.\n", " - Click **Save** to apply your changes to that role.\n", "\n", "2. Remove yourself as a developer:\n", "\n", - " - Click on the **DEVELOPERS** tile.\n", + " - Click on the **Developers** tile.\n", " - Click the **x** next to your name to remove yourself from that model's role.\n", " - Click **Save** to apply your changes to that role.\n", "\n", "3. Add yourself as a validator:\n", "\n", - " - Click on the **VALIDATORS** tile.\n", + " - Click on the **Validators** tile.\n", " - Select your name from the drop-down menu.\n", " - Click **Save** to apply your changes to that role." ] @@ -246,7 +248,7 @@ "\n", " If you cannot locate your Validation document, make sure Validation type documents are enabled for model records and create a new document. (**Learn more:** [Manage documents](https://docs.validmind.ai/guide/templates/manage-documents.html#add-record-documents))\n", "\n", - "2. Under **TEMPLATE**, select `Generic Validation Report`.\n", + "2. Under **Template**, select `Generic Validation Report`.\n", "\n", "3. Click **Use Template** to apply the template." ] @@ -294,7 +296,7 @@ "\n", "Initialize the ValidMind Library with the *code snippet* unique to each record per document, ensuring your test results are uploaded to the correct record and automatically populated in the right document in the ValidMind Platform when you run the Library.\n", "\n", - "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **DOCUMENT** drop-down menu.\n", + "1. On the left sidebar that appears for your model, select **Getting Started** and select `Validation` from the **Document** drop-down menu.\n", "\n", "2. Click **Copy snippet to clipboard**.\n", "\n", diff --git a/site/reference/validmind-rest-api-vm.qmd b/site/reference/validmind-rest-api-vm.qmd index 4b4cb42804..7c97cb7869 100644 --- a/site/reference/validmind-rest-api-vm.qmd +++ b/site/reference/validmind-rest-api-vm.qmd @@ -64,8 +64,8 @@ curl -X GET "https://api.prod.validmind.ai/vm/api/v1/models" \ 3. Under Access Keys: - - Locate [api key]{.smallcaps} and click **{{< fa clipboard >}} Copy to Clipboard**. - - Locate [secret key]{.smallcaps} and click **{{< fa clipboard >}} Copy to Clipboard**. + - Locate **API Key** and click **{{< fa clipboard >}} Copy to Clipboard**. + - Locate **Secret Key** and click **{{< fa clipboard >}} Copy to Clipboard**. ## Data formats diff --git a/site/releases/2023/release-notes-2023-jul-24.qmd b/site/releases/2023/release-notes-2023-jul-24.qmd index 5c9bdc6b02..deb842b846 100644 --- a/site/releases/2023/release-notes-2023-jul-24.qmd +++ b/site/releases/2023/release-notes-2023-jul-24.qmd @@ -116,7 +116,7 @@ We've now enhanced the flexibility of documenting models by allowing you to swap ::: ::: {.w-40-ns .tc} -[View record activity](/guide/inventory/view-record-activity.qmd){.button .button-green} +[View record activity](/guide/reporting/view-record-activity.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-dec-06/release-notes.qmd b/site/releases/2024/2024-dec-06/release-notes.qmd index 6f0b2eb791..aacebdeedb 100644 --- a/site/releases/2024/2024-dec-06/release-notes.qmd +++ b/site/releases/2024/2024-dec-06/release-notes.qmd @@ -919,7 +919,7 @@ This new guide features expanded information on the auditing feature, including ::: ::: {.w-30-ns .tc} -[View record activity](/guide/inventory/view-record-activity.qmd){.button} +[View record activity](/guide/reporting/view-record-activity.qmd){.button} ::: diff --git a/site/releases/2024/2024-dec-24/release-notes.qmd b/site/releases/2024/2024-dec-24/release-notes.qmd index 9fefde0934..17ee901a80 100644 --- a/site/releases/2024/2024-dec-24/release-notes.qmd +++ b/site/releases/2024/2024-dec-24/release-notes.qmd @@ -436,6 +436,6 @@ The **{{< fa cube >}} Developers** portal also got a makeover, with a {{< var vm [^2]: [Working with analytics](/guide/reporting/working-with-analytics.qmd) -[^3]: [View record activity](/guide/inventory/view-record-activity.qmd) +[^3]: [View record activity](/guide/reporting/view-record-activity.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) \ No newline at end of file diff --git a/site/releases/2024/2024-feb-14/highlights.qmd b/site/releases/2024/2024-feb-14/highlights.qmd index ca223cc2e9..42a50f8302 100644 --- a/site/releases/2024/2024-feb-14/highlights.qmd +++ b/site/releases/2024/2024-feb-14/highlights.qmd @@ -285,7 +285,7 @@ We implemented a toggle feature in the **{{< fa wifi >}} Model Activity** and Re ::: {.w-30-ns} -[View record activity](/guide/inventory/view-record-activity.qmd){.button} +[View record activity](/guide/reporting/view-record-activity.qmd){.button} ::: @@ -378,7 +378,7 @@ We implemented a toggle feature in the **{{< fa wifi >}} Model Activity** and Re ::: ::: {.w-30-ns .tc} -[View record activity](/guide/inventory/view-record-activity.qmd){.button} +[View record activity](/guide/reporting/view-record-activity.qmd){.button} ::: diff --git a/site/releases/2024/2024-jan-18/highlights.qmd b/site/releases/2024/2024-jan-18/highlights.qmd index a95046768f..df10d2f02d 100644 --- a/site/releases/2024/2024-jan-18/highlights.qmd +++ b/site/releases/2024/2024-jan-18/highlights.qmd @@ -237,7 +237,7 @@ You use these new template management features to: ::: ::: {.w-25-ns .tc} -[View record activity](/guide/inventory/view-record-activity.qmd){.button} +[View record activity](/guide/reporting/view-record-activity.qmd){.button} ::: diff --git a/site/releases/2024/2024-oct-22/release-notes.qmd b/site/releases/2024/2024-oct-22/release-notes.qmd index 469e0a772b..a7eb8aa288 100644 --- a/site/releases/2024/2024-oct-22/release-notes.qmd +++ b/site/releases/2024/2024-oct-22/release-notes.qmd @@ -441,7 +441,7 @@ The new activity type filters are available on: ::: {.w-40-ns} -[Filter activity](/guide/inventory/view-record-activity.qmd#filter-activity){.button} +[Filter activity](/guide/reporting/view-record-activity.qmd#filter-activity){.button} ::: diff --git a/site/releases/_sidebar.yaml b/site/releases/_sidebar.yaml index 54a2b38317..cfcadeb6ca 100644 --- a/site/releases/_sidebar.yaml +++ b/site/releases/_sidebar.yaml @@ -13,7 +13,7 @@ website: - text: "---" - releases/breaking-changes-and-deprecations.qmd - text: "---" - - text: "Older releases" + - text: "Release archive" - file: releases/2025/2025-releases.qmd contents: - releases/2025/2025-apr-24/release-notes.qmd diff --git a/site/releases/all-releases.qmd b/site/releases/all-releases.qmd index 3da385153b..68ae146ff9 100644 --- a/site/releases/all-releases.qmd +++ b/site/releases/all-releases.qmd @@ -5,33 +5,17 @@ date: last-modified listing: - id: release-pages type: grid + grid-columns: 4 sort: false fields: [title, date, subtitle] contents: - ../releases/validmind-platform-releases.qmd - ../releases/validmind-library-releases.qmd - ../releases/documentation-updates.qmd - - id: releases - type: table - page-size: 20 - table-hover: true - max-description-length: 250 - sort: "date desc" - date-format: iso - sort-ui: [date, subtitle] - filter-ui: false - fields: [title, date, subtitle] - field-display-names: - title: "Release notes" - subtitle: "{{< var vm.product >}} version" - description: "Summary" - exclude: - categories: ["breaking changes", "deprecations", "releases by year"] - contents: - - ../releases/2025/**/*.qmd + - ../releases/breaking-changes-and-deprecations.qmd - id: feature-highlights type: table - page-size: 10 + max-items: 6 table-hover: true include: categories: highlight @@ -39,12 +23,12 @@ listing: max-description-length: 300 categories: false exclude: - categories: + categories: - "admin ui" - "hidden" sort-ui: false filter-ui: false - fields: [date, title, subtitle,] + fields: [date, title, subtitle] contents: - ../releases/frontend/**/pr*.qmd - ../releases/documentation/**/pr*.qmd @@ -61,27 +45,18 @@ aliases: :::{#release-pages} ::: -## Latest feature highlights +### Latest feature highlights :::{#feature-highlights} ::: -[View all feature highlights](/releases/feature-highlights.qmd){.button} - -::: {.pt4} -::: {.callout-important collapse="true" appearance="minimal"} - -## Older releases +[View all feature highlights](/releases/feature-highlights.qmd){.button .button-green} -We introduced a new release notes format in April 2025 with better highlights and filtering: +## Release archive -- Release notes up to version `25.03` are in this section. -- Release notes from version `25.04` and later are under "Current releases". +We introduced a new release notes format in April 2025 with better highlights and filtering. As a result: -:::{#releases} -::: +- Release notes up to version `25.03` are under [release archive]{.smallcaps}. +- Release notes from version `25.04` and later are under [current releases]{.smallcaps}. ::: -::: - -::: \ No newline at end of file diff --git a/site/theme.scss b/site/theme.scss index b23ee2f1c9..d656fc30f8 100644 --- a/site/theme.scss +++ b/site/theme.scss @@ -61,6 +61,12 @@ $mermaid-label-fg-color: #36454F; ry: var(--mermaid-node-radius) !important; } +/* Add breathing room after intro listing tiles before the next section. */ +.intro-listing.quarto-listing-container-grid, +.intro-listing .quarto-listing-container-grid { + margin-bottom: 1.65rem; +} + /* Import modular SCSS files */ @import 'assets/styles/bug-fixes'; @import 'assets/styles/codeblocks'; diff --git a/site/training/administrator-fundamentals/_invite-new-user.qmd b/site/training/administrator-fundamentals/_invite-new-user.qmd index 6c999f1ed5..527ab4f30e 100644 --- a/site/training/administrator-fundamentals/_invite-new-user.qmd +++ b/site/training/administrator-fundamentals/_invite-new-user.qmd @@ -9,9 +9,9 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Under Invite By Email: - - Enter the user's **[email]{.smallcaps}** address. - - Assign the user to a group from the **[group]{.smallcaps}** dropdown menu. - - Click **{{< fa plus >}}** under [role (optional)]{.smallcaps} to assign roles to that user: + - Enter the user's **Email** address. + - Assign the user to a group from the **Group** dropdown menu. + - Click **{{< fa plus >}}** under **Role** to assign roles to that user: 1. Click **{{< fa plus >}}** next to the role for each role to be assigned. 2. Click **Assign Additional Roles (Optional)**.^[Users invited without additional roles applied will be automatically assigned to a [{{< fa wrench >}} Basic User]{.bubble} role with minimal permissions.] diff --git a/site/training/administrator-fundamentals/administrator-fundamentals-register.qmd b/site/training/administrator-fundamentals/administrator-fundamentals-register.qmd index 9dbf25188d..a07140991d 100644 --- a/site/training/administrator-fundamentals/administrator-fundamentals-register.qmd +++ b/site/training/administrator-fundamentals/administrator-fundamentals-register.qmd @@ -38,7 +38,7 @@ listing: - path: organizational-oversight-reporting.html title: "Organizational Oversight & Reporting" subtitle: "Module 4" - description: "{{< fa check >}} Audit record activity
    {{< fa check >}} Audit workflows
    {{< fa check >}} View and customize analytics" + description: "{{< fa check >}} Audit organization activity
    {{< fa check >}} Audit workflows
    {{< fa check >}} View and customize analytics" reading-time: "45" author: "{{< var vm.product >}}" fields: [title, subtitle, description, reading-time] diff --git a/site/training/administrator-fundamentals/customizing-your-inventory.qmd b/site/training/administrator-fundamentals/customizing-your-inventory.qmd index 7f08c86f45..6ca80c2023 100644 --- a/site/training/administrator-fundamentals/customizing-your-inventory.qmd +++ b/site/training/administrator-fundamentals/customizing-your-inventory.qmd @@ -110,7 +110,7 @@ For this training course, you'll register a dummy model-type record to familiari **Register a new model** 1. Enter in some details for your sample model, then click **Next {{< fa angle-right >}}**. -2. Select your own name under the **[record owner]{.smallcaps}** drop-down. +2. Select your own name under the **Record Owner** drop-down. 3. Click **Register Model** to add the model to your inventory. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -178,7 +178,7 @@ Manage inventory record types ::: 1. Click **{{< fa plus >}} Add Inventory Record Type**. -2. Enter a a **[name]{.smallcaps}** for your record type. +2. Enter a **Name** for your record type. 3. Include optional information for your record type. 4. Click **Save** to add your record type. @@ -216,12 +216,12 @@ Manage inventory record fields Aggregation : Automatically compute a read-only value from [downstream artifacts](/guide/validation/working-with-artifacts.qmd){target="_blank"} linked to this record. - 1. Select the [**[type of artifacts]{.smallcaps}**](/guide/validation/manage-artifact-types.qmd){target="_blank"} to aggregate from. - 2. Select an **[aggregation function]{.smallcaps}**: + 1. Select the [**Artifacts**](/guide/validation/manage-artifact-types.qmd){target="_blank"} to aggregate from. + 2. Select an **Aggregation Function**: - **COUNT - Count matching entities** — Count the number of matching artifacts for that type. - - **MIN - Earliest/minimum value** — Return the least recent value from a selected Date type artifact field for that type, then select the Date type **[artifact field]{.smallcaps}** to aggregate on. - - **MAX - Latest/maximum value** — Return the most recent value from a selected Date type artifact field for that type, then select the Date type **[artifact field]{.smallcaps}** to aggregate on. - 4. (Optional) Click **{{< fa plus >}} Add Rule** under [filters]{.smallcaps} to narrow which artifacts are included in the aggregation. + - **MIN - Earliest/minimum value** — Return the least recent value from a selected Date type artifact field for that type, then select the Date type **Artifact Field** to aggregate on. + - **MAX - Latest/maximum value** — Return the most recent value from a selected Date type artifact field for that type, then select the Date type **Artifact Field** to aggregate on. + 4. (Optional) Click **{{< fa plus >}} Add Rule** under **Filters** to narrow which artifacts are included in the aggregation. {{< include /guide/inventory/_field-types.qmd >}} @@ -241,8 +241,8 @@ Aggregation ::: 1. Click **{{< fa plus >}} Add Field**. -2. Enter a **[title]{.smallcaps}** (name), select the field **[type]{.smallcaps}**. -3. Indicate what **[inventory record types]{.smallcaps}** the field is available on — choose `Model` so that we can review this field on our sample model. +2. Enter a **Title** (name), and select the field **Type**. +3. Indicate what **Inventory Record Types** the field is available on — choose `Model` so that we can review this field on our sample model. 4. Click **Save** to add your field. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -276,7 +276,7 @@ Manage record stakeholder types
    Try it **live** on the next page. {{< fa hand-point-right >}} :::: {.f5 .pr3 .pl3 .mt4 .embed} -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. +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 modified. ::: ::: @@ -317,9 +317,9 @@ Please note that the stock **Record Developer**, **Record Owner**, and **Record ::: 1. Click **{{< fa plus >}} Add Stakeholder Type**. -2. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type. -3. Select the **[inventory record types]{.smallcaps}** this stakeholder type is available on. -4. Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. +2. Enter the unique **Name** and **Description** for the stakeholder type. +3. Select the **Inventory Record Types** this stakeholder type is available on. +4. Under **Default on Inventory Record Types**, select which inventory record types should display this stakeholder type by default. 5. Click **Add Stakeholder Type** to create the stakeholder type. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -397,11 +397,11 @@ Manage artifact (finding) types ::: 1. Click **{{< fa plus >}} Add Artifact Type**. -2. Enter a **[name]{.smallcaps}** (name) and an optional **[description]{.smallcaps}**. +2. Enter a **Name** and an optional **Description**. 3. Click **Create** to create your new artifact type. 4. Click on your newly created artifact type to edit its details and permissions. 5. Click **{{< fa plus >}} Add Status** to add a status for this artifact type. -6. Enter in a **[status name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. +6. Enter in a **Status Name** and assign a **Color** to your artifact status. 7. When you are done, click **Add Status** to create your new status. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -453,8 +453,8 @@ Manage artifact fields ::: 1. Click **{{< fa plus >}} Add Field**. -2. Enter a **[title]{.smallcaps}** (name) and select the field **[type]{.smallcaps}**. -3. Select the **[artifact types]{.smallcaps}** this field is available on. +2. Enter a **Title** (name) and select the field **Type**. +3. Select the **Artifact Types** this field is available on. 4. Click **Save** to add your field. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -502,7 +502,7 @@ Manage artifact severities ::: 1. Click **{{< fa plus >}} Add Artifact Severity**. -2. Enter a **[name]{.smallcaps}** and select a **[color]{.smallcaps}** for the severity. +2. Enter a **Name** and select a **Color** for the severity. 3. Click **Add Severity** to create the severity. 4. Once added, reorder the severities as required. @@ -563,7 +563,7 @@ Work with templates 1. Select one of the tabs for the type of template you want to duplicate. For example: **Development** 2. Select the template to duplicate. For example: **Binary classification** 3. On the template details page, click **{{< fa copy >}} Duplicate Template**. -4. Give your copy a **[template name]{.smallcaps}** and a **[template description]{.smallcaps}**. +4. Give your copy a **Template Name** and a **Template Description**. 5. Click **Duplicate Template** to create a copy of your template. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -603,7 +603,7 @@ Customize document templates 3. Click **{{< fa pencil >}} Edit Outline**. 4. Make a modification to your template. For example: **Add a 1.4 Feature Engineering subsection** 5. Click **Create New Version** to view a side-by-side comparison of your changes with the previous version. -6. Add a description in **[version notes]{.smallcaps}** to track your changes. +6. Add a description in **Version Notes** to track your changes. 7. Click **Save** to save the new version. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -670,7 +670,7 @@ Private blocks can be modified by any user role and are unique to that user. ::: 1. Click **Add New Block** and enter in the details for your text block. -2. Select the following **[sharing]{.smallcaps}** option: **Shared** +2. Select the following **Sharing** option: **Shared** 3. Click **Add Block** to save your text block. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -686,7 +686,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. 1. Click the **Shared Blocks** tab. 2. To the right of the text block you created earlier, click **{{< fa ellipsis-vertical >}}** and select **Duplicate Text Block**. -3. Make your changes to the details of the block, and select the following **[sharing]{.smallcaps}** option: **Private** +3. Make your changes to the details of the block, and select the following **Sharing** option: **Private** 4. Click **Duplicate Block** to save a private copy of the text block. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -708,7 +708,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. 6. In the modal that opens, select the shared block you added earlier. 7. Click **Insert # Text Block(s) to Document**. 8. Click **Create New Version** to view a side-by-side comparison of your changes with the previous version. -9. Add a description in **[version notes]{.smallcaps}** to track your changes. +9. Add a description in **Version Notes** to track your changes. 10. Click **Save** to save the new version. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/administrator-fundamentals/onboarding-your-organization.qmd b/site/training/administrator-fundamentals/onboarding-your-organization.qmd index 1ce0198bbd..41cde0dc96 100644 --- a/site/training/administrator-fundamentals/onboarding-your-organization.qmd +++ b/site/training/administrator-fundamentals/onboarding-your-organization.qmd @@ -165,7 +165,7 @@ Get your organization ready for use by first defining business units and use cas ::: 1. Click **{{< fa plus >}} Add Business Unit** under Business Units. -2. Enter your **[business unit name]{.smallcaps}**. +2. Enter your **Business Unit Name**. 3. Click **Add Business Unit** to save your changes. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -180,7 +180,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. ::: 1. Click on the **Use Case** field under Default Fields. -2. Type in your use case name under **[options and groups]{.smallcaps}**. +2. Type in your use case name under **Options And Groups**. 3. Click **{{< fa plus >}} Add Option** to add the use case to the list. (Optional) Click and hold to drag and drop the use case to a group. 4. Click **Save Configuration** to save the inserted use case. @@ -233,7 +233,7 @@ Next, define your risk areas and validation guidelines: ::: 1. Click **{{< fa plus >}} Add Risk Area**. -2. Provide a **[name]{.smallcaps}** and **[description]{.smallcaps}** for your risk area. +2. Provide a **Name** and **Description** for your risk area. 3. Click **Add Risk Area** to create your risk area. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -249,7 +249,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. 1. Hover over the risk area you added previously until the **{{< fa ellipsis-vertical >}}** menu appears, then click on it. 2. Select **{{< fa plus >}} Add Guideline**. -3. Provide a **[title]{.smallcaps}** and **[description]{.smallcaps}** for your guideline. +3. Provide a **Title** and **Description** for your guideline. 4. Click **Add Guideline** to insert your guideline to your risk area. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -303,7 +303,7 @@ Manage user groups ::: 1. Click **{{< fa plus >}} Create Group**. -2. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**. +2. Enter a **Group Name** and **Group Description** for the new group and click **Continue**. 3. Select users from the list to add them to the group. 4. Click **Create Group** to save. @@ -352,7 +352,7 @@ Manage user roles ::: 1. Click **{{< fa plus >}} Add Role**. -2. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role. +2. Enter the unique **Name** and **Description** for the role. 3. Click **Add Role**. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd b/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd index 3cc2be2641..f3e5d03b11 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 record activity](#audit-record-activity) +1. [Audit organization activity](#audit-organization-activity) 2. [Audit workflows](#audit-workflows) 3. [Work with analytics](#work-with-analytics) @@ -100,9 +100,47 @@ Already logged in and refreshed this module? Click [{{< fa chevron-right >}}]() ::: -# Audit record activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} +# Audit organization activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} -{{< include /training/common-slides/_track-changes-updates.qmd >}} +## {.scrollable} + +:::: {.columns} +::: {.column width="30%" .pr4 .f2} +View settings activity + +::: {.tc} +[Learn more ...](/guide/reporting/view-settings-activity.qmd){.button target="_blank"} +::: + +
    Try it **live** on the next page. {{< fa hand-point-right >}} +::: + +::: {.column width="70%" .bl .pl4 .f4} +{{< include /guide/reporting/_view-settings-activity-overview.qmd >}} + +{{< include /guide/reporting/_view-settings-activity-steps.qmd >}} + +::: + +:::: + +## {background-iframe="https://app.prod.validmind.ai/activity" background-interactive="true" data-preload="yes"} + +:::: {.slideover--b .auto-collapse-10} +::: {.tc} +**Review settings activity** +::: + +1. In the left sidebar, click **{{< fa wifi >}} Activity**. +2. Select the **Settings Activity** tab: + - Click **{{< fa filter >}} Filter** to open the filter popover and select the **Event Type**s you want to filter by from the drop-down menu. + - Click **{{< fa chevron-down >}} View Details** to reveal more details about the activity when the option is available on an entry. + +When you're done, click [{{< fa chevron-right >}}]() to continue. + +:::: + +{{< include /training/common-slides/_view-record-activity.qmd >}} {{< include /training/common-slides/_review-model-activity.qmd >}} @@ -112,7 +150,7 @@ Already logged in and refreshed this module? Click [{{< fa chevron-right >}}]() :::: {.columns} ::: {.column width="30%" .pr4 .f2} -Review workflow executions +View workflow executions ::: {.f5 .nt2 .pl2 .mb4} (Scroll down for the full instructions.) @@ -153,7 +191,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. :::: {.columns} ::: {.column width="30%" .pr4 .f2} -Review workflows on records & artifacts +View record & artifact workflows ::: {.f5 .nt2 .pl2 .mb4} (Scroll down for the full instructions.) @@ -193,7 +231,7 @@ Review workflows associated with your records or artifacts: ::: 1. Select the name of your model you registered for this course to open up the record details page. -2. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +2. On the landing page of your model, locate the **Active Workflows** section. 3. Click on the name of any active workflow to review that specific workflow's details. 4. Close the detail view for your workflow. 5. Click **{{< fa arrow-right-arrow-left >}} See All Workflows** to see records of workflows by status. @@ -307,7 +345,7 @@ Manage custom reports ::: 1. Click **{{< fa plus >}} Add Page**. -2. On the Add New Page module, enter the **[page name]{.smallcaps}** and the **[description]{.smallcaps}**. +2. On the Add New Page module, enter the **Page Name** and the **Description**. 3. Click **Add New Page** to create your custom analytics page. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -323,9 +361,9 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. 1. Click on the tab for the custom page you added previously. 1. Click **{{< fa pencil >}} Edit Dashboard** and select **{{< fa pencil >}} Add Widget** then **{{< fa pencil >}} Add Visualization**. -3. On the Add Visualization panel, enter your **[title]{.smallcaps}**. -4. Select a **[visualization type]{.smallcaps}**. -5. Select a **[dataset]{.smallcaps}**. +3. On the Add Visualization panel, enter your **Title**. +4. Select a **Visualization Type**. +5. Select a **Dataset**. 6. Select the visualization configuration options to apply to the dataset. 7. Click **Add Visualization** to insert your custom widget onto the analytics page. diff --git a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd index 8a94d74d75..e1a06aeb5a 100644 --- a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd +++ b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd @@ -210,7 +210,7 @@ Manage record stages 1. Select the **Model** inventory record type. 2. Click **{{< fa plus >}} Add Stage**. -3. Provide a stage **[name]{.smallcaps}** and a stage **[description]{.smallcaps}**, then assign a **[color]{.smallcaps}** to the stage. +3. Provide a stage **Name** and a stage **Description**, then assign a **Color** to the stage. 4. When you are done, click **Save** to apply your changes. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -277,11 +277,11 @@ To set up a new custom workflow, you'll need to complete these four steps in seq ::: 1. Click **{{< fa plus >}} Add Workflow**. -2. Select **Inventory Record** under [workflow target]{.smallcaps}. -3. Enter a **[title]{.smallcaps}** and a **[description]{.smallcaps}** for the workflow. -4. Under [record type]{.smallcaps}, select **Model**. -5. Under **[workflow start]{.smallcaps}**, select **Manually**. -6. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow. +2. Select **Inventory Record** under **Workflow Target**. +3. Enter a **Title** and a **Description** for the workflow. +4. Select **Model** by clicking on **{Record} Inventory**, where `{Record}` is the currently active type of record. +5. Under **Workflow Start**, select **Manually**. +6. Under **Workflow Expected Duration**, define the SLA for the workflow. 7. Click **Save Draft** to save your blank workflow. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -318,7 +318,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. ::: 1. Hover over the workflow you added earlier. -2. Under the [actions]{.smallcaps} column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. +2. Under the **Actions** column, click **{{< fa ellipsis-vertical >}}** and select **{{< fa circle-check >}} Publish Workflow**. 3. Click **Yes, Publish** to confirm the publication of the workflow. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -356,7 +356,7 @@ Run workflows manually 1. Select the name of your model you registered for this course to open up the record details page. 2. On the landing page of your model, click the **Workflows** tab. 3. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. -4. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you configured earlier, then select **Run Now** under **[workflow start]{.smallcaps}**. +4. Select **{{< fa arrow-right >}} Run Workflow** for the workflow you configured earlier, then select **Run Now** under **Workflow Start**. 5. Click **{{< fa arrow-right >}} Run Workflow Now** to confirm. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -408,10 +408,10 @@ As an administrator, you may need to reset or abort workflows as required: ::: 1. Select the name of your model you registered for this course to open up the record details page. -2. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +2. On the landing page of your model, locate the **Active Workflows** section. 3. Click on the name of the workflow you manually initiated earlier to open that workflow's details. 4. Click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}. -5. Toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. +5. Toggle **Restart Workflow After Aborting** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -464,7 +464,7 @@ Add regulations & policies 1. Under {{< fa shield >}} Governance, select **Regulations & Policies**. 2. Click **{{< fa plus >}} Add Regulation or Policy** to create a new regulation or policy. -3. Provide a **[regulation or policy name]{.smallcaps}** and an optional **[description]{.smallcaps}**. +3. Provide a **Regulation Or Policy Name** and an optional **Description**. 4. Click **Add Regulation or Policy** to create your regulation or policy. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -510,7 +510,7 @@ Add assessments 1. Under {{< fa shield >}} Governance, select **Regulations & Policies**. 2. Select the regulation or policy you added in the previous step by clicking on it. 3. Click **{{< fa plus >}} Add Assessment** to create a new assessment. -4. Provide an **[assessment name]{.smallcaps}**, then select the **[assessment type]{.smallcaps}** and **[document type]{.smallcaps}**. +4. Provide an **Assessment Name**, then select the **Assessment Type** and **Document Type**. 5. Click **Add Assessment** to create your assessment. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -548,7 +548,7 @@ Add assessment questions 2. Select the regulation or policy you added previously by clicking on it. 3. Select the assessment you added previously by clicking on it. 4. Click **{{< fa plus >}} Add Question** to create a new question. -5. Enter the **[questions]{.smallcaps}**. +5. Enter the **Questions**. 6. Click **Add # Question(s)** to insert questions into the assessment. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -650,7 +650,7 @@ Set up attestations ::: 1. Click **{{< fa plus >}} Add Attestation**. -2. Enter a **[name]{.smallcaps}** and **[description]{.smallcaps}** for the attestation. +2. Enter a **Name** and **Description** for the attestation. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -664,7 +664,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. Click on the name of the attestation you added previously to configure it: 1. Click **{{< fa plus >}} Add Attestation Period** and add a period. - - Enter the **[name]{.smallcaps}**, **[start date]{.smallcaps}**, and **[end date]{.smallcaps}**. + - Enter the **Name**, **Start Date**, and **End Date**. - Click **Add Period**. 2. Under Relevant Attestation Fields, drag fields into the **Relevant Attestation Fields** column to display in record snapshots. 3. Under Questionnaire Template, click the template area to edit, then click **Save** to apply your changes. diff --git a/site/training/common-slides/_get-your-code-snippet.qmd b/site/training/common-slides/_get-your-code-snippet.qmd index 86abe88aad..a0f7a14f32 100644 --- a/site/training/common-slides/_get-your-code-snippet.qmd +++ b/site/training/common-slides/_get-your-code-snippet.qmd @@ -42,7 +42,7 @@ Initialize the {{< var validmind.developer >}} with the *code snippet* unique to ::: {.f5} 1. Select the name of your model you registered for this course to open up the model details page. 2. On the left sidebar that appears for your model, click **Getting Started**. -3. Select `Development` from the **[document]{.smallcaps}** drop-down menu. +3. Select `Development` from the **Document** drop-down menu. 4. Click **Copy snippet to clipboard**. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -102,7 +102,7 @@ Initialize the {{< var validmind.developer >}} with the *code snippet* unique to ::: {.f5} 1. Select the name of your model you registered for this course to open up the model details page. 2. On the left sidebar that appears for your model, click **Getting Started**. -3. Select `Validation` from the **[document]{.smallcaps}** drop-down menu. +3. Select `Validation` from the **Document** drop-down menu. 4. Click **Copy snippet to clipboard**. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/common-slides/_register-sample-model.qmd b/site/training/common-slides/_register-sample-model.qmd index 7a7c5349e1..8fbfc188a0 100644 --- a/site/training/common-slides/_register-sample-model.qmd +++ b/site/training/common-slides/_register-sample-model.qmd @@ -10,7 +10,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> **Register a sample model** 1. Enter some details for your sample model, then click **Next {{< fa angle-right >}}**. -2. Select your own name under the **[record owner]{.smallcaps}** drop-down. +2. Select your own name under the **Record Owner** drop-down. 3. Click **Register Model** to add the model to your inventory. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -29,7 +29,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. **Register a sample model** 1. Enter some details for your sample model, then click **Next {{< fa angle-right >}}**. -2. Select your own name under the **[record owner]{.smallcaps}** drop-down — don't worry, we'll adjust these permissions next for validation. +2. Select your own name under the **Record Owner** drop-down — don't worry, we'll adjust these permissions next for validation. 3. Click **Register Model** to add the model to your inventory. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/common-slides/_retrieve-your-code-snippet.qmd b/site/training/common-slides/_retrieve-your-code-snippet.qmd index 8f5bbdd685..e589db19d2 100644 --- a/site/training/common-slides/_retrieve-your-code-snippet.qmd +++ b/site/training/common-slides/_retrieve-your-code-snippet.qmd @@ -38,7 +38,7 @@ As usual, let's connect back up to your model in the {{< var validmind.platform 1. Select the name of your model you registered for this course to open up the model details page. 2. On the left sidebar that appears for your model, click **Getting Started**. -3. Select `Development` from the **[document]{.smallcaps}** drop-down menu. +3. Select `Development` from the **Document** drop-down menu. 4. Click **Copy snippet to clipboard**. ::: @@ -87,7 +87,7 @@ As usual, let's connect back up to your model in the {{< var validmind.platform 1. Select the name of your model you registered for this course to open up the model details page. 2. On the left sidebar that appears for your model, click **Getting Started**. -3. Select `Validation` from the **[document]{.smallcaps}** drop-down menu. +3. Select `Validation` from the **Document** drop-down menu. 4. Click **Copy snippet to clipboard**. ::: diff --git a/site/training/common-slides/_submit-for-approval.qmd b/site/training/common-slides/_submit-for-approval.qmd index fbc2f44bf0..0c5c790a34 100644 --- a/site/training/common-slides/_submit-for-approval.qmd +++ b/site/training/common-slides/_submit-for-approval.qmd @@ -10,10 +10,10 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ::: 1. Select the name of your model you registered for this course to open up the model details page. -2. On the landing page of your model, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. +2. On the landing page of your model, locate the **Active Workflows** section and the workflow you'd like to transition. 3. 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 any other additional inventory fields then click **Submit**. + - Enter your **Notes** and any other additional inventory fields then click **Submit**. 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 b7041942a3..b3e11642b0 100644 --- a/site/training/common-slides/_track-changes-updates.qmd +++ b/site/training/common-slides/_track-changes-updates.qmd @@ -6,21 +6,19 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.columns} ::: {.column width="30%" .pr4 .f2} -Track changes & updates +View record activity ::: {.tc} -[Learn more ...](/guide/inventory/view-record-activity.qmd){.button target="_blank"} +[Learn more ...](/guide/reporting/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 record activity +{{< include /guide/reporting/_view-record-activity-overview.qmd >}} -{{< include /guide/inventory/_view-record-activity-overview.qmd >}} - -{{< include /guide/inventory/_view-record-activity-steps.qmd >}} +{{< include /guide/reporting/_view-record-activity-steps.qmd >}} ::: diff --git a/site/training/common-slides/_view-record-activity.qmd b/site/training/common-slides/_view-record-activity.qmd new file mode 100644 index 0000000000..b72cddc4ae --- /dev/null +++ b/site/training/common-slides/_view-record-activity.qmd @@ -0,0 +1,27 @@ + + +## {.scrollable .center} + +:::: {.columns} +::: {.column width="30%" .pr4 .f2} +View record activity + +::: {.tc} +[Learn more ...](/guide/reporting/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 record activity + +{{< include /guide/reporting/_view-record-activity-overview.qmd >}} + +{{< include /guide/reporting/_view-record-activity-steps.qmd >}} + +::: + +:::: \ No newline at end of file diff --git a/site/training/developer-fundamentals/finalizing-documentation.qmd b/site/training/developer-fundamentals/finalizing-documentation.qmd index ddfc6a166c..961166ca88 100644 --- a/site/training/developer-fundamentals/finalizing-documentation.qmd +++ b/site/training/developer-fundamentals/finalizing-documentation.qmd @@ -263,7 +263,7 @@ Use the {{< var vm.checker >}} 1. Select the name of your model you registered for this course to open up the model details page. 2. On the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. 3. Locate the {{< var vm.checker >}} box on the right and click **{{< fa check >}} Check Document**. -4. Select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to to check your document against. +4. Select a **Regulation** and an associated **Assessment** from the drop-down menus to check your document against. 5. Scroll to the bottom and click **Check Document**. 6. After the {{< var vm.checker >}} has completed its analysis, expand individual questions or click **Expand All** to look through the observations. @@ -326,7 +326,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. # Track activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} -{{< include /training/common-slides/_track-changes-updates.qmd >}} +{{< include /training/common-slides/_view-record-activity.qmd >}} {{< include /training/common-slides/_review-model-activity.qmd >}} diff --git a/site/training/developer-fundamentals/implementing-custom-tests.qmd b/site/training/developer-fundamentals/implementing-custom-tests.qmd index 278a6aa0e9..1bd80b52d3 100644 --- a/site/training/developer-fundamentals/implementing-custom-tests.qmd +++ b/site/training/developer-fundamentals/implementing-custom-tests.qmd @@ -352,9 +352,9 @@ With the custom test results logged, let's head to the model we connected to at 4. Hover under the Pearson Correlation Matrix content block until a horizontal line with a **{{< fa plus >}}** button appears, indicating that you can insert a new block. -5. Click **{{< fa plus >}}** and then select **Test-Driven Block** under [from library]{.smallcaps}: +5. Click **{{< fa plus >}}** and then select **Test-Driven Block** under From Library: - - Click on **Custom** under [test-driven]{.smallcaps} in the left sidebar. + - Click on **Custom** under Test-Driven in the left sidebar. - Select the two custom `ConfusionMatrix` tests you logged previously: ![The ConfusionMatrix tests selected](/notebooks/tutorials/development/selecting-confusion-matrix-test.png){fig-alt="Screenshot showing the ConfusionMatrix tests selected" .screenshot} @@ -378,8 +378,8 @@ With the custom test results logged, let's head to the model we connected to at 2. In the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. 3. Click on **3.2 Model Evaluation** to expand that section. 4. Hover under the Pearson Correlation Matrix content block until a horizontal line with a **{{< fa plus >}}** button appears, indicating that you can insert a new block. -5. Click **{{< fa plus >}}** and then select **Test-Driven Block** under [from library]{.smallcaps}: - - Click on **Custom** under [test-driven]{.smallcaps} in the left sidebar. +5. Click **{{< fa plus >}}** and then select **Test-Driven Block** under From Library: + - Click on **Custom** under Test-Driven in the left sidebar. - Select the two custom `ConfusionMatrix` tests you logged previously. 6. Finally, click **Insert 2 Test Results to Document** to add the test results to the documentation. diff --git a/site/training/developer-fundamentals/learning-to-run-tests.qmd b/site/training/developer-fundamentals/learning-to-run-tests.qmd index c720e5c9b5..2cdd67a4c0 100644 --- a/site/training/developer-fundamentals/learning-to-run-tests.qmd +++ b/site/training/developer-fundamentals/learning-to-run-tests.qmd @@ -309,8 +309,8 @@ Work with test results 2. In the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. 3. Click on **2.3 Correlations and Interactions** to expand that section. 4. Hover under the Pearson Correlation Matrix content block until a horizontal line with a **{{< fa plus >}}** button appears, indicating that you can insert a new block. -5. Click **{{< fa plus >}}** and then select **Test-Driven Block** under [from library]{.smallcaps}: - - Click on **VM Library** under [test-driven]{.smallcaps} in the left sidebar. +5. Click **{{< fa plus >}}** and then select **Test-Driven Block** under From Library: + - Click on **VM Library** under Test-Driven in the left sidebar. - In the search bar, type in `HighPearsonCorrelation`. - Select `HighPearsonCorrelation:balanced_raw_dataset` as the test. 5. Finally, click **Insert 1 Test Result to Document** to add the test result to the documentation. diff --git a/site/training/developer-fundamentals/using-validmind-for-development.qmd b/site/training/developer-fundamentals/using-validmind-for-development.qmd index ef4bf79cca..b723759d88 100644 --- a/site/training/developer-fundamentals/using-validmind-for-development.qmd +++ b/site/training/developer-fundamentals/using-validmind-for-development.qmd @@ -186,7 +186,7 @@ Once you've registered your model, let's select a documentation template. A temp 1. Click on the name of the model you registered earlier. 2. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Development**. -3. Under [create document]{.smallcaps}, select `Binary classification` from the **[template]{.smallcaps}** drop-down menu. +3. Under **Create Document**, select `Binary classification` from the **Template** drop-down menu. 4. Click **Use Template** to apply the template. :::: {.f2 .embed} diff --git a/site/training/program/learning-paths.qmd b/site/training/program/learning-paths.qmd index 7d469a3128..b898e221f4 100644 --- a/site/training/program/learning-paths.qmd +++ b/site/training/program/learning-paths.qmd @@ -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 record activity +- Audit organization activity - Audit workflows - View and customize analytics diff --git a/site/training/validator-fundamentals/finalizing-validation-reports.qmd b/site/training/validator-fundamentals/finalizing-validation-reports.qmd index 5f7ca5093b..8134b8b131 100644 --- a/site/training/validator-fundamentals/finalizing-validation-reports.qmd +++ b/site/training/validator-fundamentals/finalizing-validation-reports.qmd @@ -445,7 +445,7 @@ Along with model-specific artifacts, you can also view and filter a list of arti 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 triangle-exclamation >}} Validation Issues**. 3. Select the validation issue you logged during this course, and make some changes to any of the fields. -4. When you are finished editing, set the valildation issue **[status]{.smallcaps}** to `Closed`. +4. When you are finished editing, set the validation issue **Status** to `Closed`. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -549,7 +549,7 @@ Use the {{< var vm.checker >}} 1. Select the name of your model you registered for this course to open up the model details page. 2. On the left sidebar that appears for your model, click **Validation** under {{< fa file >}} Documents. 3. Locate {{< fa file-circle-check >}} Check Document on the right and click to expand the menu, then click **{{< fa check >}} Check Document**. -4. Select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to to check your report against. +4. Select a **Regulation** and an associated **Assessment** from the drop-down menus to check your report against. 5. Scroll to the bottom and click **Check Validation Document**. 6. After the {{< var vm.checker >}} has completed its analysis, expand individual questions or click **Expand All** to look through the observations. @@ -614,7 +614,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. # Track activity {background-color="#083E44" background-image="/training/assets/home-hero.svg"} -{{< include /training/common-slides/_track-changes-updates.qmd >}} +{{< include /training/common-slides/_view-record-activity.qmd >}} {{< include /training/common-slides/_review-model-activity.qmd >}} diff --git a/site/training/validator-fundamentals/using-validmind-for-validation.qmd b/site/training/validator-fundamentals/using-validmind-for-validation.qmd index 32506b258e..437beed97e 100644 --- a/site/training/validator-fundamentals/using-validmind-for-validation.qmd +++ b/site/training/validator-fundamentals/using-validmind-for-validation.qmd @@ -189,9 +189,9 @@ For this training course, you'll register a dummy record and assign yourself as In order to log tests as a validator instead of as a developer, we'll need to adjust your **inventory record stakeholder** permissions: 1. Select the name of your model you registered for this course to open up the model details page. -2. Remove yourself as an owner by clicking on the **[owners]{.smallcaps}** tile, then clicking on the **x** next to your name. Click **Save** to apply your changes to that role. -3. Remove yourself as a developer by clicking on the **[developers]{.smallcaps}** tile, then clicking on the **x** next to your name. Click **Save** to apply your changes to that role. -4. Add yourself as a validator by clicking on the **[validators]{.smallcaps}** tile, and selecting your name from the drop-down menu. Click **Save** to apply your changes to that role. +2. Remove yourself as an owner by clicking on the **Owners** tile, then clicking on the **x** next to your name. Click **Save** to apply your changes to that role. +3. Remove yourself as a developer by clicking on the **Developers** tile, then clicking on the **x** next to your name. Click **Save** to apply your changes to that role. +4. Add yourself as a validator by clicking on the **Validators** tile, and selecting your name from the drop-down menu. Click **Save** to apply your changes to that role. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -210,7 +210,7 @@ We'll need this documentation template later for reference as we draft our valid 1. Click on the name of the model you registered earlier. 2. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Development**. -3. Under [create document]{.smallcaps}, select `Binary classification` from the **[template]{.smallcaps}** drop-down menu. +3. Under **Create Document**, select `Binary classification` from the **Template** drop-down menu. 4. Click **Use Template** to apply the template. :::: {.f2 .embed} @@ -233,7 +233,7 @@ Next, let's select a validation report template. A template predefines sections 1. Click on the name of the model you registered earlier. 2. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Validation**. -3. Under [create document]{.smallcaps}, select `Generic Validation Report` from the **[template]{.smallcaps}** drop-down menu. +3. Under **Create Document**, select `Generic Validation Report` from the **Template** drop-down menu. 4. Click **Use Template** to apply the template. :::: {.f2 .embed}