Spotfire® Server and Environment - Installation and Administration

config-library-external-data-storage

Configures the external library data storage.

config-library-external-data-storage 
[-c value | --configuration=value] 
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value] 
<-e <true|false> | --enabled=<true|false>> 
[-s value | --external-storage=value] 
[-f | --force]

Overview

Use this command for general configuration of the external library data storage.

When this feature is enabled, the structure of the library is stored in the Spotfire database, while the actual data of library items is stored elsewhere.

The library must have been migrated completely when you switch to or from an external data storage. The suggested procedure for switching is described in Configuring and migrating to external library storage. Switching storage modes without proper migration of library items can cause data to be lost.

Spotfire supports different options for external data storage. See Library content storage outside of the Spotfire database for more information. When enabling this feature, you must configure the storage using either the config-library-external-s3-storage command, the config-library-external-azure-blob-storage command, the config-library-external-google-cloud-storage command, or the config-library-external-file-storage command.

Options

Option Optional or Required Default Value Description
-c value
--configuration=value
Optional configuration.xml The path to the server configuration file.
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-t value
--tool-password=value
Optional none The configuration tool password used to decrypt the database password in the file bootstrap.xml. If the tool password is omitted, the command prompts the user for it in the console. Refer to Bootstrap.xml file.
-e <true|false>
--enabled=<true|false>>
Required none Specifies whether external library data storage should be enabled.
-s value
--external-storage=value
Optional none The external storage to use. The following names are valid: 'AMAZON_S3', 'AZURE_BLOB_STORAGE', 'GOOGLE_CLOUD_STORAGE' and 'FILE_SYSTEM'.
-f
--force
Optional none Indicates that the tool should change the library configuration even if the library is not properly migrated.