Documentation
Custom frameworks
Author your own compliance framework, add controls to it, map evidence to each control and delete frameworks or controls.
Overview
The six published frameworks cover the common standards. When your organization has its own baseline, a customer questionnaire or an internal policy to prove, author it as a custom framework. You give it a name and version, add the controls that matter to your tenant, and map evidence to each control. A custom framework sits beside the six published frameworks.
Open the Custom Frameworks tab on the Compliance page, or press g then f.
Screen tour
- New Framework: creates a custom framework.
- Expand / Collapse: shows or hides the framework’s controls.
- Add Control: adds a control to the framework.
- Delete: deletes the framework with all its controls and evidence mappings.
- Status: the control’s evidence status: Pass, Fail or Pending.
- Evidence: maps a piece of evidence to the control.
Each framework card shows the name, the version (for example v1.0), the number of controls and the description. Each control row shows the control ID, title, category, description, status, the number of mapped evidence items (n evidence), and the Evidence and Delete buttons.
Before you create your first framework, the tab shows No custom frameworks yet and a Create your first framework button.
Create a framework
- Name: the framework name, for example
Internal security baseline. Required. - Description: what the framework covers.
- Version: your version label, for example
1.0.
- On the Custom Frameworks tab, click New Framework.
- Enter the Name, and optionally a Description and Version.
- Click Create Framework.
Framework names are unique in your tenant.
Add a control
- Control ID: your identifier, for example
CC6.1. Required. - Title: a short name for the control. Required.
- Description: what the control requires.
- Category: a grouping, for example
Access Control.
- On the framework card, click Add Control.
- Enter the Control ID and Title, and optionally a Description and Category.
- Click Add Control.
Control IDs are unique within a framework. Click Expand to see the new control.
Map evidence to a control
An evidence mapping tells DeviceQuest which piece of evidence proves a control, for example an asset observation or an uploaded file.
- Evidence Type: the kind of evidence, for example
asset_observation. Required. - Evidence Reference: the observation key or file ID that identifies the evidence. Required.
- Click Expand on the framework card.
- On the control row, click Evidence.
- Enter the Evidence Type and Evidence Reference.
- Click Add Evidence.
The control’s evidence count goes up by one. The new mapping starts as Pending until it is evaluated.
Delete a framework or control
- Click Delete on the framework card, or on a control row.
- In Confirm Delete, read Are you sure you want to delete this framework? This action cannot be undone. (or …this control?…).
- Click Delete, or Cancel to keep it.
Deleting a framework also deletes all its controls and evidence mappings.
Fields
Framework
| Field | Description | Rules |
|---|---|---|
| Name | The framework name | Required; unique in your tenant |
| Description | What the framework covers | Optional |
| Version | Your version label | Optional |
Control
| Field | Description | Rules |
|---|---|---|
| Control ID | Your identifier for the control | Required; unique within the framework |
| Title | Short name | Required |
| Description | What the control requires | Optional |
| Category | Grouping such as Access Control | Optional |
Evidence mapping
| Field | Description | Rules |
|---|---|---|
| Evidence Type | The kind of evidence, for example asset_observation | Required |
| Evidence Reference | The observation key or file ID | Required |
Statuses
A control’s status comes from its evidence mappings.
| Status | Meaning | Next possible status |
|---|---|---|
| Pending | The control has no evidence mappings, or at least one mapping is still waiting to be evaluated | Pass or Fail once its evidence is evaluated |
| Pass | Every mapped piece of evidence passes | Fail if any evidence starts failing |
| Fail | At least one mapped piece of evidence fails | Pass when all evidence passes again |
Permissions
| Action | Permission |
|---|---|
| View custom frameworks and their controls | compliance:read |
| Create and delete frameworks and controls, add evidence mappings | compliance:write |