DW2WIN

DocuWare for Windows

Reliable document transfer, built for the enterprise desktop.

DW2WIN exports documents from DocuWare to the local file system — run it directly as an executable, from the command line, as a Windows service, or via scheduled tasks.

Get started View commands
Downloads

Get DW2WIN 3.0.0

Download the Windows installer and follow the setup wizard to deploy DW2WIN on your server or workstation.

Latest release

Current stable version of DW2WINSETUP.msi.

Download latest

Archive

Previous versions for legacy environments or rollback.

Browse archive
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 Runtime 9 is required (install via setup.exe if it is not already present).

Setup wizard

The MSI wizard guides you through the following steps:

  1. Terms and conditions — accept the license agreement.
  2. Mode and configuration (1/2) — user / trusted user / credential mode (see Credential modes), password, customer id, and parameter document name.
  3. Configuration (2/2) — impersonated user, organization, and DocuWare server URL.
  4. 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.
  5. Installation directory — choose where DW2WIN files are placed (default: C:\Program Files\itarius\DW2WIN).
  6. Confirmation & install — review choices and start the installation.

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

Wizard inputs

The setup wizard collects the following values, which are stored 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 (see Default task schedule).
INSTALLDIR
Installation directory (default: 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 reference for all options.

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/update the IEF parameter document inside the archive, but it does not create the archive itself.

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.

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.
mandant
Mandant (tenant) identifier. Inserted between the basis folder and the file transfer mappings.
exportBasisFolder
Base folder path for exported files.
fileTransferMappings
Target folder mappings for file transfer.
exportFilterFileTransfer
Filter expression for selecting documents to export.
statusUpdate
DocuWare index field to update after export.
statusUpdateForExport
Status values that mark documents as ready for export.
stamp
Stamp name to apply to exported documents.
layers
Annotation layers to include in the export.
firstSectionOnly
Export only the first section of each document.
keepAnnotations
Preserve annotations on the exported document.

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

Commands

CLI reference

Run DW2WIN help for full CLI reference, or DW2WIN help <command> for details on a single command.

init

Ensures the parameter document/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 (does not overwrite existing values).
  • 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, e.g. 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/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 alternative 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 will run transfers on its configured schedule until stopped. 

DW2WIN start

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

stop

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

DW2WIN stop

Equivalent to sc stop DW2WIN or stopping the service via 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 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/pipe separated).
-x, --configurationPattern=<pattern>
Select configs by wildcard (*, ?) or regex (re:<regex>).
-r, --runconfig=<mode>
How login settings are loaded (default: 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 keypress on exit.

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
Reference

Definitions & 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-is.
(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 directly 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