PhixFlow Help

Context Parameter

This page explains how to set context parameter properties for an action.

This setting is not available from the repository browser. It opens from an action properties → Context Parameters section.

The toolbar has the standard icons. For information about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties.  For information about other property tabs, see Property Tabs.

Basic Settings

FieldDescription
OrderThe order in which context parameters will be evaluated
NameThe name of the context parameter.
Either select an attribute name from the drop-down list, or enter a different name.
Expression

An expression for the context parameter. The context parameter expressions can refer to any values entered on the form view using the notation:

_prompt.<Form Field Name>

The context parameters can also refer to any attributes of any records selected on the view or dashboard from which the action was initiated using the notation:

<View name or alias>.<Attribute name or alias>

Context parameters may also refer to $-variables used in other context parameter expressions on the same action.

It is not possible to refer to one context parameter from another.

The values returned by the context parameter expressions can be referenced by the Validation expression, the Filter, the Maximum and Minimum Items expressions, any Stream Action Attribute expressions and any dashboard opened by this action.

The context values are referenced using the syntax:

_context.<context parameter name>

Unlike stream action attribute expressions, context parameter expressions can evaluate to a list of values as well as single values.

The usual message functions debug(message), info(message), warning(message), and error(message) are all available to be used in these expressions and will result in messages being written to the system console logs.

Be careful when using the error(message) function as this will stop the action from being completed.

Example

A view called Customers shows a list of customers including the account ID, name and other account details. You want to create an action button to open up another dashboard, containing a view called Invoices, which will show the invoices for the customer selected on the Customers view.To do this:

  1. Add an action button to the Customers view, and configure it to open the dashboard containing the Invoices view
  2. Add a context parameter called Account to the action, with the context parameter expression set to customers.account_id
  3. On the background filter of the Invoices view, set the filter to only select those invoices whose account_id is equal to _context.account.




Please let us know if we could improve this page feedback@phixflow.com