Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
7bae551
Integrations: Core guides
validbeck Jun 2, 2026
24ec04a
Integrations: Jira example
validbeck Jun 2, 2026
03e6968
Integrations: ServiceNow example
validbeck Jun 2, 2026
3f0ce4a
save
validbeck Jun 2, 2026
b4bc134
Merge 'main' into beck/sc-16491/documentation-primary-record-types-final
validbeck Jun 2, 2026
c20c0bd
Edit: ServiceNow example
validbeck Jun 2, 2026
741839a
Edit: JIRA example
validbeck Jun 2, 2026
2fd85e6
Edit: AWS Bedrock
validbeck Jun 2, 2026
38eabc7
Edit...
validbeck Jun 2, 2026
a309bf4
Edit: AWS SageMaker
validbeck Jun 2, 2026
98a48f8
Edit: GitLab
validbeck Jun 2, 2026
19baa4b
Edit: Databricks
validbeck Jun 2, 2026
83a6d3d
Edit: Workflow webhooks
validbeck Jun 2, 2026
7d80ee0
save
validbeck Jun 2, 2026
dd191a7
save
validbeck Jun 2, 2026
3b883e8
save
validbeck Jun 2, 2026
fd4bdd6
WIP: Implement custom integratons
validbeck Jun 2, 2026
5df6819
saqve
validbeck Jun 2, 2026
e9da6e6
Edit: Implement custom integrations
validbeck Jun 2, 2026
437741e
Edit: Managing integrations
validbeck Jun 2, 2026
8694f6e
Edit: Manage secretes
validbeck Jun 2, 2026
bc35314
Edit: Configure connections
validbeck Jun 2, 2026
7f86d73
Edit: Connect AI assistants via MCP
validbeck Jun 2, 2026
fec9c6c
save
validbeck Jun 2, 2026
9cfc761
save
validbeck Jun 2, 2026
e8de549
save
validbeck Jun 2, 2026
1a52ae8
save
validbeck Jun 2, 2026
b1dd193
save
validbeck Jun 2, 2026
45220dc
save
validbeck Jun 2, 2026
fa3ee49
Edi: Configure analytics exports
validbeck Jun 2, 2026
77ffaf3
proof
validbeck Jun 3, 2026
6a2bb3b
more proofreading
validbeck Jun 3, 2026
d1728ba
more proofreading
validbeck Jun 3, 2026
bfef378
more proofreading
validbeck Jun 3, 2026
53983f1
Edit & update sitemap
validbeck Jun 3, 2026
4df1a4c
steven's suggestions
validbeck Jun 5, 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
2 changes: 1 addition & 1 deletion site/guide/_sidebar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ website:
- guide/integrations/manage-secrets.qmd
- guide/integrations/configure-connections.qmd
- guide/integrations/implement-custom-integrations.qmd
- guide/integrations/link-external-models.qmd
- guide/integrations/link-external-records.qmd
- guide/mcp/connect-ai-assistants-via-mcp.qmd
- guide/integrations/configure-analytics-exports.qmd
- file: guide/integrations/integrations-examples.qmd
Expand Down
10 changes: 5 additions & 5 deletions site/guide/attestation/_configure-attestations.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ c. Set the **[start date]{.smallcaps}** for the attestation period.

d. Set the **[end date]{.smallcaps}** when the attestation period ends.

e. Optional: Toggle **[email reminders]{.smallcaps}** to send reminders to Submitters, Reviewers, and Approvers:
e. (Optional) Toggle **[email reminders]{.smallcaps}** to send reminders to Submitters, Reviewers, and Approvers:

- **[days before end]{.smallcaps}** — How many days before the end date to send the reminder.
- **[subject]{.smallcaps}** — The email subject line.
Expand Down Expand Up @@ -94,7 +94,7 @@ a. Under Inventory Scope, click **{{< fa plus >}} Add Rule** to add a filter con

b. Click **Save**.

c. Optional: Click **View Records** to preview which records match your filter criteria.
c. (Optional) Click **View Records** to preview which records match your filter criteria.

::: {.embed-tip}
### How do I filter for groups?
Expand All @@ -113,7 +113,7 @@ a. Under Relevant Attestation Fields, drag inventory record fields between colum
- **Inventory Record Fields** — Available fields from the inventory
- **Relevant Attestation Fields** — Selected fields to display in record snapshots

