Document reference type
The predefined enumeration Document reference type (DocumentReferenceType) defines selection options for the ‘Document reference type’ for Documents, which defines the mechanism for establishing a relationship from one document to another entity (see Assigning documents).
The list can be customised.
There is a separate configuration type ‘Document reference type (configuration)’ (DocumentReferenceTypeConfiguration) for the configuration of enumeration values, which has two specific fields in addition to the ‘Icon URI’ (iconUri) field:
The Referenced entity (referencedEntity) field can optionally be assigned a reference for an entity type (using a Combobox).
The Reference search (referenceSearch) field defines a Search for the relevant entity type, in which the text value in the ‘Reference’ (reference) field of the document to be referenced can be accessed via the reference Variable. The screenshot on the right shows the Search for the only predefined Document reference type 'Entity ID' (ENTITY_ID), which contains a Field restriction as the only Where condition in which the Variable reference is matched with the 'ID' field of an undefined entity type (no Referenced entity selected). If the string provided by the document to be referenced as a ‘reference’ (reference) at runtime matches the number sequence of an ‘ID’ (id) for an instance of the entity type also to be provided, then a document that refers to this Document reference type is automatically assigned to the relevant entity when it is saved. |
|
Exactly one Document reference type is predefined by default:
Ordinal |
Name |
Description |
Icon URI |
Referenced entity |
Reference search |
German |
English |
French |
0 |
ENTITY_ID |
empty |
empty |
empty |
see screenshot |
leer |
Entity ID |
ID de l'entité |