Qorus Integration Engine®  4.0.3_git
OMQ Namespace Reference

main Qorus namespace More...

Namespaces

 Client
 objects that are also present in the server with the same names are created under the OMQ::Client namespace
 
 MapperModuleApi
 Mapper module API namespace.
 
 UserApi
 user API namespace root
 

Classes

class  AbstractConnectionFileHelper
 this class is used to parse the connection files in the server and client More...
 
class  AbstractFsRemoteReceive
 A class for inbound/reading data from the remote instance's filesystem. More...
 
class  AbstractFtpHandler
 this class is used to customize and control the behavior of Qorus FTP servers attached to services More...
 
class  AbstractMapperType
 abstract class for a mapper provider; defines the interface for the class of object returned by the "get_mapper_providers()" function More...
 
class  AbstractParallelReceiveStream
 this class handles stream classes that use an I/O thread to receive data More...
 
class  AbstractParallelStream
 common base class for streams using a background thread for socket I/O More...
 
class  AbstractParallelWriteStream
 this class handles stream classes that use an I/O thread to send data More...
 
class  AbstractPersistentDataHelper
 this class is the base class for persistent HTTP connection support in 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...
 
hashdecl  ConfigItemInfo
 hash of config item info More...
 
class  ConnectionScheme
 defines the class of object returned by the "get_schemes()" function in custom user modules More...
 
class  CryptoKeyHelper
 manages Qorus encryption keys More...
 
class  DbQueuedBlockStreamConfig
 config class for DbRemoteSend More...
 
class  DbRemote
 A high level API for remote system.sqlutil service calls. More...
 
class  DbRemoteReceive
 A class for inbound/reading data from the remote instance, I/O is handled in a background thread and is made available in the getData() and getAllData() methods. More...
 
class  DbRemoteSend
 Database stream for outbound/writing data to the remote instance. More...
 
class  DbSelectStreamConfig
 config class for DB select streams More...
 
class  DbStreamConfig
 configuration class for DB streams More...
 
class  DbStreamConfigBase
 base configuration for DB streams More...
 
class  DefaultQorusRBACAuthenticator
 class for authenticating with standard Qorus RBAC authentication More...
 
class  DefaultQorusRBACBasicAuthenticator
 class for authenticating with standard Qorus RBAC authentication that returns a header that asks for basic authentication when authentication fails More...
 
class  ErrorDef
 class that defines error attributes More...
 
class  FsReceiveStreamConfig
 filesystem receive stream base config class More...
 
class  FsRemote
 A high level API for a remote system.fs service. More...
 
class  FsRemoteSend
 Filesystem stream for outbound/writing data to the remote instance. More...
 
class  FsSendStreamConfig
 filesystem send stream base config class More...
 
hashdecl  HttpBindOptionInfo
 HTTP binding options. More...
 
class  InboundTableMapperType
 system mapper class for prividing TableMapper::InboundTableMapper objects at runtime More...
 
class  InterfaceModuleProgram
 used to create interface module program objects More...
 
class  JobDef
 class that defines job attributes More...
 
class  JobProgram
 used to create job program objects (client & server) More...
 
hashdecl  JobRecoveryInfo
 Job recovery information. More...
 
hashdecl  JobResultInfo
 This hash provides information about job instance execution. More...
 
class  MapperDef
 class that defined mapper attributes More...
 
class  MapperProgram
 used to create mapper program objects (client & server) More...
 
class  MapperType
 system mapper class for prividing Mapper::Mapper objects at runtime More...
 
hashdecl  OrderSlaOutputInfo
 workflow order SLA band info; summarizes info for a particular status code in a band More...
 
hashdecl  OrderStatusOutputInfo
 workflow order stats band info; summarizes info for a particular status code in a band More...
 
hashdecl  OrderSummaryOutputInfo
 workflow order stats summary info hash More...
 
class  PermissiveAuthenticator
 class providing automatic authentication for all requests More...
 
class  QorusClient
 This class implements static methods in the client API. More...
 
class  QorusClientAPI
 This class implements the client interface to a Qorus server. More...
 
class  QorusExtensionHandler
 this class is used to define a Qorus UI extension in a Qorus service More...
 
class  QorusInboundTableMapper
 this class provides an inbound table mapper based on TableMapper::InboundTableMapper with consistent constructor arguments More...
 
class  QorusInboundTableMapperIterator
 this class provides an inbound table mapper iterator based on TableMapper::InboundTableMapperIterator with consistent constructor arguments More...
 
class  QorusParametrizedAuthenticator
 This class allows for authentication labels to be used with HTTP services provided by Qorus services. More...
 
class  QorusProgram
 base class for Qorus program classes, where the parse options are reset after each object is parsed More...
 
class  QorusRawSqlStatementOutboundMapper
 Qorus oubound mapper based on raw SQL select statement. More...
 
class  QorusRawSqlStatementOutboundMapperType
 defines the mapper type for raw outbound SQL mappers 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  QorusSqlStatementOutboundMapper
 Qorus oubound mapper based on SqlUtil select. More...
 
class  QorusSqlStatementOutboundMapperType
 system mapper class for prividing OMQ::QorusSqlStatementOutboundMapper objects at runtime 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  QueuedBlockConfigBase
 config class for DB streams using queued / blocked I/O More...
 
hashdecl  SensitiveDataInfo
 this hash provides info about workflow order sensitive data More...
 
class  ServiceFileHandler
 this class supports the implementation of HTTP file-based request handler with automatic handling of files in a certain root directory as well as rendering of templates 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...
 
