QorusSystemInfoService Class Reference

system info service More...

Inherits QorusSystemService.

Public Member Methods
hash	getWorkflowStatus (softint id)
	getWorkflowStatus service method More...
hash	getWorkflowStatus2 (softstring wfiid)
	getWorkflowStatus2 service method More...
hash	getOrderInfo (softstring wfiid)
	getOrderInfo service method
list	getOrderInfoFromExternalID (softstring id)
	getOrderInfoFromExternalID service method
softlist	getOrderInfoFromKey (string name, string version, softstring key, softstring value)
	getOrderInfoFromKey service method
softlist	getOrdersFromKey (softstring key, softstring value)
	getOrdersFromKey service method
list	getWorkflowListFromWorkflowKey (string workflow, softstring key, softstring value)
	getWorkflowListFromWorkflowKey service method More...
hash	getAllInfoFromOrderKey (string name, string version, softstring key, softstring value)
	getAllInfoFromOrderKey service method
	getWorkflowOverview (softdate date=now() - 1D, *softlist wfids, softbool useSqlCache=True, softbool with_deprecated=True)
	getWorkflowOverview service method More...
hash	getWorkflowOverviewFromName (softdate date=now() - 1D, *string name, *string version, softbool useSqlCache=True, softbool with_deprecated=True)
	getWorkflowOverviewFromName service method More...
list	getWorkflowSummaryOverview (softdate date=now() - 1D, softbool useSqlCache=True, softbool with_deprecated=True)
	getWorkflowSummaryOverview service method More...
hash	getWorkflowMetadata ()
	getWorkflowMetadata service method More...
hash	getWorkflowMetadata2 ()
	getWorkflowMetadata2 service method More...
hash	getWorkflowMetadataFromName (string name, *string ver)
	getWorkflowMetadataFromName service method More...
hash	getWorkflowMetadataFromName2 (string name, *string ver)
	getWorkflowMetadataFromName2 service method More...
hash	getFunctionInstance (softint fiid, *softdate date)
	getFunctionInstance service method
hash	getFunctionInstanceFromName (string name, *string ver)
	getFunctionInstanceFromName service method
hash	getServiceMethod2 (softint mid, *softdate date)
	getServiceMethod2 service method More...
hash	getServiceMethod (softint mid, *softdate date)
	getServiceMethod service method More...
hash	getServiceMetadata ()
	getServiceMetadata service method
hash	getServiceMetadataFromName (string type, string name, *string ver)
	getServiceMetadataFromName service method
list	getLibraryMetadata ()
	getLibraryMetadata service method
list	getWorkflowInstanceList (*softlist workflowid, *softdate date=now() - 1D, auto stati, softint rownum=OptionHelper::getOption("row-limit"))
	getWorkflowInstanceList service method
list	getWorkflowInstances (softint workflowid, *string condition, int rownum=OptionHelper::getOption("row-limit"))
	getWorkflowInstances service method 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)
	getWorkflowInstancesByKeyValue service method
list	searchWorkflowInstances (*hash h)
	searchWorkflowInstances service method More...
list	getWorkflowInstanceOverview (list wfilist)
	getWorkflowInstanceOverview service method
list	getStepInstanceList (softint wfiId)
	getStepInstanceList service method
list	getErrorInstanceList (softint wfiid, *softint stepId, *softint ind)
	getErrorInstanceList service method
list	getErrorInstanceListByWFIID (softint wfiid, *softint stepId)
	getErrorInstanceListByWFIID service method
	getClass (softint classid, *softdate date)
	getClass service method
hash	getClassFromName (string name, *string ver)
	getClassFromName service method
hash	getConstant (softint constantid, *softdate date)
	getConstant service method
hash	getConstantFromName (string name, *string ver)
	getConstantFromName service method
hash	getStepMetadata ()
	getStepMetadata service method
hash	getTreeWithWorkflowInstance (softint wfiid, softbool full=False, softbool compat=True)
	getTreeWithWorkflowInstance service method
	getWFIAllInfo (softint wfiid, *softdate last_modified, softbool compat=True, softbool with_sensitive_data=False)
	getWFIAllInfo service method More...
hash	getWFIInstanceInfo (softint wfiid, *softdate last_modified, softbool compat=True)
	getWFIInstanceInfo service method More...
hash	getWFIOrderInfo (softint wfiid, *softdate last_modified, softbool compat=True, softbool with_sensitive_data=False)
	getWFIOrderInfo service method More...
hash	getWFIStepInstances (softint wfiid, *softdate last_modified, softbool compat=False)
	getWFIStepInstances service method
hash	getWFIErrorInstances (softint wfiid, *softdate last_modified, softbool compat=True)
	getWFIErrorInstances service method
list	getWorkflowInstanceListFromWorkflowNameAndKeyValue (string name, softstring val)
	getWorkflowInstanceListFromWorkflowNameAndKeyValue service method
list	getWorkflowInstanceListFromWorkflowNameVersionAndKeyValue (string name, string version, softstring val)
	getWorkflowInstanceListFromWorkflowNameVersionAndKeyValue service method
list	getWorkflowInstanceListFromKeyValue (softstring val)
	getWorkflowInstanceListFromKeyValue service method
list	getOrderInfoList (string name, softstring key, softstring value)
	getOrderInfoList service method
hash	getWFIOrderKeysOnly (softint wfiid)
	getWFIOrderKeysOnly service method
	searchOrderKeys (hash params)
	searchOrderKeys service method More...
list	getWorkflowProcessingSummary (hash h)
	getWorkflowProcessingSummary service method More...
list	getStepProcessingSummary (hash h)
	getStepProcessingSummary service method More...
softlist	searchWorkflowErrors (hash h)
	searchWorkflowErrors service method More...
list	searchReleases (*hash params)
	searchReleases service method More...
list	searchSessions (*hash params)
	searchSessions service method More...
hash	getUnpostedEvents (*softlist ids, *softdate lastmod=now() - 6M, softint rownum=OptionHelper::getOption("row-limit"), *int offset)
	getUnpostedEvents service method More...
hash	getUnpostedEventsFromName (string eventname, *softdate lastmod)
	getUnpostedEventsFromName service method More...
list	searchEvents (*hash h)
	searchEvents service method More...
	getJobOverview (date, jobids, useSqlCache)) sortBy(%name)
	getJobOverview service method More...
hash	getJobOverviewFromName (softdate date=now() - 1D, *string name, bool useSqlCache=True)
	getJobOverviewFromName service method More...
hash	getJobMetadata ()
	getJobMetadata service method More...
hash	getJobMetadataFromName (string name)
	getJobMetadataFromName service method More...
list	getJobList ()
	getJobList service method More...
hash	getJobStatus (softint jiid)
	getJobStatus service method More...
list	getJobInstanceList (auto jobid, *softdate date=now() - 1D, auto stati, softint rownum=OptionHelper::getOption("row-limit"))
	getJobInstanceList service method 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)
	getJobInstances service method More...
softlist	getOrderInstanceNotes (softint wfiid, *int count)
	getOrderInstanceNotes service method More...
	searchSlaEvents (*hash h)
	searchSlaEvents service method More...
	getSlaPerformance (*hash h)
	getSlaPerformance service method More...

Detailed Description

system info service

Member Function Documentation

getJobInstanceList()

list QorusSystemInfoService::getJobInstanceList ( auto  jobid, *softdate  date = now() - 1D, auto  stati, softint  rownum = OptionHelper::getOption("row-limit")  )

inline

getJobInstanceList service method

Parameters

jobid	a single jobid or a list of jobids to query
date	an optional cutoff date, if the date parameter is not passed, then the cutoff date is set to 24 hours in the past; the cutoff date is used with the job_instance.modified column; only rows with a modified date greater than or equal to the date passed will be returned
stati	a single job status or a list of job statuses to check; see Job Data Status Descriptions for possible values
rownum	the maximum number of rows to return

Returns

a list of integer job instance IDs

Note

if more than one jobid is given, there is no way to differentiate the jobid from the list returned because only a flat list of job_instanceid values is returned

Exceptions

PARAMETER-ERROR	missing jobid parameter, invalid date passed, or invalid job status passed
JOB-ACCESS-ERROR	Role Based Access Control is enabled and the calling user does not have the right to access one or more of the given jobids

getJobInstances()

list QorusSystemInfoService::getJobInstances ( *softlist  jobids, *softlist  statuses, *softdate  modified, softint  rownum = OptionHelper::getOption("row-limit"), *softint  offset, *softlist  sort, *softlist  jiids, *softbool  desc, *softbool  full  )

inline

getJobInstances service method

Parameters

jobids	one or more jobids to query
statuses	a list with requested statuses in expanded form ('ERROR') or NOTHING
modified	a limit (>=) for the modified column or NOTHING
rownum	the maximum number of rows to return
offset	the row offset (for paging results)
sort	a list of column names for sorting
jiids	an optional list of job_instanceids for the search
desc	if True, then a descending sort is used
full	if True, then errors and audit events are also returned

Returns

NOTHING if no rows match the criteria, or a list of hashes with the following keys:

• job_instanceid: the job instance ID being queried
• jobid: the jobid (metadata ID)
• jobstatus: the current status of the job (see Job Data Status Descriptions for possible values)
• sessionid: the application session currently running the job, otherwise 0
• started: the time the job instance was started
• completed: the time the job instance completed (with any status)
• modified: the time the job instance was last modified
• errors: a list of error hashes (included only if full = True)
• audit: a list of audit event hashes (included only if full = True)

Exceptions

JOB-ACCESS-ERROR

Role Based Access Control is enabled and the calling user does not have the right to access one or more of the given jobids

getJobList()

list QorusSystemInfoService::getJobList ( )

inline

getJobList service method

Returns

a list of hashes with the following keys for all jobs in the database:

• name: the unique name of the job
• jobid: the unique job ID
• description: job description
• version: version number of the job
• sessionid: session where the job is running
• active: True if active, False if not
• run_skipped: True if the job should be executed immediately if a trigger time was missed due to down time, False if not
• [recurring]: if this field is present, this gives the number of seconds between job executions, and the cron fields will not be present
• [minute]: cron field: minutes when the job can be executed
• [hour]: cron field: hours when the job can be executed
• [day]: cron field: days when the job can be executed
• [month]: cron field: months when the job can be executed
• [wday]: cron field: week days (0 = Sunday) when the job can be executed
• [last_executed]: the date/time the job was last executed (if not present, the job has not yet been executed)
• [last_executed_job_instanceid]: the last executed instance id of the job
• [expiry_date]: the date/time the job will expire; if this date is present, the job will not run automatically after this date
• created: the date/time the job was loaded into the database
• modified: the date/time the job was modified in the database
• groups: a list of RBAC group names that this job is a member of

Note

if this method is called externally, and the user has a limited list of accessible jobs, then only information about the jobs the user can access is returned

getJobMetadata()

hash QorusSystemInfoService::getJobMetadata ( )

inline

getJobMetadata service method

Returns

NOTHING if no job can be matched to any of the given ids (or no jobs are in the system if no id is passed), or a hash keyed by job name where the value is a hash of job information with the following keys:

• name: the unique name of the job
• jobid: the unique job ID
• description: job description
• version: version number of the job
• sessionid: session where the job is running
• active: True if active, False if not
• run_skipped: True if the job should be executed immediately if a trigger time was missed due to down time, False if not
• code: the source code of the job
• [recurring]: if this field is present, this gives the number of seconds between job executions, and the cron fields will not be present
• [minute]: cron field: minutes when the job can be executed
• [hour]: cron field: hours when the job can be executed
• [day]: cron field: days when the job can be executed
• [month]: cron field: months when the job can be executed
• [wday]: cron field: week days (0 = Sunday) when the job can be executed
• [last_executed]: the date/time the job was last executed (if not present, the job has not yet been executed)
• [last_executed_job_instanceid]: the last executed instance id of the job
• [expiry_date]: the date/time the job will expire; if this date is present, the job will not run automatically after this date
• created: the date/time the job was loaded into the database
• modified: the date/time the job was modified in the database
• lib: a hash keyed by library object type (key values: "functions", "classes", "constants"); the value of each key will be a list of hashes with the following keys (empty lists mean no objects of that type are listed as library objects of the workflow):
  • name: the name of the library object
  • version: the version of the library object
  • id: the ID of the library object (referencing the tables, FUNCTION_INSTANCE, CLASSES, or CONSTANTS)
