Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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

This page is for application designers who need to configure specific operations that will change data in the stream.

A stream item action (SIA for short?) belongs to a stream. It represents the smallest, specific operation that can happen to the data in the stream. 

To create a stream item action:

  • either open a stream's properties. In the Stream Item Action section, click  Add New .
  • or open the repository branch for a stream. Right-click Stream Item Actions and select  Add New.

In both cases, PhixFlow opens a new stream item action properties tab. Use the following properties to configure the stream item action.

You can configure an Action by adding several stream item actions from different streams. In the action you also specify the conditions or rules under which the stream item action will run.

For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties.  We recommend you always add a Description that explains the purpose of the item you are creating. 

For a full list of all the PhixFlow property tabs and windows, see Properties, Windows, Menus and Toolbars.

Basic Settings

FieldFor Type of OperationDescription
Name

All

Enter the name of the stream item action.
Stream Item Action

All

Select the type of operation:

  • None 
  • Insert
  • Delete
  • Update

The remaining options available in Basic Settings depend on the type of operation you select.

You cannot undo or reverse a stream item action that deletes data records from a stream.

If you want users to have the option to undo a change:

  1. Configure a stream item action to Update rather than delete.
  2. The update marks the records as 'deleted', for example in a "status" attribute.
  3. Set up a scheduled archive task. Configure it to archive (delete) records set that have had status set to 'delete' in a specified time period, e.g. 48h hours.

This gives users time to reinstate records that have been deleted by mistake. The user will need to manually update the status attribute for the record to remove 'deleted'. If you do not  want your users to see deleted records, you can filter them from any views.

Copy Values by Name

Insert

Update

This will only apply to records which have a corresponding record on the form.

 Untick 

Error rendering macro 'excerpt-include' : No link could be created for '_check_box_ticked'.
 

If there is a form. And it includes attributes

and some of those attributes are not listed in the properties grid "Attributes to update"  below

 will take their new values from the current form..

Attributes to UpdateInsert

Is the following true?

This section has a toolbar with standard buttons and   Show Attributes.

The grid  contains a list of attributes on which the stream item action will operate. If the grid is empty, the stream item action will operate on all attributes in the stream. To add stream attributes to the grid, in the toolbar, click  Show Attributes. PhixFlow opens the list of stream attributes. Drag attributes into the grid.

To create a new attribute, click  Add New. To edit an attribute that is listed in the grid, double-click its name. In both cases, PhixFlow opens the Action Attribute properties.

The grid displays:

  • Order: The order in which the rules are evaluated.
  • Name: The backing stream.
  • Expression: Any expression that has been defined for the attribute.

In the grid, double-click an attribute to open its properties; see Action Attribute. To remove an attribute from the grid, use the  Delete in the toolbar.

Filter Type

Delete

Update

Select an option from the drop-down list:

  • Selected Items - Action will only apply to the records selected on the view from which the action was initiated unless the Target View is specified.
  • Edited Items - Action will only apply to the updated records on the view from which the action was initiated unless the Target View is specified.
  • View Filter - Action will only apply to the records shown on the view from which the action was initiated unless the Target View is specified.
  • Action Filter - Action will only apply to the records retrieved by the filter defined in the action.
  • Dragged Items - Action will only apply to the records which are being dragged in the case that this is a drag and drop action.
  • Drop Target Items - Action will only apply to the records which are having records dropped onto them in the case that this is a drag and drop action.
Condition

This is only available if you have selected Filter Type = Action Filter.

Create a filter to specify the records that an Update or Delete will apply to. Any expressions on this filter can reference the Form View fields, Context Parameters and any attributes from any record selected on the view or dashboard from which this action was initiated. Configure this filter in the same way that you would a pipe filter.

Copy Values By Name

This is only available if you have selected Stream Item Action = Insert or Update.

If this flag is ticked, all Stream Item Attributes which are not present on the Action Attributes list below will take their new values from the current form.

This will only apply to records which have a corresponding record on the form.

Target View

Delete

Update

If specified, changes the view the action applies to

(gets records from if selected Filter Type = Selected Items, Edited Items or View Filter).

Maximum Items Expr.

Delete

Update

Enter an expression that evaluates to a number??. The number limits how many records or cells ?? that this action can affect.
Minimum Items Expr.

Delete

Update

Enter an expression that evaluates to a number??. The number specifies the minimum number of records or cells ?? that this action can affect.

Data Sources

Not sure what this is for. A data source itself is just a name. 

This section has a toolbar with standard buttons and  User Groups.

Optionally create data sources that affect this stream item action how ??.

To create a data source, in the toolbar, click  Show Attributes. PhixFlow opens a new properties tab for the data source. Enter the name and save. PhixFlow adds the data source to the stream item action.

In the grid, double-click a data source to open its properties. To remove a data source from the grid, use the  Delete in the toolbar.

Action Validation

FieldDescription
Validation Expression

Enter an expression. Examples??






  • No labels