OMQ Namespace Reference

main Qorus system namespace More...

Namespaces
	UserApi
	user API namespace root

Classes
class	AbstractConnection
	abstract base class for user connection type More...
class	AbstractConnectionFileHelper
	this class is used to parse the connection files in the server and client More...
class	AbstractFtpHandler
	this class is used to customize and control the behavior of Qorus FTP servers attached to services More...
class	AbstractServiceDataStreamResponseHandler
	this class implements a request handler supporting the DataStream protocol for Qorus services and allows logging to the service log file More...
class	AbstractServiceHttpHandler
	this class is used to customize and control the behavior of the Qorus HTTP server as it redirects URLs to services More...
class	AbstractServiceRestHandler
	this class is used to customize and control the behavior of the Qorus HTTP server as it redirects URLs to Qorus services providing HTTP-based REST services More...
class	AbstractServiceStream
	class used for handling chunked requests and responses in services More...
class	AbstractServiceWebSocketHandler
	this class is used to allow Qorus services to provide dedicated WebSocket server services to external clients More...
class	ConnectionScheme
	defines the class of object returned by the "get_schemas()" function in custom user modules More...
class	DefaultQorusRBACAuthenticator
	this class does nothing in the client library; it is a placeholder for HttpServer::AbstractAuthenticator More...
class	ErrorDef
	class that defines error attributes More...
class	FilesystemConnection
	class for filesystem connections; returns an object of type Qore::Dir; this can be used to monitor filesystem free space or to ensure a network filesystem is mounted, for example More...
class	FtpConnection
	class for FTP connections; returns Qore::FtpClient objects More...
class	HttpConnection
	class for HTTP connections; returns Qore::HTTPClient objects More...
class	JobDef
	class that defines job attributes More...
class	JobProgram
	used to create job program objects (client & server) More...
class	JsonRpcConnection
	class for JSON-RPC connections; returns Qore::Json::JsonRpcClient objects More...
class	Map
	a class to be used to give object properties to a hash More...
class	Pop3Connection
	class for POP3 connections; returns an object of class Pop3Client::Pop3Client for receiving or polling for emails More...
class	QorusExtensionHandler
	this class is used to define a Qorus UI extension in a Qorus service More...
class	QorusHttpRequestHandler
	helper class for consistent auditing and logging from system HTTP handlers; this class has a different implementation in the server More...
class	QorusProgram
	base class for Qorus program classes, where the parse options are reset after each object is parsed More...
class	QorusRemoteServiceHelper
	top-level class for transparently redirecting calls to services More...
class	QorusServiceHelper
	mid-level class representing a service type (either "user" or "system") for transparently redirecting calls to services; this class is not designed to be used directly; use OMQ::QorusRemoteServiceHelper instead More...
class	QorusSystemAPIHelper
	class used to call the Qorus system API for a remote Qorus instance through the network API More...
class	QorusSystemAPIHelperBase
	This class provides an easy way to call Qorus API functions using the network API. More...
class	QorusSystemRestHelper
	class used to call the Qorus REST API for a remote Qorus instance More...
class	QorusSystemRestHelperBase
	base class for accessing the system REST API More...
class	QorusSystemServiceHelper
	top-level class that allows transparent auto-loading and access to Qorus system and user services; do not instantiate this class directly; use the global $omqservice object instead More...
class	QorusWebSocketConnection
	this wrapsr WebSocketHandler::WebSocketConnection so that service programs to not have to import the entire WebSocketHandler module to access the connection class More...
class	RestConnection
	class for REST HTTP connections; returns RestClient::RestClient objects More...
class	ServiceGate
	ServiceGate allows autoloading of Qorus services on reference; this class is not designed to be used directly; use $omqservice instead. More...
class	ServiceLogBase
	base class for objects that capture a service context for logging More...
class	ServiceMethodGate
	ServiceMethodGate provides a gateway to service methods; this class is not designed to be used directly; use $omqservice instead. More...
class	ServiceMethodGateHelper
	this class provides an easy way to call service methods on a Qorus server; this class is not designed to be used directly; use OMQ::QorusRemoteServiceHelper instead More...
class	ServiceProgram
	used to create service program objects (client & server) More...
class	SftpConnection
	class for SFTP connections; returns an object of class Qore::SSH2::SFTPClient for acquiring files from or posting files to SFTP servers More...
class	SmtpConnection
	class for SMTP connections; returns an object of class SmtpClient::SmtpClient for sending emails More...
class	SoapConnection
	class for SOAP connections; returns an object of class SoapClient::SoapClient for connecting to SOAP servers More...
class	TelnetConnection
	class for Telnet connections; returns an object of class TelnetClient::TelnetClient for connecting to telnet sessions More...
class	UserWebSocketConnection
	class for websocket connections; returns an object of class WebSocketClient::WebSocketClient for receiving websocket events from a websocket server More...
class	WorkflowDef
	class that defines workflow attributes More...
class	WorkflowProgram
	used to create workflow program objects (client & server) More...
class	XmlRpcConnection
	class for XML-RPC connections; returns Qore::Xml::XmlRpcClient objects More...
class	YamlRpcConnection
	class for YAML-RPC connections; returns YamlRpcClient::YamlRpcClient objects More...

Variables
public const	DefaultServerPort = 8001
	the default server port for Qorus servers if no other port is defined
public const	OT_CONSTANT = "CONSTANT"
	for constant library objects
public const	OT_CLASS = "CLASS"
	for class library objects
public const	OT_FUNCTION = "FUNCTION"
	for function library objects
public const	MinSystemServiceVersion
	hash giving minimum versions of system services
public const	MinSystemDBDriverVersion
	hash giving minimum driver versions for the system ("omq") datasource
public const	CommonAPI
	list of functions common to workflow and service programs
public const	WorkflowAPI
	list of functions specific to workflow programs
public const	WorkflowParseOptions = PO_REQUIRE_OUR|PO_NO_TOP_LEVEL_STATEMENTS|PO_NO_THREAD_CONTROL|PO_NO_PROCESS_CONTROL|PO_NO_GLOBAL_VARS|PO_NO_INHERIT_USER_FUNC_VARIANTS|PO_NO_INHERIT_GLOBAL_VARS|PO_NO_USER_CLASSES
	workflow programs will have the following parse options
public const	workflowParseOptions = WorkflowParseOptions
	backwards-compatible definition
public const	QorusServerDefines = ("Qorus", "QorusServer", "QorusHasUserConnections", "QorusHasAlerts")
	defines for all Qorus user code
