docXporter Dokumentation

Aktualisiert 3 months ago von DocuScan Support

Funktionsumfang

docXporter erlaubt das Exportieren von Dokumenten aus DocuWare Archiven ins Dateisystem. Für die Auswahl der Dokumente stehen beliebige Filterkriterien auf Basis der Indexbegriffe zur Verfügung. Die exportierten Dateien werden nach dem Export im Archiv durch das Ändern von beliebigen Indexwerten gekennzeichnet. Die Dokumente werden standardmäßig als PDF Datei exportiert oder als Tiff-Datei. Optional werden Annotationen und Stempeln exportiert.

Installation

Download: Aktuelle Installationsdateien

Der docXporter erfordert das .net Framework 4.6.2. Die Anwendung wird als ZIP Datei ausgeliefert, welche alle erforderlichen Dateien enthält. Folgenden Dateien kommt eine besondere Bedeutung zu:

docXporter.exe

Die eigentliche Anwendung mit der Programmlogik

docXporter.exe.config

Die Konfigurationsdatei der Anwendung

Die Installation erfolgt manuell durch das Kopieren der Programdateien in ein beliebiges Verzeichnis.

WICHTIG! Der docXporter verwendet die DocuWare Platform Services und erfordert daher mindestens DocuWare in der Version 6.8. Empfohlen wird allerdings die Verwendung von DocuWare 6.12 oder höher.

Konfiguration

Bitte verwenden Sie für die Bearbeitung der Konfigurationsdatei nicht den mit Windows mitgelieferten Editor (Notepad.exe), sondern ein alternatives Programm wie Notepad++ oder Visual Studio Code. Ansonsten besteht die Gefahr, dass die Konfigurationsdatei beschädigt wird.

Die Konfiguration des docXporter erfolgt über die docXporter.exe.config, einer XML Datei die die anpassbaren Parameter enthält. Jeder Parameter besteht immer aus Parametername und Parameterwert:

PARAMETERNAME enthält den Namen der Einstellung und ist Case-Sensitiv

PARAMETERWERT enthält den jeweils gesetzten Wert

Die Einstellungen haben jeweils den folgenden Aufbau: 

<setting name="PARAMETERNAME" serializeAs="String">
    <value>PARAMETERWERT</value>
</setting>

Bei Parametern mit mehreren Werten hat dieser folgenden Aufbau:

<setting name="PARAMETERNAME" serializeAs="Xml">
<value>
<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>PARAMETERWERT</string>
<string>PARAMETERWERT</string>
<string>PARAMETERWERT</string>
</ArrayOfString>
</value>
</setting>
ACHTUNG: Die Möglichkeit mehr als eine Konfiguration innerhalb derselben Konfigurationsdatei anzugeben wurde mit dieser Version 3.0 entfernt. Sollen mehrere Konfigurationen verwaltet werden, so sind mehrere Instanzen von docXporter in unterschiedlichen Ordnern erforderlich.
ACHTUNG: Ab Version 3.2 wurden die Optionen zum Festlegen der Exportmodus verändert. Die Einstellungen EnableExportAnnotations und ExportAsTiff wurden entfernt und in der neuen Einstellung ExportMode zusammengefasst.
ACHTUNG: Die Einstellung CreateIndexFile wurde mit Version 3.2 entfernt und durch die Einstellung IndexFileMode ersetzt.

Parameter der Konfigurationsdatei

Allgemeine Parameter

LicenseKey

Ab Version 3.0 ist ein Lizenzschlüssel für docXporter erforderlich. Ohne gültigen Lizenzschlüssel kann die Anwendung nach einer Testphase von 30 Tagen nicht weiterverwendet werden.

DWServiceUrl

Die URL zu den DocuWare Platform Services. Beispiel: http://DOCUWARESERVER/DocuWare/Platform DOCUWARESERVER muss entsprechend durch den Servernamen ersetzt werden unter dem auch der DocuWare Webclient erreichbar ist.

DWUser

Benutzername des DocuWare Benutzers mit dem sich die Anwendung an DocuWare anmelden soll. Wir dieser Parameter leer gelassen, versucht die Anwendung sich per Windowsauthentifizierung mit dem User anzumelden, mit dem die Anwendung gestartet wurde.

DWPassword

Passwort des DocuWare Benutzers mit dem sich die Anwendung an DocuWare anmelden soll.

DWOrganization

Die DocuWare Organisation an welcher die Anwendung angemeldet werden soll.

DWArchivGuid

Die GUID des DocuWare Archivs aus dem die Dokumente exportiert werden sollen (findet man in der DocuWare Administration in den Allgemeinen Einstellungen des Archivs).

DWSearchDialogGuid

Die GUID des Suchdialoges auf dessen Basis die Dokumente für den Export ermittelt werden sollen.

Stempel

Das sich in der Verarbeitung befindliche Dokument kann vor oder nach dem Export mit einem Stempel versehen werden.

EnableStamps

Ermöglicht die Aktivierung bzw. Deaktivierung der Möglichkeit ob der Stempel auf dem exportierten Dokument aufgebracht werden soll. Gültige Werte sind True = Aktiv, False = Inaktiv. Beachten Sie auch die weiterführenden Informationen zu den Stempeln weiter unten.

StampBeforeExport

Dieser Schalter wird ignoriert, wenn EnableStamps den Wert False hat. Ermöglicht zu entscheiden ob der Stempel vor dem Export des Dokuments gesetzt wird und damit in den exportierten Dokumenten enthalten ist (sofern über den ExportMode Annotationen exportiert werden sollen) oder nach dem Export des Dokumentes. Gültige Werte sind True = Vor dem Export stempeln, False = Nach dem Export stempeln.

StampLayer

Bezeichnet die Anmerkungsebene wo der Stempel aufgebracht wird. Standardmäßig hat diese Einstellung den Wert 1.

StampPosX

Die Position in Pixeln, beginnend am linken Rand des Dokuments, wo der Stempel platziert wird. Für eine automatische Positionierung des Stempels muss hier -1 eingetragen werden.

StampPosY

Die Position in Pixeln, beginnend am oberen Rand des Dokuments, wo der Stempel platziert wird. Für eine automatische Positionierung des Stempels muss hier -1 eingetragen werden.

DWStampName

Der Name des Stempels welcher beim Export auf das Dokument aufgebracht wird.

Export

ExportMode

Hier wird festgelegt in welchem Format die Dokumente nach dem Export im Dateisystem gespeichert werden. Groß-/Kleinschreibung beachten. 

ExportMode

Beschreibung

Disabled

Deaktiviert den Export von Dokumenten Hinweis: Ermöglicht den reinen Export von Indexdaten (siehe IndexFileMode)

Pdf

Export als PDF

PdfWithAnnotations

Export als PDF mit Anmerkungen

Tiff

Export als Tiff. Siehe unten für weitere Einstellungen

TiffWithAnnotations

Export als Tiff mit Anmerkungen

OriginalFormat

Export das Dokument im OriginalFormat, sofern es sich um geklammerte Dokumente handelt werden mehrere Dateien exportiert und dem Dateinamen ein Index angehangen.

OriginalFormatZipped

Export im Original Format in einer Zip-Datei zusammengefasst.

ExportCoverage

Hiermit wird festgelegt welcher Teil des Dokuments exportiert werden soll.

ExportCoverage

Beschreibung

All

Dies ist der Standardwert. Es wird der gesamte Dokument exportiert

FirstSection

Es wird nur die erste Sektion exportiert

LastSection

Es wird nur die letzte Sektion exportiert

SectionIndex

Es wird nur die Sektion mit dem Index exportiert wie in der Einstellung SectionIndex definiert exportiert. Hinweis: Alle zu exportierenden Dokumente müssen eine Sektion mit diesem Index haben.

SectionIndex

Der Index der Sektion die exportiert werden soll. Damit diese Einstellung verwendet wird muss in der Einstellung ExportCoverage der Wert auf SectionIndex gesetzt werden.

DWArchivFilter

Die Filterkriterien nach denen die zu exportierenden Dokumente ausgewählt werden sollen. Der Parameterwert hat folgenden Aufbau: FELDNAME=WERT Beispiel: STATUS=EMPTY()FELDNAME entspricht dem Datenbanknamen des DocuWare Feldes in Großbuchstaben (findet man in der DocuWare Administration in den Feldeigenschaften des jeweiligen Feldes). Manchmal enthalten diese auch _ wenn beim Anlegen des Feldes Sonderzeichen verwendet wurden. Diese müssen ebenfalls mit eingegeben werden.Beispiel: COMPANY_=Flying Tom*.WERT kann entweder ein fester Wert sein, der Teil eines festen Wertes mit * als Wildcard versehen oder die aus DocuWare bekannten variablen wie EMPTY() oder NOTEMPTY(). Die Eingabemöglichkeiten entsprechen der Allgemeinen Suchmaske in der DocuWare Administration wie z.B. bei Archivfiltern.Um mit Operatoren wie größer oder kleiner als zu arbeiten ist folgender Syntax zu verwenden: FELD=~~[OPT]~~WERT

Die nachfolgend beschriebene Funktion ist ab Version 4.0.19206 verfügbar

Ein Sonderfall ist der Wert ~~DATE(). Hiermit kann auf das aktuelle Systemdatum zugegriffen werden. Der Wert kann noch mit mittels + und - ergänzt werden, also z.B.~~DATE()-3 für aktuelles Datum -3 Tage.

Beispiel für eine Suche im Feld COMPANY nach sämtlichen Dokumenten die mit Peters beginnen:

<setting name="DWArchivFilter" serializeAs="Xml">
<value>
<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>COMPANY=Peters*</string>
</ArrayOfString>
</value>
</setting>

Beispiel für eine Suche die im Feld COUNTER nach Dokumenten sucht, die größer als 1.000 und kleiner als 2.000 sind:

<setting name="DWArchivFilter" serializeAs="Xml">
<value>
<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>COUNTER=~~[gt]1000~~[lt]2000</string>
</ArrayOfString>
</value>
</setting>

Beispiel für eine Suche die im internen Feld DWSTOREDATETIME nach Dokumenten sucht, die in den vergangenen 3 Tagen (ausgenommen aktueller Tag) archiviert wurden:

<setting name="DWArchivFilter" serializeAs="Xml">
<value>
<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>DWSTOREDATETIME=~~[gte]~~DATE()-3~~[lt]~~DATE()</string>
</ArrayOfString>
</value>
</setting>

OPT

Beschreibung

[ne]

Ungleich (entspricht <> in DocuWare)

[lt]

Kleiner als (entspricht < in DocuWare)

[gt]

Größer als (entspricht > in DocuWare)

[lte]

Kleiner oder gleich als (entspricht <= in DocuWare)

[gte]

Größer oder gleich als (entspricht >= in DocuWare)

DWArchivUpdateIndex

Parameter mit mehrfachen Werten. Die Konfiguration erfolgt gemäß den Informationen unter DwArchivFilter.Die Indexe die nach dem Export geändert werden sollen. Der Parameterwert hat folgenden Aufbau: FELDNAME=WERT Beispiel: STATUS=ExportiertFELDNAME entspricht dem Datenbanknamen des DocuWare Feldes in Großbuchstaben (findet man in der DocuWare Administration in den Feldeigenschaften des jeweiligen Feldes). Manchmal enthalten diese auch _ wenn beim Anlegen des Feldes Sonderzeichen verwendet wurden. Diese müssen ebenfalls mit eingegeben werden. Beispiel: EXPORTED_=done.WERT ist immer ein fester Wert.

ExportPath

Definiert den Ordner in den die Dokumente exportiert werden sollen. Bsp.: c:\export\ (UNC Pfad ist möglich). Wenn der Ordner nicht existiert wird dieser angelegt. Hier können auch Indexwerte des Dokuments verwendet werden, indem der Feldname in geschweiften Klammern z.B. {COMPANY} angegeben wird. Die Angabe des Feldnamens erfolgt wie bei den übrigen Einstellungen entsprechend dem Datenbanknamen des DocuWare Feldes.

FileName

Definiert den Aufbau des Dateinamens der exportierten Datei. Hierzu können sowohl fixe Werte als auch Indexwerte des Dokuments verwendet werden. Im Falle von Indexwerten wird der Feldname in geschweiften Klammern angegeben Bsp. {COMPANY} oder {DWDOCID}. Die Angabe des Feldnamens erfolgt wie bei den übrigen Einstellungen entsprechend dem Datenbanknamen des DocuWare Feldes. Die Dateien werden im Standard als PDF Dateien exportiert.

ExportAsTiff

Ermöglicht die Dokumente als Tiff-Dateien zu exportieren. Bitte beachten Sie, dass die Ausgabe als Tiff-Datei zu deutlich größeren Ausgabedateien führt, als dies bei PDF-Dateien der Fall ist. Gültige Werte sind True = Aktiv, False = Inaktiv

TiffCompression

Ermöglicht die Angabe der Kompression zur Speicherung der Tiff-Dateien. Hiermit haben Sie die Möglichkeit Einfluss auf die Qualität und die Dateigröße zu nehmen. Folgende Werte stehen Ihnen zur Verfügung: Jpeg Empfohlen für farbige Dokumente und Dokumente mit Graustufen CcittGroup4 Empfohlen für schwarz-weiß Dokumente

TiffResolution

Hier können Sie die Auflösung des Tiff Dokuments festlegen. Je höher der Wert, desto besser kann die Qualität sein, aber die Dateigröße wird sich bei hohen Werten extrem erhöhen.

