Adding HTML links to the existing HTML navigation structure

You can add new HTML links to the existing HTML navigation structure.

About this task

To add a new HTML link to the existing HTML navigation structure, complete the following steps:

  1. Determine the name of the customized workspace that you want to add to the existing navigation structure. You find the workspace name in the title bar of the Tivoli Enterprise Portal window.
  2. Choose a navigation category that you would like to add the new workspace link to. The available navigation categories are:
    • Statistic_Navigation
    • Thread_Detail_Navigation
    • Thread_Summary_Navigation
  3. Open the XML file that defines all HTML links for the chosen navigation category. The name of the XML file is <navigation category>.xml. The path for this XML file is the following: <ITM base directory>\CNB\classes\candle\kdp\resources\help\<language locale>\HTML_BrowserNavigation\V420 where <ITM base directory> is the base directory of IBM Tivoli Monitoring. Remark: An empty language locale string represents the English language locale.
  4. Make the following changes to the added first_level_navigator node: Set the name of your customized workspace as the new caption_EN_US value. Set the name of your customized workspace as the new caption_NLS value. Set the target_workspace_objectid to the OBJECTID that you have determined in Step 2. Parameter details:
    1. caption_EN_US: This property must be unique in this XML file. Therefore, choose a caption_EN_US name that does not exist yet in this XML file.
    2. caption_NLS: This xml node contains the link caption. The new workspace link gets its caption from here.
    3. target_workspace_objectid: This xml node defines the target workspace for the HTML link.
    4. keep_symbols: This parameter is important for context-sensitive navigation. keep_symbols set to 'true' specifies that there is context information that must be passed along when linking to the workspace. keep_symbols set to 'false' specifies that no context information that must be passed along when linking to the workspace. Do not change this parameter.
  5. XML files that are required for the HTML navigation in Tivoli Enterprise Portal are generated in this step. To generate these XML files, browse to the following directory: <ITM base directory>\CNB\classes\candle\kdp\resources\help\<language locale>\HTML_BrowserNavigation\V420 where <ITM base directory> is the base directory of IBM Tivoli Monitoring.
  6. Run the HTML_Navigation_Generator.bat.
  7. Restart Tivoli Enterprise Portal.
  8. Use the added HTML link to navigate to your customized workspace. The new customized workspace is displayed. But in the HTML navigation the wrong navigator item is highlighted. The new customized workspace is displayed and that navigator item should be the one that is highlighted.
    1. To correct this, open the Properties dialog for the HTML navigation. In the "HOME" text field, change the XML file name to the caption_EN_US value that you specified for the added HTML link.
    2. In the XML file name, replace all blanks by underscores.
    3. Click OK.
  9. Click on the added HTML link again, and click OK when you are asked to save the workspace changes. Now the correct navigator item is highlighted when the new customized workspace is displayed in Tivoli Enterprise Portal.

Exception paths

About this task

One exception path is that you enter a wrong OBJECTID into the XML file (see Step 5). This means that the identifier for the workspace that Tivoli Enterprise Portal should navigate to is wrong. The effect in Tivoli Enterprise Portal is that nothing happens when you click on that workspace link with the wrong OBJECTID in the HTML navigation view. There is no error message displayed on the Tivoli Enterprise Portal GUI, but Tivoli Enterprise Portal provides a trace log. You can navigate to the trace log using the Manage Tivoli Enterprise Monitoring Services dialog.

Results

In the trace log you find the following error messages that indicate the problem:

...
An error occurred requesting the workspace record for: REPORT, 117cae1a3ad
...
No workspace group was found for the given workspace type and id
At least one invalid parameter found, request has failed.
...

Here 117cae1a3ad is the wrong OBJECTID.

What to do next

You can correct the OBJECTID by either removing a typo or by determining the correct workspace ID of the new customized workspace (Step 2).