public const	QorusWorkflowDefines = QorusServerDefines + "QorusWorkflow"
	defines for workflow programs
public const	QorusServiceDefines = QorusServerDefines + ("QorusService", "QorusHasHttpUserIndex")
	defines for service programs
public const	QorusJobDefines = QorusServerDefines + "QorusJob"
	defines for job programs
public const	FT_Step = "STEP"
	step function type
public const	FT_Generic = "GENERIC"
	generic function type
public const	FT_AsyncStart = "ASYNC-START"
	async start function type for async steps
public const	FT_AsyncEnd = "ASYNC-END"
	async end function type for async steps
public const	FT_Validation = "VALIDATION"
	validation function type
public const	FT_Array = "ARRAY"
	array function type
public const	FT_Subworkflow = "SUBWORKFLOW"
	subworkflow function type
public const	AllFunctionTypes = (FT_Step, FT_Generic, FT_AsyncStart, FT_AsyncEnd, FT_Validation, FT_Array, FT_Subworkflow)
	list of all valid function types
public const	ExecNormal = "NORMAL"
	step attribute: for normal steps
public const	ExecAsync = "ASYNC"
	step attribute: for async steps
public const	ExecSubWorkflow = "SUBWORKFLOW"
	step attribute: for subworkflow steps
public const	ExecEvent = "EVENT"
	step attribute: for synchronization event steps
public const	ArrayNone = "NONE"
	array type: for non-array steps
public const	ArraySeries = "SERIES"
	array type: executed in series (only valid array type)
public const	ArrayParallel = "PARALLEL"
	array type: executed in parallel (not implemented; do not use)
public const	ServiceAPI
	list of functions imported into service program objects
public const	SystemServiceAPI
	list of functions imported into only into system service program objects
public const	SSRunning = "running"
	service status: running
public const	SSLoaded = "loaded"
	service status: running
public const	SLNone = "none"
	service lock type: none
public const	SLRead = "read"
	service lock type: read
public const	SLWrite = "write"
	service lock type: write
public const	AllSLTypes = (SLNone, SLRead, SLWrite)
	list of all service lock types
public const	ServiceParseOptions = PO_REQUIRE_OUR|PO_NO_TOP_LEVEL_STATEMENTS|PO_NO_THREAD_CONTROL|PO_NO_PROCESS_CONTROL|PO_NO_INHERIT_USER_FUNC_VARIANTS|PO_NO_INHERIT_GLOBAL_VARS|PO_NO_USER_CLASSES
	services will have the following parse options
public const	serviceParseOptions = ServiceParseOptions
	backwards-compatible definition
public const	SystemServiceParseOptions = 0
	system services additionally have the following parse options
public const	systemServiceParseOptions = SystemServiceParseOptions
	backwards-compatible definition
public const	WISInitializing = "initializing"
	workflow instance status: initializing
public const	WISRunning = "running"
	workflow instance status: running
public const	WISWaiting = "waiting"
	workflow instance status: waiting
public const	WISStopping = "stopping"
	workflow instance status: stopping
public const	StatComplete = "COMPLETE"
	This status indicates that the object it is attached to has successfully completed its processing. More...
public const	StatError = "ERROR"
	Indicates that the workflow order data instance has at least one step with an OMQ::StatError status. More...
public const	StatWaiting = "WAITING"
	Indicates that subworkflow steps are in progress and the system is waiting on the subworkflows to become OMQ::StatComplete. More...
public const	StatInProgress = "IN-PROGRESS"
	Indicates that the workflow order data instance is currently being processed. More...
public const	StatIncomplete = "INCOMPLETE"
	Indicates that processing for the workflow order data instance is not yet complete yet has no errors. More...
public const	StatAsyncWaiting = "ASYNC-WAITING"
	Indicates that asynchronous steps are in process and the system is waiting on data to become available in the queue assigned to the step. More...
public const	StatEventWaiting = "EVENT-WAITING"
	Indicates that one or more workflow event synchronization steps are in progress and the workflow is waiting for the event(s) to be posted. More...
public const	StatRetry = "RETRY"
	Indicates that workflow processing on the order data instance has generated an error and is now waiting for an automatic retry. More...
public const	StatCanceled = "CANCELED"
	Indicates that workflow order data instance processing has been canceled. More...
public const	StatReady = "READY"
	Indicates that a workflow order data instance has been created and is waiting for processing to start. More...
public const	StatScheduled = "SCHEDULED"
	Indicates that a workflow order data instance has been created and has not yet been processed because at the time the order was created, the scheduled date (the earliest possible processing date) was in the future. More...
public const	StatBlocked = "BLOCKED"
	Indicates that workflow order data instance processing has been temporarily blocked. More...
public const	SQLStatComplete = "C"
	SQL Status: COMPLETE. More...
public const	SQLStatError = "E"
	SQL Status: ERROR. More...
public const	SQLStatWaiting = "W"
	SQL Status: WAITING. More...
public const	SQLStatInProgress = "I"
	SQL Status: IN-PROGRESS. More...
public const	SQLStatIncomplete = "N"
	SQL Status: INCOMPLETE. More...
public const	SQLStatAsyncWaiting = "A"
	SQL Status: ASYNC-WAITING. More...
public const	SQLStatEventWaiting = "V"
	SQL Status: EVENT-WAITING. More...
public const	SQLStatRetry = "R"
	SQL Status: RETRY. More...
public const	SQLStatCanceled = "X"
	SQL Status: CANCELED. More...
public const	SQLStatReady = "Y"
	SQL Status: READY. More...
public const	SQLStatScheduled = "S"
	SQL Status: SCHEDULED. More...
public const	SQLStatBlocked = "B"
	SQL Status: BLOCKED. More...
public const	StatMap
	map from text descriptions to SQL status characters
public const	SQLStatMap
	hash mapping SQL status characters to text descriptions
public const	ES_Fatal = "FATAL"
	Error Severity: FATAL.
public const	ES_Major = "MAJOR"
	Error Severity: MAJOR.
public const	ES_Minor = "MINOR"
	Error Severity: MINOR, identical in function to WARNING and INFO.
public const	ES_Warning = "WARNING"
	Error Severity: WARNING, identical in function to MINOR and INFO.
public const	ES_Info = "INFO"
	Error Severity: INFO, identical in function to WARNING and MINOR.
public const	ES_None = "NONE"
	Error Severity: NONE.
public const	ErrorSeverityOrder
	map giving the relative importance of each error code
public const	ErrorSeverityMap
	map from error importance rankings to codes
public const	ErrLevelAuto = "AUTO"
	auto level: global if no global error exists, workflow if a global exists and differs from the current definition More...
