v3.6.12
(2025/05)
Fixes
In some cases of advanced stereo, the 'Get LiveReport Content' Pipeline Pilot component might not correctly retrieve all the stereo information.
v3.6.0
(2025/05)
New Features
This new version allows deployment of the gadget outside the Pipeline Pilot server. It is now possible to deploy the gadget on the LiveDesign environment (hosted in a cloud), without having the necessity to open the connection from the LiveDesign Server to the Pipeline Pilot server.
v3.5.0
(2025/04)
New Features
This new version is fully compatible with LiveDesign 2023-3, 2024-1 and 2024-3.
It is possible to retrieve information about one or several models using the "Get LiveDesign Models" component and to execute one or several models using the "Run LiveDesign Models" component. It is also possible to automate the creation of parametrized models using the "Create Parametrized Model" component. For now this component does not manage the inputs of file type. It is a beta version and might change in the future.
Fixes
The gadget has been fixed to always provide a valid cookie to be authenticated to Pipeline Pilot. This means that there is no need anymore to authenticate again when a protocol calls another protocol through reporting.
The "Add Rows to LiveReport" component has been fixed and allow to add a molecule without any property to an existing LiveReport.
The example protocol "Get Folders - REST Resource" has been fixed to work even when the given project has no folder.
The "Set LiveDesign Connection Details" component can be used to connect to a different LiveDesign server than the one defined in the global properties of the Pipeline Pilot package (if the version of the LiveDesign server is the same).
v3.4.46
(2023/11)
New Features
This new version is fully compatible with Pipeline Pilot 2023.
Fixes
A bug from BIOVIA creates issues with group names including spaces. To avoid this, the group Discngine/LiveDesignConnector/Administrators has been introduced to replace Discngine/LiveDesign Connector/Administrators.
For backward compatibility reason the old group is kept, but it is highly recommended to use only the new one, and to move associated users and subgroups in it.
v3.4.33
(2023/09)
New Features
This new version is fully compatible with LiveDesign 2023-2.
It is possible to adapt the result page of a protocol to the selection in the active LiveReport. See example protocol "Get Marked Rows".
v3.4.16
(2023/02)
New Features
This new version is fully compatible with LiveDesign 2022-4.
v3.4.0
New Features
The LiveDesign user name and identifier are retrieved and saved in the job list when a protocol is run from the LiveDesign Gadget.
v3.3.30
(2022/08)
New Features
Compatibility with LiveDesign 2022.3
This new version is fully compatible with LiveDesign 2022-3
v3.3.0
New features
Improved nginx config
This new version is fully compatible with LiveDesign 2022-2.
v3.2
LiveDesign Gadget
New features
Improved nginx config
Following discussion with engineers from Schrödinger, we found a new and cleaner way to pass the session token to Pipeline Pilot.
In consequence, the nginx config needs to be adjusted accordingly.
Mainly, the previous /ppproxy route is now moved to /livedesign/ppproxy.
See this section of the installation guide for details.
Jobs List filtering
The jobs can be filtered in the jobs list according to the active LiveReport. By selecting the associated option, you will see in the jobs list only those that have been launched on the current active LiveReport.
Menu path editing
The path of the gadget menu can be modified through a package global property.
v3.1
Pipeline Pilot Collection
New features
Reporting in the gadget
The component "LiveDesign HTML Report Viewer" has been created to ensure the proper functioning of the reporting in the gadget, and should be used instead of the "HTML Report Viewer" component.
Get the active LiveReport
The component "Set LiveDesign Context" allows to get the active LiveReport when used from the gadget. This prevent you from using a LiveReport ID parameter at the protocol level if you know that your actions will be applied on the active LiveReport.
v3.0
Pipeline Pilot Collection
New features
Column manipulation
Add Freeform Columns to LiveReport
The data manipulation has been diversified with the possibility to add a new type of column to a LiveReport with the "Add Freeform Columns to LiveReport" component. It creates freeform columns or uses already existing ones and fill them with data contained in Pipeline Pilot properties. The freeform columns can contain values of different types such as text, boolean or images.
Add 3D Columns to LiveReport (Beta)
The "Add 3D Columns to LiveReport" component has been created to allow you to add columns containing pose data into a LiveReport. With this component you can import poses to different 3D columns at once, import poses onto arbitrary compounds (the ligand in the pose is not required to have the same chemical structure as the compound its being imported onto) and import poses that contain only a ligand. This component needs 3D files as parameters.
.png "Add 3D Columns to LiveReport")
More details about the component and its parameters can be found in the corresponding help texts.
Remove Columns from LiveReport
We have enhanced column manipulation by creating the "Remove Columns from LiveReport" component.
Show or Hide LiveReport Columns
A component has been added allowing you to show or hide columns of a LiveReport. You can also specify a group of columns to show or hide all the columns belonging to the group at once.
Simplified authentication
In previous versions, each component interacting with LiveDesign had to contain the user's credentials. Although it was possible to promote the Credentials field, it was bad practice and a bit cumbersome for the Pipeline Pilot developer.
In this new version, we have introduced a "Set LiveDesign Connection Details" component which needs to be inserted at the begining of your protocol. The LiveDesign credentials fed in this component will then be used when necessary in all Connector component interacting with LiveDesign. Developers familiar with SQL components will see a similar pattern here.
Note that this component will also extract the LiveDesign credentials when calling a protocol from the Discngine LiveDesign-Pipeline Pilot gadget. For this reason, it is strongly recommended to remove all credentials from this component before publishing your protocol.
As for the credentials entered in the individual components, we strongly advise you not to save your credentials along with the Protocol and to clear this component before saving.
Utilities
Get LiveReport Metadata
A component has been created to get metadata of a specific LiveReport. With this component you can for example see in which folder a LiveReport is saved, who is the owner or whether it is a template or not.
Get LiveDesign Freeform Columns
A component has been added allowing you to get information about all the published freeform columns. The ID of these freeform columns can be used in the "Add Freeform Columns to LiveReport" to add an existing freeform column to a LiveReport.
Get LiveDesign Folders
A component has been created to get either all folders and nested folders from LiveDesign, or the folders and nested folders of a specific LiveDesign project.
Get ID from Name
All components used to fetch or send data to LiveDesign now require the ID of the element to interact with (see Using IDs instead of Names below, in the fixes provided in this version). Then a set of utility components has been added to facilitate the retrieval of these identifiers from their names. These components are not supposed to be used in protocols designed for the gadget, but only as utilities when developping in Pipeline Pilot, as the gadget already sends IDs to Pipeline Pilot.
The "Get LiveReport ID from Name" component gives you the ID(s) of all LiveReports having a specific name. This ID can be used in most of the components manipulating data or columns.
The "Get LiveDesign Folder ID from Name" component gives you the ID of a folder or a nested folder from its name. This ID can be used when creating LiveReport in a specific folder with the "Create LiveReport" or "Copy LiveReport from Template" components.
The "Get LiveDesign Project ID from Name" component gives you the ID of a project from its name. Like the "Get LiveDesign Folder ID from Name" it can be used when creating LiveReport, but also when getting the list of LiveReports belonging to a specific project with the "Get LiveReports from Project" component.
The "Get LiveReport Column ID from Name" component gives you the ID(s) of all columns belonging to a specific LiveReport and having a specific name, as well as the "Column Type" and "Value Type" properties. The ID can be used for several components manipulating data or columns, such as "Add Freeform Columns to LiveReport" or "Group LiveReport Columns".
The "Get LiveReport Group ID from Name" component gives you the ID(s) of all groups of columns belonging to a specific LiveReport and having a specific name. This ID can be used with the "Show or Hide LiveReport Columns" component, to specify a group of columns to show or hide.
Enhancements
LiveReport creation
You can now check before the creation of a LiveReport that a LiveReport having the same name does not exist yet. To do this the "Create LiveReport" and "Copy LiveReport from Template" components have been modified. It is now also possible to create an empty LiveReport.
Fixes
Normalizing names (breaking changes)
In previous versions, names were sometimes inconsistent. From v3.0, we have adopted the LiveDesign nomenclature more rigorously.
"Live Design" is now "LiveDesign" everywhere, and similarly "Live Report" is now "LiveReport". We also homogenized the way column parameters are named, refering to a LiveDesign column by "Column" and to a Pipeline Pilot column by "Property".
Using IDs instead of Names (breaking changes)
This version introduces significant changes in the input parameters of the Pipeline Pilot Components.
Now all components used to fetch or send data to LiveDesign will require the ID of the element to interact with (LiveReport ID, Column ID, Folder ID, etc.).
This change is motivated by the stability of IDs compared to names.
To fit with this change, a new global property, called DefaultProjectID, has been added to the package to replace the global DefaultProjectName. This global contains the identifier of the default project to use, which is set to "0" by default, and corresponds to the "Global" project.
Old components using the name parameter as input have been deprecated but will still work with this new version. However we stronly recommend upgrading your protocols to the new components since the old components will be removed in v4.0.
LiveDesign Gadget
New features
Multi LiveReport columns selector
It is now possible to select multiple LiveReport columns from a gadget parameter. To do this a new input parameter type "Live Report Columns (Multiple)" has been created. It is available when a parameter at the protocol level is an array of LongType.
v2.0
This new version contains internal changes which should not affect end users but justify the major version bump.
v1.0 (compared to EA 2.0.10)
(2021/07)
Backwards compatibility break
In this first production release of the Discngine Connector for LiveDesign and Pipeline Pilot, the Pipeline Pilot collection has been rethought and redesigned to make it more consistent. This may involve breaking backwards compatibility on your existing protocols if the records from the Pass Port of a component from the LiveDesign collection (other than "Get LiveReport, renamed to "Get LiveReport Content") are used in the rest of the pipeline.
More details on this can be found in the User Guide which describes exactly how to develop a Pipeline Pilot protocol for LiveDesign and how to use the components of the collection.
New Pipeline Pilot components
The new components in this release include column manipulation, template manipulation and folder creation.
Column manipulation
Add Columns with Properties to LiveReport
We have enhanced adding data to an existing LiveReport by creating the "Add Columns with Properties to LiveReport" component. You can always use the "Add Columns to LiveReport" component if you don't want to customize the properties, these will then be the ones we have defined by default, otherwise you can specify for each column the values you want for each property:
More details about the component and its parameters can be found in the corresponding help texts.
Group Columns
Once the columns have been added to the LiveReport, you can now group them using the "Group Columns" component. In the component settings, you will need to specify the name of the group and the columns in it, and optionally the position in the LiveReport of the group:
This component can also be used to modify a group, or to delete it (in this case the group name should be left blank).
Get Column From Column ID
The "Get Column Name From Column ID" component is replaced by the more general "Get Column From Column ID" component. This change is transparent to existing protocols: the old component returned a single record with the "display_name" property only, the new component still returns a single record with this same property and the other column properties.
Template manipulation
You can now create templates and then copy them to create new LiveReports. To do this, the "Create LiveReport" component has been modified to allow you to specify that the LiveReport to be created is a template:
Once a template exists (created via a Pipeline Pilot protocol or via the LiveDesign client), you can use it to create new LiveReports using the "Copy LiveReport From Template" component:
Folder creation
To organize your LiveReports of a project into folders and nested folders, you can use the two components "Create Folder" and "Create Nested Folder":
We tagged the "Create Nested Folder" as a beta component because the LiveDesign API function we use in this component is not fully documented, so we cannot guarantee that it will not be changed in the future.
Project management
To make it easier for you to organise your LiveReports and projects in LiveDesign, we have created a new global property for the package, called DefaultProjectName, which contains the name of the default project to use.
You can find this property in various components, for example the "Create LiveReport" component:
In the package we provide, the global property "DefaultProjectName" is set to "Global", so by default components such as "Create LiveReport" will use the "Global" project. You can change the value of "DefaultProjectName" (in the Pipeline Pilot administration portal, refer to the installation guide), which will change the default project for all components. You can also have more control by changing the value of the parameter directly in your protocol if the default value defined at the server level is not appropriate.