Qorus Integration Engine®  5.1.2_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. 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. 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  DbRawSelectStreamConfig
 config class for raw DB select streams More...
 
class  DbRemote
 A high level API for remote system.sqlutil service calls. More...
 
class  DbRemoteBase
 A high level API for remote system.sqlutil service calls. More...
 
class  DbRemoteRawReceive
 A class for inbound/reading data from the remote instance from a raw SQL query, I/O is handled in a background thread and is made available in the getData() and getAllData() methods. 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  DelayedObservable
 This class represents an observable subject that waits for external confirmation before raising events. 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...
 
class  Observable
 This class represents an observable subject that will notify all of its registered observers. More...
 
class  Observer
 This abstract class represents an observer that will get notified by the subject it observes. 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  QorusHttpConnection
 Qorus HTTP connection object. 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  QorusLocalRestHelper
 class for local REST API calls More...
 
class  QorusMapper
 this class provides a plain mapper based on Mapper::Mapper with consistent constructor arguments More...
 
class  QorusOracleDatasourcePool
 An Oracle specific class which is used for automated instrumentation as in OracleExtensions::OracleDatasourcePool but this one is directly inherited from Qore::SQL::DatasourcePool. 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 More...
 
class  QorusWebSocketConnection
 This wraps WebSocketHandler::WebSocketConnection. 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 More...
 
class  ServiceGate
 ServiceGate allows autoloading of Qorus services on referenced. More...
 
class  ServiceLogBase
 base class for objects that capture a service context for logging More...
 
class  ServiceMethodGate
 ServiceMethodGate provides a gateway to service methods. 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...
 
hashdecl  TokenInfo
 Token information hash. 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

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

Variables

const public DirSep = (PlatformOS != "Windows" ? "/" : "\\")
 directory separator character
 
public Qore::SQL::Datasource omq
 global qorus system schema datasource
 
public Qore::SQL::Datasource omquser
 global qorus user schema datasource
 
public OMQ::QorusClientAPI omqclient
 global client API variable; initialized in QorusClient::init2()
 
public OMQ::Client::QorusSystemAPIHelper omqapi
 global object for accessing the Qorus network API through lightweight web service calls; initialized in QorusClient::init2()
 
public OMQ::Client::QorusClientRemoteServiceHelper omqservice
 global object for making service calls using omqapi; initialized in QorusClient::init2() More...
 
public OMQ::Client::QorusSystemRestHelper qrest
 global object for accessing the Qorus REST API
 
const public M_BIND = ("^bind^": True)
 A helper constant used in QorusSqlStatementOutboundMapper Variable Binding.
 
const public ValidClientAPIOpts
 valid client API options
 
const public DefaultServerPort = 8001
 the default server port for Qorus servers if no other port is defined
 
const public OT_CONSTANT = "CONSTANT"
 for constant library objects
 
const public OT_CLASS = "CLASS"
 for class library objects
 
const public OT_FUNCTION = "FUNCTION"
 for function library objects
 
const public OT_PIPELINE = "PIPELINE"
 for pipeline library objects More...
 
const public OT_FSM = "FSM"
 for FSM library objects More...
 
const public OT_MAPPER = "MAPPER"
 for mapper library objects (only for pipelines and FSMs) More...
 
const public MinSystemServiceVersion
 hash giving minimum versions of system services
 
const public CommonAPI
 list of functions common to workflow, service, and job programs
 
const public WorkflowAPI
 list of functions specific to workflow programs
 
const public CommonParseOptions
 all sandboxed Qorus code has at least the following parse options
 
const public WorkflowParseOptions = CommonParseOptions|PO_NO_GLOBAL_VARS
 workflow programs will have the following parse options
 
const public workflowParseOptions = WorkflowParseOptions
 backwards-compatible definition
 
const public QorusServerDefines
 defines for all Qorus user code
 
const public QorusWorkflowDefines = QorusServerDefines + "QorusWorkflow"
 defines for workflow programs
 
const public QorusServiceDefines = QorusServerDefines + ("QorusService", "QorusHasHttpUserIndex")
 defines for service programs
 
const public QorusJobDefines = QorusServerDefines + "QorusJob"
 defines for job programs
 
const public QorusMapperDefines = QorusServerDefines + "QorusMapper"
 defines for mapper programs
 
const public MapperParseOptionList
 valid parse options for mappers
 
const public DefaultSystemUser = "%SYS%"
 Default internal system username.
 
const public FT_Step = "STEP"
 step function type
 
const public FT_Generic = "GENERIC"
 generic function type
 
const public FT_AsyncStart = "ASYNC-START"
 async start function type for async steps
 
const public FT_AsyncEnd = "ASYNC-END"
 async end function type for async steps
 
const public FT_Validation = "VALIDATION"
 validation function type
 
const public FT_Array = "ARRAY"
 array function type
 
const public FT_Subworkflow = "SUBWORKFLOW"
 subworkflow function type
 
const public AllFunctionTypes = (FT_Step, FT_Generic, FT_AsyncStart, FT_AsyncEnd, FT_Validation, FT_Array, FT_Subworkflow)
 list of all valid function types
 
const public ExecNormal = "NORMAL"
 step attribute: for normal steps
 
const public ExecAsync = "ASYNC"
 step attribute: for async steps
 
const public ExecSubWorkflow = "SUBWORKFLOW"
 step attribute: for subworkflow steps
 
const public ExecEvent = "EVENT"
 step attribute: for synchronization event steps
 
const public ArrayNone = "NONE"
 array type: for non-array steps
 
const public ArraySeries = "SERIES"
 array type: executed in series (only valid array type)
 
const public ArrayParallel = "PARALLEL"
 array type: executed in parallel (not implemented; do not use)
 
const public ServiceAPI
 list of functions imported into service program objects
 
const public SystemServiceAPI
 list of functions imported into only into system service program objects
 
const public SSRunning = "running"
 service status: running
 
const public SSLoaded = "loaded"
 service status: running
 
const public SLNone = "none"
 service lock type: none
 
const public SLRead = "read"
 service lock type: read
 
const public SLWrite = "write"
 service lock type: write
 
const public AllSLTypes = (SLNone, SLRead, SLWrite)
 list of all service lock types
 
const public ServiceParseOptions = CommonParseOptions
 services will have the following parse options
 
const public serviceParseOptions = ServiceParseOptions
 backwards-compatible definition
 
const public SystemServiceParseOptions = 0
 system services additionally have the following parse options
 
const public systemServiceParseOptions = SystemServiceParseOptions
 backwards-compatible definition
 
const public ServiceParseOptionList
 valid additional parse options for services
 
const public WISInitializing = "initializing"
 workflow instance status: initializing
 
const public WISRunning = "running"
 workflow instance status: running
 
const public WISWaiting = "waiting"
 workflow instance status: waiting
 
const public WISStopping = "stopping"
 workflow instance status: stopping
 
const public StatComplete = "COMPLETE"
 This status indicates that the object it is attached to has successfully completed its processing. More...
 
const public StatError = "ERROR"
 Indicates that the workflow order data instance has at least one step with an OMQ::StatError status. More...
 
const public StatWaiting = "WAITING"
 Indicates that subworkflow steps are in progress and the system is waiting on the subworkflows to become OMQ::StatComplete. More...
 
const public StatInProgress = "IN-PROGRESS"
 Indicates that the workflow order data instance is currently being processed. More...
 
const public StatIncomplete = "INCOMPLETE"
 Indicates that processing for the workflow order data instance is not yet complete yet has no errors. More...
 
const public 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...
 
const public 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...
 
const public StatRetry = "RETRY"
 Indicates that workflow processing on the order data instance has generated an error and is now waiting for an automatic retry. More...
 
const public StatCanceled = "CANCELED"
 Indicates that workflow order data instance processing has been canceled. More...
 
const public StatReady = "READY"
 Indicates that a workflow order data instance has been created and is waiting for processing to start. More...
 
const public 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...
 
const public StatBlocked = "BLOCKED"
 Indicates that workflow order data instance processing has been temporarily blocked. More...
 
const public SQLStatComplete = "C"
 SQL Status: COMPLETE. More...
 
const public SQLStatError = "E"
 SQL Status: ERROR. More...
 
const public SQLStatWaiting = "W"
 SQL Status: WAITING. More...
 
const public SQLStatInProgress = "I"
 SQL Status: IN-PROGRESS. More...
 
const public SQLStatIncomplete = "N"
 SQL Status: INCOMPLETE. More...
 
const public SQLStatAsyncWaiting = "A"
 SQL Status: ASYNC-WAITING. More...
 
const public SQLStatEventWaiting = "V"
 SQL Status: EVENT-WAITING. More...
 
const public SQLStatRetry = "R"
 SQL Status: RETRY. More...
 
const public SQLStatCanceled = "X"
 SQL Status: CANCELED. More...
 
const public SQLStatReady = "Y"
 SQL Status: READY. More...
 
const public SQLStatScheduled = "S"
 SQL Status: SCHEDULED. More...
 
const public SQLStatBlocked = "B"
 SQL Status: BLOCKED. More...
 
const public StatMap
 map from text descriptions to SQL status characters
 
const public SQLStatMap
 hash mapping SQL status characters to text descriptions
 
const public ES_Fatal = "FATAL"
 Error Severity: FATAL.
 
const public ES_Major = "MAJOR"
 Error Severity: MAJOR.
 
const public ES_Minor = "MINOR"
 Error Severity: MINOR, identical in function to WARNING and INFO.
 
const public ES_Warning = "WARNING"
 Error Severity: WARNING, identical in function to MINOR and INFO.
 
const public ES_Info = "INFO"
 Error Severity: INFO, identical in function to WARNING and MINOR.
 
const public ES_None = "NONE"
 Error Severity: NONE.
 
const public ErrorSeverityOrder
 map giving the relative importance of each error code
 
const public ErrorSeverityMap
 map from error importance rankings to codes
 
const public ErrLevelAuto = "AUTO"
 auto level: global if no global error exists, workflow if a global exists and differs from the current definition More...
 
const public ErrLevelGlobal = "GLOBAL"
 global level: the error will be created at the global level More...
 
const public ErrLevelWorkflow = "WORKFLOW"
 workflow level: the error will always be created at the workflow level More...
 
const public ErrLevelTypes
 oload error definition level type hash
 
const public CS_Clean = "C"
 order went to COMPLETE without any errors
 
const public CS_RecoveredAuto = "A"
 order went to COMPLETE after being recovered automatically
 
const public CS_RecoveredManual = "M"
 order went to COMPLETE after being recovered with manual retries
 
const public WM_Normal = "NORMAL"
 Workflow Mode: NORMAL.
 
const public WM_Recovery = "RECOVERY"
 Workflow Mode: RECOVERY.
 
const public WM_Synchronous = "SYNCHRONOUS"
 Workflow Mode: SYNCHRONOUS. More...
 
const public LL_CRITICAL = -1
 Log Level: CRITICAL -> Logger::LoggerLevel::FATAL.
 
const public LL_IMPORTANT = 0
 Log Level: IMPORTANT -> Logger::LoggerLevel::INFO.
 
const public LL_INFO = 1
 Log Level: INFO -> Logger::LoggerLevel::INFO.
 
const public LL_DETAIL_1 = 2
 Log Level: DETAIL_1 -> Logger::LoggerLevel::INFO.
 
const public LL_DETAIL_2 = 3
 Log Level: DETAIL_2 -> Logger::LoggerLevel::INFO.
 
const public LL_DEBUG_1 = 4
 Log Level: DEBUG_1 -> Logger::LoggerLevel::DEBUG.
 
const public LL_DEBUG_2 = 5
 Log Level: DEBUG_2 -> Logger::LoggerLevel::DEBUG.
 
const public LL_DEBUG_3 = 6
 Log Level: DEBUG_3 -> Logger::LoggerLevel::DEBUG.
 
const public StatusOrder
 map giving the relative ranking of status codes (text code -> numeric ranking)
 
const public SpecialStatusOrder
 map giving the relative ranking of status codes (text code -> numeric ranking), including IN-PROGRESS
 
const public ArrayStatusOrder
 map giving the relative ranking of status codes (text code -> numeric ranking), for calculating array step status
 
const public QS_Waiting = "WAITING"
 Queue Status Text Description: WAITING. More...
 
const public QS_Received = "RECEIVED"
 Queue Status Text Description: RECEIVED. More...
 
const public QS_Error = "ERROR"
 Queue Status Text Description: ERROR. More...
 
const public QS_Used = "USED"
 Queue Status Text Description: USED. More...
 
const public QS_ALL = ( QS_Waiting, QS_Received, QS_Error, QS_Used )
 list of all queue status descriptions
 
const public SQL_QS_Waiting = "W"
 Queue Status SQL Character Code: WAITING. More...
 
const public SQL_QS_Received = "R"
 Queue Status SQL Character Code: RECEIVED. More...
 
const public SQL_QS_Error = "E"
 Queue Status SQL Character Code: ERROR. More...
 
const public SQL_QS_Used = "X"
 Queue Status SQL Character Code: USED. More...
 
const public SQL_QS_ALL = ( SQL_QS_Waiting, SQL_QS_Received, SQL_QS_Error, SQL_QS_Used )
 list of all queue status character codes
 
const public QSMap
 map of queue status descriptions to the character code
 
const public SQLQSMap
 map of queue status character codes to the description
 
const public omq_option_aliases
 Qorus server option alias hash.
 
const public client_option_aliases
 Qorus client option alias hash.
 
const public QR_LOGIN = "LOGIN"
 RBAC System Permission: "LOGIN". More...
 
const public QR_SHUTDOWN = "SHUTDOWN"
 RBAC System Permission: "SHUTDOWN". More...
 
const public QR_WORKFLOW_CONTROL = "WORKFLOW-CONTROL"
 RBAC System Permission: "WORKFLOW-CONTROL". More...
 
const public QR_WORKFLOW_EXEC_CONTROL = "WORKFLOW-EXEC-CONTROL"
 RBAC System Permission: "WORKFLOW-EXEC-CONTROL". More...
 
const public QR_START_WORKFLOW = "START-WORKFLOW"
 RBAC System Permission: "START-WORKFLOW". More...
 
const public QR_STOP_WORKFLOW = "STOP-WORKFLOW"
 RBAC System Permission: "STOP-WORKFLOW". More...
 
const public QR_RESET_WORKFLOW = "RESET-WORKFLOW"
 RBAC System Permission: "RESET-WORKFLOW". More...
 
const public QR_WORKFLOW_OPTION_CONTROL = "WORKFLOW-OPTION-CONTROL"
 RBAC System Permission: "WORKFLOW-OPTION-CONTROL". More...
 
const public QR_WORKFLOW_ERROR_CONTROL = "WORKFLOW-ERROR-CONTROL"
 RBAC System Permission: "WORKFLOW-ERROR-CONTROL". More...
 
const public QR_WORKFLOW_ORDER_CONTROL = "WORKFLOW-ORDER-CONTROL"
 RBAC System Permission: "WORKFLOW-ORDER-CONTROL". More...
 
const public QR_RETRY_WORKFLOW_ORDER = "RETRY-WORKFLOW-ORDER"
 RBAC System Permission: "RETRY-WORKFLOW-ORDER". More...
 
const public QR_RESCHEDULE_WORKFLOW_ORDER = "RESCHEDULE-WORKFLOW-ORDER"
 RBAC System Permission: "RESCHEDULE-WORKFLOW-ORDER". More...
 
const public QR_REPRIORITIZE_WORKFLOW_ORDER = "REPRIORITIZE-WORKFLOW-ORDER"
 RBAC System Permission: "REPRIORITIZE-WORKFLOW-ORDER". More...
 
const public QR_BLOCK_WORKFLOW_ORDER = "BLOCK-WORKFLOW-ORDER"
 RBAC System Permission: "BLOCK-WORKFLOW-ORDER". More...
 
const public QR_CANCEL_WORKFLOW_ORDER = "CANCEL-WORKFLOW-ORDER"
 RBAC System Permission: "CANCEL-WORKFLOW-ORDER". More...
 
const public QR_SET_WORKFLOW_ORDER_ERROR = "SET-WORKFLOW-ORDER-ERROR"
 RBAC System Permission: "SET-WORKFLOW-ORDER-ERROR". More...
 
const public QR_SKIP_STEP = "SKIP-STEP"
 RBAC System Permission: "SKIP-STEP". More...
 
const public QR_SET_ORDER_INFO = "SET-ORDER-INQR_O"
 RBAC System Permission: "SET-ORDER-INFO"QR_. More...
 
const public QR_POST_WORKFLOW_EVENT = "POST-WORKFLOW-EVENT"
 RBAC System Permission: "POST-WORKFLOW-EVENT". More...
 
const public QR_LOCK_WORKFLOW_ORDER = "LOCK-WORKFLOW-ORDER"
 RBAC System Permission: "LOCK-WORKFLOW-ORDER". More...
 
const public QR_BREAK_WORKFLOW_ORDER_LOCK = "BREAK-WORKFLOW-ORDER-LOCK"
 RBAC System Permission: "BREAK-WORKFLOW-ORDER-LOCK". More...
 
const public QR_EDIT_WORKFLOW_DATA = "EDIT-WORKFLOW-DATA"
 RBAC System Permission: "EDIT-WORKFLOW-DATA". More...
 
const public QR_READ_SENSITIVE_DATA = "READ-SENSITIVE-DATA"
 RBAC System Permission: "READ-SENSITIVE-DATA";. More...
 
const public QR_EDIT_SENSITIVE_DATA = "EDIT-SENSITIVE-DATA"
 RBAC System Permission: "EDIT-SENSITIVE-DATA";. More...
 
const public QR_DELETE_SENSITIVE_DATA = "DELETE-SENSITIVE-DATA"
 RBAC System Permission: "DELETE-SENSITIVE-DATA";. More...
 
const public QR_SENSITIVE_DATA_CONTROL = "SENSITIVE-DATA-CONTROL"
 RBAC System Permission: "SENSITIVE-DATA-CONTROL";. More...
 
const public QR_EXEC_SYNC_WORKFLOW = "EXEC-SYNC-WORKFLOW"
 RBAC System Permission: "EXEC-SYNC-WORKFLOW". More...
 
const public QR_SUBMIT_ORDER = "SUBMIT-ORDER"
 RBAC System Permission: "SUBMIT-ORDER". More...
 
const public QR_SET_STEP_CONFIG = "SET-STEP-CONFIG"
 RBAC System Permissions: "SET-STEP-CONFIG". More...
 
const public QR_SET_WORKFLOW_CONFIG = "SET-WORKFLOW-CONFIG"
 RBAC System Permissions: "SET-WORKFLOW-CONFIG". More...
 
const public QR_SERVICE_CONTROL = "SERVICE-CONTROL"
 RBAC System Permission: "SERVICE-CONTROL". More...
 
const public QR_LOAD_SERVICE = "LOAD-SERVICE"
 RBAC System Permission: "LOAD-SERVICE". More...
 
const public QR_UNLOAD_SERVICE = "UNLOAD-SERVICE"
 RBAC System Permission: "UNLOAD-SERVICE". More...
 
const public QR_RESET_SERVICE = "RESET-SERVICE"
 RBAC System Permission: "RESET-SERVICE". More...
 
const public QR_SET_SERVICE_AUTOSTART = "SET-SERVICE-AUTOSTART"
 RBAC System Permission: "SET-SERVICE-AUTOSTART". More...
 
const public QR_SET_SERVICE_OPTIONS = "SET-SERVICE-OPTIONS"
 RBAC System Permission: "SET-SERVICE-OPTIONS". More...
 
const public QR_CALL_USER_SERVICES_RO = "CALL-USER-SERVICES-RO"
 RBAC System Permission: "CALL-USER-SERVICES-RO". More...
 
const public QR_CALL_SYSTEM_SERVICES_RO = "CALL-SYSTEM-SERVICES-RO"
 RBAC System Permission: "CALL-SYSTEM-SERVICES-RO". More...
 
const public QR_CALL_USER_SERVICES_RW = "CALL-USER-SERVICES-RW"
 RBAC System Permission: "CALL-USER-SERVICES-RW". More...
 
const public QR_CALL_SYSTEM_SERVICES_RW = "CALL-SYSTEM-SERVICES-RW"
 RBAC System Permission: "CALL-SYSTEM-SERVICES-RW". More...
 
const public QR_SET_SERVICE_CONFIG = "SET-SERVICE-CONFIG"
 RBAC System Permissions: "SET-SERVICE-CONFIG". More...
 
const public QR_SERVICE_OPTION_CONTROL = "SERVICE-OPTION-CONTROL"
 RBAC System Permission: "SERVICE-OPTION-CONTROL". More...
 
const public QR_USER_CONTROL = "USER-CONTROL"
 RBAC System Permission: "USER-CONTROL". More...
 
const public QR_RELOAD_RBAC = "RELOAD-RBAC"
 RBAC System Permission: "RELOAD-RBAC". More...
 
const public QR_ADD_USER = "ADD-USER"
 RBAC System Permission: "ADD-USER". More...
 
const public QR_MODIFY_USER = "MODIFY-USER"
 RBAC System Permission: "MODIFY-USER". More...
 
const public QR_DELETE_USER = "DELETE-USER"
 RBAC System Permission: "DELETE-USER". More...
 
const public QR_ADD_PERMISSION = "ADD-PERMISSION"
 RBAC System Permission: "ADD-PERMISSION". More...
 
const public QR_MODIFY_PERMISSION = "MODIFY-PERMISSION"
 RBAC System Permission: "MODIFY-PERMISSION". More...
 
const public QR_DELETE_PERMISSION = "DELETE-PERMISSION"
 RBAC System Permission: "DELETE-PERMISSION". More...
 
const public QR_ADD_ROLE = "ADD-ROLE"
 RBAC System Permission: "ADD-ROLE". More...
 
const public QR_MODIFY_ROLE = "MODIFY-ROLE"
 RBAC System Permission: "MODIFY-ROLE". More...
 
const public QR_DELETE_ROLE = "DELETE-ROLE"
 RBAC System Permission: "DELETE-ROLE". More...
 
const public QR_OPTION_CONTROL = "OPTION-CONTROL"
 RBAC System Permission: "OPTION-CONTROL". More...
 
const public QR_LOGGER_CONTROL = "LOGGER-CONTROL"
 RBAC System Permission: "LOGGER-CONTROL". More...
 
const public QR_ROTATE_LOG_FILES = "ROTATE-LOG-FILES"
 RBAC System Permission: "ROTATE-LOG-FILES". More...
 
const public QR_MODIFY_LOGGER = "MODIFY-LOGGER"
 RBAC System Permission: "MODIFY-LOGGER". More...
 
const public QR_DELETE_LOGGER = "DELETE-LOGGER"
 RBAC System Permission: "DELETE-LOGGER". More...
 
const public QR_CREATE_LOGGER = "CREATE-LOGGER"
 RBAC System Permission: "CREATE-LOGGER". More...
 
const public QR_DATASOURCE_CONTROL = "DATASOURCE-CONTROL"
 RBAC System Permission: "DATASOURCE-CONTROL". More...
 
const public QR_READ_DATASOURCE = "READ-DATASOURCE"
 RBAC System Permission: "READ-DATASOURCE". More...
 
const public QR_ADD_DATASOURCE = "ADD-DATASOURCE"
 RBAC System Permission: "ADD-DATASOURCE". More...
 
const public QR_SELECT_DATASOURCE = "SELECT-DATASOURCE"
 RBAC System Permission: "SELECT-DATASOURCE". More...
 
const public QR_MODIFY_DATASOURCE = "MODIFY-DATASOURCE"
 RBAC System Permission: "MODIFY-DATASOURCE". More...
 
const public QR_RESET_DATASOURCE = "RESET-DATASOURCE"
 RBAC System Permission: "RESET-DATASOURCE". More...
 
const public QR_DELETE_DATASOURCE = "DELETE-DATASOURCE"
 RBAC System Permission: "DELETE-DATASOURCE". More...
 
const public QR_RELOAD_DATASOURCE = "RELOAD-DATASOURCE"
 RBAC System Permission: "RELOAD-DATASOURCE". More...
 
const public QR_FLUSH_DATASOURCE = "FLUSH-DATASOURCE"
 RBAC System Permission: "FLUSH-DATASOURCE". More...
 
const public QR_SQLUTIL_READ = "SQLUTIL-READ"
 RBAC System Permission: "SQLUTIL-READ". More...
 
const public QR_SQLUTIL_WRITE = "SQLUTIL-WRITE"
 RBAC System Permission: "SQLUTIL-WRITE". More...
 
const public QR_GROUP_CONTROL = "GROUP-CONTROL"
 RBAC System Permission: "GROUP-CONTROL". More...
 
const public QR_ADD_GROUP = "ADD-GROUP"
 RBAC System Permission: "ADD-GROUP". More...
 
const public QR_MODIFY_GROUP = "MODIFY-GROUP"
 RBAC System Permission: "MODIFY-GROUP". More...
 
const public QR_DELETE_GROUP = "DELETE-GROUP"
 RBAC System Permission: "DELETE-GROUP". More...
 
const public QR_MODIFY_GROUP_STATUS = "MODIFY-GROUP-STATUS"
 RBAC System Permission: "MODIFY-GROUP-STATUS". More...
 
const public QR_SERVER_CONTROL = "SERVER-CONTROL"
 RBAC System Permission: "SERVER-CONTROL". More...
 
const public QR_SET_PROPERTY = "SET-PROPERTY"
 RBAC System Permission: "SET-PROPERTY". More...
 
const public QR_DELETE_PROPERTY = "DELETE-PROPERTY"
 RBAC System Permission: "DELETE-PROPERTY". More...
 
const public QR_RELOAD_PROPERTIES = "RELOAD-PROPERTIES"
 RBAC System Permission: "RELOAD-PROPERTIES". More...
 
const public QR_START_LISTENER = "START-LISTENER"
 RBAC System Permission: "START-LISTENER". More...
 
const public QR_STOP_LISTENER = "STOP-LISTENER"
 RBAC System Permission: "STOP-LISTENER". More...
 
const public QR_JOB_CONTROL = "JOB-CONTROL"
 RBAC System Permission: "JOB-CONTROL". More...
 
const public QR_RUN_JOB = "RUN-JOB"
 RBAC System Permission: "RUN-JOB". More...
 
const public QR_MODIFY_JOB_STATUS = "MODIFY-JOB-STATUS"
 RBAC System Permission: "MODIFY-JOB-STATUS". More...
 
const public QR_MODIFY_JOB_EXPIRY = "MODIFY-JOB-EXPIRY"
 RBAC System Permission: "MODIFY-JOB-EXPIRY". More...
 
const public QR_RESCHEDULE_JOB = "RESCHEDULE-JOB"
 RBAC System Permission: "RESCHEDULE-JOB". More...
 
const public QR_RESET_JOB = "RESET-JOB"
 RBAC System Permission: "RESET-JOB". More...
 
const public QR_SET_JOB_OPTIONS = "SET-JOB-OPTIONS"
 RBAC System Permission: "SET-JOB-OPTIONS". More...
 
const public QR_SET_JOB_CONFIG = "SET-JOB-CONFIG"
 RBAC System Permissions: "SET-JOB-CONFIG". More...
 
const public QR_JOB_OPTION_CONTROL = "JOB-OPTION-CONTROL"
 RBAC System Permission: "JOB-OPTION-CONTROL". More...
 
const public QR_SCHEMA_CONTROL = "SCHEMA-CONTROL"
 RBAC System Permission: "SCHEMA-CONTROL". More...
 
const public QR_USER_CONNECTION_CONTROL = "USER-CONNECTION-CONTROL"
 RBAC System Permission: "USER-CONNECTION-CONTROL". More...
 
const public QR_READ_USER_CONNECTION = "READ-USER-CONNECTION"
 RBAC System Permission: "READ-USER-CONNECTION". More...
 
const public QR_RELOAD_USER_CONNECTION = "RELOAD-USER-CONNECTION"
 RBAC System Permission: "RELOAD-USER-CONNECTION". More...
 
const public QR_ADD_USER_CONNECTION = "ADD-USER-CONNECTION"
 RBAC System Permission: "ADD-USER-CONNECTION". More...
 
const public QR_MODIFY_USER_CONNECTION = "MODIFY-USER-CONNECTION"
 RBAC System Permission: "MODIFY-USER-CONNECTION". More...
 
const public QR_DELETE_USER_CONNECTION = "DELETE-USER-CONNECTION"
 RBAC System Permission: "DELETE-USER-CONNECTION". More...
 
const public QR_SERVER_CONNECTION_CONTROL = "SERVER-CONNECTION-CONTROL"
 RBAC System Permission: "SERVER-CONNECTION-CONTROL". More...
 
const public QR_RELOAD_SERVER_CONNECTION = "RELOAD-SERVER-CONNECTION"
 RBAC System Permission: "RELOAD-SERVER-CONNECTION". More...
 
const public QR_READ_SERVER_CONNECTION = "READ-SERVER-CONNECTION"
 RBAC System Permission: "READ-SERVER-CONNECTION". More...
 
const public QR_ADD_SERVER_CONNECTION = "ADD-SERVER-CONNECTION"
 RBAC System Permission: "ADD-SERVER-CONNECTION". More...
 
const public QR_MODIFY_SERVER_CONNECTION = "MODIFY-SERVER-CONNECTION"
 RBAC System Permission: "MODIFY-SERVER-CONNECTION". More...
 
const public QR_DELETE_SERVER_CONNECTION = "DELETE-SERVER-CONNECTION"
 RBAC System Permission: "DELETE-SERVER-CONNECTION". More...
 
const public QR_FILESYSTEM_CONTROL = "FILESYSTEM-CONTROL"
 RBAC System Permission: "FILESYSTEM-CONTROL". More...
 
const public QR_FILESYSTEM_READ = "FILESYSTEM-READ"
 RBAC System Permission: "FILESYSTEM-READ". More...
 
const public QR_FILESYSTEM_WRITE = "FILESYSTEM-WRITE"
 RBAC System Permission: "FILESYSTEM-WRITE". More...
 
const public QR_MAPPER_CONTROL = "MAPPER-CONTROL"
 RBAC System Permission: "MAPPER-CONTROL". More...
 
const public QR_RELOAD_MAPPER = "RELOAD-MAPPER"
 RBAC System Permission: "RELOAD-MAPPER". More...
 
const public QR_MODIFY_MAPPER = "MODIFY-MAPPER"
 RBAC System Permission: "MODIFY-MAPPER". More...
 
const public QR_VALUE_MAP_CONTROL = "VALUE-MAP-CONTROL"
 RBAC System Permission: "VALUE-MAP-CONTROL". More...
 
const public QR_RELOAD_VALUE_MAP = "RELOAD-VALUE-MAP"
 RBAC System Permission: "RELOAD-VALUE-MAP". More...
 
const public QR_MODIFY_VALUE_MAP = "MODIFY-VALUE-MAP"
 RBAC System Permission: "MODIFY-VALUE-MAP". More...
 
const public QR_CREATE_SLA = "CREATE-SLA"
 RBAC System Permission: "CREATE-SLA". More...
 
const public QR_DELETE_SLA = "DELETE-SLA"
 RBAC System Permission: "DELETE-SLA". More...
 
const public QR_MODIFY_SLA = "MODIFY-SLA"
 RBAC System Permission: "MODIFY-SLA". More...
 
const public QR_SLA_CONTROL = "SLA-CONTROL"
 RBAC System Permission: "SLA-CONTROL". More...
 
const public QR_DEBUG_CONTROL = "DEBUG-CONTROL"
 RBAC System Permission: "DEBUG-CONTROL". More...
 
const public QR_REMOTE_DEPLOYMENT = "REMOTE-DEPLOYMENT"
 RBAC System Permission: "REMOTE-DEPLOYMENT". More...
 
const public QR_REMOTE_DELETE_INTERFACE = "REMOTE-DELETE-INTERFACE"
 RBAC System Permission: "REMOTE-DELETE-INTERFACE". More...
 
const public QR_REMOTE_RELEASE = "REMOTE-RELEASE"
 RBAC System Permission: "REMOTE-RELEASE". More...
 
const public QR_REMOTE_EXEC_ALL = "REMOTE-EXEC-ALL"
 RBAC System Permission: "REMOTE-EXEC-ALL". More...
 
const public QR_KILL_PROCESS = "KILL-PROCESS"
 RBAC System Permission: "KILL-PROCESS". More...
 
const public QR_DATA_PROVIDER_CONTROL = "DATA-PROVIDER-CONTROL"
 Data Provider System Permission: "DATA-PROVIDER-CONTROL". More...
 
const public QR_DATA_PROVIDER_CREATE = "DATA-PROVIDER-CREATE"
 Data Provider System Permission: "DATA-PROVIDER-CREATE". More...
 
const public QR_DATA_PROVIDER_READ = "DATA-PROVIDER-READ"
 Data Provider System Permission: "DATA-PROVIDER-READ". More...
 
const public QR_DATA_PROVIDER_UPDATE = "DATA-PROVIDER-UPDATE"
 Data Provider System Permission: "DATA-PROVIDER-UPDATE". More...
 
const public QR_DATA_PROVIDER_DELETE = "DATA-PROVIDER-DELETE"
 Data Provider System Permission: "DATA-PROVIDER-DELETE". More...
 
const public QR_DATA_PROVIDER_REQUEST = "DATA-PROVIDER-REQUEST"
 Data Provider System Permission: "DATA-PROVIDER-REQUEST". More...
 
const public QR_TYPE_CACHE_CONTROL = "TYPE-CACHE-CONTROL"
 Type Cache System Permission: "TYPE-CACHE-CONTROL". More...
 
const public QR_TYPE_CACHE_RELOAD = "TYPE-CACHE-RELOAD"
 Type Cache System Permission: "TYPE-CACHE-RELOAD". More...
 
const public QR_TYPE_CACHE_CREATE = "TYPE-CACHE-CREATE"
 Type Cache System Permission: "TYPE-CACHE-CREATE". More...
 
const public QR_TYPE_CACHE_DELETE = "TYPE-CACHE-DELETE"
 Type Cache System Permission: "TYPE-CACHE-DELETE". More...
 
const public QR_SET_FSM_CONFIG = "SET-FSM-CONFIG"
 Finite State Machine System Permission: "SET-FSM-CONFIG". More...
 
const public QR_SET_PIPELINE_CONFIG = "SET-PIPELINE-CONFIG"
 Pipeline System Permission: "SET-PIPELINE-CONFIG". More...
 
const public QR_UPLOAD = "UPLOAD"
 Remote Command System Permission: "UPLOAD". More...
 
const public QR_WEBDAV_CONTROL = "WEBDAV-CONTROL"
 Remote Command System Permission: "WEBDAV-CONTROL". More...
 
const public QR_WEBDAV_ACCESS_ALL = "WEBDAV-ACCESS-ALL"
 Remote Command System Permission: "WEBDAV-ACCESS-ALL". More...
 
const public QR_WEBDAV_RWD = "WEBDAV-RWD"
 Remote Command System Permission: "WEBDAV-RWD". More...
 
const public QR_WEBDAV_READ = "WEBDAV-READ"
 Remote Command System Permission: "WEBDAV-READ". More...
 
const public QR_WEBDAV_WRITE = "WEBDAV-WRITE"
 Remote Command System Permission: "WEBDAV-WRITE". More...
 
const public QR_WEBDAV_DELETE = "WEBDAV-DELETE"
 Remote Command System Permission: "WEBDAV-DELETE". More...
 
const public QR_SCALING = "SCALING"
 Remote Command System Permission: "SCALING". More...
 
const public QR_CREATOR_CONTROL = "CREATOR-CONTROL"
 Remote Command System Permission: "CREATOR-CONTROL". More...
 
const public QR_CREATOR_CREATE = "CREATOR-CREATE"
 Remote Command System Permission: "CREATOR-CREATE". More...
 
const public QR_CREATOR_DELETE = "CREATOR-DELETE"
 Remote Command System Permission: "CREATOR-DELETE". More...
 
const public QR_CREATOR_UPDATE = "CREATOR-UPDATE"
 Remote Command System Permission: "CREATOR-UPDATE". More...
 
const public AUTH_OVERRIDE_ERROR = 1001
 RBAC Authorization Error Code.
 
const public AUTH_INVALID_USER_OR_PASSWORD = 1002
 RBAC Authorization Error Code.
 
const public AUTH_UNAUTHORIZED = 1003
 RBAC Authorization Error Code.
 
const public AUTH_REQUIRES_AUTHORIZATION = 1004
 RBAC Authorization Error Code.
 
const public AUTH_INVALID_USERNAME = 1005
 RBAC Authorization Error Code.
 
const public AUTH_USER_ALREADY_EXISTS = 1006
 RBAC Authorization Error Code.
 
const public AUTH_INVALID_PERMISSION = 1007
 RBAC Authorization Error Code.
 
const public AUTH_INVALID_USER = 1008
 RBAC Authorization Error Code.
 
const public AUTH_MISSING_USERNAME = 1009
 RBAC Authorization Error Code.
 
const public AUTH_MISSING_DESCRIPTION = 1010
 RBAC Authorization Error Code.
 
const public AUTH_MISSING_PERMISSION = 1011
 RBAC Authorization Error Code.
 
const public AUTH_MISSING_ROLE = 1012
 RBAC Authorization Error Code.
 
const public AUTH_INVALID_ROLE = 1013
 RBAC Authorization Error Code.
 
