When registering a protocol in the SWAPP, several input types are available according to the parameter type in Pipeline Pilot.
- Multi Checkboxes, available for array of defined values.
- Multi Selection, available for array parameters.
- Yes/No Toggle, available for Boolean parameters.
- Hidden field, available for all non-required parameters.
- Multi Select, select with creation of options, available for array parameters without defined values.
- Select, available for array parameters with defined values.
- Long Text, available for string parameters with no defined values.
- Text, available for string parameters with no defined values.
- Number, available for float or integer parameters. Note that Pipeline Pilot enforces a value between -2,147,483,648 and 2,147,483,647.
- Radio Select, available for string parameters with a list of allowed values.
- Password, available for string parameters with no defined values.
- Molecule, available for string parameters with no defined values. Ketcher is used by default; MarvinJS is also available as an alternative sketcher if configured on the Pipeline Pilot server. The output will be the CTAB of the molecule.
- File(s) to upload, available for string or array of string parameters with no defined values. The user will be prompted to select one or more file(s) from his/her computer and those files will be uploaded to the Pipeline Pilot's job directory, in the
/tempfolder. - TIBCO Spotfire Data Table, available for string parameters. The data table will then be uploaded as an SBDF file readable with the Data Table Reader component. The parameter itself will contain the name of the data table.
- TIBCO Spotfire Column, available for string parameters. Intended to work alongside TIBCO Spotfire Data Table. You will have the option to specify a filtering method or to use the auto-generated "TSC_ROWID" column which contains a unique value for each input row.
- TIBCO Spotfire Marked Rows, available for array of strings or numbers. The output array will contain the values from the selected column of the data table.
- TIBCO Spotfire Marking, available for string parameters. The output will be the marking name.
- TIBCO Spotfire Document Property, available for string parameters. The output will be a document property's name, value or name concatenated with value, depending on the option chosen at registration.
- REST API Resource, available for strings, numbers or array of strings or number with no defined values. The specified endpoint will be used to populate the list of input options. See the dedicated tutorial to learn how to use it.
- The endpoint must return a JSON response containing:
- either an array of values (number or strings), e.g.
['val1', 'val2', 'val3', 'val4'] - or an array of objects with at least a value key and optionally label and/or default keys, e.g.
[{ label: 'My label 1', value: 'val1' }, { value: 'val2' }, { value: 'val3', default: true }, { label: 'My label 4', value: 'val4', default: true }]
- either an array of values (number or strings), e.g.
- When using an array of values or when label is missing, the value itself will be used as label.
- Defaults only apply at the first load; once the selection is changed, defaults are never re-applied.
- Multi-value fields pre-select all options marked as default while single-value fields pre-select the first one.
- The endpoint must return a JSON response containing:
- Group Field, available for group of parameters. There is no output.
- Collapsible Group Field, available for group of parameters. There is no output.