Bind to Data-flo input

Value to be provided by the user at Run-Time

When using the Bind to Data-flo input binding, the value for the argument can be defined by the user each time the data-flo is run. This is the easiest way to make a data-flo flexible to handle various similar data files.

A few of the many use cases:

  • Different users have similar files stored in different locations, and will need to point the data-flo accordingly (e.g. files saved on individuals' local computers)

  • Different values for a text or number field will be used from run to run (e.g. setting the numeric threshold for a filtering adaptor)

TIP: name your input and add plenty of information to the input description (in the right sidebar) so users know what they need to input. This is especially helpful when a data-flo’s inputs and outputs are going to be provided in a nested data-flo.

How to use 'Bind to a Data-flo input'

As shown in images below:

  1. Select "Bind to a Data-flo input"

  2. Click on the PLUS next to "Input argument"

  3. This adds the input box, which will be labeled with the argument name.

  4. Click on the new input box to bring up the "Input details" sidebar.

  5. Set the default value options:

    1. If the user must always enter a value at run-time, select "A value is required"

    2. In rare cases when no value is required from the user or a preset default, choose "Optional without a default"

    3. If the user can enter their own value, but a default value is desired (e.g. a numeric filter threshold is usually 0.2 but a user may desire a different threshold), select "Optional with a default value" and set the "Default value" (selecting "Treat default value as secret" is useful for values like API keys or other information that may help the data-flo run, but should not be shared among users or shown on the Run Page)

  6. Change the name of the input as needed, and add a description to assist users in setting the input from the Run Page. The values entered in these fields will be shown on the Run Page's INFO and RUN subpages.

Secret inputs

Default values are not shown on the Run Page, but by default, they do carry over when someone makes a copy of the data-flo.

In some cases, you may want to share a data-flo that contains sensitive information in the default value of a binding. When you want to hide values from others, check the box to "Treat default value as secret"; this leaves the value there, but the default is not shown on the Run Page (and if another user creates a copy of your data-flo, the secret input changes to "A value is required" so your secret doesn't get shared).

Allowed Values

This feature is meant to act similarly to a dropdown. It can be used regardless of whether the input is required, has default, has secret input, etc.

*Known bug alert*-"Allowed Values" feature does not always behave.

Remove binding

When you click the "REMOVE BINDING" button, the argument reverts to its defaults or reverts to blank**.**

If you delete the adaptor for a Data-flo input (e.g. the "target" box in the image above), this will also remove the binding.

How inputs look on the Run Page

The input looks the same on the Run Page, regardless of how it is configured, with the exception of the use of "Allowed Values". See images.

Last updated