main interface API class for the Java Qorus API More...

Inheritance diagram for com.qoretechnologies.qorus.UserApi:

Static Public Member Methods
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, Object >	runtimeProperties () 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, Object >	getSqlCacheInfo () 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, Object >	getSystemServiceInfo (String name) throws Throwable
	returns information about the given system service (if it's currently loaded) More...

static HashMap< String, Object >	getServiceInfo (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, Object >	getRunningWorkflowInfo (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, Object >	execSynchronousWorkflow (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, Object >	execSynchronousWorkflow (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, Object >	execSynchronousWorkflow (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, Object >	execSynchronousWorkflow (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, Object >	execSynchronousWorkflow (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, Object >	execSynchronousWorkflow (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, Object >	execSynchronousWorkflow (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, Object >	execSynchronousWorkflow (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, Object >	getQorusOptions () 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, Object >	getQorusOptions (String... opts) throws Throwable
	returns the value of the given system options More...

static HashMap< String, Object >	getQorusOptionsArgs (String[] opts) throws Throwable
	returns the value of the given system options More...

static HashMap< String, Object >	getQorusOptionInfo () throws Throwable
	returns a hash giving information about system options More...

static HashMap< String, Object >	getQorusOptionInfoArgs (String[] args) throws Throwable
	returns a hash giving information about system options More...

static HashMap< String, Object >	getActiveJobs () 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, Object >	getDatasourceInfo (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, Object >	getOption (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, Object >	getOption () throws Throwable
	Returns the value of all workflow, service, or job options depending on the calling context. More...

static HashMap< String, Object >	blockOrder (int wfiid) throws Throwable
	block the given workflow order data instance More...

static HashMap< String, Object >	unblockOrder (int wfiid, HashMap< String, Object > tempdata, HashMap< String, Object > orderkeys) throws Throwable
	unblocks the given workflow order data instance More...

static HashMap< String, Object >	unblockOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
	unblocks the given workflow order data instance More...

static HashMap< String, Object >	unblockOrder (int wfiid) throws Throwable
	unblocks the given workflow order data instance More...

static HashMap< String, Object >	cancelOrder (int wfiid) throws Throwable
	cancel the given workflow order data instance More...

static HashMap< String, Object >	uncancelOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
	uncancels the given workflow order data instance More...

static HashMap< String, Object >	uncancelOrder (int wfiid) throws Throwable
	uncancels the given workflow order data instance More...

static HashMap< String, Object >	getUserContextInfo () 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, Object >	getSystemInfo () throws Throwable
	returns a hash of system info More...

static HashMap< String, Object >	propGet () throws Throwable
	returns a hash of all system properties in all domains More...

static HashMap< String, Object >	propGet (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, Object >	propGet (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, Object >	bbParseExactlyOneVariable (String str) throws Throwable
	parses one template variable and returns a hash with its parts More...

static HashMap< String, Object >	getInputData (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, Object >	getInputData (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, String >	StatMap
	map from text descriptions to SQL status characters

static final Map< String, String >	SQLStatMap
	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, String >	QSMap
	map of queue status descriptions to the character code

static final Map< String, String >	SQLQSMap
	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, String >	QE_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, String >	QE_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, String >	JSMap
	map of Job status descriptions to the character code

static final Map< String, String >	SQLJSMap
	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, String >	AuditEventMap
	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, String >	AuditCodeMap
	map of audit codes to audit options

Detailed Description

main interface API class for the Java Qorus API

Member Function Documentation

◆ auditCheckEvent()

static boolean com.qoretechnologies.qorus.UserApi.auditCheckEvent ( int opt ) throws Throwable

inlinestatic

checks if the given audit event (given as an integer code) is enabled

Parameters

opt	the audit event code to check; see Java Audit Event Codes for possible values

Returns: true if the event is audited, false if not

See also

◆ auditCheckEventString()

static boolean com.qoretechnologies.qorus.UserApi.auditCheckEventString ( String opt ) throws Throwable

inlinestatic

checks if the given audit event (given as a string) is enabled

Parameters

opt	the audit event code to check; see Java Audit Event Strings for possible values

Returns: true if the event is audited, false if not

Exceptions

AUDIT-EVENT-ERROR the given audit event string does not exist

See also

◆ auditGetMask()

static int com.qoretechnologies.qorus.UserApi.auditGetMask ( ) throws Throwable

inlinestatic

returns the audit event mask

Returns: the audit event mask

See also

◆ auditUserEvent() [1/3]

static Integer com.qoretechnologies.qorus.UserApi.auditUserEvent	(	String	user_event,
		String	info1,
		String	info2
	)		throws Throwable

inlinestatic

creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance

Parameters

user_event	the user event code string
info1	optional informational string for the `AUDIT_EVENTS.INFO1` field
info2	optional informational string for the `AUDIT_EVENTS.INFO2` field

Returns: null if user event auditing is not enabled (see system option qorus.audit), or the integer audit event id

Note: nothing will be written to the AUDIT_EVENTS table if the qorus.audit system option does not include the "user-events" (OMQ.AO_USER_EVENTS) option; in case this is not set, the call will have no effect

See also

◆ auditUserEvent() [2/3]

static Integer com.qoretechnologies.qorus.UserApi.auditUserEvent	(	String	user_event,
		String	info1
	)		throws Throwable

inlinestatic

creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance

Parameters

user_event	the user event code string
info1	optional informational string for the `AUDIT_EVENTS.INFO1` field

Returns: null if user event auditing is not enabled (see system option qorus.audit), or the integer audit event id

Note: nothing will be written to the AUDIT_EVENTS table if the qorus.audit system option does not include the "user-events" (OMQ.AO_USER_EVENTS) option; in case this is not set, the call will have no effect

See also

◆ auditUserEvent() [3/3]

static Integer com.qoretechnologies.qorus.UserApi.auditUserEvent ( String user_event ) throws Throwable

inlinestatic

creates a user audit event (with audit event code OMQ.AE_USER_EVENT) against the workflow, service, or job instance

Parameters

user_event the user event code string

Returns: null if user event auditing is not enabled (see system option qorus.audit), or the integer audit event id

Note: nothing will be written to the AUDIT_EVENTS table if the qorus.audit system option does not include the "user-events" (OMQ.AO_USER_EVENTS) option; in case this is not set, the call will have no effect

See also

◆ bbParseExactlyOneVariable()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.bbParseExactlyOneVariable ( String str ) throws Throwable

inlinestatic

parses one template variable and returns a hash with its parts

Parameters

str	templated string to be parsed (has to contain exactly one variable and nothing more); see Config Item / Building Block Template Substitution Strings for the format of this string

Returns: BbVariable hash representing the variable

Exceptions

FORMAT-ERROR if the templated string doesn't have correct format

See also: Config Item / Building Block Template Substitution Strings for information on template variable expansion

◆ blockOrder()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.blockOrder ( int wfiid ) throws Throwable

inlinestatic

block the given workflow order data instance

Parameters

wfiid the workflow order instance ID to block

Returns

a hash with the following key:

workflow_status: the status of the workflow order

An exception will be thrown if the status is OMQ.StatInProgress

Exceptions

BLOCK-WORKFLOW-ERROR invalid status, foreign session id, missing original status, uncancel operation already in progress

See also

◆ callNetworkApi()

static Object com.qoretechnologies.qorus.UserApi.callNetworkApi	(	String	call,
		Object...	args
	)		throws Throwable

inlinestatic

calls a system RPC API and returns the result; the API is called with system permissions (no restrictions)

include any arguments after the method name, ex:

callNetworkApi("omq.system.exec-synchronous-existing", hash);

Parameters

call	the full RPC API method name (ex: `"omq.system.exec-synchronous-exiting"`); see Network System API for a full list
args	the arguments to the call

Returns: the return value of the method

Exceptions

UNKNOWN-API-CALL	invalid API method
INVALID-INTERNAL-API-CALL	API may not be called internally (ex: omq.system.shutdown-wait())

See also

UserApi::callNetworkApi()
call_network_api()
callNetworkApiArgsWithAuthentication() to call with the permissions as a specific user
callNetworkApiArgs()
callRestApi()
callRestApiWithAuthentication()

◆ callNetworkApiArgs()

static Object com.qoretechnologies.qorus.UserApi.callNetworkApiArgs	(	String	call,
		Object []	args
	)		throws Throwable

inlinestatic

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)

Parameters

call	the full RPC API method name (ex: `"omq.system.exec-synchronous-exiting"`); see Network System API for a full list
args	any arguments to the method; if multiple argument should be passed to the method, use a list of arguments here

Returns: the return value of the method

Exceptions

UNKNOWN-API-CALL	invalid API method
INVALID-INTERNAL-API-CALL	API may not be called internally (ex: omq.system.shutdown-wait())

See also

UserApi::callNetworkApiArgs()
call_network_api_args()
callNetworkApiArgsWithAuthentication() to call with the permissions as a specific user
callNetworkApi()
callRestApi()
callRestApiWithAuthentication()

◆ callNetworkApiArgsWithAuthentication()

static Object com.qoretechnologies.qorus.UserApi.callNetworkApiArgsWithAuthentication	(	String	user,
		String	pass,
		String	call,
		Object []	args
	)		throws Throwable

inlinestatic

calls a system RPC API with authentication information (username and password)

Parameters

user	the username to use for the call
pass	the password to use for the call
call	the full RPC API method name (ex: `"omq.system.exec-synchronous-exiting"`); see Network System API for a full list
args	any arguments to the method; if multiple argument should be passed to the method, use a list of arguments here

Returns: the return value of the method

Exceptions

UNKNOWN-API-CALL	invalid API method
INVALID-INTERNAL-API-CALL	API may not be called internally (ex: omq.system.shutdown-wait())

See also

◆ callRestApi() [1/2]

static Object com.qoretechnologies.qorus.UserApi.callRestApi	(	String	method,
		String	path,
		HashMap< String, Object >	body_args
	)		throws Throwable

inlinestatic

calls a system REST API method and returns the result; the API is called with system permissions (no restrictions)

Example:: int pid = (int)UserApi.callRestApi("GET", "system/pid");

Parameters

method	the HTTP method name
path	the URI path without the leading `"api"`; if it does not begin with `"latest"` or `"v//"` (for a REST API version), then `"/latest/"` is prepended ot the path, meaning that the latest version of the REST API will be used
body_args	the arguments to the call

Returns: the return value of the method

Note: to use a specific REST API version, make sure path begins with "/api"

See also

UserApi::callRestApi()
call_rest_api()
callRestApiWithAuthentication() to call with the permissions as a specific user
RestHandler::handleExternalRequest() for information about possible exceptions

◆ callRestApi() [2/2]

static Object com.qoretechnologies.qorus.UserApi.callRestApi	(	String	method,
		String	path
	)		throws Throwable

inlinestatic

calls a system REST API method and returns the result; the API is called with system permissions (no restrictions)

Example:: int pid = (int)UserApi.callRestApi("GET", "system/pid");

Parameters

method	the HTTP method name
path	the URI path without the leading `"api"`; if it does not begin with `"latest"` or `"v//"` (for a REST API version), then `"/latest/"` is prepended ot the path, meaning that the latest version of the REST API will be used

Returns: the return value of the method

Note: to use a specific REST API version, make sure path begins with "/api"

See also

UserApi::callRestApi()
call_rest_api()
callRestApiWithAuthentication() to call with the permissions as a specific user
RestHandler::handleExternalRequest() for information about possible exceptions

◆ callRestApiWithAuthentication()

static Object com.qoretechnologies.qorus.UserApi.callRestApiWithAuthentication	(	String	user,
		String	pass,
		String	method,
		String	path,
		HashMap< String, Object >	body_args
	)		throws Throwable

inlinestatic

calls a system REST API method with authentication information (username and password) and returns the result

Example:: int pid = callRestApiWithAuthentication(user, pass, "PUT", "system?action=shutdown");

Parameters

user	the username to use for the call
pass	the password to use for the call
method	the HTTP method name
path	the URI path without the leading `"api"`; if it does not begin with `"latest"` or `"v//"` (for a REST API version), then `"/latest/"` is prepended ot the path, meaning that the latest version of the REST API will be used
body_args	the arguments to the call

Returns: the return value of the method

Note: to use a specific REST API version, make sure path begins with "/api"

See also

UserApi::callRestApiWithAuthentication()
call_rest_api_with_authentication()
RestHandler::handleExternalRequest() for information about possible exceptions

◆ cancelOrder()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.cancelOrder ( int wfiid ) throws Throwable

inlinestatic

cancel the given workflow order data instance

Parameters

wfiid the workflow order instance ID to cancel

Returns

a hash with the following key:

workflow_status: the status of the workflow order

An exception will be thrown if the status is OMQ.StatInProgress

Exceptions

CANCEL-WORKFLOW-ERROR invalid status, foreign session id, missing original status, uncancel operation already in progress

See also

◆ clearSqlTableCache() [1/2]

static void com.qoretechnologies.qorus.UserApi.clearSqlTableCache	(	String	datasource,
		String	table_name
	)		throws Throwable

inlinestatic

clears the entry for the given datasource and table from the SQL cache (for example, if database objects have been updated in the dataserver)

Parameters

datasource	the name of a Qorus datasource
table_name	the table name to clear

Example:: UserApi.clearSqlTableCache("omquser", "table");

See

◆ clearSqlTableCache() [2/2]

static void com.qoretechnologies.qorus.UserApi.clearSqlTableCache ( String datasource ) throws Throwable

inlinestatic

clears all objects for given datasource from the SQL cache (for example, if database objects have been updated in the dataserver)

Parameters

datasource the name of a Qorus datasource

Example:: UserApi.clearSqlTableCache("omquser");

See also

◆ createOrder() [1/4]

static int com.qoretechnologies.qorus.UserApi.createOrder	(	String	name,
		String	version,
		HashMap< String, Object >	params
	)		throws Throwable

inlinestatic

creates a workflow order data instance in the database with status READY

Creates a workflow order data instance of the specified type with the data passed.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

name	the name of the workflow
version	the version of the workflow; if this parameter is not passed, then the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key

Returns: the workflow instance ID created

Exceptions

SUBMIT-ORDER-ERROR	invalid status value
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

Prior to Qorus 3.0.2 this function was known as createOrder(), and is still imported with this old camel-case name for backwards compatibility
In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createOrder() [2/4]

static int com.qoretechnologies.qorus.UserApi.createOrder	(	String	name,
		String	version,
		HashMap< String, Object >	params,
		String	status
	)		throws Throwable

inlinestatic

creates a workflow order data instance in the database

Creates a workflow order data instance of the specified type with the data passed.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

name	the name of the workflow
version	the version of the workflow; if this parameter is not passed, then the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
status	create the workflow order data instance with this status; may be either: OMQ.StatReady which is the default value OMQ.StatBlocked meaning: do not process the order, wait for unblocking later

Returns: the workflow instance ID created

Exceptions

SUBMIT-ORDER-ERROR	invalid status value
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

Prior to Qorus 3.0.2 this function was known as createOrder(), and is still imported with this old camel-case name for backwards compatibility
In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createOrder() [3/4]

static int com.qoretechnologies.qorus.UserApi.createOrder	(	String	name,
		HashMap< String, Object >	params
	)		throws Throwable

inlinestatic

creates a workflow order data instance in the database with status READY

Creates a workflow order data instance of the specified type with the data passed.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

name the name of the workflow; the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used (determined by the latest created date for the workflow_instance entry) will be used

params

The hash passed must have at either a staticdata key or an external_order_instanceid key, valid keys:

dynamicdata: (optional hash) the initial dynamic data for the order
external_order_instanceid: (optional/required string) the external order instance ID for the workflow data; one of staticdata or external_order_instanceid must be provided
global_unique_key: (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
orderkeys: (optional hash) a hash of order keys for the order
parent_workflow_instanceid: (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false
priority: the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest
scheduled: (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady
sensitive_data: (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys:
- aliases: (optional list of strings) zero or more string aliases for the sensitive data
- data: (required hash) the sensitive data hash itself
- meta: (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself):
  - 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
staticdata: (optional/required hash) the initial data for the order; one of staticdata or external_order_instanceid must be provided
tempdata: (optional hash) the initial temporary data for the order
workflow_specific_unique_key: (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
workflow_unique_key: (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key

Returns: the workflow instance ID created

Exceptions

SUBMIT-ORDER-ERROR	invalid status value
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

Prior to Qorus 3.0.2 this function was known as createOrder(), and is still imported with this old camel-case name for backwards compatibility
In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createOrder() [4/4]

static int com.qoretechnologies.qorus.UserApi.createOrder	(	String	name,
		HashMap< String, Object >	params,
		String	status
	)		throws Throwable

inlinestatic

creates a workflow order data instance in the database

Creates a workflow order data instance of the specified type with the data passed.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

name	the name of the workflow; the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
status	create the workflow order data instance with this status; may be either: OMQ.StatReady which is the default value OMQ.StatBlocked meaning: do not process the order, wait for unblocking later

Returns: the workflow instance ID created

Exceptions

SUBMIT-ORDER-ERROR	invalid status value
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

Prior to Qorus 3.0.2 this function was known as createOrder(), and is still imported with this old camel-case name for backwards compatibility
In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createRemoteOrder() [1/6]

static int com.qoretechnologies.qorus.UserApi.createRemoteOrder	(	String	remote,
		String	name,
		String	version,
		HashMap< String, Object >	params,
		String	status,
		boolean	register_dependency
	)		throws Throwable

inlinestatic

creates a workflow order data instance in a remote Qorus instance

Creates a workflow order data instance of the specified type with the data passed in the specified remote Qorus instance.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

remote	the name of the remote Qorus connection
name	the name of the workflow
version	the version of the workflow; if this parameter is not passed, then the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
status	create the workflow order data instance with this status; may be either: OMQ.StatReady which is the default value OMQ.StatBlocked meaning: do not process the order, wait for unblocking later
register_dependency	if true (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again

Returns: the workflow instance ID created

Exceptions

GET-REMOTE-ERROR	The given connection is not known
SUBMIT-ORDER-ERROR	invalid status value
WORKFLOW-ERROR	unknown or invalid workflow
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createRemoteOrder() [2/6]

static int com.qoretechnologies.qorus.UserApi.createRemoteOrder	(	String	remote,
		String	name,
		String	version,
		HashMap< String, Object >	params,
		String	status
	)		throws Throwable

inlinestatic

creates a workflow order data instance in a remote Qorus instance, establishing a connection dependency with the calling interface

Creates a workflow order data instance of the specified type with the data passed in the specified remote Qorus instance.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

remote	the name of the remote Qorus connection
name	the name of the workflow
version	the version of the workflow; if this parameter is not passed, then the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
status	create the workflow order data instance with this status; may be either: OMQ.StatReady which is the default value OMQ.StatBlocked meaning: do not process the order, wait for unblocking later

Returns: the workflow instance ID created

Exceptions

GET-REMOTE-ERROR	The given connection is not known
SUBMIT-ORDER-ERROR	invalid status value
WORKFLOW-ERROR	unknown or invalid workflow
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createRemoteOrder() [3/6]

static int com.qoretechnologies.qorus.UserApi.createRemoteOrder	(	String	remote,
		String	name,
		String	version,
		HashMap< String, Object >	params
	)		throws Throwable

inlinestatic

creates a workflow order data instance in a remote Qorus instance with status READY amd establishing a connection dependency with the calling interface

Creates a workflow order data instance of the specified type with the data passed in the specified remote Qorus instance.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

remote	the name of the remote Qorus connection
name	the name of the workflow
version	the version of the workflow; if this parameter is not passed, then the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key

Returns: the workflow instance ID created

Exceptions

GET-REMOTE-ERROR	The given connection is not known
SUBMIT-ORDER-ERROR	invalid status value
WORKFLOW-ERROR	unknown or invalid workflow
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createRemoteOrder() [4/6]

static int com.qoretechnologies.qorus.UserApi.createRemoteOrder	(	String	remote,
		String	name,
		HashMap< String, Object >	params,
		String	status,
		boolean	register_dependency
	)		throws Throwable

inlinestatic

creates a workflow order data instance in a remote Qorus instance

Creates a workflow order data instance of the specified type with the data passed in the specified remote Qorus instance.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

remote	the name of the remote Qorus connection
name	the name of the workflow; the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
status	create the workflow order data instance with this status; may be either: OMQ.StatReady which is the default value OMQ.StatBlocked meaning: do not process the order, wait for unblocking later
register_dependency	if true (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again

Returns: the workflow instance ID created

Exceptions

GET-REMOTE-ERROR	The given connection is not known
SUBMIT-ORDER-ERROR	invalid status value
WORKFLOW-ERROR	unknown or invalid workflow
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createRemoteOrder() [5/6]

static int com.qoretechnologies.qorus.UserApi.createRemoteOrder	(	String	remote,
		String	name,
		HashMap< String, Object >	params,
		String	status
	)		throws Throwable

inlinestatic

creates a workflow order data instance in a remote Qorus instance, establishing a connection dependency with the calling interface

Creates a workflow order data instance of the specified type with the data passed in the specified remote Qorus instance.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

remote	the name of the remote Qorus connection
name	the name of the workflow; the latest version of the named worklow is used to create the order
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
status	create the workflow order data instance with this status; may be either: OMQ.StatReady which is the default value OMQ.StatBlocked meaning: do not process the order, wait for unblocking later

Returns: the workflow instance ID created

Exceptions

GET-REMOTE-ERROR	The given connection is not known
SUBMIT-ORDER-ERROR	invalid status value
WORKFLOW-ERROR	unknown or invalid workflow
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ createRemoteOrder() [6/6]

static int com.qoretechnologies.qorus.UserApi.createRemoteOrder	(	String	remote,
		String	name,
		HashMap< String, Object >	params
	)		throws Throwable

inlinestatic

creates a workflow order data instance in a remote Qorus instance with status READY amd establishing a connection dependency with the calling interface

Creates a workflow order data instance of the specified type with the data passed in the specified remote Qorus instance.

To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

remote	the name of the remote Qorus connection
name	the name of the workflow; the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
params	The hash passed must have at either a `staticdata` key or an `external_order_instanceid` key, valid keys: `dynamicdata:` (optional hash) the initial dynamic data for the order `external_order_instanceid:` (optional/required string) the external order instance ID for the workflow data; one of `staticdata` or `external_order_instanceid` must be provided `global_unique_key:` (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); keys are order key names and values are the string key values; if this key already exists for any order in the system, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `orderkeys:` (optional hash) a hash of order keys for the order `parent_workflow_instanceid:` (optional int) a loosely-coupled workflow that will be marked as the parent of this workflow; if this key is not set, and this function is called from workflow code (even indirectly, by calling a service method that calls this function in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false `priority:` the order priority (optional int, default OMQ.DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest `scheduled:` (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ.StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ.StatScheduled instead of OMQ.StatReady `sensitive_data:` (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys: `aliases:` (optional list of strings) zero or more string aliases for the sensitive data `data:` (required hash) the sensitive data hash itself `meta:` (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself): `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 `staticdata:` (optional/required hash) the initial data for the order; one of `staticdata` or `external_order_instanceid` must be provided `tempdata:` (optional hash) the initial temporary data for the order `workflow_specific_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); keys are order key names and values are the string key values; if any of the keys given already exists for an order with the target workflowid, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key `workflow_unique_key:` (optional hash) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); keys are order key names and values are the string key values; if this key already exists for a workflow order with the same name, then the order creation will fail with a `DUPLICATE-ORDER-KEY` error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key

Returns: the workflow instance ID created

Exceptions

GET-REMOTE-ERROR	The given connection is not known
SUBMIT-ORDER-ERROR	invalid status value
WORKFLOW-ERROR	unknown or invalid workflow
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope, also sets `arg` with a `workflow_instance_ids` key with a list of all conflicting workflow instance IDs
WORKFLOW-KEY-ERROR	invalid workflow key given

Note

In the params argument above, either the staticdata or external_order_instanceid values must be provided; staticdata may be omitted if external_order_instanceid is provided and vice-versa
The global_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.

See also

◆ deserializeQorusData()

static Object com.qoretechnologies.qorus.UserApi.deserializeQorusData ( String data ) throws Throwable

inlinestatic

parses a serialized data string and returns the corresponding data

Parameters

data	the string data to deserialize

Returns: the Qore data represented by the string argument

See also

◆ execSynchronousWorkflow() [1/8]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.execSynchronousWorkflow	(	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

inlinestatic

executes a workflow order synchronously and returns the final status and order ID in a hash

Parameters

name	the workflow name
version	the workflow version (if null then the latest version of the workflow will be used)
sdata	the static data hash for the workflow order
opts	the options for the synchronous workflow execution instance
ddata	the optional initial dynamic data hash for the workflow order
priority	the order priority for the order
orderkeys	optional order keys for the order
external_order_instanceid	the optional external order instanceid for the order
parent_workflow_instanceid	an optional loosely-coupled workflow order ID that will be marked as the parent of this order; if this key is not set, and this method is called from workflow code (even indirectly, by calling a service method that calls this method in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false

Returns

a hash of workflow order information with the following keys:

workflow_instanceid (int): the workflow order instance ID
status: (String) the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)

See also

◆ execSynchronousWorkflow() [2/8]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.execSynchronousWorkflow	(	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

inlinestatic

executes a workflow order synchronously and returns the final status and order ID in a hash

Parameters

name	the workflow name; the latest version of the workflow will be used
sdata	the static data hash for the workflow order
opts	the options for the synchronous workflow execution instance
ddata	the optional initial dynamic data hash for the workflow order
priority	the order priority for the order
orderkeys	optional order keys for the order
external_order_instanceid	the optional external order instanceid for the order
parent_workflow_instanceid	an optional loosely-coupled workflow order ID that will be marked as the parent of this order; if this key is not set, and this method is called from workflow code (even indirectly, by calling a service method that calls this method in the same thread as the call from workflow code), the new order will be loosely-coupled with the calling workflow order as the parent; to keep this from happening, set the value of this key to false

Returns

a hash of workflow order information with the following keys:

workflow_instanceid (int): the workflow order instance ID
status: (String) the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)

See also

◆ execSynchronousWorkflow() [3/8]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.execSynchronousWorkflow	(	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

inlinestatic

executes a workflow order synchronously and returns the final status and order ID in a hash

Parameters

name	the workflow name; the latest version of the workflow will be used
sdata	the static data hash for the workflow order
opts	the options for the synchronous workflow execution instance
ddata	the optional initial dynamic data hash for the workflow order
priority	the order priority for the order
orderkeys	optional order keys for the order
external_order_instanceid	the optional external order instanceid for the order

Returns

a hash of workflow order information with the following keys:

workflow_instanceid (int): the workflow order instance ID
status: (String) the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)

See also

◆ execSynchronousWorkflow() [4/8]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.execSynchronousWorkflow	(	String	name,
		HashMap< String, Object >	sdata,
		HashMap< String, Object >	opts,
		HashMap< String, Object >	ddata,
		int	priority,
		HashMap< String, Object >	orderkeys
	)		throws Throwable

inlinestatic

executes a workflow order synchronously and returns the final status and order ID in a hash

Parameters

name	the workflow name; the latest version of the workflow will be used
sdata	the static data hash for the workflow order
opts	the options for the synchronous workflow execution instance
ddata	the optional initial dynamic data hash for the workflow order
priority	the order priority for the order
orderkeys	optional order keys for the order

Returns

a hash of workflow order information with the following keys:

workflow_instanceid (int): the workflow order instance ID
status: (String) the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)

See also

◆ execSynchronousWorkflow() [5/8]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.execSynchronousWorkflow	(	String	name,
		HashMap< String, Object >	sdata,
		HashMap< String, Object >	opts,
		HashMap< String, Object >	ddata,
		int	priority
	)		throws Throwable

inlinestatic

executes a workflow order synchronously and returns the final status and order ID in a hash

Parameters

name	the workflow name; the latest version of the workflow will be used
sdata	the static data hash for the workflow order
opts	the options for the synchronous workflow execution instance
ddata	the optional initial dynamic data hash for the workflow order
priority	the order priority for the order

Returns

a hash of workflow order information with the following keys:

workflow_instanceid (int): the workflow order instance ID
status: (String) the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)

See also

◆ execSynchronousWorkflow() [6/8]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.execSynchronousWorkflow	(	String	name,
		HashMap< String, Object >	sdata,
		HashMap< String, Object >	opts,
		HashMap< String, Object >	ddata
	)		throws Throwable

inlinestatic

executes a workflow order synchronously and returns the final status and order ID in a hash

Parameters

name	the workflow name; the latest version of the workflow will be used
sdata	the static data hash for the workflow order
opts	the options for the synchronous workflow execution instance
ddata	the optional initial dynamic data hash for the workflow order

Returns

a hash of workflow order information with the following keys:

workflow_instanceid (int): the workflow order instance ID
status: (String) the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)

See also

◆ execSynchronousWorkflow() [7/8]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.execSynchronousWorkflow	(	String	name,
		HashMap< String, Object >	sdata,
		HashMap< String, Object >	opts
	)		throws Throwable

inlinestatic

executes a workflow order synchronously and returns the final status and order ID in a hash

Parameters

name	the workflow name; the latest version of the workflow will be used
sdata	the static data hash for the workflow order
opts	the options for the synchronous workflow execution instance

Returns

a hash of workflow order information with the following keys:

workflow_instanceid (int): the workflow order instance ID
status: (String) the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)

See also

◆ execSynchronousWorkflow() [8/8]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.execSynchronousWorkflow	(	String	name,
		HashMap< String, Object >	sdata
	)		throws Throwable

inlinestatic

executes a workflow order synchronously and returns the final status and order ID in a hash

Parameters

name	the workflow name; the latest version of the workflow will be used
sdata	the static data hash for the workflow order

Returns

a hash of workflow order information with the following keys:

workflow_instanceid (int): the workflow order instance ID
status: (String) the order status commit to the database (for possible values, see Workflow, Segment, and Step Status Descriptions)

See also

◆ expandOneVariable()

static String com.qoretechnologies.qorus.UserApi.expandOneVariable	(	String	str,
		String	var_context,
		String	var_name,
		HashMap< String, Object >	local_context
	)		throws Throwable

inlinestatic

expands one variable in a templated string

Parameters

str	templated string to be expanded; see Config Item / Building Block Template Substitution Strings for the format of this string
var_context	context of the variable to be expanded (e.g. local, static, dynamic, keys,...)
var_name	name of the variable to be expanded
local_context	local context supplied by the caller (plus user context info is added - see UserApi.getUserContextInfo() method)

Returns: modified string with the specified template variable already expanded

Exceptions

NOT-WF-CONTEXT-ERROR	if WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERROR	if an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERROR	if the variable doesn't have a value in the specified context

See also: Config Item / Building Block Template Substitution Strings for information on template variable expansion

◆ expandTemplatedValue()

static Object com.qoretechnologies.qorus.UserApi.expandTemplatedValue	(	String	str,
		HashMap< String, Object >	local_context
	)		throws Throwable

inlinestatic

expands all variables in a templated string

Parameters

str	templated string to be expanded; see Config Item / Building Block Template Substitution Strings for the format of template variable references in this string
local_context	local context supplied by the caller (plus user context info is added - see UserApi.getUserContextInfo() method)

Returns: the value of the string as substituted with all variables expanded

Exceptions

NOT-WF-CONTEXT-ERROR	if WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERROR	if an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERROR	if the variable doesn't have a value in the specified context
FORMAT-ERROR	if the templated string doesn't have correct format (e.g. unescaped dollar sign that does not represent a variable)

See also: Config Item / Building Block Template Substitution Strings for information on template variable expansion

◆ flushSlaEvents()

static void com.qoretechnologies.qorus.UserApi.flushSlaEvents ( ) throws Throwable

inlinestatic

flushes all pending SLA events to disk and returns after the data has been committed

Example:: UserApi.flushSlaEvents();

See also

◆ getActiveJobs()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getActiveJobs ( ) throws Throwable

inlinestatic

Returns information on all active jobs visible to the calling user.

If any active jobs are not accessible to the calling user, then they are filtered from the hash returned.

Returns

a hash is keyed by job name; the hash values are job information hashes with the following keys:

jobid: the metadata jobid of the job type
name: the job name
version: the job version
description: the job description
trigger: a string describing the timer/trigger for the job
[job_instanceid]: the id of the job instance (will only have a value if the job is currently executing)
[last_executed]: the last executed date/time of the job (null if not yet executed)
[last_executed_job_instanceid]: the last executed instance id of the job
[expiry_date]: the expiry date of the job, if any; if this date is present, then the job will not run automatically after this date
single_instance: true if the job can only be run in a single Qorus instance, false if no such restriction is enabled
[next]: the next trigger date/time; this key is only included if the job is active
active: this value is always true because this API only returns information about active jobs

See also

◆ getBinaryFileFromLocation()

static byte [] com.qoretechnologies.qorus.UserApi.getBinaryFileFromLocation ( String location ) throws Throwable

inlinestatic

returns binary data for the given file location

Parameters

location the location of the file data (ex: "resource://service-name:path/to/ressource")

Returns: the resource data as a binary value

Exceptions

LOCATION-ERROR the location string cannotbe parsed; unknown location scheme; invalid location option

See also

Since: Qorus 4.0.3

◆ getDatasourceInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getDatasourceInfo ( String name ) throws Throwable

inlinestatic

returns a hash of information for the given datasource, if known, otherwise throws an exception

Parameters

name	the name of the datasource

Returns

a hash of information for the given datasource, if known, otherwise throws an exception; the following keys are returned in the hash:

name (string): the name of the datasource connection (corresponding to the argument name)
type (string): datasource constant
url (string): a connection string
url_hash (hash): parsed connection string and options
- type (string): driver name
- user (string): the username for the datasource connection, if any
- pass (string): the password for the datasource connection, if any
- charset (string): the DB-specific character encoding for the datasource connection
- db (string): The database name of the datasource connection
- options (hash): an optional hash of options for the DBI driver for this datasource connection; also "min" and "max" for the DatasourcePool minimum and maximum options
locked (bool): a flag indicating if the datasource is locked or not (the system datasource "omq" is locked)
up (bool): a flag indicating if monitoring has discovered if the datasource is up or not
desc (string): a string description of the datasource
monitor (bool): a flag indicating if the datasource is monitored or not
status (string): "OK" if the datasource is up or an error string if the datasource is down; set by monitoring
last_check (date/time): the date and time of the last monitoring check
shared_pool (string): a string giving the pool state (only present if a pool has been initialized on the datasource)
deps (list): a list of hashes giving interface objects that depend on the connection; each entry is a hash with the following keys:
- type: "WORKFLOW", "SERVICE", or "JOB"
- workflowid: for workflows, gives the workflow ID
- serviceid: for services, gives the service ID
- jobid: for jobs, gives the job ID
- name: the name of the workflow, service, or job
- version: the version of the workflow, service, or job
- desc: a string description of the object

Exceptions

DATASOURCE-ERROR unknown datasource

See also

◆ getDatasourcePool() [1/2]

static DatasourcePool com.qoretechnologies.qorus.UserApi.getDatasourcePool	(	String	name,
		boolean	register_dependency
	)		throws Throwable

inlinestatic

returns a DatasourcePool object for the given datasource name

Example:: // acquiree a org.qore.lang.DatasourcePool object managing a weak reference to a Qore::SQL::DatasourcePool object
org.qore.lang.DatasourcePool dsp = UserApi.getDatasourcePool(dspname, true);
try {
// ... use the pool
// then release the connection back to the pool
dsp.commit();
} catch (Throwable e) {
dsp.rollback();
} finally {
// release the weak reference to the Qore object
dsp.release();
}

Parameters

name	the name of the datasource
register_dependency	if true (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again

Returns: a DatasourcePool object

Exceptions

DATASOURCE-ERROR unknown or system datasource

Note: It is recommended to release the weak reference to the org::qore::lang::DatasourcePool when done using it by calling org::qore::lang::DatasourcePool::release() as in the example above, otherwise releasing the weak reference depends on Java object finalization, which is not deterministic.

See also

◆ getDatasourcePool() [2/2]

static DatasourcePool com.qoretechnologies.qorus.UserApi.getDatasourcePool ( String name ) throws Throwable

inlinestatic

returns a DatasourcePool object for the given datasource name; a dependency is created between the calling interface and the datasource

Example:: // acquiree a org.qore.lang.DatasourcePool object managing a weak reference to a Qore::SQL::DatasourcePool object
org.qore.lang.DatasourcePool dsp = UserApi.getDatasourcePool(dspname);
try {
// ... use the pool
// then release the connection back to the pool
dsp.commit();
} catch (Throwable e) {
dsp.rollback();
} finally {
// release the weak reference to the Qore object
dsp.release();
}

Parameters

name	the name of the datasource

Returns: a DatasourcePool object

Exceptions

DATASOURCE-ERROR unknown or system datasource

Note: It is recommended to release the weak reference to the org::qore::lang::DatasourcePool when done using it by calling org::qore::lang::DatasourcePool::release() as in the example above, otherwise releasing the weak reference depends on Java object finalization, which is not deterministic.

See also

◆ getGlobalConfigItemValue()

static Object com.qoretechnologies.qorus.UserApi.getGlobalConfigItemValue ( String item ) throws Throwable

inlinestatic

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

Parameters

item	the name of the configuration item to retrieve the value

Returns: the value of the given configuration item on global level

Exceptions

CONFIG-ITEM-ERROR thrown if the configuration item is not valid

Since: Qorus 4.0.3

◆ getInputData() [1/2]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getInputData	(	String	field_name,
		HashMap< String, Object >	local_context,
		HashMap< String, Object >	input_data_cfg
	)		throws Throwable

inlinestatic

returns specified input data field's value

Parameters

field_name	name of the field that should be returned; identifies a key in input_data_cfg
local_context	the caller can supply its `"$local:"` context for template variables (plus user context info is added - see UserApi.getUserContextInfo()); hash values are subject to recursive template variable expansion
input_data_cfg	input data configuration; if not provided, the default location for the input data config is retrieved from configuration item `"input_data"`; field_name must be present in this hash; string values of the key referenced with field_name in this hash are subject to recursive template variable expansion, and the resulting value is returned; non-string values are returned as-is

Returns: the value of the key given by field_name in the input_data_cfg hash is subject to recursive template variable expansion and returned; template variable expansion is performed if the hash value is a string, if the value is any other data type, it is returned as-is

Exceptions

NOT-WF-CONTEXT-ERROR	if WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERROR	if an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERROR	if the variable doesn't have a value in the specified context
SENSITIVE-DATA-FORMAT-ERROR	if the `"$sensitive:<skey>.<svalue>.field-ref..."` value or `"$sensitive-alias:<alias>.field-ref..."` template string does not have the required format
INVALID-ARGUMENT	if the field_name is not present in input data

See also: Config Item / Building Block Template Substitution Strings for information on template variable expansion

◆ getInputData() [2/2]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getInputData	(	HashMap< String, Object >	input_data_cfg,
		HashMap< String, Object >	local_context
	)		throws Throwable

inlinestatic

returns all input data

Parameters

local_context	the caller can supply its `"$local:"` context for template variables (plus user context info is added - see UserApi.getUserContextInfo()); hash values are subject to recursive template variable expansion
input_data_cfg	input data configuration; if not provided, the default location for the input data config is retrieved from configuration item `"input_data"`

Returns: the entire input data hash with all string hash values subject to recursive template variable expansion; input data hash values that are not strings are returned as-is

Exceptions

NOT-WF-CONTEXT-ERROR	if WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERROR	if an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERROR	if the variable doesn't have a value in the specified context
SENSITIVE-DATA-FORMAT-ERROR	if the `"$sensitive:<skey>.<svalue>.field-ref..."` value or `"$sensitive-alias:<alias>.field-ref..."` template string does not have the required format

Since: Qorus 4.0.3

◆ getMapper() [1/2]

static Mapper com.qoretechnologies.qorus.UserApi.getMapper	(	String	name,
		HashMap< String, Object >	rtopts
	)		throws Throwable

inlinestatic

returns the given mapper if registered for the current interface

Example:: Mapper m = UserApi.getMapper("my_mapper");

Parameters

name	the name of the mapper
rtopts	any runtime options accepted by the mapper

Exceptions

MAPPER-ERROR the given mapper is unknown or not registered to the current interface

See also

◆ getMapper() [2/2]

static Mapper com.qoretechnologies.qorus.UserApi.getMapper ( String name ) throws Throwable

inlinestatic

returns the given mapper if registered for the current interface

Example:: Mapper m = UserApi.getMapper("my_mapper");

Parameters

name	the name of the mapper

Exceptions

MAPPER-ERROR the given mapper is unknown or not registered to the current interface

See also

◆ getNextSequenceValue() [1/2]

static int com.qoretechnologies.qorus.UserApi.getNextSequenceValue	(	AbstractDatasource	ds,
		String	name
	)		throws Throwable

inlinestatic

returns the next sequence value for the given datasource and sequence

Example:: int val = UserApi.getNextSequenceValue(ds, seqnem);

Parameters

ds	the datasource to retrieve the sequence from
name	the name of the sequence

Returns: the next value of the sequence

See also: UserApi::getNextSequenceValue()

◆ getNextSequenceValue() [2/2]

static int com.qoretechnologies.qorus.UserApi.getNextSequenceValue	(	String	ds,
		String	name
	)		throws Throwable

inlinestatic

returns the next sequence value for the given datasource and sequence

Example:: int val = UserApi.getNextSequenceValue(ds, seqnem);

Parameters

ds	the datasource name to retrieve the sequence from; a pool corresponding to the datasource will be used to retrieve the sequence
name	the name of the sequence

Returns: the next value of the sequence

See also: UserApi::getNextSequenceValue()

◆ getOption() [1/3]

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

inlinestatic

Returns the value of the named workflow, service, or job option or options.

If the option is not set on the workflow, service, or job level (depending on the calling context) and it is a valid system option, then the value of the system option will be returned.

Returns: a hash of option keys and values is returned; note that if called from a workflow and no arguments are passed to the method all workflow-level options are returned as a hash

Note: When called from workflow code, invalid options do not cause an errors to be raised; the associated key values in the hash returned will be null

See also: UserApi::getOption()

◆ getOption() [2/3]

static Object com.qoretechnologies.qorus.UserApi.getOption ( String key ) throws Throwable

inlinestatic

Returns the value of the named workflow, service, or job option.

If the option is not set on the workflow, service, or job level (depending on the calling context) and it is a valid system option, then the value of the system option will be returned.

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: UserApi::getOption()

◆ getOption() [3/3]

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

inlinestatic

Returns the value of all workflow, service, or job options depending on the calling context.

Returns: all workflow, service, or job options are returned as a hash depending on the calling context

See also: UserApi::getOption()

◆ getQorusOptionInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getQorusOptionInfo ( ) throws Throwable

inlinestatic

returns a hash giving information about system options

See also

◆ getQorusOptionInfoArgs()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getQorusOptionInfoArgs ( String [] args ) throws Throwable

inlinestatic

returns a hash giving information about system options

See also

◆ getQorusOptions() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getQorusOptions ( ) throws Throwable

inlinestatic

returns the value of all system options

See also

◆ getQorusOptions() [2/3]

static Object com.qoretechnologies.qorus.UserApi.getQorusOptions ( String opt ) throws Throwable

inlinestatic

returns the value of the given system option

See also

◆ getQorusOptions() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getQorusOptions ( String... opts ) throws Throwable

inlinestatic

returns the value of the given system options

See also

◆ getQorusOptionsArgs()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getQorusOptionsArgs ( String [] opts ) throws Throwable

inlinestatic

returns the value of the given system options

See also

◆ getRemoteRestConnection() [1/3]

static QorusSystemRestHelper com.qoretechnologies.qorus.UserApi.getRemoteRestConnection	(	String	name,
		boolean	connect,
		boolean	register_dependency
	)		throws Throwable

inlinestatic

Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection.

Parameters

name	the name of the remote connection
connect	if false an unconnected object will be returned, otherwise the object is already connected
register_dependency	if true (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again

Returns: a new QorusSystemRestHelper object

Exceptions

GET-REMOTE-ERROR The given connection is not known

See also

UserApi::getRemoteRestConnection()
get_remote_rest_connection

◆ getRemoteRestConnection() [2/3]

static QorusSystemRestHelper com.qoretechnologies.qorus.UserApi.getRemoteRestConnection	(	String	name,
		boolean	connect
	)		throws Throwable

inlinestatic

Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection; a dependency is established between the current interface and the remote connection.

Parameters

name	the name of the remote connection
connect	if false an unconnected object will be returned, otherwise the object is already connected

Returns: a new QorusSystemRestHelper object

Exceptions

GET-REMOTE-ERROR The given connection is not known

See also

UserApi::getRemoteRestConnection()
get_remote_rest_connection

◆ getRemoteRestConnection() [3/3]

static QorusSystemRestHelper com.qoretechnologies.qorus.UserApi.getRemoteRestConnection ( String name ) throws Throwable

inlinestatic

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.

Parameters

name	the name of the remote connection

Returns: a new QorusSystemRestHelper object

Exceptions

GET-REMOTE-ERROR The given connection is not known

See also

UserApi::getRemoteRestConnection()
get_remote_rest_connection

◆ getRunningWorkflowInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getRunningWorkflowInfo ( int id ) throws Throwable

inlinestatic

returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not

returns an empty hash if the workflow execution ID is not currently valid

Parameters

id	workflow execution instance id

Returns

a hash of the workflow execution instance info if the ID is valid or an empty hash if not; if valid, the hash will have the following keys:

name: the name of the workflow
version: version of the workflow
workflowid: the workflowid of the workflow
executionID: the workflow execution instance id (same as the argument)
mode: OMQ.WM_Normal or OMQ.WM_Recovery
sync: true if the execution instance is synchronous, false if not
iterations: number of segment iterations performed so far
totalSegments: number of segments executed
errors: total number of errors encountered
warnings: total number of warnings raised
starttime: date/time the execution instance was started
options: options set on the workflow execution instance
logfile: log file name
remote: true if the workflow is running as a remote qwf process, false if not

Note: prior to Qorus 3.0.2 this function was known as getRunningWorkflowInfo(), and is still imported with this old camel-case name for backwards compatibility

See also

◆ getRunningWorkflowList() [1/3]

static HashMap<String, Object> [] com.qoretechnologies.qorus.UserApi.getRunningWorkflowList	(	String	name,
		String	ver
	)		throws Throwable

inlinestatic

returns a list of hashes giving information about the currently-running workflow execution instances

Parameters

name	workflow name for filtering the result list
ver	workflow version for filtering the result list (only used if name also passed)

Returns

a list of hashes giving information about the currently-running workflow execution instances; if no matching workflow execution instances are running, then an empty list is returned; otherwise each list element is a hash with the following keys:

executionID: the workflow execution instance id
name: the name of the workflow
version: version of the workflow
workflowid: the workflowid of the workflow
mode: OMQ.WM_Normal or OMQ.WM_Recovery
sync: true if the execution instance is synchronous, false if not
iterations: number of segment iterations performed so far
totalSegments: number of segments executed
errors: total number of errors encountered
warnings: total number of warnings raised
starttime: date/time the execution instance was started
options: options set on the workflow execution instance
logfile: log file name
remote: true if the workflow is running as a remote qwf process, false if not

Note: prior to Qorus 3.0.2 this function was known as getRunningWorkflowList(), and is still imported with this old camel-case name for backwards compatibility

See also

◆ getRunningWorkflowList() [2/3]

static HashMap<String, Object> [] com.qoretechnologies.qorus.UserApi.getRunningWorkflowList ( String name ) throws Throwable

inlinestatic

returns a list of hashes giving information about the currently-running workflow execution instances

Parameters

name	workflow name for filtering the result list

Returns

a list of hashes giving information about the currently-running workflow execution instances; if no matching workflow execution instances are running, then an empty list is returned; otherwise each list element is a hash with the following keys:

executionID: the workflow execution instance id
name: the name of the workflow
version: version of the workflow
workflowid: the workflowid of the workflow
mode: OMQ.WM_Normal or OMQ.WM_Recovery
sync: true if the execution instance is synchronous, false if not
iterations: number of segment iterations performed so far
totalSegments: number of segments executed
errors: total number of errors encountered
warnings: total number of warnings raised
starttime: date/time the execution instance was started
options: options set on the workflow execution instance
logfile: log file name
remote: true if the workflow is running as a remote qwf process, false if not

Note: prior to Qorus 3.0.2 this function was known as getRunningWorkflowList(), and is still imported with this old camel-case name for backwards compatibility

See also

◆ getRunningWorkflowList() [3/3]

static HashMap<String, Object> [] com.qoretechnologies.qorus.UserApi.getRunningWorkflowList ( ) throws Throwable

inlinestatic

returns a list of hashes giving information about the currently-running workflow execution instances

Returns

a list of hashes giving information about the currently-running workflow execution instances; if no matching workflow execution instances are running, then an empty list is returned; otherwise each list element is a hash with the following keys:

executionID: the workflow execution instance id
name: the name of the workflow
version: version of the workflow
workflowid: the workflowid of the workflow
mode: OMQ.WM_Normal or OMQ.WM_Recovery
sync: true if the execution instance is synchronous, false if not
iterations: number of segment iterations performed so far
totalSegments: number of segments executed
errors: total number of errors encountered
warnings: total number of warnings raised
starttime: date/time the execution instance was started
options: options set on the workflow execution instance
logfile: log file name
remote: true if the workflow is running as a remote qwf process, false if not

Note: prior to Qorus 3.0.2 this function was known as getRunningWorkflowList(), and is still imported with this old camel-case name for backwards compatibility

See also

◆ getServiceInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getServiceInfo	(	String	type,
		String	name
	)		throws Throwable

inlinestatic

returns information about the given service (if it's currently loaded)

Parameters

type	the type of service (either `"system"` or `"user"`; case is ignored)
name	the name of the system service to query

Returns

a hash of service information or null if the service is not loaded; the hash will have the following structure:

type: either "system" or "user" corresponding to the argument
name: the name of the service
version: version of the service
patch: the patch string for the service
desc: description of the service
author: the author of the service
serviceid: service ID
parse_options: parse options for the service
status: OMQ.SSRunning or OMQ.SSLoaded
log: path to the service log file
active_calls: number of active service calls and persistent connection handlers currently in progress
waiting_threads: number of threads waiting on the service (for a service reset or unload action)
threads: number of running threads in the service
autostart: true of false if the autostart flag is set
manual_autostart: true of false the autostart value has been manually set
loaded: date/time the service was loaded
methods: list of hashes for each method with name and desc keys
resources: list of service resources
resource_files: list of service file resources
options: service options
groups: interface groups that the service belongs to
alerts: any alerts raised against the service

See also

◆ getSessionId()

static int com.qoretechnologies.qorus.UserApi.getSessionId ( ) throws Throwable

inlinestatic

returns the current Qorus application session ID

Returns: the current Qorus application session ID

See also

Application Session Model for more information about the session ID

◆ getSqlCacheInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getSqlCacheInfo ( ) throws Throwable

inlinestatic

get information about cached object

Returns: hash the whole sql cache

Resulting hash (keys are datasource names) of hashes (keys are cache types) of hashes (keys are names of individual cached objects) provides the information about given cached objects as a value. This information has the form of hash with the following keys:

count - how many times it was used
created - datetime of the first call (when the cache was created)
object - stored object that is cached

Example:: HashMap<String, Object> cache = UserApi.getSqlCacheInfo();
HashMap<String, Object> cache_for_my_datasource = (HashMap<String, Object>)cache.get("my_datasource");
HashMap<String, Object> table_cache_for_my_datasource = (HashMap<String, Object>)cache_for_my_datasource.get("tables");
boolean is_mytable_cached = table_cache_for_my_datasource.containsKey("my_table");
ZonedDateTime date_when_mytable_was_cached = (ZonedDateTime)((HashMap<String, Object>)table_cache_for_my_datasource.get("my_table")).get("created");

See also

◆ getSqlTable() [1/2]

static AbstractTable com.qoretechnologies.qorus.UserApi.getSqlTable	(	String	datasource,
		String	table_name
	)		throws Throwable

inlinestatic

get a cached table object (suitable for DML) if present, otherwise it creates one from scratch

Example:: org.qore.lang.sqlutil.AbstractTable t = UserApi.getSqlTable("pgsql:user/password@db", "my_table");
try {
// use the table object
} finally {
t.release();
}

Parameters

datasource	a Qorus datasource name
table_name	the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor(); names are converted to lower-case before performing the lookup and storage in the cache to ensure that the cache is based on case-insensitive lookups

Returns: an AbstractTable object corresponding to the parameters

Exceptions

INVALID-DATASOURCE this exception is thrown if the datasource argument cannot be matched to a known datasource

Note

other exceptions can be thrown when acquiring the table, for example if the given table is not accessible or if there are technical errors communicating with the database server, etc
you need to call clear_sql_table_cache() any time the table structure has changed

See also

◆ getSqlTable() [2/2]

static AbstractTable com.qoretechnologies.qorus.UserApi.getSqlTable	(	AbstractDatasource	datasource,
		String	table_name
	)		throws Throwable

inlinestatic

get a cached table object (suitable for DML) if present, otherwise it creates one from scratch

Example:: org.qore.lang.sqlutil.AbstractTable t = UserApi.getSqlTable(datasource_pool, "my_table");
try {
// use the table object
} finally {
t.release();
}

Parameters

datasource	a DatasourcePool object for a Qorus datasource; note that if the DatasourcePool object cannot be matched back to a known Qorus datasource, an `INVALID-DATASOURCE` exception will be thrown
table_name	the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor(); names are converted to lower-case before performing the lookup and storage in the cache to ensure that the cache is based on case-insensitive lookups

Returns: an AbstractTable object corresponding to the parameters

Exceptions

INVALID-DATASOURCE this exception is thrown if the datasource argument cannot be matched to a known Qorus datasource

Note

INVALID-DATASOURCE exceptions can be thrown with a valid Qorus datasource if the given datasource has been reset since it was acquired
other exceptions can be thrown when acquiring the table, for example if the given table is not accessible or if there are technical errors communicating with the database server, etc
you need to call clearSqlTableCache() any time the table structure has changed

See also

◆ getSystemInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getSystemInfo ( ) throws Throwable

inlinestatic

returns a hash of system info

Returns

a hash of system info with the following keys:

instance-key: value of the system option by the same name
session-id: the session ID for the current Qorus application session
omq-version: the version string for the Qorus server
omq-version-code: a numeric code of the Qorus server version, where
major = (x / 10000), minor = (x / 100) % 100, sub = x % 100
this value is suitable for comparisons (ex: for Qorus 2.6.0, omq-version-code = 20600)
qore-version: the version string for the qore build used
datamodel-version: the datamodel version required by this version of Qorus
omq-schema: the datasource string for the system schema (without the password)
omquser-schema: the datasource string for the user schema (without the password)
starttime: the date and time when the instance was started
hostname: the hostname of the machine where the Qorus server is running
pid: the PID of the Qorus server process
threads: number of threads currently active
schema-properties: a hash of schema properties with the following keys:
omq-schema-version
omq-schema-compatibility
omq-load-schema-compatibility
logfile: the path for the system log file

See also

◆ getSystemServiceInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getSystemServiceInfo ( String name ) throws Throwable

inlinestatic

returns information about the given system service (if it's currently loaded)

Parameters

name	the name of the system service to query

Returns

a hash of user information or null if the service is not loaded; the hash will have the following structure:

type: "system"
name: the name of the service
version: version of the service
desc: description of the service
serviceid: service ID
status: OMQ.SSRunning or OMQ.SSLoaded
threads: number of running threads in the service
autostart: true of false if the autostart flag is set
loaded: date/time the service was loaded
methods: list of hashes for each method with name and desc keys

Note: prior to Qorus 3.0.2 this function was known as getSystemServiceInfo(), and is still imported with this old camel-case name for backwards compatibility

See also

◆ getTextFileFromLocation()

static String com.qoretechnologies.qorus.UserApi.getTextFileFromLocation ( String location ) throws Throwable

inlinestatic

returns string data for the given file location

Parameters

location the location of the file data (ex: "resource://service-name:path/to/ressource")

Returns: the resource data as a string

Exceptions

LOCATION-ERROR the location string cannotbe parsed; unknown location scheme; invalid location option

See also

Since: Qorus 4.0.3

◆ getUserConnection() [1/4]

static Object com.qoretechnologies.qorus.UserApi.getUserConnection	(	String	name,
		boolean	connect,
		boolean	register_dependency,
		HashMap< String, Object >	rtopts
	)		throws Throwable

inlinestatic

Returns an object corresponding to a defined user connection.

Parameters

name	the name of the connection
connect	if false an unconnected object will be returned, otherwise the object is already connected
register_dependency	if true (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again
rtopts	any runtime options accepted by the connection

Returns: the object representing the connection

Exceptions

CONNECTION-ERROR The given connection is not known

See also

◆ getUserConnection() [2/4]

static Object com.qoretechnologies.qorus.UserApi.getUserConnection	(	String	name,
		boolean	connect,
		boolean	register_dependency
	)		throws Throwable

inlinestatic

Returns an object corresponding to a defined user connection.

Parameters

name	the name of the connection
connect	if false an unconnected object will be returned, otherwise the object is already connected
register_dependency	if true (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again

Returns: the object representing the connection

Exceptions

CONNECTION-ERROR The given connection is not known

See also

◆ getUserConnection() [3/4]

static Object com.qoretechnologies.qorus.UserApi.getUserConnection	(	String	name,
		boolean	connect
	)		throws Throwable

inlinestatic

Returns an object corresponding to a defined user connection, establishing a dependency by default between the calling inteerface and the connection.

Parameters

name	the name of the connection
connect	if false an unconnected object will be returned, otherwise the object is already connected

Returns: the object representing the connection

Exceptions

CONNECTION-ERROR The given connection is not known

See also

◆ getUserConnection() [4/4]

static Object com.qoretechnologies.qorus.UserApi.getUserConnection ( String name ) throws Throwable

inlinestatic

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.

Parameters

name	the name of the connection

Returns: the object representing the connection

Exceptions

CONNECTION-ERROR The given connection is not known

See also

◆ getUserContextInfo()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.getUserContextInfo ( ) throws Throwable

inlinestatic

returns a hash for the current user context

Example:: HashMap<String, Object> h = UserApi.getUserContextInfo();

Returns

a hash describing the current user context or null if called outside a workflow, service, or job; hash keys are as follows:

when called in a service:
- "type": "service"
- "servicetype": the type of service ("user" or "system")
- "name": the name of the service
- "version": the version of the service
- "id": the service id
when called in a job:
- "type": "job"
- "name": the name of the job
- "version": the version of the job
- "id": the job id
- "job_instanceid": the job_instanceid of the current job instance
when called in a workflow:
- "type": "workflow"
- "name": the name of the workflow
- "version": the version of the workflow
- "id": the workflow id
- "workflow_instanceid": the workflow_instanceid of the current workflow instance (if available)
- "stepname": the name of the current step (if available)
- "stepversion": the version of the current step (if available)
- "stepid": the id of the current step (if available)
- "ind": the name of the current step index (if available)
- "execid": the execution ID of the current workflow execution instance (if available)

See also

◆ getValueMap()

static Object com.qoretechnologies.qorus.UserApi.getValueMap	(	String	mapname,
		String	key
	)		throws Throwable

inlinestatic

Gets a lookup value from the value map by a key; the value map must be registered to the current interface.

Parameters

mapname	name of the value map
key	a key name

Returns: the value assigned to the key

Exceptions

VALUE-MAP-ERROR the given value map is unknown or not registered to the current interface

See also

◆ getValueMaps()

static HashMap<String, Object> [] com.qoretechnologies.qorus.UserApi.getValueMaps ( ) throws Throwable

inlinestatic

Gets all value maps valid for the current interface.

Returns

a list of hashes describing available value maps; keys are value map names; values are hashes with the following keys:

"id": the internal ID of the value map
"name": the name of the value map
"description": a string describing the value map
"author": the author tag
"throws_exception": a tag that controls the behavior when an unknown mapping is referenced (Value Map Error Handling and Missing Data)
"valuetype": the type of values in the map
"created": the created time stamp
"modified": the last modified time stamp

See also

◆ logDebug() [1/2]

static void com.qoretechnologies.qorus.UserApi.logDebug ( String msg ) throws Throwable

inlinestatic

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.

Parameters

msg	the message to log

See also

UserApi::logDebug()

◆ logDebug() [2/2]

static void com.qoretechnologies.qorus.UserApi.logDebug	(	String	msg,
		Object...	args
	)		throws Throwable

inlinestatic

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.

Parameters

msg	the message to log
args	arguments to the format placeholders in msg

See also

UserApi::logDebug()

◆ logError() [1/2]

static void com.qoretechnologies.qorus.UserApi.logError ( String msg ) throws Throwable

inlinestatic

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.

Parameters

msg	the message to log

See also

UserApi::logError()

◆ logError() [2/2]

static void com.qoretechnologies.qorus.UserApi.logError	(	String	msg,
		Object...	args
	)		throws Throwable

inlinestatic

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.

Parameters

msg	the message to log
args	arguments to the format placeholders in msg

See also

UserApi::logError()

◆ logFatal() [1/2]

static void com.qoretechnologies.qorus.UserApi.logFatal ( String msg ) throws Throwable

inlinestatic

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.

Parameters

msg	the message to log

See also

UserApi::logFatal()

◆ logFatal() [2/2]

static void com.qoretechnologies.qorus.UserApi.logFatal	(	String	msg,
		Object...	args
	)		throws Throwable

inlinestatic

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.

Parameters

msg	the message to log
args	arguments to the format placeholders in msg

See also

UserApi::logFatal()

◆ logInfo() [1/2]

static void com.qoretechnologies.qorus.UserApi.logInfo ( String msg ) throws Throwable

inlinestatic

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.

Parameters

msg	the message to log

See also

UserApi::logInfo()

◆ logInfo() [2/2]

static void com.qoretechnologies.qorus.UserApi.logInfo	(	String	msg,
		Object...	args
	)		throws Throwable

inlinestatic

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.

Parameters

msg	the message to log
args	arguments to the format placeholders in msg

See also

UserApi::logInfo()

◆ logTrace() [1/2]

static void com.qoretechnologies.qorus.UserApi.logTrace ( String msg ) throws Throwable

inlinestatic

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.

Parameters

msg	the message to log

See also

UserApi::logTrace()

◆ logTrace() [2/2]

static void com.qoretechnologies.qorus.UserApi.logTrace	(	String	msg,
		Object...	args
	)		throws Throwable

inlinestatic

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.

Parameters

msg	the message to log
args	arguments to the format placeholders in msg

See also

UserApi::logTrace()

◆ logWarn() [1/2]

static void com.qoretechnologies.qorus.UserApi.logWarn ( String msg ) throws Throwable

inlinestatic

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.

Parameters

msg	the message to log

See also

UserApi::logWarn()

◆ logWarn() [2/2]

static void com.qoretechnologies.qorus.UserApi.logWarn	(	String	msg,
		Object...	args
	)		throws Throwable

inlinestatic

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.

Parameters

msg	the message to log
args	arguments to the format placeholders in msg

See also

UserApi::logWarn()

◆ postSlaEventError()

static boolean com.qoretechnologies.qorus.UserApi.postSlaEventError	(	String	sla,
		float	value,
		String	err,
		String	desc
	)		throws Throwable

inlinestatic

posts an unsuccessful SLA event for SLA monitoring and performance tracking

Example:: UserApi.postSlaEventError(sla, value, err, desc);

Parameters

sla	the SLA name
value	the SLA performance value
err	the error code for the SLA event error
desc	the error description for the SLA event error

Returns: true if the event was posted, false if not (because the SLA does not exist)

See also

◆ postSlaEventSuccess()

static boolean com.qoretechnologies.qorus.UserApi.postSlaEventSuccess	(	String	sla,
		float	value
	)		throws Throwable

inlinestatic

posts a successful SLA event for SLA monitoring and performance tracking

Example:: UserApi.postSlaEventSuccess(sla, value);

Parameters

sla	the SLA name
value	the SLA performance value

Returns: true if the event was posted, false if not (because the SLA does not exist)

See also

◆ postSyncEvent()

static boolean com.qoretechnologies.qorus.UserApi.postSyncEvent	(	String	eventtype,
		String	eventkey
	)		throws Throwable

inlinestatic

posts a workflow synchronization event given the event type name and the unique event key

Example:: UserApi.postSyncEvent(type, key);

Parameters

eventtype	the event type name
eventkey	the event key in the event type queue to post

Returns: true if the event was posted for the first time, false if the event had already been posted beforehand

Exceptions

UNKNOWN-EVENT unknown event type name

See also

◆ postUserEvent()

static int com.qoretechnologies.qorus.UserApi.postUserEvent	(	String	severity,
		Object	info
	)		throws Throwable

inlinestatic

posts an application event of class OMQ.QE_CLASS_USER

Parameters

severity	see Error Severity Codes for possible values
info	the user-defined information for the event

Exceptions

POST-USER-EVENT-ERROR invalid severity value

See also

◆ propGet() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.propGet ( ) throws Throwable

inlinestatic

returns a hash of all system properties in all domains

Example:: HashMap<String, Object> h = UserApi.propGet();

Returns: a hash of all system properties in all domains; the top-level keys are domain keys which have as values hashes with all key-value pairs set in the domain

See also

◆ propGet() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.propGet ( String domain ) throws Throwable

inlinestatic

returns a hash of all key-value pairs in the given domain or null if the system property domain does not exist

Example:: HashMap<String, Object> h = UserApi.propGet(domain);

Returns: a hash of all key-value pairs in the given domain or null if the system property domain does not exist

See also

◆ propGet() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.propGet	(	String	domain,
		String	key
	)		throws Throwable

inlinestatic

returns the value of the given system property key in the given domain or null if the system property does not exist

Example:: Object val = propGet(domain, key);

Returns: the value of the given system property key in the given domain

See also

◆ propUpdate()

static String com.qoretechnologies.qorus.UserApi.propUpdate	(	String	domain,
		String	key,
		Object	value
	)		throws Throwable

inlinestatic

changes (inserts, updates, or deletes) the value of a single system property

Example:: UserApi.propUpdate(domain, key, val);

Updates the value of the property in the domain passed. If the property does not exist, then it is created. If the value is null, then the property will be deleted. Changes are committed to the database and the internal cache before the method call returns. No changes may be made in the system "omq" domain.

Parameters

domain	the domain of the property to set
key	the key to set
value	the value to set in the property domain; if null is passed here, and the property exists, it will be deleted

Returns: the action code, "INSERT", "UPDATE", "DELETE", "IGNORED" (if a non-existent key should be deleted)

Exceptions

PARAMETER-ERROR	if the domain or key arguments are empty strings
PROP-ERROR	serialized value exceeds 240 characters (column limit)
UPDATE-ERROR	changes attempted in the `"omq"` domain

See also

◆ qorusGetLocalUrl() [1/2]

static String com.qoretechnologies.qorus.UserApi.qorusGetLocalUrl	(	String	username,
		String	password
	)		throws Throwable

inlinestatic

returns a string giving the local system URL

Parameters

username	the username for the new connection
password	the password for the new connection

Returns: a string giving the local system URL

See also

◆ qorusGetLocalUrl() [2/2]

static String com.qoretechnologies.qorus.UserApi.qorusGetLocalUrl ( ) throws Throwable

inlinestatic

returns a string giving the local system URL

Returns: a string giving the local system URL

See also

◆ raiseTransientAlert() [1/2]

static void com.qoretechnologies.qorus.UserApi.raiseTransientAlert	(	String	alert,
		String	reason,
		HashMap< String, Object >	info
	)		throws Throwable

inlinestatic

raises a transient system alert from a workflow, service, or job

Parameters

alert	the name of the alert (ex: `"DATA-SIZE-EXCEEDED"`)
reason	the reason or verbose description of the alert
info	optional key / value details for the alert

See also

◆ raiseTransientAlert() [2/2]

static void com.qoretechnologies.qorus.UserApi.raiseTransientAlert	(	String	alert,
		String	reason
	)		throws Throwable

inlinestatic

raises a transient system alert from a workflow, service, or job

Parameters

alert	the name of the alert (ex: `"DATA-SIZE-EXCEEDED"`)
reason	the reason or verbose description of the alert

See also

◆ restartTransaction()

static String com.qoretechnologies.qorus.UserApi.restartTransaction	(	String	driver,
		HashMap< String, Object >	ex
	)		throws Throwable

inlinestatic

returns a string error message if any exception in the chain passed was caused by a recoverable DB error, otherwise returns NOTHING

Parameters

driver	the database driver name, which must be a driver supported by the Qorus system schema, currently one of `"oracle"`, `"pgsql"`, or `"mysql"`, otherwise an `UNSUPPORTED-DRIVER` exception is thrown
ex	the exception hash

Returns: a string error message if any exception in the chain passed was caused by a recoverable DB error, otherwise returns NOTHING

Exceptions

UNSUPPORTED-DRIVER only "oracle", "pgsql", and "mysql" are currently supported

See also

UserApi::restartTransaction()

◆ runtimeProperties()

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.runtimeProperties ( ) throws Throwable

inlinestatic

returns Qorus runtime properties as a hash

Returns: Qorus runtime properties as a hash; if no properties are set, returns an empty hash

See also

◆ serializeQorusData()

static String com.qoretechnologies.qorus.UserApi.serializeQorusData ( Object d ) throws Throwable

inlinestatic

returns a string giving the default serialization of the given data structure for storage in Qorus

the default serialization is currently YAML

Parameters

d	the data to serialize

Returns: a YAML string representing the given data structure for storage in Qorus, in case the given data is NOTHING an empty string is returned

See also

◆ serializeQorusDataWithNothing()

static String com.qoretechnologies.qorus.UserApi.serializeQorusDataWithNothing ( Object d ) throws Throwable

inlinestatic

returns a string giving the default serialization of the given data structure for storage in Qorus

the default serialization is currently YAML

Parameters

d	the data to serialize

Returns: a YAML string representing the given data structure for storage in Qorus

See also

◆ setOption() [1/2]

static void com.qoretechnologies.qorus.UserApi.setOption ( HashMap< String, Object > hash ) throws Throwable

inlinestatic

Changes option values on a workflow, service, or job.

if called from workflow code, and the workflow has defined workflow options and an invalid option is passed to the method, an exception will be raised; however all other valid options in the hash will be set before the exception is raised.

Parameters

hash	a hash of option-value pairs

Exceptions

WORKFLOW-OPTION-ERROR invalid option name

See also: UserApi::setOption()

◆ setOption() [2/2]

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

inlinestatic

Changes a single option value on a workflow, service, or job.

if called from workflow code, and the workflow has defined workflow options and an invalid option is passed to the method, an exception will be raised; however all other valid options in the hash will be set before the exception is raised.

Parameters

option	the option to set
value	the value to set for the option

Exceptions

WORKFLOW-OPTION-ERROR invalid option name

See also: UserApi::setOption()

◆ unblockOrder() [1/3]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.unblockOrder	(	int	wfiid,
		HashMap< String, Object >	tempdata,
		HashMap< String, Object >	orderkeys
	)		throws Throwable

inlinestatic

unblocks the given workflow order data instance

Parameters

wfiid	the workflow order instance ID to unblock
tempdata	optional workflow order tempdata to pass to the workflow order (will only be used if the order is immediately cached as a part of the unblock_order() call) (may be null)
orderkeys	optional workflow order data keys (may be null)

Returns

a hash with the following key:

workflow_status: the status of the workflow order

Exceptions

BLOCK-WORKFLOW-ERROR invalid status, foreign session id, missing original status, uncancel operation already in progress

See also

◆ unblockOrder() [2/3]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.unblockOrder	(	int	wfiid,
		HashMap< String, Object >	tempdata
	)		throws Throwable

inlinestatic

unblocks the given workflow order data instance

Parameters

wfiid	the workflow order instance ID to unblock
tempdata	optional workflow order tempdata to pass to the workflow order (will only be used if the order is immediately cached as a part of the unblock_order() call)

Returns

a hash with the following key:

workflow_status: the status of the workflow order

Exceptions

BLOCK-WORKFLOW-ERROR invalid status, foreign session id, missing original status, uncancel operation already in progress

See also

◆ unblockOrder() [3/3]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.unblockOrder ( int wfiid ) throws Throwable

inlinestatic

unblocks the given workflow order data instance

Parameters

wfiid the workflow order instance ID to unblock

Returns

a hash with the following key:

workflow_status: the status of the workflow order

Exceptions

BLOCK-WORKFLOW-ERROR invalid status, foreign session id, missing original status, uncancel operation already in progress

See also

◆ uncancelOrder() [1/2]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.uncancelOrder	(	int	wfiid,
		HashMap< String, Object >	tempdata
	)		throws Throwable

inlinestatic

uncancels the given workflow order data instance

Parameters

wfiid	the workflow order instance ID to uncancel
tempdata	temporary data to provide when uncanceling the order

Returns

a hash with the following key:

workflow_status: the status of the workflow order

Exceptions

CANCEL-WORKFLOW-ERROR invalid status, foreign session id, missing original status, uncancel operation already in progress

See also

◆ uncancelOrder() [2/2]

static HashMap<String, Object> com.qoretechnologies.qorus.UserApi.uncancelOrder ( int wfiid ) throws Throwable

inlinestatic

uncancels the given workflow order data instance

Parameters

wfiid the workflow order instance ID to uncancel

Returns

a hash with the following key:

workflow_status: the status of the workflow order

Exceptions

CANCEL-WORKFLOW-ERROR invalid status, foreign session id, missing original status, uncancel operation already in progress

See also

◆ updateOutputData() [1/2]

static void com.qoretechnologies.qorus.UserApi.updateOutputData	(	String	field_name,
		Object	output_data,
		HashMap< String, Object >	output_data_cfg
	)		throws Throwable

inlinestatic

updates output data with the given configuration

Parameters

field_name	name of the field that should be updated; identifies a key in output_data_cfg that provides the location for writing the output data
output_data	the value to write in the location determined by the field_name key in output_data_cfg
output_data_cfg	a hash of values giving output data locations; if not provided, the default location for the output data config is retrieved from configuration item `"output_data"`; field_name must be present in this hash; string values of the key referenced with field_name in this hash provide the location to write output_data and are not subject to template variable expansion

For a list of supported output fields for output_data_cfg values; see template strings listed in Config Item / Building Block Template Substitution Strings marked as writable (W)

Exceptions

UNSUPPORTED-CONTEXT-ERROR	if output data configuration specifies an unsupported context
OUTPUT-CONFIG-ERROR	field_name is not present in output_data_cfg
SENSITIVE-DATA-FORMAT-ERROR	if the `"$sensitive:<skey>.<svalue>.field-ref..."` value or `"$sensitive-alias:<alias>.field-ref..."` template string does not have the required format
SET-ORDER-KEYS-ERROR	missing value for order key
INVALID-WORKFLOW-KEY	workflow key not valid for the current workflow
DUPLICATE-KEY-VALUE	duplicate value provided for order key

See also

Since: Qorus 4.0.3

◆ updateOutputData() [2/2]

static void com.qoretechnologies.qorus.UserApi.updateOutputData	(	HashMap< String, Object >	all_output_data,
		HashMap< String, Object >	output_data_cfg
	)		throws Throwable

inlinestatic

updates all output data

Parameters

all_output_data a hash giving output data; keys in this hash must match a corresponding key in output_data_cfg which will provide the location for writing the value, values in this hash will be written to the locations provided in output_data_cfg

output_data_cfg a hash of values giving output data locations; if not provided, the default location for the output data config is retrieved from configuration item "output_data"; all keys in all_output_data must also be present in this hash; string values of referenced keys in this hash provide the location to write the values of the all_output_data hash; these values are not subject to template variable expansion

For a list of supported output fields for output_data_cfg values; see template strings listed in Config Item / Building Block Template Substitution Strings marked as writable (W)

Exceptions

UNSUPPORTED-CONTEXT-ERROR	if output data configuration specifies an unsupported context
OUTPUT-CONFIG-ERROR	field_name is not present in output_data_cfg
SENSITIVE-DATA-FORMAT-ERROR	if the `"$sensitive:<skey>.<svalue>.field-ref..."` value or `"$sensitive-alias:<alias>.field-ref..."` template string does not have the required format

See also

Since: Qorus 4.0.3

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

/builds/qorus/qorus/java/com/qoretechnologies/qorus/UserApi.java

Static Public Member Methods

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ auditCheckEvent()

◆ auditCheckEventString()

◆ auditGetMask()

◆ auditUserEvent() [1/3]

◆ auditUserEvent() [2/3]

◆ auditUserEvent() [3/3]

◆ bbParseExactlyOneVariable()

◆ blockOrder()

◆ callNetworkApi()

◆ callNetworkApiArgs()

◆ callNetworkApiArgsWithAuthentication()

◆ callRestApi() [1/2]

◆ callRestApi() [2/2]

◆ callRestApiWithAuthentication()

◆ cancelOrder()

◆ clearSqlTableCache() [1/2]

◆ clearSqlTableCache() [2/2]

◆ createOrder() [1/4]

◆ createOrder() [2/4]

◆ createOrder() [3/4]

◆ createOrder() [4/4]

◆ createRemoteOrder() [1/6]

◆ createRemoteOrder() [2/6]

◆ createRemoteOrder() [3/6]

◆ createRemoteOrder() [4/6]

◆ createRemoteOrder() [5/6]

◆ createRemoteOrder() [6/6]

◆ deserializeQorusData()

◆ execSynchronousWorkflow() [1/8]

◆ execSynchronousWorkflow() [2/8]

◆ execSynchronousWorkflow() [3/8]

◆ execSynchronousWorkflow() [4/8]

◆ execSynchronousWorkflow() [5/8]

◆ execSynchronousWorkflow() [6/8]

◆ execSynchronousWorkflow() [7/8]

◆ execSynchronousWorkflow() [8/8]

◆ expandOneVariable()

◆ expandTemplatedValue()

◆ flushSlaEvents()

◆ getActiveJobs()

◆ getBinaryFileFromLocation()

◆ getDatasourceInfo()

◆ getDatasourcePool() [1/2]

◆ getDatasourcePool() [2/2]

◆ getGlobalConfigItemValue()

◆ getInputData() [1/2]

◆ getInputData() [2/2]

◆ getMapper() [1/2]

◆ getMapper() [2/2]

◆ getNextSequenceValue() [1/2]

◆ getNextSequenceValue() [2/2]

◆ getOption() [1/3]

◆ getOption() [2/3]

◆ getOption() [3/3]

◆ getQorusOptionInfo()

◆ getQorusOptionInfoArgs()

◆ getQorusOptions() [1/3]

◆ getQorusOptions() [2/3]

◆ getQorusOptions() [3/3]

◆ getQorusOptionsArgs()

◆ getRemoteRestConnection() [1/3]

◆ getRemoteRestConnection() [2/3]

◆ getRemoteRestConnection() [3/3]

◆ getRunningWorkflowInfo()

◆ getRunningWorkflowList() [1/3]

◆ getRunningWorkflowList() [2/3]

◆ getRunningWorkflowList() [3/3]

◆ getServiceInfo()

◆ getSessionId()

◆ getSqlCacheInfo()

◆ getSqlTable() [1/2]

◆ getSqlTable() [2/2]

◆ getSystemInfo()

◆ getSystemServiceInfo()

◆ getTextFileFromLocation()

◆ getUserConnection() [1/4]