numoverdueprocessesforprocessmodel() Function

Function

numoverdueprocessesforprocessmodel( processModelId, includeSubProcessData )

Returns the number of active and completed processes for the specified process model, which are past the deadline.

Parameters

Keyword Type Description

processModelId

Integer

The Id number of the process model.

includeSubProcessData

Boolean

Controls whether data from subprocesses are included in the count.

Returns

Integer

Usage considerations

For active processes, processes whose deadlines have passed are counted.

For completed processes, processes that were completed after their deadline are counted.

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

Deleted and archived process instances are not counted.

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.

Examples

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

numoverdueprocessesforprocessmodel(processModelId) returns 1

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.

Custom Record Field Expressions 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.

Open in Github Built: Fri, Sep 23, 2022 (01:18:20 PM)

On This Page

FEEDBACK