Open Documentation Menu

Setting up redirections (integrator)

The Redirections feature in d.velop documents for Microsoft 365 enables you to define calls to third-party documents and dossiers using generic links.

This is how it works

  1. Open the d.velop for Microsoft 365 - Admin site in your browser at the URL https://admin.d-velop365.com.

  2. Log in.

  3. Click the nine-point menu.

  4. Click Redirections below d.velop documents for Microsoft 365.

  5. Click New.

  6. Enter a unique name for the redirection in the Name field.

  7. Specify a description for the redirection.

  8. Select a search method to search for the target. You can choose between a cross-search in the search index (SharePoint search, KeyWordQuery) and a direct search in a list or library (SPQuery).

Creating a new redirection for the search in the search index

  1. Enter the desired target URL. For simplicity, select a saved template from Template for the target URL.

    If you want to address the embedded view, manually enter the URL for the call. The URL can be found in the folderplan.

  2. Define the desired query parameters under SharePoint search query. Define the SharePoint KeyWordQuery in KeyWordQuery Language (KQL) syntax.

    If you want to link multiple queries together, use AND as the operator.

    Example

    • Calling a document via DocumentNumber:

      ecsDocumentID={DocumentNumber}

    • Calling a document of content type Invoice via DocumentNumber and Tenant:

      ecsDocumentID={DocumentNumber} AND contentType=Invoice AND ecsCompanyCode={CompanyCode}

  3. Test the query by defining the query parameters in the Test parameter field.

    • You will receive a table with the test results.

    • Click on a row for more information about the result.

  4. Take the generated URL for integration in external systems and define the URL in the calling system. Replace the placeholder with system-specific placeholders, for example %1.

  5. Save the redirection.

    Warning

    Select the option Override the SharePoint base URL only if the tenant’s search index is having problems and, for example, search results are not found at the tenant level, but only at the site collection level.

Creating a new redirection for the search in a list or library

  1. Enter the desired target URL. For simplicity, select a saved template from Template for the target URL.

  2. Complete the entry under URL of the list/library and specify the list/library to search in.

  3. Complete the Site URL property with the absolute URL of the SharePoint site collection.

  4. Define the desired query parameters under Parameter mapping. For the SharePoint SPQuery, define the query with the syntax ecsPlaneID:{PlaneID}. ecsPlaneID represents the internal name of the site column and {PlaneID} specifies the parameter.

    Example

    • ecsCaseNumber:{case no.}

    • (ecsArticlePackagingCode:{ArticlePackagingCode}) and (ecsArticle:{Article})

  5. Test the query by defining the query in the Test parameter field.

    • You will receive a table with the test results.

    • Click on a row for more information about the result.

  6. Take the generated URL for integration in external systems and define the URL in the calling system.

  7. Save the redirection.