Qorus Integration Engine®  4.0.3_git
com.qoretechnologies.qorus.workflow.WorkflowApi Class Reference

The main Qorus Java workflow API class. More...

Inheritance diagram for com.qoretechnologies.qorus.workflow.WorkflowApi:
com.qoretechnologies.qorus.UserApi com.qoretechnologies.qorus.OMQ com.qoretechnologies.qorus.workflow.QorusStepBase com.qoretechnologies.qorus.workflow.QorusWorkflow com.qoretechnologies.qorus.workflow.QorusAsyncStepBase com.qoretechnologies.qorus.workflow.QorusEventStepBase com.qoretechnologies.qorus.workflow.QorusNormalArrayStep com.qoretechnologies.qorus.workflow.QorusNormalStep com.qoretechnologies.qorus.workflow.QorusSubworkflowStepBase com.qoretechnologies.qorus.workflow.QorusAsyncArrayStep com.qoretechnologies.qorus.workflow.QorusAsyncStep com.qoretechnologies.qorus.workflow.QorusEventArrayStep com.qoretechnologies.qorus.workflow.QorusEventStep com.qoretechnologies.qorus.workflow.QorusSubworkflowArrayStep com.qoretechnologies.qorus.workflow.QorusSubworkflowStep

Static Public Member Methods

static String generateUniqueKey () throws Throwable
 returns a unique async key for the order for use with submitAsyncKey() More...
 
static void stepError (String err, Object info, int retry_delay_secs) throws Throwable
 Raises an error against the current step without affecting the flow of processing. More...
 
static void stepError (String err, int retry_delay_secs) throws Throwable
 Raises an error against the current step without affecting the flow of processing. More...
 
static void stepError (String err, Object info) throws Throwable
 Raises an error against the current step without affecting the flow of processing. More...
 
static void stepError (String err) throws Throwable
 Raises an error against the current step without affecting the flow of processing. More...
 
static void stepWarning (String err, Object info) throws Throwable
 Raises a warning against the step. More...
 
static void stepWarning (String err) throws Throwable
 Raises a warning against the step. More...
 
static void setRetryDelay (int secs) throws Throwable
 Sets the value of the retry delay for an asynchronous step. More...
 
static void updateDynamicData (HashMap< String, Object > hash) throws Throwable
 Updates the values of one or more keys in the workflow order data instance’s dynamic data hash. More...
 
static void deleteDynamicDataKey (String... keys) throws Throwable
 Deletes one or more keys from the workflow order data instance’s dynamic data hash. More...
 
static void deleteDynamicDataKey (String key) throws Throwable
 Deletes one key from the workflow order data instance’s dynamic data hash. More...
 
static Object getDynamicData (String key) throws Throwable
 Retrieves the value of one keys from the workflow order data instance’s dynamic data hash. More...
 
static HashMap< String, ObjectgetDynamicData (String... keys) throws Throwable
 Retrieves the values of one or more keys from the workflow order data instance’s dynamic data hash. More...
 
static HashMap< String, ObjectgetDynamicData () throws Throwable
 Retrieves the entire workflow order data instance’s dynamic data hash. More...
 
static Object getStaticData (String key) throws Throwable
 Retrieves the value of one key from the workflow order data instance’s static data hash. More...
 
static HashMap< String, ObjectgetStaticData (String... keys) throws Throwable
 Retrieves the values of multiple keys from the workflow order data instance’s static data hash. More...
 
static HashMap< String, ObjectgetStaticData () throws Throwable
 Retrieves the entire workflow order data instance’s static data hash. More...
 
static void updateTempData (HashMap< String, Object > hash) throws Throwable
 Updates the values of one or more keys in the workflow order data instance’s temporary data hash. More...
 
static Object getTempData (String key) throws Throwable
 Retrieves the value of one key from the workflow order data instance’s temporary data hash. More...
 
static HashMap< String, ObjectgetTempData (String... keys) throws Throwable
 Retrieves the values multiple keys from the workflow order data instance’s temporary data hash. More...
 
static HashMap< String, ObjectgetTempData () throws Throwable
 Retrieves the entire workflow order data instance’s temporary data hash. More...
 
static void deleteTempDataKey (String... keys) throws Throwable
 Deletes one or more keys from the workflow order data instance’s temporary data hash. More...
 
static void updateSensitiveData (String skey, String svalue, HashMap< String, Object > hash, String[] aliases, HashMap< String, Object > meta) throws Throwable
 Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data key and value. More...
 
static void updateSensitiveData (String skey, String svalue, HashMap< String, Object > hash, String[] aliases) throws Throwable
 Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data key and value. More...
 
static void updateSensitiveData (String skey, String svalue, HashMap< String, Object > hash) throws Throwable
 Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data key and value. More...
 
static void updateSensitiveDataFromAlias (String alias, HashMap< String, Object > hash, HashMap< String, Object > meta) throws Throwable
 Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data alias. More...
 
static void updateSensitiveDataFromAlias (String alias, HashMap< String, Object > hash) throws Throwable
 Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data alias. More...
 
static HashMap< String, ObjectgetSensitiveMetadata (String skey, String svalue) throws Throwable
 Returns the sensitive metadata hash for the given sensitive data key and value if present, otherwise returns an empty hash. More...
 
static HashMap< String, ObjectgetSensitiveMetadataFromAlias (String alias) throws Throwable
 returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of the sensitive metadata hash for the given sensitive data alias corresponding to a sensitive data key and value More...
 
static HashMap< String, ObjectgetSensitiveData (String skey, String svalue, String... keys) throws Throwable
 Returns the sensitive data hash for the given sensitive data key and value. More...
 
static Object getSensitiveData (String skey, String svalue, String key) throws Throwable
 Returns the sensitive data hash for the given sensitive data key and value. More...
 
static HashMap< String, ObjectgetSensitiveData (String skey, String svalue) throws Throwable
 Returns the sensitive data hash for the given sensitive data key and value. More...
 
static HashMap< String, ObjectgetSensitiveDataFromAlias (String alias, String... keys) throws Throwable
 returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of one or more keys in the workflow sensitive data hash for the given sensitive data alias corresponding to a sensitive data key and value More...
 
static HashMap< String, ObjectgetSensitiveDataFromAlias (String alias, String key) throws Throwable
 returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of one or more keys in the workflow sensitive data hash for the given sensitive data alias corresponding to a sensitive data key and value More...
 
static HashMap< String, ObjectgetSensitiveDataFromAlias (String alias) throws Throwable
 returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of one or more keys in the workflow sensitive data hash for the given sensitive data alias corresponding to a sensitive data key and value More...
 
static HashMap< String, ObjectgetSensitiveDataAliases () throws Throwable
 returns a hash of all sensitive data aliases for the current order or an empty hash if there are none More...
 
static boolean deleteSensitiveData (String skey, String svalue) throws Throwable
 Deletes the sensitive data hash for the given sensitive data key and value; changes have already been committed to the database when this method returns. More...
 
static boolean deleteSensitiveDataKey (String skey, String svalue, String... keys) throws Throwable
 Deletes one or more keys from the workflow order data instance’s sensitive data hash for the given sensitive data key and value; changes have already been committed to the database when this method returns. More...
 
static HashMap< String, ObjectgetSensitiveDataKeyValues () throws Throwable
 Returns a hash of sensitive data keys and values saved against the order; the sensitive data hashes themselves are not returned, just the information used to index sensitive data against the order. More...
 
static void deleteInstanceDataKey (String... keys) throws Throwable
 Deletes a single key or a list of keys from the workflow execution instance’s instance data hash. More...
 
static void updateInstanceData (HashMap< String, Object > hash) throws Throwable
 Updates the values of one or more keys in the workflow execution instance’s instance data hash. More...
 
static HashMap< String, ObjectgetInstanceData () throws Throwable
 Retrieves the workflow execution instance’s instance data hash. More...
 
static Object getInstanceData (String key) throws Throwable
 Retrieves the value of the given key in the workflow execution instance’s instance data hash. More...
 
static HashMap< String, ObjectgetInstanceData (String... args) throws Throwable
 Retrieves the values of multiple keys from the workflow execution instance’s instance data hash. More...
 
static boolean stepExecuted (String stepname) throws Throwable
 This method returns true if the step passed has been executed and has status OMQ.StatComplete ("C") More...
 
static String getStepStatus (String stepname) throws Throwable
 Returns the current status of the given step for the current workflow order instance. More...
 
static HashMap< String, ObjectgetStepInfo () throws Throwable
 This method will return a hash of step information for the current step. More...
 
static HashMap< String, ObjectgetWorkflowInstanceData () throws Throwable
 Retrieves all available values from the workflow execution instance object itself. More...
 
static Object getWorkflowInstanceData (String key) throws Throwable
 Retrieves the value of a single key (system-defined property) from the workflow execution instance object itself. More...
 
static HashMap< String, ObjectgetWorkflowInstanceData (String... args) throws Throwable
 Retrieves the values of one or more keys (system-defined properties) from the workflow execution instance object itself. More...
 
static void setOrderKeys (HashMap< String, Object > h, boolean truncate) throws Throwable
 This method sets user-defined order keys against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void setOrderKeys (HashMap< String, Object > h) throws Throwable
 This method sets user-defined order keys against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void setOrderKey (String key, String value, boolean truncate) throws Throwable
 This method sets the values for a sinle user-defined order key against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void setOrderKey (String key, String value) throws Throwable
 This method sets the values for a sinle user-defined order key against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void setOrderKey (String key, String[] values, boolean truncate) throws Throwable
 This method sets the values for a sinle user-defined order key against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void setOrderKey (String key, Object... values) throws Throwable
 This method sets the values for a sinle user-defined order key against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void appendOrderKeys (HashMap< String, Object > h, boolean truncate) throws Throwable
 This method appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void appendOrderKeys (HashMap< String, Object > h) throws Throwable
 This method appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void appendOrderKeys (String key, String value, boolean truncate) throws Throwable
 This method appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static void appendOrderKeys (String key, Object... values) throws Throwable
 This method appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...
 
static Object getOrderKeys (String key) throws Throwable
 This method retrieves the user-defined order key information saved against the workflow order data instance. More...
 
static HashMap< String, ObjectgetOrderKeys (String... keys) throws Throwable
 This method retrieves the user-defined order key information saved against the workflow order data instance. More...
 
static HashMap< String, ObjectgetOrderKeys () throws Throwable
 This method retrieves the user-defined order key information saved against the workflow order data instance. More...
 
static HashMap< String, ObjectgetWorkflowMetadata () throws Throwable
 returns workflow metadata for the currently running workflow as a hash More...
 
static void setBlocked () throws Throwable
 set the current workflow order status to OMQ.StatBlocked, can only be called from the attach function More...
 
static HashMap< String, Object > [] getOrderNotes (int count) throws Throwable
 Get Order Instance Notes. More...
 
static HashMap< String, Object > [] getOrderNotes () throws Throwable
 Get Order Instance Notes. More...
 
static void addOrderNote (String notestr) throws Throwable
 Add new note as described in Order Instance Notes. More...
 
static void setCustomStatus (String stat) throws Throwable
 Sets a user-defined custom status for the current step. More...
 
static void rescheduleOrder (ZonedDateTime scheduled) throws Throwable
 reschedules the current workflow order instance for later processing More...
 
static void reprioritizeOrder (int prio) throws Throwable
 changes the order priority for the current workflow order instance More...
 
static void leaveParentFeedback (String key, Object value) throws Throwable
 leaves feedback for a parent workflow More...
 
static Object getChildFeedback (String key) throws Throwable
 gets feedback from a child workflow order with the given key More...
 
static HashMap< String, ObjectgetChildFeedback () throws Throwable
 gets all feedback from all child workflow orders as a hash More...
 
static Integer parentWfiid () throws Throwable
 Returns the parent workflow order data instance ID from a subworkflow or null if the current workflow order is not a subworkflow and therefore has no parent. More...
 
static HashMap< String, ObjectgetOption (String... keys) throws Throwable
 Returns the value of the named workflow options. More...
 
static Object getOption (String key) throws Throwable
 Returns the value of the named workflow option. More...
 
static HashMap< String, ObjectgetOption () throws Throwable
 Returns the value of all workflow options. More...
 
static void setOption (HashMap< String, Object > hash) throws Throwable
 Changes option values on a workflow. More...
 
static void setOption (String option, Object value) throws Throwable
 Changes a single option value on a workflow. More...
 
static Integer getWfiid () throws Throwable
 returns the current workflow_instanceid as an integer; returns null if not called in a workflow order context (ex: onetimeinit function, etc) More...
 
static int sleep (int arg) throws Throwable
 puts the current thread to sleep for a certain number of seconds More...
 
static int usleep (int arg) throws Throwable
 puts the current thread to sleep for a certain number of microseconds More...
 
static int usleep (QoreRelativeTime arg) throws Throwable
 puts the current thread to sleep for a certain number of microseconds More...
 
static Object getConfigItemValue (String item, HashMap< String, Object > local_context) throws Throwable
 returns the value of the given step configuration item More...
 
static Object getConfigItemValue (String item) throws Throwable
 returns the value of the given step configuration item More...
 
static HashMap< String, ObjectgetConfigItemHash (HashMap< String, Object > local_context) throws Throwable
 returns a hash of all configuration items for the current step as a combination of local and global configuration items More...
 
static HashMap< String, ObjectgetConfigItemHash () throws Throwable
 returns a hash of all configuration items for the current step as a combination of local and global configuration items More...
 
- Static Public Member Methods inherited from com.qoretechnologies.qorus.UserApi
static Integer auditUserEvent (String user_event, String info1, String info2) throws Throwable
 creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance More...
 
static Integer auditUserEvent (String user_event, String info1) throws Throwable
 creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance More...
 
static Integer auditUserEvent (String user_event) throws Throwable
 creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance More...
 
static boolean auditCheckEventString (String opt) throws Throwable
 checks if the given audit event (given as a string) is enabled More...
 
static boolean auditCheckEvent (int opt) throws Throwable
 checks if the given audit event (given as an integer code) is enabled More...
 
static int auditGetMask () throws Throwable
 returns the audit event mask More...
 
static int postUserEvent (String severity, Object info) throws Throwable
 posts an application event of class OMQ.QE_CLASS_USER More...
 
static HashMap< String, ObjectruntimeProperties () throws Throwable
 returns Qorus runtime properties as a hash More...
 
static Object callNetworkApi (String call, Object... args) throws Throwable
 calls a system RPC API and returns the result; the API is called with system permissions (no restrictions) More...
 
static Object callNetworkApiArgs (String call, Object[] args) throws Throwable
 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...
 
static Object callNetworkApiArgsWithAuthentication (String user, String pass, String call, Object[] args) throws Throwable
 calls a system RPC API with authentication information (username and password) More...
 
static Object callRestApi (String method, String path, HashMap< String, Object > body_args) throws Throwable
 calls a system REST API method and returns the result; the API is called with system permissions (no restrictions) More...
 
static Object callRestApi (String method, String path) throws Throwable
 calls a system REST API method and returns the result; the API is called with system permissions (no restrictions) More...
 
static Object callRestApiWithAuthentication (String user, String pass, String method, String path, HashMap< String, Object > body_args) throws Throwable
 calls a system REST API method with authentication information (username and password) and returns the result More...
 
static AbstractTable getSqlTable (String datasource, String table_name) throws Throwable
 get a cached table object (suitable for DML) if present, otherwise it creates one from scratch More...
 
static AbstractTable getSqlTable (AbstractDatasource datasource, String table_name) throws Throwable
 get a cached table object (suitable for DML) if present, otherwise it creates one from scratch More...
 
static HashMap< String, ObjectgetSqlCacheInfo () throws Throwable
 get information about cached object More...
 
static void clearSqlTableCache (String datasource, String table_name) throws Throwable
 clears the entry for the given datasource and table from the SQL cache (for example, if database objects have been updated in the dataserver) More...
 
static void clearSqlTableCache (String datasource) throws Throwable
 clears all objects for given datasource from the SQL cache (for example, if database objects have been updated in the dataserver) More...
 
static Object getValueMap (String mapname, String key) throws Throwable
 Gets a lookup value from the value map by a key; the value map must be registered to the current interface. More...
 
static HashMap< String, Object > [] getValueMaps () throws Throwable
 Gets all value maps valid for the current interface. More...
 
static boolean postSlaEventSuccess (String sla, float value) throws Throwable
 posts a successful SLA event for SLA monitoring and performance tracking More...
 
static boolean postSlaEventError (String sla, float value, String err, String desc) throws Throwable
 posts an unsuccessful SLA event for SLA monitoring and performance tracking More...
 
static void flushSlaEvents () throws Throwable
 flushes all pending SLA events to disk and returns after the data has been committed More...
 
static HashMap< String, ObjectgetSystemServiceInfo (String name) throws Throwable
 returns information about the given system service (if it's currently loaded) More...
 
static HashMap< String, ObjectgetServiceInfo (String type, String name) throws Throwable
 returns information about the given service (if it's currently loaded) More...
 
static HashMap< String, Object > [] getRunningWorkflowList (String name, String ver) throws Throwable
 returns a list of hashes giving information about the currently-running workflow execution instances More...
 
static HashMap< String, Object > [] getRunningWorkflowList (String name) throws Throwable
 returns a list of hashes giving information about the currently-running workflow execution instances More...
 
static HashMap< String, Object > [] getRunningWorkflowList () throws Throwable
 returns a list of hashes giving information about the currently-running workflow execution instances More...
 
static HashMap< String, ObjectgetRunningWorkflowInfo (int id) throws Throwable
 returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not More...
 
static int createOrder (String name, String version, HashMap< String, Object > params) throws Throwable
 creates a workflow order data instance in the database with status READY More...
 
static int createOrder (String name, String version, HashMap< String, Object > params, String status) throws Throwable
 creates a workflow order data instance in the database More...
 
static int createOrder (String name, HashMap< String, Object > params) throws Throwable
 creates a workflow order data instance in the database with status READY More...
 
static int createOrder (String name, HashMap< String, Object > params, String status) throws Throwable
 creates a workflow order data instance in the database More...
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params, String status, boolean register_dependency) throws Throwable
 creates a workflow order data instance in a remote Qorus instance More...
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params, String status) throws Throwable
 creates a workflow order data instance in a remote Qorus instance, establishing a connection dependency with the calling interface More...
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params) throws Throwable
 creates a workflow order data instance in a remote Qorus instance with status READY amd establishing a connection dependency with the calling interface More...
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params, String status, boolean register_dependency) throws Throwable
 creates a workflow order data instance in a remote Qorus instance More...
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params, String status) throws Throwable
 creates a workflow order data instance in a remote Qorus instance, establishing a connection dependency with the calling interface More...
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params) throws Throwable
 creates a workflow order data instance in a remote Qorus instance with status READY amd establishing a connection dependency with the calling interface More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, String version, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid, int parent_workflow_instanceid) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid, int parent_workflow_instanceid) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata) throws Throwable
 executes a workflow order synchronously and returns the final status and order ID in a hash More...
 
static HashMap< String, ObjectgetQorusOptions () throws Throwable
 returns the value of all system options More...
 
static Object getQorusOptions (String opt) throws Throwable
 returns the value of the given system option More...
 
static HashMap< String, ObjectgetQorusOptions (String... opts) throws Throwable
 returns the value of the given system options More...
 
static HashMap< String, ObjectgetQorusOptionsArgs (String[] opts) throws Throwable
 returns the value of the given system options More...
 
static HashMap< String, ObjectgetQorusOptionInfo () throws Throwable
 returns a hash giving information about system options More...
 
static HashMap< String, ObjectgetQorusOptionInfoArgs (String[] args) throws Throwable
 returns a hash giving information about system options More...
 
static HashMap< String, ObjectgetActiveJobs () throws Throwable
 Returns information on all active jobs visible to the calling user. More...
 
static Object getUserConnection (String name, boolean connect, boolean register_dependency, HashMap< String, Object > rtopts) throws Throwable
 Returns an object corresponding to a defined user connection. More...
 
static Object getUserConnection (String name, boolean connect, boolean register_dependency) throws Throwable
 Returns an object corresponding to a defined user connection. More...
 
static Object getUserConnection (String name, boolean connect) throws Throwable
 Returns an object corresponding to a defined user connection, establishing a dependency by default between the calling inteerface and the connection. More...
 
static Object getUserConnection (String name) throws Throwable
 Returns an object corresponding to a defined user connection, performing an automatic connection to the target and establishing a dependency by default between the calling inteerface and the connection. More...
 
static DatasourcePool getDatasourcePool (String name, boolean register_dependency) throws Throwable
 returns a DatasourcePool object for the given datasource name More...
 
static DatasourcePool getDatasourcePool (String name) throws Throwable
 returns a DatasourcePool object for the given datasource name; a dependency is created between the calling interface and the datasource More...
 
static HashMap< String, ObjectgetDatasourceInfo (String name) throws Throwable
 returns a hash of information for the given datasource, if known, otherwise throws an exception More...
 
static QorusSystemRestHelper getRemoteRestConnection (String name, boolean connect, boolean register_dependency) throws Throwable
 Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection. More...
 
static QorusSystemRestHelper getRemoteRestConnection (String name, boolean connect) throws Throwable
 Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection; a dependency is established between the current interface and the remote connection. More...
 
static QorusSystemRestHelper getRemoteRestConnection (String name) throws Throwable
 Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection; a dependency is established between the current interface and the remote connection and the connection is connected automatically. More...
 
static void raiseTransientAlert (String alert, String reason, HashMap< String, Object > info) throws Throwable
 raises a transient system alert from a workflow, service, or job More...
 
static void raiseTransientAlert (String alert, String reason) throws Throwable
 raises a transient system alert from a workflow, service, or job More...
 
static String qorusGetLocalUrl (String username, String password) throws Throwable
 returns a string giving the local system URL More...
 
static String qorusGetLocalUrl () throws Throwable
 returns a string giving the local system URL More...
 
static void setOption (HashMap< String, Object > hash) throws Throwable
 Changes option values on a workflow, service, or job. More...
 
static void setOption (String option, Object value) throws Throwable
 Changes a single option value on a workflow, service, or job. More...
 
static HashMap< String, ObjectgetOption (String... keys) throws Throwable
 Returns the value of the named workflow, service, or job option or options. More...
 
static Object getOption (String key) throws Throwable
 Returns the value of the named workflow, service, or job option. More...
 
static HashMap< String, ObjectgetOption () throws Throwable
 Returns the value of all workflow, service, or job options depending on the calling context. More...
 
static HashMap< String, ObjectblockOrder (int wfiid) throws Throwable
 block the given workflow order data instance More...
 
static HashMap< String, ObjectunblockOrder (int wfiid, HashMap< String, Object > tempdata, HashMap< String, Object > orderkeys) throws Throwable
 unblocks the given workflow order data instance More...
 
static HashMap< String, ObjectunblockOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
 unblocks the given workflow order data instance More...
 
static HashMap< String, ObjectunblockOrder (int wfiid) throws Throwable
 unblocks the given workflow order data instance More...
 
static HashMap< String, ObjectcancelOrder (int wfiid) throws Throwable
 cancel the given workflow order data instance More...
 
static HashMap< String, ObjectuncancelOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
 uncancels the given workflow order data instance More...
 
static HashMap< String, ObjectuncancelOrder (int wfiid) throws Throwable
 uncancels the given workflow order data instance More...
 
static HashMap< String, ObjectgetUserContextInfo () throws Throwable
 returns a hash for the current user context More...
 
static Object getGlobalConfigItemValue (String item) throws Throwable
 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 Mapper getMapper (String name, HashMap< String, Object > rtopts) throws Throwable
 returns the given mapper if registered for the current interface More...
 
static Mapper getMapper (String name) throws Throwable
 returns the given mapper if registered for the current interface More...
 
static boolean postSyncEvent (String eventtype, String eventkey) throws Throwable
 posts a workflow synchronization event given the event type name and the unique event key More...
 
static int getSessionId () throws Throwable
 returns the current Qorus application session ID More...
 
static HashMap< String, ObjectgetSystemInfo () throws Throwable
 returns a hash of system info More...
 
static HashMap< String, ObjectpropGet () throws Throwable
 returns a hash of all system properties in all domains More...
 
static HashMap< String, ObjectpropGet (String domain) throws Throwable
 returns a hash of all key-value pairs in the given domain or null if the system property domain does not exist More...
 
static HashMap< String, ObjectpropGet (String domain, String key) throws Throwable
 returns the value of the given system property key in the given domain or null if the system property does not exist More...
 
static String propUpdate (String domain, String key, Object value) throws Throwable
 changes (inserts, updates, or deletes) the value of a single system property More...
 
static void logFatal (String msg) throws Throwable
 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 void logError (String msg) throws Throwable
 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 void logWarn (String msg) throws Throwable
 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 void logInfo (String msg) throws Throwable
 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 void logDebug (String msg) throws Throwable
 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 void logTrace (String msg) throws Throwable
 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 void logFatal (String msg, Object... args) throws Throwable
 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 void logError (String msg, Object... args) throws Throwable
 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 void logWarn (String msg, Object... args) throws Throwable
 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 void logInfo (String msg, Object... args) throws Throwable
 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 void logDebug (String msg, Object... args) throws Throwable
 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 void logTrace (String msg, Object... args) throws Throwable
 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 getNextSequenceValue (AbstractDatasource ds, String name) throws Throwable
 returns the next sequence value for the given datasource and sequence More...
 
static int getNextSequenceValue (String ds, String name) throws Throwable
 returns the next sequence value for the given datasource and sequence More...
 
static String serializeQorusData (Object d) throws Throwable
 returns a string giving the default serialization of the given data structure for storage in Qorus More...
 
static String serializeQorusDataWithNothing (Object d) throws Throwable
 returns a string giving the default serialization of the given data structure for storage in Qorus More...
 
static Object deserializeQorusData (String data) throws Throwable
 parses a serialized data string and returns the corresponding data More...
 
static String restartTransaction (String driver, HashMap< String, Object > ex) throws Throwable
 returns a string error message if any exception in the chain passed was caused by a recoverable DB error, otherwise returns NOTHING More...
 
static String expandOneVariable (String str, String var_context, String var_name, HashMap< String, Object > local_context) throws Throwable
 expands one variable in a templated string More...
 
static Object expandTemplatedValue (String str, HashMap< String, Object > local_context) throws Throwable
 expands all variables in a templated string More...
 
static HashMap< String, ObjectbbParseExactlyOneVariable (String str) throws Throwable
 parses one template variable and returns a hash with its parts More...
 
static HashMap< String, ObjectgetInputData (String field_name, HashMap< String, Object > local_context, HashMap< String, Object > input_data_cfg) throws Throwable
 returns specified input data field's value More...
 
static HashMap< String, ObjectgetInputData (HashMap< String, Object > input_data_cfg, HashMap< String, Object > local_context) throws Throwable
 returns all input data More...
 
static void updateOutputData (String field_name, Object output_data, HashMap< String, Object > output_data_cfg) throws Throwable
 updates output data with the given configuration More...
 
static void updateOutputData (HashMap< String, Object > all_output_data, HashMap< String, Object > output_data_cfg) throws Throwable
 updates all output data More...
 
static String getTextFileFromLocation (String location) throws Throwable
 returns string data for the given file location More...
 
static byte [] getBinaryFileFromLocation (String location) throws Throwable
 returns binary data for the given file location More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.qoretechnologies.qorus.OMQ
static final String OT_CONSTANT = "CONSTANT"
 for constant library objects
 
static final String OT_CLASS = "CLASS"
 for class library objects
 
static final String OT_FUNCTION = "FUNCTION"
 for function library objects
 
static final String ExecNormal = "NORMAL"
 step attribute: for normal steps
 
static final String ExecAsync = "ASYNC"
 step attribute: for async steps
 
static final String ExecSubWorkflow = "SUBWORKFLOW"
 step attribute: for subworkflow steps
 
static final String ExecEvent = "EVENT"
 step attribute: for synchronization event steps
 
static final String SSRunning = "running"
 service status: running
 
static final String SSLoaded = "loaded"
 service status: running
 
static final String SLNone = "none"
 service lock type: none
 
static final String SLRead = "read"
 service lock type: read
 
static final String SLWrite = "write"
 service lock type: write
 
static final String SQLStatComplete = "C"
 SQL Status: COMPLETE. More...
 
static final String SQLStatError = "E"
 SQL Status: ERROR. More...
 
static final String SQLStatWaiting = "W"
 SQL Status: WAITING. More...
 
static final String SQLStatInProgress = "I"
 SQL Status: IN-PROGRESS. More...
 
static final String SQLStatIncomplete = "N"
 SQL Status: INCOMPLETE. More...
 
static final String SQLStatAsyncWaiting = "A"
 SQL Status: ASYNC-WAITING. More...
 
static final String SQLStatEventWaiting = "V"
 SQL Status: EVENT-WAITING. More...
 
static final String SQLStatRetry = "R"
 SQL Status: RETRY. More...
 
static final String SQLStatCanceled = "X"
 SQL Status: CANCELED. More...
 
static final String SQLStatReady = "Y"
 SQL Status: READY. More...
 
static final String SQLStatScheduled = "S"
 SQL Status: SCHEDULED. More...
 
static final String SQLStatBlocked = "B"
 SQL Status: BLOCKED. More...
 
static final int LL_CRITICAL = -1
 Log Level: CRITICAL.
 
static final int LL_IMPORTANT = 0
 Log Level: IMPORTANT.
 
static final int LL_INFO = 1
 Log Level: INFO.
 
static final int LL_DETAIL_1 = 2
 Log Level: DETAIL_1.
 
static final int LL_DETAIL_2 = 3
 Log Level: DETAIL_2.
 
static final int LL_DEBUG_1 = 4
 Log Level: DEBUG_1.
 
static final int LL_DEBUG_2 = 5
 Log Level: DEBUG_2.
 
static final int LL_DEBUG_3 = 6
 Log Level: DEBUG_3.
 
static final String WM_Normal = "NORMAL"
 Workflow Mode: NORMAL.
 
static final String WM_Recovery = "RECOVERY"
 Workflow Mode: RECOVERY.
 
static final String StatComplete = "COMPLETE"
 This status indicates that the object it is attached to has successfully completed its processing. More...
 
static final String StatError = "ERROR"
 Indicates that the workflow order data instance has at least one step with an OMQ.StatError status. More...
 
static final String StatWaiting = "WAITING"
 Indicates that subworkflow steps are in progress and the system is waiting on the subworkflows to become OMQ.StatComplete. More...
 
static final String StatInProgress = "IN-PROGRESS"
 Indicates that the workflow order data instance is currently being processed. More...
 
static final String StatIncomplete = "INCOMPLETE"
 Indicates that processing for the workflow order data instance is not yet complete yet has no errors. More...
 
static final String StatAsyncWaiting = "ASYNC-WAITING"
 Indicates that asynchronous steps are in process and the system is waiting on data to become available in the queue assigned to the step. More...
 
static final String StatEventWaiting = "EVENT-WAITING"
 Indicates that one or more workflow event synchronization steps are in progress and the workflow is waiting for the event(s) to be posted. More...
 
static final String StatRetry = "RETRY"
 Indicates that workflow processing on the order data instance has generated an error and is now waiting for an automatic retry. More...
 
static final String StatCanceled = "CANCELED"
 Indicates that workflow order data instance processing has been canceled. More...
 
static final String StatReady = "READY"
 Indicates that a workflow order data instance has been created and is waiting for processing to start. More...
 
static final String StatScheduled = "SCHEDULED"
 Indicates that a workflow order data instance has been created and has not yet been processed because at the time the order was created, the scheduled date (the earliest possible processing date) was in the future. More...
 
static final String StatBlocked = "BLOCKED"
 Indicates that workflow order data instance processing has been temporarily blocked. More...
 
static final Map< String, StringStatMap
 map from text descriptions to SQL status characters
 
static final Map< String, StringSQLStatMap
 hash mapping SQL status characters to text descriptions
 
static final String ES_Major = "MAJOR"
 Error Severity: MAJOR.
 
static final String ES_Warning = "WARNING"
 Error Severity: WARNING.
 
static final String CS_Clean = "C"
 order went to COMPLETE without any errors
 
static final String CS_RecoveredAuto = "A"
 order went to COMPLETE after being recovered automatically
 
static final String CS_RecoveredManual = "M"
 order went to COMPLETE after being recovered with manual retries
 
static final String QS_Waiting = "WAITING"
 Queue Status Text Description: WAITING. More...
 
static final String QS_Received = "RECEIVED"
 Queue Status Text Description: RECEIVED. More...
 
static final String QS_Error = "ERROR"
 Queue Status Text Description: ERROR. More...
 
static final String QS_Used = "USED"
 Queue Status Text Description: USED. More...
 
static final String SQL_QS_Waiting = "W"
 Queue Status SQL Character Code: WAITING. More...
 
static final String SQL_QS_Received = "R"
 Queue Status SQL Character Code: RECEIVED. More...
 
static final String SQL_QS_Error = "E"
 Queue Status SQL Character Code: ERROR. More...
 
static final String SQL_QS_Used = "X"
 Queue Status SQL Character Code: USED. More...
 
static final Map< String, StringQSMap
 map of queue status descriptions to the character code
 
static final Map< String, StringSQLQSMap
 map of queue status character codes to the description
 
static final String QR_LOGIN = "LOGIN"
 RBAC System Permission: "LOGIN". More...
 
static final String QR_SHUTDOWN = "SHUTDOWN"
 RBAC System Permission: "SHUTDOWN". More...
 
static final String QR_WORKFLOW_CONTROL = "WORKFLOW-CONTROL"
 RBAC System Permission: "WORKFLOW-CONTROL". More...
 
static final String QR_WORKFLOW_EXEC_CONTROL = "WORKFLOW-EXEC-CONTROL"
 RBAC System Permission: "WORKFLOW-EXEC-CONTROL". More...
 
static final String QR_START_WORKFLOW = "START-WORKFLOW"
 RBAC System Permission: "START-WORKFLOW". More...
 
static final String QR_STOP_WORKFLOW = "STOP-WORKFLOW"
 RBAC System Permission: "STOP-WORKFLOW". More...
 
static final String QR_RESET_WORKFLOW = "RESET-WORKFLOW"
 RBAC System Permission: "RESET-WORKFLOW". More...
 
static final String QR_WORKFLOW_OPTION_CONTROL = "WORKFLOW-OPTION-CONTROL"
 RBAC System Permission: "WORKFLOW-OPTION-CONTROL". More...
 
static final String QR_WORKFLOW_ERROR_CONTROL = "WORKFLOW-ERROR-CONTROL"
 RBAC System Permission: "WORKFLOW-ERROR-CONTROL". More...
 
static final String QR_WORKFLOW_ORDER_CONTROL = "WORKFLOW-ORDER-CONTROL"
 RBAC System Permission: "WORKFLOW-ORDER-CONTROL". More...
 
static final String QR_RETRY_WORKFLOW_ORDER = "RETRY-WORKFLOW-ORDER"
 RBAC System Permission: "RETRY-WORKFLOW-ORDER". More...
 
static final String QR_RESCHEDULE_WORKFLOW_ORDER = "RESCHEDULE-WORKFLOW-ORDER"
 RBAC System Permission: "RESCHEDULE-WORKFLOW-ORDER". More...
 
static final String QR_REPRIORITIZE_WORKFLOW_ORDER = "REPRIORITIZE-WORKFLOW-ORDER"
 RBAC System Permission: "REPRIORITIZE-WORKFLOW-ORDER". More...
 
static final String QR_BLOCK_WORKFLOW_ORDER = "BLOCK-WORKFLOW-ORDER"
 RBAC System Permission: "BLOCK-WORKFLOW-ORDER". More...
 
static final String QR_CANCEL_WORKFLOW_ORDER = "CANCEL-WORKFLOW-ORDER"
 RBAC System Permission: "CANCEL-WORKFLOW-ORDER". More...
 
static final String QR_SET_WORKFLOW_ORDER_ERROR = "SET-WORKFLOW-ORDER-ERROR"
 RBAC System Permission: "SET-WORKFLOW-ORDER-ERROR". More...
 
static final String QR_SKIP_STEP = "SKIP-STEP"
 RBAC System Permission: "SKIP-STEP". More...
 
static final String QR_SET_ORDER_INFO = "SET-ORDER-INFO"
 RBAC System Permission: "SET-ORDER-INFO". More...
 
static final String QR_POST_WORKFLOW_EVENT = "POST-WORKFLOW-EVENT"
 RBAC System Permission: "POST-WORKFLOW-EVENT". More...
 
static final String QR_LOCK_WORKFLOW_ORDER = "LOCK-WORKFLOW-ORDER"
 RBAC System Permission: "LOCK-WORKFLOW-ORDER". More...
 
static final String QR_BREAK_WORKFLOW_ORDER_LOCK = "BREAK-WORKFLOW-ORDER-LOCK"
 RBAC System Permission: "BREAK-WORKFLOW-ORDER-LOCK". More...
 
static final String QR_EDIT_WORKFLOW_DATA = "EDIT-WORKFLOW-DATA"
 RBAC System Permission: "EDIT-WORKFLOW-DATA". More...
 
static final String QR_READ_SENSITIVE_DATA = "READ-SENSITIVE-DATA"
 RBAC System Permission: "READ-SENSITIVE-DATA";. More...
 
static final String QR_EDIT_SENSITIVE_DATA = "EDIT-SENSITIVE-DATA"
 RBAC System Permission: "EDIT-SENSITIVE-DATA";. More...
 
static final String QR_DELETE_SENSITIVE_DATA = "DELETE-SENSITIVE-DATA"
 RBAC System Permission: "DELETE-SENSITIVE-DATA";. More...
 
static final String QR_SENSITIVE_DATA_CONTROL = "SENSITIVE-DATA-CONTROL"
 RBAC System Permission: "SENSITIVE-DATA-CONTROL";. More...
 
static final String QR_EXEC_SYNC_WORKFLOW = "EXEC-SYNC-WORKFLOW"
 RBAC System Permission: "EXEC-SYNC-WORKFLOW". More...
 
static final String QR_SUBMIT_ORDER = "SUBMIT-ORDER"
 RBAC System Permission: "SUBMIT-ORDER". More...
 
static final String QR_SET_STEP_CONFIG = "SET-STEP-CONFIG"
 RBAC System Permissions: "SET-STEP-CONFIG". More...
 
static final String QR_SET_WORKFLOW_CONFIG = "SET-WORKFLOW-CONFIG"
 RBAC System Permissions: "SET-WORKFLOW-CONFIG". More...
 
static final String QR_SERVICE_CONTROL = "SERVICE-CONTROL"
 RBAC System Permission: "SERVICE-CONTROL". More...
 
static final String QR_LOAD_SERVICE = "LOAD-SERVICE"
 RBAC System Permission: "LOAD-SERVICE". More...
 
static final String QR_UNLOAD_SERVICE = "UNLOAD-SERVICE"
 RBAC System Permission: "UNLOAD-SERVICE". More...
 
static final String QR_RESET_SERVICE = "RESET-SERVICE"
 RBAC System Permission: "RESET-SERVICE". More...
 
static final String QR_SET_SERVICE_AUTOSTART = "SET-SERVICE-AUTOSTART"
 RBAC System Permission: "SET-SERVICE-AUTOSTART". More...
 
static final String QR_SET_SERVICE_OPTIONS = "SET-SERVICE-OPTIONS"
 RBAC System Permission: "SET-SERVICE-OPTIONS". More...
 
static final String QR_CALL_USER_SERVICES_RO = "CALL-USER-SERVICES-RO"
 RBAC System Permission: "CALL-USER-SERVICES-RO". More...
 
static final String QR_CALL_SYSTEM_SERVICES_RO = "CALL-SYSTEM-SERVICES-RO"
 RBAC System Permission: "CALL-SYSTEM-SERVICES-RO". More...
 
static final String QR_CALL_USER_SERVICES_RW = "CALL-USER-SERVICES-RW"
 RBAC System Permission: "CALL-USER-SERVICES-RW". More...
 
static final String QR_CALL_SYSTEM_SERVICES_RW = "CALL-SYSTEM-SERVICES-RW"
 RBAC System Permission: "CALL-SYSTEM-SERVICES-RW". More...
 
static final String QR_SET_SERVICE_CONFIG = "SET-SERVICE-CONFIG"
 RBAC System Permissions: "SET-SERVICE-CONFIG". More...
 
static final String QR_USER_CONTROL = "USER-CONTROL"
 RBAC System Permission: "USER-CONTROL". More...
 
static final String QR_RELOAD_RBAC = "RELOAD-RBAC"
 RBAC System Permission: "RELOAD-RBAC". More...
 
static final String QR_ADD_USER = "ADD-USER"
 RBAC System Permission: "ADD-USER". More...
 
static final String QR_MODIFY_USER = "MODIFY-USER"
 RBAC System Permission: "MODIFY-USER". More...
 
static final String QR_DELETE_USER = "DELETE-USER"
 RBAC System Permission: "DELETE-USER". More...
 
static final String QR_ADD_PERMISSION = "ADD-PERMISSION"
 RBAC System Permission: "ADD-PERMISSION". More...
 
static final String QR_MODIFY_PERMISSION = "MODIFY-PERMISSION"
 RBAC System Permission: "MODIFY-PERMISSION". More...
 
static final String QR_DELETE_PERMISSION = "DELETE-PERMISSION"
 RBAC System Permission: "DELETE-PERMISSION". More...
 
static final String QR_ADD_ROLE = "ADD-ROLE"
 RBAC System Permission: "ADD-ROLE". More...
 
static final String QR_MODIFY_ROLE = "MODIFY-ROLE"
 RBAC System Permission: "MODIFY-ROLE". More...
 
static final String QR_DELETE_ROLE = "DELETE-ROLE"
 RBAC System Permission: "DELETE-ROLE". More...
 
static final String QR_OPTION_CONTROL = "OPTION-CONTROL"
 RBAC System Permission: "OPTION-CONTROL". More...
 
static final String QR_LOGGER_CONTROL = "LOGGER-CONTROL"
 RBAC System Permission: "LOGGER-CONTROL". More...
 
static final String QR_ROTATE_LOG_FILES = "ROTATE-LOG-FILES"
 RBAC System Permission: "ROTATE-LOG-FILES". More...
 
static final String QR_MODIFY_LOGGER = "MODIFY-LOGGER"
 RBAC System Permission: "MODIFY-LOGGER". More...
 
static final String QR_DELETE_LOGGER = "DELETE-LOGGER"
 RBAC System Permission: "DELETE-LOGGER". More...
 
static final String QR_CREATE_LOGGER = "CREATE-LOGGER"
 RBAC System Permission: "CREATE-LOGGER". More...
 
static final String QR_DATASOURCE_CONTROL = "DATASOURCE-CONTROL"
 RBAC System Permission: "DATASOURCE-CONTROL". More...
 
static final String QR_READ_DATASOURCE = "READ-DATASOURCE"
 RBAC System Permission: "READ-DATASOURCE". More...
 
static final String QR_ADD_DATASOURCE = "ADD-DATASOURCE"
 RBAC System Permission: "ADD-DATASOURCE". More...
 
static final String QR_SELECT_DATASOURCE = "SELECT-DATASOURCE"
 RBAC System Permission: "SELECT-DATASOURCE". More...
 
static final String QR_MODIFY_DATASOURCE = "MODIFY-DATASOURCE"
 RBAC System Permission: "MODIFY-DATASOURCE". More...
 
static final String QR_RESET_DATASOURCE = "RESET-DATASOURCE"
 RBAC System Permission: "RESET-DATASOURCE". More...
 
static final String QR_DELETE_DATASOURCE = "DELETE-DATASOURCE"
 RBAC System Permission: "DELETE-DATASOURCE". More...
 
