Mit der DocuWare URL-Integration lassen sich Elemente von DocuWare in eine Drittanwendung einbinden. Die Mitarbeiter können direkt aus ihrer Hauptanwendung heraus in Archiven ablegen oder suchen, ohne zuerst DocuWare zu öffnen.
Derzeit nur klassischer DocuWare Client
Die URL-Integration steht im neuen DocuWare Client, der mit DocuWare 7.15 eingeführt wurde, noch nicht zur Verfügung.
Das Prinzip hinter der URL-Integration ist einfach: Jedes Element von DocuWare hat eine Identifikationsnummer, die ID. Auf die ID kann über den Platform Service zugegriffen werden, die zentrale Anwendungsschnittstelle von DocuWare. Die IDs und einige weitere Parameter werden an die Standard-URL zum DocuWare-System angehängt. Entwickler haben die Möglichkeit, diese URL in den Code einer Website oder einer Drittanwendung einzubinden. Ein mit einer URL-Integration eingebundenes DocuWare-Element ist immer in die DocuWare-Benutzeroberfläche eingebettet. Eine Ergebnisliste wird so angezeigt, wie sie im Web Client geöffnet wird.
Darüber hinaus lassen sich Dialoge, Briefkörbe und weitere Elemente von DocuWare in die Benutzeroberfläche einer Drittanwendung einbinden. Dafür ist mehr Programmieraufwand nötig als für eine URL-Integration. Mehr Informationen dazu finden Sie im Platform Service.
Überblick: Integrationstypen
Auf die folgenden Elemente des DocuWare Client können Sie per URL-Integration zugreifen:
Viewer (V): zeigt ein Dokument im Viewer an
Ergebnis- oder Aufgabenliste mit Viewer (RLV): zeigt eine Ergebnisliste oder eine Liste mit Dokumenten an. Ein Dokument lässt sich im Viewer öffnen.
Suchdialog: (SRLV): zeigt einen Suchdialog an; der Benutzer kann Suchkriterien eingeben oder ein Dokument aus der Ergebnisliste im Viewer öffnen.
Download (D): der Benutzer kann ein in DocuWare archiviertes Dokument herunterladen
Dokumenthistorie (DH): zeigt ein Dokument mit seiner Historie an
Workflow-Aufgabenliste (WFTL): zeigt den Bereich des Web Client mit der Aufgabenliste des Workflow Manager an
Workflow-Aufgabe (WFST): zeigt den Bereich des Web Client mit der Aufgabe des Workflow Manager an
Anfrage senden (SWT): zeigt einen Link auf eine Workflow-Anfrage an, die einem Benutzer (Empfänger) zugewiesen ist
Gesendete Anfragen (SWO): zeigt einen Link auf alle Workflow-Anfragen eines Benutzers (Absender) an
Indexdialog (IND): ruft den Indexdialog zu einem Dokument auf
document tray (B): bietet den Briefkorb mit allen seinen Funktionen an.
Dokumentverknüpfung (DL): Dokumentverknüpfungen stellen verwandte Dokumente in einer Ergebnisliste oder im Viewer des Web Client zur Verfügung
Anwendungsbeispiele
Die folgenden Beispiele zeigen, wie die DocuWare URL-Integration die tägliche Arbeit im Büro vereinfacht:
1. Link zum Download einer Produktbeschreibung
Sie möchten auf Ihrer Website Produktbeschreibungen anbieten, die in DocuWare archiviert sind? Mit einer Download-Integration erstellen Sie einen Link, der auf ein Dokument in einem Archiv zeigt. Ein Klick auf den Link lädt das Dokument direkt herunter. Ganz gleich, wie oft Sie das Dokument im Archiv bearbeiten: Sie müssen das Dokument nur einmal erstellen.
2. Suchdialog für Kunden
Sie können Kunden über einen Link, den Sie beispielsweise auf Ihrer Website platzieren, Zugriff auf einen Suchdialog geben. Kunden können über diesen Suchdialog alle Dokumente einsehen, die sie betreffen, etwa Bestellungen, Rechnungen und Lieferscheine. Kunden greifen nur auf ihre eigenen Dokumente zu, können aber bestimmte Suchbegriffe eingeben, um die Suchergebnisse zum Beispiel auf einen Zeitraum einzuschränken.
Jeder Kunde benötigt für den Zugriff auf ein in DocuWare gespeichertes Dokument eine eigene Lizenz. Die DocuWare URL-Integration ist nicht für Multiplexing vorgesehen.
3. Link auf eine Produktbeschreibung
Ihre Kunden müssen regelmäßig auf Dokumente wie Produktbeschreibungen zugreifen? Dann erstellen Sie eine Integration mit einer festen Suchabfrage. Die Ergebnisliste wird direkt angezeigt. Die Benutzer können die Dokumente auswählen, die sie interessieren.
4. Komfortable Rechnungsfreigabe
Einige Mitarbeiter in Ihrem Unternehmen müssen regelmäßig Rechnungen freigeben. Mit der URL-Integration geht das ganz einfach. Angenommen, die Mitarbeiter erhalten die freizugebenden Rechnungen in einer Liste des Task Manager. Sie können auf ihrem Desktop eine Verknüpfung mit der URL anlegen und damit die Liste des Task Manager aufrufen. So sehen sie mit einem Doppelklick alle freizugebenden Rechnungen. Die Liste lässt sich auch in eine Buchhaltungssoftware einbinden. Die Mitarbeiter gelangen dann noch einfacher an ihre Aufgaben. Wenn Ihr Unternehmen den Workflow Manager einsetzt, können Sie die Workflow-Aufgabenlisten auf dieselbe Weise in eine Buchhaltungssoftware einbinden.
5. Eine aktuelle Preisliste bereitstellen
Mit einer Viewer-Integration geben Sie Kunden oder Geschäftspartnern einen Lesezugriff auf die aktuelle Preisliste. Über den Link wird die Preisliste direkt im DocuWare Viewer angezeigt. So müssen Sie die jeweils aktuelle Preisliste nicht immer wieder an Kunden und Partner versenden.
6. Versionsverlauf eines Dokuments
Sie möchten beispielsweise in Ihr Wiki-Projekt einen Link auf alle Versionen einer Produktdokumentation einbinden. Wenn diese Dokumentation in DocuWare archiviert ist, kann eine Integration "Dokumenthistorie" neben der aktuellen Version auch alle früheren Versionen der Dokumentation anzeigen. Voraussetzung für diese Art der Integration ist natürlich ein Archiv mit aktiviertem Versionsmanagement.
Eine URL-Integration erstellen: Überblick
Die Integration in andere Anwendungen erfolgt über die Definition einer bestimmten URL. Dazu hängen Sie die nötigen Parameter an die HTTP-Adresse Ihres DocuWare Web Client an.
Es gibt zwei Möglichkeiten, eine solche URL zu erstellen:
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 Sie Schritt für Schritt durch die Konfiguration einer Integrations-URL.
URL-Integrationen manuell erstellen: DocuWare Administratoren oder Entwickler können die Parameter für die Elemente von DocuWare manuell zusammensetzen.
Beide Methoden sind in diesem Handbuch beschrieben:
Für das Erstellen einer URL-Integration benötigen Sie einige Informationen aus dem DocuWare Server Manager, etwa den Servernamen - siehe unten.
Auf einen Blick: IDs der DocuWare Elemente
Für eine URL-Integration benötigen Sie die Identifikationsnummern der einzubindenden Elemente sowie die URL des Web Client. Hier finden Sie sie:
URL des Web Client: DocuWare Server Manager > Systemverbindungen > Webverbindung > HTTP-Root-Verzeichnis > Web Client
GUID der Organisation: DocuWare Server Manager > Organisation
Archiv-ID: DocuWare Konfigurationen > Dokumentspeicherung > Archive > Archiv x > Allgemein
Listen-ID (Task Manager): DocuWare Konfigurationen > Dokumentspeicherung > Archive > Archiv x > Dialoge > Liste
Ergebnislisten-ID: DocuWare Konfigurationen > Dokumentspeicherung > Archive > Archiv x > Dialoge > Ergebnis
Suchdialog-ID: DocuWare Konfigurationen > Dokumentspeicherung > Archive > Archiv x > Dialoge > Suche
Briefkorb-ID: DocuWare Konfigurationen > Persönlich > Briefkorb
Dokument-ID: Suchen Sie im Web Client nach einem Dokument. Wenn das Dokument in der Ergebnisliste angezeigt wird, öffnen Sie das Kontextmenü des Dokuments. Indexeinträge bearbeiten öffnet den Infodialog zum Dokument. Klicken Sie auf Systemeinträge. In den Systemeinträgen finden Sie die Dokument-ID.
Platform Service: Den DocuWare Platform Service rufen Sie über diese URL auf: http://[servername]/DocuWare/Platform/Home/XSL. Klicken Sie bei Bedarf auf Anmelden, um Ihre Zugangsdaten einzugeben.
Dokumentverknüpfungs-ID:
Ermitteln Sie zuerst den Namen des Archivs, das die Dokumentverknüpfung enthält, und die ID des verknüpften Dokuments. Beides benötigen Sie, um die ID der Dokumentverknüpfung zu finden.
Wechseln Sie in den Platform Service und klicken Sie auf List Organizations und dann auf file cabinets.
Suchen Sie den Namen des Archivs, das die Verknüpfung enthält. Klicken Sie unter dem Archiv auf den Link neben documents.
Suchen Sie nun die ID des Dokuments, das zur Verknüpfung gehört.
Wenn Sie sie gefunden haben, scrollen Sie zum Abschnitt Flags und klicken Sie auf den Link neben self.
Scrollen Sie auf der folgenden Seite wieder zum Abschnitt Flags und klicken Sie auf den Link neben documentLinks. Kopieren Sie die ID der Verknüpfung.
Rechte und Profile festlegen
Mit einer Integrations-URL kann der Benutzer auf alle Suchdialoge, Archive und so weiter zugreifen, die ihm zugewiesen sind. Die Zugriffsrechte werden unter DocuWare Konfigurationen > Archive festgelegt.
Dem Benutzer, mit dem auf das DocuWare Archiv zugegriffen wird, muss der beim Zugriff verwendete Dialog (Ergebnisliste, Liste oder Suchdialog) über ein Archivprofil zugewiesen sein.
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.
Wenn Sie einen Suchdialog einbinden, müssen Sie für jedes Feld, das dem Benutzer für die Suche zur Verfügung stehen soll, mindestens das Feldrecht Suchen aktivieren.
Damit in der Ergebnisliste der Feldname im Spaltenkopf und zu jedem Treffer der Eintrag je Feld (Spalte) zu sehen ist, muss für dieses Feld das Feldrecht Leserecht aktiviert sein. Andernfalls wird das Dokument zwar in der Ergebnisliste aufgeführt und lässt sich öffnen, ist aber mangels Einträgen nicht identifizierbar.
Damit sich die Versionen eines Dokuments mit einer DH-Integration (Dokumenthistorie) anzeigen lassen, muss für das Archiv, in dem sich das Dokument befindet, das Versionsmanagement oder das automatische Versionsmanagement aktiviert sein.