SAP KMC Connector

Installation and Configuration

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 2017.

All rights reserved. All hardware and software names used are registered trade names and/or registered trademarks of the respective manufacturers.

These documents are highly confidential. No rights to our software or our professional services, or results of our professional services, or other protected rights can be based on the handing over and presentation of these documents.

Distribution, publication or duplication is not permitted.

The term “user” is used in a gender-neutral sense throughout the document.

InstallationPermanent link for this heading

Before installing the SAP KMC Connector ensure that the Mindbreeze Server is already installed and this connector is also included in the Mindbreeze license.

Installing the SAP KMC ConnectorPermanent link for this heading

The SAP KMC Connector is available as a ZIP file. The Plugin can be uploaded using the Plugins-tab of the Mindbreeze InSpire configuration interface or registered on the Mindbreeze InSpire server using the mesextension tool, with following command:

mesextension --interface=plugin --type=archive --file=sapkmc-datasourece-<version>.zip install

PLEASE NOTE: The process of updating a plugin is the same as installation. Mindbreeze InSpire will automatically carry out the required update und retain the existing configuration.

Configuration of MindbreezePermanent link for this heading

Select the “Advanced” installation method:

Click on the “Indices” tab and then on the “Add new index” symbol to create a new index.

Enter the index path, e.g. “C:\Indices\sapkmc. Change the Display Name of the Index Service and the related Filter Service if necessary.

Add a new data source with the symbol “Add new custom source” at the bottom right.

Data Source ConfigurationPermanent link for this heading

Connection SettingsPermanent link for this heading

  • WebDAV URL Base: the base WebDAV URL of the SAP KMC server.
  • WebDAV User Name: SAP KMC administrator user with WebDAV access. This credential is used for login by the SAP KMC Connector.  
  • WebDAV Password: password of the crawler user.

Login URL: Form-based Login is used if this option is configured. “Form Data” will be sent to this URL.

Form Data: URL-encoded Login Form Data that schould be sent to the “Login URL“.

  • Enforce Proactive BASIC Authentication: Login Data is sent on the first request to prevent problems with firewalls or load-balancers.
  • Index all custom properties: All custom properties are added as metadata.
  • Add directories to Index: This option enables the crawling of Folders.
  • Root Directories: path to the WebDAV folders that should be indexed. The paths are relative to the URL configured in the “WebDAV URL Base” field.
  • Exclude From Indexing: regular expression for matching URL-s that are excluded from indexing.

Performance SettingsPermanent link for this heading

  • Concurrent Filter and Index Dispatch Threads: number of parallel threads, which send downloaded documents to the index.
  • Document Downloader Thread Count: number of threads, which download discovered documents.
  • Directory Iterator Thread Count: number of threads, which iterate through the directory structure of the specified root directories (see “Root Directories” option in the previous section) and add the discovered document URL-s to the file queue. The discovered subdirectories are added to the directory queue.
  • Directory Queue Size: size of the directory queue, which contains the discovered directory URL-s until they are processed by a directory iterator thread. If the queue is full no new directories are discovered until some already queued directories are processed and removed.
  • File Queue Size: size of the file queue, which contains the discovered document URL-s until they are processed by the document downloader threads. If the queue is full no new documents are discovered until some of the already queued documents are processed and removed.

SAP KMC SettingsPermanent link for this heading

  • LDAP attribute that is used as principal name: in case of SAP KMC users mapped from LDAP directories this LDAP attribute is used as principal name in SAP KMC. This setting allows the resolving of the LDAP groups of a SAP KMC user principal in the authorization provider component.
  • Comma separated list of SAP Privilege QNames that are interpreted as GRANT in the ACL-s: if a SAP KMC user or group has any of this privileges on a document, a GRANT entry is added for the user or group to the access control list of the indexed document. This makes the document visible for the user or group members via Mindbreeze InSpire Search. The elements of this list should be qualified names of SAP permissions, as in the example below:
  • read,all,{http://sapportals.com/xmlns/cm}readwrite,{http://sapportals.com/xmlns/cm}fullcontrol
  • Comma separated list of SAP Privilege QNames that are interpreted as DENY in the ACL-s: if a SAP KMC user or group has any of this privileges denied on a document, a DENY entry is added for the user or group to the access control list of the indexed document. This makes the document inaccessible for the user or group members via Mindbreeze InSpire Search. The elements of this list should be qualified names of SAP Permissions, as in the example below:

read,all,{http://sapportals.com/xmlns/cm}readwrite

  • Base path of local user objects: WebDAV path of local KMC user objects. The path is relative to the base URL configured in “WebDAV URL Base”.
  • Base path of LDAP user objects: WebDAV path of KMC user objects mapped from an LDAP directory. The path is relative to the base URL configured in “WebDAV URL Base”.
  • Base path of local group objects: WebDAV path of local KMC group objects. The path is relative to the base URL configured in “WebDAV URL Base”.
  • Base path of LDAP group objects: WebDAV path of KMC group objects mapped from an LDAP directory. The path is relative to the base URL configured in “WebDAV URL Base”.
  • Base path of role objects: WebDAV path of KMC role objects. The path is relative to the base URL configured in “WebDAV URL Base”.

Uninstalling the SAP KMC ConnectorPermanent link for this heading

To uninstall the SAP KMC Connector, first delete all SAP KMC crawlers and then carry out the following command:

mesextension --interface=plugin --type=archive --file=sapkmc-datasource-<version>.zip uninstall