static final String QR_RELOAD_DATASOURCE = "RELOAD-DATASOURCE"
 RBAC System Permission: "RELOAD-DATASOURCE". More...
 
static final String QR_FLUSH_DATASOURCE = "FLUSH-DATASOURCE"
 RBAC System Permission: "FLUSH-DATASOURCE". More...
 
static final String QR_SQLUTIL_READ = "SQLUTIL-READ"
 RBAC System Permission: "SQLUTIL-READ". More...
 
static final String QR_SQLUTIL_WRITE = "SQLUTIL-WRITE"
 RBAC System Permission: "SQLUTIL-WRITE". More...
 
static final String QR_GROUP_CONTROL = "GROUP-CONTROL"
 RBAC System Permission: "GROUP-CONTROL". More...
 
static final String QR_ADD_GROUP = "ADD-GROUP"
 RBAC System Permission: "ADD-GROUP". More...
 
static final String QR_MODIFY_GROUP = "MODIFY-GROUP"
 RBAC System Permission: "MODIFY-GROUP". More...
 
static final String QR_DELETE_GROUP = "DELETE-GROUP"
 RBAC System Permission: "DELETE-GROUP". More...
 
static final String QR_MODIFY_GROUP_STATUS = "MODIFY-GROUP-STATUS"
 RBAC System Permission: "MODIFY-GROUP-STATUS". More...
 
static final String QR_SERVER_CONTROL = "SERVER-CONTROL"
 RBAC System Permission: "SERVER-CONTROL". More...
 
static final String QR_SET_PROPERTY = "SET-PROPERTY"
 RBAC System Permission: "SET-PROPERTY". More...
 
static final String QR_DELETE_PROPERTY = "DELETE-PROPERTY"
 RBAC System Permission: "DELETE-PROPERTY". More...
 
static final String QR_RELOAD_PROPERTIES = "RELOAD-PROPERTIES"
 RBAC System Permission: "RELOAD-PROPERTIES". More...
 
static final String QR_START_LISTENER = "START-LISTENER"
 RBAC System Permission: "START-LISTENER". More...
 
static final String QR_STOP_LISTENER = "STOP-LISTENER"
 RBAC System Permission: "STOP-LISTENER". More...
 
static final String QR_JOB_CONTROL = "JOB-CONTROL"
 RBAC System Permission: "JOB-CONTROL". More...
 
static final String QR_RUN_JOB = "RUN-JOB"
 RBAC System Permission: "RUN-JOB". More...
 
static final String QR_MODIFY_JOB_STATUS = "MODIFY-JOB-STATUS"
 RBAC System Permission: "MODIFY-JOB-STATUS". More...
 
static final String QR_MODIFY_JOB_EXPIRY = "MODIFY-JOB-EXPIRY"
 RBAC System Permission: "MODIFY-JOB-EXPIRY". More...
 
static final String QR_RESCHEDULE_JOB = "RESCHEDULE-JOB"
 RBAC System Permission: "RESCHEDULE-JOB". More...
 
static final String QR_RESET_JOB = "RESET-JOB"
 RBAC System Permission: "RESET-JOB". More...
 
static final String QR_SET_JOB_OPTIONS = "SET-JOB-OPTIONS"
 RBAC System Permission: "SET-JOB-OPTIONS". More...
 
static final String QR_SET_JOB_CONFIG = "SET-JOB-CONFIG"
 RBAC System Permissions: "SET-JOB-CONFIG". More...
 
static final String QR_SCHEMA_CONTROL = "SCHEMA-CONTROL"
 RBAC System Permission: "SCHEMA-CONTROL". More...
 
static final String QR_USER_CONNECTION_CONTROL = "USER-CONNECTION-CONTROL"
 RBAC System Permission: "USER-CONNECTION-CONTROL". More...
 
static final String QR_READ_USER_CONNECTION = "READ-USER-CONNECTION"
 RBAC System Permission: "READ-USER-CONNECTION". More...
 
static final String QR_RELOAD_USER_CONNECTION = "RELOAD-USER-CONNECTION"
 RBAC System Permission: "RELOAD-USER-CONNECTION". More...
 
static final String QR_ADD_USER_CONNECTION = "ADD-USER-CONNECTION"
 RBAC System Permission: "ADD-USER-CONNECTION". More...
 
static final String QR_MODIFY_USER_CONNECTION = "MODIFY-USER-CONNECTION"
 RBAC System Permission: "MODIFY-USER-CONNECTION". More...
 
static final String QR_DELETE_USER_CONNECTION = "DELETE-USER-CONNECTION"
 RBAC System Permission: "DELETE-USER-CONNECTION". More...
 
static final String QR_SERVER_CONNECTION_CONTROL = "SERVER-CONNECTION-CONTROL"
 RBAC System Permission: "SERVER-CONNECTION-CONTROL". More...
 
static final String QR_RELOAD_SERVER_CONNECTION = "RELOAD-SERVER-CONNECTION"
 RBAC System Permission: "RELOAD-SERVER-CONNECTION". More...
 
static final String QR_READ_SERVER_CONNECTION = "READ-SERVER-CONNECTION"
 RBAC System Permission: "READ-SERVER-CONNECTION". More...
 
static final String QR_ADD_SERVER_CONNECTION = "ADD-SERVER-CONNECTION"
 RBAC System Permission: "ADD-SERVER-CONNECTION". More...
 
static final String QR_MODIFY_SERVER_CONNECTION = "MODIFY-SERVER-CONNECTION"
 RBAC System Permission: "MODIFY-SERVER-CONNECTION". More...
 
static final String QR_DELETE_SERVER_CONNECTION = "DELETE-SERVER-CONNECTION"
 RBAC System Permission: "DELETE-SERVER-CONNECTION". More...
 
static final String QR_FILESYSTEM_CONTROL = "FILESYSTEM-CONTROL"
 RBAC System Permission: "FILESYSTEM-CONTROL". More...
 
static final String QR_FILESYSTEM_READ = "FILESYSTEM-READ"
 RBAC System Permission: "FILESYSTEM-READ". More...
 
static final String QR_FILESYSTEM_WRITE = "FILESYSTEM-WRITE"
 RBAC System Permission: "FILESYSTEM-WRITE". More...
 
static final String QR_MAPPER_CONTROL = "MAPPER-CONTROL"
 RBAC System Permission: "MAPPER-CONTROL". More...
 
static final String QR_RELOAD_MAPPER = "RELOAD-MAPPER"
 RBAC System Permission: "RELOAD-MAPPER". More...
 
static final String QR_MODIFY_MAPPER = "MODIFY-MAPPER"
 RBAC System Permission: "MODIFY-MAPPER". More...
 
static final String QR_VALUE_MAP_CONTROL = "VALUE-MAP-CONTROL"
 RBAC System Permission: "VALUE-MAP-CONTROL". More...
 
static final String QR_RELOAD_VALUE_MAP = "RELOAD-VALUE-MAP"
 RBAC System Permission: "RELOAD-VALUE-MAP". More...
 
static final String QR_MODIFY_VALUE_MAP = "MODIFY-VALUE-MAP"
 RBAC System Permission: "MODIFY-VALUE-MAP". More...
 
static final String QR_CREATE_SLA = "CREATE-SLA"
 RBAC System Permission: "CREATE-SLA". More...
 
static final String QR_DELETE_SLA = "DELETE-SLA"
 RBAC System Permission: "DELETE-SLA". More...
 
static final String QR_MODIFY_SLA = "MODIFY-SLA"
 RBAC System Permission: "MODIFY-SLA". More...
 
static final String QR_SLA_CONTROL = "SLA-CONTROL"
 RBAC System Permission: "SLA-CONTROL". More...
 
static final String QR_DEBUG_CONTROL = "DEBUG-CONTROL"
 RBAC System Permission: "DEBUG-CONTROL". More...
 
static final int QE_CLASS_SYSTEM = 101
 Event Class Code for SYSTEM Events.
 
static final int QE_CLASS_WORKFLOW = 102
 Event Class Code for WORKFLOW Events.
 
static final int QE_CLASS_SERVICE = 103
 Event Class Code for SERVICE Events.
 
static final int QE_CLASS_USER = 104
 Event Class Code for USER Events.
 
static final int QE_CLASS_JOB = 105
 Event Class Code for JOB Events.
 
static final int QE_CLASS_ALERT = 106
 Event Class Code for ALERT Events.
 
static final int QE_CLASS_GROUP = 107
 Event Class Code for GROUP Events.
 
static final int QE_CLASS_CONNECTION = 108
 Event Class Code for CONNECTION events.
 
static final int QE_CLASS_PROCESS = 109
 Event Class Code for PROCESS events. More...
 
static final int QE_CLASS_CLUSTER = 110
 Event Class Code for CLUSTER events. More...
 
static final int QE_CLASS_LOGGER = 111
 Event Class Code for LOGGER events. More...
 
static final int QE_CLASS_CONFIG_ITEM = 112
 Event Class Code for CONFIG ITEM events. More...
 
static final Map< Integer, StringQE_MAP_CLASS
 hash mapping event class codes to descriptive strings
 
static final int QEC_SYSTEM_STARTUP = 1001
 Qorus Event Code: SYSTEM_STARTUP. More...
 
static final int QEC_SYSTEM_SHUTDOWN = 1002
 Qorus Event Code: SYSTEM_SHUTDOWN. More...
 
static final int QEC_SYSTEM_ERROR = 1003
 Qorus Event Code: SYSTEM_ERROR. More...
 
static final int QEC_SYSTEM_HEALTH_CHANGED = 1004
 Qorus Event Code: SYSTEM_HEALTH_CHANGED. More...
 
static final int QEC_SYSTEM_REMOTE_HEALTH_CHANGED = 1005
 Qorus Event Code: SYSTEM_REMOTE_HEALTH_CHANGED. More...
 
static final int QEC_GROUP_STATUS_CHANGED = 1101
 Qorus Event Code: GROUP_STATUS_CHANGED. More...
 
static final int QEC_WORKFLOW_START = 2001
 Qorus Event Code: WORKFLOW_START. More...
 
static final int QEC_WORKFLOW_STOP = 2002
 Qorus Event Code: WORKFLOW_STOP. More...
 
static final int QEC_WORKFLOW_CACHE_RESET = 2003
 Qorus Event Code: WORKFLOW_CACHE_RESET. More...
 
static final int QEC_WORKFLOW_DATA_SUBMITTED = 2004
 Qorus Event Code: WORKFLOW_DATA_SUBMITTED. More...
 
static final int QEC_WORKFLOW_DATA_ERROR = 2005
 Qorus Event Code: WORKFLOW_DATA_ERROR. More...
 
static final int QEC_WORKFLOW_DATA_RELEASED = 2006
 Qorus Event Code: WORKFLOW_DATA_RELEASED (workflow detach event) More...
 
static final int QEC_WORKFLOW_DATA_CACHED = 2007
 Qorus Event Code: WORKFLOW_DATA_CACHED (workflow attach event) More...
 
static final int QEC_WORKFLOW_INFO_CHANGED = 2008
 Qorus Event Code: WORKFLOW_INFO_CHANGED. More...
 
static final int QEC_WORKFLOW_STATUS_CHANGED = 2009
 Qorus Event Code: WORKFLOW_STATUS_CHANGED. More...
 
static final int QEC_WORKFLOW_STEP_PERFORMANCE = 2010
 Qorus Event Code:: WORKFLOW_STEP_PERFORMANCE. More...
 
static final int QEC_WORKFLOW_PERFORMANCE = 2011
 Qorus Event Code:: WORKFLOW_PERFORMANCE. More...
 
static final int QEC_WORKFLOW_DATA_LOCKED = 2012
 Qorus Event Code: WORKFLOW_DATA_LOCKED. More...
 
static final int QEC_WORKFLOW_DATA_UNLOCKED = 2013
 Qorus Event Code: WORKFLOW_DATA_UNLOCKED. More...
 
static final int QEC_WORKFLOW_DATA_UPDATED = 2014
 Qorus Event Code: WORKFLOW_DATA_UPDATED (static or dynamic data changed) More...
 
static final int QEC_WORKFLOW_STATS_UPDATED = 2015
 Qorus Event Code: WORKFLOW_STATS_UPDATED. More...
 
static final int QEC_WORKFLOW_RECOVERED = 2016
 Qorus Event Code: WORKFLOW_RECOVERED. More...
 
static final int QEC_WORKFLOW_UPDATED = 2017
 Qorus Event code: WORKFLOW_UPDATED. More...
 
static final int QEC_WORKFLOW_STEP_DATA_UPDATED = 2018
 Qorus Event Code: WORKFLOW_STEP_DATA_UPDATED (step dynamic data changed) More...
 
static final int QEC_SERVICE_START = 3001
 Qorus Event Code: SERVICE_START. More...
 
static final int QEC_SERVICE_STOP = 3002
 Qorus Event Code: SERVICE_STOP. More...
 
static final int QEC_SERVICE_ERROR = 3003
 Qorus Event Code: SERVICE_ERROR. More...
 
static final int QEC_SERVICE_AUTOSTART_CHANGE = 3004
 Qorus Event Code: SERVICE_AUTOSTART_CHANGE. More...
 
static final int QEC_SERVICE_METHOD_PERFORMANCE = 3005
 Qorus Event Code:: SERVICE_METHOD_PERFORMANCE. More...
 
static final int QEC_SERVICE_UPDATED = 3006
 Qorus Event code: SERVICE_UPDATED. More...
 
static final int QEC_JOB_START = 4001
 Qorus Event Code: JOB_START. More...
 
static final int QEC_JOB_STOP = 4002
 Qorus Event Code: JOB_STOP. More...
 
static final int QEC_JOB_ERROR = 4003
 Qorus Event Code: JOB_ERROR. More...
 
static final int QEC_JOB_INSTANCE_START = 4004
 Qorus Event Code: JOB_INSTANCE_START. More...
 
static final int QEC_JOB_INSTANCE_STOP = 4005
 Qorus Event Code: JOB_INSTANCE_STOP. More...
 
static final int QEC_JOB_RECOVERED = 4006
 Qorus Event Code: JOB_RECOVERED. More...
 
static final int QEC_JOB_UPDATED = 4007
 Qorus Event code: JOB_UPDATED. More...
 
static final int QEC_CONFIG_ITEM_CHANGED = 4100
 Qorus Event code: CONFIG_ITEM_CHANGED. More...
 
static final int QEC_ALERT_ONGOING_RAISED = 5006
 Qorus Event Code: ALERT_ONGOING_RAISED. More...
 
static final int QEC_ALERT_ONGOING_CLEARED = 5007
 Qorus Event Code: ALERT_ONGOING_CLEARED. More...
 
