![]() |
Qorus Integration Engine® Enterprise Edition 6.0.27_prod
|
user API namespace root More...
Namespaces | |
namespace | Job |
main job API namespace | |
namespace | Service |
Qorus service API namespace. | |
namespace | Workflow |
main workflow API namespace | |
Classes | |
class | QorusConfigurationItemProvider |
Base class for object providing configuration items. More... | |
class | QorusRestartableTransaction |
Class that allows for managing restartable transactions. More... | |
class | UserApi |
main common Qorus API class More... | |
Functions | |
*string | restart_transaction (string driver, hash< auto > ex) |
returns a string error message if any exception in the chain passed was caused by a recoverable DB error More... | |
bool | duplicate_key (string driver, hash< auto > ex) |
Returns True if the error was caused by a duplicate key error. More... | |
deprecated *hash< auto > | get_user_service_info (string name) |
returns information about the given user service (if it's currently loaded) More... | |
deprecated SqlUtil::AbstractTable | get_sql_table (string datasource, string table_name) |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch More... | |
deprecated SqlUtil::AbstractTable | get_sql_table (AbstractDatasource datasource, string table_name) |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch More... | |
deprecated hash< auto > | get_sql_cache_info () |
get information about cached object More... | |
deprecated | clear_sql_table_cache (string datasource, *string table_name) |
clears all objects for given datasource from the cache (for example, if database objects have been updated in the dataserver) More... | |
deprecated | clear_sql_table_cache (AbstractDatasource datasource, *string table_name) |
clears cached objects for given datasource (for example, if database objects have been updated in the dataserver) More... | |
deprecated auto | get_value_map (string mapname, string key) |
Gets a lookup value from the value map by a key; the value map must be registered to the current interface. More... | |
deprecated list | get_value_maps () |
Gets all value maps valid for the current interface. More... | |
deprecated bool | post_sla_event_success (string sla, number value) |
posts a successful SLA event for SLA monitoring and performance tracking More... | |
deprecated bool | post_sla_event_error (string sla, number value, string err, string desc) |
posts an unsuccessful SLA event for SLA monitoring and performance tracking More... | |
deprecated | flush_sla_events () |
flushes all pending SLA events to disk and returns after the data has been committed More... | |
deprecated *hash | get_system_service_info (string name) |
returns information about the given system service (if it's currently loaded) More... | |
deprecated *hash< auto > | get_service_info (string type, string name) |
returns information about the given service (if it's currently loaded) More... | |
deprecated list< auto > | get_running_workflow_list (*string name, *string ver) |
returns a list of hashes giving information about the currently-running workflow execution instances More... | |
deprecated hash< auto > | get_running_workflow_info (softint id) |
returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not More... | |
deprecated softstring | create_order (string name, *string version, hash params, string status=StatReady) |
creates a workflow order data instance in the database More... | |
deprecated softstring | create_remote_order (string remote, string name, *string version, hash params, string status=StatReady, bool register_dependency=True) |
creates a workflow order data instance in a remote Qorus instance More... | |
deprecated hash< auto > | exec_synchronous_workflow (string name, *string version, hash< auto > sdata, *hash< auto > opts, *hash< auto > ddata, softint priority=DefaultOrderPriority, *hash< auto > orderkeys, *softstring external_order_instanceid, *softint parent_workflow_instanceid) |
executes a workflow order synchronously and returns the final status and order ID in a hash More... | |
deprecated int | post_user_event (string severity, auto info) |
posts an application event of class QE_CLASS_USER More... | |
deprecated hash | runtime_properties () |
returns Qorus runtime properties as a hash More... | |
deprecated auto | call_network_api_args_with_authentication (string user, string pass, string call, softlist args) |
calls a system RPC API with authentication information (username and password) More... | |
deprecated auto | call_network_api_args (string call, softlist args) |
calls a system RPC API with the argument list to the API method as a top-level argument to this function; the API is called with system permissions (no restrictions) More... | |
deprecated auto | call_network_api (string call) |
calls a system RPC API and returns the result; the API is called with system permissions (no restrictions) More... | |
deprecated auto | call_rest_api (string method, string path, *hash< auto > body_args) |
calls a system REST API method and returns the result; the API is called with system permissions (no restrictions) More... | |
deprecated auto | call_rest_api_with_authentication (string user, string pass, string method, string path, *hash body_args) |
calls a system REST API method with authentication information (username and password) and returns the result More... | |
deprecated hash< auto > | get_system_info () |
returns a hash of system info More... | |
deprecated int | get_session_id () |
returns the current Qorus application session ID More... | |
deprecated | log (softint lvl, softstring msg) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the log level passed is equal to or lower than value of the system option qorus.verbose. More... | |
deprecated *int | audit_user_event (string user_event, *string info1, *string info2) |
creates a user audit event (with audit event code AE_USER_EVENT) against the workflow, service, or job instance More... | |
deprecated bool | audit_check_event_string (string opt) |
checks if the given audit event (given as a string) is enabled More... | |
deprecated bool | audit_check_event (softint opt) |
checks if the given audit event (given as an integer code) is enabled More... | |
deprecated int | audit_get_mask () |
returns the audit event mask More... | |
deprecated int | omqsleep (softint arg) |
puts the current thread to sleep for a certain number of seconds More... | |
deprecated int | omqusleep (softint arg) |
puts the current thread to sleep for a certain number of microseconds More... | |
deprecated auto | get_qorus_options () |
returns the value of the given system option or options More... | |
deprecated hash< auto > | get_qorus_option_info () |
returns a hash giving information about system options More... | |
deprecated auto | get_qorus_options_args (softlist args) |
returns the value of the given system option or options More... | |
deprecated hash< auto > | get_qorus_option_info_args (softlist args) |
returns a hash giving information about system options More... | |
deprecated hash< auto > | get_active_jobs () |
Returns information on all active jobs visible to the calling user. More... | |
deprecated object | get_user_connection (string name, bool connect=True, bool register_dependency=True, *hash< auto > rtopts) |
Returns an object corresponding to a defined user connection. More... | |
deprecated Qore::SQL::Datasource | get_datasource_shared (string name, bool register_dependency=True) |
Returns a shared Datasource object with autocommit turned on from the given datasource name. More... | |
deprecated Qore::SQL::Datasource | get_datasource_dedicated (string name, bool register_dependency=True) |
returns a new, dedicated Datasource object, suitable for transaction management for long-running transactions More... | |
deprecated AbstractDatasource | get_datasource_pool (string name, bool register_dependency=True) |
returns a DatasourcePool object for the given datasource name More... | |
deprecated hash< auto > | get_datasource_info (string name) |
returns a hash of information for the given datasource, if known, otherwise throws an exception More... | |
deprecated QorusSystemAPIHelper | get_remote_rpc_connection (string name, bool connect=True, bool register_dependency=True) |
Returns a new QorusSystemAPIHelper object corresponding to a defined Qorus remote connection. More... | |
deprecated QorusSystemRestHelper | get_remote_rest_connection (string name, bool connect=True, bool register_dependency=True) |
Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection. More... | |
deprecated | raise_transient_alert (string alert, string reason, *hash info) |
raises a transient system alert from a workflow, service, or job More... | |
deprecated string | qorus_get_local_url (*string username, *string password) |
returns a string giving the local system URL More... | |
deprecated | set_option (hash< auto > hash) |
Changes option values on a workflow, service, or job. More... | |
deprecated auto | get_option () |
Returns the value of the named workflow, service, or job option or options. More... | |
deprecated hash< auto > | block_order (softint wfiid) |
block the given workflow order data instance More... | |
deprecated hash< auto > | unblock_order (softint wfiid, *hash< auto > tempdata, *hash< auto > orderkeys) |
unblocks the given workflow order data instance More... | |
deprecated hash< auto > | cancel_order (softint wfiid) |
cancel the given workflow order data instance More... | |
deprecated hash< auto > | uncancel_order (softint wfiid, *hash< auto > tempdata) |
uncancels the given workflow order data instance More... | |
deprecated *hash< auto > | get_user_context_info () |
returns a hash for the current user context More... | |
deprecated auto | get_global_config_item_value (string item) |
returns the value of the given global configuration item; throws an exception if no such global configuration item exists More... | |
deprecated auto | get_global_config_item_value_with_default (string item, auto default_value) |
returns the value of the given global configuration item; throws an exception if no such global configuration item exists More... | |
deprecated Mapper::Mapper | get_mapper (string name, *hash< auto > rtopts) |
returns the given mapper if registered for the current interface More... | |
deprecated Qore::AbstractIterator | get_mapper_iterator (string name, Qore::AbstractIterator input, *hash rtopts) |
returns an iterator for the named mapper using the iterator argument for input More... | |
deprecated bool | post_sync_event (string eventtype, string eventkey) |
posts a workflow synchronization event given the event type name and the unique event key More... | |
deprecated hash< auto > | prop_get () |
returns a hash of all system properties in all domains More... | |
deprecated *hash< auto > | prop_get (string domain) |
returns a hash of all key-value pairs in the given domain or NOTHING if the system property domain does not exist More... | |
deprecated auto | prop_get (string domain, string key) |
returns the value of the given system property key in the given domain or NOTHING if the system property does not exist More... | |
deprecated string | prop_update (string domain, softstring key, auto value) |
changes (inserts, updates, or deletes) the value of a single system property More... | |
deprecated hash< auto > | prop_update (hash< auto > h) |
changes (inserts, updates, or deletes) the value of one or more system properties according to a hash argument More... | |
deprecated any | getOption () |
deprecated | setOption (hash hash) |
*hash | getSystemServiceInfo (string name) |
*hash | getUserServiceInfo (string name) |
list | getRunningWorkflowList () |
hash | getRunningWorkflowInfo (softint id) |
softstring | createOrder (string name, *string version, hash params, string status=StatReady) |
hash | runtimeProperties () |
hash | execSynchronousWorkflow (string name, *string version, hash sdata, *hash opts, *hash ddata, softint priority=DefaultOrderPriority, *hash orderkeys, *softstring external_order_instanceid, *softint parent_workflow_instanceid) |
any | callNetworkAPIArgsWithAuthentication (string user, string pass, string call, softlist args) |
any | callNetworkAPIArgs (string call, softlist args) |
any | callNetworkAPI (string call, softlist args) |
hash | getSystemInfo () |
int | getSessionID () |
list< auto > | remove_from_list (list< auto > list, auto val) |
uses the select operator to remove all occurences of a value from a list More... | |
list< auto > | remove_from_list (reference list, auto val) |
uses the select operator to remove all occurences of a value from a list More... | |
string | xml_change_encoding (string xml, string enc) |
returns a string with the XML encoding name changed to that given as an argument More... | |
string | xml_get_encoding (string xml) |
returns the XML encoding name given in the string (not the actual string encoding, which may be different) More... | |
string | serialize_qorus_data (auto d) |
returns a string giving the default serialization of the given data structure for storage in Qorus More... | |
auto | deserialize_qorus_data (string data) |
parses serialized data in either XML-RPC or YAML format and returns the corresponding qore data More... | |
string | get_salted_string (string str, binary salt) |
returns a string that has been x-ored with binary "salt" data | |
softint | next_sequence_value (AbstractDatasource ds, string name) |
returns the next sequence value for the given sequence | |
string | get_ds_desc (hash< auto > h, *int dd_opts) |
returns a datasource description string from a datasource configuration hash More... | |
list< hash< CallStackInfo > > | get_thread_call_stack () |
allows Qore::get_thread_call_stack() to be called from Qorus interfaces More... | |
deprecated auto | getOracleNumber (auto v) |
returns a string suitable for dynamic SQL More... | |
deprecated auto | getSQLNumber (auto v) |
returns a string suitable for dynamic SQL More... | |
deprecated auto | get_sql_number (auto v) |
returns either the value returned or the string "NULL" if the type cannot be converted to a number More... | |
deprecated string | getOracleString (auto v, int size=0) |
returns a string suitable for dynamic SQL More... | |
deprecated string | getSQLString (auto v, int size=0) |
returns a string suitable for dynamic SQL More... | |
deprecated string | get_sql_string (auto v, int size=0) |
returns a singly-quoted string aimed to be directly usable in dynamic SQL queries with single quote (\') characters escaped or returns the string "NULL" if the argument type is not int, float, bool, or string More... | |
deprecated string | fix_quotes (string str) |
doubles single quotes (\') in strings and returns the new string More... | |
deprecated string | fix_quotes (reference str) |
doubles single quotes (\') in strings and returns the new string More... | |
deprecated string | make_select_list (auto list) |
returns a string based on a list, processed for the values in the list to be used in an SQL string with an Oracle DB More... | |
deprecated string | make_select_list2 (auto driver, auto list) |
returns a string based on a list, processed for the values in the list to be used in a dynamic SQL string More... | |
deprecated list< auto > | remove_from_list_index (list< auto > list, int index) |
remove an element from a list More... | |
deprecated string | oracle_date (date date) |
returns a string from a date suitable for use in a dynamic oracle SQL string More... | |
deprecated string | db_date (string driver, date date) |
returns a string from a date suitable for use in a dynamic SQL string depending on the driver More... | |
deprecated string | create_sql_string () |
returns a string suitable for use in a dyanamic Oracle SQL query string based on the arguments passed More... | |
deprecated string | create_sql_string2 (auto driver) |
returns a string suitable for use in a dynamic SQL query string (driver-dependent) based on the arguments passed More... | |
deprecated bool | parseBoolean (auto v) |
deprecated string | get_exception_string (hash< auto > ex) |
deprecated int | compareVersion (string lv, string rv) |
Variables | |
public const | DD_WITH_PASSWORD = 1 << 0 |
includes the password in the return value More... | |
public const | DD_SHORT = 1 << 1 |
does not include character encoding and options in the return value | |
user API namespace root
deprecated bool OMQ::UserApi::audit_check_event | ( | softint | opt | ) |
checks if the given audit event (given as an integer code) is enabled
opt | the audit event code to check; see Audit Event Codes for possible values |
deprecated bool OMQ::UserApi::audit_check_event_string | ( | string | opt | ) |
checks if the given audit event (given as a string) is enabled
opt | the audit event code to check; see Audit Event Strings for possible values |
AUDIT-EVENT-ERROR | the given audit event string does not exist |
deprecated int OMQ::UserApi::audit_get_mask | ( | ) |
returns the audit event mask
deprecated *int OMQ::UserApi::audit_user_event | ( | string | user_event, |
*string | info1, | ||
*string | info2 | ||
) |
creates a user audit event (with audit event code AE_USER_EVENT) against the workflow, service, or job instance
user_event | the user event code string |
info1 | optional informational string for the AUDIT_EVENTS.INFO1 field |
info2 | optional informational string for the AUDIT_EVENTS.INFO2 field |
AUDIT_EVENTS
table if the qorus.audit system option does not include the "user-events"
(AO_USER_EVENTS) option; in case this is not set, the call will have no effectdeprecated hash< auto > OMQ::UserApi::block_order | ( | softint | wfiid | ) |
block the given workflow order data instance
wfiid | the workflow order instance ID to block |
workflow_status:
the status of the workflow orderAn exception will be thrown if the status is OMQ::StatInProgress
BLOCK-WORKFLOW-ERROR | invalid status, foreign session id, missing original status, uncancel operation already in progress |
deprecated auto OMQ::UserApi::call_network_api | ( | string | call | ) |
calls a system RPC API and returns the result; the API is called with system permissions (no restrictions)
include any arguments after the method name, ex:
call | the full RPC API method name (ex: "omq.system.exec-synchronous-exiting" ); see Network System API for a full list |
UNKNOWN-API-CALL | invalid API method |
INVALID-INTERNAL-API-CALL | API may not be called internally (ex: omq.system.shutdown-wait()) |
deprecated auto OMQ::UserApi::call_network_api_args | ( | string | call, |
softlist | args | ||
) |
calls a system RPC API with the argument list to the API method as a top-level argument to this function; the API is called with system permissions (no restrictions)
call | the full RPC API method name (ex: "omq.system.exec-synchronous-exiting" ); see Network System API for a full list |
args | any arguments to the method; if multiple argument should be passed to the method, use a list of arguments here |
UNKNOWN-API-CALL | invalid API method |
INVALID-INTERNAL-API-CALL | API may not be called internally (ex: omq.system.shutdown-wait()) |
deprecated auto OMQ::UserApi::call_network_api_args_with_authentication | ( | string | user, |
string | pass, | ||
string | call, | ||
softlist | args | ||
) |
calls a system RPC API with authentication information (username and password)
user | the username to use for the call |
pass | the password to use for the call |
call | the full RPC API method name (ex: "omq.system.exec-synchronous-exiting" ); see Network System API for a full list |
args | any arguments to the method; if multiple argument should be passed to the method, use a list of arguments here |
UNKNOWN-API-CALL | invalid API method |
INVALID-INTERNAL-API-CALL | API may not be called internally (ex: omq.system.shutdown-wait()) |
deprecated auto OMQ::UserApi::call_rest_api | ( | string | method, |
string | path, | ||
*hash< auto > | body_args | ||
) |
calls a system REST API method and returns the result; the API is called with system permissions (no restrictions)
method | the HTTP method name in all caps |
path | the URI path without the leading "api" ; if it does not begin with "latest" or "v#" (for a REST API version), then "/latest/" is prepended ot the path, meaning that the latest version of the REST API will be used |
body_args | the arguments to the call |
path
begins with "/api"
deprecated auto OMQ::UserApi::call_rest_api_with_authentication | ( | string | user, |
string | pass, | ||
string | method, | ||
string | path, | ||
*hash | body_args | ||
) |
calls a system REST API method with authentication information (username and password) and returns the result
user | the username to use for the call |
pass | the password to use for the call |
method | the HTTP method name in all caps |
path | the URI path without the leading "api" ; if it does not begin with "latest" or "v#" (for a REST API version), then "/latest/" is prepended ot the path, meaning that the latest version of the REST API will be used |
body_args | the arguments to the call |
path
begins with "/api"
any OMQ::UserApi::callNetworkAPI | ( | string | call, |
softlist | args | ||
) |
any OMQ::UserApi::callNetworkAPIArgs | ( | string | call, |
softlist | args | ||
) |
any OMQ::UserApi::callNetworkAPIArgsWithAuthentication | ( | string | user, |
string | pass, | ||
string | call, | ||
softlist | args | ||
) |
deprecated hash< auto > OMQ::UserApi::cancel_order | ( | softint | wfiid | ) |
cancel the given workflow order data instance
wfiid | the workflow order instance ID to cancel |
workflow_status:
the status of the workflow orderAn exception will be thrown if the status is OMQ::StatInProgress
CANCEL-WORKFLOW-ERROR | invalid status, foreign session id, missing original status, uncancel operation already in progress |
deprecated OMQ::UserApi::clear_sql_table_cache | ( | AbstractDatasource | datasource, |
*string | table_name | ||
) |
clears cached objects for given datasource (for example, if database objects have been updated in the dataserver)
datasource | a DatasourcePool object for a Qorus datasource; note that if the Qore::SQL::DatasourcePool object cannot be matched back to a known Qorus datasource, an INVALID-DATASOURCE exception will be thrown |
table_name | an optional table name to clear; if not present, then all objects in the given datasource are cleared |
INVALID-DATASOURCE | this exception is thrown if the datasource argument cannot be matched to a known Qorus datasource |
deprecated OMQ::UserApi::clear_sql_table_cache | ( | string | datasource, |
*string | table_name | ||
) |
clears all objects for given datasource from the cache (for example, if database objects have been updated in the dataserver)
datasource | the name of a Qorus datasource |
table_name | an optional table name to clear; if not present, then all objects in the given datasource are cleared |
deprecated int OMQ::UserApi::compareVersion | ( | string | lv, |
string | rv | ||
) |
deprecated softstring OMQ::UserApi::create_order | ( | string | name, |
*string | version, | ||
hash | params, | ||
string | status = StatReady |
||
) |
creates a workflow order data instance in the database
Creates a workflow order data instance of the specified type with the data passed.
To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:
global_unique_key
workflow_specific_unique_key
workflow_unique_key
name | the name of the workflow |
version | the version of the workflow; if this parameter is not passed, then the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used |
params | The hash passed must have at either a staticdata key or an external_order_instanceid key, valid keys:
|
status | create the workflow order data instance with this status; may be either:
|
SUBMIT-ORDER-ERROR | invalid status value |
ORDER-DATA-ERROR | missing either external_order_instanceid or staticdata , unknown workflow; invalid keys or sensitive data format |
DUPLICATE-ORDER-KEY | the given unique key already exists in the defined scope |
WORKFLOW-KEY-ERROR | invalid workflow key given |
staticdata
or external_order_instanceid
values must be provided; staticdata
may be omitted if external_order_instanceid
is provided and vice-versaglobal_unique_key
, workflow_specific_unique_key
, and workflow_unique_key
options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.tempdata
key in the params argumentglobal_unique_key
sensitive_data
workflow_specific_unique_key
workflow_unique_key
deprecated softstring OMQ::UserApi::create_remote_order | ( | string | remote, |
string | name, | ||
*string | version, | ||
hash | params, | ||
string | status = StatReady , |
||
bool | register_dependency = True |
||
) |
creates a workflow order data instance in a remote Qorus instance
Creates a workflow order data instance of the specified type with the data passed in the specified remote Qorus instance.
To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:
global_unique_key
workflow_specific_unique_key
workflow_unique_key
remote | the name of the remote Qorus connection |
name | the name of the workflow |
version | the version of the workflow; if this parameter is not passed, then the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used |
params | The hash passed must have at either a staticdata key or an external_order_instanceid key, valid keys:
|
status | create the workflow order data instance with this status; may be either:
|
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
GET-REMOTE-ERROR | The given connection is not known |
SUBMIT-ORDER-ERROR | invalid status value |
WORKFLOW-ERROR | unknown or invalid workflow |
ORDER-DATA-ERROR | missing either external_order_instanceid or staticdata , invalid keys or sensitive data format |
DUPLICATE-ORDER-KEY | the given unique key already exists in the defined scope |
WORKFLOW-KEY-ERROR | invalid workflow key given |
staticdata
or external_order_instanceid
values must be provided; staticdata
may be omitted if external_order_instanceid
is provided and vice-versaglobal_unique_key
, workflow_specific_unique_key
, and workflow_unique_key
options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.deprecated string OMQ::UserApi::create_sql_string | ( | ) |
returns a string suitable for use in a dyanamic Oracle SQL query string based on the arguments passed
deprecated string OMQ::UserApi::create_sql_string2 | ( | auto | driver | ) |
returns a string suitable for use in a dynamic SQL query string (driver-dependent) based on the arguments passed
softstring OMQ::UserApi::createOrder | ( | string | name, |
*string | version, | ||
hash | params, | ||
string | status = StatReady |
||
) |
deprecated string OMQ::UserApi::db_date | ( | string | driver, |
date | date | ||
) |
returns a string from a date suitable for use in a dynamic SQL string depending on the driver
bool OMQ::UserApi::duplicate_key | ( | string | driver, |
hash< auto > | ex | ||
) |
Returns True if the error was caused by a duplicate key error.
deprecated hash< auto > OMQ::UserApi::exec_synchronous_workflow | ( | string | name, |
*string | version, | ||
hash< auto > | sdata, | ||
*hash< auto > | opts, | ||
*hash< auto > | ddata, | ||
softint | priority = DefaultOrderPriority , |
||
*hash< auto > | orderkeys, | ||
*softstring | external_order_instanceid, | ||
*softint | parent_workflow_instanceid | ||
) |
executes a workflow order synchronously and returns the final status and order ID in a hash
name | the workflow name |
version | the workflow version (if NOTHING then the latest version of the workflow will be used) |
sdata | the static data hash for the workflow order |
opts | the options for the synchronous workflow execution instance |
ddata | the optional initial dynamic data hash for the workflow order |
priority | the order priority for the order |
orderkeys | optional order keys for the order |
external_order_instanceid | the optional external order instanceid for the order |
parent_workflow_instanceid | an optional loosely-coupled workflow order ID that will be marked as the parent of this order; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to False |
workflow_instanceid:
the workflow order instance IDstatus
the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)hash OMQ::UserApi::execSynchronousWorkflow | ( | string | name, |
*string | version, | ||
hash | sdata, | ||
*hash | opts, | ||
*hash | ddata, | ||
softint | priority = DefaultOrderPriority , |
||
*hash | orderkeys, | ||
*softstring | external_order_instanceid, | ||
*softint | parent_workflow_instanceid | ||
) |
deprecated string OMQ::UserApi::fix_quotes | ( | reference | str | ) |
doubles single quotes (\') in strings and returns the new string
deprecated string OMQ::UserApi::fix_quotes | ( | string | str | ) |
doubles single quotes (\') in strings and returns the new string
deprecated OMQ::UserApi::flush_sla_events | ( | ) |
flushes all pending SLA events to disk and returns after the data has been committed
deprecated hash< auto > OMQ::UserApi::get_active_jobs | ( | ) |
Returns information on all active jobs visible to the calling user.
If any active jobs are not accessible to the calling user, then they are filtered from the hash returned.
jobid:
the metadata jobid of the job typename:
the job nameversion:
the job versiondescription:
the job descriptiontrigger:
a string describing the timer/trigger for the jobjob_instanceid
]: the id of the job instance (will only have a value if the job is currently executing)last_executed
]: the last executed date/time of the job (NOTHING if not yet executed)last_executed_job_instanceid
]: the last executed instance id of the jobexpiry_date
]: the expiry date of the job, if any; if this date is present, then the job will not run automatically after this datenext
]: the next trigger date/time; this key is only included if the job is activeactive:
this value is always True
because this API only returns information about active jobsdeprecated Qore::SQL::Datasource OMQ::UserApi::get_datasource_dedicated | ( | string | name, |
bool | register_dependency = True |
||
) |
returns a new, dedicated Datasource object, suitable for transaction management for long-running transactions
name | the name of the datasource |
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
DATASOURCE-ERROR | The given connection is not known or is a system datasource |
deprecated hash< auto > OMQ::UserApi::get_datasource_info | ( | string | name | ) |
returns a hash of information for the given datasource, if known, otherwise throws an exception
name | the name of the datasource |
name
(string): the name of the datasource connection (corresponding to the argument name)type
(string): datasource
constanturl
(string): a connection stringurl_hash
(hash): parsed connection string and optionstype
(string): driver nameuser
(string): the username for the datasource connection, if anypass
(string): the password for the datasource connection, if anycharset
(string): the DB-specific character encoding for the datasource connectiondb
(string): The database name of the datasource connectionoptions
(hash): an optional hash of options for the DBI driver for this datasource connection; also "min"
and "max"
for the DatasourcePool minimum and maximum optionslocked
(bool): a flag indicating if the datasource is locked or not (the system datasource "omq"
is locked)up
(bool): a flag indicating if monitoring has discovered if the datasource is up or notdesc
(string): a string description of the datasourcemonitor
(bool): a flag indicating if the datasource is monitored or notstatus
(string): "OK"
if the datasource is up or an error string if the datasource is down; set by monitoringlast_check
(date/time): the date and time of the last monitoring checkshared_pool
(string): a string giving the pool state (only present if a pool has been initialized on the datasource)deps
(list): a list of hashes giving interface objects that depend on the connection; each entry is a hash with the following keys:type:
"WORKFLOW"
, "SERVICE"
, or "JOB"
workflowid:
for workflows, gives the workflow IDserviceid:
for services, gives the service IDjobid:
for jobs, gives the job IDname:
the name of the workflow, service, or jobversion:
the version of the workflow, service, or jobdesc:
a string description of the objectDATASOURCE-ERROR | unknown datasource |
deprecated AbstractDatasource OMQ::UserApi::get_datasource_pool | ( | string | name, |
bool | register_dependency = True |
||
) |
returns a DatasourcePool object for the given datasource name
name | the name of the datasource |
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
DATASOURCE-ERROR | unknown or system datasource |
deprecated Qore::SQL::Datasource OMQ::UserApi::get_datasource_shared | ( | string | name, |
bool | register_dependency = True |
||
) |
Returns a shared Datasource object with autocommit turned on from the given datasource name.
name | the name of the datasource |
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
DATASOURCE-ERROR | The given connection is not known or is a system datasource |
deprecated string OMQ::UserApi::get_exception_string | ( | hash< auto > | ex | ) |
deprecated auto OMQ::UserApi::get_global_config_item_value | ( | string | item | ) |
returns the value of the given global configuration item; throws an exception if no such global configuration item exists
item | the name of the global configuration item to retrieve |
CONFIG-ITEM-ERROR | thrown if the configuration item is not valid |
"$"
characters with a backslash ("\"
) to avoid template substitutiondeprecated auto OMQ::UserApi::get_global_config_item_value_with_default | ( | string | item, |
auto | default_value | ||
) |
returns the value of the given global configuration item; throws an exception if no such global configuration item exists
item | the name of the global configuration item to retrieve |
default_value | the value to be returned if the value is not set |
"$"
characters with a backslash ("\"
) to avoid template substitutiondeprecated Mapper::Mapper OMQ::UserApi::get_mapper | ( | string | name, |
*hash< auto > | rtopts | ||
) |
returns the given mapper if registered for the current interface
name | the name of the mapper |
rtopts | any runtime options accepted by the mapper |
MAPPER-ERROR | the given mapper is unknown or not registered to the current interface |
deprecated Qore::AbstractIterator OMQ::UserApi::get_mapper_iterator | ( | string | name, |
Qore::AbstractIterator | input, | ||
*hash | rtopts | ||
) |
returns an iterator for the named mapper using the iterator argument for input
name | the name of the mapper |
input | an iterator providing the input for the mapper for the iterator returned; the input iterator must iterate hashes (as returned by the Qore::AbstractIterator::getValue() method) |
rtopts | any runtime options accepted by the mapper |
MAPPER-ERROR | unknown mapper or not registered to the current interface |
deprecated auto OMQ::UserApi::get_option | ( | ) |
Returns the value of the named workflow, service, or job option or options.
If the option is not set on the workflow, service, or job level (depending on the calling context) and it is a valid system option, then the value of the system option will be returned.
deprecated hash< auto > OMQ::UserApi::get_qorus_option_info | ( | ) |
returns a hash giving information about system options
deprecated hash< auto > OMQ::UserApi::get_qorus_option_info_args | ( | softlist | args | ) |
returns a hash giving information about system options
deprecated auto OMQ::UserApi::get_qorus_options | ( | ) |
returns the value of the given system option or options
deprecated auto OMQ::UserApi::get_qorus_options_args | ( | softlist | args | ) |
returns the value of the given system option or options
deprecated QorusSystemRestHelper OMQ::UserApi::get_remote_rest_connection | ( | string | name, |
bool | connect = True , |
||
bool | register_dependency = True |
||
) |
Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection.
name | the name of the remote connection |
connect | if False an unconnected object will be returned, otherwise the object is already connected |
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
GET-REMOTE-ERROR | The given connection is not known |
deprecated QorusSystemAPIHelper OMQ::UserApi::get_remote_rpc_connection | ( | string | name, |
bool | connect = True , |
||
bool | register_dependency = True |
||
) |
Returns a new QorusSystemAPIHelper object corresponding to a defined Qorus remote connection.
name | the name of the remote connection |
connect | if False an unconnected object will be returned, otherwise the object is already connected |
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
GET-REMOTE-ERROR | The given connection is not known |
deprecated hash< auto > OMQ::UserApi::get_running_workflow_info | ( | softint | id | ) |
returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not
returns an empty hash if the workflow execution ID is not currently valid
id | workflow execution instance id |
name:
the name of the workflowversion:
version of the workflowworkflowid:
the workflowid of the workflowexecutionID:
the workflow execution instance id (same as the argument)mode:
WM_Normal or WM_Recoverysync:
True if the execution instance is synchronous, False if notstatus:
WISInitializing, WISRunning, WISWaiting, WISStoppingiterations:
number of segment iterations performed so fartotalSegments:
number of segments executederrors:
total number of errors encounteredwarnings:
total number of warnings raisedstarttime:
date/time the execution instance was startedoptions:
options set on the workflow execution instancelogfile:
log file nameremote:
True if the workflow is running as a remote qwf process, False if notdeprecated list< auto > OMQ::UserApi::get_running_workflow_list | ( | *string | name, |
*string | ver | ||
) |
returns a list of hashes giving information about the currently-running workflow execution instances
name | optional workflow name for filtering the result list |
ver | optional workflow version for filtering the result list (only used if name also passed) |
executionID:
the workflow execution instance idname:
the name of the workflowversion:
version of the workflowworkflowid:
the workflowid of the workflowmode:
WM_Normal or WM_Recoverysync:
True if the execution instance is synchronous, False if notstatus:
WISInitializing, WISRunning, WISWaiting, WISStoppingiterations:
number of segment iterations performed so fartotalSegments:
number of segments executederrors:
total number of errors encounteredwarnings:
total number of warnings raisedstarttime:
date/time the execution instance was startedoptions:
options set on the workflow execution instancelogfile:
log file nameremote:
True if the workflow is running as a remote qwf process, False if notdeprecated *hash< auto > OMQ::UserApi::get_service_info | ( | string | type, |
string | name | ||
) |
returns information about the given service (if it's currently loaded)
to get information about services whether they are loaded or not, call:
type | the type of service (either "system" or "user" ; case is ignored) |
name | the name of the system service to query |
type:
either "system"
or "user"
corresponding to the argumentname:
the name of the serviceversion:
version of the servicepatch:
the patch string for the servicedesc:
description of the serviceauthor:
the author of the serviceserviceid:
service IDparse_options:
parse options for the servicestatus:
SSRunning or SSLoadedlog:
path to the service log fileactive_calls:
number of active service calls and persistent connection handlers currently in progresswaiting_threads:
number of threads waiting on the service (for a service reset or unload action)threads:
number of running threads in the serviceautostart:
True
of False
if the autostart flag is setmanual_autostart:
True
of False
the autostart value has been manually setloaded:
date/time the service was loadedmethods:
list of hashes for each method with name
and desc
keysresources:
list of service resourcesresource_files:
list of service file resourcesoptions:
service optionsgroups:
interface groups that the service belongs toalerts:
any alerts raised against the serviceactive_calls
and waiting_threads
keysdeprecated int OMQ::UserApi::get_session_id | ( | ) |
returns the current Qorus application session ID
deprecated hash< auto > OMQ::UserApi::get_sql_cache_info | ( | ) |
get information about cached object
Resulting hash (keys are datasource names) of hashes (keys are cache types) of hashes (keys are names of individual cached objects) provides the information about given cached objects as a value. This information has the form of hash with the following keys:
deprecated auto OMQ::UserApi::get_sql_number | ( | auto | v | ) |
returns either the value returned or the string "NULL" if the type cannot be converted to a number
this function is designed to be used to directly put values in an SQL query that should be of NUMBER/NUMERIC/DECIMAL type
v | the value to use a number in an SQL query |
deprecated string OMQ::UserApi::get_sql_string | ( | auto | v, |
int | size = 0 |
||
) |
returns a singly-quoted string aimed to be directly usable in dynamic SQL queries with single quote (\') characters escaped or returns the string "NULL" if the argument type is not int, float, bool, or string
this function is designed to be used to directly put values in an SQL query that should be of VARCHAR/CHAR type
v | value to return as a string that can be directly used in an SQL query |
size | if non-zero, give the maximum size in characters of the string |
deprecated SqlUtil::AbstractTable OMQ::UserApi::get_sql_table | ( | AbstractDatasource | datasource, |
string | table_name | ||
) |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch
datasource | a DatasourcePool object for a Qorus datasource; note that if the Qore::SQL::DatasourcePool object cannot be matched back to a known Qorus datasource, an INVALID-DATASOURCE exception will be thrown |
table_name | the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor(); names are converted to lower-case before performing the lookup and storage in the cache to ensure that the cache is based on case-insensitive lookups |
INVALID-DATASOURCE | this exception is thrown if the datasource argument cannot be matched to a known Qorus datasource |
INVALID-DATASOURCE
exceptions can be thrown with a valid Qorus datasource if the given datasource has been reset since it was acquireddeprecated SqlUtil::AbstractTable OMQ::UserApi::get_sql_table | ( | string | datasource, |
string | table_name | ||
) |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch
datasource | a Qorus datasource name |
table_name | the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor(); names are converted to lower-case before performing the lookup and storage in the cache to ensure that the cache is based on case-insensitive lookups |
INVALID-DATASOURCE | this exception is thrown if the datasource argument cannot be matched to a known datasource |
deprecated hash< auto > OMQ::UserApi::get_system_info | ( | ) |
returns a hash of system info
instance-key
: value of the system option by the same namesession-id
: the session ID for the current Qorus application sessionomq-version
: the version string for the Qorus serveromq-version-code
: a numeric code of the Qorus server version, where omq-version-code
= 20600)qore-version
: the version string for the qore build useddatamodel-version
: the datamodel version required by this version of Qorusomq-schema
: the datasource string for the system schema (without the password)omquser-schema
: the datasource string for the user schema (without the password)starttime:
the date and time when the instance was startedhostname:
the hostname of the machine where the Qorus server is runningpid:
the PID of the Qorus server processthreads:
number of threads currently activeschema-properties
: a hash of schema properties with the following keys:omq-schema-version
omq-schema-compatibility
omq-load-schema-compatibility
logfile:
the path for the system log fileomq-version-code
deprecated *hash OMQ::UserApi::get_system_service_info | ( | string | name | ) |
returns information about the given system service (if it's currently loaded)
to get information about system services whether they are loaded or not, call:
name | the name of the system service to query |
type:
"system"
name:
the name of the serviceversion:
version of the servicedesc:
description of the serviceserviceid:
service IDstatus:
SSRunning or SSLoadedthreads:
number of running threads in the serviceautostart:
True
of False
if the autostart flag is setloaded:
date/time the service was loadedmethods:
list of hashes for each method with name
and desc
keysdeprecated object OMQ::UserApi::get_user_connection | ( | string | name, |
bool | connect = True , |
||
bool | register_dependency = True , |
||
*hash< auto > | rtopts | ||
) |
Returns an object corresponding to a defined user connection.
name | the name of the connection |
connect | if False an unconnected object will be returned, otherwise the object is already connected |
register_dependency | if True (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again |
rtopts | any runtime options accepted by the connection |
CONNECTION-ERROR | The given connection is not known |
deprecated *hash< auto > OMQ::UserApi::get_user_context_info | ( | ) |
returns a hash for the current user context
"type"
: "service"
"servicetype"
: the type of service ("user"
or "system"
)"name"
: the name of the service"version"
: the version of the service"id"
: the service id"type"
: "job"
"name"
: the name of the job"version"
: the version of the job"id"
: the job id"job_instanceid"
: the job_instanceid of the current job instance"type"
: "workflow"
"name"
: the name of the workflow"version"
: the version of the workflow"id"
: the workflow id"workflow_instanceid"
: the workflow_instanceid of the current workflow instance (if available)"stepname"
: the name of the current step (if available)"stepversion"
: the version of the current step (if available)"stepid"
: the id of the current step (if available)"ind"
: the name of the current step index (if available)"execid"
: the execution ID of the current workflow execution instance (if available)deprecated *hash< auto > OMQ::UserApi::get_user_service_info | ( | string | name | ) |
returns information about the given user service (if it's currently loaded)
to get information about user services whether they are loaded or not, call REST API:
name | the name of the user service to query |
type:
"user"
name:
the name of the serviceversion:
version of the servicedesc:
description of the serviceserviceid:
service IDstatus:
SSRunning or SSLoadedthreads:
number of running threads in the serviceautostart:
True
of False
if the autostart flag is setloaded:
date/time the service was loadedmethods:
list of hashes for each method with name
and desc
keysdeprecated auto OMQ::UserApi::get_value_map | ( | string | mapname, |
string | key | ||
) |
Gets a lookup value from the value map by a key; the value map must be registered to the current interface.
mapname | name of the value map |
key | a key name |
VALUE-MAP-ERROR | the given value map is unknown or not registered to the current interface |
deprecated list OMQ::UserApi::get_value_maps | ( | ) |
Gets all value maps valid for the current interface.
"id"
: the internal ID of the value map"name"
: the name of the value map"description"
: a string describing the value map"author"
: the author tag"throws_exception"
: a tag that controls the behavior when an unknown mapping is referenced (Value Map Error Handling and Missing Data)"valuetype"
: the type of values in the map"created"
: the created time stamp"modified"
: the last modified time stampdeprecated any OMQ::UserApi::getOption | ( | ) |
deprecated auto OMQ::UserApi::getOracleNumber | ( | auto | v | ) |
returns a string suitable for dynamic SQL
deprecated string OMQ::UserApi::getOracleString | ( | auto | v, |
int | size = 0 |
||
) |
returns a string suitable for dynamic SQL
hash OMQ::UserApi::getRunningWorkflowInfo | ( | softint | id | ) |
list OMQ::UserApi::getRunningWorkflowList | ( | ) |
int OMQ::UserApi::getSessionID | ( | ) |
deprecated auto OMQ::UserApi::getSQLNumber | ( | auto | v | ) |
returns a string suitable for dynamic SQL
deprecated string OMQ::UserApi::getSQLString | ( | auto | v, |
int | size = 0 |
||
) |
returns a string suitable for dynamic SQL
hash OMQ::UserApi::getSystemInfo | ( | ) |
*hash OMQ::UserApi::getSystemServiceInfo | ( | string | name | ) |
*hash OMQ::UserApi::getUserServiceInfo | ( | string | name | ) |
deprecated OMQ::UserApi::log | ( | softint | lvl, |
softstring | msg | ||
) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the log level passed is equal to or lower than value of the system option qorus.verbose.
lvl | if this value is lower than or equal to the value of the Qorus system qorus.verbose option, the message logged in the appropriate log file, otherwise the message is ignored. See Log Levels for valid values |
msg | the format string for a vsprintf() call with the remaining arguments |
deprecated string OMQ::UserApi::make_select_list | ( | auto | list | ) |
returns a string based on a list, processed for the values in the list to be used in an SQL string with an Oracle DB
deprecated string OMQ::UserApi::make_select_list2 | ( | auto | driver, |
auto | list | ||
) |
returns a string based on a list, processed for the values in the list to be used in a dynamic SQL string
deprecated int OMQ::UserApi::omqsleep | ( | softint | arg | ) |
puts the current thread to sleep for a certain number of seconds
This function is available in the job, workflow, and service API in the same form. If the job, workflow execution instance, or service is stopping, this function returns immediately with a return value of -1; otherwise the current thread is put to sleep for the full time period requested. If this function (or omqusleep()) is called again after -1 is returned, then a "STOP-ERROR"
exception is thrown.
arg | the number of seconds to sleep |
STOP-ERROR | the current object is stopping and this function already returned -1 as a warning |
deprecated int OMQ::UserApi::omqusleep | ( | softint | arg | ) |
puts the current thread to sleep for a certain number of microseconds
This function is available in the job, workflow, and service API in the same form. If the job, workflow execution instance, or service is stopping, this function returns immediately with a return value of -1; otherwise the current thread is put to sleep for the full time period requested. If this function (or omqsleep()) is called again after -1 is returned, then a "STOP-ERROR"
exception is thrown.
arg | the number of microseconds to sleep (1 microsecond = 1/1000000 of a second) |
STOP-ERROR | the current object is stopping and this function already returned -1 as a warning |
deprecated string OMQ::UserApi::oracle_date | ( | date | date | ) |
returns a string from a date suitable for use in a dynamic oracle SQL string
deprecated bool OMQ::UserApi::parseBoolean | ( | auto | v | ) |
deprecated bool OMQ::UserApi::post_sla_event_error | ( | string | sla, |
number | value, | ||
string | err, | ||
string | desc | ||
) |
posts an unsuccessful SLA event for SLA monitoring and performance tracking
sla | the SLA name |
value | the SLA performance value |
err | the error code for the SLA event error |
desc | the error description for the SLA event error |
deprecated bool OMQ::UserApi::post_sla_event_success | ( | string | sla, |
number | value | ||
) |
posts a successful SLA event for SLA monitoring and performance tracking
sla | the SLA name |
value | the SLA performance value |
deprecated bool OMQ::UserApi::post_sync_event | ( | string | eventtype, |
string | eventkey | ||
) |
posts a workflow synchronization event given the event type name and the unique event key
eventtype | the event type name |
eventkey | the event key in the event type queue to post |
UNKNOWN-EVENT | unknown event type name |
deprecated int OMQ::UserApi::post_user_event | ( | string | severity, |
auto | info | ||
) |
posts an application event of class QE_CLASS_USER
severity | see Error Severity Codes for possible values |
info | the user-defined information for the event |
POST-USER-EVENT-ERROR | invalid severity value |
deprecated hash< auto > OMQ::UserApi::prop_get | ( | ) |
returns a hash of all system properties in all domains
deprecated *hash< auto > OMQ::UserApi::prop_get | ( | string | domain | ) |
returns a hash of all key-value pairs in the given domain or NOTHING if the system property domain does not exist
deprecated auto OMQ::UserApi::prop_get | ( | string | domain, |
string | key | ||
) |
returns the value of the given system property key in the given domain or NOTHING if the system property does not exist
deprecated hash< auto > OMQ::UserApi::prop_update | ( | hash< auto > | h | ) |
changes (inserts, updates, or deletes) the value of one or more system properties according to a hash argument
Updates the values of the properties in the domain corresponding to the top level keys of the hash passed and the keys corresponding to the second-level keys in the hash according to the rules for prop_update(domain, key, value) method.
The method returns a hash with "INSERT"
, "UPDATE"
, "DELETE"
and "IGNORED"
keys having integer values corresponding to the number of operations performed (deleting a non-existent key or domain causes a "IGNORED"
value to be returned).
All changes are made atomically in a single transaction.
h | in the format domain.key.value for updating, inserting, or deleting |
PROP-ERROR | serialized value exceeds 240 characters (column limit) |
UPDATE-ERROR | changes attempted in the "omq" domain |
deprecated string OMQ::UserApi::prop_update | ( | string | domain, |
softstring | key, | ||
auto | value | ||
) |
changes (inserts, updates, or deletes) the value of a single system property
Updates the value of the property in the domain passed. If the property does not exist, then it is created. If the value is NOTHING
(i.e. if no value is supplied) then the property will be deleted. Changes are committed to the database and the internal cache before the method call returns. No changes may be made in the system "omq"
domain.
domain | the domain of the property to set |
key | the key to set |
value | the value to set in the property domain; if no value is passed here, and the property exists, it will be deleted |
"INSERT"
, "UPDATE"
, "DELETE"
, "IGNORED"
(if a non-existent key should be deleted)PARAMETER-ERROR | if the domain or key arguments are empty strings |
PROP-ERROR | serialized value exceeds 240 characters (column limit) |
UPDATE-ERROR | changes attempted in the "omq" domain |
deprecated string OMQ::UserApi::qorus_get_local_url | ( | *string | username, |
*string | password | ||
) |
returns a string giving the local system URL
username | an optional username for the new connection |
password | an optional password for the new connection |
deprecated OMQ::UserApi::raise_transient_alert | ( | string | alert, |
string | reason, | ||
*hash | info | ||
) |
raises a transient system alert from a workflow, service, or job
alert | the name of the alert (ex: "DATA-SIZE-EXCEEDED" ) |
reason | the reason or verbose description of the alert |
info | optional key / value details for the alert |
deprecated list< auto > OMQ::UserApi::remove_from_list_index | ( | list< auto > | list, |
int | index | ||
) |
remove an element from a list
*string OMQ::UserApi::restart_transaction | ( | string | driver, |
hash< auto > | ex | ||
) |
returns a string error message if any exception in the chain passed was caused by a recoverable DB error
If the error is not recognized as a recoverable DB error, NOTHING is returned
driver | the database driver name, which must be a driver supported by the Qorus system schema, currently one of "oracle" , "pgsql" , or "mysql" , otherwise an UNSUPPORTED-DRIVER exception is thrown |
ex | the exception hash |
UNSUPPORTED-DRIVER | only "oracle" , "pgsql" , and "mysql" are currently supported |
deprecated hash OMQ::UserApi::runtime_properties | ( | ) |
returns Qorus runtime properties as a hash
hash OMQ::UserApi::runtimeProperties | ( | ) |
deprecated OMQ::UserApi::set_option | ( | hash< auto > | hash | ) |
Changes option values on a workflow, service, or job.
if called from workflow code, and the workflow has defined workflow options and an invalid option is passed to the function, an exception will be raised; however all other valid options in the hash will be set before the exception is raised
hash | a hash of option-value pairs |
WORKFLOW-OPTION-ERROR | invalid option name |
deprecated OMQ::UserApi::setOption | ( | hash | hash | ) |
deprecated hash< auto > OMQ::UserApi::unblock_order | ( | softint | wfiid, |
*hash< auto > | tempdata, | ||
*hash< auto > | orderkeys | ||
) |
unblocks the given workflow order data instance
wfiid | the workflow order instance ID to unblock |
tempdata | optional workflow order tempdata to pass to the workflow order (will only be used if the order is immediately cached as a part of the unblock_order() call) |
orderkeys | optional workflow order data keys |
workflow_status:
the status of the workflow orderBLOCK-WORKFLOW-ERROR | invalid status, foreign session id, missing original status, uncancel operation already in progress |
deprecated hash< auto > OMQ::UserApi::uncancel_order | ( | softint | wfiid, |
*hash< auto > | tempdata | ||
) |
uncancels the given workflow order data instance
wfiid | the workflow order instance ID to uncancel |
tempdata | temporary data to provide when uncanceling the order |
workflow_status:
the status of the workflow orderCANCEL-WORKFLOW-ERROR | invalid status, foreign session id, missing original status, uncancel operation already in progress |