Dokumentenreferenztyp

Die vordefinierte Aufzählung Dokumentenreferenztyp (DocumentReferenceType) definiert Auswahlmöglichkeiten für den "Dokumentenreferenztyp" für Dokumente, der den Mechanismus zum Herstellen einer Beziehung von einem Dokument zu einer anderen Entität definiert (s. Dokumente zuweisen).

  • Die Aufzählung lässt Anpassungen zu.

  • Für die Konfiguration von Aufzählungswerten steht ein eigener Konfigurationstyp "Dokumentenreferenztyp (Konfiguration)" (DocumentReferenceTypeConfiguration) der neben dem Feld "Icon-URI" (iconUri) zwei spezifische Felder:

Das Feld Referenziertes Objekt (referencedEntity) kann optional (per Auswahlfeld/Combobox) mit einer Referenz für einen Entitätstyp belegt werden.

  • Wird ein Entitätstyp ausgewählt, dann gilt dieser Entitätstyp verbindlich für die auszuführende Suche nach Zielobjekten für das Zuweisen eines vorliegenden Dokuments.

  • Ist kein Entitätstyp ausgewählt, dann muss das zu referenzierende Dokument zur Laufzeit einen Entitätstyp im Feld "Referenziertes Objekt" (referencedObject) spezifizieren, auf den die im folgenden Parameter definierte Suche anwendbar ist.

Das Feld Referenz-Suche (referenceSearch) definiert eine Suche für den relevante Entitätstyp, in der über die Variable reference auf den Textwert im Feld "Referenz" (reference) des zu referenzierenden Dokuments zugegriffen werden kann.

Der Screenshot rechts zeigt die Suche für den einzigen vordefinierten Dokumentenreferenztyp "Entity ID" (ENTITY_ID), die eine Feld Einschränkung 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 Dokumentenreferenztyp bezieht, beim Speichern automatisch der betreffenden Entität zugewiesen.

images/download/attachments/201669229/image-2025-4-15_10-21-25-version-1-modificationdate-1744705285030-api-v2.png

Werksseitig ist genau ein Dokumentenreferenztyp 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é