BSOA Orchestra Process Console User's Guide

Table of Contents

 

Chapter 1.          Introduction to the Orchestra Process Console 1

1.1        Console Loading. 1

1.2        Console Frames Description. 2

Chapter 2.          Guide for Process Console Administrator 5

2.1        User Management 5

2.1.1      Orchestra User Management Basic Configuration. 5

2.1.2      Orchestra Profiles 6

2.1.3      Changing the Basic Configuration. 7

2.1.4      Initiating a New Datasource Security Realm for Use by Orchestra. 9

2.1.5      Configuring an Ldap Directory for Use by Orchestra – LoginModule Feature. 10

2.1.6      Selecting a New Security Realm For User Management 14

2.1.7      Accessing the Description of a Specific Realm.. 16

2.1.8      Accessing the Users List for a Specific Realm.. 17

2.1.9      Adding a User to a Specific Realm.. 18

2.1.10    Suppressing a User From a Specific Realm.. 19

2.1.11    Accessing the List of Users Involved in a Specific BSOA Profile. 20

2.1.12    Modifying the BSOA Profile or Password for a Specific User 22

2.2        Engine Databases 23

2.2.1      Changing Basic Engine Datasources 24

2.2.2      Looking at the Engine Datasource Definition. 24

2.3        Editing Custom Properties 26

2.4        Setup. 28

Chapter 3.          Guide for Process Console Designer 29

3.1        Orchestra Process Models 29

3.2        Adding a New Process Model 29

3.3        Deleting Process Models 31

Chapter 4.          Guide for Process Console Operator 33

4.1        Orchestra Process Models 33

4.1.1      Accessing the Orchestra Process Models List 33

4.1.2      Accessing the Information for a Specific Model 35

4.1.3      Deploying/Undeploying a BPEL Process Model 36

4.1.4      Starting a Process Model 36

4.2        BPEL Instances 39


Chapter 5.       Guide for Process Console User 41

5.1        Accessing the Orchestra Process List 41

5.2        Creating a New Instance of an Orchestra Process 43

 


List of Figures

 

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

Figure 1‑2.      Administration Console Frames Description. 2

Figure 2‑1.      Orchestra User Management Basic Configuration. 5

Figure 2‑2.      Illustration of Scope of the Orchestra Profile Roles 6

Figure 2‑3.      Changing the Basic Configuration for User Management 7

Figure 2‑4.      Navigational Path to Select a New Security Realm. 14

Figure 2‑5.      User Management Core Frame of Administration Console. 14

Figure 2‑6.      Confirmation Warning When Selecting a New Realm. 15

Figure 2‑7.      User Management Core Frame Displaying Selected and Available Realms 16

Figure 2‑8.      Display of Information for a Selected Realm. 16

Figure 2‑9.      User Management Core Frame Displaying Selected Realm. 17

Figure 2‑10.   List of Users for a Selected Realm. 17

Figure 2‑11.   New User Registration Form. 18

Figure 2‑12.   Remove Users Form. 19

Figure 2‑13.   Navigational Path to Select a Datasource Realm. 20

Figure 2‑14.   Datasource Realm Display 20

Figure 2‑15.   List of Profiles for a Selected Realm. 21

Figure 2‑16.   List of Users in a Specific BSOA Profile. 21

Figure 2‑17.   User Information Form. 22

Figure 2‑18.   Navigational Path to Select Datasource Configuration Display 24

Figure 2‑19.   BPEL Datasource Configuration Display 25

Figure 2‑20.   Display of Available BPEL Datasources 25

Figure 2‑21.   Navigational Path for Accessing Custom Configuration Form. 26

Figure 2‑22.   Custom Properties Configuration form. 26

Figure 2‑23.   Process Models Display 27

Figure 2‑24.   Navigational Path to Access Setup. 28

Figure 2‑25.   Setup Panel 28

Figure 3‑1.      Navigational Path to Add a New Process Model 29

Figure 3‑2.      Import Files Frame for Adding a New Process Model 30

Figure 3‑3.      Specifying an External WSDL File. 30

Figure 3‑4.      Navigational Path to Process Models List 31

Figure 3‑5.      Process Models List 31

Figure 4‑1.      Navigational Path to Access Process Models List 33

