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).

  • If an entity type is selected, then this entity type is binding for the Search being carried out for target objects to assign an existing document.

  • If no entity type is selected, the document to be referenced must specify an entity type in the ‘Referenced entity’ (referencedEntity) field at runtime to which the Search defined in the following parameter is applicable.

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.

Der Screenshot rechts zeigt die Search für den einzigen vordefinierten Document reference type "Entity ID" (ENTITY_ID), die eine Field restriction als einzige Bedingung beinhaltet, in der die Variable reference mit dem Feld "ID" eines dem Typ nach unbestimmten Entitätstyps (kein Referenziertes Objekt ausgewählt) abgeglichen wird.

Stimmt die vom zu referenzierenden Dokument zur Laufzeit als "Referenz" (reference) bereitgestellte Zeichenfolge mit der Ziffernfolge einer "ID" (id) für eine Instanz des ebenfalls bereitzustellenden Entitätstyps überein, dann wird ein Dokument, das sich auf den vorliegenden Document reference type bezieht, beim Speichern automatisch der betreffenden Entität zugewiesen.

images/download/attachments/201669229/image-2025-4-15_11-26-3-version-1-modificationdate-1744709162913-api-v2.png

Werksseitig ist genau ein Document reference type vorbelegt:

Ordinal

Name

Beschreibung

Icon-URI

Referenziertes Objekt

Referenz-Suche

Deutsch

Englisch

Französisch

0
ENTITY_ID

leer

leer

leer

s. Screenshot

leer

Entity ID

ID de l'entité