const public AUTH_ROLE_ALREADY_EXISTS = 1014
 RBAC Authorization Error Code.
 
const public AUTH_PERMISSION_ALREADY_EXISTS = 1015
 RBAC Authorization Error Code.
 
const public AUTH_CANNOT_UPDATE_SYSTEM_PERMISSION = 1016
 RBAC Authorization Error Code.
 
const public AUTH_CANNOT_DELETE_PERMISSION_IN_USE = 1017
 RBAC Authorization Error Code.
 
const public AUTH_INVALID_GROUP = 1018
 RBAC Authorization Error Code.
 
const public AUTH_INVALID_WORKFLOW = 1019
 RBAC Authorization Invalid Workflow Error Code.
 
const public AUTH_INVALID_SERVICE = 1020
 RBAC Authorization Invalid Service Error Code.
 
const public AUTH_INVALID_JOB = 1021
 RBAC Authorization Invalid Workflow Error Code.
 
const public AUTH_NO_SUCH_ROLE = 1022
 RBAC Authorization Error Code.
 
const public XMLRPC_INVALID_XML = 2001
 error code for invalid XML revied by the XML-RPC handler
 
const public QEM_FILTER_CRITERIA_HASH
 valid event filter criteria code hash
 
const public QEM_FILTER_CRITERIA = QEM_FILTER_CRITERIA_HASH.keys()
 valid event filter criteria code list
 
const public QE_CLASS_SYSTEM = 101
 Event Class Code for SYSTEM Events.
 
const public QE_CLASS_WORKFLOW = 102
 Event Class Code for WORKFLOW Events.
 
const public QE_CLASS_SERVICE = 103
 Event Class Code for SERVICE Events.
 
const public QE_CLASS_USER = 104
 Event Class Code for USER Events.
 
const public QE_CLASS_JOB = 105
 Event Class Code for JOB Events.
 
const public QE_CLASS_ALERT = 106
 Event Class Code for ALERT Events.
 
const public QE_CLASS_GROUP = 107
 Event Class Code for GROUP Events.
 
const public QE_CLASS_CONNECTION = 108
 Event Class Code for CONNECTION events.
 
const public QE_CLASS_PROCESS = 109
 Event Class Code for PROCESS events. More...
 
const public QE_CLASS_CLUSTER = 110
 Event Class Code for CLUSTER events. More...
 
const public QE_CLASS_LOGGER = 111
 Event Class Code for LOGGER events. More...
 
const public QE_CLASS_CONFIG_ITEM = 112
 Event Class Code for CONFIG ITEM events. More...
 
const public QE_CLASS_CLASS = 113
 Event Class Code for CLASS events. More...
 
const public QE_MAP_CLASS
 hash mapping event class codes to descriptive strings
 
const public QE_RMAP_CLASS = map {$1.value: $1.key.toInt()}
 hash mapping event class descriptive strings to class codes
 
const public QEC_SYSTEM_STARTUP = 1001
 Qorus Event Code: SYSTEM_STARTUP. More...
 
const public QEC_SYSTEM_SHUTDOWN = 1002
 Qorus Event Code: SYSTEM_SHUTDOWN. More...
 
const public QEC_SYSTEM_ERROR = 1003
 Qorus Event Code: SYSTEM_ERROR. More...
 
const public QEC_SYSTEM_HEALTH_CHANGED = 1004
 Qorus Event Code: SYSTEM_HEALTH_CHANGED. More...
 
const public QEC_SYSTEM_REMOTE_HEALTH_CHANGED = 1005
 Qorus Event Code: SYSTEM_REMOTE_HEALTH_CHANGED. More...
 
const public QEC_SYSTEM_SCALED = 1006
 Qorus Event Code: SYSTEM_SCALED. More...
 
const public QEC_GROUP_STATUS_CHANGED = 1101
 Qorus Event Code: GROUP_STATUS_CHANGED. More...
 
const public QEC_WORKFLOW_START = 2001
 Qorus Event Code: WORKFLOW_START. More...
 
const public QEC_WORKFLOW_STOP = 2002
 Qorus Event Code: WORKFLOW_STOP. More...
 
const public QEC_WORKFLOW_CACHE_RESET = 2003
 Qorus Event Code: WORKFLOW_CACHE_RESET. More...
 
const public QEC_WORKFLOW_DATA_SUBMITTED = 2004
 Qorus Event Code: WORKFLOW_DATA_SUBMITTED. More...
 
const public QEC_WORKFLOW_DATA_ERROR = 2005
 Qorus Event Code: WORKFLOW_DATA_ERROR. More...
 
const public QEC_WORKFLOW_DATA_RELEASED = 2006
 Qorus Event Code: WORKFLOW_DATA_RELEASED (workflow detach event) More...
 
const public QEC_WORKFLOW_DATA_CACHED = 2007
 Qorus Event Code: WORKFLOW_DATA_CACHED (workflow attach event) More...
 
const public QEC_WORKFLOW_INFO_CHANGED = 2008
 Qorus Event Code: WORKFLOW_INFO_CHANGED. More...
 
const public QEC_WORKFLOW_STATUS_CHANGED = 2009
 Qorus Event Code: WORKFLOW_STATUS_CHANGED. More...
 
const public QEC_WORKFLOW_STEP_PERFORMANCE = 2010
 Qorus Event Code:: WORKFLOW_STEP_PERFORMANCE. More...
 
const public QEC_WORKFLOW_PERFORMANCE = 2011
 Qorus Event Code:: WORKFLOW_PERFORMANCE. More...
 
const public QEC_WORKFLOW_DATA_LOCKED = 2012
 Qorus Event Code: WORKFLOW_DATA_LOCKED. More...
 
const public QEC_WORKFLOW_DATA_UNLOCKED = 2013
 Qorus Event Code: WORKFLOW_DATA_UNLOCKED. More...
 
const public QEC_WORKFLOW_DATA_UPDATED = 2014
 Qorus Event Code: WORKFLOW_DATA_UPDATED (static or dynamic data changed) More...
 
const public QEC_WORKFLOW_STATS_UPDATED = 2015
 Qorus Event Code: WORKFLOW_STATS_UPDATED. More...
 
const public QEC_WORKFLOW_RECOVERED = 2016
 Qorus Event Code: WORKFLOW_RECOVERED. More...
 
const public QEC_WORKFLOW_UPDATED = 2017
 Qorus Event code: WORKFLOW_UPDATED. More...
 
const public QEC_WORKFLOW_STEP_DATA_UPDATED = 2018
 Qorus Event Code: WORKFLOW_STEP_DATA_UPDATED (step dynamic data changed) More...
 
const public QEC_SERVICE_START = 3001
 Qorus Event Code: SERVICE_START. More...
 
const public QEC_SERVICE_STOP = 3002
 Qorus Event Code: SERVICE_STOP. More...
 
const public QEC_SERVICE_ERROR = 3003
 Qorus Event Code: SERVICE_ERROR. More...
 
const public QEC_SERVICE_AUTOSTART_CHANGE = 3004
 Qorus Event Code: SERVICE_AUTOSTART_CHANGE. More...
 
const public QEC_SERVICE_METHOD_PERFORMANCE = 3005
 Qorus Event Code:: SERVICE_METHOD_PERFORMANCE. More...
 
const public QEC_SERVICE_UPDATED = 3006
 Qorus Event code: SERVICE_UPDATED. More...
 
const public QEC_JOB_START = 4001
 Qorus Event Code: JOB_START. More...
 
const public QEC_JOB_STOP = 4002
 Qorus Event Code: JOB_STOP. More...
 
const public QEC_JOB_ERROR = 4003
 Qorus Event Code: JOB_ERROR. More...
 
const public QEC_JOB_INSTANCE_START = 4004
 Qorus Event Code: JOB_INSTANCE_START. More...
 
const public QEC_JOB_INSTANCE_STOP = 4005
 Qorus Event Code: JOB_INSTANCE_STOP. More...
 
const public QEC_JOB_RECOVERED = 4006
 Qorus Event Code: JOB_RECOVERED. More...
 
const public QEC_JOB_UPDATED = 4007
 Qorus Event code: JOB_UPDATED. More...
 
const public QEC_JOB_CREATED = 4008
 Qorus Event code: JOB_CREATED. More...
 
const public QEC_JOB_DELETED = 4009
 Qorus Event code: JOB_DELETED. More...
 
const public QEC_CONFIG_ITEM_CHANGED = 4100
 Qorus Event code: QEC_CONFIG_ITEM_CHANGED. More...
 
const public QEC_ALERT_ONGOING_RAISED = 5006
 Qorus Event Code: ALERT_ONGOING_RAISED. More...
 
const public QEC_ALERT_ONGOING_CLEARED = 5007
 Qorus Event Code: ALERT_ONGOING_CLEARED. More...
 
const public QEC_ALERT_TRANSIENT_RAISED = 5008
 Qorus Event Code: ALERT_TRANSIENT_RAISED. More...
 
const public QEC_CONNECTION_UP = 5101
 Qorus Event Code: CONNECTION_UP. More...
 
const public QEC_CONNECTION_DOWN = 5102
 Qorus Event Code: CONNECTION_DOWN. More...
 
const public QEC_CONNECTION_ENABLED_CHANGE = 5103
 Qorus Event Code: CONNECTION_ENABLED_CHANGE. More...
 
const public QEC_CONNECTION_CREATED = 5104
 Qorus Event Code: CONNECTION_CREATED. More...
 
const public QEC_CONNECTION_UPDATED = 5105
 Qorus Event Code: CONNECTION_UPDATED. More...
 
const public QEC_CONNECTION_DELETED = 5106
 Qorus Event Code: CONNECTION_DELETED. More...
 
const public QEC_CONNECTIONS_RELOADED = 5107
 Qorus Event Code: CONNECTIONS_RELOADED. More...
 
const public QEC_CONNECTION_DEBUG_DATA_CHANGE = 5108
 Qorus Event Code: CONNECTION_DEBUG_DATA_CHANGE. More...
 
const public QEC_LOGGER_CREATED = 5200
 Qorus Event Code: LOGGER_CREATED. More...
 
const public QEC_LOGGER_UPDATED = 5201
 Qorus Event Code: LOGGER_UPDATED. More...
 
const public QEC_LOGGER_DELETED = 5202
 Qorus Event Code: LOGGER_DELETED. More...
 
const public QEC_APPENDER_CREATED = 5203
 Qorus Event Code: APPENDER_CREATED. More...
 
const public QEC_APPENDER_DELETED = 5204
 Qorus Event Code: APPENDER_DELETED. More...
 
const public QEC_APPENDER_UPDATED = 5205
 Qorus Event Code: APPENDER_UPDATED. More...
 
const public QEC_PROCESS_STARTED = 6001
 Qorus Event Code: PROCESS_STARTED. More...
 
const public QEC_PROCESS_STOPPED = 6002
 Qorus Event Code: PROCESS_STOPPED. More...
 
const public QEC_PROCESS_START_ERROR = 6003
 Qorus Event Code: PROCESS_START_ERROR. More...
 
const public QEC_PROCESS_MEMORY_CHANGED = 6004
 Qorus Event Code: PROCESS_MEMORY_CHANGED. More...
 
const public QEC_NODE_INFO = 7001
 Qorus Event Code: NODE_INFO. More...
 
const public QEC_NODE_REMOVED = 7002
 Qorus Event Code: NODE_REMOVED. More...
 
const public QEC_CLASS_CREATED = 8001
 Qorus Event code: CLASS_CREATED. More...
 
const public QEC_CLASS_DELETED = 8002
 Qorus Event code: CLASS_DELETED. More...
 
const public QEC_CLASS_UPDATED = 8003
 Qorus Event code: CLASS_UPDATED. More...
 
const public QEC_USER_EVENT = 9001
 Qorus Event Code: USER_EVENT. More...
 
const public QE_MAP_EVENT
 hash mapping event codes to descriptive strings
 
const public QE_RMAP_EVENT = map {$1.value: $1.key.toInt()}
 hash mapping event descriptive strings to codes
 
const public QorusSystemOptionHash
 master Qorus system option hash for all valid system options
 
const public QorusSystemOptionDefaults
 default values for Qorus system options
 
const public QorusClientOptionHash
 valid Qorus client options in the options file under domain "qorus-client" More...
 
const public QorusClientOptionDefaults
 the following are default values for options when no option is set in the option file
 
const public omq_option_hash = QorusSystemOptionHash
 backwards-compatible constant name for QorusSystemOptionHash
 
const public option_defaults = QorusSystemOptionDefaults
 backwards-compatible constant name for QorusSystemOptionDefaults
 
const public client_option_hash = QorusClientOptionHash
 backwards-compatible constant name for QorusClientOptionHash
 
const public client_defaults = QorusClientOptionDefaults
 backwards-compatible constant name for QorusClientOptionDefaults
 
const public qhaorder_option_hash
 valid options for the "qhaorder" program
 
const public QorusMapperKeys
 Mapper keys to be added to all data provider info hashes. More...
 
const public segment_options = ("async", "retry")
 valid segment options
 
const public SQL_DEF_INIT_BLOCKSIZE = 200
 default SQL blocksize for the initial block for piecewise parallel SQL execution
 
const public SQL_DEF_BLOCKSIZE = 5000
 default SQL blocksize when reading in new data to the WorkflowQueue
 
const public DefaultEventTypeID = 0
 default system workflow synchronization event type ID
 
const public DefaultEventKey = "OMQ-SYSTEM-DEFAULT-EVENT"
 default system workflow synchronization event key
 
const public SystemRoleHash
 Qorus system role hash.
 
const public QSE_OK = 0
 Qorus Startup Error Code: no error.
 
const public QSE_NO_INSTANCE_KEY = 1
 Qorus Startup Error Code: no instance key set.
 
const public QSE_INVALID_DB_MAX_THREADS = 2
 Qorus Startup Error Code: invalid db-max-threads option.
 
const public QSE_DATASOURCE = 3
 Qorus Startup Error Code: can't open system datasources.
 
const public QSE_LOG_ERROR = 4
 Qorus Startup Error Code: error opening system log files.
 
const public QSE_RBAC_ERROR = 5
 Qorus Startup Error Code: error initializing RBAC framework.
 
const public QSE_EVENT_ERROR = 6
 Qorus Startup Error Code: error initializing event framework.
 
const public QSE_SESSION_ERROR = 7
 Qorus Startup Error Code: error opening or recovering application session.
 
const public QSE_COMMAND_LINE_ERROR = 8
 Qorus Startup Error Code: error in command-line options.
 
const public QSE_OPTION_ERROR = 9
 Qorus Startup Error Code: error setting options on startup.
 
const public QSE_VERSION_ONLY = 10
 Qorus Startup Error Code: command-line option requested version display and exit.
 
const public QSE_STARTUP_ERROR = 99
 Qorus Startup Error Code: other error starting server.
 
const public DefaultGroupID = 0
 groupid of the default workflow and service group
 
const public DefaultGroupName = "DEFAULT"
 name of the default workflow and service group
 
const public DefaultOrderPriority = 500
 default order priority
 
const public SQLDescLen = 4000
 default description length in bytes for user objects
 
const public SQLNameLen = 160
 length of name columns in bytes
 
const public SQLAuthorLen = 240
 length of author columns in bytes
 
const public SQLPatchLen = 80
 length of patch columns in bytes
 
const public SQLVersionLen = 80
 length of version columns in bytes
 
const public SQLSensitiveKeyLen = 150
 length of sensitive data keys in bytes More...
 
const public SQLSensitiveValueLen = 150
 length of sensitive data key values in bytes More...
 
const public JS_Complete = "COMPLETE"
 Job Status Text Description: COMPLETE. More...
 
const public JS_InProgress = "IN-PROGRESS"
 Job Status Text Description: IN-PROGRESS. More...
 
const public JS_Error = "ERROR"
 Job Status Text Description: ERROR. More...
 
const public JS_Crash = "CRASH"
 Job Status Text Description: CRASH. More...
 
const public JS_ALL = ( JS_Complete, JS_InProgress, JS_Error, JS_Crash )
 list of all Job status descriptions
 
const public SQL_JS_Complete = "C"
 Job Status SQL Character Code: COMPLETE. More...
 
const public SQL_JS_InProgress = "I"
 Job Status SQL Character Code: IN-PROGRESS. More...
 
const public SQL_JS_Error = "E"
 Job Status SQL Character Code: ERROR. More...
 
const public SQL_JS_Crash = "Z"
 Job Status SQL Character Code: CRASH. More...
 
const public SQL_JS_ALL
 list of all Job status character codes
 
const public JSMap
 map of Job status descriptions to the character code
 
const public SQLJSMap
 map of Job status character codes to the description
 
const public JobParseOptions = CommonParseOptions
 job programs will have the following parse options
 
const public MapperParseOptions1 = CommonParseOptions
 mapper programs will have the following parse options when created before importing modules
 
const public MapperParseOptions2 = PO_LOCKDOWN
 mapper programs will have the following parse options added after importing modules
 
const public MapperParseOptions = MapperParseOptions1|MapperParseOptions2
 mapper programs will have the following parse options at the end of setup
 
const public JobAPI
 job programs have the following API
 
const public MapperAPI
 mapper programs have the following API
 
const public AE_USER_EVENT = 1
 user event audit code More...
 
const public AE_SYSTEM_STARTUP = 2
 system startup audit code More...
 
const public AE_SYSTEM_SHUTDOWN = 3
 system shutdown audit code More...
 
const public AE_SYSTEM_RECOVERY_START = 4
 system recovery start audit code More...
 
const public AE_SYSTEM_RECOVERY_COMPLETE = 5
 system recovery complete audit code More...
 
const public AE_WORKFLOW_STATUS_CHANGE = 6
 workflow status change audit code More...
 
const public AE_WORKFLOW_START = 7
 workflow start audit code More...
 
const public AE_WORKFLOW_STOP = 8
 workflow stop audit code More...
 
const public AE_SERVICE_START = 9
 service start audit code More...
 
const public AE_SERVICE_STOP = 10
 service stop audit code More...
 
const public AE_JOB_START = 11
 job start audit code More...
 
const public AE_JOB_STOP = 12
 job stop audit code More...
 
const public AE_JOB_INSTANCE_START = 13
 job instance start audit code More...
 
const public AE_JOB_INSTANCE_STOP = 14
 job instance stop audit code More...
 
const public AE_API_CALL = 15
 api call audit code More...
 
const public AE_JOB_RECOVERY = 16
 job recovery audit code More...
 
const public AE_WORKFLOW_DATA_CREATED = 17
 workflow order data created audit code More...
 
const public AE_ALERT_ONGOING_RAISED = 18
 ongoing alert raised audit code More...
 
const public AE_ALERT_ONGOING_CLEARED = 19
 ongoing alert cleared audit code More...
 
const public AE_ALERT_TRANSIENT_RAISED = 20
 transient alert raised audit code More...
 
