Menü der Dokumentation

Verwenden von Dokumenteigenschaften im Formular

Um in einem Formular Zugriff auf die Eigenschaften eines Dokuments zu haben, können Sie die Formular-URL mit den folgenden Request-Parametern aufrufen:

  • dmsRepoId=<dms-repo-id>

  • dmsObjectId=<dms-object-id>

Die Dokumenteigenschaften werden automatisch beim Laden des Formulars aus der DMS-App ermittelt und im Formular mit der Variable dmsProperties als JSON-Objekt zur Verfügung gestellt.

Beispiel für das JSON-Objekt "dmsProperties"

{
  "myProperty" : "Hello!",
  "otherProperty" : 4711
}

Anmerkung

Wenn der Key einer Dokumenteigenschaft Punkte enthält, werden daraus Unterobjekte.

Beispiel:

Aus der Dokumenteigenschaft mit dem Key this.is.a.key und dem Wert My value wird folgendes JSON-Objekt:

{
  "this" : {
    "is" : {
      "a" : {
        "key" : "My value"
      }
    }
  }
}

Sie können die Dokumenteigenschaften auf zwei Arten verwenden:

  1. In einem Skript

  2. In einem Formularelement

Verwenden einer Dokumenteigenschaft in einem Skript

Sie können in einem Skript jederzeit sowohl lesend als auch schreibend auf das JSON-Objekt zugreifen. Wenn das Formular am Ende mit dem Event taskCompletion oder saveDmsProperties abgeschickt wird, werden die aktuellen Werte aus dem JSON-Objekt ermittelt und in die Dokumenteigenschaften geschrieben.

Binden eines Formularelements an eine Dokumenteigenschaft

Um ein Formularelement an eine Dokumenteigenschaft zu binden, öffnen Sie in den Einstellungen des Formularelements die Registerkarte API und geben Sie die Dokumenteigenschaft in der Form dmsProperties.<´dms-property-key> unter Property Name an. Dieses Formularelement wird nun beim Laden des Formulars mit dem Wert der Dokumenteigenschaft vorausgefüllt. Der Benutzer, welcher das Formular geöffnet hat, kann den Wert danach ggf. anpassen. Wenn das Formular am Ende mit dem Event taskCompletion abgesendet wird, wird der aktuelle Wert des Formularelements wieder in die Dokumenteigenschaften geschrieben.

Warnung

Die Dokumenteigenschaften werden im Namen des angemeldeten Benutzers, welcher das Formular geöffnet hat, geladen und gespeichert. Stellen Sie sicher, dass der Benutzer Berechtigungen für das Dokument hat.