Accessing the IBM Business Automation Workflow documentation offline

Business Automation Workflow links to the current version of the online documentation. If you need to work offline, you must download the documentation files, install them in a local directory and redirect the help requests to the local Knowledge Center (KCCI).

Before you begin

The following prerequisites must be met:
  • To perform this task, your user ID must be associated with the Administrator role.
  • A working Internet connection is required to download documentation files.

About this task

The documentation for Business Automation Workflow is available at the IBM Business Automation Workflow Knowledge Center. When you launch a help topic from the Business Automation Workflow product, you are using this site to access the current version of this information. For example, if you click the Help link, the help topic is launched in the external knowledge center. If you want to work offline, you need to download the documentation to a local directory and redirect the help requests to the local knowledge center. When there is a new release of the product, you need to update your installed documentation to keep it current.

Procedure

To use the Business Automation Workflow documentation from a local directory, follow these steps.

  1. Download the Business Automation Workflow Knowledge Center. For details, see IBM® Business Automation Workflow Knowledge Center downloadable content.
  2. In every Business Automation Workflow installation that hosts application cluster members of your deployment environment, unzip the content to the <install_root>/BPM/KnowledgeCenter/usr/content/SS8JB4 directory. If files with the same names are detected in the destination directory, replace the existing files.
  3. If the <install_root>/temp/KnowledgeCenter/runtime/index directory exists, delete it so that the search index will be rebuilt with the newly installed content.
  4. Delete the external knowledge center endpoint by using the deleteBPMEndpoint command on the deployment manager: 
    AdminTask.deleteBPMEndpoint( [ '-scenario', 'PUBLIC_KC' ] )
    For more information, see deleteBPMEndpoint command.

    When you click a help link from Business Automation Workflow, the help topic is launched from the local directory where you downloaded the documentation.

  5. To switch back to the online knowledge center, on the deployment manager, use the setBPMEndpoint command: 
    AdminTask.setBPMEndpoint( [ '-scenario', 'PUBLIC_KC', '-url', 'https://www.ibm.com/support/knowledgecenter' ]
    For Business Automation Workflow version 18.0.0.0, use the following command:
    AdminTask.setBPMEndpoint( [ '-scenario', 'PUBLIC_KC', '-url', 'https://www.ibm.com/support/knowledgecenter/SS8JB4_18.0.0' ]
    For more information, see setBPMEndpoint command.