Aktualisieren von DMS-Objekten mit Benutzerinteraktion

Freigegeben: HTML-Seite

Sie können das Feature Ablage zum Aktualisieren der Eigenschaften und der Datei eines DMS-Objektes aufrufen. Grundvoraussetzung für das Durchführen der Aktion sind die Zuordnungen (Mappings). Im Kapitel Grundlegendes zu Zuordnungen (Mappings) finden Sie Basisinformationen, die Ihnen das Erstellen von Zuordnungen erleichtern.

Um ein DMS-Objekt zu aktualisieren, müssen Sie folgende Schritte durchführen:

  • Ermitteln der ID zum bestehenden DMS-Objekt

  • Bereitstellen der zu speichernden Datei (optional)

  • Ermitteln der Linkrelation für den Ablagedialog

  • Erstellen eines Ablagedialogs mit definierten Eigenschaften und Dateien

  • Anzeigen des Ablagedialogs mit definierten Eigenschaften und Dateien

  • Ausführen weiterer Aktionen nach dem Speichern (optional)

Ermitteln der ID zum bestehenden DMS-Objekt

Im Kapitel Suchen von DMS-Objekten wird beschrieben, wie Sie die ID zu einem bestehenden DMS-Objekt ermitteln können. Hat das bereits vorhandene DMS-Objekt den d.3-Dokumentstatus Processing muss der authentifizierte Benutzer der Bearbeiter des DMS-Objektes sein.

Bereitstellen der zu speichernden Datei (optional)

Im Kapitel Bereitstellen von Dateien können Sie nachlesen, wie Sie eine Datei bereitstellen können.

Ermitteln der Linkrelation für den Ablagedialog

Im Kapitel Ermitteln eines Repositorys können Sie nachlesen, wie Sie die URL zu einem Repository ermitteln. Danach führen Sie eine HTTP Get-Anforderung auf die URL zu einem Repository wie folgt aus:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27
Accept: application/hal+json

Das JSON-Objekt zu einem Repository enthält die Linkrelation new .

Response

{
        "_links": {
                "new": {
                        "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/new/"
                }
        },
        "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27"
}

Erstellen eines Ablagedialogs mit definierten Eigenschaften und Dateien

Führen Sie eine HTTP POST-Anforderung mit den benötigten Eigenschaften als Body auf die URL aus, die Sie in der Linkrelation new erhalten haben.

Request

POST /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/new
Origin: https://baseuri
Accept: application/hal+json
Content-Type: application/hal+json

{
    "storeObjects": [{
        "dmsObjectId": "D123456789",
        "displayValue": "Please verify the XYZ invoice",
        "filename": "myfile.txt",
        "contentLocationUri": "/dms/blob/chunk/2016-May-24-14-20-26-393-1720.part",
        "sourceId": "/myapp/sources/mysourcel",
        "sourcePropertiesUri": "/myapp/sources/mysourcel/properties/myfile.haljson",
        "successCallbackUri": "/myapp/sources/mysourcel/success/myfile"
    },
    {
        ...
    }]
}

Das JSON-Objekt, das beim POST übergeben wird, ist wie folgt beschrieben:

Eigenschaft

Beschreibung

storeObjects

Gibt das Array der Elementeigenschaften und Dateien an, mit denen der Ablagedialog definiert werden soll. Informationen zu einem Element des Arrays finden Sie unter Definieren der Parameter zum Speichern.

Wenn Sie nur ein einzelnes DMS-Objekt aktualisieren möchten, dann können Sie das JSON-Objekt der Elementeigenschaften ohne das übergeordnete Array storeObjects angeben.

Ist der Aufruf erfolgreich, wird die URL zum Ablagedialog im Header Location zurückgegeben:

Response

HTTP/1.1 201 Created
Location: /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/new/a09dd457-5a21-4b90-8134-e562092b50ea

Schlägt das Erstellen des Ablagedialogs fehl, wird eine entsprechende Antwort (Response) zurückgegeben. Weitere Informationen finden Sie unter Format der Antwort bei Fehlern.

Anzeigen des Ablagedialogs mit definierten Eigenschaften und Dateien

Rufen Sie die URL zum Ablagedialog, die Sie im Header Location erhalten haben, im Browser auf, um dem Anwender den Ablagedialog anzuzeigen. Der Anwender kann die Eigenschaften bearbeiten und das Aktualisieren der DMS-Objekte abschließen.

Ausführen weiterer Aktionen nach dem Speichern (optional)

Wenn Sie beim Erstellen des Ablagedialogs den Parameter successCallbackUri angeben und der Anwender das Speichern erfolgreich abgeschlossen hat, wird die URL aufgerufen. Sie können nach dieser Aktion weitere Schritte ausführen. Weitere Informationen finden Sie unter Feedback mithilfe von "SuccessCallback" und "Userdata".