const public AE_SOURCE_FILE_LOADED = 21
 source file loaded into the system schema by oload More...
 
const public AE_GROUP_STATUS_CHANGED = 22
 group status changed audit code More...
 
const public AE_JOB_CREATED = 23
 Job created audit code. More...
 
const public AE_JOB_DELETED = 24
 Job deleted audit code. More...
 
const public AE_JOB_UPDATED = 25
 Job updated audit code. More...
 
const public AE_CLASS_CREATED = 23
 class created audit code More...
 
const public AE_CLASS_DELETED = 24
 Class deleted audit code. More...
 
const public AE_CLASS_UPDATED = 25
 Class updated audit code. More...
 
const public AE_CONNECTION_CREATED = 26
 connection created audit code More...
 
const public AE_CONNECTION_DELETED = 27
 Connection deleted audit code. More...
 
const public AE_CONNECTION_UPDATED = 28
 Connection updated audit code. More...
 
const public AES_USER_EVENT = "USER-EVENT"
 user event audit code More...
 
const public AES_SYSTEM_STARTUP = "SYSTEM-STARTUP"
 system startup audit code More...
 
const public AES_SYSTEM_SHUTDOWN = "SYSTEM-SHUTDOWN"
 system shutdown audit code More...
 
const public AES_SYSTEM_RECOVERY_START = "SYSTEM-RECOVERY-START"
 system recovery start audit code More...
 
const public AES_SYSTEM_RECOVERY_COMPLETE = "SYSTEM-RECOVERY-COMPLETE"
 system recovery complete audit code More...
 
const public AES_WORKFLOW_STATUS_CHANGE = "WORKFLOW-STATUS-CHANGE"
 workflow status change audit code More...
 
const public AES_WORKFLOW_START = "WORKFLOW-START"
 workflow start audit code More...
 
const public AES_WORKFLOW_STOP = "WORKFLOW-STOP"
 workflow stop audit code More...
 
const public AES_SERVICE_START = "SERVICE-START"
 service start audit code More...
 
const public AES_SERVICE_STOP = "SERVICE-STOP"
 service stop audit code More...
 
const public AES_JOB_START = "JOB-START"
 job start audit code More...
 
const public AES_JOB_STOP = "JOB-STOP"
 job stop audit code More...
 
const public AES_JOB_INSTANCE_START = "JOB-INSTANCE-STOP"
 job instance start audit code More...
 
const public AES_JOB_INSTANCE_STOP = "JOB-INSTANCE-START"
 job instance stop audit code More...
 
const public AES_API_CALL = "API-CALL"
 api call audit code More...
 
const public AES_JOB_RECOVERY = "JOB-RECOVERY"
 job recovery audit code More...
 
const public AES_WORKFLOW_DATA_CREATED = "WORKFLOW-DATA-CREATED"
 workflow order data created audit code More...
 
const public AES_ALERT_ONGOING_RAISED = "ALERT-ONGOING-RAISED"
 ongoing alert raised audit code More...
 
const public AES_ALERT_ONGOING_CLEARED = "ALERT-ONGOING-CLEARED"
 ongoing alert cleared audit code More...
 
const public AES_ALERT_TRANSIENT_RAISED = "ALERT-TRANSIENT-RAISED"
 transient alert raised audit code More...
 
const public AES_SOURCE_FILE_LOADED = "SOURCE-FILE-LOADED"
 source file loaded into the system schema by oload audit code More...
 
const public AES_GROUP_STATUS_CHANGED = "GROUP-STATUS-CHANGED"
 group status changed audit code More...
 
const public AuditEventMap
 map of audit event codes to descriptions
 
const public AuditEventCodeMap
 map of audit event descriptions to codes
 
const public AO_SYSTEM = "system"
 Audit option: system events. More...
 
const public AO_WORKFLOWS = "workflows"
 Audit option: workflow events. More...
 
const public AO_WORKFLOW_DATA = "workflow-data"
 Audit option: workflow data events. More...
 
const public AO_JOBS = "jobs"
 Audit option: job events. More...
 
const public AO_JOB_DATA = "job-data"
 Audit option: job data events. More...
 
const public AO_SERVICES = "services"
 Audit option: service events. More...
 
const public AO_API = "api"
 Audit option: api write events. More...
 
const public AO_USER_EVENTS = "user-events"
 Audit option: user events. More...
 
const public AO_OLOAD_EVENTS = "oload"
 Audit option: oload events. More...
 
const public AO_ALERT_EVENTS = "alerts"
 Audit option: alert events. More...
 
const public AO_GROUP_EVENTS = "groups"
 Audit option: RBAC interface group events. More...
 
const public AO_CODE_EVENTS = "code"
 Audit option: code events. More...
 
const public AuditOptionList
 list of all audit options
 
const public AOC_SYSTEM = (1 << 0)
 Audit option code: system events. More...
 
const public AOC_WORKFLOWS = (1 << 1)
 Audit option code: workflow events.
 
const public AOC_WORKFLOW_DATA = (1 << 2)
 Audit option code: workflow data events.
 
const public AOC_JOBS = (1 << 3)
 Audit option code: job events.
 
const public AOC_JOB_DATA = (1 << 4)
 Audit option code: job data events.
 
const public AOC_SERVICES = (1 << 5)
 Audit option code: service events.
 
const public AOC_API = (1 << 6)
 Audit option code: api write events.
 
const public AOC_USER_EVENTS = (1 << 7)
 Audit option code: user events.
 
const public AOC_OLOAD_EVENTS = (1 << 8)
 Audit option code: oload events. More...
 
const public AOC_ALERT_EVENTS = (1 << 9)
 Audit option code: alert events. More...
 
const public AOC_GROUP_EVENTS = (1 << 10)
 Audit option code: RBAC interface group events. More...
 
const public AOC_CODE_EVENTS = (1 << 11)
 Audit option code: code events. More...
 
const public AuditMask
 mask of all audit options
 
const public AuditOptionMap
 map of audit options to audit codes
 
const public AuditCodeMap
 map of audit codes to audit options
 
const public UiExtensionRoot = "UIExtension"
 Root part of UI extension URL paths.
 
const public ORDER_INSTANCE_KEYS_KEY_LEN = 240
 byte length of the order_instance_keys keyname column
 
const public ORDER_INSTANCE_KEYS_VALUE_LEN = 4000
 byte length of the order_instance_keys value column
 
const public SysTagSource = "_source"
 source tag name
 
const public SysTagOffset = "_offset"
 offset tag name
 
const public SysTagSet
 known system tags
 
const public DefaultWorkflowSlaThreshold = 1800
 the default workflow SLA threshold value as an integer in seconds More...
 
const public CommonModuleList = ("uuid", "xml", "json", "yaml", "Mime", "Util", "SqlUtil", "DataStreamClient", "RestClient")
 list of module loaded in all Qorus Program containers including mapper Programs
 
const public ModuleList = CommonModuleList + ("SoapClient", "Mapper", "TableMapper")
 list of modules automatically loaded into Qorus programs (for workflows, services, jobs, etc)
 
const public ServiceModuleList = ModuleList + ("HttpServerUtil", "RestHandler")
 list of modules automatically loaded into Qorus service programs
 
const public ServiceOnlyClassList
 list of service classes
 
const public ServiceClassList = CommonClassList + ServiceOnlyClassList
 list of service classes + common classes
 
const public SystemServiceClassList
 list of system service classes
 
const public WorkflowOnlyClassList
 list of workflow classes
 
const public WorkflowClassList = CommonClassList + WorkflowOnlyClassList
 list of workflow classes + common classes
 
const public JobOnlyClassList
 list of job classes
 
const public JobClassList = CommonClassList + JobOnlyClassList
 list of job classes + common classes
 
const public CommonHashDeclList
 list of hashdecls common to all user code Program objects (except mappers)
 
const public DefaultTokenExpirationPeriod = 3D
 The default access token expiration period as a date/time value. More...
 
const public DefaultTokenExpirationSeconds = DefaultTokenExpirationPeriod.durationSeconds()
 The default access token expiration period in seconds. More...
 

Detailed Description

main Qorus namespace

the main client namespace

main Qorus system namespace

Function Documentation

◆ absolute_path()

bool OMQ::absolute_path ( string  path)

returns True if the argument is an absolute path, False if not

Example:
bool abs = absolute_path(path);
Parameters
paththe path to check
Returns
True if the argument is an absolute path, False if not
Note
reexported from the Util module for backwards-compatibility

◆ compare_version()

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

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

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

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

◆ qorus_get_local_url()

string OMQ::qorus_get_local_url ( *string  username,
*string  password 
)

returns a string giving a local URL for the current Qorus instance with a specific username and password for the connection

Since
Qorus 5.0

Variable Documentation

◆ AE_ALERT_ONGOING_CLEARED

const public OMQ::AE_ALERT_ONGOING_CLEARED = 19

ongoing alert cleared audit code

this code is used when an ongoing alert is cleared and the "alert ongoing cleared" audit event is written to the AUDIT_EVENTS table

Since
Qorus 3.0.0

◆ AE_ALERT_ONGOING_RAISED

const public OMQ::AE_ALERT_ONGOING_RAISED = 18

ongoing alert raised audit code

this code is used when an ongoing alert is raised and the "alert ongoing raised" audit event is written to the AUDIT_EVENTS table

Since
Qorus 3.0.0

◆ AE_ALERT_TRANSIENT_RAISED

const public OMQ::AE_ALERT_TRANSIENT_RAISED = 20

transient alert raised audit code

this code is used when a transient alert is raised and the "alert transient raised" audit event is written to the AUDIT_EVENTS table

Since
Qorus 3.0.0

◆ AE_API_CALL

const public OMQ::AE_API_CALL = 15

api call audit code

this code is used when a "api call" audit event is written to the AUDIT_EVENTS table

◆ AE_CLASS_CREATED

const public OMQ::AE_CLASS_CREATED = 23

class created audit code

This code is used when a "class created" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_CLASS_CREATED
Since
Qorus 5.1

◆ AE_CLASS_DELETED

const public OMQ::AE_CLASS_DELETED = 24

Class deleted audit code.

This code is used when a "class deleted" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_CLASS_DELETED
Since
Qorus 5.1

◆ AE_CLASS_UPDATED

const public OMQ::AE_CLASS_UPDATED = 25

Class updated audit code.

This code is used when a "class updated" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_CLASS_UPDATED
Since
Qorus 5.1

◆ AE_CONNECTION_CREATED

const public OMQ::AE_CONNECTION_CREATED = 26

connection created audit code

This code is used when a "connection created" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_CONNECTION_CREATED
Since
Qorus 5.1

◆ AE_CONNECTION_DELETED

const public OMQ::AE_CONNECTION_DELETED = 27

Connection deleted audit code.

This code is used when a "connection deleted" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_CONNECTION_DELETED
Since
Qorus 5.1

◆ AE_CONNECTION_UPDATED

const public OMQ::AE_CONNECTION_UPDATED = 28

Connection updated audit code.

This code is used when a "connection updated" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_CONNECTION_UPDATED
Since
Qorus 5.1

◆ AE_GROUP_STATUS_CHANGED

const public OMQ::AE_GROUP_STATUS_CHANGED = 22

group status changed audit code

this code is used when an RBAC interface group's status changes and the "group status changed" event is writteo the the AUDIT_EVENTS table; corresponds to OMQ::AE_GROUP_STATUS_CHANGED

Since
Qorus 3.0.0

◆ AE_JOB_CREATED

const public OMQ::AE_JOB_CREATED = 23

Job created audit code.

This code is used when a "job created" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_JOB_CREATED
Since
Qorus 5.1

◆ AE_JOB_DELETED

const public OMQ::AE_JOB_DELETED = 24

Job deleted audit code.

This code is used when a "job deleted" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_JOB_DELETED
Since
Qorus 5.1

◆ AE_JOB_INSTANCE_START

const public OMQ::AE_JOB_INSTANCE_START = 13

job instance start audit code

this code is used when a "job instance start" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_JOB_INSTANCE_START

◆ AE_JOB_INSTANCE_STOP

const public OMQ::AE_JOB_INSTANCE_STOP = 14

job instance stop audit code

this code is used when a "job instance stop" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_JOB_INSTANCE_STOP

◆ AE_JOB_RECOVERY

const public OMQ::AE_JOB_RECOVERY = 16

job recovery audit code

this code is used when a "job recovery" audit event is written to the AUDIT_EVENTS table

◆ AE_JOB_START

const public OMQ::AE_JOB_START = 11

job start audit code

this code is used when a "job start" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_JOB_START

◆ AE_JOB_STOP

const public OMQ::AE_JOB_STOP = 12

job stop audit code

this code is used when a "job stop" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_JOB_STOP

◆ AE_JOB_UPDATED

const public OMQ::AE_JOB_UPDATED = 25

Job updated audit code.

This code is used when a "job updated" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_JOB_UPDATED
Since
Qorus 5.1

◆ AE_SERVICE_START

const public OMQ::AE_SERVICE_START = 9

service start audit code

this code is used when a "service start" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_SERVICE_START

◆ AE_SERVICE_STOP

const public OMQ::AE_SERVICE_STOP = 10

service stop audit code

this code is used when a "service stop" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_SERVICE_STOP

◆ AE_SOURCE_FILE_LOADED

const public OMQ::AE_SOURCE_FILE_LOADED = 21

source file loaded into the system schema by oload

this code is used when any source file is loaded into the database by oload and the "source file loaded" event is written to the AUDIT_EVENTS table

Since
Qorus 3.0.0

◆ AE_SYSTEM_RECOVERY_COMPLETE

const public OMQ::AE_SYSTEM_RECOVERY_COMPLETE = 5

system recovery complete audit code

this code is used when a "system recovery complete" audit event is written to the AUDIT_EVENTS table

◆ AE_SYSTEM_RECOVERY_START

const public OMQ::AE_SYSTEM_RECOVERY_START = 4

system recovery start audit code

this code is used when a "system recovery start" audit event is written to the AUDIT_EVENTS table

◆ AE_SYSTEM_SHUTDOWN

const public OMQ::AE_SYSTEM_SHUTDOWN = 3

system shutdown audit code

this code is used when a "system shutdown" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_SYSTEM_SHUTDOWN

◆ AE_SYSTEM_STARTUP

const public OMQ::AE_SYSTEM_STARTUP = 2

system startup audit code

this code is used when a "system startup" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_SYSTEM_STARTUP

◆ AE_USER_EVENT

const public OMQ::AE_USER_EVENT = 1

user event audit code

These are the possible audit event codes for system auditing events. this code is used when a user audit event is written to the AUDIT_EVENTS table

◆ AE_WORKFLOW_DATA_CREATED

const public OMQ::AE_WORKFLOW_DATA_CREATED = 17

workflow order data created audit code

this code is used when a workflow order is created and the "order created" audit event is written to the AUDIT_EVENTS table

◆ AE_WORKFLOW_START

const public OMQ::AE_WORKFLOW_START = 7

workflow start audit code

this code is used when a "workflow start" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_WORKFLOW_START

◆ AE_WORKFLOW_STATUS_CHANGE

const public OMQ::AE_WORKFLOW_STATUS_CHANGE = 6

workflow status change audit code

this code is used when a "workflow status change" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_WORKFLOW_STATUS_CHANGED

◆ AE_WORKFLOW_STOP

const public OMQ::AE_WORKFLOW_STOP = 8

workflow stop audit code

this code is used when a "workflow stop" audit event is written to the AUDIT_EVENTS table

See also
OMQ::QEC_WORKFLOW_STOP

◆ AES_ALERT_ONGOING_CLEARED

const public OMQ::AES_ALERT_ONGOING_CLEARED = "ALERT-ONGOING-CLEARED"

ongoing alert cleared audit code

this code is used when an ongoing alert is cleared and the "alert ongoing cleared" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_ALERT_ONGOING_CLEARED

Since
Qorus 3.0.0

◆ AES_ALERT_ONGOING_RAISED

const public OMQ::AES_ALERT_ONGOING_RAISED = "ALERT-ONGOING-RAISED"

ongoing alert raised audit code

this code is used when an ongoing alert is raised and the "alert ongoing raised" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_ALERT_ONGOING_RAISED

Since
Qorus 3.0.0

◆ AES_ALERT_TRANSIENT_RAISED

const public OMQ::AES_ALERT_TRANSIENT_RAISED = "ALERT-TRANSIENT-RAISED"

transient alert raised audit code

this code is used when a transient alert is raised and the "alert transient raised" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_ALERT_TRANSIENT_RAISED

Since
Qorus 3.0.0

◆ AES_API_CALL

const public OMQ::AES_API_CALL = "API-CALL"

api call audit code

this code is used when a "api call" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_API_CALL

◆ AES_GROUP_STATUS_CHANGED

const public OMQ::AES_GROUP_STATUS_CHANGED = "GROUP-STATUS-CHANGED"

group status changed audit code

this code is used when an RBAC interface group's status changes and the "group status changed" event is writteo the the AUDIT_EVENTS table; corresponds to OMQ::AE_GROUP_STATUS_CHANGED

Since
Qorus 3.0.0

◆ AES_JOB_INSTANCE_START

const public OMQ::AES_JOB_INSTANCE_START = "JOB-INSTANCE-STOP"

job instance start audit code

this code is used when a "job instance start" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_JOB_INSTANCE_START

◆ AES_JOB_INSTANCE_STOP

const public OMQ::AES_JOB_INSTANCE_STOP = "JOB-INSTANCE-START"

job instance stop audit code

this code is used when a "job instance stop" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_JOB_INSTANCE_STOP

◆ AES_JOB_RECOVERY

const public OMQ::AES_JOB_RECOVERY = "JOB-RECOVERY"

job recovery audit code

this code is used when a "job recovery" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_JOB_RECOVERY

◆ AES_JOB_START

const public OMQ::AES_JOB_START = "JOB-START"

job start audit code

this code is used when a "job start" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_JOB_START

◆ AES_JOB_STOP

const public OMQ::AES_JOB_STOP = "JOB-STOP"

job stop audit code

this code is used when a "job stop" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_JOB_STOP

◆ AES_SERVICE_START

const public OMQ::AES_SERVICE_START = "SERVICE-START"

service start audit code

this code is used when a "service start" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_SERVICE_START

◆ AES_SERVICE_STOP

const public OMQ::AES_SERVICE_STOP = "SERVICE-STOP"

service stop audit code

this code is used when a "service stop" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_SERVICE_STOP

◆ AES_SOURCE_FILE_LOADED

const public OMQ::AES_SOURCE_FILE_LOADED = "SOURCE-FILE-LOADED"

source file loaded into the system schema by oload audit code

this code is used when any source file is loaded into the database by oload and the "source file loaded" event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_SOURCE_FILE_LOADED

Since
Qorus 3.0.0

◆ AES_SYSTEM_RECOVERY_COMPLETE

