main workflow API namespace More...

Classes
class	DynamicDataHelper
	This class is a helper class that allows workflow dynamic data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor. More...

class	QorusAsyncArrayStep
	The abstract class for asynchronous array steps. More...

class	QorusAsyncStep
	The abstract class for asynchronous steps. More...

class	QorusAsyncStepBase
	The Qore base interface class for asynchronous steps. More...

class	QorusEventArrayStep
	The abstract class for workflow synchronization event array steps. More...

class	QorusEventStep
	The abstract class for workflow synchronization event steps. More...

class	QorusEventStepBase
	The Qore base interface class for event steps. More...

class	QorusNormalArrayStep
	The abstract class for normal array steps. More...

class	QorusNormalStep
	The abstract class for normal steps. More...

class	QorusStepBase
	Base class for workflow step classes. More...

class	QorusSubworkflowArrayStep
	The abstract class for subworkflow array steps. More...

class	QorusSubworkflowStep
	The abstract class for subworkflow steps. More...

class	QorusSubworkflowStepBase
	The Qore base interface class for subworkflow steps. More...

class	QorusWorkflow
	Base class for workflow classes. More...

class	SensitiveDataHelper
	This class is a helper class that allows workflow sensitive data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor. More...

class	StepDataHelper
	This class is a helper class that allows workflow dynamic step data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor. More...

class	TempDataHelper
	This class is a helper class that allows workflow temp data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor. More...

class	WorkflowApi
	primary workflow API class More...

class	WorkflowDataHelper
	This class is a helper class that allows workflow dynamic data (DynamicDataHelper) and workflow temp data (TempDataHelper) to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor. More...

Functions
deprecated string	wf_generate_unique_key ()
	returns a unique async key for the order for use with wf_submit_async_key() More...

deprecated	wf_serror (string err, auto info)
	Raises an error against the current step without affecting the flow of processing. More...

deprecated	wf_serror (string err, auto info, date retry_delay)
	Raises an error against the current step without affecting the flow of processing. More...

deprecated	wf_serror (string err, auto info, int retry_delay)
	Raises an error against the current step without affecting the flow of processing. More...

deprecated	wf_swarning (string err, auto info)
	Raises a warning against the step. More...

deprecated	wf_swarning (string err, string fmt)
	Raises a warning against the step. More...

deprecated	wf_set_retry_delay (date delay)
	Sets the value of the retry delay for an asynchronous step. More...

deprecated	wf_set_retry_delay (int secs)
	Sets the value of the retry delay for an asynchronous step. More...

*hash< auto >	wf_get_error_info (string err)
	Returns the hash data associated with the error code passed as an argument. More...

deprecated	wf_update_dynamic_data (hash< auto > hash)
	Updates the values of one or more keys in the workflow order data instance’s dynamic data hash. More...

deprecated	wf_delete_dynamic_data_key (softlist list)
	Deletes one or more keys from the workflow order data instance’s dynamic data hash. More...

deprecated auto	wf_get_dynamic_data ()
	Retrieves the values of one or more keys from the workflow order data instance’s dynamic data hash. More...

deprecated auto	wf_get_static_data ()
	Retrieves the values of one or more keys from the workflow order data instance’s static data hash (this is the order data the workflow execution instance is processing) More...

deprecated	wf_update_temp_data (hash< auto > hash)
	Updates the values of one or more keys in the workflow order data instance’s temporary data hash. More...

deprecated auto	wf_get_temp_data ()
	Retrieves the values of one or more keys from the workflow order data instance’s temporary data hash. More...

deprecated	wf_delete_temp_data_key (softlist list)
	Deletes one or more keys from the workflow order data instance’s temporary data hash. More...

deprecated	wf_update_sensitive_data (string skey, string svalue, hash< auto > hash, softlist aliases, hash< auto > meta)
	Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data key and value. More...

deprecated	wf_update_sensitive_data_from_alias (string alias, hash hash, *hash meta)
	Updates or creates the values of one or more keys in the workflow order's sensitive data hash for the given sensitive data alias. More...

deprecated auto	wf_get_sensitive_metadata (string skey, string svalue)
	Returns the sensitive metadata hash for the given sensitive data key and value if present, otherwise returns an empty hash. More...

deprecated hash< auto >	wf_get_sensitive_metadata_from_alias (string alias)
	returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of the sensitive metadata hash for the given sensitive data alias corresponding to a sensitive data key and value More...

deprecated auto	wf_get_sensitive_data (string skey, string svalue)
	Returns the sensitive data hash for the given sensitive data key and value. More...

deprecated hash< auto >	wf_get_sensitive_data_from_alias (string alias)
	returns a hash with the corresponding sensitive data key and sensitive data value as well as the value of one or more keys in the workflow sensitive data hash for the given sensitive data alias corresponding to a sensitive data key and value More...

deprecated hash< auto >	wf_get_sensitive_data_aliases ()
	returns a hash of all sensitive data aliases for the current order or an empty hash if there are none More...

deprecated bool	wf_delete_sensitive_data (string skey, string svalue)
	Deletes the sensitive data hash for the given sensitive data key and value; changes have already been committed to the database when this function returns. More...

deprecated bool	wf_delete_sensitive_data_key (string skey, string svalue, softlist< auto > list)
	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 function returns. More...

deprecated hash< auto >	wf_get_sensitive_data_key_values ()
	Returns a hash of sensitive data keys and values saved against the order; the sensitive data hashes themselves are not returned, just the information used to index sensitive data against the order. More...

deprecated	wf_update_instance_data (hash< auto > hash)
	Updates the values of one or more keys in the workflow execution instance’s instance data hash. More...

deprecated	wf_delete_instance_data_key (softlist list)
	Deletes a single key or a list of keys from the workflow execution instance’s instance data hash. More...

deprecated auto	wf_get_instance_data ()
	Retrieves the values of one or more keys from the workflow execution instance’s instance data hash. More...

deprecated auto	wf_get_workflow_instance_data (string field)
	Retrieves the value of a single key (system-defined property) from the workflow execution instance object itself. More...

deprecated hash< auto >	wf_get_workflow_instance_data ()
	Retrieves the values of one or more keys (system-defined properties) from the workflow execution instance object itself. More...

deprecated	wf_set_order_keys (hash< auto > h, bool truncate=False)
	This function sets user-defined order keys against an order, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...

deprecated	wf_append_order_keys (hash< auto > h, bool truncate=False)
	This function appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...

deprecated	wf_append_order_keys (string key, softstring value, bool truncate=False)
	This function appends user-defined order key values to a workflow order key, so that the workflow order data instance can be quickly searched and retrieved using the key value. More...

deprecated auto	wf_get_order_keys ()
	This function retrieves the user-defined order key information saved against the workflow order data instance. More...

deprecated bool	wf_step_executed (string stepname)
	This function returns True if the step passed has been executed and has status OMQ::StatComplete (`"C"`) More...

deprecated *string	wf_get_step_status (string stepname)
	Returns the current status of the given step for the current workflow order instance. More...

deprecated	wf_submit_async_key (softstring key)
	This function creates a queue entry in the asynchronous queue bound to the asynchronous step being executed with a queue status of OMQ::QS_Waiting (`"W"`) More...

deprecated	wf_skip_async_step ()
	This function will skip the execution of an asynchronous step. More...

deprecated *hash< auto >	wf_get_step_info ()
	This function will return a hash of step information for the current step. More...

deprecated	wf_bind_event (softstring eventkey)
	binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) More...

deprecated	wf_bind_event_unposted (softstring eventkey)
	binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) only if the event has not yet been posted; if the event has already been posted, then an ALREADY-POSTED exception is raised More...

deprecated	wf_skip_event ()
	skips a workflow synchronization event step More...

deprecated hash< auto >	wf_bind_subworkflow (hash< auto > wf, hash< auto > order)
	This function binds a workflow to a subworkflow step. More...

deprecated hash< auto >	wf_skip_subworkflow ()
	This function will skip the execution of a subworkflow step. More...

deprecated hash< auto >	wf_get_workflow_metadata ()
	returns workflow metadata for the currently running workflow as a hash More...

deprecated *softstring	wf_get_parent_workflow_instanceid ()
	Returns the parent workflow order data instance ID of a subworkflow or NOTHING if the current workflow order is not a subworkflow and therefore has no parent. More...

deprecated	wf_set_blocked ()
	set the current workflow order status to OMQ::StatBlocked, can only be called from the attach function More...

deprecated	setOrderInfo (*hash< auto > h)
	Sets additional order attributes (`op_username`, `op_comment`) for the current workflow order data instance. More...

deprecated hash< auto >	getOrderInfo ()
	Returns the last order note for the current workflow order data instance. More...

deprecated list< auto >	wf_get_order_notes (*int count)
	Get Order Instance Notes. More...

deprecated	wf_add_order_note (string notestr)
	Add new note as described in Order Instance Notes. More...

deprecated	wf_set_custom_status (string stat)
	Sets a user-defined custom status for the current step. More...

deprecated	wf_reschedule_order (date scheduled)
	reschedules the current workflow order instance for later processing More...

deprecated	wf_reprioritize_order (int prio)
	changes the order priority for the current workflow order instance More...

deprecated	wf_leave_parent_feedback (string key, auto value)
	leaves feedback for a parent workflow More...

deprecated auto	wf_get_child_feedback (string key)
	gets feedback from a child workflow order with the given key More...

deprecated *hash< auto >	wf_get_child_feedback ()
	gets all feedback from all child workflow orders as a hash More...

deprecated *softint	wf_parent_wfiid ()
	Returns the parent workflow order data instance ID from a subworkflow or NOTHING if the current workflow order is not a subworkflow and therefore has no parent. More...

deprecated *softint	wf_wfiid ()
	returns the current workflow_instanceid as an integer; returns NOTHING if not called in a workflow order context (ex: onetimeinit function, etc) More...

deprecated	sqllog (string ds, string msg)
	Saves the information passed to the current log file depending on the calling context (workflow, service, or job) More...

deprecated	bind_event (softstring eventkey)

deprecated	bind_event_unposted (softstring eventkey)

deprecated	skip_event ()

deprecated hash	bindSubWorkflow (hash wf, hash order)

deprecated hash	skipSubWorkflow ()

deprecated	deleteDynamicDataKey (softlist list)

deprecated	deleteInstanceDataKey (softlist list)

deprecated	deleteTempDataKey (softlist list)

deprecated any	get_child_feedback (string key)

deprecated Datasource	getSharedDatasource (string ds)

deprecated DatasourcePool	getUniqueDatasource (string ds)

deprecated string	generateUniqueKey ()

deprecated any	getErrorInfo (string err)

deprecated any	getInstanceData ()

deprecated *string	getParentWorkflowInstanceID ()

deprecated any	getWorkflowInstanceData (string field)

deprecated hash	getWorkflowInstanceData ()

deprecated	setRetryDelay (date delay)

deprecated	setRetryDelay (int secs)

deprecated any	getDynamicData ()

deprecated any	getOrderKeys ()

deprecated any	getStaticData ()

deprecated *hash	getStepInfo ()

deprecated *string	getStepStatus (string stepname)

deprecated any	getTempData ()

deprecated hash	getWorkflowMetadata ()

deprecated	leave_parent_feedback (string key, any value)

deprecated	reschedule_order (date scheduled)

deprecated	reprioritize_order (int prio)

deprecated	serror (string err, any info)

deprecated	serror (string err, any info, date retry_delay)

deprecated	serror (string err, any info, int retry_delay)

deprecated	setBlocked ()

deprecated	setCustomStatus (string stat)

deprecated	setOrderKeys (hash hash, bool truncate=False)

deprecated	skipAsyncStep ()

deprecated bool	stepExecuted (string stepname)

deprecated	submitAsyncKey (softstring key)

deprecated	swarning (string err, any info)

deprecated	updateDynamicData (hash hash)

deprecated	updateInstanceData (hash hash)

deprecated	updateTempData (hash hash)

Detailed Description

main workflow API namespace

Qorus workflow API namespace.

Function Documentation

◆ bind_event()

deprecated OMQ::UserApi::Workflow::bind_event ( softstring eventkey )

Deprecated:: by wf_bind_event()

◆ bind_event_unposted()

deprecated OMQ::UserApi::Workflow::bind_event_unposted ( softstring eventkey )

Deprecated:: by wf_bind_event_unposted()

◆ bindSubWorkflow()

deprecated hash OMQ::UserApi::Workflow::bindSubWorkflow	(	hash	wf,
		hash	order
	)

Deprecated:: by wf_bind_subworkflow()

◆ deleteDynamicDataKey()

deprecated OMQ::UserApi::Workflow::deleteDynamicDataKey ( softlist list )

Deprecated:: by wf_delete_dynamic_data_key()

◆ deleteInstanceDataKey()

deprecated OMQ::UserApi::Workflow::deleteInstanceDataKey ( softlist list )

Deprecated:: by wf_delete_instance_data_key()

◆ deleteTempDataKey()

deprecated OMQ::UserApi::Workflow::deleteTempDataKey ( softlist list )

Deprecated:: by wf_delete_temp_data_key()

◆ generateUniqueKey()

deprecated string OMQ::UserApi::Workflow::generateUniqueKey ( )

Deprecated:: by wf_generate_unique_key()

◆ get_child_feedback()

deprecated any OMQ::UserApi::Workflow::get_child_feedback ( string key )

Deprecated:: by wf_get_child_feedback()

◆ getDynamicData()

deprecated any OMQ::UserApi::Workflow::getDynamicData ( )

Deprecated:: by wf_get_dynamic_data()

◆ getErrorInfo()

deprecated any OMQ::UserApi::Workflow::getErrorInfo ( string err )

Deprecated:: by wf_get_error_info()

◆ getInstanceData()

deprecated any OMQ::UserApi::Workflow::getInstanceData ( )

Deprecated:: by wf_get_instance_data()

◆ getOrderInfo()

deprecated hash< auto > OMQ::UserApi::Workflow::getOrderInfo ( )

Returns the last order note for the current workflow order data instance.

Deprecated:: This function is present for backwards-compatibility, now uses Order Instance Notes; use WorkflowApi::getOrderNotes() instead

Returns

a hash with the following keys for backwards-compatibility (returns other keys as well, see wf_get_order_notes() for more information):

op_username: the username of the operator who created the last note (renamed from username)
op_comment: the content of the last note (renamed from note)

Deprecated:: use WorkflowApi::getOrderNotes() instead

Since: Qorus 2.5.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ getOrderKeys()

deprecated any OMQ::UserApi::Workflow::getOrderKeys ( )

Deprecated:: by wf_get_order_keys()

◆ getParentWorkflowInstanceID()

deprecated *string OMQ::UserApi::Workflow::getParentWorkflowInstanceID ( )

Deprecated:: by wf_get_parent_workflow_instanceid()

◆ getSharedDatasource()

deprecated Datasource OMQ::UserApi::Workflow::getSharedDatasource ( string ds )

Deprecated:: by get_datasource_shared()

◆ getStaticData()

deprecated any OMQ::UserApi::Workflow::getStaticData ( )

Deprecated:: by wf_get_static_data()

◆ getStepInfo()

deprecated *hash OMQ::UserApi::Workflow::getStepInfo ( )

Deprecated:: by wf_get_step_info()

◆ getStepStatus()

deprecated *string OMQ::UserApi::Workflow::getStepStatus ( string stepname )

Deprecated:: by wf_get_step_status()

◆ getTempData()

deprecated any OMQ::UserApi::Workflow::getTempData ( )

Deprecated:: by wf_get_temp_data()

◆ getUniqueDatasource()

deprecated DatasourcePool OMQ::UserApi::Workflow::getUniqueDatasource ( string ds )

Deprecated:: by get_datasource_dedicated()

◆ getWorkflowInstanceData() [1/2]

deprecated hash OMQ::UserApi::Workflow::getWorkflowInstanceData ( )

Deprecated:: by wf_get_workflow_instance_data()

◆ getWorkflowInstanceData() [2/2]

deprecated any OMQ::UserApi::Workflow::getWorkflowInstanceData ( string field )

Deprecated:: by wf_get_workflow_instance_data()

◆ getWorkflowMetadata()

deprecated hash OMQ::UserApi::Workflow::getWorkflowMetadata ( )

Deprecated:: by wf_get_workflow_metadata()

◆ leave_parent_feedback()

deprecated OMQ::UserApi::Workflow::leave_parent_feedback	(	string	key,
		any	value
	)

Deprecated:: by wf_leave_parent_feedback()

◆ reprioritize_order()

deprecated OMQ::UserApi::Workflow::reprioritize_order ( int prio )

Deprecated:: by wf_reprioritize_order()

◆ reschedule_order()

deprecated OMQ::UserApi::Workflow::reschedule_order ( date scheduled )

Deprecated:: by wf_reschedule_order()

◆ serror() [1/3]

deprecated OMQ::UserApi::Workflow::serror	(	string	err,
		any	info
	)

Deprecated:: by wf_serror()

◆ serror() [2/3]

deprecated OMQ::UserApi::Workflow::serror	(	string	err,
		any	info,
		date	retry_delay
	)

Deprecated:: by wf_serror()

◆ serror() [3/3]

deprecated OMQ::UserApi::Workflow::serror	(	string	err,
		any	info,
		int	retry_delay
	)

Deprecated:: by wf_serror()

◆ setBlocked()

deprecated OMQ::UserApi::Workflow::setBlocked ( )

Deprecated:: by wf_set_blocked()

◆ setCustomStatus()

deprecated OMQ::UserApi::Workflow::setCustomStatus ( string stat )

Deprecated:: by wf_set_custom_status()

◆ setOrderInfo()

deprecated OMQ::UserApi::Workflow::setOrderInfo ( *hash< auto > h )

Sets additional order attributes (op_username, op_comment) for the current workflow order data instance.

Parameters

h	a hash with the following keys: `op_username:` the username of the operator currently working on the workflow order data when performing manual error resolution `op_comment:` notes about the workflow order data instance; for example; notes about manual processing steps already taken or needed

Deprecated:: use WorkflowApi::addOrderNote() instead

Since: Qorus 2.5.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ setOrderKeys()

deprecated OMQ::UserApi::Workflow::setOrderKeys	(	hash	hash,
		bool	truncate = `False`
	)

Deprecated:: by wf_set_order_keys()

◆ setRetryDelay() [1/2]

deprecated OMQ::UserApi::Workflow::setRetryDelay ( date delay )

Deprecated:: by wf_set_retry_delay()

◆ setRetryDelay() [2/2]

deprecated OMQ::UserApi::Workflow::setRetryDelay ( int secs )

Deprecated:: by wf_set_retry_delay()

◆ skip_event()

deprecated OMQ::UserApi::Workflow::skip_event ( )

Deprecated:: by wf_skip_event()

◆ skipAsyncStep()

deprecated OMQ::UserApi::Workflow::skipAsyncStep ( )

Deprecated:: by wf_skip_async_step()

◆ skipSubWorkflow()