• groups: a list of RBAC group names that this job is a member of

Exceptions

JOB-ACCESS-ERROR

Role Based Access Control is enabled and the user does not have access to the given job

getJobMetadataFromName()

hash QorusSystemInfoService::getJobMetadataFromName ( string  name )

inline

getJobMetadataFromName service method

Parameters

name	the name of the job to query

Returns

see getJobMetadata() for information about the return value

Exceptions

JOB-ACCESS-ERROR

Role Based Access Control is enabled and the user does not have access to the given job

getJobOverview()

QorusSystemInfoService::getJobOverview ( date  , jobids  , useSqlCache    )

inline

getJobOverview service method

Parameters

date	the minimum date to check for changes; job_instance rows with a modified date before this date will not be reported; the default value is 24 hours from the current date and time
jobids	the jobs IDs to query
useSqlCache	if the sql cache should be used

Returns

NOTHING if no information is available, otherwise a hash where the keys are job names and the values are hashes with the following keys:

• jobid: the jobid of the job
• version: the version of the job
• [COMPLETE]: the number of job instances with status OMQ::JS_Complete in the given time frame
• [ERROR]: the number of job instances with status OMQ::JS_Complete in the given time frame
• [IN-PROGRESS]: the number of job instances with status OMQ::JS_InProgress in the given time frame (should never be > 1 for a given job)
• [CRASH]: the number of job instances with status OMQ::JS_Crash in the given time frame

Exceptions

PARAMETER-ERROR	the date passed was not valid
JOB-ACCESS-ERROR	Role Based Access Control is enabled and the user does not have access to the given job

Note

if this method is called externally, and the user has a limited list of accessible jobs, then only information about the jobs the user can access is returned; if the user requests a particular job and does not have access to that job, then a JOB-ACCESS-ERROR exception is raised

getJobOverviewFromName()

hash QorusSystemInfoService::getJobOverviewFromName ( softdate  date = now() - 1D, *string  name, bool  useSqlCache = True  )

inline

getJobOverviewFromName service method

Parameters

date	the minimum date to check for changes; job_instance rows with a modified date before this date will not be reported; the default value is 24 hours from the current date and time
name	the optional name of the job to check; if no name is passed, then all accessible jobs will be reported
useSqlCache	if the sql cache should be used

Returns

see getJobOverview() for the return value

Exceptions

UNKNOWN-JOB	the job name given does not exist
PARAMETER-ERROR	the date passed was not valid
JOB-ACCESS-ERROR	Role Based Access Control is enabled and the user does not have access to the given job

Note

if this method is called externally, and the user has a limited list of accessible jobs, then only information about the jobs the user can access is returned; if the user requests a particular job and does not have access to that job, then a JOB-ACCESS-ERROR exception is raised

getJobStatus()

hash QorusSystemInfoService::getJobStatus ( softint  jiid )

inline

getJobStatus service method

Parameters

jiid	the job instance ID to query

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 with the following keys:

• job_instanceid: the job instance ID being queried
• jobid: the jobid (metadata ID)
• sessionid: the application session currently running the job, otherwise 0
• jobstatus: the current status of the job (see Job Data Status Descriptions for possible values)
• [info]: the information saved against the job (if any)
• started: the time the job instance was started
• completed: the time the job instance completed (with any status)
• modified: the time the job instance was last modified
• errors: if any errors were raised against the job instance, they will appear as hashes in a list assigned to this key; the hashes will have the following keys:
• job_errorid: the unique ID of the error in the job_errors table
• severity: the severity of the error (see Error Severity Codes for possible values)
• error: the error code
• description: description of the error
• [info]: any additional data saved against the error
• business_error: True if the error is a business error, False if not
• created: the date/time the error was created
• audit: if any audit events were created for the given job instance, they will appear as hashes in a list assigned to this key; the hashes will have the following keys:
• audit_eventid: the audit event ID (unique key in the AUDIT_EVENTS table)
• [related_audit_eventid]: related audit event ID
• audit_event_code: the audit event code (see Audit Event Codes for possible values)
• [audit_user_event]: the user audit event code string (present only when audit_event_code is OMQ::AE_USER_EVENT)
• [reason]: the reason for the event
• who: the initiator of the event
• source: a string describing the source of the event
• [info1]: an informational string about the event
• [info2]: an informational string about the event
• created: the date/time the audit event was created
• event: the string description corresponding to the audit_event_code (see Audit Event Strings for possible values)

Exceptions

JOB-ACCESS-ERROR

Role Based Access Control is enabled and the user does not have access to the given job instance ID

getOrderInstanceNotes()

softlist QorusSystemInfoService::getOrderInstanceNotes ( softint  wfiid, *int  count  )

inline

getOrderInstanceNotes service method

Parameters

wfiid	the wfiid to query
count	an optional "limit count

getServiceMethod()

hash QorusSystemInfoService::getServiceMethod ( softint  mid, *softdate  date  )

inline

getServiceMethod service method

Deprecated:

use getServiceMethod2() instead; this method is the same but provides 2 additional hardcoded fields for backwards-compatibility

Parameters

mid	the method ID
date	if this date is present, then information will only be returned if the method has been modified after the given date

Returns

NOTHING if no data is available, or a hash with the same keys as the return value of getServiceMethod2() with 2 additional hardcoded fields:

• createdby: hardcoded to "omq"
• modifiedby: hardcoded to "omq"

Exceptions

SERVICE-ACCESS-ERROR

Role Based Access Control is enabled and the user does not have access to the given service

Note

if this method is called externally, and the user does not have access to the given service, then a SERVICE-ACCESS-ERROR exception is raised

getServiceMethod2()

hash QorusSystemInfoService::getServiceMethod2 ( softint  mid, *softdate  date  )

