Using a local version of the information center

By default, the Sterling Warehouse Management System accesses product documentation on the IBM Knowledge Center residing on the ibm.com® Web site. If you do not have access to the Internet, you can optionally download the product documentation to a local environment so that users can access it.

About this task

If you download the product documentation, you can update it when changes are available.

Procedure

  1. Update the host address for the information center, so that it points to your local server instead of the IBM® remote location.
    1. Change the EXT_HOST_ADDR and IC_PORT parameters in the sandbox.cfg file.

      ...where EXT_HOST_ADDR is the IP address or host name of the machine where you have installed Sterling Warehouse Management System, and IC_PORT is the port that Sterling Warehouse Management System listens to.

    2. Run the script setupfiles.cmd (for Windows) or setupfiles.sh (for UNIX or Linux).
    3. On the server where Sterling Order Management Sterling Configure, Price, Quote is installed, browse to the <INSTALL_DIR>/properties/ folder. Open the customer_overrides.properties file in a text editor. If the customer_overrides.properties file does not exit, create it.
    4. Add these lines to the customer_overrides.properties file:
      yfs.yfs.local.iehs.help=true
      yfs.yfs.online.help.url=http://<Hostname/IPaddress>:9999/infocenter/ssfs/v9r4/index.jsp.
      Here, <Hostname/IPaddress> refers to the Hostname or IPaddress of the local server that is used for hosting the Sterling Warehouse Management System Information Center.

      Example: yfs.yfs.online.help.url=http://10.23.23.25:9999/infocenter/ssfs/v9r4/index.jsp

      Note: Ensure that the application server that hosts the application EAR and the Sterling Warehouse Management System Information Center are not running on the same machine. If they are running on the same machine, access the application using the computer name; for example, http://abc.com:8001/sbc/sbc/login.do. In addition, access general help using the IP address; for example, http://127.0.0.1:9999/infocenter/ssfs/v9r4/index.jsp.
    5. Rebuild the product EAR file and redeploy it to the application server.
  2. Download, extract, and set up the information center on your local server where Sterling Warehouse Management System is installed.
    1. Download the latest version of the information center compressed file 94WMS_InformationCenter.zip
    2. Stop the information center system by running the script <INSTALL_DIR>\bin\stopHelp.cmd (for Windows) or <INSTALL_DIR>/bin/stopHelp.sh (for UNIX or Linux).
    3. On the server where Sterling Warehouse Management System is installed, extract the compressed file to this folder:

      <INSTALL_DIR>/xapidocs/ibm_help/eclipse/plugins

    4. Delete the <INSTALL_DIR>/xapidocs/ibm_help/eclipse/workspace directory.
    5. Delete the subdirectories and files in the <INSTALL_DIR>/xapidocs/ibm_help/eclipse/configuration directory except for the config.ini file. Do not delete the config.ini file.
    6. Restart the information center by running the script <INSTALL_DIR>\bin\startHelp.cmd (for Windows) or <INSTALL_DIR>/bin/startHelp.sh (for UNIX or Linux).
    7. Users can now access the product documentation without being connected to the Internet.