Setting Configuration for Decoupling of Documentation

TIBCO MDM documentation is decoupled from the product installation. Therefore, to integrate documentation in the application, select either online or offline for the com.tibco.cim.help.url (MDM Help Configuration) property in Configurator. The default value is online.

  • Online: Using this mode, you can access the documentation online when you are in the network. In the online mode, by default the documentation is linked to the latest documentation site URL. For example, for the TIBCO MDM 9.1.0 release version, after clicking the Help icon in the application, the documentation is linked to https://docs.tibco.com/pub/mdm/9.1.0/doc/html/index.htm URL.
  • Offline: Select this mode if you are off the network and want to access the documentation in the application. Stop the TIBCO MDM server if it is running, and then perform the following steps:

Procedure

  1. Copying Documentation Directory
    1. Go to https://docs.tibco.com and access TIBCO MDM documentation.
    2. Click the Versions tab to access the release specific documentation assembly.
    3. Click Download All to download all documentation including PDF and HTML Help.
    4. Save tibco-mdm-version-documentation.zip file to your local directory.
    5. Extract contents of the documentation ZIP directory.
    6. Go to $MQ_HOME and locate ECM.ear\EML.war.
    7. Create the doc sub-directory inside the help folder.
    8. Copy the html directory extracted from the documentation ZIP directory inside the doc sub-directory.
    9. Deploy the modified the ECM.ear file to the Application Server.
  2. Specifying Configurations
    1. Restart the Configurator.
    2. Click Advanced in the Configuration Outline section. A list of advanced configuration categories is displayed.
    3. Select the UI Setting category.
    4. Select offline from the MDM Help Configuration property drop-down list.
    5. Click Save. The Save dialog box is displayed.
    6. Enter the description, if any.
    7. Click Save. The configuration changes are saved.
  3. Hot Deploying on Application Server
    1. Go to Initial ConfigNodeID
    2. Click Save & Redeploy. The Save & Redeploy dialog box is displayed. For Host Name, by default localhost is displayed.
    3. Enter the description, if any.
    4. Click Save. The MDM Help Configuration property is hot deployed on the application server.
  4. Verifying Help
    1. Restart the TIBCO MDM server.
    2. Click the Help icon on any screen, the TIBCO MDM documentation is displayed.