public const	ErrLevelGlobal = "GLOBAL"
	global level: the error will be created at the global level More...
public const	ErrLevelWorkflow = "WORKFLOW"
	workflow level: the error will always be created at the workflow level More...
public const	ErrLevelTypes
	oload error definition level type hash
public const	WM_Normal = "NORMAL"
	Workflow Mode: NORMAL.
public const	WM_Recovery = "RECOVERY"
	Workflow Mode: RECOVERY.
public const	WM_Synchronous = "SYNCHRONOUS"
	Workflow Mode: SYNCHRONOUS.
public const	LL_CRITICAL = -1
	Log Level: CRITICAL.
public const	LL_IMPORTANT = 0
	Log Level: IMPORTANT.
public const	LL_INFO = 1
	Log Level: INFO.
public const	LL_DETAIL_1 = 2
	Log Level: DETAIL_1.
public const	LL_DETAIL_2 = 3
	Log Level: DETAIL_2.
public const	LL_DEBUG_1 = 4
	Log Level: DEBUG_1.
public const	LL_DEBUG_2 = 5
	Log Level: DEBUG_2.
public const	LL_DEBUG_3 = 6
	Log Level: DEBUG_3.
public const	StatusOrder
	map giving the relative ranking of status codes (text code -> numeric ranking)
public const	SpecialStatusOrder
	map giving the relative ranking of status codes (text code -> numeric ranking), including IN-PROGRESS
public const	ArrayStatusOrder
	map giving the relative ranking of status codes (text code -> numeric ranking), for calculating array step status
public const	QS_Waiting = "WAITING"
	Queue Status Text Description: WAITING. More...
public const	QS_Received = "RECEIVED"
	Queue Status Text Description: RECEIVED. More...
public const	QS_Error = "ERROR"
	Queue Status Text Description: ERROR. More...
public const	QS_Used = "USED"
	Queue Status Text Description: USED. More...
public const	QS_ALL = ( QS_Waiting, QS_Received, QS_Error, QS_Used )
	list of all queue status descriptions
public const	SQL_QS_Waiting = "W"
	Queue Status SQL Character Code: WAITING. More...
public const	SQL_QS_Received = "R"
	Queue Status SQL Character Code: RECEIVED. More...
public const	SQL_QS_Error = "E"
	Queue Status SQL Character Code: ERROR. More...
public const	SQL_QS_Used = "X"
	Queue Status SQL Character Code: USED. More...
public const	SQL_QS_ALL = ( SQL_QS_Waiting, SQL_QS_Received, SQL_QS_Error, SQL_QS_Used )
	list of all queue status character codes
public const	QSMap
	map of queue status descriptions to the character code
public const	SQLQSMap
	map of queue status character codes to the description
public const	omq_option_aliases
	Qorus server option alias hash.
public const	QR_LOGIN = "LOGIN"
	RBAC System Permission: "LOGIN". More...
public const	QR_SHUTDOWN = "SHUTDOWN"
	RBAC System Permission: "SHUTDOWN". More...
public const	QR_WORKFLOW_CONTROL = "WORKFLOW-CONTROL"
	RBAC System Permission: "WORKFLOW-CONTROL". More...
public const	QR_WORKFLOW_EXEC_CONTROL = "WORKFLOW-EXEC-CONTROL"
	RBAC System Permission: "WORKFLOW-EXEC-CONTROL". More...
public const	QR_START_WORKFLOW = "START-WORKFLOW"
	RBAC System Permission: "START-WORKFLOW". More...
public const	QR_STOP_WORKFLOW = "STOP-WORKFLOW"
	RBAC System Permission: "STOP-WORKFLOW". More...
public const	QR_RESET_WORKFLOW = "RESET-WORKFLOW"
	RBAC System Permission: "RESET-WORKFLOW". More...
public const	QR_WORKFLOW_OPTION_CONTROL = "WORKFLOW-OPTION-CONTROL"
	RBAC System Permission: "WORKFLOW-OPTION-CONTROL". More...
public const	QR_WORKFLOW_ERROR_CONTROL = "WORKFLOW-ERROR-CONTROL"
	RBAC System Permission: "WORKFLOW-ERROR-CONTROL". More...
public const	QR_WORKFLOW_ORDER_CONTROL = "WORKFLOW-ORDER-CONTROL"
	RBAC System Permission: "WORKFLOW-ORDER-CONTROL". More...
public const	QR_RETRY_WORKFLOW_ORDER = "RETRY-WORKFLOW-ORDER"
	RBAC System Permission: "RETRY-WORKFLOW-ORDER". More...
public const	QR_RESCHEDULE_WORKFLOW_ORDER = "RESCHEDULE-WORKFLOW-ORDER"
	RBAC System Permission: "RESCHEDULE-WORKFLOW-ORDER". More...
public const	QR_REPRIORITIZE_WORKFLOW_ORDER = "REPRIORITIZE-WORKFLOW-ORDER"
	RBAC System Permission: "REPRIORITIZE-WORKFLOW-ORDER". More...
public const	QR_BLOCK_WORKFLOW_ORDER = "BLOCK-WORKFLOW-ORDER"
	RBAC System Permission: "BLOCK-WORKFLOW-ORDER". More...
public const	QR_CANCEL_WORKFLOW_ORDER = "CANCEL-WORKFLOW-ORDER"
	RBAC System Permission: "CANCEL-WORKFLOW-ORDER". More...
public const	QR_SET_WORKFLOW_ORDER_ERROR = "SET-WORKFLOW-ORDER-ERROR"
	RBAC System Permission: "SET-WORKFLOW-ORDER-ERROR". More...
public const	QR_SKIP_STEP = "SKIP-STEP"
	RBAC System Permission: "SKIP-STEP". More...
public const	QR_SET_ORDER_INFO = "SET-ORDER-INFO"
	RBAC System Permission: "SET-ORDER-INFO". More...
public const	QR_POST_WORKFLOW_EVENT = "POST-WORKFLOW-EVENT"
	RBAC System Permission: "POST-WORKFLOW-EVENT". More...
public const	QR_LOCK_WORKFLOW_ORDER = "LOCK-WORKFLOW-ORDER"
	RBAC System Permission: "LOCK-WORKFLOW-ORDER". More...
public const	QR_BREAK_WORKFLOW_ORDER_LOCK = "BREAK-WORKFLOW-ORDER-LOCK"
	RBAC System Permission: "BREAK-WORKFLOW-ORDER-LOCK". More...