inline

getServiceMethod2 service method

Parameters

mid	the method ID
date	if this date is present, then information will only be returned if the method has been modified after the given date

Returns

NOTHING if no data is available, or a hash with the following info:

• service_methodid: the method ID (corresponding to the mid argument)
• serviceid: the ID of the service
• name: the method name
• description: the method description
• locktype: the lock attribute for the method, see Service Method Lock Attribute Values for possible values
• internal: a flag where 0 = not internal, 1 = internal
• body: the method body
• created: the create date/time of the method record
• modified: the modification date/time of the method record
• write: a flag where 0 = not write, 1 = write
• tags: any service method tags; the special tag "sys" is a hash with system tags

Exceptions

SERVICE-ACCESS-ERROR

Role Based Access Control is enabled and the user does not have access to the given service

Note

if this method is called externally, and the user does not have access to the given service, then a SERVICE-ACCESS-ERROR exception is raised

getSlaPerformance()

QorusSystemInfoService::getSlaPerformance ( *hash  h )

inline

getSlaPerformance service method

Parameters

h

a hash of search criteria with the following optional keys: err: the error string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matching errdesc: the error description string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matching grouping: (optional) possible values for reporting performance statistics: "hourly": hourly grouping "daily": daily grouping "monthly": monthly grouping "yearly": yearly grouping name: the name of the SLA; can be a list of names or a string with "%" characters for SQL like matching maxdate: maximum SLA event timestamp (exclusive, meaning "<" comparisons used) mindate: minimum SLA event timestamp (inclusive, meaning ">=" comparisons used) producer: the producer string of SLA events; can be a list of strings or a string with "%" characters for SQL like matching slaid: the SLA ID, can be a list of IDs success: filter for sucessful calls (1) or errored calls (0)

Returns

an empty list if no events are matched, otherwise a list of OMQ::SlaPerformanceInfo hashes

Since

Qorus 3.1.1

getStepProcessingSummary()

list QorusSystemInfoService::getStepProcessingSummary ( hash  h )

inline

getStepProcessingSummary service method

Parameters

h

a hash with the following keys: mindate: (required) the minimum date/time for the processing summary maxdate: (optional) the maximum date/time for the processing summary step: (optional) one or more step names stepids: (optional) one or more stepids for the processing summary seconds: (optional) if True then the performance values will be returned in integers representing seconds grouping: (optional) possible values for reporting performance statistics: "hourly": hourly grouping "daily": daily grouping "monthly": monthly grouping "yearly": yearly grouping global: (optional) if True then all workflows will be combined into an overall processing report, if False then each workflow gets a separate line in the output

getUnpostedEvents()

hash QorusSystemInfoService::getUnpostedEvents ( *softlist  ids, *softdate  lastmod = now() - 6M, softint  rownum = OptionHelper::getOption("row-limit"), *int  offset  )

inline

getUnpostedEvents service method

Parameters

ids	NOTHING or one or more event type IDs to check
lastmod	an optional last modified date; if present, then only records modified after the given date will be returned
rownum	maximum rowz returned
offset	row offset for return values

Returns

NOTHING if no events are available, or a hash keyed by the event type name where each value is a list of event keys

getUnpostedEventsFromName()

hash QorusSystemInfoService::getUnpostedEventsFromName ( string  eventname, *softdate  lastmod  )

inline

getUnpostedEventsFromName service method

Parameters

eventname	the event type name to query
lastmod	an optional last modified date; if present, then only records modified after the given date will be returned

Returns

NOTHING if no events are available, or a hash keyed by the event type name where each value is a list of event keys

Exceptions

UNKNOWN-EVENT

the event name passed is invalid

getWFIAllInfo()

QorusSystemInfoService::getWFIAllInfo ( softint  wfiid, *softdate  last_modified, softbool  compat = True, softbool  with_sensitive_data = False  )

inline

getWFIAllInfo service method

Parameters

wfiid	the workflow instance ID of the order
last_modified	only retrieve information if changed after this date (if the argument is present); note that this argument is ignored if the workflow order data is cached; in this case, all information are returned and this argument is ignored
compat	add keys for backwards-compatibility with very old versions of Qorus
with_sensitive_data	also return Sensitive Data in the OrderInfo key

Returns

NOTHING if the workflow instance ID does not exist, otherwise a hash is returned with the following keys:

• InstanceInfo: information about the workflow order; see getWFIInstanceInfo() return value for the value of this key see the OrderInfo key also
• OrderInfo: information about the actual order information
• StepInstances: information about steps in the current workflow order
• ErrorInstances: information about errors raised against the workflow order
• HierarchyInfo: information about all parent and/or child workflows related to this workflow order
• AuditEvents: if any audit events were created for the given job instance, they will appear as hashes in a list assigned to this key; the hashes will have the following keys:
• audit_eventid: the audit event ID (unique key in the AUDIT_EVENTS table)
• [related_audit_eventid]: related audit event ID
• audit_event_code: the audit event code (see Audit Event Codes for possible values)
• [audit_user_event]: the user audit event code string (present only when audit_event_code is OMQ::AE_USER_EVENT)
• [reason]: the reason for the event
• who: the initiator of the event
• source: a string describing the source of the event
• [info1]: an informational string about the event
• [info2]: an informational string about the event
• created: the date/time the audit event was created
• event: the string description corresponding to the audit_event_code (see Audit Event Strings for possible values)
• LastModified: the last modified date of the workflow order if the data is retrieved from the DB, otherwise the current date and time if the information was retrieved form the workflow order cache

Exceptions

SENSITIVE-DATA-ERROR	this exception is thrown when with_sensitive_data is True and the request is received over an insecure connection
AUTHORIZATION-ERROR	this exception is thrown when with_sensitive_data is True and the user has neither OMQ::QR_READ_SENSITIVE_DATA or OMQ::QR_SENSITIVE_DATA_CONTROL

Since

Qorus 3.1.1 this API supports retrieving sensitive data over internal and encrypted connections by authorized users

getWFIInstanceInfo()

hash QorusSystemInfoService::getWFIInstanceInfo ( softint  wfiid, *softdate  last_modified, softbool  compat = True  )

inline

getWFIInstanceInfo service method

Parameters

wfiid	the workflow instance ID of the order
last_modified	only retrieve information if changed after this date (if the argument is present)
compat	add keys for backwards-compatibility with very old versions of Qorus

Returns

NOTHING if the criteria do not match any workflow order, otherwise a hash with the following keys:

• InstanceInfo: a hash with the following keys:
• name: the name of the workflow (metadata)
• version: the version of the workflow (metadata)
• workflow_instanceid: equal to the wfiid argument
• workflowid: the workflowid of the workflow (metadata)
• workflowstatus: the status of the workflow (see Workflow, Segment, and Step Status Descriptions for possible values)
• status_sessionid: the Qorus application session that the order belongs to or 0 if not owned by any session
• parent_workflow_instanceid: the parent workflow instance ID if this workflow is a subworkflow
• synchronous: 1 for an order currently being executed synchronously
• business_error: True if the OMQ::StatError status is due to a business error
• workflowstatus_orig: the original status of the workflow (only if the status is OMQ::StatBlocked or OMQ::StatCanceled; see Workflow, Segment, and Step Status Descriptions for possible values)
• custom_status: the custom status set for the order (if any)
• scheduled: the scheduled date for the workflow (if any)
• priority: the order priority
• started: the date/time the workflow order was created
• completed: the date/time the workflow order got a OMQ::StatComplete status
• modified: the last modified date/time
• archive: the archive flag for the workflow order instance (presented only if it goes from archive datasource)
• LastModified: the last modified date of the workflow order instance

getWFIOrderInfo()

hash QorusSystemInfoService::getWFIOrderInfo ( softint  wfiid, *softdate  last_modified, softbool  compat = True, softbool  with_sensitive_data = False  )

inline

getWFIOrderInfo service method

Exceptions

SENSITIVE-DATA-ERROR	this exception is thrown when with_sensitive_data is True and the request is received over an insecure connection
AUTHORIZATION-ERROR	this exception is thrown when with_sensitive_data is True and the user has neither OMQ::QR_READ_SENSITIVE_DATA or OMQ::QR_SENSITIVE_DATA_CONTROL

Since

Qorus 3.1.1 this API supports retrieving sensitive data over internal and encrypted connections by authorized users

getWorkflowInstances()

list QorusSystemInfoService::getWorkflowInstances ( softint  workflowid, *string  condition, int  rownum = OptionHelper::getOption("row-limit")  )

inline

getWorkflowInstances service method

Parameters

workflowid	a WF id or 0
condition	a string with any SQL condition used in WHERE clause
rownum	limit for max rows

Deprecated:

use the variant taking a workflow ID list instead

getWorkflowListFromWorkflowKey()

list QorusSystemInfoService::getWorkflowListFromWorkflowKey ( string  workflow, softstring  key, softstring  value  )

inline

getWorkflowListFromWorkflowKey service method

Returns

NOTHING if there is no match or a list of hashes with the following keys:

• workflowid
• workflow_instanceid

getWorkflowMetadata()

hash QorusSystemInfoService::getWorkflowMetadata ( )

inline

getWorkflowMetadata service method

Deprecated:

use getWorkflowMetadata2() instead

getWorkflowMetadata2()

hash QorusSystemInfoService::getWorkflowMetadata2 ( )

inline

getWorkflowMetadata2 service method

Returns

NOTHING if the workflowids are not valid, otherwise a hash keyed by workflow name where the values are hases keyed by workflow version with values as hashes of workflow information having the following keys:

• workflowid: the id of the workflow
• patch: the "patch" value of the workflow
• description: the description of the workflow
• errorfunction_instanceid: id of the Deprecated Workflow Error Function
• attach_func_instanceid: id of the Deprecated Attach Function
• onetimeinit_func_instanceid: id of the Deprecated OneTimeInit Function
• created: the date/time the workflow was created in the DB
• modified: the date/time the workflow was last modified in the DB
• keylist: either NOTHING or a list of valid workflow order keys
• steps: a list of step hashes defining the steps in the workflow; each step hash will have the following keys:
• stepid: the stepid of the step
• steptype: type of the step (see Step Types for possible values)
• arraytype: array attribute of the step (see Step Array Attribute Values for possible values)
• name: name of the step
• version: version of the step
• [patch]: the "patch" value of the step
• description: description of the step
• stepfunction_instanceid: id of the Deprecated Primary Step Function
• [validationfunction_instanceid]: id of the Deprecated Validation Step Function
• [endfunction_instanceid]: id of the Deprecated Asynchronous Back-End Step Function for asynchronous steps
• [arrayfunction_instanceid]: id of the Deprecated Array Function for array steps
• [queueid]: id of the asynchronous queue for asynchronous steps
• created: the date/time the step was created in the DB
• modified: the date/time the step was last modified in the DB
• [event]: a hash of event information (present if the steptype = OMQ::ExecEvent):
  • name: name of the event type
  • desc: description of the event type
  • typeid: the event type ID
• step_dependencies: a list of hashes of step dependencies with the following keys:
• stepid: the stepid of the step
• dependson_stepid: the stepid of the step that the step depends on (note that if a hash has stepid = dependson_stepid, then the step has no dependencies)
• workflow_segments: a list of hashes of segment dependencies with the following keys:
• segmentid: the segmentid of the segment
• dependson_segmentid: the segnentid of the segment that the segment depends on (note that if a hash has segmentid = dependson_segmentid, then the segment has no dependencies)
• segments: a hash of segments where the keys are segmentids and the values are step dependency lists within that segment; the step dependency list elements are hashes with the following keys:
• stepid: the stepid of the step
• dependson_stepid: the stepid of the step that the step depends on (note that if a hash has stepid = dependson_stepid, then the step has no dependencies within the given segment)
• options: a hash of options where the keys are the option names, and the values are the option descriptions
• lib: a hash keyed by library object type (key values: "functions", "classes", "constants"); the value of each key will be a list of hashes with the following keys (empty lists mean no objects of that type are listed as library objects of the workflow):
• name: the name of the library object
• version: the version of the library object
• id: the ID of the library object (referencing the tables, FUNCTION_INSTANCE, CLASSES, or CONSTANTS)
• groups: a list of RBAC group names that this service is a member of