static final int QEC_ALERT_TRANSIENT_RAISED = 5008
 Qorus Event Code: ALERT_TRANSIENT_RAISED. More...
 
static final int QEC_CONNECTION_UP = 5101
 Qorus Event Code: CONNECTION_UP. More...
 
static final int QEC_CONNECTION_DOWN = 5102
 Qorus Event Code: CONNECTION_DOWN. More...
 
static final int QEC_CONNECTION_ENABLED_CHANGE = 5103
 Qorus Event Code: CONNECTION_ENABLED_CHANGE. More...
 
static final int QEC_CONNECTION_CREATED = 5104
 Qorus Event Code: CONNECTION_CREATED. More...
 
static final int QEC_CONNECTION_UPDATED = 5105
 Qorus Event Code: CONNECTION_UPDATED. More...
 
static final int QEC_CONNECTION_DELETED = 5106
 Qorus Event Code: CONNECTION_DELETED. More...
 
static final int QEC_CONNECTIONS_RELOADED = 5107
 Qorus Event Code: CONNECTIONS_RELOADED. More...
 
static final int QEC_LOGGER_CREATED = 5108
 Qorus Event Code: LOGGER_CREATED. More...
 
static final int QEC_LOGGER_UPDATED = 5109
 Qorus Event Code: LOGGER_UPDATED. More...
 
static final int QEC_LOGGER_DELETED = 5110
 Qorus Event Code: LOGGER_DELETED. More...
 
static final int QEC_APPENDER_CREATED = 5111
 Qorus Event Code: APPENDER_CREATED. More...
 
static final int QEC_APPENDER_DELETED = 5112
 Qorus Event Code: APPENDER_DELETED. More...
 
static final int QEC_APPENDER_UPDATED = 5113
 Qorus Event Code: APPENDER_UPDATED. More...
 
static final int QEC_PROCESS_STARTED = 6001
 Qorus Event Code: PROCESS_STARTED. More...
 
static final int QEC_PROCESS_STOPPED = 6002
 Qorus Event Code: PROCESS_STOPPED. More...
 
static final int QEC_PROCESS_START_ERROR = 6003
 Qorus Event Code: PROCESS_START_ERROR. More...
 
static final int QEC_PROCESS_MEMORY_CHANGED = 6004
 Qorus Event Code: PROCESS_MEMORY_CHANGED. More...
 
static final int QEC_NODE_INFO = 7001
 Qorus Event Code: NODE_INFO. More...
 
static final int QEC_USER_EVENT = 9001
 Qorus Event Code: USER_EVENT. More...
 
static final Map< Integer, StringQE_MAP_EVENT
 hash mapping event codes to descriptive strings
 
static final int QSE_OK = 0
 Qorus Startup Error Code: no error.
 
static final int QSE_NO_INSTANCE_KEY = 1
 Qorus Startup Error Code: no instance key set.
 
static final int QSE_INVALID_DB_MAX_THREADS = 2
 Qorus Startup Error Code: invalid db-max-threads option.
 
static final int QSE_DATASOURCE = 3
 Qorus Startup Error Code: can't open system datasources.
 
static final int QSE_LOG_ERROR = 4
 Qorus Startup Error Code: error opening system log files.
 
static final int QSE_RBAC_ERROR = 5
 Qorus Startup Error Code: error initializing RBAC framework.
 
static final int QSE_EVENT_ERROR = 6
 Qorus Startup Error Code: error initializing event framework.
 
static final int QSE_SESSION_ERROR = 7
 Qorus Startup Error Code: error opening or recovering application session.
 
static final int QSE_COMMAND_LINE_ERROR = 8
 Qorus Startup Error Code: error in command-line options.
 
static final int QSE_OPTION_ERROR = 9
 Qorus Startup Error Code: error setting options on startup.
 
static final int QSE_VERSION_ONLY = 10
 Qorus Startup Error Code: command-line option requested version display and exit.
 
static final int QSE_STARTUP_ERROR = 99
 Qorus Startup Error Code: other error starting server.
 
static final int DefaultOrderPriority = 500
 default order priority
 
static final String JS_Complete = "COMPLETE"
 Job Status Text Description: COMPLETE. More...
 
static final String JS_InProgress = "IN-PROGRESS"
 Job Status Text Description: IN-PROGRESS. More...
 
static final String JS_Error = "ERROR"
 Job Status Text Description: ERROR. More...
 
static final String JS_Crash = "CRASH"
 Job Status Text Description: CRASH. More...
 
static final String SQL_JS_Complete = "C"
 Job Status SQL Character Code: COMPLETE. More...
 
static final String SQL_JS_InProgress = "I"
 Job Status SQL Character Code: IN-PROGRESS. More...
 
static final String SQL_JS_Error = "E"
 Job Status SQL Character Code: ERROR. More...
 
static final String SQL_JS_Crash = "Z"
 Job Status SQL Character Code: CRASH. More...
 
static final Map< String, StringJSMap
 map of Job status descriptions to the character code
 
static final Map< String, StringSQLJSMap
 map of Job status character codes to the description
 
static final int AE_USER_EVENT = 1
 user event audit code More...
 
static final int AE_SYSTEM_STARTUP = 2
 system startup audit code More...
 
static final int AE_SYSTEM_SHUTDOWN = 3
 system shutdown audit code More...
 
static final int AE_SYSTEM_RECOVERY_START = 4
 system recovery start audit code More...
 
static final int AE_SYSTEM_RECOVERY_COMPLETE = 5
 system recovery complete audit code More...
 
static final int AE_WORKFLOW_STATUS_CHANGE = 6
 workflow status change audit code More...
 
static final int AE_WORKFLOW_START = 7
 workflow start audit code More...
 
static final int AE_WORKFLOW_STOP = 8
 workflow stop audit code More...
 
static final int AE_SERVICE_START = 9
 service start audit code More...
 
static final int AE_SERVICE_STOP = 10
 service stop audit code More...
 
static final int AE_JOB_START = 11
 job start audit code More...
 
static final int AE_JOB_STOP = 12
 job stop audit code More...
 
static final int AE_JOB_INSTANCE_START = 13
 job instance start audit code More...
 
static final int AE_JOB_INSTANCE_STOP = 14
 job instance stop audit code More...
 
static final int AE_API_CALL = 15
 api call audit code More...
 
static final int AE_JOB_RECOVERY = 16
 job recovery audit code More...
 
static final int AE_WORKFLOW_DATA_CREATED = 17
 workflow order data created audit code More...
 
static final int AE_ALERT_ONGOING_RAISED = 18
 ongoing alert raised audit code More...
 
static final int AE_ALERT_ONGOING_CLEARED = 19
 ongoing alert cleared audit code More...
 
static final int AE_ALERT_TRANSIENT_RAISED = 20
 transient alert raised audit code More...
 
static final int AE_SOURCE_FILE_LOADED = 21
 source file loaded into the system schema by oload More...
 
static final int AE_GROUP_STATUS_CHANGED = 22
 group status changed audit code More...
 
static final String AES_USER_EVENT = "USER-EVENT"
 user event audit code More...
 
static final String AES_SYSTEM_STARTUP = "SYSTEM-STARTUP"
 system startup audit code More...
 
static final String AES_SYSTEM_SHUTDOWN = "SYSTEM-SHUTDOWN"
 system shutdown audit code More...
 
static final String AES_SYSTEM_RECOVERY_START = "SYSTEM-RECOVERY-START"
 system recovery start audit code More...
 
static final String AES_SYSTEM_RECOVERY_COMPLETE = "SYSTEM-RECOVERY-COMPLETE"
 system recovery complete audit code More...
 
static final String AES_WORKFLOW_STATUS_CHANGE = "WORKFLOW-STATUS-CHANGE"
 workflow status change audit code More...
 
static final String AES_WORKFLOW_START = "WORKFLOW-START"
 workflow start audit code More...
 
static final String AES_WORKFLOW_STOP = "WORKFLOW-STOP"
 workflow stop audit code More...
 
static final String AES_SERVICE_START = "SERVICE-START"
 service start audit code More...
 
static final String AES_SERVICE_STOP = "SERVICE-STOP"
 service stop audit code More...
 
static final String AES_JOB_START = "JOB-START"
 job start audit code More...
 
static final String AES_JOB_STOP = "JOB-STOP"
 job stop audit code More...
 
static final String AES_JOB_INSTANCE_START = "JOB-INSTANCE-STOP"
 job instance start audit code More...
 
static final String AES_JOB_INSTANCE_STOP = "JOB-INSTANCE-START"
 job instance stop audit code More...
 
static final String AES_API_CALL = "API-CALL"
 api call audit code More...
 
static final String AES_JOB_RECOVERY = "JOB-RECOVERY"
 job recovery audit code More...
 
static final String AES_WORKFLOW_DATA_CREATED = "WORKFLOW-DATA-CREATED"
 workflow order data created audit code More...
 
static final String AES_ALERT_ONGOING_RAISED = "ALERT-ONGOING-RAISED"
 ongoing alert raised audit code More...
 
static final String AES_ALERT_ONGOING_CLEARED = "ALERT-ONGOING-CLEARED"
 ongoing alert cleared audit code More...
 
static final String AES_ALERT_TRANSIENT_RAISED = "ALERT-TRANSIENT-RAISED"
 transient alert raised audit code More...
 
static final String AES_SOURCE_FILE_LOADED = "SOURCE-FILE-LOADED"
 source file loaded into the system schema by oload audit code More...
 
static final String AES_GROUP_STATUS_CHANGED = "GROUP-STATUS-CHANGED"
 group status changed audit code More...
 
static final Map< Integer, StringAuditEventMap
 map of audit event codes to descriptions
 
static final Map< String, Integer > AuditEventCodeMap
 map of audit event descriptions to codes
 
static final String AO_SYSTEM = "system"
 Audit option: system events. More...
 
static final String AO_WORKFLOWS = "workflows"
 Audit option: workflow events. More...
 
static final String AO_WORKFLOW_DATA = "workflow-data"
 Audit option: workflow data events. More...
 
static final String AO_JOBS = "jobs"
 Audit option: job events. More...
 
static final String AO_JOB_DATA = "job-data"
 Audit option: job data events. More...
 
static final String AO_SERVICES = "services"
 Audit option: service events. More...
 
static final String AO_API = "api"
 Audit option: api write events. More...
 
static final String AO_USER_EVENTS = "user-events"
 Audit option: user events. More...
 
static final String AO_OLOAD_EVENTS = "oload"
 Audit option: oload events. More...
 
static final String AO_ALERT_EVENTS = "alerts"
 Audit option: alert events. More...
 
static final String AO_GROUP_EVENTS = "groups"
 Audit option: RBAC interface group events. More...
 
static final int AOC_SYSTEM = (1 << 0)
 Audit option code: system events. More...
 
static final int AOC_WORKFLOWS = (1 << 1)
 Audit option code: workflow events.
 
static final int AOC_WORKFLOW_DATA = (1 << 2)
 Audit option code: workflow data events.
 
static final int AOC_JOBS = (1 << 3)
 Audit option code: job events.
 
static final int AOC_JOB_DATA = (1 << 4)
 Audit option code: job data events.
 
static final int AOC_SERVICES = (1 << 5)
 Audit option code: service events.
 
static final int AOC_API = (1 << 6)
 Audit option code: api write events.
 
static final int AOC_USER_EVENTS = (1 << 7)
 Audit option code: user events.
 
static final int AOC_OLOAD_EVENTS = (1 << 8)
 Audit option code: oload events. More...
 
static final int AOC_ALERT_EVENTS = (1 << 9)
 Audit option code: alert events. More...
 
static final int AOC_GROUP_EVENTS = (1 << 10)
 Audit option code: RBAC interface group events. More...
 
static final int AuditMask = (AOC_SYSTEM|AOC_WORKFLOWS|AOC_WORKFLOW_DATA|AOC_JOBS|AOC_JOB_DATA|AOC_SERVICES|AOC_API|AOC_USER_EVENTS|AOC_OLOAD_EVENTS|AOC_ALERT_EVENTS|AOC_GROUP_EVENTS)
 mask of all audit options
 
static final Map< String, Integer > AuditOptionMap
 map of audit options to audit codes
 
static final Map< Integer, StringAuditCodeMap
 map of audit codes to audit options
 

Detailed Description

The main Qorus Java workflow API class.

Member Function Documentation

◆ addOrderNote()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.addOrderNote ( String  notestr) throws Throwable
inlinestatic

Add new note as described in Order Instance Notes.

Parameters
notestra string with note
See also