public const	QR_EDIT_WORKFLOW_DATA = "EDIT-WORKFLOW-DATA"
	RBAC System Permission: "EDIT-WORKFLOW-DATA". More...
public const	QR_EXEC_SYNC_WORKFLOW = "EXEC-SYNC-WORKFLOW"
	RBAC System Permission: "EXEC-SYNC-WORKFLOW". More...
public const	QR_SUBMIT_ORDER = "SUBMIT-ORDER"
	RBAC System Permission: "SUBMIT-ORDER". More...
public const	QR_SERVICE_CONTROL = "SERVICE-CONTROL"
	RBAC System Permission: "SERVICE-CONTROL". More...
public const	QR_LOAD_SERVICE = "LOAD-SERVICE"
	RBAC System Permission: "LOAD-SERVICE". More...
public const	QR_UNLOAD_SERVICE = "UNLOAD-SERVICE"
	RBAC System Permission: "UNLOAD-SERVICE". More...
public const	QR_RESET_SERVICE = "RESET-SERVICE"
	RBAC System Permission: "RESET-SERVICE". More...
public const	QR_SET_SERVICE_AUTOSTART = "SET-SERVICE-AUTOSTART"
	RBAC System Permission: "SET-SERVICE-AUTOSTART". More...
public const	QR_SET_SERVICE_OPTIONS = "SET-SERVICE-OPTIONS"
	RBAC System Permission: "SET-SERVICE-OPTIONS". More...
public const	QR_CALL_USER_SERVICES_RO = "CALL-USER-SERVICES-RO"
	RBAC System Permission: "CALL-USER-SERVICES-RO". More...
public const	QR_CALL_SYSTEM_SERVICES_RO = "CALL-SYSTEM-SERVICES-RO"
	RBAC System Permission: "CALL-SYSTEM-SERVICES-RO". More...
public const	QR_CALL_USER_SERVICES_RW = "CALL-USER-SERVICES-RW"
	RBAC System Permission: "CALL-USER-SERVICES-RW". More...
public const	QR_CALL_SYSTEM_SERVICES_RW = "CALL-SYSTEM-SERVICES-RW"
	RBAC System Permission: "CALL-SYSTEM-SERVICES-RW". More...
public const	QR_USER_CONTROL = "USER-CONTROL"
	RBAC System Permission: "USER-CONTROL". More...
public const	QR_RELOAD_RBAC = "RELOAD-RBAC"
	RBAC System Permission: "RELOAD-RBAC". More...
public const	QR_ADD_USER = "ADD-USER"
	RBAC System Permission: "ADD-USER". More...
public const	QR_MODIFY_USER = "MODIFY-USER"
	RBAC System Permission: "MODIFY-USER". More...
public const	QR_DELETE_USER = "DELETE-USER"
	RBAC System Permission: "DELETE-USER". More...
public const	QR_ADD_PERMISSION = "ADD-PERMISSION"
	RBAC System Permission: "ADD-PERMISSION". More...
public const	QR_MODIFY_PERMISSION = "MODIFY-PERMISSION"
	RBAC System Permission: "MODIFY-PERMISSION". More...
public const	QR_DELETE_PERMISSION = "DELETE-PERMISSION"
	RBAC System Permission: "DELETE-PERMISSION". More...
public const	QR_ADD_ROLE = "ADD-ROLE"
	RBAC System Permission: "ADD-ROLE". More...
public const	QR_MODIFY_ROLE = "MODIFY-ROLE"
	RBAC System Permission: "MODIFY-ROLE". More...
public const	QR_DELETE_ROLE = "DELETE-ROLE"
	RBAC System Permission: "DELETE-ROLE". More...
public const	QR_OPTION_CONTROL = "OPTION-CONTROL"
	RBAC System Permission: "OPTION-CONTROL". More...
public const	QR_ROTATE_LOG_FILES = "ROTATE-LOG-FILES"
	RBAC System Permission: "ROTATE-LOG-FILES". More...
public const	QR_DATASOURCE_CONTROL = "DATASOURCE-CONTROL"
	RBAC System Permission: "DATASOURCE-CONTROL". More...
public const	QR_READ_DATASOURCE = "READ-DATASOURCE"
	RBAC System Permission: "READ-DATASOURCE". More...
public const	QR_ADD_DATASOURCE = "ADD-DATASOURCE"
	RBAC System Permission: "ADD-DATASOURCE". More...
public const	QR_SELECT_DATASOURCE = "SELECT-DATASOURCE"
	RBAC System Permission: "SELECT-DATASOURCE". More...
public const	QR_MODIFY_DATASOURCE = "MODIFY-DATASOURCE"
	RBAC System Permission: "MODIFY-DATASOURCE". More...
public const	QR_RESET_DATASOURCE = "RESET-DATASOURCE"
	RBAC System Permission: "RESET-DATASOURCE". More...
public const	QR_DELETE_DATASOURCE = "DELETE-DATASOURCE"
	RBAC System Permission: "DELETE-DATASOURCE". More...
public const	QR_RELOAD_DATASOURCE = "RELOAD-DATASOURCE"
	RBAC System Permission: "RELOAD-DATASOURCE". More...
public const	QR_FLUSH_DATASOURCE = "FLUSH-DATASOURCE"
	RBAC System Permission: "FLUSH-DATASOURCE". More...
public const	QR_SQLUTIL_READ = "SQLUTIL-READ"
	RBAC System Permission: "SQLUTIL-READ". More...
public const	QR_SQLUTIL_WRITE = "SQLUTIL-WRITE"
	RBAC System Permission: "SQLUTIL-WRITE". More...
public const	QR_GROUP_CONTROL = "GROUP-CONTROL"
	RBAC System Permission: "GROUP-CONTROL". More...
public const	QR_ADD_GROUP = "ADD-GROUP"
	RBAC System Permission: "ADD-GROUP". More...
public const	QR_MODIFY_GROUP = "MODIFY-GROUP"
	RBAC System Permission: "MODIFY-GROUP". More...
public const	QR_DELETE_GROUP = "DELETE-GROUP"
	RBAC System Permission: "DELETE-GROUP". More...
public const	QR_MODIFY_GROUP_STATUS = "MODIFY-GROUP-STATUS"
	RBAC System Permission: "MODIFY-GROUP-STATUS". More...
public const	QR_SERVER_CONTROL = "SERVER-CONTROL"
	RBAC System Permission: "SERVER-CONTROL". More...
public const	QR_SET_PROPERTY = "SET-PROPERTY"
	RBAC System Permission: "SET-PROPERTY". More...
public const	QR_DELETE_PROPERTY = "DELETE-PROPERTY"
	RBAC System Permission: "DELETE-PROPERTY". More...
public const	QR_RELOAD_PROPERTIES = "RELOAD-PROPERTIES"
	RBAC System Permission: "RELOAD-PROPERTIES". More...
public const	QR_START_LISTENER = "START-LISTENER"
	RBAC System Permission: "START-LISTENER". More...
public const	QR_STOP_LISTENER = "STOP-LISTENER"
	RBAC System Permission: "STOP-LISTENER". More...
public const	QR_JOB_CONTROL = "JOB-CONTROL"
	RBAC System Permission: "JOB-CONTROL". More...
public const	QR_RUN_JOB = "RUN-JOB"
	RBAC System Permission: "RUN-JOB". More...
public const	QR_MODIFY_JOB_STATUS = "MODIFY-JOB-STATUS"
	RBAC System Permission: "MODIFY-JOB-STATUS". More...
public const	QR_MODIFY_JOB_EXPIRY = "MODIFY-JOB-EXPIRY"
	RBAC System Permission: "MODIFY-JOB-EXPIRY". More...
public const	QR_RESCHEDULE_JOB = "RESCHEDULE-JOB"
	RBAC System Permission: "RESCHEDULE-JOB". More...
public const	QR_RESET_JOB = "RESET-JOB"
	RBAC System Permission: "RESET-JOB". More...
public const	QR_SET_JOB_OPTIONS = "SET-JOB-OPTIONS"
	RBAC System Permission: "SET-JOB-OPTIONS". More...
public const	QR_SCHEMA_CONTROL = "SCHEMA-CONTROL"
	RBAC System Permission: "SCHEMA-CONTROL". More...
public const	QR_USER_CONNECTION_CONTROL = "USER-CONNECTION-CONTROL"
	RBAC System Permission: "USER-CONNECTION-CONTROL". More...
public const	QR_READ_USER_CONNECTION = "READ-USER-CONNECTION"
	RBAC System Permission: "READ-USER-CONNECTION". More...
public const	QR_RELOAD_USER_CONNECTION = "RELOAD-USER-CONNECTION"
	RBAC System Permission: "RELOAD-USER-CONNECTION". More...
public const	QR_ADD_USER_CONNECTION = "ADD-USER-CONNECTION"
	RBAC System Permission: "ADD-USER-CONNECTION". More...
public const	QR_MODIFY_USER_CONNECTION = "MODIFY-USER-CONNECTION"
	RBAC System Permission: "MODIFY-USER-CONNECTION". More...
public const	QR_DELETE_USER_CONNECTION = "DELETE-USER-CONNECTION"
	RBAC System Permission: "DELETE-USER-CONNECTION". More...
public const	QR_SERVER_CONNECTION_CONTROL = "SERVER-CONNECTION-CONTROL"
	RBAC System Permission: "SERVER-CONNECTION-CONTROL". More...
public const	QR_RELOAD_SERVER_CONNECTION = "RELOAD-SERVER-CONNECTION"
	RBAC System Permission: "RELOAD-SERVER-CONNECTION". More...
public const	QR_READ_SERVER_CONNECTION = "READ-SERVER-CONNECTION"
	RBAC System Permission: "READ-SERVER-CONNECTION". More...
public const	QR_FILESYSTEM_CONTROL = "FILESYSTEM-CONTROL"
	RBAC System Permission: "FILESYSTEM-CONTROL". More...
public const	QR_FILESYSTEM_READ = "FILESYSTEM-READ"
	RBAC System Permission: "FILESYSTEM-READ". More...
public const	QR_FILESYSTEM_WRITE = "FILESYSTEM-WRITE"
	RBAC System Permission: "FILESYSTEM-WRITE". More...
public const	AUTH_OVERRIDE_ERROR = 1001
	RBAC Authorization Error Code.
public const	AUTH_INVALID_USER_OR_PASSWORD = 1002
	RBAC Authorization Error Code.
public const	AUTH_UNAUTHORIZED = 1003
	RBAC Authorization Error Code.
public const	AUTH_REQUIRES_AUTHORIZATION = 1004
	RBAC Authorization Error Code.
public const	AUTH_INVALID_USERNAME = 1005
	RBAC Authorization Error Code.
public const	AUTH_USER_ALREADY_EXISTS = 1006
	RBAC Authorization Error Code.
public const	AUTH_INVALID_PERMISSION = 1007
	RBAC Authorization Error Code.
public const	AUTH_INVALID_USER = 1008
	RBAC Authorization Error Code.
public const	AUTH_MISSING_USERNAME = 1009
	RBAC Authorization Error Code.
public const	AUTH_MISSING_DESCRIPTION = 1010
	RBAC Authorization Error Code.
public const	AUTH_MISSING_PERMISSION = 1011
	RBAC Authorization Error Code.
public const	AUTH_MISSING_ROLE = 1012
	RBAC Authorization Error Code.
public const	AUTH_INVALID_ROLE = 1013
	RBAC Authorization Error Code.
public const	AUTH_ROLE_ALREADY_EXISTS = 1014
	RBAC Authorization Error Code.
public const	AUTH_PERMISSION_ALREADY_EXISTS = 1015
	RBAC Authorization Error Code.
public const	AUTH_CANNOT_UPDATE_SYSTEM_PERMISSION = 1016
	RBAC Authorization Error Code.
public const	AUTH_CANNOT_DELETE_PERMISSION_IN_USE = 1017
	RBAC Authorization Error Code.
public const	AUTH_INVALID_GROUP = 1018
	RBAC Authorization Error Code.
public const	AUTH_INVALID_WORKFLOW = 1019
	RBAC Authorization Invalid Workflow Error Code.
public const	AUTH_INVALID_SERVICE = 1020
	RBAC Authorization Invalid Service Error Code.
public const	AUTH_INVALID_JOB = 1021
	RBAC Authorization Invalid Workflow Error Code.
public const	AUTH_NO_SUCH_ROLE = 1022
	RBAC Authorization Error Code.
public const	XMLRPC_INVALID_XML = 2001
	error code for invalid XML revied by the XML-RPC handler
public const	QEM_FILTER_CRITERIA_HASH
	valid event filter criteria code hash
public const	QEM_FILTER_CRITERIA = QEM_FILTER_CRITERIA_HASH.keys()
	valid event filter criteria code list
public const	QE_CLASS_SYSTEM = 101
	Event Class Code for SYSTEM Events.
public const	QE_CLASS_WORKFLOW = 102
	Event Class Code for WORKFLOW Events.
