› AutoStore › Route Components › DocuWare › Configuring the DocuWare component › General tab

General tab

Use this tab to configure general connection parameters for logging in to the DocuWare server and specify the destination of the routed document.

All text boxes on this tab can contain RRTs.
Option Description
Activate Select this checkbox to make the component active. If this checkbox is not selected, the component won't perform any actions during files processing at runtime, and all options of the component will be disabled for configuring.
Pass through Select this checkbox to make documents available to the subsequent components.
Communication group
Type Select the type of connection to the server. An RRT in this box must be replaced by one of the values in the list.
  • .Net API OAuth2: This type uses a .NET API that has been secured using the standard OAuth 2.0 delegated authorization protocol for connection to the DocuWare server. When this type is selected, you must select Access mode from the list and enter the Organization and Server address manually.
  • .Net API: This type uses the .NET API for connection to the DocuWare server. When this type is selected, enter the Organization and Server address manually. The .NET API connection type works with DocuWare server 6.5 or higher.
  • Windows client: This type uses the desktop DocuWare client for connection to the DocuWare server. When this type is selected, the Organization and Server address text boxes are disabled, because this information is stored in the client. Starting with DocuWare server 6.9, the Windows client connection type is no longer supported.
    To use this type of connection, install the DocuWare client on the machine with the component service.

    For proper operation of the component with Windows client, switch on the Allow service to interact with desktop option in the workflow service properties and start the Interactive services detection service in the Windows administrative tools.

  • Web services: This type uses DocuWare web services for connection to the DocuWare server. When this type is selected, enter the Organization and Server address manually. Starting with DocuWare server 6.9, the Windows client connection type is no longer supported.
    This type of connection has no support for Baskets; therefore, the component routes documents only to the cabinets, and the File cabinet text box is mandatory to be filled out.
Access mode Select an Access mode value when the .NET API OAuth2 communication type is selected. There are two possible options:
  • Password credentials: Use this access mode when the connector authenticates with a username and password taken from the DocuWare user identification system. When this access mode is selected, enter the User name, Password, Client ID, and Token Endpoint in the Authentication group.
  • Token Vault-based: When Token Vault-based access mode is selected, a properly configured Token Vault authorization is needed. Enter the Token Vault user, Token Vault URL, and Provider ID in the Authentication group.
Organization Enter the name of your organization. This text box is optional.
Server address Specify the address of the DocuWare server to which you want to connect. You must complete this text box when it is enabled.

The server address may be specified as follows:

server:port/Docuware/Platform

Where:
  • server is a name of a machine where the DocuWare server is hosted, or its IP address. The machine name may be specified with or without its domain.
  • port is a port number used by the server for communications with its clients. The default port number is 9007. The port number can be omitted; in this case the default port number will be used.
  • The Server address must contain the /Docuware/Platform postfix.

The following examples provide a sample reference of what is acceptable to be entered in this text box:

  • MyDocuware6:9007/Docuware/Platform
  • 192.168.0.15
  • docuware5-sec.domain.com
Authentication group
User name If you select Password credentials access mode, enter the name of the user account that will be used for connection to the DocuWare server. This must be a valid DocuWare username that follows DocuWare username rules.
Password If you select Password credentials access mode, enter the password for the user account specified in the User name box. This is the password associated with the specified DocuWare username, used for authentication via username/password login.
If User name and Password boxes contain RRTs or invalid data, an error message will appear when you try to open another tab. In this case, the component will switch to offline mode and will not check the connection to the server.

This field supports and returns values for encrypted by restricted RRTs. For more information, see Encrypted Field RRTs.
Client ID If you select Password credentials access mode, enter the DocuWare server Client ID value. This identifies the application requesting authentication from the DocuWare identity service.
Token Endpoint If you select Password credentials access mode, enter the DocuWare server Token Endpoint value. This is the OAuth 2.0 endpoint used to request the access token, and it must match the DocuWare identity issuer URL to avoid authority mismatch errors.
Token Vault user If you select Token Vault-based access mode, the component can upload documents on behalf of the signed-in user specified in this box.
Token Vault URL If you select Token Vault-based access mode, enter the fully qualified Token Vault URL with port number.
Provider ID If you select Token Vault-based access mode, enter the ID of the authorization provider that was set up in Token Vault to work with this AutoStore component.
Route group
File cabinet Enter the name of the file cabinet where you want to store documents. Or select the browse button (...) to select one of the available file cabinets in the Select File Cabinet dialog box.
Basket Enter the name of the basket where you want to store documents or select the browse button (...) to select one of the available baskets in the Select Basket dialog box.

You must complete either the File cabinet text box or the Basket text box. If you specify the File cabinet only, the component will store documents directly in the file cabinet. If you specify the Basket only, the component will store documents directly in the basket. If both the File cabinet and the Basket are specified, the component will store documents in the file cabinet through the basket; that is, the documents will be stored both in the file cabinet and in the basket.

If you specify the File cabinet only, and the component fails to save the documents in the specified file cabinet for some reason, the documents will be saved in the basket that is active on the DocuWare server. This is DocuWare server behavior that depends on the server settings.

  • If the DocuWare client is not running when you configure the component and you select the browse button (...) to select the File cabinet or the Basket, or switch to another tab from this tab, the DocuWare client will start automatically. If the DocuWare client is running under another user account, the component will restart the DocuWare client using the specified User name and Password.

  • The DocuWare client can start on a separate desktop; therefore additional instances of the DocuWare client started by a user do not affect the work of the component.