Show TOC

Filtering Entry PointsLocate this document in the navigation structure

Context

You can filter entry points so that only certain entry points are displayed in a given desktop. This is accomplished by specifying a Filter ID for objects that have been defined as entry points, and then adding the relevant filter ID values to the desktop. At runtime, the desktop in use only displays the entry points with filter IDs that match the filter IDs specified for the desktop. If you define a filter ID for a folder, all nodes in that folder inherit the filter ID.

In the Filter ID property of a desktop, you list one or more filter ID values. To display in the desktop also content that does not have a filter ID, add the following value to the list: com.sap.portal.emptyFilterID .

Procedure

  1. Activate filtering by configuring the navigation_events_helper service:

    1. In SAP NetWeaver Administrator, go to Start of the navigation path Configuration Management Next navigation step Infrastructure Next navigation step Application Modules End of the navigation path.

    2. In the Module List , find com.sap.portal.navigation.helperservice .

    3. In the Web Module Details section, in the Components tab, select navigation_events_helper .

    4. In the Portal Service Details section, configure the following properties:

      • FilterbyDesktopView : Change the value to one of the following:

        • 0 - Filtering is disabled. All roles assigned to the user are displayed at runtime.

        • 1 - Filtering is enabled. Only matching nodes are displayed at runtime.

          If no match can be found between filter IDs defined in the object and filter IDs defined in the desktop, all content is displayed.

        • 2 - Filtering is enabled. Only matching nodes are displayed at runtime.

          If no roles match the defined filter, only roles without a defined filter are displayed. If all the roles have filters, the header area displays an empty top-level navigation.

      • FilterByExcludedFilterIDs : Enter the filter ID values that you want to exclude from the filtering mechanism. Separate values with a semicolon (;).

        Note

        This property is only valid when the value of the FilterbyDesktopView property is 1 .

        At runtime, entry points that have a filter ID in this list are only displayed if the desktop has a matching filter ID. The nodes are not displayed, if the current desktop has no filter ID, or if FilterbyDesktopView is set to 1 and no match is found (causing all content to be displayed).

        For example, say your portal has two roles: the first, designed for mobile users, is called 'Mobile' and has a filter ID called 'Mobile'; the second, designed for users accessing the portal from a desktop computer, is called 'Home' and has a filter ID called 'Home'. If the current desktop has no filter ID, and no filter IDs have been added to the FilterByExcludedFilterIDs property, both 'Mobile' and 'Home' are displayed in top-level navigation. In such a case, you could add the filter ID 'Mobile' to the FilterByExcludedFilterIDs property so that only the 'Home' entry point is displayed if the desktop contains no filter IDs.

    5. Choose Save , and restart the service.

  2. Navigate to Start of the navigation path Content Administration Next navigation step Portal Content Management End of the navigation path.
  3. In the Portal Catalog, locate the role, workset, or folder to which you want to add a filter ID value and from the context menu, choose Start of the navigation path Open Next navigation step Object End of the navigation path.
  4. In the Properties editor, choose Modify Properties .
  5. In the Navigation property category, find the Filter ID property and enter any value.
    Note

    You can add more than one filter ID to an object so that the entry point can be displayed in more than one desktop. Separate entries with a semicolon (;).

  6. Add Filter ID values to any other entry points that you want filtered.
  7. Navigate to Start of the navigation path System Administration Next navigation step Portal Display Next navigation step Desktops & Display Rules End of the navigation path.
  8. In the Portal Catalog, locate the desktop for which you want to filter the entry points and from the context menu, choose Start of the navigation path Open Next navigation step Properties End of the navigation path.
  9. In the Properties editor, choose Modify Properties .
  10. In the Filter ID property, specify the filter ID(s) that you defined for the entry points that you want to appear in top-level navigation.

    To display also content that does not have a filter ID, add the following value to the list: com.sap.portal.emptyFilterID .

    To display all entry points, leave the field empty.

Example

The following diagram shows the effect of the different filter ID modes on the roles that are displayed at runtime.

Figure 1: Filter ID