How to create and customize workflow parameters
On this page
A workflow parameter is a named, typed configuration value filed in a
category, and workflow reads it through the placeholder %[WFP <Name>]%. An
administrator defines the parameter once in the Settings App and places its
placeholder in the workflow items that need the value. To update all those
items, change the parameter's value on the Workflow Configuration page.
Before you begin
- To define parameters and their categories, you need the administrative right named Configuration Parameters in the Settings App. Parameters and categories are defined only there.
- To change parameter values in the Settings App, you need the administrative right of its Workflow Configuration page.
- To change parameter values in the Admin Center, you need the Workflow Configuration permission, which shows the Workflow Configuration tile.
- In a new 2026.1 database created with the Default Workflow, the workflow starts with a set of parameters; see Default Workflow Configuration.
Choose or create a category
Parameters are defined in the Settings App under Workflow and Business Logic > Advanced > Configuration Parameters. The left pane is the category tree, and its toolbar holds the commands for categories.
- New > New Category creates a category at the level of the selected one, under the same parent.
- New > New Subcategory creates a subcategory and is available only for a top-level category.
- A category name can be up to 50 characters.
The other category commands are in Manage categories.
Define the parameter
In the Settings App, under Workflow and Business Logic > Advanced > Configuration Parameters:
- Select a category and click New on the toolbar of the parameter list.
- In the Workflow Parameter window, fill in the General tab:
- Name: (required). The name must be unique among all workflow parameters.
- Label:, up to 100 characters.
- Type: (required).
- Reference to:.
- Lookup values:, for a Lookup or Multi-select parameter.
- Description:.
- Category: (required).
- The Initial value group, which takes a single value.
- For a Lookup or Multi-select parameter, click the button of Lookup values: and type the values.
- Click OK.
- Click Apply to write your pending changes.
A new parameter takes its initial value as its current value, which is the value workflow uses. The available types and what happens to the current value when you edit a parameter later are in Create or edit a parameter.
Use the parameter in workflow items
Write the placeholder %[WFP <Name>]% in workflow text, expressions, scripts,
or notification bodies, with the parameter's name in place of <Name>. The
placeholder is expanded from the item's text when the item runs.
In the Settings App, you can choose the placeholder instead of typing it:
- In the editor, click Insert Placeholder....
- In the Select Placeholder window, select the Workflow Parameters category. It groups the parameters by parameter category.
- Double-click the parameter.
The window is described in Pick a placeholder.
Check where the parameter is used
The Usage tab of the Workflow Parameter window lists the workflow items
that use the parameter's placeholder, one row per use. Its caption shows the
number of uses while there are any, as in Usage (<count>).
- Under Configuration Parameters, select the parameter and click Edit, or double-click it.
- Click the Usage tab.
- To open a referring item, select a use and click Open.
Change the value in one place
When the setting changes, change the parameter's current value; the workflow items that use the placeholder read the new value.
In the Settings App
- In the navigation tree, select Workflow and Business Logic > Workflow Configuration.
- Select a category. The page shows an editor for each parameter of the category, labeled with the parameter's label, or with its name when it has no label.
- Change the values.
- Click Apply. Only the current values are written; the initial values stay as defined.
In the Admin Center
- In the Workflow and Business Logic section, click the Workflow Configuration tile.
- In the category tree, open the category that holds the parameters.
- Change the values. Save and Cancel appear once you change a field.
- Click Save.
Saving writes only the current values of the category's parameters; the parameter definitions stay as they are.
When the new value takes effect
Each application keeps a copy of the workflow it has loaded and reloads the parameters when it notices that their values were saved. Until then, it still uses the previous value. How soon each application notices is in How changes reach running applications.
Rename or remove the parameter later
- Renaming a saved parameter rewrites
%[WFP <old name>]%to the new name in the workflow items that use it. - A parameter that a workflow item uses cannot be deleted. The Settings App opens that parameter's window on its Usage tab; remove the uses first.
Result
The value lives in one workflow parameter. The workflow items that need it read
it through %[WFP <Name>]%, the Usage tab shows where it is used, and you
change it on the Workflow Configuration page of the Settings App or the
Admin Center.
Related topics
- Workflow Configuration and Parameters - define parameters and change their values.
- Macros Reference - placeholder syntax and the Select Placeholder window.
- Workflow Overview - how changes reach running applications.