Spotfire® Server and Environment - Installation and Administration

Passing username and password to custom properties in Information Services

For some use cases, you might want to pass the username and password information from an Information Services data source to a specific connection property in the JDBC driver (instead of the standard user and password properties). This can be useful for making use of certain authentication methods when you access data from a database.

To specify the JDBC driver connection properties to which the data source should pass the values from the username and password fields, configure a data source template with the custom credentials provider CustomPropertiesCredentialsProvider.

Tip: To learn how to add a data source template, see Adding a data source template. For sample data source templates for different database types, see JDBC Data Access on the Spotfire Community.

CustomPropertiesCredentialsProvider reference

To use the CustomPropertiesCredentialsProvider class in a data source template, set credentials-provider-class to com.spotfire.ws.im.ds.sql.CustomPropertiesCredentialsProvider.

<credentials-provider-class>com.spotfire.ws.im.ds.sql.CustomPropertiesCredentialsProvider</credentials-provider-class>
 <credentials-provider-init-params>
   <parameter>
     <key>username_property_name</key>
     <value>user</value>
   </parameter>
   <parameter>
     <key>password_property_name</key>
     <value>password</value>
   </parameter>
</credentials-provider-init-params>
Table 1. Initialization parametersThe table lists all initialization parameters (credentials-provider-init-params).
Setting Description
username_property_name

String.

The name of the connection property to which Spotfire should pass the value from the username field in the data source.

Required if password_property_name is not set.

password_property_name

String.

The name of the connection property to which Spotfire should pass the value from the password field in the data source.

Required if username_property_name is not set.