OBJECTLOOP

An object loop is a custom loop that allows the configuration to loop through any table in the OIPA database. There are three required configuration lines to an object loop.

  1. Configure a MathLoop that is TYPE="OBJECTLOOP" (returns a collection of objects) 

  2. Configure a MathVariable that is TYPE="OBJECT" (returns a single instance from the collection) 

  3. Configure a MathVariable that is TYPE="OBJECTFIELD" (returns a specific field value from the object) 

OBJECTLOOP: Elements and Attributes
TYPE=OBJECTLOOP
Element Attributes Parent Element Description Element/Attribute Value

<MathLoop>

TYPE

  

Configuration for statements that are repeatedly executed for each object in the collection.

OBJECTLOOP

 

OBJECTNAME

  

This is the table that is being used for the loop without the As, for example Client should be used for AsClient.

 

Name of the object where the data resides. This coincides with a database table. 

 

KEY

   Condition to evaluate. See operators for more details. Allows for the filtering of keys to be returned in the array. For example, if you are retrieving values from Client, you may filter via a condition stating TypeCode=’02’ for Individual client types only.

Column name that is the key for the database table referenced in OBJECTNAME.

 

CONDITION

   Condition to evaluate. See operators for more details. Allows for the filtering of keys to be returned in the array. For example, if you are retrieving values from Client, you may filter via a condition stating TypeCode=’02’ for Individual client types only.

A string value that must be compatible with the SQL predicate used to retrieve the object data.

CLEARVALUE

 

Optional Element

Value: Yes / No

Default Value: No

Yes: The value of the math variable will be deleted after the execution of all the Attached Rules at the end of activity processing and will not be visible on the Math tab in the Activity details screen.

No: The value of the math variable will be retained after activity processing and will be displayed in the Math tab in the Activity details screen.

XML Example

<MathLoop VARIABLENAME="ClientLoop" TYPE="OBJECTLOOP" OBJECTNAME="Client" CONDITION="TypeCode="02'" KEY="ClientGUID">
</MathLoop>