TIBCO BWPM Server User Guide 2.0

TIBCO ActiveMatrix BusinessWorks
Process Monitor Server

User Guide
Software Release 2.0
Published: November 2012
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR
BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON
FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT
LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR,
IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH
IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN
LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER
LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF
THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL
CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No
part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.
TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO
Enterprise Message Service, TIBCO InConcert, TIBCO Policy Manager, and TIBCO Hawk are either registered
trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.
EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun
Microsystems, Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their respective
owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING
SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE
README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM
PLATFORM.
THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES
ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN
NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES
IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY
OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY
RELEASE NOTES AND "READ ME" FILES.
Copyright 2001-2012 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
Contents
Introduction
Overview
User Management
Domain Objects
Process Monitoring
TIBCO BWPM instance
TIBCO BWPM Server
Tomcat Servlet Container
TIBCO BWPM Clients
Starting TIBCO BWPM Server
Starting TIBCO BWPM Server on Windows
Starting TIBCO BWPM Server on UNIX
Stopping TIBCO BWPM Server
Automatic Logout
Manage Users and Roles

Manage Users
9
9
Adding and Deleting Users
10
Granting and Revoking Permissions
11
Manage Passwords
11
Manage Roles
13
Adding and Deleting Roles
14
15
Granting Access to Domain Objects

Domain Objects
Rules
17
17
18
Editing rules
19
Editing Conditions
19
Editing Actions
21
Email Action
22
JMS Message Action
23
Create Task Action
24
Templating Language
25
Working with Monitored Objects
27
Overview
27
Using the GUI
29
Main Table
29
Event Table
34
Process Diagram
35
Details Table
35
Domain Object Tree
36
Searching for Process Instances
38
By Time
39
By Taxonomy
40
By Status
42
QuickSearch
44
Interacting with Process Instances
47
Process Context
47
Process Data
48
Process Diagram
49
Data retention
57
Glossary
58
Preface
This document explains the TIBCO BWPM Server GUI. See the TIBCO BWPM Server
Administration and Configuration Guide for information about installation and configuration of
the server.
TIBCO BWPM Server User Guide
Introduction
This chapter gives a high level overview over the TIBCO BWPM Server GUI, the TIBCO BWPM instance
and their relationships with other programs in the installation.
Overview
The TIBCO BWPM Server has two main components: the TIBCO BWPM Server and the TIBCO BWPM
Server GUI. The TIBCO BWPM Server manages resources in a TIBCO BWPM instance. The TIBCO
BWPM Server GUI provides a thin client (browser) interface, allowing the user to interact with the
TIBCO BWPM Server and the data managed by it.
The next picture shows the User Management module in the TIBCO BWPM Server GUI. Depending on
the roles you have been assigned to, your view may vary.
|1
User Management
The User Management is available to members of the admin role, only. This module allows
administrators to create, modify and delete users and roles and assign privileges on Domain Objects
managed by the TIBCO BWPM instance:
Users: users can be created and assigned to (multiple) roles to ease administration.
Roles: Access rights are managed on role level and control which modules, data and functions are
available for the members of the role.
Domain Objects
BWPM organizes (technical) resources hierarchically. At the top of the hierarchy the name of the
TIBCO BWPM instance is shown. The next deeper levels are called Domain, Deployment, Engine and
Process, known as Domain Objects. They represent manageable objects within the TIBCO BWPM
instance. The taxonomy will be referenced as Domain Object Tree (short: DOT).
Where possible, the taxonomy will match existing concepts of the monitored technology.
For example: if BWPM is used to monitor TIBCO BusinessWorks Domains, the taxonomy will match
the taxonomy of the TIBCO BusinessWorks Domain (best effort). The terminology used by TIBCO
Administrator is matched by the TIBCO BWPM Server GUI as follows:
TIBCO BWPM Server
TIBCO Administrator
TIBCO BWPM instance

Domain
Deployment
Engine
Process
n.a.
TIBCO BusinessWorks Domain
Service
Service Instance
Process
|2

Compare the following picture with the picture above:
Process Monitoring
Using the DOT and various other search and filter controls the user can identify and navigate to any
hotspot in the TIBCO BWPM instance with ease.
|3

The user interface is context sensitive and will adjust its layout depending on the user interaction. All
data displayed and actions triggered by the user are checked against the users access rights and
either granted or denied. This affects reports and statistics, too.
TIBCO BWPM instance

When the TIBCO BWPM Server is installed and its database objects are created, the installation
procedure asks for a TIBCO BWPM instance name. The name given will become the logical name of
the TIBCO BWPM Server from there on. Two TIBCO BWPM instances cannot share the same database
schema.
A TIBCO BWPM instance monitors and grants access to some or all of its managed domain objects.
The TIBCO BWPM instance is a logical management domain and does not relate to the physical or
logical layout of the monitored domain objects. For example, a single TIBCO BWPM instance can
monitor resources of multiple TIBCO BusinessWorks Domains.
BWPM Instance Development and Test
TIBCO Administration Domain

Development
TIBCO Administration Domain

Test
TIBCO BusinessWorks
TIBCO BusinessWorks
TIBCO BusinessWorks
TIBCO BusinessWorks
The minimum setup of a TIBCO BWPM instance consists of a TIBCO BWPM Server and at least one
BWPM Client. The TIBCO BWPM Server requires a servlet engine to run in (i.e. Apache TOMCAT),
while the TIBCO BWPM Clients are run standalone or as plugins to their respective target technology
(i.e. BWPM Client for BW requires a TIBCO BusinessWorks engine).
TIBCO BWPM Server

The TIBCO BWPM Server acts as the core of a TIBCO BWPM instance. It processes inbound event
messages, communicates with local or remote TIBCO BWPM Clients and provides the TIBCO BWPM
Server GUI; it also manages the resources participating in the TIBCO BWPM instance and enforces
the authorization concept.
|4
Tomcat Servlet Container

The Tomcat Servlet Container manages the communication and provides the BWPM GUI. It is
configured using the standard Tomcat configuration files. See the Apache Tomcat manuals for further
reference.
TIBCO BWPM Clients

TIBCO BWPM Clients are stand-alone components or plugins to their respective target technology.
TIBCO BWPM Clients collect monitoring data of other data sources they connect to (i.e. other
applications, log files, etc) and forward them to the TIBCO BWPM Server. The TIBCO BWPM Server
can communicate with TIBCO BWPM Clients and change their configuration without the requirement
to restart them.
TIBCO BWPM Clients are fully decoupled from the TIBCO BWPM Server; a BWPM Client can fully
operate even if the communication with the TIBCO BWPM Server is interrupted.
|5
Starting TIBCO BWPM Server

In order to access the TIBCO BWPM Server GUI the TIBCO BWPM Server must be started first. Since
the TIBCO BWPM Server is a standard web application running inside a Tomcat server, starting the
Tomcat server and the BWPM web application is sufficient to start the TIBCO BWPM Server.
Starting TIBCO BWPM Server on Windows

If the Tomcat server has been registered as a Windows service, the corresponding Windows service
must be started.
Alternatively, the Tomcat server can be started from the command line as follows:
Open a DOS prompt and navigate to the Tomcat bin directory. Then run the Tomcat startup script
startup.bat. Note: your Tomcat installation home may vary!
Open the web browser and navigate to the following URL:

http://<BWPM_SERVER>:<PORT>/BWPM
where
-
BWPM_SERVER is the name of the server running the Tomcat server which hosts the BWPM
web application
PORT is the port of the Tomcat server (default is 8080)
|6
Starting TIBCO BWPM Server on UNIX

On Unix change the current directory to the Tomcat bin directory and run the startup script
startup.sh. Note: your Tomcat installation home may vary!
Open the web browser and navigate to the following URL:

http://<BWPM_SERVER>:<PORT>/BWPM
where
|7

-
BWPM_SERVER is the name of the server running the Tomcat server which hosts the BWPM
web application
PORT is the port of the Tomcat server (default is 8080)
Stopping TIBCO BWPM Server

To stop the TIBCO BWPM Server the Tomcat server must be stopped.
If the Tomcat server has been registered as a Windows service, the corresponding Windows service
must be stopped.
In all other cases navigate to the Tomcat bin directory and run the stop script shutdown.bat
(Windows) or shutdown.sh (Unix).
Automatic Logout
After 15 minutes of inactivity a user will be warned that his session will be terminated shortly. If no
activity is recorded within the next five minutes after the warning, the user will be logged out.
|8
Manage Users and Roles

The User Management allows a member of the admin role to manage users, roles and access rights.
The User Management module is located in the Administration category:
Manage Users
To access the User Management, navigate to the Users node in the Administration Tree. This will
open a list of available users in right side of the window.
|9
Adding and Deleting Users

Users can be edited, created and deleted using the corresponding buttons underneath the list. When
creating a user you must supply a user name (which will act as the login id) and password. Optionally
a comment can be added and a time interval that constraints the new users validity be configured.
When created, the username cannot be changed afterwards.
Select the Roles tab on top of the dialog to configure the new users role memberships.
Once the user is created, a personal role of the same name as the user is created in the system and
the user is added to that role.
| 10

To edit a user you can either select it straight from the Administration Tree, or mark the entry in the
list on the right side and click the Edit button. All changes to role memberships come into effect
immediately then the user entry is saved. Users are not required to logout and login for these
changes to be applied to their BWPM session.
To delete a user it must be selected from the users table and the Delete button must be pressed.
Confirm the delete request when prompted:
Note: the admin user cannot be deleted.

Permissions are managed via roles. To grant or revoke permissions from a user, the permission must
be configured for a role the user is member of. To grant a permission to a single user, only, configure
the permission for the users personal role (a role that has the same name as the user; it gets created
automatically when a new user is created).
Manage Passwords
When creating a user, an initial password must be set. That password should be changed by the new
user after his first login. The password can be changed either by an administrator or by the user using
the Profile dialog:
| 11

The user can change his first and last name (required for personalized emails, etc), update the email
address and change the password. Also the user may configure which BWPM view should be
presented when logging in to the system.
| 12
Manage Roles
To access the management interfaces for roles, navigate to the Roles node in the Administration
Tree. This will open a list of available roles in right side of the window.
| 13
Adding and Deleting Roles

Roles can be edited, created and deleted using the corresponding buttons underneath the list. When
creating a new role, you must supply a name and a time interval that constraints the new roles
validity.
Once the role is created, privileges can be configured (see Granting and Revoking Permissions for
more information) and user added.
To edit a role you can either select it straight from the Administration Tree, or mark the entry in the
list on the right side and click the Edit button. All changes to roles come into effect immediately
when it they are saved. Users are not required to logout and login for these changes to be applied to
their BWPM session.
To delete a role it must be selected from the users table and the Delete button must be pressed.
Confirm the delete request when prompted:
Note: the admin role cannot be deleted.
| 14

