pub.monitor.process.model:getModelNamesWithFilter

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:getModelNamesWithFilter

Retrieves names and IDs of process models that match a specified filter and for which information is stored in the logging database.

Use the pub.monitor.process.model:setProcessFilter service to set the filters that you want to reference in this getModelNamesWithFilter service.

Note: Whether the search is case-sensitive or case-insensitive 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 to limit the list of returned values. Use the following format:

field1=value1, value2, ... , valueN

For example, if you have set a filter field countryCode and want to return only the names and IDs of process models for which countryCode is es, use the filter, countryCode=es

To return the names and IDs of 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 names and IDs of process models for which the countryCode is es or fr and the department is AP, use the following filter, countryCode=es, fr and department=AP

Output Parameters

The following table lists the output parameters.

modelNames	Document List List of the retrieved model names and IDs. The following fields are returned for each process model. PROCESSKEYDECODE String The name of the process model. PROCESSLABEL String The name of the process model. PROCESSKEY String The model ID for the process. PROCESSPATH String The directory path to the folder where the process file in is stored.
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.