Mehrere Beispiele zeigen, wie Parameter bei der DocuWare-URL-Integration verwendet werden können, um den Zugriff auf Dokumente und Funktionen anzupassen. Diese Beispielkonfigurationen verdeutlichen, wie verschiedene Parameter das Verhalten der integrierten URLs beeinflussen.
Alle Beispiele, die hier aufgeführt sind, können Sie in Ihrer DocuWare Installation ausprobieren. Voraussetzung ist, dass Sie ein Beispielarchiv installiert haben und der Platform Service in die Standardseite des IIS publiziert ist. Sie müssen den realen Servernamen eintragen. Alle weiteren Parameter müssen den Werten Ihrer Installation entsprechen.
Alle URLs der folgenden Beispieladressen beginnen mit
http://<ihr_servername>/<DocuWare>/<Platform>/WebClient/Integration
Voraussetzung für die Beispiel-URLs in diesem Kapitel ist, dass der Benutzer die Rechte auf die Archive und Ergebnis- oder Aufgabenliste hat, siehe dazu auch das Kapitel "Voreinstellungen".
Login-Parameter
Eine Ergebnisliste &p=RLV&rl=<result list id> soll per Integrations-URL aufgerufen werden, und zwar
mit manueller Eingabe
http://<ihr_servername>/<DocuWare>/<Platform>/WebClient/Integration?p=RLV&rl=<result list id>
Der Benutzer muss seine DocuWare-Kennung eingeben, bevor die Ergebnisliste angezeigt wird.
mit Single Sign-on
Der Parameter für das Windows-Login ist "SSO". Er wird in die Basis-URL vor die Identifizierungsnummer eingefügt.
http://<ihr_servername>/<DocuWare>/<Platform>/WebClient/SSO/Integration?p=RLV& rl=<result list id>
Der Benutzer wird automatisch angemeldet. Er muss weder seine Windows- noch seine DocuWare-Kennung eingeben.
mit Benutzernamen und Passwort in URL
Mit einem automatischen Login kann beispielsweise der Kunde aus einer internen Anwendung ein Element aus DocuWare aufrufen, ohne seine Logindaten eingeben zu müssen. Der Parameter "lc" integriert die Kennung in die URL, dazu müssen die Logindaten vorher Base64-kodiert werden.
Logindaten: User=administrator\nPwd=admin.
Logindaten Base64URL-kodiert: VXNlcj1hZG1pbmlzdHJhdG9yXG5Qd2Q9YWRtaW4=
Dieser String wird mit dem Parameter "lc" in die URL integriert:
http://<ihr_servername>/<DocuWare>/<Platform>/WebClient/Integration&p=RLV&rl=<result list id>&lc=VXNlcj1hZG1pbmlzdHJhdG9yXG5Qd2Q9YWRtaW4=
Zudem muss die URL den Benutzernamen und das Passwort in verschlüsselter Form enthalten. Die URL für ein automatisches Login ist folgendermaßen aufgebaut:
http://<ihr_servername>/<DocuWare>/<Platform>/WebClient/Integration?ep=<verschlüsselte Parameter für Loginkennung>
Sie können eine URL über den URL-Creator verschlüsseln lassen, siehe Kapitel DocuWare-URL-Creator. Verschlüsseln Sie die verschlüsselbaren Parameter selbst, weil die URLs on the fly erzeugt werden müssen, finden Sie im Kapitel Verschlüsselung mehr Informationen.
Unverschlüsselte URLs mit den Login-Parametern lc oder lct können ab DocuWare Version 7.1 nicht mehr verwendet werden.
Um bestehende Integrations-URLs zu aktualisieren, gehen Sie wie folgt vor:
Wählen Sie im URL Creator im ersten Schritt "Parse URL"
Kopieren Sie die bisherige URL in das Textfeld und klicken Sie auf "Next"
Aktivieren Sie "Use passphrase" und geben Sie die Passphrase ein.
Sie finden die Passphrase in der DocuWare Administration im Organisationsbereich unter "Allgemein"Klicken Sie auf "Next" bis zur Summary-Seite und kopieren Sie die neue URL mit dem sicher verschlüsselten Login.
Wenn eine Anwendung Ihre URL generiert, müssen Sie diese mit der Passphrase aus der DocuWare Administration anpassen.
Mehr Informationen zur Verschlüsselung
Viewer, Listen, Dialoge und Download
Viewer ohne Ergebnisliste
Ein spezifisches Dokument wird geöffnet, DocID ist in diesem Beispiel „8":
&p=V&rl=a60d2279-227d-454b-815c-14d64eb165a1&did=8
Wenn Sie hier keine DocID angeben, wird automatisch der erste Treffer der Ergebnisliste angezeigt. Oder Sie können eine Abfrage in der URL definieren.
&p=V&rl=69e807b6-70e8-48c2-8857-2864dfebc4ac
Viewer mit Ergebnisliste
&p=RLV&rl=69e807b6-70e8-48c2-8857-2864dfebc4ac
Bei der Ergebnisliste, die über die GUID in dieser URL definiert ist, muss es sich um eine Aufgaben- oder Ergebnisliste handeln.
Es ist auch möglich, den RLV-Parameter mit einem Suchdialog zu kombinieren. Das Ergebnis unterscheidet sich nicht von der Integration einer Ergebnisliste mit der rl-GUID.
?p=RLV&fc=<c1699bcf-6ae6-4f1c-b881-17792edbdd92>&sed=<b0342b12-0050-45f8-9060-db44f47d7b8f>
Die Archiv-ID ist nicht zwingend erforderlich. Ohne Archiv-ID wird jedoch in allen Archiven nach dem Suchdialog gesucht, was die Ladzeit verlängern kann.
Suchdialog mit Viewer und Ergebnisliste
&p=SRLV&sed=0c825e8b-e21f-48e8-b31f-590bf60a6c59
In diesem Beispiel muss der Parameter für eine Ergebnisliste nicht eigens angegeben werden, da einem Suchdialog standardmäßig eine Ergebnisliste zugeordnet ist.
Indexdialog
Ein Indexdialog (Info-Dialog) lässt sich mit dem folgenden URL-Schema aufrufen:
? p=IND&rl=<Resultlist_ID>&fc=<FileCabinet_ID>&did=<doc_ID>
IND = Parameter für Indexdialog
rl = Parameter für die ID einer Ergebnisliste
fc = Archiv-ID
did = ID vom Dokument, für das der Indexdialog angezeigt werden soll.
Alle Parameter müssen verschlüsselt werden.
Briefkorb
Eine Briefkorb-Intgeration stellt alle Funktionen des Briefkorbs wie im Web Client zur Verfügung.
Ein Briefkorb kann mit dem folgenden URL-Schema eingebettet werden:
? p=B&bid=<Basket_ID>
B = Parameter für Briefkorb
bid = ID vom Briefkorb
Alle Parameter müssen verschlüsselt werden.
Dokumentverknüpfung
Mit diesem URL-Schema können Sie eine Dokumentverknüpfung einbetten:
?p=DL&fc=<FileCabinet_ID>&did=<doc_ID>&docLink=<doc_ID>
DL = Parameter für Dokumentverknüpfung (document link)
fc = Archiv-ID, es muss hier das Quellarchiv angegeben werden, also das Archiv, in welchem der Link enthalten ist.
did = ID des Dokuments zu dem der Link gehört
docLink = ID der Dokumentverknüpfung
Download
&p=D&rl=a60d2279-227d-454b-815c-14d64eb165a1&did=8
Bei dieser URL öffnet sich das Dokument im Plugin-Programm, da nicht explizit als Download-Typ "Download" vorgegeben ist. Möchten Sie ein Dokument zum Herunterladen anbieten, lautet die URL:
&p=D&rl=a60d2279-227d-454b-815c-14d64eb165a1&did=8&dt=Download
Sie können auch für eine Download-Integration eine Aufgabenliste oder eine Abfrage definieren. Sollten mehrere Treffer gefunden werden, wird immer der erste Treffer im Plugin-Programm angezeigt oder zum Herunterladen angeboten.
Für alle Beispiele in diesem Kapitel können Sie die Kennung als Parameter definieren; alternativ zur Aufgabenliste können Sie auch die Abfrage als Parameter definieren.
Abfragen
Bei allen folgenden Beispielen erfolgt der Zugang über Benutzer-Kennung in der URL; Benutzername ist guest und Passwort ist ebenfalls guest. Der Einfachheit halber sind hier nur die Parameter aufgelistet. Die Basis-URL ist die gleiche wie bei den Beispielen zuvor.
Wenn Sie eine Abfrage in der URL definieren, und die Ergebnisliste eine Aufgabenliste ist, kann der Parameter „q" die Abfrage der Aufgabenliste weiter verfeinern.
mit einfachem Suchausdruck
[COMPANY]="Peters Engineering"
&p=RLV&lc=VXNlcj1ndWVzdFxuUHdkPWd1ZXN0&rl=a60d2279-227d-454b-815c-14d64eb165a1&q=W0NPTVBBTlldPZRQZXRlcnMgRW5naW5lZXJpbmeU
[CONTACT] LIKE "Lau*"
&p=RLV&lc=VXNlcj1ndWVzdFxuUHdkPWd1ZXN0&rl=a60d2279-227d-454b-815c-14d64eb165a1&q=W0NPTlRBQ1RdIExJS0Ugk0xhdSqT
für Dokumente innerhalb eines Zeitraums
[DATE]<=CURRENTDATE(-5) AND [DATE]>=CURRENTDATE(-8)
mit komplexen Suchausdrücken
[COMPANY]="US-Steel" AND [DEPARTMENT]="Production"
&p=RLV&lc=VXNlcj1ndWVzdFxuUHdkPWd1ZXN0&rl=a60d2279-227d-454b-815c-14d64eb165a1&q=W0NPTVBBTlldPZNVUy1TdGVlbJMgQU5EIFtERVBBUlRNRU5UXT2TUHJvZHVjdGlvbpM=
[COMPANY]="Phone Wizard" AND [DEPARTMENT]="Accounting" AND [STATUS]="to be approved"
&p=RLV&lc=VXNlcj1ndWVzdFxuUHdkPWd1ZXN0&rl=a60d2279-227d-454b-815c-14d64eb165a1&q=W0NPTVBBTlldPZNQaG9uZSBXaXphcmSTIEFORCBbREVQQVJUTUVOVF09k0FjY291bnRpbmeTIEFORCBbU1RBVFVTXT2UdG8gYmUgYXBwcm92ZWSU
(([CONTACT]="Werner Moser" OR [CONTACT] LIKE "*Moser*") AND [COMPANY] LIKE "*Moser*") OR [DocuWareFulltext] LIKE "*Moser*"
mit numerischen Feldern
Verwenden Sie in einem numerischen Feld bei Dezimalstellen immer einen Punkt - unabhängig von der Spracheinstellung. Dadurch kann die Suchabfrage unabhängig von Sprach.- und Ländereinstellungen ausgeführt werden.
mit Wildcard
[Index Field DB Name] LIKE "*[Search Value]*"
Der Stern kann vor dem Suchwert stehen, danach oder an beiden Stellen.
Verschlüsselung
Setzen Sie einzelne, fest vorgegebene URLs ein, so können Sie diese mit dem DocuWare-URL-Creator verschlüsseln und entschlüsseln lassen (siehe Kapitel DocuWare-URL-Creator). Verschlüsseln Sie die verschlüsselbaren Parameter selbst, weil die URLs on the fly erzeugt werden müssen, können Sie dazu folgende Algorithmen verwenden:
Algorithmen zur Verschlüsselung
Bitte beachten Sie, dass zur Verschlüsselung einige Parameter base64URL-kodiert sein müssen. Hinweise dazu finden Sie im Kapitel URL-Parameter.
Verschlüsselung der URL
Es wird ein symmetrischer Verschlüsselungs-Algorithmus benutzt.
Zur Verschlüsselung wird der Advanced Encryption Standard (AES) entsprechend der Spezifikation FIPS-197 mit folgenden Parametern verwendet:
Block Size = 128 Bits
Cipher size = CBC (Cipher Block Chaining)
Initialization vector (IV) = 128 bits
Key length = 256 bits
Kein salt
Schlüssel
Zur Ver- und Entschlüsselung wird ein AES-Schlüssel mit 256 Bits und ein Initialisierungs-Vektor (IV) mit 128 Bits verwendet. Der Schlüssel und der Initialisierungs-Vektor müssen auch der externen Anwendung bekannt sein. Dazu werden Passphrasen verwendet. Aus dieser Passphrase errechnet DocuWare den Schlüssel und den Initialisierungs-Vektor. Die Passphrase wird verschlüsselt und als Eigenschaft in den Einstellungen der Organisation abgelegt. Der Administrator muss in der externen Anwendung die Passphrase ebenfalls eingeben und verschlüsseln lassen.
Ab DocuWare 6.5 finden Sie die Passphrase zur Verschlüsselung im Bereich Organisation / Allgemein / Webverbindung.
Zur Ermittlung des AES-Schlüssels und des Initialisierungs-Vektors aus der Passphrase wird folgender Algorithmus verwendet:
Ermittlung eines SHA-512 Hashs aus der Passphrase (ergeben 512 Bits). Das kann mit der SHA512Managed-class in .NET implementiert werden und wird auch von Java und PHP unterstützt. Für JavaScript sind third-party Add-Ons verfügbar.
Nutzen Sie die ersten 256 Bits (32-Bytes-Array) für den AES-Schlüssel.
Nutzen Sie die folgenden 128 Bits (16-Bytes-Array) für den Initialisierungs-Vektor.