Call Workflow Service

Calls another workflow and obtains the results for further processing in this workflow. The workflow can receive inputs via Workflow Service Input nodes and return outputs using Workflow Service Output nodes.

Each Workflow Service Input node in the workflow to be called will create an input port on this node when finishing the configuration of the Call Workflow Service node. Similarly, each Workflow Service Output node will create an output port on the node.

The called workflow can be located on a KNIME Server or in the Local Workspace. If the workflow is located on a KNIME Server, the execution will take place on the server. In contrast, when using the Workflow Executor node, the execution will always be performed in the workflow containing the Workflow Executor node.

The difference between this node and the Call Workflow (Table Based) node is the set of supported workflow input and output nodes. This node supports the Workflow Service Input and Workflow Service Output nodes, which support arbitrary port types and are more efficient than the various Container Input and Container Output nodes. The container input and output nodes on the other hand expect and produce data in a format that can easily be produced by third-party software, whereas Workflow Service Input and Workflow Service Output nodes are designed exclusively to be used by other KNIME workflows.

To define which Workflow Service Input node receives data from which of this node's input ports, each input node defines a parameter identifier. The parameter identifier is supposed to be unique, but it might happen that a workflow has multiple input nodes defining the same parameter name. In this case, KNIME will make the parameter names unique by appending the input node's node ID to the parameter name, e.g., "input-table" becomes "input-table-7".

Options

Workflow

Server address (only when connected to a KNIME Server)
Displays the address of the connected server.
Short duration (only applies to execution 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 (only applies to execution 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 repeatedly until the job completes (or fails). 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.
Retain job on failure (only applies to execution on a KNIME Server)
When selected, failing jobs of the called workflow will be kept on the server. This can be useful for debugging purposes. When not selected, the failing jobs will be discarded.
Discard job on successful execution (only applies to execution on a KNIME Server)
When selected, successful jobs of the called workflow will be discarded from the server. When not selected, the successful jobs will be kept.
Workflow path
The path of the workflow you want to call. If connected to a server, the path must be an absolute path (i.e., a path starting with "/") in the server's repository. If calling a workflow in the Local Workspace, the path may be absolute or relative (i.e., a path starting with "../"). You can either enter the path by hand or click on Browse Workflows and then select one of the available workflows.
Fetch workflow parameters
Retrieves the parameter names defined in Workflow Service Input and Workflow Service Output nodes in the workflow selected for execution.
Load timeout
The maximum amount of time the client will wait for the server to fetch the input and output parameters of the called workflow. Specified in seconds. A value of 0 means that no timeout will be used.
Adjust node ports
When the node ports differ from the workflow parameters, this button is used to confirm updating the node ports, which may remove connections to other nodes.

Input Ports

Icon
Optional connection to a KNIME Server where the workflow to be executed is located. If connected, the execution of the workflow will be performed on that server.
One output port for each Workflow Service Input node in the workflow to be executed. The ports are automatically created when finishing the configuration of the node.

Output Ports

One output port for each Workflow Service Output node in the workflow to be executed. The ports are automatically created when finishing the configuration of the node.

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.