Container Input (Table)
JSON related functionality for KNIME version 3.7.0.v201811121404 by KNIME AG, Zurich, Switzerland
This node receives a KNIME table from an external caller (i.e. the Call Workflow (Table Based) node)
and makes it available at the output port. A configured parameter makes the Container Input (Table)
visible from the external caller and enables the external caller to send a KNIME table to the
Container Input (Table) node.
If a data table is connected to the optional input, the node will simply forward this table to the output
port unless a table is supplied via the REST API, in which case the supplied table will be available at the
output port.
If no input is given, a configured template table is output.
Options
- Parameter name
- A name for the input parameter(preferably unique). This name is exposed in the REST interface and in the Call Workflow (Table Based) node.
- Description
- A description for the input parameter. The description is shown in the API specification of the REST interface.
- Template table
- A template table can be used to define a table structure which allows the workflow to execute properly.
The main purpose of the template table is to populate the "InputParameters" field of the generated OpenAPI
specification, which is presented to end users for documentation purposes. When a node is executed without
receiving any external input (over REST or from the Call Workflow (Table Based) node) and it has no
table connected to its optional input port, the template is output. This allows downstream nodes
to be configured when no external input is present and simplifies making adjustments to the workflow.
The template table also serves as a table spec when a simplified external input without table spec is received over the REST API. When receiving an input without table spec, the input will be parsed according to the spec defined by the template table, i.e. each input row must contain as many cells as columns in the template table and each cell must contain a type that is compatible to the column spec, throwing an error in case of any inconsistencies. - Set input table as template
- By selecting this button, the input table, given one is provided, will be set as the new template table.
- Use entire input table
- When selected, the entire input table will be set as the template.
- Use only first rows
- When selected, only the first n rows are used as the template table. Can be especially useful when the input table serves as an example in the OpenAPI specification and you want to avoid over specifying the example with too many rows.
- Omit table spec in API definition
- When selected, only the data part of the template table is exposed to the OpenAPI definition, showing a well formed simplified example input. Select this if the workflow is expected to be consumed over REST and the caller of the workflow prefers the simplified input format.
Input Ports
- An optional input that is directly forwarded to the output of the node, unless overwritten by supplying a table via the REST API.
Output Ports
- The table contained in this container. A configured template table is output if no table has been injected from an external source.
Workflows
Update Site
To use this node in KNIME, install JSON related functionality for KNIME from the following update site: