Versions Compared

Version Old Version 3 New Version 4
Changes made by

Fiona Sargeant (Unlicensed)

Fiona Sargeant (Unlicensed)

Saved on

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

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.

Note

A stream item action that deletes data records from a stream is non-reversible.

Consider using an Update action to simply mark the records as 'deleted'. You can then run archive task to remove records marked as deleted after a certain period of time. This will provide a window of opportunity for these 'deletions' to be reversed manually if they are made by mistake. If you do not  want your users to see these deleted records, you can filter them from any views.


Copy Values by Name

Insert

Update

?? 

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue

Attributes to UpdateInsert

Is the following true?

This section has a toolbar with standard buttons and 

Insert excerpt
_user_group
_user_group
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.

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. To remove an attribute from the grid, use the

Insert excerpt
_delete
_delete
nopaneltrue
 in the toolbar.

Filter Type

Delete

Update

Is there helpful information we can add for this??

Select an option that tells the action which data records are affected.

  • Selected items
  • Edited Items
  • View Filter
  • Action Filter
  • Dragged Items
    • Drop target Items

    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

    What's this for??

    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.

    ...

    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 ??.

    ...