devguard
Collections

Definitions

Explain the terms your policies rely on once, in one glossary, and link acronyms and policy text to them.

A definition is a term with an explanation, for example Business impact analysis and what it means in your organization. Your policies and records can mention it with :. Acronyms can link to it, so BIA and its full form lead to the same explanation.

To mention, import, archive or delete definitions, see Collections. Scripts and integrations: see API below.

Add a definition

  1. Open Collections, then Definitions, and choose Add definition.
  2. Enter the term in Name, for example Business impact analysis.
  3. In Explanation, write what the term means. Write it for a reader who does not know the term.
  4. Choose Create.

When you mention the definition in a policy, the badge card shows the explanation. The policy PDF prints the name.

See which acronyms use it

Open the definition. On the Detail tab, Related Acronyms lists every acronym that links to it. To link another acronym, open that acronym and choose the definition there.


Reference

FieldRequiredNotes
NameyesThe term. 2 to 255 characters.
ExplanationnoWhat the term means.
SlugyesMade from the name. See Collections.

When you delete a definition, the acronyms that linked to it stay. They lose the link.

CSV columns

The template from Download CSV template has these columns. Leave slug empty to make it from the name.

definitions.csv
slug,name,explanation
business-impact-analysis,Business impact analysis,An analysis of how a disruption affects each process

API

The calls are the same for all collections; see the Collections API. The path is /definitions/.

FieldTypeRequired
organizationIdstringon create
namestring, 2 to 255 charactersyes
slugstring, lowercase with hyphensyes
explanationstringno
POST /definitions/
{
  "organizationId": "<organization id>",
  "name": "Business impact analysis",
  "slug": "business-impact-analysis",
  "explanation": "An analysis of how a disruption affects each business process."
}

How is this guide?

On this page