Qorus Common Server API

Table of Contents

• Qorus System Utility Classes
• Qorus System Information
• Qorus System Connection APIs
• Qorus System Utility APIs
• Calling Services

This section covers APIs and API concepts common to all Qorus user code, workflows, services, and jobs.

Qorus System Utility Classes

The following classes are imported into all user objects:

• OMQ::QorusRemoteServiceHelper
• OMQ::QorusSystemAPIHelper
• OMQ::QorusSystemRestHelper

Qorus System Information

Logging function:

• log()

The following functions provide access to Qorus system information:

• get_active_jobs()
• get_running_workflow_list()
• get_qorus_options()
• get_qorus_options_args()
• get_qorus_option_info()
• get_qorus_option_info_args()
• get_running_workflow_info()
• get_service_info()
• get_session_id()
• get_system_info()
• get_system_service_info()
• get_user_service_info()
• runtime_properties()
• qorus_get_local_url()

Qorus System Connection APIs

The following functions provide APIs to acquire system connection objects:

• get_datasource_dedicated()
• get_datasource_shared()
• get_datasource_pool()
• get_remote_rest_connection()
• get_remote_rpc_connection()
• get_user_connection()

Qorus System Utility APIs

The following functions provide APIs to perform various actions with the Qorus system:

• call_network_api()
• call_network_api_args()
• call_network_api_args_with_authentication()
• create_order()
• exec_synchronous_workflow()
• get_option()
• post_user_event()
• set_option()

The following functions provide auditing functionality:

• audit_check_event_string()
• audit_check_event()
• audit_get_mask()
• audit_user_event()

The following functions provide general utility functionality:

• deserialize_qorus_data()
• next_sequence_value()
• HttpServer::parse_uri_query()
• serialize_qorus_data()

Note

all functions in the Util module are available in all user code objects in Qorus as well.

Old backwards-compatible API functions (will be maintained indefinitely for backwards compatibility):

• callNetworkAPI(): replaced with call_network_api()
• callNetworkAPIArgs(): replaced with call_network_api_args()
• callNetworkAPIArgsWithAuthentication(): replaced with call_network_api_args_with_authentication()
• createOrder(): replaced with create_order()
• execSynchronousWorkflow(): replaced with exec_synchronous_workflow()
• getOption(): replaced with get_option()
• getRunningWorkflowInfo(): replaced with get_running_workflow_info()
• getRunningWorkflowList(): replaced with get_running_workflow_list()
• getSessionID(): replaced with get_session_id()
• getSystemInfo(): replaced with get_system_info()
• getSystemServiceInfo(): replaced with get_system_service_info()
• getUserServiceInfo(): replaced with get_user_service_info()
• runtimeProperties(): replaced with runtime_properties()
• setOption(): replaced with set_option()

Calling Services

Services can be called from anywhere in Qorus user code (from a workflow, from another service, or in a job). To call a service, use the ::$omqservice object imported into every workflow, service, and job program object as follows:

$omqservice.[system|user].<service_name>.<method_name>(<arguments>)

For example, to get all system properties in all domains:

my hash $props = $omqservice.system.prop.get();