Spotfire Server and Environment - Quick Start

validate-data-source

Facilitates testing and troubleshooting of data source templates for Information Services data sources.

validate-data-source 
[-c value | --configuration=value] 
[-b value | --bootstrap-config=value] 
<-n value | --name=value> 
<template-definition-file> 
[--get-metadata] 
<-u value | --user=value> 
<-p value | --password=value> 
[--catalog-name=value] 
<--connection-url=value> 
[--temp-table-write-allowed] 
[--output-file=value] 
[--schema-name=value] 
[--max-connections=value] 
[--min-connections=value] 
{--session-open-commandsvalue} 
{--session-close-commandsvalue} 
{--initialization-commandsvalue}

Overview

Use this command to run a connection test towards a JDBC-compliant data source that you want to access data from with Information Services, using the configurations from a data source template .xml file. The purpose of the test is to help you to assess the compatibility of the data source template with the data source, the installed JDBC driver, and Spotfire Server, before you add the data source template to the Spotfire configuration.
Note: It is only supported to validate data sources and data source templates with username and password authentication.

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.
-n value
--name=value
Mandatory none Specifies the name for the data source to test. The name can be any string value.
template-definition-file
Mandatory none Specifies the path to the data source template .xml file.
--get-metadata
Optional False Specifies whether to fetch metadata (for catalog/schema/tables) from the data source.
-u value 
--user=value
Mandatory none Specifies the username for the data source.
-p value
 --password=value
Mandatory none Specifies the password for the data source.
--catalog-name=value
Optional none Specifies the catalog name in the data source.
--connection-url=value
Mandatory none Specifies the connection URL for the data source connection.
--temp-table-write-allowed
Optional False Specifies whether temporary table creation is allowed for the data source.
--output-file=value
Optional none Specifies the path where to log the console output in a file.
--schema-name=value
Optional none Specifies the schema name in the data source.
--max-connections=value
Optional none Specifies the maximum number of connections allowed for the data source.
--min-connections=value
Optional none Specifies the minimum number of connections allowed for the data source.
--session-open-commandsvalue
Optional none Specifies a list of session open commands. This argument is optional and may be specified multiple times with different values.
--session-close-commandsvalue
Optional none Specifies a list of session close commands. This argument is optional and may be specified multiple times with different values.
--initialization-commandsvalue
Optional none Specifies a list of initialization commands. This argument is optional and may be specified multiple times with different values.