const public OMQ::AES_SYSTEM_RECOVERY_COMPLETE = "SYSTEM-RECOVERY-COMPLETE"

system recovery complete audit code

this code is used when a "system recovery complete" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_SYSTEM_RECOVERY_COMPLETE

◆ AES_SYSTEM_RECOVERY_START

const public OMQ::AES_SYSTEM_RECOVERY_START = "SYSTEM-RECOVERY-START"

system recovery start audit code

this code is used when a "system recovery start" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_SYSTEM_RECOVERY_START

◆ AES_SYSTEM_SHUTDOWN

const public OMQ::AES_SYSTEM_SHUTDOWN = "SYSTEM-SHUTDOWN"

system shutdown audit code

this code is used when a "system shutdown" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_SYSTEM_SHUTDOWN

◆ AES_SYSTEM_STARTUP

const public OMQ::AES_SYSTEM_STARTUP = "SYSTEM-STARTUP"

system startup audit code

this code is used when a "system startup" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_SYSTEM_STARTUP

◆ AES_USER_EVENT

const public OMQ::AES_USER_EVENT = "USER-EVENT"

user event audit code

These are the possible audit event strings corresponding to the audit event codes for system auditing events this code is used when a user audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_USER_EVENT

◆ AES_WORKFLOW_DATA_CREATED

const public OMQ::AES_WORKFLOW_DATA_CREATED = "WORKFLOW-DATA-CREATED"

workflow order data created audit code

this code is used when a workflow order is created and the "order created" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_WORKFLOW_DATA_CREATED

◆ AES_WORKFLOW_START

const public OMQ::AES_WORKFLOW_START = "WORKFLOW-START"

workflow start audit code

this code is used when a "workflow start" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_WORKFLOW_START

◆ AES_WORKFLOW_STATUS_CHANGE

const public OMQ::AES_WORKFLOW_STATUS_CHANGE = "WORKFLOW-STATUS-CHANGE"

workflow status change audit code

this code is used when a "workflow status change" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_WORKFLOW_STATUS_CHANGE

◆ AES_WORKFLOW_STOP

const public OMQ::AES_WORKFLOW_STOP = "WORKFLOW-STOP"

workflow stop audit code

this code is used when a "workflow stop" audit event is written to the AUDIT_EVENTS table; corresponds to OMQ::AE_WORKFLOW_STOP

◆ AO_ALERT_EVENTS

const public OMQ::AO_ALERT_EVENTS = "alerts"

Audit option: alert events.

audits the following events: OMQ::AE_ALERT_ONGOING_RAISED, OMQ::AE_ALERT_ONGOING_CLEARED, OMQ::AE_ALERT_TRANSIENT_RAISED

Since
Qorus 3.0.0

◆ AO_API

const public OMQ::AO_API = "api"

Audit option: api write events.

audits the following events: OMQ::AE_API_CALL for external network API calls that cause changes to be made

◆ AO_CODE_EVENTS

◆ AO_GROUP_EVENTS

const public OMQ::AO_GROUP_EVENTS = "groups"

Audit option: RBAC interface group events.

audits the following events: OMQ::AE_GROUP_STATUS_CHANGED

Since
Qorus 3.0.0

◆ AO_JOB_DATA

const public OMQ::AO_JOB_DATA = "job-data"

Audit option: job data events.

audits the following events:

◆ AO_JOBS

const public OMQ::AO_JOBS = "jobs"

Audit option: job events.

audits the following events:

◆ AO_OLOAD_EVENTS

const public OMQ::AO_OLOAD_EVENTS = "oload"

Audit option: oload events.

audits the following event: OMQ::AE_SOURCE_FILE_LOADED

Since
Qorus 3.0.0

◆ AO_SERVICES

const public OMQ::AO_SERVICES = "services"

Audit option: service events.

audits the following events:

◆ AO_SYSTEM

const public OMQ::AO_SYSTEM = "system"

Audit option: system events.

These are the possible audit option codes for the system option qorus.audit audits the following events:

◆ AO_USER_EVENTS

const public OMQ::AO_USER_EVENTS = "user-events"

Audit option: user events.

audits the following events: OMQ::AE_USER_EVENT

◆ AO_WORKFLOW_DATA

const public OMQ::AO_WORKFLOW_DATA = "workflow-data"

Audit option: workflow data events.

audits the following events:

◆ AO_WORKFLOWS

const public OMQ::AO_WORKFLOWS = "workflows"

Audit option: workflow events.

audits the following events:

◆ AOC_ALERT_EVENTS

const public OMQ::AOC_ALERT_EVENTS = (1 << 9)

Audit option code: alert events.

Since
Qorus 3.0.0

◆ AOC_CODE_EVENTS

const public OMQ::AOC_CODE_EVENTS = (1 << 11)

Audit option code: code events.

Since
Qorus 5.1

◆ AOC_GROUP_EVENTS

const public OMQ::AOC_GROUP_EVENTS = (1 << 10)

Audit option code: RBAC interface group events.

Since
Qorus 3.0.0

◆ AOC_OLOAD_EVENTS

const public OMQ::AOC_OLOAD_EVENTS = (1 << 8)

Audit option code: oload events.

Since
Qorus 3.0.0

◆ AOC_SYSTEM

const public OMQ::AOC_SYSTEM = (1 << 0)

Audit option code: system events.

Internal codes corresponding to each audit option

◆ DefaultTokenExpirationPeriod

const public OMQ::DefaultTokenExpirationPeriod = 3D

The default access token expiration period as a date/time value.

Since
Qorus 5.1.1

◆ DefaultTokenExpirationSeconds

const public OMQ::DefaultTokenExpirationSeconds = DefaultTokenExpirationPeriod.durationSeconds()

The default access token expiration period in seconds.

Since
Qorus 5.1.1

◆ DefaultWorkflowSlaThreshold

const public 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

◆ ErrLevelAuto

const public OMQ::ErrLevelAuto = "AUTO"

auto level: global if no global error exists, workflow if a global exists and differs from the current definition

Error level definition constants for error definitionas processed by oload this is the default if no explicit error level is given in the error definition

◆ ErrLevelGlobal

const public OMQ::ErrLevelGlobal = "GLOBAL"

global level: the error will be created at the global level

if a global level error of the same name already exists and differs from the given definition, the error will only be updated if not manually updated in the database

◆ ErrLevelWorkflow

const public OMQ::ErrLevelWorkflow = "WORKFLOW"

workflow level: the error will always be created at the workflow level

if a workflow level error of the same name already exists and differs from the given definition, the error will only be updated if not manually updated in the database

◆ JS_Complete

const public OMQ::JS_Complete = "COMPLETE"

Job Status Text Description: COMPLETE.

The equivalent status code actually stored in the database is OMQ::SQL_JS_Complete

◆ JS_Crash

const public OMQ::JS_Crash = "CRASH"

Job Status Text Description: CRASH.

The equivalent status code actually stored in the database is OMQ::SQL_JS_Crash

◆ JS_Error

const public OMQ::JS_Error = "ERROR"

Job Status Text Description: ERROR.

The equivalent status code actually stored in the database is OMQ::SQL_JS_Error

◆ JS_InProgress

const public OMQ::JS_InProgress = "IN-PROGRESS"

Job Status Text Description: IN-PROGRESS.

The equivalent status code actually stored in the database is OMQ::SQL_JS_InProgress

◆ 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.

◆ OT_FSM

const public OMQ::OT_FSM = "FSM"

for FSM library objects

Since
Qorus 5.0

◆ OT_MAPPER

const public OMQ::OT_MAPPER = "MAPPER"

for mapper library objects (only for pipelines and FSMs)

Since
Qorus 5.0

◆ OT_PIPELINE

const public OMQ::OT_PIPELINE = "PIPELINE"

for pipeline library objects

Since
Qorus 5.0

◆ QE_CLASS_CLASS

const public OMQ::QE_CLASS_CLASS = 113

Event Class Code for CLASS events.

Since
Qorus 5.1

◆ QE_CLASS_CLUSTER

const public OMQ::QE_CLASS_CLUSTER = 110

Event Class Code for CLUSTER events.

Since
Qorus 4.0

◆ QE_CLASS_CONFIG_ITEM

const public OMQ::QE_CLASS_CONFIG_ITEM = 112

Event Class Code for CONFIG ITEM events.

Since
Qorus 4.0

◆ QE_CLASS_LOGGER

const public OMQ::QE_CLASS_LOGGER = 111

Event Class Code for LOGGER events.

Since
Qorus 4.0

◆ QE_CLASS_PROCESS

const public OMQ::QE_CLASS_PROCESS = 109

Event Class Code for PROCESS events.

Since
Qorus 4.0

◆ QEC_ALERT_ONGOING_CLEARED

const public OMQ::QEC_ALERT_ONGOING_CLEARED = 5007

Qorus Event Code: ALERT_ONGOING_CLEARED.

See also
ALERT_ONGOING_CLEARED Event Information Description for a description of the event info hash

◆ QEC_ALERT_ONGOING_RAISED

const public OMQ::QEC_ALERT_ONGOING_RAISED = 5006

Qorus Event Code: ALERT_ONGOING_RAISED.

See also
ALERT_ONGOING_RAISED Event Information Description for a description of the event info hash

◆ QEC_ALERT_TRANSIENT_RAISED

const public OMQ::QEC_ALERT_TRANSIENT_RAISED = 5008

Qorus Event Code: ALERT_TRANSIENT_RAISED.

See also
ALERT_TRANSIENT_RAISED Event Information Description for a description of the event info hash

◆ QEC_APPENDER_CREATED

const public OMQ::QEC_APPENDER_CREATED = 5203

Qorus Event Code: APPENDER_CREATED.

Sent when an appender is created by a user using the REST API

See also
APPENDER_CREATED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_APPENDER_DELETED

const public OMQ::QEC_APPENDER_DELETED = 5204

Qorus Event Code: APPENDER_DELETED.

Sent when an appender is deleted by a user using the REST API

See also
APPENDER_DELETED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_APPENDER_UPDATED

const public OMQ::QEC_APPENDER_UPDATED = 5205

Qorus Event Code: APPENDER_UPDATED.

Sent when an appender is updated by a user using the REST API

See also
APPENDER_UPDATED Event Information description for a description of the event info hash
Since
Qorus 4.0.3

◆ QEC_CLASS_CREATED

const public OMQ::QEC_CLASS_CREATED = 8001

Qorus Event code: CLASS_CREATED.

CLASS_CREATED Event Information Description for a description of the event info hash

Since
Qorus 5.1

◆ QEC_CLASS_DELETED

const public OMQ::QEC_CLASS_DELETED = 8002

Qorus Event code: CLASS_DELETED.

CLASS_DELETED Event Information Description for a description of the event info hash

Since
Qorus 5.1

◆ QEC_CLASS_UPDATED

const public OMQ::QEC_CLASS_UPDATED = 8003

Qorus Event code: CLASS_UPDATED.

CLASS_UPDATED Event Information Description for a description of the event info hash

Since
Qorus 5.1

◆ QEC_CONFIG_ITEM_CHANGED

const public OMQ::QEC_CONFIG_ITEM_CHANGED = 4100

Qorus Event code: QEC_CONFIG_ITEM_CHANGED.

CONFIG_ITEM_CHANGED Event Information Description for a description of the event info hash

Since
Qorus 4.0

◆ QEC_CONNECTION_CREATED

const public OMQ::QEC_CONNECTION_CREATED = 5104

Qorus Event Code: CONNECTION_CREATED.

Sent when a connection is created by a user using the REST API

See also
CONNECTION_CREATED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_CONNECTION_DEBUG_DATA_CHANGE

const public OMQ::QEC_CONNECTION_DEBUG_DATA_CHANGE = 5108

Qorus Event Code: CONNECTION_DEBUG_DATA_CHANGE.

Sent when the debug data flag flag is changed for any connection

See also
QEC_CONNECTION_DEBUG_DATA_CHANGE for a description of the event info hash
Since
Qorus 4.1

◆ QEC_CONNECTION_DELETED

const public OMQ::QEC_CONNECTION_DELETED = 5106

Qorus Event Code: CONNECTION_DELETED.

Sent when is a connection deleted by a user using the REST API

See also
CONNECTION_DELETED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_CONNECTION_DOWN

const public OMQ::QEC_CONNECTION_DOWN = 5102

Qorus Event Code: CONNECTION_DOWN.

See also
CONNECTION_DOWN Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_CONNECTION_ENABLED_CHANGE

const public OMQ::QEC_CONNECTION_ENABLED_CHANGE = 5103

Qorus Event Code: CONNECTION_ENABLED_CHANGE.

Sent when any connection enabled flag is changed

See also
CONNECTION_ENABLED_CHANGE Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_CONNECTION_UP

const public OMQ::QEC_CONNECTION_UP = 5101

Qorus Event Code: CONNECTION_UP.

See also
CONNECTION_UP Event Information description for a description of the event info hash

◆ QEC_CONNECTION_UPDATED

const public OMQ::QEC_CONNECTION_UPDATED = 5105

Qorus Event Code: CONNECTION_UPDATED.

Sent when is a connection updated by a user using the REST API

See also
CONNECTION_UPDATED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_CONNECTIONS_RELOADED

const public OMQ::QEC_CONNECTIONS_RELOADED = 5107

Qorus Event Code: CONNECTIONS_RELOADED.

Sent when connections are reloaded by a user using the REST API

See also
CONNECTIONS_RELOADED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_GROUP_STATUS_CHANGED

const public OMQ::QEC_GROUP_STATUS_CHANGED = 1101

Qorus Event Code: GROUP_STATUS_CHANGED.

See also
GROUP_STATUS_CHANGED Event Information Description for a description of the event info hash

◆ QEC_JOB_CREATED

const public OMQ::QEC_JOB_CREATED = 4008

Qorus Event code: JOB_CREATED.

JOB_CREATED Event Information Description for a description of the event info hash

Since
Qorus 5.1

◆ QEC_JOB_DELETED

const public OMQ::QEC_JOB_DELETED = 4009

Qorus Event code: JOB_DELETED.

JOB_DELETED Event Information Description for a description of the event info hash

Since
Qorus 5.1

◆ QEC_JOB_ERROR

const public OMQ::QEC_JOB_ERROR = 4003

Qorus Event Code: JOB_ERROR.

See also
JOB_ERROR Event Information Description for a description of the event info hash

◆ QEC_JOB_INSTANCE_START

const public OMQ::QEC_JOB_INSTANCE_START = 4004

Qorus Event Code: JOB_INSTANCE_START.

See also

◆ QEC_JOB_INSTANCE_STOP

const public OMQ::QEC_JOB_INSTANCE_STOP = 4005

Qorus Event Code: JOB_INSTANCE_STOP.

See also

◆ QEC_JOB_RECOVERED

const public OMQ::QEC_JOB_RECOVERED = 4006

Qorus Event Code: JOB_RECOVERED.

JOB_RECOVERED Event Information Description for a description of the event info hash

Since
Qorus 4.0

◆ QEC_JOB_START

const public OMQ::QEC_JOB_START = 4001

Qorus Event Code: JOB_START.

See also

◆ QEC_JOB_STOP

const public OMQ::QEC_JOB_STOP = 4002

Qorus Event Code: JOB_STOP.

for a description of the event info hash

See also

◆ QEC_JOB_UPDATED

const public OMQ::QEC_JOB_UPDATED = 4007

Qorus Event code: JOB_UPDATED.

JOB_UPDATED Event Information Description for a description of the event info hash

Since
Qorus 4.0

◆ QEC_LOGGER_CREATED

const public OMQ::QEC_LOGGER_CREATED = 5200

Qorus Event Code: LOGGER_CREATED.

Sent when a logger is created by a user using the REST API

See also
LOGGER_CREATED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_LOGGER_DELETED

const public OMQ::QEC_LOGGER_DELETED = 5202

Qorus Event Code: LOGGER_DELETED.

Sent when a logger is deleted by a user using the REST API

See also
LOGGER_DELETED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_LOGGER_UPDATED

const public OMQ::QEC_LOGGER_UPDATED = 5201

Qorus Event Code: LOGGER_UPDATED.

Sent when a logger is updated by a user using the REST API

See also
LOGGER_UPDATED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_NODE_INFO

const public OMQ::QEC_NODE_INFO = 7001

Qorus Event Code: NODE_INFO.

See also
NODE_INFO Event Information Description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_NODE_REMOVED

const public OMQ::QEC_NODE_REMOVED = 7002

Qorus Event Code: NODE_REMOVED.

See also
NODE_REMOVED Event Information Description for a description of the event info hash
Since
Qorus 5.0

◆ QEC_PROCESS_MEMORY_CHANGED

const public OMQ::QEC_PROCESS_MEMORY_CHANGED = 6004

Qorus Event Code: PROCESS_MEMORY_CHANGED.

See also
PROCESS_MEMORY_CHANGED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_PROCESS_START_ERROR

const public OMQ::QEC_PROCESS_START_ERROR = 6003

Qorus Event Code: PROCESS_START_ERROR.

See also
PROCESS_START_ERROR Event Information Description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_PROCESS_STARTED

const public OMQ::QEC_PROCESS_STARTED = 6001

Qorus Event Code: PROCESS_STARTED.

See also
PROCESS_STARTED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_PROCESS_STOPPED

const public OMQ::QEC_PROCESS_STOPPED = 6002

Qorus Event Code: PROCESS_STOPPED.

See also
PROCESS_STOPPED Event Information description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_SERVICE_AUTOSTART_CHANGE

const public OMQ::QEC_SERVICE_AUTOSTART_CHANGE = 3004

Qorus Event Code: SERVICE_AUTOSTART_CHANGE.

Deprecated:
This event is no longer raised as of Qorus 4.0

◆ QEC_SERVICE_ERROR

const public OMQ::QEC_SERVICE_ERROR = 3003

Qorus Event Code: SERVICE_ERROR.

See also
SERVICE_ERROR Event Information Description for a description of the event info hash

◆ QEC_SERVICE_METHOD_PERFORMANCE

const public OMQ::QEC_SERVICE_METHOD_PERFORMANCE = 3005

Qorus Event Code:: SERVICE_METHOD_PERFORMANCE.

See also
SERVICE_METHOD_PERFORMANCE Event Information Description for a description of the event info hash
Since
Qorus 3.0.2

◆ QEC_SERVICE_START

const public OMQ::QEC_SERVICE_START = 3001

Qorus Event Code: SERVICE_START.

See also

◆ QEC_SERVICE_STOP

const public OMQ::QEC_SERVICE_STOP = 3002

Qorus Event Code: SERVICE_STOP.

See also

◆ QEC_SERVICE_UPDATED

const public OMQ::QEC_SERVICE_UPDATED = 3006

Qorus Event code: SERVICE_UPDATED.

SERVICE_UPDATED Event Information Description for a description of the event info hash

