Container Input (Row)

This node receives a row from an external caller (i.e. the Call Workflow (Row Based) nodes or via an external REST client) and makes it available at the output port. Rows are represented in the input as simple key/value maps where the keys are the column names and the corresponding values are the row cells. A configured parameter makes the Container Input (Row) visible to the external caller.

If a data table is connected to the optional input port, the node will simply forward the first row of the table to the output port unless a row is supplied via an external caller, in which case the supplied row will be available at the output port.

If no input is given, a configured template row is output.

Options

Parameter name
A name for the input parameter (preferably unique). This name is exposed in the REST interface. It must start with a letter, followed by letters and digits and single minus signs or dashes and must end with a letter. Pattern: ^[a-zA-Z](?:[-_]?[a-zA-Z0-9]+)*(?<![0-9])$
Append unique ID to parameter name
If checked, the name set above will be amended by the node's ID "{Parameter Name}-{Relative node ID}" to guarantee unique parameter names. Usually it's a good idea to have this box not checked and instead make sure to use meaningful and unique names in all container nodes present in a workflow.
Description
The description for the input parameter. It is currently not shown in the API specification of the REST interface but it's used for example when using this workflow as a tool for an AI Agent or when extracting the workflow summary.
Input validation mode
Controls whether the external input is validated against a configured template row specification.
  • Accept any: Accepts any well-formed input with an arbitrary number of columns. Each object (key/value pair) in the input represents a column, where the key is the column name and the value is the cell. The columns will only have primitive types (string, int, double, long and boolean).
  • Match template spec: Only accepts input that matches the template row specification. The input has to contain an object (key/value pair) for each of the columns in the template, where the key is identical to the column name and the value can be parsed to the column's type. The input columns can be of any order, but will be output in the same order as in the template. The input validation can be adjusted via the input validation options below.
Set first row of input as template
By selecting this button, the first row of the input table, given one is provided, will be set as the new template row.
The template row defines the expected column names and types of the external input and the order of the output. It also populates the "InputParameters" field of the generated OpenAPI specification, which is presented to end users for documentation purposes.
When the node is executed without receiving any external input and has no table connected to its optional input port, the template row is used as the output.
Missing values
Defines how missing values in the input row are handled when validating against the template:
  • Accept: Missing values in the input row will be filled with missing values.
  • Fill with templates: Missing values in the input row will be filled with the corresponding values defined in the template row.
  • Fail: Missing values in the input row will cause the node to fail.
Missing columns
Defines how missing columns, i.e. columns that the template requires but are not present in the input, are handled:
  • Fill with missings: The missing columns will be present in the output row with missing values.
  • Fill with templates: The missing columns will be present in the output row with the corresponding template values defined in the template row.
  • Remove: The missing columns are removed and not present in the output row.
  • Fail: The node fails on any missing columns.
Unknown columns
Defines how unknown columns, i.e. columns that are present in the input but are not required by the template, are handled:
  • Move to end: Appends all unknown columns at the end of the output row.
  • Ignore: Ignores all unknown columns in the output row.

Input Ports

Icon
An optional input that can be used to configure a template row.

Output Ports

Icon
The row contained in this container. A configured template row is output if no row has been injected from an external source.

Views

This node has no views

Workflows

Links

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.