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 

For the full list of Calculate Action

Creating Calculate Actions

We want to be able to filter the records that can be seen in our School Courses grid. To do this, we will create three Calculate Actionflows. Each Actionflow will populate a string field with a string of text. That text will then be interpreted by a background filter to see if it matches any records for the specified attributes, and will filter the grid accordingly.

Calculate Actions to Initiate Filters

1. Open the Course Management screen where the Actionflow will be initiated from
2. The Filters panel on the left of the screen contains a number of buttons which we will set up so when they are pressed, the School Courses grid is filtered:
   1. All: This will reset the grid to show all records
   2. Maths: This will show only records where the department name is Mathematics
   3. English: This will show only records where the department name is English

Reset Filter

Image Removed

1. Click and drag the 

   Insert excerpt
   _action_calculate _action_calculate nopanel true

    icon from the toolbar onto the canvas
2. Enter a name for the Calculate action, then select Create Action
3. 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
hidden true
Insert excerpt Calculate Action Properties Calculate Action Properties nopanel true

Tip
Calculate actions and their connection points, can have an attribute type of Structured Data. Use this if you need the Actionflow to pass a list (an array of values).

Example Uses

Calculate Actions can be used for: 

• Inserting static text strings, e.g. when inserting a new record set a value of "New" in a status field
• Modifying dynamic text components
• 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). 

In this example, we are using:

• A Course Management screen containing a grid of the School Courses data - this screen was created using the Tile with Buttons template
• A Course Form screen containing form fields and associated with School Courses data by a background filter - this screen was created using the Edit Form template

Example 1: Use a Calculate Action to Add Static Text

We want to add a message, "Create New Course", to the Course Form header that shows only when a new course is being created. To do this, we will add a Calculate Action to the Open Screen Actionflow for adding a new course.

Image Added

1. On the screen where the Actionflow will be initiated from, Course Management, right-click on the Image Added button on the School Courses grid and choose 

   Insert excerpt
   _actionflow_adddisplay _actionflow_adddisplay nopanel true

2. Enter a name for the Actionflow:
   1. Name: All Filter
3. Connect the filter button by selecting Click to Connect
   1. For the input, choose the On Click Action Event, then select Connect InputIf there is no Actionflow to display, see Open Screen Action Configuration
4. Click and drag the 

   Insert excerpt
   _action_calculate _action_calculate nopanel true

    icon from the toolbar onto the canvas
5. Enter a name for the Calculate actionAction:
   1. Name: Reset Filter Course Header
   2. Select Create Action
   Click and drag the 
   1. Action 
6. The 

   Insert excerpt
   _drivingproperty_interfacetabs _connection_point _driving_interface_connection_point name iconproperty_tabs nopanel true

    for the Calculate Action will open on the right
   1. If the 

      Insert excerpt
      _property_tabs _property_tabs nopanel true

    icon onto the Reset Filter node to connect the input to the actionClick on the Reset Filter node to open its Properties on the right
   1. is not open, click the Calculate Action node on the canvas 
7. In the Output Attributes section, click the 

   Insert excerpt
   _add_icon _add_icon nopanel true

    icon
8. Enter the following details for the new Output Attribute:
   1. Name: pfDept NewCourse
   2. Type: choose String

   3. Expression: 

      Code Block
      theme Emacs
      "AllCreate New Course"

      
      

   4. Then 

      Insert excerpt
      _finish _finish nopanel true

   Under Connections, click  Insert excerpt_addIcon_addIconnopaneltrue Add
9. In the Add Connection Point window, enter:
   1. Name: Out
   2. Type: choose Output
   3. Select Create Connection Point
10. Click on Click to Connect
11. In the Connect Output window, choose the Course Management form and select Connect Output
12. Close the Mappings window that opens
13. Hover over the Reset Filter calculate node on the canvas and select out
14. A red arrow will attach to your mouse, click on the Drag and drop the Course Header Calculate Action onto the connector between the input node and the Open Course Form Action
    1. Image Added
15. Right-click on the connector between the Course Header Calculate Action and the Open Course Form Open Screen Action and choose

    Insert excerpt
    name _open_outputmappings _open_output mappings icon nopanel true

     icon under Connections
16. The On the Mappings window will open:
    1. Drag across the Output Attribute, pfDept,  into the area on the right to create a corresponding attribute on the output connection point
    2. Press Save
