Red Hat Training

A Red Hat training course is available for JBoss Enterprise SOA Platform

Chapter 16. Administering Your System with the BPEL Web Console

16.1. BPEL Web Console

The BPEL Web Console is a tool that allows you to view:
  • any process definitions you have deployed to the BPEL engine
  • the process instances executing in the BPEL engine
  • a process' execution history
  • the query pertaining to the execution history
Find the console at http://localhost:8080/bpel-console.

Important

It is recommended that you only open one BPEL Console window at a time within your browser or you may have trouble logging in or you may see a blank window once you have logged in.

16.2. Business Process Execution Language (BPEL)

Business Process Execution Language (BPEL) is an OASIS-standard language for business rules orchestration. Refer to http://docs.oasis-open.org/wsbpel/2.0/wsbpel-v2.0.html for more information.

16.3. Business Rule Orchestration

Business rule orchestration refers to the act of specifying actions within business processes via web services.

16.4. Process Definition

A BPEL Process Definition is an XML file that acts as a template for a process. when published, the process definition creates a process that is a web service in its own right.

16.5. Process Instance

A process instance is one execution of a process definition.

16.6. View Deployed Processes with the BPEL Web Console

Procedure 16.1. Task

  1. Launch a web browser and go to http://localhost:8080/bpel-console.
  2. Input your user name and password.
  3. Click on the Manage Instances tab to see which BPEL processes are currently deployed. You will also see version information for each of these processes.
  4. Select a process definition to open it. In the bottom panel you will see a list of process instances that are active for that particular definition.

    Note

    Only one version of a process can be active at a time. When you open a process definition, the active version is automatically selected.
  5. Sometimes you will find that you need to manage a "retired" version (for example, in order to terminate running instances). In these cases, click More - Change Version and then select the version you want.

    Note

    If there is no version for a particular process archive, (such as Quickstart_bpel_simple_invoke.jar), it is treated as version zero. (In this case, Quickstart_bpel_simple_invoke-1.jar, will be the next version deployed.)

16.7. Business Process Analytics Format (BPAF)

The Business Process Analytics Format (BPAF) is designed to provide you with information about the efficiency and effectiveness of your organizational processes.

16.8. View BPAF Data with the BPEL Web Console

Procedure 16.2. Task

  1. Launch a web browser and go to http://localhost:8080/bpel-console.
  2. Input your user name and password.
  3. Click on the Manage Instances tab to see which BPEL processes are currently deployed. You will also see version information for each of these processes.
  4. Select a process definition to open it. In the bottom panel you will see a list of process instances that are active for that particular definition.
  5. Use the Execution History to produce a chart. Here you can specify a particular period of time to review and choose whether or not to include failed and terminated instances in the chart.

16.9. List of Shortcut Keys to Use When Navigating the Execution History Chart

Table 16.1. Navigation Keystrokes

Keyboard or Mouse Command
Result
Up Arrow
Zoom In
Down Arrow
Zoom Out
Left Arrow
Half-Page Left
Right Arrow
Half-Page Right
Page-Up
Page Left
Page-Down
Page Right
TAB
Next Focus
Shift-TAB
Previous Focus
HOME
Max Zoom Out
ENTER
Max Zoom In to Focus
Mouse Drag
Scroll Chart
Shift Mouse Drag
Drag Select/Zoom
Mouse Wheel Up/Z
Zoom In
Mouse Wheel Down/X
Zoom Out
Backspace/Back Button
Back
Right Mouse-Click
Context Menu
Left-Click
Set Focus
Double-Click
Maximise Zoom-In-to-Focus

16.10. Activate the BPEL Web Console's Logging Functionality

Procedure 16.3. Task

  1. Open the deploy.xml file in a text editor (for the bpel_helloworld quick start, this would be vi SOA_ROOT/jboss-as/samples/quickstarts/bpel_hello_world/bpelContent/deploy.xml
  2. Edit the file as follows:
    <deploy xmlns="http://www.apache.org/ode/schemas/dd/2007/03"
     xmlns:bpl="http://www.jboss.org/bpel/examples" 
     xmlns:intf="http://www.jboss.org/bpel/examples/wsdl">
    
     <process name="bpl:HelloGoodbye">
      <active>true</active>
            <process-events generate="all"/>
      <provide partnerLink="helloGoodbyePartnerLink">
       <service name="intf:HelloGoodbyeService" port="HelloGoodbyePort"/>
      </provide>
     </process>
    </deploy>
    
  3. Save the file and exit.
  4. Open the bpel.properties file in the text editor: vi SOA_ROOT/jboss-as/server/PROFILE/deploy/riftsaw.sar/bpel.properties
  5. Switch on the process-events option for the particular process you want to log and make sure that org.jboss.soa.bpel.console.bpaf.BPAFLogAdapter is enabled.
  6. Save the file and exit.

16.11. View Instance Data with the BPEL Web Console

Procedure 16.4. Task

  1. Launch a web browser and go to http://localhost:8080/bpel-console.
  2. Input your user name and password.
  3. Click on the Manage Instances tab to see which BPEL processes are currently deployed. You will also see version information for each of these processes.
  4. Select a process definition to open it. In the bottom panel you will see a list of process instances that are active for that particular definition.

    Note

    Only one version of a process can be active at a time. When you open a process definition, the active version is automatically selected.
  5. Click the Instance Data button.
  6. The View tab shows the instance execution graph, while the Source tab below it shows all of the "activity" events.

16.12. Instance Execution Graph

The instance execution graph is a visual representation of a running instance of a process. It tells the user about the process instance's performance over time.

16.13. View the Instance Execution Graph with the BPEL Web Console

Procedure 16.5. Task

  1. Launch a web browser and go to http://localhost:8080/bpel-console.
  2. Input your user name and password.
  3. Click on the Manage Instances tab to see which BPEL processes are currently deployed. You will also see version information for each of these processes.
  4. Select a process definition to open it. In the bottom panel you will see a list of process instances that are active for that particular definition.

    Note

    Only one version of a process can be active at a time. When you open a process definition, the active version is automatically selected.
  5. Click on the Execution Path button to see an instance execution graph for the process.

16.14. View a History Instance Query

Prerequisites

  • History logging must be enabled.

Procedure 16.6. Task

  1. Log into the BPEL Web Console.
  2. Choose a process definition and a process status from the list box.
    You can also optionally choose to input the correlation key, the start time and the end time as search criteria.
  3. Go to the History Instances List and double-click on a row. A window will pop up showing you all of the execution events that happened when that process ran.

16.15. Active Process Definition

When you deploy the first version of a BPEL process definition, it automatically becomes the active definition. If this definition is subsequently changed and redeployed, then that version is "retired", and a new version becomes active automatically.

16.16. Retired Process Definition

If the active process definition is changed and redeployed, the old version is "retired". The new version automatically becomes active. The only difference between an active version and a retired one is that a retired one can no longer create new process instances. However, if there are active process instances associated with the retired process version, then these will continue to run.

16.17. Manually Retire an Active Process Definition

Procedure 16.7. Task

  1. Launch a web browser and go to http://localhost:8080/bpel-console.
  2. Input your user name and password.
  3. Click on the Runtime tab.
  4. Select the Deployments option.
    You will now be able to see the version information and current status (active or retired) of each process definition.
  5. Select the particular version of the process definition you want to retire and then press the Retire button.

    Note

    If you undeploy a process, its end-points will only deactivate if no previous versions of that process have ever existed.

16.18. End-Point Reference

An end-point reference (EPR) contains the address information and technical specifications for a service. Indeed, all ESB-aware services are identified using end-point references. It is through these references that services are contacted. The are stored in the registry. Services add their end-point references to the registry when they are launched and should automatically remove them when they terminate. A service may have multiple end-point references. End-point references are also known as binding templates.
End-point references can contain links to the tModels designating the interface specifications for a particular service.

16.19. Manually Re-Activate a Retired Process Definition

Procedure 16.8. Task

  1. Launch a web browser and go to http://localhost:8080/bpel-console.
  2. Input your user name and password.
  3. Click on the Runtime tab.
  4. Select the Deployments option.
    You will now be able to see the version information and current status (active or retired) of each process definition.
  5. Select the retired version you want to reactivate and press the Activate button (found on the bottom-right of screen.)

16.20. Enable UTF-8 Support for Processes or External Web Services

Procedure 16.9. Task

  1. Check your database to make sure UTF-8 encoding is being used by default.
  2. Launch a text editor and open the database's configuration file.
  3. Add these settings to the file:
    hibernate.connection.useUnicode=true
    hibernate.connection.characterEncoding=UTF-8
    
  4. Save the file and exit.