Installation

Package content

The Discngine LiveDesign Connector for Pipeline Pilot package contains:

• ldconn.zip: the Pipeline Pilot collection developed to interact with LiveDesign into 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.

Prerequisite

• Licenses

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

• Server

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

• Access and permission

  • 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

5. The package components and the application need some information about your LiveDesign environment. You can set the values directly into the parameters of the component, but we highly recommend to set the global properties declared for the package. To do so:

   • Open the Pipeline Pilot server administration page
   • Navigate to Setup > Global Property in the left pane
   • Here is the list of properties:

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 set for you.

LiveDesign

Gadget deployment

Cloud deployment

For these steps, we assume that your LiveDesign instance is deployed by Schrödinger. You will probably need to contact your Schrödinger architect for this section.

We provide an example of a helm chart file that you can use or take inspiration from to deploy the gadget to suit your needs. You can download it by clicking on this link.

This zip package can be used for the LiveDesign Connector for Pipeline Pilot or for the LiveDesign Connector for Spotfire. At the root of the unzipped folder, you will find a README.md that explains the procedure for these two gadgets, follow the instructions under the section LiveDesign Pipeline Pilot gadget.

On-premise deployment

For the following steps, we assume you have SSH access to your LiveDesign server. Note that you might need sudo rights on the LiveDesign server.

1. Create a ldconn.conf file in nginx's endpoints.d folder:

cd /etc/nginx/endpoints.d
touch ldconn.conf

2. Fill the ldconn.conf file.

Copy the files in the folder web of the downloaded zip package into the /home/seurat/custom_gadgets/ldpp/ folder (or any other folder you wish to use). Then, paste the following lines in the ldconn.conf file:

location /discngine/ldconn/ {
    alias /home/seurat/custom_gadgets/ldpp/;
    index index.htm;
}

3. Add the following endpoint at the end of the ldconn.conf file:

location = /discngine/ldconn/session/ {
    default_type text/plain;

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

4. Restart nginx:

sudo service nginx restart

Gadget configuration (on-premise and cloud deployments)

The final step is to configure the gadget in the LiveDesign administration tool.

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 deployment
• pipelinepilot-server-url: the URL of your Pipeline Pilot server
• port: the port of your Pipeline Pilot server