Customizing the Help link in dashboards spaces

The banner contains a link to access the online help. By default, it opens the documentation delivered with the product. You can modify this link so that it opens different documentation instead.

Before you begin

Ensure that you have created a copy of the banner content files for customizing.

About this task

The location, appearance, and content of the Help link is controlled by the banner.html file. By default, this link is mapped to /BusinessSpaceHelp/index.jsp?topic=/com.ibm.wbpm.bspace.help.main.doc/welcome/bspace_welcome.html.

Procedure

  1. Open the banner.html file in the copy of the folder that you created.
  2. Update the following markup, replacing the help_URL placeholder with the new URL for the Help link
    Before update:
    <div class="iw-iWidget iw-Standalone" id="commonAction">
    <a class="iw-Definition" 
    href="/BusinessSpace/iWidget/widgets/system/commonActions/commonActions.xml"></a>
    </div> 
    After update:
    <div class="iw-iWidget iw-Standalone" id="commonAction">
    <a class="iw-Definition" 
    href="/BusinessSpace/iWidget/widgets/system/commonActions/commonActions.xml"></a>
    <span class="iw-ItemSet" title="attributes" style="visibility: hidden; 
    display: none;">
    <a class="iw-Item" style="visibility: hidden; display: none;"
    href="#helpurl">help_URL</a>
    </span></div> 
    Tip: To set the URL to point to a resource on the server, use a relative path where possible, because relative paths are easier to maintain. Otherwise, you need to use a fully qualified path, for example, beginning with http://.
  3. Save the banner.html file.