To grant or revoke access rights for a certain domain object an administrator can assign three
different privileges to each role and domain object:
Read: a role with this privilege can access all process instances relating to this domain object.
All reports and statistics displayed to the user include this domain object.
Data: the user is granted the right to access all data that is collected automatically by a
BWPM Client. This includes data generated by trace points and detailed stack traces; such
trace point and stack trace data may include sensitive information and hence access is
protected by this privilege.
Manage: a user with this privilege is entitled to manage trace points (enable, disable, set
duration).
To update a roles privileges navigate to the Privileges tab of the Role Edit dialog. Then navigate
to the domain object you want to manage a privilege for. Privileges are assigned using a hierarchical
order. If a privilege is granted or revoked on a higher level, it will be granted or revoked on all its
child elements.
For example: granting the Manage privilege to the fs_dev domain (see picture above) will grant
the privilege to its entire domain objects (Deployments, Engines and Processes automatically.
| 15

In order to assign users to roles, select the Users tab and mark all users that should be members of
that role. To remove a user from a role, uncheck the entry. Then save the changes using the Save
settings button at the bottom of the table.
| 16
Granting Access to Domain Objects

By default new domain objects are accessible to BWPM administrators, only. To grant access to new
or existing domain objects to other users, a role must be created and the corresponding privileges
configured. Then the user must be added to that role.
Using roles to manage privileges provides the administrator with greatest flexibility manage access
rights.
Domain Objects
Domain objects are technical resources managed within a TIBCO BWPM instance. They are organized
in a hierarchy, starting at the domain level. The descending levels, in order, are: domain,
deployment, engine and process.
| 17
Rules
The server does allow the configuration of monitoring rules, which can trigger various actions. For
example, an administrator may want to get email alerts whenever a certain BW jobs execution time,
or an individual activity, exceeds a given threshold.
Rules can be configured and managed in the Administration -> Rules category:
When the Rules node is selected, a list of all configured rulesets is shown. A ruleset bundles
multiple rules. Each rule has a set of conditions, which all must be met for the rule to trigger all of its
actions. Using the buttons at the bottom of the table, existing rulesets can be edited or deleted and
new rulesets can be created.
| 18
Editing rules
When editing or creating a rule, at first the scope of the rule must be set (1).
The scope can be limited to an individual TIBCO BusinessWorks domain by selecting it from the drop
down menu; to not limit the scope of the ruleset to a specific domain, select All.
Next, a name for the ruleset must be set (2). To add rules to the ruleset, click on the Add Rule
button (3). This creates an empty rule configuration:
Set a name for the newly added rule (4), and add at least one condition (5) and one action (6) to the
rule. Additional rules can be added to the ruleset by clicking on the Add rule button (7). To delete
rules from a ruleset click the delete button to the right of the rule (8).
Editing Conditions
To add a condition, click on the Add Condition button (5). Every condition needs four items to be
configured: the object the condition should work on (9), the objects attribute (10), a comparator
(11) and a value to compare the objects attribute with (12). For new conditions only the objects
field (9) is visible. The other fields appear step by step after the previous field has been configured.
Each fields appearance is dependent on the previous fields configuration. For example, if you select
Process as object and Duration as attribute, the comparators you can choose from will only allow
comparison of numbers, since Process Duration is a number.
| 19
The following combination of object and attribute are available:

Object
Attribute
Attribute Type
Valid Attributename
Activity (duration)
<name of activity>
Number
The exact name of the activity, as

defined in the BW process
definition. The attributes value is
in milliseconds.
Example: Timer
Attribute
<name of attribute>
Number |
String | Date
The exact name of the attribute, as

defined in an extraction rule.
Example: Order No
Deployment
Name
String
Any string
Example: OrderProcessing
Domain
Name
String
Any string
Example: Development
Engine
Name
String
Any string
Example: OrderProcessing-Archive
Event
Status
String
The events status name. Valid

values are:
INFO, SUCCESS, WARNING, ERROR
Error Code
String
Any string
Example: ORA-01417
Error Message
String
Any string
Example: A table may be outer
joined to at most one
Name
String
Any string
Example: LogInfo
Timestamp
Date
Any date
Example: 2012-10-01 23:42:37
Name
String
Any string. To match exactly one

process definition, the full URI of
the process should be used.
Example:
DemoFolder/DemoProcess.process
Process
| 20
Server
Status
String
The process status.

Valid values are:
Business Object
String
Any string
Example: Invoice
Business Service
String
Any string
Example: Fax Service
External Reference
String
Any string
Example: A119764
Jobstart
Date
Any date
Example: 2012-10-01 23:42:37
Jobend
Date
Any date
Example: 2012-10-01 23:42:37
Duration
Number
Any number. The attributes value

is in milliseconds.
Name
String
Any string
Example: vsltibbw01.domain.com
The following comparators are available for the different attribute types:
Attribute Type
Comparators
String
equals, not equals, contains, not contains, starts

with, starts not with, ends with, ends not with
Number
equals, not equals, greater than, greater or

equal, less than, less or equal
Date
after, before
Editing Actions
Whenever all conditions of a rule are matched, the server triggers all actions configured for that very
rule. To add an action, click on the Add action button (6) and select from the available actions:
Email, JMS Message or Create Task.
| 21
To configure or show the settings of an action, click the Settings button (14) next to the action
select list. Actions can be deleted using the Delete button next to the actions Settings button.
Email Action
Note: before Email actions are configured, please validate that an email server has been configured
in Administration -> Connections -> SMTP. Otherwise the system will not be able to send emails.
The email action is configured using the following five (optional) fields: to, cc, bcc, subject and
message body. An example configuration could be as follows:
Description of available settings for mail action:

Setting
Description
Example
To
List of email addresses to send

this email to. Separate
addresses using the semicolon
(;)
alert@domain.com;
support@domain.com
Cc
List of email addresses to copy
alert@domain.com;
| 22

this email to. Separate
(;)
support@domain.com
Bcc
List of email addresses to blind

copy this email to. Separate
(;)
alert@domain.com;
support@domain.com
Subject
Message
The subject of the email

The emails body
Notification email
The process took longer than
expected!
Note: the email action does not support email attachments in this release.
JMS Message Action

The JMS Message action sends a JMS text message to a configurable destination. The destination and
message body can be freely configured; the JMS connection used for sending the message, however,
must be selected from the list of configured JMS connections.
Description of available settings for JMS Message action:

Setting
Description
Example
Destination
The JMS destination name to

send this message to.
new.destination
JMS Connection
The JMS connection to use for

sending the message. JMS
connections can be configured
in the Administration ->
Connections -> JMS category.
jmsQueueConnection
Message
Chosoe between creating a new

(text) message, and sending a
copy of the retrieved log
message to the new
New
| 23

destination.
Message Body
Only available, when New

Message is selected. Defines
the text body of the JMS
message.
Hello, world!
Note: the JMS Message action does not support configuration of JMS Headers in this release.
Create Task Action

To mark a process instance for follow-up, the Create Task action can be used. It will create a new
task, associate the current evaluated process instance with it and assign it to the configured role.
Description of available settings for Create Task action:

Setting
Description
Example
Task name
The name of the task to appear

in the users task list.
Select one of the available roles
to assign this task to.
Defaults to zero. Select any
other priority, if wanted.
Priorities can be used by users
to sort their task list.
A free text comment to append
to the task.
Generated Task for

[process.logid]
Admin
Assign to
Priority
Comment
100
Please check this out!
| 24
Templating Language
For all settings that allow free text entries, such as email address, message body or task comment, a
templating language is available. This allows to dynamically insert content into the concrete field at
runtime, such as process names, activity durations and other.
Text strings that should be replaced when the action is triggered must be enclosed using square
brackets ([ and ]). For example, to insert the name of the process into the email message body,
the following text can be used: The process name is: [process.name]. At runtime this will result
into, for example, this: The process name is: DemoFolder/DemoProcess.process
A valid token consists of two parts: the object and its attribute, and is of this format:
[object.attribute]. The following table lists all available objects and attributes combination:
Object
Attribute
Description / Returned value
activity
<name of activity>
The exact name of the activity, as defined in the

BW process definition
Example: activity.Timer
Returns: activitys duration
attribute
<name of attribute>
The exact name of the attribute, as defined in an

extraction rule.
Example: attribute.Order No
Returns: value of attribute Order No
deployment
name
Returns the name of the deployment this process

has been executed in.
domain
name
Returns the name of the domain this process has

been executed in.
engine
name
Returns the name of the BW engine this process

has been executed in.
event
status
errorcode
The events status name.

The error code that has been configured for this
activity.
Example: ORA-01417
The error message that has been configured for
this activity.
Example: A table may be outer joined to at most
one
The name if the event activity.
Example: LogInfo
The events timestamp.
Example: 2012-10-01 23:42:37
The events sequence number in this process
instance.
errormessage
name
eventdatetime
sequence
process
name
The full process URI of the executed process.

Example: DemoFolder/DemoProcess.process
| 25

status
businessobject
businessservice
externallogid
jobstart
jobend
duration
logid
correlationid
businessstart
businessend
parentlogid
jobid
The process status.

Valid values are:
The configured business object for this process.
Example: Invoice
The configured business service for this process.
Example: Fax Service
The configured external reference for this
process.
Example: A119764
The timestamp of the jobs start.
Example: 2012-10-01 23:42:37
The timestamp of the jobs termination.
Example: 2012-10-01 23:42:37
The duration of the job in milliseconds.
The unique identifier for this process instance.
The correlation id for this process instance.
The configured Business Start date and time.
Example: 2012-10-01 23:42:37
The configured Business End date and time.
Example: 2012-10-01 23:42:37
The unique id of the parent (or calling) process.
The BW job id for this instance.
machine
name
The server name this process was executed on.

Example: vsltibbw01.domain.com
rawmessage
The original log event (XML String)
Note: all tokens are case sensitive! All settings listed above must be used in lower case, but for
an activity or attribute name. If an activity or attribute name is using mixed case, the exact case must
be used in the template text, too.
| 26
Working with Monitored Objects

Overview
The TIBCO BWPM Server GUI is designed to efficiently search for historic and current process
instances executed across a TIBCO BWPM instance. After logging in the user is presented a working
area, divided into few sections:
Each section, but the header section containing the time window toolbar, can be resized, collapsed
and expanded by dragging the dividers between the sections, or clicking on the
icons in the
middle of the dividers.
At the top of the screen the time window selection toolbar is located. It is used to easily set the time
window the user wants to query data within. Everything displayed by the TIBCO BWPM Server GUI is
constrained by the time window selected here! Shortcuts to conveniently select frequently used
time windows (i.e. today, last 24h, last week, 1h back / forth, etc) are available, too:
At the very left side of the screen the user can select from various categories: Technical View (which
contains the Domain Object Tree), Business View (which gives easy access to registered business
objects and services in BWPM) and Administration (if the user is a member of the admin role). The
screenshot below shows the Domain Object Tree inside the Technical View category.
| 27
Depending on the selected category, the right part of the page will change and present additional
information to the user.
The Technical View and Business View allow searching, filtering and reporting on domain objects, or
processes executed by any such domain object.
The Administration category enables a BWPM administrator to configure the TIBCO BWPM instance,
for example adding users or additional data providers. Please refer to the TIBCO BWPM Server
Administration Guide for additional information about this category. This category will not be shown
to users that are not member of the admin role.
A typical workflow when interacting with the TIBCO BWPM Server GUI is as follows:
A user logs in to the system. Depending on the roles the user holds and his personal settings the
initial layout is rendered and displayed. The user will choose the time window (1) to search data
within (default: most recent 60 minutes), and limit the scope of the search to a set of domain objects
by clicking on a node in the domain object tree (2). If the user is only interested into processes of a
certain state, for example error, he will select one or more of the status filter buttons (3).
Any of these interactions with the TIBCO BWPM Server GUI triggers a new search. The search results
are displayed immediately in the Main Table (4) at the center of the screen. The user may select any
of the records displayed and be presented additional information about the record and its context.
| 28
At the far right side of the screen, process instances sharing the same Correlation ID with the
selected record of the Main Table are listed (5). Each record can be expanded to show the
intermediate events that may have been recorded during the execution of the process instance.
Additional information about the selected process instance or event record is displayed at the
bottom right part of the screen, the Details Table (6).
Using the GUI

Main Table
Search results are displayed in the center table, called Main Table. The Main Table lists all process
instances that match the search and filter criteria entered by the user (time window, domain object,
status, and filter text). The Main Table offers various ways to the user to interact with it; sort, search,
and filter to eventually find a specific record or process instance.
The user can set the amount of records to be displayed (and loaded into the browser) per page, using
the control marked with A in the screenshot below. The two buttons at G allow the user to flip
back and forth through the result set.
| 29
The list can be filtered by entering a filter text into the text box B. Any record matching the filter
will be displayed. You can use ! to negate a token; wildcards are not supported. The filter is case
insensitive. It is applied to all records of the result set, not only the ones displayed in the Main Table.
Also, it filters on all properties and attributes associated with the record or process instances (it acts
like a full text search on every property and attribute).
Examples:
11:00:00 will find all records that either started or ended at 11:00:00
!success will find all records that are NOT of status success
!success 2012-07-10 order A7104201 will find all records that are not of
status success, have been created on July 10th 2012, have an attribute of name order and a
value of A7104201.
At the bottom of the table, a numeric summary is displayed, showing the total result set size, the
amount of filtered records and the amount of matching records.
A matching record, listed in the Main Table, shows the following information (in order):
| 30
Correlation Status: if process instances share the same Correlation ID, they are correlated.
The Correlation Status is an indicator of that (a) the process instance is correlated with other
process instances and (b) what the most severe status of the correlated processes is (green:
all correlated processes are of status success; yellow: at least one correlated process is of
status warning; red: at least one correlated process is of status error). You can click on the
Correlation Status icon to expand the list of correlated processes (E).
Process Status: the icon shows the current status of the process instance. It can be: running,
success, success with warning, success with error, warning or error.
Process Path: this is the URI of the process definition within its execution engine. For
example: if the process is executed within TIBCO BusinessWorks, the Process Path shows the
exact location of the process definition within the TIBCO BusinessWorks project.
Process Name: this is the name of the process definition this instance has been derived from;
if the process instance has custom attributes, the first two attributes (in alphabetical order)
are displayed right below the process name. If more than two attributes are available for this
process instance, a hint is displayed. To show all attributes, select the record and check the
Details Table.
Job Start: the timestamp of when the job was started by its execution engine
ms: the execution time of the process in milliseconds
The displayed columns can be selected using the column selector, located at the top right of the
Main Table:
The information is shown for correlated processes, too, but for the Correlation Status, which is not
available on correlated processes.
Click on the Correlation Status icon to expand a record and show the correlated processes.
Correlated processes (including the very process instance that just has been expanded) are shown
sorted by job start and in ascending order. In other words: the correlated process with the oldest job
start is at the top of the list, the most recent at the bottom. The sort order of correlated processes
cannot be changed. The expanded record is embedded into the list and surrounded by a blue border,
for better visibility:
| 31
Whenever a process instance is selected in the Main Table, the Event Table or Process Diagram,
Details Table and Domain Object Tree are updated:
The Event Table will list all correlated processes (as if the process instance was expanded in
the Main Table itself) and highlight the selected process instance.
If, instead of the Event Table, the Process Diagram is visible, it will be updated with a
graphical representation of the very process definitions version that was active when the
process instance was executed:
| 32
The Details Table at the right bottom of the screen is updated to display properties and
attributes of the selected process instance:
And, finally, the Domain Object Tree will expand and mark the process definition, which the
selected process instance was derived from.
| 33
This allows the user to rapidly navigate through the process instances and find the information he is
searching for.
Event Table
The Event Table is located at the right top, next to the Main Table. To show the Event Table, select
the Events tab. When a record of the Main Table is selected, the Event Table will list all processes
correlated with the selected Main Table record, including the very record itself. The processes are
listed in ascending order of their start date and time.
The Event Table cannot be sorted or filtered.

From left to right the Event Table shows the following information:
Event indicator: If a process instance has recorded intermediate (BWPM) events, a gray
triangle is shown in front of the record. Click on the triangle to expand and collapse the
records, showing and hiding the recorded events.
| 34
Process status / Event severity: the icon represents the status of the process instance, as
recorded in the BWPM database. The status is identical to the status shown in the Main
Table for this process instance.
For BWPM Events the status icon represents the events severity, which is any of:
informational, success, warning or error.
Name: for processes instances the name of the process definition is shown. The meaning is
identical to the Process name column of the Main Table.
For events, the name of the activity recording the event is shown.
Message: available for events, only. The log message a short descriptive text of the logging
event is displayed here.
Event Date and Time: the timestamp of when the event was created
Log data / Stack Trace: these two columns will show icons, if additional data (logged data or
stack trace) is available for an event. Click on the icon to display the data.
When the user clicks on an event row, the Details Table is updated to show the data related to the
very event.
Process Diagram
The Process Diagram is located at the right top, next to the Main Table. To show it, select the
Process Diagram tab. The Process Diagram is a visual representation of the process definition a
user selected: when the user selects a Process from the Domain Object Tree, the most recent process
definition available within the selected time window (see time window toolbar at top of the screen)
is shown; when a user selects a record of the Main Table, the process definition used for the selected
record is shown.
If no process definition can be found in the database, a dummy graph is shown.
When the user selects a record of the Main Table, the process definition will show additional
information:
The execution path of the process instance is highlighted in green

The currently executed activity is highlighted in yellow
An erroneous activity is highlighted in red
All activities with active trace points have a bright yellow marker above them
All activities with trace data show a yellow envelope icon above them
For more information on how to interact with the Process Diagram, see chapter Process .
Details Table
The Details Table is located at the right bottom of the screen. Select the Details tab to show it.
Whenever the user selects a process instance in either the Main- or the Event Table, the Details
Table is updated to display more detailed information about it.
The list starts with the custom attributes a developer may have configured when using the BWPM
Client; typically they will represent valuable business related information, such as Customer Number,
Purchase Order Number or similar.
| 35

Below the attributes list all built-in properties of the process instance are shown. In particular the
following properties are listed:
Business Service
Business Object
Job Start
Job End
Duration (in milliseconds)
Machine Name (server the process was executed by)
Job ID (i.e. TIBCO BusinessWorks job id)
Log ID (a GUID identifying this record)
Correlation ID
Parent Log ID
The list can be filtered using the Search text field at the top right; sorting is not possible.
Domain Object Tree

BWPM organizes (technical) resources hierarchically. At the top of the hierarchy the name of the
TIBCO BWPM instance is shown. The next deeper levels are called Domain, Deployment, Engine and
Process. From here on those levels will be referenced as Domain Objects, as they represent
manageable objects within the TIBCO BWPM instance. The taxonomy will be referenced as Domain
Object Tree (short: DOT) from here on.
Where possible, the taxonomy will match existing concepts of the monitored technology. For
example: if BWPM is used to monitor TIBCO BusinessWorks Domains, the taxonomy will match the
taxonomy of the TIBCO BusinessWorks Domain (best effort).
Interacting with the DOT automatically updates the search criteria, and hence update the Main
Table. When a node is selected, the search will only return process instances of the selected domain
object and all its children. For example, selecting the root node will return all process instances
| 36

stored in the TIBCO BWPM instances database that match the selected time window (see the time
window toolbar at top of the screen) and status (see status filter buttons above the Main Table).
Selecting a Deployment node will limit the search to process instances of that deployment.
The DOT is color coded: gray entries have not had any process executions within the selected time
window; hence a search for those domain objects would return an empty result. Hovering the mouse
cursor above a gray entry will display a tooltip with the last recorded activity time of that domain
object.
Colored entries had process executions within the selected time window; a search may return
results.
The DOT can be filtered by using the text box above, or the DOT Filter Buttons next to it:
| 37
When entering a filter text, the DOT is reduced to elements matching the entered text. Nodes with
no matching children are removed from the tree. The DOT Filter Buttons can be used to further alter
the number of nodes displayed:
Show starter processes. A starter process is a process definition that can be
instantiated by an external event, such as Timer, JMS Messages or web service
calls. Starter processes have a little green triangle in their icon. When this filter is
selected, all sub process definitions are hidden from the tree.
Show active processes. When selected, all grayed out entries are removed from
the tree; only process definitions that have been executed within the selected
time window are displayed.
Shorten path names (only show the first letter of each directory in the project
path). A tooltip will still show the full path of the process definition, for
convenience.
Use the filter text and button to quickly reduce the amount of domain objects displayed, or find a
specific domain object by name more easily.
Searching for Process Instances

Searching for a process instances will always follow a certain pattern:
First, set the time window to search within; remember that everything displayed in the
TIBCO BWPM Server GUI is constrained by the time window selected at the top of the
screen!
Second, chose the domain object to find instances of
Third, decide on the status to search for to further limit the result set
Finally, use the filter and sorting features of the Main Table to track down on a particular
record.
All search results are compiled by taking the following aspects into consideration:
Access rights ( read access on domain objects granted to the user)

Time window
| 38
Selected domain object

Status
Filter text (Main Table)
The following chapters will discuss each of the steps outlined above, and the available search options
in more detail. Reading them carefully will enable the user to efficiently retrieve any information
from the TIBCO BWPM instances database he may be interested in.
By Time
Every query triggered by the user is constrained by at least two properties: the users privileges and
the selected time window. While only an administrator can grant and revoke a users privileges, the
user can control the time window to search within. As a rule of thumb, the more precise the time
window is chosen (the smaller it is), the faster the query is executed and results are presented on the
screen.
Using the Time Toolbar

To set the time window, the user must use the time window toolbar at the top of the screen:
The toolbar has ten buttons and two date picker fields. The field to the left is the from date and
time, the field on the right the to date and time; a search will only return results from between
these two dates. The from date must always be set, while the to date field is allowed to stay
empty, in which case the to date is interpreted as now. After setting the time window, a click on
the very right button will start the search. Note: changing the time window using the date pickers
alone will not trigger a search automatically. The user must click on the Search button!
The remaining nine buttons (seven to the left, two to the right of the date picker fields) allow quickly
selecting a predefined time window and triggering a search instantaneously (when using the buttons,
the Search button does not need to be pushed to trigger a search):
From 0:00 to current time; the number
inside shows the current day of month
Last 24 Hours
Start search
Last 48 Hours
-1 Hour
Last Week
+1 Day
Last Month
+1 Hour
-1 Day
The default behavior of the toolbar is to set the from date to now minus 60 minutes when the
user logs in, and leave the to date blank. Consequently the initial result set shown in the Main
Table right after login will show the process instances with a start date within the most recent 60
minutes.
| 39

A search triggered by this toolbar also updates the DOT on the right side. Nodes will be colored or
grayed out, depending on their recorded activity in the defined time window.
Using the Trend Chart

The Trend Chart is another option to narrow down the time window and reduce the result set
further. The Trend Chart is hidden at the very bottom of the screen. Click on the
icon at the
bottom of the screen to open and close it.
By default the chart shows the amount of total processes (belonging to the selected domain object),
grouped by process state (running, successful, warning, error), as well as their average duration. The
chart only displays information within the selected time window.
The user can show / hide various series and drill down into the chart by dragging the time selectors
at the bottom of the chart. Any change to the time selectors will automatically update the from
and to date of the time toolbar and filter the Main Table; the Main Table will only show records
that match the new from and to dates:
A typical usage scenario is that a user may see a peak in average duration or recorded errors. By
simply drilling down into the affected time window, the Main Table is filtered. Now the user can
inspect the individual records for root cause analysis.
By Taxonomy
Using the Technical View and the Business View a user can limit the scope the search easily. The
Technical View contains the Domain Object Tree, a hierarchical representation of all monitored
Domain Objects. Selecting any node of the DOT limits the scope of the search to the selected Domain
Object and its children.
The Business View allows limiting the scope of the search by using business terms. Each process
instance that is associated with a defined business object or business service can be found easily,
regardless of where it was executed technically (which domain, deployment or process definition).
| 40
Using the Technical View

The Technical View shows a representation of all monitored Domain Objects, hierarchically organized
and limited by the users privileges the Domain Object Tree. Only Domain Objects the user has
been granted read access are shown.
To retrieve all process instances recorded in the BWPM database, the user would simply select the
root node of the tree. Navigating down the tree, the scope can be reduced to individual domains,
deployments, engines and process definitions. Every click on a node in the DOT triggers a new search,
so that the Main Table will continuously adjust to the selection the user makes.
Using a color code the DOT indicates Domain Objects activities. If a node is grayed-out, the Domain
Object had no activity within the given time window. Placing the mouse cursor above a gray node will
display a tooltip with the timestamp of the most recent activity of this Domain Object.
The additional filtering and display options are discussed in the chapter Fehler! Verweisquelle
konnte nicht gefunden werden..
Using Business Service and Business Object

The Business View allows narrowing down the search using business terms, rather than technical
vocabulary. While the processing of for example - an invoice will technically happen within a
certain engine, that belongs to a deployment that belongs to a domain, a business user may (and
should) not be bothered with that technical details.
| 41

The TIBCO BWPM Server GUI allows users to search by business terms, such as Invoice or Mail
Service. The prerequisite is, however, that developers make use of this BWPM feature during the
design phase of the application.
Working with the Business View is almost identical to working with the DOT. The tree can be filtered,
and selecting a node will search for matching process instances in the BWPM database.
Note: the Business Objects and Business Services presented to the user are constrained by the
privileges granted to the user!
By Status
In most cases a user of the TIBCO BWPM Server GUI is interested in processes of a certain state,
while the other states may be safely ignored for the time being.
Using the Status Filter Buttons

The Status Filter buttons next to the QuickSearch bar allow constraining the search by process status.
The user can select any combination of success, warning, error or running; selecting none or all filters
will return processes of all states.
Every click on the Status Filter buttons triggers a search and the Main Table is updates accordingly.
Using the Reports Page

When navigating using the Technical View or the Business View the user can chose to either see the
Main Table or a Reports Page for the selected Domain Object(s). The reports page can be reached by
selecting the Reports tab of the main working area.
When opening the Reports Page the user is presented a pie chart. The chart shows the distribution of
process state for the selected Domain Object (inner circle), and the distribution of that state for the
next lower element in the hierarchy.
For example:
| 42

When the user selects a Domain from the DOT, the pie chart will show the total amount of processes
in their final state within the selected time window in the inner circle and the amount of process
instances for a particular state within the Domains Deployments. See the screenshot below for an
example:
The user can drill down into the pie chart by clicking on any of the slices. Clicking on a slice of the
inner circle will narrow down the search by status. For example: clicking on the (very thin) yellow
slice (just left of the red Error slice), will adjust the search to only report on processes of state
Warning.
A click into a slice of the outer circle will limit the search by status AND next deeper domain object
type. For example, clicking on the green ESBEngine slice of the outer circle will drill down into the
ESBEngine Domain Object (of type Deployment) AND status success.
The Status Filter buttons and the Domain Object Tree will adjust accordingly with the clicks into the
pie chart.
| 43

The pie chart can be exported into various graphical formats using the export in the top right corner
of the chart.
QuickSearch
The QuickSearch bar is a complex, yet powerful tool to most rapidly narrow down the search for
process instances. It allows the user to custom build a search query; the wizard-like QuickSearch bar
will suggest search values based on the set time window and the search criteria entered so far. Only
valid combinations that would actually return a non-empty result set are suggested by the wizard.
The following key words are supported by this control:

Name
Type
Wildcard Description
Attribute
Attribute
No
The name of a custom attribute. Only process instances

that have this attribute set will be returned by the search.
If this keyword is directly followed by the keyword
Attributevalue, the search will return only process
instances where an attribute of the given name has the
value given for Attributevalue.
Attributevalue
Attribute
Yes
The value of a custom attribute. Only process instances

that have an attribute (of any name) set to this value are
returned. If this keyword is directly preceded by the
keyword Attribute, the search will return only process
instances where an attribute of the given name has the
value given for Attributevalue.
CorrelationLogId Property
Yes
Return process instances that have this property set to

the given value.
Deployment
Taxonomy No
Return all process instances of this domain object (and its

children).
Domain
Taxonomy No

children).
Engine
Taxonomy No

