Anzeigen des Ablagedialogs

Freigegeben: HTML-Seite 

Der Ablagedialog des Features Ablage bietet Ihnen die Möglichkeit, DMS-Objekte zu speichern und zu aktualisieren.

Wenn Sie den Ablagedialog im Browser geöffnet und Werte eingegeben haben, dann wird Ihnen in der URL der Link zum Aufrufen des angezeigten Dialogs inklusive Ihrer eingegebenen Werte angezeigt. Sie können diesen Link z.B. als Lesezeichen im Browser verwenden, um den Ablagedialog immer mit den eingegebenen Werten anzuzeigen. In diesem Kapitel erfahren Sie, wie dieser Link aufgebaut ist.

Möchten Sie ein externes System anbinden, dann finden Sie weitere Informationen zum Speichern neuer DMS-Objekte mithilfe des Ablagedialogs unter Speichern neuer DMS-Objekte mit Benutzerinteraktion . Wie Sie aus einem externem System den Ablagedialog zum Aktualisieren vorbereiten und anzeigen, erfahren Sie im Kapitel  Aktualisieren von DMS-Objekten mit Benutzerinteraktion.

Ermitteln der Linkrelation zum Anzeigen des Ablagedialogs 

Wenn Sie die Rootressource /dms aufrufen, erhalten Sie als Antwort ein JSON-Objekt mit der Linkrelation new , mit der Sie den Ablagedialog anzeigen können.

Der Request zur Rootresource /dms:

Request 

GET /dms
Accept: application/hal+json

Das JSON-Objekt der Rootressource enthält die Linkrelation new:

Response 

{
        _links: {
                new: {
                        href: "/dms/new/"
                }
        }
}

Angeben von verhaltenssteuernden Parametern 

Das Verhalten des Ablagedialogs steuern Sie mit den folgenden Parametern. Sie müssen die Parameter der URL encodieren (z.B. Leerzeichen in %20). Die Länge des encodierten Abfrageparameters darf 2000 Zeichen nicht überschreiten.

Parameter

Beschreibung

type 

Legt die Kategorie (Ablagetyp) im Ablagedialog fest. Der einzige mögliche Wert ist dossier. Mit type wird der Ablagedialog zum Erstellen von Akten geöffnet.

repositoryid 

Definiert die Repository-ID.

objectdefinitionid 

Legt fest, welche Kategorie in dem Ablagedialog ausgewählt sein soll. Geben Sie die ID einer Kategorie an. Wird keine Angabe gemacht, wird keine Kategorie ausgewählt.

Beispiel (nicht encodiert):

  • objectdefinitionid=RECH: Wählt die Kategorie Rechnung ("RECH") zum Speichern aus.

properties 

Ein JSON-Objekt, mit dem Sie folgende Eigenschaften setzen können:

  • Dokumentnummer: property_document_number 

  • Variantennummer: property_variant_number 

  • Dokumentstatus: property_state (Mögliche Werte sind Be für Bearbeitung, Pr für Prüfung, Fr für Freigabe und Ar für Archiv).

  • Bearbeiter: property_editor (d.3-Benutzerkennung)

  • Bemerkung1: property_remark1 

  • Bemerkung2: property_remark2 

  • Bemerkung3: property_remark3 

  • Bemerkung4: property_remark4 

  • Farbmarkierung: property_colorcode (Ist eine Ganzzahl zwischen 1 und 24, die der Nummer des gewünschten Farbcodes entspricht).

Sie können auch Werte für erweiterte Eigenschaften setzen. Die ID der Eigenschaft entspricht der Kennung (RID) der Eigenschaft. Die ID können Sie aus der URL in der Adresszeile Ihres Browsers entnehmen. Wenn Sie den Ablagedialog im Browser geöffnet und Werte eingegeben haben, wird Ihnen in der URL der Link zum Aufrufen des angezeigten Dialogs inklusive Ihrer eingegebenen Werte angezeigt.

Für erweiterte Eigenschaften setzen Sie einen Wert wie folgt:

  • properties={"227"=["KND001"]} 

Für Mehrfachwerte müssen Sie noch die Zeilennummer setzen:

  • properties={"232":{"1":"Name1@contoso.com", "2":"Name2@contoso.com"}} 

Aufrufen der URL für den Ablagedialog 

Sie haben eine URL für den Ablagedialog erzeugt. Wenn Sie die URL im Browser öffnen, wird der Ablagedialog mit den übergebenen Parametern geladen.

Anmerkung

Anwendungsbeispiele für verschiedene Aufrufe des Ablagedialogs:

  • Speichern in einer Kategorie: Ergänzen Sie die URL um den Teil objectdefinitionid=<ID der Katgorie>.

https://<Basisadresse>/dms/new/?repositoryid=<RepositoryID>&objectdefinitionid=RECH 

  • Speichern mit einer alphanumerischen Eigenschaft: Ergänzen Sie den properties-Parameter in der URL um properties={"227":"KND001"} (nicht encodiert), um das Eigenschaftsfeld mit der RID 227 (Kundennummer) und dem Wert "KND001" als Kundennummer vorzuschlagen. 

https://<Basisadresse>/dms/new/?repositoryid=<RepositoryID>&objectdefinitionid=RECH&properties=%7B%22227%22%3A%22KND001%22%7D

  • Speichern mit mehreren Eigenschaften: Ergänzen Sie den properties-Parameter in der URL um properties={"227":"KND001","231":"-100"} (nicht encodiert), um das Eigenschaftsfeld mit der RID 227 (Kundennummer) mit dem Wert "KND001" und das Eigenschaftsfeld mit der RID 231 (Rechnungsbetrag) mit dem Wert -100 vorzuschlagen.

https://<Basisadresse>/dms/new/?repositoryid=<RepositoryID>&objectdefinitionid=RECH&properties=%7B%22227%22%3A%22KND001%22%2C%22231%22%3A%22-100%22%7D

  • Speichern mit Mehrfachwerten: Ergänzen Sie den properties-Parameter in der URL um properties={"232":{"1":"Name1@contoso.com", "2":"Name2@contoso.com"}} (nicht encodiert), um das Eigenschaftsfeld mit der RID 232 (E-Mail) mit den Werten "Name1@contoso.com" und "Name2@contoso.com" vorzuschlagen.

https://<Basisadresse>/dms/new/?repositoryid=<RepositoryID>&objectdefinitionid=RECH&properties=%7B%22227%22%3A%22KND001%22%2C%22231%22%3A%22-100%22%2C%22232%22%3A%7B%221%22%3A%22Name1%40contoso.com%22%2C%20%222%22%3A%22Name2%40contoso.com%22%7D%7D