Although we introduced a major version change, migrating from v2 to v3 should be straightforward.
The main differences are the introduction of the new Set LiveDesign Connection Details as described in the changelog and the use of IDs instead of names (also described in the changelog)
How to migrate
-
The very first thing to do is to add the Set LiveDesign Connection Details component at the beginning of your protocol.
-
Upgrade each component of the Discngine LiveDesign-Pipeline Pilot Connector collection by right-clicking on them and selecting Replace with Latest Version.
-
Update the parameters of those components following the indications below.
Components migration detailed
Column Manipulators
Get Column Descriptors → Get LiveReport Column Descriptors
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report ID |
LiveReport ID |
breaking - Space removed between "Live" and "Report" |
Get Column From Column ID → Get LiveReport Column from Column ID
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report ID |
LiveReport ID |
breaking - Space removed between "Live" and "Report" |
Group Columns → Group LiveReport Columns
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report ID |
LiveReport ID |
breaking - Space removed between "Live" and "Report" |
| Group |
Group Details |
Renamed |
| Group > Name |
Group Details > Name |
Unchanged |
| Group > Columns |
Group Details > Column IDs |
Renamed |
| Group > Position |
Group Details > Position |
Unchanged |
| Group > Freeze Columns |
Group Details > Freeze Columns |
Unchanged |
Data Manipulators
Add Columns to LiveReport
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report ID |
LiveReport ID |
breaking - Space removed between "Live" and "Report" |
| Columns |
Properties |
Renamed |
| Published |
Published |
Unchanged |
Add Columns with Properties to LiveReport
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report ID |
LiveReport ID |
breaking - Space removed between "Live" and "Report" |
| Published |
Published |
Unchanged |
| Definition Mode |
Definition Mode |
Unchanged |
| Columns |
Columns |
Unchanged |
| Columns > Column [i] |
Columns > Column [i] |
Unchanged |
| Columns > Column [i] > Name |
Columns > Column [i] > Column Name |
Renamed |
| Columns > Column [i] > Model |
Columns > Column [i] > Property |
Renamed |
| Columns > Column [i] > Endpoint |
Columns > Column [i] > Endpoint |
Unchanged |
| Columns > Column [i] > Unit |
Columns > Column [i] > Unit |
Unchanged |
| JSON |
JSON |
Unchanged |
Add Rows to LiveReport
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report ID |
LiveReport ID |
breaking - Space removed between "Live" and "Report" |
| Other parameters unchanged |
|
|
Remove Rows from LiveReport
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report ID |
LiveReport ID |
breaking - Space removed between "Live" and "Report" |
| IDs |
Row IDs |
Renamed |
Data Readers
Get LiveReport Content
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report ID |
LiveReport ID |
breaking - Space removed between "Live" and "Report" |
| Other parameters unchanged |
|
|
Data Writers
Copy LiveReport from Template
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report Name |
LiveReport Name |
breaking - Space removed between "Live" and "Report" |
| Template Name |
Template ID |
breaking |
| Default Rationale |
Default Rationale |
Unchanged |
| Is Template |
Is Template |
Unchanged |
| Project Name |
Project ID |
breaking (default project is 0 - Global) |
| Folder Name |
Folder ID |
breaking |
| Nested Folder Name |
- |
breaking - Removed since it is covered by Folder ID. Indicate the ID of the nested folder if needed. |
Create LiveReport
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Live Report Name |
LiveReport Name |
breaking - Space removed between "Live" and "Report" |
| Default Rationale |
Default Rationale |
Unchanged |
| Is Template |
Is Template |
Unchanged |
| Published |
Published |
Unchanged |
| LiveDesign Project Name |
Project ID |
breaking (default project is 0 - Global) |
| Folder Name |
Folder ID |
breaking |
| Nested Folder Name |
- |
breaking - Removed since it is covered by Folder ID. Indicate the ID of the nested folder if needed. |
Folder Manipulators
Create Folder → Create LiveDesign Folder
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Folder Name |
Folder Name |
Unchanged |
| Project Name |
Project ID |
breaking (default project is 0 - Global) |
Create Nested Folder (Beta) → Create LiveDesign Nested Folder (Beta)
| v2 Parameters |
v3 Parameters |
Notes on changes |
| Nested Folder Name |
Nested Folder Name |
Unchanged |
| Folder Name |
Location > Parent Folder ID |
breaking |
| Project Name |
Location > Project ID |
breaking |
LiveReport Manipulators
Get LiveReports From Project
| v2 Parameters |
v3 Parameters |
Notes on changes |
| LiveDesign Project Id |
Project ID |
breaking |