public const	QE_CLASS_SERVICE = 103
	Event Class Code for SERVICE Events.
public const	QE_CLASS_USER = 104
	Event Class Code for USER Events.
public const	QE_CLASS_JOB = 105
	Event Class Code for JOB Events.
public const	QE_CLASS_ALERT = 106
	Event Class Code for ALERT Events.
public const	QE_CLASS_GROUP = 107
	Event Class Code for GROUP Events.
public const	QE_CLASS_CONNECTION = 108
	Event Class Code for CONNECTION events.
public const	QE_MAP_CLASS
	hash mapping event class codes to descriptive strings
public const	QE_RMAP_CLASS
	hash mapping event class descriptive strings to class codes
public const	QEC_SYSTEM_STARTUP = 1001
	Qorus Event Code: SYSTEM_STARTUP. More...
public const	QEC_SYSTEM_SHUTDOWN = 1002
	Qorus Event Code: SYSTEM_SHUTDOWN. More...
public const	QEC_SYSTEM_ERROR = 1003
	Qorus Event Code: SYSTEM_ERROR.
public const	QEC_SYSTEM_HEALTH_CHANGED = 1004
	Qorus Event Code: SYSTEM_HEALTH_CHANGED.
public const	QEC_SYSTEM_REMOTE_HEALTH_CHANGED = 1005
	Qorus Event Code: SYSTEM_REMOTE_HEALTH_CHANGED.
public const	QEC_GROUP_STATUS_CHANGED = 1101
	Qorus Event Code: GROUP_STATUS_CHANGED.
public const	QEC_WORKFLOW_START = 2001
	Qorus Event Code: WORKFLOW_START. More...
public const	QEC_WORKFLOW_STOP = 2002
	Qorus Event Code: WORKFLOW_STOP. More...
public const	QEC_WORKFLOW_CACHE_RESET = 2003
	Qorus Event Code: WORKFLOW_CACHE_RESET.
public const	QEC_WORKFLOW_DATA_SUBMITTED = 2004
	Qorus Event Code: WORKFLOW_DATA_SUBMITTED. More...
public const	QEC_WORKFLOW_DATA_ERROR = 2005
	Qorus Event Code: WORKFLOW_DATA_ERROR.
public const	QEC_WORKFLOW_DATA_RELEASED = 2006
	Qorus Event Code: WORKFLOW_DATA_RELEASED (workflow detach event)
public const	QEC_WORKFLOW_DATA_CACHED = 2007
	Qorus Event Code: WORKFLOW_DATA_CACHED (workflow attach event)
public const	QEC_WORKFLOW_STATUS_CHANGED = 2009
	Qorus Event Code: WORKFLOW_STATUS_CHANGED. More...
public const	QEC_WORKFLOW_STEP_PERFORMANCE = 2010
	Qorus Event Code:: WORKFLOW_STEP_PERFORMANCE. More...
public const	QEC_WORKFLOW_PERFORMANCE = 2011
	Qorus Event Code:: WORKFLOW_PERFORMANCE. More...
public const	QEC_WORKFLOW_DATA_LOCKED = 2012
	Qorus Event Code: WORKFLOW_DATA_LOCKED. More...
public const	QEC_WORKFLOW_DATA_UNLOCKED = 2013
	Qorus Event Code: WORKFLOW_DATA_UNLOCKED. More...
public const	QEC_SERVICE_START = 3001
	Qorus Event Code: SERVICE_START. More...
public const	QEC_SERVICE_STOP = 3002
	Qorus Event Code: SERVICE_STOP. More...
public const	QEC_SERVICE_ERROR = 3003
	Qorus Event Code: SERVICE_ERROR.
public const	QEC_SERVICE_AUTOSTART_CHANGE = 3004
	Qorus Event Code: SERVICE_AUTOSTART_CHANGE.
public const	QEC_SERVICE_METHOD_PERFORMANCE = 3005
	Qorus Event Code:: SERVICE_METHOD_PERFORMANCE. More...
public const	QEC_JOB_START = 4001
	Qorus Event Code: JOB_START. More...
public const	QEC_JOB_STOP = 4002
	Qorus Event Code: JOB_STOP. More...
public const	QEC_JOB_ERROR = 4003
	Qorus Event Code: JOB_ERROR.
public const	QEC_JOB_INSTANCE_START = 4004
	Qorus Event Code: JOB_INSTANCE_START. More...
public const	QEC_JOB_INSTANCE_STOP = 4005
	Qorus Event Code: JOB_INSTANCE_STOP. More...
public const	QEC_ALERT_ONGOING_RAISED = 5006
	Qorus Event Code: ALERT_ONGOING_RAISED.
public const	QEC_ALERT_ONGOING_CLEARED = 5007
	Qorus Event Code: ALERT_ONGOING_CLEARED.
public const	QEC_ALERT_TRANSIENT_RAISED = 5008
	Qorus Event Code: ALERT_TRANSIENT_RAISED.
public const	QEC_CONNECTION_UP = 5101
	Qorus Event Code: CONNECTION_UP.
public const	QEC_CONNECTION_DOWN = 5102
	Qorus Event Code: CONNECTION_DOWN.
public const	QEC_USER_EVENT = 9001
	Qorus Event Code: USER_EVENT. More...
public const	QE_MAP_EVENT
	hash mapping event codes to descriptive strings
public const	QE_RMAP_EVENT
	hash mapping event descriptive strings to codes
public const	omq_option_hash
	master Qorus system option hash for all valid system options
public const	option_defaults
	default values for Qorus system options
public const	client_option_hash
	valid Qorus client options in the options file under domain "qorus-client" More...
public const	client_defaults
	the following are default values for options when no option is set in the option file
public const	qhaorder_option_hash
	valid options for the "qhaorder" program
public const	qhaorder_defaults
	defualt values for qhaorder options
public const	options_relations
	option information More...
public const	segment_options = ("async", "retry")
	valid segment options
public const	SQL_DEF_INIT_BLOCKSIZE = 200
	default SQL blocksize for the initial block for piecewise parallel SQL execution
public const	SQL_DEF_BLOCKSIZE = 5000
	default SQL blocksize when reading in new data to the WorkflowQueue
public const	DefaultEventTypeID = 0
	default system workflow synchronization event type ID
public const	DefaultEventKey = "OMQ-SYSTEM-DEFAULT-EVENT"
	default system workflow synchronization event key
public const	DefaultGroupID = 0
public const	DefaultGroupName = "DEFAULT"
	name of the default workflow and service group
public const	DefaultOrderPriority = 500
	default order priority
