Skip to content

Flow Parameters

Give a Prep flow's parameters fixed values per task or per chain step, or one-off values for a single run, and see which values each run used.

How values are applied

Where you set values Saved? Used by
A task (Parameters > Configure in the task dialog, or Params on the task row) Yes, with the task Every scheduled run of the task, and Run on the task row
A chain step (gear button on the step) Yes, with the step Every run of that step
Run Now on the flow (Run parameters - ) No That one run only

Every run records the values it was submitted with. Params in Run History opens "Parameters used" for the run.

Before you begin

  • The flow declares parameters in Tableau Prep and is published to Tableau Server.
  • The task or chain exists, or you are creating it. See Tasks or Chains.

Steps

  1. Open the values dialog:
    • New or edited task: in the Task tab, click Configure next to Parameters. The button shows the number of values set, for example Configure (2).
    • Existing task: click Params on the task row.
    • Chain step: click the gear button (tooltip "Flow parameters") on the step.
  2. In Parameters - , enter a value for each parameter.
    • Each field shows the parameter's type, and its Tableau default as "default: ".
    • Required parameters are marked with *.
    • List parameters show a drop-down; true/false parameters show a check box.
  3. Click Save. Cancel closes the dialog without saving.

To run once with different values, click Run Now on the flow and enter values in Run parameters - . The dialog says "These values apply to this run only and are not saved to a task."

When the flow changes in Tableau

If the flow's parameters changed in Tableau after you saved values, the dialog shows "Flow parameters changed on Tableau since these were last saved. Review the values and save again." Check each value and click Save.

Verify

  • Configure shows the number of values you set.
  • After the next run, Params in Run History shows the values in "Parameters used".

Troubleshooting

Params says This flow declares no parameters to configure

Params appears on every task, including flows without parameters. For such a flow there is nothing to set.

A run used other values than I expected

Open "Parameters used" for the run. A run started with Run Now uses the one-off values entered for it, not the task's saved values.

Next steps