Diese Anleitung beschreibt die notwendigen Vorbereitungen zur Anbindung eines d.3 DMS per RESTful APIs. Das sowohl in der d.velop cloud als auch on-premises verfügbare Produkt d.3one stellt die hierfür benötigten RESTful APIs bereit. Weitergehende Informationen können den Dokumentationen zur IdentityProvider API und zur DMS API entnommen werden. Die IdentityProvider API ermöglicht die Anmeldung von Benutzern und die Ermittlung von Informationen zu Benutzern und Gruppen. Durch die DMS API sind die CRUD-Operationen für das Hochladen, Ändern, Suchen und Herunterladen von Dateien und Metadaten, sowie das Löschen von Dokumenten verfügbar.

Für einen schnellen Einstieg ist Beispielcode auf GitHub verfügbar,

Vor dem ersten Aufruf einer API-Funktion müssen aber folgende Schritte durchgeführt werden:

 1) Ermitteln der Verbindungsinformationen zum d.3 DMS.

Sofern noch kein d.3one Zielsystem zur Verfügung steht, kann dieses im d.velop store über das Produkt d.velop documents gebucht werden. Folgende Informationen werden benötigt:

baseURI: Basis-URL, über die d.3one erreichbar ist. Beispielsweise https://mytenant.d-velop.cloud
apiKey: API-Key zur Authentifizierung an d.3one. Ein Api-Key kann in d.3one über die Kachel "Identity Provider" und Klick auf das "Fingerabdruck-Symbol" erstellt werden. Die Kachel "Identity Provider" ist nur für Administratoren sichtbar.
repoId: Repository-Id des gewünschten Archivs. Über die Eingabe der URL baseURI + /repo/repositories/, also beispielsweise https://mytenant.d-velop.cloud/repo/repositories/, lassen sich die Ids aller verfügbaren Archive ermitteln.

 2) Erstellen einer Quelldefinition für die Zuordnungen (Mappings)

Für die Nutzung von Funktionen der DMS API ist die Konfiguration von Zuordnungen) erforderlich.
Die Informationen einer Quelle müssen als JSON-Objekte bereitgestellt werden, einmal für die Quelldefinition selbst (source.json), sowie für die Route zur Quelldefinition (sourceurl.json).

Beispiel für eine source.json und für eine sourceurl.json

 3) Bereitstellen der Quelldefinition als Webanwendung

Die JSON-Objekte müssen von einer Webanwendung per HTTP oder HTTPS mit dem "Content-Type" "application/json" ausgeliefert werden. Diese Webanwendung (yourWebAppName) muss für d.3one Zielsystem erreichbar sein.

Hinweis

  • Um Konflikte mit anderen Quelldefinitionen zu vermeiden, sollte in yourWebAppName als Prefix ein Unternehmensname verwendet werden. Beispielsweise myCompanyMyMapping.
  • Bindestriche oder Minuszeichen dürfen in yourWebAppName nicht verwendet werden!
  • Der Name der Webanwendung muss der erste Teil der URI nach der Basis-URL sein. Beispielsweise https://yourWebHostUri/yourWebAppName

Die für die Auslieferung der JSON-Objekte erforderliche Webanwendung kann individuell und mit der Technik eigener Wahl erstellt werden. Zwei einfache Möglichkeiten werden in den folgenden Anleitungen beschrieben. Alle Angaben erfolgen ohne Gewähr:

 4) Neue App im d.3one Zielsystem registrieren.

Die Registrierung der Webanwendung macht die Quelldefinition für d.3one bekannt.

  • Ist das d.3one Zielsystem d.velop documents in der Cloud, so wird die Webanwendung als neue App über das Cloudcenter registriert.
  • Wird das d.3one Zielsystem in einer lokalen Umgebung betrieben, so wird die Webanwendung über die Webkonsole von d.ecs http gateway admin (HTTP) registriert.

 5) Konfiguration des Mappings

Die Verbindung von Quelldefinition mit dem d.3one Zielsystem erfolgt über die Kachel "Zuordnungen". Diese Kachel ist für d.3one Administratoren sichtbar.

 6) Start coding ;-)

Code samples on GitHub: https://github.com/d-velop/dvelop-examples-cs