Important Information
TIBCO Spotfire Server Documentation and Support Services
Getting started
Introduction to the TIBCO Spotfire environment
Spotfire Server introduction
Spotfire database introduction
Nodes and services introduction
Spotfire clients introduction
Environment communication introduction
Authentication and user directory introduction
Users and groups introduction
Licenses and preferences introduction
Deployment introduction
Spotfire library introduction
Routing introduction
Data sources introduction
Logging introduction
Administration interface introduction
Example scenario
Upgrading from Spotfire 7.0 or earlier – an introduction
Basic installation process for Spotfire
Installation and configuration
Preparation
Downloading required software
Collecting required information
Setting up the Spotfire database (Oracle)
Setting up the Spotfire database (SQL Server)
Setting up the Spotfire database (SQL Server with Integrated Windows authentication)
Running database preparation scripts manually
Installation
Installing the Spotfire Server files (interactively on Windows)
Installing the Spotfire Server files (silently on Windows)
Installing the Spotfire Server files (RPM Linux)
Installing the Spotfire Server files (Tarball Linux)
Database drivers
Installing the Oracle database driver
Installing database drivers for Information Designer
Applying hotfixes to the server
Initial configuration
Configuration using the configuration tool
Opening the configuration tool
Running the configuration tool on a local computer
Creating the bootstrap.xml file
Setting up the Spotfire Server bootstrap file for Integrated Windows authentication
Saving basic configuration data (authentication towards Spotfire database)
Creating an administrator user
Configuration using the command line
Executing commands on the command line
Executing commands on a local computer
Viewing help on configuration commands
Configuration and administration commands by function
Action log configuration commands
Administration commands
Authentication commands
Client configuration command
Information Services commands
JAAS commands
LDAP commands
Library commands
Monitoring commands
Server configuration commands
Server database commands
Services commands
Spotfire collective commands
User directory commands
Miscellaneous configuration commands
Manually creating a simple configuration
Scripting a configuration
Editing and running a basic configuration script
Script language
Configuration.xml file
Manually editing the Spotfire Server configuration file
Start or stop Spotfire Server
Starting or stopping Spotfire Server (as a Windows service)
Starting or stopping Spotfire Server (Windows, no service)
Starting or stopping Spotfire Server (Windows, service exists, Integrated Authentication for SQL Server)
Starting or stopping Spotfire Server (Windows, no service, Integrated Authentication for SQL Server)
Starting or stopping Spotfire Server (Linux)
Clustered server deployments
Setting up a cluster of Spotfire Servers
Using Hazelcast for clustering
Using ActiveSpaces for clustering
Installing ActiveSpaces
Configuring a server cluster with ActiveSpaces (Windows)
Configuring a server cluster with ActiveSpaces (Linux)
Enabling secure transport for ActiveSpaces
Using Apache Ignite for clustering
Configuring NTLM for a cluster of Spotfire Servers
Enabling health check URL for load balanced servers
Kerberos authentication for clustered servers with load balancer
X.509 client certificates for clustered servers with load balancer
Configuring shared import and export folders for clustered deployments
Deploying client packages to Spotfire Server
User authentication
User name and password authentication methods
Authentication towards the Spotfire database
Authentication towards LDAP
Configuring LDAP
Configuring LDAPS
SASL authentication for LDAP
Configuring Spotfire Server for DIGEST-MD5 authentication of LDAP
Configuring Spotfire Server for GSSAPI authentication of LDAP
Authentication towards Windows NT Domain (legacy)
Combination of LDAP and Spotfire database authentication
Disabling adding database users when using LDAP
Authentication towards a custom JAAS module
Single sign-on authentication methods
NTLM authentication
Downloading third-party components (JCIFS) for NTLM authentication
Creating a computer service account in your Windows domain
Creating a computer service account manually
Configuring NTLM authentication for a single server
Kerberos authentication
Setting up Kerberos authentication on Spotfire Server
Creating a Kerberos service account
Registering Service Principal Names
Creating a keytab file for the Kerberos service account
Configuring Kerberos for Java
Copying the Kerberos service account’s keytab file to Spotfire Server
Using Kerberos authentication with delegated credentials
Enabling constrained delegation
Enabling unconstrained delegation on a domain controller in Windows Server 2003 mode
Enabling unconstrained delegation for an account on a domain controller in Windows 2000 mixed or native mode
Selecting Kerberos as the Spotfire login method
Disabling the username and password fields in the Spotfire Analyst login dialog
Kerberos authentication for clustered servers with load balancer
Setting up Kerberos authentication on nodes
Enabling constrained delegation on nodes
Enable Kerberos authentication for end-users
Enabling Kerberos for Internet Explorer and Spotfire Analyst
Enabling delegated Kerberos for Google Chrome
Enabling Kerberos for Mozilla Firefox
Using Kerberos to log in to the Spotfire database
Creating a Windows domain account for the Spotfire database
Configuring the Spotfire database account to the Windows domain account
Keytab file for the Kerberos service account
Creating a keytab file for the Kerberos service account (using the ktpass.exe command from Microsoft Support Tools)
Creating a keytab file for the Kerberos service account (using the ktpass.exe command from the bundled JDK)
Creating a keytab file for the Kerberos service account (using the ktutil command on Linux)
Creating a JAAS application configuration for the Spotfire database connection pool
Acquiring a Kerberos ticket by using a keytab file
Acquiring a Kerberos ticket by using a username and password
Acquiring a Kerberos ticket by using the identity of the account running the Spotfire Server process
Registering the JAAS application configuration file with Java
Configuring the database connection for Spotfire Server using Kerberos (Oracle)
Configuring the database connection for Spotfire Server using Kerberos (SQL Server)
Authentication using X.509 client certificates
Installing CA certificates
Configuring Spotfire Server to require client certificates for HTTPS
Configuring Spotfire Server to use X.509 client certificates to authenticate users
Configuring anonymous authentication
Web authentication
Configuring OpenID Connect
Advanced OpenID Connect settings
Configuring custom web authentication
Two-factor authentication
Configuring two-factor authentication
Configuring two-factor authentication using the command line
External authentication
Configuring external authentication
External directories and domains
LDAP synchronizations
User synchronization
Group synchronization
Group-based and role-based synchronization
LDAP authentication and user directory settings
Post-authentication filter
HTTPS
Configuring HTTPS
Node manager installation
Installing a node manager interactively
Installing a node manager silently
Starting or stopping a node manager (as a Windows service)
Trusting a node
Automatically trusting new nodes
Automatically installing services and instances
Login behavior configuration
Enabling an RSS feed in the Spotfire login dialog
Service installation on a node
Preconfiguring Spotfire Web Player services (optional)
Installing Spotfire Web Player instances
Multiple service instances on one node
Preconfiguring Spotfire Automation Services (optional)
Installing Spotfire Automation Services instances
Automation Services Job Builder and Client Job Sender
Sites
Creating sites
Setting different authentication methods and user directories for sites
Moving a server and its nodes to a different site
Sites administration
Deleting sites
Connectors
Setting up connectors
Configuring connectors for use with web clients and Spotfire Automation Services
Authentication modes
Connector configuration examples
Connector names in configuration file
Access to the connectors
Installing Oracle Essbase Client on client computers
Creating environment variables
Configuring the Google Analytics connector
Additional configuration
Updating a server configuration in the configuration tool
Running the configuration tool on a local computer
Updating a server configuration on the command line
Manually editing the Spotfire Server configuration file
Manually editing the service configuration files
Viewing the name of the active service configuration
Service configuration files
Spotfire.Dxp.Worker.Automation.config file
Spotfire.Dxp.Worker.Core.config file
Spotfire.Dxp.Worker.Host.exe.config file
Spotfire.Dxp.Worker.Web.config file
Customizing the service logging configuration
Customize statistics and performance counter logging
Service log levels
Configuring a specific directory for library import and export
Enabling cached and precomputed data for scheduled update files
Disabling the attachment manager cache
Post-installation steps
Enabling demo database use
Enabling geocoding tables for map charts
Administration
Opening Spotfire Server
Nodes, services, and resource pools
Creating resource pools
Adding resources to resource pools
Removing resources from resource pools
Changing the name of a resource pool
Deleting resource pools
Updating node managers
Rolling back a node manager update
Updating services
Rolling back a service update
Shutting down a service instance
Revoking trust of a node
User administration
Creating new Spotfire users
Adding a user to one or more groups
Removing a user from one or more groups
Changing a user's name, password, or email
Disabling a user account
Deleting users from the system
Group administration
Roles and special groups
Creating a new group
Adding users to a group
Adding groups to a group
Assigning a primary group to a subgroup
Assigning a deployment area to a group
Renaming a group
Removing members from a group
Deleting groups from the system
Deployments and deployment areas
Creating a new deployment area
Adding software packages to a deployment area
Copying a distribution to another deployment area
Exporting a distribution
Changing the default deployment area
Renaming a deployment area
Removing packages from a deployment area
Clearing a deployment area
Deleting a deployment area
Scheduled updates to analyses
Creating a scheduled update by using Spotfire Server
Additional settings for scheduled updates
Setting the number of Spotfire Web Player instances to make available for a scheduled update
Switching the scheduled update method from automatic to manual
Disallowing cached and precomputed data in individual scheduled update files
Scheduled updates with prompted or personalized information links
Editing a scheduled update
Creating a reusable schedule
Manually updating a file outside of its update schedule
Copying routing rules and schedules from one site to another
Exporting routing rules and schedules for import in a different Spotfire environment
Importing routing rules and schedules from a different Spotfire environment
Disabling or deleting scheduled updates and routing rules
Deleting schedules
Creating a scheduled update by using TIBCO EMS
Creating a scheduled update by using a SOAP web service
Scheduled updates monitoring
Changing the priority of a rule
Changing the number of retries for failed scheduled updates
Changing how often the scheduled update history is cleared
Common analysis loading errors
Routing rules
The default routing rule
Creating a routing rule
Changing the priority of a rule
Disabling or deleting scheduled updates and routing rules
Monitoring and diagnostics
Server and node logging levels
Changing server and node logging levels
Changing the logging level for a server or node that is not running
Switching back to the Standard (default) logging level
Accessing Spotfire Server and node logs
Spotfire Server logs
Location of server logs
Changing the default location of server logs
Node logs
Enabling Kerberos debug logging
Accessing services logs
Service logs
General logging properties
Auditlog
DateTimesLog
DocumentCacheStatisticsLog
MemoryStatisticsLog
MonitoringEventsLog
OpenFilesStatisticsLog
PerformanceCounterLog
Spotfire.Dxp.Worker.Host and Spotfire.Dxp.Worker.Host.Debug
TimingLog
UserSessionStatisticsLog
Action logs and system monitoring
Configure action logging from the command line
Enabling action logging and system monitoring from the command line
Configuring logging to a Microsoft SQL Server database with the command line
Configuring logging to an Oracle database with the command line
Configuring the action log web service from the command line
Configure action logging using the configuration tool
Setting action logging to write to a file from the configuration tool
Setting action logging to write to a database from the configuration tool
Configuring the action log web service from the configuration tool
Importing a library to Spotfire Analyst for analyzing action logs
Setting the action log interval
Database logging
Action log reference
Action log data collected
Action log generic entries
Action log categories
admin actions logged on Spotfire Server
auth actions logged from Spotfire Server
dblogging actions logged from the database
ems action logged from Spotfire Server
info_link actions logged from Spotfire Server
library actions logged from Spotfire Server
routing_rules actions logged from Spotfire Server
scheduled_updates actions logged from Spotfire Server
Automation Services actions logged from the web service
Spotfire Analyst actions logged from the web service
Web Player actions logged from the web service
Action log actions
Action log properties
Action log entries
Sample action log output
System monitoring reference
System monitoring entries
System monitoring properties
Update action logs and system monitoring
Updating the Oracle database
Updating the Microsoft SQL Server database
Server monitoring using JMX
Spotfire Server instrumentation
JMX configuration security features
JMX configuration commands
JMX levels
Enabling the JMX logging appender
Setting up JMX monitoring for JConsole
Services monitoring
Accessing performance data
Web Player analyses information - Overview
Web Player analysis information - Details
Web Player service performance counters
Automation Services instance performance counters
Performance troubleshooting
Examining the statistics of an individual analysis
Logging and exporting monitoring diagnostics
Viewing node information
Viewing service configuration information
Monitoring CPU usage by instances
Viewing assemblies information
Viewing site information
Website diagnostics
Viewing routing
Enabling automatic dump capture from non-responsive Web Players
Basic troubleshooting
Troubleshooting Spotfire Server
Spotfire Server fails to start
Spotfire Server runs out of JVM memory
Users cannot log in
Troubleshooting the Spotfire database
Creating a thread dump
Memory exhaustion
Creating a memory dump
Disabling the memory dump feature
Creating a troubleshooting bundle
Command-based library administration tasks
Importing library content by using the command line
Exporting library content by using the command line
Library content storage outside of the Spotfire database
Configuring external library storage in AWS
Configuring external library storage in a file system
Monitoring external library storage and fixing inconsistencies
Forcing Java to use Internet Protocol version 4
Upgrading Spotfire
Upgrading from Spotfire 7.0 or earlier
Setting up the test environment
Upgrading Spotfire Server
Installation of Spotfire Server during upgrade
Applying hotfixes to the server
Run the Spotfire Server upgrade tool
Running the Spotfire Server upgrade tool interactively
Running the Spotfire Server upgrade tool silently
Start Spotfire Server
Upgrading a cluster of Spotfire Servers
Upgrading Spotfire Analyst clients
Deploy client packages
Upgrading Spotfire Web Player
Mapping content of old configuration files to new service configuration files
Upgrading scheduled updates
Upgrading Spotfire Automation Services
Upgrading authentication method
Anonymous combined with other authentication method
Different authentication methods for Spotfire Server and Web Player
Upgrading load balancing
Upgrading analysis links
Upgrading Web Services API clients
Upgrading customizations
Upgrading custom visualizations
Upgrading cobranding
Upgrading from Spotfire 7.5 or later
Installation of Spotfire Server during upgrade
Preventing Spotfire Servers and node managers from starting automatically
Applying hotfixes to the server
Run the Spotfire Server upgrade tool
Running the Spotfire Server upgrade tool interactively
Running the Spotfire Server upgrade tool silently
Start Spotfire Server
Upgrading nodes
Install node manager
Installing a node manager interactively during upgrade
Run the node manager upgrade tool
Running the node manager upgrade tool interactively
Running the node manager upgrade tool silently
Optional upgrades
Upgrading service configurations
Upgrading custom-modified log4j.properties files
Applying hotfixes to the Spotfire environment
Applying hotfixes for services
Backup and restore
Backup of Spotfire database
Backup of Spotfire Server
Backup of services
Uninstallation
Deleting services
Revoking trust of nodes
Uninstalling node manager
Uninstalling Spotfire Server
Advanced procedures
Custom configurations for managing space needs
Changing the default location of the Web Player temporary files
Temporary tablespace
Virtual memory modification
Modifying the virtual memory (server not running as Windows service)
Modifying the virtual memory (server running as Windows service)
Data source templates
Setting up MySQL5 vendor driver
Data source template commands
XML settings for data source templates
JDBC connection properties
Advanced connection pool configuration
Kerberos authentication for JDBC data sources
Creating an Information Services data source template using Kerberos login
Verifying a data source template
Information Services settings
Default join database
Spotfire Server public Web Services API's
Enabling the Web Services API
Generating client proxies
Optional security HTTP headers
X-Frame-Options
X-XSS-Protection
HTTP Strict-Transport-Security (HSTS)
Cache-Control
X-Content-Type-Options
Changing how long the server waits before assuming that a node manager is offline
Setting the maximum execution time for an Automation Services job
Setting the maximum inactivity time for an Automation Services job
Absolute session timeout and idle session timeout
Setting idle session timeout and absolute session timeout by using the configuration tool
Setting idle session timeout by using the command line
Setting absolute session timeout by using the command line
Changing whether scheduled updates are sent to exhausted service instances
Preventing users from opening scheduled update files outside of their schedule window
Changing whether recovered rules are automatically enabled
Restarting a node manager to terminate its running jobs
Increase the number of available sockets on Linux
Switching from online to offline administration help
Displaying or hiding the Spotfire Server version
Contacting support
Reference
Spotfire Server files
Bootstrap.xml file
Server.xml file
Krb5.conf file
Server bootstrapping and database connection pool configuration
Database connectivity
Database drivers and database connection URLs
Command-line reference
add-ds-template
add-member
bootstrap
check-external-library
clear-join-db
config-action-log-database-logger
config-action-logger
config-action-log-web-service
config-anonymous-auth
config-attachment-manager
config-auth
config-auth-filter
config-basic-database-auth
config-basic-ldap-auth
config-basic-windows-auth
config-client-cert-auth
config-cluster
config-csrf-protection
config-custom-web-auth
config-encryption
config-external-auth
config-external-scheduled-updates
config-import-export-directory
config-jmx
config-kerberos-auth
config-ldap-group-sync
config-ldap-userdir
config-library-external-data-storage
config-library-external-file-storage
config-library-external-s3-storage
config-login-dialog
config-ntlm-auth
config-oidc
config-persistent-sessions
config-post-auth-filter
config-public-address
config-scheduled-updates-retries
config-two-factor-auth
config-userdir
config-web-service-api
config-windows-userdir
copy-group-membership
copy-library-permissions
copy-rules-to-site
create-default-config
create-jmx-user
create-join-db
create-ldap-config
create-site
create-user
delete-disabled-users
delete-disconnected-groups
delete-jmx-user
delete-library-content
delete-node
delete-oauth2-client
delete-service-config
delete-site
delete-user
demote-admin
enable-user
export-config
export-ds-template
export-groups
export-library-content
export-rules
export-service-config
export-users
help
import-config
import-groups
import-jaas-config
import-library-content
import-rules
import-scheduled-updates
import-service-config
import-users
invalidate-persistent-sessions
list-active-service-configs
list-addresses
list-admins
list-auth-config
list-certificates
list-configs
list-deployment-areas
list-ds-template
list-groups
list-jaas-config
list-jmx-users
list-ldap-config
list-ldap-userdir-config
list-licenses
list-logging
list-nodes
list-ntlm-auth
list-oauth2-clients
list-online-servers
list-post-auth-filter
list-service-configs
list-service-instances
list-services
list-sites
list-userdir-config
list-users
list-windows-userdir-config
manage-deployment-areas
modify-db-config
modify-ds-template
promote-admin
register-job-sender-client
remove-ds-template
remove-jaas-config
remove-ldap-config
remove-license
reset-trust
run
s3-download
set-addresses
set-config
set-config-prop
set-db-config
set-license
set-logging
set-public-address
set-server-service-config
set-service-config
set-site
set-user-password
show-basic-ldap-auth
show-config-history
show-deployment
show-import-export-directory
show-join-database
show-library-permissions
show-licenses
show-oauth2-client
switch-domain-name-style
test-jaas-config
trust-node
untrust-node
update-bootstrap
update-deployment
update-ldap-config
version
Glossary