IBM Tivoli Netcool/OMNIbus Version 8.1

Configuring and running online help

After you install Tivoli Netcool/OMNIbus, you might need to configure your system to access the online help. Online help is deployed using the IBM® Eclipse Help System (IEHS) and can be accessed in standalone mode or information center mode.

Procedure

  1. For UNIX operating system For Linux operating system Use the information in the following table to configure IEHS on your system.
    Setting Description
    Browser environment variables Add the directory location of your web browser to the following environment variables (if not already added):
    • PATH
    • For Linux operating system LD_LIBRARY_PATH
    • For AIX operating system LIBPATH
    • SHLIB_PATH
    • Browser-specific environment variables, for example: MOZILLA_FIVE_HOME

    The operating system default browser is used.
    Standalone mode

    Local Help System feature installed on a client workstation

    (Online help files installed on a local IEHS Web server)

    		 Configuration is only necessary if the default IEHS port number of 8888 is being used by another local service.
    If this is the case, edit the IEHS configuration file $NCHOME/omnibus/etc/nco_IEHS.cfg as follows:
    • IEHSMode: 0
    • IEHSHost: leave blank
    • IEHSPort: an unused port number
    Note: After changing the port number in the configuration file, you must shut down the local IEHS server for your changes to take effect. Run the $NCHOME/omnibus/bin/help_end command to shut down the server. The server automatically restarts when you access online help. (If you change your environment variable settings for the browser, you must also shut down the IEHS server for your changes to take effect.)
    Information center mode

    Local Help System feature installed on a remote server

    (Online help files installed on a remote IEHS Web server, which is configured for client access; typically managed by a system administrator)

    		 On the computer designated as the IEHS server, edit the IEHS configuration file $NCHOME/omnibus/etc/nco_IEHS.cfg as follows:
    • IEHSMode: 1
    • IEHSHost: leave blank, or specify the IP address or host name of the IEHS server
      Note: IEHS V3.1.1 does not support IPv6 addresses.
    • IEHSPort: an unused port number for the IEHS server

      The default port number is 8888. If necessary, update your firewall settings to open the port.

    The host name on which the IEHS server is running can be obtained from the $NCHOME/omnibus/platform/arch/nco_IEHS/eclipse/workspace/.metadata/.connection file. Note that this file is available only when the IEHS server is running. The file is deleted when you shut down the IEHS server.

    On each client workstation, edit the IEHS configuration file $NCHOME/omnibus/etc/nco_IEHS.cfg as follows:
    • IEHSMode: 1
    • IEHSHost: IP address or host name of the IEHS server
    • IEHSPort: port number on which the IEHS server is running
    Important: You must instruct users to perform this task.
  2. For Windows operating system Use the information in the following table to configure IEHS on your system.
    Setting Description
    Standalone mode

    Local Help System feature installed on a client workstation

    (Online help files installed on a local IEHS Web server)

    		 Configuration is only necessary if the default IEHS port number of 8888 is being used by another local service.
    If this is the case, edit the IEHS configuration file %NCHOME%\omnibus\ini\nco_IEHS.cfg as follows:
    • IEHSMode: 0
    • IEHSHost: leave blank
    • IEHSPort: an unused port number
    Note: After changing the port number in the configuration file, you must shut down the local IEHS server for your changes to take effect. Run the %NCHOME%\omnibus\bin\help_end.bat command or double-click the file in Windows Explorer. (The server automatically restarts when you access online help.)
    Information center mode

    Local Help System feature installed on a remote server

    (Online help files installed on a remote IEHS Web server, which is configured for client access; typically managed by a system administrator)

    		 On the computer designated as the IEHS server, edit the IEHS configuration file %NCHOME%\omnibus\ini\nco_IEHS.cfg as follows:
    • IEHSMode: 1
    • IEHSHost: leave blank, or specify the IP address or host name of the IEHS server
      Note: IEHS V3.1.1 does not support IPv6 addresses.
    • IEHSPort: an unused port number for the IEHS server

      The default port number is 8888. If necessary, update your firewall settings to open the port.

    The host name on which the IEHS server is running can be obtained from the %NCHOME%\omnibus\platform\win32\nco_IEHS\eclipse\workspace\.metadata\.connection file. Note that this file is available only when the IEHS server is running. The file is deleted when you shut down the IEHS server.

    On each client workstation, edit the IEHS configuration file %NCHOME%\omnibus\ini\nco_IEHS.cfg as follows:
    • IEHSMode: 1
    • IEHSHost: IP address or host name of the IEHS server
    • IEHSPort: port number on which the IEHS server is running
    Important: You must instruct users to perform this task.

Information center mode

  1. Use the following commands to start and stop IEHS.
    • Start IEHS: NCHOME/omnibus/bin/IC_start
    • Stop IEHS: NCHOME/omnibus/bin/IC_end

Standalone mode

  1. In standalone mode, the local IEHS server automatically starts the first time that you make a help request. Use the following command to stop it.

    NCHOME/omnibus/bin/help_end

Library | Support |