What are Loop Actions?

 Loop actions repeat an action or set of actions multiple times for a recordset or array.

Loop Types

In PhixFlow, there are three types of supported looping:

Polling

Repeats the same operation multiple times with the same parameters, until a desired result is obtained.

• Generates a single output record
  • Output results are only generated at the end of the iterations
• Example: polling a HTTP API until the results are available

Accumulation

Repeats the same operation multiple times, where each iteration accumulates the progress results and triggers the next iteration with the updated result.

• Generates a single output record
• Example: calling a database (DB) to get a parent record, and then repeating the call with the parent until the root has been reached

Paging

Repeats an operation multiple times with different parameters.

• Generates the next parameters with a set of output records for each iteration of the loop
• Example: reading from a paging API, where each iteration provides the link for the next iteration and a set of output records

Start Loop and End Loop

Loops consist of a  Start Loop Action  and an  End Loop Action, joined by a loop connector which returns the result of the End node back to the Start node. The Start and End Loop each have their own properties.

On the  End Loop Action, the Records to output can be set, either outputting All Records from the loop or just the Final Record. The icon on the end loop node shows which option is set.

Loop Mappings

Attributes passed into a loop are available as passthrough, as well as attributes mapped in from the End Loop. This allows the original passthrough values to be referenced and if the loop is manipulating the incoming attributes, for example, incrementing a number, this is also available.

The mapped attributes that are manipulated by the loop are shown with a loop icon on the Mappings window, and passthrough attributes are shown with the icon of where they have come from, for example, a  Calculate action.

Creating Loop Actions

1. Click and drag the  Loop icon from the toolbar onto the canvas
2. In the Create Loop Action window:
   1. Enter a Name
   2. Select Create Action
3. Map attributes from other actions to the  Start Loop Actionto be processed by the loop
4. On the  End Loop Action, set:
   1. Records to output: Choose whether to output all records from the loop or just the final record
   2. Until Expression: An expression that is checked on each cycle of the loop, and once the expression returns true, the loop will end
      1. Example: in.myValue == 10
   3. Max Loops: This is a safety net designed to stop infinite loops. After the number of loops set here, the loops will stop
      1.  Set a sensible number of max loops
      2. This default to 10000

Worked Example

Here's a worked example using the Company Data (available from the Learning Centre).

In this example, we are using:  

• A Company Bank Holiday API - Loops screen containing a grid backed by an empty Bank_Holiday_Results table, drop down fields for the user to select the Year From and Year To values and a Run button - this screen was created using the Tile no Buttons template

Loop Through Selected Years and Return Bank Holidays

In this example, a user selects a date range (years) to return UK bank holidays. We'll create an Actionflow that takes in these parameters and each cycle of the loop returns the bank holiday dates for that year. For the purposes of this example, our Actionflow will call an API that exists within PhixFlow but this API represents an external public API. This is an example of paging where you retrieve a set amount of data per request, this is particular useful for large datasets.

Obtain the API URL

We have provided an Actionflow that acts as a UK Bank Holiday API. This can be called by a Actionflow, in the same way that an external API can be called. The UK Bank Holiday API has been configured to receive a year parameter and use that parameter to pass out the bank holiday dates for the corresponding year.

See 3.11 Setting up an API Endpoint for more details on how this API has been setup or to set one up yourself.

1. Search for the Bank Holiday API in the API Endpoint section of the  Repository for your application
   1. 
2. Right-click the Bank Holiday API and select Edit
3. Copy the URL and save it locally to be used later

Actionflow Setup

Create an Actionflow using a  Loop Action to poll the API and retrieve the bank holidays for the years selected on the Company Bank Holidays API - Loops screen.

1. Open the Company Bank Holidays API - Loops screen
2. Add an Actionflow to the Run button
   1. Name: Get Bank Holidays
3. Choose the input of the CompanyBankHolidayAPI-Loops form
4. Map in the two input fields:
   1. YearFrom
   2. YearTo
5. On the Mappings window, change the names of these two attributes on the input to allow them to be easily distinguished from two attributes with similar names we will create in the next section
   1. Change their names to: 
      1. YearFromIn
      2. YearToIn
      3. 

Type Conversion