Figure 4‑2.      Orchestra Process Models List 34

Figure 4‑3.      Scrolling Display for List of More than 10 Process Models 34

Figure 4‑4.      Display of Information for a Specific Process Model 35

Figure 4‑5.      Display of Available Process Models 36

Figure 4‑6.      Display of Process Details for a Process Model 37

Figure 4‑7.      Screen To Select a Port Type to Start a Process Model 37

Figure 4‑8.      Form To Start a Process Model 38

Figure 4‑9.      Navigational Path to Access the Instances List 39

Figure 4‑10.   Process Instances 39


Figure 5‑1.      Navigational Path to Access the Orchestra Process List 41

Figure 5‑2.      Orchestra Processes That Have Been Deployed Into the BPEL Engine. 42

Figure 5‑3.      Display of Available Processes to Start 42

Figure 5‑4.      Display of Available Port Types and Operations To Instantiate a New Instance of a Process 43

Figure 5‑5.      Form To Create a New Instance of an Orchestra Process 44

Figure 5‑6.      Example Response to “Create a New Instance of an Orchestra Process” 45

 


Preface

This guide describes the Orchestra Process Console and its functions associated with the roles of Administrator, Designer, Operator, and User.

The following documents from the previous version (v2.5) of BSOA Orchestra are now combined in this comprehensive user’s guide for v3.0:

·           Administrator’s Guide

·           Designer’s Guide

·           Operator’s Guide

·           User’s Guide

 



Chapter 1. Introduction to the Orchestra Process Console

 

This chapter explains how to load the Orchestra Process Console and provides a description of the console frames.

 

1.1                     Console Loading

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

(default: http://localhost:9000/jiapAdmin/, user name “bsoa”, password “bsoa”).

 

Figure 11.    Process Administration Console Login Screen

 


1.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 the footer frame is configured), each with a specific role:

 

Figure 12.    Administration Console Frames Description

 

Navigational Frame

Use this frame to navigate between the different options the console offers, which are based on the user role 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 displays 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. It also displays the path corresponding to the actual information shown in the Core Frame.


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 2. Guide for Process Console Administrator

 

This chapter describes the functions for the role of Process Console Administrator.

For an explanation about the different BSOA roles and how to modify these profiles, see the “Modifying the BSOA Profile or Password for a Specific User” section in this document.

This chapter provides the information necessary to:

·           Modify the basic configuration for user management (Ldap or Datasource Realm),

·           In case of Datasource Realm, Add or Remove user, Specifying BSOA profiles for BSOA users,

·           Access Orchestra engine Datasource configuration: JNDI name, port number, etc.

2.1                     User Management

2.1.1                     Orchestra User Management Basic Configuration

After Orchestra is installed, specific information for user management is stored in the default security Datasource realm, as shown below. This Datasource points to an hsql database, which also contains the Administration console and the Orchestra engine data.

 

Figure 21.    Orchestra User Management Basic Configuration

The installation process:

·           Creates and initiates the Datasources (bsoaadmin.properties file created, and Datasource at Orchestra URL populated).

·           Adds the associated Datasource security realm (server.xml and jonas-realm.xml files updated).

This basic configuration can be changed according to specific preferences, for example to use an enterprise Ldap Directory, or to move to another security Datasource realm.


2.1.2                     Orchestra Profiles

Orchestra users can be granted four different roles covering the main functions of the BPEL management. The following figure shows the scope of each of these roles (Administrator, Designer, Operator, and User).

Process Models are built from a BPEL and WSDL files and get deployed to the Orchestra engine.

Once a process model is started/instantiated, there is a Process Instance in existence for that model.

 

Figure 22.    Illustration of Scope of the Orchestra Profile Roles

 

 


2.1.3                     Changing the Basic Configuration

Orchestra can be configured to use an internal Datasource or a pre-existing external Ldap database for User Management.

 

Figure 23.    Changing the Basic Configuration for User Management

 

 

 

Orchestra uses the security realm defined at the global context for JOnAS. To change the basic configuration, do the following:

When using another Datasource Security Realm:

·           Create the new database that will be used, and adapt the Datasource description file (bsoaadmin.properties) to the new URL to be used.

·           Initiate this Datasource for correct use with Orchestra (See Initiating a New Datasource Security Realm for Use by Orchestra).

