numprocessesforprocessmodelforstatus() Function

Function

numprocessesforprocessmodelforstatus( processModelId, status, includeSubProcessData )

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

Parameters

Keyword	Type	Description
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 subprocesses are included in the count.

Returns

Integer

Usage considerations

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 subprocesses available.

For example, if the function is used on a Web Content with Process Details Channel and the channel's context includes subprocesses, these subprocesses 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

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Partially compatible	Can be used with offline mobile if it is loaded at the top of the form.
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible
Process Reports	Incompatible	You cannot use this function to configure a process report.
Process Events	Incompatible	You cannot use this function to configure a process event node, such as a start event or timer event.

Feedback