hashdecl  SlaEventInfo
 this hash describes SLA events More...
 
hashdecl  SlaInfo
 this hash describes SLAs More...
 
hashdecl  SlaJobInfo
 this hash describes jobs with a particular SLA More...
 
hashdecl  SlaPerformanceInfo
 this hash provides SLA performance info More...
 
hashdecl  SlaServiceMethodInfo
 this hash describes service methods with a particular SLA More...
 
class  StreamConfig
 stream configuration class More...
 
class  StreamInfo
 provides info about the stream More...
 
class  TaggedFileParser
 Qorus Source Code parser class. More...
 
class  WorkflowDef
 class that defines workflow attributes More...
 
class  WorkflowProgram
 used to create workflow program objects (client & server) More...
 
hashdecl  WorkflowRecoveryInfo
 Workflow recovery information. More...
 

Functions

public int compare_version (string lv, string rv)
 compares complex versions by breaking down strings into component parts More...
 
public string normalize_dir (string dir, string cwd=getcwd())
 returns a platform-specific normalized path name (starting from /, eliminates ".", "..", and "//") More...
 
public bool absolute_path (string path)
 returns True if the argument is an absolute path, False if not More...
 
public string qorus_get_local_url ()
 returns a string giving a local URL for the current Qorus instance
 
public string qorus_get_source ()
 returns the constant string "system"
 
public alert_exception (string type, string alert, hash ex, int id=-1)
 outputs a formatted alert string on stdout
 
public hash encrypt_order_data (softint wfiid, string skey, string svalue, hash info, *hash meta)
 encrypts order data by calling OMQ::QorusClientAPI::encryptOrderData() More...
 
public validate_object_name (*string name, *bool with_dot)
 Validates Qorus object (serivce, workflow, job, ...) name. More...
 
public string get_option_description (hash oh)
 returns the option description including the deprecated info
 
public bool is_valid_object_name (*string name, *bool with_dot)
 Validates Qorus object (service, workflow, job, ...) name. More...
 

Variables

public const DirSep = (PlatformOS != "Windows" ? "/" : "\\")
 directory separator character
 
Qore::SQL::Datasource omq
 global qorus system schema datasource
 
Qore::SQL::Datasource omquser
 global qorus user schema datasource
 
OMQ::QorusClientAPI omqclient
 global client API variable; initialized in QorusClient::init2()
 
OMQ::Client::QorusSystemAPIHelper omqapi
 global object for accessing the Qorus network API through lightweight web service calls; initialized in QorusClient::init2()
 
OMQ::Client::QorusClientRemoteServiceHelper omqservice
 global object for making service calls using omqapi; initialized in QorusClient::init2() More...
 
OMQ::Client::QorusSystemRestHelper qrest
 global object for accessing the Qorus REST API
 
public const NameTagParams = ("maxlen": SQLNameLen)
 common definition of the name tag
 
public const NameTag = ("name": NameTagParams)
 name tag definition
 
public const NameTagReq = ("name": NameTagParams + ("mandatory": True))
 name tag definition for objects where the tag is required
 
public const VersionTag = ("version": ("mandatory": True, "attrib": True, "maxlen": SQLVersionLen))
 version tag definition
 
public const DescTag = ("desc": ("maxlen": SQLDescLen, "multi": " ", "warn": True))
 desc tag definition
 
public const AuthorTag = ("author": ("maxlen": SQLAuthorLen, "multi": ", ", "attrib": True))
 author tag definition
 
public const PatchTag = ("patch": ("maxlen": SQLPatchLen, "attrib": True))
 patch tag definition
 
public const FuncTypeTag = ("type": ("mandatory": True, "attrib": True))
 function type tag definition
 
public const LangTag = {"lang": {"maxlen": 80, "values": ("qore", "java"), "default": "qore"}}
 lang tag definition
 
public const RequiresTag = {"requires": {"list": True}}
 requires tag definition
 
public const ClassNameTag = {"class-name": {"maxlen": SQLNameLen}}
 class-name tag definition
 
const CommonBaseTags = VersionTag + DescTag + AuthorTag
 common to many files
 
const CommonGenericTags = CommonBaseTags + PatchTag
 common to functions, classes, and constants
 
const FunctionTags = NameTag + CommonGenericTags + FuncTypeTag
 tags for function files
 
const ClassTags = NameTag + LangTag + RequiresTag + CommonGenericTags
 tags for class files
 
const ConstantTags = NameTagReq + CommonGenericTags
 tags for constant files
 
const LibTags
 tags for library objects
 
const GroupTags
 tags for groups
 
const ComplexTags = CommonBaseTags + LibTags + GroupTags
 tags for complex files
 
public const ClassBasedTag = {"class-based": {"type": Type::Boolean, "default": False}}
 class-based tag
 
const JobTags
 tags for job files
 
const ServiceTags
 tags for service files
 
const MapperTags
 tags for mapper files
 
const ValueMapTags
 tags for value maps
 
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
 
const MinSystemServiceVersion
 hash giving minimum versions of system services
 
const CommonAPI
 list of functions common to workflow, service, and job programs
 
const WorkflowAPI
 list of functions specific to workflow programs
 
const CommonParseOptions = 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_INHERIT_USER_CLASSES|PO_NO_INHERIT_USER_HASHDECLS
 all sandboxed Qorus code has at least the following parse options
 
const WorkflowParseOptions = CommonParseOptions|PO_NO_GLOBAL_VARS
 workflow programs will have the following parse options
 
const workflowParseOptions = WorkflowParseOptions
 backwards-compatible definition
 
public const QorusServerDefines = ("Qorus", "QorusServer", "QorusHasUserConnections", "QorusHasAlerts", "QorusHasTableCache")
 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 QorusMapperDefines = QorusServerDefines + "QorusMapper"
 defines for mapper 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
 
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)
 
const ServiceAPI
 list of functions imported into service program objects
 
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
 
const AllSLTypes = (SLNone, SLRead, SLWrite)
 list of all service lock types
 
const ServiceParseOptions = CommonParseOptions
 services will have the following parse options
 
const serviceParseOptions = ServiceParseOptions
 backwards-compatible definition
 
const SystemServiceParseOptions = 0
 system services additionally have the following parse options
 
const systemServiceParseOptions = SystemServiceParseOptions
 backwards-compatible definition
 
const ServiceParseOptionList
 valid additional parse options for services
 
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...
 
const StatMap
 map from text descriptions to SQL status characters
 
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.
 
const ErrorSeverityOrder
 map giving the relative importance of each error code
 
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...
 
const ErrLevelTypes
 oload error definition level type hash
 
public const CS_Clean = "C"
 order went to COMPLETE without any errors
 
public const CS_RecoveredAuto = "A"
 order went to COMPLETE after being recovered automatically
 
public const CS_RecoveredManual = "M"
 order went to COMPLETE after being recovered with manual retries
 
public const WM_Normal = "NORMAL"
 Workflow Mode: NORMAL.
 
public const WM_Recovery = "RECOVERY"
 Workflow Mode: RECOVERY.
 
public const WM_Synchronous = "SYNCHRONOUS"
 Workflow Mode: SYNCHRONOUS. More...
 
const LL_CRITICAL = -1
 Log Level: CRITICAL -> Logger::LoggerLevel::FATAL.
 
const LL_IMPORTANT = 0
 Log Level: IMPORTANT -> Logger::LoggerLevel::INFO.
 
const LL_INFO = 1
 Log Level: INFO -> Logger::LoggerLevel::INFO.
 
const LL_DETAIL_1 = 2
 Log Level: DETAIL_1 -> Logger::LoggerLevel::INFO.
 
const LL_DETAIL_2 = 3
 Log Level: DETAIL_2 -> Logger::LoggerLevel::INFO.
 
const LL_DEBUG_1 = 4
 Log Level: DEBUG_1 -> Logger::LoggerLevel::DEBUG.
 
const LL_DEBUG_2 = 5
 Log Level: DEBUG_2 -> Logger::LoggerLevel::DEBUG.
 
const LL_DEBUG_3 = 6
 Log Level: DEBUG_3 -> Logger::LoggerLevel::DEBUG.
 
const StatusOrder
 map giving the relative ranking of status codes (text code -> numeric ranking)
 
const SpecialStatusOrder
 map giving the relative ranking of status codes (text code -> numeric ranking), including IN-PROGRESS
 
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...
 
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...
 
const SQL_QS_ALL = ( SQL_QS_Waiting, SQL_QS_Received, SQL_QS_Error, SQL_QS_Used )
 list of all queue status character codes
 
const QSMap
 map of queue status descriptions to the character code
 
const SQLQSMap
 map of queue status character codes to the description
 
const omq_option_aliases
 Qorus server option alias hash.
 
const client_option_aliases
 Qorus client 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_READ_SENSITIVE_DATA = "READ-SENSITIVE-DATA"
 RBAC System Permission: "READ-SENSITIVE-DATA";. More...
 
public const QR_EDIT_SENSITIVE_DATA = "EDIT-SENSITIVE-DATA"
 RBAC System Permission: "EDIT-SENSITIVE-DATA";. More...
 
public const QR_DELETE_SENSITIVE_DATA = "DELETE-SENSITIVE-DATA"
 RBAC System Permission: "DELETE-SENSITIVE-DATA";. More...
 
public const QR_SENSITIVE_DATA_CONTROL = "SENSITIVE-DATA-CONTROL"
 RBAC System Permission: "SENSITIVE-DATA-CONTROL";. 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_SET_STEP_CONFIG = "SET-STEP-CONFIG"
 RBAC System Permissions: "SET-STEP-CONFIG". More...
 
public const QR_SET_WORKFLOW_CONFIG = "SET-WORKFLOW-CONFIG"
 RBAC System Permissions: "SET-WORKFLOW-CONFIG". 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_SET_SERVICE_CONFIG = "SET-SERVICE-CONFIG"
 RBAC System Permissions: "SET-SERVICE-CONFIG". 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_LOGGER_CONTROL = "LOGGER-CONTROL"
 RBAC System Permission: "LOGGER-CONTROL". More...
 
public const QR_ROTATE_LOG_FILES = "ROTATE-LOG-FILES"
 RBAC System Permission: "ROTATE-LOG-FILES". More...
 
public const QR_MODIFY_LOGGER = "MODIFY-LOGGER"
 RBAC System Permission: "MODIFY-LOGGER". More...
 
public const QR_DELETE_LOGGER = "DELETE-LOGGER"
 RBAC System Permission: "DELETE-LOGGER". More...
 
public const QR_CREATE_LOGGER = "CREATE-LOGGER"
 RBAC System Permission: "CREATE-LOGGER". 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_SET_JOB_CONFIG = "SET-JOB-CONFIG"
 RBAC System Permissions: "SET-JOB-CONFIG". 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_ADD_SERVER_CONNECTION = "ADD-SERVER-CONNECTION"
 RBAC System Permission: "ADD-SERVER-CONNECTION". More...
 
