Dokumentation

Konfiguration, Parameter und Befehle

DW2WIN liest die Anmeldedaten aus der Windows-Registrierung und die Exporteinstellungen aus einem IEF-Parameterdokument in DocuWare. Auf dieser Seite sind alle Felder des Assistenten, alle Parameter und alle Befehle beschrieben.

Installation

Bereitstellung unter Windows

Starten Sie DW2WINSETUP.msi und folgen Sie dem Assistenten. Dienst und Aufgaben lassen sich auch später in einer Eingabeaufforderung mit erhöhten Rechten einrichten. Ab Version 2.4.0 wird die .NET Desktop Runtime 9 benötigt. Fehlt sie, installieren Sie sie mit setup.exe.

Setup-Assistent

Der MSI-Assistent führt Sie durch diese Schritte:

  1. Nutzungsbedingungen — die Lizenzvereinbarung akzeptieren.
  2. Modus und Konfiguration (1/2) — Benutzer, vertrauenswürdiger Benutzer oder Anmeldemodus (siehe Anmeldemodi), Passwort, Kundenkennung und Name des Parameterdokuments.
  3. Konfiguration (2/2) — Benutzer für den Identitätswechsel, Organisation und URL des DocuWare-Servers.
  4. Startart — festlegen, wie DW2WIN ausgeführt wird:
    • Überspringen — es werden nur die Dateien abgelegt. Weder ein Dienst noch eine Aufgabe wird erstellt.
    • Windows-Dienst — registriert den Dienst DW2WIN und zwei Aufgaben der Aufgabenplanung (DW2WIN Start, DW2WIN Stop) unter \itarius\.
    • Geplante Aufgabe — erstellt \itarius\DW2WIN. Die Aufgabe führt DW2WIN.exe --nopause stündlich aus.
  5. Installationsverzeichnis — Ablageort der DW2WIN-Dateien. Voreingestellt ist C:\Program Files\itarius\DW2WIN.
  6. Bestätigung und Installation — die Angaben prüfen und die Installation starten.

Der Dienst wird installiert, aber nicht gestartet. Geplante Aufgaben werden deaktiviert erstellt und müssen manuell aktiviert werden. Siehe Voreingestellter Aufgabenzeitplan.

Felder des Assistenten

Der Assistent schreibt diese Werte in die Windows-Registrierung unter HKLM\Software\itarius\DW2WIN:

FeldBeschreibung
CUSTOMERKundenkennung für die Lizenzierung.
USERDocuWare-Benutzername oder ein besonderer Modus. Siehe Anmeldemodi.
PASSWORDDocuWare-Passwort.
URLURL des DocuWare-Servers.
ORGName der DocuWare-Organisation.
TRUSTEDUSERBenutzer für den Identitätswechsel beim Zugriff auf DocuWare.
DATEINAMEName des IEF-Parameterdokuments in DocuWare.
STARTUPCHOICEAusführung von DW2WIN: Service, ScheduledTask oder Skip.
INSTALLDIRInstallationsverzeichnis. Voreingestellt ist C:\Program Files\itarius\DW2WIN.

Befehle nach der Installation

In einer Eingabeaufforderung mit erhöhten Rechten können Sie die Automatisierung später einrichten oder anpassen:

DW2WIN install-service
DW2WIN install-task
install-service
Registriert den Dienst DW2WIN sowie die Aufgaben zum Starten und Stoppen.
install-task
Erstellt die stündliche geplante Aufgabe.

Initialisierung nach der Installation

Initialisieren Sie danach die IEF-Parametertabelle Ihrer Konfigurationsgruppe:

DW2WIN init --group=DW2WIN.MyCompany

Für neue Konfigurationen ist --group erforderlich. Das Format lautet DW2WIN.<id>. Dabei werden die grundlegenden IEF-Einstellungen im IEF-Archiv angelegt. Die vollständige Liste der Optionen steht beim Befehl init.

Das IEF-Archiv wird nicht automatisch erstellt

Legen Sie das Archiv IEF in DocuWare derzeit selbst an, oder importieren Sie die Definitionsdatei. DW2WIN init erstellt oder aktualisiert danach das Parameterdokument im Archiv. Das Archiv selbst wird dabei nicht angelegt.

Namen und Werte der Parameter sind unter Parameter aufgeführt.

Konfiguration

Parametertabelle

DW2WIN wird über ein Parameterdokument konfiguriert, das im IEF-Archiv in DocuWare liegt. Jede Konfigurationsgruppe (DW2WIN.<id>) enthält die folgenden Einstellungen. Mit DW2WIN init --group=... legen Sie Parameter an oder aktualisieren sie.

Globale Parameter

ParameterBeschreibungErforderlichMehrfach
exportIntervalMinuten zwischen zwei Exportläufen, wenn DW2WIN als Dienst läuft.NeinNein

Läuft DW2WIN als Windows-Dienst, muss exportInterval größer als 0 sein. Der Wert 0 exportiert einmal und beendet das Programm. Das eignet sich nur für eine geplante Aufgabe oder einen manuellen Start.

Gruppenparameter

ParameterBeschreibungErforderlichMehrfach
archiveName des DocuWare-Archivs, aus dem exportiert wird.JaNein
mandantKennung des Mandanten. Sie wird zwischen dem Basisordner und den Ordnerzuordnungen eingefügt.NeinNein
exportBasisFolderBasispfad für die exportierten Dateien.NeinNein
fileTransferMappingsZuordnung der Zielordner für den Dateitransfer.NeinJa
exportFilterFileTransferFilter für die Auswahl der zu exportierenden Dokumente.NeinJa
statusUpdateDocuWare-Indexfeld, das nach dem Export geschrieben wird.NeinNein
statusUpdateForExportStatuswerte, die ein Dokument als exportbereit kennzeichnen.NeinJa
stampName des Stempels, der auf exportierte Dokumente gesetzt wird.NeinNein
layersAnmerkungsebenen, die in den Export aufgenommen werden.NeinNein
firstSectionOnlyExportiert nur den ersten Abschnitt jedes Dokuments.NeinNein
keepAnnotationsExportiert Dokumente als PDF mit Stempeln und Anmerkungen. E-Rechnungen, die über eInvoiceField erkannt werden, behalten ihr Originalformat, sofern forcePDF nicht gesetzt ist.NeinNein
defaultFileTypeDateiformat, wenn keepAnnotations deaktiviert ist (PDF, Auto oder zip). Voreingestellt ist PDF. Für die ältere Gruppe IEF2WIN gilt Auto.NeinNein
eInvoiceFieldDocuWare-Indexfeld für ZUGFeRD- und Factur-X-Rechnungen. Ist das Feld gefüllt, gilt das Dokument als E-Rechnung.NeinNein
forcePDFWandelt E-Rechnungen ebenfalls nach PDF, wenn keepAnnotations aktiv ist. Anmerkungen bleiben erhalten, das eingebettete XML entfällt.NeinNein

Parameter mit mehreren Werten können für dieselbe Gruppe mehrfach in der Tabelle stehen. Neue Gruppen heißen DW2WIN.<id>, zum Beispiel DW2WIN.MyCompany. Die älteren Gruppen DW2WIN, DW2WIN2 und IEF2WIN werden weiterhin unterstützt.

Anmerkungen und E-Rechnungen

Ist keepAnnotations aktiv, exportiert DW2WIN die meisten Dokumente als PDF, damit Stempel und Anmerkungen erhalten bleiben. E-Rechnungen, die über eInvoiceField erkannt werden, bleiben im Originalformat, in der Regel XML, damit die eingebetteten Rechnungsdaten erhalten bleiben. Ist keepAnnotations deaktiviert, gilt stattdessen defaultFileType. XML- und ZIP-Dateien werden immer unverändert exportiert.

Ist zusätzlich forcePDF aktiv, werden auch E-Rechnungen nach PDF gewandelt. Das eingebettete XML entfällt dann. Die Datei ist danach keine ZUGFeRD- oder Factur-X-Rechnung mehr.

Befehle

Befehlsreferenz

Mit DW2WIN help rufen Sie die vollständige Befehlsreferenz auf, mit DW2WIN help <command> die Hilfe zu einem einzelnen Befehl.

init

Stellt sicher, dass Parameterdokument oder Parametertabelle im IEF-Archiv vorhanden sind, und ergänzt fehlende Parameter. Nach einer Neuinstallation oder beim Anlegen einer neuen Konfigurationsgruppe ausführen.

DW2WIN init [-i|--iefdateiname=<name>] [-a|--archive=<fileCabinet>]
DW2WIN init [-i|--iefdateiname=<name>] -g|--group=<group> [-a|--archive=<fileCabinet>] [-f|--force]
  • init (ohne --group) — fehlende Parameter aller vorhandenen Konfigurationsgruppen ergänzen.
  • init --group='<'group'>' — fehlende Parameter dieser Gruppe ergänzen. Vorhandene Werte bleiben unverändert.
  • init --group='<'group'>' --force — die Gruppe vollständig ersetzen. Alle Zeilen der Gruppe werden gelöscht. Vorher wird eine Bestätigung abgefragt (y/N).

Parameter: -g, --group=<group> (für neue Konfigurationen DW2WIN.<id>, zum Beispiel DW2WIN.MyCompany), -a, --archive=<fileCabinet>, -i, --iefdateiname=<name>, -f, --force.

# Neue Konfigurationsgruppe „MyCompany“ für das Archiv „Invoices“ anlegen
DW2WIN init --group=DW2WIN.MyCompany --archive=Invoices

# Vorgaben einer vorhandenen Gruppe neu schreiben (löscht vorhandene Werte und fragt vorher nach)
DW2WIN init --group=DW2WIN.MyCompany --force

# Fehlende Parameter in allen vorhandenen Gruppen ergänzen
DW2WIN init

install-service

Richtet DW2WIN als Windows-Dienst ein und erstellt die Aufgaben zum Starten und Stoppen unter \itarius\. Dafür ist eine Eingabeaufforderung mit erhöhten Rechten erforderlich.

DW2WIN install-service

