Skip to main content

Spotfire Platform Configuration

  • Spotfire requires external authentication to be enabled to work with BI Hub.

v10.6.0#

  1. Register a new OAuth Client.
  • On the computer running Spotfire Server, open a command line as an administrator and change the directory to the location of the config.bat file (config.sh in Linux). The default location is <server installation dir>/tomcat/spotfire-bin.
  • Run the below command to register a new OAuth Client:
$ register-api-client --name="BIHubAPIClient" -S api.soap.user-directory-service -S api.soap.impersonate -S api.soap.library-service
  1. Copy both the Client ID and Client Secret displayed on the output screen.

These details are displayed just once and lost once you close the screen.

  1. Copy and paste the contents of <Spotfire Agent installation folder>/ext_auth to the <Server installation dir>/tomcat/webapps/spotfire/WEB-INF/lib location.

  2. Enable External Authentication and set the type and class name.

  • Open Spotfire Server Configuration utility.

  • In the Configuration tab, select External Authentication in the left panel.

    Enable External Authentication and configure

    Spotfire External Authentication configurations

  • Select Yes to Enable external authentication in the right panel.

  • In the Type label, select Custom Authenticator from the dropdown list.

  • In the Class name label, enter: vbi.spotfireagent.VbiExtAuthenticator.

  • Click Save Configuration and restart Spotfire related services.

If there is an error in starting the Spotfire services, check the access log or system log for any errors and make sure the file is in the location mentioned.

Following are the configuration fields details required from the BI Platform:

  • Spotfire Server URL
  • Spotfire Server Port
  • Spotfire Service Account Username
  • Spotfire Service Account Domain
  • Spotfire Platform Version
  • Client ID – Registered OAuth Client ID
  • Client Secret - Registered OAuth Client ID

v7.10.0#

  • Copy all the files from <spotfire installation location>/ext_auth/ directory and paste them to the location - "tibco\tss\tomcat\lib\webapps\spotfire\WEB-INF\lib".

  • Go to Spotfire Server Configuration > External Authentication, and set the Type as Authentication Filter. This will enable Spotfire Server to use the custom Java authentication filter.

  • Enter the Class Name as - vbi.spotfireagent.VbiExtAuthenticator.

    Users and Groups

    Manage Users and Groups account

  • Create a Service account for the Spotfire agent with both API User, and Impersonator user roles.

  • Click Add Users and add the user members with the Display name, and Composite name.

    Add Users

    Add Users

Restart the server for the changes to take place.

✅ Spotfire agent configured with the BI Platform.