IBM Web Services Navigator
An Eclipse/RAD plug-in for interactive visualization of Web service transactions.
Date Posted: December 2, 2004
|
|
 |
 |
|
 |  Open views can be displayed by clicking on their tabs at the top of their pane.
Open views can be rearranged within the Eclipse window by clicking on their tabs and dragging them. For more information about rearranging views, please refer to the topic "Rearranging views and editors" in the Eclipse "Basic Tutorial."
To close a view, click on the X icon in its tab at the top of the view.
To open or re-open any of the IBM Web Services Navigator views, follow these steps:
- On the Eclipse menu bar, select Window -> Show View -> Other....
- In the Show View window, expand Websight, select one or more views, and click on OK.
| | |
 |  The Service Topology view shows a schematic diagram of the Web services involved in the log and the message flows between them. The blocks represent individual Web services, and are labeled with the names of the services, the names of the machines that host the services, and the names of the operations the services provide. The colors of the blocks indicate different host
machines. The arrows between blocks represent Web service requests and are labeled with the number of requests in the log.
The Service Topology view provides additional information when the cursor is moved over these objects:
- service blocks
- message arrows
| | |
 |  A message can be selected by clicking on its arrow with the left-hand mouse button. The selected message will be highlighted in yellow in the Service Topology view, as well as in the Transaction Flows view. If the Link with other views icon of the Message Content view is active, the Message Content view will automatically be updated with the contents of the selected message.
| | |
 |  The Service Topology title bar contains these controls:
- move node icon (cursor and solid rectangle): When this control is active, you can move service blocks around on the pane by dragging them with the left-hand mouse button.
- select zoom icon (cursor and dotted rectangle): When this control is active, you can zoom in on any area of the view by dragging a rectangle around it with the left-hand mouse button.
- zoom in icon (magnifying glass containing +): When this control is active, you can zoom into the view by clicking on the left-hand mouse button.
- zoom out icon (magnifing glass containing -): When this control is active, you can zoom out from the view by clicking on the left-hand mouse button.
- Home icon: When this control is selected, the view is automatically zoomed in or out to fit everything into the pane.
| | |
 |  The Service Topology view has a pop-up context menu that will be displayed when the right-hand mouse button is clicked on.
Hide Operations: When this option is disabled, operation names will be displayed in service blocks below machine names. When this option is enabled, operation names will be hidden. This option is disabled by default.
| | |
 | 
When the screen focus is in the Service Topology view, the following keyboard short-cuts are available:
"<" key (less-than symbol)
"," key (comma symbol)
When these keys are pressed, the vertical scale is compressed by one-third.
">" key (greater-than symbol)
"." key (period symbol)
When these keys are pressed, the vertical scale is expanded by one-third.
"+" key (plus symbol)
"=" key (equal symbol)
When this key is pressed, the view is zoomed in by one-third.
"-" key (minus symbol)
"_" key (underscore symbol)
When this key is pressed, the view is zoomed out by one-third.
"Home" key
When this key is pressed, the view is automatically zoomed in or out to fit everything into the view.
| | |
 |  The Transaction Flows view shows a time sequence diagram of the Web services involved in the log and the message flows between them. The columns represent individual Web services and are labeled with the names of the services and the names of the machines that host them. The colors of the column labels indicate different host machines. Time proceeds from top to bottom: diagonal arrows between columns represent Web service requests and responses; vertical bars represent processing of a request. The colors of the arrows and bars indicate different transactions.
The Transaction Flows view provides additional information when the cursor moves over these objects:
- machine labels
- service labels
- processing bars
- message arrows
| | |
 |  A message can be selected by clicking on its arrow with the left-hand mouse button. The selected message will be highlighted in yellow in the Transaction Flows view, as well as in the Service Topology and Message Statistics views. If the Link with other views icon of the Message Content view is active, the Message Content view will automatically be updated with the contents of the selected message.
| | |
 |  The Transaction Flows view provides three different vertical time scales. To change the vertical time scale, click on the down-triangle in the title bar of the view, select Time Scale, and then select one of the time scale options:
- Time Scale -> Logical Time Scale: In this mode, message flows and business logic will be scaled evenly from top to bottom. That is, the vertical distance between consecutive events will be the same, regardless of how much time each represents. No time scale will be displayed along the right-hand edge of the view. This is the default time scale mode.
- Time Scale -> Linear Time Scale: In this mode, message flows and business logic will be scaled proportionally from top to bottom. That is, the height of each arrow and bar will be proportional to the amount of time it represents. A time scale labeled in seconds will be displayed along the right-hand edge of the view. If the clocks of the machines are not all synchronized, their message arrows and business logic bars may be adjusted up or down so that all messages flow forwards in time. A "double clock" icon will be displayed in machine bars to indicate that this adjustment has been made.
- Time Scale -> Raw Time Scale: In this mode, message flows and business logic will be scaled proportionally from top to bottom. That is, the height of each arrow and bar will be proportional to the amount of time it represents. A time scale labelled in seconds will be displayed along the right-hand edge of the view. If the clocks of the machines included in the log are not all synchronized, their message arrows may appear to flow backwards in time. A "double clock" icon will be displayed in machine bars to indicate that message arrows point backwards in time because the machine clocks are not synchronized.
The Transaction Flows view can highlight patterns of repeated invocations within transactions. To highlight repetitions, click on the Find repetitions icon in the title bar of the view. If the displayed transactions contain any repetitions, a grey rectangle will be drawn behind them, and the rectangle will be labelled with the number of repetitions.
| | |
 |  The Transaction Flows title bar contains these controls:
- select zoom icon (cursor and dotted rectangle): When this control is active, you can zoom in on any area of the view by dragging a rectangle around it with the left-hand mouse button.
- zoom in icon (magnifying glass containing "+"): When this control is active, you can zoom into the view by clicking on the left-hand mouse button.
- zoom out icon (magnifing glass containing "-"): When this control is active, you can zoom out from the view by clicking on the left-hand mouse button.
- Find Repetitions icon (columns of circles and lines): When this control is active, any repeated patterns of invocations will be highlighted with a grey rectangle and labelled with the number of repetitions.
- Home icon: When this control is selected, the view is automatically zoomed in or out to fit everything into the pane.
- Menu icon (down-triangle): When this control is selected, the Time Scale menu is displayed, and one of the three Time Scale modes described above can be selected.
| | |
 |  The "Transaction Flows" view has a pop-up context menu that will be displayed when the right-hand mouse button is clicked on:
- Open Content: This option is active only when the cursor is located over a message arrow. When this option is selected, the Message Content view is displayed with the contents of the selected message.
- Optimal Fit: When this option is selected, the vertical scale is expanded so that all message labels are legible.
- Visible Transactions: When this option is selected, a sub-menu is displayed that lists all of the transactions in the view. Individual transactions can be hidden or displayed, or all transactions can be hidden or displayed. Hidden transactions are displayed in grey and cannot be selected. All transactions are visible by default.
- Hide All Labels: When this option is disabled and there is room for the labels, message arrows are labelled with the name of the message, and the first processing bar of each transaction is labelled with the transaction number. When this option is enabled, message labels and transaction numbers are not displayed. Message labels and transaction numbers are displayed be default if there is room for them.
- Home: When this option is selected, the view is automatically zoomed in or out in order to fit everything into the pane.
- Hide Data Matches: This option is active only when Data Tracking has been enabled in the Message Content view. When this option is selected, data tracking is disabled. Message labels will show message names instead of field names and data values.
| | |
 |  When the screen focus is in the Transaction Flows view, the following keyboard short-cuts are available:
"<" key (less-than symbol)
"," key (comma symbol)
When these keys are pressed, the vertical scale is compressed by one-third.
">" key (greater-than symbol)
"." key (period symbol)
When these keys are pressed, the vertical scale is expanded by one-third.
"+" key (plus symbol)
"=" key (equal symbol)
When this key is pressed, the view is zoomed in by one-third.
"-" key (minus symbol)
"_" key (underscore symbol)
When this key is pressed, the view is zoomed out by one-third.
"Home" key
When this key is pressed, the view is automatically zoomed in or out to fit everything into the view.
| | |
 |  The WS Flow Patterns view shows the different patterns of transactions in the log. Each pattern shown in this view represents one or more trasactions in the log that involve the same sequence of requests and responses between the same Web services. The colors of the arrows and bars indicate different patterns.
