Stream Item Action Rule

Currently in draft. Requires technical input from Eleanor and context input from Skevi.

This page is for application designers who need to configure when a specific operation will change data in the stream.

Action Concepts

A stream has a set of Stream Item Actions. These specify an operation that can happen to a record in the stream. Stream item actions can create, read, update or delete a record, so are called CRUD actions.

You can configure an Action to perform several operations on the data in different streams. This is because the action contains a list of stream item actions that can come from different streams.

The action can potentially run any of the actions in its list. To decide which stream item action to run, the action has a rule associated with each stream item action. When a Stream Item Action Rule evaluates to true, the action runs the action and therefore makes a change to the data in the stream.

Creating a Stream Item Action Rule

To use a stream item action in an action and to add a rule for it:

Open the Action properties.
In the toolbar of the Stream Item Action Rules section:
- either click Add to create a new stream item action rule.
- or click Stream Item Action (SIA) to open a repository list of streams.
  Expand the branch for the stream, then drag its stream item action into the action properties → Stream Item Action Rules grid.
  Double-click on row of the grid to open the stream item action rule properties.

Stream Item Action Rule Properties

Use the following properties to configure the conditions or rules under which the stream item action will run.

This properties tab is not available from the repository. It only opens from the Action properties.

For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. For a full list of all the PhixFlow property tabs and windows, see Property Tabs.

Basic Settings

Field	Description
Stream Item Action	The name of the stream item action. To add or change the name, do one of the following: select a stream item action name from the drop-down list of all SIAs in the repository. click Add to create a new one; see Stream Item Actions (SIA) click Stream Item Action (SIA) to open the repository Streams branch to find a stream item action and drag it in. This makes it easier to find a stream item action for a specific stream.
Stop if True	If the following expression is true, stop the stream item action from running.?? If the expression is true run this action but do not evaluate any more stream item action rule expressions and do not run any more of the stream item actions.
Expression	Enter an expression. Details?? The expression should evaluate to true or false and the action will run if true. If the expression is empty this is equivalent to true. Values are true or false according to the same rules as true/false stream attributes, except empty is true (but an expression that evaluates to null or empty string is false).
Order	Specify the order in which this stream item action is listed in the action properties → Stream Item Action Rules grid. PhixFlow evaluates the stream item action in order and runs those that evaluate to true in order.