Installation

Package content

The Discngine LiveDesign Connector for Pipeline Pilot package contains:

• ldconn.zip: the Pipeline Pilot collection developed to interact with LiveDesign from Pipeline Pilot protocols
• web: the gadget application to be deployed on the LiveDesign server
• PoweredBy.md: the list of third-party components used and their associated license

This package is available in the download center.

Prerequisites

• Licenses

  • License key is required to use the Connector, please contact us to get it

• Server

  • BIOVIA® Pipeline Pilot version 2023, 2024 or 2025 with secured protocol (HTTPS)
  • Schrödinger® LiveDesign version 2023+, 2024+ or 2025+ with secured protocol (HTTPS)

• Access and permissions

  • BIOVIA® Pipeline Pilot: remote access to the Pipeline Pilot server and rights to install packages on it and restart Apache server
  • Schrödinger® LiveDesign: administrator role and SSH access to the LiveDesign server, with rights to edit the nginx configuration and restart nginx server

Pipeline Pilot

Package installation

1. On the Pipeline Pilot server, place the ldconn folder of the package in <PP Installation>\PPS\apps\discngine\.

2. Open the command line prompt as an administrator from the windows start menu (Right click > execute as administrator) and change the directory to [scitegic_root]\bin (or [scitegic_root]/linux_bin if you are on a Linux server).

3. Install the Discngine LiveDesign Connector collection executing the following command:

   .\pkgutil.exe -i discngine/ldconn

4. 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

Global properties definition

The package declares some global properties which need to be set mainly to provide information about your LiveDesign environment.

• Open the Pipeline Pilot server administration page
• Navigate to Setup > Global Property in the left pane
• Select package Discngine/Discngine LiveDesign Connector
• Set the list of properties below

Server configuration

1. Allow cross-site requests from the LiveDesign instance domain (because the gadget is hosted on the LiveDesign server):

• Open the Pipeline Pilot server administration page
• Navigate to Setup > Server Configuration OR Security > Security Configuration (depending on your Pipeline Pilot server version) in the left pane
• Set "Block Content Framing by Non-Origin Hosts" to No
• Add the LiveDesign instance domain to the "Allow Cross-origin Requests" fields

2. Restart the Apache server:

   • Navigate to Maintenance > Manage Server in the left pane
   • Press the "Restart Apache" button

Gadget permissions

To allow a fine control of the actions a user can perform, the gadget uses a permission system. Theses permissions are set on Pipeline Pilot end. To control these permissions, on the Pipeline Pilot Administration server, go to Security > Permissions. Three different permissions exist: LDCONN_ADD, LDCONN_EDIT, LDCONN_DELETE.
Alternatively, a group Discngine/LiveDesignConnector/Administrators is available and encompasses all above permissions. To control which users belong to this group, on the Pipeline Pilot Administration server, go to Security > Groups.

If you plan on using the gadget and register new protocols, make sure you have the correct permissions.

LiveDesign

The LiveDesign part of the installation involves deploying and configuring the Pipeline Pilot Connector Gadget. As many LiveDesign gadgets, it is a web application and needs to be hosted on the LiveDesign server (it can also be hosted on the Pipeline Pilot server but this is not recommended). The deployment procedure is different if the LiveDesign server is on-premise (legacy installation process) or on cloud (see below).

Gadget deployment

For the following steps, we assume that your LiveDesign instance is deployed by Schrödinger. You will probably need to contact your Schrödinger architect to perform them.

1. Download the helm chart here

   • This is an example of a helm chart file that you can use or take inspiration from to deploy the gadget to suit your needs
   • Note that this zip package can be used for the LiveDesign Connector for Pipeline Pilot or for the LiveDesign Connector for Spotfire

2. Unzip the folder and open the README.md file located at the root

   • This file explains the procedure for the two gadgets

3. Follow the instructions under the LiveDesign Pipeline Pilot gadget section

Gadget configuration

The final step is to configure the gadget in the LiveDesign administration tool. It is the same for on-premise (legacy) and cloud deployments.

Go to LiveDesign Admin Panel > Properties > CUSTOM_TOOLS and declare the gadget:

[
  // ... other gadgets
  {
    "categoryName": "Discngine",
    "gadgets": [
        {
            "name": "Pipeline Pilot Connector",
            "location": "<gadget-endpoint>/index.htm?pipelinePilotServerUrl=https://<pipelinepilot-server-url>:<port>"
        }
    ]
  }
]

Placeholders:

• gadget-endpoint: the endpoint value from the pp_values.yaml file for cloud deployment, the endpoint of your nginx configuration for on-premise (legacy) deployment
• pipelinepilot-server-url: the URL of your Pipeline Pilot server
• port: the port of your Pipeline Pilot server