This tutorial shows how to register an existing Pipeline Pilot protocol into the SWAPP. This protocol will then be available in the SWAPP menu and you will be able to run it and get its results in Spotfire (SWAPP - Running example protocols).
The example registered protocols can be found under Discngine/Spotfire Enabled Protocols/Client Automation/SWAPP Examples. In there the protocol "Add SMILES to Data Table" has not yet been registered, let's use it as an example.
Open the registration menu
- Click on the icon to open the settings modal.
- Then click on "+ Register new Protocol" to open the registration modal.
Select the protocol
- Browse the tree of Pipeline Pilot protocols and look for the example protocol "Add SMILES to Data Table" available under
Discngine/Spotfire Enabled Protocols/Client Automation/SWAPP Examples. - Click on the protocol name to load the parameters list.
Define the inputs
Based on the input type, the SWAPP will try to guess the most relevant input type (number, text, select, etc.).
- The first parameter,
Data Table Nameis set by default to a TIBCO Spotfire Data Table input type. Although it is a text field in Pipeline Pilot, because it contains the words "Data Table" the SWAPP automatically suggested the correct type. Let's leave it as is. - The second parameter
Destinationis set by default to a Select input type as shown in the Overview / Default value section. Switch it to Radio Select and add some description so that your users know what this parameter is for. - Click "Next" at the bottom of the page.
Create the menu item
The next step is to select where the link of the protocol will appear in the menu and with what name.
- Select the "ChemoInformatics" folder or create a new one.
- Leave the Menu item name as it is.
- Optionally write a description of that protocol which will be displayed above the form.
- Click on "Save Protocol" and the protocol will be registered in the menu.
Load the protocol form
You can now load the protocol from the menu and you should see the form displayed:
