Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

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 
    Insert excerpt
    _add
    _add
    nopaneltrue
     .
  • or open the repository branch for a stream. Right-click Stream Item Actions and select 
    Insert excerpt
    _add
    _add
    nopaneltrue
    .

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.

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

Field
For Type of Operation
Description
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.

Note

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

UpdateIs the following true?

This option is only available where Stream Item Action is Insert or Update.

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

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 

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 Update
Insert

This option is only available where Stream Item Action is Insert.

This section has a toolbar with standard buttons and 

Insert excerpt
_attributes_show
_attributes_show
nopaneltrue
.

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 

Insert excerpt
_attributes_show
_attributes_show
nopaneltrue
. PhixFlow opens the list of stream attributes. Drag attributes into the grid.

To create a new attribute, click 

Insert excerpt
_add
_add
nopaneltrue
. 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 information from the action attribute:

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

To remove an attribute from the grid, use the

Insert excerpt
_delete
_delete
nopaneltrue
 in the toolbar.

Filter Type

Delete

Update

This option is only available where Stream Item Action is Delete or Update.

Select an option from the drop-down list

:Selected Items - Action

.

The action will only apply to the records that:

  • Selected Items - the user has selected on the
view
  • dashboard from which the action was
initiated unless
  • initiated, unless the Target View is specified.
  • Edited Items -
Action will only apply to the updated records
  • that the use has updated 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
  • that are currently displayed  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
  • that the filter defined in the action has retrieved.
  • Dragged Items -
 Action will only apply to the records which are being dragged in the case that this is a drag and
  • the user is dragging, for 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
  • the user is dropping something onto, for a drag-and-drop action.
Condition

This option is only available

if you have selected

where Stream Item Action is Insert or Update and  Filter Type

=

is 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 option is only available

if you have selected

where Stream Item Action

 =

is 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

This option is only available where Stream Item Action is Delete or 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

This option is only available where Stream Item Action is Delete or 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

This option is only available where Stream Item Action is Delete or 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 

Insert excerpt
_user_group
_user_group
nopaneltrue
.

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

...