Spotfire Server and Environment - Quick Start

Managing data source templates

When you use Information Services to access data from a JDBC data source, you must have a data source template for that data source. When you have installed the appropriate driver and data source template on the Spotfire Server, you can use the Information Designer tool in the installed Spotfire client to create information links for accessing data from that data source.

Overview

Data source templates are XML configuration files. They define JDBC connections for Information Services by specifying which driver will be used, how the connection string should be formatted, and other settings needed for successfully connecting to a database.

Several data source templates and JDBC drivers are included in the Spotfire Server installation. As an Information Services Configurator, you can add custom data source templates. This way, you can enable users to create information links to more types of data sources.

Template status and availability

When you view the data source templates list in the administration page, two columns indicate the state of a template:

  • Status
    • Valid indicates that the template configuration is valid, and the required JDBC driver is successfully installed on the Spotfire Server.
    • Warning indicates a configuration issue. In most cases the required driver is missing and needs to be deployed. Contact your Spotfire administrator if this is the case.
  • Availability

    Indicates whether users can use this template to create new information links and whether the dependent data sources will work. A disabled template is not visible to users, which could be good alternative to deletion. Edit the template to switch the availability.

    Note: You can see the dependent data sources in the library by right-clicking on a template and selecting Copy library search query for dependent data sources. Paste the contents into the library search field.

Supported functionality

You can manage data source templates in two different ways:
  • Using the server administration page (Configuration > Data source templates).
  • Using command-line commands. Find a list of the commands in Data source template commands.
Note: Not all features are available for both ways. See the table below for the differences.
Task Web administration pages Command-line commands
Add a data source template to the environment Yes Yes
Download template XML of a specific version Yes No
Enable/disable a template Yes Yes
Edit the template XML Yes No
Export a single template Yes Yes
Export all templates on the environment No Yes
Import a single template Yes No
Import all templates specified in a file No Yes
Remove a data source template Yes Yes
Restore a template to a previous version Yes No
Validate a data source template connection No Yes
View dependent data sources Yes Yes
View template versions and their comments Yes No
Verify template status Yes No
Verify template XML Yes No