Entities are variables within a Document Set. They always have a name and a value. The name consists of a string of alphanumeric characters (a ... z, A ... Z, 0 ... 9). The value is any character string which may also contain references to other entities.

Entities can be defined at a Document Set, at folders within a Document Set, or in templates within the Document Set.

4.16.3.1 Entity definition for a Document Set or folder

For a Document Set or a folder, entities are defined by selecting the menu entry  Action    Entities   and then filling a form with the name and value of the entity.

4.16.3.2 Entity definition in Templates

Within templates, entities are defined with the notation

<entity name="name of entity">
value of entity
</entity>

4.16.3.3 Entity references

Entities are references with the notation

&(name of entity);

References can be made within templates or within entity definitions for a Document Set or a folder.

4.16.3.4 Scope of entity definitions

Entities defined in the Document Set can be referenced anywhere from folders or in templates within the Document Set and its folders. Entities defined in a specific folder of the Document Set can be referenced anywhere from folders or in templates subordinate to these folders, i.e., the scope of entity definitions follows the folder hierarchy. Existing entity definitions can be replaced (overridden) by new definitions in subordinate folders or within templates.