Qorus Integration Engine®  4.1.4.p2_git
com.qoretechnologies.qorus.workflow.WorkflowApi Class Reference
Inheritance diagram for com.qoretechnologies.qorus.workflow.WorkflowApi:
com.qoretechnologies.qorus.UserApi com.qoretechnologies.qorus.OMQ com.qoretechnologies.qorus.workflow.QorusStepBase com.qoretechnologies.qorus.workflow.QorusWorkflow com.qoretechnologies.qorus.workflow.QorusAsyncStepBase com.qoretechnologies.qorus.workflow.QorusEventStepBase com.qoretechnologies.qorus.workflow.QorusNormalArrayStep com.qoretechnologies.qorus.workflow.QorusNormalStep com.qoretechnologies.qorus.workflow.QorusSubworkflowStepBase com.qoretechnologies.qorus.workflow.QorusAsyncArrayStep com.qoretechnologies.qorus.workflow.QorusAsyncStep com.qoretechnologies.qorus.workflow.QorusEventArrayStep com.qoretechnologies.qorus.workflow.QorusEventStep com.qoretechnologies.qorus.workflow.QorusSubworkflowArrayStep com.qoretechnologies.qorus.workflow.QorusSubworkflowStep

Static Public Member Methods

static String generateUniqueKey () throws Throwable
 
static void stepError (String err, Object info, int retry_delay_secs) throws Throwable
 
static void stepError (String err, int retry_delay_secs) throws Throwable
 
static void stepError (String err, Object info) throws Throwable
 
static void stepError (String err) throws Throwable
 
static void stepWarning (String err, Object info) throws Throwable
 
static void stepWarning (String err) throws Throwable
 
static void setRetryDelay (int secs) throws Throwable
 
static void updateDynamicData (HashMap< String, Object > hash) throws Throwable
 
static void deleteDynamicDataKey (String... keys) throws Throwable
 
static void deleteDynamicDataKey (String key) throws Throwable
 
static Object getDynamicData (String key) throws Throwable
 
static HashMap< String, ObjectgetDynamicData (String... keys) throws Throwable
 
static HashMap< String, ObjectgetDynamicData () throws Throwable
 
static Object getStaticData (String key) throws Throwable
 
static HashMap< String, ObjectgetStaticData (String... keys) throws Throwable
 
static HashMap< String, ObjectgetStaticData () throws Throwable
 
static void updateTempData (HashMap< String, Object > hash) throws Throwable
 
static Object getTempData (String key) throws Throwable
 
static HashMap< String, ObjectgetTempData (String... keys) throws Throwable
 
static HashMap< String, ObjectgetTempData () throws Throwable
 
static void deleteTempDataKey (String... keys) throws Throwable
 
static void updateSensitiveData (String skey, String svalue, HashMap< String, Object > hash, String[] aliases, HashMap< String, Object > meta) throws Throwable
 
static void updateSensitiveData (String skey, String svalue, HashMap< String, Object > hash, String[] aliases) throws Throwable
 
static void updateSensitiveData (String skey, String svalue, HashMap< String, Object > hash) throws Throwable
 
static void updateSensitiveDataFromAlias (String alias, HashMap< String, Object > hash, HashMap< String, Object > meta) throws Throwable
 
static void updateSensitiveDataFromAlias (String alias, HashMap< String, Object > hash) throws Throwable
 
static HashMap< String, ObjectgetSensitiveMetadata (String skey, String svalue) throws Throwable
 
static HashMap< String, ObjectgetSensitiveMetadataFromAlias (String alias) throws Throwable
 
static HashMap< String, ObjectgetSensitiveData (String skey, String svalue, String... keys) throws Throwable
 
static Object getSensitiveData (String skey, String svalue, String key) throws Throwable
 
static HashMap< String, ObjectgetSensitiveData (String skey, String svalue) throws Throwable
 
static HashMap< String, ObjectgetSensitiveDataFromAlias (String alias, String... keys) throws Throwable
 
static HashMap< String, ObjectgetSensitiveDataFromAlias (String alias, String key) throws Throwable
 
static HashMap< String, ObjectgetSensitiveDataFromAlias (String alias) throws Throwable
 
static HashMap< String, ObjectgetSensitiveDataAliases () throws Throwable
 
static boolean deleteSensitiveData (String skey, String svalue) throws Throwable
 
static boolean deleteSensitiveDataKey (String skey, String svalue, String... keys) throws Throwable
 
static HashMap< String, ObjectgetSensitiveDataKeyValues () throws Throwable
 
static void deleteInstanceDataKey (String... keys) throws Throwable
 
static void updateInstanceData (HashMap< String, Object > hash) throws Throwable
 
static HashMap< String, ObjectgetInstanceData () throws Throwable
 
static Object getInstanceData (String key) throws Throwable
 