public const	SQLDescLen = 4000
	default description length in bytes for user objects
public const	SQLNameLen = 160
	length of name columns in bytes
public const	SQLAuthorLen = 240
	length of author columns in bytes
public const	SQLPatchLen = 80
	length of patch columns in bytes
public const	SQLVersionLen = 80
	length of version columns in bytes
public const	JS_Complete = "COMPLETE"
	Job Status Text Description: COMPLETE. More...
public const	JS_InProgress = "IN-PROGRESS"
	Job Status Text Description: IN-PROGRESS. More...
public const	JS_Error = "ERROR"
	Job Status Text Description: ERROR. More...
public const	JS_Crash = "CRASH"
	Job Status Text Description: CRASH. More...
public const	JS_ALL = ( JS_Complete, JS_InProgress, JS_Error, JS_Crash )
	list of all Job status descriptions
public const	SQL_JS_Complete = "C"
	Job Status SQL Character Code: COMPLETE. More...
public const	SQL_JS_InProgress = "I"
	Job Status SQL Character Code: IN-PROGRESS. More...
public const	SQL_JS_Error = "E"
	Job Status SQL Character Code: ERROR. More...
public const	SQL_JS_Crash = "Z"
	Job Status SQL Character Code: CRASH. More...
public const	SQL_JS_ALL = ( SQL_JS_Complete, SQL_JS_InProgress, SQL_JS_Error, SQL_JS_Crash )
	list of all Job status character codes
public const	JSMap
	map of Job status descriptions to the character code
public const	SQLJSMap
	map of Job status character codes to the description
public const	JobParseOptions = PO_REQUIRE_OUR|PO_NO_TOP_LEVEL_STATEMENTS|PO_NO_THREAD_CONTROL|PO_NO_PROCESS_CONTROL|PO_NO_INHERIT_USER_FUNC_VARIANTS|PO_NO_INHERIT_GLOBAL_VARS|PO_NO_USER_CLASSES
	job programs will have the following parse options
public const	JobAPI
	job programs have the following API
public const	AE_USER_EVENT = 1
	user event audit code More...
public const	AE_SYSTEM_STARTUP = 2
	system startup audit code More...
public const	AE_SYSTEM_SHUTDOWN = 3
	system shutdown audit code More...
public const	AE_SYSTEM_RECOVERY_START = 4
	system recovery start audit code More...
public const	AE_SYSTEM_RECOVERY_COMPLETE = 5
	system recovery complete audit code More...
public const	AE_WORKFLOW_STATUS_CHANGE = 6
	workflow status change audit code More...
public const	AE_WORKFLOW_START = 7
	workflow start audit code More...
public const	AE_WORKFLOW_STOP = 8
	workflow stop audit code More...
public const	AE_SERVICE_START = 9
	service start audit code More...
public const	AE_SERVICE_STOP = 10
	service stop audit code More...
public const	AE_JOB_START = 11
	job start audit code More...
public const	AE_JOB_STOP = 12
	job stop audit code More...
public const	AE_JOB_INSTANCE_START = 13
	job instance start audit code More...
public const	AE_JOB_INSTANCE_STOP = 14
	job instance stop audit code More...
public const	AE_API_CALL = 15
	api call audit code More...
public const	AE_JOB_RECOVERY = 16
	job recovery audit code More...
public const	AE_WORKFLOW_DATA_CREATED = 17
	workflow order data created audit code More...
public const	AE_ALERT_ONGOING_RAISED = 18
	ongoing alert raised audit code More...
public const	AE_ALERT_ONGOING_CLEARED = 19
	ongoing alert cleared audit code More...
public const	AE_ALERT_TRANSIENT_RAISED = 20
	transient alert raised audit code More...
public const	AE_SOURCE_FILE_LOADED = 21
	source file loaded into the system schema by oload More...
public const	AE_GROUP_STATUS_CHANGED = 22
	group status changed audit code More...
public const	AES_USER_EVENT = "USER-EVENT"
	user event audit code More...
public const	AES_SYSTEM_STARTUP = "SYSTEM-STARTUP"
	system startup audit code More...
public const	AES_SYSTEM_SHUTDOWN = "SYSTEM-SHUTDOWN"
	system shutdown audit code More...
public const	AES_SYSTEM_RECOVERY_START = "SYSTEM-RECOVERY-START"
	system recovery start audit code More...
public const	AES_SYSTEM_RECOVERY_COMPLETE = "SYSTEM-RECOVERY-COMPLETE"
	system recovery complete audit code More...
public const	AES_WORKFLOW_STATUS_CHANGE = "WORKFLOW-STATUS-CHANGE"
	workflow status change audit code More...
public const	AES_WORKFLOW_START = "WORKFLOW-START"
	workflow start audit code More...
public const	AES_WORKFLOW_STOP = "WORKFLOW-STOP"
	workflow stop audit code More...
public const	AES_SERVICE_START = "SERVICE-START"
	service start audit code More...
public const	AES_SERVICE_STOP = "SERVICE-STOP"
	service stop audit code More...
public const	AES_JOB_START = "JOB-START"
	job start audit code More...
public const	AES_JOB_STOP = "JOB-STOP"
	job stop audit code More...
public const	AES_JOB_INSTANCE_START = "JOB-INSTANCE-STOP"
	job instance start audit code More...
public const	AES_JOB_INSTANCE_STOP = "JOB-INSTANCE-START"
	job instance stop audit code More...
public const	AES_API_CALL = "API-CALL"
	api call audit code More...
public const	AES_JOB_RECOVERY = "JOB-RECOVERY"
	job recovery audit code More...
public const	AES_WORKFLOW_DATA_CREATED = "WORKFLOW-DATA-CREATED"
	workflow order data created audit code More...
public const	AES_ALERT_ONGOING_RAISED = "ALERT-ONGOING-RAISED"
	ongoing alert raised audit code More...
public const	AES_ALERT_ONGOING_CLEARED = "ALERT-ONGOING-CLEARED"
	ongoing alert cleared audit code More...
public const	AES_ALERT_TRANSIENT_RAISED = "ALERT-TRANSIENT-RAISED"
	transient alert raised audit code More...
public const	AES_SOURCE_FILE_LOADED = "SOURCE-FILE-LOADED"
	source file loaded into the system schema by oload audit code More...
public const	AES_GROUP_STATUS_CHANGED = "GROUP-STATUS-CHANGED"
	group status changed audit code More...
public const	AuditEventMap
	map of audit event codes to descriptions
public const	AuditEventCodeMap
	map of audit event descriptions to codes
