Documentation

Configuration, parameters, and commands

DW2WIN reads login settings from the Windows registry and export settings from an IEF parameter document in DocuWare. This page lists every wizard field, parameter, and command.

Installation

Deploy on Windows

Run DW2WINSETUP.msi and follow the wizard, or configure the service and tasks later from an elevated command prompt. From version 2.4.0 onwards, the .NET Desktop Runtime 9 is required. Install it with setup.exe if it is not already present.

Setup wizard

The MSI wizard guides you through the following steps:

Terms and conditions — accept the license agreement.
Mode and configuration (1/2) — user, trusted user, or credential mode (see Credential modes), password, customer id, and parameter document name.
Configuration (2/2) — impersonated user, organization, and DocuWare server URL.
Startup mode — select how DW2WIN should run:
- Skip — copies files only. No service or task is created.
- Windows service — registers the DW2WIN service and two Task Scheduler tasks (DW2WIN Start, DW2WIN Stop) under \itarius\.
- Scheduled task — creates \itarius\DW2WIN, which runs DW2WIN.exe --nopause hourly.
Installation directory — choose where DW2WIN files are placed. The default is C:\Program Files\itarius\DW2WIN.
Confirmation and install — review the choices and start the installation.

The service is installed but not started. All scheduled tasks are created disabled and must be enabled manually. See Default task schedule.

Wizard inputs

The setup wizard stores these values in the Windows registry under HKLM\Software\itarius\DW2WIN:

Field	Description
`CUSTOMER`	Customer id for licensing.
`USER`	DocuWare username, or a special mode. See Credential modes.
`PASSWORD`	DocuWare password.
`URL`	DocuWare server URL.
`ORG`	DocuWare organization name.
`TRUSTEDUSER`	Impersonated (trusted) user for DocuWare access.
`DATEINAME`	Name of the IEF parameter document in DocuWare.
`STARTUPCHOICE`	How DW2WIN runs: `Service`, `ScheduledTask`, or `Skip`.
`INSTALLDIR`	Installation directory. The default is `C:\Program Files\itarius\DW2WIN`.

Post-install commands

From an elevated prompt you can install or adjust automation later:

DW2WIN install-service
DW2WIN install-task

install-service: Registers the DW2WIN service and the Start/Stop tasks.
install-task: Creates the hourly scheduled task.

First-run initialisation

After installing, initialise the IEF parameter table for your configuration group:

DW2WIN init --group=DW2WIN.MyCompany

The --group argument is required for new configurations. Use the format DW2WIN.<id>. This creates the basic IEF settings in the IEF archive. See the init command for every option.

IEF archive must be created manually

For the time being, you must create the IEF archive in DocuWare manually, or import its definition file. DW2WIN init can then create or update the IEF parameter document inside the archive, but it does not create the archive itself.

Parameter names and values are listed under Parameters.

Configuration

Parameter table

DW2WIN is configured through a parameter document stored in DocuWare (the IEF archive). Each configuration group (DW2WIN.<id>) holds the settings below. Use DW2WIN init --group=... to create or update parameters.

Global parameters

Parameter	Description	Required	Multi
`exportInterval`	Interval in minutes between transfer runs when running as a service.	No	No

When running as a Windows service, exportInterval must be greater than 0. A value of 0 performs a single export and exits, which is only suitable for scheduled-task or on-demand execution.

Group parameters

Parameter	Description	Required	Multi
`archive`	DocuWare file cabinet name to export from.	Yes	No
`mandant`	Mandant (tenant) identifier. Inserted between the basis folder and the file transfer mappings.	No	No
`exportBasisFolder`	Base folder path for exported files.	No	No
`fileTransferMappings`	Target folder mappings for file transfer.	No	Yes
`exportFilterFileTransfer`	Filter expression for selecting documents to export.	No	Yes
`statusUpdate`	DocuWare index field to update after export.	No	No
`statusUpdateForExport`	Status values that mark documents as ready for export.	No	Yes
`stamp`	Stamp name to apply to exported documents.	No	No
`layers`	Annotation layers to include in the export.	No	No
`firstSectionOnly`	Export only the first section of each document.	No	No
`keepAnnotations`	Export documents as PDF with stamps and annotations. E-invoices identified by `eInvoiceField` keep their original file unless `forcePDF` is enabled.	No	No
`defaultFileType`	File format used when `keepAnnotations` is off (`PDF`, `Auto`, or `zip`). Defaults to `PDF`, or `Auto` for the legacy `IEF2WIN` group.	No	No
`eInvoiceField`	DocuWare index field that marks ZUGFeRD / Factur-X e-invoices. A document is treated as an e-invoice when this field is set to anything other than empty.	No	No
`forcePDF`	Also convert e-invoices to PDF when `keepAnnotations` is on. Annotations are kept; the embedded XML is removed.	No	No

Multi-value parameters can have multiple rows in the parameter table for the same group. The group name convention is DW2WIN.<id> (for example DW2WIN.MyCompany). Legacy groups DW2WIN, DW2WIN2, and IEF2WIN are also supported.

Annotation export and e-invoices

If keepAnnotations is on, DW2WIN exports most documents as PDF so stamps and annotations are included. E-invoices identified by eInvoiceField are left in their original format (usually XML) so the embedded invoice data is kept. If keepAnnotations is off, DW2WIN uses defaultFileType instead. XML and ZIP files are always exported as-is.

If you also enable forcePDF, e-invoices are converted to PDF as well. That removes the embedded XML, so the exported file is no longer a ZUGFeRD or Factur-X e-invoice.

Commands

CLI reference

Run DW2WIN help for the full CLI reference, or DW2WIN help <command> for one command.

`init`

Ensures the parameter document or table exists in the IEF archive and appends any missing parameters. Run this after a fresh install or when adding a new configuration group.

DW2WIN init [-i|--iefdateiname=<name>] [-a|--archive=<fileCabinet>]
DW2WIN init [-i|--iefdateiname=<name>] -g|--group=<group> [-a|--archive=<fileCabinet>] [-f|--force]

init (no --group) — append missing parameters for all existing config groups.
init --group='<'group'>' — append missing parameters for that group. Existing values are not overwritten.
init --group='<'group'>' --force — destructive overwrite. Deletes all rows for the group and prompts for confirmation (y/N).

Parameters: -g, --group=<group> (use DW2WIN.<id> for new configs, for example DW2WIN.MyCompany), -a, --archive=<fileCabinet>, -i, --iefdateiname=<name>, -f, --force.

# Create a new config group for "MyCompany" using the "Invoices" file cabinet
DW2WIN init --group=DW2WIN.MyCompany --archive=Invoices

# Re-create defaults for an existing group (destructive, asks for confirmation)
DW2WIN init --group=DW2WIN.MyCompany --force

# Append missing parameters to all existing groups
DW2WIN init

`install-service`

Registers DW2WIN as a Windows service and creates the Start/Stop scheduled tasks under \itarius\. Must be run from an elevated command prompt.

DW2WIN install-service

After installation, start the service with `DW2WIN start` or enable the scheduled tasks to automate start and stop times. See Default task schedule.

`install-task`

Creates \itarius\DW2WIN as a scheduled task that runs DW2WIN.exe --nopause hourly during business hours. Use this when you prefer task-based execution over a long-running service.

DW2WIN install-task

The task is created disabled. Enable it in Task Scheduler when ready.

`uninstall`

Removes the DW2WIN Windows service and any generated scheduled tasks if present. Files on disk are not deleted. Run from an elevated command prompt.

# Stop the service first, then uninstall
DW2WIN stop
DW2WIN uninstall

`start`

Starts the DW2WIN Windows service. The service runs transfers on its configured schedule until stopped.

DW2WIN start

Equivalent to sc start DW2WIN or starting the service in the Services console.

`stop`

Stops the DW2WIN Windows service gracefully. Any in-progress transfer completes before the service exits.

DW2WIN stop

Equivalent to sc stop DW2WIN or stopping the service in the Services console.

`status`

Displays the local install state: registry settings (no password shown), service registration, scheduled tasks, and any STARTUPCHOICE mismatches. Does not start the service or run a transfer.

# Show install state
DW2WIN status

# Also verify DocuWare connectivity using stored registry credentials
DW2WIN status --check

-k, --check attempts a DocuWare login to verify that credentials and the server URL are valid.

`help`

Prints the full CLI reference, or detailed usage for a single command.

# Show all available commands
DW2WIN help

# Get detailed help for a specific command
DW2WIN help init
DW2WIN help status

Global options

Option	Description
`-i, --iefdateiname=<name>`	Selects the parameter document by DATEINAME.
`-s, --configurations=<g1,g2>`	Run only the listed config groups (comma, semicolon, or pipe separated).
`-x, --configurationPattern=<pattern>`	Select configs by wildcard (`*`, `?`) or regex (`re:<regex>`).
`-r, --runconfig=<mode>`	How login settings are loaded. The default is `registry`. Modes: `registry`, `test`, `commandline`.
`-c, --customer=<customer>`	Customer id for licensing.
`-p, --password=<password>`	DocuWare password, when not using stored credentials.
`-n, --nopause`	Do not wait for a keypress on exit.
`-d, --dwdocid=<id>`	Export only the document with this DocuWare DWDOCID. Replaces the configured export filters for that run.

Options use a long form (--name) and a short form (-x). Values may be given as --name=value or --name value. Direct runs and the Windows service ImagePath accept the same arguments.

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

Reference

Definitions and defaults

Credential modes

The USER field in the setup wizard accepts special values that control how DocuWare credentials are handled:

WS: Retrieves credentials from the itarius server using the provided CUSTOMER/PASSWORD combination, then stores the resolved values in the registry.
KEEP: Leaves existing registry settings unchanged. Only explicitly provided values are updated. All others remain as they are.
Any other value: The entered credentials are written directly to the registry, overwriting any existing settings.

Default task schedule

These are the default schedules. You can adjust triggers, times, and frequency in the Windows Task Scheduler.

Task	Schedule
`\itarius\DW2WIN Start`	Monday–Friday at 07:00
`\itarius\DW2WIN Stop`	Monday–Friday at 19:00
`\itarius\DW2WIN`	Hourly, Monday–Friday 07:00–19:00