0 ×

PPilot Connector

KNIME Pipeline Pilot WebService Connector version 4.2.0.v202006230508 by KNIME AG, Zurich, Switzerland

Invokes a pipeline pilot web service. These services require dedicated login procedures to create a new session. They also allow for dedicated job control options such as timeout and whether to keep the result after the job finishes. Other controls are very similar to the generic web service node, that is, the user needs to define the input and output parameter assignments.
Each of the input parameters must be mapped to either a column from the input table, which you can choose in the rightmost column of the table (just click into it to get an editor to choose a column), or a constant value, which you can enter in the second-rightmost column after having activated the checkbox for constant values.
In the bottom table you may decide which output values you want to include in the output table. For each desired output parameter, activate the "Include" check box and enter the respective output column name. The "All in List" field will contain check boxes if the output parameter represents a collection (see below)
Please note, that this node does currently not support optional input parameters.

Options

WSDL location
URL to the webservice's WSDL file. After entering the URL you have to click on the Analyze button. Note that fetching and parsing the WSDL takes place in background (buttons will be disabled).
User
The user name as required by the service endpoint.
Password
The password as required by the service endpoint.
Timout
Timeout as passed to the service endpoint.
Retain job after completion
Whether to keep the result files on the server after the job completes.
Continue job after timeout
Whether to keep job running after timeout occurs.
Input
Table with all required input parameters which you have to be mapped to columns or constant values as described above. The table represents elements of a tree that is constructed by analyzing the complex input parameter types. The different columns represent:
  • Parameter: The name of the parameter
  • Type: Type of the parameter (this can be as easy as string or double but also more complex, such as the name of dynamically generated classes)
  • Constant?: A check box for all leave elements. Select this box to assign a constant value that you enter in the text field next to this entry. If unselected, use the value of the column that is selected in the right-most column.
  • Constant value: The value that is to be used when the "Constant?" check box is selected. The entered string must comply with the expected type (otherwise the execution will fail).
  • Mapped column: The column whose value is used for the current invocation.
Output
Table with all output values which you can assign to new column in the output table as described above. The values in the column are as follows:
  • Parameter: The name of the parameter (see above)
  • Type: Type of the parameter (see above)
  • Include?: Whether to include this parameter in the output table. It selected, this value will constitute one new column in the output table.
  • Output column?: The name of the column that will be append to the output table.
  • All in list: If a type represents a collection and this option is checked, all list elements will be returned. Each list element will thereby be represented by a separate row. If unselected, only the first list element (if any) will be returned. Note that if you have lists of lists in the output parameter tree (both of which are checked), these will be flattened (the row count for a single invocation is outer_list_size times inner_list_size). Likewise, if the output parameter tree contains different lists on the same level, these will be treated independently, whereby new output columns that are covered by the elements in one list will be filled with missing values when processing the respectively other list.
Override Endpoint
If selected, the webservice endpoint as given in the wsdl will be overwritten using the value entered in the accompanying text field.
Add SOAP Header
An XML tree that will be inserted into the soap header of outgoing soap request (for instance identification tags required by the server). Note, the text snippet needs to be valid XML.
Parallel Invocation Count
The number of maximum asynchronous invocations (an invocation translates to the processing of a single input row). The "optimal" number depends on the endpoint. A high number increases the parallel job count at the service endpoint, possibly leading to an overload situation or a lock-out of the client. A low value increases the overall execution time.
Row Cache Size
The number of rows to be kept in memory at most. The output table will retain the same ordering as the input table. If for any reason the processing of a row takes significantly longer than the processing time of other rows, the webservice invocation will stall, keeping at most this number of rows in memory.
New RowID suffix
The string (usually only a character such as '_') is used when the webservice returns a list, and new row IDs need to be created. These new IDs will have the same base name as the original row ID + a suffix (the value entered here) + an increasing counter.

Input Ports

Icon
Input table, containing parameters for the webservice

Output Ports

Icon
The input table with additional columns holding the results from the webservice

Best Friends (Incoming)

Best Friends (Outgoing)

Installation

To use this node in KNIME, install KNIME Pipeline Pilot Connector from the following update site:

KNIME 4.2

A zipped version of the software site can be downloaded here. Read our FAQs to get instructions about how to install nodes from a zipped update site.

Wait a sec! You want to explore and install nodes even faster? We highly recommend our NodePit for KNIME extension for your KNIME Analytics Platform.

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.