Creating the bootstrap.xml file

The bootstrap.xml file configures the database connection.


Spotfire Server is installed.
Note: For Integrated Windows authentication (IWA) between Spotfire Server and the Spotfire database, see Setting up the Spotfire Server bootstrap file for Integrated Windows authentication.


  1. If the configuration tool is not open, open it; for instructions see Opening the configuration tool.
    The configuration tool opens to the System Status page, which lists the necessary configuration steps.
  2. Click Create new bootstrap file.
    The Bootstrap page is displayed.
  3. Enter the following information in the fields:
    Path You may leave the default path as is.
    Driver template Select a template that is compatible with your database server.
    Hostname The Spotfire database host name (the address of the computer on which the SQL or Oracle database is installed).
    Port The Spotfire database port.
    Identifier (SID/database/service) The Server ID (for Oracle) or the database name (for MS SQL) of the Spotfire database that was created; spotfire_server is the default.
    Username The name of the database account used by Spotfire Server to connect to the Spotfire database. In the create_databases.bat file, this is the value for ADMINNAME.
    Password The password of the database account. Enter correct database login details, as specified earlier. In the create_databases.bat file, this is the value for ADMINPASSWORD
    URL The JDBC connection URL. This field is pre-populated from selections made but can be edited.
    Driver class This field is pre-populated from selections made, and cannot be edited. To be able to select Oracle, you must also download the JDBC driver.

    For details, see Database drivers and database connection URLs

    Configuration tool password Enter a configuration tool password of your choice. This will be used to protect the server configuration from unauthorized access.
    Note: The configuration tool password will be required when running the configuration tool.
    Server alias Enter any unique name for the Spotfire Server.
    Encryption password (optional) Enter an encryption password of your own choice. This will be used for encrypting other passwords stored in the Spotfire database. The passwords are encrypted with a static key if no encryption password is specified here.
    Addresses These values should match actual hostnames, fully qualified domain names ( FQDN ), and IP addresses (IPv4 or IPv6) at which the Spotfire Server can be reached by other Spotfire Servers and nodes.

    If any of these values do not describe the server, or are on a network that will not be used for back-end communication, you should remove them.

    If you changed the hostname, domain, or IP address, add the new values.

    Note: Valid hostnames may only contain alphabetic characters, numeric characters, hyphen and period.
    Note: If you want to change these addresses after setting up your environment, use the set-addresses command.

    If you plan to use sites in your implementation you should assign the server to a site now. If you have not yet created the sites, see Creating sites. After creating the sites, click Lookup to select a site for this server. For more information, see Sites.

  4. Click Save Bootstrap.
    The configuration tool checks that database drivers are installed and that the database is running. It also checks that the database accepts the given credentials. A message indicates whether the bootstrap file was successfully created. After it is created, the Configuration page of the configuration tool is displayed.
Related reference