deprecated hash OMQ::UserApi::Workflow::skipSubWorkflow ( )

Deprecated:: by wf_skip_subworkflow()

◆ sqllog()

deprecated OMQ::UserApi::Workflow::sqllog	(	string	ds,
		string	msg
	)

Saves the information passed to the current log file depending on the calling context (workflow, service, or job)

Deprecated:: This function is present for backwards-compatibility; use log() instead

Parameters

ds	the datasource for the SQL message
msg	the format string for a vsprintf() call with the remaining arguments

Deprecated:: use UserApi::logInfo() or UserApi::logDebug() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ stepExecuted()

deprecated bool OMQ::UserApi::Workflow::stepExecuted ( string stepname )

Deprecated:: by wf_step_executed()

◆ submitAsyncKey()

deprecated OMQ::UserApi::Workflow::submitAsyncKey ( softstring key )

Deprecated:: by wf_submit_async_key()

◆ swarning()

deprecated OMQ::UserApi::Workflow::swarning	(	string	err,
		any	info
	)

Deprecated:: by wf_swarning()

◆ updateDynamicData()

deprecated OMQ::UserApi::Workflow::updateDynamicData ( hash hash )

Deprecated:: by wf_update_dynamic_data()

◆ updateInstanceData()

deprecated OMQ::UserApi::Workflow::updateInstanceData ( hash hash )

Deprecated:: by wf_update_instance_data()

◆ updateTempData()

deprecated OMQ::UserApi::Workflow::updateTempData ( hash hash )

Deprecated:: by wf_update_temp_data()

◆ wf_add_order_note()

deprecated OMQ::UserApi::Workflow::wf_add_order_note ( string notestr )

Add new note as described in Order Instance Notes.

Parameters

notestr a string with note

Note: The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::addOrderNote() instead

Since: Qorus 3.0.2; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_append_order_keys() [1/2]

deprecated OMQ::UserApi::Workflow::wf_append_order_keys	(	hash< auto >	h,
		bool	truncate = `False`
	)

This function 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 function are updated and any new keys are added.

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

Parameters

h	key-value pairs to append to workflow order keys; the keys in this hash must match those defined for the workflow
truncate	allow key values to be truncated without an error

Exceptions

APPEND-ORDER-KEYS-ERROR	empty hash passed to wf_append_order_keys()
INVALID-WORKFLOW-KEY	invalid key for workflow
SET-ORDER-KEYS-ERROR	an 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::appendOrderKeys() instead

Since: Qorus 3.1.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_append_order_keys() [2/2]

deprecated OMQ::UserApi::Workflow::wf_append_order_keys	(	string	key,
		softstring	value,
		bool	truncate = `False`
	)

This function 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 function appends orders keys to the workflow order; existing order keys matching keys given in the arguments to this function are updated and any new keys are added.

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

Parameters

key	the workflow order key to append to; this key must match a defined workflow order key
value	the value to append for the given key
truncate	allow key values to be truncated without an error

Exceptions

INVALID-WORKFLOW-KEY	invalid key for workflow
DUPLICATE-KEY-VALUE	an 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::appendOrderKeys() instead

Since: Qorus 3.1.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_bind_event()

deprecated OMQ::UserApi::Workflow::wf_bind_event ( softstring eventkey )

binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent)

can only be called from a workflow synchronization event step (step of type OMQ::ExecEvent); otherwise if called from any other step type, or called twice for the same step; or called after wf_skip_event(), then an exception is raised. The event type is defined when the step is defined in the workflow definition (see Workflow Synchronization Step Event Type); this information does not need to be supplied here; only the event key, and the event will be automatically created (if it does not exist) or found in the queue as defined by its event type.

Parameters

eventkey the event key to bind the step to; if the event key does not already exist, then it is created in the table WORKFLOW_EVENTS and automatically tagged with its event type. A record for this step is also created in STEP_INSTANCE_EVENTS

Exceptions

WORKFLOW-EVENT-ERROR invalid function call (not workflow synchronization step, multiple call, etc)

Note

Either this function, wf_bind_event_unposted() or wf_skip_event() must be called in a workflow synchronization event step
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use QorusEventStepBase::bindEvent() instead

Since: Qorus 2.6.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_bind_event_unposted()

deprecated OMQ::UserApi::Workflow::wf_bind_event_unposted ( softstring eventkey )

binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) only if the event has not yet been posted; if the event has already been posted, then an ALREADY-POSTED exception is raised

can only be called from a workflow synchronization event step (step of type OMQ::ExecEvent); otherwise if called from any other step type, or called twice for the same step; or called after wf_skip_event(), then an exception is raised. The event type is defined when the step is defined in the workflow definition (see Workflow Synchronization Step Event Type); this information does not need to be supplied here; only the event key, and the event will be automatically created (if it does not exist) or found in the queue as defined by its event type.

Parameters

eventkey the event key to bind the step to; if the event key does not already exist, then it is created in the table WORKFLOW_EVENTS and automatically tagged with its event type. A record for this step is also created in STEP_INSTANCE_EVENTS

Exceptions

ALREADY-POSTED	the given event has already been posted
WORKFLOW-EVENT-ERROR	invalid function call (not workflow synchronization step, multiple call, etc)

Note

Either this function, wf_bind_event() or wf_skip_event() must be called in a workflow synchronization event step
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use QorusEventStepBase::bindEventUnposted() instead

Since: Qorus 2.6.3.p14; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_bind_subworkflow()

deprecated hash< auto > OMQ::UserApi::Workflow::wf_bind_subworkflow	(	hash< auto >	wf,
		hash< auto >	order
	)

This function binds a workflow to a subworkflow step.

If this function is called from a non-subworkflow step, or if called twice or after wf_skip_subworkflow() is called, then an exception is raised

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

global_unique_key
workflow_specific_unique_key
workflow_unique_key

Parameters

wf

This hash identifies the workflow type to be bound to the subworkflow step having the following keys:

name: (required) the workflow name for the new order
version: (optional) the version of the workflow for the new order
Other keys will be ignored. If the version key is not present, an order for the latest version of the workflow will be created

order

A hash defining the order data to be processed. Valid keys for this hash are:

