Qorus Integration Engine®  5.0.3_git
com.qoretechnologies.qorus.UserApi Class Reference
Inheritance diagram for com.qoretechnologies.qorus.UserApi:
com.qoretechnologies.qorus.OMQ com.qoretechnologies.qorus.job.JobApi com.qoretechnologies.qorus.service.ServiceApi com.qoretechnologies.qorus.workflow.WorkflowApi com.qoretechnologies.qorus.job.QorusJob com.qoretechnologies.qorus.service.QorusService com.qoretechnologies.qorus.workflow.QorusStepBase com.qoretechnologies.qorus.workflow.QorusWorkflow com.qoretechnologies.qorus.workflow.QorusAsyncStepBase com.qoretechnologies.qorus.workflow.QorusEventStepBase com.qoretechnologies.qorus.workflow.QorusNormalArrayStep com.qoretechnologies.qorus.workflow.QorusNormalStep com.qoretechnologies.qorus.workflow.QorusSubworkflowStepBase com.qoretechnologies.qorus.workflow.QorusAsyncArrayStep com.qoretechnologies.qorus.workflow.QorusAsyncStep com.qoretechnologies.qorus.workflow.QorusEventArrayStep com.qoretechnologies.qorus.workflow.QorusEventStep com.qoretechnologies.qorus.workflow.QorusSubworkflowArrayStep com.qoretechnologies.qorus.workflow.QorusSubworkflowStep

Static Public Member Methods

static Integer auditUserEvent (String user_event, String info1, String info2) throws Throwable
 
static Integer auditUserEvent (String user_event, String info1) throws Throwable
 
static Integer auditUserEvent (String user_event) throws Throwable
 
static boolean auditCheckEventString (String opt) throws Throwable
 
static boolean auditCheckEvent (int opt) throws Throwable
 
static int auditGetMask () throws Throwable
 
static int postUserEvent (String severity, Object info) throws Throwable
 
static HashMap< String, ObjectruntimeProperties () throws Throwable
 
static Object callNetworkApi (String call, Object... args) throws Throwable
 
static Object callNetworkApiArgs (String call, Object[] args) throws Throwable
 
static Object callNetworkApiArgsWithAuthentication (String user, String pass, String call, Object[] args) throws Throwable
 
static Object callRestApi (String method, String path, HashMap< String, Object > body_args) throws Throwable
 
static Object callRestApi (String method, String path) throws Throwable
 
static Object callRestApiWithAuthentication (String user, String pass, String method, String path, HashMap< String, Object > body_args) throws Throwable
 
static AbstractTable getSqlTable (String datasource, String table_name) throws Throwable
 
static AbstractTable getSqlTable (AbstractDatasource datasource, String table_name) throws Throwable
 
static HashMap< String, ObjectgetSqlCacheInfo () throws Throwable
 
static void clearSqlTableCache (String datasource, String table_name) throws Throwable
 
static void clearSqlTableCache (String datasource) throws Throwable
 
static Object getValueMap (String mapname, String key) throws Throwable
 
static HashMap< String, Object >[] getValueMaps () throws Throwable
 
static boolean postSlaEventSuccess (String sla, float value) throws Throwable
 
static boolean postSlaEventError (String sla, float value, String err, String desc) throws Throwable
 
static void flushSlaEvents () throws Throwable
 
static HashMap< String, ObjectgetSystemServiceInfo (String name) throws Throwable
 
static HashMap< String, ObjectgetServiceInfo (String type, String name) throws Throwable
 
static HashMap< String, Object >[] getRunningWorkflowList (String name, String ver) throws Throwable
 
static HashMap< String, Object >[] getRunningWorkflowList (String name) throws Throwable
 
static HashMap< String, Object >[] getRunningWorkflowList () throws Throwable
 
static HashMap< String, ObjectgetRunningWorkflowInfo (int id) throws Throwable
 
static int createOrder (String name, String version, HashMap< String, Object > params) throws Throwable
 
static int createOrder (String name, String version, HashMap< String, Object > params, String status) throws Throwable
 
static int createOrder (String name, HashMap< String, Object > params) throws Throwable
 
static int createOrder (String name, HashMap< String, Object > params, String status) throws Throwable
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params, String status, boolean register_dependency) throws Throwable
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params, String status) throws Throwable
 
static int createRemoteOrder (String remote, String name, String version, HashMap< String, Object > params) throws Throwable
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params, String status, boolean register_dependency) throws Throwable
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params, String status) throws Throwable
 
static int createRemoteOrder (String remote, String name, HashMap< String, Object > params) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, String version, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid, int parent_workflow_instanceid) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid, int parent_workflow_instanceid) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys, String external_order_instanceid) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority, HashMap< String, Object > orderkeys) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata, int priority) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts, HashMap< String, Object > ddata) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata, HashMap< String, Object > opts) throws Throwable
 
static HashMap< String, ObjectexecSynchronousWorkflow (String name, HashMap< String, Object > sdata) throws Throwable
 
static HashMap< String, ObjectgetQorusOptions () throws Throwable
 
static Object getQorusOptions (String opt) throws Throwable
 
static HashMap< String, ObjectgetQorusOptions (String... opts) throws Throwable
 
static HashMap< String, ObjectgetQorusOptionsArgs (String[] opts) throws Throwable
 
static HashMap< String, ObjectgetQorusOptionInfo () throws Throwable
 
static HashMap< String, ObjectgetQorusOptionInfoArgs (String[] args) throws Throwable
 
static HashMap< String, ObjectgetActiveJobs () throws Throwable
 
static Object getUserConnection (String name, boolean connect, boolean register_dependency, HashMap< String, Object > rtopts) throws Throwable
 
static Object getUserConnection (String name, boolean connect, boolean register_dependency) throws Throwable
 
static Object getUserConnection (String name, boolean connect) throws Throwable
 
static Object getUserConnection (String name) throws Throwable
 
static HashMap< String, ObjectgetUserConnectionTags (String name) throws Throwable
 
static DatasourcePool getDatasourcePool (String name, boolean register_dependency) throws Throwable
 
static DatasourcePool getDatasourcePool (String name) throws Throwable
 
static HashMap< String, ObjectgetDatasourceInfo (String name) throws Throwable
 
static QorusSystemRestHelper getRemoteRestConnection (String name, boolean connect, boolean register_dependency) throws Throwable
 
static QorusSystemRestHelper getRemoteRestConnection (String name, boolean connect) throws Throwable
 
static QorusSystemRestHelper getRemoteRestConnection (String name) throws Throwable
 
static void raiseTransientAlert (String alert, String reason, HashMap< String, Object > info) throws Throwable
 
static void raiseTransientAlert (String alert, String reason) throws Throwable
 
static String qorusGetLocalUrl (String username, String password) throws Throwable
 
static String qorusGetLocalUrl () throws Throwable
 
static void setOption (HashMap< String, Object > hash) throws Throwable
 
static void setOption (String option, Object value) throws Throwable
 
static HashMap< String, ObjectgetOption (String... keys) throws Throwable
 
static Object getOption (String key) throws Throwable
 
static HashMap< String, ObjectgetOption () throws Throwable
 
static HashMap< String, ObjectblockOrder (int wfiid) throws Throwable
 
static HashMap< String, ObjectunblockOrder (int wfiid, HashMap< String, Object > tempdata, HashMap< String, Object > orderkeys) throws Throwable
 
static HashMap< String, ObjectunblockOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
 
static HashMap< String, ObjectunblockOrder (int wfiid) throws Throwable
 
static HashMap< String, ObjectcancelOrder (int wfiid) throws Throwable
 
static HashMap< String, ObjectuncancelOrder (int wfiid, HashMap< String, Object > tempdata) throws Throwable
 
static HashMap< String, ObjectuncancelOrder (int wfiid) throws Throwable
 
static HashMap< String, ObjectgetUserContextInfo () throws Throwable
 
static String getContextUserName () throws Throwable
 