b. Optional: Reorder the fields to change how they display in the attestation.
b. (Optional) Reorder the fields to change how they display in the attestation.

### 5. Add questionnaire fields

Expand Down Expand Up @@ -150,7 +150,7 @@ c. Click **Add Field**.

d. Repeat to add additional fields as needed.

e. Optional: Reorder fields by dragging them to change the order in which they appear to submitters.
e. (Optional) Reorder fields by dragging them to change the order in which they appear to submitters.

Questionnaire fields are available immediately for new attestation instances. Submitters see structured inputs for each field, and responses are collected consistently across all submissions.

Expand Down Expand Up @@ -198,7 +198,7 @@ a. Under Relevant Attestation Fields, drag inventory record fields between colum
- **Inventory Record Fields** — Available fields from the inventory
- **Relevant Attestation Fields** — Selected fields to display in record snapshots

a. Optional: Reorder the fields to change how they display in the attestation.
a. (Optional) Reorder the fields to change how they display in the attestation.

#### Add questionnaire fields

Expand Down
10 changes: 5 additions & 5 deletions site/guide/attestation/manage-attestations.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ For testing purposes only, you can trigger the attestation process:

3. Under **Attestation Periods**, hover over an attestation period.

4. When **{{< fa ellipsis-vertical >}}** appears, select **{{< fa play >}} Start Now**.
4. When the **{{< fa ellipsis-vertical >}}** menu appears, select **{{< fa play >}} Start Now**.

5. Click **Confirm**.

Expand All @@ -64,7 +64,7 @@ After starting the schedule, attestation participants are notified via My Inbox

3. Under **Attestation Periods**, hover over an attestation period.

4. When **{{< fa ellipsis-vertical >}}** appears, select **{{< fa pencil >}} Edit**.
4. When the **{{< fa ellipsis-vertical >}}** menu appears, select **{{< fa pencil >}} Edit**.

5. Make your desired changes to the following:

Expand All @@ -88,7 +88,7 @@ This action cannot be undone. The history of previous attestation periods is una

3. Under **Attestation Periods**, hover over an attestation period.

4. When **{{< fa ellipsis-vertical >}}** appears, select [**{{< fa trash >}} Cancel Period**]{.red}.
4. When the **{{< fa ellipsis-vertical >}}** menu appears, select [**{{< fa trash >}} Cancel Period**]{.red}.

5. Click **Confirm** to cancel the period.

Expand Down Expand Up @@ -184,7 +184,7 @@ To manually complete an attestation period:

3. Under **Attestation Periods**, hover over an active attestation period.

4. When **{{< fa ellipsis-vertical >}}** appears, select **{{< fa check >}} Complete Period**.
4. When the **{{< fa ellipsis-vertical >}}** menu appears, select **{{< fa check >}} Complete Period**.

5. Click **Confirm**.

Expand All @@ -204,7 +204,7 @@ You cannot delete an attestation template if it has any active attestation perio

3. Locate the template to delete and hover over it.

4. When **{{< fa ellipsis-vertical >}}** appears, select [**{{< fa trash >}} Delete**]{.red}.
4. When the **{{< fa ellipsis-vertical >}}** menu appears, select [**{{< fa trash >}} Delete**]{.red}.

5. Click **Confirm** to delete the template.

Expand Down
2 changes: 1 addition & 1 deletion site/guide/attestation/review-attestations.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ As a reviewer, you assess the submitter's attestation, including ownership, usag
- **Validation Issues** — Shows open validation issues at the time of the snapshot.
- **Artifacts** — Shows artifacts (findings) captured in the snapshot.

4. Optional: Click **Activity** to review the attestation history:
4. (Optional) Click **Activity** to review the attestation history:

- Who completed the different status changes.
- When the attestation status changed.
Expand Down
39 changes: 20 additions & 19 deletions site/guide/attestation/working-with-attestations.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,6 @@ listing:

{{< include /guide/attestation/_attestations.qmd >}}

::: {.attn}

## Prerequisites

