Summary: This article provides a high-level overview of the components available in the Project Data collection for use with ScienceCloud applications.
Clicking a link will scroll the page to the relevant section.
Note: From the Components tab in Pipeline Pilot Client, these components are available in the ScienceCloud folder.
The components that are available in the Project Data collection are grouped into two subfolders, Data Types and Utilities. The top-level data types include:
- Assay Group
- Assay Parameter
- Assay Result
- Assay Result Type
- Batch Group
- Entity Status
- Entity Type
- Hit List
- Trace Type
The Utilities folder contains a number of components not associated with any specific data type. In particular, components are available to query the database for additional information, such as:
- Register Custom Properties
- Search Result Query
- Project Data Search Saved Query components
The components within different data types are similarly structured, with functional categories repeated across data types, but specialized for particular types. In the discussion, we will abstract data types names using the variables XXX and YYY. Here are the categories we will discuss:
- XXX Filter– Filter XXX data records from other data record types. Other options might be available to select with the XXX type.
- XXX Query – Query the database using the filter values provided in the parameters, and return zero to N XXX data records.
- XXX to YYY – Convert the XXX data record into YYY data records.
- XXX View – Convert the XXX data record into a reporting element suitable for inclusion into the HTML Report Viewer or the PDF Report Viewer.
- Define Existing XXX – Take a data record containing properties that refer to an existing Project Data object and create an XXX data record representing that existing object. The data can be rejected, if it does not refer to an existing object, or if it has invalid formatting. Missing properties can be added. Once created, the object can be edited or updated.
- Define New XXX – Take a data record containing properties that define a new, unregistered, Project Data object, and create an XXX data record representing that new object. The data can be rejected, if it refers to an already existing object, or if it has invalid formatting and fails to validate. Once created, the object can later be registered.
- Edit XXX – Edit an XXX data record for later update or registration.
- Register New XXX – Register a new XXX data record to persist it in Project Data.
- Update XXX – Update an existing XXX data record to change the stored information in Project Data.
- Create XXX – Create a new object of type XXX.
- Delete XXX – Take a data record containing properties defining an object of type XXX, and delete that object.
To see examples of these types, look at the contents of the Batch data type folder.
The key concept to remember is that when working with any particular data type, the components most suited to work with that type are collected into that type's folder. After you apply a converter to change types, you can move to that new type's folder to see what would be useful to attach downstream.
The Batch folder is provided only as an example. Other folders will contain different components and may not support every possible operation. For example, if there is no way to update an object type, there will be no Update XXX component in that folder.