Show TOC

Activating the Query Extender for the Room SearchLocate this document in the navigation structure

Context

The query extender for the room search allows you to improve performance for the search for room content.

The query extender defines a search query in the folders in which the content of the following rooms is stored:

  • Rooms that the logged-on user in question is a member of

  • Public rooms

The system links this search query with the user's search query (using AND). This has the benefit that TREX only searches in room content for which the user in question has read permission 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.sap.ip.collaboration.room.impl.trexsearch. RoomsSearchQueryExtender

    This query extender restricts the search to the content of rooms that the user in question is a member of and to the content of public rooms.

    It does not search through public documents in private rooms that the user is not a member of.
    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 room content in this index and no other content.

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

    Index Property

    Value

    RQE_FolderNames

    Specify the names of the folder that you want to restrict the search to.

    Example: Documents/News/Discussions/FAQs

    restricts the search to folders with the names Documents , News , Discussions , and FAQs .

    If you enter more than one folder name, separate the entries with /. Note that the slashes do not specify a path.

    RQE_UserCacheID

    Cache ID

    The system uses this cache to store the paths that are visible for each user.

    We recommend that you create a separate memory cache for the room search.

    For more information, see Caches .

    RQE_RoomStructureCacheID

    Cache ID

    The system uses this cache to store all searchable paths for each room.

    We recommend that you create a separate memory cache for the room search.

    For more information, see Caches .

    RQE_MaxNumOfPaths

    Integer

    If certain users, such as administrators, have access to a large number of rooms, search queries using the query extender can become very complex. You can use this parameter to switch off the query extender for such users.

    The system only applies the query extender if the number of paths to be searched is smaller than the specified value.

  3. Add the following parameter to the properties of the iViews in which you want to use the query extender:

    iView Property

    Value

    Query

    RQEActivate=true

    The system uses the query extender for the search query only if you start the search in an iView in which you have activated this parameter.

Next Steps

Extending the Search Query

Configuring the Search for Room Content