Versions Compared

Key

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

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue

TThis page provides details of the properties for the phase node. These are part of actionflows.

Overview

Actionflows process data one record at a time. However, sometimes you may want to process all records up to one point, before moving on to the next process. For example, you may first want to check all the data before starting to process the first record. One way to do this is to have separate actionflows, so that all the data is processed by one actionflow, saved to a table and then the table is used at the start of the next actionflow. The other way is to use a 

Insert excerpt
_action_phase
_action_phase
nopaneltrue
 node.

Phase nodes act as an internal break in the actionflow. For example, you can have one phase in which records are read into the actionflow and checked one at a time. Once all records have been validated, the actionflow can then move to the next phase, where records are updated. Phase nodes are particularly useful if there the actionflow requires the user to make a choice as part of the actionflow. 

Example

Configuring a Validation Phase

A user wants to check some company fields before saving them in an actionflow. The simplest way to do this is to add a new phase before the existing processing phase. The new phase will contain all the logic to check the fields, and only pass on validated fields to the next phase.

Use the following steps:

  • to add validation to the fields
  • to check that a company name has been provided
  • to check that the phone number only contains numbers.


  1. In the application screen, right-click on the Save button, then click Display Actionflow.
  2. PhixFlow opens the actionflow that is connected to the Save button. Above the canvas is the phase toolbar.
  3. In the phase toolbar, click
    Insert excerpt
    _add
    _add
    nopaneltrue
    .
  4. Select Add Phase Before and set the Name to Validation. PhixFlow adds a new Validation tab to the phase toolbar.
  5. Click the Validation phase tab. PhixFlow displays the actionflow canvas for this phase.
  6. In the Inputs panel, add the form as an input into the actionflow.
  7. Map the fields that need to be validated: CompanyName and Number
  8. Drag a 
    Insert excerpt
    _action_calculate
    _action_calculate
    nopaneltrue
    node onto the actionflow canvas and set its Name to Validate Fields.
  9. Connect the
    Insert excerpt
    _driving_interface_connection_point
    _driving_interface_connection_point
    nopaneltrue
     to the calculate node.
  10. Map CompanyName and Number into the calculate node.
  11. Create a calculate attribute with the following properties:
    • Name: ValidRecord
    • Type: TrueFalse
    • Expression:

      Code Block
      do(
      	//set error message variable to use in the validation
      
      	$errorMessage = [],
      
      	//check the company name is populated
      
      	if(in.CompanyName == _NULL, 
      
      		$errorMessage = addElement($errorMessage, "Please provide a name")
      	),
      
      	if(contains(in.Number, [abc]),
      
      		$errorMessage = addElement($errorMessage, "Phone number should not contain any letter")
      	),
      
      	if(countElements($errorMessage) > 0,
      
      		do(
      			error(listToString($errorMessage, ", ")),
      
      			false
      		),
      
      		true
      	)
      )	
      
      


    • To save the calculate attribute, click 

      Insert excerpt
      _save
      _save
      nopaneltrue
      .

  12. Drag a 
    Insert excerpt
    _action_phase
    _action_phase
    namestart
    nopaneltrue
     node onto the actionflow canvas and select Processing Phase.
  13. Hover your mouse pointer over the calculate node and select the out connection point.
  14. PhixFlow creates a wire. Click onto the canvas to show the node options and select the 
    Insert excerpt
    _action_gateway
    _action_gateway
    nopaneltrue
    node.
  15. Set the Name to  Valid Records Only. PhixFlow adds the gateway node.
  16. Right-click on the connection point between the calculate and the gateway nodes and click 
    Insert excerpt
    _node_map
    _node_map
    nopaneltrue
  17. Map ValidRecord into the gateway node and click Confirm Mappings.
  18. Hover your mouse pointer over the gateway node and click Add Output. Set the Name to Valid.
  19. Click on the 
    Insert excerpt
    _action_phase
    _action_phase
    namestart
    nopaneltrue
     node to wire the gateway output into the start phase node
  20. Right-click on the wire and select Show Properties.
  21. In the wire properties → Basic Settings → Expression, add:

    Code Block
    in.ValidRecord

    This ensures only valid records pass to the next phase.


The completed validation phase of the actionflow looks like this:

Configuring a Confirmation Phase

A confirmation phase is useful if the user must:

  • confirm an action before it runs
  • choose an option to determine which phase runs.
    In this case, configure a phase with an 
    Insert excerpt
    _action_screen
    _action_screen
    nopaneltrue
     node that contains a start phase button. Link the button directly to the outputs on an open screen node.

A confirmation phase usually opens a pop-up window. The following steps assume this screen has already been designed.

To add a confirmation phase:

  1. In the phase toolbar, click
    Insert excerpt
    _add
    _add
    nopaneltrue
    .
  2. Select Add Phase Before and set the Name to Confirmation.
  3. In the Inputs panel, configure the input into the actionflow: 
    • If you want to map data into the confirmation phase, add the form as the input.
    • If you do not need any data,  add the event as the input.
  4. Click 
    Insert excerpt
    _screen
    _screen
    nopaneltrue
    to open the list of available screens. Drag the confirmation screen you require onto the actionflow.
  5. Connect the confirmation screen to the interface input connection point.
  6. Drag an  
    Insert excerpt
    _action_phase
    _action_phase
    nopaneltrue
     node onto the canvas and select the right phase.
  7. Hover your mouse pointer over the screen node and select the correct output.
  8. Connect the screen output to the Start Phase node.

Sarah todo: add video once working in product. At the moment, adding a phase is just adding a node called Processing Phase. It's not prompting for a phase type or for a name.

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

Select the type of phase: todo

  • Processing to do xx
  • ?? to do yyy
Order

Specify the order of the phase.

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

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