public const	AO_SYSTEM = "system"
	Audit option: system events. More...
public const	AO_WORKFLOWS = "workflows"
	Audit option: workflow events. More...
public const	AO_WORKFLOW_DATA = "workflow-data"
	Audit option: workflow data events. More...
public const	AO_JOBS = "jobs"
	Audit option: job events. More...
public const	AO_JOB_DATA = "job-data"
	Audit option: job data events. More...
public const	AO_SERVICES = "services"
	Audit option: service events. More...
public const	AO_API = "api"
	Audit option: api write events. More...
public const	AO_USER_EVENTS = "user-events"
	Audit option: user events. More...
public const	AO_OLOAD_EVENTS = "oload"
	Audit option: oload events. More...
public const	AO_ALERT_EVENTS = "alerts"
	Audit option: alert events. More...
public const	AO_GROUP_EVENTS = "groups"
	Audit option: RBAC interface group events. More...
public const	AuditOptionList
	list of all audit options
public const	AOC_SYSTEM = (1 << 0)
	Audit option code: system events. More...
public const	AOC_WORKFLOWS = (1 << 1)
	Audit option code: workflow events.
public const	AOC_WORKFLOW_DATA = (1 << 2)
	Audit option code: workflow data events.
public const	AOC_JOBS = (1 << 3)
	Audit option code: job events.
public const	AOC_JOB_DATA = (1 << 4)
	Audit option code: job data events.
public const	AOC_SERVICES = (1 << 5)
	Audit option code: service events.
public const	AOC_API = (1 << 6)
	Audit option code: api write events.
public const	AOC_USER_EVENTS = (1 << 7)
	Audit option code: user events.
public const	AOC_OLOAD_EVENTS = (1 << 8)
	Audit option code: oload events. More...
public const	AOC_ALERT_EVENTS = (1 << 9)
	Audit option code: alert events. More...
public const	AOC_GROUP_EVENTS = (1 << 10)
	Audit option code: RBAC interface group events. More...
public const	AuditMask = (AOC_SYSTEM|AOC_WORKFLOWS|AOC_WORKFLOW_DATA|AOC_JOBS|AOC_JOB_DATA|AOC_SERVICES|AOC_API|AOC_USER_EVENTS|AOC_OLOAD_EVENTS|AOC_ALERT_EVENTS|AOC_GROUP_EVENTS)
	mask of all audit options
public const	AuditOptionMap
	map of audit options to audit codes
public const	AuditCodeMap
	map of audit codes to audit options
public const	UiExtensionRoot = "UIExtension"
	Root part of UI extension URL paths.
public const	ORDER_INSTANCE_KEYS_KEY_LEN = 240
	byte length of the order_instance_keys keyname column
public const	ORDER_INSTANCE_KEYS_VALUE_LEN = 4000
	byte length of the order_instance_keys value column
public const	SysTagSource = "_source"
	source tag name
public const	SysTagOffset = "_offset"
	offset tag name
public const	SysTagSet
	known system tags
public const	ModuleList = ("uuid", "xml", "json", "yaml", "SoapClient", "Mime", "Util")
	list of modules automatically loaded into Qorus programs (for workflows, services, jobs, etc)
public const	ServiceClassList = CommonClassList + ("AbstractServiceHttpHandler", "AbstractFtpHandler", "AbstractServiceRestHandler", "RestHandler", "AbstractRestClass", "AbstractServiceWebSocketHandler", "QorusWebSocketConnection", "AbstractAuthenticator", "QorusExtensionHandler", "AbstractServiceDataStreamResponseHandler", "AbstractRestStreamRequestHandler", "AbstractServiceStream", "AbstractHttpRequestHandler", "AbstractPersistentDataHelper", "PermissiveAuthenticator")
	list of service classes
public const	SystemServiceClassList = ("RemoteConnectionFileHelperBase", "SQLInterface", "Map")
	list of system service classes
public const	WorkflowClassList = CommonClassList
	list of workflow classes
public const	JobClassList = CommonClassList
	list of job classes
const	ValidClientAPIOpts
	valid client API options
QorusSystemServiceHelper	$omqservice
	global service access object; transparently loads and initializes services and redirects calls to service methods More...

Detailed Description

main Qorus system namespace

the main client namespace

Variable Documentation

QorusSystemServiceHelper OMQ::$omqservice

global service access object; transparently loads and initializes services and redirects calls to service methods

The $omqservice object is available in all user code in Qorus Integration Engine. It provides transparent service loading and initialization when calling service methods. That is; if a service is not loaded when referenced in a call using the $omqservice object, Qorus will attempt to load and initialize the service before making the method call and returning the result.
Therefore if a service cannot be found (it doesn’t exist) or cannot be initialized, an appropriate exception could be returned to the caller.
for example:

my hash $sys_props = $omqservice.system.prop.get("omq");

Exceptions

NO-SERVICE	Service doesn’t exists (type or name invalid)
BAD-SERVICE-DEFINITION	Service has an invalid definition and was not loaded; this should not happen in practice.
INCONSISTENT-SERVICE	Service has only one of start or stop methods, but not both.

public const OMQ::client_option_hash

valid Qorus client options in the options file under domain "qorus-client"

Option	Type	Description
applications	list of string	application(s) served by this Qorus instance, can be used to allow oload to refuse to load code tagged for applications not in the list
client-pool-maximum	int	Maximum size of the connection pool
client-pool-minimum	int	Minimum size of the connection pool
client-url	string	URL of the Qorus server
missing-tag-warning	bool	Show missing tag warnings in oload
omq-data-tablespace	string	Override the system schema's data tablespace name
omq-index-tablespace	string	Override the system schema's index tablespace name
override-job-params	bool	Override job schedule and runtime parameters in oload
proxy-url	string	URL of the proxy for the Qorus server
warn-deprecated-api	bool	if True will cause oload to raise warnings when loading user code that references deprecated APIs
<datasource>-data-tablespace	string	Override the data tablespace name for given datasource
<datasource>-index-tablespace	string	Override the index tablespace name for given datasource

public const OMQ::DefaultGroupID = 0

groupid of the default workflow and service group

public const OMQ::options_relations

Initial value:

= (         "qorus": ( "list" : omq_option_hash, "defaults" : option_defaults, "alias" : omq_option_aliases),
         "qhaorder": ( "list" : qhaorder_option_hash, "defaults" : qhaorder_defaults),
         "qorus-client": ( "list" : client_option_hash, "defaults" : client_defaults)
         )

option information

See also

QorusClientAPI::getOptionInfoFile()