Special function

The Special function component allows you to configure a range of mathematical functions and special model logic or to output specific information.

The following functions are available:

Function	Description
Counter	Counts the number of objects found
Arithmetic Average	Forms an average of a number attribute (integer, float) of all found objects. The number attribute is stored in the Attributes property.
Minimum	Outputs objects that have the smallest value in a number attribute (integer, float). The number attribute is stored in the Attributes property.
Maximum	Outputs objects that have the highest value in a number attribute (integer, float). The number attribute is stored in the Attributes property.
Sum	Forms the sum of a number attribute (integer, float) of all found objects. The number attribute is stored in the Attributes property.
Multiply	Forms the product (multiplication) of a number attribute (integer, float) of all found objects. The number attribute is stored in the Attributes property.
Successor	Evaluates the successor of the selected object.
Successor Activities	Evaluates the successor activities of the selected object.
Successor activity path text	Evaluates the successor activities of the selected object. The path texts of the successor activity are also output.
Predecessor	Evaluates the predecessor of the selected object.
Predecessor Activities	Evaluates the predecessor actions of the selected object.
Copies	Evaluates the copies of the selected object.
Copy of	Evaluates from which object the selected object is a copy.
Source object(s)	Evaluates the source objects of the selected object.
Chart number	Evaluates the shape number of a process from a BPMN diagram, the predecessor BPMN diagram or the successor BPMN diagram.
Row number	Evaluates the row number of a table.
Current user notifications	Evaluates for the currently logged in user for which objects he/she receives notifications.
Current user	Evaluates the currently logged in user(s).
Session object	Evaluates an object of the current session (e.g. the session scope).
Portraits Diagram(s)	Evaluates diagrams modeled in portrait format.
Landscape Diagram(s)	Evaluates diagrams modeled in landscape format.
Added to	Evaluates when an object was added to another object via a specific model object list attribute.
Random object selection	Randomly selects a given number of objects from a set. The number is stored in the Number property.
Relevance	Evaluates the relevance of an object (e.g. a search hit).
Search result text (index)

Configuration:

Property	Description
Queries	Configure here queries that return objects that serve as source for the function. The Queries property displays the query components that have been configured for the query. The result of the queries is used as input for the execution of this query. If no queries are created, the result is obtained directly from the current context. You also have the option here to configure new queries via the text box or the buttons to the right of the text box.
Attributes	Reference here the attributes of the found objects that will be evaluated.
Function	Select here the function that the component should execute.
Number	Enter the number that will be used for the Random object selection function.
Remove duplicates	With this property, objects found twice are returned only once.
Variables	You can activate the enabled attributes of a query and condition in the Variables property so that they can be changed by users at the time of execution. See also: Chapter Variables.

Example: For a special function:

The average hourly wage rate for all tasks is to be determined. For this, arithmetic average is selected as the function. In the Queries field, a category query is created that searches all tasks. In the Attributes field, the (user-defined) attribute Hourly wage rate of the Task category is selected.