Property Functions for Rules

The Property category of rule function terms available within the rule definition provide functions that are specific to working with properties, and in most cases are intended for use with properties of a given type. While they may take any property as a parameter, the resulting behavior of the function may not be desired if the selected property is not of the type for which the function is intended.

Many of the functions within this category are intended for use with collection properties. Most of these are named to reflect this, beginning with the word COLLECTION, e.g. @COLLECTION_FIND. Exceptions to this are COUNT and SIZE, which both return the total number of objects in a collection property, optionally counting only those that meet some criteria.

Another sub-set of the functions within this category are intended for use with properties of type external data. External data properties are defined to reference files stored on the client device from within the mobile application. The functions within this category that are intended for this property type each begin with the value FILE in their names, e.g. @FILE_PATH.

Other functions within this category include those that work with the user interface, returning values or names from the screens and fields of the currently displayed screen or screen set on the client. Each of these functions begins with the value SCREEN or SCREENSET in their names, e.g. @SCREENFIELDVALUE.