This 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  Phase 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  Add New.
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  Calculate node onto the actionflow canvas and set its Name to Validate Fields.
9. Connect the  Driving interface connection point 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:

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

12. Drag a  Start Phase 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  Gateway 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 
    Error rendering macro 'excerpt-include' : No link could be created for '_node_map'.
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  Start Phase 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:

    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  Open Screen 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  Add New.
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  Screen 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   Phase 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.

 Properties Tab

Property Pane Toolbar

For information about the toolbar options, see the Common Properties page, Toolbars and Controls section.

Parent Details

If this item is within or belongs to another, it's parent name is shown here. See the Common Properties page, Parent Details section for more details.

Basic Settings

Description

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

 Audit Tab

Audit Summary

See the Common Properties page, Audit Summary section.