The Flow Patterns view provides additional information when the cursor moves over these objects:
- machine labels
- service labels
- processing bars
- message arrows
The Flow Patterns view can highlight patterns of repeated invocations within transactions. To highlight repetitions, click on the Find repetitions icon in the title bar of the view. If the displayed transactions contain any repetitions, a grey rectangle will be drawn behind them, and the rectangle will be labelled with the number of repetitions.
| | |
 |  The Flow Patterns title bar contains the following controls:
- "select zoom" icon (cursor and dotted rectangle): When this control is active, you can zoom in on any area of the view by dragging a rectangle around it with the left-hand mouse button.
- "zoom in" icon (magnifying glass containing "+"): When this control is active, you can zoom into the view by clicking on the left-hand mouse button.
- "zoom out" icon (magnifing glass containing "-"): When this control is active, you can zoom out from the view by clicking on the left-hand mouse button.
- "Find Repetitions" icon (columns of circles and lines): When this control is active, any repeated patterns of invocations will be highlighted with a grey rectangle and labelled with the number of repetitions.
- "Home" icon: When this control is selected, the view is automatically zoomed in or out to fit everything into the pane.
| | |
 |  When the screen focus is in the Flow Patterns view, the following keyboard short-cuts are available:
"<" key (less-than symbol)
"," key (comma symbol)
When these keys are pressed, the vertical scale is compressed by one-third.
">" key (greater-than symbol)
"." key (period symbol)
When these keys are pressed, the vertical scale is expanded by one-third.
"+" key (plus symbol)
"=" key (equal symbol)
When this key is pressed, the view is zoomed in by one-third.
"-" key (minus symbol)
"_" key (underscore symbol)
When this key is pressed, the view is zoomed out by one-third.
"Home" key
When this key is pressed, the view is automatically zoomed in or out to fit everything into the view.
| | |
 |  The Message Content view shows the contents of individual messages. To view the content of a message, select a message in the Transaction Flows view, right-click on the mouse to open the message's context menu, and select Open Source. This will open the Message Content view if it is not already open. The SOAP Envelope in the message is displayed as a tree. The structure of the message is shown by indention, with field names and data values as leaves.
In the initial view, the message content tree is fully expanded. Individual subtrees can be expanded by clicking on the "boxed-plus" icons, or collapsed by clicking on the "boxed-minus" icons. The entire tree can be fully expanded by clicking on the "double-boxed-plus" icon in the title bar, or fully collapsed by clicking on the "double-boxed-minus" icon in the title bar.
The Message Content view can track the flow of data through the transactions displayed in the Transaction Flows view. Data tracking shows which messages in each transaction contain selected data. Data can be tracked through transactions in two ways:
- Exact Data Matches shows messages that contain the selected field name and data value.
- Data Dependency Matches shows messages that contain values similar to the selected data.
Data tracking can be enabled by right-clicking on any row of the message content and selecting an option from the pop-up context menu.
| | |
 |  The Message Content title bar contains the following controls:
- Expand All icon (double box containing "+"): When this control is selected, the current message will be completely expanded.
- Collapse All icon (double box containing "-"): When this control is selected, the current message will be completely collapsed.
- Link with other views icon (left and right arrows): When this control is active, the Message Content view is automatically updated whenever a message is selected in another view. That is, the Message Content view always displays the contents of the currently selected message.
- Menu icon (down-triangle): When this control is selected, the Hide menu is displayed, and one of the message content hiding options can be enabled or disabled:
- Hide Namespace nodes
- Hide SOAP Header
| | |
 |  The Message Content view has a pop-up context menu that will be displayed when a row is selected with the right-hand mouse button:
- Show Exact Data Matches: When this option is selected, the Transaction Flows view will label the messages that contain a field name and data value that is identical to the selected row.
- Show Data Dependency Matches: When this option is selected, the Transaction Flows view will label the messages that contain a data value and/or a field name that is similar to the selected row.
- Hide Data Matches: When this option is selected, data tracking is disabled. Message labels
in the Transaction Flows view will show message names instead of field names and data values.
| | |
 |  In any view (except the Flow Patterns view), a message can be selected by left-clicking on its arrow or table row. The selected message will then be highlighted in yellow in the current view and in all other views. For example:
- Select the Service Topology view, and then select an arrow that represents all of the messages between two Web Services. The selected arrow is highlighted. Then select the Transaction Flows view. All of the corresponding request and response messages are highlighted.
- Select the Transaction Flows view, and then select an arrow that represents a request or response message between two Web Services. The selected message is highlighted (in solid yellow). Then select the Service Topology view. The corresponding arrow is highlighted (in dashed yellow, indicating only partial selection).
When the Link with other views icon in the Message Content view is active, the Message Content view will be automatically updated with the contents of the currently selected message.
| | |
 |  Online documentation for the IBM Web Services Navigator is available in the Eclipse Help system. You can launch the Help system by selecting the following from the Eclipse menu bar:
To open the documentation for the IBM Web Services Navigator, double-click on the following title in the Contents pane:
IBM Web Services Navigator User Guide
and then click on the "boxed plus" icons to expand individual chapters.
A printable version of the online documentation for the IBM Web Services Navigator is available in the included PDF document.
| | |
 |  Eclipse disables the IBM Web Services Navigator if the Eclipse Modeling Framework (EMF) is not installed. Verify that your Eclipse Workbench installation includes the ...\eclipse\features\org.eclipse.emf_2.0.1\ directory. If not, download and install EMF according to the directions in this file:
C:\EclipseWorkbench\eclipse\plugins\com.ibm.websightView_3.0.0\ReadMe.txt
| | |
 |  The EMF distribution file includes the eclipse directory, so it must be unzipped into the parent directory of your Eclipse Workbench installation. If you have the ...\eclipse\eclipse\features and ...\eclipse\eclipse\plugins directories,
then stop Eclipse, move their subdirectories to ...\eclipse\features and ...\eclipse\plugins, respectively, and start Eclipse again.
| | |
 |  The IBM Web Services Navigator requires Eclipse Version 3.0.1, and will not function with Eclipse 3.0.0 or earlier versions of Eclipse. On the Eclipse menu bar, select Help -> About Eclipse Platform and verify that the version number is 3.0.1. If not, download and install Eclipse Workbench 3.0.1 according to the directions in this file:
C:\EclipseWorkbench\eclipse\plugins\com.ibm.websightView_3.0.0\ReadMe.txt
| | |
 |  Some of the views may have been inadvertently closed or moved to unexpected places. To reset the perspective and views to their defaults, go to the Eclipse menu bar and select Windows -> Reset Perspective.
| | |
 |  Navigator view contains icons for traces: green check (loaded) and red X (invalid).
Transaction Flows view:
- Machines are represented in better order for nicer layout.
- Missing events are represented with "dashed" message arrows.
- Details of data tracking matches were added to flyover text.
- Message labels are now shown or hidden automatically.
Flow Patterns view:
- Averages and variations of performance data were added to the view.
- Total, average, minimum and maximum response times were added to flyover text.
- View now includes ability to view flow patterns with Logical or Adjusted Time Scales.
- View now includes ability to select and highlight an individual transaction in flow pattern view.
Message Content view: Data-matching options were added to pop-up context menu (in order to enable this feature, first define the eclipse VM environment variable: com.ibm.websightView.analysis=true).
New Statistics Tables view: Four new statistics tables were added.
| | |
 |  The Emerging Technologies Toolkit (ETTK) is a collection of emerging technologies that are relevant to IBM's emerging software strategies. The ETTK team works with external users to incubate and further develop these technologies so they can be used to create innovative customer solutions. ETTK packages are focused on just a few select technology areas. In a way, you could associate "ETTK"-labeled technologies as being close to "alphaWorks Featured Technologies." ETTK technologies explore new types of applications or address emerging application-, Internet-, or standard-oriented domains. We value your input and want to hear how you would make use of this technology in your environment; please visit the ETTK Blog or ETTK Wiki for additional information. | |
|
|
 |
|
View screenshots:
 |
| |