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

Record-Action Concepts

To make changes to the data in a table use a record-action. Each record-action is a single operation that can happen to a record in the table. Record-actions can create, read, update or delete a record, so are sometimes called CRUD actions. To configure PhixFlow to perform several operations to the data  record-actions directly to a table. Alternatively, to configure PhixFlow to perform several operations

  • in one table, add a list of record-actions to a table or to a table-action associated with the table.
  • in different tables, add a list of record-actions to an action that is not associated with a specific table. The record-actions affect the different tables.

An action/table-action can potentially run any of the record-actions in its list. To decide which record-action to run, create a rule associated with each record-action. When the rule evaluates to true, the record-action runs, making a change to the data in the table. See Record-Action and Record-Action Rule properties.

Creating a Stream Item Action

To create a stream item action:

  • either open a stream's properties. In the Stream Item Action ??Change 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.

Stream Item Action Properties

 Use the following properties to configure the stream item action.

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

FieldDescription
NameEnter the name of the stream item action.

Stream Item Action

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.

Attributes to Update

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

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 Stream Item 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  Delete in the toolbar.

Filter Type

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

Select an option from the drop-down list.

The action will only apply to the records that:

  • Selected Items - the user has selected on the dashboard from which the action was initiated, unless the Target View is specified.
  • Edited Items - that the use has updated on the view from which the action was initiated, unless the Target View is specified.
  • View Filter - that are currently displayed  on the view from which the action was initiated unless the Target View is specified.
  • Action Filter - that the filter defined in the action has retrieved.
  • Dragged Items - the user is dragging, for a drag-and-drop action.
  • Drop Target Items - the user is dropping something onto, for a drag-and-drop action.
Target View

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

Enter a stream view name.

Where Filter Type is one of Selected Items, Edited Items or View Filter the records will be taken from the named view, not the view from which the action was initiated.

Condition

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

Create a filter to specify the records to which the action applies.

Expressions in this filter can refer items on the view or dashboard from which this action was initiated, for example:

  • form fields
  • context parameters
  • attributes from any selected record

Configure this filter in the same way that you would a pipe filter.

Copy Values By Name

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

Specify what to do if the dashboard from which the action was initiated includes more attributes than those listed in the properties grid Attributes to Update.

 UntickIf this is unticked then only attributes listed in Attributes to Update will be updated. All other attributes will be unchanged, or null if the action is insert.

Error rendering macro 'excerpt-include' : No link could be created for '_check_box_ticked'.
 For each stream attribute, if it is not listed in Attributes to Update, the attribute will be updated to the value of the form field or stream view attribute with the same name as the stream attribute. If there is no match it will not be updated.

Maximum Items Expr.

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 that this action can affect. If this action is applied to more than this number of items, only the specified number of items will be updated and the rest will be ignored. Items are ordered as they are in the stream view the items are selected from.

Minimum Items Expr.

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 that the action must be applied to for this action to run. If fewer than this number of items the action will return an error and will not run.

Data Sources

Not sure what this is for. A data source itself is just a name. This is for the new workflows.

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

Enter an expression. Examples??





  • No labels