# Orchestra Console User Guide

### Orchestra Team

Copyright © 2009 Bull SAS - OW2 Consortium

Abstract

This document contains an installation and user guide for Orchestra Console included in Orchestra 4.2.0 (also known as Nova Orchestra)

## Introduction

This documentation is targeted to Orchestra users. It presents the installation procedure and a quick user guide of the Orchestra Console features.

Chapter 1, Overview Gives an overview of the Orchestra process console

Chapter 2, Installation describes how to install the Orchestra console

Chapter 3, Quick Start Quick start information of the Orchestra console

Chapter 4, User Guide Gives a complete description of the Orchestra process Console.

Chapter 5, Managing users, groups and memberships Explains how to manage Users in Orchestra process Console.

## Chapter 1. Overview

## 1.1. Nova Orchestra Process Console Overview

This document describes the Orchestra process console capabilities. This console is aimed at Orchestra administrators. Therefore the operator role is the only one that gives possibility to interact with Orchestra engine. The user role does not give any right to interact wqith Orchestra.

## Chapter 2. Installation

## 2.1. Prerequisite

The Nova Orchestra process Console works with java 1.5. Be sure that your default JRE is 1.5

## 2.2. Installation procedure

The Orchestra process console is available in two version. You can either use the full version which contains both the Orchestra engine and the console, or you can use the console version which gives the possibility to connect to an existing Orchestra engine.

-Get the latest version of the Orchestra Console from this web page :

http://forge.ow2.org/project/showfiles.php?group_id=266

- Extract it and go in the Orchestra-Console-Full-X.X.X/bin directory

- If your use Linux as Operating system do the following::

> chmod +x Orchestra-Console-Full-X.X.X/bin/*.sh

> unset CATALINA_HOME CATALINA_BASE

## 2.3. How to connect the Console with existing Orchestra engine

As explained in the previous section, it is possible to install just the console and to connect it with an existing Orchestra engine. To do this, you just install the console as explained in the previous section and then you need to specify the JMX information used by your Orchestra engine. You need to change the following lines in the orchestra.properties file in the conf directory of your console installation :

    				# Port of the JMX registry
    				orchestra.jmx.port=9999
    				# JMX Service URL to connect to orchestra mbean server.
    				orchestra.jmx.serviceUrl=service:jmx:rmi:///jndi/rmi://localhost:9999/orchestraServer
    				# Name of the Orchestra MBean
    				orchestra.jmx.objectName=JMXAgent:name=orchestraRemoteDeployer

## Chapter 3. Quick Start

In this chapter we present a quick start documentation for Orchestra process console. In the next chapters we will explain in more details the functionalities available in this release

## 3.1. Console Start

- Open a command line and execute the following under the Orchestra-Console-Full-X.X.X/bin directory:

1. For Linux : ./orchestraConsole.sh run

2. For Windows : orchestraConsole run

- In your web browser connect to the following URL : http://localhost:8080/portal/

Connect with :

1. User Name : root

2. Password : orchestra

## 3.2. Deploy process

Open the Orchestra Management portlet available in the doc bar.

To test the console, you can use the Orchestra examples delivered with the Orchestra package

Choose a process to deploy and click on deploy button

## Chapter 4. User Guide

In this chapter we present the possibilities of the Orchestra process console.

## 4.1. Console Access

To access the Orchestra Console, connect to the following URL :

http://your_host:your_HttpPort/portal/

(by default : http://localhost:8080/portal/ )

## 4.2. Default users

The Orchestra Console has three default users types:

root :

This user has the rights to manage the console look and feel, he can also manage :

1. The navigations and pages of the console

2. The languages setting

3. The users, groups and memberships

4. The registry of all the Orchestra Console applications

admin :

This user has the Operator profile so he access the Orchestra administration possibilities

## 4.3. Console frames description

After logging in, the Orchestra Console is available in the main frame, of your browser

Desktop :

The Desktop is the workspace in which BPM and others applications (aka portlets) can be added, removed, configured... like in an OS

Doc Bar :

The Doc Bar is used to access to the available applications for a particular user type

Applications :

The Application allow to perform the business functionalities like the process management ...etc. Each application is independent from the others. It looks like a simple window.

Pages Navigation Button :

This button allow to display the list of the Console navigations and to navigate between the different pages.

Add Applications Button :

This button allow to add an application/widget in the Doc Bar/Desktop.

Show / Hide Applications :

This button allow to hide all the Applications / Widgets displayed on the desktop. A second click allow to display them again.

Welcome Widget :

The welcome widget display the logged user's name and allow to logout from the Orchestra Console.

## 4.4. Application's graphical organization description

Each Application is organized like this :

1. Main Tools : The main banner that allow to access the main tools.

2. Tabulations : A set of tabulation for the tools in use. A lot of tabulations can be opened at the same time.

3. Work Area : The tools display area.

## 4.5. Deploy / Undeploy / Delete Processes Models

Go to the process models list

Deploy :

To deploy a process model, click on the browse button and select the path to access your process model, then click on the button (upload).

After deploying operation, the process models list is refreshed with the new imported process model.

Delete :

To delete a process model, click on the delete button at the end line of the process you want to delete. You can also open the detailed view of a process model, then click on the delete button in the Actions field.

## 4.6. Access the Process Instances List

Select the application Orchestra Management in the Doc Bar, then select the

Instances tabulation in the Main Tools to display the list of all the running instances.

The following parameters are displayed for each process instance :

1. Instance Id : The Id of the instance

2. Process name : The name of the associated process model (click to display the detailed view of the process)

3. State : The state of the instance

## Chapter 5. Managing users, groups and memberships

Those functionalities can be done only by the root user.

This user is allowed to view the left side workspace bar that gives access to administration features of the Console.

## 5.1. Add a new user to the Nova Orchestra Console

Then open the ''New Account'' application, and fill the form with the informations of the new user and finally click on ''Save '' button to validate.

## 5.2. Set roles/permission of a user to access to the console

- Open the ''Community Management'' application.

- Click on ''Group Management'' tabulation.

- Select the group Platform > Console > Orchestra

- After that just add the user you want to give access to the console with at least the membership “user”. And repeat the operation if you want that user has the role “operator”.

Example : Setting the user “lejeuneg” as operator of the console means that we need to put it in the group Orchestra with 2 memberships : user and operator.