Show TOC

Activating KM Resource Indexing with ACLsLocate this document in the navigation structure

Context

The query extender for the KM (Knowledge Management) resources search allows you to improve performance when searching for KM resources. In addition, the ACL (Access Control List) security manager supports events at ACL change, so that the indexing infrastructure can react and re-index the relevant document. The benefit is that TREX only searches in KM resources for which the user has read permissions and the system has fewer resources to filter out when preparing the search results list.

Procedure

  1. Create a search index with the custom property:

    Index Property

    Value

    queryExtender

    com.sapportals.wcm.service.indexmanagement.retrieval.search.AclQueryExtender

    This query extender restricts the search to KM resources for which the user has read permissions for the resources. It does not search through resources for which the user has no read permissions.
    Note

    If you specify this query extender for an index, the system finds only items that are stored under the path specified. Therefore, you should index only KM resources in this index and no other content.

  2. Optional: To further optimize performance, you can define the following additional custom properties:

    Index Property

    Value

    aclQeMaxQueryLength

    Integer

    Defines the maximum length of the query. If it exceeds the specified integer value, the extension is not added.

    aclQeCheckIndexedPrincipals

    Integer

    Defines that the query is only extended with the indexed principals. The specified number defines how often the indexed principals are prefetched from TREX (in milliseconds). The number should be greater than zero. This call becomes slow if there are too many different roles and groups in the document ACLs of the index.

    aclQeCheckIndexedPrincipalTypes

    Integer

    Defines that the query is only extended with the indexed principals types. The specified number defines how often the indexed principals are prefetched from TREX (in milliseconds). If no roles or groups are indexed, such terms are not added to the query extension. The number should be greater than zero.

    aclQeExtendQuery

    True or False

    If the value is set to False no query extension is added.

Next Steps

Extending the Search Query