DocuWare TOOLKIT für C-Programmiersprachen, VB 6- und 4GL-Programmiersprachen
Über einen C-Programmierschnittstelle lassen sich TOOLKIT-Funktionen zur Steuerung von DocuWare in anderen Applikationen einsetzen. TOOLKIT steuert wesentliche DocuWare-Funktionen aus den Bereichen Briefkorb-, Archiv- und Dokumentbearbeitung. So können Briefkörbe und darin befindliche Dokumente markiert und angezeigt werden. Dokumente können importiert, verschlagwortet und in Archive abgelegt werden. Für die Suche und Ablage von Dokumenten in DocuWare-Archive stehen verschiedenste Funktionen bereit – Dialoge wie Such- und Ablagemaske können beispielsweise aufgerufen und Dokumente aus der Ergebnisliste angezeigt werden. Funktionen der C-Programmierschnittstelle werden per dynamischer oder statischer Bindungen aus den TOOLKIT-DLLs integriert. Für ein optimales Fehler- bzw. Exception-Handling liefert jede TOOLKIT-Funktion einen interpretierbaren Fehlercode. Auf eine wesentliche Erleichterung beim Handling mit TOOLKIT-Funktionen in 4GL-Programmiersprachen (z.B. Microsoft Visual Basic) zielt die COM-Schnittstelle ab, die OLE-Automation ermöglicht. Damit eine Applikation Archiv- und Briefkorbfunktionen verwenden kann, muss zur Laufzeit DocuWare gestartet sein. Nur so ist gewährleistet, dass eine Authentifikation im DocuWare-System stattfindet. Für Dokument-Funktionen (wie Ablegen) hingegen muss DocuWare nicht gestartet sein.

TOOLKIT .NET-Schnittstelle für .NET- und C#-Applikationen
Die TOOLKIT .NET-Schnittstelle fungiert als Wrapper um die C-Programmierschnittstelle. Sie ermöglicht es .NET-Sprachen, die DocuWare TOOLKIT-Funktionen zu nutzen. So können beispielsweise auch aus VB.NET- und C#-Anwendungen Dokumente im DocuWare-Viewer angezeigt werden, da die Client-Funktionalitäten angesprochen werden können. Die TOOLKIT .NET-Schnittstelle bildet die TOOLKIT-Funktionen nicht eins zu eins ab, sondern arbeitet objektorientiert. Sie bietet dabei den gleichen Funktionsumfang in einer anderen Form. Aktionen wie Suchen und Ändern können parallel über GAPI erfolgen.

DocuWare GAPI für VB.NET und C#
Das .NET 2.0 basierte Programmier-Interface GAPI ist objektorientiert und arbeitet unabhängig vom DocuWare- Client. Statt über einen Client greift GAPI direkt über TCP/IP auf die DocuWare-Server zu. Dank des direkten Zugriffs ist GAPI äußerst performant, sicher und sehr einfach einzusetzen. Zur Integration in .NET- und C#-Applikationen werden Referenzen auf die DOCUWARE.GAPI.DLL gesetzt. Fehler werden als Exceptions zurückgeliefert. Zum Teil überschneiden sich die Funktionalitäten mit denen von DocuWare TOOLKIT. Da aber GAPI ohne Client arbeitet, steht kein Benutzerinterface zur Verfügung. Die GAPI-Kommandos zur Integration in .NET- und C#-Anwendungen erlauben beispielsweise das Suchen und Ablegen von Dokumenten im Archiv, das Ändern von Indexeinträgen, das Löschen, Exportieren und Downloaden von Dokumenten. Zudem können eine Reihe Informationen einzelner Entitäten/Klas-sen abgerufen werden wie die Namen aller Benutzer einer Organisation oder die Einstellungen hinsichtlich der Indexfelder eines Archivs.

Web Services und JAPI
Web Services erlauben eine Interoperabilität der auf Basis von .NET entwickelten DocuWare-Server beispielsweise mit der Java-Welt. Die Web Services bauen auf der DocuWare GAPI (General Application Programming Interface) auf. DocuWare stellt fünf lose gekoppelte Dienste zur Verfügung, die einzeln angewendet werden können. Jeder der fünf Schnittstellen hat einen klar umrissenen Funktionsumfang. Die Services werden in zwei unterschiedlichen Ausprägungen ausgeliefert: Zum einen als „Compatible Web Services“ und zum anderen als „Session Web Services“. Beide Gruppen haben denselben Funktionsumfang, werden jedoch unterschiedlich angesprochen und werden in unterschiedlichen Umgebungen angewendet. Um beispielsweise eine Java-Client anzubinden, sind die Compatible Web Services erforderlich. Compatible Web Services unterstützen das Netzwerkprotokoll SOAP 1.1 (Simple Object Access Protocol). Die Session Services unterstützen SOAP 1.2 und dienen der Anbindung eines .NET-Clients. Auf die Web Services setzt wiederum JAPI auf - eine nahtlose Schnittstelle zur Java-Welt.

Validierung und Trigger
DocuWare bietet die Möglichkeit, über allgemeingültige oder kundenspezifische Validierungs-Bibiliotheken serverseitig Indexeinträge auf Plausibilität zu prüfen. Realisiert wird die Plausibilitätsprüfung über .NET 2.0 DLLs, die beliebig viele Prüfungen enthalten können. Die DLLs werden vom Partner oder Kunden selbst geschrieben und können daher genau auf die Bedürfnisse der Anwender zugeschnitten werden. Sowohl Eingaben in einem Feld (Feldvalidierung) als auch die Validität beliebiger Einträge (Indexvalidierung) können abgeprüft werden. DocuWare liefert eine DLL (DOCUWARE.VALIDATORBASE.DLL) mit Basis-Klassen aus. Auf der Grundlage dieser DLL erstellt der Partner/Kunde seine eigenen, spezifischen DLLs. Diese DLLs werden in der DocuWare-Administration registriert und Archiven und/oder Indexfeldern zugewiesen. Sobald ein Indexeintrag geschrieben oder aktualisiert wird, ruft das System die Bibliothek auf und prüft die Eingaben, akzeptiert sie entweder oder weist sie mit einer entsprechenden Meldung zurück. Der Benutzer kann dann seine Eingaben noch korrigieren. Die Validierungen greifen bei allen Ablagen und Indexänderungen, also etwa auch dann, wenn ein Stempel gesetzt wird, der Indexeinträge ändert. Bei einer Feldvalidierung beispielsweise kann geprüft werden, ob ein Datum älter als das aktuelle Tagesdatum ist oder ein Wert eine bestimmte Größe nicht überschreitet. Bei einer Index-Validierung wird zum Beispiel anhand einer externen Datenquelle geprüft, ob eine eingegebene Kundennummer zum Kundennamen passt.

Unabhängig von der Plausibilitätsprüfung bietet die Einbindung von .NET-Bibliotheken eine weitere Funktion: Da die DLLs beliebigen Programmcode enthalten können, sind sie auch als Trigger für die Steuerung von Vorgängen einsetzbar. So kann beispielsweise implementiert werden, dass eine Benachrichtigung an alle Benutzer geschickt wird, sobald ein Dokument mit bestimmten Indexkriterien abgelegt wurde. Ebenso lässt sich in einem fremden Datenbestand ein Eintrag vornehmen, sobald ein Indexeintrag auf einen bestimmten Wert geändert wurde. Beim Ändern eines Statusfeldes, etwa durch einen Stempel, kann durch Abgleich mit einer externen Datenbank ein anderes Indexfeld geändert werden, das die Weiterleitung an einen bestimmten Benutzer mit CONTENT-FOLDER steuert.

Hier finden Sie wesentliche Funktionen, die Sie über TOOLKIT aufrufen können. Die jeweiligen Funktionsaufrufe sowie eine vollständige Übersicht finden Sie im TOOLKIT Manual.

Briefkorb

• Anzahl aller Dokumente im Briefkorb
• Auslesen der Liste aller DocuWare Dokumente in einem Briefkorb
• Auflisten der Datei- und Dokumentnamen aller im Briefkorb befindlichen Dokumente
• Selektion oder Deselektion aller Dokumente im aktiven Briefkorb
• Selektion eines Dokuments
• Auflisten aller registrierten Briefkörbe
• Pfadangabe des aktiven Briefkorbes
• Einen Briefkorb aktivieren
• Öffnen und Aktivieren eines Briefkorbs
• Anzeige eines Dokumentes im Briefkorb
• Importieren eines Dokuments in einen Briefkorb
• Aktualisierung des aktiven Briefkorbs
• Heften markierter Dokumente in einem Briefkorb

Archiv

• Auflisten aller registrierten Archive
• Zielarchiv setzen
• Öffnen und Aktivieren eines Archivs
• Ablage eines Dokuments in ein Archiv
• Suche eines Dokuments
• Anzahl der Ergebnislisten-Einträge
• Ausdruck eines Dokuments aus der Ergebnisliste
• Anzeige eines Dokuments aus der Ergebnisliste
• Öffnen des registrierten Bearbeitungsprogramms zum Bearbeiten eines Dokumentes
• Löschen eines Dokuments aus dem Archiv
• Kopieren eines Dokuments in Briefkorb
• Ergebnisliste in Datei speichern
• Geöffnete Ablage-/Suchmaske mit Schlagworten füllen
• Ändern der Verschlagwortung bei archivierten Dokumenten
• Datenbankeintrag erzeugen

Dokument

• DW-Dokument-Header öffnen
• Auslesen und Setzen eines Text-, Datums-, numerischen oder des Bemerkungsfeldes
• Konvertieren eines Dateiformates (schwarz-weiß) in ein DocuWare-TIFF- G4-Format
• Ãœberlagerung von TIFF-Dokumenten

Hier sind die GAPI Funktionalitäten aufgelistet, die DocuWare bietet. Die Features sind unterteilt in die, die lediglich einen Lesezugriff benötigen und Informationen bereitstellen, und diejenigen, die über Kommandos Aktionen ausführen können.

A. Client

• Liste aller möglichen Authentication Server für eine Verbindung
• Login über DocuWare- oder Windows-Authentifizierung

B. Informationen
Organisation

• Name und GUID aller Gruppen, Profile und Rollen
• Liste aller Benutzer oder Direktzugriff über Name / GUID

Benutzer

• Name und GUID
• Zugewiesene Archive
• Zugewiesene Gruppen, Profile, Rollen
• Liste aller Rechte hinsichtlich Archiven, Indexfeldern von Archiven und Funktionalitäten (Menürechte)

Archiv

• Name, GUID, Farbe und Beschreibung
• Felder inklusive Label, Datenbankname, Typ, GUID, Indexnummer, Länge
• Einstellungen hinsichtlich Volltext und Satellitenarchiv

Dokument

• DocuWare-Dokumentseiten eines Dokuments
• Indexdaten, Textnotiz
• Systemfelder

C. Aktionen
Archiv

• Suche: Beliebige Archivfelder für Liste mit Treffern definierbar
• Suchkriterien für Felder und Systemfelder können definiert werden, erweitere Suchkriterien möglich, das Verknüpfen der Kriterien erfolgt über AND oder OR Trefferlisten blockweise als .NET-DataTable
• Ablage
• Finden eines Dokuments anhand der DocID

Dokument
Alle Dokumente

• Indexeinträge ändern
• Dokument oder DocuWare-Dokumentseiten löschen
• DocuWare-Dokumentseiten am Ende anhängen
• Textnotiz ändern
• Dokument oder DocuWare-Dokumentseiten ins Dateisystem exportieren

Archivierte Dokumente

• Dateien eines DocuWare-Dokuments zu/von einem Pfad down- oder uploaden
• Dateien eines DocuWare-Dokuments zu/von einem GAPI-Cache down- oder uploaden
• Dateien eines DocuWare-Dokuments kontinuierlich als Datenstrom downloaden
• Stempel setzen, auch mit Formularfeldern

DocuWare stellt fünf lose gekoppelte Dienste zur Verfügung, die verbunden oder einzeln angewendet werden können. Jede der Schnittstellen hat einen klar umrissenen Funktionsumfang. Folgende Web Services sind mit klar zugeordneten Funktionen verfügbar.

DWService

• Authentifizierung
• Liste aller Archive
• Liste aller Stempel

FileCabinetService

• Zugriff auf die Indexfelder eines Archivs
• Zugriff auf Dialoge und Auswahllisten
• Dokumente löschen

ResultListService

• Suche
• Zugriff auf Ergebnisliste
• Trefferlisten blockweise

DocumentService

• Dokumente öffnen und schließen
• Indexeinträge ändern
• Textnotiz anbringen
• Stempeln

FileService

• Zugriff auf die Dateien
• Daten eines DocuWare-Dokuments downloaden/uploaden

Hier sind die JAPI Funktionalitäten aufgelistet, die DocuWare bietet.

Archiv

• Suche: Beliebige Suchfelder und Ergebnisliste frei definierbar
• Suchkriterien für Felder können definiert werden. Erweitere Suche möglich, das Verknüpfen der Kriterien erfolgt über AND oder OR
• Trefferlisten blockweise
• Ablage von Dokumenten
• Finden eines Dokuments anhand der DocID

Dokument
Alle Dokumente

• Indexeinträge ändern
• Ganzes Dokument oder einzelne Seiten löschen

Archivierte Dokumente

• Dateien eines DocuWare-Dokuments zu/von einem Pfad down- oder uploaden
• Stempel setzen, auch mit Formularfeldern