TetraScience

Tetra Data Platform Documentation

Welcome to TetraScience Tetra Data Platform (TDP) documentation site. Here, you'll find Product Documentation, API Documentation, and Release Notes for TDP components.

Release Notes    API Documentation

Tibco Spotfire

How to Import a Spotfire Dashboard Into Your Own Spotfire Instance?

  • Receive the package from your TetraScience delivery team. The package should contain the following 3 items
    • Exported ZIP file
    • Exported DXP file (optional - DXP is usually part of exported ZIP file)
    • A set of credential for you to access the data within your organization
  • Using a tool like scp, add the ZIP file to the folder on Spotfire server machine: <path_to_tibco>/tomcat/application-data/library/ (e.g. /usr/local/bin/tibco/tss/7.11.0/tomcat/application-data/library)
  • Log in to Spotfire client using your Spotfire root account
  • Open Library Administration (Tools->Library Administration)
  • From Library Administration, click on button Import to open Import dialog
  • Click on button Browse
  • ZIP file from Step (1) should be displayed. If that is not the case, restart Spotfire server
  • Select ZIP file and click Import
  • Once import is done, open Information Designer from Tools->Information Designer
  • Click on Data Sources tab
  • Right click on appropriate date source and select edit. Provide the correct username/password and save the changes. Get the username password from your dedicated TetraScience delivery team.
  • Close Spotfire Client
  • Run Spotfire Client as either root or analyst
  • Now open the DXP file directly and that should pop up the Spotfire Dashboard with all the data tables. Then you can save this Dashboard to your library.

Spotfire caching

Spotfire supports multiple types of caching. The most common approaches are following:

  • Embedded data in Dashboard - useful for small data and if MS SQL server is used as back end RDBMS, this approach has limitation to max 2 GB

  • Spotfire Automation services - this is another software from Tibco and requires additional license

  • Information links caching - this approach is useful for us because we create Athena based dashboards using Information links. Therefore, we will describe all necessary steps for this approach.

Information Links Caching

To support information links caching, several things need to be set on both server side and client side. By default, settings on server are enabled, but if customer has specific needs, they will need to change server side settings as well. Here are the configurations we need to have to fulfill information links caching:

  1. Attachment manager settings on server configuration

  2. Information link with caching enabled

  3. Scheduled rule that loads dashboard that uses particular information links

Attachment manager

  1. Login to Spotfire server machine
  2. Navigate to bin folder of Tomcat that comes with Spotfire installation (e.g. C:\tibco\tss\7.11.8\tomcat\bin)
  3. Run uiconfig.bat (on Linux, uiconfig.sh) to run Spotfire configuration manager
  4. Provide password for default bootstrap configuration file
  5. Server manager loads default bootstrap configuration file
  6. Click on Configuration tab, then on Attachment Manager node
  7. Make sure that Cache expiration time is larger than 0. Default value is 86400 and that is one whole day. Value 0 disables caching.

Default settings are displayed below:

Default cache expiration time should be fine, but if needed, can be changed. Also, default value for Max cache size is 10 GB.

NOTE 1: Attachment manager cache is stored in Tibco’s Tomcat subfolder (\7.5.X\tomcat\temp\AttachmentManager)

NOTE 2: Attachment manager cache is deleted every time Spotfire server is restarted

More: https://support.tibco.com/s/article/Caching-data-through-Information-Links

Information Link Caching
This caching is configured through Spotfire client (analyst).

In order to make possible information link caching, we need to enable caching on that particular information link. By default, when creating Information Link, caching option is disabled. We need to make sure that this option is enabled and cache timeout set to some large value, like one whole day. Cache option is the last option on Information Link properties. Example is given below:

In this example, Cacheable checkbox is selected and Timeout is set to 86400 and that should be one whole day. This setting means that user who first opens the dashboard that uses this information link will query Athena and will cache the data. The next user who tries to open the same dashboard within the day will use cached data.

NOTE: This caching is great when we load all data immediately. When using load data on demand, this caching is tricky and not very usable - system will cache data based on users' selections - let’s assume that we have two tables, Sample Sets and Injection Results that depend on Sample sets. When one user selects three sample sets from the first table and load injection results, next user who select any single or double combination from those three sample sets (but not all three at once) will trigger new load from Athena, and not load from cache. Cache is hit only if next user select all three sample sets. That means that cache system has cache key and in this case, key is user’s selection. With lots of different data, it is probably hard to hit the same key. Therefore, we should force loading all data immediately when we deal with reasonable large data (basically, everything except datacubes).

Scheduled Rule

This option is set from Spotfire’s web UI. To setup scheduled rule, please follow these steps:

  1. Login to Spotfire web interface with root account or with account that has proper permissions:
  1. Click on Nodes & Services and validate there is WebPlayer instance installed and actived:
  1. Navigate to Scheduling & Routing

4, Create new Rule:

  1. Rule should be of File type:
  1. Click Next

On following screen, provide meaningful name to rule, select dashboard that we want to load by navigating through library and by selecting the dashboard file, select resource pool, number of instances to load the data, priority and use ‘Use custom schedule’. Everything else should be left with default values

  1. For custom schedule, we should set rule to execute every day before customer’s working hours. In other words, we should set some time like 6AM or 7AM, depending on how much time it takes to load the dashboard.

Click on Save button

  1. Rule is created and is active by default
  1. Once rule is triggered, it will load Dashboard on Spotfire Web player and that will load all information links in that dashboard. If cache timeout has expired, that will trigger cache reload and users will work with refreshed data.
  1. If everything is OK, rule should appear in green box as successful load, and there should be an entry in Activity tab:

More on information links caching: https://support.tibco.com/s/article/Caching-data-through-Information-Links

Updated about a year ago


Tibco Spotfire


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.