Please enable JavaScript to view this site.

Process Designer

Navigation: PHP API > General 

Types of PHP functions

Scroll Prev Top Next More

There are different types of PHP functions for the different possible applications:

Functions of the type Rule condition function can be used as conditions in rules. Rule condition functions can, for example, use process data to perform certain validations. The result of this validation can then be used in the condition of a rule.  A rule condition function must always return the value true or false, which decides if a rule is going to be executed or not.

You can use functions of the type Rule execution function to execute certain actions in action rules. Rule execution functions can be used, for example, to write files or enter data into another database. A rule execution function does not require a return value.

Functions of the type Form function can be executed in user forms with the help of the JavaScript API function jr_execute_dialog_function. A dialog function can be used, for example, to use data the user entered into the form to make calculations server-side and return the result into the form. External databases can also be queried that way. A form function does not require a return value. Further information can be found in the chapter Work with dialog functions as well as in the JavaScript API manual.

Functions of the type Box action function can be used as actions in inboxes. The execution of a box action function assigned to a specific action in the inbox of a user is performed when the user selects the respective action in the inbox. A box action can be used, for example, to simplify the approval of multiple steps of a process, so that the user has no need to approve every instance individually. A box action function must always return the value true or false, which decides if the action of the inbox is going to be executed or not. Further information can be found in the chapter Work with box action functions.

Functions of the type Step initialization function can be used to initiate steps. A step initialization function assigned to a step will be executed if the step is opened to be processed. A step initialization function needs no return value.