Administering and Monitoring Business Processes 10.4 | Administering and Monitoring Business Processes | webMethods Monitor Built-in Services Reference | pub.monitor.process.model Folder | pub.monitor.process.model:getModelListWithFilter
 
pub.monitor.process.model:getModelListWithFilter
Retrieves a list of process models that match a specified filter and for which at least one process instance of the model has run.
Use the pub.monitor.process.model:setProcessFilter service to set the filters that you want to reference in this getModelListWithFilter service.
Note: Whether the search is case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
Input Parameters
The following table lists the input parameters.
criteriaField
String Optional. Filter that you want to use to limit the list of returned values. Use the following format to create the filter:
field1=value1, value2, ... , valueN
For example, if you have set a filter field named countryCode and want to return only those process models for which countryCode is es, use the following filter, countryCode=es
To return process models for which the countryCode is es or fr, use the filter: countryCode=es, fr
To use multiple filter fields, specify and between the fields/values. For example, to return process models for which the countryCode is es or fr and the department is AP, use the filter, countryCode=es, fr and department=AP
modelID
String Optional. Complete model ID of a process model. Use the modelID parameter if you want to determine whether a specific model has had any running process instances. To retrieve model IDs, invoke the pub.monitor.process.model:getModelNames service and use the value returned in the modelNames/PROCESSKEY output parameter. If you specify modelID, do not use the modelNameInput parameter.
Note: Whether Monitor treats modelID as case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
modelNameInput
String Optional. Partial model name of a model. Use the modelNameInput parameter if you want to limit the retrieved models to those that match the partial model name. You can retrieve model names by invoking the pub.monitor.process.model:getModelNames service and using the value returned in the modelNames/PROCESSKEYDECODE output parameter. When you specify modelNameInput, do not use the modelID parameter.
Note: Whether Monitor treats modelNameInput as case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
enabled
String Optional. For webMethods-executed process models only, whether you want to retrieve models that are enabled or disabled.
*0 Disabled.
*1 Enabled.
*2 Default. Either enabled or disabled.
sortColumn
String Optional. How to sort retrieved process models. This parameter works with the sortOrder parameter. Sort by any of the following columns:
*started Number of process instances model that are started.
*completed Number of process instances that are completed.
*suspended Number of process instances that are suspended.
*failed Number of process instances that have failed.
*canceled Number of process instances that have been canceled.
*resumed Number of process instances that have been resumed.
*resubmitted Number of process instances that have been resubmitted.
*modelName Default. The name of the process model.
*enabled Whether the process models are enabled.
*deployTime The time the process models were updated in the Process Audit Log database tables. The value varies by model type:
*webMethods-executed process model, the last date and time the process model version was built and uploaded for execution.
*Externally executed process model, the last date and time the process model was uploaded for analysis.
*Integration process, when the pub.monitor.integrationProcessLogging: createProcessMetadata service was used to log information about the process.
sortOrder
String Optional. Whether to sort in ascending or descending order. This parameter works with the sortColumn parameter.
*0 Default. Sort in ascending order.
*1 Sort in descending order.
Output Parameters
The following table lists the output parameters.
modelTable
Document List List of the retrieved webMethods-executed process models, externally executed process models, integration processes, and task models. For each model, the following fields are returned:
*MODELID String Unique model ID of the process model.
*MODELNAME String Name of the process model.
*STARTED String Number of process instances in Started status.
*COMPLETED String Number of process instances in Completed status.
*FAILED String Number of process instances in Failed status.
*SUSPENDED String Number of process instances in Suspended status.
*CANCELED String Number of process instances in Canceled status.
*RESUMED String Number of process instances in Resumed status.
*RESUBMITTED String Number of process instances in Resubmitted status.
*DEPLOYDATE String Time the process model was last updated in the Process Audit Log database tables. The time is specified in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where:
*YYYY-MM-DD is the date
*hh:mm:ss:SSS is the time, including milliseconds
*zzz is the time zone
*DEPLOYTIME Number Time the process model was last updated in the Process Audit Log tables. The time is in epoch time, which is the number of seconds since January 1, 1970.
ENABLED String For webMethods-executed process models, whether the process model is enabled or disabled.
*0   Disabled.
*1   Enabled.
*-1 Disabled and generation failed.
*-2 Enabled and generation failed.
wfTable
Document List List of workflow models that were created using webMethods Workflow. If you still have workflow models in your logging database, they are returned in the following fields for each workflow model:
*MODELID String Unique model ID of the workflow.
*STARTED String Number of processes in Started status.
*COMPLETED String Number of processes in Completed status.
*FAILED String Number of processes in Failed status.
*SUSPENDED String Number of processes in Suspended status.
*CANCELED String Number of processes in Canceled status.
*RESUMED String Number of processes in Resumed status.
*RESUBMITTED String Number of processes in Resubmitted status.
*DEPLOYDATE String Time the model was last updated in the Process Audit Log database tables, in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where:
*YYYY-MM-DD is the date
*hh:mm:ss:SSS is the time, including milliseconds
*zzz is the time zone
*DEPLOYTIME Number Time the model was last updated in the Process Audit Log database component. The time is in epoch time, which is the number of seconds since January 1, 1970.
message
String Error that occurred during the execution of this service if this service encountered an error.
Usage Notes
The following are services are related to the criteriaFilter input field:
*To assign a filter field that you can reference in criteriaFilter, use the pub.monitor.process.model:setProcessFilter service.
*To retrieve a list of filter fields that are already set, use the pub.monitor.process.model:getProcessFilter service.
*To clear a filter field, use the pub.monitor.process.model:clearProcessFilter service.
Copyright © 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release