Input Methods
Input methods pass parameters to opened views, scripts, or variables through click actions (except the Go to the URL action).
- Input methods also pass parameters to a script using script launch actions in the Table widget.
- Each widget has its own set of available input methods.
- The Event Name, Start Event Name, and Finish Event Name input methods are available only with the Process Explorer and Sphere of Processes widgets. These methods do not display additional fields and pass a value of data type String.
Column
Use this method to pass a value from a selected table column. For running a script from the Table widget, the value comes from the column corresponding to the selected table row. For a click action, the value comes from the column filtered by the dimension value on which the user clicked to trigger the action. The column specified in the input method does not need to appear in the dashboard.
Variable
Use this method to pass a dashboard variable to an executable script as an expected field or to an opened view as an input value.
When you select this input method, the Variable field appears. Click the field and select a dashboard variable of the appropriate data type.
If the opened view is generated by a script, the dashboard variable passes to the script’s expected field, and the expected field’s value passes to the input value variable of the generated view.
Formula
This method passes the result of a formula calculation. When selected, the Formula field appears, where you must enter a dimension formula matching the parameter’s data type.
Set by Aggregation
Use this method to pass an aggregation result to a script’s expected field. For example, to pass a string containing an aggregation result to a filter in a generated view. The aggregation result must match the expected field’s data type.
When using Formula or Set by aggregation, the Consider Filters switch is available. When enabled, the parameter receives data filtered by Browse mode filters.
Event Name
This input method applies only to click actions configured for events in the Process Explorer and Sphere of Processes. When clicking a transition with this action, the system passes the name of that transition’s event.
Start Event Name
This input method applies only to click actions configured for transitions in the Process Explorer and Sphere of Processes. When clicking a transition with this action, the system passes the name of that transition’s start event.
Finish Event Name
This input method applies only to click actions configured for transitions in the Process Explorer and Sphere of Processes. When clicking a transition with this action, the system passes the name of that transition’s finish event.
The Event Name, Start Event Name, and Finish Event Name input methods pass values of data type String.
Input Method Sets by Widget
Available input methods depend on the widget for which they are configured.
| Input Method | Widget |
|---|---|
| Column | Table Pivot Table Combined Bar Chart Bar Chart Donut Chart Line Chart |
| Variable | Table Pivot Table Combined Bar Chart Bar Chart Donut Chart Line Chart Button Process Explorer (for events and transitions) Sphere of Processes (for events and transitions) Funnel chart (for process stages) KPI List Text |
| From Data Model | Button (only for the Run Script click action) |
| Formula | Table Pivot Table Combined Bar Chart Bar Chart Donut Chart Line Chart |
| Set by aggregation | Button Donut Chart Combined Bar Chart Line Chart Pivot Table Bar Chart Table Funnel chart (for process stages) KPI List Text |
| Event Name | Process Explorer (for events) Sphere of Processes (for events) |
| Start Event Name | Process Explorer (for transitions) Sphere of Processes (for transitions) |
| Finish Event Name | Process Explorer (for transitions) Sphere of Processes (for transitions) |
Input Methods in YAML
Input methods in YAML are specified in the inputMethod block:
| Key | Type | Definition |
|---|---|---|
| inputMethod | enum | Variable input method: - COLUMN — column- VARIABLE — variable- FORMULA — formula- AGGREGATION — set by aggregation- EVENT — event name- START_EVENT — start event name- FINISH_EVENT — finish event name |
Additional settings exist for the COLUMN, VARIABLE, FORMULA, and AGGREGATION keys.
For the COLUMN key:
| Key | Type | Definition |
|---|---|---|
| tableName | string | Table name |
| columnName | string | Column name in the table specified by tableName |
For the VARIABLE key:
| Key | Type | Definition |
|---|---|---|
| sourceVariable | string | Variable name |
For the FORMULA and AGGREGATION keys:
| Key | Type | Definition |
|---|---|---|
| formula | string | Formula supporting aggregate functions |
| considerFilters | boolean | Consider Browse mode filters |
Was the article helpful?