public const QR_MODIFY_SERVER_CONNECTION = "MODIFY-SERVER-CONNECTION"
 RBAC System Permission: "MODIFY-SERVER-CONNECTION". More...
 
public const QR_DELETE_SERVER_CONNECTION = "DELETE-SERVER-CONNECTION"
 RBAC System Permission: "DELETE-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 QR_MAPPER_CONTROL = "MAPPER-CONTROL"
 RBAC System Permission: "MAPPER-CONTROL". More...
 
public const QR_RELOAD_MAPPER = "RELOAD-MAPPER"
 RBAC System Permission: "RELOAD-MAPPER". More...
 
public const QR_MODIFY_MAPPER = "MODIFY-MAPPER"
 RBAC System Permission: "MODIFY-MAPPER". More...
 
public const QR_VALUE_MAP_CONTROL = "VALUE-MAP-CONTROL"
 RBAC System Permission: "VALUE-MAP-CONTROL". More...
 
public const QR_RELOAD_VALUE_MAP = "RELOAD-VALUE-MAP"
 RBAC System Permission: "RELOAD-VALUE-MAP". More...
 
public const QR_MODIFY_VALUE_MAP = "MODIFY-VALUE-MAP"
 RBAC System Permission: "MODIFY-VALUE-MAP". More...
 
public const QR_CREATE_SLA = "CREATE-SLA"
 RBAC System Permission: "CREATE-SLA". More...
 
public const QR_DELETE_SLA = "DELETE-SLA"
 RBAC System Permission: "DELETE-SLA". More...
 
public const QR_MODIFY_SLA = "MODIFY-SLA"
 RBAC System Permission: "MODIFY-SLA". More...
 
public const QR_SLA_CONTROL = "SLA-CONTROL"
 RBAC System Permission: "SLA-CONTROL". More...
 
public const QR_DEBUG_CONTROL = "DEBUG-CONTROL"
 RBAC System Permission: "DEBUG-CONTROL". More...
 
public const QR_REMOTE_DEPLOYMENT = "REMOTE-DEPLOYMENT"
 RBAC System Permission: "REMOTE-DEPLOYMENT". More...
 
public const QR_REMOTE_DELETE_INTERFACE = "REMOTE-DELETE-INTERFACE"
 RBAC System Permission: "REMOTE-DELETE-INTERFACE". More...
 
public const QR_REMOTE_RELEASE = "REMOTE-RELEASE"
 RBAC System Permission: "REMOTE-RELEASE". More...
 
public const QR_KILL_PROCESS = "KILL-PROCESS"
 RBAC System Permission: "KILL-PROCESS". More...
 
const AUTH_OVERRIDE_ERROR = 1001
 RBAC Authorization Error Code.
 
const AUTH_INVALID_USER_OR_PASSWORD = 1002
 RBAC Authorization Error Code.
 
const AUTH_UNAUTHORIZED = 1003
 RBAC Authorization Error Code.
 
const AUTH_REQUIRES_AUTHORIZATION = 1004
 RBAC Authorization Error Code.
 
const AUTH_INVALID_USERNAME = 1005
 RBAC Authorization Error Code.
 
const AUTH_USER_ALREADY_EXISTS = 1006
 RBAC Authorization Error Code.
 
const AUTH_INVALID_PERMISSION = 1007
 RBAC Authorization Error Code.
 
const AUTH_INVALID_USER = 1008
 RBAC Authorization Error Code.
 
const AUTH_MISSING_USERNAME = 1009
 RBAC Authorization Error Code.
 
const AUTH_MISSING_DESCRIPTION = 1010
 RBAC Authorization Error Code.
 
const AUTH_MISSING_PERMISSION = 1011
 RBAC Authorization Error Code.
 
const AUTH_MISSING_ROLE = 1012
 RBAC Authorization Error Code.
 
const AUTH_INVALID_ROLE = 1013
 RBAC Authorization Error Code.
 
const AUTH_ROLE_ALREADY_EXISTS = 1014
 RBAC Authorization Error Code.
 
const AUTH_PERMISSION_ALREADY_EXISTS = 1015
 RBAC Authorization Error Code.
 
const AUTH_CANNOT_UPDATE_SYSTEM_PERMISSION = 1016
 RBAC Authorization Error Code.
 
const AUTH_CANNOT_DELETE_PERMISSION_IN_USE = 1017
 RBAC Authorization Error Code.
 
const AUTH_INVALID_GROUP = 1018
 RBAC Authorization Error Code.
 
const AUTH_INVALID_WORKFLOW = 1019
 RBAC Authorization Invalid Workflow Error Code.
 
const AUTH_INVALID_SERVICE = 1020
 RBAC Authorization Invalid Service Error Code.
 
const AUTH_INVALID_JOB = 1021
 RBAC Authorization Invalid Workflow Error Code.
 
const AUTH_NO_SUCH_ROLE = 1022
 RBAC Authorization Error Code.
 
const XMLRPC_INVALID_XML = 2001
 error code for invalid XML revied by the XML-RPC handler
 
const QEM_FILTER_CRITERIA_HASH
 valid event filter criteria code hash
 
const QEM_FILTER_CRITERIA = QEM_FILTER_CRITERIA_HASH.keys()
 valid event filter criteria code list
 
const QE_CLASS_SYSTEM = 101
 Event Class Code for SYSTEM Events.
 
const QE_CLASS_WORKFLOW = 102
 Event Class Code for WORKFLOW Events.
 
const QE_CLASS_SERVICE = 103
 Event Class Code for SERVICE Events.
 
const QE_CLASS_USER = 104
 Event Class Code for USER Events.
 
const QE_CLASS_JOB = 105
 Event Class Code for JOB Events.
 
const QE_CLASS_ALERT = 106
 Event Class Code for ALERT Events.
 
const QE_CLASS_GROUP = 107
 Event Class Code for GROUP Events.
 
const QE_CLASS_CONNECTION = 108
 Event Class Code for CONNECTION events.
 
const QE_CLASS_PROCESS = 109
 Event Class Code for PROCESS events. More...
 
const QE_CLASS_CLUSTER = 110
 Event Class Code for CLUSTER events. More...
 
const QE_CLASS_LOGGER = 111
 Event Class Code for LOGGER events. More...
 
const QE_CLASS_CONFIG_ITEM = 112
 Event Class Code for CONFIG ITEM events. More...
 
const QE_MAP_CLASS
 hash mapping event class codes to descriptive strings
 
const QE_RMAP_CLASS = map {$1.value: $1.key.toInt()}
 hash mapping event class descriptive strings to class codes
 
const QEC_SYSTEM_STARTUP = 1001
 Qorus Event Code: SYSTEM_STARTUP. More...
 
const QEC_SYSTEM_SHUTDOWN = 1002
 Qorus Event Code: SYSTEM_SHUTDOWN. More...
 
const QEC_SYSTEM_ERROR = 1003
 Qorus Event Code: SYSTEM_ERROR. More...
 
const QEC_SYSTEM_HEALTH_CHANGED = 1004
 Qorus Event Code: SYSTEM_HEALTH_CHANGED. More...
 
const QEC_SYSTEM_REMOTE_HEALTH_CHANGED = 1005
 Qorus Event Code: SYSTEM_REMOTE_HEALTH_CHANGED. More...
 
const QEC_GROUP_STATUS_CHANGED = 1101
 Qorus Event Code: GROUP_STATUS_CHANGED. More...
 
const QEC_WORKFLOW_START = 2001
 Qorus Event Code: WORKFLOW_START. More...
 
const QEC_WORKFLOW_STOP = 2002
 Qorus Event Code: WORKFLOW_STOP. More...
 
const QEC_WORKFLOW_CACHE_RESET = 2003
 Qorus Event Code: WORKFLOW_CACHE_RESET. More...
 
const QEC_WORKFLOW_DATA_SUBMITTED = 2004
 Qorus Event Code: WORKFLOW_DATA_SUBMITTED. More...
 
const QEC_WORKFLOW_DATA_ERROR = 2005
 Qorus Event Code: WORKFLOW_DATA_ERROR. More...
 
const QEC_WORKFLOW_DATA_RELEASED = 2006
 Qorus Event Code: WORKFLOW_DATA_RELEASED (workflow detach event) More...
 
const QEC_WORKFLOW_DATA_CACHED = 2007
 Qorus Event Code: WORKFLOW_DATA_CACHED (workflow attach event) More...
 
const QEC_WORKFLOW_INFO_CHANGED = 2008
 Qorus Event Code: WORKFLOW_INFO_CHANGED. More...
 
const QEC_WORKFLOW_STATUS_CHANGED = 2009
 Qorus Event Code: WORKFLOW_STATUS_CHANGED. More...
 
const QEC_WORKFLOW_STEP_PERFORMANCE = 2010
 Qorus Event Code:: WORKFLOW_STEP_PERFORMANCE. More...
 
const QEC_WORKFLOW_PERFORMANCE = 2011
 Qorus Event Code:: WORKFLOW_PERFORMANCE. More...
 
const QEC_WORKFLOW_DATA_LOCKED = 2012
 Qorus Event Code: WORKFLOW_DATA_LOCKED. More...
 
const QEC_WORKFLOW_DATA_UNLOCKED = 2013
 Qorus Event Code: WORKFLOW_DATA_UNLOCKED. More...
 
const QEC_WORKFLOW_DATA_UPDATED = 2014
 Qorus Event Code: WORKFLOW_DATA_UPDATED (static or dynamic data changed) More...
 
const QEC_WORKFLOW_STATS_UPDATED = 2015
 Qorus Event Code: WORKFLOW_STATS_UPDATED. More...
 
const QEC_WORKFLOW_RECOVERED = 2016
 Qorus Event Code: WORKFLOW_RECOVERED. More...
 
const QEC_WORKFLOW_UPDATED = 2017
 Qorus Event code: WORKFLOW_UPDATED. More...
 
const QEC_WORKFLOW_STEP_DATA_UPDATED = 2018
 Qorus Event Code: WORKFLOW_STEP_DATA_UPDATED (step dynamic data changed) More...
 
const QEC_SERVICE_START = 3001
 Qorus Event Code: SERVICE_START. More...
 
const QEC_SERVICE_STOP = 3002
 Qorus Event Code: SERVICE_STOP. More...
 
const QEC_SERVICE_ERROR = 3003
 Qorus Event Code: SERVICE_ERROR. More...
 
const QEC_SERVICE_AUTOSTART_CHANGE = 3004
 Qorus Event Code: SERVICE_AUTOSTART_CHANGE. More...
 
const QEC_SERVICE_METHOD_PERFORMANCE = 3005
 Qorus Event Code:: SERVICE_METHOD_PERFORMANCE. More...
 
const QEC_SERVICE_UPDATED = 3006
 Qorus Event code: SERVICE_UPDATED. More...
 
const QEC_JOB_START = 4001
 Qorus Event Code: JOB_START. More...
 
const QEC_JOB_STOP = 4002
 Qorus Event Code: JOB_STOP. More...
 
const QEC_JOB_ERROR = 4003
 Qorus Event Code: JOB_ERROR. More...
 
