Sobald docXporter installiert ist, kann es konfiguriert werden. Beachten Sie, dass docXporter kein UI-basiertes Konfigurationstool enthält. Stattdessen werden alle Konfigurationen über einzelne XML-Dateien verwaltet, die mit jedem Texteditor bearbeitet werden können.
Wir empfehlen, einen Editor wie Notepad++ oder Visual Studio Code zu verwenden, um die Konfigurationsdateien zu bearbeiten. Der mit Windows gelieferte Editor (Notepad.exe) hat in der Vergangenheit bereits dazu geführt, dass Konfigurationsdateien unbrauchbar wurden.
Während der Einrichtung von docXporter wird die Standardkonfigurationsdatei defaultconfig.xml im Ordner C:\ProgramData\docXporter\ installiert.
Verwenden Sie diese Konfigurationsdatei als Vorlage für weitere Konfigurationsdateien. Es können beliebig viele Konfigurationen erstellt werden, indem eine vorhandene Datei kopiert und entsprechend ihrer Aufgabe umbenannt wird. Wenn Sie beispielsweise einen Export speziell für Rechnungen benötigen, ist der Name invoices.xml eine gute Wahl. Konfigurationen können alle oder spezifisch ausgeführt werden (siehe Kapitel „Einen Export ausführen“)
Für grundlegende Einstellungen reicht es aus, den Wert zwischen den XML-Tags zu ändern. Gehen Sie zu den allgemeinen Parametern in der Tabelle unten, um dies zu überprüfen.
Einstellungen wie Suchparameter im Dateiarchiv oder das Aktualisieren von Indexbegriffen folgen einer bestimmten Struktur:
Die
Item
-Zeile wird für jeden Eintrag dupliziertName
enthält den Datenbanknamen des FeldesWert
der Wert
Beispiel
<Object Name="DWArchivFilter" Type="Docuscan.DocuwareExporter.Configuration.FieldMapping">
<Item Name="COMPANY" Value="Berger Stahlgroßhandel GmbH" />
<Item Name="STATUS" Value="Export" />
</Object>
Sonderzeichen wie &, < oder > sowie sprachspezifische Zeichen wie ä, ö oder ñ können Probleme verursachen, wenn sie im Klartext innerhalb von XML-Dateien verwendet werden. Wenn Ihre Konfiguration die Verwendung dieser Zeichen erfordert, erweitern Sie bitte den folgenden Abschnitt für weitere Informationen.
Zusätzliche Informationen zum Umgang mit Sonderzeichen in XML-Dateien
Da die in einer XML-Datei verwendete Syntax einige Zeichen reserviert hat, müssen diese umgeschrieben werden, um sie in der Datei zu speichern. Die folgende Tabelle zeigt die am häufigsten umgeschriebenen Zeichen. Probleme treten besonders häufig auf, weil das Zeichen & nicht umgeschrieben wird.
Zeichen | Zu ersetzen durch |
---|---|
& |
|
< |
|
> |
|
Klassische Beispiele sind DocuWare-Organisationsnamen für Unternehmensformen wie GmbH & Co KG oder wenn SQL-Abfragen mit größer als/kleiner als Bedingungen.
Probleme können auch auftreten, wenn Zeichen außerhalb des ASCII-Zeichensatzes verwendet werden. Beispiele hierfür sind é, à usw.
Solche Zeichen müssen ebenfalls durch entsprechende Ersatzzeichen ersetzt werden. Eine Internetsuche nach „Unicode-Zeichentabelle“ bringt beispielsweise die folgende Seite hervor: https://www.utf8-zeichentabelle.de/unicode-utf8-table.pl?names=-&unicodeinhtml=hex
Demnach wird beispielsweise das Zeichen é durch é
oder à durch à
ersetzt. Es ist natürlich auch möglich, die jeweilige hexadezimale Notation zu verwenden.
Parameter in der Konfigurationsdatei
Allgemein
DWServiceUrl
URL zu DocuWare Platform Services
Beispiel: https://DOCUWARESERVER/DocuWare/Platform
Ersetzen Sie den Wert DOCUWARESERVER durch denselben Servernamen wie für den DocuWare Web Client
DWUser
Benutzername des DocuWare-Benutzers, den die Anwendung zum Anmelden bei DocuWare verwendet.
Wenn dieser Parameter leer bleibt, versucht die Anwendung, sich über die Windows-Authentifizierung mit dem Benutzer anzumelden, mit dem die Anwendung gestartet wurde.
DWPassword
Passwort des DocuWare-Benutzers, den die Anwendung zum Anmelden bei DocuWare verwendet.
Das Passwort muss über das bereitgestellte Verschlüsselungstool verschlüsselt werden. Sie finden eine Verknüpfung im Konfigurationsdateien-Ordner.
DWOrganization
Die DocuWare-Organisation, bei der die Anwendung registriert ist.
DWArchivGuid
GUID des DocuWare-Dateischranks, aus dem die Dokumente exportiert werden. Die GUID finden Sie in der DocuWare-Konfiguration in den allgemeinen Einstellungen des Dateiarchivs.
DWSearchDialogGuid
GUID des Suchdialogs, der verwendet wird, um die Dokumente für den Export zusammenzustellen. Die GUID finden Sie in der DocuWare-Konfiguration in den Dateiarchiv-Dialogen.
Stempel
Dokumente können vor oder nach dem Export gestempelt werden.
EnableStamps
Aktivieren oder deaktivieren Sie die Option, den Stempel auf das exportierte Dokument zu setzen.
Gültige Werte sind True = aktiv, False = nicht aktiv.
Beachten Sie weitere Informationen zu Stempeln unten.
StampBeforeExport
Dieser Schalter wird ignoriert, wenn EnableStamps den Wert False hat.
Entscheiden Sie, ob
der Stempel vor dem Export des Dokuments gesetzt wird und daher in den exportierten Dokumenten enthalten ist (wenn Anmerkungen über den ExportMode exportiert werden sollen)
oder nachdem das Dokument exportiert wurde.
Gültige Werte sind
True = Stempel vor dem Export
False = Stempel nach dem Export
StampLayer
Bezeichnet die Anmerkungsebene, auf der der Stempel angewendet wird. Standardmäßig hat diese Einstellung den Wert 1.
StampPosX
Position in Pixeln, beginnend am linken Rand des Dokuments, an der der Stempel platziert wird.
Für die automatische Positionierung des Stempels muss hier -1 eingegeben werden.
StampPosY
Position in Pixeln, beginnend am oberen Rand des Dokuments, an der der Stempel platziert wird.
Für die automatische Positionierung des Stempels muss hier -1 eingegeben werden.
DWStampName
Name des Stempels, der während des Exports auf das Dokument angewendet wird.
Suche
docXporter unterstützt zwei Varianten zur Suche nach Dokumenten. Die empfohlene Methode ist die Verwendung des Suchmodus DocuWare
. Für sehr spezielle Anwendungsfälle in Docuware On-Premises können Sie den Suchmodus SQL
verwenden.
SearchMode
Gültige Werte sind DocuWare
und SQL
.
Eine normale Suche wird im DocuWare-Dateischrank durchgeführt. Parameter, die bei der Suche in DocuWare gültig sind (z.B. NOT, OR oder EMPTY() ), können bei der Suche in Textfeldern verwendet werden.
Die Suche über DocuWare liefert maximal 10.000 Ergebnisse.
Um diesen Suchmodus zu verwenden, müssen folgende Parameter konfiguriert werden:
DWSearchDialogGuid
GUID des Suchdialogs, der verwendet wird, um die Dokumente für den Export zusammenzustellen. Die GUID finden Sie in der DocuWare-Konfiguration in den Dateiarchiv-Dialogen.
DWArchivFilter
Filterkriterien, nach denen die zu exportierenden Dokumente ausgewählt werden. Die allgemeine Syntax der Einstellungen sieht so aus. Für jedes DocuWare-Feld muss eine weitere Item-Zeile hinzugefügt werden.
<Object Name="DWArchivFilter" Type="Docuscan.DocuwareExporter.Configuration.FieldMapping">
<Item Name="COMPANY" Value="Peter Engineering" />
<Item Name="STATUS" Value="Export" />
</Object>
Der Wert des Name-Attributs entspricht dem Datenbanknamen des DocuWare-Felds in Großbuchstaben (siehe DocuWare-Konfiguration in den Eigenschaften des jeweiligen Felds).
Manchmal wurden bei der Felderstellung Sonderzeichen verwendet. Geben Sie diese auch hier ein, z.B. Name=”COMPANY”
Der Wert des Value-Attributs kann entweder ein fester Wert, ein Teil eines festen Werts mit * als Platzhalter oder eine in DocuWare bekannte Variable wie EMPTY() oder NOTEMPTY() sein. Die Eingabeoptionen entsprechen dem allgemeinen Suchdialog in der DocuWare-Konfiguration, z.B. für Dateiarchiv-Filter.
Für anspruchsvollere Suchvorgänge lesen Sie bitte den Artikel über Erweiterte Suchfilter.
Alternative Suche in einer SQL-Datenbank für On-Premise-Systeme
Diese Suche ist nur für Sonderfälle erforderlich, z.B. wenn die erwartete Anzahl der Ergebnisse 10.000 Dokumente übersteigt oder ein Vergleich mit einer anderen Datenbank erforderlich ist.
Um diesen Suchmodus zu verwenden, müssen folgende Parameter konfiguriert werden
SqlConnectionString
Eine SQL-Verbindungszeichenfolge zur verwendeten Datenbank. In den meisten Fällen ist dies die DocuWare-Datenbank. Verschiedene Beispiele für Verbindungszeichenfolgen finden Sie z.B. unter https://connectionstrings.com
docXporter unterstützt nur Microsoft SQL Server-Datenbanken.
SqlSearchQuery
Die Select-Anweisung als SQL-Abfrage zur Bestimmung der zu exportierenden Dokumente. Die Abfrage muss das Feld DWDOCID enthalten. Darüber hinaus ist eine explizite Angabe aller Felder erforderlich, die für den Dateinamen und den Ordnernamen benötigt werden.
Export
docXporter unterstützt verschiedene Optionen zum Exportieren von Dokumenten aus DocuWare. Dies wird durch die Einstellung ExportMode definiert.
ExportMode
Geben Sie das Format an, in dem die Dokumente nach dem Export im Dateisystem gespeichert werden. Beachten Sie dabei Groß- und Kleinschreibung.
Disabled | Deaktiviert den Dokumentenexport. Hinweis: Ermöglicht den Export von Indexdaten nur (siehe IndexFileMode) |
Export als PDF | |
PdfWithAnnotations | Export als PDF mit Anmerkungen. Entspricht dem Zusammenführen der Anmerkungen |
Tiff | Export als Tiff, siehe unten für weitere Einstellungen |
TiffWithAnnotations | Export als Tiff mit Anmerkungen. Entspricht dem Zusammenführen der Anmerkungen |
OriginalFormat | Export des Dokuments im Originalformat. Ein geklipptes Dokument wird als mehrere Dateien exportiert und ein Index wird dem Dateinamen angehängt. |
OriginalFormatZipped | Export im Originalformat gebündelt in einer Zip-Datei |
ExportCoverage
Definieren Sie, welcher Teil des Dokuments exportiert werden soll.
All | Standard. Export des gesamten Dokuments |
FirstSection | Export nur des ersten Abschnitts |
LastSection | Export nur des letzten Abschnitts |
SectionIndex | Export nur der Abschnitte mit Index – wie in der Einstellung SectionIndex definiert. Alle zu exportierenden Dokumente erfordern Abschnitte mit diesem Index. |
SectionIndex
Der Index des zu exportierenden Abschnitts. Damit diese Einstellung verwendet werden kann, muss der Wert in der Einstellung ExportCoverage auf SectionIndex gesetzt werden.
ExportPath
Definiert den Ordner, in den die Dokumente exportiert werden sollen. Beispiel: C:\Export\
(UNC-Pfad ist möglich). Wenn der Ordner nicht existiert, wird er erstellt. Indexwerte des Dokuments können hier auch verwendet werden, indem der Feldname in geschweiften Klammern angegeben wird, z.B. {COMPANY}
. Wie bei den anderen Einstellungen wird der Feldname gemäß dem Datenbanknamen des DocuWare-Felds angegeben.
Beispiel: C:\Export\{COMPANY}\
Der ExportPath kann auch Teile eines DocuWare-Datumfelds enthalten, z.B. den Monat oder das Jahr. Nach der Angabe des Feldnamens wird die .net-konforme Datumsformatierung mit einem Doppelpunkt angegeben, z.B. {DATE:MMMM}
für den vollständigen Monatsnamen oder {DATE:yy}
für ein zweistelliges Jahr.
Wenn sowohl Monat als auch Jahr in einem Exportpfad verwendet werden, werden die Informationen in einem eingegeben.
Beispiel: C:\Export\{DATE:yyyy}\{DATE:MMMM}\{COMPANY}\
Ergebnis: C:\Export\2021\Januar\Peters Engineering\
FileName
Definiert die Struktur des Dateinamens der exportierten Datei. Sowohl feste Werte als auch Indexwerte des Dokuments können hierfür verwendet werden. Im Falle von Indexwerten wird der Feldname in geschweiften Klammern angegeben, z.B. {COMPANY} oder {DWDOCID}. Wie bei den anderen Einstellungen wird der Feldname gemäß dem Datenbanknamen des DocuWare-Felds angegeben. Die Dateien werden standardmäßig als PDF-Dateien exportiert.
Verwenden Sie einen eindeutigen Dateinamen, um versehentliches Überschreiben zu verhindern. Unter bestimmten Umständen können verschiedene Dokumente während des Exports denselben Dateinamen erhalten, nämlich wenn beide Dokumente denselben Wert in den Indexfeldern enthalten, aus denen der Dateiname erstellt wird. In diesem Fall wird das bereits exportierte Dokument überschrieben.
Dies gilt insbesondere für das Exportziel MergedPdf.
TiffCompression
Geben Sie die Komprimierung für das Speichern der Tiff-Dateien an. Beeinflussen Sie die Qualität und Dateigröße. Folgende Werte stehen zur Verfügung:
JPEG: Empfohlen für Farbdokumente und Dokumente mit Graustufen
CcittGroup4: Empfohlen für Schwarz-Weiß-Dokumente
TiffResolution
Geben Sie die Auflösung des Tiffs an. Je höher der Wert, desto besser kann die Qualität sein, aber die Dateigröße wird bei hohen Werten potenziell zunehmen.
Nach Abschluss des Exports eines Dokuments sollten die Indexdaten des Dokuments aktualisiert werden, um zu vermeiden, dass sie erneut exportiert werden.
DWArchivUpdateIndex
Enthält die Indexwerte, die nach dem Export geändert werden sollen, um exportierte Dokumente vom Exportfilter auszuschließen. Die Konfiguration funktioniert im Grunde genauso wie bei DWArchivFilter.
Die allgemeine Syntax der DWArchivUpdateIndex-Einstellung sieht so aus. Für jedes DocuWare-Feld muss eine weitere Item-Zeile hinzugefügt werden.
<Object Name="DWArchivUpdateIndex" Type="Docuscan.DocuwareExporter.Configuration.FieldMapping">
<Item Name="STATUS" Value="Exported" />
</Object>
Der Wert des Name-Attributs entspricht dem Datenbanknamen des DocuWare-Felds in Großbuchstaben (kann in der DocuWare-Konfiguration der Feldeigenschaften des jeweiligen Felds gefunden werden). Manchmal enthalten diese auch wenn bei der Erstellung des Felds Sonderzeichen verwendet wurden. Diese müssen ebenfalls eingegeben werden, zum Beispiel: Name=”COMPANY”
Beispiel: <Item Name=“EXPORTED_” Value=“done” />
. Der Wert ist entweder ein fester Wert oder ein relatives Datum wie DATE(-1)
für das Datum des Vortages.
Indexdateien
Wenn Dokumente exportiert werden, können zusätzliche Dateien mit den Indexdaten der Dokumente erstellt werden. Bitte lesen Sie den ausführlichen Artikel über Indexdateien wie man Vorlagen erstellt.
IndexFileMode
Steuert, ob eine Indexdatei für ein Dokument erstellt werden soll und wie sie erstellt wird. Groß-/Kleinschreibung muss beachtet werden.
Disabled | Keine Indexdatei erstellen |
Document | Erstellen Sie eine Indexdatei pro Dokument |
ResultSet | Erstellen Sie eine Indexdatei, die die Indexdaten für alle exportierten Dokumente enthält. |
IndexFileNamePattern
Definiert die Struktur des Dateinamens der exportierten Datei. Sowohl feste Werte als auch Indexwerte des Dokuments können hierfür verwendet werden. Im Gegensatz zur Einstellung FileName (siehe oben) muss hier die Dateierweiterung angegeben werden.
TemplateFile
Der Pfad zur Vorlagendatei. Wenn nur der Dateiname angegeben wird, wird die Vorlage im Ordner C:\ProgramData\docXporter\Templates gesucht. Wenn ein Pfad angegeben wird, wird dieser direkt verwendet.
Veraltete Legacy-Einstellungen
Sie finden möglicherweise die Einstellungen IndexFileDocumentTemplate und IndexFileRepetitionTemplate in der Konfigurationsdatei. Diese Einstellung ist zur Aufrechterhaltung der Kompatibilität enthalten und sollte nicht mehr verwendet werden. Verwenden Sie stattdessen eine Vorlage für Indexdateien.
Dokumente in einer ZIP- oder zusammengeführten PDF-Datei bündeln
Zusätzlich zum Exportieren von Dokumenten in einen Ordner im Dateisystem können Dokumente auch in ZIP-Dateien exportiert werden. Je nach Anforderung können die Dokumente auch auf mehrere Dateien verteilt werden.
ExportTarget
Steuert, ob der Export in eine ZIP-Datei oder einen Dateisystemordner erfolgt.
Folder | Export in den Ordner ExportPath |
ZipFile | Die exportierten Dokumente werden in ZIP-Dateien gepackt, die dann im Ordner ExportPath gespeichert werden. |
MergedPdf | Die exportierten Dokumente werden in einer einzigen PDF-Datei gebündelt, die im Ordner ExportPath gespeichert wird. Der ExportMode wird automatisch auf Pdf gesetzt, wenn ein anderer ExportMode als Pdf oder PdfWithAnnotations festgelegt ist. |
GroupFileNamePattern
Geben Sie hier das Muster an, aus dem der Dateiname für die Ausgabedatei erstellt werden soll.
Es ist nicht erforderlich, die Dateierweiterung hier anzugeben, da diese automatisch zugewiesen wird. Abhängig davon, welches Exportziel ausgewählt wurde, lautet die Erweiterung .zip oder .pdf
Die Dateien werden im Ordner bereitgestellt, wie in der Einstellung ExportPath angegeben.
Beim Erstellen einer Zip-Datei wird die Struktur der Dokumentdateinamen innerhalb der Zip-Datei über die Einstellung FileName definiert.
Beispiel: {CUSTOMER_NUMBER}
GroupPath
Um die Dokumente zu gruppieren, wird diese Einstellung verwendet, um eine Gruppierung aus einem oder mehreren Indexbegriffen zu erstellen.
Der hier definierte Wert wird an den intern generierten temporären Pfad angehängt, um die jeweiligen Dokumente nach Abschluss des Exports in die vorgesehenen ZIP-Dateien zu packen oder daraus eine zusammengeführte PDF-Datei zu erstellen.
Beispiel: {COMPANY}\{CUSTOMER_NUMBER}
Nach diesem Beispiel werden ZIP-Dateien erstellt, die Dokumente mit demselben Wert in den Indexfeldern COMPANY
und CUSTOMER_NUMBER
enthalten.
Stempel
Wenn der Stempel Felder enthält, die denselben Namen (Bezeichnung) wie die Datenbankfeldnamen der Indexfelder des Dokuments haben, auf das der Stempel angewendet werden soll, werden diese Felder automatisch mit den Indexwerten des entsprechenden Indexfelds gefüllt.
Um die DocuWare-Dokument-ID in einem Stempel zu verwenden, verwenden Sie die Bezeichnung DWDOCID für das Stempelfeld.
Eine Konfiguration ausführen
Sobald die Anwendung vollständig konfiguriert ist, kann die Anwendung gestartet werden.
Führen Sie dazu einfach docXporter.exe aus. Wenn es ohne weitere Parameter ausgeführt wird, werden alle Konfigurationsdateien verarbeitet.
Wenn Sie eine bestimmte Konfiguration nicht verarbeiten möchten, können Sie sie entweder löschen oder umbenennen. Weisen Sie einfach eine andere Dateierweiterung Ihrer Wahl zu, zum Beispiel:
invoices.xml.disable
Es spielt keine Rolle, welche Erweiterung Sie dafür verwenden. Es darf nur nicht ".xml" sein.
Wenn der Aufruf mit dem Parameter docXporter.exe -c "Konfigurationsname"
erfolgt, wird nur die entsprechende Konfiguration verarbeitet. Der Konfigurationsname ist derselbe wie der Dateiname der Konfigurationsdatei ohne deren Erweiterung.
Die Anwendung dokumentiert die einzelnen Verarbeitungsschritte als Ausgabe im Konsolenfenster und in einer Protokolldatei. Es kann hilfreich sein, sich die Programmausgabe genau anzusehen, insbesondere während der ersten Tests.
Um die Verarbeitung oder Ausführung zu automatisieren, kann die docXporter.exe über die "Geplanten Aufgaben" von Windows gemäß den dortigen Möglichkeiten zu verschiedenen Zeiten oder Ereignissen ausgeführt werden.
Erweiterte Befehlszeilenparameter
docXporter kann auch mit Befehlszeilenparametern aufgerufen werden. Hier können Sie alternative Suchkriterien definieren, in verschiedenen Archiven suchen oder Indexwerte auf einen anderen Wert setzen.
Diese Funktion ist in Situationen nützlich, in denen Sie docXporter von Drittanbieteranwendungen aufrufen und dynamisch festlegen möchten, welche Dokumente ausgewählt werden sollen.
-help | Ruft die Hilfeseite auf und führt keine Verarbeitung durch. |
-q “FELDNAME=Wert” | Ein zusätzlicher Suchbegriff, der die Werte aus der Konfigurationsdatei ergänzt oder ersetzt. |
-u “FELDNAME=Wert” | Ein zusätzliches Index-Update, das die Werte aus der Konfigurationsdatei ergänzt oder ersetzt. |
-fc GUID | Die GUID eines Archivs kann hier angegeben werden. Ersetzt die Einstellung der Konfigurationsdatei. |
-sd GUID | Die GUID einer Suchmaske kann hier angegeben werden. Ersetzt die Einstellung der Konfigurationsdatei. |
Die Parameter -q und -u ermöglichen die Angabe mehrerer Felder und Werte. Diese werden durch das Hashtag-Zeichen #
getrennt.
Beispiel: -q “CUSTOMER=Peters Engineering#STATUS=New”
Beispielanwendungsfall
DocXporter wird verwendet, um alle Rechnungen für das aktuelle Quartal zu exportieren, die noch nicht exportiert wurden.
Dies wird in der Konfigurationsdatei angegeben:
<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>DOCUMENT_DATE=SEARCH_QUARTER()</string>
<string>DOCUMENT_TYPE=Invoice</string>
<string>STATUS=NOT Exported</string>
</arrayofstring>
</value>
</setting>
Nun sollen anstelle der Rechnungen die Gutschriften des aktuellen Quartals exportiert werden, bei denen der Kunde „Peters Engineering“ ist. Zusätzlich sollte das Statusfeld auf „Exported“ gesetzt werden.
Die folgenden Parameter werden angegeben:
DocXporter.exe -q “DOCUMENT_TYPE=Invoice#CUSTOMER=Peters Engineering” -u “STATUS=Exported”
Da DOCMENT_DATE in der Konfiguration bereits korrekt eingestellt ist, muss es nicht erneut angegeben werden.
Protokollierung
Alle Programmaktivitäten können in einer Protokolldatei dokumentiert werden. Das Protokollverzeichnis befindet sich unter C:\ProgramData\docXporter\Logs. Standardmäßig wird pro Tag eine Protokolldatei erstellt und 30 Dateien werden gespeichert. Sobald die Anzahl dieser historischen Protokolldateien erreicht ist, wird die älteste Datei gelöscht.
Darüber hinaus werden zunächst nur Informationen und Fehler protokolliert. Wenn mehr Details erforderlich sind - z.B. während der Testphase - kann die Protokollierung auf DEBUG erhöht werden.
Das Detaillierungsgrad der Protokollierung wird auch in docXporter.exe.config festgelegt. Suchen Sie hier nach dem Block und ändern Sie den Text INFO in DEBUG:
<root>
<level value="INFO" />
</root>