Guide

Installation

Zip Content

Details of the content

/docs This documentation
/library Contains the entry point document to be imported in the Spotfire Library
/Spotfire10.10 contains the TIBCO® Spotfire extensions for Spotfire 10.10 version
/web The gadget application to be deployed on the Live Design server
Discngine.WebPanelForAnalyst.spk Discngine Connector core Spotfire extensions, for usage in Analyst
Discngine.WebPanelForWebPlayer.spk Discngine Connector core Spotfire extensions for usage in Web Player
Discngine.DataSource.LiveDesign.spk The LiveDesign Connector Spotfire extensions for the DataSource, for usage in Analyst and Web Player
Discngine.DataSource.LiveDesign.Web.spk The LiveDesign Connector Web Player extensions, for Web Player

Spotfire 10.3+ or Spotfire 10.10 (if 10.10, use the specific .spk files in the Spotfire10.10 directory).

LiveDesign version 8.9 or LiveDesign version 8.10.

If you have already installed the beta early version, please uninstall all related Spotfire extensions.

1 - Deploy all .spk to your area using the Spotfire administration tool

At the end you must have these extensions activated:

Area after Deployment Core spks

If the Discngine TIBCO® Spotfire Connector for BIOVIA® Pipeline Pilot is already installed on the area, its version must be 5.6 or higher.

Fill TIBCO® Spotfire preferences as indicated here.

Activate the following license for the final users or groups:

Spotfire licenses;

2 - Update the corresponding web player services to install the webplayer tool

See Spotfire official documentation for more information

3 - Update the webplayer configuration:

To import data from LiveDesign to Spotfire, the webplayer worker service will needs to write temporary files on the server's %TEMP% directory.

To get the temporary folder of the Spotfire nodemanager service:

  • if the account used is Local Service, Local System, or Network services, or any service account, the default temporary folder is usually %WINDOWS%\temp
  • if the account used is a generic account, please contact your System administrator to get the information

Once the temporary folder path is known, open the Spotfire Server directory (not the node manager) to export the service configuration.

Open a shell with elevated rights ("run as administrator")

a. Export the current directory for your webworker service area:

%SPOTFIRE_HOME%\tomcat\spotfire-bin> config export-service-config --deployment-area="<Your Area>" --force --capability=WEB_PLAYER

This will create a config directory under the spotfire-bin config:

b. With a text editor using elevated rights, edit the file config\root\Spotfire.Dxp.Worker.Host.exe.config. In it, search and modify the following section, adding a string element containing the path to the temporary directory you retrieved eariler:

Configuration Section To Modify

Save the file, and import the config with a new name:

%SPOTFIRE_HOME%\tomcat\spotfire-bin> config import-service-config --config-name="<New Configuration Name>"

c. Go to the Spotfire administration website, and select the webplayer service for the corresponding area, then click the Edit button:

Select service screen

d. Change the configuration using the new one you have just imported and click save. Spotfire will restart the webplayer node:

Change configuration

4 - LiveDesign Connector license activation and preferences

In the Spotfire web administration, under Users & Groups, select the group(s) you want to provide access to the Live Design Connector tool, and in the Licences menu, under TIBCO® Spotfire Extensions, activate the Spotfire extension licence LDConnector:

Activate extension licence

In Spotfire analyst, go to Tools > Administration Manager, and open the Preferences tab. In here, fill the preferences:

Important!!: Make sure the value for the LiveDesign configuration matches your actual Live Design version (8.9 and 8.10 currently supported)
Configuration Key Required Default Description
DefaultLibraryPath When set, only the templates in the specified folder and its children will be available in the Gadget.
DefaultPageTitle "[Default]" The page that will be opened with light Spotfire interface during automated opening Spotfire template in gadget
GenerateInChi false When true, a "Structure <InChi>" column containing the InChi of the compound will be generated during export. Default to false.
GenerateLiveReportImage false When true, a "Structure <LiveReport Image>" column containing the Image of the compound in the Live Report will be generated during export. Default to false.
GenerateMolFile false When true, a "Structure <MOLFILE>" column containing the MOLFILE of the compound will be generated during export. Default to false.
GeneratePNG false When true, a "Structure <PNG>" column containing the PNG of the compound will be generated during export. Default to false.
GenerateSmiles false When true, a "Structure <Smiles>" column containing the SMILES of the compound will be generated during export. Default to false.
LicenseKey (required) The license key provided by Discngine.
LiveDesignVersion 8.9 Specify the version of Live Design api to use. 8.9 (default) and 8.10 are supported.
LiveDesignServerUrl The default Live Design server URL which will be used to prefill the Data Source connexion screen.
PeriodBeforeExpiration The number of days you want to be warned before the license expires.
PythonVersion 3.9 Specifies the version of the python runtime to use. 3.9 (default) and 2.7 are supported.

Spotfire Preferences

5 - Deploy Entry point document in Spotfire Library

Copy the LDConnector.part0.zip file to your Spotfire server shared folder (by default <TIBCO® Spotfire Root>\tss&lt;version>\tomcat\application-data\library).

Spotfire Library Shared Folder

In Spotfire analyst, go to Tools > Library Administration

Spotfire Library Admin tool Menu

Click on import and browse to select the LDConnector.part0.zip file:

Spotfire Library Admin tool Import modal

Spotfire Library File Selection

Click on Ok. Check in library but you may have now this file available for Everyone:

Spotfire Library Entry Point Document

Live Design 8.9 on linux

As many Live Design gadgets, the Spotfire Gadget by Discngine is a web appplication. The current installation procedure is based on a standard LiveDesign installation using nginx as application server.

For the following steps, we assume you have SSH access to your live design server.

  1. Copy the content of the web folder from the LiveDesign Connector package to the server, under seurat/custom_gagdets directory:
scp -r /path/to/web <user>@<ld_server_url>:/home/seurat/custom_gadgets/ldconnector
  1. Edit the config file

Use your favourite editor to open the file /home/seurat/custom_gadgets/ldconnector/config/config.json

{
  "visualizer": {
    "url": "<your Spotfire url>"
    "entryPointDocumentIdOrPath": "df7b5c3b-935c-4dde-b102-54f44b3b6a6b"
  },
  "data": {
    "liveDesignServerUrl": "<your Live Design url>"
  }
}
  • Set your Spotfire server url in the > visualizer > url, e.g. "https://spotfire.mycompany.com"
  • Set the id of the entry point document in > visualizer > entryPointDocumentIdOrPath (see below for details)
  • Set the Live Design url in > data > liveDesignServerUrl, e.g. 'https://livedesign.mycompany.com"

The parameter entryPointDocumentIdOrPath should be the id of the default document that will be used to check the connexion to Spotfire.

We strongly suggest to use the empty document provided in the LDConnector.part0.zip file.

To get the id of the Entry point document:

  • Go to the Spotfire Library / LDConnector and click copy link:

Display Copy Link Menu

  • Take the id of the document from the link and use it as entryPointDocumentIdOrPath:

Select the id of the document

  1. Check that the ownership and access rights are correct
sudo chown seurat:seurat -R /home/seurat/custom_gadgets/ldconnector/
# if required:
sudo chmod 755 -R /home/seurat/custom_gadgets/ldconnector/
  1. Create/Edit the nginx configuration for exposing two location:

Go to the nginx config folder:

cd /etc/nginx/endpoints.d

Create a new config file for the Discngine configuration and open it with your favourite editor:

touch discngine.conf
vi discngine.conf

Then paste the following

location = /livedesign/session {
    default_type text/plain;

    if ( $http_cookie ~ "JSESSIONID=(?<token>[^;]*)" ) {
        return 200 $1;
    }
    return 401;
}

location /livedesign/ldconnector {
    alias /home/seurat/custom_gadgets/ldconnector/;
    index index.htm;
}

Save your file and restart nginx:

sudo systemctl restart nginx
  1. Configure gadget in Live Design admin tool

Finally, go to LiveDesign admin tools > Properties > Custom Gadget and declare the gadget

{
  "Other Gadgets": "/path/to/gadget",
  "Spotfire Gadget by Discngine": "/livedesign/ldconnector"
}

Custom Gadget Declaration