17. Right-click the Out wire, under Connections, and choose Configure Mappings
18. The Mappings window will open:
    1. Select Map by Name
    2. Press Save
19. , drag the NewCourse attribute onto the Header1Dynamic attribute to create the mapping
    1. Press Save
    2. Image Added
20. Close the Actionflow to return to the Course Management screen
21. Lock the

    Insert excerpt
    _lock _lock nopanel true

     the screen and press the Image Removed button Image Added button to see the Actionflow in action
    1. We can see that the Actionflow is working because it displays the string, All, in the pfDept String field and all records display in the grid

Maths Filter

Have a go at creating the Actionflow for the Image Removed button, with some guidance below.

1. 1. Create New Course, in place of the original heading on the Course Form 

Example 2: Use a Calculate Action to Perform a Function 

In this example, we will add a Calculate Action that performs the function, toUpper, to a Save Actionflow. This function will format the course name on the Course Management screen into upper case, when the course is added/edited. 

Image Added

Setup the Input 

1. On the Course Management screen, click the Image Added or Image Added button to open the Course Form
2. Right-click on the Image RemovedImage Added button and choose select 

   Insert excerpt
   _actionflow_adddisplay _actionflow_add_display nopanel true

3. Click and drag the 

   Insert excerpt
   _action_calculate _action_calculate nopanel true

    icon from the toolbar onto the canvas
4. Enter a name for the ActionflowCalculate Action:
   1. Name: Maths Filter
   Repeat the same steps as with the All Filter, but make the following changes:
   1. Name the Calculate Action: Maths Filter

   2. When creating a new Output Attribute, the following expression should be used:

      Code Block
      "Mathematics"

      Tip

      title	Why do we use "Mathematics" and not "Maths"?

      We use "Mathematics" because this is the spelling of the Department Name in our data (you can see this on the School Courses grid), therefore the Background Filter is looking to match up the text in the string field with the data name. Where it gets a match, it will filter the grid accordingly. If we use a different spelling or shortening, the filter will not work as expected.  UppercaseName
   3. Select Create Action
5. Right-click on the input connection point under Connections and choose 

   Insert excerpt
   _mappings_configure _mappings_configure nopanel true

6. 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) 
   1. Select Save
7. On the canvas, drag the UppercaseName Calculate Action node onto the in connector between the 

   Insert excerpt
   _input _input nopanel true

    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
8. Right-click on the in connector between the 

   Insert excerpt
   _input _input nopanel true

    node and the 

   Insert excerpt
   _actionflow_calculate _actionflow_calculate nopanel true

    and select 

   Insert excerpt
   _open_mappings _open_mappings nopanel true

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

   
   

   1. Select Save

Checkpoint

Image Added

Setup the Calculate Action 

1. Select the Calculate Action, UppercaseName, to open its 

   Insert excerpt
   _property_settings _property_settings nopanel true

2. In the Output Attributes section, click the 

   Insert excerpt
   _addIcon _addIcon nopanel true

    to create a new attribute:
   1. Name: UpperName
   2. Type: choose String

   3. Expression:

      Code Block
      theme Emacs
      toUpper(in.Name)

      
      

   4. 
      

      Click 

      Insert excerpt
      _finish _finish nopanel true

3. Right-click on the in connector between the 

   Insert excerpt
   _actionflow_calculate _actionflow_calculate nopanel true

    action node and the 

   Insert excerpt
   _action_save _action_save nopanel true

    action node, and select 

   Insert excerpt
   _open_mappings _open_mappings nopanel true

4. On the Mappings window, drag the attribute, UpperName, from the Calculate Action (left) onto the Name attribute on the Save Action (right)

   1. Press Save
      
      Checkpoint
      
      Image Added

      
      

      
      

5. Close the Actionflow to return to the Course Management screenLock the screen and press the Image Removed button Form
6. Ensure the screen is 

   Insert excerpt
   _lock _lock nopanel true

   ed, then add or edit the course details and press the Image Added button to see the Actionflow in action
   1. We You can see that the Actionflow is working because it displays the string, Mathematics, in the pfDept String field and just the matching records display in the grid

English Filter

Use the knowledge you have acquired throughout this chapter to independently create the Actionflow for the English filter.

1. 1. the Name for the course you just added/edited is now in capital letters on the Course Management screen

Image Modified