dynamicdata: (optional hash) the initial dynamic data for the order
external_order_instanceid: (optional/required string) the external order instance ID for the workflow data; one of staticdata or external_order_instanceid must be provided
global_unique_key: (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); if this key already exists for any order in the system, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
orderkeys: (optional hash; also order-keys is accepted for backwards-compatibility) a hash of order keys for the order
priority: the order priority (optional int, default DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowest
scheduled: (optional date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to StatScheduled instead of StatReady
sensitive_data: (optional hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys:
- aliases: (optional list of strings) zero or more string aliases for the sensitive data
- data: (required hash) the sensitive data hash itself
- meta: (optional hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself):
  - PURPOSE: free-form information about the purpose of the sensitive data
  - CATEGORIES: free-form information about the categories of sensitive data
  - RECIPIENTS: free-form information about the recipients or recipient catories of sensitive data
  - STORAGE: free-form information about the storage time or rules for sensitive data
staticdata: (optional/required hash) the initial static data for the order; one of staticdata or external_order_instanceid must be provided
tempdata: (optional hash) the initial temporary data for the order
workflow_specific_unique_key: (optional string) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); if this key already exists for an order with the target workflowid, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key
workflow_unique_key: (optional string) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); if this key already exists for a workflow order with the same name, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order key

Returns: a hash with a single key: workflow_instanceid, the value of which is the workflow order data instance ID of the subworkflow

Exceptions

SUBWORKFLOW-ERROR	invalid function call (not subworkflow step, multiple call, etc), invalid arguments (unknown workflow, etc)
WORKFLOW-KEY-ERROR	invalid workflow key given
ORDER-DATA-ERROR	missing either `external_order_instanceid` or `staticdata`, unknown workflow; invalid keys or sensitive data format
DUPLICATE-ORDER-KEY	the given unique key already exists in the defined scope

Note

Subworkflow steps must call either this function or wf_skip_subworkflow() or an error will be raised.
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use QorusSubworkflowStepBase::bindSubworkflow() instead

Since

Qorus 3.1.1 implemented support for the following keys in the order argument:
- global_unique_key
- sensitive_data
- workflow_specific_unique_key
- workflow_unique_key

Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_delete_dynamic_data_key()

deprecated OMQ::UserApi::Workflow::wf_delete_dynamic_data_key ( softlist list )

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 function returns.

See also: Workflow Order Dynamic Data

Parameters

list	a single key or a 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::deleteDynamicDataKey() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_delete_instance_data_key()

deprecated OMQ::UserApi::Workflow::wf_delete_instance_data_key ( softlist list )

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

Parameters

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

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::deleteInstanceDataKey() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_delete_sensitive_data()

deprecated bool OMQ::UserApi::Workflow::wf_delete_sensitive_data	(	string	skey,
		string	svalue
	)

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

Example:: wf_delete_sensitive_data("personal_id", personal_id);

Parameters

skey	the type of sensitive key provided in svalue
svalue	the 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::deleteSensitiveData() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_delete_sensitive_data_key()

deprecated bool OMQ::UserApi::Workflow::wf_delete_sensitive_data_key	(	string	skey,
		string	svalue,
		softlist< auto >	list
	)

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 function returns.

Example:: # delete the "tax_number" and "insurance_number" keys from the sensitive data hash for the given person

wf_delete_sensitive_data_key("personal_id", personal_id, ("tax_number", "insurance_number"));

Changes are committed to the database before the function returns.

Parameters

skey	the type of sensitive key provided in svalue
svalue	the value of the sensitive data key identified by skey
list	a 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::deleteSensitiveDataKey() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_delete_temp_data_key()

deprecated OMQ::UserApi::Workflow::wf_delete_temp_data_key ( softlist list )

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

Parameters

list	a single key or a a list of strings (keys) to delete in workflow temporary data

See also: Workflow Temporary Data

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::deleteTempDataKey() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_generate_unique_key()

deprecated string OMQ::UserApi::Workflow::wf_generate_unique_key ( )

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

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::get()

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::generateUniqueKey() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_child_feedback() [1/2]

deprecated *hash< auto > OMQ::UserApi::Workflow::wf_get_child_feedback ( )

gets all feedback from all child workflow orders as a hash

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

Returns: a hash representing all feedback values saved by child workflow orders with wf_leave_parent_feedback()

Note: The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getChildFeedback() instead

Since: Qorus 3.1.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_child_feedback() [2/2]

deprecated auto OMQ::UserApi::Workflow::wf_get_child_feedback ( string key )

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 wf_leave_parent_feedback() for any value to be returned with this function call

Parameters

key	the feedback key name used by the child workflow

Returns: the value of the feedback saved by the child workflow order with wf_leave_parent_feedback() under the given key

Deprecated:: use WorkflowApi::getChildFeedback() instead

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_dynamic_data()

deprecated auto OMQ::UserApi::Workflow::wf_get_dynamic_data ( )

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

Pass a single string argument, in which case 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

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getDynamicDataArgs() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_error_info()

*hash< auto > OMQ::UserApi::Workflow::wf_get_error_info ( string err )

Returns the hash data associated with the error code passed as an argument.

Parameters

err	the error name

Returns: normally returns a hash of error information or NOTHING if the error is not defined

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getErrorInfo() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_instance_data()

deprecated auto OMQ::UserApi::Workflow::wf_get_instance_data ( )

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

This data is set by the user (by calling wf_update_instance_data()) 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.

Pass a single string argument, in which case 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.

Returns: a single value or hash of workflow execution instance data, depending on the argument(s)

Note

not to be confused with wf_get_workflow_instance_data(), which returns system properties of the workflow execution instance
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getInstanceData() or WorkflowApi::getInstanceDataArgs() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_order_keys()

deprecated auto OMQ::UserApi::Workflow::wf_get_order_keys ( )

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

Pass a single string argument, in which case 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. Pass NOTHING to the function to get a hash of all keys (if any are set).

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getOrderKeysArgs() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_order_notes()

deprecated list< auto > OMQ::UserApi::Workflow::wf_get_order_notes ( *int count )

Get Order Instance Notes.

Parameters

count an optional integer to limit the list size

Returns: list of hashes of Order Instance Notes

Note: The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getOrderNotes() instead

Since: Qorus 3.0.2; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_parent_workflow_instanceid()

deprecated *softstring OMQ::UserApi::Workflow::wf_get_parent_workflow_instanceid ( )

Returns the parent workflow order data instance ID of a subworkflow or NOTHING 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 NOTHING if the current workflow order is not a subworkflow

Note

this function returns *string for backwards-compatibility
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::parentWfiid() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_sensitive_data()

deprecated auto OMQ::UserApi::Workflow::wf_get_sensitive_data	(	string	skey,
		string	svalue
	)

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

Example:: string tax_number = wf_get_sensitive_data("personal_id", personal_id, "tax_number");

Parameters

skey	the type of sensitive key provided in svalue
svalue	the value of the sensitive data key identified by skey
...	any sensitive data keys for the given key and value; if none are present, the entire hash is returned (if any), otherwise only the given key values are returned; if mutiple keys are given, then a hash is returned, if a single key is given, then only that key value is returned

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 function
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getSensitiveDataArgs() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_sensitive_data_aliases()

deprecated hash< auto > OMQ::UserApi::Workflow::wf_get_sensitive_data_aliases ( )

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

Example:: hash<auto> ah = wf_get_sensitive_data_aliases();

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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getSensitiveDataAliases() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_sensitive_data_from_alias()

deprecated hash< auto > OMQ::UserApi::Workflow::wf_get_sensitive_data_from_alias ( string alias )

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 = wf_get_sensitive_data_from_alias("0", "tax_number").value;

Parameters

alias	the alias to lookup; if the alias is unknown, an `INVALID-ALIAS` exception is raised
...	zero or more string 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: the value of the entire hash (if no arguments were requested), or a hash of the requested keys (if more than one key was requested), or the given value (if set, if one value is requested)

Exceptions

INVALID-ALIAS the given alias is unknown

Note

returns sensitive data; take care not to log any of the data returned by this function
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getSensitiveDataFromAliasArgs() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_sensitive_data_key_values()

deprecated hash< auto > OMQ::UserApi::Workflow::wf_get_sensitive_data_key_values ( )

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:: *hash<auto> h = wf_get_sensitive_data_key_values();

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; 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getSensitiveDataKeyValues() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_sensitive_metadata()

deprecated auto OMQ::UserApi::Workflow::wf_get_sensitive_metadata	(	string	skey,
		string	svalue
	)

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

Example:: hash metadata = wf_get_sensitive_metadata("personal_id", personal_id);

Parameters

skey	the type of sensitive key provided in svalue
svalue	the 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 function
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getSensitiveMetadata() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_sensitive_metadata_from_alias()

deprecated hash< auto > OMQ::UserApi::Workflow::wf_get_sensitive_metadata_from_alias ( string alias )

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

hash<auto> metadata = wf_get_sensitive_metadata_from_alias("0").value;

Parameters

alias the 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-ALIAS the given alias is unknown

Note

returns sensitive data; take care not to log any of the sensitive data returned by this function
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getSensitiveMetadataFromAlias() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_static_data()

deprecated auto OMQ::UserApi::Workflow::wf_get_static_data ( )

Retrieves the values of one or more keys from the workflow order data instance’s static data hash (this is the order data the workflow execution instance is processing)

Pass a single string argument, in which case 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

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

Returns: data from the workflow order data instance’s static data hash according to the arguments passed

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getStaticDataArgs() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_step_info()

deprecated *hash< auto > OMQ::UserApi::Workflow::wf_get_step_info ( )

This function 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:

stepid: the ID of the step
name: the name of the step
[patch]: the patch string for the step
[desc]: the description of the step
version: the version of the step
steptype: OMQ::ExecNormal, OMQ::ExecSubWorkflow, or OMQ::ExecAsync
arraytype: either OMQ::ArraySeries or OMQ::ArrayNone for non-array steps
index: the element number for array steps (always 0 for non-array steps)
[array_size]: the number of elements in the array for array steps
[stepstatus]: the previous step status when called from a workflow executpon instance run in OMQ::WM_Recovery mode
[retries]: the current retry number when called from a workflow execution instance run in OMQ::WM_Recovery mode
stepfunction_instanceid: the function instance ID of the primary step function
sfname: the name of the primary step function
[validationcodetion_instanceid]: the function instance ID of the validation function
[vfname]: the name of the validation function (corresponds to validationcodetion_instanceid)
[endfunction_instanceid]: the function instance ID of the asynchronous end function for asynchronous steps
[efname]: the name of the end function (corresponds to endfunction_instanceid)
[arrayfunction_instanceid]: the function instance ID of the array function for array steps
[afname]: the name of the array function (corresponds to arrayfunction_instanceid)
[queueid]: the ID of the asynchronous queue for asynchronous steps
[queuename]: the name of the asynchronous queue (corresponds to queueid)
[workflow_event_typeid]: the event type ID for workflow synchronization event steps
[eventtype]: the name of the event type (corresponds to workflow_event_typeid)

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getStepInfo() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_step_status()

deprecated *string OMQ::UserApi::Workflow::wf_get_step_status ( string stepname )

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

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getStepStatus() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_temp_data()

deprecated auto OMQ::UserApi::Workflow::wf_get_temp_data ( )

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

See also: Workflow Temporary Data

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getTempDataArgs() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_workflow_instance_data() [1/2]

deprecated hash< auto > OMQ::UserApi::Workflow::wf_get_workflow_instance_data ( )

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 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-ERROR invalid arguments to function

Note

Not to be confused with wf_get_instance_data()
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getWorkflowInstanceDataArgs() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_workflow_instance_data() [2/2]

deprecated auto OMQ::UserApi::Workflow::wf_get_workflow_instance_data ( string field )

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

Parameters

field the 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

Note

not to be confused with wf_get_instance_data()
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getWorkflowInstanceData() instead

Since: Qorus 3.1.0 the sync attribute was added; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_get_workflow_metadata()

deprecated hash< auto > OMQ::UserApi::Workflow::wf_get_workflow_metadata ( )

returns workflow metadata for the currently running workflow as a hash

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

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getWorkflowMetadata() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_leave_parent_feedback()

deprecated OMQ::UserApi::Workflow::wf_leave_parent_feedback	(	string	key,
		auto	value
	)

leaves feedback for a parent workflow

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

Parameters

key	the key name for the feedback in the parent workflow
value	the value of the key

Exceptions

FEEDBACK-ERROR	the current workflow is not a subworkflow; value is NOTHING or an error occurred accessing the parent workflow order
SESSION-ERROR	the parent workflow order is being processed by another Qorus session
STATUS-ERROR	the parent workflow order is already COMPLETE or CANCELED and cannot be updated

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

Deprecated:: use WorkflowApi::leaveParentFeedback() instead

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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_parent_wfiid()

deprecated *softint OMQ::UserApi::Workflow::wf_parent_wfiid ( )

Returns the parent workflow order data instance ID from a subworkflow or NOTHING 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 NOTHING if the current workflow order is not a subworkflow

Note: The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::parentWfiid() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_reprioritize_order()

deprecated OMQ::UserApi::Workflow::wf_reprioritize_order ( int prio )

changes the order priority for the current workflow order instance

Parameters

prio	must be an integer >= 0 and <= 999

Note

The order priority can be changed externally by calling the system API method omq.system.reprioritize-order()
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::reprioritizeOrder() instead

Since: Qorus 2.6.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_reschedule_order()

deprecated OMQ::UserApi::Workflow::wf_reschedule_order ( date scheduled )

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

scheduled If the date is ealier than the current time; then this call is ignored

Exceptions

RESCHEDULE-ERROR function 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()
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::rescheduleOrder() instead

Since: Qorus 2.6.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_serror() [1/3]

deprecated OMQ::UserApi::Workflow::wf_serror	(	string	err,
		auto	info
	)

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

This function 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

err	the string error code
info	additional 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::stepError() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_serror() [2/3]

deprecated OMQ::UserApi::Workflow::wf_serror	(	string	err,
		auto	info,
		date	retry_delay
	)

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

This function 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

err	the string error code
info	additional 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	the amount of time to wait until a retry is made; overrides any value in the error definition; this may be either a relative date/time value (in which case the value is added to the current time to arrive at an absolute date/time value), or an absolute date/time value, giving the earliest date/time that the error will be retried

Since: Qorus 2.5.0 (variants with the retry_delay parameter)

Note

workflow errors can also be raised by throwing an exception
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::stepError() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_serror() [3/3]

deprecated OMQ::UserApi::Workflow::wf_serror	(	string	err,
		auto	info,
		int	retry_delay
	)

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

This function 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

err	the string error code
info	additional 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	the amount of time in seconds to wait until a retry is made; overrides any value in the error definition

Since: Qorus 2.5.0 (variants with the retry_delay parameter)

Note

workflow errors can also be raised by throwing an exception
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::stepError() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_set_blocked()

deprecated OMQ::UserApi::Workflow::wf_set_blocked ( )

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-ERROR function not called from attach function

Note

This function can only be called in the attach function of the workflow; if called from any other code, an exception will result.
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::setBlocked() instead

Since: Qorus 2.5.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_set_custom_status()

deprecated OMQ::UserApi::Workflow::wf_set_custom_status ( string stat )

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

stat	the custom user-defined status to set for the step

Exceptions

CUSTOM-STATUS-ERROR this exception is thrown if this function is called outside of step code

Note

The custom status must be a single character
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::setCustomStatus() instead

Since: Qorus 2.5.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_set_order_keys()

deprecated OMQ::UserApi::Workflow::wf_set_order_keys	(	hash< auto >	h,
		bool	truncate = `False`
	)

This function 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 function are replaced and any new keys in the hash are added.

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

Parameters

h	key-value pairs to set for order keys; the keys in this hash must match those defined for the workflow
truncate	allow key values to be truncated without an error

Exceptions

SET-ORDER-KEYS-ERROR	empty hash passed to wf_set_order_keys()
INVALID-WORKFLOW-KEY	invalid key for workflow
DUPLICATE-KEY-VALUE	an 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::setOrderKeys() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_set_retry_delay() [1/2]

deprecated OMQ::UserApi::Workflow::wf_set_retry_delay ( date delay )

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 function 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 wf_serror() function with the optional third argument giving the retry delay instead of calling this function after the call to wf_serror().

Parameters

delay the amount of time to wait until a retry is made; overrides any value in the error definition

Since: Qorus 2.5.0

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::setRetryDelay() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_set_retry_delay() [2/2]

deprecated OMQ::UserApi::Workflow::wf_set_retry_delay ( int secs )

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 function 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 wf_serror() function with the optional third argument giving the retry delay instead of calling this function after the call to serror().

Parameters

secs	the amount of time in seconds to wait until a retry is made; overrides any value in the error definition

Since: Qorus 2.5.0

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::setRetryDelay() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_skip_async_step()

deprecated OMQ::UserApi::Workflow::wf_skip_async_step ( )

This function will skip the execution of an asynchronous step.

Calling this function in a non-asynchronous step or calling this function or wf_submit_async_key() more than once from an asynchronous step will result in an exception.

Exceptions

INVALID-FUNCTION-CALL invalid function call (not from async step or double call, etc)

Note

Asynchronous steps must call either this function or wf_submit_async_key() or an error will be raised.
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use QorusAsyncStepBase::skipAsyncStep() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_skip_event()

deprecated OMQ::UserApi::Workflow::wf_skip_event ( )

skips a workflow synchronization event step

can only be called from a workflow synchronization event step (step of type OMQ::ExecEvent); otherwise if called from any other step type, or called after wf_bind_event(), then an exception is raised. If called twice for the same step a message is logged but no exception is raised

Exceptions

WORKFLOW-EVENT-ERROR invalid function call (not workflow synchronization step, multiple call, etc)

Note

Either wf_bind_event() or wf_skip_event() must be called in a workflow synchronization event step
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use QorusEventStepBase::skipEvent() instead

Since: Qorus 2.6.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_skip_subworkflow()

deprecated hash< auto > OMQ::UserApi::Workflow::wf_skip_subworkflow ( )

This function will skip the execution of a subworkflow step.

Calling this function in a non-subworkflow step will result in an exception being thrown.

Calling after wf_bind_subworkflow() has already been called, and a subworkflow order instance has been bound to the step, will result in an exception.

Calling this function twice for the same step will simply cause a message to be logged that the function was called twice.

Returns

a hash with the following keys:

workflow_instanceid: the current workflow_instanceid
skipped: constant boolean True

Exceptions

SUBWORKFLOW-ERROR invalid call (not subworkflow step, subworkflow already bound, etc)

Note

Subworkflow steps must call either this function or wf_bind_subworkflow() or an error will be raised.
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use QorusSubworkflowStepBase::skipSubworkflow() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_step_executed()

deprecated bool OMQ::UserApi::Workflow::wf_step_executed ( string stepname )

This function 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")

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::stepExecuted() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_submit_async_key()

deprecated OMQ::UserApi::Workflow::wf_submit_async_key ( softstring key )

This function creates a queue entry in the asynchronous queue bound to the asynchronous step being executed with a queue status of OMQ::QS_Waiting ("W")

If this function is called in a non-asynchronous (i.e. not OMQ::ExecAsync, so either a normal, deprecated subworkflow, or event synchronization) step, or if this function or wf_skip_async_step() are called more than once from an asynchronous step, an exception will be thrown.

If the key already exists in the queue, an exception will be thrown.

The queue name and ID is taken from the step definition; queue entries are created in the table QUEUE_DATA.

Parameters

key	the key for the queue entry; must be unique in the queue

Exceptions

INVALID-FUNCTION-CALL	invalid function call (not from async step or double call, etc)
INVALID-KEY	empty string passed for key

Note

Asynchronous steps must call either this function or wf_skip_async_step() or an error will be raised.
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use QorusAsyncStepBase::submitAsyncKey() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_swarning() [1/2]

deprecated OMQ::UserApi::Workflow::wf_swarning	(	string	err,
		auto	info
	)

Raises a warning against the step.

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

Parameters

err	the string error code
info	additional 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

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::stepWarning() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_swarning() [2/2]

deprecated OMQ::UserApi::Workflow::wf_swarning	(	string	err,
		string	fmt
	)

Raises a warning against the step.

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

Parameters

err	the string error code
fmt	a format string to format additional arguments

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::stepWarning() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_update_dynamic_data()

deprecated OMQ::UserApi::Workflow::wf_update_dynamic_data ( hash< auto > hash )

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 function returns.

See also: Workflow Order Dynamic Data

Parameters

hash	the 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::updateDynamicData() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_update_instance_data()

deprecated OMQ::UserApi::Workflow::wf_update_instance_data ( hash< auto > hash )

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

Parameters

hash	the key-value pairs to update in workflow execution instance data

Note

The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::updateInstanceData() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_update_sensitive_data()

deprecated OMQ::UserApi::Workflow::wf_update_sensitive_data	(	string	skey,
		string	svalue,
		hash< auto >	hash,
		*softlist	aliases,
		*hash< auto >	meta
	)

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:: wf_update_sensitive_data("personal_id", h.person.personal_id, h, h.("tax_number",));

Parameters

skey	the type of value provided in svalue; must not be longer than 100 bytes long or a `SENSITIVE-DATA-ERROR` exception is raised
svalue	the value of the sensitive data key identified by skey; if this string is empty or longer than 100 bytes, a `SENSITIVE-DATA-ERROR` exception is raised
hash	the 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
aliases	other values for the sensitive data
meta	optional 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-ERROR no 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::updateSensitiveData() instead

Since

introduced in Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_update_sensitive_data_from_alias()

deprecated OMQ::UserApi::Workflow::wf_update_sensitive_data_from_alias	(	string	alias,
		hash	hash,
		*hash	meta
	)

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:: wf_update_sensitive_data_from_alias("0", h);

Parameters

alias	the alias to use for updating the data; if the alias is unknown, an `INVALID-ALIAS` exception is raised
hash	the 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
meta	optional 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-ALIAS the 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
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::updateSensitiveDataFromAlias() instead

Since

Qorus 3.1.1
in Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_update_temp_data()

deprecated OMQ::UserApi::Workflow::wf_update_temp_data ( hash< auto > hash )

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

Parameters

hash	the key-value pairs to update in workflow temporary data

See also: Workflow Temporary Data

Note

this call does not replace the temporary data hash; any keys in the hash parameter are added to the temporary data hash
The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::updateTempData() instead

Since: Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

◆ wf_wfiid()

deprecated *softint OMQ::UserApi::Workflow::wf_wfiid ( )

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

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

Note: The function-baased workflow API is deprecated; please use class-based steps and the WorkflowApi class instead of this function

Deprecated:: use WorkflowApi::getWfiid() instead

Since: Qorus 3.1.0; Qorus 5.0 all workflow API functions were deprecated in favor of the APIs in WorkflowApi

Classes

Functions

Detailed Description

Function Documentation

◆ bind_event()

◆ bind_event_unposted()

◆ bindSubWorkflow()

◆ deleteDynamicDataKey()

◆ deleteInstanceDataKey()

◆ deleteTempDataKey()

◆ generateUniqueKey()

◆ get_child_feedback()

◆ getDynamicData()

◆ getErrorInfo()

◆ getInstanceData()

◆ getOrderInfo()

◆ getOrderKeys()

◆ getParentWorkflowInstanceID()

◆ getSharedDatasource()

◆ getStaticData()

◆ getStepInfo()

◆ getStepStatus()

◆ getTempData()

◆ getUniqueDatasource()

◆ getWorkflowInstanceData() [1/2]

◆ getWorkflowInstanceData() [2/2]

◆ getWorkflowMetadata()

◆ leave_parent_feedback()

◆ reprioritize_order()

◆ reschedule_order()

◆ serror() [1/3]

◆ serror() [2/3]

◆ serror() [3/3]

◆ setBlocked()

◆ setCustomStatus()

◆ setOrderInfo()

◆ setOrderKeys()

◆ setRetryDelay() [1/2]

◆ setRetryDelay() [2/2]

◆ skip_event()

◆ skipAsyncStep()

◆ skipSubWorkflow()

◆ sqllog()

◆ stepExecuted()

◆ submitAsyncKey()

◆ swarning()

◆ updateDynamicData()

◆ updateInstanceData()

◆ updateTempData()

◆ wf_add_order_note()

◆ wf_append_order_keys() [1/2]

◆ wf_append_order_keys() [2/2]

◆ wf_bind_event()

◆ wf_bind_event_unposted()

◆ wf_bind_subworkflow()

◆ wf_delete_dynamic_data_key()

◆ wf_delete_instance_data_key()

◆ wf_delete_sensitive_data()

◆ wf_delete_sensitive_data_key()

◆ wf_delete_temp_data_key()

◆ wf_generate_unique_key()

◆ wf_get_child_feedback() [1/2]

◆ wf_get_child_feedback() [2/2]

◆ wf_get_dynamic_data()

◆ wf_get_error_info()

◆ wf_get_instance_data()

◆ wf_get_order_keys()

◆ wf_get_order_notes()

◆ wf_get_parent_workflow_instanceid()

◆ wf_get_sensitive_data()

◆ wf_get_sensitive_data_aliases()

◆ wf_get_sensitive_data_from_alias()

◆ wf_get_sensitive_data_key_values()

◆ wf_get_sensitive_metadata()

◆ wf_get_sensitive_metadata_from_alias()

◆ wf_get_static_data()

◆ wf_get_step_info()

◆ wf_get_step_status()

◆ wf_get_temp_data()

◆ wf_get_workflow_instance_data() [1/2]