Starten Sie den Dienst danach mit `DW2WIN start`, oder aktivieren Sie die geplanten Aufgaben für feste Start- und Stoppzeiten. Siehe Voreingestellter Aufgabenzeitplan.

install-task

Erstellt \itarius\DW2WIN als geplante Aufgabe. Sie führt DW2WIN.exe --nopause während der Geschäftszeiten stündlich aus. Geeignet, wenn statt eines dauerhaft laufenden Dienstes eine Aufgabe verwendet werden soll.

DW2WIN install-task

Die Aufgabe wird deaktiviert erstellt. Aktivieren Sie sie in der Aufgabenplanung, sobald sie laufen soll.

uninstall

Entfernt den Windows-Dienst DW2WIN und vorhandene geplante Aufgaben. Die Dateien auf dem Datenträger bleiben erhalten. Dafür ist eine Eingabeaufforderung mit erhöhten Rechten erforderlich.

# Zuerst den Dienst beenden, dann entfernen
DW2WIN stop
DW2WIN uninstall

start

Startet den Windows-Dienst DW2WIN. Danach exportiert der Dienst nach dem konfigurierten Zeitplan, bis er beendet wird.

DW2WIN start

Entspricht sc start DW2WIN oder dem Start in der Dienste-Konsole.

stop

Beendet den Windows-Dienst DW2WIN kontrolliert. Eine laufende Übertragung wird abgeschlossen, bevor der Dienst stoppt.

DW2WIN stop

Entspricht sc stop DW2WIN oder dem Beenden in der Dienste-Konsole.

status

Zeigt den lokalen Installationsstand: Registrierungseinträge ohne Passwort, Dienst, geplante Aufgaben und Abweichungen bei STARTUPCHOICE. Der Dienst wird nicht gestartet und es läuft kein Export.

# Installationsstand anzeigen
DW2WIN status

# Zusätzlich die Verbindung zu DocuWare mit den gespeicherten Anmeldedaten prüfen
DW2WIN status --check

-k, --check meldet sich bei DocuWare an und prüft damit Anmeldedaten und Server-URL.

help

Zeigt die vollständige Befehlsreferenz oder die ausführliche Hilfe zu einem einzelnen Befehl.

# Alle verfügbaren Befehle anzeigen
DW2WIN help

# Ausführliche Hilfe zu einem Befehl anzeigen
DW2WIN help init
DW2WIN help status

Globale Optionen

OptionBeschreibung
-i, --iefdateiname=<name>Wählt das Parameterdokument über DATEINAME aus.
-s, --configurations=<g1,g2>Führt nur die genannten Konfigurationsgruppen aus. Als Trennzeichen dienen Komma, Semikolon oder Pipe.
-x, --configurationPattern=<pattern>Wählt Konfigurationen über Platzhalter (*, ?) oder einen regulären Ausdruck (re:<regex>).
-r, --runconfig=<mode>Legt fest, woher die Anmeldedaten gelesen werden. Voreingestellt ist registry. Zulässig sind registry, test und commandline.
-c, --customer=<customer>Kundenkennung für die Lizenzierung.
-p, --password=<password>DocuWare-Passwort, wenn keine gespeicherten Anmeldedaten verwendet werden.
-n, --nopauseWartet beim Beenden nicht auf einen Tastendruck.
-d, --dwdocid=<id>Exportiert nur das Dokument mit dieser DocuWare-DWDOCID. Die konfigurierten Exportfilter gelten für diesen Lauf nicht.

Jede Option hat eine Langform (--name) und eine Kurzform (-x). Werte geben Sie als --name=value oder als --name value an. Dasselbe gilt für den direkten Aufruf und für den ImagePath des Windows-Dienstes.

"C:\Path\DW2WIN.exe" --runconfig=registry --configurations=DW2WIN.MyCompany
DW2WIN --nopause --dwdocid=12345

Referenz

Begriffe und Voreinstellungen

Anmeldemodi

Das Feld USER im Assistenten akzeptiert besondere Werte. Sie legen fest, wie die DocuWare-Anmeldedaten verarbeitet werden:

WS
Ruft die Anmeldedaten mit der angegebenen Kombination aus CUSTOMER und PASSWORD vom itarius-Server ab und schreibt die aufgelösten Werte in die Registrierung.
KEEP
Vorhandene Registrierungseinträge bleiben unverändert. Aktualisiert werden nur Werte, die Sie ausdrücklich angeben.
Jeder andere Wert
Die eingegebenen Anmeldedaten werden direkt in die Registrierung geschrieben und ersetzen die vorhandenen Einstellungen.

Voreingestellter Aufgabenzeitplan

Diese Zeitpläne sind voreingestellt. Auslöser, Uhrzeiten und Häufigkeit ändern Sie in der Windows-Aufgabenplanung.

AufgabeZeitplan
\itarius\DW2WIN StartMontag bis Freitag um 07:00 Uhr
\itarius\DW2WIN StopMontag bis Freitag um 19:00 Uhr
\itarius\DW2WINStündlich, Montag bis Freitag von 07:00 bis 19:00 Uhr