On the d.3 link Configuration page you can configure the ACLs for d.3one application server as known from d.3 web. ACLs are shortcuts for frequently used parameters in an URL. You can also manage the repository indices on this page, these are used to associate the d.3 web repository indices to repositories, which you have already added in the Repository feature on the d.3one application server.

You can open and view the page at a later stage on the d.3one application server or on any client PC using Internet Explorer by entering the URL: https://<Baseaddress>/dms/d3web/.

Using d.3 links

There are three basic types of usage:

1. Download

The d.3 links for downloading documents are structured as follows: https://<Baseaddress>/d.web/download?<Query_parameter>

Sample links look like this:

2. Search

The d.3 links for searching documents are structured as follows: https://<Baseaddress>/d.web/dxplorer/dweb?goto=resultgroups&<Query_parameter>

An example link looks like this:

The parameter openDoc=openDoc opens the document automatically in the d.3one perspective Details, provided the whole query returns exactly one single document. If the query returns several documents, then the result list is displayed.

An example link looks like this:

In this table you find the allowed query parameters for d.3 links:

^{(N/A = Not available)}

ACL configuration

By using ACLs it is possible to apply existing d.3 links from d.3 web. ACLs also allow you to customize d.3 links globally at a later stage in order to adjust existing links to, for example, new d.3 configuration.

If an ACL is marked as default, then this is always apply. Parameters which are set in the default ACL can be overwritten in the d.3 link at a later stage by explicitly selecting or explicitly setting an ACL.

Example:

An example for an ACL configuration for the following search scenario: Determining documents in a specific document type that have a specific status and displaying its dependent TIF file, provided a result is found.

For an ACL, specify the value ZEICH on the d.3 link Configuration page on the ACLs tab in the Name field. The values in the Value field could be entered as follows:

Separate several parameters by a semicolon (;).

In this example, the link means the following: If ACL=ZEICH is defined for the d.3 link, then a search is performed in the document type zeich for the documents in the status Release and the dependent TIF file is loaded.

If the name of an ACL contains extended characters, the name of the ACL in the URL must be encoded so that it meets the standard of the URL encoding.

Example:

Repository index configuration

A repository index must be configured in case there are more than one d.3 repository. While configuring you map a number to a d.3 repository. Later on, you can use this number in a d.3 link with the parameter AI to select the d.3 repository in which the search is to be performed.

If a repository is marked as default (Default), then all queries are sent to this d.3 repository for which the parameter AI is not set.

Example:

An example for a repository index configuration: A search operation is performed across only one repository.

Specify the value 1 on the d.3 link Configuration page on the Repository indexes tab in the Repository index field. Select a configured repository under Repository ID, e.g. ProductiveArchive. This configuration cause the following: If the following value AI=1 is defined as a parameter in a d.3 link, a search is performed in the ProductiveArchive repository.

The OpenSearch functionality d.3one allows the users to search in a simple manner for items in different formats, and the result is displayed and can be read independently from the application. The OpenSearch technology defines a standard used by search providers to browse a defined section.

The advantages for OpenSearch in combination with d.3one consist of how simple a kind of search container in a basic format can be provided to the user on the one hand, and on the other hand in the appearance of the search results independently from source to browse.

With a defined OpenSearch range search you can, for example, define a search query that selectively searches for items in a d.3 repository. You can use this OpenSearch functionality in Windows Explorer so that users can display their search results from a d.3 repository in Windows Explorer.

This topic provides you with basic information about OpenSearch and further details about configuring a federated search for OpenSearch:

For additional information about the fundamentals of the OpenSearch functionality see the OpenSearch website.

You can use functionality that uses the base address with an additional reverse proxy which is used in front of the d.ecs http gateway app. If you want to use the OpenSearch functionality and set up an additional reverse proxy, you need to use the URL of the reverse proxy in the DMSApp. For additional information about the configuration, see Using an additional reverse proxy.

Defining an OpenSearch URL

Using an example for a search operation in a d.3 repository, in this chapter you can learn more about the XML structure of a search result using OpenSearch and the potential information to be specified in an URL for applications which either support cookies or not. In addition, you learn more about the potential restrictions of the search query using properties.

