Building Parameter Forms
The Parameters tab of the component editor is a visual builder. It turns the
{{variables}} in your script into a form that whoever adds the component to a
workflow fills in. You do not write YAML by hand; the builder generates it.
Fields map to script variables
The most important rule: a field's Variable name is exactly what you
reference in the script as {{that_name}}.
If your script uses {{package_id}}, add a field whose Variable name is
package_id. The two must match. The editor flags any variable without a field
and any field the script does not use.
- 1
Add a field
Add a field for each value your script needs. Set its Variable name to match the
{{name}}in the script. - 2
Choose a type
Pick the input type: Text, Number, Checkbox, Dropdown (a fixed list of choices), Multi-Select, Text Area, Date, Password, IP Address, File Path, URL, or Storage File. The type controls how the value is rendered and formatted. A checkbox becomes
$true/$falsein PowerShell, for example. - 3
Set a label, default, and requirement
The label is what people see. Provide a sensible default where one exists, and mark a field required only if the script cannot run without it.
- 4
Group related fields
Use groups to organize a longer form into labelled sections.
Field types
| Type | Use it for | Notes |
|---|---|---|
| Text | Free-form strings | The default. |
| Number | Numeric values | Substituted without quotes. |
| Checkbox | On/off switches | Becomes $true / $false. |
| Dropdown | A fixed set of choices | Provide the options; set one as the default. |
| Multi-Select | Choosing more than one option at once | Value is a list of the selected options. |
| Text Area | Longer free-form text | Renders a multi-line input. |
| Date | Calendar dates | Renders a native date picker. |
| Password | Secrets entered at setup time | Masked as the person types. |
| IP Address | IPv4 or IPv6 addresses | Add an IPv4/IPv6 validation preset to enforce the format. |
| File Path | File-system paths | Add a file-path validation preset to enforce the format. |
| URL | Links | Add a URL validation preset to enforce the format. |
| Storage File | A file from storage | The agent resolves it to a local path at run time. |
How it looks to the person adding the step
When someone adds your component to a workflow, this form is what they see in the step's Setup tab. The values they enter are substituted into your script for that step. See Writing a Custom Component for the script side.
Keep required fields to a minimum and lean on good defaults. A component that works with mostly-default settings is faster to adopt.