Document Tool

The Document Tool is a command line tool for executing certain document related workflows. It provides two processes:

Index Restore

If you have the checkbox Backup index data to storage location enabled for a file cabinet, all index entries, annotations, stamps, etc. are backed up next to the stored documents. You can restore this information to the database from there. For the restore operation to work, the database structure must be present. If the database structure has been lost, you can restore it either from the database backup or by creating a new file cabinet with an identical structure.

Avoid using Index Restore for synchronized file cabinets. Under certain circumstances, there will be duplicated documents in the synchronized file cabinets. For more information, please contact your DocuWare partner or support

Migration

Migrate documents within a file cabinet from one disk to another disk. This is done to reduce disk sizes within a file cabinet or to combine disks. Furthermore, documents can be moved to a disk which is marked as Read-Only or uses a different storage location.

Notes on both processes:

The known file cabinet feature Encrypt documents can only be applied to documents that are stored from the point they are encrypted. With Document Tool, existing documents can now also be encrypted.
Document Tool can only restore or migrate documents with a DWX or XML header.
Restoring or migrating an XML header will not work in a newly created file cabinet. For this purpose, you need a correctly updated DocuWare file cabinet with legacy tables (V5 tables).

The DocumentTool.exe is a standard console application controlled by command line parameters.

It is located

until DocuWare v7.10: in the Background Process Service folder of your DocuWare installation:
…\DocuWare\Background Process Service\
from DocuWare version 7.11 and later: in the Powertools folder of your DocuWare installation:
…\DocuWare\PowerTools\DocumentTool

Command Line Parameters

Following parameters are available

Parameter	Description
filename	Name of XML settings file needed for the job	required
jobtype	Type of the job; 0 = Index Restore, 1 = Migration; 2 = Encrypt	required
username	DocuWare username under which credentials the job will be executed. The user needs to be the file cabinet owner	required
password	Password of the user	required
orgaguid	GUID of the organization, e.g. d439603c-9a3a-40ae-8e8d-a404f61dd1c3. It is necessary if there is more than one organization	optional

Sample commands

Tip: Add a task to the Windows Task Scheduler, to run the Document Tool scheduled.

Index Restore:

until DocuWare version 7.10
"C:\Program Files\DocuWare\Background Process Service\DocumentTool.exe" -filename=MyRestoreSettings.xml -jobtype=0 -username="admin" -password="Pa$$w0rd"
from DocuWare version 7.11 and later
"C:\Program Files\DocuWare\PowerTools\DocumentTool\DocumentTool.exe" -filename=MyRestoreSettings.xml -jobtype=0 -username="admin" -password="Pa$$w0rd"

Migration:

until DocuWare version 7.10
"C:\Program Files\DocuWare\Background Process Service\DocumentTool.exe" -filename=MyMigrationSettings.xml -jobtype=1 -username="admin" -password="Pa$$w0rd"
from DocuWare version 7.11 and later
"C:\Program Files\DocuWare\PowerTools\DocumentTool\DocumentTool.exe" -filename=MyMigrationSettings.xml -jobtype=1 -

Note: Running the Document Tool generates a Output_[…].txt log file, which contains detailed error messages and all other info about the run.

Settings File

The settings file is necessary to configure the parameter and settings of the job.

Settings parameters

Parameter	Description
fileCabinetGuid	GUID of the target file cabinet	required
destinationDiskNumber	Target disk number	required for migration
DocumentsFilter	Filter conditions for the documents on the storage location	optional

You can filter by following criteria:

fromStorageDateTime and toStorageDateTime
Time period when the document was stored.
The local time zone, where the Document Tool is started, is used.
fromModificationDateTime and toModificationDateTime
Time period when the document was last modifed.
The local time zone, where the Document Tool is started, is used.
fromDocID and toDocID
Unique DocID of the document
DiskNumber
Disk number where the document is stored

Sample settings files

Sample Settings File for Index Restore

You’ll find a sample for the restore settings here:

until DocuWare version 7.10: "…\DocuWare\Background Process Service\DocumentTool.SampleRestoreSettings.xml"

from DocuWare version 7.11 and later: …\DocuWare\PowerTools\DocumentTool\DocumentTool.SampleRestoreSettings.xml"

Restore all document index data of a file cabinet

</DocumentsFilter>

</BatchDocumentSettings>

With these settings the job will restore all documents of file cabinet with GUID e3dcc667-3bb3-46fd-9b23-395bd28a0f52.

Restore a specific set of document index data of a file cabinet

<System.Int32>2</System.Int32>

<System.Int32>3</System.Int32>

</DiskNumbers>

</DocumentsFilter>

</BatchDocumentSettings>

With these settings the job will restore the index data of all documents of file cabinet with GUID e3dcc667-3bb3-46fd-9b23-395bd28a0f52, that...

are currently stored on disk number 2 or 3 and
have been modified between 12th June 2017 05:54:27 and 12th June 2018 05:54:27 and
have been stored between 12th June 2017 05:54:27 and 12th June 2018 05:54:27 and
have a DocID between 0 and 1500

Sample Settings File for Migration

The settings for migration are the same as for restore. There is just one additional setting which needs to be specified: destinationDiskNumber

You’ll find a sample for the migration settings here:

until DocuWare version 7.10: "…\DocuWare\Background Process Service\DocumentTool.SampleMigrationSettings.xml"

until DocuWare version 7.11: "…\DocuWare\PowerTools\DocumentTool\DocumentTool.SampleMigrationSettings.xml"

Migrate all documents of a file cabinet to a disk

</DocumentsFilter>

</BatchDocumentSettings>

With these settings the job will migrate all documents of file cabinet with GUID e3dcc667-3bb3-46fd-9b23-395bd28a0f52 (stored on another disk number than 1) to disk number 1.

Migrate a specific set of documents of a file cabinet to a disk

<System.Int32>2</System.Int32>

<System.Int32>3</System.Int32>

</DiskNumbers>

</DocumentsFilter>

</BatchDocumentSettings>

With these settings the job will migrate all documents of file cabinet with GUID e3dcc667-3bb3-46fd-9b23-395bd28a0f52 to disk number 1, that…

are currently stored on disk number 2 or 3 and
have been modified between 12th June 2017 05:54:27 and 12th June 2018 05:54:27 and
have been stored between 12th June 2017 05:54:27 and 12th June 2018 05:54:27 and
have a DocID between 0 and 1500

Sample Settings File for Encryption

You’ll find a sample for the restore settings here:

until DocuWare version 7.10: "…\DocuWare\Background Process Service\DocumentTool.SampleRestoreSettings.xml"

from DocuWare version 7.11 and later: "…\DocuWare\PowerTools\DocumentTool\DocumentTool.SampleRestoreSettings.xml"

Restore all document index data of a file cabinet

</DocumentsFilter>

</BatchDocumentSettings>

With these settings the job will encrypt all documents of file cabinet with GUID e3dcc667-3bb3-46fd-9b23-395bd28a0f52.

Encrypt existing documents of a file cabinet

<System.Int32>2</System.Int32>

<System.Int32>3</System.Int32>

</DiskNumbers>

</DocumentsFilter>

</BatchDocumentSettings>

With these settings the job will encrypt the documents of file cabinet with GUID e3dcc667-3bb3-46fd-9b23-395bd28a0f52, that

are currently stored on disk number 2 or 3 and
have been modified between 12th June 2017 05:54:27 and 12th June 2018 05:54:27 and
have been stored between 12th June 2017 05:54:27 and 12th June 2018 05:54:27 and
have a DocID between 0 and 1500