queryProcessInstanceCount

Syntax

com.tibco.wcc.base.Requests.queryProcessInstanceCount(requestId,
                                                      arrProcessTemplates,
                                                      txtFilter);

Parameters

• requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.
• arrayProcessTemplates - (Array[Object]) The process templates whose instances are to be counted.

  [
    {
       moduleName: moduleName,
       processName: processName,
       processVersion : processVersion
    }
  ]

  where:

• moduleName - (String) The path to the XPDL file that defines the “process package”.
• processName - (String) The name of the process template whose instances are to be counted.
• processVersion - (String) The version of the process template.
• txtFilter - (String) A filter expression to limit the number of process instances. Only the process instances that satisfy the expression are counted. For information about filter syntax, see the "Sorting and Filtering Process Lists" topic in the developer's guide for your BPM runtime environment.

  For a list of the attributes that can be used in the filter expression, use the listProcessInstanceAttributes request.

Returns

Returns an <ap:QueryProcessInstanceCount> element, which contains the process instance count.

For example:

<ap:Requests>
   <ap:QueryProcessInstanceCount Id="ApiSample.queryProcessInstanceCount">5</ap:QueryProcessInstanceCount>
</ap:Requests>