The command line offers more experienced administrators quick
access to a wider variety of options than the configuration tool.
Before you begin
You must have
administrative credentials for Spotfire Server. If Spotfire Server is set up to
authenticate with the Spotfire database using Windows Integrated
Authentication, you must run commands as the same user that Spotfire Server
authenticates as. Otherwise, the commands cannot authenticate with the
database.
Procedure
-
On the computer running Spotfire Server, open a command line as an
administrator (or, if you are using Windows Integrated Authentication, as the
Spotfire Server database user) and change the directory to the location of the
config.bat file (config.sh
on Linux). The default location is
<server installation
dir>/tomcat/spotfire-bin.
This is where you execute commands.
-
Export the active server configuration (the
configuration.xml file) by using the
export-config command.
Example:
config export-config --tool-password=mypassword
-
On the command line, enter
config (config.sh on Linux)
followed by the command and any required parameters.
-
After you have finished running commands, upload the modified
configuration back to the
Spotfire
database by using the
import-config command. The
configuration that you import becomes the active configuration for that server
or cluster.
Example:
config import-config --tool-password=mypassword --comment=what was changed
-
Restart
Spotfire Server;
for instructions, see
Start or stop Spotfire
Server.
Note: Because the
configuration.xml file contains confidential
information, you may want to restrict access to it.