![]() |
Qorus Integration Engine® Enterprise Edition 6.0.27_prod
|
The abstract class for Qorus jobs. More...
Public Member Methods | |
abstract public nothing | run () |
The logic for the job. | |
![]() | |
final *hash< string, hash< ConfigItemInfo > > | getConfigItems () |
Method to return local configuration items. More... | |
*hash< string, hash< ConfigItemInfo > > | getConfigItemsImpl () |
Method to return local configuration items; this method should be overridden by child classes to provide item configuration. More... | |
Additional Inherited Members | |
![]() | |
static | err (string err, string desc_fmt) |
raises an error in a running job; does not affect the flow of execution in the job code More... | |
static | errWithInfo (string err, softstring desc="", auto info, softstring severity=OMQ::ES_Major, softbool business=False) |
raises an error in a running job; does not affect the flow of execution in the job code More... | |
static | warn (string err, string desc_fmt) |
raises a warning in a running job; does not affect the flow of execution in the job code More... | |
static | warnWithInfo (string err, softstring desc="", auto info, softbool business=False) |
raises a warning in a running job; does not affect the flow of execution in the job code More... | |
static | saveInfo (auto info) |
saves information against the job instance in the database More... | |
static | saveInfoPath (string path, auto value) |
saves information against the job instance in the database More... | |
static hash< auto > | getInfo () |
returns a hash of job information about the current job More... | |
static *hash< auto > | getJobInfo () |
returns any hash stored with a call to saveInfo() More... | |
static | saveStateData (hash< auto > data) |
serializes the given hash and stores against the job's state data in JOB_STATE_DATA More... | |
static | saveStateDataPath (string path, auto value) |
serializes the given hash and stores against the job's state data in JOB_STATE_DATA More... | |
static *hash< auto > | getStateData () |
returns any job state data stored with saveStateData() More... | |
static | savePersistentStateData (hash< auto > data) |
serializes the given hash and stores against the job's state data in JOB_PERSISTENT_STATE_DATA More... | |
static | savePersistentStateDataPath (string path, auto value) |
serializes the given hash and stores against the job's state data in JOB_PERSISTENT_STATE_DATA More... | |
static | clearPersistentStateData () |
clears the job's state data in JOB_PERSISTENT_STATE_DATA More... | |
static *hash< auto > | getPersistentStateData () |
returns any job state data stored with savePersistentStateData() More... | |
static bool | setTrigger (date ts) |
sets a one-time custom trigger time for the job; returns True if set, False if ignored More... | |
static | setOption (hash< auto > opts) |
Changes option values on a job. More... | |
static | setOption (string option, auto value) |
Changes a single option value on a job. More... | |
static auto | getOption () |
Returns the value of the named job option(s) More... | |
static auto | getOptionArgs (*softlist< string > args) |
Returns the value of the named job option or options. More... | |
static int | sleep (softint arg) |
puts the current thread to sleep for a certain number of seconds More... | |
static int | usleep (softint arg) |
puts the current thread to sleep for a certain number of microseconds More... | |
static int | usleep (date arg) |
puts the current thread to sleep for a certain number of microseconds More... | |
static auto | getConfigItemValue (string item, *hash< auto > local_context, bool expand_complex_values=True) |
returns the value of the given job configuration item More... | |
static hash< auto > | getConfigItemHash (*hash< auto > local_context) |
returns a hash of all configuration items for the current job More... | |
![]() | |
static *hash< auto > | getUserServiceInfo (string name) |
returns information about the given user service (if it's currently loaded) More... | |
static SqlUtil::AbstractTable | getSqlTable (string datasource, string table_name, bool register_dependency=True) |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch More... | |
static SqlUtil::AbstractTable | getSqlTable (AbstractDatasource datasource, string table_name, bool register_dependency=True) |
get a cached table object (suitable for DML) if present, otherwise it creates one from scratch More... | |
static hash< auto > | getSqlCacheInfo () |
get information about cached object More... | |
static | clearSqlTableCache (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... | |
static | clearSqlTableCache (AbstractDatasource datasource, *string table_name) |
clears cached objects for given datasource (for example, if database objects have been updated in the dataserver) More... | |
static auto | getValueMap (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... | |
static list< auto > | getValueMaps () |
Gets all value maps valid for the current interface. More... | |
static bool | postSlaEventSuccess (string sla, number value) |
posts a successful SLA event for SLA monitoring and performance tracking More... | |
static bool | postSlaEventError (string sla, number value, string err, string desc) |
posts an unsuccessful SLA event for SLA monitoring and performance tracking More... | |
static | flushSlaEvents () |
flushes all pending SLA events to disk and returns after the data has been committed More... | |
static *hash< auto > | getSystemServiceInfo (string name) |
returns information about the given system service (if it's currently loaded) More... | |
static *hash< auto > | getServiceInfo (string type, string name) |
returns information about the given service (if it's currently loaded) More... | |
static list | getRunningWorkflowList (*string name, *string ver) |
returns a list of hashes giving information about the currently-running workflow execution instances More... | |
static hash | getRunningWorkflowInfo (softint id) |
returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not More... | |
static softint | createOrder (string name, *string version, hash< auto > params, string status=StatReady) |
creates a workflow order data instance in the database More... | |
static softint | createRemoteOrder (string remote, string name, *string version, hash< auto > params, string status=StatReady, bool register_dependency=True) |
creates a workflow order data instance in a remote Qorus instance More... | |
static hash< auto > | execSynchronousWorkflow (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... | |
static int | postUserEvent (string severity, auto info) |
posts an application event of class OMQ::QE_CLASS_USER More... | |
static hash | runtimeProperties () |
returns Qorus runtime properties as a hash More... | |
static auto | callNetworkApiArgsWithAuthentication (string user, string pass, string call, softlist< auto > args) |
calls a system RPC API with authentication information (username and password) More... | |
static auto | callNetworkApiArgs (string call, *softlist< auto > args) |
calls a system RPC API with the argument list to the API method as a top-level argument to this method; the API is called with system permissions (no restrictions) More... | |
static auto | callNetworkApi (string call) |
calls a system RPC API and returns the result; the API is called with system permissions (no restrictions) More... | |
static auto | callRestApi (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... | |
static auto | callRestApiWithAuthentication (string user, string pass, string method, string path, *hash< auto > body_args) |
calls a system REST API method with authentication information (username and password) and returns the result More... | |
static hash< auto > | getSystemInfo () |
returns a hash of system info More... | |
static int | getSessionId () |
returns the current Qorus application session ID More... | |
static | startCapturingObjectsFromJava () |
Starts capturing Qore objects created from Java APIs in the current interface's object cache. More... | |
static | stopCapturingObjectsFromJava () |
Stops capturing Qore objects created from Java APIs in the current interface's object cache. More... | |
static | startCapturingObjectsFromPython () |
Starts capturing Qore objects created from Python APIs in the current interface's object cache. More... | |
static | stopCapturingObjectsFromPython () |
Stops capturing Qore objects created from Python APIs in the current interface's object cache. More... | |
static | saveObjectInObjectCache (object obj) |
Saves the object in the object cache. More... | |
static bool | clearObjectFromObjectCache (object obj) |
Removes the object from the object cache. More... | |
static *date | checkObjectCache (object obj) |
Returns the date/time the object was cached or NOTHING if the object is not in the cache. More... | |
static int | getObjectCacheSize () |
Returns the number of objects in the cache. More... | |
static int | clearObjectCache () |
Clears the entire the object cache. More... | |
static int | clearObjectCache (date cutoff) |
Clears the entire the object cache for all objects cached before the given date/time. More... | |
static list< hash< CallStackInfo > > | getThreadCallStack () |
Allows the current thread's call stack to be retrieved in Qorus. More... | |
static | logFatal (softstring msg) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logError (softstring msg) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logWarn (softstring msg) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logInfo (softstring msg) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logDebug (softstring msg) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logTrace (softstring msg) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logArgsFatal (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logWithLevel (Logger::LoggerLevel level, string msg) |
Writes to the current interface log file with the given log level. More... | |
static | logWithLevel (int level, string msg) |
Writes to the current interface log file with the given log level. More... | |
static | logWithLevelArgs (Logger::LoggerLevel level, string msg, *softlist< auto > args) |
Writes to the current interface log file with the given log level. More... | |
static | logWithLevelArgs (int level, string msg, *softlist< auto > args) |
Writes to the current interface log file with the given log level. More... | |
static | logArgsError (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logArgsWarn (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logArgsInfo (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logArgsDebug (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static | logArgsTrace (softstring msg, *softlist< auto > args) |
Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the interface logger level is equal or lower. More... | |
static *int | auditUserEvent (string user_event, *string info1, *string info2) |
creates a user audit event (with audit code AE_USER_EVENT) against the workflow, service, or job instance More... | |
static bool | auditCheckEventString (string opt) |
checks if the given audit event (given as a string) is enabled More... | |
static bool | auditCheckEvent (softint opt) |
checks if the given audit event (given as an integer code) is enabled More... | |
static int | auditGetMask () |
returns the audit event mask More... | |
static bool | isKubernetes () |
returns True when Qorus is running under Kubernetes More... | |
static int | usleep (date arg) |
puts the current thread to sleep for a certain number of microseconds More... | |
static int | sleep (softint arg) |
puts the current thread to sleep for a certain number of seconds More... | |
static int | usleep (softint arg) |
puts the current thread to sleep for a certain number of microseconds More... | |
static hash< auto > | getQorusOptions () |
returns the value of the given system option or options More... | |
static hash< auto > | getQorusOptionInfo () |
returns a hash giving information about system options More... | |
static hash< auto > | getQorusOptionInfoArgs (*list< auto > args) |
returns a hash giving information about system options More... | |
static auto | getQorusOptionsArgs (softlist< auto > args) |
returns the value of the given system option or options More... | |
static hash< auto > | getActiveJobs () |
Returns information on all active jobs visible to the calling user. More... | |
static object | getUserConnection (string name, bool connect=True, bool register_dependency=True, *hash< auto > rtopts) |
Returns an object corresponding to a defined user connection. More... | |
static hash< auto > | getUserConnectionTags (string name) |
Returns any tags set on the given user connection. More... | |
static Qore::SQL::Datasource | getDatasourceDedicated (string name, bool register_dependency=True) |
returns a new, dedicated Datasource object, suitable for transaction management for long-running transactions More... | |
static AbstractDatasource | getDatasourcePool (string name, bool register_dependency=True) |
returns a DatasourcePool object for the given datasource name More... | |
static hash< auto > | getDatasourceInfo (string name) |
returns a hash of information for the given datasource, if known, otherwise throws an exception More... | |
static QorusSystemAPIHelper | getRemoteRpcConnection (string name, bool connect=True, bool register_dependency=True) |
Returns a new QorusSystemAPIHelper object corresponding to a defined Qorus remote connection. More... | |
static QorusSystemRestHelper | getRemoteRestConnection (string name, bool connect=True, bool register_dependency=True) |
Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection. More... | |
static | raiseTransientAlert (string alert, string reason, *hash< auto > info) |
raises a transient system alert from a workflow, service, or job More... | |
static string | qorusGetLocalUrl (*string username, *string password) |
returns a string giving the local system URL More... | |
static | setOption (hash< auto > hash) |
Changes option values on a workflow, service, or job. More... | |
static auto | getOption () |
Returns the value of the named workflow, service, or job option or options. More... | |
static auto | getOptionArgs (*softlist< string > args) |
Returns the value of the named workflow, service, or job option or options. More... | |
static hash< auto > | blockOrder (softint wfiid) |
block the given workflow order data instance More... | |
static hash< auto > | unblockOrder (softint wfiid, *hash< auto > tempdata, *hash< auto > orderkeys) |
unblocks the given workflow order data instance More... | |
static hash< auto > | cancelOrder (softint wfiid) |
cancel the given workflow order data instance More... | |
static hash< auto > | uncancelOrder (softint wfiid, *hash< auto > tempdata) |
uncancels the given workflow order data instance More... | |
static | updateDynamicOrderData (softint wfiid, hash< auto > new_data) |
updates the given workflow order instance's dynamic data hash atomically More... | |
static | updateDynamicOrderDataPath (softint wfiid, string path, auto value) |
updates the given workflow order instance's dynamic data hash atomically More... | |
static *hash< auto > | getUserContextInfo () |
returns a hash for the current user context More... | |
static *string | getContextUserName () |
returns the current username for any external user-initiated call or NOTHING if executing in a system context More... | |
static auto | getConfigItemValue (string cfg_item, *hash< auto > local_context, bool expand_complex_values=True) |
returns config item value in the current user context More... | |
static auto | getInterfaceConfigItemValue (string cfg_item, *hash< auto > local_context, bool expand_complex_values=True) |
returns config item value in the current interface context More... | |
static hash< auto > | getConfigItemHash (*hash< auto > local_context) |
returns a hash of all configuration items for the current interface More... | |
static hash< auto > | getInterfaceConfigItemHash (*hash< auto > local_context) |
Returns a hash of all configuration items for the current context as a combination of local and global configuration items. More... | |
static auto | getGlobalConfigItemValue (string item, *hash< auto > local_context, bool expand_complex_values=True) |
returns the value of the given configuration item on global level; throws an exception if there is no value on global level for the configuration item More... | |
static auto | getGlobalConfigItemValueWithDefault (string item, auto default_value, *hash< auto > local_context, bool expand_complex_values=True) |
returns the value of the given configuration item on global level; throws an exception if there is no value on global level for the configuration item More... | |
static AbstractDataProvider | getDataProvider (hash< auto > h, *hash< auto > ctx) |
Returns a data provider corresponding to the hash description. More... | |
static AbstractDataProvider | getDataProvider (string path) |
returns the data provider given by a path string More... | |
static AbstractDataProvider | getDataProvider (string type, string name, *string path, *hash< auto > opts, *hash< auto > ctxt, *bool handle_template_args) |
returns the data provider given by a path string More... | |
static AbstractDataProviderType | getQorusType (string type_path) |
Returns a data provider type from a direct type path. More... | |
static AbstractDataProviderType | getTypeFromPath (string path) |
returns a data provider type identified by a path string More... | |
static Mapper::Mapper | getMapper (string name, *hash< auto > rtopts) |
returns the given mapper if registered for the current interface More... | |
static Qore::AbstractIterator | getMapperIterator (string name, Qore::AbstractIterator input, *hash< auto > rtopts) |
returns an iterator for the named mapper using the iterator argument for input More... | |
static bool | postSyncEvent (string eventtype, string eventkey) |
posts a workflow synchronization event given the event type name and the unique event key More... | |
static hash< auto > | propGet () |
returns a hash of all system properties in all domains More... | |
static *hash< auto > | propGet (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... | |
static auto | propGet (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... | |
static string | propUpdate (string domain, softstring key, auto value) |
changes (inserts, updates, or deletes) the value of a single system property More... | |
static hash< auto > | propUpdate (hash< auto > h) |
changes (inserts, updates, or deletes) the value of one or more system properties according to a hash argument More... | |
static softint | getNextSequenceValue (AbstractDatasource ds, string name) |
returns the next sequence value for the given datasource and sequence More... | |
static softint | getNextSequenceValue (string ds, string name) |
returns the next sequence value for the given datasource and sequence More... | |
static string | serializeQorusData (auto d) |
returns a string giving the default serialization of the given data structure for storage in Qorus More... | |
static string | serializeQorusDataWithNothing (auto d) |
returns a string giving the default serialization of the given data structure for storage in Qorus More... | |
static auto | deserializeQorusData (string data) |
parses serialized data in either XML-RPC or YAML format and returns the corresponding qore data More... | |
static auto | deserializeQorusData (null data) |
deserializing a NULL value from the DB returns no value | |
static *string | restartTransaction (string driver, hash< auto > ex) |
returns a string error message if any exception in the chain passed was caused by a recoverable DB error, otherwise returns NOTHING More... | |
static bool | isInternalSystemDebuggingEnabled () |
returns True if internal system debugging is enabled More... | |
static auto | getHashDotValue (*hash< auto > var_data, string var_name, *reference< bool > missing_input) |
returns the value of the given key from the given hash, respects dot notation in the key name More... | |
static auto | expandOneVariable (string str, string var_context, auto template_arg, *hash< auto > local_context, *bool brackets, bool expand_complex_values=True, *reference< bool > missing_input) |
expands one variable in a templated string More... | |
static bool | isSingleTemplatedString (auto value) |
checks if the given value is a templated string with only one expandable variable More... | |
static auto | expandTemplatedValue (auto value, *hash< auto > local_context, bool expand_complex_values=True, *reference< bool > missing_input, *string template_context) |
expands all variables in a templated string More... | |
static softlist< auto > | expandComplexValue (list< auto > val, *hash< auto > local_context, *string template_context) |
expands all variables in a list with templated values More... | |
static hash< auto > | expandComplexValue (hash< auto > val, *hash< auto > local_context, *string template_context) |
expands all variables in a hash with templated values More... | |
static hash< BbVariable > | bbParseExactlyOneVariable (string str) |
parses one template variable and returns a hash with its parts More... | |
static auto | getInputData (string field_name, *hash< auto > local_context, *hash< auto > input_data_cfg) |
returns specified input data field's value More... | |
static hash< auto > | getInputData (*hash< auto > input_data_cfg, *hash< auto > local_context) |
returns all input data More... | |
static *hash< auto > | updateHashDotValue (*hash< auto > var_data, string var_name, auto value) |
updates the given hash with a key in dot notation with the given value More... | |
static | updateOutputData (string field_name, auto output_data, *hash< auto > output_data_cfg) |
updates specified output data field's value More... | |
static | updateOutputData (hash< auto > all_output_data, hash< auto > output_data_cfg=UserApi::getConfigItemValue(BB_OUTPUT_DATA_CFG_KEY, NOTHING, False)) |
updates all output data More... | |
static | writeOutputData (*hash< auto > output_data) |
Writes output data using a concise format. More... | |
static string | getTextFileFromLocation (string location) |
returns string data for the given file location More... | |
static binary | getBinaryFileFromLocation (string location) |
returns binary data for the given file location More... | |
static Qore::StreamReader | getStreamReaderFromLocation (string location) |
Returns a string stream for the file's data at the given location. More... | |
static Qore::InputStream | getBinaryStreamFromLocation (string location) |
Returns an input stream for file data at the given location. More... | |
static | writeFileToLocation (string location, data contents) |
Writes data to a file at the given location. More... | |
static FileLocationHandler::OutputStreamWrapper | getOutputStreamForLocation (string location) |
Returns an output stream for writing data to the given location. More... | |
static auto | executeFsm (string fsm_name, auto arg) |
Executes the given Finite State Machine and returns the final output. More... | |
static | registerFsmAsObserver (string fsm_name, DataProvider::Observable observable, string event_id) |
Registers the given Finite State Machine with the given object as an Observer. More... | |
static string | generateTokenForUser (string username, timeout expiry=DefaultTokenExpirationPeriod) |
Generates an access token for the given user with the given expiration time. More... | |
static string | generateTokenForUser (string username, int expiry_seconds) |
Generates an access token for the given user with the given expiration time. More... | |
static bool | invalidateToken (string token) |
Invalidates the given token. More... | |
static | refreshToken (string token, *int expiry_seconds) |
Refreshes the given token. More... | |
static | refreshToken (string token, timeout expiry_seconds) |
Refreshes the given token. More... | |
static *hash< TokenInfo > | getTokenInfo (string token, *bool refresh_token) |
Returns information for the given token. More... | |
static *hash< QorusUserInfo > | getCurrentUserInfo () |
Returns information for the current user. More... | |
static hash< QorusUserInfo > | getUserInfo (string username) |
Returns information for the given user. More... | |
static public hash< auto > | bindSubworkflow (hash< auto > wf, hash< auto > order) |
This method binds a workflow to a subworkflow step. More... | |
static public hash< auto > | skipSubworkflow () |
This method skips binding a workflow to a subworkflow step. More... | |
static public | submitAsyncKey (string key) |
Binds the given key to the asynchronous step. More... | |
static public | skipAsyncStep () |
This method will skip the execution of an asynchronous step. More... | |
static public | bindEvent (string eventkey) |
binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) More... | |
static public | bindEventUnposted (string eventkey) |
binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) only if the event has not yet been posted; if the event has already been posted, then an ALREADY-POSTED exception is raised More... | |
static public | skipEvent () |
skips a workflow synchronization event step More... | |
static | leaveParentFeedback (string key, auto value) |
leaves feedback for a parent workflow More... | |
static auto | getChildFeedback (string key) |
gets feedback from a child workflow order with the given key More... | |
static bool | isWorkflowContext () |
Returns True if the code is executing in an immediate workflow context, False if not. More... | |
static bool | isServiceContext () |
Returns True if the code is executing in an immediate service context, False if not. More... | |
static bool | isJobContext () |
Returns True if the code is executing in an immediate job context, False if not. More... | |
![]() | |
static QorusProgram | DynamicLogic (False, CommonParseOptions|PO_NO_INHERIT_USER_CLASSES|PO_NO_INHERIT_USER_FUNC_VARIANTS|PO_NO_INHERIT_GLOBAL_VARS|PO_NO_INHERIT_USER_CONSTANTS|PO_NO_INHERIT_USER_HASHDECLS|PO_NEW_STYLE|PO_STRICT_ARGS|PO_REQUIRE_TYPES, QorusServerDefines) |
Program for dynamic logic. | |
![]() | |
const | DataProviderRootValues |
data provider root path values | |
const | DataTypeRootValues |
data type root path values | |
const | DataProviderPathTypeValues |
data type path provider type values | |
The abstract class for Qorus jobs.
Qorus job constructors do not take any arguments; see Job Constructors and Static Initialization for information about constructors and static class initialization.