diff --git a/site/_quarto.yml b/site/_quarto.yml index 977562cd8..9cdad331c 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/deployment/deployment-options.qmd b/site/about/deployment/deployment-options.qmd index acb49defa..bbdcb0dde 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 39f59870e..b315faa77 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 e0eb1656f..a18f91b00 100644 --- a/site/developer/quickstart/install-and-initialize-validmind-library.qmd +++ b/site/developer/quickstart/install-and-initialize-validmind-library.qmd @@ -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 c59d30396..ab8ac1bf4 100644 --- a/site/developer/quickstart/store-credentials-in-env-file.qmd +++ b/site/developer/quickstart/store-credentials-in-env-file.qmd @@ -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 000000000..261f6c9c8 --- /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 739040675..1ed751f0f 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 67f93679a..5616ba40a 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/generating-exports.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 dd9e0f62b..4e49b576e 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 42dee4c34..80a3eea34 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 000000000..b93f48176 --- /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 2a8c46024..df96d1457 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 000000000..1f975d731 --- /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 76e1dd16a..07f9c2ff1 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 bd78fd085..5386d02b7 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 e1be63566..d409a7f83 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 3cb987a69..cbe623d9d 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 4709d309a..bbbc1395f 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 b2468c25e..f28132651 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 c672652c5..44f194fbe 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 6f82ab169..929ddb7f0 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 a188986d2..a390ba299 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 5b9a1424c..d337a8b37 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 50a718ba8..b7f878f89 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/guide/_sidebar.yaml b/site/guide/_sidebar.yaml index c2ec40712..c9860201b 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: @@ -48,7 +50,7 @@ website: - guide/integrations/implement-custom-integrations.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/accessing-validmind.qmd b/site/guide/access/accessing-validmind.qmd index 8aa90d6e4..6b4c14d69 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 e0cec28b5..7720c4719 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/working-with-attestations.qmd b/site/guide/attestation/working-with-attestations.qmd index cae0b87f9..af276f248 100644 --- a/site/guide/attestation/working-with-attestations.qmd +++ b/site/guide/attestation/working-with-attestations.qmd @@ -1,7 +1,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 +# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial ? title: "Working with attestations" date: last-modified listing: @@ -24,6 +24,12 @@ listing: {{< include /about/glossary/_attestation.qmd >}} +::: {.column-margin} +::: {#attestation-faq} +::: + +::: + ### Where do I access attestations? @@ -40,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. ::: @@ -136,6 +142,11 @@ Work with your risk management team to create a template that accurately reflect ::: {#attestation-listing} ::: +## What's next + +- [Attestation FAQ](/faq/faq-attestations.qmd) +- [Working with analytics](/guide/reporting/working-with-analytics.qmd) + diff --git a/site/guide/configuration/_add-remove-group-members.qmd b/site/guide/configuration/_add-remove-group-members.qmd index c111aab92..089375870 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/configuring-private-connectivity.qmd b/site/guide/configuration/configuring-private-connectivity.qmd new file mode 100644 index 000000000..a32e98ce9 --- /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 4c4d6646b..b14c2d995 100644 --- a/site/guide/configuration/customize-your-dashboard.qmd +++ b/site/guide/configuration/customize-your-dashboard.qmd @@ -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 96338b37d..ad1129245 100644 --- a/site/guide/configuration/manage-platform-notifications.qmd +++ b/site/guide/configuration/manage-platform-notifications.qmd @@ -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/managing-users.qmd b/site/guide/configuration/managing-users.qmd index 52bed3a7f..232445709 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 32813a5e1..0b282448d 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 87bc63515..11a335e84 100644 --- a/site/guide/configuration/set-up-your-organization.qmd +++ b/site/guide/configuration/set-up-your-organization.qmd @@ -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 6a694403e..3fe25621f 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 bf9e22965..03efd0ae5 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. diff --git a/site/guide/documentation/_check-documents.qmd b/site/guide/documentation/_check-documents.qmd index af38364c4..d17923a06 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} diff --git a/site/guide/documentation/_document-checker.qmd b/site/guide/documentation/_document-checker.qmd index 54919af98..bd34530c4 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 2a62793a5..4b6393e23 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 af25cd9fe..62f839f6e 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 0d087136c..9a2adcb3e 100644 --- a/site/guide/documentation/collaborate-with-others.qmd +++ b/site/guide/documentation/collaborate-with-others.qmd @@ -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/work-with-content-blocks.qmd b/site/guide/documentation/work-with-content-blocks.qmd index 6ec599dba..a8bc39014 100644 --- a/site/guide/documentation/work-with-content-blocks.qmd +++ b/site/guide/documentation/work-with-content-blocks.qmd @@ -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 15ee59055..af12c0e14 100644 --- a/site/guide/documentation/work-with-document-versions.qmd +++ b/site/guide/documentation/work-with-document-versions.qmd @@ -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 778e152aa..31a84af06 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 @@ -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 3375eb734..b6bd56e7a 100644 --- a/site/guide/documentation/working-with-documentation.qmd +++ b/site/guide/documentation/working-with-documentation.qmd @@ -118,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 4a14c93eb..b5d36744f 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-exports.qmd b/site/guide/integrations/configure-data-exports.qmd similarity index 65% rename from site/guide/integrations/configure-analytics-exports.qmd rename to site/guide/integrations/configure-data-exports.qmd index 8d00be60e..561d82cb7 100644 --- a/site/guide/integrations/configure-analytics-exports.qmd +++ b/site/guide/integrations/configure-data-exports.qmd @@ -2,12 +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: "Configure analytics exports" +title: "Configure data exports" date: last-modified +aliases: + - /guide/integrations/configure-analytics-exports.html --- -Configure scheduled exports of analytics 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. +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} @@ -19,11 +21,11 @@ Configure scheduled exports of analytics datasets to cloud storage so that BI to ::: -## View analytics exports +## View data exports 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports** to view existing export configuration details or export run history: +2. Under {{< fa puzzle-piece >}} Integrations, select **Data Exports** to view existing export configuration details or export run history: ::: {.panel-tabset} @@ -43,54 +45,55 @@ Review past runs with their status, start time, duration, rows exported, and fil ::: -## Create analytics exports +## Create data exports 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Data Exports**. -3. On the Analytics Exports page, click **{{< fa plus >}} Create Analytics Export**. +3. On the Data Exports page, click **{{< fa plus >}} Create Data Export**. -4. From the **[datasets]{.smallcaps}** dropdown, choose which analytics datasets to export: +4. From the **[datasets]{.smallcaps}** dropdown, choose which datasets to export: - Artifact - Limitation - Artifact - Policy Exception - Artifact - Validation Issue + - Custom artifact types[^3] - Inventory Records - - Record Activity[^3] - Custom inventory record types[^4] - - Custom artifact types[^5] + - Record Activity[^5] + - Settings Activity[^6] -5. Click **Next** {{< fa angle-right >}}. +5. For Record Activity or Settings Activity exports, choose a rolling activity window: **Last 30 days**, **Last 60 days**, or **Last 90 days**. -6. Configure the cloud storage destination and output settings: +6. Click **Next** {{< fa angle-right >}}. + +7. 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`). + - **[bucket]{.smallcaps}** — Enter the bucket or container name (example: `my-data-exports-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. +8. Click **Next** {{< fa angle-right >}}. -7. Click **Next** {{< fa angle-right >}}. - -8. Set how often to export: +9. 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`). - -9. Click **Create Analytics Export**. +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 analytics exports +## Manage data exports 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports** to edit existing export configurations, disable or enable exports, or delete configured exports: +2. Under {{< fa puzzle-piece >}} Integrations, select **Data Exports** to edit existing export configurations, disable or enable exports, or delete configured exports: ::: {.panel-tabset} @@ -112,7 +115,7 @@ The export stops or starts running depending on the action you take. ### Delete configured exports -::: {.callout-important title="Deleting an analytics export configuration is permanent."} +::: {.callout-important title="Deleting a data export configuration is permanent."} Data you exported previously will remain in the cloud storage destination unchanged. ::: @@ -124,11 +127,11 @@ c. In the confirmation dialog, click **Yes, Delete Export** to confirm deletion. ::: -## Run analytics exports manually +## Run data exports manually 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Data Exports**. 3. Hover over the export you want to run. @@ -150,9 +153,9 @@ A one-off export runs in addition to the scheduled runs. The status for a run is [^3]: - Record Activity exports audit events — for example, comments, workflow status changes, and field updates on inventory records. Use this dataset for compliance reporting or audit trails. Record Activity respects the same export scope (organization, workspace, or selected records) and supports 30, 60, or 90-day window filtering. + Any custom artifact types defined for your organization also appear in the datasets dropdown and can be exported.

    - **Learn more:** [View record activity](/guide/inventory/view-record-activity.qmd) + **Learn more:** [Manage artifact types](/guide/validation/manage-artifact-types.qmd) [^4]: @@ -162,6 +165,12 @@ A one-off export runs in addition to the scheduled runs. The status for a run is [^5]: - Any custom artifact types defined for your organization also appear in the datasets dropdown and can be exported. + 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:** [Manage artifact types](/guide/validation/manage-artifact-types.qmd) + **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/managing-integrations.qmd b/site/guide/integrations/managing-integrations.qmd index e8fa3650c..741d4a8ca 100644 --- a/site/guide/integrations/managing-integrations.qmd +++ b/site/guide/integrations/managing-integrations.qmd @@ -14,7 +14,7 @@ listing: contents: - manage-secrets.qmd - configure-connections.qmd - - configure-analytics-exports.qmd + - configure-data-exports.qmd - implement-custom-integrations.qmd - link-external-records.qmd - integrations-examples.qmd @@ -76,7 +76,7 @@ graph TD ### 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** @@ -100,7 +100,7 @@ Access built-in analytics and dashboards. Or, import analytics data into externa ### Inventory -Link to records (such as 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** @@ -160,7 +160,7 @@ Link to records (such as models) in external registries and development platform ![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 record lifecycles by configuring workflows to transition records through your organization’s custom record stages.[^3] +Manage record lifecycles by configuring workflows to transition records through your organization’s custom record stages.[^4] :::: {.flex .flex-wrap .justify-around} @@ -180,7 +180,7 @@ 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** @@ -204,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** @@ -279,12 +279,24 @@ Connect AI assistants to {{< var vm.product >}} using the Model Context Protocol :::{#integrations-listing} ::: +## What's next + +- [Integrations and support FAQ](/faq/faq-integrations.qmd) +- [Setting up workflows](/guide/workflows/introduction-to-workflows.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) + +[^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) + +[^5]: [Public REST API](/reference/validmind-rest-api-vm.qmd) + +[^6]: [Testing & documentation](/developer/validmind-library.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/_view-record-activity-overview.qmd b/site/guide/inventory/_view-record-activity-overview.qmd deleted file mode 100644 index a238d728b..000000000 --- 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/edit-inventory-fields.qmd b/site/guide/inventory/edit-inventory-fields.qmd index ab5194624..eb438af74 100644 --- a/site/guide/inventory/edit-inventory-fields.qmd +++ b/site/guide/inventory/edit-inventory-fields.qmd @@ -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/managing-the-inventory.qmd b/site/guide/inventory/managing-the-inventory.qmd index b5095eebb..f975f8e4f 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/setting-up-the-inventory.qmd b/site/guide/inventory/setting-up-the-inventory.qmd index c20d47de4..e108b251d 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 45bf466ba..535d42843 100644 --- a/site/guide/inventory/working-with-the-inventory.qmd +++ b/site/guide/inventory/working-with-the-inventory.qmd @@ -67,8 +67,8 @@ 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) diff --git a/site/guide/monitoring/enable-monitoring.qmd b/site/guide/monitoring/enable-monitoring.qmd index 07e64065a..7a289faa5 100644 --- a/site/guide/monitoring/enable-monitoring.qmd +++ b/site/guide/monitoring/enable-monitoring.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 6f3ad83e1..dc1966793 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 589707303..994a67ed7 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 78801e96d..5a3d60f70 100644 --- a/site/guide/monitoring/work-with-metrics-over-time.qmd +++ b/site/guide/monitoring/work-with-metrics-over-time.qmd @@ -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,7 +160,7 @@ 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 records](/guide/integrations/link-external-records.qmd) 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 000000000..9884a359c --- /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 100% rename from site/guide/inventory/_view-record-activity-steps.qmd rename to site/guide/reporting/_view-record-activity-steps.qmd 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 000000000..3b89b8e2d --- /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 000000000..b53fb6ed3 --- /dev/null +++ b/site/guide/reporting/_view-settings-activity-steps.qmd @@ -0,0 +1,52 @@ + + +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, click: + + - **All** to view all activity. + - **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)] + + When enough activity categories are displayed, click {{< fa chevron-left >}} or {{< fa chevron-right >}} to scroll through left or right respectively through the list. + + ### View more details about specific activity + + To view more details about specific activity, click {{< fa chevron-down >}} 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: + + - Narrow down settings activity by clicking on the tab for the category you want to view activity for. When enough categories are displayed, click {{< fa chevron-left >}} or {{< fa chevron-right >}} to scroll through left or right respectively through the list. + - View more details about specific activity by clicking {{< fa chevron-down >}} when the option is available on an entry. + +:::: diff --git a/site/guide/reporting/export-documents.qmd b/site/guide/reporting/export-documents.qmd index 4d698115a..f84a63a4b 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 f3e0420e8..6a4bdc2a0 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/tracking-organization-activity.qmd b/site/guide/reporting/tracking-organization-activity.qmd new file mode 100644 index 000000000..0bd0f7791 --- /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 91% rename from site/guide/inventory/view-record-activity.qmd rename to site/guide/reporting/view-record-activity.qmd index b710fd595..f107c10f8 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 @@ -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 000000000..c73a1aa8c --- /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 b1f644060..db51cb6f2 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/templates/_customize-document-templates.qmd b/site/guide/templates/_customize-document-templates.qmd index 1f37129c2..d7a08e8bd 100644 --- a/site/guide/templates/_customize-document-templates.qmd +++ b/site/guide/templates/_customize-document-templates.qmd @@ -27,7 +27,7 @@ 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**. @@ -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**. diff --git a/site/guide/templates/_duplicate-template.qmd b/site/guide/templates/_duplicate-template.qmd index f2f3c0420..dddfb3add 100644 --- a/site/guide/templates/_duplicate-template.qmd +++ b/site/guide/templates/_duplicate-template.qmd @@ -14,7 +14,7 @@ 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**. @@ -34,7 +34,7 @@ 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**. diff --git a/site/guide/templates/_view-document-templates.qmd b/site/guide/templates/_view-document-templates.qmd index a2bc6d93e..830f2a6ec 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-templates.qmd b/site/guide/templates/customize-document-templates.qmd index 80cc00805..cd8da00d4 100644 --- a/site/guide/templates/customize-document-templates.qmd +++ b/site/guide/templates/customize-document-templates.qmd @@ -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 76ed999d2..b6816eb71 100644 --- a/site/guide/templates/manage-document-templates.qmd +++ b/site/guide/templates/manage-document-templates.qmd @@ -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]: diff --git a/site/guide/templates/manage-documents.qmd b/site/guide/templates/manage-documents.qmd index ae09f9cc2..474290adb 100644 --- a/site/guide/templates/manage-documents.qmd +++ b/site/guide/templates/manage-documents.qmd @@ -62,7 +62,7 @@ b. Drag and drop a `.pdf` file into the upload area, or click **choose a file** 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: diff --git a/site/guide/templates/manage-text-block-library.qmd b/site/guide/templates/manage-text-block-library.qmd index b43d1ac6c..8b31aecb5 100644 --- a/site/guide/templates/manage-text-block-library.qmd +++ b/site/guide/templates/manage-text-block-library.qmd @@ -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 000000000..048f4341b --- /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 57aed31de..00078640b 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 e598a9a23..000000000 --- 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/manage-artifact-types.qmd b/site/guide/validation/manage-artifact-types.qmd index ac667db17..ca670618a 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. ::: ::: diff --git a/site/guide/validation/managing-validation.qmd b/site/guide/validation/managing-validation.qmd index c42a5853b..1c5e1c857 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 c169c8176..a1c77f8c6 100644 --- a/site/guide/validation/preparing-validation-reports.qmd +++ b/site/guide/validation/preparing-validation-reports.qmd @@ -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/update-artifacts.qmd b/site/guide/validation/update-artifacts.qmd index 34894b1c6..45bad46e1 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 ddbb30535..ba6b51576 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/_transition-workflows.qmd b/site/guide/workflows/_transition-workflows.qmd index a94ba254d..870a4d76c 100644 --- a/site/guide/workflows/_transition-workflows.qmd +++ b/site/guide/workflows/_transition-workflows.qmd @@ -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. diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index 76d03cb09..e0b8801da 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -164,10 +164,10 @@ Deleting workflow steps on workflows active on records may result in malfunction 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) diff --git a/site/guide/workflows/introduction-to-workflows.qmd b/site/guide/workflows/introduction-to-workflows.qmd index a233b9b39..2b69586fd 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/setting-up-workflows.qmd b/site/guide/workflows/setting-up-workflows.qmd index 6b5d25cdc..9a567a45d 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/working-with-workflows.qmd b/site/guide/workflows/working-with-workflows.qmd index b98a909e9..ff81e21f2 100644 --- a/site/guide/workflows/working-with-workflows.qmd +++ b/site/guide/workflows/working-with-workflows.qmd @@ -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/llm/chatbot-product-map-frontend-snapshot.json b/site/llm/chatbot-product-map-frontend-snapshot.json index 4ee66823a..b1609bea5 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 0ef651839..04f5bd8bd 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: 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 -- `/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: 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 + - 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,7 +492,7 @@ **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; 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` @@ -474,7 +514,7 @@ **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; 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` @@ -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: 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 + - 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,7 +607,7 @@ **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; 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` diff --git a/site/releases/2023/release-notes-2023-jul-24.qmd b/site/releases/2023/release-notes-2023-jul-24.qmd index 5c9bdc6b0..deb842b84 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 6f0b2eb79..aacebdeed 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 9fefde093..17ee901a8 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 ca223cc2e..42a50f830 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 a95046768..df10d2f02 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 469e0a772..a7eb8aa28 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/theme.scss b/site/theme.scss index b23ee2f1c..d656fc30f 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/organizational-oversight-reporting.qmd b/site/training/administrator-fundamentals/organizational-oversight-reporting.qmd index 3cc2be264..1a04aff90 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: + - Narrow down settings activity by clicking on the tab for the category you want to view activity for. + - View more details about specific activity by clicking {{< fa chevron-down >}} 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.) diff --git a/site/training/common-slides/_track-changes-updates.qmd b/site/training/common-slides/_track-changes-updates.qmd index b7041942a..b3e11642b 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 000000000..b72cddc4a --- /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 ddfc6a166..4ab3f9a62 100644 --- a/site/training/developer-fundamentals/finalizing-documentation.qmd +++ b/site/training/developer-fundamentals/finalizing-documentation.qmd @@ -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/validator-fundamentals/finalizing-validation-reports.qmd b/site/training/validator-fundamentals/finalizing-validation-reports.qmd index 5f7ca5093..e0afe4558 100644 --- a/site/training/validator-fundamentals/finalizing-validation-reports.qmd +++ b/site/training/validator-fundamentals/finalizing-validation-reports.qmd @@ -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 >}}