docXporter Dokumentation
Aktualisiert 6 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.
Konfiguration
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>
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.
| ||||||||||||||||
ExportCoverage | Hiermit wird festgelegt welcher Teil des Dokuments exportiert werden soll.
| ||||||||||||||||
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: Die nachfolgend beschriebene Funktion ist ab Version 4.0.19206 verfügbar Ein Sonderfall ist der Wert Beispiel für eine Suche im Feld COMPANY nach sämtlichen Dokumenten die mit Peters beginnen: <setting name="DWArchivFilter" serializeAs="Xml"> 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"> 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">
| ||||||||||||||||
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: | ||||||||||||||||
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.
| ||||||||||||
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.
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>