static Object getConfigItemValue (String item, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static Object getConfigItemValue (String item, HashMap< String, Object > local_context) throws Throwable
 
static Object getConfigItemValue (String item) throws Throwable
 
static Object getInterfaceConfigItemValue (String item, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static Object getInterfaceConfigItemValue (String item, HashMap< String, Object > local_context) throws Throwable
 
static Object getInterfaceConfigItemValue (String item) throws Throwable
 
static HashMap< String, ObjectgetConfigItemHash (HashMap< String, Object > local_context) throws Throwable
 
static HashMap< String, ObjectgetConfigItemHash () throws Throwable
 
static HashMap< String, ObjectgetInterfaceConfigItemHash (HashMap< String, Object > local_context) throws Throwable
 
static HashMap< String, ObjectgetInterfaceConfigItemHash () throws Throwable
 
static AbstractDataProvider getDataProvider (String path) throws Throwable
 
static AbstractDataProviderType getQorusType (String type_path) throws Throwable
 
static AbstractDataProviderType getTypeFromPath (String path) throws Throwable
 
static Object getGlobalConfigItemValue (String item, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static Object getGlobalConfigItemValue (String item, HashMap< String, Object > local_context) throws Throwable
 
static Object getGlobalConfigItemValue (String item) throws Throwable
 
static Mapper getMapper (String name, HashMap< String, Object > rtopts) throws Throwable
 
static Mapper getMapper (String name) throws Throwable
 
static boolean postSyncEvent (String eventtype, String eventkey) throws Throwable
 
static int getSessionId () throws Throwable
 
static HashMap< String, ObjectgetSystemInfo () throws Throwable
 
static HashMap< String, ObjectpropGet () throws Throwable
 
static HashMap< String, ObjectpropGet (String domain) throws Throwable
 
static HashMap< String, ObjectpropGet (String domain, String key) throws Throwable
 
static String propUpdate (String domain, String key, Object value) throws Throwable
 
static void logFatal (String msg) throws Throwable
 
static void logError (String msg) throws Throwable
 
static void logWarn (String msg) throws Throwable
 
static void logInfo (String msg) throws Throwable
 
static void logDebug (String msg) throws Throwable
 
static void logTrace (String msg) throws Throwable
 
static void logFatal (String msg, Object... args) throws Throwable
 
static void logError (String msg, Object... args) throws Throwable
 
static void logWarn (String msg, Object... args) throws Throwable
 
static void logInfo (String msg, Object... args) throws Throwable
 
static void logDebug (String msg, Object... args) throws Throwable
 
static void logTrace (String msg, Object... args) throws Throwable
 
static int getNextSequenceValue (AbstractDatasource ds, String name) throws Throwable
 
static int getNextSequenceValue (String ds, String name) throws Throwable
 
static String serializeQorusData (Object d) throws Throwable
 
static String serializeQorusDataWithNothing (Object d) throws Throwable
 
static Object deserializeQorusData (String data) throws Throwable
 
static String restartTransaction (String driver, HashMap< String, Object > ex) throws Throwable
 
static String expandOneVariable (String str, String var_context, String var_name, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static String expandOneVariable (String str, String var_context, String var_name, HashMap< String, Object > local_context) throws Throwable
 
static Object expandTemplatedValue (String str, HashMap< String, Object > local_context, boolean expand_complex_values) throws Throwable
 
static Object expandTemplatedValue (String str, HashMap< String, Object > local_context) throws Throwable
 
static HashMap< String, ObjectbbParseExactlyOneVariable (String str) throws Throwable
 
static HashMap< String, ObjectgetInputData (String field_name, HashMap< String, Object > local_context, HashMap< String, Object > input_data_cfg) throws Throwable
 
static HashMap< String, ObjectgetInputData (HashMap< String, Object > input_data_cfg, HashMap< String, Object > local_context) throws Throwable
 
static void updateOutputData (String field_name, Object output_data, HashMap< String, Object > output_data_cfg) throws Throwable
 
static void updateOutputData (HashMap< String, Object > all_output_data, HashMap< String, Object > output_data_cfg) throws Throwable
 
static String getTextFileFromLocation (String location) throws Throwable
 
static byte[] getBinaryFileFromLocation (String location) throws Throwable
 
static void startCapturingObjects () throws Throwable
 
static void stopCapturingObjects () throws Throwable
 
static void saveObjectInObjectCache (QoreObject obj) throws Throwable
 
static boolean clearObjectFromObjectCache (QoreObject obj) throws Throwable
 
static ZonedDateTime checkObjectCache (QoreObject obj) throws Throwable
 
static int getObjectCacheSize () throws Throwable
 
static int clearObjectCache () throws Throwable
 
static int clearObjectCache (ZonedDateTime cutoff) throws Throwable
 
static Object executeFsm (String name, Object arg) throws Throwable
 Executes the given Finite State Machine and returns the final output. More...
 
static Object executeFsm (String name) throws Throwable
 Executes the given Finite State Machine and returns the final output. More...
 
static void registerFsmAsObserver (String fsm_name, Observable observable, String event_id) throws Throwable
 Registers the given FSM with the given object as an Observer. More...
 

Static Private:Internal Member Methods

static Object doUserConnectionIntern (Object obj)
 

Additional Inherited Members

- Static Public Attributes inherited from com.qoretechnologies.qorus.OMQ
static final String OT_CONSTANT = "CONSTANT"
 
static final String OT_CLASS = "CLASS"
 
static final String OT_FUNCTION = "FUNCTION"
 
static final String ExecNormal = "NORMAL"
 
static final String ExecAsync = "ASYNC"
 
static final String ExecSubWorkflow = "SUBWORKFLOW"
 
static final String ExecEvent = "EVENT"
 
static final String SSRunning = "running"
 
static final String SSLoaded = "loaded"
 
static final String SLNone = "none"
 
static final String SLRead = "read"
 
static final String SLWrite = "write"
 
static final String SQLStatComplete = "C"
 
static final String SQLStatError = "E"
 
static final String SQLStatWaiting = "W"
 
static final String SQLStatInProgress = "I"
 
static final String SQLStatIncomplete = "N"
 
static final String SQLStatAsyncWaiting = "A"
 
static final String SQLStatEventWaiting = "V"
 
static final String SQLStatRetry = "R"
 
static final String SQLStatCanceled = "X"
 
static final String SQLStatReady = "Y"
 
static final String SQLStatScheduled = "S"
 
static final String SQLStatBlocked = "B"
 
static final int LL_CRITICAL = -1
 
static final int LL_IMPORTANT = 0
 
static final int LL_INFO = 1
 
static final int LL_DETAIL_1 = 2
 
static final int LL_DETAIL_2 = 3
 
static final int LL_DEBUG_1 = 4
 
static final int LL_DEBUG_2 = 5
 
static final int LL_DEBUG_3 = 6
 
static final String WM_Normal = "NORMAL"
 
static final String WM_Recovery = "RECOVERY"
 
static final String StatComplete = "COMPLETE"
 
static final String StatError = "ERROR"
 
static final String StatWaiting = "WAITING"
 
static final String StatInProgress = "IN-PROGRESS"
 
static final String StatIncomplete = "INCOMPLETE"
 
static final String StatAsyncWaiting = "ASYNC-WAITING"
 
static final String StatEventWaiting = "EVENT-WAITING"
 
static final String StatRetry = "RETRY"
 
static final String StatCanceled = "CANCELED"
 
static final String StatReady = "READY"
 
static final String StatScheduled = "SCHEDULED"
 
static final String StatBlocked = "BLOCKED"
 
static final Map< String, StringStatMap
 
static final Map< String, StringSQLStatMap
 
static final String ES_Major = "MAJOR"
 
static final String ES_Warning = "WARNING"
 
static final String CS_Clean = "C"
 
static final String CS_RecoveredAuto = "A"
 
static final String CS_RecoveredManual = "M"
 
static final String QS_Waiting = "WAITING"
 
static final String QS_Received = "RECEIVED"
 
static final String QS_Error = "ERROR"
 
static final String QS_Used = "USED"
 
static final String SQL_QS_Waiting = "W"
 
static final String SQL_QS_Received = "R"
 
static final String SQL_QS_Error = "E"
 
static final String SQL_QS_Used = "X"
 
static final Map< String, StringQSMap
 
static final Map< String, StringSQLQSMap
 
static final String QR_LOGIN = "LOGIN"
 
static final String QR_SHUTDOWN = "SHUTDOWN"
 
static final String QR_WORKFLOW_CONTROL = "WORKFLOW-CONTROL"
 
static final String QR_WORKFLOW_EXEC_CONTROL = "WORKFLOW-EXEC-CONTROL"
 
static final String QR_START_WORKFLOW = "START-WORKFLOW"
 
static final String QR_STOP_WORKFLOW = "STOP-WORKFLOW"
 
static final String QR_RESET_WORKFLOW = "RESET-WORKFLOW"
 
static final String QR_WORKFLOW_OPTION_CONTROL = "WORKFLOW-OPTION-CONTROL"
 
static final String QR_WORKFLOW_ERROR_CONTROL = "WORKFLOW-ERROR-CONTROL"
 
static final String QR_WORKFLOW_ORDER_CONTROL = "WORKFLOW-ORDER-CONTROL"
 
static final String QR_RETRY_WORKFLOW_ORDER = "RETRY-WORKFLOW-ORDER"
 
static final String QR_RESCHEDULE_WORKFLOW_ORDER = "RESCHEDULE-WORKFLOW-ORDER"
 
static final String QR_REPRIORITIZE_WORKFLOW_ORDER = "REPRIORITIZE-WORKFLOW-ORDER"
 
static final String QR_BLOCK_WORKFLOW_ORDER = "BLOCK-WORKFLOW-ORDER"
 
static final String QR_CANCEL_WORKFLOW_ORDER = "CANCEL-WORKFLOW-ORDER"
 
static final String QR_SET_WORKFLOW_ORDER_ERROR = "SET-WORKFLOW-ORDER-ERROR"
 
static final String QR_SKIP_STEP = "SKIP-STEP"
 
static final String QR_SET_ORDER_INFO = "SET-ORDER-INFO"
 
static final String QR_POST_WORKFLOW_EVENT = "POST-WORKFLOW-EVENT"
 
static final String QR_LOCK_WORKFLOW_ORDER = "LOCK-WORKFLOW-ORDER"
 
static final String QR_BREAK_WORKFLOW_ORDER_LOCK = "BREAK-WORKFLOW-ORDER-LOCK"
 
static final String QR_EDIT_WORKFLOW_DATA = "EDIT-WORKFLOW-DATA"
 
static final String QR_READ_SENSITIVE_DATA = "READ-SENSITIVE-DATA"
 
static final String QR_EDIT_SENSITIVE_DATA = "EDIT-SENSITIVE-DATA"
 
static final String QR_DELETE_SENSITIVE_DATA = "DELETE-SENSITIVE-DATA"
 
static final String QR_SENSITIVE_DATA_CONTROL = "SENSITIVE-DATA-CONTROL"
 
static final String QR_EXEC_SYNC_WORKFLOW = "EXEC-SYNC-WORKFLOW"
 
static final String QR_SUBMIT_ORDER = "SUBMIT-ORDER"
 
static final String QR_SET_STEP_CONFIG = "SET-STEP-CONFIG"
 
static final String QR_SET_WORKFLOW_CONFIG = "SET-WORKFLOW-CONFIG"
 
static final String QR_SERVICE_CONTROL = "SERVICE-CONTROL"
 
static final String QR_LOAD_SERVICE = "LOAD-SERVICE"
 
static final String QR_UNLOAD_SERVICE = "UNLOAD-SERVICE"
 
static final String QR_RESET_SERVICE = "RESET-SERVICE"
 
static final String QR_SET_SERVICE_AUTOSTART = "SET-SERVICE-AUTOSTART"
 
static final String QR_SET_SERVICE_OPTIONS = "SET-SERVICE-OPTIONS"
 
static final String QR_CALL_USER_SERVICES_RO = "CALL-USER-SERVICES-RO"
 
static final String QR_CALL_SYSTEM_SERVICES_RO = "CALL-SYSTEM-SERVICES-RO"
 
static final String QR_CALL_USER_SERVICES_RW = "CALL-USER-SERVICES-RW"
 
static final String QR_CALL_SYSTEM_SERVICES_RW = "CALL-SYSTEM-SERVICES-RW"
 
static final String QR_SET_SERVICE_CONFIG = "SET-SERVICE-CONFIG"
 
static final String QR_SERVICE_OPTION_CONTROL = "SERVICE-OPTION-CONTROL"
 
static final String QR_USER_CONTROL = "USER-CONTROL"
 
static final String QR_RELOAD_RBAC = "RELOAD-RBAC"
 
static final String QR_ADD_USER = "ADD-USER"
 
static final String QR_MODIFY_USER = "MODIFY-USER"
 
static final String QR_DELETE_USER = "DELETE-USER"
 
static final String QR_ADD_PERMISSION = "ADD-PERMISSION"
 
static final String QR_MODIFY_PERMISSION = "MODIFY-PERMISSION"
 
static final String QR_DELETE_PERMISSION = "DELETE-PERMISSION"
 
static final String QR_ADD_ROLE = "ADD-ROLE"
 
static final String QR_MODIFY_ROLE = "MODIFY-ROLE"
 
static final String QR_DELETE_ROLE = "DELETE-ROLE"
 
static final String QR_OPTION_CONTROL = "OPTION-CONTROL"
 
static final String QR_LOGGER_CONTROL = "LOGGER-CONTROL"
 
static final String QR_ROTATE_LOG_FILES = "ROTATE-LOG-FILES"
 
static final String QR_MODIFY_LOGGER = "MODIFY-LOGGER"
 
static final String QR_DELETE_LOGGER = "DELETE-LOGGER"
 
static final String QR_CREATE_LOGGER = "CREATE-LOGGER"
 
static final String QR_DATASOURCE_CONTROL = "DATASOURCE-CONTROL"
 
static final String QR_READ_DATASOURCE = "READ-DATASOURCE"
 
static final String QR_ADD_DATASOURCE = "ADD-DATASOURCE"
 
static final String QR_SELECT_DATASOURCE = "SELECT-DATASOURCE"
 
static final String QR_MODIFY_DATASOURCE = "MODIFY-DATASOURCE"
 
static final String QR_RESET_DATASOURCE = "RESET-DATASOURCE"
 
static final String QR_DELETE_DATASOURCE = "DELETE-DATASOURCE"
 
static final String QR_RELOAD_DATASOURCE = "RELOAD-DATASOURCE"
 
static final String QR_FLUSH_DATASOURCE = "FLUSH-DATASOURCE"
 
static final String QR_SQLUTIL_READ = "SQLUTIL-READ"
 
static final String QR_SQLUTIL_WRITE = "SQLUTIL-WRITE"
 
static final String QR_GROUP_CONTROL = "GROUP-CONTROL"
 
static final String QR_ADD_GROUP = "ADD-GROUP"
 
static final String QR_MODIFY_GROUP = "MODIFY-GROUP"
 
static final String QR_DELETE_GROUP = "DELETE-GROUP"
 
static final String QR_MODIFY_GROUP_STATUS = "MODIFY-GROUP-STATUS"
 
static final String QR_SERVER_CONTROL = "SERVER-CONTROL"
 
static final String QR_SET_PROPERTY = "SET-PROPERTY"
 
static final String QR_DELETE_PROPERTY = "DELETE-PROPERTY"
 
static final String QR_RELOAD_PROPERTIES = "RELOAD-PROPERTIES"
 
static final String QR_START_LISTENER = "START-LISTENER"
 
static final String QR_STOP_LISTENER = "STOP-LISTENER"
 
static final String QR_JOB_CONTROL = "JOB-CONTROL"
 
static final String QR_RUN_JOB = "RUN-JOB"
 
static final String QR_MODIFY_JOB_STATUS = "MODIFY-JOB-STATUS"
 
static final String QR_MODIFY_JOB_EXPIRY = "MODIFY-JOB-EXPIRY"
 
static final String QR_RESCHEDULE_JOB = "RESCHEDULE-JOB"
 
static final String QR_RESET_JOB = "RESET-JOB"
 
static final String QR_SET_JOB_OPTIONS = "SET-JOB-OPTIONS"
 
static final String QR_SET_JOB_CONFIG = "SET-JOB-CONFIG"
 
static final String QR_JOB_OPTION_CONTROL = "JOB-OPTION-CONTROL"
 
static final String QR_SCHEMA_CONTROL = "SCHEMA-CONTROL"
 
static final String QR_USER_CONNECTION_CONTROL = "USER-CONNECTION-CONTROL"
 
static final String QR_READ_USER_CONNECTION = "READ-USER-CONNECTION"
 
static final String QR_RELOAD_USER_CONNECTION = "RELOAD-USER-CONNECTION"
 
static final String QR_ADD_USER_CONNECTION = "ADD-USER-CONNECTION"
 
static final String QR_MODIFY_USER_CONNECTION = "MODIFY-USER-CONNECTION"
 
static final String QR_DELETE_USER_CONNECTION = "DELETE-USER-CONNECTION"
 
static final String QR_SERVER_CONNECTION_CONTROL = "SERVER-CONNECTION-CONTROL"
 
static final String QR_RELOAD_SERVER_CONNECTION = "RELOAD-SERVER-CONNECTION"
 
static final String QR_READ_SERVER_CONNECTION = "READ-SERVER-CONNECTION"
 
static final String QR_ADD_SERVER_CONNECTION = "ADD-SERVER-CONNECTION"
 
static final String QR_MODIFY_SERVER_CONNECTION = "MODIFY-SERVER-CONNECTION"
 
static final String QR_DELETE_SERVER_CONNECTION = "DELETE-SERVER-CONNECTION"
 
static final String QR_FILESYSTEM_CONTROL = "FILESYSTEM-CONTROL"
 
static final String QR_FILESYSTEM_READ = "FILESYSTEM-READ"
 
static final String QR_FILESYSTEM_WRITE = "FILESYSTEM-WRITE"
 
static final String QR_MAPPER_CONTROL = "MAPPER-CONTROL"
 
static final String QR_RELOAD_MAPPER = "RELOAD-MAPPER"
 
static final String QR_MODIFY_MAPPER = "MODIFY-MAPPER"
 
static final String QR_VALUE_MAP_CONTROL = "VALUE-MAP-CONTROL"
 
static final String QR_RELOAD_VALUE_MAP = "RELOAD-VALUE-MAP"
 
static final String QR_MODIFY_VALUE_MAP = "MODIFY-VALUE-MAP"
 
static final String QR_CREATE_SLA = "CREATE-SLA"
 
static final String QR_DELETE_SLA = "DELETE-SLA"
 
static final String QR_MODIFY_SLA = "MODIFY-SLA"
 
static final String QR_SLA_CONTROL = "SLA-CONTROL"
 
static final String QR_DEBUG_CONTROL = "DEBUG-CONTROL"
 
static final String QR_REMOTE_DEPLOYMENT = "REMOTE-DEPLOYMENT"
 
static final String QR_REMOTE_DELETE_INTERFACE = "REMOTE-DELETE-INTERFACE"
 
static final String QR_REMOTE_RELEASE = "REMOTE-RELEASE"
 
static final String QR_REMOTE_EXEC_ALL = "REMOTE-EXEC-ALL"
 
static final String QR_KILL_PROCESS = "KILL-PROCESS"
 
static final String QR_DATA_PROVIDER_CONTROL = "DATA-PROVIDER-CONTROL"
 
static final String QR_DATA_PROVIDER_CREATE = "DATA-PROVIDER-CREATE"
 
static final String QR_DATA_PROVIDER_READ = "DATA-PROVIDER-READ"
 
static final String QR_DATA_PROVIDER_UPDATE = "DATA-PROVIDER-UPDATE"
 
static final String QR_DATA_PROVIDER_DELETE = "DATA-PROVIDER-DELETE"
 
static final String QR_TYPE_CACHE_CONTROL = "TYPE-CACHE-CONTROL"
 
static final String QR_TYPE_CACHE_RELOAD = "TYPE-CACHE-RELOAD"
 
static final String QR_TYPE_CACHE_CREATE = "TYPE-CACHE-CREATE"
 
static final String QR_TYPE_CACHE_DELETE = "TYPE-CACHE-DELETE"
 
static final String QR_SET_FSM_CONFIG = "SET-FSM-CONFIG"
 Finite State Machine System Permission: "SET-FSM-CONFIG". More...
 
static final String QR_SET_PIPELINE_CONFIG = "SET-PIPELINE-CONFIG"
 Pipeline System Permission: "SET-PIPELINE-CONFIG". More...
 
static final String QR_UPLOAD = "UPLOAD"
 #! Remote Command System Permission: "UPLOAD" More...
 
static final int QE_CLASS_SYSTEM = 101
 
static final int QE_CLASS_WORKFLOW = 102
 
static final int QE_CLASS_SERVICE = 103
 
static final int QE_CLASS_USER = 104
 
static final int QE_CLASS_JOB = 105
 
static final int QE_CLASS_ALERT = 106
 
static final int QE_CLASS_GROUP = 107
 
static final int QE_CLASS_CONNECTION = 108
 
static final int QE_CLASS_PROCESS = 109
 
static final int QE_CLASS_CLUSTER = 110
 
static final int QE_CLASS_LOGGER = 111
 
static final int QE_CLASS_CONFIG_ITEM = 112
 
static final Map< Integer, StringQE_MAP_CLASS
 
static final int QEC_SYSTEM_STARTUP = 1001
 
static final int QEC_SYSTEM_SHUTDOWN = 1002
 
static final int QEC_SYSTEM_ERROR = 1003
 
static final int QEC_SYSTEM_HEALTH_CHANGED = 1004
 
static final int QEC_SYSTEM_REMOTE_HEALTH_CHANGED = 1005
 
static final int QEC_GROUP_STATUS_CHANGED = 1101
 
static final int QEC_WORKFLOW_START = 2001
 
static final int QEC_WORKFLOW_STOP = 2002
 
static final int QEC_WORKFLOW_CACHE_RESET = 2003
 
static final int QEC_WORKFLOW_DATA_SUBMITTED = 2004
 
static final int QEC_WORKFLOW_DATA_ERROR = 2005
 
static final int QEC_WORKFLOW_DATA_RELEASED = 2006
 
static final int QEC_WORKFLOW_DATA_CACHED = 2007
 
static final int QEC_WORKFLOW_INFO_CHANGED = 2008
 
static final int QEC_WORKFLOW_STATUS_CHANGED = 2009
 
static final int QEC_WORKFLOW_STEP_PERFORMANCE = 2010
 
static final int QEC_WORKFLOW_PERFORMANCE = 2011
 
static final int QEC_WORKFLOW_DATA_LOCKED = 2012
 
static final int QEC_WORKFLOW_DATA_UNLOCKED = 2013
 
static final int QEC_WORKFLOW_DATA_UPDATED = 2014
 
static final int QEC_WORKFLOW_STATS_UPDATED = 2015
 
static final int QEC_WORKFLOW_RECOVERED = 2016
 
static final int QEC_WORKFLOW_UPDATED = 2017
 
static final int QEC_WORKFLOW_STEP_DATA_UPDATED = 2018
 
static final int QEC_SERVICE_START = 3001
 
static final int QEC_SERVICE_STOP = 3002
 
static final int QEC_SERVICE_ERROR = 3003
 
static final int QEC_SERVICE_AUTOSTART_CHANGE = 3004
 
static final int QEC_SERVICE_METHOD_PERFORMANCE = 3005
 
static final int QEC_SERVICE_UPDATED = 3006
 
static final int QEC_JOB_START = 4001
 
static final int QEC_JOB_STOP = 4002
 
static final int QEC_JOB_ERROR = 4003
 
static final int QEC_JOB_INSTANCE_START = 4004
 
static final int QEC_JOB_INSTANCE_STOP = 4005
 
static final int QEC_JOB_RECOVERED = 4006
 
static final int QEC_JOB_UPDATED = 4007
 
static final int QEC_CONFIG_ITEM_CHANGED = 4100
 
static final int QEC_ALERT_ONGOING_RAISED = 5006
 
static final int QEC_ALERT_ONGOING_CLEARED = 5007
 
static final int QEC_ALERT_TRANSIENT_RAISED = 5008
 
static final int QEC_CONNECTION_UP = 5101
 
static final int QEC_CONNECTION_DOWN = 5102
 
static final int QEC_CONNECTION_ENABLED_CHANGE = 5103
 
static final int QEC_CONNECTION_CREATED = 5104
 
static final int QEC_CONNECTION_UPDATED = 5105
 
static final int QEC_CONNECTION_DELETED = 5106
 
static final int QEC_CONNECTIONS_RELOADED = 5107
 
static final int QEC_CONNECTION_DEBUG_DATA_CHANGE = 5108
 
static final int QEC_LOGGER_CREATED = 5200
 
static final int QEC_LOGGER_UPDATED = 5201
 
static final int QEC_LOGGER_DELETED = 5202
 
static final int QEC_APPENDER_CREATED = 5203
 
static final int QEC_APPENDER_DELETED = 5204
 
static final int QEC_APPENDER_UPDATED = 5205
 
static final int QEC_PROCESS_STARTED = 6001
 
static final int QEC_PROCESS_STOPPED = 6002
 
static final int QEC_PROCESS_START_ERROR = 6003
 
static final int QEC_PROCESS_MEMORY_CHANGED = 6004
 
static final int QEC_NODE_INFO = 7001
 
static final int QEC_NODE_REMOVED = 7002
 Qorus Event Code: NODE_REMOVED. More...
 
static final int QEC_USER_EVENT = 9001
 
static final Map< Integer, StringQE_MAP_EVENT
 
static final int QSE_OK = 0
 
static final int QSE_NO_INSTANCE_KEY = 1
 
static final int QSE_INVALID_DB_MAX_THREADS = 2
 
static final int QSE_DATASOURCE = 3
 
static final int QSE_LOG_ERROR = 4
 
static final int QSE_RBAC_ERROR = 5
 
static final int QSE_EVENT_ERROR = 6
 
static final int QSE_SESSION_ERROR = 7
 
static final int QSE_COMMAND_LINE_ERROR = 8
 
static final int QSE_OPTION_ERROR = 9
 
static final int QSE_VERSION_ONLY = 10
 
static final int QSE_STARTUP_ERROR = 99
 
static final int DefaultOrderPriority = 500
 
static final String JS_Complete = "COMPLETE"
 
static final String JS_InProgress = "IN-PROGRESS"
 
static final String JS_Error = "ERROR"
 
static final String JS_Crash = "CRASH"
 
static final String SQL_JS_Complete = "C"
 
static final String SQL_JS_InProgress = "I"
 
static final String SQL_JS_Error = "E"
 
static final String SQL_JS_Crash = "Z"
 
static final Map< String, StringJSMap
 
static final Map< String, StringSQLJSMap
 
static final int AE_USER_EVENT = 1
 
static final int AE_SYSTEM_STARTUP = 2
 
static final int AE_SYSTEM_SHUTDOWN = 3
 
static final int AE_SYSTEM_RECOVERY_START = 4
 
static final int AE_SYSTEM_RECOVERY_COMPLETE = 5
 
static final int AE_WORKFLOW_STATUS_CHANGE = 6
 
static final int AE_WORKFLOW_START = 7
 
static final int AE_WORKFLOW_STOP = 8
 
static final int AE_SERVICE_START = 9
 
static final int AE_SERVICE_STOP = 10
 
static final int AE_JOB_START = 11
 
static final int AE_JOB_STOP = 12
 
static final int AE_JOB_INSTANCE_START = 13
 
static final int AE_JOB_INSTANCE_STOP = 14
 
static final int AE_API_CALL = 15
 
static final int AE_JOB_RECOVERY = 16
 
static final int AE_WORKFLOW_DATA_CREATED = 17
 
static final int AE_ALERT_ONGOING_RAISED = 18
 
static final int AE_ALERT_ONGOING_CLEARED = 19
 
static final int AE_ALERT_TRANSIENT_RAISED = 20
 
static final int AE_SOURCE_FILE_LOADED = 21
 
static final int AE_GROUP_STATUS_CHANGED = 22
 
static final String AES_USER_EVENT = "USER-EVENT"
 
static final String AES_SYSTEM_STARTUP = "SYSTEM-STARTUP"
 
static final String AES_SYSTEM_SHUTDOWN = "SYSTEM-SHUTDOWN"
 
static final String AES_SYSTEM_RECOVERY_START = "SYSTEM-RECOVERY-START"
 
static final String AES_SYSTEM_RECOVERY_COMPLETE = "SYSTEM-RECOVERY-COMPLETE"
 
static final String AES_WORKFLOW_STATUS_CHANGE = "WORKFLOW-STATUS-CHANGE"
 
static final String AES_WORKFLOW_START = "WORKFLOW-START"
 
static final String AES_WORKFLOW_STOP = "WORKFLOW-STOP"
 
static final String AES_SERVICE_START = "SERVICE-START"
 
static final String AES_SERVICE_STOP = "SERVICE-STOP"
 
static final String AES_JOB_START = "JOB-START"
 
static final String AES_JOB_STOP = "JOB-STOP"
 
static final String AES_JOB_INSTANCE_START = "JOB-INSTANCE-STOP"
 
static final String AES_JOB_INSTANCE_STOP = "JOB-INSTANCE-START"
 
static final String AES_API_CALL = "API-CALL"
 
static final String AES_JOB_RECOVERY = "JOB-RECOVERY"
 
static final String AES_WORKFLOW_DATA_CREATED = "WORKFLOW-DATA-CREATED"
 
static final String AES_ALERT_ONGOING_RAISED = "ALERT-ONGOING-RAISED"
 
static final String AES_ALERT_ONGOING_CLEARED = "ALERT-ONGOING-CLEARED"
 
static final String AES_ALERT_TRANSIENT_RAISED = "ALERT-TRANSIENT-RAISED"
 
static final String AES_SOURCE_FILE_LOADED = "SOURCE-FILE-LOADED"
 
static final String AES_GROUP_STATUS_CHANGED = "GROUP-STATUS-CHANGED"
 
static final Map< Integer, StringAuditEventMap
 
static final Map< String, Integer > AuditEventCodeMap
 
static final String AO_SYSTEM = "system"
 
static final String AO_WORKFLOWS = "workflows"
 
static final String AO_WORKFLOW_DATA = "workflow-data"
 
static final String AO_JOBS = "jobs"
 
static final String AO_JOB_DATA = "job-data"
 
static final String AO_SERVICES = "services"
 
static final String AO_API = "api"
 
static final String AO_USER_EVENTS = "user-events"
 
static final String AO_OLOAD_EVENTS = "oload"
 
static final String AO_ALERT_EVENTS = "alerts"
 
static final String AO_GROUP_EVENTS = "groups"
 
static final int AOC_SYSTEM = (1 << 0)
 
static final int AOC_WORKFLOWS = (1 << 1)
 
static final int AOC_WORKFLOW_DATA = (1 << 2)
 
static final int AOC_JOBS = (1 << 3)
 
static final int AOC_JOB_DATA = (1 << 4)
 
static final int AOC_SERVICES = (1 << 5)
 
static final int AOC_API = (1 << 6)
 
static final int AOC_USER_EVENTS = (1 << 7)
 
static final int AOC_OLOAD_EVENTS = (1 << 8)
 
static final int AOC_ALERT_EVENTS = (1 << 9)
 
static final int AOC_GROUP_EVENTS = (1 << 10)
 
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)
 
static final Map< String, Integer > AuditOptionMap
 
static final Map< Integer, StringAuditCodeMap
 

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
optthe 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
UserApi::auditCheckEvent()
audit_check_event()

◆ 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
optthe 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-ERRORthe given audit event string does not exist
See also
UserApi::auditCheckEventString()
audit_check_event_string()

◆ auditGetMask()

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

Returns the audit event mask

Returns
the audit event mask
See also
UserApi::auditGetMask()
audit_get_mask()

◆ auditUserEvent() [1/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_eventthe 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
UserApi::auditUserEvent()
audit_user_event()

◆ 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_eventthe user event code string
info1optional 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
UserApi::auditUserEvent()
audit_user_event()

◆ auditUserEvent() [3/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_eventthe user event code string
info1optional informational string for the AUDIT_EVENTS.INFO1 field
info2optional 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
UserApi::auditUserEvent()
audit_user_event()

◆ 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
strtemplated 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-ERRORif 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
wfiidthe 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-ERRORinvalid status, foreign session id, missing original status, uncancel operation already in progress
See also
UserApi::blockOrder()
block_order()

◆ 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
callthe full RPC API method name (ex: "omq.system.exec-synchronous-exiting"); see Network System API for a full list
argsthe arguments to the call
Returns
the return value of the method
Exceptions
UNKNOWN-API-CALLinvalid API method
INVALID-INTERNAL-API-CALLAPI 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
callthe full RPC API method name (ex: "omq.system.exec-synchronous-exiting"); see Network System API for a full list
argsany 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-CALLinvalid API method
INVALID-INTERNAL-API-CALLAPI 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
userthe username to use for the call
passthe password to use for the call
callthe full RPC API method name (ex: "omq.system.exec-synchronous-exiting"); see Network System API for a full list
argsany 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-CALLinvalid API method
INVALID-INTERNAL-API-CALLAPI may not be called internally (ex: omq.system.shutdown-wait())
See also
UserApi::callNetworkApiArgsWithAuthentication()
call_network_api_args_with_authentication()
callNetworkApiArgs()
callNetworkApi()
callRestApi()
callRestApiWithAuthentication()

◆ callRestApi() [1/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
methodthe HTTP method name
paththe 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

◆ callRestApi() [2/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
methodthe HTTP method name
paththe 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_argsthe 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

◆ 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
userthe username to use for the call
passthe password to use for the call
methodthe HTTP method name
paththe 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_argsthe 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
wfiidthe 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-ERRORinvalid status, foreign session id, missing original status, uncancel operation already in progress
See also
UserApi::cancelOrder()
cancel_order()

◆ checkObjectCache()

static ZonedDateTime com.qoretechnologies.qorus.UserApi.checkObjectCache ( QoreObject  obj) throws Throwable
inlinestatic

Returns the date/time the object was cached or null if the object is not in the cache

Parameters
objthe object to check
Exceptions
NO-INTERFACEthrown if there is no interface context; this API is only valid when called in a workflow, service, or job context
Since
Qorus 4.1

◆ clearObjectCache() [1/2]

static int com.qoretechnologies.qorus.UserApi.clearObjectCache ( ) throws Throwable
inlinestatic

Clears the entire the object cache

Returns
the number of objects cleared from the cache
Exceptions
NO-INTERFACEthrown if there is no interface context; this API is only valid when called in a workflow, service, or job context
Since
Qorus 4.1

◆ clearObjectCache() [2/2]

static int com.qoretechnologies.qorus.UserApi.clearObjectCache ( ZonedDateTime  cutoff) throws Throwable
inlinestatic

Clears the entire the object cache for all objects cached before the given date/time

Returns
the number of objects cleared from the cache
Exceptions
NO-INTERFACEthrown if there is no interface context; this API is only valid when called in a workflow, service, or job context
Since
Qorus 4.1

◆ clearObjectFromObjectCache()

static boolean com.qoretechnologies.qorus.UserApi.clearObjectFromObjectCache ( QoreObject  obj) throws Throwable
inlinestatic

Removes the object from the object cache

Returns
true if the object was removed, false if it was not in the cache
Exceptions
NO-INTERFACEthrown if there is no interface context; this API is only valid when called in a workflow, service, or job context
Since
Qorus 4.1

◆ clearSqlTableCache() [1/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
datasourcethe name of a Qorus datasource
Example:
UserApi.clearSqlTableCache("omquser");
See also
UserApi::clearSqlTableCache()
Qorus SQL Object Cache
clear_sql_table_cache()

◆ clearSqlTableCache() [2/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
datasourcethe name of a Qorus datasource
table_namethe table name to clear
Example:
UserApi.clearSqlTableCache("omquser", "table");
See also
UserApi::clearSqlTableCache()
Qorus SQL Object Cache
clear_sql_table_cache()

◆ createOrder() [1/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
namethe 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
paramsThe 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-ERRORinvalid status value
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createOrder()
create_order()
createRemoteOrder()

◆ createOrder() [2/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
namethe name of the workflow; the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
paramsThe 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
statuscreate the workflow order data instance with this status; may be either:
Returns
the workflow instance ID created
Exceptions
SUBMIT-ORDER-ERRORinvalid status value
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createOrder()
create_order()
createRemoteOrder()

◆ createOrder() [3/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
namethe name of the workflow
versionthe 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
paramsThe 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-ERRORinvalid status value
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createOrder()
create_order()
createRemoteOrder()

◆ createOrder() [4/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
namethe name of the workflow
versionthe 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
paramsThe 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
statuscreate the workflow order data instance with this status; may be either:
Returns
the workflow instance ID created
Exceptions
SUBMIT-ORDER-ERRORinvalid status value
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createOrder()
create_order()
createRemoteOrder()

◆ createRemoteOrder() [1/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
remotethe name of the remote Qorus connection
namethe name of the workflow; the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
paramsThe 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-ERRORThe given connection is not known
SUBMIT-ORDER-ERRORinvalid status value
WORKFLOW-ERRORunknown or invalid workflow
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createRemoteOrder()
create_remote_order()
createOrder()

◆ createRemoteOrder() [2/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
remotethe name of the remote Qorus connection
namethe name of the workflow; the latest version of the named worklow is used to create the order
paramsThe 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
statuscreate the workflow order data instance with this status; may be either:
Returns
the workflow instance ID created
Exceptions
GET-REMOTE-ERRORThe given connection is not known
SUBMIT-ORDER-ERRORinvalid status value
WORKFLOW-ERRORunknown or invalid workflow
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createRemoteOrder()
create_remote_order()
createOrder()

◆ createRemoteOrder() [3/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
remotethe name of the remote Qorus connection
namethe name of the workflow; the latest version of the workflow (determined by the latest created date for the workflow_instance entry) will be used
paramsThe 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
statuscreate the workflow order data instance with this status; may be either:
register_dependencyif 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-ERRORThe given connection is not known
SUBMIT-ORDER-ERRORinvalid status value
WORKFLOW-ERRORunknown or invalid workflow
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createRemoteOrder()
create_remote_order()
createOrder()

◆ createRemoteOrder() [4/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
remotethe name of the remote Qorus connection
namethe name of the workflow
versionthe 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
paramsThe 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-ERRORThe given connection is not known
SUBMIT-ORDER-ERRORinvalid status value
WORKFLOW-ERRORunknown or invalid workflow
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createRemoteOrder()
create_remote_order()
createOrder()

◆ createRemoteOrder() [5/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
remotethe name of the remote Qorus connection
namethe name of the workflow
versionthe 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
paramsThe 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
statuscreate the workflow order data instance with this status; may be either:
Returns
the workflow instance ID created
Exceptions
GET-REMOTE-ERRORThe given connection is not known
SUBMIT-ORDER-ERRORinvalid status value
WORKFLOW-ERRORunknown or invalid workflow
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createRemoteOrder()
create_remote_order()
createOrder()

◆ createRemoteOrder() [6/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
remotethe name of the remote Qorus connection
namethe name of the workflow
versionthe 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
paramsThe 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
statuscreate the workflow order data instance with this status; may be either:
register_dependencyif 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-ERRORThe given connection is not known
SUBMIT-ORDER-ERRORinvalid status value
WORKFLOW-ERRORunknown or invalid workflow
ORDER-DATA-ERRORmissing either external_order_instanceid or staticdata, invalid keys or sensitive data format
DUPLICATE-ORDER-KEYthe 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-ERRORinvalid 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
UserApi::createRemoteOrder()
create_remote_order()
createOrder()

◆ deserializeQorusData()

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

Parses a serialized data string and returns the corresponding data

Parameters
datathe string data to deserialize
Returns
the Qore data represented by the string argument
See also
UserApi::deserializeQorusData()
deserialize_qorus_data()
UserApi::deserializeQorusData()

◆ doUserConnectionIntern()

static Object com.qoretechnologies.qorus.UserApi.doUserConnectionIntern ( Object  obj)
inlinestaticprivate:internal

Returns a native Java object for Qore-based connections wherever possible

◆ execSynchronousWorkflow() [1/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
namethe workflow name; the latest version of the workflow will be used
sdatathe static data hash for the workflow order
Returns
a hash of workflow order information with the following keys:
See also
UserApi::execSynchronousWorkflow()
exec_synchronous_workflow()

◆ execSynchronousWorkflow() [2/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
namethe workflow name; the latest version of the workflow will be used
sdatathe static data hash for the workflow order
optsthe options for the synchronous workflow execution instance
Returns
a hash of workflow order information with the following keys:
See also
UserApi::execSynchronousWorkflow()
exec_synchronous_workflow()

◆ 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 
) throws Throwable
inlinestatic

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

Parameters
namethe workflow name; the latest version of the workflow will be used
sdatathe static data hash for the workflow order
optsthe options for the synchronous workflow execution instance
ddatathe optional initial dynamic data hash for the workflow order
Returns
a hash of workflow order information with the following keys:
See also
UserApi::execSynchronousWorkflow()
exec_synchronous_workflow()

◆ 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 
) throws Throwable
inlinestatic

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

Parameters
namethe workflow name; the latest version of the workflow will be used
sdatathe static data hash for the workflow order
optsthe options for the synchronous workflow execution instance
ddatathe optional initial dynamic data hash for the workflow order
prioritythe order priority for the order
Returns
a hash of workflow order information with the following keys:
See also
UserApi::execSynchronousWorkflow()
exec_synchronous_workflow()

◆ 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,
HashMap< String, Object orderkeys 
) throws Throwable
inlinestatic

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

Parameters
namethe workflow name; the latest version of the workflow will be used
sdatathe static data hash for the workflow order
optsthe options for the synchronous workflow execution instance
ddatathe optional initial dynamic data hash for the workflow order
prioritythe order priority for the order
orderkeysoptional order keys for the order
Returns
a hash of workflow order information with the following keys:
See also
UserApi::execSynchronousWorkflow()
exec_synchronous_workflow()

◆ 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,
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
namethe workflow name; the latest version of the workflow will be used
sdatathe static data hash for the workflow order
optsthe options for the synchronous workflow execution instance
ddatathe optional initial dynamic data hash for the workflow order
prioritythe order priority for the order
orderkeysoptional order keys for the order
external_order_instanceidthe optional external order instanceid for the order
Returns
a hash of workflow order information with the following keys:
See also
UserApi::execSynchronousWorkflow()
exec_synchronous_workflow()

◆ execSynchronousWorkflow() [7/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
namethe workflow name; the latest version of the workflow will be used
sdatathe static data hash for the workflow order
optsthe options for the synchronous workflow execution instance
ddatathe optional initial dynamic data hash for the workflow order
prioritythe order priority for the order
orderkeysoptional order keys for the order
external_order_instanceidthe optional external order instanceid for the order
parent_workflow_instanceidan 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:
See also
UserApi::execSynchronousWorkflow()
exec_synchronous_workflow()

◆ execSynchronousWorkflow() [8/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
namethe workflow name
versionthe workflow version (if null then the latest version of the workflow will be used)
sdatathe static data hash for the workflow order
optsthe options for the synchronous workflow execution instance
ddatathe optional initial dynamic data hash for the workflow order
prioritythe order priority for the order
orderkeysoptional order keys for the order
external_order_instanceidthe optional external order instanceid for the order
parent_workflow_instanceidan 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:
See also
UserApi::execSynchronousWorkflow()
exec_synchronous_workflow()

◆ executeFsm() [1/2]

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

Executes the given Finite State Machine and returns the final output.

Parameters
namethe name of the Finite State Machine to execute; must be a valid Finite State Machine for the current interface context
Returns
any final output provided by the Finite State Machine
Exceptions
FSM-NOT-FOUNDThe given Finite State Machine is not valid for the current interface context
Since
Qorus 5.0

◆ executeFsm() [2/2]

static Object com.qoretechnologies.qorus.UserApi.executeFsm ( String  name,
Object  arg 
) throws Throwable
inlinestatic

Executes the given Finite State Machine and returns the final output.

Parameters
namethe name of the Finite State Machine to execute; must be a valid Finite State Machine for the current interface context
argany optional input argument for the Finite State Machine
Returns
any final output provided by the Finite State Machine
Exceptions
FSM-NOT-FOUNDThe given Finite State Machine is not valid for the current interface context
Since
Qorus 5.0

◆ expandOneVariable() [1/2]

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
strtemplated string to be expanded; see Config Item / Building Block Template Substitution Strings for the format of this string
var_contextcontext of the variable to be expanded (e.g. local, static, dynamic, keys,...)
var_namename of the variable to be expanded
local_contextlocal 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-ERRORif WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERRORif an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERRORif 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

◆ expandOneVariable() [2/2]

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

Expands one variable in a templated string

Parameters
strtemplated string to be expanded; see Config Item / Building Block Template Substitution Strings for the format of this string
var_contextcontext of the variable to be expanded (e.g. local, static, dynamic, keys,...)
var_namename of the variable to be expanded
local_contextlocal context supplied by the caller (plus user context info is added - see UserApi.getUserContextInfo() method)
expand_complex_valuesif true then lists and hashes will have their string values expanded recursively
Returns
modified string with the specified template variable already expanded
Exceptions
NOT-WF-CONTEXT-ERRORif WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERRORif an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERRORif 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() [1/2]

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
strtemplated string to be expanded; see Config Item / Building Block Template Substitution Strings for the format of template variable references in this string
local_contextlocal 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-ERRORif WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERRORif an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERRORif the variable doesn't have a value in the specified context
FORMAT-ERRORif 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

◆ expandTemplatedValue() [2/2]

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

Expands all variables in a templated string

Parameters
strtemplated string to be expanded; see Config Item / Building Block Template Substitution Strings for the format of template variable references in this string
local_contextlocal context supplied by the caller (plus user context info is added - see UserApi.getUserContextInfo() method)
expand_complex_valuesif true then lists and hashes will have their string values expanded recursively
Returns
the value of the string as substituted with all variables expanded
Exceptions
NOT-WF-CONTEXT-ERRORif WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERRORif an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERRORif the variable doesn't have a value in the specified context
FORMAT-ERRORif 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
UserApi::flushSlaEvents()
flush_sla_events()

◆ 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_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
UserApi::getActiveJobs()
get_active_jobs()

◆ getBinaryFileFromLocation()

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

Returns binary data for the given file location

Parameters
locationthe location of the file data (ex: "resource://service-name:path/to/ressource"); see File Locations for more information about this parameter
Returns
the resource data as a binary value
Exceptions
LOCATION-ERRORthe location string cannotbe parsed; unknown location scheme; invalid location option
See also
UserApi::getBinaryFileFromLocation()
getTextFileFromLocation()
Since
Qorus 4.0.3

◆ getConfigItemHash() [1/2]

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

Returns a hash of all configuration items for the current context as a combination of local and global configuration items

Example:
Hash config = UserApi.getConfigItemHash();
Returns
a hash of all configuration items for the current context; keys are config item names; values are config item values. If there are no config items for the current context, an empty hash is returned.
Note
See also
getInterfaceConfigItemHash()
Since
Qorus 5.0

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.workflow.WorkflowApi, and com.qoretechnologies.qorus.job.JobApi.

◆ getConfigItemHash() [2/2]

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

Returns a hash of all configuration items for the current context as a combination of local and global configuration items

Example:
HashMap<String, Object> config = UserApi.getConfigItemHash(local_context);
Parameters
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
Returns
a hash of all configuration items for the current context; keys are config item names; values are config item values. If there are no config items for the current context, then an empty hash is returned.
Note
See also
getInterfaceConfigItemHash()
Since
Qorus 5.0

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.workflow.WorkflowApi, and com.qoretechnologies.qorus.job.JobApi.

◆ getConfigItemValue() [1/3]

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

Returns the value of the given configuration item

Example:
Object val = UserApi.getConfigItemValue(item);
Parameters
itemthe name of the configuration item; interface configuration item values take precedence over values on global level. If there is no value on the previous levels then the default value is returned.
Returns
the value of the given configuration item
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Note
See also
getInterfaceConfigItemValue()
Since
Qorus 5.0

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.workflow.WorkflowApi, and com.qoretechnologies.qorus.job.JobApi.

◆ getConfigItemValue() [2/3]

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

Returns the value of the given configuration item

Example:
Object val = UserApi.getConfigItemValue(item, local_context);
Parameters
itemthe name of the configuration item; interface configuration item values take precedence over values on global level. If there is no value on the previous levels then the default value is returned.
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
Returns
the value of the given configuration item
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Note
See also
getInterfaceConfigItemValue()
Since
Qorus 5.0

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.workflow.WorkflowApi, and com.qoretechnologies.qorus.job.JobApi.

◆ getConfigItemValue() [3/3]

static Object com.qoretechnologies.qorus.UserApi.getConfigItemValue ( String  item,
HashMap< String, Object local_context,
boolean  expand_complex_values 
) throws Throwable
inlinestatic

Returns the value of the given configuration item

Example:
Object val = User.getConfigItemValue(item, local_context);
Parameters
itemthe name of the configuration item; interface configuration item values take precedence over values on global level. If there is no value on the previous levels then the default value is returned.
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
expand_complex_valuesif true then lists and hashes will have their string values expanded recursively
Returns
the value of the given configuration item
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Note
See also
getInterfaceConfigItemValue()
Since
Qorus 5.0

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.workflow.WorkflowApi, and com.qoretechnologies.qorus.job.JobApi.

◆ getContextUserName()

static String com.qoretechnologies.qorus.UserApi.getContextUserName ( ) throws Throwable
inlinestatic

Returns the current username for any external user-initiated call or NOTHING if executing in a system context

Returns
the current username for any external user-initiated call or NOTHING if executing in a system context
Since
Qorus 4.1

◆ getDataProvider()

static AbstractDataProvider com.qoretechnologies.qorus.UserApi.getDataProvider ( String  path) throws Throwable
inlinestatic

Returns the data provider given by a path string

Example:
AbstractDataProvider d = UserApi.getDataProvider("connection/rest-billing-1/accounts/POST");
Parameters
paththe path to the dataprovider; the first element must be one of the following:
The second element should be the name of the connection, and further elements should be the path to the data provider.
Exceptions
DATA-PROVIDER-ERRORthe given data provider is unknown
See also
OMQ::UserApi::UserApi::getDataProvider() "UserApi::getDataProvider()"
Since
Qorus 4.1

◆ 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
namethe 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-ERRORunknown datasource
See also
UserApi::getDatasourceInfo()
get_datasource_info()

◆ getDatasourcePool() [1/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
namethe name of the datasource
Returns
a DatasourcePool object
Exceptions
DATASOURCE-ERRORunknown 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
UserApi::getDatasourcePool()
get_datasource_pool()

◆ getDatasourcePool() [2/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
namethe name of the datasource
register_dependencyif 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-ERRORunknown 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
UserApi::getDatasourcePool()
get_datasource_pool()

◆ getGlobalConfigItemValue() [1/3]

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
itemthe name of the configuration item to retrieve the value
Returns
the value of the given configuration item on global level
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Since
Qorus 4.0.3

◆ getGlobalConfigItemValue() [2/3]

static Object com.qoretechnologies.qorus.UserApi.getGlobalConfigItemValue ( String  item,
HashMap< String, Object local_context 
) 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
itemthe name of the configuration item to retrieve the value
local_contextlocal context supplied by the caller (plus user context info is added - see UserApi.getUserContextInfo() method)
Returns
the value of the given configuration item on global level
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Since
Qorus 4.1.1

◆ getGlobalConfigItemValue() [3/3]

static Object com.qoretechnologies.qorus.UserApi.getGlobalConfigItemValue ( String  item,
HashMap< String, Object local_context,
boolean  expand_complex_values 
) 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
itemthe name of the configuration item to retrieve the value
local_contextlocal context supplied by the caller (plus user context info is added - see UserApi.getUserContextInfo() method)
expand_complex_valuesif true then lists and hashes will have their string values expanded recursively
Returns
the value of the given configuration item on global level
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid
Since
Qorus 4.1.1

◆ getInputData() [1/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_contextthe 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_cfginput 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-ERRORif WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERRORif an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERRORif the variable doesn't have a value in the specified context
SENSITIVE-DATA-FORMAT-ERRORif 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

◆ getInputData() [2/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_namename of the field that should be returned; identifies a key in input_data_cfg
local_contextthe 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_cfginput 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-ERRORif WF specific context (e.g. static) variable is specified to be expanded
UNSUPPORTED-CONTEXT-ERRORif an unknown context variable is specified to be expanded
UNKNOWN-VALUE-ERRORif the variable doesn't have a value in the specified context
SENSITIVE-DATA-FORMAT-ERRORif the "$sensitive:<skey>.<svalue>.field-ref..." value or "$sensitive-alias:<alias>.field-ref..." template string does not have the required format
INVALID-ARGUMENTif the field_name is not present in input data
See also
Config Item / Building Block Template Substitution Strings for information on template variable expansion

◆ getInterfaceConfigItemHash() [1/2]

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

Returns a hash of all configuration items for the current interface context as a combination of local and global configuration items

Example:
Hash config = UserApi.getInterfaceConfigItemHash();
Returns
a hash of all configuration items for the current context; keys are config item names; values are config item values. If there are no config items for the current context, an empty hash is returned.
Note
See also
getConfigItemHash()
Since
Qorus 5.0

◆ getInterfaceConfigItemHash() [2/2]

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

Returns a hash of all configuration items for the current interface context as a combination of local and global configuration items

Example:
HashMap<String, Object> config = UserApi.getInterfaceConfigItemHash(local_context);
Parameters
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
Returns
a hash of all configuration items for the current context; keys are config item names; values are config item values. If there are no config items for the current context, then an empty hash is returned.
Note
See also
getConfigItemHash()
Since
Qorus 5.0

◆ getInterfaceConfigItemValue() [1/3]

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

Returns the value of the given configuration item from the current interface context

Example:
Object val = UserApi.getInterfaceConfigItemValue(item);
Parameters
itemname of the config item
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid in the current context
Returns
value for the given config item in the current CONTEXT
Note
See also
getConfigItemValue()
Since
  • Qorus 5.0

◆ getInterfaceConfigItemValue() [2/3]

static Object com.qoretechnologies.qorus.UserApi.getInterfaceConfigItemValue ( String  item,
HashMap< String, Object local_context 
) throws Throwable
inlinestatic

Returns the value of the given configuration item from the current interface context

Example:
Object val = UserApi.getInterfaceConfigItemValue(item);
Parameters
itemname of the config item
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid in the current context
Returns
value for the given config item in the current CONTEXT
Note
See also
getConfigItemValue()
Since
  • Qorus 5.0

◆ getInterfaceConfigItemValue() [3/3]

static Object com.qoretechnologies.qorus.UserApi.getInterfaceConfigItemValue ( String  item,
HashMap< String, Object local_context,
boolean  expand_complex_values 
) throws Throwable
inlinestatic

Returns the value of the given configuration item from the current interface context

Example:
Object val = UserApi.getInterfaceConfigItemValue(item);
Parameters
itemname of the config item
local_contextthe caller can supply its "local" context for template variables (plus user context info is added - see UserApi.getUserContextInfo() method)
expand_complex_valuesif True then lists and hashes will have their string values expanded recursively
Exceptions
CONFIG-ITEM-ERRORthrown if the configuration item is not valid in the current context
Returns
value for the given config item in the current CONTEXT
Note
See also
getConfigItemValue()
Since
  • Qorus 5.0

◆ getMapper() [1/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
namethe name of the mapper
Exceptions
MAPPER-ERRORthe given mapper is unknown or not registered to the current interface
See also
UserApi::getMapper()
get_mapper()
Qorus Mappers
Implementing Mappers

◆ getMapper() [2/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
namethe name of the mapper
rtoptsany runtime options accepted by the mapper
Exceptions
MAPPER-ERRORthe given mapper is unknown or not registered to the current interface
See also
UserApi::getMapper()
get_mapper()
Qorus Mappers
Implementing Mappers

◆ 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
dsthe datasource to retrieve the sequence from
namethe 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
dsthe datasource name to retrieve the sequence from; a pool corresponding to the datasource will be used to retrieve the sequence
namethe name of the sequence
Returns
the next value of the sequence
See also
UserApi::getNextSequenceValue()

◆ getObjectCacheSize()

static int com.qoretechnologies.qorus.UserApi.getObjectCacheSize ( ) throws Throwable
inlinestatic

Returns the number of objects in the cache

Returns
the number of objects in the cache
Exceptions
NO-INTERFACEthrown if there is no interface context; this API is only valid when called in a workflow, service, or job context
Since
Qorus 4.1

◆ getOption() [1/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()

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.workflow.WorkflowApi, and com.qoretechnologies.qorus.job.JobApi.

◆ 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()

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.workflow.WorkflowApi, and com.qoretechnologies.qorus.job.JobApi.

◆ getOption() [3/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()

Reimplemented in com.qoretechnologies.qorus.workflow.WorkflowApi, com.qoretechnologies.qorus.service.ServiceApi, and com.qoretechnologies.qorus.job.JobApi.

◆ getQorusOptionInfo()

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

Returns a hash giving information about system options

See also
UserApi::getQorusOptionInfo()
get_qorus_option_info()

◆ 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
UserApi::getQorusOptionInfoArgs()
get_qorus_option_info()

◆ getQorusOptions() [1/3]

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

Returns the value of all system options

See also
UserApi::getQorusOptions()
get_qorus_options()

◆ 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
UserApi::getQorusOptions()
get_qorus_options()

◆ 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
UserApi::getQorusOptions()
get_qorus_options()

◆ 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
UserApi::getQorusOptionsArgs()
get_qorus_options_args()

◆ getQorusType()

static AbstractDataProviderType com.qoretechnologies.qorus.UserApi.getQorusType ( String  type_path) throws Throwable
inlinestatic

Returns a data provider type from a direct type path

Parameters
type_paththe direct path to the type as would be used with DataProvider::getTypeEx()
Returns
the data provider type corresponding to the type
Exceptions
DATA-TYPE-ERRORthe given type is unknown
See also
getTypeFromPath()
Since
Qorus 4.1.2

◆ getRemoteRestConnection() [1/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
namethe name of the remote connection
Returns
a new QorusSystemRestHelper object
Exceptions
GET-REMOTE-ERRORThe 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
namethe name of the remote connection
connectif false an unconnected object will be returned, otherwise the object is already connected
Returns
a new QorusSystemRestHelper object
Exceptions
GET-REMOTE-ERRORThe 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,
boolean  connect,
boolean  register_dependency 
) throws Throwable
inlinestatic

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

Parameters
namethe name of the remote connection
connectif false an unconnected object will be returned, otherwise the object is already connected
register_dependencyif 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-ERRORThe 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
idworkflow 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
UserApi::getRunningWorkflowInfo()
get_running_workflow_info()
get_running_workflow_list()

◆ getRunningWorkflowList() [1/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
UserApi::getRunningWorkflowList()
get_running_workflow_list()

◆ 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
nameworkflow 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
UserApi::getRunningWorkflowList()
get_running_workflow_list()

◆ getRunningWorkflowList() [3/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
nameworkflow name for filtering the result list
verworkflow 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
UserApi::getRunningWorkflowList()
get_running_workflow_list()

◆ 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
typethe type of service (either "system" or "user"; case is ignored)
namethe 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
UserApi::getServiceInfo()
get_service_info()

◆ 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
UserApi::getSessionId()
get_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
UserApi::getSqlCacheInfo()
Qorus SQL Object Cache
get_sql_cache_info()

◆ getSqlTable() [1/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
datasourcea 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_namethe 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-DATASOURCEthis 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
UserApi::getSqlTable()
get_sql_table()
Qorus SQL Object Cache

◆ getSqlTable() [2/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
datasourcea Qorus datasource name
table_namethe 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-DATASOURCEthis 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
UserApi::getSqlTable()
get_sql_table()
Qorus SQL Object Cache

◆ 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
UserApi::getSystemInfo()
get_system_info()

◆ 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
namethe 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
UserApi::getSystemServiceInfo()
get_system_service_info()

◆ getTextFileFromLocation()

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

Returns string data for the given file location

Parameters
locationthe location of the file data (ex: "resource://service-name:path/to/ressource"); see File Locations for more information about this parameter
Returns
the resource data as a string
Exceptions
LOCATION-ERRORthe location string cannotbe parsed; unknown location scheme; invalid location option
See also
UserApi::getTextFileFromLocation()
getBinaryFileFromLocation()
Since
Qorus 4.0.3

◆ getTypeFromPath()

static AbstractDataProviderType com.qoretechnologies.qorus.UserApi.getTypeFromPath ( String  path) throws Throwable
inlinestatic

Returns a data provider type identified by a path string

Example:
AbstractDataProviderType type = UserApi.getTypeFromPath("type/qore/ftp/event");
Parameters
paththe path to the type; the first element must be one of the following:
  • type: indicates that the rest of the path identifies a registered data provider type
  • connection: indicates that the following path element identifies a user connection
  • datasource: indicates that the following path element identifies a datasource
  • remote: indicates that the following path element identifies a Qorus remote connection

For type paths in data providers (i.e. connection, datasource, and remote), the path element after the provider must be one of the following:
  • request: for the request type
  • response: for the response type
  • error: for the error response type, in which case the next path element provides the error code
  • record: for the record type
Exceptions
DATA-TYPE-ERRORthe given type is unknown
See also
getQorusType()
Since
Qorus 4.1.1

◆ getUserConnection() [1/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
namethe name of the connection
Returns
the object representing the connection
Exceptions
CONNECTION-ERRORThe given connection is not known
Since
Qorus 4.1.1 returns a native Java object for Qore-based connections when possible
See also
UserApi::getUserConnection()
get_user_connection()

◆ getUserConnection() [2/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
namethe name of the connection
connectif false an unconnected object will be returned, otherwise the object is already connected
Returns
the object representing the connection
Exceptions
CONNECTION-ERRORThe given connection is not known
Since
Qorus 4.1.1 returns a native Java object for Qore-based connections when possible
See also
UserApi::getUserConnection()
get_user_connection()

◆ getUserConnection() [3/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
namethe name of the connection
connectif false an unconnected object will be returned, otherwise the object is already connected
register_dependencyif 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-ERRORThe given connection is not known
Since
Qorus 4.1.1 returns a native Java object for Qore-based connections when possible
See also
UserApi::getUserConnection()
get_user_connection()

◆ getUserConnection() [4/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
namethe name of the connection
connectif false an unconnected object will be returned, otherwise the object is already connected
register_dependencyif true (the default) then if the connection is monitored as down, the calling interface will be temporarily disabled until the connection is up again
rtoptsany runtime options accepted by the connection
Returns
the object representing the connection
Exceptions
CONNECTION-ERRORThe given connection is not known
Since
Qorus 4.1.1 returns a native Java object for Qore-based connections when possible
See also
UserApi::getUserConnection()
get_user_connection()

◆ getUserConnectionTags()

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

Returns any tags set on the given user connection

Parameters
namethe name of the connection
Returns
any tags set on the given user connection
Exceptions
CONNECTION-ERRORThe given connection is not known
See also
getUserConnection()
UserApi::getUserConnectionTags()
Since
Qorus 4.0.3

◆ 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
    • "context_user": the current username context, if any
  • 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
    • "context_user": the current username context, if any
  • 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)
    • "context_user": the current username context, if any
See also
UserApi::getUserContextInfo()
get_user_context_info()
Since
Qorus 4.1 added the context_user key

◆ 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
mapnamename of the value map
keya key name
Returns
the value assigned to the key
Exceptions
VALUE-MAP-ERRORthe given value map is unknown or not registered to the current interface
See also
UserApi::getValueMap()
Qorus Value Maps
Implementing Value Maps
get_value_map()

◆ 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
UserApi::getValueMaps()
Qorus Value Maps
Implementing Value Maps
get_value_map()

◆ 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
msgthe 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
msgthe message to log
argsarguments 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
msgthe 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
msgthe message to log
argsarguments 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
msgthe 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
msgthe message to log
argsarguments 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
msgthe 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
msgthe message to log
argsarguments 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
msgthe 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
msgthe message to log
argsarguments 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
msgthe 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
msgthe message to log
argsarguments 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
slathe SLA name
valuethe SLA performance value
errthe error code for the SLA event error
descthe 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
UserApi::postSlaEventError()
post_sla_event_error()

◆ 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
slathe SLA name
valuethe SLA performance value
Returns
true if the event was posted, false if not (because the SLA does not exist)
See also
UserApi::postSlaEventSuccess()
post_sla_event_success()

◆ 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
eventtypethe event type name
eventkeythe 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-EVENTunknown event type name
See also
UserApi::postSyncEvent()
post_sync_event()
Workflow Synchronization Event Steps
PUT /api/latest/sync-events/{type}/{key}?action=post

◆ 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
severitysee Error Severity Codes for possible values
infothe user-defined information for the event
Exceptions
POST-USER-EVENT-ERRORinvalid severity value
See also
UserApi::postUserEvent()
post_user_event()

◆ 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
UserApi::propGet()
prop_get()
propUpdate()

◆ 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
UserApi::propGet()
prop_get()
propUpdate()

◆ 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
UserApi::propGet()
prop_get()
propUpdate()

◆ 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
domainthe domain of the property to set
keythe key to set
valuethe 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-ERRORif the domain or key arguments are empty strings
PROP-ERRORserialized value exceeds 240 characters (column limit)
UPDATE-ERRORchanges attempted in the "omq" domain
See also
UserApi::propUpdate()
prop_update()
propGet()

◆ qorusGetLocalUrl() [1/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
UserApi::qorusGetLocalUrl()
qorus_get_local_url()

◆ qorusGetLocalUrl() [2/2]

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

Returns a string giving the local system URL

Parameters
usernamethe username for the new connection
passwordthe password for the new connection
Returns
a string giving the local system URL
See also
UserApi::qorusGetLocalUrl()
qorus_get_local_url()

◆ raiseTransientAlert() [1/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
alertthe name of the alert (ex: "DATA-SIZE-EXCEEDED")
reasonthe reason or verbose description of the alert
See also
UserApi::raiseTransientAlert()
raise_transient_alert()

◆ raiseTransientAlert() [2/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
alertthe name of the alert (ex: "DATA-SIZE-EXCEEDED")
reasonthe reason or verbose description of the alert
infooptional key / value details for the alert
See also
UserApi::raiseTransientAlert()
raise_transient_alert()

◆ registerFsmAsObserver()

static void com.qoretechnologies.qorus.UserApi.registerFsmAsObserver ( String  fsm_name,
Observable  observable,
String  event_id 
) throws Throwable
inlinestatic

Registers the given FSM with the given object as an Observer.

Parameters
fsm_namethe name of the Finite State Machine to register with observable
observablethe event source object
event_idthe event ID to register with observable
Exceptions
FSM-NOT-FOUNDThe given Finite State Machine is not valid for the current interface context
Since
Qorus 5.0

◆ 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
driverthe 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
exthe 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-DRIVERonly "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
UserApi::runtimeProperties()
runtime_properties()

◆ saveObjectInObjectCache()

static void com.qoretechnologies.qorus.UserApi.saveObjectInObjectCache ( QoreObject  obj) throws Throwable
inlinestatic

Saves the object in the object cache

Exceptions
NO-INTERFACEthrown if there is no interface context; this API is only valid when called in a workflow, service, or job context
Since
Qorus 4.1

◆ 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
dthe 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
UserApi::serializeQorusData()
serialize_qorus_data()
UserApi::serializeQorusData()

◆ 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
dthe data to serialize
Returns
a YAML string representing the given data structure for storage in Qorus
See also
serialize_qorus_data()
deserializeQorusData()

◆ 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
hasha hash of option-value pairs
Exceptions
WORKFLOW-OPTION-ERRORinvalid option name
See also
UserApi::setOption()

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.job.JobApi, and com.qoretechnologies.qorus.workflow.WorkflowApi.

◆ 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
optionthe option to set
valuethe value to set for the option
Exceptions
WORKFLOW-OPTION-ERRORinvalid option name
See also
UserApi::setOption()

Reimplemented in com.qoretechnologies.qorus.service.ServiceApi, com.qoretechnologies.qorus.workflow.WorkflowApi, and com.qoretechnologies.qorus.job.JobApi.

◆ startCapturingObjects()

static void com.qoretechnologies.qorus.UserApi.startCapturingObjects ( ) throws Throwable
inlinestatic

Starts capturing Qore objects created from Java APIs in the current interface's object cache

Exceptions
NO-INTERFACEthrown if there is no interface context; this API is only valid when called in a workflow, service, or job context
Since
Qorus 4.1
See also
Managing the Lifecycle of Qore objects from Java

◆ stopCapturingObjects()

static void com.qoretechnologies.qorus.UserApi.stopCapturingObjects ( ) throws Throwable
inlinestatic

Stops capturing Qore objects created from Java APIs in the current interface's object cache

Exceptions
NO-INTERFACEthrown if there is no interface context; this API is only valid when called in a workflow, service, or job context
Since
Qorus 4.1
See also
Managing the Lifecycle of Qore objects from Java

◆ unblockOrder() [1/3]

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

Unblocks the given workflow order data instance

Parameters
wfiidthe workflow order instance ID to unblock
Returns
a hash with the following key:
  • workflow_status: the status of the workflow order
Exceptions
BLOCK-WORKFLOW-ERRORinvalid status, foreign session id, missing original status, uncancel operation already in progress
See also
UserApi::unblockOrder()
unblock_order()

◆ 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
wfiidthe workflow order instance ID to unblock
tempdataoptional 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-ERRORinvalid status, foreign session id, missing original status, uncancel operation already in progress
See also
UserApi::unblockOrder()
unblock_order()

◆ unblockOrder() [3/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
wfiidthe workflow order instance ID to unblock
tempdataoptional 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)
orderkeysoptional 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-ERRORinvalid status, foreign session id, missing original status, uncancel operation already in progress
See also
UserApi::unblockOrder()
unblock_order()

◆ uncancelOrder() [1/2]

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

Uncancels the given workflow order data instance

Parameters
wfiidthe workflow order instance ID to uncancel
Returns
a hash with the following key:
  • workflow_status: the status of the workflow order
Exceptions
CANCEL-WORKFLOW-ERRORinvalid status, foreign session id, missing original status, uncancel operation already in progress
See also
UserApi::uncancelOrder()
uncancel_order()

◆ uncancelOrder() [2/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
wfiidthe workflow order instance ID to uncancel
tempdatatemporary 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-ERRORinvalid status, foreign session id, missing original status, uncancel operation already in progress
See also
UserApi::uncancelOrder()
uncancel_order()

◆ updateOutputData() [1/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_dataa 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_cfga 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-ERRORif output data configuration specifies an unsupported context
OUTPUT-CONFIG-ERRORfield_name is not present in output_data_cfg
SENSITIVE-DATA-FORMAT-ERRORif the "$sensitive:<skey>.<svalue>.field-ref..." value or "$sensitive-alias:<alias>.field-ref..." template string does not have the required format
See also
UserApi.updateOutputData()
Config Item / Building Block Template Substitution Strings
Since
Qorus 4.0.3

◆ updateOutputData() [2/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_namename of the field that should be updated; identifies a key in output_data_cfg that provides the location for writing the output data
output_datathe value to write in the location determined by the field_name key in output_data_cfg
output_data_cfga 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-ERRORif output data configuration specifies an unsupported context
OUTPUT-CONFIG-ERRORfield_name is not present in output_data_cfg
SENSITIVE-DATA-FORMAT-ERRORif the "$sensitive:<skey>.<svalue>.field-ref..." value or "$sensitive-alias:<alias>.field-ref..." template string does not have the required format
SET-ORDER-KEYS-ERRORmissing value for order key
INVALID-WORKFLOW-KEYworkflow key not valid for the current workflow
DUPLICATE-KEY-VALUEduplicate value provided for order key
See also
UserApi.updateOutputData()
Config Item / Building Block Template Substitution Strings
Since
Qorus 4.0.3

The documentation for this class was generated from the following file:
org
com.qoretechnologies.qorus.UserApi.callNetworkApi
static Object callNetworkApi(String call, Object... args)
Definition: UserApi.java:168
type
string type(auto arg)
com.qoretechnologies.qorus.UserApi.propGet
static HashMap< String, Object > propGet()
Definition: UserApi.java:3103
org::qore::jni::QoreObjectWrapper::release
void release()
org::qore::lang::AbstractDatasource::commit
void commit()
Object
const Object
org::qore::lang::sqlutil
org::qore::lang
hash
hash< auto > hash(object obj)
org::qore::lang::sqlutil::AbstractTable
Mapper
com.qoretechnologies.qorus.UserApi.callRestApiWithAuthentication
static Object callRestApiWithAuthentication(String user, String pass, String method, String path, HashMap< String, Object > body_args)
Definition: UserApi.java:284
Hash
const Hash
int
int int(string str, int base=10)
org::qore::lang::DatasourcePool