Introduction

Contents of this section:

• Overview
• Task Summary

Overview

This document is intended to provide a guide to usage of the Qorus Integration Engine system. For more detailed information on the system’s design, please see the System Reference Manual.

Common operational tasks are covered here, as well as common errors and some troubleshooting information.

Common tasks included:

• Database Maintenance And Administration
• Start Qorus Integration Engine
• Stop Qorus Integration Engine
• View System Options
• Set System Options
• Start a Workflow Execution Instance
• Stop a Workflow Execution Instance By ID, Stop Workflow Execution Instances by Name, Stop All Workflow Execution Instances
• View Workflow Execution Instance Options
• Set Workflow Execution Instance Options
• Working With Services
• Working With Role-Based Access Control

Note that this manual does not cover performing common operational tasks from the Qorus Integration Engine GUI; all tasks (aside from starting the system) can also be performed with the Qorus GUI as well.

In addition to the topics above, database administration is a critical area that must be covered properly in order to ensure the correct operation of the system, in particular database free space (for example, the data and index tablespaces with Oracle and PostgreSQL installations) and transaction log space must be monitored closely, and all indexes must be kept current.

If indexes are invalidated for whatever reason, Qorus Integration Engine may deadlock (as row locks may be silently converted into table locks) or performance will suffer.

Database administration regarding basic tasks such as index maintenance and data deletion are documented in Database Maintenance And Administration, however detailed Oracle, MySQL, and PostgreSQL database administration is beyond the scope of this manual; make sure a competent DBA is monitoring your system any time Qorus is used for business-critical process automation.

Task Summary

For all the commands in this section, the UNIX environment must be set up properly to run the qore binary and the Qorus system. For more information on these requirements, see Installation Guide.

All commands should be typed on a single line. Text in italics should be replaced with the appropriate value. Optional arguments are enclosed in square brackets ([]),

Operational Task Overview

Task	RBAC Role(s) Required	Commands
Start Qorus	n/a	qorus [options]
Shutdown Qorus	SHUTDOWN	ocmd shutdown
Check System Options	LOGIN	ostatus –o
Set System Options	OPTION_CONTROL	ocmd set-option option=value
Redefine Datasources	CALL-SYSTEM-SERVICES-RW	ocmd omq.system.service.datasource.update
Rotate Log Files	ROTATE-LOG-FILES	ocmd rotate-log-files
View System Properties	CALL-SYSTEM-SERVICES-RO or CALL-SYSTEM-SERVICES-RW	ocmd omq.system.service.prop.get
Update System Properties	CALL-SYSTEM-SERVICES-RW	ocmd omq.system.service.prop.update domain key value
List Running Workflows	CALL-SYSTEM-SERVICES-RO	ostatus -w
Start a Workflow	WORKFLOW-CONTROL	ostart workflowname [version] [mode] [options]
Stop a Workflow	WORKFLOW-CONTROL	ostop workflowname
Stop All Workflows	WORKFLOW-CONTROL	ostop -a
Check Workflow Options	LOGIN	ostatus –wv
Set Workflow Options	WORKFLOW-CONTROL	ocmd set-workflow-option id option=value
Reset a Workflow	WORKFLOW-CONTROL	ocmd reset-workflow workflowname version
Check System Status	LOGIN	ostatus -oS
Check Running Workflow Status	LOGIN	ostatus -w
Check Workflow Data Status	CALL-SYSTEM-SERVICES-RO	oview -ssg wid
Check Service Status	LOGIN	ostatus –sv
Call a System Service Method	CALL-SYSTEM-SERVICES-RO or CALL-SYSTEM-SERVICES-RW	ocmd omq.system.service.nservicename.method [options]
Call a User Service Method	CALL-USER-SERVICES-RO or CALL-USER-SERVICES-RW	ocmd omq.user.service.servicename.method [options]
Live Upgrades	n/a – direct DB access	oload <release file>
Online: Add a New User	USER-CONTROL	ocmd omq.system.add-user username password description role-list groups
Online: Change Password	USER-CONTROL	ocmd omq.system.update-user username pass=newpassword
Online: Change Your Own Password	LOGIN	ocmd omq.system.update-current-user pass=newpassword
Online: Add a New User Role	USER-CONTROL	ocmd omq.system.add-role rolename description
Online: Add a New Profile	USER-CONTROL	ocmd omq.system.add-profile profilename description roles groups
Online: Delete a User	USER-CONTROL	ocmd omq.system.delete-user username
Online: Delete a User Role	USER-CONTROL	ocmd omq.system.delete-role rolename
Online: Delete a Profile	USER-CONTROL	ocmd omq.system.delete-profile profilename
Offline: Add a New User	USER-CONTROL	user-tool -Ausername,pass,profile,"description"
Offline: Change Password	n/a – direct DB access	user-tool –dusername:pass=newpassword
Offline: Add a New User Role	n/a – direct DB access	user-tool –nrolename:"description"
Offline: Add a New Profile	n/a – direct DB access	user-tool -Pprofilename:"description":role[,role,...]
Offline: Delete a User	n/a – direct DB access	user-tool –Xuser:username
Offline: Delete a User Role (Cascading)	n/a – direct DB access	user-tool –c –Xrole:name
Offline: Delete a Profile	n/a – direct DB access	user-tool –Xprofile:name
Synchronize Offline RBAC Changes	USER-CONTROL	user-tool -s