You need the base address of the d.3one application server for the URL and the ID of the d.3 repository, for which you want to define a search query:

• The base address is specified while installing the core apps.

• You can find the repository ID in the Detail section of the d.3 repositories feature (https://<Baseaddress>/repo/repositories/) when establishing a connection. You can obtain the ID either by using the URL or clicking in the Start menu on All Programs > d.velop > d.3one > Repository Configuration.

In general, search queries for OpenSearch are designed as follows: https://<Baseaddress>/identitytunnel/auth?url=/dms/r/<RepositoryID>/sr/?<SEARCHSPECIFICATIONS>&format=opensearch

As a rule of thumb, this common schema is valid for search queries in applications that do not support any cookies.

Note

You can only use search queries performed by applications that do not support any cookies, if you have enabled the authentication mechanism Basic or Kerberos in d.ecs identity provider.

For example, the search query must be slightly adjusted in order to use a browser for searching by deleting the part /identitytunnel/auth?url= from the link.

Example: performing a OpenSearch search query as full-text search in Internet Explorer (only with d.3 search installed) 

Let us suppose, you want to perform a dedicated full-text search for the keyword "invoice" in the repository with the ID 9263b97e-fa3c-52ca-b3af-45c762b5cbd8.

1. In the link https://<Baseaddress>/dms/r/<RepositoryID>/sr/?fulltext=<keyword>&format=opensearch replace the respective data (base address, repository ID and keyword).

2. Copy the link https://<Baseaddress>/dms/r/9263b97e-fa3c-52ca-b3af-45c762b5cbd8/sr/?fulltext=invoice&format=opensearch to the browser's address bar.

3. Press ENTER.

4. The following view is displayed:

Other browsers display the response in form of XML data as text. Provided you have not specified any other parameters, a query returns 25 matches based on the default sort order (dossiers prior to documents, the recently modified items).

Structure of an OpenSearch result 

The OpenSearch result contains the following default properties that describe the items in a d.3 repository.

XML element	Description
<title>	Corresponds to the title field (caption) in the d.3 repository.
<author>	Corresponds to the owner in the d.3 repository.
<description>	Contains a short description based on the properties of the document.
<category>	Corresponds to the label of the category (dossier type or document type respectively) for the dossier or the document in the d.3 repository.

The properties with the prefix win: and media: are used for an improved display of the search result in Windows Explorer. The document properties with the prefix dvelop: are used, for example, to use OpenSearch in Microsoft SharePoint. The common and advanced properties for a result are listed.

You can view the OpenSearch result in any text editor as XML structure (e.g. use the option to display the source text in a browser):

Performing a search using applications that do not support cookies 

The previously mentioned example for OpenSearch queries cannot be entirely applied to applications that do not store any cookies between requests (e.g. Windows Explorer). In this context, the redirection option of d.ecs identity provider is used. The mechanism based on the fact that d.ecs identity provider passed the URI of the search as parameter. The d.ecs identity provider app redirects the query while using the user authentication and stores the cookies on behalf of the application. Compared to a browser call this alternative is a bit slower, because there are some costs for the internal authentication for each query.

Example: performing a OpenSearch search query as full-text search in an application that do not support cookies 

Example URI for the OpenSearch call using the identity provider (d.ecs identity provider):

You can deduce the URI from a link by inserting the part identitytunnel/auth?url=:

• Browser-based call: https://<Baseaddress>/dms/r/<RepositoryID>/sr/?fulltext=<keyword>&format=opensearch

• Redirected call: https://<Baseaddress>/identityprovider/tunnel/?uri=/dms/r/<RepositoryID>/sr/?fulltext=<keyword>&format=opensearch

Parameterization of the search in connection with a d.3 repository 

Usually, the full-text search in a d.3 repository is not specific enough. Thus, you can restrict the search query by using query parameters.

You must encode extended characters for the URL appropriately (e.g. spaces in %20). The length of the encoded query parameter is limited to 8000 characters.

Parameter	Description
fulltext	Specifies a full-text keyword. You need to have installed d.3 search to use the full-text search.
page	Specifies the page to be queried in the results. If page is not specified, the first page (page=1) is requested. If you open the result list in the HTML5 display of the d.3one browser integration, any existing page parameter is ignored and the beginning of the result list is displayed. It is not possible to directly go to a specific position in the result list.
pagesize	Specifies the number of results per search query. If this parameter is not set, up to 25 matches are returned (pagesize=25). The value of the parameter can be 10 (minimum) and 1000 (maximum).
propertysort	Specifies the ID of the property that is used to sort the result. If no sort property is specified, the default sort order using the sort criteria Last modified is applied. Furthermore, the Last modified sort order displayed dossiers prior to documents and within dossiers and documents the recently modified date is used for sorting. Title: property_caption  Owner: property_owner  File type: property_filetype  Comment: property_remark  Last access: property_access_date  Editor: property_editor  Document ID: property_document_id  Document number: property_document_number  File size: property_size  Document status: property_state  Last modified: property_last_modified_date  Last file update: property_last_alteration_date  Color marking: property_colorcode  Category: property_category  Created on: property_creation_date  Last access: property_access_date  You can also sort the result list based on an advanced property. The ID of the property corresponds to the ID (RID) of a property that you can determine for each advanced property in d.3 admin. Depending of the application that is used with OpenSearch, it may happen that the application independently sorts the results, e.g. for the modified date (Internet Explorer, Windows Explorer).
ascending	Specifies the direction of the sort order. ascending=true: results in an ascending sort order (from small to big (A-Z) and from old to young). ascending=false: results in an descending sort order (from big to small (Z-A) and from young to old). In case the ascending parameter is not explicitly specified, the ascending sort order is applied. This is not true for the default sort order: If the criteria Last modified is used for sorting and sort order is not specified, the sort order is descending. In addition, dossiers are displayed prior to documents in the result list. Within documents and dossiers, the items are sorted by the sorting criterion. Depending of the application that is used with OpenSearch, it may happen that the application independently sorts the results, e.g. for the modified date (Internet Explorer, Windows Explorer).
properties	Specifies the search restriction according to the properties of documents and dossiers. Use the following criteria to restrict a search operation to certain aspects: Document ID: property_document_id  File type: property_filetype  Owner: property_owner  Document number: property_document_number  Document status: property_state (Allowed values are Be for Processing (Bearbeitung), Pr for Verification (Prüfung), Fr for Release (Freigabe) and Ar for the status Archive (Archiv). Editor: property_editor (d.3 user name) File name: property_filename  Last file update: property_last_alteration_date  Import date: property_creation_date  File size: property_size (When searching for the file size, the size must be specified in bytes and as integer. A search within a specific range can be done using the separator pipe and minus character (|-): Search for documents whose document file is smaller than or equal to 1024 bytes with the expression {"property_size ":["|-1024"]}. Last modified: property_last_modified_date  Access date: property_access_date  Comment: property_remark  Color marking: property_colorcode (is an integer value between 1 and 24 that correspond to the number of the color code you want to assign). Variant number: property_variant_number  You can define at least one value for each property. Examples: properties={"property_filetype":["docx"]}: for searching the file type DOCX. properties={"property_filetype":["docx","pdf"]}: for searching for items with the file type DOCX or PDF. You can also limit the result list based on an advanced property. The ID of the property corresponds to the ID (RID) of a property that you can determine for each advanced property in d.3 admin. Examples: properties={"227":["KND001"]}: for searching for items which have the advanced property with the ID "227" and this property has the value "KND001". properties={"227":["KND001","KND002"]}: for searching for items which have the advanced property with the ID "227" and this property has the value "KND001" or "KND002". You can also use several properties as search restriction simultaneously. Examples: properties={"227":["KND001"],"231":["|-100"]}: for searching for items with the customer number (advanced property with the ID "227") "KND001" and an invoice amount (advanced property with the RID "231") less than or equals to 100. properties={"227":["KND001"],"property_filetype":["pdf"]}: for searching for items with the customer number (advanced property with the ID "227") "KND001" and the file type PDF.
objectdefinitionids	Sets the categories used for searching items. You can at least define one category. Specify the ID of a category. If this value is not specified, the search is done across all categories in a d.3 repository. Examples: objectdefinitionids=["RECH"]: for performing a search across the document type "Invoice" (Rechnung) (RECH). objectdefinitionids=["RECH", "AUFT"]: for performing a search across the document types "Invoice" (Rechnung) (RECH) and "Order" (Aufträge) (AUFT).
viceuser	Restricts the search result to those matches that a user, whose d.3 user name is specified in the parameter viceuser, is allowed to view. In this case, the search result only contains the items for which the authenticated user (d.3 service user) as well as the viceuser user are granted the required permissions. The viceuser parameter is exclusively used to restricting the search. If the user performs further actions based on the returned links which are part of the results (e.g. open the link for downloading purposes), the permissions of the authenticated users are used. In order to use the permissions of the user for any further actions, you must make sure that the links from the results are used in an individually authenticated user interface (e.g. browser).

Note

Specific values for the properties parameter with regard to the various options to restrict the result purposefully:

1. Search for a numeric value or a money value:

   Specify the value without using a thousand separator. The decimal separator is the dot (.). Example: For the value 1,000.20 EUR specify 1000.20.

2. Search for a date and time:

   Specify the date in the format YYYY-MM-DD. Example: Enter 2018-12-05 for the date 12/05/2018 (MM/DD/YYYY).

   Time is specified in the format YYYY-MM-DDTHH:mm:ss+01:00. You must encode the plus character (+) with %2b. Example: 2018-02-18T23:59:59%2b01:00 for 02/18/2018 at 11:59 p.m. and 59 seconds in the time zone UTC+1 for standard time in Germany.

3. Search for items that are located in a specific range:

   For searching in a range use a combination of pipe and minus character (|-) as separators. Examples for a numeric field with the ID 231:

• • Values greater than or equal to 100: {"231":["100|-"]}

  • Values smaller than or equal to 100: {"231":["|-100"]}

  • Values between 100 and 200: {"231":["100|-200"]}

Use cases for various search queries using the OpenSearch functionality:

• Searching across a document type: Complete the URL by the part objectdefinitionids=["<Document type name short>"].

https://<Basesaddresse>/dms/r/<RepositoryID>/sr/?fulltext=5353&format=opensearch&objectdefinitionids=["RECH"]

• Searching across several document types: Complete the URL by the part objectdefinitionids=["<Document type name short>"].

https://<Baseaddress>/dms/r/<RepositoryID>/sr/?fulltext=5353&format=opensearch&objectdefinitionids=["RECH","AUFT"]

• Searching for PDF documents restricted to the file type: Complete the URL by the part properties={"property_filetype":["<File type>"]}.

https://<Baseaddress>/dms/r/<RepositoryID>/sr/?fulltext=test&format=opensearch&properties={"property_filetype":["pdf"]}

• Searching for an alphanumeric property: Complete the properties parameter in the URL by properties={"227":["KND001"]} in order to find the property field with the RID 227 (customer number) and the value "KND001" as customer number.

https://<Baseaddress>/dms/r/<RepositoryID>/sr/?objectdefinitionids=["RECH"]&fulltext=&properties={"227":["KND001"]}&format=opensearch

• Defining the sort order of the result list based on the title: Complete the URL by the part propertysort=property_caption.

https://<Baseaddress>/dms/r/<RepositoryID>/sr/?fulltext=&format=opensearch&objectdefinitionids=["RECH"]&propertysort=property_caption

For details about defining and deploying search connectors to be used with Windows Explorer see Deploying and defining federated searches in OpenSearch.

See also:

• Basic functioning of OpenSearch 

• Deploying and defining federated searches in OpenSearch 

Based on the d.3ecm architecture, any organization can configure its own features, which you can integrate as tiles onto the start page. In the configuration guidelines for d.velop infrastructure components, see the chapter “Adding tiles to the start page” for technical details on configuring the tiles.

Your users can use the Combine into PDF file context action to export items into a PDF file. The PDF file generated during the export process contains the selected documents. Thus, the users get the opportunity to export several selected document to a local file. The PDF file is a kind of file container and your users can use this file anytime out of a d.3 repository, for example, to send the file to someone else. The exported files are contained as attachments in the PDF file. To read the embedded documents, the users need to have the appropriate applications in use.

It is recommended to set an upper limit for the number of files that can be exported. The upper limit depends, for example, on the performance of your system and the size of the files to be exported. The default value for this feature is limited to 100 items. Dossiers cannot be exported.

You can change the value if you determine that your users make heavy use of the feature which has an impact on the system. You can increase the default value, however, it is recommended to increase the value only if you detect a special need to do so. The value 0 disables the feature so that the context action is not displayed.

If you want to change the value, you can modify the web.config file in the installation directory c:\d3\d.3one\dms.

This is how it works

    <!-- This parameter defines the maximum number of files that can be exported to a PDF file container. -->
    <!-- Default: 100 (A maximum number of 100 files can be exported.) -->
    <!-- Disabled: 0 (The context action "Export PDF file"  is disabled.) -->
    <add key="Multiselection.PdfContainer.MaxCount" value="100"/>

If you work with Microsoft Office 2013, 2016 or 2019 in your enterprise or organization, you can enable the feature to directly edit Microsoft Office documents stored in your d.3 repository. Your users can use the context actions Edit in Microsoft Word locally, Edit in Microsoft Excel locally and Edit in Microsoft PowerPoint locally to simply work on Microsoft Office documents in the appropriate Microsoft Office application and again store them in the d.3 repository. The Microsoft Office documents must be in the status Processing and the user must be the owner of the document.

A WebDav interface allows the edit directly feature by extending HTTP with some verbs. By default, these verbs are permitted and allowed in the DMS app. If you changed some other settings, you must enable these WebDav verbs in Internet Information Services (IIS) again. The WebDav module in IIS must be disabled for the d.3one site.

To enable the function, change the web.config file in the installation directory c:\d3\d.3one\dms.

This is how it works

    <!--This parameter specifies whether editing Microsoft Office documents (Microsoft Word, Microsoft Excel, or Microsoft Powerpoint) is enabled or not-->
    <!--Before you use the feature, please read the manual to take care of all needed requirements-->
    <!--Default: false (Editing Microsoft Office documents is not enabled)--> 
    <add key="WebDav.EditOfficeDocuments" value="false"/>

If you have enabled the HTML login (alternative login) in d.ecs identity provider, you need to change the value "true" in the same file in the following section:

    <!--This parameter specifies if you get a HTML login form when editing Microsoft Office documents.-->
    <!--Only set this parameter to true if you have enabeld "OpenId Connect" or "HTML login" in identityprovider-->
    <!--Default: false (Only Basic Auth for editing Microsoft Office documents is supported)-->
    <add key="WebDav.EnableHtmlLogin" value="false" />

If you allow your users to take over a document which is edited by another user, it is recommended to establish an enterprise-wide or organization-wide policy. The user who currently edits a document in Microsoft Office cannot store the document any longer, if another user has taken over the document to edit it.

Your users can use the Dossier creation feature to create new dossiers in the d.3 repository. You need to know the ID of a user group in d.ecs identity provider so that your users can see and use the Dossier creation tile on the start page. You specify this ID in the web.config file in the installation directory c:\d3\d.3one\dms. You can specify several user group IDs separated by a comma.

This is how it works

<!-- This parameter defines for which IdentityProvider groups to show the "Dossier creation" tile -->
<!-- Must be a list of ids of IdentityProvider groups, seperated with , -->
<add key="NewDossier.IdpGroups" value="DC4895EF-A72C-4489-95A1-F38269D6E48D,cn%3Dd3admin%2Co%3Dadmin%2Ccn%3Daccounts%2Cdc%3Dcontoso%2Cdc%3Dnet"/>

See also: