0 ×

Call Workflow (Table Based)

KNIME nodes to connect to KNIME Server version 4.12.1.v202101261634 by KNIME AG, Zurich, Switzerland

This node can be used to call other workflows that resides either locally or on a KNIME Server. The called workflow must contain at least one of the Container Input (Table), Container Input (Variable), Container Input (Credential) or Container Output (Table) nodes, which defines the interface between the Call Workflow (Table Based) node and the called workflow in the following way:

Send Table
The data table provided at the optional input of the Call Workflow (Table Based) node can be sent to a Container Input (Table) node in the called workflow via the input parameter defined in the Container Input (Table) node

Receive Table
After the execution of the called workflow, a data table can be received from a Container Output (Table) node in the called workflow via the output parameter defined in the Container Output (Table) node. The received data table will be made available at the output port of the Call Workflow (Table Based) node

Send Flow Variables
All flow variables available in the Call Workflow (Table Based) node can be sent to a Container Input (Variable) node in the called workflow via the variable-input defined in the Container Input (Variable) node

Send Flow Credentials
All flow credentials available in the Call Workflow (Table Based) node can be sent to a Container Input (Credential) node in the called workflow via the credential-input defined in the Container Input (Credential) node

To call workflows that reside on a KNIME server a KNIME Server Connection node must be connected to the server connection input port. The server connection provides the node with the server address and the user credentials.

Options

Server address (Only when connected to a KNIME Server)
Displays the server address of the server connection.
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.
Retain job on failure (only applies if the called workflow is executed 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 if the called workflow is executed 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 in the server's repository. If not connected to a server the path may be absolute or use KNIME URLs. You can either enter the path by hand, or click on Browse Workflows and then select one of the available workflows in a pop up dialog. The pop up dialog offers a search field for easier location of the desired workflow. When a search string is entered, the dialog lists all workflows that contain the typed search string in their path.
Load timeout
The maximum amount of time the client will wait for the server to load the called workflow. Specified in seconds. A value of 0 means that no timeout will be used.
Advanced Settings
After a workflow has been successfully selected, the input table can be directed to a desired Container Input (Table) node, the output table can be fetched from a desired Container Output (Table) node, and all flow variables/credentials can be pushed to a desired Container Input (Variable)/Container Input (Credentials) in the called workflow. This routing is done via drop down menus showing all available parameters in the selected workflow.
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 Container Input (Table) and Container Output (Table)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).

In the case a parameter defined in any of the Container Input (Table), Container Output (Table) or Container Input (Variable) nodes is not unique, the node ID will be appended to the parameter even though the use fully qualified names check box has not been checked.

Options

Workflow

Server address (Only when connected to a KNIME Server)
Displays the server address of the server connection.
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.
Retain job on failure (only applies if the called workflow is executed 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 if the called workflow is executed 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 in the server's repository. If not connected to a server the path may be absolute or use KNIME URLs. You can either enter the path by hand, or click on Browse Workflows and then select one of the available workflows in a pop up dialog. The pop up dialog offers a search field for easier location of the desired workflow. When a search string is entered, the dialog lists all workflows that contain the typed search string in their path.
Load timeout
The maximum amount of time the client will wait for the server to load the called workflow. Specified in seconds. A value of 0 means that no timeout will be used.
Advanced Settings
After a workflow has been successfully selected, the input table can be directed to a desired Container Input (Table) node, the output table can be fetched from a desired Container Output (Table) node, and all flow variables/credentials can be pushed to a desired Container Input (Variable)/Container Input (Credentials) in the called workflow. This routing is done via drop down menus showing all available parameters in the selected workflow.
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 Container Input (Table) and Container Output (Table)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).

In the case a parameter defined in any of the Container Input (Table), Container Output (Table) or Container Input (Variable) nodes is not unique, the node ID will be appended to the parameter even though the use fully qualified names check box has not been checked.

Advanced Settings

Job Status Polling
When calling remote workflows and when using asynchronous invocation (option "Long Duration"): if a HTTP 5XX error occurs, eg. bad gateway, while polling the job status, the node will retry the request. The node will wait a certain amount of time before each retry. The time to wait before the n-th attempt is determined by base * multiplier^n. Use a multiplier of 1 for a linear, or greater than 1 for an exponential backoff. Set the number of retries to 0 to disable retrying.

Input Ports

Icon
Connection to a KNIME server
Icon
Any input table

Output Ports

Icon
Output of workflow call

Workflows

Installation

To use this node in KNIME, install KNIME ServerSpace from the following update site:

KNIME 4.3

A zipped version of the software site can be downloaded here.

You don't know what to do with this link? Read our NodePit Product and Node Installation Guide that explains you in detail how to install nodes to your KNIME Analytics Platform.

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. Browse NodePit from within KNIME, install nodes with just one click and share your workflows with NodePit Space.

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.