Skip to main content

Keyword types

A keyword type is the reusable definition of a metadata field — Invoice number, Customer name, Date received. You define it once and assign it to as many document types as you need. Its data type and validation rules then apply everywhere it’s used. Manage keyword types under Admin settings → Keywords → Keyword types (open Admin settings from your profile menu at the bottom-left of the sidebar). The list shows every keyword type with its data type, length, any value list, and which document types use it. The same screen has a second tab for keyword type groups.
Keyword types list under Admin settings, Keywords, showing data type, length and dataset columns and a New keyword type button

Data types

The data type fixes what kind of value a keyword accepts and how it’s validated, sorted, and searched. Choose it when you create the keyword type.
Data typeUse it for
TextNames, references, and codes — any free or formatted text. Text keywords have the most options: length, case, masks, and value lists.
Whole numberCounts and integer identifiers.
DecimalNumbers with fractional precision.
CurrencyMonetary amounts. A specific-currency variant pins the value to a defined currency format.
DateA calendar date with no time.
Date & timeA precise moment in time.
Pick the most specific data type that fits. It drives correct sorting and comparison (so dates sort as dates, not text), tighter validation, and better search — and the data type can’t be changed later without recreating the keyword.

Text keyword options

Text keywords support extra validation that the other data types don’t:
OptionWhat it does
Maximum lengthThe longest value allowed, from 1 to 255 characters.
Text caseWhether values are stored as entered (mixed case) or forced to upper or lower case. Forcing case keeps look-ups consistent.
Input maskA fixed format the value must follow — for example 99-AAA-99. Fixed characters in the mask (such as the dashes) are part of the pattern.
Value list (dataset)A defined set of allowed values — see Value lists.

Lengthening a text keyword

You can increase a text keyword’s maximum length later if values outgrow it. You cannot shorten it, because that would risk truncating values already stored. Plan a generous length up front for fields that might grow.

Value lists

A value list (dataset) attaches a set of allowed values to a keyword, so users pick from a list instead of typing freely. There are two strengths:
ModeBehaviour
SuggestedUsers get a dropdown of the listed values but can still enter something else. Good for convenience and consistency.
RestrictedUsers must choose a value from the list. Anything else is rejected. Good for controlled vocabularies.
You enter the values one per line when creating or editing the keyword type. A restricted list must contain at least one value.

Deleting a keyword type

Deleting a keyword type is permanent and requires the Keyword Configuration Administration permission (see Application permissions). A keyword type cannot be deleted while it’s still in use. Nobly Insight blocks the delete and tells you what references it — for example:
  • it’s assigned to a document type,
  • it’s a member of a keyword type group or autofill keyword set,
  • it’s used by a security keyword rule or a retention policy,
  • it still has stored values.
Remove those references first, then delete.

Keyword assignment models

Assign keyword types to document types as standalone fields or grouped together.

Autofill keyword sets

Fill related keywords automatically from a single look-up value.