children).
EventCode
Event
property
Searches and returns process instances that have at least

one associated event with the given EventCode. Very
helpful to search for custom error codes set by the
developers of the process definitions.
Yes
| 44
EventMessage
Event
property
Yes
Searches and returns process instances that have at least

one associated event with the given EventMessage. Very
helpful to search for custom error messages set by the
developers of the process definitions.
ExternalLogId
Property
Yes

the given value.
JobId
Property
Yes

the given value.
LogId
Property
Yes

the given value.
Object
Property
No
Return process instances that belong to the given

Business Object. For example: return all Invoice
records.
ParentLogId
Property
Yes

the given value.
Process
Taxonomy No

children).
Service
Property
No
Return process instances that belong to the given

Business Service. For example: return all Email Service
records.
Status
Property
No

the given status.
Wildcards are allowed for the keywords Attributevalue, CorrelationLogId, EventCode, EventMessage,
ExternalLogId, JobId, LogId, and ParentLogId:
* matches any sequence of characters

? matches exactly any single character
To use the QuickSearch bar, start typing the keyword you want to use. The control will automatically
suggest matching keywords. Once you selected a keyword, the available values are presented in a list
box to select from. The system narrows down the available options by only showing values that
match the time window and already entered search criteria!
For example: if you have already picked a Deployment and want to add the Attribute keyword, only
attribute names that actually exist within the chosen Deployment are displayed! Or, if you have
chosen an Attribute, only Deployments will be suggested that actually have matching process
instances.
| 45
With Attribute and Attributevalue being the only exceptions, keywords of the same name are
combined in the search using a logical OR, while keywords of different names are combined using a
logical AND. Attribute and Attributevalue are always combined using AND.
Examples:
Search for processes that have been executed in either of the two deployments:
Search for processes that have been executed in the given deployment and have an attribute of
name Order No:
The following sample will search for processes that have been executed in the given deployment and
have an attribute of name Order No and its value starting with B79:
See a sample result set for the above query in the below screenshot:
| 46
If a valid search returns an empty result set (for example: the user searches for a LogId that is not
known by the system), the QuickSearch bar will flash red, once.
Interacting with Process Instances

