General tab

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

All text boxes in this tab can contain RRTs.
Option Description
Activate Select this check box to make the component active. If this check box is not selected, the component won't perform any actions during files processing at run time, and all the options of the component will be disabled for configuring.
Communication group
Type In this combo box, select the type of connection to the server. An RRT in this combo box must be replaced by one of the values in the list. There are three possible options:
  • 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.
    To use this type of connection, you should install the DocuWare client on the machine with the component service.

    For a proper operation of the component with windows client you should 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, you should enter the Server address and Organization manually.
    This type of connection has no support for Baskets; hence, the component routs documents only to the cabinets, and the File cabinet text box is mandatory to be filled out.
  • .Net API: This type uses the .NET API for connection to the DocuWare server. When this type is selected, you should enter the Server address and Organization manually.

The .NET API connection type works with DocuWare server 6.5 or higher, and starting with DocuWare server 6.9 it is the only supported connection type.

Organization Enter the name of your organization. This text box is enabled only when Web services communication type is selected. This text box is optional.
Server address In this text box, specify the address of the DocuWare server, to which you want to connect. This text box is enabled only when Web services communication type is selected; it is mandatory to fill out this text box when it is enabled.

The server address may be specified as follows:

server:port

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 following examples provide you with a sample reference of what is acceptable to be entered in this text box:

  • MyDocuware6:9007
  • 192.168.0.15
  • docuware5-sec.domain.com
Pass through Select this check box to make the document(s) available to the subsequent components.
Authentication group
User name Enter the name of the user account that will be used for connection to the DocuWare server.
Password Enter the password for the user account specified in the User name text field.
If User name and Password text fields contain RRTs or invalid data, an error message will appear when you try to open another tab. At this case, the component will switch to off-line regime 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.

Route group
File cabinet Enter the name of the file cabinet where you want to store documents. Or click the browse button (...) to select one of the available file cabinets in the opened Select File Cabinet dialog box.
Basket Enter the name of the basket where you want to store document or click the browse button (...) to select one of the available baskets in the opened Select Basket dialog box.
It is mandatory to fill out either the File cabinet text box or the Basket text box. If you specify the File cabinet only, the component will store document directly in the file cabinet. If you specify the Basket only, the component will store document directly in the basket. If both the File cabinet and the Basket are specified the component will store documents into file cabinet through the basket; that is, the document 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 document in the specified file cabinet for some reason, the document will be saved in the basket which is active on the DocuWare server. This is the DocuWare server peculiarity that depends on the server settings.

If the DocuWare client is not running when you configure the component and you click the browse button (...) to select the File cabinet or the Basket, or switch to another tab from this tab, the DocuWare client will be started 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.
When the component service works on Windows Server 2008 or Windows Vista, the DocuWare client can be started on a separate desktop; therefore, the additional instance of the DocuWare client started by user will not affect the work of the component. When the component service works on Windows Server 2003 or Windows XP, the component will start the DocuWare client on the user's desktop or use the already running instance of the DocuWare client. In this case, you can start an additional instance of the DocuWare client under another user account if it is necessary.