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/Attributes
TYPE=OBJECTLOOP
Element Attribute Attribute Value Element Value Definition

<MathLoop>

TYPE

OBJECTLOOP

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

 

 

OBJECTNAME

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

  

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

 

KEY

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

   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.

 

CONDITION

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

   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.

XML Example

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