Versions Compared

Version Old Version 49 New Version Current
Changes made by

Zoe Baldwin

Zoe Baldwin

Saved on

Key

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

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue

This page is for application designers who need to configure functionality for components or events. It explains the properties for the calculate node and associated expressions, which is part of an actionflow.


Excerpt
OverviewThe actionflow configuration is complete.
Tip

After configuring an actionflow, always test the actionflow to make sure it works.

Insert excerpt_

Calculate Node Properties

Image Modified

Use a 

Insert excerpt
_action_calculate
_action_calculate
nopaneltrue
node to manipulate data that is passed to it. Calculate nodes have their own attributes, which can reference incoming data via expressions using one or more of the 115+ functions available in PhixFlow.

Worked Example

Click to play the following video that shows an example of using a calculate node in an actionflow.

View file
nameOpen Calculate Example.mp4
height250

The video shows an actionflow that opens a new screen containing a dynamic text field. It then populates the dynamic text field with a message, which is set in a calculate node attribute. The steps for are:

  • Drag a calculate node from the toolbar and drop it into the actionflow diagram.
  • Name the calculate something meaningful, e.g. Set Message
    • Disconnect the Insert excerpt_action_screen_action_screennopaneltrue node from the  Insert excerpt_driving_interface_connection_point_driving_interface_connection_pointnopaneltrue.Connect the  Insert excerpt_driving_interface_connection_point_driving_interface_connection_pointnopaneltrue to the  Insert excerpt_action_calculate_action_calculatenopaneltrue node.
  • To pass data into the actionflow, go to the Inputs section on the left. Connect the component input connection point ScreenToOpen to the calculate node.
  • Click on the calculate node to open its properties.
    • In the Attributes section, add a new calculate attribute and set:
  • Name to Message

    • Expression to:

    Code Block
    "You have successfully set up a calculate node"
  • Map the calculate attribute to the dynamic text field on the screen as follows: 

    1. Right-click on the connection and click Configure Mappings.

    2. Drag the Message attribute from the calculate node, on the left, to the Message attribute on the open screen, on the right.
    3. Close the mapping screen.

    • For full details on how to create Calculate actions, including worked examples, see Calculate Action Configuration.

    Insert excerpt
    _property_tabs
    _property_tabs
    namebasic-h
    nopaneltrue

    Insert excerpt
    _property_toolbar
    _property_toolbar
    nopaneltrue

    Insert excerpt
    _parent
    _parent
    nopaneltrue

    Basic Settings

    FieldDescription
    NameEnter the name for the action node.
    Insert excerpt_actionflow_properties_actionflow_propertiesnameshow-namenopaneltrue Insert excerpt_actionflow_properties_actionflow_propertiesnameshow-textnopaneltruePass Through

    Specify whether or not to allow data that has not been processed to pass through to the next action node. 

    Insert excerpt_check_box_untick_check_box_unticknopaneltrue to prevent data that is not processed by this node from passing to the next action node.  Insert excerpt_check_box_tick_check_box_ticknopaneltrue to allow data that is not processed to pass through to the next action node.

    Input Connection Points

    This section has a toolbar with standard buttons. The grid contains a list of the connection points that connect into this calculate node.

    To add a new input connection point, in the section toolbar click  Insert excerpt_add_addnopaneltrue  and set the properties.
  • To edit an existing connection point, double-click it in the list to open its properties.
    • To remove a connection points, select one and in the section toolbar click  Insert excerpt_delete_deletenopaneltrue.

    For details about the Name, Type and Data Attributes properties of the input connection point, see Input Connection Points.

    Calculate Attributes

    Calculate
    Description

    We recommend that you always enter a description to explain the purpose of this item.

    Output Attributes
    Anchor
    attribute
    attribute

    Calculate actions process data using expressions; see pages in the topic Expressions and PhixScripts.

    This section has a toolbar with standard buttons. 

    The grid contains a list of the expressions that the calculate action will perform. 

    • To add a new expression, in the section toolbar click 
      Insert excerpt
      _add
      _add
      nopaneltrue
       to open a new expression and set the properties.
    • To edit an existing expression, double-click it in the list to open its properties.
    • To remove an expression, select one and in the section toolbar click 
      Insert excerpt
      _delete
      _delete
      nopaneltrue
      .
    • To reorder an attribute, drag and drop the attribute into the desired position. Alternatively, double-click to open its properties and update the Order field.
    • Click 
      Insert excerpt
      _add
      _add
      nopaneltrue
      . PhixFlow opens the properties for a new calculate attribute
    ; see Calculate Attributes Properties, below. Insert excerpt_description_descriptionnopaneltrue Insert excerpt_audit_auditnopaneltrueCalculate Attributes Properties  Anchorattributeattribute Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue Insert excerpt_property_toolbar_property_toolbarnopaneltrue Insert excerpt_parent_parentnopaneltrue

    Basic Settings

    Insert excerpt_check_box_tick_check_box_ticknopaneltrue to indicate the calculate attribute matches the name of an attribute in the data. Insert excerpt_check_box_untick_check_box_unticknopaneltrue to indicate the calculate attribute does not have the same name as an attribute in the data. In this case you will need to map the data attribute to this calculate attribute.
    • .

    Create New Output Attribute

    Field

    		Description
    NameEnter the name of the calculate attribute.
    Type

    Select one of the data types:

    • String
    • Bigstring
    • Integer
    • Float
    • Decimal
    • Date
    • Datetime
    • Graphic
    • TrueFalse
    • Structured Data
    Note

    Make sure you select the same data type as that of the attribute to which you are mapping; see Understanding Data Types.

    Attribute Name


    Where the calculate action runs multiple expressions, enter a number to indicate the order in which this expression will be run.

    Remember that an expression that generates a value must run before any expression that uses the value.
    Order

    Where the calculate action runs multiple expressions, enter a number to indicate the order in which this expression will be run.

    Remember that an expression that generates a value must run before any expression that uses the value.

    Expression

    Enter an expression. To work in a larger popup window, click 

    Insert excerpt
    _editor_expand
    _editor_expand
    nopaneltrue
    .

    See also:

    Order

    Input Connections

    The grid contains a list of the connection points that connect into this calculate node.

    • To add a new input connection point, in the section toolbar click 
      Insert excerpt
      _
    audit
    • add
      _
    audit
    • add
      nopaneltrue
    Save
    •   and
    close
    • set the
    calculate attribute properties to return to the calculate properties.

    Live Search
    spaceKey@self
    additionalnone
    placeholderSearch all help pages
    typepage

    Panel
    borderColor#00374F
    titleColorwhite
    titleBGColor#00374F
    borderStylesolid
    titleSections on this page

    Table of Contents
    maxLevel3
    indent12px
    stylenone

    Learn More

    For links to all pages in this topic, see Understanding Actionflows. 

    Insert excerpt_terms_changing_terms_changingnopaneltrue
    • properties.
    • To edit an existing connection point, double-click it in the list to open its properties.
    • To remove a connection points, select one and in the section toolbar click 
      Insert excerpt
      _delete
      _delete
      nopaneltrue
      .

    For details about the Name, Type and Data Attributes properties of the input connection point, see Input Connection Points.

    Advanced

    FieldDescription

    Prioritise Throughput Over Ordering

    Insert excerpt
    Actionflow Properties
    Actionflow Properties
    namePrioritiseThroughputOverOrdering
    nopaneltrue


    Insert excerpt
    _audit
    _audit
    nopaneltrue