const QEC_JOB_INSTANCE_START = 4004
 Qorus Event Code: JOB_INSTANCE_START. More...
 
const QEC_JOB_INSTANCE_STOP = 4005
 Qorus Event Code: JOB_INSTANCE_STOP. More...
 
const QEC_JOB_RECOVERED = 4006
 Qorus Event Code: JOB_RECOVERED. More...
 
const QEC_JOB_UPDATED = 4007
 Qorus Event code: JOB_UPDATED. More...
 
const QEC_CONFIG_ITEM_CHANGED = 4100
 Qorus Event code: QEC_CONFIG_ITEM_CHANGED. More...
 
const QEC_ALERT_ONGOING_RAISED = 5006
 Qorus Event Code: ALERT_ONGOING_RAISED. More...
 
const QEC_ALERT_ONGOING_CLEARED = 5007
 Qorus Event Code: ALERT_ONGOING_CLEARED. More...
 
const QEC_ALERT_TRANSIENT_RAISED = 5008
 Qorus Event Code: ALERT_TRANSIENT_RAISED. More...
 
const QEC_CONNECTION_UP = 5101
 Qorus Event Code: CONNECTION_UP. More...
 
const QEC_CONNECTION_DOWN = 5102
 Qorus Event Code: CONNECTION_DOWN. More...
 
const QEC_CONNECTION_ENABLED_CHANGE = 5103
 Qorus Event Code: CONNECTION_ENABLED_CHANGE. More...
 
const QEC_CONNECTION_CREATED = 5104
 Qorus Event Code: CONNECTION_CREATED. More...
 
const QEC_CONNECTION_UPDATED = 5105
 Qorus Event Code: CONNECTION_UPDATED. More...
 
const QEC_CONNECTION_DELETED = 5106
 Qorus Event Code: CONNECTION_DELETED. More...
 
const QEC_CONNECTIONS_RELOADED = 5107
 Qorus Event Code: CONNECTIONS_RELOADED. More...
 
const QEC_LOGGER_CREATED = 5108
 Qorus Event Code: LOGGER_CREATED. More...
 
const QEC_LOGGER_UPDATED = 5109
 Qorus Event Code: LOGGER_UPDATED. More...
 
const QEC_LOGGER_DELETED = 5110
 Qorus Event Code: LOGGER_DELETED. More...
 
const QEC_APPENDER_CREATED = 5111
 Qorus Event Code: APPENDER_CREATED. More...
 
const QEC_APPENDER_DELETED = 5112
 Qorus Event Code: APPENDER_DELETED. More...
 
const QEC_APPENDER_UPDATED = 5113
 Qorus Event Code: APPENDER_UPDATED. More...
 
const QEC_PROCESS_STARTED = 6001
 Qorus Event Code: PROCESS_STARTED. More...
 
const QEC_PROCESS_STOPPED = 6002
 Qorus Event Code: PROCESS_STOPPED. More...
 
const QEC_PROCESS_START_ERROR = 6003
 Qorus Event Code: PROCESS_START_ERROR. More...
 
const QEC_PROCESS_MEMORY_CHANGED = 6004
 Qorus Event Code: PROCESS_MEMORY_CHANGED. More...
 
const QEC_NODE_INFO = 7001
 Qorus Event Code: NODE_INFO. More...
 
const QEC_USER_EVENT = 9001
 Qorus Event Code: USER_EVENT. More...
 
const QE_MAP_EVENT
 hash mapping event codes to descriptive strings
 
const QE_RMAP_EVENT = map {$1.value: $1.key.toInt()}
 hash mapping event descriptive strings to codes
 
const QorusSystemOptionHash
 master Qorus system option hash for all valid system options
 
const QorusSystemOptionDefaults
 default values for Qorus system options
 
const QorusClientOptionHash
 valid Qorus client options in the options file under domain "qorus-client" More...
 
const QorusClientOptionDefaults
 the following are default values for options when no option is set in the option file
 
const omq_option_hash = QorusSystemOptionHash
 backwards-compatible constant name for QorusSystemOptionHash
 
const option_defaults = QorusSystemOptionDefaults
 backwards-compatible constant name for QorusSystemOptionDefaults
 
const client_option_hash = QorusClientOptionHash
 backwards-compatible constant name for QorusClientOptionHash
 
const client_defaults = QorusClientOptionDefaults
 backwards-compatible constant name for QorusClientOptionDefaults
 
const qhaorder_option_hash
 valid options for the "qhaorder" program
 
public const segment_options = ("async", "retry")
 valid segment options
 
const SQL_DEF_INIT_BLOCKSIZE = 200
 default SQL blocksize for the initial block for piecewise parallel SQL execution
 
const SQL_DEF_BLOCKSIZE = 5000
 default SQL blocksize when reading in new data to the WorkflowQueue
 
const DefaultEventTypeID = 0
 default system workflow synchronization event type ID
 
public const DefaultEventKey = "OMQ-SYSTEM-DEFAULT-EVENT"
 default system workflow synchronization event key
 
const SystemRoleHash
 Qorus system role hash.
 
const QSE_OK = 0
 Qorus Startup Error Code: no error.
 
const QSE_NO_INSTANCE_KEY = 1
 Qorus Startup Error Code: no instance key set.
 
const QSE_INVALID_DB_MAX_THREADS = 2
 Qorus Startup Error Code: invalid db-max-threads option.
 
const QSE_DATASOURCE = 3
 Qorus Startup Error Code: can't open system datasources.
 
const QSE_LOG_ERROR = 4
 Qorus Startup Error Code: error opening system log files.
 
