Determine the id of a user interface object

You need to determine the id of an existing user interface element when you create extensions that exclude features or items, or that add menu items to an existing menu.

Procedure

  1. If you are running Cognos Analytics 11.0.7 or later, follow these steps:
    1. Open the Windows Services window and stop the IBM Cognos service.
    2. Open the file installation_location\wlp\usr\servers\cognosserver\bootstrap.properties.
    3. Add the following line:
      disableXSRFCheck=true
    4. Save the file.
    5. Restart the IBM Cognos service.
  2. Sign in to your IBM® Cognos® Analytics server.
  3. Type the following URL in a web browser: http://<server_name>:<port>/bi/v1/perspectives/<view> where <view> is the view (home, authoring, dashboard, or modeller) that contains the user interface object.
    A JSON file is returned that contains a description of all the user interface elements in the view.
  4. Search for the hover text for the user interface element.
    The id and featureId of the user interface items are displayed following the hover text.

Example

Searching for Delete in the JSON file that is returned for the home view displays the following part of the file.
"label": "Delete",
"id": "com.ibm.bi.contentApps.deleteAction.DeleteAction",
"featureId": "com.ibm.bi.contentApps.deleteAction"

The values of id and featureId can be used in your extension to exclude this button or feature, if wanted.