Since
Qorus 4.0

◆ QEC_SYSTEM_ERROR

const public OMQ::QEC_SYSTEM_ERROR = 1003

Qorus Event Code: SYSTEM_ERROR.

See also
SYSTEM_ERROR Event Information Description

◆ QEC_SYSTEM_HEALTH_CHANGED

const public OMQ::QEC_SYSTEM_HEALTH_CHANGED = 1004

Qorus Event Code: SYSTEM_HEALTH_CHANGED.

See also
SYSTEM_HEALTH_CHANGED Event Information Description for a description of the event info hash

◆ QEC_SYSTEM_REMOTE_HEALTH_CHANGED

const public OMQ::QEC_SYSTEM_REMOTE_HEALTH_CHANGED = 1005

Qorus Event Code: SYSTEM_REMOTE_HEALTH_CHANGED.

See also
SYSTEM_REMOTE_HEALTH_CHANGED Event Information Description for a description of the event info hash

◆ QEC_SYSTEM_SCALED

const public OMQ::QEC_SYSTEM_SCALED = 1006

Qorus Event Code: SYSTEM_SCALED.

See also
SYSTEM_SCALED Event Information Description for a description of the event info hash

◆ QEC_SYSTEM_SHUTDOWN

const public OMQ::QEC_SYSTEM_SHUTDOWN = 1002

Qorus Event Code: SYSTEM_SHUTDOWN.

This event has no info hash

See also

◆ QEC_SYSTEM_STARTUP

const public OMQ::QEC_SYSTEM_STARTUP = 1001

Qorus Event Code: SYSTEM_STARTUP.

See also

◆ QEC_USER_EVENT

const public OMQ::QEC_USER_EVENT = 9001

Qorus Event Code: USER_EVENT.

this is the generic event code used for all user events

See also
USER_EVENT Event Information Description for a description of the event info hash

◆ QEC_WORKFLOW_CACHE_RESET

const public OMQ::QEC_WORKFLOW_CACHE_RESET = 2003

Qorus Event Code: WORKFLOW_CACHE_RESET.

See also
WORKFLOW_CACHE_RESET Event Information Description for a description of the event info hash

◆ QEC_WORKFLOW_DATA_CACHED

const public OMQ::QEC_WORKFLOW_DATA_CACHED = 2007

Qorus Event Code: WORKFLOW_DATA_CACHED (workflow attach event)

See also
WORKFLOW_DATA_CACHED Event Information Description for a description of the event info hash

◆ QEC_WORKFLOW_DATA_ERROR

const public OMQ::QEC_WORKFLOW_DATA_ERROR = 2005

Qorus Event Code: WORKFLOW_DATA_ERROR.

See also
WORKFLOW_DATA_ERROR Event Information Description for a description of the event info hash

◆ QEC_WORKFLOW_DATA_LOCKED

const public OMQ::QEC_WORKFLOW_DATA_LOCKED = 2012

Qorus Event Code: WORKFLOW_DATA_LOCKED.

See also
WORKFLOW_DATA_LOCKED Event Information Description for a description of the event info hash
Since
Qorus 3.0.2

◆ QEC_WORKFLOW_DATA_RELEASED

const public OMQ::QEC_WORKFLOW_DATA_RELEASED = 2006

Qorus Event Code: WORKFLOW_DATA_RELEASED (workflow detach event)

See also
WORKFLOW_DATA_RELEASED Event Information Description for a description of the event info hash

◆ QEC_WORKFLOW_DATA_SUBMITTED

const public OMQ::QEC_WORKFLOW_DATA_SUBMITTED = 2004

Qorus Event Code: WORKFLOW_DATA_SUBMITTED.

See also

◆ QEC_WORKFLOW_DATA_UNLOCKED

const public OMQ::QEC_WORKFLOW_DATA_UNLOCKED = 2013

Qorus Event Code: WORKFLOW_DATA_UNLOCKED.

See also
WORKFLOW_DATA_UNLOCKED Event Information Description for a description of the event info hash
Since
Qorus 3.0.2

◆ QEC_WORKFLOW_DATA_UPDATED

const public OMQ::QEC_WORKFLOW_DATA_UPDATED = 2014

Qorus Event Code: WORKFLOW_DATA_UPDATED (static or dynamic data changed)

See also
WORKFLOW_DATA_UPDATED Event Information Description for a description of the event info hash
Since
Qorus 3.1.0

◆ QEC_WORKFLOW_INFO_CHANGED

const public OMQ::QEC_WORKFLOW_INFO_CHANGED = 2008

Qorus Event Code: WORKFLOW_INFO_CHANGED.

See also
WORKFLOW_INFO_CHANGED Event Information Description for a description of the event info hash

◆ QEC_WORKFLOW_PERFORMANCE

const public OMQ::QEC_WORKFLOW_PERFORMANCE = 2011

Qorus Event Code:: WORKFLOW_PERFORMANCE.

See also
WORKFLOW_PERFORMANCE Event Information Description for a description of the event info hash
Since
Qorus 3.0.2

◆ QEC_WORKFLOW_RECOVERED

const public OMQ::QEC_WORKFLOW_RECOVERED = 2016

Qorus Event Code: WORKFLOW_RECOVERED.

WORKFLOW_RECOVERED Event Information Description for a description of the event info hash

Since
Qorus 4.0

◆ QEC_WORKFLOW_START

const public OMQ::QEC_WORKFLOW_START = 2001

Qorus Event Code: WORKFLOW_START.

See also

◆ QEC_WORKFLOW_STATS_UPDATED

const public OMQ::QEC_WORKFLOW_STATS_UPDATED = 2015

Qorus Event Code: WORKFLOW_STATS_UPDATED.

See also
WORKFLOW_STATS_UPDATED Event Information Description for a description of the event info hash
Since
Qorus 4.0

◆ QEC_WORKFLOW_STATUS_CHANGED

const public OMQ::QEC_WORKFLOW_STATUS_CHANGED = 2009

Qorus Event Code: WORKFLOW_STATUS_CHANGED.

See also

◆ QEC_WORKFLOW_STEP_DATA_UPDATED

const public OMQ::QEC_WORKFLOW_STEP_DATA_UPDATED = 2018

Qorus Event Code: WORKFLOW_STEP_DATA_UPDATED (step dynamic data changed)

See also
WORKFLOW_STEP_DATA_UPDATED Event Information Description for a description of the event info hash
Since
Qorus 4.0.1

◆ QEC_WORKFLOW_STEP_PERFORMANCE

const public OMQ::QEC_WORKFLOW_STEP_PERFORMANCE = 2010

Qorus Event Code:: WORKFLOW_STEP_PERFORMANCE.

See also
WORKFLOW_STEP_PERFORMANCE Event Information Description for a description of the event info hash
Since
Qorus 3.0.2

◆ QEC_WORKFLOW_STOP

const public OMQ::QEC_WORKFLOW_STOP = 2002

Qorus Event Code: WORKFLOW_STOP.

See also

◆ QEC_WORKFLOW_UPDATED

const public OMQ::QEC_WORKFLOW_UPDATED = 2017

Qorus Event code: WORKFLOW_UPDATED.

WORKFLOW_UPDATED Event Information Description for a description of the event info hash

Since
Qorus 4.0

◆ QorusClientOptionHash

const public 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

◆ QorusMapperKeys

const public OMQ::QorusMapperKeys
Initial value:
= {
"context": <MapperRuntimeKeyInfo>{
"desc": "the option's value will be processed by UserApi::expandTemplatedValue(), and the "
"resulting value will be used",
"value_type": "string",
"unique_roles": "value",
},
"template": <MapperRuntimeKeyInfo>{
"desc": "the value of the input field will be processed by UserApi::expandTemplatedValue(), "
"and the resulting value will be used",
"value_type": "bool",
"requires_roles": "value",
},
"value_lookup": <MapperRuntimeKeyInfo>{
"desc": "the format is <value map name>.<key>; the result of the lookup will be used",
"value_type": "string",
"unique_roles": "value",
},
}

Mapper keys to be added to all data provider info hashes.

Since
Qorus 4.1

◆ QR_ADD_DATASOURCE

const public OMQ::QR_ADD_DATASOURCE = "ADD-DATASOURCE"

RBAC System Permission: "ADD-DATASOURCE".

Allows adding new datasources

Since
Qorus 3.0.0

◆ QR_ADD_GROUP

const public OMQ::QR_ADD_GROUP = "ADD-GROUP"

RBAC System Permission: "ADD-GROUP".

This permission allows the caller to add interface groups

◆ QR_ADD_PERMISSION

const public OMQ::QR_ADD_PERMISSION = "ADD-PERMISSION"

RBAC System Permission: "ADD-PERMISSION".

This permission allows the caller to add a user permission

◆ QR_ADD_ROLE

const public OMQ::QR_ADD_ROLE = "ADD-ROLE"

RBAC System Permission: "ADD-ROLE".

This permission allows the caller to add a role

◆ QR_ADD_SERVER_CONNECTION

const public OMQ::QR_ADD_SERVER_CONNECTION = "ADD-SERVER-CONNECTION"

RBAC System Permission: "ADD-SERVER-CONNECTION".

this permission allows the user to add Qorus <-> Qorus server connection information

Since
Qorus 4.0.0

◆ QR_ADD_USER

const public OMQ::QR_ADD_USER = "ADD-USER"

RBAC System Permission: "ADD-USER".

This permission allows the caller to add a user

◆ QR_ADD_USER_CONNECTION

const public OMQ::QR_ADD_USER_CONNECTION = "ADD-USER-CONNECTION"

RBAC System Permission: "ADD-USER-CONNECTION".

this permission allows the user to add user connections

Since
Qorus 3.0.0

◆ QR_BLOCK_WORKFLOW_ORDER

const public OMQ::QR_BLOCK_WORKFLOW_ORDER = "BLOCK-WORKFLOW-ORDER"

RBAC System Permission: "BLOCK-WORKFLOW-ORDER".

This permission allows the caller to block and unblock workflow order instances

◆ QR_BREAK_WORKFLOW_ORDER_LOCK

const public OMQ::QR_BREAK_WORKFLOW_ORDER_LOCK = "BREAK-WORKFLOW-ORDER-LOCK"

RBAC System Permission: "BREAK-WORKFLOW-ORDER-LOCK".

This permission allows the caller to break exclusive operator locks acquired by other users on workflow order instances

◆ QR_CALL_SYSTEM_SERVICES_RO

const public OMQ::QR_CALL_SYSTEM_SERVICES_RO = "CALL-SYSTEM-SERVICES-RO"

RBAC System Permission: "CALL-SYSTEM-SERVICES-RO".

this permission allows the caller to call system service methods without the write flag set

◆ QR_CALL_SYSTEM_SERVICES_RW

const public OMQ::QR_CALL_SYSTEM_SERVICES_RW = "CALL-SYSTEM-SERVICES-RW"

RBAC System Permission: "CALL-SYSTEM-SERVICES-RW".

this permission allows the caller to call system service methods with write flag set

◆ QR_CALL_USER_SERVICES_RO

const public OMQ::QR_CALL_USER_SERVICES_RO = "CALL-USER-SERVICES-RO"

RBAC System Permission: "CALL-USER-SERVICES-RO".

this permission allows the caller to call user service methods without the write flag set

◆ QR_CALL_USER_SERVICES_RW

const public OMQ::QR_CALL_USER_SERVICES_RW = "CALL-USER-SERVICES-RW"

RBAC System Permission: "CALL-USER-SERVICES-RW".

this permission allows the caller to call user service methods with write flag set

◆ QR_CANCEL_WORKFLOW_ORDER

const public OMQ::QR_CANCEL_WORKFLOW_ORDER = "CANCEL-WORKFLOW-ORDER"

RBAC System Permission: "CANCEL-WORKFLOW-ORDER".

This permission allows the caller to cancel and uncancel workflow order instances

◆ QR_CREATE_LOGGER

const public OMQ::QR_CREATE_LOGGER = "CREATE-LOGGER"

RBAC System Permission: "CREATE-LOGGER".

this permission allows the user to create loggers and appenders

◆ QR_CREATE_SLA

const public OMQ::QR_CREATE_SLA = "CREATE-SLA"

RBAC System Permission: "CREATE-SLA".

this permission allows the user to create SLAs

Since
Qorus 3.1.1

◆ QR_CREATOR_CONTROL

const public OMQ::QR_CREATOR_CONTROL = "CREATOR-CONTROL"

Remote Command System Permission: "CREATOR-CONTROL".

this permission provides full access to all functionality of the creator API Includes the following:

Since
Qorus 5.1

◆ QR_CREATOR_CREATE

const public OMQ::QR_CREATOR_CREATE = "CREATOR-CREATE"

Remote Command System Permission: "CREATOR-CREATE".

Allows the user to create interface objects with the creator API

Since
Qorus 5.1

◆ QR_CREATOR_DELETE

const public OMQ::QR_CREATOR_DELETE = "CREATOR-DELETE"

Remote Command System Permission: "CREATOR-DELETE".

Allows the user to delete interface objects with the creator API

Since
Qorus 5.1

◆ QR_CREATOR_UPDATE

const public OMQ::QR_CREATOR_UPDATE = "CREATOR-UPDATE"

Remote Command System Permission: "CREATOR-UPDATE".

Allows the user to update interface objects with the creator API

Since
Qorus 5.1

◆ QR_DATA_PROVIDER_CONTROL

const public OMQ::QR_DATA_PROVIDER_CONTROL = "DATA-PROVIDER-CONTROL"

Data Provider System Permission: "DATA-PROVIDER-CONTROL".

this permission allows the user to perform all actions with data providers Includes the following:

Since
Qorus 4.1

◆ QR_DATA_PROVIDER_CREATE

const public OMQ::QR_DATA_PROVIDER_CREATE = "DATA-PROVIDER-CREATE"

Data Provider System Permission: "DATA-PROVIDER-CREATE".

this permission allows the user to create records in data providers

Since
Qorus 4.1

◆ QR_DATA_PROVIDER_DELETE

const public OMQ::QR_DATA_PROVIDER_DELETE = "DATA-PROVIDER-DELETE"

Data Provider System Permission: "DATA-PROVIDER-DELETE".

this permission allows the user to update / upsert records in data providers

Since
Qorus 4.1

◆ QR_DATA_PROVIDER_READ

const public OMQ::QR_DATA_PROVIDER_READ = "DATA-PROVIDER-READ"

Data Provider System Permission: "DATA-PROVIDER-READ".

this permission allows the user to read data from data providers

Since
Qorus 4.1

◆ QR_DATA_PROVIDER_REQUEST

const public OMQ::QR_DATA_PROVIDER_REQUEST = "DATA-PROVIDER-REQUEST"

Data Provider System Permission: "DATA-PROVIDER-REQUEST".

this permission allows the user to execute requests in data providers

Since
Qorus 4.1

◆ QR_DATA_PROVIDER_UPDATE

const public OMQ::QR_DATA_PROVIDER_UPDATE = "DATA-PROVIDER-UPDATE"

Data Provider System Permission: "DATA-PROVIDER-UPDATE".

this permission allows the user to update / upsert records in data providers

Since
Qorus 4.1

◆ QR_DATASOURCE_CONTROL

const public OMQ::QR_DATASOURCE_CONTROL = "DATASOURCE-CONTROL"

RBAC System Permission: "DATASOURCE-CONTROL".

this permission allows the user to save the server-side Datasource Connections and to use functionality that sends datasource passwords

Includes the following:

Since
Qorus 2.5.0

◆ QR_DEBUG_CONTROL

const public OMQ::QR_DEBUG_CONTROL = "DEBUG-CONTROL"

RBAC System Permission: "DEBUG-CONTROL".

this permission allows the user to debug the system

Since
Qorus 3.1.1

◆ QR_DELETE_DATASOURCE

const public OMQ::QR_DELETE_DATASOURCE = "DELETE-DATASOURCE"

RBAC System Permission: "DELETE-DATASOURCE".

Allows deleting datasources

Since
Qorus 3.0.0

◆ QR_DELETE_GROUP

const public OMQ::QR_DELETE_GROUP = "DELETE-GROUP"

RBAC System Permission: "DELETE-GROUP".

This permission allows the caller to delete interface groups

◆ QR_DELETE_LOGGER

const public OMQ::QR_DELETE_LOGGER = "DELETE-LOGGER"

RBAC System Permission: "DELETE-LOGGER".

this permission allows the user to delete loggers and appenders

◆ QR_DELETE_PERMISSION

const public OMQ::QR_DELETE_PERMISSION = "DELETE-PERMISSION"

RBAC System Permission: "DELETE-PERMISSION".

This permission allows the caller to delete a user permission

◆ QR_DELETE_PROPERTY

const public OMQ::QR_DELETE_PROPERTY = "DELETE-PROPERTY"

RBAC System Permission: "DELETE-PROPERTY".

allows the user to delete system properties

Since
Qorus 3.0.0

◆ QR_DELETE_ROLE

const public OMQ::QR_DELETE_ROLE = "DELETE-ROLE"

RBAC System Permission: "DELETE-ROLE".

This permission allows the caller to delete a role

◆ QR_DELETE_SENSITIVE_DATA

const public OMQ::QR_DELETE_SENSITIVE_DATA = "DELETE-SENSITIVE-DATA"

RBAC System Permission: "DELETE-SENSITIVE-DATA";.

This permission allows the caller to delete workflow sensitive data

See also
Sensitive Data
Since
Qorus 3.1.1

◆ QR_DELETE_SERVER_CONNECTION

const public OMQ::QR_DELETE_SERVER_CONNECTION = "DELETE-SERVER-CONNECTION"

RBAC System Permission: "DELETE-SERVER-CONNECTION".

this permission allows the user to delete Qorus <-> Qorus server connection information

Since
Qorus 4.0.0

◆ QR_DELETE_SLA

const public OMQ::QR_DELETE_SLA = "DELETE-SLA"

RBAC System Permission: "DELETE-SLA".

this permission allows the user to delete SLAs

Since
Qorus 3.1.1

◆ QR_DELETE_USER

const public OMQ::QR_DELETE_USER = "DELETE-USER"

RBAC System Permission: "DELETE-USER".

This permission allows the caller to delete a user

◆ QR_DELETE_USER_CONNECTION

const public OMQ::QR_DELETE_USER_CONNECTION = "DELETE-USER-CONNECTION"

RBAC System Permission: "DELETE-USER-CONNECTION".

this permission allows the user to delete user connections

Since
Qorus 3.0.0

◆ QR_EDIT_SENSITIVE_DATA

const public OMQ::QR_EDIT_SENSITIVE_DATA = "EDIT-SENSITIVE-DATA"

RBAC System Permission: "EDIT-SENSITIVE-DATA";.

This permission allows the caller to update workflow sensitive data

See also
Sensitive Data
Since
Qorus 3.1.1

