By the end of this chapter you will understand what a Calculate action is and how to use them, and you will have created three Calculate Actionflows in your application.
What is a Calculate Action?
The Insert excerpt |
---|
| _action_calculate |
---|
| _action_calculate |
---|
nopanel | true |
---|
|
action manipulates and processes data. Calculate nodes have their own attributes, which can reference incoming data via expressions, using one or more of the 135+ Functions available in PhixFlow.
Creating Calculate Actions
- Click and drag the
Insert excerpt |
---|
| _action_calculate |
---|
| _action_calculate |
---|
nopanel | true |
---|
|
icon from the toolbar onto the canvas - Enter a name for the Calculate action, then select Create Action
- In the Calculate Action
Insert excerpt |
---|
| _property_settings |
---|
| _property_settings |
---|
nopanel | true |
---|
|
on the right, click the Insert excerpt |
---|
| _add_icon |
---|
| _add_icon |
---|
nopanel | true |
---|
|
icon in the Output Attributes section to add new attributes
HTML Comment |
---|
|
Insert excerpt |
---|
| Calculate Node Properties |
---|
| Calculate Node Properties |
---|
nopanel | true |
---|
|
|
Example Uses
Calculate Actions can be used for: I HAVE UPDATED THE EXAMPLES
- inserting static text strings, e.g. when inserting a new record set a value of "New" in a status field
- Calculating values using Functions, e.g. Calculating the amount of VAT on a customer invoice
- performing lookups against a view action node or lookup connection point, e.g. counting records in a grid or retrieving details of all students on a course
Worked Examples
Here's a worked example using the School Data (available from the Learning Centre). LINK DIRECTLY TO DOWNLOADS, CHECK OTHER LINKS.
Tip |
---|
If you are completing this chapter as part of the Actionflow course and using a training instance, this data has already been pre-loaded into the Actionflow Application. |
Use a Calculate Action to Add Static Text
Earlier in this course we created an Actionflow that opens a blank input form for adding new courses to the School Courses grid. In this example we will enhance that Actionflow by adding the static text "New Course" to the blank input form.
- Open the Course Management screen where the Actionflow will be initiated from
- Right-click on the button on the School Courses grid and choose
Insert excerpt |
---|
| _actionflow_display |
---|
| _actionflow_display |
---|
nopanel | true |
---|
|
- Click and drag the
Insert excerpt |
---|
| _action_calculate |
---|
| _action_calculate |
---|
nopanel | true |
---|
|
icon from the toolbar onto the canvas - Enter a name for the Calculate Action:
- Name:
Course Header
- Select Create Action
- The
Insert excerpt |
---|
| _property_tabs |
---|
| _property_tabs |
---|
nopanel | true |
---|
|
for the Calculate Action will open on the right- If the
Insert excerpt |
---|
| _property_tabs |
---|
| _property_tabs |
---|
nopanel | true |
---|
|
is not open, click the Calculate Action node on the canvas
- In the Output Attributes section, click the
Insert excerpt |
---|
| _add_icon |
---|
| _add_icon |
---|
nopanel | true |
---|
|
icon - Enter the following details for the new Output Attribute:
- Name:
NewCourse
- Type: choose
String
Expression:
Code Block |
---|
"Create New Course" |
- Then
Insert excerpt |
---|
| _finish |
---|
| _finish |
---|
nopanel | true |
---|
|
- Drag and drop the Course Header Calculate Action onto the connector between the input node and the Open Course Form Action
- Right-click on the connector between the Course Header Calculate Action and the Open Course Form Open Screen Action and choose
Insert excerpt |
---|
| _open_mappings |
---|
| _open_mappings |
---|
nopanel | true |
---|
|
- On the Mappings window, drag the NewCourse attribute onto the Heading attribute to create the mapping
- Press Save
- Close the Actionflow to return to the Course Management screen
- the screen and press the button to see the Actionflow in action
- We can see that the Actionflow is working because it displays the string, New Course, in place of the original heading on the input form
In this example, we will configure a button to run an Actionflow that uses the now function to insert today's date into a dynamic text field. This example uses no data for the input.
Description?
On the Course Management screen open the Insert excerpt |
---|
_layers | _layers | nopanel | true |
and expand the area, Screen HeaderExpand the area, Right, and you will see two components - a button and a dynamic text fieldClick on the button, Button Date, in the Insert excerpt |
---|
_layers | _layers | nopanel | true |
to highlight it on the screenRight-click on the button on the screen and choose Insert excerpt |
---|
_actionflow_add | _actionflow_add | nopanel | true |
Enter a name for the Actionflow,- Name:
Populate Date Field
- Select Confirm
Select Click to Connect and for the input, choose the Insert excerpt |
---|
_actionflow_on_click | _actionflow_on_click | nopanel | true |
Action Event, then select Connect InputClick and drag the Insert excerpt |
---|
_action_calculate | _action_calculate | nopanel | true |
icon from the toolbar onto the canvasEnter a name for the Calculate Action:- Name:
Get Date
- Select Create Action
The Insert excerpt |
---|
_property_tabs | _property_tabs | nopanel | true |
for the Calculate Action will open on the rightIn the Output Attributes section, click the Insert excerpt |
---|
_add_icon | _add_icon | nopanel | true |
iconEnter the following details for the new Output Attribute:Name: TodayDate
Type: choose String
Expression:
Then Insert excerpt |
---|
_finish | _finish | nopanel | true |
Click and drag the input onto the Get Date Calculate ActionSetup the Output and Write Back to the Screen
DESCRIPTION?
In the Connections panel on the left, click Insert excerpt |
---|
_addIcon | _addIcon | nopanel | true |
Add to create a new connection point- Enter the following details for the new connection point:
- Name:
out
- Type: choose
Output
- Select Create Connection Point
Select Click to Connect and for the output, choose the Insert excerpt |
---|
_form | _form | nopanel | true |
datasource- Select Connect Output
- Close the Mappings window that automatically opens
- Hover over the Calculate Action node and select out
A red arrow will appear - click on the Insert excerpt |
---|
_output | _output | name | icon |
---|
nopanel | true |
output node under Connections- On the Mappings window, drag the attribute, TodayDate, from the left (Calculate Action) to the right (output connection point) to create an attribute on the output
- Select Save
Under Connections, right-click on the connector, out, and choose Insert excerpt |
---|
_mappings_configure | _mappings_configure | nopanel | true |
---|
- Drag the TodayDate attribute from the left (output connection point) and drop it onto the DateField target parameter on the right (Course Management screen)
- Select Save
- Close the Actionflow to return to the Course Management screen
Insert excerpt |
---|
_lock | _lock | nopanel | true |
the screen and press the Button Date on the screen to see the Actionflow in action- We can see that the Actionflow is working because it displays today's date in the format DD/MM/YY in the DateField dynamic text field
In this example, we will modify the Save Actionflow we created in an earlier chapter to perform the function, toUpper, which will format the course name into upper case. This example uses data for the input.
- On the Course Management screen click the or button to open the Course Form
- Right-click on the button and select
Insert excerpt |
---|
| _actionflow_display |
---|
| _actionflow_display |
---|
nopanel | true |
---|
|
- Click and drag the
Insert excerpt |
---|
| _action_calculate |
---|
| _action_calculate |
---|
nopanel | true |
---|
|
icon from the toolbar onto the canvas - Enter a name for the Calculate Action:
- Name:
UppercaseName
- Select Create Action
- Right-click on the input connection point under Connections and choose
Insert excerpt |
---|
| _mappings_configure |
---|
| _mappings_configure |
---|
nopanel | true |
---|
|
- On the Mappings window, drag the attribute, Name, from the left (Course Form) into the Drag and Drop space on the right (input connection point)
- Select Save
- On the canvas, drag the UppercaseName Calculate Action node onto the in connector between the node and the
Insert excerpt |
---|
| _save_icon |
---|
| _save_icon |
---|
nopanel | true |
---|
|
SaveCourse node and drop it when the Insert excerpt |
---|
| _add_icon |
---|
| _add_icon |
---|
nopanel | true |
---|
|
icon appears - Right-click on the in connector between the node and the
Insert excerpt |
---|
| _actionflow_calculate |
---|
| _actionflow_calculate |
---|
nopanel | true |
---|
|
and select Insert excerpt |
---|
| _open_mappings |
---|
| _open_mappings |
---|
nopanel | true |
---|
|
- On the Mappings window, drag the Name attribute from the left to the right (calculate action)
Tip |
---|
We only need to map the Name attribute here because it is used within the Calculate Action. The CourseID attribute will pass through the Calculate Action and can be used later on in the Actionflow. |
- Select Save
Setup the Calculate Action
- Select the Calculate Action, UppercaseName, to open its
Insert excerpt |
---|
| _property_settings |
---|
| _property_settings |
---|
nopanel | true |
---|
|
- In the Output Attributes section, click
Insert excerpt |
---|
| _addIcon |
---|
| _addIcon |
---|
nopanel | true |
---|
|
to create a new attribute:- Name:
UpperName
- Type: choose String
Expression:
Code Block |
---|
toUpper(in.Name) |
- Right-click on the in connector between the
Insert excerpt |
---|
| _actionflow_calculate |
---|
| _actionflow_calculate |
---|
nopanel | true |
---|
|
node and the Insert excerpt |
---|
| _action_save |
---|
| _action_save |
---|
nopanel | true |
---|
|
and select Insert excerpt |
---|
| _open_mappings |
---|
| _open_mappings |
---|
nopanel | true |
---|
|
- On the Mappings window, drag the attribute, UpperName, from the Calculate Action (left) onto the Name attribute on the Save Action (right)
- Press Save
- Close the Actionflow to return to the Course Form
- Ensure the screen is ed, then add or edit the course details and press the button to see the Actionflow in action
- You can see that the Actionflow is working because the Name for the course you just added/edited is now in capital letters on the School Courses grid