Call Remote Workflow (Row Based)

KNIME nodes to connect to KNIME Server version 4.8.1.v201901281201 by KNIME AG, Zurich, Switzerland

This node can be used to call other workflows that reside on a KNIME Server. Input data can be passed to Quickform Input nodes (only the new input nodes, e.g Container Input (JSON)) in the other workflow and results can likewise be read back as a JSON value from JSON Output nodes(e.g Container Output (JSON)). The input can either be a static JSON values provided via the dialog (which itself can be overridden by a flow variable) or from a JSON column in the input table. The node will call the other workflow with every row of the input table and append the results of the call to it.
The node will call the other workflow with every row of the input table and append the results of the call to it. The same remote workflow can be called by multiple nodes at the same time, a new job is created on the server for each node.

Options

Server address

The address to the KNIME Server's REST interface. This is usually something like http://server:8080/knime/rest.

User

The username on the server.

Password

The user's password the server.

Short duration: the workflow is expected to run quickly, less than 10 seconds (only applies if the called workflow is executed on a KNIME server)

Choose this if the called workflow is expected to finish within ten seconds. When selected, the invocation of the workflow will not poll its status, but wait until the job completes (or fails). This removes the polling overhead and makes this option quicker for short running workflows. Choosing this option for long running workflows (> a minute) will cause timeout problems.

Long duration: the workflow is expected to run longer than 10 seconds (only applies if the called workflow is executed on a KNIME server)

Choose this if the called workflow is expected to run for more than ten seconds. When selected, the invocation of the workflow will poll its status, that is start, poll, poll, ..., finish, until the job completes (or fails). This option is reasonable for long running workflows where the overhead of regularly polling the status is negligible. The polling is implemented so that for the first few seconds there will be frequent status checks (poll interval 100ms or 500ms), whereas jobs that run minutes or hours will be checked only every few seconds.

Asynchronous Invocation

The user's password the server.

Workflow path

The path of the workflow on the server you want to call. The path must an absolute path in the server's repository. You can either enter the path by hand, or click on List available workflows and then select a workflow in the dropdown list.

Create Report

If checked the report associated with the remote workflow will be generated and put into the output table. The format can be chosen in the drop-down. The output table will contain a column containing the binary content of the report (column type: binary object); the column can be further processed, e.g. use a "Binary Objects to Files" node to write the content to a file, or use a database writer to write the report as BLOB into a database. Failures to generate the report (for instance, because no report is attached to the workflow) will result in a missing cell.

Use Fully Qualified Name for Input and Output Parameters

If checked, use the full parameter name to select the input and output. The parameter names are defined by the user in the configuration dialog of each of the parameters (like JSON In/Output node), e.g. "timeout", "count", etc. Using these 'simple names' may lead to duplicates, hence a 'fully qualified name' is constructed by appending a suffix, e.g. "timeout-1" or "count-5:6". While these suffixes guarantee unique parameter names across one workflow they may cause names not to match in case you call out to different workflows (e.g. in a loop). It's good practice to (manually) ensure that parameter names in the called workflow are unique and hence often the 'simple name' is sufficient (= do not check the box).

Inputs

After you have loaded the input format you will see an input block for every input node in the called workflow. You can select if you want to use a static value or the value of a column for the respective input field or use the default value (that is the value that is set up in the workflow being called).

Input Ports

Any input, possibly with JSON column.

Output Ports

Output of workflow call

Best Friends (Incoming)

• Table to JSON (15 %) Manipulator
• Empty Table Creator (11 %) Source
• Call Remote Workflow (Row Based) (8 %) Other
• Table Creator (8 %) Source
• Credentials Input (8 %) QuickForm
• Transpose (7 %) Manipulator
• Columns to JSON (4 %) ManipulatorStreamable
• Loop End (3 %) LoopEnd
• Merge Variables (3 %) Other
• Data Generator (3 %) SourceStreamable
• Timer Info (3 %) Sink
• Container Input (JSON) (3 %) QuickForm
• Table Row to Variable (1 %) Other
• Variable to Table Row (1 %) Other
• CSV Reader (1 %) Source
• Database Reader (1 %) Source
• File Reader (1 %) SourceStreamable
• Table Writer (1 %) Sink
• Chunk Loop Start (1 %) LoopStart
• Variable Condition Loop End (1 %) LoopEnd
• Generic Loop Start (1 %) LoopStart
• Recursive Loop Start (1 %) LoopStart
• Concatenate (1 %) ManipulatorStreamable
• Row Filter (1 %) ManipulatorStreamable
• Column Rename (1 %) ManipulatorStreamable
• IF Switch (1 %) Manipulator
• Java IF (Table) (1 %) Manipulator
• JSON Row Combiner (1 %) Manipulator
• String to JSON (1 %) ManipulatorStreamable
• Copy/Move Files (< 1 %) Other
• Files to Binary Objects (< 1 %) Manipulator
• Table Column to Variable (< 1 %) Other
• Java Edit Variable (< 1 %) Manipulator
• Java Snippet (< 1 %) ManipulatorStreamable
• Concatenate (Optional in) (< 1 %) ManipulatorStreamable
• Column Appender (< 1 %) ManipulatorStreamable
• RowID (< 1 %) ManipulatorStreamable
• Rule-based Row Filter (< 1 %) ManipulatorStreamable
• Parallel Chunk Start (< 1 %) LoopStart
• Call Local Workflow (Row Based) (< 1 %) Other
• Math Formula (< 1 %) ManipulatorStreamable
• JSON Path (< 1 %) ManipulatorStreamable
• JSON Reader (< 1 %) Source
• Python Script (2⇒1) (< 1 %) ManipulatorDeprecated
• GET Request (< 1 %) ManipulatorStreamable
• XML Reader (< 1 %) Source
• Show all 46 recommendations

Best Friends (Outgoing)

• JSON to Table (21 %) Manipulator
• Binary Objects to Files (16 %) Manipulator
• Call Remote Workflow (Row Based) (14 %) Other
• Column Filter (9 %) ManipulatorStreamable
• Loop End (7 %) LoopEnd
• Group Loop Start (5 %) LoopStart
• Create Temp Dir (5 %) Other
• Save File Locally (2 %) ManipulatorStreamable
• Database SQL Executor (2 %) Manipulator
• Database Writer (2 %) SinkStreamable
• Recursive Loop Start (2 ports) (2 %) LoopStart
• Concatenate (2 %) ManipulatorStreamable
• Category To Number (2 %) ManipulatorStreamable
• String Manipulation (2 %) ManipulatorStreamable
• Ungroup (2 %) ManipulatorStreamable
• JSON Path (2 %) ManipulatorStreamable
• Container Output (JSON) (2 %) QuickForm
• Data to Report (< 1 %) Other
• SSH Connection (< 1 %) Source
• Catch Errors (Data Ports) (< 1 %) ScopeEnd
• Table Row to Variable (< 1 %) Other
• CASE Switch Data (Start) (< 1 %) Manipulator
• Merge Variables (< 1 %) Other
• Parallel Chunk End (< 1 %) LoopEnd
• Columns to JSON (< 1 %) ManipulatorStreamable
• Time Generator (legacy) (< 1 %) Source
• Show all 26 recommendations

Workflows

• 02_Call_a_Workflow_on_a_Server
• Call (Remote) Workflow
• Model_Factory
• 01_call_server_workflow_(JSON)

Installation

To use this node in KNIME, install KNIME nodes to connect to KNIME Server from the following update site: