Qorus Integration Engine®  4.0.3.p2_git
QorusSystemQueueService Class Reference

the main queue service class More...

Inheritance diagram for QorusSystemQueueService:
QorusSystemService

Static Private:Internal Member Methods

static deprecated nothing updateData (string name, softstring key, any data)
 DEPRECATED: updates a pending entry in a system queue with status OMQ::QS_Waiting, sets the status to OMQ::QS_Received (params: queue name, key, data) More...
 
static deprecated nothing correctData (softint wfiid, softint stepid, softint ind)
 DEPRECATED: corrects a queue entry with status OMQ::QS_Waiting, sets the status to OMQ::QS_Received and sets the corrected attribute to True (params: workflow_instanceid, stepid, ind) More...
 
static deprecated nothing cancelData (string name, softstring key)
 DEPRECATED: cancels a queue entry with status OMQ::QS_Waiting (params: queue name, key) More...
 
static deprecated nothing updateKey (string queuename, softstring oldkey, softstring newkey)
 DEPRECATED: changes the key for a pending entry in a system queue, only when the status is OMQ::QS_Waiting (args: queue name, old key, new key) More...
 
static deprecated auto getInfo (softint wfiid, softint stepid=0, *softint ind)
 DEPRECATED: gets queue information for a particular workflow and step (params: workflow_instanceid, optional: stepid, ind) More...
 
static deprecated *hash getInfoFromQueueKey (string queue, softstring key)
 DEPRECATED: gets queue information for a queue entry from the queue name and key (params: queue_name, key) More...
 
static deprecated *hash status (*softstring name)
 DEPRECATED: gives internal queue status (without parameters: for all queues) More...
 
static deprecated *list getQueueInfo (softint queueid, *string status)
 DEPRECATED: Returns a list of queue entries on a given queue from the queue ID and an optional status filter. More...
 
static deprecated *list getQueueInfoFromName (string name, *string status)
 DEPRECATED: Returns a list of queue entries on a given queue from the queue name and an optional status filter. More...
 

Additional Inherited Members

- Public Member Methods inherited from QorusSystemService
 constructor ()
 initializes the info service
 
softlist getOrderInfoFromKey (string name, string version, softstring key, softstring value)
 returns order instance info from user order key (params: workflowname, workflowversion, keyname, value)
 
*list getWorkflowListFromWorkflowKey (string workflow, softstring key, softstring value)
 returns order instance info from the workflow name, key, and value More...
 
hash getAllInfoFromOrderKey (string name, string version, softstring key, softstring value)
 returns all information about a workflow from a user order key (params: workflowname, workflowversion, keyname, value)
 
deprecated *hash getWorkflowMetadata ()
 gets workflow metadata (optional params: list of IDs), returns: hash of workflow metadata keyed by name and then version: COMPAT VERSION with fake flow information (removed in Qorus v2); use getWorkflowMetadata2() instead More...
 
*hash getWorkflowMetadata2 ()
 gets workflow metadata (optional params: list of IDs), returns: hash of workflow metadata keyed by name and then version More...
 
*hash getWorkflowMetadataFromName (string name, *string ver)
 gets workflow metadata from name and version (params: name, optional: version), returns: hash of workflow metadata keyed by name and then version: COMPAT VERSION with fake flow information; use getWorkflowMetadataFromName2() instead More...
 
*hash getWorkflowMetadataFromName2 (string name, *string ver)
 gets workflow metadata from name and version (params: name, optional: version), returns: hash of workflow metadata keyed by name and then version, new version without flows (removed in Qorus v2) More...
 
*hash getFunctionInstance (softint fiid, *softdate date)
 retrieves function data from the function_instanceid (params: function_instanceid), returns: hash of function data keyed by name and then version
 
*hash getFunctionInstanceFromName (string name, *string ver)
 retrieves function data from the name and optionally the version (params: name, [version]), returns: hash of function data keyed by name and then version
 
*hash getServiceMethod2 (softint mid, *softdate date)
 retrieves method data from the service_methodid (params: service_methodid), returns: hash of method data More...
 
*hash getServiceMethod (softint mid, *softdate date)
 retrieves method data from the service_methodid (params: service_methodid), returns: hash of method data More...
 
*list getWorkflowInstanceList (*softlist workflowid, *softdate date=now() - 1D, any stati, softint rownum=OptionHelper::getOption("row-limit"))
 gets a list of workflow instance ids (not more than 100 by default, can be overridden with the 4th argument), params: workflowid (single value, list, or NOTHING), date, [statuses, num rows]
 