When using an Ldap Security Realm:

·           Create the LDAP Directory if it does not exist.

·           Initiate this directory for correct use with Orchestra (see Configuring an Ldap Directory for Use by Orchestra – LoginModule Feature”).

·           Remember to introduce Orchestra users in it, and to enter each of them in the “Admin” group.


At this point, the JOnAS Application server will use the Datasource or Ldap Security Realm. The last step is to configure Orchestra to use the configured Security Realm for its own user management.

To do this:

·           Use the Process console to change the User Management realm (see Selecting a New Security Realm For User Management).

·           Stop and Start the JOnAS Server.

Note:

Datasource or Ldap Realm configuration parameters can be accessed and modified by using the JOnAS Admin Console http://Your_Host:Your_HttpPort/jonasAdmin, which defaults to http://localhost:9000/jonasAdmin with a user of “jonas” and password of “jonas”. Access the security information by using the menu choices: Domain > Server JOnAS > Security.

Then, for a Datasource Security Realm, the Process Console provides facilities to:

·           Add or Remove users,

·           Modify their profiles within the BSOA scope.

When managing users with an Ldap directory, only the association between users and profiles can be modified through the Orchestra Administration Console. Adding or deleting users must be done according to the user-specific Ldap Administration process.

 


2.1.4                     Initiating a New Datasource Security Realm for Use by Orchestra

CREATE THE DATABASE

If using a new database create it first following your specific Databases administration process.

When using hsql, the database is automatically created when launching the JOnAS application server, if it does not exist.

Adapt the JOnAS Datasource configuration files:

The best way to do this is to keep the default Datasource names in the jonas.properties file (bpel and bsoaadmin), and to modify the properties files (bpel.properties and bsoaadmin.properties) according to the new configuration (changing URL for using a new database, and changing Mapper and Driver for using a new rdbms).

Note:

It is mandatory to keep the JNDI names of these Datasources (bpel and jiapadmin, referenced in the properties files).

The following is an example of the properties files for using a PostgreSQL database, named MyDB.

These files are located under $JONAS_BASE/conf.

Part of bpel.properties file:

   datasource.name         bpel
   datasource.url                jdbc:postgresql://localhost:5432/db_jiapadmin211
   datasource.classname  org.postgresql.Driver
   datasource.mapper      rdb.postgres

Part of jonasadmin.properties file:

   datasource.name=jiap
   datasource.url=jdbc:postgresql://localhost:5432/db_jiapadmin211
   datasource.mapper=rdb.postgres
   datasource.classname=org.postgresql.Driver

The application server must then be stopped and restarted with "Start JOnAS". Remember to put the correct drivers under the $JONAS_ROOT/lib/ext directory. These drivers are located under the bpel/lib/ext directory.


INITIALIZE THE DATABASE(S)

 bpel Datasource: go to the installation directory, and execute the ant initBsoaDb command.

BsoaAdmin Datasource: go to the bsoaadmin directory and execute the
ant –f initJiapDb.xml initJiapDb command.
The databases are then populated with the BPEL and Jiapadmin tables, and the minimum required data.

Note:

Even if a specific Datasource security realm is already being used, the corresponding database must be initialized as described above. Only data contained in BPEL and jiapadmin tables will be available for Orchestra user management.

 

2.1.5                     Configuring an Ldap Directory for Use by Orchestra – LoginModule Feature

JOnAS configuration:

Jonas-realm.xml file (default path: Orchestra Installation directory \bsoa_base\conf):

The LDAP realm must be described for JOnAS to take it into account. To do this, modify the jonas-realm.xml file (jonas-ldaprealm target) to add the Ldap entry point.

The following is an example of the lines that could be added:

 

<ldaprealm name="ldaprlm_1"

baseDN="dc=frec,dc=bull,dc=fr"

initialContextFactory="com.sun.jndi.ldap.LdapCtxFactory"

providerUrl="ldap://localhost:389"

securityAuthentication="simple"

securityPrincipal="cn=admin,dc=frec,dc=bull,dc=fr"

securityCredentials="xxxxxx"

authenticationMode="bind"

userPasswordAttribute="userPassword"

userRolesAttribute="memberOf"

roleNameAttribute="cn"

userDN="ou=jiap_user"

userSearchFilter="uid={0}"

roleDN="ou= jiap _group"

roleSearchFilter="uniqueMember={0}"

referral="throw" />

 


server.xml file (default path: Orchestra Installation directory \bsoa_base\conf):

Modify the server.xml file to make it take this new realm into account.

First modify the global realm:

Realm className="org.objectweb.jonas.security.realm.web.catalina55.JACC" debug="99" resourceName="Ldaprlm_1"/>

And change the resourceName field for BPEL Context (path="/bpel"), BPEL Web Services (path="/bpel_ws"),  BPEL Form Generator(path="/formgenerator-1.0" ).

Note:

The Single Sign On (SSO) of Tomcat has been activated.

Jaas.config file (default path: Orchestra Installation directory \bsoa_base\conf):

To run the BPEL tests or BPEL samples mentioned in the Orchestra documentation, the jaas.config file must be modified to let jaas know which security resource to use (modify the bpel, TestClient, bpel_policy entries).

Refer to the JOnAS User Documentation for more information about how to modify server.xml and jonas-realm.xml files to introduce a new security realm.

A User Ldap Configuration:

An administrator account that has modify permission to the necessary subTree must be used to update the LDAP directory.

Then, a subtree must be created that will contain the following groups:

JIAPUSER
JIAPOPERATOR
JIAPDESIGNER
JIAPADMINISTRATOR
jonas_admin

All these groups are mandatory for Orchestra, unless using the BsoaLogin Module as explained at the end of this section (JIAPUSER, jonas_admin are no longer required in the Ldap server).

JIAPUSER, JIAPOPERATOR, JIAPDESIGNER, JIAPADMINISTRATOR are managed by the Process Admin Console.


The following is an example of the minimum configuration to import into a user Ldap, based on the previous mentioned Ldap:

 

  dn: dc=frec,dc=bull,dc=fr

  objectClass: top

  objectClass: dcObject

  objectClass: organization

  o: bull

  dc: frec

 

  dn: cn=admin,dc=frec,dc=bull,dc=fr

  objectClass: simpleSecurityObject

  objectClass: organizationalRole

  cn: admin

  description: LDAP administrator

 

  dn: ou=jiap_group,dc=frec,dc=bull,dc=fr

  ou: jiap_group

  objectClass: top

  objectClass: organizationalUnit

 

  dn: ou=jiap_user,dc=frec,dc=bull,dc=fr

  ou: jiap_user

  objectClass: top

  objectClass: organizationalUnit

 

  dn: cn=JIAPUSER,ou=jiap_group,dc=frec,dc=bull,dc=fr

  cn: JIAPUSER

  uniqueMember: uid=jiap,ou=jiap_user,dc=frec,dc=bull,dc=fr

  description: jiap user

  objectClass: groupOfUniqueNames

  objectClass: top

 

  dn: uid=jiap,ou=jiap_user,dc=frec,dc=bull,dc=fr

  cn: jiap

  sn: jiap

  uid: jiap

  objectClass: inetOrgPerson

  objectClass: top

 

  dn: cn=JIAPOPERATOR,ou=jiap_group,dc=frec,dc=bull,dc=fr

  cn: JIAPOPERATOR

  uniqueMember: uid=jiap,dc=frec,dc=bull,dc=fr

  objectClass: groupOfUniqueNames

  objectClass: top

 

  dn: cn=JIAPADMINISTRATOR,ou=jiap_group,dc=frec,dc=bull,dc=fr

  cn: JIAPADMINISTRATOR

  objectClass: groupOfUniqueNames

  objectClass: top

uniqueMember: uid=jiap,ou=jiap_user,dc=frec,dc=bull,dc=fr


 

  dn: cn=JIAPDESIGNER,ou=jiap_group,dc=frec,dc=bull,dc=fr

  cn: JIAPDESIGNER

  objectClass: groupOfUniqueNames

  objectClass: top

  uniqueMember: uid=jiap,ou=jiap_user,dc=frec,dc=bull,dc=fr

 

  dn: cn=jonas-admin,ou=jiap_group,dc=frec,dc=bull,dc=fr

  cn: jonas-admin

  uniqueMember: uid=jiap,ou=jiap_user,dc=frec,dc=bull,dc=fr

  description: jonas administration group

  objectClass: groupOfUniqueNames

  objectClass: top

 

  dn: cn=BPELUSER,ou=jiap_group,dc=frec,dc=bull,dc=fr

  cn: BPELUSER

  description: Bpel Acces Group

  objectClass: groupOfUniqueNames

  objectClass: top

  uniqueMember: uid=jiap,ou=jiap_user,dc=frec,dc=bull,dc=fr

Note:

These entries are mandatory for using the BPEL Engine. To use BPEL, have to introduce BPEL users must also be introduced in the Ldap Directory with the “BPELUSER” role.

After all of this has been done, restart the JOnAS server (bsoap start).


2.1.6                     Selecting a New Security Realm For User Management

After the previous steps, Orchestra must be configured to modify the User Management configuration.

Orchestra administration

Connect to the Administration console with the appropriate user (Doing this requires an administrator profile. If the basic installation has not been changed, the default login/password (bsoa/bsoa) can be used).

Select the following path in the Navigational Tree (Left Panel): Administrator User Management.

 

Figure 24.    Navigational Path to Select a New Security Realm

 

The Core Frame (Right Panel) presents the selected and available realms.

 

Figure 25.    User Management Core Frame of Administration Console

 


To select a new realm, check the box in front of the appropriate realm in the « Available Realms » list in the Core Frame and click on the « Select the Realm » Button.

A warning is then provided. Confirm your choice by clicking on the “Confirm” Button.

 

Figure 26.    Confirmation Warning When Selecting a New Realm

 

Then stop and restart the JOnAS Server: the new User Management configuration will be available.

Warning:

The User Manager API of Orchestra immediately recognizes these modifications. This can cause problems for running applications. It is strongly recommended to stop and restart the JOnAS server.

 

 


2.1.7                     Accessing the Description of a Specific Realm

Select the following path in the Navigational Tree (Left Panel): Administrator User Management. The Core Frame (Right Panel) presents the selected and available realms.

 

Figure 27.    User Management Core Frame Displaying Selected and Available Realms

Click on the name of the desired Realm. Related information will be displayed in the Core Frame, as shown below for an Ldap Realm.

 

Figure 28.    Display of Information for a Selected Realm

 


2.1.8                     Accessing the Users List for a Specific Realm

Warning:

This operation can only be performed on the selected security realm (See the previous sections for more information on how to select a specific Security Realm).

Select the following path in the Navigational Tree (Left Panel): Administrator User Management. The Core Frame (Right Panel) presents the selected realm.

 

Figure 29.    User Management Core Frame Displaying Selected Realm

Just click on the name of the selected Realm, choose the “Users” tab in the Core Frame, and then click on the “List Users” Button. The users’ list will display under the search panel.

Figure 210.  List of Users for a Selected Realm

 


2.1.9                     Adding a User to a Specific Realm

Warning:

This operation can only be performed on the selected security realm (see the previous sections for more information on how to select a specific Security Realm) in the case of a Datasource Realm. Ldap Realms must be managed with their specific administration tool.

 

Figure 211.  New User Registration Form

 

First, access the users list of the realm (see Accessing the Users List for a Specific Realm). Then click on the “New user” Button.

The user registration form is shown in the Core Frame. Enter the user information and click on the “Create” button.

For more information on the “Profiles” panel, see “Accessing the List of Users Involved In a specific BSOA Profile.”

The user is then added to the security realm.


2.1.10              Suppressing a User From a Specific Realm

Warning:

This operation can only be performed on the selected security realm (See the previous sections for more information on how to select a specific Security Realm) in case of a Datasource Realm. Ldap Realms must be managed with their specific administration tool.

First, access the user list of the realm (see Accessing the Users List for a Specific Realm”).  Then check the square in front of the users to be suppressed, and click on the “Remove Users” Button.

 

Figure 212.  Remove Users Form



The users are deleted from the list (replay SEARCH to see it).

 

Warning:

These deletions are effective immediately. This can cause problems for users involved in a current Orchestra process.


2.1.11              Accessing the List of Users Involved in a Specific BSOA Profile

 

Select the following path in the Navigational Tree (Left Panel): Administrator User Management->Datasource realm.

 

Figure 213.  Navigational Path to Select a Datasource Realm

The Core Frame (Right Panel) presents the selected realm.

 

Figure 214.  Datasource Realm Display


Click on the name of the selected Realm, and choose the “Profiles” tab in the Core Frame.

 

Figure 215.  List of Profiles for a Selected Realm

 

The four profiles are then shown: select one by clicking on it.

A new tab is then available in the Core Frame, which lists the users involved in the selected profile.

 

Figure 216.  List of Users in a Specific BSOA Profile

 

To add a user to this profile, select the user in the list by clicking on the user name. The “User xxx” tab will then be shown in the Core Frame. The chosen profile for this user can be selected by clicking first on it in the “Available” panel, then on the  arrow.

To suppress a user from this profile, select the user by clicking on the user name. The “User xxx” tab will then be shown in the Core Frame. The chosen profile can then be suppressed from his list by clicking first on it in the User’s profile panel, then on the  arrow.


2.1.12              Modifying the BSOA Profile or Password for a Specific User

Warning:

This operation can only be performed on the selected security realm (See the previous sections for more information on how to select a specific Security Realm) in case of a Datasource Realm. Ldap Realms must be managed with their specific administration tool.

First, access the users list for the realm (see Accessing the Users List for a Specific Realm) and select a user by clicking on his name. The user information form is shown in the Core Frame.

 

Figure 217.  User Information Form

 


To add a profile for this user, first select the profile by clicking on it in the Available panel (on the right), then click on the  arrow. The profile will then be present in the User’s profile panel.

To delete a profile for this user, first select the profile by clicking on it in the User’s profile panel, then click on the  arrow.  The profile will then be suppressed from the user’s profiles.

For other changes, modify user information as necessary.

When finished, click on the “Apply” button to validate the changes.

Warning:

These changes are effective immediately. Changing groups cause problems for users currently running the Process Console.

 

2.2                     Engine Databases

Within this version of Orchestra, only the BPEL Engine is provided. In further versions, a workflow engine will also be included.

The Process console offers a means to access the current Datasource configuration for information only.

 


2.2.1                     Changing Basic Engine Datasources

Specifying Datasources (datasource mapper, datasource url, …), is not in the scope of the Process Console.

This is done at installation time and is described in the Orchestra installation guide, “Getting Started.” This guide explains how to adapt jonas.properties and [datasourceName].xml files according to user-specific needs.

To access to the Datasource configuration and to modify the JDBC connection parameters, use the Jonas admin console accessed via:

http://Your_Host:Your_HttpPort/jonasAdmin

This defaults to:  http://localhost:9000/jonasAdmin with a user of “jonas” and password of “jonas”.

The Datasource configuration can be accessed in the Jonas console by using the menu choices:  Domain Server JOnAS Services Database.  There will be a datasource for Orchestra (bpel) and for Orchestra administration (bsoaadmin).  The default is manage both of these within the same HSQL database.

 

2.2.2                     Looking at the Engine Datasource Definition

Select the following path in the Navigational Tree (Left Panel): Administrator Engine Databases Orchestra database.

 

Figure 218.  Navigational Path to Select Datasource Configuration Display

 


The BPEL Datasource configuration is shown in the Core Frame (Right Panel).

 

Figure 219.  BPEL Datasource Configuration Display

 

This figure shows the port number used for the database in its connection URL, along with other connection properties.

Clicking on the Engine database tab will show the Datasources that are available, as shown in the following figure.

 

Figure 220.  Display of Available BPEL Datasources

 


2.3                     Editing Custom Properties

Select the following path in the Navigational Tree (Left Panel): Administrator Edit Custom Properties.

 

Figure 221.  Navigational Path for Accessing Custom Configuration Form

The Custom Properties configuration is shown in the Core Frame (Right Panel).

 

Figure 222.  Custom Properties Configuration form

 

To edit the Custom Properties, insert a URL that points to one of the following: a customized file whose content represents an HTML to be displayed in the header or footer frames, a Cascading Style Sheet (CSS), or Extensible Style Language (XSL) definition file. Once the URL(s) are inserted, click the Save button. The administrator will be prompted to confirm the save action. Once the confirmation is performed, refreshing the console () will enable the changes.


Rows of items per page:  can have its default value of 10 changed to alter the number of models/processes displayed on a page.  The example below shows what happens for displaying process models when this value is changed to 15 (there must be 15 or more models present for this to make a difference):

 

Figure 223.  Process Models Display

 

Include process type in tree:  Some of expanding/collapsing tree nodes in the left frame contain a "Process type" label node that reads either "Bonita" or "BPEL".  Since the console (at least currently) supports only one type at a time this option allows the user the choice of displaying the label or not.  Try it out, then look at the node list under the "Operator" tree node. It may be necessary to refresh the view to see the changes.

Console utility bar:  The "utility bar" is a narrow frame between the header frame and the main body frame of the console display. It contains the name of the user and an exit and refresh button.  The use of this frame is optional via this selection.

 


2.4                     Setup

Select the following path in the Navigational Tree (Left Panel): Administrator Setup.

Figure 224.  Navigational Path to Access Setup

The Setup panel is shown in the Core Frame (Right Panel).

Figure 225.  Setup Panel

This panel provides access to the settings for the Engine Setup and the Monitoring Mode.

Engine Setup:

·           DB: with this mode, all activities are saved to the database incrementally.

·           Memory: choose this mode for optimum performance of Orchestra. Since no backup is made, this option should be chosen for non-critical processes only.

Monitoring Mode:

·           Nothing: no monitoring at all.

·           RunningOnly: monitors only executing instances.

·           MessagesOnly: no monitoring but messages exchanged via the web service are saved.

·           RunningAndMessages: a combination of the RunningOnly and MessagesOnly modes.

·           All: all instances are monitored.

A warning is then provided. Confirm the choice by clicking on the “Confirm” Button.


Chapter 3. Guide for Process Console Designer

 

This chapter describes the functions for the role of Process Console Designer.

This includes the information necessary to be able to:

·           Access Process Management in order to create, modify, or delete Process Models,

·           Manage Orchestra Process Models: import BPEL files, etc.

 

3.1                     Orchestra Process Models

 

Any user managing process models to view a given process model must have a designer profile.  An Administrator user of the Process console sets this operator profile. See Orchestra Profiles in the Process Console Administration chapter to set operator profiles.

 

3.2                     Adding a New Process Model

 

Select the following path in the Navigational Tree (Left Panel): Designer Process management Import files.

Figure 31.    Navigational Path to Add a New Process Model

 


Figure 32.    Import Files Frame for Adding a New Process Model

The figure above shows an example of importing the “assign” sample.

To specify a BPEL process the console must be given:

1)      a BPEL file describing the process,

2)      a WSDL file describing the interfaces of the process, and

3)      a WSDL file (or a set thereof) for each Web Service called within the process. The assign sample does not call any external web services, thus none were supplied with this example.

·           Use the “Browse” button to specify a BPEL and WSDL file as required.

·           Use the “Browse” button to specify an external WSDL file. To import more than one external WSDL file, click the “Add” button to browse and import additional files. Once specified, these files are listed under the “External WSDL file” line with a “delete” action available, and can be deleted as desired before clicking on the “Import” button.

Figure 33.    Specifying an External WSDL File

 

·           Click the “Import” button at the bottom of the form to import the BPEL process definition into the BPEL engine. If there is an existing process model of the same name, it must be deleted before the import will succeed (see Deleting Process Models).

Note:

At least one BPEL file and one WSDL file are required in order to import a process.

 


3.3                     Deleting Process Models

Select the following path in the Navigational Tree (Left Panel): Designer Process management Process models.

 

Figure 34.    Navigational Path to Process Models List

If there are more than 10 models are available, they can be scrolled through by using the forward , backward , begin , and end  buttons at the top of the display, as shown in the following figure which has the second 10 models displayed.

 

 

Figure 35.    Process Models List

 


The “Process models” list is displayed in the core panel with the following information:

·           Name: the name of the imported process model.

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

-          The DEPLOYED state occurs after the Deploy action is taken, which is described under the Operator Process Models menu choice in Section 4.1.3, "Deploying/Undeploying a BPEL Process Model.”

-          The TODEPLOY state occurs after an Import Files operation. 

·           Creator: the login name of the designer who imported the process files into the Orchestra engine.

·           The last column of the table, named “Action”, contains a “Delete” link for each process in the list.

