Qorus Integration Engine®
4.1.4.p4_git
|
the main info service class More...
Inherits QorusSystemService.
Public Member Methods | |
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")) |
*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 | |
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... | |
the main info service class
|
inline |
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]
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 |
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 |
|
inline |
gets a list of job instance ids, params: jobid, condition, number of rows (100 default)
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 |
job_instanceid:
the job instance ID being queriedjobid:
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 0started:
the time the job instance was startedcompleted:
the time the job instance completed (with any status)modified:
the time the job instance was last modifiederrors:
a list of error hashes (included only if full
= True)audit:
a list of audit event hashes (included only if full
= True)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 |
|
inline |
retrieves a list of all jobs without the code field
name:
the unique name of the jobjobid:
the unique job IDdescription:
job descriptionversion:
version number of the jobsessionid:
if single_instance
is True
, then this field could be non-0, meaning that the job is currently running in that instanceactive:
True
if active, False
if notrun_skipped:
True
if the job should be executed immediately if a trigger time was missed due to down time, False
if notrecurring
]: if this field is present, this gives the number of seconds between job executions, and the cron fields will not be presentminute
]: cron field: minutes when the job can be executedhour
]: cron field: hours when the job can be executedday
]: cron field: days when the job can be executedmonth
]: cron field: months when the job can be executedwday
]: cron field: week days (0 = Sunday) when the job can be executedlast_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 jobexpiry_date
]: the date/time the job will expire; if this date is present, the job will not run automatically after this datecreated:
the date/time the job was loaded into the databasemodified:
the date/time the job was modified in the databasesingle_instance:
if True
, then this job can only be started on one Qorus instance at a timegroups:
a list of RBAC group names that this job is a member of
|
inline |
retrieves job metadata (optional params: list of job ids), returns: job info keyed by name
name:
the unique name of the jobjobid:
the unique job IDdescription:
job descriptionversion:
version number of the jobsessionid:
if single_instance
is True
, then this field could be non-0, meaning that the job is currently running in that instanceactive:
True
if active, False
if notrun_skipped:
True
if the job should be executed immediately if a trigger time was missed due to down time, False
if notcode:
the source code of the jobrecurring
]: if this field is present, this gives the number of seconds between job executions, and the cron fields will not be presentminute
]: cron field: minutes when the job can be executedhour
]: cron field: hours when the job can be executedday
]: cron field: days when the job can be executedmonth
]: cron field: months when the job can be executedwday
]: cron field: week days (0 = Sunday) when the job can be executedlast_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 jobexpiry_date
]: the date/time the job will expire; if this date is present, the job will not run automatically after this datecreated:
the date/time the job was loaded into the databasemodified:
the date/time the job was modified in the databasesingle_instance:
if True
, then this job can only be started on one Qorus instance at a timelib:
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 objectversion:
the version of the library objectid:
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 ofJOB-ACCESS-ERROR | Role Based Access Control is enabled and the user does not have access to the given job |
retrieves job metadata from the name, returns: job info keyed by name
name | the name of the job to query |
JOB-ACCESS-ERROR | Role Based Access Control is enabled and the user does not have access to the given job |
|
inlinestatic |
gets job overview, params: [date, [jobids]]: If no date is given, default = last 24 hours
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 |
jobid:
the jobid of the jobversion:
the version of the jobCOMPLETE
]: the number of job instances with status OMQ::JS_Complete in the given time frameERROR
]: the number of job instances with status OMQ::JS_Complete in the given time frameIN-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 framePARAMETER-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 |
JOB-ACCESS-ERROR
exception is raised
|
inlinestatic |
gets job overview, params: [date, [name]]: If no date is given, default = last 24 hours
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 |
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 |
JOB-ACCESS-ERROR
exception is raised
|
inline |
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
jiid | the job instance ID to query |
job_instanceid:
the job instance ID being queriedjobid:
the jobid (metadata ID)sessionid:
the application session currently running the job, otherwise 0jobstatus:
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 startedcompleted:
the time the job instance completed (with any status)modified:
the time the job instance was last modifiederrors:
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
tableseverity:
the severity of the error (see Error Severity Codes for possible values)error:
the error codedescription:
description of the errorinfo
]: any additional data saved against the errorbusiness_error:
True if the error is a business error, False if notcreated:
the date/time the error was createdaudit:
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 IDaudit_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 eventwho:
the initiator of the eventsource:
a string describing the source of the eventinfo1
]: an informational string about the eventinfo2
]: an informational string about the eventcreated:
the date/time the audit event was createdevent:
the string description corresponding to the audit_event_code
(see Audit Event Strings for possible values)JOB-ACCESS-ERROR | Role Based Access Control is enabled and the user does not have access to the given job instance ID |
|
inline |
gets a list of order instance notes
wfiid | the wfiid to query |
count | an optional "limit count |
|
inline |
retrieves method data from the service_methodid (params: service_methodid), returns: hash of method data
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 |
createdby:
hardcoded to "omq"
modifiedby:
hardcoded to "omq"
SERVICE-ACCESS-ERROR | Role Based Access Control is enabled and the user does not have access to the given service |
SERVICE-ACCESS-ERROR
exception is raised
|
inline |
retrieves method data from the service_methodid (params: service_methodid), returns: hash of method data
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 |
service_methodid:
the method ID (corresponding to the mid argument)serviceid:
the ID of the servicename:
the method namedescription:
the method descriptionlocktype:
the lock attribute for the method, see Service Method Lock Attribute Values for possible valuesinternal:
a flag where 0 = not internal, 1 = internalbody:
the method bodycreated:
the create date/time of the method recordmodified:
the modification date/time of the method recordwrite:
a flag where 0 = not write, 1 = writetags:
any service method tags; the special tag "sys"
is a hash with system tagsSERVICE-ACCESS-ERROR | Role Based Access Control is enabled and the user does not have access to the given service |
SERVICE-ACCESS-ERROR
exception is raised searches for SLA events according to the given criteria and returns a list of results
h | a hash of search criteria with the following optional keys:
|
returns a summary of step processing for the given time period and optional step ID(s)
h | a hash with the following keys:
|
|
inline |
returns a hash of event type names with lists of unposted events for each, params: event ID(s), [last modified date]
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 a hash of event type names with lists of unposted events for each, params: event type name, [last modified date]
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 |
UNKNOWN-EVENT | the event name passed is invalid |
|
inline |
Retrieves all workflow instance info (params: workflowInstanceID, [lastModifiedDate]; output hash keys: InstanceInfo, OrderInfo, StepInstances, ErrorInstances, LastModified.
workflowInstanceID | the workflow instance ID of the order |
lastModifiedDate | 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 |
InstanceInfo:
information about the workflow order; see getWFIInstanceInfo() return value for the value of this key see the OrderInfo
key alsoOrderInfo:
information about the actual order informationStepInstances:
information about steps in the current workflow orderErrorInstances:
information about errors raised against the workflow orderHierarchyInfo:
information about all parent and/or child workflows related to this workflow orderAuditEvents:
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 IDaudit_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 eventwho:
the initiator of the eventsource:
a string describing the source of the eventinfo1
]: an informational string about the eventinfo2
]: an informational string about the eventcreated:
the date/time the audit event was createdevent:
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 cacheSENSITIVE-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 |
|
inline |
Retrieves only workflow instance info (params: workflowInstanceID, [lastModifiedDate]; output hash keys: InstanceInfo, LastModified.
workflowInstanceID | the workflow instance ID of the order |
lastModifiedDate | 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 |
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 workflowInstanceID argumentworkflowid:
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 sessionparent_workflow_instanceid:
the parent workflow instance ID if this workflow is a subworkflowsynchronous:
1 for an order currently being executed synchronouslybusiness_error:
True
if the OMQ::StatError status is due to a business errorworkflowstatus_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 prioritystarted:
the date/time the workflow order was createdcompleted:
the date/time the workflow order got a OMQ::StatComplete statusmodified:
the last modified date/timearchive:
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
|
inline |
Retrieves workflow instances order info (params: workflowInstanceID, [lastModifiedDate]; output hash keys: OrderInfo, LastModified.
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 |
|
inline |
gets a list of workflow instance ids; this is the safe and preferred variant of this method
This is the preferred variant of this method, using safe SQL handling; oview uses this variant
wfids | a list of WF ids (or names) or NOTHING |
statuses | a list with requested statuses in expanded form ('ERROR') or NOTHING |
modified | a limit (>=) for MODIFIED columnn or NOTHING |
rownum | limit for max rows |
offset | the starting row |
sort | the sorting key for SQL "order by" |
wfiids | zero or more workflow_instanceids to use to filter the results |
desc | sort the results descending |
minstarted | the minstarted date |
maxstarted | the maxstarted date |
|
inline |
workflowid | a WF id or 0 |
condition | a string with any SQL condition used in WHERE clause |
rownum | limit for max rows |
|
inline |
returns order instance info from the workflow name, key, and value
workflowid
workflow_instanceid
|
inline |
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
|
inline |
gets workflow metadata (optional params: list of IDs), returns: hash of workflow metadata keyed by name and then version
workflowid:
the id of the workflowpatch:
the "patch"
value of the workflowdescription:
the description of the workflowerrorfunction_instanceid:
id of the Workflow Error Functionattach_func_instanceid:
id of the Attach Logiconetimeinit_func_instanceid:
id of the OneTimeInit Logiccreated:
the date/time the workflow was created in the DBmodified:
the date/time the workflow was last modified in the DBkeylist:
either NOTHING or a list of valid workflow order keyssteps:
a list of step hashes defining the steps in the workflow; each step hash will have the following keys:stepid:
the stepid of the stepsteptype:
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 stepversion:
version of the steppatch
]: the "patch"
value of the stepdescription:
description of the stepstepfunction_instanceid:
id of the Primary Step Functionvalidationfunction_instanceid
]: id of the Validation Step Functionendfunction_instanceid
]: id of the Asynchronous Back-End Step Function for asynchronous stepsarrayfunction_instanceid
]: id of the Array Function for array stepsqueueid
]: id of the asynchronous queue for asynchronous stepscreated:
the date/time the step was created in the DBmodified:
the date/time the step was last modified in the DBevent
]: a hash of event information (present if the steptype = OMQ::ExecEvent):name:
name of the event typedesc:
description of the event typetypeid:
the event type IDstep_dependencies:
a list of hashes of step dependencies with the following keys:stepid:
the stepid of the stepdependson_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 segmentdependson_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 stepdependson_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 descriptionslib:
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 objectversion:
the version of the library objectid:
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 ofWORKFLOW-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 |
WORKFLOW-ACCESS-ERROR
exception is raised 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
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 |
WORKFLOW-ACCESS-ERROR
exception is raised 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)
name | the name of the workflow |
ver | the optional version of the workflow to return |
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 |
WORKFLOW-ACCESS-ERROR
exception is raised
|
inlinestatic |
gets workflow overview, params: [date, [workflowids]]: If no date is given, default = last 24 hours
PARAMETER-ERROR | the date passed was not valid |
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 |
|
inlinestatic |
gets workflow overview, params: [date, [name, [version]]]: If no date is given, default = last 24 hours
PARAMETER-ERROR | the date passed was not valid |
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 a summary of workflow processing for the given time period and optional workflow ID(s)
h | a hash with the following keys:
|
|
inlinestatic |
returns workflow instance status from workflow_instanceid: COMPAT VERSION with fake flow and flow_instance information (removed in Qorus v2); use getWorkflowStatus2() instead
id | the workflow_instanceid |
|
inlinestatic |
returns workflow order data instance status from the workflow_instanceid
This method will retrieve information directly from the internal server cache if possible, otherwise data is retrieved from the database
wfiid | the workflow_instanceid |
name:
the name of the workflow (metadata)version:
the version of the workflow (metadata)workflow_instanceid:
the instance id of the workflow order data instanceworkflowstatus:
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 instancestarted:
the date/time the workflow order data instance was originally createdcompleted:
the date/time the workflow order data instance received status OMQ::StatCompletecustom_status:
the custom status for the workflow order data instance, if anycustom_status_desc:
the description for the custom status for the workflow order data instance, if anyscheduled:
the date/time the order is scheduled for future execution, if anypriority:
the priority of the ordersegment_instance:
a list of hashes for each segment with the following keys:segmentid:
the segment IDsegmentstatus:
the status of the segment (see Workflow, Segment, and Step Status Descriptions for possible values)created:
date/time the segment was createdmodified:
date/time the segment was last modifiedsteps:
a list of stepids in the segmentstep_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 DBcompleted:
date/time the step got status OMQ::StatCompletecustom_status:
the custom status for the step, if anycustom_status_desc:
the description for the custom status for the step, if anyevent
]: only present for event steps; if present, this will be a hash with the following keys:name:
the event type namedesc:
the event type descriptiontypeid:
the event type idkey
]: if not an arraystep, the event key will be present heresubworkflow_instanceid
]: only present for subworkflow steps: the workflow_instanceid of the subworkflow bound to the stepsubworkflowstatus
]: only present for subworkflow steps: the status of the subworkflow instance bound to the stepsubsteps
]: 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 structureind:
the step index numberstepstatus:
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 DBcompleted:
date/time the step got status OMQ::StatCompleteeventkey:
the eventkey bound to the step, if anycustom_status:
the custom status for the step, if anycustom_status_desc:
the description for the custom status for the step, if anyerrors:
a list of hashes with the following keys for errors raised while processing the workflow order data instancestepid:
the stepid of the step that created the errorind:
the index of the stepseverity:
severity of the error: Error Severity Codeserror:
the error codedescription:
description of the errorinfo:
information about the errorbusiness_error:
True if the error is a business error, False if notcreated:
the date/time the error was raisedworkflow_instanceid:
the same as the workflow_instanceid of the parent data structure 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 |
|
inlinestatic |
gets system overview, params: [date]: If no date is given, default = last 24 hours
PARAMETER-ERROR | the date passed was not valid |
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 workflow synchronization event information
h | a hash with the following optional keys:
|
returns a list of workflow instance info matching the input criteria
params | a hash with one or more of the following keys:
|
workflow_instanceid:
the workflow order instance IDworkflowid:
the workflow IDname:
the name of the workflowversion:
the version of the workflowworkflowstatus:
the status of the workflow order instancestarted:
the start date/time of the workflow order instancecompleted:
the completed date/time for the workflow order instancemodified:
the last modified date/time of the workflow order instancesynchronous:
the synchronous flag for the workflow order instancebusiness_error:
the business error flag for the workflow order instancearchive:
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 datanote_count:
the number of notes attached to the workflow order instancewarning_count:
the warning count of the workflow order instanceerror_count:
the error count of the workflow order instancecustom_status:
any custom status for the workflow order instancepriority:
the priority of the workflow order instancescheduled:
the scheduled date for the workflow order instancekeyname:
the order key namevalue:
the order key valuecreated:
the date/time the order key was createdSEARCH-ORDER-KEYS-ERROR | thrown if the orderkeys options and one of both of the keyname or value options are used in the same call |
orderkeys
and workflowname
options returns release info
params | search parameters with the following optional keys:
|
returns information about application sessions
params | search parameters with the following optional keys:
|
searches for SLA events according to the given criteria and returns a list of results
h | a hash of search criteria with the following optional keys:
|
|
inline |
returns a list of matching errors for the input criteria
h | a hash with the following keys:
|
name:
the workflow nameversion:
the workflow versionworkflow_instanceid:
the workflow order instance IDworkflowid:
the workflow IDstepid:
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 instancestarted:
the start date/time of the workflow order instancecompleted:
the completed date/time for the workflow order instanceparent_workflow_instanceid:
the parent workflow_instanceid if the workflow is a child workflow ordercustom_status:
any custom status for the workflow order instancepriority:
the priority of the workflow order instancescheduled:
the scheduled date for the workflow order instanceerror_instanceid:
the error IDerror:
the error namedescription:
the error descriptioninfo:
the error info stringseverity:
the severity of the errorcreated:
the created date and time of the errorretry:
indicates if the error will get a retry statusbusiness_error:
indicates if the error is a business errorarchive:
if retrieved from the archive datasource searches for workflow order instances according to a hash
h | a hash of search parameters with the following keys (all are optional):
|
name:
the name of the workflowversion:
the version of the workflowworkflow_instanceid:
the workflow order instance IDworkflowid:
the workflow IDworkflowstatus:
the status of the workflow order instancestatus_sessionid:
the application session ID that owns the workflow order instance data or 0 if the data is now owned by any application sessionstarted:
the start date/time of the workflow order instancecompleted:
the completed date/time for the workflow order instancemodified:
the last modified date/time of the workflow order instanceparent_workflow_instanceid:
the parent workflow_instanceid if the workflow is a child workflow ordersynchronous:
the synchronous flag for the workflow order instancebusiness_error:
the business error flag for the workflow order instancearchive:
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 datanote_count:
the number of notes attached to the workflow order instancewarning_count:
the warning count of the workflow order instanceerror_count:
the error count of the workflow order instancecustom_status:
any custom status for the workflow order instancepriority:
the priority of the workflow order instancescheduled:
the scheduled date for the workflow order instancearchive:
if retrieved from the archive datasource