Konfigurieren eines Endpunkts für einen Webhook zum Ändern von Werten für ECM-Zieleigenschaften während der Archivierung

Sie können in edoc archive service einen Webhook verwenden, um eigene Logik in die Verarbeitung von Archivierungsvorgängen einzubringen und edoc archive service zu erweitern.

Um einen Webhook zu verwenden, müssen Sie den Webhook zuerst unter einem Endpunkt bereitstellen. Der Endpunkt muss für edoc archive service erreichbar sein.

Weitere Informationen zum Definieren eines Webhooks finden Sie hier: Welche Daten werden an meinen Webhook zum Ändern von Werten für ECM-Zieleigenschaften vor dem Archivieren übermittelt und als Antwort erwartet?

Folgende Daten Ihres Webhooks benötigen Sie zum Herstellen einer Verbindung:

• Endpunkt, unter dem der Webhook erreichbar ist.

• Optional: API-Schlüssel für die Authentifizierung (Sicherheit).

Nachdem Sie einen Endpunkt für den Webhook zum Ändern von Werten konfiguriert und bereitgestellt haben, können Sie diesen Endpunkt in edoc archive service verwenden.

So geht’s

1. Gehen Sie zur edoc platform-Systemumgebung und öffnen Sie die Administration von edoc archive service im Browser.

2. Navigieren Sie zu Endpunkte für Webhooks konfigurieren > Neuen Endpunkt für Webhook erstellen.

3. Geben Sie unter Namen für den Endpunkt eingeben einen aussagekräftigen Namen für den Endpunkt ein. Der Name wird Ihnen in verschiedenen Konfigurationsoptionen für die Webhooks angezeigt.

4. Geben Sie unter Beschreibung für den Endpunkt eingeben eine aussagekräftige Beschreibung ein, in der Sie die Funktion des Webhooks näher erläutern.

5. Wählen Sie unter Verwendungszweck für den Endpunkt auswählen den Verwendungszweck Werte für ECM-Zieleigenschaften vor dem Archivierungsprozess ändern aus. Durch diese Angabe bestimmen Sie, wann der Webhook verwendet wird, welche Informationen an den Webhook gesendet werden und welche Informationen vom Webhook erwartet werden.

6. Geben Sie unter URL des Endpunkts angeben die URL des Endpunkts im Format einer URL (z.B. https://meineURL.com) an, an die die Abfragen für den Webhook gesendet werden sollen.

7. Geben Sie unter Geheimen API-Schlüssel angeben den geheimen API-Schlüssel für die Authentifizierung am Endpunkt an. Wenn es keinen Authentifizierungsmechanismus für den Endpunkt gibt, tragen Sie nichts ein.

8. Geben Sie unter Timeout für den Verbindungsaufbau angeben die Anzahl der Sekunden ein, die ein Verbindungsaufbau maximal dauern darf, bis ein Timeout auftritt.

9. Klicken Sie auf Speichern.

Sie haben den Endpunkt erfolgreich konfiguriert.

Tipp

Testen Sie die angegeben Verbindungsdaten mit Verbindung testen.