pub.monitor.process.model:setProcessFilter

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

Assigns a filter field and its value to a process model. You can then use the filter field and value in a filter that limits the items returned when you execute services to retrieve a list of process models, list of process model names and IDs, or a list of process instances.

You can specify filters with the following services:

pub.monitor.process.model:getModelListWithFilter to limit the list of process models that are returned to those that match the filter you specify.

pub.monitor.process.model:getModelNamesWithFilter to limit the list of process model names and IDs that are returned to those that match the filter you specify.

pub.monitor.process.instance:getInstanceListWithFilter to limit the list of process instances that are returned to those that match filters you specify.

Input Parameters

The following table lists the input parameters.

processKey	String The internal identifier (that is, process key) of the process model to which you want to assign the filter field and value.
fieldName	String The name of the filter field you want to assign to the process model. For example, you might specify countryCode so that you can associate a country code with a process model.
stringValue	String The value to set for the filter field. For example, if you specify countryCode for fieldName, you might specify es for stringValue.

Output Parameters

The following table lists the output parameters.

result

String The outcome of the service. If the service completes successfully, the value of result will be success. Otherwise, result will contain the failure message.

Usage Notes

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.