◆ QR_EDIT_WORKFLOW_DATA

const public OMQ::QR_EDIT_WORKFLOW_DATA = "EDIT-WORKFLOW-DATA"

RBAC System Permission: "EDIT-WORKFLOW-DATA".

this permission allows the caller to update Workflow Static Order Data and Workflow Dynamic Order Data by calling omq.system.replace-static-data() and omq.system.replace-dynamic-data(), respectively

◆ QR_EXEC_SYNC_WORKFLOW

const public OMQ::QR_EXEC_SYNC_WORKFLOW = "EXEC-SYNC-WORKFLOW"

RBAC System Permission: "EXEC-SYNC-WORKFLOW".

this permission allows the user to execute synchronous workflows (call omq.system.exec-synchronous-workflow() and omq.system.exec-synchronous-existing())

◆ QR_FILESYSTEM_CONTROL

const public OMQ::QR_FILESYSTEM_CONTROL = "FILESYSTEM-CONTROL"

RBAC System Permission: "FILESYSTEM-CONTROL".

this permission allows the user to read and write to the filesystem

Since
Qorus 3.0.2

◆ QR_FILESYSTEM_READ

const public OMQ::QR_FILESYSTEM_READ = "FILESYSTEM-READ"

RBAC System Permission: "FILESYSTEM-READ".

this permission allows the user to read from the filesystem

Since
Qorus 3.0.2

◆ QR_FILESYSTEM_WRITE

const public OMQ::QR_FILESYSTEM_WRITE = "FILESYSTEM-WRITE"

RBAC System Permission: "FILESYSTEM-WRITE".

this permission allows the user to write to the filesystem

Since
Qorus 3.0.2

◆ QR_FLUSH_DATASOURCE

const public OMQ::QR_FLUSH_DATASOURCE = "FLUSH-DATASOURCE"

RBAC System Permission: "FLUSH-DATASOURCE".

Allows the user to flush all cached datasource information to the configuration file

Since
Qorus 3.0.0

◆ QR_GROUP_CONTROL

const public OMQ::QR_GROUP_CONTROL = "GROUP-CONTROL"

RBAC System Permission: "GROUP-CONTROL".

this permission allows the user to manipulate group definitions and to enable/disable workflow/service groups

Includes the following:

Note
Any user with this permission can change the definition of any group and enable/disable any group, so assign with care
See also
OMQ::QR_USER_CONTROL
Since
Qorus 2.6.0

◆ QR_JOB_CONTROL

const public OMQ::QR_JOB_CONTROL = "JOB-CONTROL"

RBAC System Permission: "JOB-CONTROL".

this permission allows the user to update the status of jobs

Includes the following:

Since
Qorus 2.6.1

◆ QR_JOB_OPTION_CONTROL

const public OMQ::QR_JOB_OPTION_CONTROL = "JOB-OPTION-CONTROL"

RBAC System Permission: "JOB-OPTION-CONTROL".

This permission allows the caller to change job options

Since
Qorus 5.0

◆ QR_KILL_PROCESS

const public OMQ::QR_KILL_PROCESS = "KILL-PROCESS"

RBAC System Permission: "KILL-PROCESS".

this permission allows the user to kill remote Qorus processes

Since
Qorus 4.0

◆ QR_LOAD_SERVICE

const public OMQ::QR_LOAD_SERVICE = "LOAD-SERVICE"

RBAC System Permission: "LOAD-SERVICE".

This permission allows the caller to load services

◆ QR_LOCK_WORKFLOW_ORDER

const public OMQ::QR_LOCK_WORKFLOW_ORDER = "LOCK-WORKFLOW-ORDER"

RBAC System Permission: "LOCK-WORKFLOW-ORDER".

This permission allows the caller to acquire and release exclusive operator locks on workflow order instances

◆ QR_LOGGER_CONTROL

const public OMQ::QR_LOGGER_CONTROL = "LOGGER-CONTROL"

RBAC System Permission: "LOGGER-CONTROL".

this permission allows the caller to manipulate RBAC information, including other users

Includes the following:

Note
Any user with this permission can add (or remove) permissions and groups to (or from) any user, so assign with care
See also
OMQ::QR_GROUP_CONTROL

◆ QR_LOGIN

const public OMQ::QR_LOGIN = "LOGIN"

RBAC System Permission: "LOGIN".

This permission is required for any user to connect to the system; it also implies read-only access to system configuration and data

◆ QR_MAPPER_CONTROL

const public OMQ::QR_MAPPER_CONTROL = "MAPPER-CONTROL"

RBAC System Permission: "MAPPER-CONTROL".

this permission allows the user to control data mapper objects Includes the following:

Since
Qorus 3.1.0

◆ QR_MODIFY_DATASOURCE

const public OMQ::QR_MODIFY_DATASOURCE = "MODIFY-DATASOURCE"

RBAC System Permission: "MODIFY-DATASOURCE".

Allows adding and modifying existing datasources and flushing the configuration to a file

Since
Qorus 3.0.0

◆ QR_MODIFY_GROUP

const public OMQ::QR_MODIFY_GROUP = "MODIFY-GROUP"

RBAC System Permission: "MODIFY-GROUP".

This permission allows the caller to modify interface groups

Includes the following:

◆ QR_MODIFY_GROUP_STATUS

const public OMQ::QR_MODIFY_GROUP_STATUS = "MODIFY-GROUP-STATUS"

RBAC System Permission: "MODIFY-GROUP-STATUS".

This permission allows the caller to modify interface group statuses (ie enable/disable interface groups)

◆ QR_MODIFY_JOB_EXPIRY

const public OMQ::QR_MODIFY_JOB_EXPIRY = "MODIFY-JOB-EXPIRY"

RBAC System Permission: "MODIFY-JOB-EXPIRY".

This permission allows the caller to modify job expiry dates

◆ QR_MODIFY_JOB_STATUS

const public OMQ::QR_MODIFY_JOB_STATUS = "MODIFY-JOB-STATUS"

RBAC System Permission: "MODIFY-JOB-STATUS".

This permission allows the caller to modify job statuses

◆ QR_MODIFY_LOGGER

const public OMQ::QR_MODIFY_LOGGER = "MODIFY-LOGGER"

RBAC System Permission: "MODIFY-LOGGER".

this permission allows the user to modify loggers and appenders

◆ QR_MODIFY_MAPPER

const public OMQ::QR_MODIFY_MAPPER = "MODIFY-MAPPER"

RBAC System Permission: "MODIFY-MAPPER".

this permission allows the user to modify existing data mappers

Since
Qorus 3.1.0

◆ QR_MODIFY_PERMISSION

const public OMQ::QR_MODIFY_PERMISSION = "MODIFY-PERMISSION"

RBAC System Permission: "MODIFY-PERMISSION".

This permission allows the caller to modify a user permission

◆ QR_MODIFY_ROLE

const public OMQ::QR_MODIFY_ROLE = "MODIFY-ROLE"

RBAC System Permission: "MODIFY-ROLE".

This permission allows the caller to modify a role

◆ QR_MODIFY_SERVER_CONNECTION

const public OMQ::QR_MODIFY_SERVER_CONNECTION = "MODIFY-SERVER-CONNECTION"

RBAC System Permission: "MODIFY-SERVER-CONNECTION".

this permission allows the user to modify Qorus <-> Qorus server connection information

Since
Qorus 4.0.0

◆ QR_MODIFY_SLA

const public OMQ::QR_MODIFY_SLA = "MODIFY-SLA"

RBAC System Permission: "MODIFY-SLA".

this permission allows the user to modify SLAs

Since
Qorus 3.1.1

◆ QR_MODIFY_USER

const public OMQ::QR_MODIFY_USER = "MODIFY-USER"

RBAC System Permission: "MODIFY-USER".

This permission allows the caller to modify a user

◆ QR_MODIFY_USER_CONNECTION

const public OMQ::QR_MODIFY_USER_CONNECTION = "MODIFY-USER-CONNECTION"

RBAC System Permission: "MODIFY-USER-CONNECTION".

this permission allows the user to modify user connections

Since
Qorus 3.0.0

◆ QR_MODIFY_VALUE_MAP

const public OMQ::QR_MODIFY_VALUE_MAP = "MODIFY-VALUE-MAP"

RBAC System Permission: "MODIFY-VALUE-MAP".

this permission allows the user to modify existing value maps

Since
Qorus 3.1.0

◆ QR_OPTION_CONTROL

const public OMQ::QR_OPTION_CONTROL = "OPTION-CONTROL"

RBAC System Permission: "OPTION-CONTROL".

this permission allows the caller to change system options

◆ QR_POST_WORKFLOW_EVENT

const public OMQ::QR_POST_WORKFLOW_EVENT = "POST-WORKFLOW-EVENT"

RBAC System Permission: "POST-WORKFLOW-EVENT".

This permission allows the caller to post workflow events

◆ QR_READ_DATASOURCE

const public OMQ::QR_READ_DATASOURCE = "READ-DATASOURCE"

RBAC System Permission: "READ-DATASOURCE".

Allows reading datasource passwords

Since
Qorus 3.0.0

◆ QR_READ_SENSITIVE_DATA

const public OMQ::QR_READ_SENSITIVE_DATA = "READ-SENSITIVE-DATA"

RBAC System Permission: "READ-SENSITIVE-DATA";.

This permission allows the caller to read workflow sensitive data

See also
Sensitive Data
Since
Qorus 3.1.1

◆ QR_READ_SERVER_CONNECTION

const public OMQ::QR_READ_SERVER_CONNECTION = "READ-SERVER-CONNECTION"

RBAC System Permission: "READ-SERVER-CONNECTION".

this permission allows the user to read Qorus <-> Qorus server connection information

Since
Qorus 3.0.0

◆ QR_READ_USER_CONNECTION

const public OMQ::QR_READ_USER_CONNECTION = "READ-USER-CONNECTION"

RBAC System Permission: "READ-USER-CONNECTION".

this permission allows the user to read user connections

Since
Qorus 3.0.0

◆ QR_RELOAD_DATASOURCE

const public OMQ::QR_RELOAD_DATASOURCE = "RELOAD-DATASOURCE"

RBAC System Permission: "RELOAD-DATASOURCE".

Allows the user to reload all datasources from the source file

Since
Qorus 3.0.0

◆ QR_RELOAD_MAPPER

const public OMQ::QR_RELOAD_MAPPER = "RELOAD-MAPPER"

RBAC System Permission: "RELOAD-MAPPER".

this permission allows the user to reload data mappers

Since
Qorus 3.1.0

◆ QR_RELOAD_PROPERTIES

const public OMQ::QR_RELOAD_PROPERTIES = "RELOAD-PROPERTIES"

RBAC System Permission: "RELOAD-PROPERTIES".

allows the user to reload system properties from the database

Since
Qorus 3.0.0

◆ QR_RELOAD_RBAC

const public OMQ::QR_RELOAD_RBAC = "RELOAD-RBAC"

RBAC System Permission: "RELOAD-RBAC".

This permission allows the caller to reload RBAC information from the database

◆ QR_RELOAD_SERVER_CONNECTION

const public OMQ::QR_RELOAD_SERVER_CONNECTION = "RELOAD-SERVER-CONNECTION"

RBAC System Permission: "RELOAD-SERVER-CONNECTION".

this permission allows the user to reload Qorus <-> Qorus server connections

Since
Qorus 3.0.0

◆ QR_RELOAD_USER_CONNECTION

const public OMQ::QR_RELOAD_USER_CONNECTION = "RELOAD-USER-CONNECTION"

RBAC System Permission: "RELOAD-USER-CONNECTION".

this permission allows the user to reload user connections

Since
Qorus 3.0.0

◆ QR_RELOAD_VALUE_MAP

const public OMQ::QR_RELOAD_VALUE_MAP = "RELOAD-VALUE-MAP"

RBAC System Permission: "RELOAD-VALUE-MAP".

this permission allows the user to reload value maps

Since
Qorus 3.1.0

◆ QR_REMOTE_DELETE_INTERFACE

const public OMQ::QR_REMOTE_DELETE_INTERFACE = "REMOTE-DELETE-INTERFACE"

RBAC System Permission: "REMOTE-DELETE-INTERFACE".

this permission allows the user to delete interfaces from Qorus remotely

Since
Qorus 4.0

◆ QR_REMOTE_DEPLOYMENT

const public OMQ::QR_REMOTE_DEPLOYMENT = "REMOTE-DEPLOYMENT"

RBAC System Permission: "REMOTE-DEPLOYMENT".

this permission allows the user to deploy to Qorus remotely

Since
Qorus 4.0

◆ QR_REMOTE_EXEC_ALL

const public OMQ::QR_REMOTE_EXEC_ALL = "REMOTE-EXEC-ALL"

RBAC System Permission: "REMOTE-EXEC-ALL".

This permission allows the user to execute any program with the remote API

Since
Qorus 5.0.1

◆ QR_REMOTE_RELEASE

const public OMQ::QR_REMOTE_RELEASE = "REMOTE-RELEASE"

RBAC System Permission: "REMOTE-RELEASE".

this permission allows the user to release functionality to Qorus remotely

Since
Qorus 4.0
Deprecated:
use QR_REMOTE_DEPLOYMENT instead

◆ QR_REPRIORITIZE_WORKFLOW_ORDER

const public OMQ::QR_REPRIORITIZE_WORKFLOW_ORDER = "REPRIORITIZE-WORKFLOW-ORDER"

RBAC System Permission: "REPRIORITIZE-WORKFLOW-ORDER".

This permission allows the caller to reprioritize workflow order instances

◆ QR_RESCHEDULE_JOB

const public OMQ::QR_RESCHEDULE_JOB = "RESCHEDULE-JOB"

RBAC System Permission: "RESCHEDULE-JOB".

This permission allows the caller to reschedule jobs

◆ QR_RESCHEDULE_WORKFLOW_ORDER

const public OMQ::QR_RESCHEDULE_WORKFLOW_ORDER = "RESCHEDULE-WORKFLOW-ORDER"

RBAC System Permission: "RESCHEDULE-WORKFLOW-ORDER".

This permission allows the caller to reschedule workflow order instances

◆ QR_RESET_DATASOURCE

const public OMQ::QR_RESET_DATASOURCE = "RESET-DATASOURCE"

RBAC System Permission: "RESET-DATASOURCE".

Allows resetting existing datasources

Since
Qorus 3.0.0

◆ QR_RESET_JOB

const public OMQ::QR_RESET_JOB = "RESET-JOB"

RBAC System Permission: "RESET-JOB".

This permission allows the caller to reset jobs

◆ QR_RESET_SERVICE

const public OMQ::QR_RESET_SERVICE = "RESET-SERVICE"

RBAC System Permission: "RESET-SERVICE".

This permission allows the caller to reset services

◆ QR_RESET_WORKFLOW

const public OMQ::QR_RESET_WORKFLOW = "RESET-WORKFLOW"

RBAC System Permission: "RESET-WORKFLOW".

This permission allows the caller to reset workflow execution instances

◆ QR_RETRY_WORKFLOW_ORDER

const public OMQ::QR_RETRY_WORKFLOW_ORDER = "RETRY-WORKFLOW-ORDER"

RBAC System Permission: "RETRY-WORKFLOW-ORDER".

This permission allows the caller to retry workflow order instances

◆ QR_ROTATE_LOG_FILES

const public OMQ::QR_ROTATE_LOG_FILES = "ROTATE-LOG-FILES"

RBAC System Permission: "ROTATE-LOG-FILES".

this permission allows the user to rotate log files (call omq.system.rotate-log-files())

◆ QR_RUN_JOB

const public OMQ::QR_RUN_JOB = "RUN-JOB"

RBAC System Permission: "RUN-JOB".

This permission allows the caller to run jobs

◆ QR_SCALING

const public OMQ::QR_SCALING = "SCALING"

Remote Command System Permission: "SCALING".

Allows access to autoscaling APIs when running under Kubernetes

Since
Qorus 5.1

◆ QR_SCHEMA_CONTROL

const public OMQ::QR_SCHEMA_CONTROL = "SCHEMA-CONTROL"

RBAC System Permission: "SCHEMA-CONTROL".

this permission allows the user to manage system database schema

Since
Qorus 2.6.3

◆ QR_SELECT_DATASOURCE

const public OMQ::QR_SELECT_DATASOURCE = "SELECT-DATASOURCE"

RBAC System Permission: "SELECT-DATASOURCE".

Allows executing select statements over the REST API on a datasource

Since
Qorus 3.0.0

◆ QR_SENSITIVE_DATA_CONTROL

const public OMQ::QR_SENSITIVE_DATA_CONTROL = "SENSITIVE-DATA-CONTROL"

RBAC System Permission: "SENSITIVE-DATA-CONTROL";.

This permission allows the caller to read, create, update, and delete workflow sensitive data

Includes the following:

See also
Sensitive Data
Since
Qorus 3.1.1

◆ QR_SERVER_CONNECTION_CONTROL

const public OMQ::QR_SERVER_CONNECTION_CONTROL = "SERVER-CONNECTION-CONTROL"

RBAC System Permission: "SERVER-CONNECTION-CONTROL".

this permission allows the user to control Qorus <-> Qorus server connections Includes the following:

Since
Qorus 3.0.0

◆ QR_SERVER_CONTROL

const public OMQ::QR_SERVER_CONTROL = "SERVER-CONTROL"

RBAC System Permission: "SERVER-CONTROL".

this permission allows the user to start or stop HTTP listeners (call omq.system.stop-listener(), omq.system.stop-listener-id(), omq.system.start-listeners()) and manipulate system properties

Includes the following:

Since
Qorus 2.6.0

◆ QR_SERVICE_CONTROL

const public OMQ::QR_SERVICE_CONTROL = "SERVICE-CONTROL"

RBAC System Permission: "SERVICE-CONTROL".

this permission allows the called to start, stop, reload, and generally manipulate services Includes the following:

◆ QR_SERVICE_OPTION_CONTROL

const public OMQ::QR_SERVICE_OPTION_CONTROL = "SERVICE-OPTION-CONTROL"

RBAC System Permission: "SERVICE-OPTION-CONTROL".

This permission allows the caller to change service options

Since
Qorus 5.0

◆ QR_SET_FSM_CONFIG

const public OMQ::QR_SET_FSM_CONFIG = "SET-FSM-CONFIG"

Finite State Machine System Permission: "SET-FSM-CONFIG".

this permission allows the user to set configuration item values for Finite State Machines

Since
Qorus 5.0

◆ QR_SET_JOB_CONFIG

const public OMQ::QR_SET_JOB_CONFIG = "SET-JOB-CONFIG"

RBAC System Permissions: "SET-JOB-CONFIG".

this permission allows the caller to change job configuration item values

Since
Qorus 4.0

◆ QR_SET_JOB_OPTIONS

const public OMQ::QR_SET_JOB_OPTIONS = "SET-JOB-OPTIONS"

