DocuWare

The following information details the connectivity and functionality offered by the EzeScan integration with the DocuWare EDRMS solution. It details the available options and how to configure an EzeScan job into DocuWare.

For information on DocuWare please refer to the DocuWare website - https://start.docuware.com/

For information on EzeScan please refer to the EzeScan website - https://ezescan.com.au

Requirements

• DocuWare On-Premise version 6.5 or higher with Platform Services enabled

• DocuWare Cloud

Support of the GAPI interface has been discontinued.

It is assumed that the operator has read about or is familiar with EzeScan Job, KFI and UPLOAD modules. If not please refer to the EzeScan PRO, KFI and UPLOAD guides. It is also assumed that the operator is experienced with the DocuWare product.

Configuring Connection Settings

When configuring a Job, KFI or Upload to use the DocuWare connector the connection settings must be completed. It is recommended this be done using a global connection profile.

Create a Connection Profile

1. Click the Admin menu, choose Workstation Options.

2. Click the Connection Profiles tab.

3. Add a new profile and give it a name

4. Select Connect to DocuWare (Platform Services).

5. Enter the following information:

Option	Description
Service URL	Specify the URL of the service (i.e. http://dwserver/DocuWare/Platform).
Organisation	Specify the name of the organisation licensed to the DocuWare Server.
Authentication Method	Specify the authentication method to use: DocuWare OpenID Connect Windows As of DocuWare 7.11 and later, OpenID Connect is the only supported authentication method.

OpenID Connect Authentication

OpenID Connect uses the Authorization Code flow to sign users in via the DocuWare authorization page.

This authentication method requires an App Registration to be configured in DocuWare Configuration → Integrations → App Registrations.

App Registration Requirements

The App Registration must:

• Use the Authorization Code grant type

• Allow access to the Platform API resource

OpenID Connect Settings

Option	Description
Authorisation Endpoint	The authorisation endpoint URL from the app registration.
Token Endpoint	The token endpoint URL from the app registration.
Client ID	The Application ID from the app registration.
Client Secret	The client secret configured in the app registration. This client secret must be replaced before its expiration date. Authentication will fail once the secret expires.
Scopes	Enter the scopes defined in the app registration. Use a single space as the delimiter between scopes.
Desktop Redirect URL	The redirect URI specifies where users are returned after completing sign‑in. EzeScan Desktop http://localhost:5000/ EzeScan Server http://localhost:32392/api/integrations/oAuthCallback Where localhost:32392 is the public address and port This Redirect URI must be added to the app registration exactly as configured in EzeScan. Any mismatch will cause the OAuth sign‑in process to fail.

DocuWare Authentication

Authenticates using a dedicated DocuWare user account.

Windows Authentication

Uses the credentials of the current Windows session.

No additional configuration is required when using Windows Authentication.

KFI Field Settings

The KFI Field Settings allow the operator to browse into DocuWare during KFI indexing so the operator choose values from File Cabinet Select Lists to be applied to the document.

The following functionality requires that the EzeScan workstation be licensed for the EDRMS as well as KFI and UPLOAD modules.

Enabling browse options

The DocuWare settings must be configured before a KFI field can use the DocuWare browse functionality.

1. Press F7 to display the KFI form.

2. Click the EDRMS tab.

3. If using the global connection settings from the Workstation Options, tick the Use Global Connection Settings box; otherwise fill in the Connection settings.

   

4. Click the Fields tab.

5. To enable a field to access DocuWare you need to:

   1. Click the edit link under Properties for the field.

   2. Click the DocuWare tab.

   3. Tick the Enable DocuWare Browse Button box.

   4. The browse parameters will become active.

      

      See next section for details on configuring these parameters.

   5. Click OK.

Configuring browse parameters

Browse Mode

This option determines the type of DocuWare Browser that is shown when the Browse button (F3) is pressed during indexing.

Choose from one of the following five options:

File Cabinet

Specify the File Cabinet to be used for the Field selection lookup. To browse a list click into the value cell and then click on the … button that appears.

File Cabinet Dialog

Specify the File Cabinet dialog to use for the display the Field selection lookup. To browse a list click into the value cell and then click on the … button that appears.

File Cabinet Field

Specify the File Cabinet field to be used for displaying the Select List. To browse a list click into the value cell and then click on the … button that appears.

Upload Settings

The UPLOAD module will obtain the KFI output data to pass into DocuWare saving the document into the respective File Cabinet and applying metadata information.

The following functionality requires that the EzeScan Workstation be licensed for the EDRMS and KFI and UPLOAD modules.

Configuring connection parameters

1. Open the Upload Form (F8).

2. Choose the Upload Type you want to configure.

3. On the left hand side in the Upload Properties pane choose DocuWare in the Upload To list.

4. If using the global connection settings from the Workstation Options. Tick the Use Global Connection Settings option; otherwise fill in the Connection settings.

   

Configuring built-in upload fields

The following fields will appear after choosing Upload To DocuWare option in the Upload Properties pane. These are the default DocuWare fields.

Each field can have its input set using the Source Field cell, noting that the FileCabinet field can’t be set to ignore.

Target Field	Description
File Cabinet	This is the DocuWare File Cabinet that the documents will be saved into. To browse for the File Cabinets set the Source Field to static and a ... button will appear for the Field Value. Click this and select your respective File Cabinet.
Auto Populate (button)	Once the File Cabinet is specified, click the Auto Populate buttonOnce the File Cabinet is specified, click the Auto Populate button. This will return all the available fields for the selected cabinet. The operator can then set the source fields from the KFI output fields. This will also return all system fields. If the status field is set to “New” this will trigger the workflow (applied on the cabinet level) when a new document is uploaded.
Custom Fields	The DocuWare Upload connector currently supports the field types –Date, Number, and Text. When processing these custom field types, excluding type Text, the connector will use the current workstations Region and Language settings (in Control Panel) to validate the data. If the data cannot be validated the Upload will fail and an error message will appear. To bypass the validation process simply set the upload field’s type to Text.To bypass the validation process simply set the upload field’s type to Text.

Configuring custom file cabinet fields

After selecting the File Cabinet that the uploaded document will be assigned to (FileCabinet Field), click the Auto Populate button at the bottom of the screen.

This will result in the DocuWare connector returning a list of custom fields that relate to that
FileCabinet.

It is then a matter of setting the source values of those fields to the target values of the custom fields.

The Auto Populate button appears under the Field Mappings grid.

Applying KFI output data to target field data

To pass through the KFI output data into the Upload module the operator is required to set the source field data to the target field data.

1. In the Upload type, set the Column names from option to the name of the KFI job Type.

   

2. In the Field Mappings Grid the operator can apply the Source Field settings to the Target Field settings.

3. When all the mappings are complete, click Apply.

4. Click OK to save the changes.