Configuration using the command-line configuration tool
1. On the local computer, on the System Status page of the graphical configuration tool, create a new bootstrap file or use an existing bootstrap file
2. Copy the bootstrap.xml file from the server computer to the local computer.
You can now run the command-line tool on this computer.
3. Each time that you run a command on the local computer, specify the location of the bootstrap file by using the [-b value | --bootstrap-config=value] option.
Example
To run the command export-config on a local computer, where the bootstrap.xml file was placed on the desktop:
config export-config -b=C:\bootstrap.xml
Viewing help on configuration commands in the command-line tool
You can view information about commands and their parameters from within the command-line tool.
Procedure
1. Open a command-line interface and go to the folder that contains the configuration command-line tool, config.bat.
The default location is c:\tibco\tss\7.5.0\tomcat\bin. 2. Type config help <command name> and press Enter.
Configuration and administration commands by function
You can run the following commands in the command-line tool to configure and manage Spotfire Server.
These frequently-used commands are grouped by functional area for easy reviewing. Command details are available in the Command-line reference. You can also view command details by running the help
command in the line tool (see Viewing help on configuration commands in the command-line tool). The command parameters to use depend on your system setup and environment.
Most configuration commands work towards the configuration.xml file, which can be exported using the export-config command, and then edited. To upload the configuration file to the Spotfire database, use the import-config command and database connection information from the
bootstrap.xml file, which is created by the bootstrap command.
Administration commands
To perform one of these basic administration tasks, use the related command. All administration commands connect directly to the Spotfire database.
Add a user or group as a member of a specified group. add-member
Create a new user account. create-user
Delete disabled users. delete-disabled-users
Delete disconnected groups. delete-disconnected-groups
Delete a user account. delete-user
Revoke full administrator privileges from a user. demote-admin Enable or disables a user in the Spotfire database. enable-user Export groups from the user directory. export-groups
Export content from the library. export-library-content Export users from the user directory. export-users
Import groups to the user directory. import-groups
Import content into the library. import-library-content
Import users to the user directory. import-users
List the server administrators. list-admins
List the deployment areas. list-deployment-areas
List all groups. list-groups
List all online servers. list-online-servers
List all users. list-users
Manage the deployment areas. manage-deployment-areas
Assign full administrator privileges to a user. promote-admin
Remove a license from a group. remove-license
Set a license and license functions for a group. set-license
Show the current deployment. show-deployment
Show permissions for a specific directory in the library. show-library-permissions
Show licenses set on the server. show-licenses
Switch the domain names for all users and groups from one style (DNS or NetBIOS) to the other (for all
configured domains).
switch-domain-name-style
Update the current deployment. update-deployment
Authentication commands
To perform an authentication task, use the related command.
Configure authentication mode and default domain. config-auth Configure the authentication filter. config-auth-filter Configure the Spotfire database authentication source for
use with the basic authentication method. config-basic-database-auth Configure the LDAP authentication source for use with
the basic authentication method. config-basic-ldap-auth Configure the Windows NT authentication source for use
with the basic authentication method. config-basic-windows-auth Configure the CLIENT_CERT authentication method. config-client-cert-auth Configure the external authentication method. config-external-auth
Configure the authentication service used with the
Kerberos authentication method. config-kerberos-auth
Configure the authentication service used with the NTLM
authentication method. config-ntlm-auth
Configure the post-authentication filter. config-post-auth-filter Configure two-factor authentication. config-two-factor-auth Display the currently configured authentication mode. list-auth-mode
Display the current authentication configuration. list-auth-config Display the NTLM authentication service configuration. list-ntlm-auth Display the current post-authentication filter
configuration. list-post-auth-filter
Show the LDAP authentication source for use with the
basic authentication method. show-basic-ldap-auth
Database connection commands
To perform a database connection task, use the related command.
Add a new data source template. add-ds-template
Clear the default join database configuration. clear-join-db Configure the default join database. create-join-db Export the definition of a data source template. export-ds-template
List the data source templates. list-ds-template
Modify a data source template. modify-ds-template
Remove a data source template. remove-ds-template
Show the configured default join database. show-join-database
JAAS commands
To perform a JAAS configuration task, use the related command.
Import new JAAS application configurations into the
server configuration. import-jaas-config
List the JAAS application configurations. list-jaas-config Remove the specified JAAS application configurations
from the server configuration. remove-jaas-config
Test a JAAS application configuration.
The test-jaas-config command connects to the database in a read operation.
test-jaas-config
Client login command
To configure the login experience of end users connecting to Spotfire Server, use this command.
Configure the client login dialog behavior. config-login-dialog
Monitoring commands
To configure and administer JMX access to the monitoring component, use the related command. All monitoring commands connect directly to the database except for config-jmx.
Configure the user action database logger. config-action-log-database-logger
Configure the user action logger. config-action-logger
Configure the action log web service. config-action-log-web-service
Configure the JMX RMI connector. config-jmx
Create a new JMX user account. create-jmx-user
Delete a JMX user. delete-jmx-user
List all JMX users. list-jmx-users
LDAP commands
To manage LDAP configuration for both authentication and the user directory, use the related command.
Configure group synchronization for an LDAP
configuration. config-ldap-group-sync
Configure the LDAP user directory mode. config-ldap-userdir Create a new LDAP configuration to be used for
authentication and/or the user directory LDAP provider. create-ldap-config
Display LDAP configurations. list-ldap-config
Remove LDAP configurations. remove-ldap-config
Set the authentication mode. set-auth-mode
Set the user directory mode. set-userdir-mode
Update LDAP configurations. update-ldap-config
Library commands
To configure and administer the Spotfire library, use the related command.
Check for inconsistencies between external storage and
Spotfire database. check-external-library
Configure the library import/export directory. config-import-export-directory Configure the external library data storage. config-library-external-data-storage Configure the file system storage of library item data. config-library-external-file-storage Configure the Amazon S3 storage of library item data. config-library-external-s3-storage
Delete library content. delete-library-content
Download the data of library items in Amazon S3 storage. s3-download
Show the library import/export directory. show-import-export-directory
Server configuration commands
To perform basic server configuration tasks, use the related command. Server configuration commands connect directly to the database, except for create-default-config.
Create a new server configuration file containing the default
configuration. create-default-config
Export a server configuration from the server database to the
current working directory as a configuration.xml file. export-config Import a server configuration from a file to the server
database. import-config
List all available server configurations. list-configs Set the current server configuration. set-config
Show the configuration history. show-config-history
Server database commands
To manage the server database connection pool, use the related command. Server database commands connect directly to the database except for bootstrap, which can connect to the database to test the bootstrap configuration but does not change the database.
Create database connection information and stores it in the
bootstrap.xml file. See The bootstrap.xml file. bootstrap
Modify the common database connection configuration. modify-db-config Set the common database connection configuration. set-db-config
User directory commands
To configure the user directory, use the related command.
Configure the LDAP user directory mode. config-ldap-userdir
Configure the user directory. config-userdir
Configure the Windows user directory mode. config-windows-userdir List the configuration for the user directory LDAP mode. list-ldap-userdir-config List the current user directory configuration. list-userdir-config List the currently configured user directory mode. list-userdir-mode List the configuration for the user directory Windows NT
mode. list-windows-userdir-config
Miscellaneous commands
Configure the Attachment Manager, which handles data
transfer to and from Spotfire Server. config-attachment-manager Display the help overview or a specific help topic. help
Run a configuration script. run
Display the current version of the server. version
Manually creating a simple configuration
You can configure Spotfire Server by executing a series of commands in the configuration command-line tool.
These instructions are for using the Spotfire database to authenticate users.
Prerequisites
● The Spotfire database has been set up; see Setting up the Spotfire database (Oracle) or Setting up the Spotfire database (SQL Server).
● The Spotfire Server files have been installed; see Installation.
Procedure
1. Run the bootstrap command to create the connection configuration that Spotfire Server needs for connecting to the database.
If you have already run the bootstrap command, there is no need to run it again unless you want to use different arguments.
a) In the following command block, replace the argument values with the appropriate values:
--driver-class The fully qualified class name of the JDBC driver
--database-url The JDBC connection URL
--username The name of the database account used by Spotfire Server to connect to the Spotfire database
--password The password of the database account
--tool-password Choose a configuration command-line tool password that will be used to protect the server configuration from unauthorized access and/or modification
A bootstrap.xml file is created in the <installation directory>\tomcat\webapps\spotfire
\WEB\INF folder. For more information about this file, see The bootstrap.xml file.
2. Create a default configuration by using the create-default-config command.
A configuration.xml file is created.
3. Import the configuration to the database by using the import-config command.
a) In the following command block, replace the argument values with the appropriate values:
> config import-config tool-password="<CONFIG TOOL PASSWORD>" --comment="<DESCRIPTION>"
Example
> config import-config --tool-password="configtoolpwd" --comment="First config"
4. Create a first user by using the create-user command. This account can be used to log in to Spotfire Server.
a) In the following command block, replace the argument values with the appropriate values:
> config create-user --tool-password="<CONFIG TOOL PASSWORD>" --username=
"<SPOTFIRE ADMIN USERNAME>" --password="<SPOTFIRE ADMIN PASSWORD>"
Example
> config create-user tool-password="configtoolpwd" --username="SpotfireAdmin" --password="s3cr3t"
5. Add the first user to the Administrator group by using the promote-admin command.
a) In the following command block, replace the argument values with the appropriate values:
> config promote-admin tool-password="<CONFIG TOOL PASSWORD>" --username="<SPOTFIRE ADMIN USERNAME>"
Example
> config promote-admin tool-password="configtoolpwd" --username="SpotfireAdmin"
When Spotfire Server is running, the first administrator can create other users and add them to the
For more experienced administrators, Spotfire Server includes two prepared configuration scripts that you can use to set up simple configurations. You can also create and run your own scripts.
● The simple-config.txt file sets up Spotfire database authentication and the user directory.
● The simple-config-ldap.txt file sets up LDAP authentication and the user directory.
These scripts are located in the <installation dir>/tomcat/bin folder.
Example: The simple-config.txt file
The simple-config.txt file, shown below, is divided into three sections:
● The first two lines describe how the script is executed.
● The second section is a list of the variables that are used by the commands.
● The rest of the script contains the commands.
# Run this script from the command-line using the following command:
# config run simple-config.txt
# Before using this script you need to set the variables below:
set DB_DRIVER = "tibcosoftwareinc.jdbc.oracle.OracleDriver"
echo Creating the '${ADMIN_USER}' user to become administrator
create-user --tool-password="${CONFIG_TOOL_PASSWORD}" --username=\ "$
{ADMIN_USER}" --password="${ADMIN_PASSWORD}"
echo
echo Promoting the user '${ADMIN_USER}' to administrator
promote-admin --tool-password="${CONFIG_TOOL_PASSWORD}" --username=\
"${ADMIN_USER}"