static HashMap< String, ObjectgetInstanceData (String... args) throws Throwable
 
static boolean stepExecuted (String stepname) throws Throwable
 
static String getStepStatus (String stepname) throws Throwable
 
static HashMap< String, ObjectgetStepInfo () throws Throwable
 
static HashMap< String, ObjectgetWorkflowInstanceData () throws Throwable
 
static Object getWorkflowInstanceData (String key) throws Throwable
 
static HashMap< String, ObjectgetWorkflowInstanceData (String... args) throws Throwable
 
static void setOrderKeys (HashMap< String, Object > h, boolean truncate) throws Throwable
 
static void setOrderKeys (HashMap< String, Object > h) throws Throwable
 
static void setOrderKey (String key, String value, boolean truncate) throws Throwable
 
static void setOrderKey (String key, String value) throws Throwable
 
static void setOrderKey (String key, String[] values, boolean truncate) throws Throwable
 
static void setOrderKey (String key, Object... values) throws Throwable
 
static void appendOrderKeys (HashMap< String, Object > h, boolean truncate) throws Throwable
 
static void appendOrderKeys (HashMap< String, Object > h) throws Throwable
 
static void appendOrderKeys (String key, String value, boolean truncate) throws Throwable
 
static void appendOrderKeys (String key, Object... values) throws Throwable
 
static Object getOrderKeys (String key) throws Throwable
 
static HashMap< String, ObjectgetOrderKeys (String... keys) throws Throwable
 
static HashMap< String, ObjectgetOrderKeys () throws Throwable
 
static HashMap< String, ObjectgetWorkflowMetadata () throws Throwable
 
static void setBlocked () throws Throwable
 
static HashMap< String, Object > [] getOrderNotes (int count) throws Throwable
 
static HashMap< String, Object > [] getOrderNotes () throws Throwable
 
static void addOrderNote (String notestr) throws Throwable
 
static void setCustomStatus (String stat) throws Throwable
 
static void rescheduleOrder (ZonedDateTime scheduled) throws Throwable
 
static void reprioritizeOrder (int prio) throws Throwable
 
static void leaveParentFeedback (String key, Object value) throws Throwable
 
static Object getChildFeedback (String key) throws Throwable
 
static HashMap< String, ObjectgetChildFeedback () throws Throwable
 
static Integer parentWfiid () throws Throwable
 
static HashMap< String, ObjectgetOption (String... keys) throws Throwable
 
static Object getOption (String key) throws Throwable
 
static HashMap< String, ObjectgetOption () throws Throwable
 
static void setOption (HashMap< String, Object > hash) throws Throwable
 
static void setOption (String option, Object value) throws Throwable
 
static Integer getWfiid () throws Throwable
 
static int sleep (int arg) throws Throwable
 
static int usleep (int arg) throws Throwable
 
static int usleep (QoreRelativeTime arg) 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 HashMap< String, ObjectgetConfigItemHash (HashMap< String, Object > local_context) throws Throwable
 
static HashMap< String, ObjectgetConfigItemHash () throws Throwable
 
- Static Public Member Methods inherited from com.qoretechnologies.qorus.UserApi
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 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
 

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_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_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_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 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_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

The main Qorus Java workflow API class

Member Function Documentation

◆ addOrderNote()

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

Add new note as described in Order Instance Notes

Parameters
notestra string with note
See also
WorkflowApi::addOrderNote()
wf_add_order_note()

◆ appendOrderKeys() [1/4]

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

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

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

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

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

◆ appendOrderKeys() [2/4]

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

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

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

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

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

◆ appendOrderKeys() [3/4]

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

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

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

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

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

◆ appendOrderKeys() [4/4]

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

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

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

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

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

◆ deleteDynamicDataKey() [1/2]

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

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

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

Changes are committed to the database before the method returns.

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

◆ deleteDynamicDataKey() [2/2]

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

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

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

Changes are committed to the database before the method returns.

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

◆ deleteInstanceDataKey()

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

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

Parameters
keysa single key or a list of strings (keys) to delete in workflow execution instance data
See also
WorkflowApi::deleteInstanceDataKey()
wf_delete_instance_data_key()
Workflow Execution Instance Data

◆ deleteSensitiveData()

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

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

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

◆ deleteSensitiveDataKey()

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

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

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

Changes are committed to the database before the method returns.

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

◆ deleteTempDataKey()

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

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

Parameters
keysa list of strings (keys) to delete in workflow temporary data
See also
WorkflowApi::deleteTempDataKey()
wf_delete_temp_data_key()
Workflow Temporary Data
TempDataHelper

◆ generateUniqueKey()

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

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

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

See also
WorkflowApi::generateUniqueKey()
wf_generate_unique_key()

◆ getChildFeedback() [1/2]

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