Click this “Delete” link to delete the process. The process model can be made available again by an import action (see Adding a New Process Model).

 

Note:

This operation will be successful if no instance of this process is still in running state.  To terminate a running BPEL process instance, refer to Chapter 4, “Guide for Process Console Operator”, which describes the Operator Process Instance menu choice and the Terminate action.


Chapter 4. Guide for Process Console Operator

 

This chapter describes the functions for the role of Process Console Operator. This includes 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.

 

4.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 Chapter 2, “Guide for Process Console Administrator,” to set operator profiles.

 

4.1.1                     Accessing the Orchestra Process Models List

Select the following path in the Navigational Tree (Left Panel): Operator Process models.

 

Figure 41.    Navigational Path to Access Process Models List

 

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 Chapter 3, “Guide for Process Console Designer”), 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 4.1.4, “Starting 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 42.    Orchestra Process Models List

 

If there are more than 10 models are available, they can be scrolled through by using the forward , backward , begin , and end  buttons at the top of the display, as shown in the figure below which has the second 10 models displayed:

 

Figure 43.    Scrolling Display for List of More than 10 Process Models

 

4.1.2                     Accessing 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 44.    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 Accessing the Orchestra Process Models List.


4.1.3                     Deploying/Undeploying 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.

Note:

It is necessary to delete an undeployed model before it can be imported again (see Chapter 3, “Guide for Process Console Designer”).

 

4.1.4                     Starting 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 45.    Display of Available Process Models

 


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

 

Figure 46.    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 47.    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 48.    Form To Start a Process Model

Fill in any required parameters, and then click on “Submit”. The reply will extend the current display in the core frame.


4.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 Chapter 2, ”Guide for Process Console Administrator.”

HOW TO ACCESS THE INSTANCES LIST

Select the following path in the Navigational Tree (Left Panel): Operator Process instances.

 

Figure 49.    Navigational Path to Access the Instances List

The Core Frame (Right Panel) displays the available process instances.

 

Figure 410.  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.

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

·           Action: “Terminate action” terminates an executing process instance (click on the terminate button  for that process).  This only kills that instance of the process, it does not undeploy it or delete it.

 

 


Chapter 5. Guide for Process Console User

 

This chapter describes the functions for the role of Process Console User.

This includes the information necessary to be able to:

·           Access the Orchestra process list.

·           Start Orchestra Processes.

Note:

Since Orchestra processes are automatically instantiated, the User function within the Process Console is only used to start processes for test purposes.

 

5.1                     Accessing the Orchestra Process List

 

Select the following path in the Navigational Tree (Left Panel): User Processes to start as shown in the example below.

 

Figure 51.    Navigational Path to Access the Orchestra Process List 

Authenticated users (to the process console) can see all the Orchestra processes that have been deployed into the BPEL engine.

Details of the selected process are displayed in the Core Frame (Right Panel).

·           Name: the name of the process.

·           Type: the type of the process (BPEL, …).

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

·           Action:  contains the Start button for the process.

 


Figure 52.    Orchestra Processes That Have Been Deployed Into the BPEL Engine

 

If there are more than 10 processes are available to start, they can be scrolled through by using the forward , backward , begin , and end  buttons at the top of the display, as shown in the figure below which has the first 10 processes displayed:

 

Figure 53.    Display of Available Processes to Start

 


5.2                     Creating a New Instance of an Orchestra Process

 

Access the Orchestra Process list (See Accessing the Orchestra Process Models List).

To create a new instance of a process, click on the “Start” button () in the “Action” column.

 

Figure 54.    Display of Available Port Types and Operations To Instantiate a New Instance of a Process

A list of the available port types and operations that can instantiate the process will be displayed.

Select one of these operations by clicking on the “Start” button () in the “Action” column.


A form is then displayed with the input of the corresponding Web Service.

 

Figure 55.    Form To Create a New Instance of an Orchestra Process

 

Fill in any required parameters (the above figure shows in the assign sample with the value “foo”  filled in for  the “name” parameter) and click on the “Submit” button to start the process with those parameters.


The response will then be displayed by extending the current core frame display. An example response using the assign sample is show below:

 

Figure 56.    Example Response to “Create a New Instance of an Orchestra Process”