dms.WriteShadowData

Dieser Job schreibt Schattendaten (Schattenkopien ausgewählter Indexfeldwerte) zu einem DMS-Objekt. Schattendaten werden separat vom Hauptobjekt persistiert und dienen vor allem:

  • als Snapshot vor strukturellen Änderungen am Hauptobjekt (Audit/Backup),

  • als schreibbar gehaltene Indexkopie, wenn das Originalobjekt durch Retention/Archivierung schreibgeschützt ist,

  • als Bereitstellungsdaten für ein sekundäres Archiv (z. B. ein Langzeit-Archiv), das die Indexwerte erhalten soll, ohne ins Hauptarchiv zurückzuschreiben.

Die geschriebenen Daten können anschliessend über dms.GetShadowData zurückgelesen werden.

Der Job ist in der offiziellen enaio®-DMS-Engine-Übersicht nicht gelistet.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

ObjectID

INT

Ja

Numerische ID des DMS-Objekts.

ObjectType

INT

Ja

Objekttyp-ID des DMS-Objekts (siehe Objekttyp-ID).

ArchiveType

INT

Ja

Ziel-Archive-/Typ-Identifier für die Schatten-Ablage. Korreliert typischerweise mit dem Haupttyp des Objekts; abweichende Werte sind möglich, wenn die Schattendaten in ein anderes Archiv geschrieben werden sollen.

UserIdent

INT

Ja

Numerische User-ID des auslösenden Anwenders (für Audit-Trail und Berechtigungsprüfung).

Flags

INT

Ja

Reserviert; stets 0 übergeben.

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

GUID

STRING

—

GUID des neu angelegten Schatten-Eintrags. Leer (''), wenn kein neuer Eintrag erzeugt wurde — entweder weil ein bestehender Eintrag aktualisiert wurde oder weil für den Objekttyp bzw. das Archiv keine Schattendaten konfiguriert sind. return_code = 0 signalisiert in beiden Fällen Erfolg.

3. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode (z. B. Objekt existiert nicht, ArchiveType ungültig, Datenbankfehler).

Weitere Rückgabewerte siehe Fehlercodes.

4. Hinweise

  • Idempotent — wiederholte Aufrufe mit identischen Parametern führen typischerweise zu einem UPDATE des bestehenden Schatten-Eintrags, nicht zu einem zusätzlichen INSERT.

  • Leerer GUID-Output bedeutet keinen Fehler (siehe Beschreibung des Parameters).

5. Verwandte Jobs

  • dms.GetShadowData — liest Schattendaten anhand der GUID aus der Historie zurück

  • dms.GetObjectHistory — liefert die Historie eines Objekts mit den GUIDs, die als Schlüssel für dms.GetShadowData dienen

  • dms.XMLUpdate — Indexdaten-Update auf XML-Basis; löst je nach Konfiguration implizit das Schreiben von Schattendaten aus

  • std.IndexDataChanged — signalisiert dem Server, dass die Indexdaten eines Objekts geändert wurden — Folgekomponenten aktualisieren daraufhin ggf. die Schattendaten