Installing local Help files

The IBM® Tivoli® Directory Integrator installer does not contain any user documentation, other than the Java API documentation, which can be displayed by selecting the Help -> Welcome screen, JavaDocs link in the Configuration Editor. IBM provides the user documentation in online form in an information center, at http://publib.boulder.ibm.com/infocenter/tivihelp/v2r1/topic/com.ibm.IBMDI.doc_7.1.1/welcome.htm.

IBM Tivoli Directory Integrator is equipped with code¹ to provide you with context-dependent online help that you can launch from the Configuration Editor (CE). By default, this code resolves the documentation from the online information center as referenced above. You can, however, install the documentation locally, such that you are not dependent upon the Internet to be able to read it.

These are the steps you must take to install documentation locally:

• The code to handle the documentation files, the IBM User Interface Help System built on Eclipse, is not installed by default. In order to install the Help system, you will need to do a custom install, and install the Help system feature into your existing Tivoli Directory Integrator installation.
• All the manuals are stored together in one compressed directory, which when uncompressed contains an Eclipse Document plug-in.
• All the manuals can be downloaded, in their compressed form, from the Tivoli Directory Integrator documentation site, at http://publib.boulder.ibm.com/infocenter/tivihelp/v2r1/topic/com.ibm.IBMDI.doc_7.1.1/welcome.htm
• The entire documentation package, di_plug-ins-7.1.1.zip, should be uncompressed into the right place: TDI_install_dir/ibm_help/eclipse/plug-ins folder (or uncompress somewhere else, and move into the right place). The package contains the actual Tivoli Directory Integrator documentation in com.ibm.IBMDI.doc_7.1.1, alongside a number of other directories whose names end in .doc; all of those directories should be at the same aforementioned plug-ins level.
• The location of the documentation that the CE tries to access is set in the global.properties file, which resides at the root level of the installation directory of IBM Tivoli Directory Integrator, or solutions.properties in the Solutions Directory. By default, this points to the online information center, but if you comment the line:

  ## Name of help server, comment out if you want local help system
  com.ibm.di.helpHost=publib.boulder.ibm.com/infocenter/tiv2help/index.jsp?topic=

  such that it reads:

  ## Name of help server, comment out if you want local help system
  #com.ibm.di.helpHost=publib.boulder.ibm.com/infocenter/tiv2help/index.jsp?topic=

  then next time you run the CE and launch Help, it starts a local task to serve the documentation, from the content in the plug-ins directory.
• The location of the documentation server that AMC tries to access is set in its web.xml file. Open the web.xml file which is located in the WEB-INF folder of tdiamc webapp and list the IP address (or hostname) and port of the help server, for both occurrences of the following attributes: InfocenterHostName and InfocenterPort.

After you install the documentation in the plug-ins directory as outlined above, you can also decide to host the documentation on that computer for other installations of IBM Tivoli Directory Integrator in your environment. In the TDI_install_dir/ibm_help directory there are a number of .bat files (Windows) or .sh files (Unix/Linux) that enable you to do this.

IC_start.bat or IC_start.sh

If you run this script, the script starts an information center on http://your_IP_address:8888

By editing this file, you can change the port number from the default, 8888; if you want to change this, to for example 80, change "-port 8888" to "-port 80". On those clients that are trying to access this information center, the port must match another property in the global.properties or solution.properties file, com.ibm.di.helpPort - its default is set to 80. Also, the com.ibm.di.helpHost property should read something like infocenter_IP_address/help, where infocenter_IP_address is the address of your local information center.

In addition, in order for AMC to find this information center, you must update the parameters InfoCenterHostname and InfoCenterPort attributes in its configuration file, web.xml, to match the values above.

IC_stop.bat or IC_stop.sh

Stops the help system, a Java program, that serves the local information center.

help_start.bat or help_start.sh

Similar to IC_start, except the port used is a random one, and it also launches a local browser showing the start page. As the port is random, unsuitable for use other than on the local computer.

help_stop.bat or help_stop.sh

Stop the local Java task that was started by WebSphere_help_start.