Switching from online to offline administration help

By default, the help button on the administration pages of Spotfire Server opens the online version of this documentation. If you are unable to use the online version, you can download the documentation and change the configuration to open your local help instead.

About this task

Note: When you use offline help, remember that you must download and update your documentation whenever you upgrade Spotfire.

Downloading the documentation

First you must download the documentation for your version of Spotfire.

Procedure

In a web browser, go to https://docs.tibco.com/products/spotfire-server.
Use the drop-down menu to select your version of Spotfire.
Click Download All Documentation.
Unpack the downloaded .zip file, and in the extracted files, locate the directory TIB_sfire_server_tsas_admin_help.
Copy the contents of the TIB_sfire_server_tsas_admin_help directory to the following directory on the computer running Spotfire Server:
```
<install-dir>\tomcat\webapps\spotfire\resources\help\en-US\administration\
```
Note: Only copy the contents of the TIB_sfire_server_tsas_admin_help directory, and not the directory itself. For example, you want the index.html file directly in the administration directory.

If the help\en-US\administration path does not already exist under resources, then create the directories.

Updating the configuration to use the offline administration help

Procedure

On the computer running Spotfire Server, open a command-line interface and go to the following directory: <server installation dir>/tomcat/spotfire-bin.

On the command line, enter the following commands:

config export-config --force

config set-config-prop -n general.applications.admin.use-online-help -v false

config import-config -c "Switching to offline administration help"

Restart the Spotfire Server.