Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
da60630
Setup > View settings activity
validbeck Jun 2, 2026
b92d116
Integrations analytics WIP
validbeck Jun 2, 2026
396abeb
Merge 'main' into beck/sc-15647/documentation-activity-log-for-settin…
validbeck Jun 2, 2026
ef3e2fa
reverting integrations and LLM changes for now
validbeck Jun 3, 2026
c66584d
wip
validbeck Jun 3, 2026
69527a4
Save
validbeck Jun 3, 2026
37c6eb3
Save
validbeck Jun 4, 2026
5a749db
save
validbeck Jun 8, 2026
36edee0
save
validbeck Jun 8, 2026
5d5f4c4
Working with documents > Managing documents
validbeck Jun 8, 2026
a150810
updated member removal from group
validbeck Jun 8, 2026
d632155
edit
validbeck Jun 8, 2026
5d2a4a1
save
validbeck Jun 8, 2026
75bb35a
save
validbeck Jun 8, 2026
49c91d9
View settings activity
validbeck Jun 8, 2026
1adc4b3
save
validbeck Jun 8, 2026
2769128
setup for training
validbeck Jun 9, 2026
fc45903
moving View record activity into reporting
validbeck Jun 9, 2026
75e993c
save
validbeck Jun 9, 2026
5af3154
training done
validbeck Jun 9, 2026
5b3118b
pull from main, resolve conflicts
validbeck Jun 9, 2026
117b869
regen sitemap
validbeck Jun 9, 2026
292f29a
oops i somehow committed some rendered files
validbeck Jun 9, 2026
99e7f60
FAQ wip
validbeck Jun 9, 2026
ba219ee
save
validbeck Jun 9, 2026
a55a910
save
validbeck Jun 9, 2026
f7436a8
save
validbeck Jun 9, 2026
1b1d730
save
validbeck Jun 9, 2026
5aa1c22
faq: integrations
validbeck Jun 9, 2026
064b4a8
save
validbeck Jun 9, 2026
df450ea
FAQ: attestations
validbeck Jun 9, 2026
690e8b9
edit
validbeck Jun 9, 2026
15f631e
Configure analytics exports > Configure data exports
validbeck Jun 9, 2026
3835f53
edit
validbeck Jun 9, 2026
6d54230
edit
validbeck Jun 9, 2026
b65c925
save
validbeck Jun 10, 2026
2cccf68
Move private connectivity to its own accordian
validbeck Jun 10, 2026
1fd8e01
update sitemap
validbeck Jun 10, 2026
1a73da8
proof
validbeck Jun 10, 2026
6987099
more proofreading
validbeck Jun 10, 2026
dfe9e7b
fix
validbeck Jun 10, 2026
dd352da
edit
validbeck Jun 10, 2026
ba94843
cleanup
validbeck Jun 10, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -29,15 +29,15 @@ website:
type: express
style: simple
position: center
google-analytics:
google-analytics:
tracking-id: "G-S46CKWPNSS"
anonymize-ip: true
show-item-context: true
page-navigation: true
repo-url: https://github.com/validmind/documentation/
repo-subdir: site/
repo-actions: [edit, issue]

navbar:
collapse-below: xl
logo: logo.svg
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -207,7 +210,7 @@ website:
<li><a href="/guide/guides.qmd#documents-templates">Documents & templates</a></li>
<li><a href="/guide/guides.qmd#documentation">Documentation</a></li>
<li><a href="/guide/guides.qmd#validation">Validation</a></li>
<li><a href="/guide/guides.qmd#reporting">Reporting</a></li>
<li><a href="/guide/guides.qmd#reporting-auditing">Reporting & auditing</a></li>
<li><a href="/guide/guides.qmd#monitoring">Monitoring</a></li>
<li><a href="/guide/guides.qmd#attestation">Attestation</a></li>
</ul>
Expand Down Expand Up @@ -236,7 +239,7 @@ website:
<div class="footer-heading">Training</div>
<ul>
<li><a href="/training/program/learning-paths.qmd">Learning paths</a></li>
<li><a href="/training/training.qmd#available-courses">Courses</a></li>
<li><a href="/training/training.qmd#training-curriculum">Courses</a></li>
<li><a href="/training/training.qmd#available-videos">Videos</a></li>
</ul>
</div>
Expand Down
12 changes: 6 additions & 6 deletions site/about/deployment/deployment-options.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
Expand Down Expand Up @@ -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}
:::

<!-- FOOTNOTES -->
[^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)

4 changes: 2 additions & 2 deletions site/about/using-the-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]:

Expand Down
9 changes: 9 additions & 0 deletions site/faq/_faq-document-checker.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- 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 -->

## 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 >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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)]
10 changes: 8 additions & 2 deletions site/faq/_faq-exporting.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.]
2 changes: 1 addition & 1 deletion site/faq/_faq-progress-workflow.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- 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)]
8 changes: 8 additions & 0 deletions site/faq/_faq-settings-activity.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- 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 -->

## 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)]
4 changes: 2 additions & 2 deletions site/faq/_faq-tracking.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
118 changes: 118 additions & 0 deletions site/faq/faq-attestations.qmd
Original file line number Diff line number Diff line change
@@ -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}
:::


<!-- FOOTNOTES -->

[^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)
Loading
Loading