Mit einer URL-Integration können Elemente vom DocuWare Web Client in eine Drittanwendung eingebunden werden. Anwender müssen ihre gewohnte Arbeitsumgebung nicht verlassen, um auf archivierte Dokumente zuzugreifen oder in DocuWare-Archive abzulegen.
Das Prinzip dahinter ist einfach: Jedes DocuWare-Element hat eine Identifikationsnummer ID, auf die über den Platform Service als zentrale Schnittstelle zugegriffen werden kann. Die IDs werden zusammen mit weiteren Parametern an die Standard-URL zum DocuWare-System angehängt. Programmierer können diese URL in den Code einer Webseite oder einer Software einbinden.
Eine URL-Integration zeigt das Element immer in der DocuWare-Oberfläche. Eine Ergebnisliste beispielsweise wird im Aussehen des Web Client geöffnet. DocuWare bietet zudem die Möglichkeit, Dialoge, Briefkörbe und weitere Elemente so einzubinden, dass sie sich der Oberfläche der Drittanwendung anpassen. Dazu ist jedoch mehr Programmieraufwand nötig, mehr Informationen dazu finden Sie im Platform Service.
Überblick Integrationstypen
Folgende Elemente vom DocuWare Client können per URL-Integration aufgerufen werden:
Viewer (V): zeigt ein Dokument im Viewer an
Ergebnis- oder Aufgabenliste mit Viewer (RLV): zeigt Ergebnisliste oder Aufgabenliste mit Dokumenten an. Ein Klick auf ein Dokument öffnet es im Viewer.
Suchdialog: (SRLV): zeigt Suchdialog an; Suchkriterien lassen sich eingeben, ein Dokument aus der Ergebnisliste kann im Viewer geöffnet werden
Download (D): bietet ein in DocuWare archiviertes Dokument zum Download an
Dokumenthistorie (DH): zeigt ein Dokument mit seiner Historie an
Workflow-Aufgabenliste (WFTL): zeigt den Bereich vom Web Client mit Aufgabenliste vom Workflow Manger an
Workflow-Aufgabe (WFST): zeigt den Bereich vom Web Client mit Aufgabe vom Workflow Manger an
Anfrage senden (Workflow Manager) - (SWT): Link auf eine Anfrage für den der Anfrage zugeordneten Benutzer
Gesandte Anfragen (Workflow Manager) - (SWO): Link auf die Übersicht der Anfragen für den Sender
Indexdialog (IND): zeigt Indexdialog (Infodialog) zu einem Dokument an
Briefkorb (B): bietet Briefkorb mit voller Funktionalität an
Dokumentverknüpfung (DL): Mit einer Dokumentverknüpfung können verwandte Dokumente in einer Ergebnisliste oder im Viewer vom Web Client zur Verfügung gestellt werden
Anwendungsbeispiele
Wie die DocuWare URL-Integration im Geschäftsalltag die Arbeit vereinfacht, zeigen folgende Beispiele:
1. Downloadlink auf ein Datenblatt
Sie wollen Interessenten auf Ihrer Website den Download von Datenblättern anbieten, die in DocuWare archiviert sind?
Mit einer Download-Integration können Sie einen Link erstellen, der bei Aufruf direkt das Dokument herunterlädt. So verwalten Sie immer die aktuelle Dokumentversion in DocuWare, müssen den Link aber nur einmal erzeugen.
2. Suchdialog für Kundendokumente
Stellen Sie über einen Link beispielsweise auf Ihrer Website Ihren Kunden einen Suchdialog zur Verfügung, über den er alle ihn betreffende Dokumente einsehen kann, wie unter anderem Bestellungen, Rechnungen und Lieferscheine.
Damit darf jeder Kunde nur auf seine Dokumente zugreifen. Bestimmte Suchbegriffe kann der Kunde aber selbst vergeben. Zum Beispiel kann er den Rechnungszeitraum einschränken.
Jeder Kunde benötigt für den Zugriff auf in DocuWare gespeicherte Dokumente eine eigene Lizenz. Die DocuWare URL Integration ist nicht für Multiplexing vorgesehen.
3. Link auf Produktbeschreibungen
Sie benötigen regelmäßig Zugriff auf bestimmte Dokumente wie eine Reihe von Produktbeschreibungen? Dann erstellen Sie eine Integration mit einer festen Suchabfrage, die direkt eine Ergebnisliste anzeigt. Der Benutzer kann die Produktbeschreibungen einzeln aus der Liste im DocuWare Viewer öffnen.
4. Aufgabenliste zur Rechnungsfreigabe
Erleichtern Sie den Kollegen die Arbeit, die regelmäßig Rechnungen freigeben müssen: Stellen Sie zunächst diese Rechnungen über eine Aufgabenliste zur Verfügung und verknüpfen dann diese Aufgabeliste via URL-Integration auf den Desktop. Über diesen Link können die Mitarbeiter die Liste aufrufen und haben alle freizugebenden Rechnungen sofort im Blick.
5. Gültige Preisliste zur Verfügung stellen
Mit einer so genannten Viewer-Integration können Ihre Kunden oder Partner stets auf die aktuelle Preisliste zugreifen. Über den Link wird die Preisliste direkt im DocuWare Viewer angezeigt. Auch hier können Sie die Preisliste bequem in DocuWare verwalten, über den Link ist dann immer die neue Liste aufrufbar - und auf Wunsch nur im Read-Only-Modus.
6. Versionsverlauf dokumentieren
Sie wollen z.B. in Ihre Wiki-Projekt-Seite einen Link auf alle Versionen einer Projektdokumentation einbinden, diese wird aber in DocuWare verwaltet. Mit einer Document-History-Integration können Sie über den Link neben der aktuellen Version auch alle vorherigen Version anzeigen. Nutzung von Versionsmanagement ist hierfür natürlich eine Voraussetzung.
URL-Integration erstellen: Übersicht
Um eine URL-Integration zu erstellen, gibt es zwei Möglichkeiten:
1. DocuWare URL Creator: Mit dem Tool URL Creator stellen Sie die Basis-URL und die Parameter einfach in vier Schritten zusammen. Ein Assistent führt Schritt für Schritt durch die Konfiguration einer Integrations-URL.
URL-Integration mit URL Creator erstellen
2. URL-Integration manuell erstellen: Entwickler können die Parameter für DocuWare-Elemente, Login etc. zusammensetzen sowie die URL codieren und verschlüsseln.
URL-Integration manuell erstellen
Für das Erstellen von URL-Integrationen benötigen Sie einige Informationen aus der DocuWare-Administration und aus dem Platform Service, z.B. Servername, GUID einer Ergebnisliste etc (siehe unten). Haben Sie nicht das Recht, die nötigen Angaben einzusehen, wenden Sie sich bitte an Ihren DocuWare-Administrator.
IDs für DocuWare-Elemente finden
Um eine URL-Integration zu erstellen, werden Identifikationsnummern (IDs) für bestimmte DocuWare-Elemente sowie der Link zum Web Client benötigt. Hier finden Sie den Link bzw. die IDs.
Link zum Web Client
Sie finden den Pfad zum Web Client in der DocuWare-Administration auf Systemebene in den Webverbindungen:
GUID der Organisation
Mit der Version 7.1 von DocuWare enthalten alle von DocuWare generierten URLs die GUID der Organisation anstatt der ID. Die GUID wird im Bereich Allgemein der DocuWare Administration angezeigt.
Bestehende URL-Integrationen funktionieren auch nach dem Upgrade auf DocuWare Version 7.1.
Cloud-Kunden können eine Integrations-URL auch ohne OrgGUID anlegen, da das Unternehmen in der Basisadresse der URL verschlüsselt ist. Gleiches gilt für Anwender von DocuWare On-Premises, wenn das System nur eine Organisation hat. Nur wenn ein DocuWare-System mehr als ein Unternehmen hat, wird eine Kennung benötigt.
Archiv-ID
DocuWare Konfiguration > Dokumentspeicherung > Archive > Archiv x > Allgemein
Ergebnislisten-ID
DocuWare Konfiguration > Dokumentspeicherung > Archive > Archiv x > Dialoge > Ergebnis
Listen-ID (Task Manager)
DocuWare Konfiguration > Dokumentspeicherung > Archive > Archiv x > Dialoge > Listen
Briefkorb-ID
DocuWare Konfiguration > Persönlich > Briefkörbe
Suchdialog-ID
DocuWare Konfiguration > Dokumentspeicherung > Archive > Archiv x > Dialoge > Suche
Dokument-ID
Die Dokumenten-ID finden Sie, indem Sie im Web Client nach dem gewünschten Dokument suchen und in der Ergebnisliste zu dem Dokument das Kontextmenü öffnen. Wählen Sie Indexeinträge ändern und klicken Sie auf Systemeinträge - hier ist die Dokument ID angegeben.
Platform Service
Den DocuWare Plattform Service rufen Sie über die folgende URL auf: http://[ihr_servername]/DocuWare/Platform/Home/XSL. Wenn Sie Ihre Zugangsdaten eingeben müssen, klicken Sie auf Log in.
Dokumentverknüpfungs-ID
Um sich die ID zur Dokumentverknüpfung anzeigen zu lassen, benötigen Sie den Namen vom Archiv, das den Link enthält, sowie die ID vom Dokument, zu welchem der Link gehört.
Klicken Sie im Platform Service auf List Organizations, dann auf file cabinets und finden Sie das Archiv, das den Link enthält. Hier wäre dies Docu-Pool DE. Klicken Sie unter dem Archiv auf den Link neben documents.
Nun suchen Sie nach der ID des Dokuments, zu welchem der Link gehört. Im Abschnitt Flags klicken Sie auf den Link neben self.
Auf der folgenden Seite klicken Sie - wieder im Flags-Bereich - auf den Link neben documenLlinks. Hier können Sie die ID der Verknüpfung kopieren.
Rechte und Profile
Auf welche Elemente aus DocuWare ein Benutzer per URL-Integration zugreifen kann, wird unter DocuWare Konfiguration > Archive über Rechte und Profile gesteuert.
Der Benutzer, mit dem auf das DocuWare-Archiv zugegriffen wird, muss in jedem Fall den Dialog (Ergebnisliste, Liste oder Suchdialog), über den der Zugang erfolgt, über ein Archivprofil zugewiesen haben.
Um ein Dokument anzeigen zu können, benötigt der Benutzer ein Archivprofil, in dem mindestens die Allgemeinen Archivrechte Suchen und Dokumente anzeigen aktiviert sind.
Wird ein Suchdialog integriert, muss für jedes Feld, das dem Benutzer für die Suche angeboten werden soll, im Archivprofil mindestens das Feldrecht Suchen aktiviert sein.
Um in der Ergebnisliste im Spaltenkopf den Feldnamen und zu jedem Treffer den Eintrag je Feld (Spalte) sehen zu können, muss für das jeweilige Feld das Feldrecht Leserecht aktiviert sein. Ansonsten wird das Dokument zwar in der Ergebnisliste aufgeführt und kann geöffnet werden, ist jedoch mangels Einträgen nicht identifizierbar.
Um sich mit einer Integration DH (document history) die Versionen eines Dokuments anzeigen lassen zu können, muss für das Archiv, in welchem sich das Dokument befindet, unter das automatische Versionsmanagement aktiviert sein.