Exceptions

WORKFLOW-ACCESS-ERROR

this is exeption is thrown when Role Based Access Control is enabled; the call is made from the network, and the user does not have the right to access the given workflow

Note

if this method is called externally, and the user has a limited list of accessible workflows, then only information about the workflows the user can access is returned; if the user requests a particular workflow and does not have access to that workflow, then a WORKFLOW-ACCESS-ERROR exception is raised

getWorkflowMetadataFromName()

hash QorusSystemInfoService::getWorkflowMetadataFromName ( string  name, *string  ver  )

inline

getWorkflowMetadataFromName service method

Deprecated:

use getWorkflowMetadataFromName2() instead

Exceptions

WORKFLOW-ACCESS-ERROR

this is exeption is thrown when Role Based Access Control is enabled; the call is made from the network, and the user does not have the right to access the given workflow

Note

if this method is called externally, and the user has a limited list of accessible workflows, then only information about the workflows the user can access is returned; if the user requests a particular workflow and does not have access to that workflow, then a WORKFLOW-ACCESS-ERROR exception is raised

getWorkflowMetadataFromName2()

hash QorusSystemInfoService::getWorkflowMetadataFromName2 ( string  name, *string  ver  )

inline

getWorkflowMetadataFromName2 service method

Parameters

name	the name of the workflow
ver	the optional version of the workflow to return

Returns

see getWorkflowMetadata2() for the definition of the hash returned

Exceptions

WORKFLOW-ACCESS-ERROR

this is exeption is thrown when Role Based Access Control is enabled; the call is made from the network, and the user does not have the right to access the given workflow

Note

if this method is called externally, and the user has a limited list of accessible workflows, then only information about the workflows the user can access is returned; if the user requests a particular workflow and does not have access to that workflow, then a WORKFLOW-ACCESS-ERROR exception is raised

getWorkflowOverview()

QorusSystemInfoService::getWorkflowOverview ( softdate  date = now() - 1D, *softlist  wfids, softbool  useSqlCache = True, softbool  with_deprecated = True  )

inline

getWorkflowOverview service method

Exceptions

PARAMETER-ERROR

the date passed was not valid

Parameters

date	optional, order instance modified threshold. Items modified in last day are used if it's not given.
wfids	optional, list of workflow IDs (not order instances) to be used in search criteria
useSqlCache	optional, default True. Unused/deprecated.
with_deprecated	if False then no workflows with the deprecated flag set are returned

Returns

hash or nothing - grouped information about workflow statuses

getWorkflowOverviewFromName()

hash QorusSystemInfoService::getWorkflowOverviewFromName ( softdate  date = now() - 1D, *string  name, *string  version, softbool  useSqlCache = True, softbool  with_deprecated = True  )

inline

getWorkflowOverviewFromName service method

Exceptions

PARAMETER-ERROR

the date passed was not valid

Parameters

date	optional, order instance modified threshold. Items modified in last day are used if it's not given.
name	optional workflow name to be used in search criteria
version	optional workflow version to be used in search criteria
useSqlCache	optional, default True. Unused/deprecated.
with_deprecated	if False then no workflows with the deprecated flag set are returned

Returns

hash or nothing - grouped information about workflow statuses

getWorkflowProcessingSummary()

list QorusSystemInfoService::getWorkflowProcessingSummary ( hash  h )

inline

getWorkflowProcessingSummary service method

Parameters

h

a hash with the following keys: mindate: (required) the minimum date/time for the processing summary maxdate: (optional) the maximum date/time for the processing summary wfids: (optional) one or more workflowids for the processing summary seconds: (optional) if True then the performance values will be returned in integers representing seconds grouping: (optional) possible values for reporting performance statistics: "hourly": hourly grouping "daily": daily grouping "monthly": monthly grouping "yearly": yearly grouping global: (optional) if True then all workflows will be combined into an overall processing report, if False then each workflow gets a separate line in the output

getWorkflowStatus()

hash QorusSystemInfoService::getWorkflowStatus ( softint  id )

inline

getWorkflowStatus service method

Parameters

id	the workflow_instanceid

Deprecated:

use getWorkflowStatus2() instead

getWorkflowStatus2()

hash QorusSystemInfoService::getWorkflowStatus2 ( softstring  wfiid )

inline

getWorkflowStatus2 service method

This method will retrieve information directly from the internal server cache if possible, otherwise data is retrieved from the database

Parameters

wfiid

the workflow_instanceid

Returns

NOTHING if the workflow_instanceid is not valid, otherwise a hash with the following keys:

• name: the name of the workflow (metadata)
• version: the version of the workflow (metadata)
• workflow_instanceid: the instance id of the workflow order data instance
• workflowstatus: the status of the workflow (see Workflow, Segment, and Step Status Descriptions for possible values)
• workflowid: the id of the workflow (metadata)
• status_sessionid: either 0 (meaning no Qorus application instance 'owns' the data) or the application sessionid that 'owns' the workflow order data instance (see Application Session Model)
• parent_workflow_instanceid: the parent workflow_instanceid if the workflow order data instance is a subworkflow instance
• started: the date/time the workflow order data instance was originally created
• completed: the date/time the workflow order data instance received status OMQ::StatComplete
• custom_status: the custom status for the workflow order data instance, if any
• custom_status_desc: the description for the custom status for the workflow order data instance, if any
• scheduled: the date/time the order is scheduled for future execution, if any
• priority: the priority of the order
• segment_instance: a list of hashes for each segment with the following keys:
• segmentid: the segment ID
• segmentstatus: the status of the segment (see Workflow, Segment, and Step Status Descriptions for possible values)
• created: date/time the segment was created
• modified: date/time the segment was last modified
• steps: a list of stepids in the segment
• step_instance: a hash keyed by stepid of steps in the workflow; each step hash value will have the following keys:
• name: name of the step (step metadata)
• version: version of the step (step metadata)
• steptype: type of the step (step metadata, see Step Types for possible values)
• arraytype: array attribute of the step (step metadata, see Step Array Attribute Values for possible values)
• stepid: id of the step (step metadata)
• stepstatus: status of the step (see Workflow, Segment, and Step Status Descriptions for possible values); note that for array steps with more than 1 element, this will be a composite status according to OMQ::StatusOrder)
• started: date/time the step was first created in the DB
• completed: date/time the step got status OMQ::StatComplete
• custom_status: the custom status for the step, if any
• custom_status_desc: the description for the custom status for the step, if any
• [event]: only present for event steps; if present, this will be a hash with the following keys:
  • name: the event type name
  • desc: the event type description
  • typeid: the event type id
  • [key]: if not an arraystep, the event key will be present here