Indexdateien

Zu den exportierten Dokumenten können zusätzliche Dateien mit Indexdaten erzeugt werden.

IndexFileMode

Steuert ob eine Indexdatei für ein Dokument erstellt werden soll und wie die Erstellung erfolgt. Groß-/Kleinschreibung muss beachtet werden.

IndexFileMode

Beschreibung

Disabled

Keine Indexdatei erstellen

Document

Eine Indexdatei pro Dokument erstellen

ResultSet

Eine Indexdatei erstellen welche die Indexdaten für sämtliche exportieren Dokumente enthält.

Sofern es bereits eine Indexdatei mit dem gleichen Namen gibt, dann wird diese überschrieben.

ResultSetAppend

Verhält sich wie ResultSet, allerdings werden die Indexdatei an eine gegebenenfalls vorhandene Indexdatei angehängt.

Addison

Spezieller Modus für die Erzeugung von Addison kompatiblen Indexdateien. Weitere Informationen: DocExporter - Export für Addison

IndexFileNamePattern

Definiert den Aufbau des Dateinamens der exportierten Datei. Hierzu können sowohl fixe Werte als auch Indexwerte des Dokuments verwendet werden. Im Gegensatz zu der Einstellung FileName (siehe oben) ist hier die Angabe der Dateinamenerweiterung anzugeben.

IndexFileDocumentTemplate

Repräsentiert die erste Zeile der Erstellten Indexdatei. Dies kann z.B. die Kopfzeile mit Spaltennamen einer CSV-Datei sein.

IndexFileRepetitionTemplate

Diese Zeile enthält die Platzhalter für die Indexdaten die in die Indexdatei geschrieben werden sollen. Platzhalter in geschweiften Klammer werden durch entsprechende Werte ersetzt.

Stempel

Sollte der Stempel Felder beinhalten die genauso benannt (Beschriftung) wurden die Datenbankfeldnamen der Indexfelder des Dokumentes auf dem der Stempel aufgebracht werden soll, dann werden diese Felder automatisch mit den Indexwerten des entsprechenden Indexfeldes gefüllt.

Um die DocuWare Dokumenten ID in einem Stempel zu verwenden, verwenden Sie für das Stempel-Feld die Beschriftung DWDOCID.

Ausführung eines Exports

Nach dem die Anwendung vollständig über die .config Datei konfiguriert wurde, kann die Anwendung gestartet werden. Hierzu kann diese entweder per Doppelklick oder per Kommandozeile aufgerufen werden. Die Anwendung dokumentiert die einzelnen Verarbeitungsschritte zum einen als Ausgabe im Konsolenfenster. Gerade bei den ersten Tests kann es hilfreich sein die Programausgaben genau zu betrachten. Um dies zu erleichtern können sie die docXporter.exe mit einem beliebigen Parameter starten. Die Anwendung wartet dann nach Abschluss der Aktivitäten auf eine beliebige Taste bevor das Konsolenfenster geschlossen wird.

Um die Verarbeitung bzw. die Ausführung zu automatisieren kann die docXporter.exe über die „Geplanten Tasks“ von Windows (Aufgabenplanung bei Server 2008) entsprechend der dortigen Möglichkeiten zu unterschiedlichsten Zeiten oder Ereignissen ausgeführt werden.

WICHTIG! Bei der Aufgabenplanung von Windows 2008 oder höher muss in der Aufgabe die Option „Mit höchsten Privilegien ausführen“ aktiviert sein, wenn Sie die Aufgabe unabhängig von der Benutzeranmeldung ausführen wollen.

Logging

Sämtliche Programmaktivitäten können in einer Log-Datei dokumentiert werden, die sich im Logs-Verzeichnis im Programmverzeichnis befinden. Standardmäßig ist eine Log-Datei 1 MB groß und es werden bei Erreichen dieser Beschränkungen die letzten 5 Dateien im Log-Verzeichnis aufbewahrt. Sobald die Anzahl dieser historischen Log-Dateien erreicht ist, wird die jeweils älteste Datei gelöscht.

Zudem werden zunächst nur Informationen, sowie Fehler protokolliert. Sofern mehr Details, z.B. während der Testphase erforderlich sind, kann die Protokollierung auf DEBUG erhöht werden.

Der Detailgrad der Protokollierung wird ebenfalls in der DocuwareExporer.exe.config vorgenommen. Suchen Sie hier nach dem Block und ändern Sie den Text INFO nach DEBUG.

<root>
   <level value="INFO"/>
</root>


Wie waren wir?