Create a Pipeline Pilot protocol for Data Functions

Protocol layout

Example protocol:

Input parameters

There are three possible types of input parameters that a Pipeline Pilot protocol might expect:

• Data Table: if the protocol requires this type of input parameter, a SBDF Reader component needs to be added at the beginning of the protocol and the Source parameter of the component needs to be promoted.

• Column Data: if the protocol requires the data from a column, the protocol will need to define an input parameter and select the Array check box of the Edit Parameter interface:

  

• Single Value: any protocol input parameter value that is neither a URL type nor an Array type will be considered as a single-valued parameter.

Output parameters

The outputs are read from the Results Web Service part of the protocols:

• Files: there will be as many data tables as there are results properties with the "*.sbdf" pattern in the protocol. For example, if a property is called test.sbdf, the data function on the Spotfire side will have an output data table called "test".
  On the Pipeline Pilot side, we expect a Spotfire SBDF Writer component with $(rundirectory)/test.sbdf as Output File.

  

  If no property follows this pattern, the first SBDF file present in the run directory will be used.

  When Files is set to None (all options are unchecked) there will be no data table output for the data function.

  

  If expected files are not found when the Data Function executes, it will fail.

• Property: they will be sent as Output of the Data Function. When using an Array type the output will be of Column type, otherwise it will be a Value. Byte Array and XMLDocument type are converted to string, avoid using them since they do not exist in Spotfire.