Downloading and installing a local IBM Integration Bus documentation feature

You can download an IBM® Integration Bus documentation feature that you can install in the IBM Integration Toolkit and use as a local documentation source.

About this task

By default, the IBM Integration Toolkit is configured to use remote help to display IBM Integration Bus topics that are hosted in the online product documentation. However, you can install one of the IBM Integration Bus documentation features, and then configure the IBM Integration Toolkit to use this feature as a local source of documentation.

Two IBM Integration Bus documentation features are available:
  • IBM Integration Bus documentation (English): This feature contains only the English documentation.
  • IBM Integration Bus documentation (all available languages): This feature contains the English documentation and translated documentation.
Note: You can install only one of the documentation features. For example, if you have installed the IBM Integration Bus documentation (English) feature, you must uninstall this feature before you can install the IBM Integration Bus documentation (all available languages) feature; see Uninstalling a local IBM Integration Bus documentation feature.

Procedure

To install one of the IBM Integration Bus documentation features, complete the following steps:

  1. Download the feature from the following location: IBM Integration Bus documentation download site.
    • If you are installing the IBM Integration Bus documentation (English) feature, download IIBversion-EN.zip.
    • If you are installing the IBM Integration Bus documentation (all available languages) feature, download IIBversion-ALL.zip.
    where version represents the version of IBM Integration Bus; for example, IIBV10000-EN.zip.
  2. Start the IBM Integration Toolkit.
  3. From the menu, click Help > Install New Software.
  4. Click Add and enter a name for the feature; for example, Local documentation.
  5. Click Archive, navigate to where you downloaded the feature, click Open, and then click OK. The IBM Integration Bus documentation feature is displayed.
  6. Select the check box for the feature and click Next.
  7. Click Next again to confirm your selection, click to accept the license terms, and then click Finish
  8. Click OK to accept the security warning. The feature is installed into your local IBM Integration Toolkit help system.
  9. Click Yes to restart the IBM Integration Toolkit.
  10. When the IBM Integration Toolkit restarts, click Window > Preferences and, in the Preferences dialog, expand Help and click Content.
  11. To enable IBM Integration Toolkit to use the feature that you installed, click one of the following options:
    • Include local help only: Select this option if you do not want to access online help under any circumstances; for example, if you never have internet access from your computer.
    • Include remote help and give local help priority: Select this option if you want to access online help, but only for topics that are not included in the local help.
    • Include remote help and give it priority: Select this option if you want to access the local help only when the online help is not available. If you are not connected to the internet, there might be a delay before help is displayed because the system only displays the local help after the attempt to access online help fails.
  12. Click OK and then, from the IBM Integration Toolkit menu, click Help > Help Contents to see the list of available help topics. If you installed the IBM Integration Bus documentation (all available languages) feature, any topics that are translated into your operating system language are displayed in that language. Any topics that are not translated into your operating system language are displayed in English.

Results

You downloaded one of the IBM Integration Bus documentation features and configured IBM Integration Toolkit to use this feature as a source of documentation.