RBAC System Permission: "SET-JOB-OPTIONS".

This permission allows the caller to set job options

◆ QR_SET_ORDER_INFO

const public OMQ::QR_SET_ORDER_INFO = "SET-ORDER-INQR_O"

RBAC System Permission: "SET-ORDER-INFO"QR_.

This permission allows the caller to set uQR_ername and comments fields in workflow order instances

◆ QR_SET_PIPELINE_CONFIG

const public OMQ::QR_SET_PIPELINE_CONFIG = "SET-PIPELINE-CONFIG"

Pipeline System Permission: "SET-PIPELINE-CONFIG".

this permission allows the user to set configuration item values for data pipelines

Since
Qorus 5.0

◆ QR_SET_PROPERTY

const public OMQ::QR_SET_PROPERTY = "SET-PROPERTY"

RBAC System Permission: "SET-PROPERTY".

allows the user to create or modify system properties

Since
Qorus 3.0.0

◆ QR_SET_SERVICE_AUTOSTART

const public OMQ::QR_SET_SERVICE_AUTOSTART = "SET-SERVICE-AUTOSTART"

RBAC System Permission: "SET-SERVICE-AUTOSTART".

This permission allows the caller to change the service autostart flag

◆ QR_SET_SERVICE_CONFIG

const public OMQ::QR_SET_SERVICE_CONFIG = "SET-SERVICE-CONFIG"

RBAC System Permissions: "SET-SERVICE-CONFIG".

this permission allows the caller to change service configuration item values

Since
Qorus 4.0

◆ QR_SET_SERVICE_OPTIONS

const public OMQ::QR_SET_SERVICE_OPTIONS = "SET-SERVICE-OPTIONS"

RBAC System Permission: "SET-SERVICE-OPTIONS".

This permission allows the caller to set service options

◆ QR_SET_STEP_CONFIG

const public OMQ::QR_SET_STEP_CONFIG = "SET-STEP-CONFIG"

RBAC System Permissions: "SET-STEP-CONFIG".

this permission allows the caller to change step configuration item values

Since
Qorus 4.0

◆ QR_SET_WORKFLOW_CONFIG

const public OMQ::QR_SET_WORKFLOW_CONFIG = "SET-WORKFLOW-CONFIG"

RBAC System Permissions: "SET-WORKFLOW-CONFIG".

this permission allows the caller to change workflow configuration item values

Since
Qorus 4.0.3

◆ QR_SET_WORKFLOW_ORDER_ERROR

const public OMQ::QR_SET_WORKFLOW_ORDER_ERROR = "SET-WORKFLOW-ORDER-ERROR"

RBAC System Permission: "SET-WORKFLOW-ORDER-ERROR".

This permission allows the caller to set workflow order instances to ERROR

◆ QR_SHUTDOWN

const public OMQ::QR_SHUTDOWN = "SHUTDOWN"

RBAC System Permission: "SHUTDOWN".

This permission allows the caller to shut down the system (call omq.system.shutdown() and omq.system.shutdown-wait())

◆ QR_SKIP_STEP

const public OMQ::QR_SKIP_STEP = "SKIP-STEP"

RBAC System Permission: "SKIP-STEP".

This permission allows the caller to skip steps in workflow order instances

◆ QR_SLA_CONTROL

const public OMQ::QR_SLA_CONTROL = "SLA-CONTROL"

RBAC System Permission: "SLA-CONTROL".

this permission allows the user to create, delete, and modify SLAs

Since
Qorus 3.1.1

◆ QR_SQLUTIL_READ

const public OMQ::QR_SQLUTIL_READ = "SQLUTIL-READ"

RBAC System Permission: "SQLUTIL-READ".

Allows the user to execute remote read operations on the sqlutil service

Since
Qorus 3.0.2

◆ QR_SQLUTIL_WRITE

const public OMQ::QR_SQLUTIL_WRITE = "SQLUTIL-WRITE"

RBAC System Permission: "SQLUTIL-WRITE".

Allows the user to execute remote write operations on the sqlutil service

Since
Qorus 3.0.2

◆ QR_START_LISTENER

const public OMQ::QR_START_LISTENER = "START-LISTENER"

RBAC System Permission: "START-LISTENER".

allows the user to start HTTP listeners

Since
Qorus 3.0.0

◆ QR_START_WORKFLOW

const public OMQ::QR_START_WORKFLOW = "START-WORKFLOW"

RBAC System Permission: "START-WORKFLOW".

This permission allows the caller to start workflow execution instances

◆ QR_STOP_LISTENER

const public OMQ::QR_STOP_LISTENER = "STOP-LISTENER"

RBAC System Permission: "STOP-LISTENER".

allows the user to start HTTP listeners

Since
Qorus 3.0.0

◆ QR_STOP_WORKFLOW

const public OMQ::QR_STOP_WORKFLOW = "STOP-WORKFLOW"

RBAC System Permission: "STOP-WORKFLOW".

This permission allows the caller to stop workflow execution instances

◆ QR_SUBMIT_ORDER

const public OMQ::QR_SUBMIT_ORDER = "SUBMIT-ORDER"

RBAC System Permission: "SUBMIT-ORDER".

this permission allows the caller to submit new workflow order data (call omq.system.submit-data.[workflow].[version]())

◆ QR_TYPE_CACHE_CONTROL

const public OMQ::QR_TYPE_CACHE_CONTROL = "TYPE-CACHE-CONTROL"

Type Cache System Permission: "TYPE-CACHE-CONTROL".

this permissions allows the user to perform all actions with the type cache Includes the following:

Since
Qorus 4.1.2

◆ QR_TYPE_CACHE_CREATE

const public OMQ::QR_TYPE_CACHE_CREATE = "TYPE-CACHE-CREATE"

Type Cache System Permission: "TYPE-CACHE-CREATE".

this permissions allows the user to add or replace types in the type cache

Since
Qorus 4.1.2

◆ QR_TYPE_CACHE_DELETE

const public OMQ::QR_TYPE_CACHE_DELETE = "TYPE-CACHE-DELETE"

Type Cache System Permission: "TYPE-CACHE-DELETE".

this permissions allows the user to remove types from the type cache

Since
Qorus 4.1.2

◆ QR_TYPE_CACHE_RELOAD

const public OMQ::QR_TYPE_CACHE_RELOAD = "TYPE-CACHE-RELOAD"

Type Cache System Permission: "TYPE-CACHE-RELOAD".

this permissions allows the user to reload the type cache

Since
Qorus 4.1.2

◆ QR_UNLOAD_SERVICE

const public OMQ::QR_UNLOAD_SERVICE = "UNLOAD-SERVICE"

RBAC System Permission: "UNLOAD-SERVICE".

This permission allows the caller to unload services

◆ QR_UPLOAD

const public OMQ::QR_UPLOAD = "UPLOAD"

Remote Command System Permission: "UPLOAD".

this permission allows the user to run upload files to a unique location on the Qorus server

Since
Qorus 5.0

◆ QR_USER_CONNECTION_CONTROL

const public OMQ::QR_USER_CONNECTION_CONTROL = "USER-CONNECTION-CONTROL"

RBAC System Permission: "USER-CONNECTION-CONTROL".

this permission allows the user to manage user connections

Includes the following:

Since
Qorus 3.0.0

◆ QR_USER_CONTROL

const public OMQ::QR_USER_CONTROL = "USER-CONTROL"

RBAC System Permission: "USER-CONTROL".

this permission allows the caller to manipulate RBAC information, including other users

Includes the following:

Note
Any user with this permission can add (or remove) permissions and groups to (or from) any user, so assign with care
See also
OMQ::QR_GROUP_CONTROL

◆ QR_VALUE_MAP_CONTROL

const public OMQ::QR_VALUE_MAP_CONTROL = "VALUE-MAP-CONTROL"

RBAC System Permission: "VALUE-MAP-CONTROL".

this permission allows the user to control value maps Includes the following:

Since
Qorus 3.1.0

◆ QR_WEBDAV_ACCESS_ALL

const public OMQ::QR_WEBDAV_ACCESS_ALL = "WEBDAV-ACCESS-ALL"

Remote Command System Permission: "WEBDAV-ACCESS-ALL".

This permission provides access to all files on the WebDAV filesystem

Since
Qorus 5.1

◆ QR_WEBDAV_CONTROL

const public OMQ::QR_WEBDAV_CONTROL = "WEBDAV-CONTROL"

Remote Command System Permission: "WEBDAV-CONTROL".

this permission provides full access to all functionality through the WebDAV interface Includes the following:

Additionally, roles with this permission have access to all users' and groups' files under $OMQ_DIR/user

Since
Qorus 5.1

◆ QR_WEBDAV_DELETE

const public OMQ::QR_WEBDAV_DELETE = "WEBDAV-DELETE"

Remote Command System Permission: "WEBDAV-DELETE".

Allows delete access to accessible files on the WebDAV filesystem

Since
Qorus 5.1

◆ QR_WEBDAV_READ

const public OMQ::QR_WEBDAV_READ = "WEBDAV-READ"

Remote Command System Permission: "WEBDAV-READ".

Allows read access to accessible files on the WebDAV filesystem

Since
Qorus 5.1

◆ QR_WEBDAV_RWD

const public OMQ::QR_WEBDAV_RWD = "WEBDAV-RWD"

Remote Command System Permission: "WEBDAV-RWD".

This permissions provides read, write, and delete access to acessible files on the WebDAV filesystem Includes the following:

Since
Qorus 5.1

◆ QR_WEBDAV_WRITE

const public OMQ::QR_WEBDAV_WRITE = "WEBDAV-WRITE"

Remote Command System Permission: "WEBDAV-WRITE".

Allows write access to accessible files on the WebDAV filesystem

Since
Qorus 5.1

◆ QR_WORKFLOW_CONTROL

const public OMQ::QR_WORKFLOW_CONTROL = "WORKFLOW-CONTROL"

RBAC System Permission: "WORKFLOW-CONTROL".

This permission allows the caller to use functions affecting workflow execution instances and workflow order data Includes the following:

Note
this permission does not include any permissions for sensitive data; these must be added separately

◆ QR_WORKFLOW_ERROR_CONTROL

const public OMQ::QR_WORKFLOW_ERROR_CONTROL = "WORKFLOW-ERROR-CONTROL"

RBAC System Permission: "WORKFLOW-ERROR-CONTROL".

This permission allows the caller to create, change, and delete workflow error definitions

◆ QR_WORKFLOW_EXEC_CONTROL

const public OMQ::QR_WORKFLOW_EXEC_CONTROL = "WORKFLOW-EXEC-CONTROL"

RBAC System Permission: "WORKFLOW-EXEC-CONTROL".

This permission allows the caller to use functions affecting workflow execution instances (start, stop, refresh, etc workflows) Includes the following:

◆ QR_WORKFLOW_OPTION_CONTROL

const public OMQ::QR_WORKFLOW_OPTION_CONTROL = "WORKFLOW-OPTION-CONTROL"

RBAC System Permission: "WORKFLOW-OPTION-CONTROL".

This permission allows the caller to change workflow execution instance options

◆ QR_WORKFLOW_ORDER_CONTROL

const public OMQ::QR_WORKFLOW_ORDER_CONTROL = "WORKFLOW-ORDER-CONTROL"

RBAC System Permission: "WORKFLOW-ORDER-CONTROL".

This permission allows the caller to use functions affecting workflow order data (except sensitive data) Includes the following:

Note
this permission does not include any permissions for sensitive data; these must be added separately

◆ QS_Error

const public OMQ::QS_Error = "ERROR"

Queue Status Text Description: ERROR.

The equivalent status code actually stored in the database is OMQ::SQL_QS_Error

◆ QS_Received

const public OMQ::QS_Received = "RECEIVED"

Queue Status Text Description: RECEIVED.

The equivalent status code actually stored in the database is OMQ::SQL_QS_Received

◆ QS_Used

const public OMQ::QS_Used = "USED"

Queue Status Text Description: USED.

The equivalent status code actually stored in the database is OMQ::SQL_QS_Used

Note
this status is only used in Oracle databases where the queue rows are not deleted in order to preserve the integrity of the indexes on the QUEUE_DATA table

◆ QS_Waiting

const public OMQ::QS_Waiting = "WAITING"

Queue Status Text Description: WAITING.

The equivalent status code actually stored in the database is OMQ::SQL_QS_Waiting

◆ SQL_JS_Complete

const public OMQ::SQL_JS_Complete = "C"

Job Status SQL Character Code: COMPLETE.

The equivalent descriptive status is OMQ::JS_Complete

◆ SQL_JS_Crash

const public OMQ::SQL_JS_Crash = "Z"

Job Status SQL Character Code: CRASH.

The equivalent descriptive status is OMQ::JS_Crash

◆ SQL_JS_Error

const public OMQ::SQL_JS_Error = "E"

Job Status SQL Character Code: ERROR.

The equivalent descriptive status is OMQ::JS_Error

◆ SQL_JS_InProgress

const public OMQ::SQL_JS_InProgress = "I"

Job Status SQL Character Code: IN-PROGRESS.

The equivalent descriptive status is OMQ::JS_InProgress

◆ SQL_QS_Error

const public OMQ::SQL_QS_Error = "E"

Queue Status SQL Character Code: ERROR.

The equivalent descriptive status is OMQ::QS_Error

◆ SQL_QS_Received

const public OMQ::SQL_QS_Received = "R"

Queue Status SQL Character Code: RECEIVED.

The equivalent descriptive status is OMQ::QS_Received

◆ SQL_QS_Used

const public OMQ::SQL_QS_Used = "X"

Queue Status SQL Character Code: USED.

The equivalent descriptive status is OMQ::QS_Used

Note
this status is only used in Oracle databases where the queue rows are not deleted in order to preserve the integrity of the indexes on the QUEUE_DATA table

◆ SQL_QS_Waiting

const public OMQ::SQL_QS_Waiting = "W"

Queue Status SQL Character Code: WAITING.

The equivalent descriptive status is OMQ::QS_Waiting

◆ SQLSensitiveKeyLen

const public OMQ::SQLSensitiveKeyLen = 150

length of sensitive data keys in bytes

Since
Qorus 3.1.1

◆ SQLSensitiveValueLen

const public OMQ::SQLSensitiveValueLen = 150

length of sensitive data key values in bytes

Since
Qorus 3.1.1

◆ SQLStatAsyncWaiting

const public OMQ::SQLStatAsyncWaiting = "A"

SQL Status: ASYNC-WAITING.

The equivalent descriptive status is OMQ::StatAsyncWaiting

◆ SQLStatBlocked

const public OMQ::SQLStatBlocked = "B"

SQL Status: BLOCKED.

The equivalent descriptive status is OMQ::StatBlocked

◆ SQLStatCanceled

const public OMQ::SQLStatCanceled = "X"

SQL Status: CANCELED.

The equivalent descriptive status is OMQ::StatCanceled

◆ SQLStatComplete

const public OMQ::SQLStatComplete = "C"

SQL Status: COMPLETE.

The equivalent descriptive status is OMQ::StatComplete

◆ SQLStatError

const public OMQ::SQLStatError = "E"

SQL Status: ERROR.

The equivalent descriptive status is OMQ::StatError

◆ SQLStatEventWaiting

const public OMQ::SQLStatEventWaiting = "V"

SQL Status: EVENT-WAITING.

The equivalent descriptive status is OMQ::StatEventWaiting

◆ SQLStatIncomplete

const public OMQ::SQLStatIncomplete = "N"

SQL Status: INCOMPLETE.

The equivalent descriptive status is OMQ::StatIncomplete

◆ SQLStatInProgress

const public OMQ::SQLStatInProgress = "I"

SQL Status: IN-PROGRESS.

The equivalent descriptive status is OMQ::StatInProgress

◆ SQLStatReady

const public OMQ::SQLStatReady = "Y"

SQL Status: READY.

The equivalent descriptive status is OMQ::StatReady

◆ SQLStatRetry

const public OMQ::SQLStatRetry = "R"

SQL Status: RETRY.

The equivalent descriptive status is OMQ::StatRetry

◆ SQLStatScheduled

const public OMQ::SQLStatScheduled = "S"

SQL Status: SCHEDULED.

The equivalent descriptive status is OMQ::StatScheduled

◆ SQLStatWaiting

const public OMQ::SQLStatWaiting = "W"

SQL Status: WAITING.

The equivalent descriptive status is OMQ::StatWaiting

◆ StatAsyncWaiting

const public OMQ::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.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatAsyncWaiting

◆ StatBlocked

const public OMQ::StatBlocked = "BLOCKED"

Indicates that workflow order data instance processing has been temporarily blocked.

This status is similar to OMQ::StatCanceled but is considered only temporary.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatBlocked

◆ StatCanceled

const public OMQ::StatCanceled = "CANCELED"

Indicates that workflow order data instance processing has been canceled.

This status is similar to OMQ::StatBlocked but is considered a final status.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatCanceled

◆ StatComplete

const public OMQ::StatComplete = "COMPLETE"

This status indicates that the object it is attached to has successfully completed its processing.

This is a final status; once a workflow, segment, or step is COMPLETE, it will not be processed anymore.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatComplete

◆ StatError

const public OMQ::StatError = "ERROR"

Indicates that the workflow order data instance has at least one step with an OMQ::StatError status.

This status takes the highest priority; if any one step in a workflow has an OMQ::StatError status, then the entire workflow will also have an OMQ::StatError status. Workflow order data instances must be manually updated to OMQ::StatRetry when an OMQ::StatError status is reached.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatError

◆ StatEventWaiting

const public OMQ::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.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatEventWaiting

◆ StatIncomplete

const public OMQ::StatIncomplete = "INCOMPLETE"

Indicates that processing for the workflow order data instance is not yet complete yet has no errors.

This status will be assigned after asynchronous segments have completed and dependent segments have not yet been started.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatIncomplete

◆ StatInProgress

const public OMQ::StatInProgress = "IN-PROGRESS"

Indicates that the workflow order data instance is currently being processed.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatInProgress

◆ StatReady

const public OMQ::StatReady = "READY"

Indicates that a workflow order data instance has been created and is waiting for processing to start.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatReady

◆ StatRetry

const public OMQ::StatRetry = "RETRY"

Indicates that workflow processing on the order data instance has generated an error and is now waiting for an automatic retry.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatRetry

◆ StatScheduled

const public OMQ::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.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatScheduled

◆ StatWaiting

const public OMQ::StatWaiting = "WAITING"

Indicates that subworkflow steps are in progress and the system is waiting on the subworkflows to become OMQ::StatComplete.

Note
The equivalent status code actually stored in the database is OMQ::SQLStatWaiting

◆ WM_Synchronous

const public OMQ::WM_Synchronous = "SYNCHRONOUS"

Workflow Mode: SYNCHRONOUS.

Deprecated:
this mode is no longer used