Upgrade

Package content

The Discngine Spotfire® Connector package contains:

• Discngine.Connector.sdn: the distribution file that bundles together the Spotfire extensions
• All the SPK files contained in the SDN file (if you do not want to install all of our extensions, including the new Discngine Molecule Renderer extension)
• Discngine-Connector.part0.zip: a Spotfire® library export
• Discngine-Connector-Authenticator-Spotfire10.zip: the java package needed to use Pipeline Pilot as an authenticator during the Web Player connection for Spotfire 10.0+
• Discngine-Connector-js-api.zip: the JavaScript API
• Discngine-Connector-js-api-4.1.zip: the JavaScript API of the Connector 4.1 (for backward compatibility)
• Discngine-Connector-PP-collection.zip: the Pipeline Pilot collection of components and example protocols, as well as bundled SWAPP
• PoweredBy.md: a file containing the list of third-party components used and their associated license

This package is available in the download center.

Prerequisites

• Licenses

  • License keys are required to use the Connector, please contact us to get them.

• Spotfire

  • Version between 11.4 and 14.0
  • Access to the Spotfire server web administration pages, remote access to the Spotfire server and access to the Analyst
  • We strongly recommend to configure HTTPS in order to secure the communication between clients and Spotfire Server as described in official documentation
  • If Spotfire server and Pipeline Pilot server are not on the same domain, please follow this knowledge base
  • To use the Discngine Automation tasks, the Spotfire Automation Services must be deployed on the Spotfire server. Please refer to the official documentation.

• Pipeline Pilot

  • Version between 2020 and 2024
  • Access to the Pipeline Pilot server web administration pages and remote access with administrative rights to the Pipeline Pilot server

Spotfire

Deploy packages

In this step you will deploy the SDN file we provide in the package on your Spotfire server. We strongly advise you to use either a test server or a test area. If you prefer to use a specific area, pay attention to the routing rules associated to the user/group who will test the Discngine Connector application in the Web Player. You can find further information in the official documentation.

1. Log in as an administrator on the Spotfire server web portal.
2. Go to the Deployments & Packages area.
3. Select the deployment area on which you want to deploy the Discngine Connector extensions.
4. Click on the "Add packages" button, then choose the .sdn file into the Discngine Connector package.
5. Click on "Validate area", then "Save area".

Update services

Please follow instructions from the official documentation in order to update your Spotfire Web Player services.

Import library

We provide in the package a file Discngine-Connector.part0.zip. Its import will create in your library a folder "Discngine" containing several files "empty.dxp". These DXPs are required to start several of the provided tools without data at the beginning.

To import this folder:

1. Copy the file Discngine-Connector.part0.zip on the Spotfire server at the location path [Spotfire root]\tss\[Spotfire version]\tomcat\application-data\library\.
2. Open the Spotfire Analyst client and log in using an administrator account.
3. Open Tools > Library Administration.
4. Click on "Import" and "Browse" to select the file Discngine-Connector.part0.zip. Select "Include permissions" and "Replace existing item".
5. Select "Library" as "Destination Folder".

We strongly recommend that you do not add your own files to the "Discngine" folder as we may update it in future versions and you may have problems updating our files while keeping yours.

Pipeline Pilot

In this section you will deploy the Connector Pipeline Pilot collection, containing:

• A set of components
• A set of protocols
• The JavaScript API
• The SWAPP
• A debug application

Upgrade collection

1. Unzip the file Discngine-Connector-PP-collection.zip from the Discngine Connector package in a short location (some protocols have long names).

2. Log in to the Pipeline Pilot server.

3. Uninstall the Discngine Connector collection by executing the following command:

   .\pkgutil.exe -u discngine/tibcoconn
   

4. Backup or remove the folder [scitegic_root]\apps\discngine\tibcoconn.

5. Copy the folder discngine\tibcoconn from the package to [scitegic_root]\apps\discngine.

6. Open the command line prompt as an administrator from the windows start menu (Right click -- execute as administrator).

7. Change the directory to [scitegic_root]\bin (or [scitegic_root]/linux_bin if you are on a Linux server).

8. Install the Discngine Connector collection by executing the following command:

   .\pkgutil.exe -i discngine/tibcoconn
   

9. If they still exist, uninstall the following collections and remove their folders from [scitegic_root]\apps\discngine:

   .\pkgutil.exe -u discngine/tibcoconn_examples
   .\pkgutil.exe -u discngine/design
   

10. If you upgrade from version 5.x to 5.2, the Pipeline Pilot server must be restarted.

11. Make sure all required Global Properties are set in the server setup section.

12. Linux servers only - To be able to use the SWAPP, the public folder $(sciroot)/public/Discngine/SWAPP must be accessible in reading for all users, and in writing for every user who will need to register or update protocols in the SWAPP. When installing the package, this folder and especially the menu.json file inside are created as writable. However, this will only be effective for the group to which the user performing the installation belongs. If the user is an admin, it is very likely that other users will not be able to open the document in writing. For this reason, we recommand to set the chmod value of this folder and the menu.json file to at least 766.

13. Restart the Apache Server:

    • Open the Pipeline Pilot server administration page
    • Navigate to Maintenance > Manage Server in the left pane
    • Press the "Restart Apache" button