numprocessesforprocessmodelforstatus() Function

Counts and returns the number of process instances with the specified status for the process model.

Syntax

numprocessesforprocessmodelforstatus( processModelId, status, [includeSubProcessData] )

processModelId: (Integer) The Id number of the process model).

status: (Text) The status of the processes you want counted. The following status parameters are available:

  • active
  • cancelled
  • completed
  • paused
  • problem (problem processes are paused by exception.)

includeSubProcessData: (Boolean) Controls whether data from sub-processes are included in the count.

Returns

Integer

Notes

If you do not provide a value for the includeSubProcessData parameter, the default value is taken from the current context or set to false if no sub-processes available.

For example, if the function is used on a Web Content with Process Details Channel and the channel's context includes sub-processes, these sub-processes are included by default.

The current user must hold at least viewer rights for the specified process model, in order to execute this function.

The status supplied must be one of the accepted status values.

Deleted and archived process instances are not counted.

Examples

You can copy and paste these examples into the Expression Rule Designer to see how this works.

numprocessesforprocessmodelforstatus(processModelId,"completed") returns 38

FEEDBACK