const QSE_RBAC_ERROR = 5
 Qorus Startup Error Code: error initializing RBAC framework.
 
const QSE_EVENT_ERROR = 6
 Qorus Startup Error Code: error initializing event framework.
 
const QSE_SESSION_ERROR = 7
 Qorus Startup Error Code: error opening or recovering application session.
 
const QSE_COMMAND_LINE_ERROR = 8
 Qorus Startup Error Code: error in command-line options.
 
const QSE_OPTION_ERROR = 9
 Qorus Startup Error Code: error setting options on startup.
 
const QSE_VERSION_ONLY = 10
 Qorus Startup Error Code: command-line option requested version display and exit.
 
const QSE_STARTUP_ERROR = 99
 Qorus Startup Error Code: other error starting server.
 
const DefaultGroupID = 0
 groupid of the default workflow and service group
 
public const DefaultGroupName = "DEFAULT"
 name of the default workflow and service group
 
const DefaultOrderPriority = 500
 default order priority
 
const SQLDescLen = 4000
 default description length in bytes for user objects
 
const SQLNameLen = 160
 length of name columns in bytes
 
const SQLAuthorLen = 240
 length of author columns in bytes
 
const SQLPatchLen = 80
 length of patch columns in bytes
 
const SQLVersionLen = 80
 length of version columns in bytes
 
const SQLSensitiveKeyLen = 150
 length of sensitive data keys in bytes More...
 
const SQLSensitiveValueLen = 150
 length of sensitive data key values in bytes More...
 
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...
 
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...
 
const SQL_JS_ALL = ( SQL_JS_Complete, SQL_JS_InProgress, SQL_JS_Error, SQL_JS_Crash )
 list of all Job status character codes
 
const JSMap
 map of Job status descriptions to the character code
 
const SQLJSMap
 map of Job status character codes to the description
 
const JobParseOptions = CommonParseOptions
 job programs will have the following parse options
 
const MapperParseOptions1 = CommonParseOptions
 mapper programs will have the following parse options when created before importing modules
 
const MapperParseOptions2 = PO_LOCKDOWN
 mapper programs will have the following parse options added after importing modules
 
const MapperParseOptions = MapperParseOptions1|MapperParseOptions2
 mapper programs will have the following parse options at the end of setup
 
const JobAPI
 job programs have the following API
 
const MapperAPI
 mapper programs have the following API
 
const AE_USER_EVENT = 1
 user event audit code More...
 
const AE_SYSTEM_STARTUP = 2
 system startup audit code More...
 
const AE_SYSTEM_SHUTDOWN = 3
 system shutdown audit code More...
 
const AE_SYSTEM_RECOVERY_START = 4
 system recovery start audit code More...
 
const AE_SYSTEM_RECOVERY_COMPLETE = 5
 system recovery complete audit code More...
 
const AE_WORKFLOW_STATUS_CHANGE = 6
 workflow status change audit code More...
 
const AE_WORKFLOW_START = 7
 workflow start audit code More...
 
const AE_WORKFLOW_STOP = 8
 workflow stop audit code More...
 
const AE_SERVICE_START = 9
 service start audit code More...
 
const AE_SERVICE_STOP = 10
 service stop audit code More...
 
const AE_JOB_START = 11
 job start audit code More...
 
const AE_JOB_STOP = 12
 job stop audit code More...
 
const AE_JOB_INSTANCE_START = 13
 job instance start audit code More...
 
const AE_JOB_INSTANCE_STOP = 14
 job instance stop audit code More...
 
const AE_API_CALL = 15
 api call audit code More...
 
const AE_JOB_RECOVERY = 16
 job recovery audit code More...
 
const AE_WORKFLOW_DATA_CREATED = 17
 workflow order data created audit code More...
 
const AE_ALERT_ONGOING_RAISED = 18
 ongoing alert raised audit code More...
 
const AE_ALERT_ONGOING_CLEARED = 19
 ongoing alert cleared audit code More...
 
const AE_ALERT_TRANSIENT_RAISED = 20
 transient alert raised audit code More...
 
const AE_SOURCE_FILE_LOADED = 21
 source file loaded into the system schema by oload More...
 
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...
 
const AuditEventMap
 map of audit event codes to descriptions
 
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...
 
const AuditOptionList
 list of all audit options
 
const AOC_SYSTEM = (1 << 0)
 Audit option code: system events. More...
 
const AOC_WORKFLOWS = (1 << 1)
 Audit option code: workflow events.
 
const AOC_WORKFLOW_DATA = (1 << 2)
 Audit option code: workflow data events.
 
const AOC_JOBS = (1 << 3)
 Audit option code: job events.
 
const AOC_JOB_DATA = (1 << 4)
 Audit option code: job data events.
 
const AOC_SERVICES = (1 << 5)
 Audit option code: service events.
 
const AOC_API = (1 << 6)
 Audit option code: api write events.
 
const AOC_USER_EVENTS = (1 << 7)
 Audit option code: user events.
 
const AOC_OLOAD_EVENTS = (1 << 8)
 Audit option code: oload events. More...
 
const AOC_ALERT_EVENTS = (1 << 9)
 Audit option code: alert events. More...
 
const AOC_GROUP_EVENTS = (1 << 10)
 Audit option code: RBAC interface group events. More...
 
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
 
const AuditOptionMap
 map of audit options to audit codes
 
const AuditCodeMap
 map of audit codes to audit options
 
public const UiExtensionRoot = "UIExtension"
 Root part of UI extension URL paths.
 
