Invoke Function dialog box—Option descriptions

Use the Invoke Function dialog box to assign values to the parameters named in a function that you are invoking in a rule or global condition definition.

Option Description
Function Name and description of the function being invoked.
Return Type Data type of the value returned by the function.
Reference tabs—Available components

List of the components that are available for use in the rule being defined.

By default, these tabs appear on the right side of the dialog box. When you select a tab, the Reference section appears, with tabs along the bottom edge.

Data tab The available study objects appear in a tree structure similar to the Project Explorer.
Functions tab The available functions appear in a tree structure organized by class.

Note:

Functions are defined in the Study Editor or Library Editor.
Constants tab The available constants appear in a tree structure organized by class.

Note:

Constants are defined in the Study Editor or Library Editor.
Data Mappings tab The components of the available mappings appear in a tree structure similar to the Project Explorer.
Show All checkbox When selected, all available study objects as well as their properties appear. When not selected, only the available study objects appear.
Parameter description section Lists the parameters that have been defined for the function, along with spaces in which to specify their values in the rule or global condition expression.
Parameter Name of the parameter.
Data Type Data type of the parameter.
Value Value the parameter takes in the rule or global condition expression:
  • An explicit number or string.
  • A study object, constant, or data series dragged from the Data, Constants, or Data Mappings tab of the References section.
  • A function that returns a value of the required data type (for example, the GetValue() function).