Monitor 10.5 | pub.monitor.process.model Folder | pub.monitor.process.model:getUnusedModels
 
pub.monitor.process.model:getUnusedModels
Retrieves process models that are available for execution, but for which no logging data exists in the Process Audit Log database component.
This includes process models for which no process instance has ever been executed and process models for which instances have run, but the logged data for the executed instances has been archived or deleted from the logging database.
Input Parameters
The following table lists the input parameters.
modelID
String Optional. Complete model ID of a process model. Use the modelID parameter to determine whether a specific model has no logged data for 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 process model. Use the modelNameInput parameter if you want to limit the retrieved process models to those that match the partial model name. To retrieve model names, invoke the pub.monitor.process.model:getModelNames service and use 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 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
sortBy
String Optional. How to sort the retrieved list of process models. This parameter works with the sortOrder parameter.
*PROCESSLABEL Default. Sorts by the name of the process model.
*ENABLED Sorts by whether the process models is enabled.
*DESCRIPTION Sorts by the description of the process model.
*CREATEDBY Sorts by the user that created the process model.
*DEPLOYMENTTIMESTAMP Sorts by the time the process model were updated in the Process Audit Log database. This time varies by the process model type:
*webMethods-executed, the last date and time the process model version was built and uploaded for execution.
*Externally executed, the last date and time the process model was uploaded for analysis.
*Integration, when 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 sortBy parameter.
*0 Default. Sort in ascending order.
*1 Sort in descending order.
Output Parameters
The following table lists the output parameters.
unusedModels
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:
*PROCESSKEYDECODE String The name of the process model.
*PROCESSLABEL String The name of the process model.
*PROCESSKEY String The model ID for the process model.
*PROCESSPATH String The directory path to the folder where the process file is stored.
*DESCRIPTION String Description of the process model.
*CREATEDBY String User who created the process model.
*DEPLOYMENTTIME Number Time the process model was last updated in the Process Audit Log database. 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 process models.
*1    Enabled
*-1  Disabled and generation failed.
*-2  Enabled and generation failed.
*TYPE String A number that represents the type of model. This will always be 1 for models created using Designer.
*DEPLOYMENTTIMESTAMP String Time the process model was last updated in the Process Audit Log database. The time is 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
unusedWorkflows
Document List List of workflow models that were created using webMethods Workflow. If you still have workflows in your logging database, they are returned in the following fields for each workflow model.
*PROCESSKEYDECODE String The name of the workflow.
*PROCESSLABEL String The name of the workflow.
*PROCESSKEY String The ID for the workflow.
*PROCESSPATH String This is null.
*DESCRIPTION String Description of the workflow.
*CREATEDBY String User who created the workflow.
*DEPLOYMENTTIME Number Deployment time, in epoch time; that is, the number of seconds since January 1, 1970.
*ENABLED String Always returns 0 for workflows.
*TYPE String A number that represents the type of model. This will always be 2 for the models created using Workflow.
*DEPLOYMENTTIMESTAMP String Deployment time 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
message
String Error that occurred during the execution of this service if this service encountered an error.
Usage Notes
If there are multiple unused versions of a process model, the service returns all versions.