Workflows
Parameters
How to define and use input parameters in Kogenta Connect workflows.
Parameters make workflows dynamic and reusable. Instead of hardcoding values like dates, regions, or thresholds, you define parameters that users provide when running the workflow.
Parameter types
| Type | Description | Example |
|---|---|---|
| Text | Free-text string input | A customer name or ID |
| Integer | Whole number | A year or count threshold |
| Decimal | Number with decimals | A percentage or distance |
| Boolean | True/false toggle | Include inactive records |
| Date | Calendar date picker | A start or end date |
| Date/Time | Date and time picker | A precise timestamp |
| Dropdown | Single selection from a predefined list | A region or category |
| Multi-Select | Multiple selections from a predefined list | Selected store types |
Defining parameters
When creating a parameter, you configure:
- Name - the identifier used in SQL queries (e.g.,
start_date,region) - Type - one of the types listed above
- Label - the display name shown to users when running the workflow
- Default value - an optional pre-filled value
- Required - whether the parameter must have a value before the workflow can run
- Help text - optional description to guide users on what value to enter
- Validation - optional rules like minimum/maximum values or allowed patterns
Using parameters in queries
Reference parameters in your SQL using double-brace syntax:
SELECT *
FROM sales.transactions
WHERE region = {{region}}
AND transaction_date >= {{start_date}}
AND amount > {{min_amount}}When the workflow executes, each {{parameter_name}} is replaced with the value provided by the user.
Parameters in dashboards
When a workflow is linked to a dashboard, its parameters can be:
- Pre-filled with fixed values at the dashboard level
- Exposed to dashboard viewers so they can provide values interactively
- Hidden from viewers if the dashboard should always use specific values
This flexibility lets the same workflow serve multiple dashboards with different parameter configurations.