In Part 3, you learned how to deploy the monitoring for a BPM process application, and how to work with the dashboard that gets automatically generated for it. Now, you will learn how to take that generated dashboard and customize it to meet the specific needs of your particular business users. You will see that you have full control over what data should be displayed, how it is visualized, and how to use the tools in the dashboard to author additional, personalized visibility into how your BPM processes are performing. Specifically, we will see how to specify exactly which fields to display in tables, we'll create our own custom bar chart, a custom gauge, and will see how to get alerted when something goes out of range - all based on data being tracked from a BPM process.Now that you've seen the generated dashboards for a BPM Process App, let's learn how to customize and extend them.
Customize a widget
First, let's learn how to customize a widget.
- Go to the HR Open New Position Instances page in Business
Space, and click Edit Page, as shown in Figure 1.
Figure 1. Editing a dashboard page
- Click the down arrow at the top right of the widget, and choose
Edit Settings, as shown in Figure 2.
Figure 2. Editing settings on a widget
- A dialog displays in which you can pick the columns you'd like to see in this widget. Let's hide some of the metric columns from the table. In the list on the right, you should see a list of Selected metrics. Choose several metrics you want to hide in that list, and click the left arrow to move them from Selected to Available.
- You can also adjust the Refresh rate to control how often the
widget contacts the server to look for new or updated process
instances. The default is once a minute. As shown in Figure 3, change
this to 30 seconds.
Figure 3. Customizing the Instances widget
- Click OK, then click Finish Editing to return the
dashboards to their normal state, as shown in Figure 4.
Figure 4. Completing your customization
Now you can see your BPM process instance data just the way you want!
Figure 5. A customized view of BPM process instance data
Define a new report
Next, let's define a new report by doing the following:
- Add a new Tools page to the space, to hold new widgets you'll
be using. Click the plus icon to the right of the HR Open New
Position Diagrams tab, as shown in Figure 6, then enter
Toolsfor the Page name, and click OK.
Figure 6. Adding a new dashboard page
- Now let's change the page layout so that we have sufficient width for
the widgets we're going to use. Click Edit Page, then click the
to the left of the Save button, and select 1
column, as shown in Figure 7.
Figure 7. Controlling the page layout
- Drag the Report Designer icon from the palette onto the page.
The palette is arranged alphabetically, so you'll need to scroll down
within the palette to find this widget -- or you can start typing the
first few letters of the name of your desired widget (such as
Rep) in the Filter Widgets field, to display only those items containing those characters.
Figure 8. Adding the Report Designer to your page
- Click Finish Editing.
- Using the Report Designer widget, enter a name for your new report,
Hiring by City.
Figure 9. Name the report
- Click Select, and in the Select Package dialog, expand
HiringSample_Main, and select HR Open New Position,
then click OK.
Figure 10. Select your BPM process to report on
- Now that you have selected your package, you will have dimensions and
measures to choose from. Skip over the Specify a dimension,
frequency, and time period for the report section, and under
Select the data you want to include in this report, check
location as the dimension, and Average empNum as the
Figure 11. Select data to include in the report
- You can now preview your report and even drill down in the preview to
see an example of analyzing the average number of employees to be
hired by loation, to make sure you are happy with it before saving it.
Click the Preview button.
Figure 12. Preview your report
- Close the preview, and click Save.
You have just authored a Cognos BI report on your BPM process application!
Customize a report
Now let's add that report to a page and customize it.
- Go to the HR Open New Position Reports page, and click on
Edit Page. Then drag the Report Viewer icon down
from the palette to the drop zone at the top of the page, so that your
custom report will show up first. Choose Edit Settings from the
widget menu at the top right of the widget, as shown in Figure 13.
Figure 13. Edit the Report Viewer settings
- A dialog displays, in which you can choose which report this widget
should show, then click Select.
Figure 14. Select the report to display
- The Select Report dialog displays, in which you can navigate to
the report you selected earlier. Expand Public Folders =>
HiringSample_Main, then click the report under there (it will
show whatever name you gave it in the Report Designer), then
Figure 15. Select report to open
- The report should display. Click Finish Editing to return to the normal dashboard mode.
- Drill down on the location (double-click on the blue bar). Notice as you hover over each bar that information about that bar is displayed.
- Select Save changes for me under Action at the top right
of the widget, as shown in Figure 16, so that you'll see the report in
this drilled-down state whenever you visit this page in the future.
Figure 16. Save changes
Create a KPI
Now let's create a new KPI.
- Return to the Tools page, then select Edit Page
- Add the KPI Manager widget to your page. Instead of dragging, you can just click the plus icon to the right of the icon in the palette.
- Click Finish Editing, to hide the widget palette.
- In the Model drop-down menu, select HiringSample_Main.
- Select Actions => New Aggregate KPI, as shown in Figure 17.
Figure 17. Create new aggregate KPI
- In the dialog that appears, enter
Average Openings per Hiring Request in Atlantain the KPI name field, as shown in Figure 18, then click the Definition tab.
Figure 18. Specify KPI name
- You can look at the aggregation options under the Operator drop-down menu, but leave it the default of Average for this KPI. Then click the … button next to the Metric field to select your desired metric.
- The Metric Selection Tree dialog displays. Expand HR Open
New Position and select empNum, as shown in Figure 19.
Figure 19. Select metric to aggregate
- Click Add under Data filter, so that you can limit this KPI to just employees in Atlanta.
- Select location from the Metric drop-down menu.
- Leave the Operator drop-down at its default value of Equals.
Atlantain the Value field (or whatever location you want to filter on, if you specified different values when running your process instances).
Figure 20. Specify KPI filter criteria
- Click the Range tab.
- Enter a value in the Target field, such as
- Use the Add row button to create new ranges, and name them
2as the Start Value and End Value for the first row.
- Click the color box to pick a green color from the color selector
dialog (or enter
- Repeat for the second and third rows, using 2-4, and 4-6, and the
colors yellow, and red, respectively, as shown in Figure 21.
Figure 21. Enter KPI range properties
- Cick the Other tab.
- Check Decimal place precision, and specify
1in the entry field, then click the Preview tab.
Figure 22. Enter additional KPI properites
- On the Preview tab, you can preview what the KPI would look
like on a dashboard page, and see some details about your new KPI. You
don't need to take any action here, so just click OK when
Figure 23. Preview the KPI
Go back to the KPI Manager widget and scroll until you see your new KPI listed.
Figure 24. New KPI in widget
Use the new KPI
Now, let's go make use of our newly defined KPI.
- Click the HR Open New Position KPIs page, and choose Edit Page.
- Select Edit Settings from the widget drop-down menu in the
upper left of the widget, as shown in Figure 25.
Figure 25. Edit the KPI widget settings
- Expand your monitor model and uncheck all of the KPIs except for HR
Open New Position Average Total Time and HR Open New
Position Count, then check the new Average Openings per
Hiring Request in Atlanta.
Figure 26. Select KPIs to be displayed
- Click the Layout tab.
- Choose Full Gauge from the Select a display type
drop-down, choose Large from the Select a size for
visualization elements drop-down, and set the Refresh
rate to 30 seconds. Then click OK.
Figure 27. Specify layout options
- Click Finish Editing. You should now see three gauges,
including one for your newly defined KPI, as shown in Figure 28.
Figure 28. New gauges
Define an alert
Finally, let's define a new alert.
- Return to the Tools page and select Edit Page, then add the Alert Manager widget to your page and click Finish Editing.
- Click on the New Alert button, as shown in Figure 29.
Figure 29. Define new alert
- In the dialog that displays, shown in Figure 30, enter
High Average Openings per Hiring Request in Atlantain the Alert name field. Provide a Description if desired. Choose HiringSample_Main 2011-06-05 16:35:17 in the Model drop-down (your timestamp will vary).
- Click the Add button in the Conditions section, then
select your Average Openings per Hiring Request in Atlanta for
the KPI Name, select In range for Condition, and
select High in the Value field. Select Minutes in
the How often to check conditions field, and choose Only
once when the condition applies in the Notification
frequency drop-down, then click OK.
Figure 30. Define alert conditions
- You should now see your alert definition in the Alert Manager widget.
Figure 31. New alert definition in the Alert Manager
Receive alert when condition occurs
Now let's add an Alerts widget to the dashboard, so we'll know when that alert arrives.
- Return to the HR Open New Position KPIs page, click Edit
Page, and add the Alerts widget to the bottom of the
page, then click on Finish Editing.
Figure 32. Add Alerts widget to dashboard
Note you may already have some alerts showing already, if you ran the Showcase model in Part 2.
- Finally, return to Process Designer and "play" a process instance in
the Inspector, using the same approach as we used in Part 2, whose location is Atlanta, with a large enough value
for the Number of Employees Needed (the empNum field)to
push the average into the High (4-6) range. For example, if you
have one Atlanta instance with an empNum of 2, create another
Atlanta instance with an empNum of 8 (meaning the average would
be 5). Be careful not to pick a value so high that the average falls
beyond the upper bound of the High range. In a minute or so, an
alert should appear in your dashboard, as shown in Figure 33.
Figure 33. New alert displays in dashboard
Congratulations! You now have a fully customized dashboard, tracking business activity of interest to your dashboard users for your BPMN process.
We hope you've enjoyed learning about the simple yet powerful combination of IBM Business Process Manager and IBM Business Monitor, and that you now feel ready to empower your business users by offering them greater visibility into both the real-time state and the historical performance of their business processes.
- IBM Business Process Monitor V7.5 Information Center
- Building IBM Business Process Management Solutions Using WebSphere V7 and Business Space (IBM Redbook)
- Monitoring your business applications with WebSphere Business Monitor (developerWorks series, 2011)
- developerWorks BPM zone: Get the latest technical resources on IBM BPM solutions, including downloads, demos, articles, tutorials, events, webcasts, and more.
- IBM BPM Journal: Get the latest articles and columns on BPM solutions in this quarterly journal, also available in both Kindle and PDF versions.
Dig deeper into WebSphere on developerWorks
Experiment with new directions in software development.
Read and subscribe for the best and latest technical info to help you deal with your development challenges.
Software development in the cloud. Register today and get free private projects through 2014.
Evaluate IBM software and solutions, and transform challenges into opportunities.