Adding a Tibco Spotfire (V2) Connection¶

Prerequisites¶

• A user with sufficient permissions is required to establish a connection with Spotfire.
• Zeenea traffic flows towards the server must be open.

Supported Versions¶

The Spotfire connector was developed and tested with Spotfire Server version 11.6.0.

Installing the Plugin¶

You can download the Spotfire plugin from Zeenea Connector Downloads.

For more information about how to install a plugin, see Installing and Configuring Connectors as a Plugin.

Declaring the Connection¶

Connectors are created and configured through a dedicated configuration file located in the /connections folder of the relevant scanner.

For more information about managing connections, see Managing Connections.

To establish a connection with a Spotfire Server instance, fill in the following parameters in the dedicated configuration file:

User Permissions¶

To collect metadata, the running user's permissions must allow them to access and read Spotfire analytics that need cataloging.

If the connector's strategy is set to webservice, the user must have sufficient permissions to call the library-services web service. The client must have the following permissions:

export CONFIG_TOOL_PASSWORD=""
scope=-Sapi.soap.library-service
./config.sh register-api-client --tool-password="${CONFIG_TOOL_PASSWORD}" --name=zeenea-scanner $scope --client-profile=other -Gclient_credentials

If connector's strategy is set to database, configured user must have read access to the following Spotfire tables in associated database:

• lib_data
• lib_items
• lib_item_types
• lib_resolved_depend
• lib_properties
• users

Data Extraction¶

To extract information, the connector runs requests on the Web Services API. During inventory, the connector collects the list of Spotfire analyses accessible to the configured client. When the connector's strategy is set to database, the inventory retrieves data directly from the Spotfire internal database. During inventory, the connector gets the .dxp file of the analysis and identifies datasets it contains. When importing datasets or analyses, the connector performs the same extraction from .dxp files. If caching is enabled (see cache.enabled property), inventory stores the analysis and dataset metadata in the cache and then reads from the cache during import.

Collected Metadata¶

Inventory¶

Collects the list of analyses and their contained datasets that the user can access.

Lineage¶

The Spotfire connector can retrieve the lineage between datasets imported into the catalog. Datasets from other connections must be imported into the catalog before they can be linked to a Spotfire dataset. This feature is available for the following systems. To enable it, an additional parameter is needed in the source system connection as configured in the Spotfire server.

Visualization¶

A visualization represents a Spotfire analysis.

• Name
• Source Description

• Technical Data:

  • Path
  • Parent Id
  • Created By Domain Name
  • Modified By Domain Name
  • Creation Date
  • Modification Date
  • Page Count
  • Visualization Count
  • Table Count
  • Column Count
  • Embed All Source Data
  • Size
  • Total Table Load Time

Dataset¶

A dataset is a data set used in a Spotfire analysis.

• Name
• Source Description: Description not retrieved

• Technical Data:

  • Database type
  • Catalog name
  • Schema name
  • Table type
  • Dataset group

Fields¶

Dataset field.

• Name
• Source Description: Description not retrieved
• Type
• Can be null: Not supported. Default value is false.
• Multivalued: Not supported. Default value is false.
• Primary Key: Not supported. Default value is false.

• Technical Data:

  • Technical Name
  • Type
  • Native type

Unique Identifier Keys¶

Each object in the catalog is associated with a unique identifier key. When the object is imported from an external system, the key is generated and provided by the connector.

For more information about identifier keys, see Identification Keys.