◆ appendOrderKeys() [1/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.appendOrderKeys ( HashMap< String, Object h,
boolean  truncate 
) throws Throwable
inlinestatic

This method appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value.

The hash provided appends orders keys to the workflow order; existing order keys matching keys given in the hash provided as an argument to this method are updated and any new keys are added.

The data is committed to the database before the method returns.

Parameters
hkey-value pairs to append to workflow order keys; the keys in this hash must match those defined for the workflow
truncateallow key values to be truncated without an error
Exceptions
APPEND-ORDER-KEYS-ERRORempty hash passed to wf_append_order_keys()
INVALID-WORKFLOW-KEYinvalid key for workflow
SET-ORDER-KEYS-ERRORan invalid data type (not convertible to a string) was given as a key value
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ appendOrderKeys() [2/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.appendOrderKeys ( HashMap< String, Object h) throws Throwable
inlinestatic

This method appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value.

The hash provided appends orders keys to the workflow order; existing order keys matching keys given in the hash provided as an argument to this method are updated and any new keys are added.

The data is committed to the database before the method returns.

Parameters
hkey-value pairs to append to workflow order keys; the keys in this hash must match those defined for the workflow
Exceptions
APPEND-ORDER-KEYS-ERRORempty hash passed to wf_append_order_keys()
INVALID-WORKFLOW-KEYinvalid key for workflow
SET-ORDER-KEYS-ERRORan invalid data type (not convertible to a string) was given as a key value
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ appendOrderKeys() [3/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.appendOrderKeys ( String  key,
String  value,
boolean  truncate 
) throws Throwable
inlinestatic

This method appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value.

This method appends order keys to the workflow order; existing order keys matching keys given in the arguments provided are updated and any new keys are added.

The data is committed to the database before the method returns.

Parameters
keythe workflow order key to append to; this key must match a defined workflow order key
valuethe value to append for the given key
truncateallow key values to be truncated without an error
Exceptions
APPEND-ORDER-KEYS-ERRORempty hash passed to wf_append_order_keys()
INVALID-WORKFLOW-KEYinvalid key for workflow
DUPLICATE-KEY-VALUEan order key was assigned a value more than once
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ appendOrderKeys() [4/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.appendOrderKeys ( String  key,
Object...  values 
) throws Throwable
inlinestatic

This method appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value.

This method appends order keys to the workflow order; existing order keys matching keys given in the arguments provided are updated and any new keys are added.

The data is committed to the database before the method returns.

Parameters
keythe workflow order key to append to; this key must match a defined workflow order key
valuesthe value(s) to append for the given key; must be directly convertible to String
Exceptions
APPEND-ORDER-KEYS-ERRORempty hash passed to wf_append_order_keys()
INVALID-WORKFLOW-KEYinvalid key for workflow
DUPLICATE-KEY-VALUEan order key was assigned a value more than once
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ deleteDynamicDataKey() [1/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.deleteDynamicDataKey ( String...  keys) throws Throwable
inlinestatic

Deletes one or more keys from the workflow order data instance’s dynamic data hash.

Dynamic data is directly linked to the order data the workflow execution instance is processing.

Changes are committed to the database before the method returns.

See also
Workflow Order Dynamic Data
Parameters
keysa list of keys to delete in the workflow order's dynamic data
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ deleteDynamicDataKey() [2/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.deleteDynamicDataKey ( String  key) throws Throwable
inlinestatic

Deletes one key from the workflow order data instance’s dynamic data hash.

Dynamic data is directly linked to the order data the workflow execution instance is processing.

Changes are committed to the database before the method returns.

See also
Workflow Order Dynamic Data
Parameters
keya single key to delete in the workflow order's dynamic data
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ deleteInstanceDataKey()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.deleteInstanceDataKey ( String...  keys) throws Throwable
inlinestatic

Deletes a single key or a list of keys from the workflow execution instance’s instance data hash.

Parameters
keysa single key or a list of strings (keys) to delete in workflow execution instance data
See also

◆ deleteSensitiveData()

static boolean com.qoretechnologies.qorus.workflow.WorkflowApi.deleteSensitiveData ( String  skey,
String  svalue 
) throws Throwable
inlinestatic

Deletes the sensitive data hash for the given sensitive data key and value; changes have already been committed to the database when this method returns.

Example:
WorkflowApi.deleteSensitiveData("personal_id", personal_id);
Parameters
skeythe type of sensitive key provided in svalue
svaluethe value of the sensitive data key identified by skey
Returns
true if the data existed and was deleted, false if no such sensitive data key and value were present in the order
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ deleteSensitiveDataKey()

static boolean com.qoretechnologies.qorus.workflow.WorkflowApi.deleteSensitiveDataKey ( String  skey,
String  svalue,
String...  keys 
) throws Throwable
inlinestatic

Deletes one or more keys from the workflow order data instance’s sensitive data hash for the given sensitive data key and value; changes have already been committed to the database when this method returns.

Example:
// delete the "tax_number" and "insurance_number" keys from the sensitive data hash for the given person
WorkflowApi.deleteSensitiveDataKey("personal_id", personal_id, "tax_number", "insurance_number");

Changes are committed to the database before the method returns.

Parameters
skeythe type of sensitive key provided in svalue
svaluethe value of the sensitive data key identified by skey
keysa single key or a list of keys to delete in the workflow order's sensitive data hash for the given sensitive key-value pair
Returns
true if the data existed and was deleted, false if no data was deleted
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ deleteTempDataKey()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.deleteTempDataKey ( String...  keys) throws Throwable
inlinestatic

Deletes one or more keys from the workflow order data instance’s temporary data hash.

Parameters
keysa list of strings (keys) to delete in workflow temporary data
See also

◆ generateUniqueKey()

static String com.qoretechnologies.qorus.workflow.WorkflowApi.generateUniqueKey ( ) throws Throwable
inlinestatic

returns a unique async key for the order for use with submitAsyncKey()

the generated key uses the workflow_instanceid, stepid, and ind number for the step to generate a unique key. Another alterative would be to call UUID.randomUUID().toString()

See also

◆ getChildFeedback() [1/2]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getChildFeedback ( String  key) throws Throwable
inlinestatic

gets feedback from a child workflow order with the given key

the child workflow has to set a value with the given key first with leaveParentFeedback() for any value to be returned with this method call

Parameters
keythe feedback key name used by the child workflow
Returns
the value of the feedback saved by the child workflow order with leaveParentFeedback() under the given key
See also

◆ getChildFeedback() [2/2]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getChildFeedback ( ) throws Throwable
inlinestatic

gets all feedback from all child workflow orders as a hash

child workflows have to set feedback values with leaveParentFeedback() for any value to be returned with this method call

Returns
a hash representing all feedback values saved by child workflow orders with leaveParentFeedback()
See also

◆ getConfigItemHash() [1/2]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getConfigItemHash ( HashMap< String, Object local_context) throws Throwable
inlinestatic

returns a hash of all configuration items for the current step as a combination of local and global configuration items

Example:
HashMap<String, Object> config = WorkflowApi.getConfigItemHash(local_context);
Parameters
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
Returns
a hash of all configuration items for the current step; keys are config item names; values are config item values. If there are no config items for the current step, then an empty hash is returned.
Note
  • if there are local configuration item values and values on global level, local values will take precedence over the global values
  • values are always substituted with UserApi.expandTemplatedValue(); make sure and escape any "$" characters with a backslash ("\") to avoid template substitution
See also
Class-Based Step Configuration Items

◆ getConfigItemHash() [2/2]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getConfigItemHash ( ) throws Throwable
inlinestatic

returns a hash of all configuration items for the current step as a combination of local and global configuration items

Example:
HashMap<String, Object> config = WorkflowApi.getConfigItemHash();
Returns
a hash of all configuration items for the current step; keys are config item names; values are config item values. If there are no config items for the current step, then an empty hash is returned.
Note
  • if there are local configuration item values and values on global level, local values will take precedence over the global values
  • values are always substituted with UserApi.expandTemplatedValue(); make sure and escape any "$" characters with a backslash ("\") to avoid template substitution
See also
Class-Based Step Configuration Items

◆ getConfigItemValue() [1/2]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getConfigItemValue ( String  item,
HashMap< String, Object local_context 
) throws Throwable
inlinestatic

returns the value of the given step configuration item

Example:
Object val = WorkflowApi.getConfigItemValue(item, local_context);
Parameters
itemthe name of the step configuration item; step configuration item values take precedence over values on workflow level. Values on workflow level take precedence over values on global level. If there is no value on the previous levels then the default value is returned.
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
Returns
the value of the given configuration item
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Note
Any global configuration item declared for any step in a workflow can be accessed in any other step in that workflow regardless of whether the step declared the global configuration item or not.
the value is always substituted with UserApi.expandTemplatedValue(); make sure and escape any "$" characters with a backslash ("\") to avoid template substitution
See also
Class-Based Step Configuration Items

◆ getConfigItemValue() [2/2]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getConfigItemValue ( String  item) throws Throwable
inlinestatic

returns the value of the given step configuration item

Example:
Object val = WorkflowApi.getConfigItemValue(item);
Parameters
itemthe name of the step configuration item; step configuration item values take precedence over values on workflow level. Values on workflow level take precedence over values on global level. If there is no value on the previous levels then the default value is returned.
Returns
the value of the given configuration item
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Note
Any global configuration item declared for any step in a workflow can be accessed in any other step in that workflow regardless of whether the step declared the global configuration item or not.
the value is always substituted with UserApi.expandTemplatedValue(); make sure and escape any "$" characters with a backslash ("\") to avoid template substitution
See also
Class-Based Step Configuration Items

◆ getDynamicData() [1/3]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getDynamicData ( String  key) throws Throwable
inlinestatic

Retrieves the value of one keys from the workflow order data instance’s dynamic data hash.

Dynamic data is directly linked to the order data the workflow execution instance is processing.

See also
Workflow Order Dynamic Data
Parameters
keythe dynamic data key value to return
Returns
the value of the dynamic data key given
See also

◆ getDynamicData() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getDynamicData ( String...  keys) throws Throwable
inlinestatic

Retrieves the values of one or more keys from the workflow order data instance’s dynamic data hash.

Dynamic data is directly linked to the order data the workflow execution instance is processing.

See also
Workflow Order Dynamic Data
Parameters
keysthe dynamic data key values to return
Returns
if a single string argument is passed, the value of that key is returned, otherwise a hash is returned giving the values of all the keys requested
See also

◆ getDynamicData() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getDynamicData ( ) throws Throwable
inlinestatic

Retrieves the entire workflow order data instance’s dynamic data hash.

Dynamic data is directly linked to the order data the workflow execution instance is processing.

See also
Workflow Order Dynamic Data
Returns
the entire dynamic data hash for the order
See also

◆ getInstanceData() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getInstanceData ( ) throws Throwable
inlinestatic

Retrieves the workflow execution instance’s instance data hash.

This data is set by the user (by calling updateInstanceData()) and is not associated to the order data being processed, but rather directly with the workflow execution instance. In this sense, this data is similar to global variables in a program.

Returns
a hash of workflow execution instance data
See also
Note
not to be confused with wf_get_workflow_instance_data(), which returns system properties of the workflow execution instance

◆ getInstanceData() [2/3]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getInstanceData ( String  key) throws Throwable
inlinestatic

Retrieves the value of the given key in the workflow execution instance’s instance data hash.

This data is set by the user (by calling updateInstanceData()) and is not associated to the order data being processed, but rather directly with the workflow execution instance. In this sense, this data is similar to global variables in a program.

Parameters
keythe key value to retrieve
Returns
a single value in the workflow execution instance data hash
See also
Note
not to be confused with getWorkflowInstanceData(), which returns system properties of the workflow execution instance

◆ getInstanceData() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getInstanceData ( String...  args) throws Throwable
inlinestatic

Retrieves the values of multiple keys from the workflow execution instance’s instance data hash.

This data is set by the user (by calling updateInstanceData()) and is not associated to the order data being processed, but rather directly with the workflow execution instance. In this sense, this data is similar to global variables in a program.

Returns
a hash of workflow execution instance data corresponding to the arguments
See also
Note
not to be confused with wf_get_workflow_instance_data(), which returns system properties of the workflow execution instance

◆ getOption() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getOption ( String...  keys) throws Throwable
inlinestatic

Returns the value of the named workflow options.

If the option is not set on the workflow, and it is a valid system option, then the value of the system option will be returned.

Returns
a hash of requested option keys and values
Note
Invalid options do not cause an errors to be raised; the associated key values in the hash returned will be null
See also
WorkflowApi::getOption()

◆ getOption() [2/3]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getOption ( String  key) throws Throwable
inlinestatic

Returns the value of the named workflow option.

If the option is not set on the workflow, and it is a valid system option, then the value of the system option will be returned.

Returns
the value of the requested option
Note
Invalid options do not cause an errors to be raised; the associated key values in the hash returned will be null
See also
WorkflowApi::getOption()

◆ getOption() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getOption ( ) throws Throwable
inlinestatic

Returns the value of all workflow options.

Returns
all workflow-level options are returned as a hash
See also
WorkflowApi::getOption()

◆ getOrderKeys() [1/3]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getOrderKeys ( String  key) throws Throwable
inlinestatic

This method retrieves the user-defined order key information saved against the workflow order data instance.

Parameters
keythe order key to return
Returns
the value of the given key is returned
See also

◆ getOrderKeys() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getOrderKeys ( String...  keys) throws Throwable
inlinestatic

This method retrieves the user-defined order key information saved against the workflow order data instance.

Parameters
keysa list of String key values
Returns
a hash is returned giving the values of all the keys requested
See also

◆ getOrderKeys() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getOrderKeys ( ) throws Throwable
inlinestatic

This method retrieves the user-defined order key information saved against the workflow order data instance.

Returns
a hash is returned giving the values of all the keys requested
See also

◆ getOrderNotes() [1/2]

static HashMap<String, Object> [] com.qoretechnologies.qorus.workflow.WorkflowApi.getOrderNotes ( int  count) throws Throwable
inlinestatic

Get Order Instance Notes.

Parameters
countan optional integer to limit the list size
Returns
list of hashes of Order Instance Notes
See also

◆ getOrderNotes() [2/2]

static HashMap<String, Object> [] com.qoretechnologies.qorus.workflow.WorkflowApi.getOrderNotes ( ) throws Throwable
inlinestatic

◆ getSensitiveData() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveData ( String  skey,
String  svalue,
String...  keys 
) throws Throwable
inlinestatic

Returns the sensitive data hash for the given sensitive data key and value.

Example:
HashMap<String, Object> hm = WorkflowApi.getSensitiveData("personal_id", personal_id).get("tax_number", "address");
Parameters
skeythe type of sensitive key provided in svalue
svaluethe value of the sensitive data key identified by skey
keyssensitive data keys for the given key and value
Returns
the sensitive data hash stored according to the sensitive data key and value; if no such sensitive key and value exist for the order, then NOTHING is returned
Note
returns sensitive data; take care not to log any of the data returned by this method
See also

◆ getSensitiveData() [2/3]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveData ( String  skey,
String  svalue,
String  key 
) throws Throwable
inlinestatic

Returns the sensitive data hash for the given sensitive data key and value.

Example:
String tax_number = WorkflowApi.getSensitiveData("personal_id", personal_id).get("tax_number");
Parameters
skeythe type of sensitive key provided in svalue
svaluethe value of the sensitive data key identified by skey
keya sensitive data key for the given key and value
Returns
the sensitive data value for the given key
Note
returns sensitive data; take care not to log any of the data returned by this method
See also

◆ getSensitiveData() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveData ( String  skey,
String  svalue 
) throws Throwable
inlinestatic

Returns the sensitive data hash for the given sensitive data key and value.

Example:
String tax_number = WorkflowApi.getSensitiveData("personal_id", personal_id).get("tax_number");
Parameters
skeythe type of sensitive key provided in svalue
svaluethe value of the sensitive data key identified by skey
Returns
the sensitive data hash stored according to the sensitive data key and value; if no such sensitive key and value exist for the order, then NOTHING is returned
Note
returns sensitive data; take care not to log any of the data returned by this method
See also

◆ getSensitiveDataAliases()

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveDataAliases ( ) throws Throwable
inlinestatic

returns a hash of all sensitive data aliases for the current order or an empty hash if there are none

Example:
HashMap<String, Object> ah = WorkflowApi.getSensitiveDataAliases();
Returns
a hash of all sensitive data aliases for the current order or an empty hash if there are none, otherwise keys are alias names and values are hashes with the following keys:
  • skey: (string) the sensitive data key type
  • svalue: (string) the sensitive data value (considered sensitive itself)
Note
returns sensitive data; sensitive data values (svalue) should not be logged
See also

◆ getSensitiveDataFromAlias() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveDataFromAlias ( String  alias,
String...  keys 
) throws Throwable
inlinestatic

returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of one or more keys in the workflow sensitive data hash for the given sensitive data alias corresponding to a sensitive data key and value

Example:
// get the tax number for the person
String tax_number = WorkflowApi.getSensitiveDataFromAlias("0", "tax_number").get("value");
Parameters
aliasthe alias to lookup; if the alias is unknown, an INVALID-ALIAS exception is raised
keysString key fields to return
Returns
a hash of information corresponding to the arguments; the hash returned has the following keys:
  • skey: (string) the sensitive data key type
  • svalue: (string) the sensitive data value
  • value: a hash givin the values of the requested keys
Exceptions
INVALID-ALIASthe given alias is unknown
Note
returns sensitive data; take care not to log any of the data returned by this method
See also

◆ getSensitiveDataFromAlias() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveDataFromAlias ( String  alias,
String  key 
) throws Throwable
inlinestatic

returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of one or more keys in the workflow sensitive data hash for the given sensitive data alias corresponding to a sensitive data key and value

Example:
// get the tax number for the person
String tax_number = WorkflowApi.getSensitiveDataFromAlias("0", "tax_number").get("value");
Parameters
aliasthe alias to lookup; if the alias is unknown, an INVALID-ALIAS exception is raised
keythe key field to return
Returns
a hash of information corresponding to the arguments; the hash returned has the following keys:
  • skey: (string) the sensitive data key type
  • svalue: (string) the sensitive data value
  • value: the value of the requested key
Exceptions
INVALID-ALIASthe given alias is unknown
Note
returns sensitive data; take care not to log any of the data returned by this method
See also

◆ getSensitiveDataFromAlias() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveDataFromAlias ( String  alias) throws Throwable
inlinestatic

returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of one or more keys in the workflow sensitive data hash for the given sensitive data alias corresponding to a sensitive data key and value

Example:
// get the tax number for the person
String tax_number = WorkflowApi.getSensitiveDataFromAlias("0").get("value").get("tax_number");
Parameters
aliasthe alias to lookup; if the alias is unknown, an INVALID-ALIAS exception is raised
Returns
a hash of information corresponding to the arguments; the hash returned has the following keys:
  • skey: (string) the sensitive data key type
  • svalue: (string) the sensitive data value
  • value: the value of the entire hash
Exceptions
INVALID-ALIASthe given alias is unknown
Note
returns sensitive data; take care not to log any of the data returned by this method
See also

◆ getSensitiveDataKeyValues()

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveDataKeyValues ( ) throws Throwable
inlinestatic

Returns a hash of sensitive data keys and values saved against the order; the sensitive data hashes themselves are not returned, just the information used to index sensitive data against the order.

Example:
HashMap<String, Object> h = WorkflowApi.getSensitiveDataKeyValues();
Returns
a hash of sensitive data keys and values saved against the order; the sensitive data hashes themselves are not returned, just the informat ion used to index sensitive data against the order; if no sensitive data is stored against the order, an empty hash is returned
Note
returns sensitive data; sensitive data values should not be logged
See also

◆ getSensitiveMetadata()

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveMetadata ( String  skey,
String  svalue 
) throws Throwable
inlinestatic

Returns the sensitive metadata hash for the given sensitive data key and value if present, otherwise returns an empty hash.

Example:
HashMap<String, Object> metadata = WorkflowApi.getSensitiveMetadata("personal_id", personal_id);
Parameters
skeythe type of sensitive key provided in svalue
svaluethe value of the sensitive data key identified by skey
Returns
the sensitive metadata hash stored according to the sensitive data key and value; if no such sensitive key and value exist for the order, or no metadata is present for the given sensitive key and value, then an empty hash is returned
Note
returns sensitive data; take care not to log any of the data returned by this method
See also

◆ getSensitiveMetadataFromAlias()

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getSensitiveMetadataFromAlias ( String  alias) throws Throwable
inlinestatic

returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of the sensitive metadata hash for the given sensitive data alias corresponding to a sensitive data key and value

Example:
// get sensitive metadata
HashMap<String, Object> metadata = WorkflowApi.getSensitiveMetadataFromAlias("0").get("value");
Parameters
aliasthe alias to lookup; if the alias is unknown, an INVALID-ALIAS exception is raised
Returns
a hash of information corresponding to the arguments; the hash returned has the following keys:
  • skey: (string) the sensitive data key type
  • svalue: (string) the sensitive data value (considered sensitive itself)
  • value: (hash) the value of the sensitive metadata hash, if any
Exceptions
INVALID-ALIASthe given alias is unknown
Note
returns sensitive data; take care not to log any of the sensitive data returned by this method
See also

◆ getStaticData() [1/3]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getStaticData ( String  key) throws Throwable
inlinestatic

Retrieves the value of one key from the workflow order data instance’s static data hash.

Workflow order static data is the primary workflow order data and corresponds to the deserialized contents of the database field ORDER_INSTANCE.STATICDATA for the current workflow order data instance.

Parameters
keythe static data key value to return
Returns
the value of the requested key is returned
See also

◆ getStaticData() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getStaticData ( String...  keys) throws Throwable
inlinestatic

Retrieves the values of multiple keys from the workflow order data instance’s static data hash.

Workflow order static data is the primary workflow order data and corresponds to the deserialized contents of the database field ORDER_INSTANCE.STATICDATA for the current workflow order data instance.

Parameters
keysthe static data key values to return
Returns
a hash is returned giving the values of all the keys requested
See also

◆ getStaticData() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getStaticData ( ) throws Throwable
inlinestatic

Retrieves the entire workflow order data instance’s static data hash.

Workflow order static data is the primary workflow order data and corresponds to the deserialized contents of the database field ORDER_INSTANCE.STATICDATA for the current workflow order data instance.

Returns
the entire static data hash for the order
See also

◆ getStepInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getStepInfo ( ) throws Throwable
inlinestatic

This method will return a hash of step information for the current step.

Returns
if not called from a step; returns NOTHING, otherwise returns a hash with the following members:
See also

◆ getStepStatus()

static String com.qoretechnologies.qorus.workflow.WorkflowApi.getStepStatus ( String  stepname) throws Throwable
inlinestatic

Returns the current status of the given step for the current workflow order instance.

If the step name does not exist then an exception is thrown

Returns
the current status of the given step for the current workflow order instance
See also

◆ getTempData() [1/3]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getTempData ( String  key) throws Throwable
inlinestatic

Retrieves the value of one key from the workflow order data instance’s temporary data hash.

See also
Workflow Temporary Data
Returns
the value of the requested key is returned
See also

◆ getTempData() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getTempData ( String...  keys) throws Throwable
inlinestatic

Retrieves the values multiple keys from the workflow order data instance’s temporary data hash.

See also
Workflow Temporary Data
Parameters
keysthe keys in the worklfow order data instance's temporary data hash
Returns
a hash is returned giving the values of all the keys requested
See also

◆ getTempData() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getTempData ( ) throws Throwable
inlinestatic

Retrieves the entire workflow order data instance’s temporary data hash.

See also
Workflow Temporary Data
Returns
the entire workflow order data instance’s temporary data hash
See also

◆ getWfiid()

static Integer com.qoretechnologies.qorus.workflow.WorkflowApi.getWfiid ( ) throws Throwable
inlinestatic

returns the current workflow_instanceid as an integer; returns null if not called in a workflow order context (ex: onetimeinit function, etc)

Returns
the current workflow_instanceid as an integer; returns null if not called in a workflow order context (ex: onetimeinit function, etc)
See also

◆ getWorkflowInstanceData() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getWorkflowInstanceData ( ) throws Throwable
inlinestatic

Retrieves all available values from the workflow execution instance object itself.

Returns
a hash of key-value pairs giving the value of the given keys in the current workflow execution instance
Exceptions
GET-WORKFLOW-INSTANCE-DATA-ERRORinvalid arguments to method
See also
Note
not to be confused with wf_get_instance_data()

◆ getWorkflowInstanceData() [2/3]

static Object com.qoretechnologies.qorus.workflow.WorkflowApi.getWorkflowInstanceData ( String  key) throws Throwable
inlinestatic

Retrieves the value of a single key (system-defined property) from the workflow execution instance object itself.

Parameters
keythe workflow execution instance key; see Running Workflow Execution Instance Properties for valid keys
Returns
the value of the key in the current workflow execution instance
See also
Note
not to be confused with wf_get_instance_data()

◆ getWorkflowInstanceData() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getWorkflowInstanceData ( String...  args) throws Throwable
inlinestatic

Retrieves the values of one or more keys (system-defined properties) from the workflow execution instance object itself.

Pass a single string argument, in which case on the value of that key is returned, or a list of strings, in which case a hash is returned giving the values of all the keys requested; see Running Workflow Execution Instance Properties for valid keys; if no arguments are passed, then a hash of all possible keys is returned

Returns
a hash of key-value pairs giving the value of the given keys in the current workflow execution instance
Exceptions
GET-WORKFLOW-INSTANCE-DATA-ERRORinvalid arguments to method
See also
Note
not to be confused with getInstanceData()

◆ getWorkflowMetadata()

static HashMap<String, Object> com.qoretechnologies.qorus.workflow.WorkflowApi.getWorkflowMetadata ( ) throws Throwable
inlinestatic

returns workflow metadata for the currently running workflow as a hash

Returns
a hash of workflow metadata; see Workflow Metadata for the hash description
See also

◆ leaveParentFeedback()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.leaveParentFeedback ( String  key,
Object  value 
) throws Throwable
inlinestatic

leaves feedback for a parent workflow

When this call returns, the feedback data has already been committed to the database.

Parameters
keythe key name for the feedback in the parent workflow
valuethe value of the key
Exceptions
FEEDBACK-ERRORthe current workflow is not a subworkflow; value is null or an error occurred accessing the parent workflow order
SESSION-ERRORthe parent workflow order is being processed by another Qorus session
STATUS-ERRORthe parent workflow order is already COMPLETE or CANCELED and cannot be updated

The parent workflow should then call getChildFeedback() to get the feedback data left by the child workflow.

See also
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible

◆ parentWfiid()

static Integer com.qoretechnologies.qorus.workflow.WorkflowApi.parentWfiid ( ) throws Throwable
inlinestatic

Returns the parent workflow order data instance ID from a subworkflow or null if the current workflow order is not a subworkflow and therefore has no parent.

Returns
the parent workflow order data instance ID of a subworkflow or null if the current workflow order is not a subworkflow
See also

◆ reprioritizeOrder()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.reprioritizeOrder ( int  prio) throws Throwable
inlinestatic

changes the order priority for the current workflow order instance

Parameters
priomust be an integer >= 0 and <= 999
Note
the order priority can be changed externally by calling the system API method omq.system.reprioritize-order()
See also

◆ rescheduleOrder()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.rescheduleOrder ( ZonedDateTime  scheduled) throws Throwable
inlinestatic

reschedules the current workflow order instance for later processing

Can only be called in the attach function; calling anywhere else will cause an exception to be raised. Can only be called when the workflow order has status OMQ.StatReady or OMQ.StatScheduled; otherwise an exception will be raised.

Parameters
scheduledIf the date is ealier than the current time; then this call is ignored
Exceptions
RESCHEDULE-ERRORmethod not called from the attach function; order data does not have OMQ.StatReady or OMQ.StatScheduled status
Note
the scheduled date can be changed or cleared by calling the system API method omq.system.reschedule-order()
See also

◆ setBlocked()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setBlocked ( ) throws Throwable
inlinestatic

set the current workflow order status to OMQ.StatBlocked, can only be called from the attach function

Processing of the workflow order will stop after this call; in order to be further processed the workflow order must be unblocked

Exceptions
BLOCK-ERRORmethod not called from attach function
Note
This method can only be called in the attach function of the workflow; if called from any other code, an exception will result.
See also

◆ setCustomStatus()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setCustomStatus ( String  stat) throws Throwable
inlinestatic

Sets a user-defined custom status for the current step.

The custom status is also propagatef to the segment and workflow order data instances. The status is reset when the step is updated subsequently. The value of the custom status is only used for display purposes; it does not affect Qorus’ internal behavior at all.

Parameters
statthe custom user-defined status to set for the step
Exceptions
CUSTOM-STATUS-ERRORthis exception is thrown if this method is called outside of step code
Note
The custom status must be a single character
See also

◆ setOption() [1/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setOption ( HashMap< String, Object hash) throws Throwable
inlinestatic

Changes option values on a workflow.

If the workflow has defined workflow options and at least one invalid option is passed to the method, an exception will be raised; however all other valid options in the hash will be set before the exception is raised

Parameters
hasha hash of option-value pairs
Exceptions
WORKFLOW-OPTION-ERRORinvalid option name
See also
WorkflowApi::setOption()

◆ setOption() [2/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setOption ( String  option,
Object  value 
) throws Throwable
inlinestatic

Changes a single option value on a workflow.

If the workflow has defined workflow options and an invalid option is passed to the method, an exception will be raised.

Parameters
optionthe option to set
valuethe value to set for the option
Exceptions
WORKFLOW-OPTION-ERRORinvalid option name
See also
WorkflowApi::setOption()

◆ setOrderKey() [1/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setOrderKey ( String  key,
String  value,
boolean  truncate 
) throws Throwable
inlinestatic

This method sets the values for a sinle user-defined order key against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value.

The value provided replaces any order key value on the workflow order

The data is committed to the database before the method returns.

Parameters
keythe workflow key to set; must be a valid workflow key
valueone or more string values for the workflow key
truncateallow key values to be truncated without an error
Exceptions
INVALID-WORKFLOW-KEYinvalid key for workflow
DUPLICATE-KEY-VALUEan order key was assigned a value more than once
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ setOrderKey() [2/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setOrderKey ( String  key,
String  value 
) throws Throwable
inlinestatic

This method sets the values for a sinle user-defined order key against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value.

The value provided replaces any order key value on the workflow order

The data is committed to the database before the method returns.

Parameters
keythe workflow key to set; must be a valid workflow key
valueone or more string values for the workflow key
Exceptions
INVALID-WORKFLOW-KEYinvalid key for workflow
DUPLICATE-KEY-VALUEan order key was assigned a value more than once
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ setOrderKey() [3/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setOrderKey ( String  key,
String []  values,
boolean  truncate 
) throws Throwable
inlinestatic

This method sets the values for a sinle user-defined order key against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value.

The value provided replaces any order key value on the workflow order

The data is committed to the database before the method returns.

Parameters
keythe workflow key to set; must be a valid workflow key
valuesone or more string values for the workflow key
truncateallow key values to be truncated without an error
Exceptions
INVALID-WORKFLOW-KEYinvalid key for workflow
DUPLICATE-KEY-VALUEan order key was assigned a value more than once
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ setOrderKey() [4/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setOrderKey ( String  key,
Object...  values 
) throws Throwable
inlinestatic

This method sets the values for a sinle user-defined order key against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value.

The value provided replaces any order key value on the workflow order

The data is committed to the database before the method returns.

Parameters
keythe workflow key to set; must be a valid workflow key
valuesone or more values for the workflow key; values must be directly convertible to String
Exceptions
INVALID-WORKFLOW-KEYinvalid key for workflow
DUPLICATE-KEY-VALUEan order key was assigned a value more than once
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ setOrderKeys() [1/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setOrderKeys ( HashMap< String, Object h,
boolean  truncate 
) throws Throwable
inlinestatic

This method sets user-defined order keys against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value.

The hash provided replaces orders keys on the workflow order; existing order keys matching keys given in the hash provided as an argument to this method are replaced and any new keys in the hash are added.

The data is committed to the database before the method returns.

Parameters
hkey-value pairs to set for order keys; the keys in this hash must match those defined for the workflow
truncateallow key values to be truncated without an error
Exceptions
SET-ORDER-KEYS-ERRORempty hash passed to wf_set_order_keys()
INVALID-WORKFLOW-KEYinvalid key for workflow
DUPLICATE-KEY-VALUEan order key was assigned a value more than once
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ setOrderKeys() [2/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setOrderKeys ( HashMap< String, Object h) throws Throwable
inlinestatic

This method sets user-defined order keys against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value.

The hash provided replaces orders keys on the workflow order; existing order keys matching keys given in the hash provided as an argument to this method are replaced and any new keys in the hash are added.

The data is committed to the database before the method returns.

Parameters
hkey-value pairs to set for order keys; the keys in this hash must match those defined for the workflow
Exceptions
SET-ORDER-KEYS-ERRORempty hash passed to wf_set_order_keys()
INVALID-WORKFLOW-KEYinvalid key for workflow
DUPLICATE-KEY-VALUEan order key was assigned a value more than once
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ setRetryDelay()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.setRetryDelay ( int  secs) throws Throwable
inlinestatic

Sets the value of the retry delay for an asynchronous step.

Only takes effect when called from an asynchronous step that will receive an OMQ.StatAsyncWaiting ("A") status or when called from a normal step after an error has been raised that will cause the step to get a OMQ.StatRetry ("R") status. Note that if this method is called before an error is raised, the retry delay setting will be lost.

Otherwise, to affect the retry of a normal step when an error has been raised that will give the step a status of OMQ.StatRetry ("R"), you can also use the stepError() method with the optional third argument giving the retry delay instead of calling this method after the call to stepError().

Parameters
secsthe amount of time in seconds to wait until a retry is made; overrides any value in the error definition
See also

◆ sleep()

static int com.qoretechnologies.qorus.workflow.WorkflowApi.sleep ( int  arg) throws Throwable
inlinestatic

puts the current thread to sleep for a certain number of seconds

If the worklow is stopping, this method returns immediately with a return value of -1; otherwise the current thread is put to sleep for the full time period requested. If this method (or usleep()) is called again after -1 is returned, then a "STOP-ERROR" exception is thrown.

Parameters
argthe number of seconds to sleep
Returns
0 if current thread was put to sleep for the full time period; -1 if the sleep was interrupted because the current object is being stopped
Exceptions
STOP-ERRORthe current object is stopping and this method already returned -1 as a warning
See also

◆ stepError() [1/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.stepError ( String  err,
Object  info,
int  retry_delay_secs 
) throws Throwable
inlinestatic

Raises an error against the current step without affecting the flow of processing.

This method will affect the final status of the step, segment, and workflow, if the severity of the error is OMQ.ES_Major or OMQ::ES_Fatal. If the error raised is not defined, severity OMQ.ES_Major is assumed.

Parameters
errthe string error code
infoadditional information for the error; should normally be a string in order to be logged in the database; if not a string then it will be converted to a string for saving in error history
retry_delay_secsthe amount of time in seconds to wait until a retry is made; overrides any value in the error definition
Note
workflow errors can also be raised by throwing an exception; this method does not affect the flow of execution in the step
See also

◆ stepError() [2/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.stepError ( String  err,
int  retry_delay_secs 
) throws Throwable
inlinestatic

Raises an error against the current step without affecting the flow of processing.

This method will affect the final status of the step, segment, and workflow, if the severity of the error is OMQ.ES_Major or OMQ::ES_Fatal. If the error raised is not defined, severity OMQ.ES_Major is assumed.

Parameters
errthe string error code
retry_delay_secsthe amount of time in seconds to wait until a retry is made; overrides any value in the error definition
Note
workflow errors can also be raised by throwing an exception; this method does not affect the flow of execution in the step
See also

◆ stepError() [3/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.stepError ( String  err,
Object  info 
) throws Throwable
inlinestatic

Raises an error against the current step without affecting the flow of processing.

This method will affect the final status of the step, segment, and workflow, if the severity of the error is OMQ.ES_Major or OMQ::ES_Fatal. If the error raised is not defined, severity OMQ.ES_Major is assumed.

Parameters
errthe string error code
infoadditional information for the error; should normally be a string in order to be logged in the database; if not a string then it will be converted to a string for saving in error history
Note
workflow errors can also be raised by throwing an exception; this method does not affect the flow of execution in the step
See also

◆ stepError() [4/4]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.stepError ( String  err) throws Throwable
inlinestatic

Raises an error against the current step without affecting the flow of processing.

This method will affect the final status of the step, segment, and workflow, if the severity of the error is OMQ.ES_Major or OMQ::ES_Fatal. If the error raised is not defined, severity OMQ.ES_Major is assumed.

Parameters
errthe string error code
Note
workflow errors can also be raised by throwing an exception; this method does not affect the flow of execution in the step
See also

◆ stepExecuted()

static boolean com.qoretechnologies.qorus.workflow.WorkflowApi.stepExecuted ( String  stepname) throws Throwable
inlinestatic

This method returns true if the step passed has been executed and has status OMQ.StatComplete ("C")

If the step name does not exist then an exception is thrown

Returns
True if the step passed has been executed and has status OMQ.StatComplete ("C")
See also

◆ stepWarning() [1/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.stepWarning ( String  err,
Object  info 
) throws Throwable
inlinestatic

Raises a warning against the step.

The information is logged, but does not affect the step’s status.

Parameters
errthe string warning code
infoadditional information for the warning; should normally be a string in order to be logged in the database; if not a string then it will be converted to a string for saving in error history
See also

◆ stepWarning() [2/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.stepWarning ( String  err) throws Throwable
inlinestatic

Raises a warning against the step.

The information is logged, but does not affect the step’s status.

Parameters
errthe string warning code
See also

◆ updateDynamicData()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.updateDynamicData ( HashMap< String, Object hash) throws Throwable
inlinestatic

Updates the values of one or more keys in the workflow order data instance’s dynamic data hash.

Dynamic data is directly linked to the order data the workflow execution instance is processing.

Changes are committed to the database before the method returns.

See also
Workflow Order Dynamic Data
Parameters
hashthe key-value pairs to update in dynamic data
Note
  • this call does not replace the dynamic data hash; any keys in the hash parameter are added to the dynamic data hash
  • the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also

◆ updateInstanceData()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.updateInstanceData ( HashMap< String, Object hash) throws Throwable
inlinestatic

Updates the values of one or more keys in the workflow execution instance’s instance data hash.

Parameters
hashthe key-value pairs to update in workflow execution instance data
See also

◆ updateSensitiveData() [1/3]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.updateSensitiveData ( String  skey,
String  svalue,
HashMap< String, Object hash,
String []  aliases,
HashMap< String, Object meta 
) throws Throwable
inlinestatic

Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data key and value.

Example:
WorkflowApi.updateSensitiveData("personal_id", h.get("personal_id"), h, aliases, meta);
Parameters
skeythe type of value provided in svalue; must not be longer than 100 bytes long or a SENSITIVE-DATA-ERROR exception is raised
svaluethe value of the sensitive data key identified by skey; if this string is empty or longer than 100 bytes, a SENSITIVE-DATA-ERR OR exception is raised
hashthe data to create or update against skey; existing keys will be replaced; new keys will be added; if the new hash does not refer to existing keys, then those existing keys remain untouched
aliasesother values for the sensitive data
metaoptional sensitve data metadata with the following recommended keys:
  • PURPOSE: free-form information about the purpose of the sensitive data
  • CATEGORIES: free-form information about the categories of sensitive data
  • RECIPIENTS: free-form information about the recipients or recipient catories of sensitive data
  • STORAGE: free-form information about the storage time or rules for sensitive data
Exceptions
SENSITIVE-DATA-ERRORno sensitive key value was provided; sensitive key value too long (100 bytes maximum length in the encoding used by the system schema)
Note
  • do not use sensitive data for the sensitive key names itself (skey); key names are logged to provide an audit trail of changes to sensitive data
  • metadata keys listed above for the meta argument are recommended for consistency's sake but are not checked; a hash with any keys can be stored with this API
See also

◆ updateSensitiveData() [2/3]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.updateSensitiveData ( String  skey,
String  svalue,
HashMap< String, Object hash,
String []  aliases 
) throws Throwable
inlinestatic

Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data key and value.

Example:
WorkflowApi.updateSensitiveData("personal_id", h.get("personal_id"), h, aliases, meta);
Parameters
skeythe type of value provided in svalue; must not be longer than 100 bytes long or a SENSITIVE-DATA-ERROR exception is raised
svaluethe value of the sensitive data key identified by skey; if this string is empty or longer than 100 bytes, a SENSITIVE-DATA-ERR OR exception is raised
hashthe data to create or update against skey; existing keys will be replaced; new keys will be added; if the new hash does not refer to existing keys, then those existing keys remain untouched
aliasesother values for the sensitive data
Exceptions
SENSITIVE-DATA-ERRORno sensitive key value was provided; sensitive key value too long (100 bytes maximum length in the encoding used by the system schema)
Note
  • do not use sensitive data for the sensitive key names itself (skey); key names are logged to provide an audit trail of changes to sensitive data
  • metadata keys listed above for the meta argument are recommended for consistency's sake but are not checked; a hash with any keys can be stored with this API
See also

◆ updateSensitiveData() [3/3]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.updateSensitiveData ( String  skey,
String  svalue,
HashMap< String, Object hash 
) throws Throwable
inlinestatic

Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data key and value.

Example:
WorkflowApi.updateSensitiveData("personal_id", h.get("personal_id"), h, aliases, meta);
Parameters
skeythe type of value provided in svalue; must not be longer than 100 bytes long or a SENSITIVE-DATA-ERROR exception is raised
svaluethe value of the sensitive data key identified by skey; if this string is empty or longer than 100 bytes, a SENSITIVE-DATA-ERR OR exception is raised
hashthe data to create or update against skey; existing keys will be replaced; new keys will be added; if the new hash does not refer to existing keys, then those existing keys remain untouched
Exceptions
SENSITIVE-DATA-ERRORno sensitive key value was provided; sensitive key value too long (100 bytes maximum length in the encoding used by the system schema)
Note
  • do not use sensitive data for the sensitive key names itself (skey); key names are logged to provide an audit trail of changes to sensitive data
  • metadata keys listed above for the meta argument are recommended for consistency's sake but are not checked; a hash with any keys can be stored with this API
See also

◆ updateSensitiveDataFromAlias() [1/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.updateSensitiveDataFromAlias ( String  alias,
HashMap< String, Object hash,
HashMap< String, Object meta 
) throws Throwable
inlinestatic

Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data alias.

Example:
WorkflowApi.updateSensitiveDataFromAlias("0", h);
Parameters
aliasthe alias to use for updating the data; if the alias is unknown, an INVALID-ALIAS exception is raised
hashthe data to create or update against skey; existing keys will be replaced; new keys will be added; if the new hash does not refer to existing keys, then those existing keys remain untouched
metaoptional sensitve data metadata with the following recommended keys:
  • PURPOSE: free-form information about the purpose of the sensitive data
  • CATEGORIES: free-form information about the categories of sensitive data
  • RECIPIENTS: free-form information about the recipients or recipient catories of sensitive data
  • STORAGE: free-form information about the storage time or rules for sensitive data
Exceptions
INVALID-ALIASthe alias given is unknown
Note
  • metadata keys listed above for the meta argument are recommended for consistency's sake but are not checked; a hash with any keys can be stored with this API
See also

◆ updateSensitiveDataFromAlias() [2/2]

static void com.qoretechnologies.qorus.workflow.WorkflowApi.updateSensitiveDataFromAlias ( String  alias,
HashMap< String, Object hash 
) throws Throwable
inlinestatic

Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data alias.

Example:
WorkflowApi.updateSensitiveDataFromAlias("0", h);
Parameters
aliasthe alias to use for updating the data; if the alias is unknown, an INVALID-ALIAS exception is raised
hashthe data to create or update against skey; existing keys will be replaced; new keys will be added; if the new hash does not refer to existing keys, then those existing keys remain untouched
Exceptions
INVALID-ALIASthe alias given is unknown
Note
  • metadata keys listed above for the meta argument are recommended for consistency's sake but are not checked; a hash with any keys can be stored with this API
See also

◆ updateTempData()

static void com.qoretechnologies.qorus.workflow.WorkflowApi.updateTempData ( HashMap< String, Object hash) throws Throwable
inlinestatic

Updates the values of one or more keys in the workflow order data instance’s temporary data hash.

Parameters
hashthe key-value pairs to update in workflow temporary data
See also
Workflow Temporary Data
Note
See also

◆ usleep() [1/2]

static int com.qoretechnologies.qorus.workflow.WorkflowApi.usleep ( int  arg) throws Throwable
inlinestatic

puts the current thread to sleep for a certain number of microseconds

If the worklow is stopping, this method returns immediately with a return value of -1; otherwise the current thread is put to sleep for the full time period requested. If this method (or sleep()) is called again after -1 is returned, then a "STOP-ERROR" exception is thrown.

Parameters
argthe number of microseconds to sleep (1 microsecond = 1/1000000 of a second)
Returns
0 if current thread was put to sleep for the full time period; -1 if the sleep was interrupted because the current object is being stopped
Exceptions
STOP-ERRORthe current object is stopping and this method already returned -1 as a warning
See also

◆ usleep() [2/2]

static int com.qoretechnologies.qorus.workflow.WorkflowApi.usleep ( QoreRelativeTime  arg) throws Throwable
inlinestatic

puts the current thread to sleep for a certain number of microseconds

If the worklow is stopping, this method returns immediately with a return value of -1; otherwise the current thread is put to sleep for the full time period requested. If this method (or sleep()) is called again after -1 is returned, then a "STOP-ERROR" exception is thrown.

Parameters
argthe amount of time in microseconds to sleep (1 microsecond = 1/1000000 of a second)
Returns
0 if current thread was put to sleep for the full time period; -1 if the sleep was interrupted because the current object is being stopped
Exceptions
STOP-ERRORthe current object is stopping and this method already returned -1 as a warning
See also

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