Several examples illustrate how parameters can be used in DocuWare URL integration to customize access to documents and functions. These sample configurations show how different parameters affect the behavior of integrated URLs.
You can try out all the examples listed here in your DocuWare installation. All you need is to have installed a sample file cabinet and published the Platfom Service in the IIS default site. You must enter the real server name. All other parameters (e.g. GUIDs) must match the values in your installation.
All URLs of the following sample addresses start with
http://<your_servername>/Docuware/WebClient/Integration
Precondition for the example URLs in this section is, that the user as the right to access the search dialogs, result and task lists, please see also chapter "Specify rights".
Login-Parameter
A result list &p=RLV&rl=<result list id> shall be called up
with manual login
http://<your_servername>/DocuWare/Platform/WebClient/Integration?p=RLV&rl=<result list id>
The user has to enter the credentials, before the result list is shown.
with single sign-on
The parameter for the Windows login is "SSO". It is added in the base URL before the org-ID:
http://<your_servername>/DocuWare/Platform/WebClient/SSO/Integration?p=RLV&rl=<result list id>
automatically with DocuWare login
It is possible to include the DocuWare credentials in the integration URL. The credentials have to be base64 encoded and encrypted.
Logindaten: User=administrator\nPwd=admin
Logindaten Bbse64- encoded: VXNlcj1hZG1pbmlzdHJhdG9yXG5Qd2Q9YWRtaW4=
This string is added to the URL with "lc"
http://<your_servername>/<DocuWare>/<Platform>/WebClient/Integration?&p=RLV&rl=<result list id>&lc=VXNlcj1hZG1pbmlzdHJhdG9yXG5Qd2Q9YWRtaW4=
If the credentials are included in the URL, DocuWare only accepts an encrypted URL. If you use individual, fixed URLs, you can encrypt and decrypt them using the DocuWare URL Creator (see section DocuWare URL Creator). If you encrypt the encryptable parameters yourself, because the URLs need to be generated "on the fly", refer to the Encryption paragraph.
The encrypted URL is added with the parameter "ep":
http://<your_servername>/<DocuWare>/<Platform>/WebClient/Integration?&ep=<encrypted parameters>
Unencrypted URLs with the login parameters lc or lct can no longer be used from DocuWare Version 7.1.
To update existing integration URLs, proceed as follows:
In the URL Creator, select "Parse URL" in the first step.
Copy the URL into the text field and click "Next".
Activate "Use passphrase" and enter the passphrase. You find the passphrase in DocuWare Administration in the organization area under "General".
Click "Next" to the Summary page and copy the new URL with the securely encrypted login.
When an application generates your URL, you must customize it with the passphrase from DocuWare Administration.
More information about Encryption
Dialogs, lists, download and viewer
Viewer only, no result list, specific document is opened
DocID of the specific document is "8"
&p=V&rl=a60d2279-227d-454b-815c-14d64eb165a1&did=8
If you do not enter a DocID here, the first result in the result list is automatically displayed. In addition, a query can be defined in the URL.
&p=V&rl=69e807b6-70e8-48c2-8857-2864dfebc4ac
Viewer and result list
&p=RLV&rl=69e807b6-70e8-48c2-8857-2864dfebc4ac
The result list defined by GUID in this URL must be a task or result list.
Search dialog and Viewer and result list
&p=SRLV&sed=0c825e8b-e21f-48e8-b31f-590bf60a6c59
There are no parameters to be defined for a result list here, because a search dialog is opened. Every search dialog always has a result list assigned to it.
Index Dialog
An info dialog can be integrated with the following URL-scheme:
? p=IND&rl=<Resultlist_ID>&fc=<FileCabinet_ID>&did=<doc_ID>
IND = parameter for index dialog (info dialog)
rl = ID of the result list
fc = ID of the file cabinet
did = ID of the document related to the info dialog
IDs of the elements of DocuWare
All parameters have to be encrypted.
Document Tray
A document tray integration provides the user with the complete functionality of a a document tray in the Web Client.
A tray can be embedded with this URL-scheme:
? p=B&bid=<Basket_ID>
B = parameter for document tray
bid = ID of the document tray
Learn how to find the IDs of the elements of DocuWare
All parameters have to be encrypted.
Document link
To integrate the link to a document you can use this URL scheme:
?p=DL&fc=<FileCabinet_ID>&did=<doc_ID>&docLink=<doc_ID>
DL = parameter for integration type "document link"
fc = ID of the source file cabinet. This is the file cabinet which contains the link.
did = ID of the document related to the link
docLink = ID of the document link
Download
&p=D&rl=a60d2279-227d-454b-815c-14d64eb165a1&did=8
This URL opens the document in the plugin program, because "Download" has not been explicitly defined as the download type. If you want a document to be proposed for downloading, the URL is:
&p=D&rl=a60d2279-227d-454b-815c-14d64eb165a1&did=8&dt=Download
You can also define a task list or a query for a download integration. If more than one result is returned, the first result is always displayed in the plugin program or proposed for downloading.
Naturally, for all the examples in this section the login can be defined as a parameter; as an alternative to the task list you can also define the query as a parameter.
Queries
For the following examples access is granted through user login in the URL; user name is guest and the password is also guest. Only the parameters of the URL are listed here. The base URL is same as before.
If you define a query in the URL and the result list is a task list, the parameter q" can refine the query of the task list.
Queries with simple search expression
[COMPANY]="Peters Engineering"
&p=RLV&lc=VXNlcj1ndWVzdFxuUHdkPWd1ZXN0&rl=a60d2279-227d-454b-815c-14d64eb165a1&q=W0NPTVBBTlldPSJQZXRlcnMgRW5naW5lZXJpbmci
[CONTACT] LIKE "Lau*"
&p=RLV&lc=VXNlcj1ndWVzdFxuUHdkPWd1ZXN0&rl=a60d2279-227d-454b-815c-14d64eb165a1&q=W0NPTlRBQ1RdIExJS0Ugk0xhdSqT
Query for documents with a specific date range
[DATE]<=CURRENTDATE(-5) AND [DATE]>=CURRENTDATE(-8)
Queries with complex search expressions
[COMPANY]="US-Steel" AND [DEPARTMENT]="Production"
&p=RLV&lc=VXNlcj1ndWVzdFxuUHdkPWd1ZXN0&rl=a60d2279-227d-454b-815c-14d64eb165a1&q=W0NPTVBBTlldPZNVUy1TdGVlbJMgQU5EIFtERVBBUlRNRU5UXT2TUHJvZHVjdGlvbpM=
[COMPANY]="Phone Wizard" AND [DEPARTMENT]="Accounting" AND [STATUS]="to be approved"
&p=RLV&lc=VXNlcj1ndWVzdFxuUHdkPWd1ZXN0&rl=a60d2279-227d-454b-815c-14d64eb165a1&q=W0NPTVBBTlldPZNQaG9uZSBXaXphcmSTIEFORCBbREVQQVJUTUVOVF09k0FjY291bnRpbmeTIEFORCBbU1RBVFVTXT2UdG8gYmUgYXBwcm92ZWSU
(([CONTACT]="Werner Moser" OR [CONTACT] LIKE "*Moser*") AND [COMPANY] LIKE "*Moser*") OR [DocuWareFulltext] LIKE "*Moser*"
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.
Query with a wildcard
[Index Field DB Name] LIKE "*[Search Value]*"
NOTE: The asterisk can be placed at the beginning of the search value, after it, or both.
Encryption
If you use individual, fixed URLs, you can encrypt and decrypt them using the DocuWare URL Creator (see section DocuWare URL Creator). If you encrypt the encryptable parameters yourself, because the URLs need to be generated "on the fly", refer to the base 64 encoding paragraph.
Encryption Algorithm
Please note that some parameters need to be base64URL-coded for the encryption. For more information, refer to section URL Parameters.
URL Encryption
This uses a symmetric encryption algorithm.
Advanced Encryption Standard (AES) in accordance with specification FIPS-197 is used for the encryption, with the following parameters:
Block Size = 128 Bits
Cipher size = CBC (Cipher Block Chaining)
Initialization vector (IV) = 128 bits
Key length = 256 bits
No salt
Keys
An AES key with 256 bits and an initialization vector (IV) with 128 bits are used for encryption/decryption. The key and the initialization vector must also be known to the external application. Passphrases are used for this. DocuWare uses this passphrase to calculate the key and the initialization vector. The passphrase is encrypted and stored as a property in the settings of the Web integration. The administrator must also enter and encrypt the passphrase in the external application.
The following algorithm is used to ascertain the AES key and the initialization vector from the passphrase:
Ascertaining an SHA-512 hash from the passphrase (result 512 bits). This can be implemented in .NET using the SHA512Managed-class and is also supported by Java and PHP. Third-party add-ons are available for JavaScript.
Use the first 256 bits (32-bytes array) for the AES key.
Use the following 128 bits (16-bytes-array) for the initialization vector.