Configure docXporter

As the syntax used in an XML file has reserved some characters, these must be rewritten in order to save them in the file. The following table shows the most common characters that need to be rewritten. Problems occur particularly frequently because the ampersand character is not rewritten.

Classic examples are DocuWare organization names for company forms such as GmbH & Co KG or when SQL queries with greater than/less than conditions.

Problems can also occur if characters outside the ASCII character space are used. Examples of this are é, à etc.

Such characters must also be replaced by corresponding substitute characters. An Internet search for “Unicode character table” brings up the following page, for example https://www.utf8-zeichentabelle.de/unicode-utf8-table.pl?names=-&unicodeinhtml=hex

According to this, for example, the character é is replaced by é or à by à. It is of course also possible to use the respective hexadecimal notation.

URL to DocuWare Platform Services

Example: https://DOCUWARESERVER/DocuWare/Platform

Replace the DOCUWARESERVER value with the same server name as for the DocuWare Web Client

User name of the DocuWare user which the application uses to log on to DocuWare.

If this parameter is left blank, the application attempts to log in via Windows authentication with the user with whom the application was started.

Password of the DocuWare user which the application uses to log on to DocuWare.

Password must be encrypted via the provided EncryptionTool. You will find a shortcut within the configuration files folder.

The DocuWare organization to which the application is registered.

GUID of the DocuWare file cabinet from which the documents are exported. The GUID can be found in the DocuWare Configuration in the general settings of the file cabinet.

GUID of the search dialog that is used to compile the documents for export. The GUID can be found in the DocuWare configuration in the file cabinet dialogs.

Activate or deactivate the option to place the stamp on the exported document.
Valid values are True = active, False = not active.

Note further information about stamps below.

This switch is ignored if EnableStamps has the value False.

Decide whether

• the stamp is set before the document is exported and is therefore included in the exported documents (if annotations are to be exported via the ExportMode)

• or after the document has been exported.

Valid values are

• True = Stamp before export

• False = Stamp after export

Designates the annotation level where the stamp is applied. By default, this setting has the value 1.

Position in pixels, starting at the left edge of the document, where the stamp is placed.

For automatic positioning of the stamp, -1 must be entered here.

Position in pixels, starting at the top of the document, where the stamp is placed.

For automatic positioning of the stamp, -1 must be entered here.

Name of the stamp that is applied to the document during export.

Valid values are DocuWare and SQL.

Specify the format in which documents will be saved in the file system after export. Take into account upper and lower case.

Define which part of the document is to be exported.

The index of the section to be exported. For this setting to be used, the value must be set to SectionIndex in the ExportCoverage setting.

Defines the folder to which the documents are to be exported. Example: C:\Export\ (UNC path is possible). If the folder does not exist, it is created. Index values of the document can also be used here by specifying the field name in curly brackets, e.g. {COMPANY}. As with the other settings, the field name is specified according to the database name of the DocuWare field.

Example: C:\Export\{COMPANY}\

The ExportPath may also contain parts of a DocuWare date field, for example the month or year. After specifying the field name, the .net-compliant date formatting is specified with a colon, e.g. {DATE:MMMM} for the full month name, or {DATE:yy} for a two-digit year.

If both month and year are used in an export path, the information is entered in one.

Example: C:\Export\{DATE:yyyy}\{DATE:MMMM}\{COMPANY}\

Result: C:\Export\2021\January\Peters Engineering\

Defines the structure of the file name of the exported file. Both fixed values and index values of the document can be used for this. In the case of index values, the field name is specified in curly brackets, e.g. {COMPANY} or {DWDOCID}. As with the other settings, the field name is specified according to the database name of the DocuWare field. The files are exported as PDF files by default.

Use a unique file name to prevent accidental overwriting. Under certain circumstances, different documents can be given the same file name during export, namely if both documents contain the same value in the index fields from which the file name is built. In this case, the document that has already been exported will be overwritten.

This applies in particular to the MergedPdf export target.

Specify the compression for saving the Tiff files. Influence the quality and file size. The following values are available:

• JPEG: Recommended for color documents and documents with greyscale

• CcittGroup4: Recommended for black and white documents

Specify the resolution of the Tiff. The higher the value, the better the quality may be, but the file size will potentially increase with high values.

Contains the index values that are to be changed after the export to exclude exported documents from the export filter. The configuration works basically the same as for DWArchivFilter.

The general syntax of the DWArchivUpdateIndex Setting looks like this. For each DocuWare field another Item row needs to be added.

<Object Name="DWArchivUpdateIndex" Type="Docuscan.DocuwareExporter.Configuration.FieldMapping">
  <Item Name="STATUS" Value="Exported" />
</Object>

The value of the name attribute corresponds to the database name of the DocuWare field in capital letters (can be found in DocuWare Configuration of the field properties of the respective field). Sometimes these also contain if special characters were used when creating the field. These must also be entered, for example: Name=”COMPANY”

Example: <Item Name=“EXPORTED_” Value=“done” />. Value is either a fixed value or a relative date such as DATE(-1) for the date of the previous day.

Controls whether an index file is to be created for a document and how it is created. Upper/lower case must be observed.

Defines the structure of the file name of the exported file. Both fixed values and index values of the document can be used for this. In contrast to the FileName setting (see above), the file extension must be specified here.

The path to the template file. If only the file name is specified, the template is searched for in the folder C:\ProgramData\docXporter\Templates. If a path is specified, this is used directly.

Controls whether the export is made to a ZIP file or a file system folder.

Specify the pattern from which the file name for the output file is to be created here.

It is not necessary to specify the file extension here as this is assigned automatically. Depending on which export target was selected, the extension is .zip or .pdf

The files are provided in the folder as specified in the ExportPath setting.

When creating a zip file, the structure of the document file names within the zip file is defined via the FileName setting.

Example: {CUSTOMER_NUMBER}

In order to group the documents, this setting is used to create a grouping from one or more index terms.

The value defined here is appended to the internally generated temp path in order to pack the respective documents into the intended ZIP files when the export is completed or to generate a merge PDF from these files.

Example: {COMPANY}\{CUSTOMER_NUMBER} following this example, ZIP files are created that contain documents with the same value in the COMPANY and CUSTOMER_NUMBER index fields.

DocXporter is used to export all invoices for the current quarter that have not yet been exported.

This is specified in the configuration file:

<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>

Now, instead of the invoices, the credit notes of the current quarter are to be exported, where the customer is “Peters Engineering”. In addition, the Status field should be set to “Exported”.

The following parameters are specified:

DocXporter.exe -q “DOCUMENT_TYPE=Invoice#CUSTOMER=Peters Engineering” -u “STATUS=Exported”

As DOCMENT_DATE has already been set correctly in the configuration, it does not need to be specified again.