Creating, modifying, and deleting a rule template

Properties tab

Name

Name of the rule template.

Classification

User-defined term used to organize rule templates.

Description

Description of the rule template.

Display Text

Text that appears in the Rule Summary section of the Rule wizard after the When Value Is information.

If this field is blank, the contents of the Expression workspace are used. If the expression contains parameters, the name of the parameter and the value of the parameter appear. For example, if the expression is value must be between {a} and {b}, and the value of a is 10 and the value of b is 100, the parameters appear as a:10 and b:100.

Definition tab

Return Type drop-down list

Return type of the rule template; one of the following: Integer, Float, String, Boolean, Date/Time, or Array (A list of values, all of the same type).

Expression

Expression of the rule. For more information, see About the rule expression language.

Parameters (Optional)

Parameter

Name of the parameter.

Data Type

Return type of the parameter; one of the following: Integer, Float, String, Boolean, Date/Time, or Array (A list of values, all of the same type).

Default Value

Specified value of the parameter.

References

Data tab

Lists study objects in the scope of the rule. Optionally, to view the rule model properties of all of the study objects, select Show all.

Functions tab

Lists functions registered in a study and the libraries that appear in the Libraries List in the Study Editor. Any rule in the study can reference a function.

Constants tab

Lists constants created in the study and the libraries that appear in the Libraries List in the Study Editor. Any rule in the study can reference a constant.

Data Mappings tab

Lists:

• RefNames of the data mappings, data sets, and data series in the study or library.
• Rule model properties for data series.

  A data series has the properties of the item that is mapped to it. If a data series contains an item that collects more than one value, the rule model properties for repeating study objects appear so you can access an array of all of the values of the item.

• Methods for data sets.

  A method appears if you select the corresponding standard data dimension of the data set. You can use data set methods to return a subset of the data in the data set.

• Study events, forms, sections, and items that are mapped to each data set.
• Study objects appear if you select the corresponding standard data dimension of the data set. The properties of the study objects are used as parameters of data set methods.