- [x] {{< var link.login >}}
- [x] Records registered in the inventory require attestation.[^1]
- [x] If applicable, artifacts (findings) have been documented.[^2]
- [x] You are assigned a role with sufficient permissions to perform attestation tasks:[^3]
- [{{< fa hand >}} Customer Admin]{.bubble} — Sets up attestations
- [Submitter]{.bubble} — Stakeholder who submits attestation questionnaires
- [Reviewer]{.bubble} — Organizational role that reviews attestation questionnaires
- [Approver]{.bubble} — Organizational role that approves attestation questionnaires

:::

## Key concepts

{{< include /about/glossary/_attestation.qmd >}}
Expand Down Expand Up @@ -72,12 +57,12 @@ graph LR
A["**Not Started**"] --> B["**In Progress**"]
B --> C["**Ready for Review**"]
end

subgraph Reviewer
C --> D["**Reviewed**"]
D -.-> B
end

subgraph Approver
D --> E["**Signed Off**"]
end
Expand Down Expand Up @@ -109,7 +94,7 @@ If attestations were organized by owner alone, neither Emma nor Kam would have p
This approach ensures 100% accountability per group, where Emma approves all Fraud records and Kam approves all KYC records. If Fraud has two co-leads (Emma and Andres), either can approve.
:::

## How do I create meaningful attestation questionnaires?
### How do I create meaningful attestation questionnaires?

Attestation questionnaires are typically used in risk management to confirm that key controls, governance processes and documentation requirements have been followed throughout a record's lifecycle. These questionnaires are part of a broader effort to ensure accountability and regulatory compliance.

Expand All @@ -131,15 +116,31 @@ Areas typically covered in the questionnaire:

Work with your risk management team to create a template that accurately reflects your organization's attestation requirements.

::: {.attn}

## Prerequisites

- [x] {{< var link.login >}}
- [x] Records registered in the inventory require attestation.[^1]
- [x] If applicable, artifacts (findings) have been documented.[^2]
- [x] You are assigned a role with sufficient permissions to perform attestation tasks:[^3]
- [{{< fa hand >}} Customer Admin]{.bubble} — Sets up attestations
- [Submitter]{.bubble} — Stakeholder who submits attestation questionnaires
- [Reviewer]{.bubble} — Organizational role that reviews attestation questionnaires
- [Approver]{.bubble} — Organizational role that approves attestation questionnaires

:::

## Manage attestations

::: {#attestation-listing}
:::


<!-- FOOTNOTES -->

[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)

[^2]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd)

[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Create a private subnet in a supported GCP region that can be used to expose {{<
c. Configure the IP address range to ensure it includes at least a `/28` of usable private IP address space.
d. Click **Create**.

2. Optional: Enable Private Google Access to provide access to Google APIs and services.[^2]
2. (Optional) Enable Private Google Access to provide access to Google APIs and services.[^2]

3. Provision two IP addresses in this subnet for later use:

Expand Down
12 changes: 6 additions & 6 deletions site/guide/configuration/customize-your-dashboard.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Dashboards allow you to use widgets to quickly review and access information by

1. In the left sidebar, click **{{< fa home >}} Dashboard**.

2. Click **{{< fa plus>}} Add Dashboard**.
2. Click **{{< fa plus >}} Add Dashboard**.

3. On the Add New Dasboard modal that appears, enter the:
3. On the Add New Dashboard modal that appears, enter the:

- **[dashboard name]{.smallcaps}**
- **[description]{.smallcaps}** (optional)
Expand All @@ -56,7 +56,7 @@ Deletion of dashboards is permanent.

#### Edit dashboard details

a. Select **{{< fa pencil >}} Details** to edit a **[dashboard name]{.smallcaps}** or **[description]{.smallcaps}**.
a. Select **{{< fa pencil >}} Details** to edit a **[dashboard name]{.smallcaps}** or **[description]{.smallcaps}**.

b. Make your edits then click **Save Changes** to apply your adjustments.

Expand Down Expand Up @@ -99,11 +99,11 @@ Retrieve a list of the latest artifacts[^5] or recent activity.[^6]

3. Click **{{< fa pencil >}} Edit Dashboard**.

4. Hover over the title of a widget until the **{{< fa hand>}}** appears.
4. Hover over the title of a widget until the **{{< fa hand >}}** appears.

5. Click and drag to position your widget as desired.

To resize a widget, hover over the bottom-right corner of a widget until the **{{< fa hand>}}** appears, then adjust the dimensions to your liking.
To resize a widget, hover over the bottom-right corner of a widget until the **{{< fa hand >}}** appears, then adjust the dimensions to your liking.

6. Click **Done Editing** to exit the editor.

Expand Down Expand Up @@ -174,7 +174,7 @@ Removing a widget from a dashboard will not delete the linked view or analytics

4. Hover over the widget you would like to remove.

5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Remove**]{.red}.
5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can >}} Remove**]{.red}.

6. Click **Yes, Delete Widget** to confirm permanent deletion of the widget from that dashboard.

Expand Down
4 changes: 2 additions & 2 deletions site/guide/configuration/manage-platform-notifications.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ To mark an individual update as read:

a. Hover over the update you want to mark as read.

b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa envelope >}} Mark as Read**.
b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa envelope >}} Mark as Read**.

To mark multiple updates as read:

Expand All @@ -79,7 +79,7 @@ To dismiss an individual update:

a. Hover over the update you want to dismiss.

b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa bell-slash >}} Dismiss**.
b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa bell-slash >}} Dismiss**.

To dismiss all updates:

Expand Down
4 changes: 2 additions & 2 deletions site/guide/configuration/set-up-your-organization.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This task involves managing organizations within {{< var vm.product >}}, allowin

a. Hover over the business unit you want to rename.

b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pencil >}} Edit Details** to rename the business unit.
b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa pencil >}} Edit Details** to rename the business unit.

c. Click **Save** to apply your changes.

Expand All @@ -51,7 +51,7 @@ In order to delete a business unit, there must be no records attached to that un

a. Hover over the business unit you want to delete.

b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Delete Business Unit**]{.red} to remove the business unit.
b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can >}} Delete Business Unit**]{.red} to remove the business unit.

::: {.callout-important}
In order to delete a business unit, there must be no records attached to that unit.
Expand Down
2 changes: 1 addition & 1 deletion site/guide/documentation/collaborate-with-others.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ b. Click on the version you would like to compare another version to.

c. Hover over the other version to compare with your first version.

d. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **Compare against selected**.
d. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **Compare against selected**.

### Rename a version

Expand Down
30 changes: 12 additions & 18 deletions site/guide/documentation/working-with-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,7 @@ After you upload initial documentation through the {{< var validmind.developer >

This section describes how to work with Development type documents[^1] (for example, model documentation) in the {{< var validmind.platform >}}. Typically, you perform the tasks described here **after you have uploaded some initial documentation** with the {{< var validmind.developer >}}.

[Learn more about the {{< var validmind.developer >}} {{< fa hand-point-right>}}](/developer/validmind-library.qmd){.button .button-green}
:::

::: {.attn}

## Prerequisites

- [x] {{< var link.login >}}
- [x] The record you are documenting is registered in the inventory.[^2]
- [x] You have provided some content for the documentation, either by uploading it through the {{< var vm.developer >}}[^3] or via the {{< var vm.platform >}}.
- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4]

[Learn more about the {{< var validmind.developer >}} {{< fa hand-point-right >}}](/developer/validmind-library.qmd){.button .button-green}
:::

## Key concepts
Expand Down Expand Up @@ -80,6 +69,17 @@ This section describes how to work with Development type documents[^1] (for exam

::::

::: {.attn}

## Prerequisites

- [x] {{< var link.login >}}
- [x] The record you are documenting is registered in the inventory.[^2]
- [x] You have provided some content for the documentation, either by uploading it through the {{< var vm.developer >}}[^3] or via the {{< var vm.platform >}}.
- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4]

:::

## Document Overview

{{< include _document-overview.qmd >}}
Expand All @@ -106,12 +106,6 @@ Modify the contents of the **Latest** version of your document:[^6]
b. Select **Save current revision** and enter a name.
c. Click {{< fa check >}} to save the current revision.

<!---
## Troubleshooting

[Include any common issues or errors that may arise during the task and how to resolve them.]
--->

## Prepare documentation

Draft, edit, and refine your documentation, complete with supporting test results:
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading