Is it possible to integrate the DocuWare Web Client with my other applications?
The Web Client has a unique way of integrating with any application by using a special URL which can be used to download, search for or display documents.
The application that you want to integrate with must be able to generate that special URL in the format that DocuWare requires.
The URL Integration is part of the SDK package. Therefore, if you want to have access to those manuals and document-guidelines and gain support at the same time, you have to purchase the SDK package. Please contact your DocuWare partner for more information about the product.
The intention of this article is to show you how to enable URL Integration in the Web Client and how to test it by using a program called URL Creator. The URL creator comes with SDK package.
- You need a web instance created in the DocuWare Administration. The web instance can be configured with Web Client Read Only license if your intention is to retrieve and display documents only.
Please pay special attention to the target directory and the http address. These will be required later during the configuration of your URL in the URL creator.
- Right-click on the web instance and select "Create New Integration"
- Assign any pair of file cabinet and result list which is available in the selected web instance.
Please take note of the identifier you specify since it will be needed it later on.
- Restart the IIS (Internet Information Services)
- Now, please open the URL Creator (UrlCreator.exe) tool in order to test whether the Web Client Integration settings are accessible. This URL Creator is part of the SDK package.
The FAQ article will only cover a very basic configuration, so please refer to the manual which comes with the SDK package for a detailed list of all parameters and options.
- DocuWare URL Creator – URL Type tab
- DocuWare URL Creator – Common Parameters tab
1 = This is typically the name of the server on which the Web Client is running, but it could possibly also be a custom URL (e.g.: www.domainname.com). This can be checked (and defined) in the the DocuWare Administration by navigating to "System -> Web Connections" -> "Internal Address"
2 = This is the name of the target directory (see step 1).
3 = Based on how the Web Client is configured, you can either have the URL use Windows authentication or specify a DocuWare user whose credentials will be used.
4 = For improved security, you can choose to use a passphrase which has to be set in the DocuWare Administration first (see step 1).
- DocuWare URL Creator – Integration Parameters tab
1 = This is the identifier you defined in step 3
2 = Select the integration type of the URL.
3 = This is the GUID of the result list which will be used. Access the desired result list in the DocuWare Administration to see its GUID. Please make sure that users accessing this integration have access to this dialog.
5 = This is the query which will be executed by the integration. The necessary syntax is explained in the manual.
- DocuWare URL Creator – Other Parameters tab
- Generate the URL with the corresponding button and open it afterwards in order to test it.
This is the general syntax which your application has to follow when generating your URL.
The URL Creator in of itself is just a tool to demonstrate to possibilities of URL integration and to test the server side settings, which you should always do before you starting building your custom URL.
You can also use this tool to parse the URL which you have created in your application in order to check its configuration.
If more than one document is returned, then you will be presented with the result list you defined in your URL integration. Otherwise, the document will be opened directly (albeit with the settings of the result list).
Once in the result list, you can open a document and most of the viewers functions will be available. This may differ based on what kind of web instance you used as a basis for the integration (regular or read-only)