The previous chapters have discussed how to find particular process instances; the following
chapters discuss how to work with the result of the search. They introduce additional views and
controls of the GUI, which present additional and detailed information about the process lifecycle.
Some of them allow to interact with the execution engine to get even more information from future
executions.
Process Context
A process always has a context associated with it. The context describes the state of the environment
the processes was executed within; knowing the context allows the user to better understand why
the process performed the way it did, and whether a similar behavior can be expected in future,
similar situations.
The most obvious context information is the execution time of the process: when did it start, and
when did it end. Its location within the taxonomy defines the context further; it provides
information about the Domain, Deployment and Engine the process was executed within.
The final major context information is the Correlation Status. This status indicates how well the endto-end processing chain performed. See the screenshot below:
| 47
At first glance, the second process from the top seems to be OK. However, its Correlation Status is
red, which means somewhere in the processing chain an error was recorded. The record has been
expanded in the screenshot, so it becomes obvious that during the SAP processing an error was
thrown. The user may now drill down into the correlated processes to better understand what
caused the error and what the consequences were.
The experienced user is able to not only understand what happened to a small piece of the
processing chain (an individual process), but is hinted on jeopardy situations along the processing
chain. This reduces the effort for analyzing erroneous situations significantly.
Process Data
During its lifecycle each process collects data; data that describes how well a process performed
(technically and business wise). The BWPM system knows about the following data categories:
(built-in) Properties: these properties always exist for every process instance monitored by
BWPM. They include the jobs start and end timestamps, a number of IDs and other
information, for example about its location in the taxonomy.
Custom Attributes: by configuration an administrator or developer can add attributes to a
process instance that hold valuable information. Typically that information is taken from the
(business) data processed by the process instance.
(Log) Events: by design a developer can add Log Events to a process; any such event
provides information about the state of processing, and may set the final state of the
process. An event can be used to set or update attributes and process state. They are also
used to generate the fourth category of data:
Log data: Log data are more complex data structures than attributes. For example: a
complete invoice can be logged by an event and stored as Log Data. Since this data often is
the original payload of a business transaction, it commonly is sensitive data. To view Log Data
the user must have the Data privilege.
| 48
Process Diagram
Whenever a Process Definition in the DOT or an entry of the Main Table is selected, the Process
Diagram of the associated Process definition is shown. The process diagram is an exact
representation of the original Process Definition as implemented by the developer.
BWPM maintains all historic versions of a Process Definition. This allows the TIBCO BWPM Server GUI
to display exactly the version of the Process Definition that was used by the execution engine for the
very selected process instance. In case the user selects the Process Definition directly from the DOT,
the most recent version within the selected time window is displayed.
The Process Diagram has a toolbar (A) for navigating within the graph (zooming, moving the
process stack). The Process Diagram area can be expanded to full screen and collapsed to original
size using the Resize button B. The name of the Process Definition is shown in the top left corner of
the diagram (C). When a process instance was selected (from the Main Table), the transitions
between the activities are colored green to show the exact process flow for this very instance. If the
process encountered an error while executing, the erroneous activity is highlighted in red (E);
activities selected by the user for further inspection are highlighted in green (D). Iteration groups
can be inspected per iteration by using the back and forth buttons in the header of the group
element (F). Finally, the section G below the Process Diagram displays more detailed information
about the process instance or the selected activities.
| 49
The user can interact with the Process Diagram in many ways:
Drag the process diagram to inspect all areas of it

Zoom in / out of the Process Diagram using the menu buttons (A) or mouse wheel
Select an activity to display its trace data, configuration, and input mapping
Iterate through iteration groups to see the individual execution paths for each iteration
Zoom in
Zoom out
Fit to window
Show previous process
Show top level process
Section G shows trace data and an activities exact configuration.

As shown in the process diagram above, when the user selects an activity (i.e. Send HTTP Request),
the tabs right below the process diagram will show additional information about the activity.
Activity Configuration
The Configuration tab shows the activity icon and name, a (optional) description the developer
may have entered, and the elapsed and CPU time of the activity for this very process instance. The
table next to this information shows the exact configuration of the activity for information.
| 50
Process and Activity Trace Data

The Trace Table tab lists all available trace data with timestamp, activity name, whether it was
input or output data and the trace data itself. Selecting an activity of the process diagram filters the
list to only show trace data records of the selected activity. If the activity is within an iteration group
and has been executed multiple times, the list is filtered to show only the trace data records for the
given activity and the selected iteration:
To inspect the concrete trace data, click on the far right icon of the trace data record. The payload is
displayed and formatted in a new dialog; it can be downloaded from within the dialog by clicking on
the top left Download link:
Input Mapping
To investigate the input mapping configuration of an activity, select the Mapping tab. The tab
shows the exact mapping rules for this activity, as designed by the developer.
| 51
Input and Output Data

The two final tabs available for the Process Diagram are Input Data and Output Data. If trace data has
been collected for an activity, these tabs show the formatted input and output data for the selected
activity.
This view is very useful, when an activity has been executed multiple time within an iteration group,
since the data updated automatically, when the user flips back and forth through the iteration group.
The user can easily see the data entering and leaving the activity for every single execution.
Example of Output Data:
| 52
The Activity Menu

When the user moves the mouse cursor above an activity in the Process Diagram the Activity Menu
appears. This menu allows the user to get additional information for the activity, and manage its
trace settings.
| 53

The first icon of the Activity Menu opens a window showing historic performance information about
the activity: minimum, maximum and average elapsed time and CPU time, as well as execution count
series are shown. This allows the user to put the current performance metrics of the activity into
perspective.
The second icon opens the Trace Settings dialog. In this dialog the user can enable or disable a trace
point and set its expiration date and time. By default a trace point expires 15 minutes after it has
been enabled; this dialog, however, enabled the user to set the trace points expiration date to any
future date. The user requires the Manage privilege on the Domain Object to update the trace
settings.
The third icon, the warning sign, is reserved for future releases of TIBCO BWPM Server GUI and not
available in this release.
The fourth icon is the Trace Point Status Indicator. If tracing is active for an activity, the indicator will
shine yellow and is always visible on top of the activity even if the Activity Menu is not shown. The
icon can be clicked upon to enable tracing for 15 minutes, or switch it off (Manage privilege
required).
The Trace Data Indicator is the fifth icon. Like the Trace Point Status Indicator is will shine (orange)
and be always visible above the activity, if trace data has been collected for this activity and the
currently selected process instance.
The last icon of the menu is only available on sub process activities. Clicking on the icon will drill
down into sub process definition. The sub process shown will always be the exact sub process that
has been executed at this stage in the process execution. That means, even if the sub process to
execute is computed dynamically, the user can rely on that the correct process definition is shown.
Also, all other information displayed in the graph and bottom tables do show precisely what
happened in the called process.
Below is a table summarizing the menus icons:
Statistics of the activity
Manage tracepoint (status, duration; requires manage privilege)
Warnings (for future use; not available in this release)
Tracepoint status indicator (changing required manage privilege)
Managing Aspectsn (see below)
Trace data indicator (yellow, if data is available)
Drill down into subprocess
Aspects
Note: managing Aspects requires the user to have manage privilege on the specific process
definition.
Aspects allow to instrument process activities non-intrusively and without downtimes of the engine
anywhere during a process execution. Using an aspect, the user can choose to add a log event (and
effectively update the log status of a job), set log context properties, such as correlation id and
others, and add custom attributes to the log, which can be searched by using the QuickSearch bar.
| 54

