Importing the Spotfire server configuration using the command line interface.

Products	Versions
Spotfire Server	7.5 or higher

Description

Description:
It is possible to export the Spotfire server configuration from the database to an XML file and then import it on another server. 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.

Issue/Introduction

Environment

Windows and Linux

Resolution

Windows:

Open a command prompt.
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)".
Run the following command to export the configuration using the default values:
- config.bat import-config -c "A comment of your choice"
When prompted, enter the "Tool Password" that you created when creating the bootstrap file for the Spotfire server.

This will import a configuration file named configuration.xml from the bin folder into the Spotfire server database. See "Advanced usage" if your XML file is named something else or located somewhere else.

Linux:

Open a command prompt.
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)".
Run the following command to export the configuration using the default values:
- config.sh import-config -c "A comment of your choice"
When prompted, enter the "Tool Password" that you created when creating the bootstrap file for the Spotfire server.

This will import a configuration file named configuration.xml from the bin folder into the Spotfire server database. See "Advanced usage" if your XML file is named something else or located somewhere else.

Advanced usage:

OVERVIEW

This command is used to import a server configuration from a file to the server database and setting it as the current configuration. Such a server configuration file can be generated either by running the 'export-config' command or by creating a new default configuration using the 'create-default-config' command. If an identical configuration file already exist in the server database, the existing configuration will get its description updated.

OPTIONS

The arguments are as follows:

-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.

-c value

--comment=value

A comment describing the reason for the configuration change. Make sure to enclose the specified comment in quotes and to quote all special characters that might otherwise be consumed by the command

line shell. This argument is mandatory.

-d <true|false>

--delete-file=<true|false>

Indicates whether the imported configuration file should be deleted from the file system or not after a successful import. This argument is optional. The default value is 'false'.

[import file]

The path to the configuration file to import. This argument is optional. The default value is 'configuration.xml'.

Additional Information

TIBCO Spotfire server manual:

https://docs.tibco.com/pub/spotfire_server/6.5.2/doc/pdf/TIB_sfire_server_doc_ServerInstallationManual.pdf

Welcome to "KB Articles"