• [subworkflow_instanceid]: only present for subworkflow steps: the workflow_instanceid of the subworkflow bound to the step
• [subworkflowstatus]: only present for subworkflow steps: the status of the subworkflow instance bound to the step
• [substeps]: only present for array steps; if present, this will be a list of hashes with the following keys:
  • stepid: same as the stepid in the parent data structure
  • ind: the step index number
  • stepstatus: the status of the step (see Workflow, Segment, and Step Status Descriptions for possible values)
  • started: date/time the step was first created in the DB
  • completed: date/time the step got status OMQ::StatComplete
  • eventkey: the eventkey bound to the step, if any
  • custom_status: the custom status for the step, if any
  • custom_status_desc: the description for the custom status for the step, if any
• errors: a list of hashes with the following keys for errors raised while processing the workflow order data instance
• stepid: the stepid of the step that created the error
• ind: the index of the step
• severity: severity of the error: Error Severity Codes
• error: the error code
• description: description of the error
• info: information about the error
• business_error: True if the error is a business error, False if not
• created: the date/time the error was raised
• workflow_instanceid: the same as the workflow_instanceid of the parent data structure

Exceptions

WORKFLOW-ACCESS-ERROR

this is exeption is thrown when Role Based Access Control is enabled; the call is made from the network, and the user does not have the right to access the given workflow

getWorkflowSummaryOverview()

list QorusSystemInfoService::getWorkflowSummaryOverview ( softdate  date = now() - 1D, softbool  useSqlCache = True, softbool  with_deprecated = True  )

inline

getWorkflowSummaryOverview service method

Exceptions

PARAMETER-ERROR

the date passed was not valid

Parameters

date	optional, order instance modified threshold. Items modified in last day are used if it's not given.
useSqlCache	optional, default True. Unused/deprecated.
with_deprecated	if False then no workflows with the deprecated flag set are returned

Returns

hash or nothing - summary workflow status information

searchEvents()

list QorusSystemInfoService::searchEvents ( *hash  h )

inline

searchEvents service method

Parameters

h

a hash with the following optional keys: "desc": return in descending order "eventkey": the event key name "eventname": the event type name "id": one or more event type IDs "limit": max number of rows to return, if not given, then the value of the "row-limit" option is used (default: 100) "maxmodified": maximum modified date "modified": minimum modified date "offset": row offset "posted": the event posted status "sort": columns for sorting the results

Since

Qorus 3.1.0

searchOrderKeys()

QorusSystemInfoService::searchOrderKeys ( hash  params )

inline

searchOrderKeys service method

Parameters

params

a hash with one or more of the following keys: keyname: one or more key names, in case a single value is given and it contains an '%' character, the SQL like operator is used; this option cannot be used with the orderkeys option mindate: the minimum creation date for the key (inclusive: ">=") maxdate: the maximum creation date for the key (exclusive: "<") limit: the maximum number of rows to return offset: the offset row number to start returning values orderby: one or more column names to order the return values by orderkeys: a hash of key names to key values to be combined with OR logic; this option cannot be used with the keyname or value options value: the value of the key to find, in case a single value is given and it contains an '%' character, the SQL like operator is used; this option cannot be used with the orderkeys option workflowid: one or more workflowids workflowname: all accessible versions of the given workflow name workflowstatus: one or more workflow order status values

Returns

NOTHING if no rows match or a list of hashes with the following keys:

• workflow_instanceid: the workflow order instance ID
• workflowid: the workflow ID
• name: the name of the workflow
• version: the version of the workflow
• workflowstatus: the status of the workflow order instance
• started: the start date/time of the workflow order instance
• completed: the completed date/time for the workflow order instance
• modified: the last modified date/time of the workflow order instance
• synchronous: the synchronous flag for the workflow order instance
• business_error: the business error flag for the workflow order instance
• archive: the archive flag for the workflow order instance (presented only if it goes from archive datasource)
• operator_lock: the username of the user owning the lock on the workflow order instance data
• note_count: the number of notes attached to the workflow order instance
• warning_count: the warning count of the workflow order instance
• error_count: the error count of the workflow order instance
• custom_status: any custom status for the workflow order instance
• priority: the priority of the workflow order instance
• scheduled: the scheduled date for the workflow order instance
• keyname: the order key name
• value: the order key value
• created: the date/time the order key was created

Exceptions

SEARCH-ORDER-KEYS-ERROR

thrown if the orderkeys options and one of both of the keyname or value options are used in the same call

Since

Qorus 3.1.1 added support for the orderkeys and workflowname options

searchReleases()

list QorusSystemInfoService::searchReleases ( *hash  params )

inline

searchReleases service method

Parameters

params

search parameters with the following optional keys: component: the component name to search for (implies with_files = True and with_components = True) component_maxdate: give the upper date range for the release search for component (implies with_files = True and with_components = True) component_mindate: give the lower date range for the release search for component (implies with_files = True and with_components = True) file_maxdate: give the upper date range for the release search for files (implies with_files = True) file_mindate: give the lower date range for the release search for files (implies with_files = True) file_name: the file name to search for; note that this is used with the SQL like operator (implies with_files = True) limit: the maximum number of releases to return maxdate: give the upper date range for the release search mindate: give the lower date range for the release search offset: the starting release to return (use when paging for example) with_components: if True then file components are included (implies with_files = True) with_files: if True then release files are included

