BSOA Orchestra Operator's Guide

Table of Contents

 

Chapter 1.             The Purpose of This Guide 1

Chapter 2.             Operator Process Console Description 3

2.1   Console Loading. 3

2.2   Console Frames Description. 4

Chapter 3.             Operator Process Console Guide 7

3.1   Orchestra Process Models 7

3.1.1      How To Access the Orchestra Process Models List 7

3.1.2      How To Access the Information for a Specific Model 8

3.1.3      How To Deploy/Undeploy a BPEL Process Model 9

3.1.4      How To Start a Process Model 9

3.2   BPEL Instances 12

 

List of Figures

 

Figure 2‑1.    Process Administration Console Login Screen. 3

Figure 2‑2.    Description of Administration Console Frames 4

Figure 3‑1.    Orchestra Process Models List 7

Figure 3‑2.    Display of Information for a Specific Process Model 8

Figure 3‑3.    Display of Available Process Models 9

Figure 3‑4.    Display of Process Details for a Process Model 10

Figure 3‑5.    Screen To Select a Port Type to Start a Process Model 10

Figure 3‑6.    Form To Start a Process Model 11

Figure 3‑7.    Display of Available Process Instances 12

 


Preface

 

This guide describes which facilities the Process Console provides to users via the Operator function.



Chapter 1.      The Purpose of This Guide

 

This guide provides the information necessary to be able to:

·           Deploy, Undeploy, Start an Orchestra process model,

·           Access Orchestra Process Model Instance information,

·           Start a new process instance.

 

 

 


Chapter 2.      Operator Process Console Description

 

2.1                       Console Loading

To access the Process Administration Console, connect to the following URL http://Your_Host:Your_HttpPort/jiapAdmin

Figure 21.    Process Administration Console Login Screen


2.2                       Console Frames Description

After logging in, the Administration Console is available in the main frame of a browser. It is divided in four parts (five if footer frame is configured), each with a specific role:

 

Figure 22.    Description of Administration Console Frames

 

Navigational Tree

Use this frame to navigate between the different options the console offers, which are based on the user profile and the user-application context.

Click either on the  /  signs, or on the desired labels to expand/retract a branch.

For a terminal node, the Core Frame then presents the corresponding information.

Header Frame

By default, this frame displays the title and icon of the Process Console. The console administrator may customize the content of this frame by displaying the content of a configured URL.


Utility Frame

This frame displays the name of the user logged in, a  button to refresh the header, core and footer frames, and a  button to exit the console. It also displays the path corresponding to the actual information shown in the Core Frame.

Core Frame

This is the main frame of the console. A navigational path showing the tree structure of the information displayed along with the actual information is available. Different tabs may be accessed in this zone, and all information entered will be displayed within it.

Footer Frame

By default this frame is not displayed. The console administrator may configure this frame to display the content of a configured URL (see Customizing Header/Footer URLs below).

Customizing Header/Footer URLs

To customize the header frame or display a customized footer frame, the properties $JONAS_BASE/conf/jiapadmin_custom.properties file must be edited. This can be done either within the navigational tree by navigating to the Edit Custom Frames link of the Administrator tree, or by manually editing the above properties file.

The following is an example of a configured footer frame, while preserving the default header frame:

# Custom console fields

 

# bottom frame (footer) of the Admin Console.

footer=http://www.somewhere.com/acme.html

# top frame (header) of the Admin Console.

header=

 

It is the responsibility of the administrator to make sure the customized frame content fits within the dimensions of the frame.

 

 


Chapter 3.      Operator Process Console Guide

3.1                       Orchestra Process Models

Any user accessing the process console to view a given process model must have an operator profile. An Administrator user of the Process console sets this operator profile. See the BSOA Orchestra Administrator’s Guide to set operator profiles.

 

3.1.1                         How To Access the Orchestra Process Models List

Select the following path in the Navigational Tree (Left Panel): Operator Process models. The Core Frame (Right Panel) displays the available process models.

For each process model, its state and its creator are displayed. Depending on its state, various actions can be taken on it.

·           Deploy
When a BPEL process definition file is imported into the Orchestra engine by a designer (see the BSOA Orchestra Designer’s Guide), the state of the process is automatically TODEPLOY.  This means that the operator must deploy it before a user can start the process model.

·           Start
When a process is deployed, it is then possible to instantiate (start) it. A form will then be displayed offering the ability to choose a Port Type.  This process is described in Section 3.1.4, “How To Start a Process Model.”

·           UnDeploy
This action prevents end users from starting new instances of the process. The operator can then import a new version of the process (all process instances must be terminated or canceled before the process model can be deleted). The new version of the process must then be redeployed before being available again for end users.

Figure 31.    Orchestra Process Models List

 

3.1.2                         How To Access the Information for a Specific Model

Select the following path in the Navigational Tree (Left Panel): Operator Process models. The Core Frame (Right Panel) displays the available process models.

To select a process and see its specific information, select it in the list by clicking on its name in the Core Frame.

The following information is then displayed.

Figure 32.    Display of Information for a Specific Process Model

 

·           Name: the name of the process model.

·           State: the state of the process model (DEPLOYED, TODEPLOY).

·           Creator: the login name of the designer who imported the BPEL process definition into the engine.

·           Creation date: the date on which the model was imported.

·           Entry points: names of the web Services that allow instantiation of the process.

·           Deploy or (UnDeploy and Start): available actions as explained in Section 3.1.1.

 


3.1.3                         How To Deploy/Undeploy a BPEL Process Model

Select the following path in the Navigational Tree (Left Panel): Operator Process models. The Core Frame (Right Panel) displays the available process models.

The fist way to deploy/undeploy a process model is to click on the desired action in the right column of the Core Frame (named “Action”): Deploy or UnDeploy, depending the current state of the process.

The second way is to select the model in the Model List by clicking on its name, and then clicking on the corresponding button (Deploy, UnDeploy) shown in the Core Frame.

 

3.1.4                         How To Start a Process Model

Select the following path in the Navigational Tree (Left Panel): Operator Process models. The Core Frame (Right Panel) displays the available process models.

The fist way to instantiate a process model is to click on the “Start() action on the right column of the Core Frame (named “Action”). This action is only available for deployed process models.

 

Figure 33.    Display of Available Process Models

 


The second way is to select the model in the Process Models List by clicking on its name.

 

Figure 34.    Display of Process Details for a Process Model

 

Then click on the corresponding “Start” button () shown at the bottom of the process details screen.

A screen will be displayed with the Port Type available to start the process. Select a Port Type by clicking on the green arrow icon. The following figure is an example of the screen displayed as a result of clicking on the Start button for the Echo sample.

 

Figure 35.    Screen To Select a Port Type to Start a Process Model

 


Then click on the Green Action button for the process.  The following form will be displayed with the input fields of the corresponding Web Service.

 

Figure 36.    Form To Start a Process Model

Fill in any required parameters, and then click on “Submit”.


3.2                       BPEL Instances

A user accessing the process console to see process instances of a given process model must meet the same requirements as those described in Section 3.1.

How To Access the Instances List

Select the following path in the Navigational Tree (Left Panel): Operator Process instances. The Core Frame (Right Panel) displays the available process instances.

 

Figure 37.    Display of Available Process Instances

 

The following information is available:

·           Instance Name: the name of the process instance.

·           Creation date: the date on which the process instance was created.

·           Creator: the login name of the end user who created the process instance.

·           Action: “Terminate action” terminates the process instance (click on the blue “T” button).

·           State: when an instance is running its state is "executing", and when it is finished its state is "terminated".