Container Input (File)

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.

Append unique ID to parameter name

If checked, the name set above will be amended by the node's 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.

Variable name

The name of the flow variable that contains the location of the local copy of the resource. Any characters are allowed as long as the name is not empty.

Use a default file

Whether to use the default file given below if no external resource is given. An external resource will always take precedence over a default file. Only the path of a default file will be exposed. A default file must exist. The node will fail to execute if this option is disabled or the default file is invalid and no external resource is available.

Read from

Select a file system which stores the data you want to read. There are four default file system options to choose from:

• Local File System: Allows you to select a file from your local system.
• Mountpoint: Allows you to read from a mountpoint. When selected, a new drop-down menu appears to choose the mountpoint. Unconnected mountpoints are greyed out but can still be selected (note that browsing is disabled in this case). Go to the KNIME Explorer and connect to the mountpoint to enable browsing. A mountpoint is displayed in red if it was previously selected but is no longer available. You won't be able to save the dialog as long as you don't select a valid i.e. known mountpoint.
• Relative to: Allows you to choose whether to resolve the path relative to the current mountpoint, current workflow or the current workflow's data area. When selected a new drop-down menu appears to choose which of the three options to use.
• Custom/KNIME URL: Allows to specify a URL (e.g. file://, http:// or knime:// protocol). When selected, a spinner appears that allows you to specify the desired connection and read timeout in milliseconds. In case it takes longer to connect to the host / read the file, the node fails to execute. Browsing is disabled for this option.

File, Folder or URL

Enter a URL when reading from Custom/KNIME URL, otherwise enter a path to a file or folder. The required syntax of a path depends on the chosen file system, such as "C:\path\to\file" (Local File System on Windows) or "/path/to/file" (Local File System on Linux/MacOS and Mountpoint). For file systems connected via input port, the node description of the respective connector node describes the required path format. You can also choose a previously selected file/folder from the drop-down list, or select a location from the "Browse..." dialog. Note that browsing is disabled in some cases:

• Custom/KNIME URL: Browsing is always disabled.
• Mountpoint: Browsing is disabled if the selected mountpoint isn't connected. Go to the KNIME Explorer and connect to the mountpoint to enable browsing.
• File systems provided via input port: Browsing is disabled if the connector node hasn't been executed since the workflow has been opened. (Re)execute the connector node to enable browsing.

The location can be exposed as or automatically set via a path flow variable. This is done additionally to the variable that is exposed via Output variable name.

Views

This node has no views

Workflows

• Apply Bundle (REST)KNIME Hub

Links

• KNIME Workflow Invocation (external clients)

  docs.knime.com/latest/analytics_platform_workflow_invocation_guide/index.html#workflow-invocation-nodes

Developers