searchSessions()

list QorusSystemInfoService::searchSessions ( *hash  params )

inline

searchSessions service method

Parameters

params

search parameters with the following optional keys: ended_maxdate: give the upper date range for the session end date ended_mindate: give the lower date range for the session end date hostname: the hostname to search for id: the session ID key: the instance key name limit: the maximum number of releases to return started_maxdate: give the upper date range for the session start date started_mindate: give the lower date range for the session start date offset: the starting release to return (use when paging for example) status: one or more session status values url: the HTTP URL for the instance version: the Qorus version string

searchSlaEvents()

QorusSystemInfoService::searchSlaEvents ( *hash  h )

inline

searchSlaEvents service method

Parameters

h

a hash of search criteria with the following optional keys: desc: return the results in descending order err: the error string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matching errdesc: the error description string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matching name: the name of the SLA; can be a list of names or a string with "%" characters for SQL like matching limit: max number of rows to return, if not given, then the value of the "row-limit" option is used (default: 100) mindate: minimum SLA event timestamp (inclusive, meaning ">=" comparisons used) maxdate: maximum SLA event timestamp (exclusive, meaning "<" comparisons used) offset: row offset producer: the producer string of SLA events; can be a list of strings or a string with "%" characters for SQL like matching slaid: the SLA ID, can be a list of IDs sort: columns for sorting the results success: filter for sucessful calls (1) or errored calls (0)

Returns

an empty list if no events are matched, otherwise a list of OMQ::SlaEventInfo hashes

Since

Qorus 3.1.1

searchWorkflowErrors()

softlist QorusSystemInfoService::searchWorkflowErrors ( hash  h )

inline

searchWorkflowErrors service method

Parameters

h

a hash with the following keys: orderby: one or more field names for sorting the output error: the error text to search (can also include '%' characters for use with the LIKE operator; in this case only 1 value can be given) description: the description text to search (can also include '%' characters for use with the LIKE operator; in this case only 1 value can be given) info: the info text to search (can also include '%' characters for use with the LIKE operator; in this case only 1 value can be given stepid: limit the search to one or more stepids severity: limit the search to one or more severity values name: limit the search to one or more step names version: limit the search to one or more step versions retry: limit the search to errors with or without the retry flag business_error: limit the search to errors with or without the business_error flag workflow_instanceid: limit the search to one or more workflow_instanceids error_instanceid: mit the search to one or more error_instanceids mindate: give the lower date range for the error search maxdate: give the upper date range for the error search workflowid: limit the search to one or more workflowids workflowstatus: limit the search to workflow instances with the given status value(s) limit: the maximum number of errors to return; note that if this parameter is not given then the row-limit option is assumed offset: the starting error to return (use when paging for example)

Returns

NOTHING if no rows match or a list of hashes with the following keys:

• name: the workflow name
• version: the workflow version
• workflow_instanceid: the workflow order instance ID
• workflowid: the workflow ID
• stepid: the stepid of the step where the error was raised (could be NULL if the error was not raised in a workflow step)
• stepname: the step name of the step where the error was raised (could be NULL if the error was not raised in a workflow step)
• stepversion: the step version of the step where the error was raised (could be NULL if the error was not raised in a workflow step)
• ind: the step array index (starting from 0) of the step where the error was raised (could be NULL if the error was not raised in a workflow step)
• workflowstatus: the status of the workflow order instance
• started: the start date/time of the workflow order instance
• completed: the completed date/time for the workflow order instance
• parent_workflow_instanceid: the parent workflow_instanceid if the workflow is a child workflow order
• custom_status: any custom status for the workflow order instance
• priority: the priority of the workflow order instance
• scheduled: the scheduled date for the workflow order instance
• error_instanceid: the error ID
• error: the error name
• description: the error description
• info: the error info string
• severity: the severity of the error
• created: the created date and time of the error
• retry: indicates if the error will get a retry status
• business_error: indicates if the error is a business error
• archive: if retrieved from the archive datasource

searchWorkflowInstances()

list QorusSystemInfoService::searchWorkflowInstances ( *hash  h )

inline

searchWorkflowInstances service method

Parameters

h

a hash of search parameters with the following keys (all are optional): keyname: the name of a search key to be used with the keyvalue value(s) keyvalue: the value(s) of workflow order search key(s) to use (optionally used in conjunction with keyname) workflowname: all accessible versions of the given workflow name workflowid: workflowid values(s) workflow_instanceid: workflow_instanceid values(s) status: status value(s) modified: minimum modified date maxmodified: maximum modified date minstarted: minimum start date maxstarted: maximum start date limit: max number of rows to return, if not given, then the value of the "row-limit" option is used (default: 100) offset: row offset sort: columns for sorting the results desc: return in descending order

Returns

NOTHING if no rows match or a list of hashes with the following keys:

• name: the name of the workflow
• version: the version of the workflow
• workflow_instanceid: the workflow order instance ID
• workflowid: the workflow ID
• workflowstatus: the status of the workflow order instance
• status_sessionid: the application session ID that owns the workflow order instance data or 0 if the data is now owned by any application session
• started: the start date/time of the workflow order instance
• completed: the completed date/time for the workflow order instance
• modified: the last modified date/time of the workflow order instance
• parent_workflow_instanceid: the parent workflow_instanceid if the workflow is a child workflow order
• synchronous: the synchronous flag for the workflow order instance
• business_error: the business error flag for the workflow order instance
• archive: the archive flag for the workflow order instance (presented only if it goes from archive datasource)
• operator_lock: the username of the user owning the lock on the workflow order instance data
• note_count: the number of notes attached to the workflow order instance
• warning_count: the warning count of the workflow order instance
• error_count: the error count of the workflow order instance
• custom_status: any custom status for the workflow order instance
• priority: the priority of the workflow order instance
• scheduled: the scheduled date for the workflow order instance
• archive: if retrieved from the archive datasource

Since

• Qorus 3.0.2
• the workflowname option was added in Qorus 3.1

---

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

• info-v6.0.qsd