This page explains how to set context parameters for an action.An action
Overview
When a user triggers an action, PhixFlow can take into account other values or attributes to decide whether or not to run. It is not possible to refer to one context parameter from another.These are called context parameters. At the start of an action, PhixFlow calculates the context parameters first. This is because they are needed to decide whether or not to run the action. This is called action validation.
Use context parameters to identify values:
- to pass from one dashboard to another
- for action validation
- that determine stream item actions
- to determine what your action will do.
Examples include:- which dashboard will open after the action completion
- which updates will take place (stream item action rules)
- whether or not a task plan will run.
| Tip |
|---|
The order of the context parameters is important! |
Context parameter values can come from:
- a field in a form
- a calculation.
The source values for the calculation can be- a field in a form
- previous context parameters
- results obtained from lookups.
You cannot directly refer to a context parameter from another context parameter. However, you can refer to a dollar variable defined that is defined in another context parameter expression. Make sure the dollar variable will be calculated before the current context parameter expression is evaluated. This can be useful to avoid repeating the same calculation. For example, sometimes you need to use a value in both a stream item action and dashboard rule.
In the action properties → Context Parameters section, there are two checkboxes that affect your context parameters
Include Previous Context Parameters adds to the context parameters of your action any existing context parameters from the dashboard. You can overwrite them by including it in your action and giving it a new value.
Context Parameter Properties
This properties tab is not available from the repository. It opens from an action properties → Context Parameters section.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Basic Settings
| Field | Description |
|---|---|
| Order | Enter the order in which context parameters will be evaluated. |
| Name | Enter the name of the context parameter. Either select an attribute name from the drop-down list, or enter a different name. |
Use these values as New |
|
| Expression | Enter the expression for the context parameter. Unlike stream action attribute expressions, context parameter expressions can evaluate to a list of values as well as single values. The context parameter expressions can refer to:
Use the notation:
The expression can include the message functions debug(message), info(message), warning(message), and error(message), which write messages to the system console logs. Remember that error(message) function stops the action from completing. |
...