const ORDER_INSTANCE_KEYS_KEY_LEN = 240
 byte length of the order_instance_keys keyname column
 
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
 
const SysTagSet
 known system tags
 
const DefaultWorkflowSlaThreshold = 1800
 the default workflow SLA threshold value as an integer in seconds More...
 
public const CommonModuleList = ("uuid", "xml", "json", "yaml", "Mime", "Util", "SqlUtil")
 list of module loaded in all Qorus Program containers including mapper Programs
 
public const ModuleList = CommonModuleList + ("SoapClient", "Mapper", "TableMapper")
 list of modules automatically loaded into Qorus programs (for workflows, services, jobs, etc)
 
public const ServiceModuleList = ModuleList + ("HttpServerUtil",)
 list of modules automatically loaded into Qorus service programs
 
const ServiceOnlyClassList
 list of service classes
 
const ServiceClassList = CommonClassList + ServiceOnlyClassList
 list of service classes + common classes
 
const SystemServiceClassList
 list of system service classes
 
const WorkflowOnlyClassList
 list of workflow classes
 
const WorkflowClassList = CommonClassList + WorkflowOnlyClassList
 list of workflow classes + common classes
 
const JobOnlyClassList
 list of job classes
 
const JobClassList = CommonClassList + JobOnlyClassList
 list of job classes + common classes
 
const CommonHashDeclList
 list of hashdecls common to all user code Program objects (except mappers)
 
public const M_BIND = ("^bind^": True)
 A helper constant used in QorusSqlStatementOutboundMapper Variable Binding.
 
const ValidClientAPIOpts
 valid client API options
 

Detailed Description

main Qorus namespace

the main client namespace

main Qorus system namespace

Function Documentation

◆ compare_version()

public int OMQ::compare_version ( string  lv,
string  rv 
)

compares complex versions by breaking down strings into component parts

Example:
int result = compare_version("2.11.1", "2.2");

Each element is compared separately, so that compare_version("2.11.1", "2.2") returns 1 (a regular string comparison would give the opposite result)

Parameters
lvleft-hand version
rvright-hand version
Returns
-1 if lv < rv, 0 if equal, and 1 if lv > rv
Note
reexported from the Util module

◆ encrypt_order_data()

public hash OMQ::encrypt_order_data ( softint  wfiid,
string  skey,
string  svalue,
hash  info,
*hash  meta 
)

encrypts order data by calling OMQ::QorusClientAPI::encryptOrderData()

Since
Qorus 3.1.1

◆ is_valid_object_name()

public bool OMQ::is_valid_object_name ( *string  name,
*bool  with_dot 
)

Validates Qorus object (service, workflow, job, ...) name.

Allowed characters are a-z A-Z 0-9 - _

Parameters
nameThe object name
with_dotif True then dots ('.') are also accepted
Returns
True if name is valid otherwise False

Note: empty name is allowed and valid

◆ normalize_dir()

public string OMQ::normalize_dir ( string  dir,
string  cwd = getcwd() 
)

returns a platform-specific normalized path name (starting from /, eliminates ".", "..", and "//")

Example:
string dir = normalize_dir(dir);

Currently only Windows and UNIX-style directories are supported; this function calls either:

Parameters
dirthe directory name to normalize
cwdthe current working directory for normalizing relative paths
Returns
a normalized path name for the current platform
Note
reexported from the Util module

◆ validate_object_name()

public OMQ::validate_object_name ( *string  name,
*bool  with_dot 
)

Validates Qorus object (serivce, workflow, job, ...) name.

Allowed characters are a-z A-Z 0-9 - _

Parameters
namestring The object name
Exceptions
INVALID-NAMEexception whenever name is invalid

Note: empty name is allowed and valid

Variable Documentation

◆ DefaultWorkflowSlaThreshold

const OMQ::DefaultWorkflowSlaThreshold = 1800

the default workflow SLA threshold value as an integer in seconds

the default value is equal to 30 minutes

Since
Qorus 4.0

◆ omqservice

QorusSystemServiceHelper OMQ::omqservice

global object for making service calls using omqapi; initialized in QorusClient::init2()

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

Example:
*hash rh = omqservice.system.info.searchReleases(("name": "qorus-user-rel1"));

The omqservice object is available in all user code in Qorus Integration Engine (server and client). 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.

If a service cannot be found (it doesn’t exist) or cannot be initialized, an appropriate exception will be returned to the caller.

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

◆ QorusClientOptionHash

const OMQ::QorusClientOptionHash

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

OptionTypeDescription
applications list of stringapplication(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 intMaximum size of the connection pool
client-pool-minimum intMinimum size of the connection pool
client-url stringURL of the Qorus server
missing-tag-warning boolShow missing tag warnings in oload
omq-data-tablespace stringOverride the system schema's data tablespace name
omq-index-tablespace stringOverride the system schema's index tablespace name
override-job-params boolOverride job schedule and runtime parameters in oload
proxy-url stringURL of the proxy for the Qorus server
warn-deprecated-api boolif True will cause oload to raise warnings when loading user code that references deprecated APIs
<datasource>-data-tablespacestringOverride the data tablespace name for given datasource
<datasource>-index-tablespacestringOverride the index tablespace name for given datasource
allow-test-execution boolallows execution of QorusInterfaceTest

◆ SQLSensitiveKeyLen

const OMQ::SQLSensitiveKeyLen = 150

length of sensitive data keys in bytes

Since
Qorus 3.1.1

◆ SQLSensitiveValueLen

const OMQ::SQLSensitiveValueLen = 150

length of sensitive data key values in bytes

Since
Qorus 3.1.1