Summary: This article provides an overview for creating a simple protocol that retrieves batches that were previously registered in a project to save as a hit list in ScienceCloud.
Every protocol that connects to ScienceCloud needs to start with the ScienceCloud Connection component. It contains information about the target ScienceCloud server and about the authentication method to use when connecting to that server.
The protocol used for this demo is in the protocol database as "Example from help topic Querying New Batches and Saving". The protocol is shown in the image below:
The Batch Query component retrieves existing batches from ScienceCloud. You can use parameters to filter and retrieve a desired subset of the batches. In our case, we will query for batches in project P027 (in the team "DEMO") that were registered before February 1, 2015.
Next, we wish to save these batches into a hit list. A hit list allows a set of batches to be saved for future use or viewing, either via another protocol, or via the web interface. To convert a list of batches into a hit list, we use the Add Batches to Hit List component.
The parameters to specify include:
- Connection Name – Must be the same name used in your ScienceCloud Connection component.
- Hit List Name – The name of your hit list. If it already exists, the existing hit list is reused. Otherwise, a new one is created.
- Append Batches – If True, appends the new batches to the existing batches in the hit list. If False, the hit list is cleared before the new batches are added.
On success, a single hit list data record is returned. It can be used for further manipulation (for example, you could append two hit lists together, or remove bad batches), or, it can be viewed. In this case, we use the Hit List View component to change the hit list into a reporting element.
The Hit List View component has one parameter – whether to include information about the individual batches it contains, or not. The default is False, but we will set it to True, then route the output to a HTML Report Viewer and look at the results:
At the top, we see information about the hit list. Only the first ten batches are shown.
All data types have an associated View component to make it easy to create reports with Project Data objects.