Home > Class Reference > %SYS namespace > WQM.API


abstract class WQM.API extends WQM.API.core

Public APIs for Work Queue Manager

Method Inventory


classmethod GetWorkersForCategory(category) as %Integer [ Language = objectscript ]
Return workers specified for a category.
If none specified then empty string is returned.
Requires management privilege.
classmethod IsUserCategory(category) as %Boolean [ Language = objectscript ]
Returns flag indicating if the category name is a User defined category.
It does not indicate if the category is defined.
classmethod IsValidCategoryName(category, Output status As %Status = $$$OK) as %Boolean [ Language = objectscript ]
Checks if the category name is a valid category name.
For all categories checks if 50 characters or less.
Returns 1 or 0 and if not valid returns an error status in the second parameter.
For User categories checks that: User category names can only contain upper case, lower case, numbers and periods and cannot end with a period.
User category names need to begin with specific characters - see documentation.
classmethod MaxActiveWorkersClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod MaxActiveWorkersExecute(ByRef qHandle As %Binary, SpecificCategory As %String, IncludeSystem As %Boolean, IncludeUser As %Boolean) as %Status [ Language = objectscript ]
classmethod MaxActiveWorkersFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod MaxWorkersAvailable() as %Integer [ Language = objectscript ]
Maximum Number of Queue Manager Workers for the system
classmethod ModifyCategory(category, workers) as %Status [ Language = objectscript ]
Modifies the workers for a given category.
If the value of workers is 0 then the category will be reset.
Requires management privilege.


query MaxActiveWorkers(SpecificCategory As %String = "", IncludeSystem As %Boolean = 1, IncludeUser As %Boolean = 1)
Selects Category As %String, IsSystem As %Boolean, IsDynamic As %Boolean, Workers As %Integer
List the existing Categories and MaxActiveWorkers
Requires management privilege.