The data coming into the Actionflow from the screen is in the Type: String. Our Actionflow needs this data in Integer format. This can be changed on the field on the screen but can also be modified in the Actionflow, which we will do here.

1. Create a  Calculate action
   1. Name: ConvertToInteger
2. Map both attributes from the input to the Calculate action

3. Use the function toNumber to create two Output Attributes on the Calculate action that convert the strings to integers

    How?

   

Loop Action

1. Create a  Loop action
   1. Name: Loop Years
2. Connect the  Calculate action to the  Start Loop Action
3. Map across the YearFrom attribute

HTTP Action

1. Create a  HTTP to call the Bank Holiday API
   1. Name: Call BH API
2. Connect the Start Loop action to the HTTP action
3. Map across the YearFrom attribute from the  Start Loop Action to the HTTP action
   1. Rename this attribute on the HTTP action to CallingYear
   2. 
4. In the HTTP Action properties, enter the following:
   1. HTTP Method: POST
   2. URL: Paste in the URL you copied earlier 

   3. Body: 

      [{
          "CallingYear": "${in.CallingYear}"
      }]

   4. Toggle on Log Traffic to log the response from the API in the  System Console

       Checkpoint

      

JSON Action

Create a JSON action to read the data coming in from the API.

1. Create a  JSON to process the returned bank holiday data from the API
   1. Name: Returned Bank Holidays
2. Connect the HTTP action to the JSON action using the out connector
3. Map across the body from the HTTP action

4. Setup the JSON action to receive the data from the API

   1. Input Expression: in.body
   2. Path: $..ouput
   3. Output Attributes:
      1. Name: Name, Type: String

         _result.Name

      2. Name: UID, Type: String

         _result.UID

      3. Name: Country, Type: String

         _result.Country

      4. Name: Date, Type: Date

         _result.Date

Save Action

Create a save action to save the bank holiday data to the Bank_Holiday_Results table where it can be viewed on the screen.

1. Create a  Save action to save the data
   1. Name: SaveBHs
   2. Type: Auto Insert/Update
   3. Table: choose the Bank_Holiday_Results table
      1. This table has been prepopulated with the attributes required to hold the data
   4. Click Create Action
2. Connect the JSON action to the Save action and map across the attributes being returned by the JSON action 
   1. 

Increment Year By One

After the bank holiday data has been saved, we need the loop to go round again, this time getting the next year in the sequence, for example, if the user has entered 2018 for the YearFrom and 2020 for the YearTo, when the data is first saved, it is just the 2018 data. For the second loop, the 2019 data will be obtained, and so on. The criteria to end the loop is covered in the next section.

1. Create a  Calculate action
   1. Name: Increment +1
2. Connect it to the Save action and map across the YearFrom attribute
   1. Ensure this is the attribute from the   Start Loop Action
   2.  
3. On the Calculate action, add an Output Attribute:
   1. Name: LoopYear
   2. Type: Integer
   3. Expression: in.YearFrom + 1

End Loop Setup

As the loop completes each iteration, criteria can be set on the End Loop to specify when the loop stops. This is specified using the Until Expression or Max Loops (whichever comes first). Our loop obtains one year's bank holidays for each loop, so if 2018 is entered for YearFrom and 2020 for YearTo, three loops are completed.

We want the looping to stop once the YearTo has passed, for this reason we must specify that the loop ends when the year after the YearTo has been reached.

1. Connect the Increment +1  Calculate action to the  End Loop Action
2. Map across the LoopYear attribute from the Increment +1  Calculate action and the YearTo attribute from the ConvertToInteger  Calculate action
   1. 
3. Setup the  End Loop Action as follows:
   1. Records to output: All records
      1. This will output all the bank holidays, not just those satisfying the final year in the date range
   2. Until Expression: in.LoopYear == in.YearTo+1
   3. Max Loops: 10
      1. A loop will be completed per year in the date range
4. 
5. On the Loop connector between the  End Loop Action and  Start Loop Action map the LoopYear attribute from the Calculate action to the YearFrom  attribute 
   1. 

Testing

1. Close all screens and reopen the Company Bank Holidays API - Loops screen
2. Select the Year From and Year To criteria and press Run