Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      


Updated on August 10, 2022

Use the Call-Function method to call a Rule-Utility-Function that returns a value for a property or parameter. Unlike calling functions by using the Property-set method, functions that are called by using the Call-Function method can also return a value of void.

This Call-Function method uses an array of parameters. Each row of the array contains an expression (the source) and the property or parameter (the destination) in which the return value is stored.

The system evaluates each expression that is identified in the Function column of the parameter array and assigns the result to the property or property part that you identified in the corresponding Results column.


  • Function: Expression that computes the return value. You can:
    • Enter an expression in the Expression Builder.
    • Click the Down arrow icon and select a function alias. This list is populated with function aliases that return a void or Boolean value. Your list of referenced rules is updated when the underlying function has parameters mapped to rule types.
  • Return Value: Optional. Name of the property or parameter in which to store the return value.
    Note: Enter one or more target property references. If you precede the property with a period but no page name, the system expects this property to be on the step page. If the Step Page field for this step is blank, the system uses the primary page of the activity.

    For example:


    For Value List, Value Group, Page List, and Page Group properties, enter a literal, property reference, or symbolic index value (subscripts):


    Do use this method to update a property that is the target property of a Declare Expression rule. You cannot save the Activity form if such a conflict is detected.


If the step page does not exist, the system creates a page of the class that is identified in the Pages & Classes tab.

Any property messages previously associated with the property are cleared.

If the type of the expression does not match the type of the destination, the value is converted following the same scheme as within expressions.

Each property value is validated against the property rule.

Rows are processed in sequence, so an expression that is set in one row (as a destination) might be a result in a later row.

  • The standard function PropertyExists() can check whether a property is already on the clipboard.
  • You cannot use this method to update a property that is also the target property of a Declare Expression rule.
  • Do not attempt to return the value of a property that has a name starting with pz; changes to such properties are reserved.
  • Use the standard activity Work-.UpdateStatus — not this method — to return the value of a work item status (pyStatusWork property).

Checking the method status

This method updates the pxMethodStatus property.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us