Vorbereiten von d.velop documents (Benutzer, API-Schlüssel und Berechtigungen)

Für die Konfiguration von edoc SHCware d.velop documents müssen Sie Vorbereitungen in d.velop documents treffen.

Sie benötigen einen Schnittstellenbenutzer in d.velop documents für die Authentifizierung, einen API-Schlüssel für den Schnittstellenbenutzer und eine eigene Gruppe für den Schnittstellenbenutzer. Die Gruppe wird aus technischen Gründen im d.velop documents-Repository benötigt.

In der d.3-Administration (d.3 admin) erstellen Sie außerdem ein eigenes Berechtigungsprofil für edoc SHCware d.velop documents connect und definieren die Berechtigungen für die Dokumentklassen in d.velop documents.

Sie müssen für die Konfiguration in d.velop documents über die entsprechenden administrativen Berechtigungen verfügen. Weitere Informationen zu den Berechtigungen finden Sie in den d.velop documents-Handbüchern.

Erstellen eines Schnittstellenbenutzers und der Gruppe

Das Erstellen des Schnittstellenbenutzers und der Gruppe für edoc SHCware d.velop documents connect nehmen Sie in der User Management App von d.velop documents vor.

So geht’s

1. Öffnen Sie das Dashboard von d.velop documents im Browser.

2. Gehen Sie zu Konfiguration > Verwaltung > Benutzer- und Gruppenverwaltung > Benutzer und Gruppen, um einen neuen Benutzer und eine neue Gruppe hinzuzufügen.

   1. Geben Sie für den neuen Benutzer folgende Daten ein und speichern Sie abschließend Ihre Änderungen:

      1. Vorname: d3_shc

      2. Nachname: API-User

      3. Email: d3_shc@<Kundendomäne.de>

   2. Geben Sie für die neue Gruppe folgende Daten ein:

      1. Name: d3_shc

      2. Beschreibung: Group for API-Users of edoc SHCware d.velop documents connect

3. Fügen Sie den Schnittstellenbenutzer zur Gruppe d3_shc hinzu.

Erstellen des API-Schlüssels für den Schnittstellenbenutzer

Damit die Authentifizierung des Schnittstellenbenutzers reibungslos funktioniert, müssen Sie den API-Schlüssel generieren.

1. Öffnen Sie das Dashboard von d.velop documents im Browser.

2. Gehen Sie zu Konfiguration > Infrastruktur und Sicherheit > Anmeldung > Anmeldeoptionen.

3. Öffnen Sie die Kontextaktion Manage API keys.

4. Klicken Sie auf die Kontextaktion Create API key.

5. Wählen Sie unter User den Schnittstellenbenutzer aus.

6. Geben Sie unter Label den Namen edoc SHCware d.velop documents connect ein.

7. Klicken Sie auf Create, um den API-Schlüssel zu generieren.

In der Übersicht API keys finden Sie den Schnittstellenbenutzer. Den API-Schlüssel benötigen Sie, wenn Sie die SQLite-Datenbank konfigurieren.

Aktivieren des Authentifizierungssystems in d.velop documents

Damit Sie die korrekte Authentifizierung verwenden, müssen Sie in d.3 admin die Authentifizierung in d.ecs identity provider festlegen.

So geht’s

1. Öffnen d.3 admin im Bearbeitungsmodus.

2. Öffnen Sie im Menü Systemeinstellungen > d.3 config.

3. Aktivieren unter d.ecs infrastructure den Eintrag Authentifizierungsystem.

4. Ändern Sie den Parameterwert auf IDP.

5. Speichern Sie die Änderung.

Erstellen des Berechtigungsprofils für den Schnittstellenbenutzer

Damit der Schnittstellenbenutzer alle erforderlichen Aktionen ausführen kann, müssen Sie in d.3 admin für den Benutzer ein Berechtigungsprofil erstellen und die entsprechenden Berechtigungen erteilen.

So geht’s

1. Öffnen Sie im Menü Berechtigungen > Berechtigungsprofile.

2. Klicken Sie auf Neu und geben Sie den Namen der Schnittstelle ein: edoc SHCware d.velop documents connect.

3. Klicken Sie auf Weiter, um die Dokumentklassen von Dokumentarten auszuwählen, die in der Ergebnisliste von edoc SHCware d.velop documents connect angezeigt werden sollen.

4. Klicken Sie auf Weiter, um zu allen ausgewählten Dokumentklassen für erforderlichen Rechte zu erteilen. Empfehlung:

   1. Ändern Attribute Bearbeitung / Prüfung

   2. Ändern Attribute Freigabe

   3. Ändern versteckter Attribute

   4. Dokument aktualisieren

   5. Dokument importieren

   6. Export abhängiges Dokument

   7. Export Original

   8. Lesen Archiv

   9. Lesen Attribute

   10. Lesen Bearbeitung

   11. Lesen Freigabe

   12. Lesen Prüfung

   13. Lesen Gesperrt

   14. Lesen versteckter Attribute

   15. Statustransfer Bearbeitung

   16. Statustransfer Freigabe

   17. Statustransfer Prüfen

   18. Statustransfer Prüfung

5. Klicken Sie auf Fertigstellen.

Verknüpfen des Berechtigungsprofils in der IDP-Unterstützung

Verknüpfen Sie in der IPD-Unterstützung in d.3 admin die erstellte Gruppe mit dem erstellten Berechtigungsprofil.

So geht’s

1. Öffnen Sie im Menü Berechtigungen > IDP-Unterstützung.

2. Suchen Sie unter IDP-Gruppen die Gruppe d3_shc und markieren Sie die Gruppe.

3. Wählen Sie unter Objekttyp den Eintrag Berechtigungsprofile aus.

4. Wählen Sie unter d.3 Objekte das Berechtigungsprofil edoc SHCware d.velop documents connect aus.

5. Klicken Sie auf Hinzufügen.

6. Speichern Sie Ihre Änderungen.

Siehe auch

• Konfigurieren der SQLite-Datenbank