Process Parameters are values supplied at runtime that control how a Process executes. They define the scope of a specific run — for example, which date to calculate for, which record to process, or which file to import. They are not database data and are not written to objects; they are inputs passed directly to the Process Logic workbook at the moment execution begins.
Not every Process requires parameters. A Process that always operates on the same dataset with no user-supplied scope may not need them. But any Process where the user or a calling system needs to specify context — a date, a reference to another record, a file — requires one or more Parameters to be configured.
When a user runs a Process manually, the platform prompts them to supply parameter values before execution begins. When a Process is triggered automatically — by a schedule, a parent Process, or a save event — the calling system or parent Process must supply the required values. No user prompt is shown.
Parameter types
Each Parameter has a type that determines what kind of value it accepts.
Boolean — a true or false value.
Date — a date value (no time component).
DateTime — a date and time value.
File — the user uploads a file (Excel, CSV, TXT, or XML). Used for Import Processes where the source data is provided at runtime.
Integer — a whole number.
Number — a decimal number.
Reference — a reference to a record in a specified object. The user selects from valid records in that object rather than typing a free value. Configure the Referenced Object field to specify which object to draw from.
String — a text value up to 1,000 characters.
Text - a text value up to 4,000 characters.
Timestamp - a date and time value which includes milliseconds dd/mmm/yyyy hh\:mm\:ss.xxx
How parameter values are passed to the workbook
All parameter values are written into the Process Logic workbook at the starting cell defined in the Spreadsheet Parameter Location field on the Process record. Values are written horizontally from that cell — one value per column — in the order defined by the Order field on each Parameter.
If the standard Process Logic template is used, the starting cell is the named range ES_PARAMETERS. The name configured in the workbook and the name entered in the Spreadsheet Parameter Location must match exactly.
Configure Process Parameters
Open the Configuration application and navigate to Process Configuration \> Processes.
Select the Process that requires parameters.
In the Process Parameter section, click Edit.
Enter the number of parameters to create and click Add.
For each parameter:
Enter a Name. Parameter names cannot begin with a number. Use consistent names across all Processes in your application — shared names allow filter reuse.
Select the Type.
If Type is Reference, select the Referenced Object.
Set the Order. Order 1 is requested first and written to the first column from the parameter starting cell. Higher numbers follow in sequence.
Enter an Audit Comment.
Click Save and Refresh.
Test the configuration
To confirm the parameters are configured correctly, navigate to the application containing the Process, open the Process Execution screen, locate the Process, and click Run. The platform should prompt for each parameter value before executing. If the prompt does not appear or the wrong parameters are shown, check the Order values and the Spreadsheet Parameter Location setting on the Process record.