DocuWare URL Creator is a wizard, which creates an URL Integration in four steps. URL Creator adds the parameters, does the Base64-Coding and encrypts, the URL automatically, if desired.
The URL creator is part of the DocuWare Desktop Apps and can be downloaded like all other Client Apps from the DocuWare Client (Main menu > Install Desktop Apps).
Select URL type
Select WebClient Integration URL to create a URL intgeration for a DocuWare element.
WebClient Login URL creates a link to the Web Client, not to a singular element.
Parse URL analyzes the parameter of an existing URL integration and displays the related elements. Wrong parameters can be found easily and corrected.
Enter DocuWare connection
Scheme
Please enter the connection to the server (http or https).
Server Name
Here the path to the current organization is written: <your_servername>/<DocuWare>/<Platform>/WebClient
You find the path in the DocuWare Administration > System > Web connections
Organization GUID
With DocuWare version 7.1 the URLs generated by DocuWare contain the organization GUID instead of the organization ID. Existing URLs with the ID will work without changes also after the update.
Cloud customers can create an integration URL without any OrgGUID or specifying name, because the organization is encoded in the base address of the URL. The same applies for users of DocuWare on-premises when the system has only one organization. Only when a DocuWare system has more than one organization, an identifier is needed.
You find the organisation GUID in the DocuWare Administration > Organization > General
Encryption
Use Passphrase
To encrypt the integration URL, please enter the passphrase, which is entered in Administration > Organisation > General > Web Access - see also the screenshot above. With User random noise... the URL will be further encrypted.
Authentification
If there is no entry in this area, the user has to enter the DocuWare login to access DocuWare.
Include Credentials in URL
If a DocuWare login is entered here, the user can access the search dialog, result list or another element of DocuWare without typing the credentials.
Attempt Single Sign-On
The integration link authenticates the user using the identity provider as defined in the Organization settings.
Other Parameters
Specify the period, in which the URL is valid. If there is no entry the URL is valid infinitely.
Integration Type
In this tab the parameters are configured which call up elements of DocuWare like archived documents, result lists etc. Depending of the integration type there are different fields to be filled.
Viewer
This integration type can show automatically a document in the DocuWare Viewer. Customer have for example the possibility to read the latest price list.
Copy the GUID of a result list which finds the requested document. Enter this GUID in the field Resultlist Dialog guid. Even if the result list is not shown the search for the document is executed in the background.
This integration type displays only a single document.
Learn how to find the GUIDs At a glance: IDs of the DocuWare elements.
Result List
With the integration type Result List and Viewer you can integrate result lists and lists of DocuWare Task Manager. A list of Task Manger for example provides the employee with the invoices to be approved at a glance.
Copy the GUID of the requested list in the field Resultlist Dialog guid and the document ID in the field DWDOCID.
Adding the search dialog parameter sed makes sure that the result list is delivered as in the web client – with every field restriction.
Learn how to find the GUIDs At a glance: IDs of the DocuWare elements
Notes:
A result list with a folder structure is not supported.
All fields queried will become part of the integration URL. If this URL gets too long, opening it will cause the browser to show an error. In this case shorten the query or use a Search, Result List and Viewer integration slrv.
Query with numeric fields
Please enter decimal points if you use decimal values in numeric fields. With a decimal point the query is culture independent an can be used with different culture settings.
Search
First you copy the GUID of the requested search dialog in the field Search Dialog guid. As a result list is assigned to each search dialog it is also used for the integration. Learn how to find the GUIDs At a glance: IDs of the DocuWare elements
Then you have the possibility to restrain the search results. Assumed the user will probably make a find in a certain department, tick the option Dialog Values and enter for example [DEPARTMENT]=Export. This field of the search dialog is prefilled with "Export". In case that the prefilling of the field does not fit the user can change or delete this entry at any time.
The field name has to be entered in square brackets. As field name please enter the database name of the field. Various fields can be combined with the &-symbol: "[FieldName1]=fieldValue1&[FieldName2]=fieldValue2".
Note: With a URL integration the results of a fulltext search will not be highlighted with colour in the DocuWare viewer.
Download
A download integration creates a link which downloads the document directly when clicked.
This integration type loads one single document.
Learn how to find the GUIDs At a glance: IDs of the DocuWare elements
Document History
With this integration type all previous versions of a document are shown beside the latest one.
Enter the file cabinet GUID and the document ID.
This integration type refers to one single document.
Learn how to find the GUIDs At a glance: IDs of the DocuWare elements
Workflow Task
With the Workflow Manager installed there is a task list displayed in the Web Client containing the tasks to be fulfilled by an employee. Workflow Task integrates a single task in for example an accounting software. With some additional programming work the document assigned to the task will be opened in third party application.
You will find both IDs in the Platform Service under Organization > Workflow.
Workflow Task List
Different task lists are displayed for users with the role "desginer" or "controller". "Designer" is here the simple user who sees only the own tasks. The task list of a controller includes all not executed tasks, among others. Workflow Task List calls up these tasks lists in a third party application.
Specify the task list with the role "Designer" for the user or "Controller". The "Workflow-ID" defines the workflow configuration.More information in the help manual of the Workflow Manager.
Index Dialog
With this integration type only the Index dialog (info dialog) related to a document is displayed. This is useful, if for example the user of an ERP software only wants to check some index info of a archived document, but not open it.
File cabinet GUID is not mandatory. If you leave this field empty the info dialog is searched in all file cabinets. Loading can take longer in this case.
This integration type displays the index dialog of a single document.
Learn how to find the GUIDs At a glance: IDs of the DocuWare elements
Document Tray
A tray integration provides your colleagues with the full functionality of a document tray.
You find the ID of the document tray in the DocuWare Configuration
Learn how to find the GUIDs At a glance: IDs of the DocuWare elements
Document Relation
You create a document relation (document link) in the DocuWare Configuration.
Find the document relation in the Platform Service. Enter in the field File Cabinet GUID the GUI of the file cabinet which contains document related to the link (source file cabinet).
Learn how to find the GUIDs At a glance: IDs of the DocuWare elements
Send Request (Workflow Manager)
The user is provided with a link to a workflow request assigned to him or her.
You can find the workflow task ID in the Platform Service under Organization > Workflow.
Sent Requests (Workflow Manager)
The sender is provided with a link to an overview of the sent workflow requests.
You can find the workflow task ID in the Platform Service under Organization > Workflow.
Summary Page
The complete URL is shown. Check with Open if the requested element can be loaded.