Gets feedback from a child workflow order with the given key

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

Parameters
keythe feedback key name used by the child workflow
Returns
the value of the feedback saved by the child workflow order with leaveParentFeedback() under the given key
See also
WorkflowApi::getChildFeedback()
wf_get_child_feedback()
Subworkflow Step
leaveParentFeedback()

◆ getChildFeedback() [2/2]

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

Gets all feedback from all child workflow orders as a hash

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

Returns
a hash representing all feedback values saved by child workflow orders with leaveParentFeedback()
See also
WorkflowApi::getChildFeedback()
wf_get_child_feedback()
Subworkflow Step
leaveParentFeedback()

◆ getConfigItemHash() [1/2]

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

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

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

◆ getConfigItemHash() [2/2]

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

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

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

◆ getConfigItemValue() [1/3]

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

Returns the value of the given step configuration item

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

◆ getConfigItemValue() [2/3]

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

Returns the value of the given step configuration item

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

◆ getConfigItemValue() [3/3]

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

Returns the value of the given step configuration item

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

◆ getDynamicData() [1/3]

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

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

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

See also
Workflow Order Dynamic Data
Parameters
keythe dynamic data key value to return
Returns
the value of the dynamic data key given
See also
WorkflowApi::getDynamicData()
wf_get_dynamic_data()
DynamicDataHelper

◆ getDynamicData() [2/3]

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

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

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

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

◆ getDynamicData() [3/3]

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

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

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

See also
Workflow Order Dynamic Data
Returns
the entire dynamic data hash for the order
See also
WorkflowApi::getDynamicData()
wf_get_dynamic_data()
DynamicDataHelper

◆ getInstanceData() [1/3]

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

Retrieves the workflow execution instance’s instance data hash

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

Returns
a hash of workflow execution instance data
See also
WorkflowApi::getInstanceData()
Workflow Execution Instance Data
Note
not to be confused with wf_get_workflow_instance_data(), which returns system properties of the workflow execution instance

◆ getInstanceData() [2/3]

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

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

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

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

◆ getInstanceData() [3/3]

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

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

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

Returns
a hash of workflow execution instance data corresponding to the arguments
See also
WorkflowApi::getInstanceData()
Workflow Execution Instance Data
Note
not to be confused with wf_get_workflow_instance_data(), which returns system properties of the workflow execution instance

◆ getOption() [1/3]

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

Returns the value of the named workflow options

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

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

◆ getOption() [2/3]

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

Returns the value of the named workflow option

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

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

◆ getOption() [3/3]

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

Returns the value of all workflow options

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

◆ getOrderKeys() [1/3]

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

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

Parameters
keythe order key to return
Returns
the value of the given key is returned
See also
WorkflowApi::getOrderKeys()
wf_get_order_keys()
appendOrderKeys()
setOrderKeys()

◆ getOrderKeys() [2/3]

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

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

Parameters
keysa list of String key values
Returns
a hash is returned giving the values of all the keys requested
See also
WorkflowApi::getOrderKeys()
wf_get_order_keys()
appendOrderKeys()
setOrderKeys()

◆ getOrderKeys() [3/3]

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

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

Returns
a hash is returned giving the values of all the keys requested
See also
WorkflowApi::getOrderKeys()
wf_get_order_keys()
appendOrderKeys()
setOrderKeys()

◆ getOrderNotes() [1/2]

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

Get Order Instance Notes

Parameters
countan optional integer to limit the list size
Returns
list of hashes of Order Instance Notes
See also
WorkflowApi::getOrderNotes()
wf_get_order_notes()

◆ getOrderNotes() [2/2]

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

◆ getSensitiveData() [1/3]

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

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

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

◆ getSensitiveData() [2/3]

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

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

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

◆ getSensitiveData() [3/3]

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

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

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

◆ getSensitiveDataAliases()

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

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

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

◆ getSensitiveDataFromAlias() [1/3]

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

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

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

◆ getSensitiveDataFromAlias() [2/3]

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

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

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

◆ getSensitiveDataFromAlias() [3/3]

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

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

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

◆ getSensitiveDataKeyValues()

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

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

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

◆ getSensitiveMetadata()

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

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

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

◆ getSensitiveMetadataFromAlias()

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

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

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

◆ getStaticData() [1/3]

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

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

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

Parameters
keythe static data key value to return
Returns
the value of the requested key is returned
See also
WorkflowApi::getStaticData()
wf_get_static_data()
Workflow Order Static Data

◆ getStaticData() [2/3]

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

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

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

Parameters
keysthe static data key values to return
Returns
a hash is returned giving the values of all the keys requested
See also
WorkflowApi::getStaticData()
wf_get_static_data()
Workflow Order Static Data

◆ getStaticData() [3/3]

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

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

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

Returns
the entire static data hash for the order
See also
WorkflowApi::getStaticData()
wf_get_static_data()
Workflow Order Static Data

◆ getStepInfo()

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

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

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

◆ getStepStatus()

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

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

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

Returns
the current status of the given step for the current workflow order instance
See also
WorkflowApi::getStepStatus()
wf_get_step_status()

◆ getTempData() [1/3]

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

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

See also
Workflow Temporary Data
Returns
the value of the requested key is returned
See also
WorkflowApi::getTempData()
wf_get_temp_data()
TempDataHelper

◆ getTempData() [2/3]

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

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

See also
Workflow Temporary Data
Parameters
keysthe keys in the worklfow order data instance's temporary data hash
Returns
a hash is returned giving the values of all the keys requested
See also
WorkflowApi::getTempData()
wf_get_temp_data()
TempDataHelper

◆ getTempData() [3/3]

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

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

See also
Workflow Temporary Data
Returns
the entire workflow order data instance’s temporary data hash
See also
WorkflowApi::getTempData()
wf_get_temp_data()
TempDataHelper

◆ getWfiid()

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

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

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

◆ getWorkflowInstanceData() [1/3]

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

Retrieves all available values from the workflow execution instance object itself

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

◆ getWorkflowInstanceData() [2/3]

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

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

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

◆ getWorkflowInstanceData() [3/3]

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

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

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

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

◆ getWorkflowMetadata()

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

Returns workflow metadata for the currently running workflow as a hash

Returns
a hash of workflow metadata; see Workflow Metadata for the hash description
See also
WorkflowApi::getWorkflowMetadata()
wf_get_workflow_metadata()

◆ leaveParentFeedback()

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

Leaves feedback for a parent workflow

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

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

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

See also
WorkflowApi::leaveParentFeedback()
wf_leave_parent_feedback()
Subworkflow Step
getChildFeedback()
Note
the use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible

◆ parentWfiid()

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

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

Returns
the parent workflow order data instance ID of a subworkflow or null if the current workflow order is not a subworkflow
See also
WorkflowApi::parentWfiid()
wf_parent_wfiid()
getWorkflowInstanceData()
getWfiid()

◆ reprioritizeOrder()

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

Changes the order priority for the current workflow order instance

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

◆ rescheduleOrder()

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

Reschedules the current workflow order instance for later processing

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

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

◆ setBlocked()

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

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

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

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

◆ setCustomStatus()

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

Sets a user-defined custom status for the current step

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

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

◆ setOption() [1/2]

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

Changes option values on a workflow

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

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

◆ setOption() [2/2]

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

Changes a single option value on a workflow

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

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

◆ setOrderKey() [1/4]

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

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

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

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

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

◆ setOrderKey() [2/4]

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

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

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

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

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

◆ setOrderKey() [3/4]

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

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

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

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

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

◆ setOrderKey() [4/4]

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

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

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

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

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

◆ setOrderKeys() [1/2]

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

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

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

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

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

◆ setOrderKeys() [2/2]

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

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

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

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

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

◆ setRetryDelay()

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

Sets the value of the retry delay for an asynchronous step

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

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

Parameters
secsthe amount of time in seconds to wait until a retry is made; overrides any value in the error definition
See also
WorkflowApi::setRetryDelay()
wf_set_retry_delay()

◆ sleep()

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

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

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

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

◆ stepError() [1/4]

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

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

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

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

◆ stepError() [2/4]

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

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

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

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

◆ stepError() [3/4]

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

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

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

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

◆ stepError() [4/4]

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

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

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

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

◆ stepExecuted()

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

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

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

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

◆ stepWarning() [1/2]

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

Raises a warning against the step

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

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

◆ stepWarning() [2/2]

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

Raises a warning against the step

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

Parameters
errthe string warning code
See also
WorkflowApi::stepWarning()
wf_swarning()

◆ updateDynamicData()

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

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

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

Changes are committed to the database before the method returns.

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

◆ updateInstanceData()

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

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

Parameters
hashthe key-value pairs to update in workflow execution instance data
See also
WorkflowApi::updateInstanceData()
wf_update_instance_data()
Workflow Execution Instance Data

◆ updateSensitiveData() [1/3]

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

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

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

◆ updateSensitiveData() [2/3]

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

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

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

◆ updateSensitiveData() [3/3]

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

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

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

◆ updateSensitiveDataFromAlias() [1/2]

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

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

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

◆ updateSensitiveDataFromAlias() [2/2]

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

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

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

◆ updateTempData()

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

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

Parameters
hashthe key-value pairs to update in workflow temporary data
See also
Workflow Temporary Data
Note
See also
WorkflowApi::updateTempData()
wf_update_temp_data()
TempDataHelper

◆ usleep() [1/2]

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

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

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

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

◆ usleep() [2/2]

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

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

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

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

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