How to export the Spotfire server configuration using the command line interface.

How to export the Spotfire server configuration using the command line interface.

book

Article ID: KB0083535

calendar_today

Updated On:

Products Versions
Spotfire Server 6.5 and higher

Description

It is possible to export the Spotfire server configuration from the database to an XML file. This can be useful if you want to copy a configuration from a production environment to a development environment or if you need to manually edit the configuration

Resolution

Windows:
  1. Open a command prompt.
  2. CD into the bin folder of the Spotfire server installation directory, e.g "<server install dir>\tomcat\bin"(default C:\tibco\tss\x.x.x\tomcat\bin)".
  3. Run this command to export the configuration using the default values:
    • config.bat export-config
  4. When prompted, enter the "Tool Password" that you created when creating the bootstrap file for the Spotfire server.
The  configuration will now have been saved as "configuration.xml" in the bin folder.
 
Linux:
  1. CD into the bin folder of the Spotfire server installation directory, e.g "<server install dir>/tomcat/bin"(default /user/local/bin/tibco/tss/x.x.x/tomcat/bin)".
  2. Run this command to export the configuration using the default values:
    • config.sh export-config
  3. When prompted, enter the "Tool Password" that you created when creating the bootstrap file for the Spotfire server.
The configuration will now have been saved as "configuration.xml" in the bin folder.

 

 

More information on using the command:

OVERVIEW
    This command is used to export a server configuration from the server database to a file. The configuration in the file can be edited and then imported back into the server database using the 'import-config' command.
 
OPTIONS
    The arguments are as follows:
 
    -f
    --force
        The force flag indicates whether or not the tool overwrites an existing destination file. This argument is optional.
 
    -b value
    --bootstrap-config=value
        The path to the bootstrap configuration file. See the 'bootstrap.xml' help topic for more information about this file. This argument is optional.
 
    -t value
    --tool-password=value
        The configuration tool password used to decrypt the database password in the bootstrap.xml file. If the tool password is omitted, the command will prompt the end-user for it on the console. See the        'bootstrap.xml' help topic for more information. This argument is optional.
 
    -h value
    --hash=value
        The (possibly abbreviated) hash of the configuration to export. Must consist of at least 6 hexadecimal characters. This argument is optional.
 
    [export file]
        The path to the configuration file to create. This argument is optional. The default value is "configuration.xml".

Issue/Introduction

How to export the Spotfire server configuration using the command line interface.

Additional Information

TIBCO Spotfire Server manual:
https://docs.tibco.com/pub/spotfire_server/6.5.2/doc/pdf/TIB_sfire_server_doc_ServerInstallationManual.pdf