Run parameters

Purpose

Collects run values, displays explanations and adds value-bearing parameters as columns to every row. Parameters are also available to subsequent conditions, formulas and mappings. You can show the form in the wizard, in a separate dialog, or use configured values without a form.

Inputs and outputs

One input, in. Usually one out output with added columns. If one radio switch has outputs=true, each position becomes a separate output; only the selected one is activated.

Parameters

Parameter	Settings and values	Options and limits
`wizard`	Show the block as a step in the execution wizard.	Default: `disabled`
`display`	hidden — no form, wizard — a wizard step, dialog — a separate dialog.	Default: `not set`
`dialog_width`	Dialog width in pixels.	Default: `760` Limits: 360…1600
`dialog_height`	Dialog height in pixels.	Default: `560` Limits: 240…1200
`dialog_stop_label`	A custom stop-button label; an empty value uses the default.	Default: `empty` Up to 60 characters
`dialog_continue_label`	A custom continue-button label.	Default: `empty` Up to 60 characters
`dialog_stop`	Allow execution to be stopped from the dialog.	Default: `enabled`
`dialog_maximize`	Show the option to expand the dialog.	Default: `enabled`
`dialog_close`	Show the close button.	Default: `enabled`
`title`	The title shown to the user.	Default: `empty` Up to 200 characters
`description`	An explanation that helps the user complete the form or make a choice.	Default: `empty` Up to 4000 characters
`columns`	The number of form-layout columns: from 1 to 4.	Options: `1`, `2`, `3`, `4` Default: `1`
`rows`	The number of grid rows; an empty value determines it automatically.	Default: `not set`
`row_gap`	The gap between grid rows.	Default: `not set`
`column_gap`	The gap between grid columns.	Default: `not set`
`fields`	From 1 to 100 form fields; the entire flow is also limited to 100 parameters.	Count: 1–100

Form field types

Parameter	What it configures
constant	A constant run value.
text / textarea	Single-line or multiline text.
number	A numeric value.
date	A calendar date.
member	Select a dimension/hierarchy member from a connection; it can be restricted to a subset.
toggle	Two positions with custom off_value/on_value values and labels.
radio	Multiple positions with unique id, label and value; displayed as a switch or buttons.
file	An attached file that can be used in messages.
info	Formatted and coloured information text; does not create a column.

Field properties

Parameter	What it configures
`name / label / hint`	The internal name, form label and tooltip.
`required / locked / value`	Required status, editing lock and default value.
`row / column / row_span / col_span`	The starting grid position and number of occupied rows/columns. Without row, the field is placed automatically in its column.
`connection_id / dimension / hierarchy / subset / private`	The member-list source for member and the subset mode.
`options / outputs`	The radio positions and whether separate outputs are enabled. Up to 20 options.
`appearance / option_gap / per_row / align / color`	The appearance of switch positions, spacing, number per row, alignment and colour.
`text / text_format / info_color`	The information field’s text, plain/html format and colour.

Step-by-step configuration

Place the block before steps that use its parameters. Enter a title and explanation.
Add fields with unique internal names and clear labels. Select each field’s type.
Set defaults, required status, editing locks and tooltips.
Choose the display mode and layout. Field positions must not overlap.
For member selection, specify the connection, dimension, hierarchy and, if needed, subset.
Link parameters to subsequent filters, formulas or targets and check the form in a simulation.

Rules and diagnostics

Parameter names are unique throughout the flow. A parameter name cannot overwrite an input column; otherwise PARAMETER_COLUMN_CONFLICT occurs.
Values become available after the block executes; subsequent steps cannot use parameters from a branch that has not run or from an unrelated branch.
An information message has no value and does not become a column. An attachment field has no default value.
A required, locked field needs a default value. The form grid checks boundaries and overlaps.
Only one radio switch in the block can have separate outputs. If the selected position is unconnected, that branch ends.
hidden mode remains hidden only when every field the user would need to fill already has a value. Otherwise, the system displays the form in the wizard.

Configuration example

Create “Scenario” as a radio with Budget/Forecast, “Period” as a member of the Month dimension, and “Rate” as number=1. Values are added to every row; a later filter uses “Period”, and a formula multiplies Value by param("Rate").

Labels, layout and supplied values

Fields provide show_label and label_gap to control the visible label and its spacing. A visually hidden label remains available to screen readers. Information fields can contain formatted text and a custom color but do not create columns. For radio choices displayed as buttons, set items per row, alignment, color and spacing. Preview the form before running it.

Schedules, APIs and other flows can supply parameters. A subflow or background call does not ask a person in a wizard: it uses supplied values or defaults. Supplied names must match internal field names. An earlier launch parameter, a first-row field and a constant are distinct sources and must be selected explicitly.