Installing local HTML help
This topic explains how to install local HTML help when the TrueSight Network Automation server is in a secured environment and you cannot access the online documentation via a web browser. This topic contains the following sections:
To install the local HTML help in your environment:
- Download the bcan-localhelp-<versionNumber>.zip from EPD.
- Copy the zip file to the <BCAN_INSTALL>\public\bmc\bca-networks\extras directory.
The unzipped bcan-localhelp folder contains the following files:
- README.txt: Text file that contains instructions about how to use the local help
- help.properties: Properties file that must be installed on the TrueSight Network Automation server
- bcan-html-localhelp.zip: Zip archive containing the local help files that must be installed on a web server
To install local HTML Help on another web server
- Copy the bcan-localhelp-<versionNumber>.zip file located in the <BCAN_INSTALL>\public\bmc\bca-networks\extras\ folder on the computer on which TrueSight Network Automation is installed to a custom directory on the other web server.
- Unzip the bcan-localhelp-<versionNumber>.zip file in the folder you specified in step 1.
- In the extracted bcan-localhelp-<versionNumber> directory, navigate to the bcan-localhelp directory.
- Create a directory where you want to extract the local help files.
- Unzip the bcan-html-localhelp.zip file to the directory you have created in step 4.
- Copy the directory created in step 4 to the Home directory on the web server.
For example, on a Windows computer with default Tomcat 7.0 installation, CATALINA_HOME= C:\Program Files\Apache Software Foundation\Tomcat 7.0. - Verify that the local help is accessible by browsing to http://<server>:<port>/<path>/index.html.
- <server>: Specifies the name of your web server
- <port>: Specifies the is the port used by your web server
- <path>: Specifies optional path information if the directory created in step 4 is not present in the root of the web server
For example: http://<myserver>:80/<path>/index.html
To configure the TrueSight Network Automation web server to use local HTML Help
- Copy the help.properties file to your TrueSight Network Automation server's <BNA-DATA> directory.
For example,- On Windows: C:\bca-networks-data\help.properties
- On Linux: /var/bca-networks-data/help.properties
- Modify the help.properties file as follows:
- Set the helpUseLocal property to true as follows: helpUseLocal=true
- Set the helpResolverURL property to your web server. For example:
helpResolverURL=http://myserver:80/<path>/urlresolver.html?product={0}&version={1}&topic={2}&lang={3}
- Restart the TrueSight Network Automation web server.
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*