list getWorkflowInstances (*softlist wfids, *list statuses, *softdate modified, softint rownum=OptionHelper::getOption("row-limit"), *int offset, *softlist sort, *softlist wfiids, *softbool desc, *date minstarted, *date maxstarted)
 gets a list of workflow instance ids; this is the safe and preferred variant of this method More...
 
deprecated list getWorkflowInstances (softint workflowid, *string condition, int rownum=OptionHelper::getOption("row-limit"))
 gets a list of workflow instance ids, params: workflowid, condition, number of rows (100 default) More...
 
*list getWorkflowInstancesByKeyValue (softlist val, *softstring key, *softlist wfids, *softlist statuses, *date modified, softint rownum=OptionHelper::getOption("row-limit"), *int offset, *softlist sort, *softlist wfiids, *softbool desc, *date minstarted, *date maxstarted)
 retrieves workflow instances from a key value and optional key name
 
*list searchWorkflowInstances (*hash h)
 searches for workflow order instances according to a hash More...
 
list getWorkflowInstanceOverview (list wfilist)
 return the Workflow Instance Overview info, PARAMS: list(hash("ID",[optional: "date"])), RETURN: list(hash(info))
 
list getStepInstanceList (softint wfiId)
 gets a list of step instances, params: workflowinstanceid
 
list getErrorInstanceList (softint workflowInstanceId, *softint stepId, *softint ind)
 gets a list of error instances, params: workflowInstanceId, [stepId, ind]
 
list getErrorInstanceListByWFIID (softint workflowInstanceId, *softint stepId)
 gets a list of error instances, params: workflowInstanceId, [stepId]
 
*hash< auto > getClass (softint classid, *softdate date)
 retrieves class data from a classid; returns: hash of class data keyed by name and then version
 
*hash getStepMetadata ()
 gets step metadata (optional params: list of IDs), returns: hash of step metadata information keyed by name and then version
 
*hash getTreeWithWorkflowInstance (softint workflowinstanceid, softbool full=False, softbool compat=True)
 retrieves tree view like structure that contains specific instanceid (params: workflowinstanceid)
 
*hash getWFIAllInfo (softint workflowInstanceID, *softdate lastModifiedDate, softbool compat=True, softbool with_sensitive_data=False)
 Retrieves all workflow instance info (params: workflowInstanceID, [lastModifiedDate]; output hash keys: InstanceInfo, OrderInfo, StepInstances, ErrorInstances, LastModified. More...
 
*hash getWFIInstanceInfo (softint workflowInstanceID, *softdate lastModifiedDate, softbool compat=True)
 Retrieves only workflow instance info (params: workflowInstanceID, [lastModifiedDate]; output hash keys: InstanceInfo, LastModified. More...
 
*hash getWFIOrderInfo (softint workflowInstanceID, *softdate lastModifiedDate, softbool compat=True, softbool with_sensitive_data=False)
 Retrieves workflow instances order info (params: workflowInstanceID, [lastModifiedDate]; output hash keys: OrderInfo, LastModified. More...
 
*hash getWFIStepInstances (softint workflowInstanceID, *softdate lastModifiedDate, softbool compat=False)
 Retrieves all step info for workflow instance (params: workflowInstanceID, [lastModifiedDate]; output hash keys: StepInstances, LastModified.
 
*hash getWFIErrorInstances (softint workflowInstanceID, *softdate lastModifiedDate, softbool compat=True)
 gets workflow instance error info (params: workflowInstanceID, [lastModifiedDate]; output hash keys: ErrorInstances, LastModified
 
*list getWorkflowInstanceListFromWorkflowNameAndKeyValue (string name, softstring val)
 retrieves workflow instances from a workflow name and a key value, returns a list of workflow instance IDs
 
*list getWorkflowInstanceListFromWorkflowNameVersionAndKeyValue (string name, string version, softstring val)
 retrieves workflow instances from a workflow name, version, and key value, returns a list of workflow instance IDs
 
*list getWorkflowInstanceListFromKeyValue (softstring val)
 retrieves workflow instances from a key value only, returns a list of workflow instance IDs
 
list getOrderInfoList (string name, softstring key, softstring value)
 returns order info from a workflow name and an order key and value (params: workflowname, keyname, value)
 
*list< auto > searchOrderKeys (hash params)
 returns a list of workflow instance info matching the input criteria More...
 
softlist searchWorkflowErrors (hash h)
 returns a list of matching errors for the input criteria More...
 
*list searchReleases (*hash params)
 returns release info More...
 
*list searchSessions (*hash params)
 returns information about application sessions More...
 
*hash getUnpostedEvents (*softlist ids, *softdate lastmod=now() - 6M, softint rownum=OptionHelper::getOption("row-limit"), *int offset)
 returns a hash of event type names with lists of unposted events for each, params: event ID(s), [last modified date] More...
 
*hash getUnpostedEventsFromName (string eventname, *softdate lastmod)
 returns a hash of event type names with lists of unposted events for each, params: event type name, [last modified date] More...
 
list searchEvents (*hash h)
 returns workflow synchronization event information More...
 
*hash getJobMetadata ()
 retrieves job metadata (optional params: list of job ids), returns: job info keyed by name More...
 
*hash getJobMetadataFromName (string name)
 retrieves job metadata from the name, returns: job info keyed by name More...
 
list getJobList ()
 retrieves a list of all jobs without the code field More...
 
*hash getJobStatus (softint jiid)
 returns NOTHING if the job instance ID is not valid or a hash giving job instance status corresponding to the job instance ID passed as an argument More...
 
*list getJobInstanceList (any jobid, *softdate date=now() - 1D, any stati, softint rownum=OptionHelper::getOption("row-limit"))
 gets a list of job instance ids (not more than 100 by default, can be overridden with the 4th argument), params: jobid (single value or list), date, [statuses, num rows] More...
 
*list getJobInstances (*softlist jobids, *softlist statuses, *softdate modified, softint rownum=OptionHelper::getOption("row-limit"), *softint offset, *softlist sort, *softlist jiids, *softbool desc, *softbool full)
 gets a list of job instance ids, params: jobid, condition, number of rows (100 default) More...
 
softlist getOrderInstanceNotes (softint wfiid, *int count)
 gets a list of order instance notes More...
 
list< hash< SlaEventInfo > > searchSlaEvents (*hash h)
 searches for SLA events according to the given criteria and returns a list of results More...
 
softlist< hash< SlaPerformanceInfo > > getSlaPerformance (*hash h)
 searches for SLA events according to the given criteria and returns a list of results More...
 
- Static Public Member Methods inherited from QorusSystemService
static deprecated *hash getWorkflowStatus (softint id)
 returns workflow instance status from workflow_instanceid: COMPAT VERSION with fake flow and flow_instance information (removed in Qorus v2); use getWorkflowStatus2() instead More...
 
static *hash getWorkflowStatus2 (softstring wfiid)
 returns workflow order data instance status from the workflow_instanceid More...
 
static *hash getOrderInfo (softstring wfiid)
 returns order instance info from workflow_instanceid
 
static *list getOrderInfoFromExternalID (softstring id)
 returns order instance info from external_order_instanceid
 
static softlist getOrdersFromKey (softstring key, softstring value)
 returns order instance info from the key and value
 
static *hash< auto > getWorkflowOverview (softdate date=now() - 1D, *softlist wfids, softbool useSqlCache=True, softbool with_deprecated=True)
 gets workflow overview, params: [date, [workflowids]]: If no date is given, default = last 24 hours More...
 
static *hash getWorkflowOverviewFromName (softdate date=now() - 1D, *string name, *string version, softbool useSqlCache=True, softbool with_deprecated=True)
 gets workflow overview, params: [date, [name, [version]]]: If no date is given, default = last 24 hours More...
 
static *list getWorkflowSummaryOverview (softdate date=now() - 1D, softbool useSqlCache=True, softbool with_deprecated=True)
 gets system overview, params: [date]: If no date is given, default = last 24 hours More...
 
static *hash getServiceMetadata ()
 retrieves service metadata (optional params: list of service ids), returns: service info keyed by name. NOTE: if no list is given, only the latest version of each service will be returned
 
static *hash getServiceMetadataFromName (string type, string name, *string ver)
 retrieves service metadata from the type, name and optional version (params: type, name, [version]), returns: service info keyed by name. NOTE: if no version is given, only the latest version will be returned
 
static list getLibraryMetadata ()
 retrieves function library information as a list of hashes with the keys name, function_instanceid
 
static *hash getClassFromName (string name, *string ver)
 retrieves class data from the class name and optional version (params: name, [version]), returns: hash of class data keyed by name and then version
 
static *hash getConstant (softint constantid, *softdate date)
 retrieves constant data from the constantid (params: constantid), returns: hash of constant data keyed by name and then version
 
static *hash getConstantFromName (string name, *string ver)
 retrieves constant data from the constant name and optional version (params: name, [version]), returns: hash of constant data keyed by name and then version
 
static *hash getWFIOrderKeysOnly (softint workflowInstanceID)
 Retrieves only order keys for workflow instance params: workflowInstanceID; output: hash.
 
static *list getWorkflowProcessingSummary (hash h)
 returns a summary of workflow processing for the given time period and optional workflow ID(s) More...
 
static *list getStepProcessingSummary (hash h)
 returns a summary of step processing for the given time period and optional step ID(s) More...
 
static *hash getJobOverview (softdate date=now() - 1D, any jobids, bool useSqlCache=True)
 gets job overview, params: [date, [jobids]]: If no date is given, default = last 24 hours More...
 
static *hash getJobOverviewFromName (softdate date=now() - 1D, *string name, bool useSqlCache=True)
 gets job overview, params: [date, [name]]: If no date is given, default = last 24 hours More...
 

Detailed Description

the main queue service class

Member Function Documentation

◆ cancelData()

static deprecated nothing QorusSystemQueueService::cancelData ( string  name,
softstring  key 
)
inlinestaticprivate:internal

DEPRECATED: cancels a queue entry with status OMQ::QS_Waiting (params: queue name, key)

Deprecated:
since Qorus 4.0. Use rest API with:
Note
- write: True (external calls require OMQ::QR_CALL_SYSTEM_SERVICES_RW)

◆ correctData()

static deprecated nothing QorusSystemQueueService::correctData ( softint  wfiid,
softint  stepid,
softint  ind 
)
inlinestaticprivate:internal

DEPRECATED: corrects a queue entry with status OMQ::QS_Waiting, sets the status to OMQ::QS_Received and sets the corrected attribute to True (params: workflow_instanceid, stepid, ind)

Deprecated:
since Qorus 4.0. Use rest API with:
Note
- write: True (external calls require OMQ::QR_CALL_SYSTEM_SERVICES_RW)

◆ getInfo()

static deprecated auto QorusSystemQueueService::getInfo ( softint  wfiid,
softint  stepid = 0,
*softint  ind 
)
inlinestaticprivate:internal

DEPRECATED: gets queue information for a particular workflow and step (params: workflow_instanceid, optional: stepid, ind)

Deprecated:
since Qorus 4.0. Use rest API with:

◆ getInfoFromQueueKey()

static deprecated *hash QorusSystemQueueService::getInfoFromQueueKey ( string  queue,
softstring  key 
)
inlinestaticprivate:internal

DEPRECATED: gets queue information for a queue entry from the queue name and key (params: queue_name, key)

Deprecated:
since Qorus 4.0. Use rest API with:

◆ getQueueInfo()

static deprecated *list QorusSystemQueueService::getQueueInfo ( softint  queueid,
*string  status 
)
inlinestaticprivate:internal

DEPRECATED: Returns a list of queue entries on a given queue from the queue ID and an optional status filter.

Deprecated:
since Qorus 4.0. Use rest API with:

◆ getQueueInfoFromName()

static deprecated *list QorusSystemQueueService::getQueueInfoFromName ( string  name,
*string  status 
)
inlinestaticprivate:internal

DEPRECATED: Returns a list of queue entries on a given queue from the queue name and an optional status filter.

Deprecated:
since Qorus 4.0. Use rest API with:

◆ status()

static deprecated *hash QorusSystemQueueService::status ( *softstring  name)
inlinestaticprivate:internal

DEPRECATED: gives internal queue status (without parameters: for all queues)

Deprecated:
since Qorus 4.0. Use rest API with:

◆ updateData()

static deprecated nothing QorusSystemQueueService::updateData ( string  name,
softstring  key,
any  data 
)
inlinestaticprivate:internal

DEPRECATED: updates a pending entry in a system queue with status OMQ::QS_Waiting, sets the status to OMQ::QS_Received (params: queue name, key, data)

Deprecated:
since Qorus 4.0. Use the REST API with:
Note
- write: True (external calls require OMQ::QR_CALL_SYSTEM_SERVICES_RW)

◆ updateKey()

static deprecated nothing QorusSystemQueueService::updateKey ( string  queuename,
softstring  oldkey,
softstring  newkey 
)
inlinestaticprivate:internal

DEPRECATED: changes the key for a pending entry in a system queue, only when the status is OMQ::QS_Waiting (args: queue name, old key, new key)

Deprecated:
since Qorus 4.0. Use rest API with:
Note
- write: True (external calls require OMQ::QR_CALL_SYSTEM_SERVICES_RW)

The documentation for this class was generated from the following file: