From Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS

<keywords content="keywords"> iterate, iterate over, iterateover, iterateoverfact, iterateoverXpath, relations, count records, modify records, relationship, relationships </keywords> 

1. Declare a variable to be used to go through each record (in this case Products). Also declare ValueApproved and ValueRequested to set some information in them and make calculations.

2. Add Iterate over an XPath as shown below.

3. Right click on the Iteration box. Select the variable declared and the XPath. In this case all the products of the request.

4. Create the expression to return a message error

Iterate Over XPath using an expression

In some cases you could need to handle Collections in expressions without using the Iterate over Xpath functionality to allow a complete manipulation of the code. It can be done by using the advanced function GetValueAsCollection of the CHelper class.

When you obtain an object from an Collection through the getXPath function, you will obtain a list of values stored as a text chain. You will no be able to go through those values and manipulate them until you obtain an array list. In order to do it you need to use the GetValueAsCollection function in the following manner:

//Obtain XPath
var List=<Process.Collection>
//Obtain array List by using CHelper
Array=CHelper.GetValueAsCollection(List)
//Iterate
for (var I=0; I < Array.size(); I++) 
{
//Manipulate information (Get, Set)
var TempVariable= Array.get(I); 			
var DesiredValue=TempVariable.getXPath("Object") 
}

The expression shown above obtains the values of a collection in a single variable, then that variable is converted to an array list by using the GetValueAsCollection function. Once it has been done you can go through the values of the collection by iterating with a FOR function.

Let´s take the Purchase Process as example. Suppose you have a collection called PRODUCT when you store the information of the products to be purchased, you wish to obtain the total price of the purchase without using the Iterate Over Xpath functionality. The information you have is as follow:

The expression you need is:

//Obtain XPath
var List=<Purchase.Product>
//Obtain array List by using CHelper
var Array=CHelper.GetValueAsCollection(List)
//Iterate
for (var I=0; I < Array.size(); I++) 
{
//Manipulate information (Get, Set)
var TempVariable= Array.get(I); 			
var Price=TempVariable.getXPath("Price") 
var Total=Total+Price
}
<Purchase.TotalPrice>=Total

And you will obtain:

Iterate over Fact

This module can be used to carry out iterations or cycles over a one-to-many relationship EXCLUSIVELY when the relationship cannot be accessed directly through the data model using XPath.

This module allows you to access each of the entries in the one-to-many relationship (also known as a fact) to evaluate them, to carry out operations such as modifying the entries, deleting entries from the relationship, searching for information, counting entries, etc.

The most common example of this is accessing a collection, or one-to-many relationship between Parameter entities. For example, the parameter entity Supplier has a collection of Products that it supplies. Then, if the user wants to iterate the Products of the Supplier, both being Parameter entities with no relation to the case's information, the user has to user Iterate Over Fact.

Edit Description: allows the user to change the name given to the diagram.

Properties: allows the user to establish the cycle.

Remove: This option allows the user to eliminate the entire module.

Add an Iterate Over Fact

1. Create an object variable to use for the iteration, in the green button. Right click over it and include a variable.

2. Right click on the vertical line of the rule and select the Add Iterate Over Fact option; the Iteration Over Fact-Description window will pop up for you to name the module

3. Right click on the Iteration module and select the Properties option to establish its characteristics. The Iteration Over Fact window will then pop up.

4.The Iterate Over Fact window includes the following parameters: