Configuring an external library for TIBCO Data Virtualization

To be able to search and browse your TIBCO Data Virtualization (TDV) data directly in the Files and Data flyout, you must configure your TDV integration. This article describes how you do this by setting the External library configurations preference in the Administration Manager.

Setting the preferences

About this task

Procedure

Log in as a Spotfire administrator and open the Administration Manager (Tools > Administration manager).
In the Administration Manager dialog, on the Preferences tab, click to select the user group you want to edit preferences for.
On the Preferences tab, click Edit.
Select External library configurations and click … on the left to open the String Collection Editor.

Add your TIBCO Data Virtualization server details. As a starting point, copy and paste either of the following code snippet and use it as a template.

Authentication method Template

Identity Provider (OAuth2)

Authentication method	Template
Identity Provider (OAuth2)	`[ { type: "Spotfire.TDVLibrary", properties: { displayName: "TDV (OAuth2)", server: "my-tdv-server.com:9401", encrypt: "false", authenticationMethod: "OAuth2", domain: "keycloak", issuer: "https://issueridentifier.example.com" } } ]`
Kerberos Authentication	`[ { type: "Spotfire.TDVLibrary", properties: { displayName: "TDV (Kerberos)", server: "my-tdv-server.com:9401", encrypt: "false", authenticationMethod: "Kerberos", spn: "HTTP/my-tdv-server.com@EXAMPLE.COM" } } ]`

[
 {
   type: "Spotfire.TDVLibrary",
   properties: {
     displayName: "TDV (OAuth2)",
     server: "my-tdv-server.com:9401",
     encrypt: "false",
     authenticationMethod: "OAuth2",
     domain: "keycloak",
     issuer: "https://issueridentifier.example.com"
   }
 }
]

Kerberos Authentication

[
 {
   type: "Spotfire.TDVLibrary",
   properties: {
     displayName: "TDV (Kerberos)",
     server: "my-tdv-server.com:9401",
     encrypt: "false",
     authenticationMethod: "Kerberos",
     spn: "HTTP/my-tdv-server.com@EXAMPLE.COM"
   }
 }
]

Tip: For an overview of the possible properties, see the Properties table below.

When you have filled in the information, click OK to close the String Collector Editor.
Click OK again to close the External library configurations preference.

Properties

This table lists the properties and their corresponding values that you can set in the External library configurations preference. You can only edit the properties, the first row that contains type: "Spotfire.TDVLibrary" must remain unchanged.

Note: The properties that you set in this preference correspond data source properties for the TIBCO Data Virtualization conenctor. If you do not set an optional property, it will be set to its default value.


Property	Description
displayName (optional)	The name that is displayed in the Files and Data flyout. The default value is `Data catalog`.
encrypt (optional)	Set `true` to enable TLS for connections to the data source. The default value is false.
searchMode (optional)	Set to `tablesOnly` to gain search performance. Set to `None` to turn off the search of TDV data. The default value is `full`.
server	The name of the TDV server where your data is located. To include a port number, add it directly after the name preceded by a colon. Example with port number: `my-tdv-server.com:9401`
authenticationMethod	Kerberos (Default) Use Kerberos to log in to TDV. OAuth2 Use an identity provider, such as Okta or Keycloak, to log in to TDV. To be able to use this authentication method, you must add your identity provider in the Spotfire configuration. See Single sign-on with an identity provider (OAuth2) for connectors.
spn	The service principal name (SPN) used to identify the Kerberos authentication service.
domain	[Only applicable when authenticationMethod is OAuth2.] The authentication domain to use when logging into the TIBCO Data Virtualization system.
issuer	[Mandatory if authenticationMethod is Oauth2.] The issuer identifier (a URL) of the identity provider you want to use for authentication. Must be the same as the issuer identifier of an identity provider in the `OAuth2IdentityProviders` preference.

Example with more than one TDV server

You can configure several TDV instances to be shown in the Files and Data flyout one below the other. In this case, you will have to add additional configurations similar to the example below.

[
  {
  type: "Spotfire.TDVLibrary",
  properties: {
    displayName: "TDV instance",
    server: "my-tdv-server.com:9401",
    encrypt: "false",
    spn: "HTTP/my-tdv-server.com@EXAMPLE.COM"
    }
  },
  {
  type: "Spotfire.TDVLibrary",
  properties: {
    displayName: "TDV other instance",
    server: "my-other-tdv-server.com",
    encrypt: "true",
    spn: "HTTP/my-other-tdv-server.com@EXAMPLE.COM"
    }
  }
]