Qorus Integration Engine® Enterprise Edition 7.0.3_prod
Loading...
Searching...
No Matches
qorus-common-server-api.ql File Reference

functions common to workflow, service, and job APIs More...

Classes

class  OMQ::QorusSystemServiceHelper
 top-level class that allows transparent auto-loading and access to Qorus system and user services More...
 
class  OMQ::ServiceGate
 ServiceGate allows autoloading of Qorus services on referenced. More...
 
class  OMQ::ServiceMethodGate
 ServiceMethodGate provides a gateway to service methods. More...
 
class  OMQ::QorusSystemAPIHelper
 class used to call the Qorus system API for a remote Qorus instance through the network API More...
 
class  OMQ::QorusSystemRestHelper
 class used to call the Qorus REST API for a remote Qorus instance More...
 

Namespaces

namespace  OMQ
 main Qorus namespace
 
namespace  OMQ::UserApi
 user API namespace root
 

Functions

deprecated *hash< auto > OMQ::UserApi::get_user_service_info (string name)
 returns information about the given user service (if it's currently loaded)
 
deprecated SqlUtil::AbstractTable OMQ::UserApi::get_sql_table (string datasource, string table_name)
 get a cached table object (suitable for DML) if present, otherwise it creates one from scratch
 
deprecated SqlUtil::AbstractTable OMQ::UserApi::get_sql_table (AbstractDatasource datasource, string table_name)
 get a cached table object (suitable for DML) if present, otherwise it creates one from scratch
 
deprecated hash< auto > OMQ::UserApi::get_sql_cache_info ()
 get information about cached object
 
deprecated OMQ::UserApi::clear_sql_table_cache (string datasource, *string table_name)
 clears all objects for given datasource from the cache (for example, if database objects have been updated in the dataserver)
 
deprecated OMQ::UserApi::clear_sql_table_cache (AbstractDatasource datasource, *string table_name)
 clears cached objects for given datasource (for example, if database objects have been updated in the dataserver)
 
deprecated auto OMQ::UserApi::get_value_map (string mapname, string key)
 Gets a lookup value from the value map by a key; the value map must be registered to the current interface.
 
deprecated list OMQ::UserApi::get_value_maps ()
 Gets all value maps valid for the current interface.
 
deprecated bool OMQ::UserApi::post_sla_event_success (string sla, number value)
 posts a successful SLA event for SLA monitoring and performance tracking
 
deprecated bool OMQ::UserApi::post_sla_event_error (string sla, number value, string err, string desc)
 posts an unsuccessful SLA event for SLA monitoring and performance tracking
 
deprecated OMQ::UserApi::flush_sla_events ()
 flushes all pending SLA events to disk and returns after the data has been committed
 
deprecated *hash OMQ::UserApi::get_system_service_info (string name)
 returns information about the given system service (if it's currently loaded)
 
deprecated *hash< auto > OMQ::UserApi::get_service_info (string type, string name)
 returns information about the given service (if it's currently loaded)
 
deprecated list< auto > OMQ::UserApi::get_running_workflow_list (*string name, *string ver)
 returns a list of hashes giving information about the currently-running workflow execution instances
 
deprecated hash< auto > OMQ::UserApi::get_running_workflow_info (softint id)
 returns a hash of the workflow execution instance info if the ID is valid or an empty hash if not
 
deprecated softstring OMQ::UserApi::create_order (string name, *string version, hash params, string status=StatReady)
 creates a workflow order data instance in the database
 
deprecated softstring OMQ::UserApi::create_remote_order (string remote, string name, *string version, hash params, string status=StatReady, bool register_dependency=True)
 creates a workflow order data instance in a remote Qorus instance
 
deprecated hash< auto > OMQ::UserApi::exec_synchronous_workflow (string name, *string version, hash< auto > sdata, *hash< auto > opts, *hash< auto > ddata, softint priority=DefaultOrderPriority, *hash< auto > orderkeys, *softstring external_order_instanceid, *softint parent_workflow_instanceid)
 executes a workflow order synchronously and returns the final status and order ID in a hash
 
deprecated int OMQ::UserApi::post_user_event (string severity, auto info)
 posts an application event of class QE_CLASS_USER
 
deprecated hash OMQ::UserApi::runtime_properties ()
 returns Qorus runtime properties as a hash
 
deprecated auto OMQ::UserApi::call_network_api_args_with_authentication (string user, string pass, string call, softlist args)
 calls a system RPC API with authentication information (username and password)
 
deprecated auto OMQ::UserApi::call_network_api_args (string call, softlist args)
 calls a system RPC API with the argument list to the API method as a top-level argument to this function; the API is called with system permissions (no restrictions)
 
deprecated auto OMQ::UserApi::call_network_api (string call,...)
 calls a system RPC API and returns the result; the API is called with system permissions (no restrictions)
 
deprecated auto OMQ::UserApi::call_rest_api (string method, string path, *hash< auto > body_args)
 calls a system REST API method and returns the result; the API is called with system permissions (no restrictions)
 
deprecated auto OMQ::UserApi::call_rest_api_with_authentication (string user, string pass, string method, string path, *hash body_args)
 calls a system REST API method with authentication information (username and password) and returns the result
 
deprecated hash< auto > OMQ::UserApi::get_system_info ()
 returns a hash of system info
 
deprecated int OMQ::UserApi::get_session_id ()
 returns the current Qorus application session ID
 
deprecated OMQ::UserApi::log (softint lvl, softstring msg)
 Writes the information passed to the workflow, service, job, or system log file depending on the calling context if the log level passed is equal to or lower than value of the system option qorus.verbose.
 
deprecated *int OMQ::UserApi::audit_user_event (string user_event, *string info1, *string info2)
 creates a user audit event (with audit event code AE_USER_EVENT) against the workflow, service, or job instance
 
deprecated bool OMQ::UserApi::audit_check_event_string (string opt)
 checks if the given audit event (given as a string) is enabled
 
deprecated bool OMQ::UserApi::audit_check_event (softint opt)
 checks if the given audit event (given as an integer code) is enabled
 
deprecated int OMQ::UserApi::audit_get_mask ()
 returns the audit event mask
 
deprecated int OMQ::UserApi::omqsleep (softint arg)
 puts the current thread to sleep for a certain number of seconds
 
deprecated int OMQ::UserApi::omqusleep (softint arg)
 puts the current thread to sleep for a certain number of microseconds
 
deprecated auto OMQ::UserApi::get_qorus_options (...)
 returns the value of the given system option or options
 
deprecated hash< auto > OMQ::UserApi::get_qorus_option_info (...)
 returns a hash giving information about system options
 
deprecated auto OMQ::UserApi::get_qorus_options_args (softlist args)
 returns the value of the given system option or options
 
deprecated hash< auto > OMQ::UserApi::get_qorus_option_info_args (softlist args)
 returns a hash giving information about system options
 
deprecated hash< auto > OMQ::UserApi::get_active_jobs ()
 Returns information on all active jobs visible to the calling user.
 
deprecated object OMQ::UserApi::get_user_connection (string name, bool connect=True, bool register_dependency=True, *hash< auto > rtopts)
 Returns an object corresponding to a defined user connection.
 
deprecated Qore::SQL::Datasource OMQ::UserApi::get_datasource_shared (string name, bool register_dependency=True)
 Returns a shared Datasource object with autocommit turned on from the given datasource name.
 
deprecated Qore::SQL::Datasource OMQ::UserApi::get_datasource_dedicated (string name, bool register_dependency=True)
 returns a new, dedicated Datasource object, suitable for transaction management for long-running transactions
 
deprecated AbstractDatasource OMQ::UserApi::get_datasource_pool (string name, bool register_dependency=True)
 returns a DatasourcePool object for the given datasource name
 
deprecated hash< auto > OMQ::UserApi::get_datasource_info (string name)
 returns a hash of information for the given datasource, if known, otherwise throws an exception
 
deprecated QorusSystemAPIHelper OMQ::UserApi::get_remote_rpc_connection (string name, bool connect=True, bool register_dependency=True)
 Returns a new QorusSystemAPIHelper object corresponding to a defined Qorus remote connection.
 
deprecated QorusSystemRestHelper OMQ::UserApi::get_remote_rest_connection (string name, bool connect=True, bool register_dependency=True)
 Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection.
 
deprecated OMQ::UserApi::raise_transient_alert (string alert, string reason, *hash info)
 raises a transient system alert from a workflow, service, or job
 
deprecated string OMQ::UserApi::qorus_get_local_url (*string username, *string password)
 returns a string giving the local system URL
 
deprecated OMQ::UserApi::set_option (hash< auto > hash)
 Changes option values on a workflow, service, or job.
 
deprecated auto OMQ::UserApi::get_option (...)
 Returns the value of the named workflow, service, or job option or options.
 
deprecated hash< auto > OMQ::UserApi::block_order (softint wfiid)
 block the given workflow order data instance
 
deprecated hash< auto > OMQ::UserApi::unblock_order (softint wfiid, *hash< auto > tempdata, *hash< auto > orderkeys)
 unblocks the given workflow order data instance
 
deprecated hash< auto > OMQ::UserApi::cancel_order (softint wfiid)
 cancel the given workflow order data instance
 
deprecated hash< auto > OMQ::UserApi::uncancel_order (softint wfiid, *hash< auto > tempdata)
 uncancels the given workflow order data instance
 
deprecated *hash< auto > OMQ::UserApi::get_user_context_info ()
 returns a hash for the current user context
 
deprecated auto OMQ::UserApi::get_global_config_item_value (string item)
 returns the value of the given global configuration item; throws an exception if no such global configuration item exists
 
deprecated auto OMQ::UserApi::get_global_config_item_value_with_default (string item, auto default_value)
 returns the value of the given global configuration item; throws an exception if no such global configuration item exists
 
deprecated Mapper::Mapper OMQ::UserApi::get_mapper (string name, *hash< auto > rtopts)
 returns the given mapper if registered for the current interface
 
deprecated Qore::AbstractIterator OMQ::UserApi::get_mapper_iterator (string name, Qore::AbstractIterator input, *hash rtopts)
 returns an iterator for the named mapper using the iterator argument for input
 
deprecated bool OMQ::UserApi::post_sync_event (string eventtype, string eventkey)
 posts a workflow synchronization event given the event type name and the unique event key
 
deprecated hash< auto > OMQ::UserApi::prop_get ()
 returns a hash of all system properties in all domains
 
deprecated *hash< auto > OMQ::UserApi::prop_get (string domain)
 returns a hash of all key-value pairs in the given domain or NOTHING if the system property domain does not exist
 
deprecated auto OMQ::UserApi::prop_get (string domain, string key)
 returns the value of the given system property key in the given domain or NOTHING if the system property does not exist
 
deprecated string OMQ::UserApi::prop_update (string domain, softstring key, auto value)
 changes (inserts, updates, or deletes) the value of a single system property
 
deprecated hash< auto > OMQ::UserApi::prop_update (hash< auto > h)
 changes (inserts, updates, or deletes) the value of one or more system properties according to a hash argument
 

Detailed Description

functions common to workflow, service, and job APIs