Set default parameters for a process
A dataset filter, rule or template can contain a parameter token such as {aoParam:Region} or $$Region$$ that isn't a field on the record. A value for it has to come from somewhere. A process's Parameters give it a default value.
Steps
-
Open the process
In the back office, open the process and find Parameters.
-
Add a parameter
Add an entry. Set Parameter Name to the name used in the token, without the brackets, for example
Region. Set Parameter Value to the value to use, for exampleUK. The name must match exactly, including capital letters. -
Save and publish
Click Save and publish.
More detail
Where parameter values are used
- In the dataset's filters, to choose which records are fetched.
- In email templates, message templates and API requests, as tokens. If a record has a field with the same name, the record's own value is used instead.
Overriding the defaults
The Test tab and the Schedule a job form on the Jobs tab show a box for each parameter the process needs, filled in with these defaults. Anything you type there is used for that test or run instead.
The process works out which parameters it needs by looking through its dataset filters, rules and the templates its steps use. Names that are already fields on the record aren't asked for.
If a value is missing
If a parameter used in the dataset's filters has no value when the process runs, the run fails with One or more aoParams were not provided.