Customizing Location of Help Files

By default, all TIBCO Workspace and Organization Browser documentation is available on the TIBCO Documentation web site. You can, however, download the documentation and store it locally, then configure Workspace so that the local documentation is accessed when a user selects Help > Help or Help > Organization Browser Help in the application.

This is typically used at sites that do not allow Internet access.

Note: If you download and store the Workspace and Organization Browser documentation, you may not be aware of changes that are made to those documents on the TIBCO Documentation web site. Occasionally, out-of-cycle (OOC) updates are published for some documents, which means that they are updated between software releases. To be notified when OOC updates occur, you can subscribe to RSS feeds by using the Subscribe button on the "TIBCO ActiveMatrix BPM" page of the TIBCO Documentation web site:

Note, however, you cannot subscribe to RSS feeds for only the Workspace and Organization Browser documentation; this notifies you of changes to any TIBCO ActiveMatrix BPM documentation.

Procedure

  1. Download the TIBCO ActiveMatrix BPM documentation from the TIBCO Documentation web site.
    Note that you cannot download just the Workspace and Organization Browser documentation; it is bundled with all of the TIBCO ActiveMatrix BPM documentation.
    1. With a browser, navigate to:

      https://docs.tibco.com/products/tibco-activematrix-bpm

      Note that this URL always takes you to the documentation for the most recently released version of TIBCO ActiveMatrix BPM. If you want the documentation for an earlier version, click the appropriate tab on the page.

    2. Click Download All.
  2. Unzip the file that you downloaded and place the files in a local file system or host them on an internal web server.
  3. Double-click the index.html file in the html directory.
  4. In the Table of Contents, navigate to the desired guide and select it:
    • Workspace > Workspace User's Guide
    • Workspace > Organization Browser User's Guide
  5. Copy the file path / URL from the address line in the browser, then paste that into the appropriate HelpFileLocations parameter.
    • If you are using the Configuration Administrator to configure the location of help files, see "Help File Locations" in Application.
    • If you are directly updating the config.xml file to configure the location of help files, see Help File Locations.

Result

Now when a user selects Help > Help or Help > Organization Browser Help from within the application, the appropriate help is opened from the local server.