To manage aspects open the Aspect configuration dialog by clicking on the aspects icon in the
activity menu:
This opens a dialog for the aspects configuration. The dialog is separated into four sections:
In section Add Event (1) a log event can be generated, which will use the selected log level
and set the process status accordingly. The name of the event will be Declarative Event, so
that the user can easily distinguish between events generated by activities or aspects in the
event table.
Section Properties (2) allows defining regular expressions to extract data from the activitys
output data and assign the result to the mentioned built-in properties: Business Service,
Business Object, Correlatio0n ID, External ID and Parent ID. Leave a field blank to not activate
this feature for any given property.
Custom Attributes (3) allow defining an arbitrary amount of extra attributes to add to the
process log, and set their values by applying the given regular expression to the activitys
output data. Note: when custom attributes are configured, an event of severity Info will
automatically be added to the process event log (unless the user has defined a higher
severity using Add Event). Attributes created this way are associated with that event.
The button area lets the user save or delete the settings, or cancel the dialog (not applying
changes).
| 55
When an aspect is defined for an activity the process graph will show the Aspect icon as an
annotation on top of the activity:
Aspects are versioned. That means, the current aspect configuration for a process definition can be
inspected by first selecting the process definition from the DOT in the technical view. Historic settings
are available when a process entry is selected in the center table. The aspect configuration shown in
the latter case matches the configuration that was active when the process was executed.
| 56
Data retention
Data stored within the BWPM database will automatically be deleted after it has expired. By default,
BWPM stores different type of data for a different period of time. The shortest (default) retention
period is for trace data (7 days), followed by track data (14 days) and event and process data (30
days).
A user with manage privilege for a domain object can configure the retention period easily by
selecting the corresponding domain object from the DOT and selecting the Administration tab,
which is displayed next to the Main View and Reports tab.
To change the retention period, simply update the values listed and click Save settings. The data
will be deleted during the next run of the data management job (a database job that frequently
purges expired data).
| 57
Glossary
Term
Definition
Business View
Business View is organized by functional, business related classification:

Business Services, Business Objects
Correlation Status
Status of the entire chain of correlated log entries
Data Provider
A data provider consists of a connection to a message server and a

destination
Details Table
The Details Table contains detail information of a main or event entry

(e.g. attributes, properties, etc.)
The Domain Object represents a technology based classification.
Domain Object
Domain Object Tree
The Domain Object Tree represents the hierarchy of the Domain

Objects
Event Table
The Event Table contains specific log events per process instance. For
example an error event indicates that during execution of a process an
error occurred. The error event also might contain additional stack
trace information for analyzing the failure.
Main Table
The Main Table contains logging information concerning process

instances. Each process instance creates an entry in the Main Table.
Instance
Represents the combination of various components that are interacting

together within one environment.
Process Diagram
The Process Diagram shows the process definiton and the track of the
process instance according to the selected main log entry
Process Instance
A Process Instance is the execution of a process definition. Each Process

Instance can be identified by a unique identifier.
Quick Search
The Quick Search allows you to search for specific log entries very
easily.
Technical View
Hierarchical view organized by technical classification
Tracepoint
You can define Tracepoints at specific positions within your process

definition in order to collect additional logging information during
runtime execution
Track
Track is the actual route of a process instance
| 58

TIBCO BWPM Server User Guide 2.0

Загружено:

Сведения о документе

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

TIBCO BWPM Server User Guide 2.0

Загружено:

Авторское право:

Доступные форматы

TIBCO ActiveMatrix BusinessWorks

Process Monitor Server

TIBCO BWPM instance

TIBCO BWPM Server

Tomcat Servlet Container

TIBCO BWPM Clients

Starting TIBCO BWPM Server

Starting TIBCO BWPM Server on Windows

Starting TIBCO BWPM Server on UNIX

Stopping TIBCO BWPM Server

Manage Users and Roles

Adding and Deleting Users

Granting and Revoking Permissions

Adding and Deleting Roles

Granting and Revoking Permissions

Granting Access to Domain Objects

JMS Message Action

Create Task Action

Working with Monitored Objects

Using the GUI

Domain Object Tree

Searching for Process Instances

Interacting with Process Instances

TIBCO BWPM Server User Guide

TIBCO BWPM Server User Guide

TIBCO BWPM instance

TIBCO BWPM Server User Guide

TIBCO BWPM Server User Guide

TIBCO BWPM instance

BWPM Instance Development and Test

TIBCO Administration Domain

TIBCO Administration Domain

TIBCO BWPM Server

TIBCO BWPM Server User Guide

Tomcat Servlet Container

TIBCO BWPM Clients

TIBCO BWPM Server User Guide

Starting TIBCO BWPM Server

Starting TIBCO BWPM Server on Windows

Open the web browser and navigate to the following URL:

TIBCO BWPM Server User Guide

Starting TIBCO BWPM Server on UNIX

Open the web browser and navigate to the following URL:

TIBCO BWPM Server User Guide

Stopping TIBCO BWPM Server

TIBCO BWPM Server User Guide

Manage Users and Roles

TIBCO BWPM Server User Guide

Adding and Deleting Users

TIBCO BWPM Server User Guide

Note: the admin user cannot be deleted.

Granting and Revoking Permissions

TIBCO BWPM Server User Guide

TIBCO BWPM Server User Guide

TIBCO BWPM Server User Guide

Adding and Deleting Roles

Note: the admin role cannot be deleted.

TIBCO BWPM Server User Guide

Granting and Revoking Permissions

TIBCO BWPM Server User Guide

TIBCO BWPM Server User Guide

Granting Access to Domain Objects

TIBCO BWPM Server User Guide

TIBCO BWPM Server User Guide