EMC Documentum Business Activity Monitor

Transcription

1 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide P/N A02 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright 2009 EMC Corporation. All rights reserved. Published March 2009 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners.

3 Table of Contents Preface Chapter 1 Understanding Business Activity Monitor Understanding the monitoring process Deploying and configuring BAM with a new installation of Process Suite Deploying and configuring BAM within an existing installation of Process Suite Designing reports, alerts, and dashboards Monitor a running process Summary of the BAM Process Understanding the Business Activity Monitor architecture Understanding the event pipe Understanding business data monitoring Understanding the format engine Understanding the aggregation engine Understanding the alert engine Understanding the gap filler Understanding machine clock settings Understanding queue monitoring Understanding Process Reporting Services Understanding BAM dashboards Chapter 2 Configuring Business Activity Monitor Enabling processes for monitoring Assigning Audit Trail permissions Enabling structured data type attributes for monitoring Enabling objects contained in packages for monitoring Enabling simple process variables for monitoring Logging in to TaskSpace Configuring connection settings Activating process monitoring Deactivating process monitoring Updating monitored business data Configuring recovery periods Configuring data transfer latency Configuring maximum data transfer idle time Chapter 3 Defining Reports and Alerts with Process Reporting Services Understanding report entities Working with activity and process entities Working with activity and process aggregation entities Working with incomplete execution entities EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 3

4 Table of Contents Working with activity performer aggregation entities Working with queue entities Working with business data entities Working with alert entities Understanding entity relationships Working with entity fields and captions Understanding report entity filtering Understanding simple report types Working with pie charts and bar charts Working with gauge reports Working with bar + line charts Working with table charts Understanding chart types and visual properties Pie chart properties Bar and Bar + Line chart properties Gauge properties Table properties Understanding reports that use aggregation Understanding server aggregation Understanding business data aggregation Understanding single drill-down reports Understanding the importance of filtering Understanding multi-drill-down reports Logging into Process Reporting Services Navigating Process Reporting Services Creating a report category Creating a simple report Sorting report columns Modifying bar chart labels Choosing bar and pie chart colors Aggregating report data Removing report aggregation Adding computed columns to a report Adding a computed column Editing or deleting a computed column Previewing a data source Filtering report entities Using filter variables Creating a Crystal Report Creating a report based on an existing data source Publishing draft reports Auto refreshing reports Configuring single drill-down reports Configuring multi-drill-down reports Configuring Crystal Report drill-downs Editing reports Deleting reports EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

5 Table of Contents Exporting reports Importing reports Editing entity field captions Using the data source undo/redo feature Creating an alert category Creating an alert Testing an alert Publishing an alert Opening an existing alert Editing an existing alert Configuring business data aggregation Deleting business data aggregation Displaying BAM reports in an enterprise portal Option 1: Using a report ID Option 2: Using the path to the report Filter and maximum row parameters Export report to PDF and Excel formats Displaying process diagrams from within a J2EE web application Embedding a diagram as an object Embedding a diagram using iframes Chapter 4 Process Reporting Services Examples Designing a New Account Openings report Designing a Total Deposits per City report Calculating inter-activity duration Chapter 5 Designing a BAM Dashboard Understanding the report dashlet Understanding the process diagram dashlet Understanding the alert list dashlet Understanding the process simulation dashlet Understanding dashlet filters Understanding dashboard permissions Understanding the dashboard interface Creating sub-processes in Process Builder Creating a new dashboard application Designing a dashboard Adding a dashboard to an application Adding a dashboard tab Assigning dashboards permissions Configuring multi-drill-down reports in a dashboard Adding process diagrams to a dashboard Scheduling refresh periods Configuring dashlet filters Printing reports from a dashboard EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 5

6 Table of Contents Modifying dashboards Removing dashboards Deleting dashboards Applying dashlet filters Updating the status of an alert Customizing a dashboard cascading style sheet (css) Chapter 6 Working with Preconfigured Dashboards Understanding the Process Monitor dashboard Understanding the List of Process Instances report Understanding the Count of Started, In-flight, and Completed Processes report Understanding the Count of In-flight Processes report Understanding the Count of Processes Started within the Last Month report Understanding the Process Instance Details report Understanding the Process Duration report Understanding the Process Summary dashboard Understanding the Count of Processes per State report Understanding the Count of Activities per State report Understanding the In-flight Process Statistics report Understanding the In-flight Activity Statistics report Understanding the Tasks Completed by Performer within the last 24 Hours report Understanding the Tasks Pending for each Performer report Understanding the Alert Monitor dashboard Understanding the Alert List dashlet Understanding the Alert Resolution report Understanding the Alerts per Process report Understanding the Alerts per Activity report Localizing the preconfigured dashboards Chapter 7 Working with BAM in a Production Environment Deploying BAM to a production environment Monitoring BAM database table space Modifying the number of records returned in a results set Scheduling BAM database purging Purging the Audit Trail database Enhancing BAM system performance Chapter 8 Creating Custom Aggregation, Report, and Filter Entities Configuring BAM custom aggregation Creating custom report entities Creating custom report entities Creating relationships between two entities Adding a field to an existing entity Adding a field to an existing entity using a database function Creating custom filter entities Creating filter entities Creating filter tabs Creating filter token items Defining filter entity relationships EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

7 Table of Contents Creating PRS client filter tree items Dynamic filters: relating children levels to the parent Creating web client filter tree items Create business data filters in the dashboard Understanding report entity tables Appendix A Entity Relation Diagrams Appendix B Report Entities Activity Process Queue Alert Activity Aggregation Process Aggregation Performer Aggregation Appendix C Database Views EXEC_ACTIVITY_EVENTS_VIEW V_FLT_QUEUE_END V_FLT_QUEUE_START EXEC_QUEUE_MANAGEMENT_VIEW EXEC_ACTIVITY_INSTANCE EXEC_PROCESS_EVENTS_VIEW EXEC_QUEUE_EVENTS_VIEW V_EXEC_PROCESS_INSTANCE V_ACT_EXECUTION V_INC_ACTIVITY_INSTANCE EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 7

8 Table of Contents List of Figures Figure 1. Scenario 1: All components of Process Suite deployed simultaneously Figure 2. Scenario 2: Process Builder and BAM deployed separately Figure 3. Implement a BAM solution Figure 4. Monitor process Figure 5. Business Activity Monitor technical architecture Figure 6. Actor, BAM configuration interaction diagram Figure 7. Select the Config Audit extended privilege Figure 8. Gap filler recovery period Figure 9. Data transfer latency Figure 10. Maximum data transfer latency Figure 11. BAM reporting components Figure 12. Report designer interaction diagram Figure 13. Alert definition interaction diagram Figure 14. PRS palette Figure 15. Entity relationship example Figure 16. Entity fields Figure 17. PRS filter window Figure 18. Process duration bar chart Figure 19. Process duration gauge Figure 20. Process duration dial gauge data source Figure 21. Bar with line report Figure 22. Table charts Figure 23. Report aggregation Figure 24. Aggregation function and group-by Figure 25. Business data aggregation Figure 26. Multi-drill-down report in a dashboard Figure 27. PRS connection parameters Figure 28. Process Reporting Services navigation Figure 29. Select report category and name Figure 30. Select entity fields Figure 31. Data Source Preview Figure 32. Format data series Figure 33. Bar and pie chart color palette Figure 34. Aggregating report data Figure 35. Aggregation in data source editor Figure 36. Computed columns report entity Figure 37. Computed column expression EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

9 Table of Contents Figure 38. Computed columns results Figure 39. Add computed column Figure 40. Edit computed column Figure 41. Preview data source Figure 42. Define data source entity filter Figure 43. Select Report Location Figure 44. Add report entity Figure 45. Dynamic filter expression Figure 46. Drill-down window Figure 47. Multi-drill configuration in PRS Figure 48. Multi-drill configuration in a dashboard Figure 49. Caption editor Figure 50. Alert Builder user interface Figure 51. Data Source Builder Figure 52. Alert Properties window Figure 53. Business data aggregation Figure 54. New account openings data source Figure 55. New account openings aggregation settings Figure 56. New account openings chart type settings Figure 57. New account openings chart data settings Figure 58. Total deposits per city data source Figure 59. Total deposits per city aggregation settings Figure 60. Total deposits per city chart type settings Figure 61. Total deposits per city chart data settings Figure 62. BAM dashboard architecture Figure 63. Dashboard designer and dashboard user interaction diagram Figure 64. Report dashlet Figure 65. Process diagram dashlet Figure 66. Alert dashlet Figure 67. Process simulation dashlet Figure 68. Multi-drill configuration in PRS Figure 69. Multi-drill configuration in a dashboard Figure 70. Add process diagram to dashboard PRS Figure 71. Add process diagram to dashboard Figure 72. Add business data report entity Figure 73. Sample DQL Figure 74. Process Monitor multi-drill-down report configuration Figure 75. Process Instance List report dashlet configuration Figure 76. Count of Processes per State filter configuration Figure 77. In-flight Process Statistics filter configuration Figure 78. Tasks Completed by Performer filter configuration Figure 79. Tasks Pending for Each Performer filter configuration Figure 80. Composer import window EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 9

10 Table of Contents Figure 81. Import artifacts from repository Figure 82. Select BAM artifacts Figure 83. Install Documentum project Figure 84. Select target repository Figure 85. Filter display in PRS Figure 86. Activity execution report entity filter Figure 87. BAM database tables Figure 88. BAM report entities EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

11 Table of Contents List of Tables Table 1. The TaskSpace URL variables Table 2. Report entity filters Table 3. JEP operators Table 4. Automatic purgers Table 5. Segments of report entity query Table 6. Segments of report entity query Table 7. Segments of entity relations query Table 8. Filter entity segment descriptions EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 11

12 Table of Contents 12 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

13 Preface This document describes how to configure, deploy, and maintain a process monitoring solution with Business Activity Monitor (BAM). BAM gives business users insight into processes executing in Documentum Process Engine. It provides the ability to generate alerts in real time and creates a dashboard view that shows process status and performance statistics. This guide contains the following chapters: Chapter 1, Understanding Business Activity Monitor Chapter 2, Configuring Business Activity Monitor Chapter 3, Defining Reports and Alerts with Process Reporting Services Chapter 4, Process Reporting Services Examples Chapter 5, Designing a BAM Dashboard Chapter 6, Working with Preconfigured Dashboards Chapter 7, Working with BAM in a Production Environment Chapter 8, Creating Custom Aggregation, Report, and Filter Entities Intended Audience The intended audience for this document includes all roles involved with implementing a Business Activity Monitor solution, including: Process Designers this persona uses Process Builder to design processes. Designing processes with Process Builder is out of scope for the document, however, there are a few BAM configuration procedures that are completed in Process Builder. These procedures are addressed in Chapter 2, Configuring Business Activity Monitor. Process Administrator this persona uses a specific set of functions available in the Administration tab of TaskSpace to configure BAM, which is also addressed in Chapter 2, Configuring Business Activity Monitor. Report Designers this persona uses Process Reporting Services to design reports and alerts. All PRS topics are presented in Chapter 3, Defining Reports and Alerts with Process Reporting Services. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 13

14 Preface Dashboard Designers this persona uses the dashboard component within TaskSpace to design dashboards. Chapter 5, Designing a BAM Dashboard describes how to build a BAM dashboard; Chapter 6, Working with Preconfigured Dashboards describes each of the three preconfigured dashboards and their dashlets. Database Administrator this persona is responsible for creating custom report and filter entities, if required. Chapter 8, Creating Custom Aggregation, Report, and Filter Entities contains procedures used by BAM Database Administrators. Each chapter can involve one or more personas. Revision History The following changes have been made to this document. Revision Date Description March 2009 Made several corrections to Chapter 8 December 2008 Initial publication Support information EMC Documentum s technical support services are designed to make your deployment and management of Documentum products as effective as possible. The Customer Guide to EMC Software Support Services provides a thorough explanation of Documentum s support services and policies. You can download this document from the Powerlink website ( by navigating to: Support > Request Support > Software Customer Guide and Offerings. Note: You must register online at Powerlink before using it. Related documentation The Business Activity Monitor technology monitors processes executing in the Process Engine. In addition to this manual, the documentation set for this product includes: Documentum Business Activity Monitor Installation Guide Documentum Business Activity Monitor Release Notes Documentum Process Builder User Guide Documentum Composer User Guide Documentum TaskSpace Configuration Guide 14 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

15 Preface Documentum Administrator User Guide EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 15

16 Preface 16 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

17 Understanding Business Activity Monitor Chapter 1 The Documentum Process Suite is a term used to describe the technologies involved in designing, executing, and monitoring business processes. One component, Process Builder, is a graphical tool used by process designer to develop business processes. A fully designed business process is a process template or abstract process that is executed by Process Engine. Each process that executes is called a process instance. Process instances are composed of a specific set of activity instances (also called work items) completed by one or more users. Business Activity Monitor (BAM) collects and stores process execution data, prepares it for reporting, and provides a real-time dashboard display environment. Another component of Business Activity Monitor is Process Reporting Services (PRS), a tool used for generating and formatting reports and alerts displayed in the dashboard. BAM enables organizations to detect problem conditions that may exist in executing processes, to diagnose these problems to determine their root cause, and to correct them. It also provides valuable historical information about process execution to enable long-term process improvement. The underlying assumptions of BAM are: A process has been developed either in a development environment, a QA environment, or exists in production. At a minimum, Documentum Content Server, the BAM database, BAM server, TaskSpace, and Process Reporting Services must be deployed Note: BAM deployment and PRS installation are addressed in Documentum Business Activity Monitor Installation Guide. For a complete set of system requirements please see the Documentum Business Activity Monitoring Release Notes. A BAM administrator is defined in the repository and assigned the BAM Admin role. This provides access to the BAM configuration options available in the Administration tab of TaskSpace. A user in the repository is assigned the ts_designer role. This role has control over designing reports in PRS and creating dashboard in TaskSpace. This chapter provides an overview of BAM. Specifically, this chapter includes the following sections: Understanding the monitoring process, page 18 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 17

18 Understanding Business Activity Monitor Understanding the Business Activity Monitor architecture, page 23 Understanding the monitoring process Implementing a process monitoring solution can be described as a process. First, the BAM technology must be deployed and configured. BAM can either be deployed within the context of a new installation of Process Suite, or within the context of an existing system. Each use case is described in the following sections. In both cases, configuration takes place in both Process Builder and within a specific set of functions available in the Administration tab of TaskSpace. Only users with permissions can complete configuration in the administration tab. Then, reports and alerts are defined and displayed in a dashboard environment. From here, users continuously monitor executing processes and address process-related issues as they arise. This section describes each phase in greater detail. Deploying and configuring BAM with a new installation of Process Suite In this scenario BAM is deployed at the same time as other components of the Process Suite (Process Builder, Process Engine, and TaskSpace). After deployment a process designer uses Process Builder to develop business processes. Once development is complete processes and business data are enabled for monitoring in Process Builder. The term business data refers to Structured Data Types (SDTs), objects contained in packages, and simple process variables that are collected as a process executes. BAM can be configured to monitor values captured in each data field. Configuration concludes in TaskSpace where monitoring is activated. In essence this turns BAM on. Understanding the Business Activity Monitor architecture, page 23 provides more information about the technical architecture of BAM. Chapter 2, Configuring Business Activity Monitor provides detailed configuration procedures. 18 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

19 Understanding Business Activity Monitor Figure 1. Scenario 1: All components of Process Suite deployed simultaneously Deploying and configuring BAM within an existing installation of Process Suite The second scenario assumes that Process Builder, Process Engine, and TaskSpace components of the Process Suite are deployed and in use before BAM is installed. This means that processes are designed in Process Builder and may even be working in a production environment, where real world users are completing work. Once BAM is installed process and business data configuration in Process Builder is the same as for the first scenario. The primary difference between these two scenarios, however, is with respect to an additional step where a feature called the gap filler is configured in TaskSpace. The gap filler serves an important purpose. Process data can be written to the Audit Trail database even if BAM is not installed. This leads to a backlog of data that can be monitored once BAM is up and running. The gap filler is the mechanism responsible for taking existing data and formatting it. The gap filler recovery period is defined as the amount of time BAM should go back to monitor data. The default recovery period is seven days, although this can be changed by a user in the Administration tab of TaskSpace. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 19

20 Understanding Business Activity Monitor Figure 2. Scenario 2: Process Builder and BAM deployed separately Designing reports, alerts, and dashboards Process data is captured and stored once BAM configuration is finalized. This data is stored in specific tables of the BAM database where it is available for reporting. Report designers use Process Reporting Services (PRS) to define reports and alerts. Reports can be formatted as pie charts, bar charts, and tables. Chapter 3, Defining Reports and Alerts with Process Reporting Services provides detailed reporting procedures. Published reports can be consumed by a dashboard that displays the report results to end users. A BAM dashboard is an application within TaskSpace that is configured by a dashboard designer. Dashboards are also capable of displaying alerts and process diagrams. The logic of an alert is defined in PRS. When an alert is triggered an notification is sent to one or more individuals. Detailed information about the alert and its status is available within the dashboard. In addition, a dashboard can hold process diagrams that graphically display the status of individual processes as they execute. The image of a process diagram is generated by the Process Engine. In some cases it may be necessary to adjust the placement of activities within the process so it is easier to read. This could involve simplifying a diagram to hide it s technical complexity in favor of a more business-oriented view of the process. Once a dashboard is built it can be deployed to a production environment. Chapter 5, Designing a BAM Dashboard contains procedures for building BAM dashboards. Chapter 7, Working with BAM in a Production Environment addresses production-oriented concepts and procedures. 20 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

21 Understanding Business Activity Monitor Figure 3. Implement a BAM solution Monitor a running process The final phase of a BAM implementation focuses on the real-time, continuous monitoring of executing processes. As process instances are executed BAM reports displayed in the dashboard are updated. These reports are available for executives and operations personnel (and other personnel, as needed) who need to understand how processes are performing. Executing processes may also trigger alerts that should be resolved by a responsible party. Responsible parties are automatically notified by way of if an alert is triggered. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 21

22 Understanding Business Activity Monitor Figure 4. Monitor process Summary of the BAM Process In general, implementing a Business Activity Monitor solution involves: 1. Designing processes in Process Builder. Using Process Builder is not in scope for this documentation. Please refer to the Documentum Process Builder User Guide for more information. 2. Once a process is designed it must be configured for monitoring. Chapter 2, Configuring Business Activity Monitor addresses configuration in both Process Builder and the Administration tab of TaskSpace. 3. Once configuration is complete, you must run at least one process instance so that the audit trail is populated with data. It is recommended that you run multiple process instances. At this point, BAM reports can be defined. Chapter 3, Defining Reports and Alerts with Process Reporting Services addresses designing BAM reports and alerts. 4. BAM reports, alerts, and diagrams are the building blocks of a dashboard application designed in TaskSpace. Chapter 5, Designing a BAM Dashboard addresses building a new dashboard application. 5. Alternatively (or in addition to a new dashboard), a preconfigured dashboard can be deployed and used out-of-the-box. The instructions for deploying the preconfigured dashboard are available in the Business Activity Monitor Installation Guide. Chapter 22 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

23 Understanding Business Activity Monitor 6, Working with Preconfigured Dashboards describes each of three preconfigured dashboards, their organization, and each report that is displayed. 6. Once your BAM solution is tested in a development environment, it can be deployed to a production environment. Chapter 7, Working with BAM in a Production Environment provides a deployment procedure and other content related to a working with BAM in production. 7. There may be times when out-of-the-box report and filter entities do not meet your particular requirements. If this is the case, custom report and filter entities can be created. Chapter 8, Creating Custom Aggregation, Report, and Filter Entities addresses these topics. Understanding the Business Activity Monitor architecture Once BAM configuration is complete process data is written to the Documentum Audit Trail database. This data is then transferred over an event pipe to the format engine component of the BAM server. Once formatted, this data is inserted into execution tables of the BAM database. The BAM database schema is created when Business Activity Monitor is deployed. BAM deployment is addressed in Documentum Business Activity Monitor Installation Guide. The execution tables store process instance data. From here, this data is aggregated and inserted into aggregation tables. Aggregating execution data means that process instances are collapsed into groups for which one or more arithmetic functions apply. For example, aggregation allows users to calculate the average duration for processes that began within the last hour, week, or year. For more information on aggregation, please see Understanding the aggregation engine, page 26. The alert engine, together with the format engine and aggregation engine, is also a function of the BAM server. The alert engine scans data stored in both execution and aggregation tables for alert conditions. Alerts are defined in PRS. For more information on defining alerts please see Creating an alert, page 103. The gap filler is the final component of the BAM server. Should the BAM server be down for any reason, the gap filler is responsible for going back in time, taking unformatted data from the Audit Trail database and formatting it. The gap filler recovery period can be specified by the user. This section describes each component of BAM architecture in more detail. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 23

24 Understanding Business Activity Monitor Figure 5. Business Activity Monitor technical architecture Understanding the event pipe As business processes execute in the Process Engine, event data is written to the Audit Trail database. On a periodic basis (such as every 5 seconds), the BAM server extracts recent events from the Audit Trail and inserts them into the BAM database, specifically into its integration table. Once this information is in the integration table, data formatting can then take place. The process of extracting and inserting process data into the integration table is referred to as the event pipe. The BAM server controls the operation of the event pipe. So, if the BAM server is down or ceases operation for any reason, then the event pipe cannot operate and no data will be transferred to the BAM database. This creates a gap between the data that has already been written to the integration table and the data that has not yet been extracted from the Audit Trail database. A special process called gap filling is used to address these situations. The gap filler allows the BAM server to catch up on its work, quickly extracting the events that it has missed while it was down and inserting them into the integration table. For more information on the gap filler please see Understanding the gap filler, page 27 and Configuring recovery periods, page EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

25 Understanding Business Activity Monitor Understanding business data monitoring In addition to process and queue data, BAM supports the monitoring of three forms of business data: Structured Data Types (SDTs), objects contained in packages, and (simple) process variables. Without business data monitoring, the data collected during process execution is constrained to default process data. Default process data is the set of data automatically captured while a process executes for example, process and activity durations, information about performers, queue data, and started/finished date information. Business data adds to this information by monitoring attribute values associated with a process instance. This data is used by report designers to generate very sophisticated reports to answer questions like: How much revenue was generated by each region over the last day, week, month? and What is the average process duration for each state?. Business data is also used in alerts. For example, an alert that is triggered when the number of company shares traded exceeds a certain value. SDTs and objects contained in packages are considered complex process variables comprised of multiple attributes. Process variables can also be simple in structure, with only a single attribute. As a result, there are some differences in monitoring of SDT and object contained in packages as opposed to simple process variables. First, SDT and objects contained in packages reporting entities can be used as base entities in a report. A base entity is the first entity used to define a report in PRS. A simple process variable report entity is, in contrast, always nested under the Process Execution report entity. Working with business data entities, page 53 describes business data reporting entities. In addition, SDTs and objects contained in packages can be aggregated. Aggregation is not available for simple process variables. Business data aggregation is configured in PRS and applies only to SDTs and objects contained in packages. Understanding the aggregation engine, page 26 describes the concept of aggregation. Configuring business data aggregation, page 109 outlines the aggregation procedure in PRS. And finally, SDTs and objects contained in packages can also be updated with the BAM database when there are changes. The update operation is not required for simple process variables.updating monitored business data, page 41 explains how to use the update feature. All business data monitoring configuration options are available in Process Builder. Therefore, it is usually the process designer that specifies which attributes to monitor. Once configured, data is written to the BAM database. For more information on configuring business data monitoring, please see Enabling structured data type attributes for monitoring, page 34,Enabling objects contained in packages for monitoring, page 35, and Enabling simple process variables for monitoring, page 36. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 25

26 Understanding Business Activity Monitor Understanding the format engine The event pipe inserts process execution data into the integration table of the BAM database. Each row of the integration table contains data about one process instance, including activities, performers, queues, and business data. The format engine extracts information from the integration table and maps it into a series of execution tables. BAM reports and alerts will then be written against these tables. For example, some data will be mapped to the process table, other data will be mapped to the activity table, and yet other data will be mapped to business data tables. In fact the format engine consists of several formatters that run simultaneously: Process formatter Activity formatter Business data formatter Queue definition formatter Once the formatting job is done, the data can be aggregated. Understanding the aggregation engine The execution tables populated by the formatting process can eventually contain thousands of rows of data. This means that some BAM reports may take quite a long time to run. The aggregation engine creates summaries of execution data so that these reports can run against summary data, with much better performance. For process, activity, and performer entities the aggregation engine calculates the following metrics: Average duration (milliseconds and seconds) Count of completed instances Count of failed instances Count of ongoing instances Count of started instances Maximum duration Minimum duration Note: Aggregation entities can also be created for business data objects. These calculations are made for a series of time intervals, based on when the process instances start: 5 minutes 15 minutes 30 minutes 26 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

27 Understanding Business Activity Monitor Hourly Daily Weekly Monthly Quarterly Yearly This summary information is then inserted into the aggregation tables. Understanding reports that use aggregation, page 65 contains much more information about the concept of aggregation. Understanding the alert engine The purpose of the alert engine is to scan execution data for alert conditions, and, if a problem presents itself generate an notification. Every time the alert engine runs, it receives a list of active alerts (alerts can be inactive, too) from PRS. Alerts can scan either instance or aggregated data. The report engine executes the alert and receives a result. For each row the alert engine evaluates the alert expression. If the alert expression is True for a row, then the process instance is added to the alert instance table of the database. A positive evaluation also generates an that is sent to all designated recipients. If configured, the alert engine can invoke a new process within Process Engine. The alert engine also provides services utilized by the BAM dashboard. Alerted processes are displayed in a diagram dashlet and alert icons are placed on the diagram indicating those activities that require attention. In addition, an alert dashlet displays all alert instances. The alert status can be updated by a user within the alert dashlet. Understanding the gap filler A gap filler is used whenever the BAM server is down, but events are still being written to the database. Without the BAM server up and running this data is not formatted or aggregated. A gap filler recovery period must be configured. Once the server is started, the gap filler begins its work formatting data within the recovery period. For example, if the BAM server was down for one month, a user can specify to have only events from the last 10 days to be formatted. The BAM server will then catch up and return to normal operation. The gap filler recovery period is specified in the Administration tab of TaskSpace. For more information on configuring the gap filler, please see Configuring recovery periods, page 42. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 27

28 Understanding Business Activity Monitor Understanding machine clock settings The Content Server (which is responsible for running Process Engine), BAM application server, and BAM database servers clocks must be synchronized to within 5 seconds with an outer limit of 30 seconds. This synchronization happens automatically except in high availability cases where two Content Servers are running on two clusters. In this case machine clocks must be synchronized manually. Understanding queue monitoring The Process Suite supports queue management. A queue is a container that holds work items (also known as activity instances) until they are completed by a performer. Performers are individuals responsible for completing specific steps within a process. Sometimes a process routes work items to a specific performer. Other times, any number of performers can complete a work item. This is where queues become useful. Instead of automatically routing work to a specific performer within a process, work items are routed to a queue where they can be selected and completed by any number of performers. Work items within a queue are usually processed in a first in, first out order. However, there are other factors (like the priority and age of the work item) that impact this order. Within the flow of a process a queue is assigned as the performer of a manual activity. Each queue is uniquely named and is characterized by thresholds (the maximum number of work items allowed in the queue), users (a list of performers that can claim work items within the queue), and policies (rules that govern how the queue operates). Queue work items are selected by performers for completion. Work items can exist in a number of different states, called events: Started Completed Aborted Acquired Unacquired Delegate Suspend Unsuspended Queue monitoring does not require any additional configuration. Note: All work items in a queue are monitored, even if the process to which the work item belongs is not monitored. If the parent process of the work item is not monitored, then you cannot report on the relationship between the work item and the process. 28 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

29 Understanding Business Activity Monitor For more information about queue reporting entities please see Working with queue entities, page 52. Understanding Process Reporting Services Process Reporting Services (PRS) is the component of BAM used for creating reports and alerts on monitored processes. PRS is used by report designers who select report entities from a palette, choose the data on which the report is based, and format the report. Reports can be formatted either in PRS or in an external Crystal Reports editor. Report entities are provided with the BAM software, although custom report entities can be created. Alerts are also defined in PRS. An entire chapter is dedicated to PRS. For more information, please see Chapter 3, Defining Reports and Alerts with Process Reporting Services. Understanding BAM dashboards A BAM dashboard is a display environment for monitoring executing processes in real-time. A dashboard is an application created within TaskSpace that contains dashlets. Dashlets display the contents of a specific report, diagram, or alert. Dashboards are created by dashboard designers who use a drag-and-drop interface to configure dashboards. Dashboard designers can also schedule dashboard refresh periods and configure dashlet filtering. Dashboard users interact with a dashboard to monitor processes. These users are granted permissions to view the content of a specific dashboard and can take action on alerts. Dashboard design is addressed in a separate chapter. For more information please see Chapter 5, Designing a BAM Dashboard BAM is also shipped with a variety of preconfigured dashboards that are already assembled. Each preconfigured dashboard contains a set of reports defined in PRS. Working with preconfigured dashboards is addressed in a separate chapter. For more information please see Chapter 6, Working with Preconfigured Dashboards. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 29

30 Understanding Business Activity Monitor 30 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

31 Chapter 2 Configuring Business Activity Monitor BAM configuration refers to a set of features that enable process execution data to be collected, formatted, and aggregated by the BAM server. BAM configuration involves two personas and is divided into four phases: First, process designers enable processes and business data (SDTs and objects contained in packages) to be monitored in Process Builder. Once enabled, the structure of the business data must then be updated in the BAM database. Within the Administration tab of TaskSpace, process administrators must make sure that a connection with the BAM server is established. This allows monitoring to be activated. As processes are being monitored, it may be necessary for the process administrator to fine-tune BAM, especially in cases when either Content Server or the BAM server are down. This also takes place in the Administration tab of TaskSpace. Figure 6. Actor, BAM configuration interaction diagram This chapter addresses all aspects of BAM configuration. It includes the following sections: EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 31

32 Configuring Business Activity Monitor Enabling processes for monitoring, page 32 Assigning Audit Trail permissions, page 33 Enabling structured data type attributes for monitoring, page 34 Enabling objects contained in packages for monitoring, page 35 Enabling simple process variables for monitoring, page 36 Logging in to TaskSpace, page 37 Configuring connection settings, page 39 Activating process monitoring, page 40 Deactivating process monitoring, page 40 Updating monitored business data, page 41 Configuring recovery periods, page 42 Configuring data transfer latency, page 43 Configuring maximum data transfer idle time, page 44 Enabling processes for monitoring Processes must be enabled for monitoring in Process Builder. Monitoring begins when process data is written to the Audit Trail database. The process designer enables monitoring in the Process Template Properties dialog box. This window provides basic information about the workflow. For more information, please see the Documentum Process Builder User Guide. For more information about auditing in Documentum software, please see the Documentum Content Server API Reference Manual. Caution: The user responsible for turning the Audit Trail on and off must have the Config Audit extended privilege assigned to them. Otherwise, these options are grayed out. Assigning Audit Trail permissions, page 33 provides guidance in assigning the config audit extended privilege to a user. To enable a process for monitoring 1. Log into Process Builder. 2. Open a process template. 3. Select Process Properties from the Tools menu or click the Template Properties icon on the toolbar. 4. Select the General tab. Basic template information appears as read-only text at the top of the template. 32 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

33 Configuring Business Activity Monitor 5. Turn on (or off) the template Audit Trail Settings by clicking the appropriate option. Note: Auditing must be turned on to enable the system to publish reporting data to the BAM database. 6. Click Ok to close the Process Properties window. Assigning Audit Trail permissions Users that turn the Audit Trail on and off must be granted the Config Audit extended privilege. This privilege is granted in the User Properties dialog in TaskSpace. This privilege cannot be granted to oneself; you must log in as another user with administrative rights first, and then assign the privilege to your user. For example, if you want to grant the dmadmin user this privilege, you would first have to log in to TaskSpace as any other administrative user and then assign this extended privilege to dmadmin. To assign the Config Audit extended privilege 1. Log into TaskSpace as a user with administrative rights. 2. Click the Administration tab. 3. Expand User Management on the tree menu. 4. Select Users. 5. Navigate to and select the user to which the config audit extended privilege is being assigned. 6. Click Properties. 7. Select Config Audit from the Extended Privileges drop-down. 8. Click Ok. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 33

34 Configuring Business Activity Monitor Figure 7. Select the Config Audit extended privilege Enabling structured data type attributes for monitoring Structured data type attributes are one form of business data that can be monitored by BAM. Configuring an SDT attribute to be monitored involves both the Structured Data Type window and the Activity Inspector window. Selecting an SDT attribute to be monitored in the Structured Data Type window only gives the attribute the potential to be monitored it does not fully enable the attribute to be monitored. The attribute must also be selected in the Activity Inspector window. Note: If an attribute is selected in the Activity Inspector window but is not selected in the Structured Data Type window, the attribute will not be monitored. Once an attribute is enabled for monitoring, the process designer must update the attribute with the BAM database. Updating prompts BAM to create execution tables in the BAM database, and corresponding report and filter entities. Updating monitored business data, page 41 addresses how to perform the update operations within both Process Builder and the Administration tab of TaskSpace. 34 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

35 Configuring Business Activity Monitor Caution: Process Builder supports the ability for SDT attribute values to consist of up to 4000 characters. This is supported for a BAM database installed on MS SQL Server and Oracle databases. For a BAM database installed on DB2 only 256 characters are supported. SDT attribute values greater than 256 characters will be truncated in the BAM database for DB2 only. To enable an SDT attribute for monitoring 1. Log into Process Builder. 2. Right-click a data type within the Structured Data Type selection panel. 3. Select View Detail... from the menu. The Structured Data Types dialog box appears and displays the details of the structured data type. 4. Locate the attribute(s) to be monitored. 5. Select the Reportable checkbox for each attribute you want monitored. 6. To update the SDT with the BAM database, select the Update BAM Database tables based on this SDT definition checkbox. This updates the BAM database with the attribute definition. Note: The update operation applies to all attributes and not just the selected attribute. 7. Click Ok to close the Structured Data Type window. 8. Open the Activity Inspector window for each activity to be monitored. 9. Click the Data tab. 10. Locate each attribute to be monitored and select the Report checkbox. 11. Click Ok to close the Activity Inspector window. Enabling objects contained in packages for monitoring Objects contained in packages are one form of business data that can be monitored by BAM. Monitoring this data requires a separate configuration than is required for structured data types. Once an object contained in a package is enabled for monitoring, the process designer must update the attribute with the BAM database. Updating prompts BAM to create execution tables in the BAM database, and corresponding report and filter entities. Updating monitored business data, page 41 addresses how to perform the update operations within both Process Builder and the Administration tab of TaskSpace. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 35

36 Configuring Business Activity Monitor Caution: Process Builder supports the ability for package attribute values to consist of up to 4000 characters. This is supported for a BAM database installed on MS SQL Server and Oracle databases. For a BAM database installed on DB2 only 256 characters are supported. Package attribute values greater than 256 characters will be truncated in the BAM database for DB2 only. To enable a package for monitoring 1. Open a process template. 2. Open the Activity Inspector window of an activity. 3. Click the Data tab. 4. Select the package to be monitored. 5. Select the This package can be used to generate reports checkbox. 6. Click Ok to close the Activity Inspector window. Enabling simple process variables for monitoring Simple process variables are one form of business data that can be monitored by BAM. Monitoring this data requires a separate configuration than is required for structured data types and packages. Note: Unlike SDTs and packages, simple process variables do not need to be updated in the BAM database. This update happens automatically. To enable simple process variables to be monitored 1. Open a process template. 2. Open the Activity Inspector window of an activity. 3. Click the Data tab. 4. Select the process variable to be monitored. 5. Select the This variable can be used to generate reports checkbox. 6. Click Ok to close the Activity Inspector window. 36 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

37 Configuring Business Activity Monitor Logging in to TaskSpace To start the user interface and log in: 1. Open a supported browser. For a list of supported browsers, refer to the Documentum TaskSpace Release Notes. 2. Navigate to the TaskSpace user interface at the following URL: Table 1, page 37 explains each variable in this URL: Table 1. The TaskSpace URL variables URL variable server_name port_number deployment_name app_name Explanation The name of the computer on which TaskSpace is installed. The port where the application server listens for connections. The virtual directory created during installation. The name of a TaskSpace application. Note: If you are not sure what URL to use, ask your system administrator. If you are accessing the TaskSpace user interface for the first time, omit the question mark and everything that follows. The login page appears. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 37

38 Configuring Business Activity Monitor 3. On the TaskSpace login page, select a repository and enter your login name and password. 4. To have the login page automatically recall this information, select the Remember my credentials option. Tip: Once you are logged in, you can view or delete your saved credentials by clicking Preferences. 5. To enter a Microsoft Windows NT domain name, click More Options and enter the domain. 6. To select the language for text in the TaskSpace user interface, click More Options and select the language. 7. To connect to the repository using a particular server, click More Options and select that server from the Server list box. The default is Any Running Server. 8. To use accessibility features, click More Options and check Additional Accessibility Options. The accessibility mode provides linear navigation, tab navigation, lists instead of menus, and additional descriptive text. 9. To change your password, complete the following steps: Note: If your organization uses Lightweight Directory Access Protocol (LDAP), you cannot change your password from the TaskSpace login page. Ask your system administrator how you can change your password. a. Click More Options. b. Click Change Password. c. Type your current password and new password. d. Click Apply. 10. Click Login. The TaskSpace software determines your user account s role memberships, and determines which of these roles have been configured for use in the TaskSpace user interface. If your login account is a member of only one role, the TaskSpace user interface appears. The interface elements available to you depend on your role. 38 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

39 Configuring Business Activity Monitor If your login account is a member of multiple roles, you are prompted to select a role. Also, if your account is a member of a role that is itself a member of another role, the inherited role also appears in the list, as long as it has been configured for use in the TaskSpace user interface. 11. If prompted, select a role and click Select. The TaskSpace user interface appears. The interface elements available to you depend on the role you selected. Note: After login, you can switch to a different role by selecting it from the list box in the top bar. The interface changes to reflect the new role. Configuring connection settings The BAM server interacts with TaskSpace, the dashboard, and Process Builder. For example, a dashboard requests reports from the BAM server. Similarly, Process Builder communicates to the BAM server when business data is monitored. Each of these clients needs to connect with the BAM server. To help with this, the BAM server publishes its address to a specific Content Server object that is then read by each of these client applications. Configuring connection settings involves entering BAM host and port numbers. To configure connection settings 1. Log in to Taskspace. For more information on logging in please see Logging in to TaskSpace, page Select the Administration tab. 3. From the left tree menu select Server Management > Business Activity Monitoring > Data Transfer Settings. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 39

40 Configuring Business Activity Monitor 4. Within the Connection region at the bottom of the form, enter the BAM Host URL. This is the machine on which the BAM server is deployed. 5. In the BAM Port field enter the BAM server port number. 6. Click Ok at the bottom of the form. Activating process monitoring Activating monitoring turns on all jobs completed by the BAM server. This includes the event pipe process, the format, aggregation and alert engines, and purging. To activate process monitoring 1. Log in to Taskspace. For more information on logging in please see Logging in to TaskSpace, page Click the Administration tab. 3. Select Server Management from the left tree menu. 4. Click the Business Activity Monitor Activate button. The Status: changes from Stopped to Running. Deactivating process monitoring Deactivating monitoring turns off all jobs controlled by the BAM server, including the event pipe process that is responsible for retrieving data from the audit trail database. It also includes the format, aggregation, and alerts engine and purging. Deactivating monitoring is necessary when business data is updated in the BAM database or when BAM is being migrated from a development/qa environment to a production environment. Note: Even though monitoring may be deactivated, events may still be inserted into the audit trail database. When monitoring is activated, the BAM server uses the gap filler to catch up. The gap filler is used whenever monitoring is deactivated or when the BAM server is shut down. To deactivate process monitoring 1. Log in to TaskSpace. For more information on logging in please see Logging in to TaskSpace, page Click the Administration tab. 40 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

41 Configuring Business Activity Monitor 3. Select Server Management from the left tree menu. 4. Click the Business Activity Monitor Deactivate button. The Status: changes from Running to Stopped. Updating monitored business data Over time, and especially in cases where BAM is deployed, configured, and tested in a development environment, the structure of a business data object (an SDT or object contained in a package) can change frequently. For example, if you modify a structured data type to add a new reportable attribute or change the name of a reportable attribute, you must update this change with the BAM database for reporting to function correctly. In addition, if you are adding new package types in your process that are also flagged for reporting, these package type definitions must be updated with the BAM database. The update operation is performed either in Process Builder or within the Update BAM Data Definitions page in the Administration tab of TaskSpace. TaskSpace can also be used to disable business data monitoring completely. Disabling removes corresponding report entities, filter entities, and deletes execution data from the business data tables in the BAM database. This section addresses each method of updating the BAM database. Note: The update operation requires a lot of system resources and takes time. This is because BAM database tables and report entities are created. To update structured data types from Process Builder 1. Select Update BAM Data Definitions from the Tools menu. 2. Select the checkbox for each SDT to be updated and click the Update button. 3. To update all SDTs select the Select All checkbox and click the Update button. 4. Click Close. To update package types from Process Builder 1. Select Update BAM Data Definitions from the Tools menu. 2. Click the Update button within the Object Types region of the window. 3. Click Close. To update monitored business data in TaskSpace 1. Log in to TaskSpace. For more information on logging in please see Logging in to TaskSpace, page 37. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 41

42 Configuring Business Activity Monitor 2. Select the Administration tab. 3. From the left tree menu select Server Management > Business Activity Monitor > Update BAM Data Definitions. 4. Select one of the following options: Update BAM tables based on SDT definition allows the user to select a single SDT from the pull-down list. Note: This option only includes SDTs. It does include objects contained in packages. To update objects contained in packages you must use the Update all BAM tables based on SDT and object type definitions option. Update all BAM tables based on SDT and object type definitions allows the user to make a mass update to all SDT and objects contained in packages. Delete BAM tables for the selected type to be selected when both of the following conditions are true: you do not want to monitor the selected business data object anymore. data for the monitored business data object can be permanently deleted from the BAM database. 5. Click Ok. Caution: This operation deletes all corresponding execution data that has been collected. This data cannot be retrieved. Configuring recovery periods Content Server writes process execution data to the audit trail database, which in turn is transferred to the BAM server over an event pipe. Without the BAM server up and running this data is not formatted or aggregated, and ultimately not reportable. A gap filler recovery period can be configured that essentially sends the BAM server back in time in order to catch up on data that was missed. The default value is seven days of data, but this can be changed by the user. Recovery options shows the different data that the gap filler will update. These options are not configurable: Process Gap Filler retrieves data related to process execution such as start and stop times, and triggers. Activity Gap Filler retrieves data related to activity execution such as activity start and completion data, and delegation. Business Data Gap Filler retrieves structured data type and package information. Once the BAM server is restarted the gap filler begins its work formatting data within the time period specified. For more information on gap fillers please see Understanding the gap filler, page EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

43 Configuring Business Activity Monitor To configure recovery period 1. Log in to TaskSpace. For more information on logging in please see Logging in to TaskSpace, page Select the Administration tab. 3. From the left tree menu select Server Management > Business Activity Monitor > Data Transfer Settings. 4. Use the fields to specify the Recovery Period in months, days, and hours. 5. Choose the gap fillers to which the period applies by selecting the Processes, Activities, or Business Data check boxes. 6. Click Ok at the bottom of the window. Figure 8. Gap filler recovery period Configuring data transfer latency Data transfer latency is defined as the amount of time (in seconds) the BAM server should wait before retrieving data and inserting it into the BAM database. In many BAM implementations there may be a slight delay between when process events occur and when they are inserted into the Audit Trail database. And when the BAM server retrieves data every 5 seconds, late-arriving data could be missed. Although there could be many reasons for this slight delay, the most common reason is the performance of the network. This configuration parameter essentially shifts the time period of the data retrieval so that every 5 seconds the BAM server attempts to gather data, but then waits an additional amount of time before collecting data. This ensures that no execution data is missed. In a typical implementation the latency period should be set to 10 seconds. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 43

44 Configuring Business Activity Monitor To configure data transfer latency 1. Log in to TaskSpace. For more information on logging in please see Logging in to TaskSpace, page Select the Administration tab. 3. From the left tree menu select Server Management > Business Activity Monitor > Data Transfer Settings. 4. Enter a value in the Data Transfer Latency field. The value is expressed in seconds. 5. Click Ok at the bottom of the window. Figure 9. Data transfer latency Configuring maximum data transfer idle time The concept of time for the BAM server is derived from execution time, and in particular, the time of specific events within a process. This type of configuration prevents data from being lost due to Content Server and BAM server clocks not being synchronized. There is one important side-affect. In periods of every 5 seconds the BAM server wakes up, checks for events and if none are found, goes back to sleep. But the time of the BAM server does not advance if no events are received. This means that the aggregation and alert engines don t run, which can lead to inaccurate reports. Maximum data transfer idle time is defined as the amount of time (in seconds) after which the BAM server clock advances when no events are detected. The default idle time is 600 seconds. After the BAM server clock advances it performs one final sweep of the audit trail database in case late-arriving events are inserted into the audit trail database. There are three (and perhaps more) cases when events could arrive late: 1. the Content Server has been down and processes resume on startup 2. there is latency in the performance of the network 3. there are multiple content servers inserting data into the audit trail database 44 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

45 Configuring Business Activity Monitor If data is found, the BAM server clock adjusts to the new time and data is formatted and aggregated. Example 2-1. Maximum data transfer latency The last event inserted into the Audit Trail database occurred at 1:00 PM. Every 5 seconds the BAM server sweeps data from the audit trail database. After 10 minutes no events are detected, but the clock of the BAM server still reads 1:00 PM. When the maximum data transfer idle time value is set to 600 seconds then the BAM server clock advances to 1:10 PM and performs one final sweep of the data. The final sweep time interval is also 10 minutes. To configure maximum data transfer idle time 1. Log in to TaskSpace. For more information on logging in please see Logging in to TaskSpace, page Select the Administration tab. 3. From the left tree menu select Server Management > Business Activity Monitor > Data Transfer Settings. 4. Enter a value in the Maximum Data Transfer Idle Time field. 5. Click Ok at the bottom of the window. Figure 10. Maximum data transfer latency EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 45

46 Configuring Business Activity Monitor 46 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

47 Defining Reports and Alerts with Process Reporting Services Chapter 3 Process Reporting Services (PRS) is a BAM tool used for creating reports and alerts on monitored processes. Reporting itself extends beyond PRS and involves a few other BAM components, as displayed in the following figure. The backbone of any report or alert is a data source. A data source is a query that runs against the BAM database (by way of the BAM server) and is defined with report entities and fields. All BAM report entities and fields are stored in the repository and are made available to PRS through the BAM server. Queries can be run against execution tables or any of the aggregation tables. Once data is returned to PRS, the report can either be formatted as a simple Flash-based chart, or exported to Crystal Reports for advanced formatting. Reports formatted in Crystal Reports can be synchronized back into PRS where they, along with simple reports, are published to a BAM dashboard. Note: PRS requires that Flash Player version 9 or higher be installed on the user machine. Alerts are also defined in PRS. Like reports, the backbone of an alert is its data source. There is one fundamental difference, however. The results of an alert are monitored by an alert engine to determine if any alert conditions have been triggered. If a problem presents itself, an notification is generated. For more information about the alert engine please see Understanding the alert engine, page 27. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 47

48 Defining Reports and Alerts with Process Reporting Services Figure 11. BAM reporting components Two personas are involved in designing BAM reports. A report designer uses PRS to create and categorize simple reports, and may also define the data source used in a Crystal Report. Crystal Reports are taken out of PRS for formatting by a Crystal Reports designer, which is then synchronized back into PRS by a report designer. Both simple reports and Crystal Reports are then published, which makes them available to use in a dashboard. In addition, drill-down reports can be configured by a report designer. The drill-down feature within PRS only applies to simple reports. Drill-down reports can also be defined for Crystal Reports, but this configuration is completed in the Crystal Reports software. Figure 12. Report designer interaction diagram 48 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

49 Defining Reports and Alerts with Process Reporting Services Report designers are also responsible for creating and categorizing alerts in PRS. Once configured, alerts can be previewed and published. Figure 13. Alert definition interaction diagram The chapter addresses all aspects of generating reports and alerts with PRS. It includes the following sections: Understanding report entities, page 50 Understanding entity relationships, page 54 Working with entity fields and captions, page 55 Understanding report entity filtering, page 56 Understanding simple report types, page 59 Understanding reports that use aggregation, page 65 Understanding single drill-down reports, page 70 Understanding multi-drill-down reports, page 72 Logging into Process Reporting Services, page 73 Navigating Process Reporting Services, page 74 Creating a report category, page 75 Creating a simple report, page 76 Sorting report columns, page 79 Modifying bar chart labels, page 79 Choosing bar and pie chart colors, page 80 Aggregating report data, page 81 Removing report aggregation, page 83 Adding computed columns to a report, page 83 Adding a computed column, page 88 Editing or deleting a computed column, page 88 Previewing a data source, page 89 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 49

50 Defining Reports and Alerts with Process Reporting Services Filtering report entities, page 89 Using filter variables, page 90 Creating a Crystal Report, page 91 Creating a report based on an existing data source, page 94 Publishing draft reports, page 94 Auto refreshing reports, page 95 Configuring single drill-down reports, page 95 Configuring multi-drill-down reports, page 97 Configuring Crystal Report drill-downs, page 99 Editing reports, page 100 Deleting reports, page 100 Exporting reports, page 101 Importing reports, page 101 Editing entity field captions, page 101 Using the data source undo/redo feature, page 102 Creating an alert category, page 103 Creating an alert, page 103 Testing an alert, page 107 Publishing an alert, page 108 Opening an existing alert, page 108 Editing an existing alert, page 108 Configuring business data aggregation, page 109 Deleting business data aggregation, page 110 Displaying BAM reports in an enterprise portal, page 111 Export report to PDF and Excel formats, page 112 Displaying process diagrams from within a J2EE web application, page 113 Understanding report entities Process Reporting Services is a visual tool that allows users to drag and drop report entities onto a canvas, create relationships, and select fields. Report entities provide a view of the data stored in the execution and aggregation tables of the BAM database. The column of each table is exposed to PRS as an entity field. Report entities operate as queries against the BAM database that returns a result. All BAM report entities are provided with the software and are stored in a repository. If required, you can also create your own, custom report entities. 50 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

51 Defining Reports and Alerts with Process Reporting Services Report entities are displayed within the palette in PRS. Report designers must select an entity category (for example, Activity) and then select a specific entity. For a complete list of report entities for each categories, please see Appendix B, Report Entities. Figure 14. PRS palette Working with activity and process entities There are two report entities belonging to the process and activity report entity categories: process execution and activity execution, and process events and activity events. These entities should be used when reporting on instance-level execution data. The Process Execution and Activity Execution report entities should be selected when reporting on processes and activities that have completed. The Activity Events entity enables users to report on activities and work queue data. The Process Events entity is appropriate in cases where event and performer data is of interest. Performers are defined as individuals that complete specific steps within a process. Working with activity and process aggregation entities Aggregation entities are a special kind of BAM reporting entity that group process instance data into specific time intervals. There are nine time intervals for both activities and processes. The time intervals are 5 minutes, 15 minutes, 30 minutes, hourly, daily, weekly, monthly, quarterly, and yearly. The incomplete execution entities have only three types of aggregation: 5 minutes, daily, and hourly. Aggregated report entities provide two benefits. First, they provide report designers an easy way to design aggregation reports. And second, overall system performance is enhanced. Instead of aggregating instance level data while the report is running, aggregated execution data is stored in special tables in BAM for fast retrieval. Querying this data is much faster than having BAM perform these calculations. For more information on aggregation please see Understanding the aggregation engine, page 26. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 51

52 Defining Reports and Alerts with Process Reporting Services Working with incomplete execution entities The Incomplete Process Execution and Incomplete Activity Execution report entities are used to report on processes and activities that have not yet completed. These processes are said to be in-flight where Ongoing Duration can be monitored in seconds, minutes, hours, and days. These time values are selected as entity fields. It is also possible to report on in-flight processes or activities by using the process or activity execution reporting entity and defining an ongoing filter. Incomplete process execution and three corresponding aggregation entities are available under the Process category. Incomplete activity execution and three corresponding aggregation entities are available under the Activity category. Working with activity performer aggregation entities BAM supports the monitoring of human activities, completed by performers. BAM captures the name of each performer and their ID, both of which can be used in reports and alerts. Performer name and performer ID can be selected as entity fields within each of the Activity Performer entities. All performer entities are aggregated, which allows users to assess an individual s performance over specific time intervals. These time intervals are: 5 minutes, 15 minutes, 30 minutes, hourly, daily, weekly, monthly, quarterly, and yearly. In addition to performer name, these entities allow users to include activity names, the average duration it takes for a performer to complete the activity, and whether the activity is completed or not (failed). Working with queue entities Process Builder and Process Engine supports queue management. Processes can be comprised of activities and queues. A queue holds work items (activities) until they are claimed and completed by a user. Sometimes it is necessary for a process to route work to specific performers. However, there may be times when any number of performers can complete a specific activity. This is where queues become useful. Instead of automatically routing work to a specific performer within a process, work items are routed to a queue where they can be selected and completed by any number of performers. Tasks are usually processed in a first in, first out order. A queue is defined in the Documentum Administrator application and assigned as the performer of a manual activity. Each queue is uniquely named and is characterized by thresholds (the maximum number of work items allowed in the queue), users (a list of performers that can claim work items within the queue), and policies (rules that govern 52 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

53 Defining Reports and Alerts with Process Reporting Services how the queue operates). Queue work items are selected by performers for completion. Work items can exist in a number of different states, called events: Started Completed Aborted Acquired Unacquired Delegate Suspend Unsuspended The Documentum TaskSpace Configuration Guide addresses queueing in greater detail. In PRS there are two queue report entities: Work Queue and Work Queue Events. The work queue report entity provides information on the queues themselves, including the name, its capacity, and the number of work items that are waiting, acquired, and suspended. The work queue events report entity provides a process context and includes the name of the activity and performer, and information about the event (see list above). Note: All work items in a queue are monitored, even if the process to which the work item belongs is not monitored. If the process is not monitored, then you cannot report on the relationship between a queue work item and its parent process. Working with business data entities Business data refers to any kind of information captured by fields on an electronic form as a process executes. Business data consist of Structured Data Types (SDTs), objects contained in packages, and simple process variables. Each of these structures is defined in Process Builder. All business data values can be reported on with a special set of reporting entities that are created. All reporting entities discussed until now are included with the BAM software. SDT and package report entities, on the other hand, are created once they are defined and enabled for reporting in Process Builder. Enabling for reporting also creates the corresponding execution tables in the BAM database. These tables store attribute values that are populated as a process executes. For example, if a customer completes an online order form, the actual values entered in the product name and quantity fields (there are many other fields, too) are stored in the BAM database. SDT and package report entities can be selected as the base entity in a report. They are also available as children of both the Activity Execution and Process Execution report entities. Unlike other report entities, aggregated business data report entities are not automatically provided. These must be configured within PRS. For more information on creating aggregated business data report entities please see Configuring business data EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 53

54 Defining Reports and Alerts with Process Reporting Services aggregation, page 109. Once created these aggregation entities are listed in the Business Data Aggregation category on the palette. Process variables are handled differently than SDTs and objects contained in packages. While they must be enabled for monitoring, there is only a single reporting entity called Process Variable that is listed as a child of only the process execution entity. This reporting entity displays each process variable as an entity field. Creating aggregated report entities for process variables is not supported. Working with alert entities The alert entity category consists of the Alert report entity and the Alert History report entity. The alert report entity allows users to report on new and unresolved alerts. Once resolved, an alert is moved to an archive table in the BAM database. From this table users can generate reports using the alert history report entity. Reports can include alert severity, status, date triggered, and date resolved. Understanding entity relationships Typically, reports are defined with more than one entity. The data source of a report starts with a parent entity and then subsequent entities are added by selecting from the palette in PRS. Each entity added is said to be related to the entity just to the left. The entities you choose and their relationships to other entities are defined in the BAM software. When Work Queue is selected, the only child that can be added is Work Queue Events. When Work Queue Events is selected the only children that can added are Activity Execution and Process Execution. The Process Execution entity has its own set of entities that are considered children, and so on with each reporting entity. Reports that contain parent-child relationships contain all of the data from the parent entity, and only the subset of data from the child entity that is related to the parent. For example, when Process Execution is the parent and Activity Execution is the child, then for each Process Execution instance, the report will show the related Activity Execution instances. If a certain process instance isn t included (perhaps because of a filter), then its related activity instances are also not included in the report. From a technical perspective, parent-child relationships represent a left-outer join between the parent and the child entity tables. 54 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

55 Defining Reports and Alerts with Process Reporting Services Figure 15. Entity relationship example Working with entity fields and captions Each report entity provides a view of a BAM database table. Each database table stores process execution data in rows and columns. Entity fields represent columnar data that can be added to any report. Once placed on the report canvas, the list of entity fields is displayed within the report entity. A check mark can be placed to the left of an entity field in order to add it to the data source. Each report entity has its own set of fields. The caption of each entity field can be changed by using the caption editor. Entity field names must be unique within a data source. For instance, if the Duration (hours) field is selected for both the Process Execution and the Activity Execution report entities, then.ae is automatically added to the duration (hours) field of Activity Execution. The suffix.ae is an abbreviation of the report entity to which the field belongs in this case, Activity Execution. If three or more duplicate fields are added, then a number is added to the second suffix. For example, Duration (hours), Duration (hours).ae, and Duration (hours).ae1. For Process Execution, this suffix is.pe. Unique data source fields applies to caption editor feature where users are prohibited from changing the name of a field to a name that already exists. For more information on editing captions please see Editing entity field captions, page 101. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 55

56 Defining Reports and Alerts with Process Reporting Services Figure 16. Entity fields Understanding report entity filtering A BAM database contains a great deal of process execution data. Without filtering, a report query returns all results. This could be thousands and thousands of data rows. Usually, this is not desired. Filtering reduces the results into a subset of data. This is achieved by defining constraints on one or more entities within a report. A filter consists of a filter expression written by selecting filter entities and entering values. Filter entities and values are selected by means of a series of filter tabs available within a Filter window, as shown in the figure below. 56 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

57 Defining Reports and Alerts with Process Reporting Services Figure 17. PRS filter window A filter expression is divided into four distinct segments: <Filter Tab Short Name>.<Filter Item Name><Operator><Value> Filter Tab Short Name each tab within the Filter window has a three character name that is automatically added to the beginning of the filter expression. This is the filter category. Filter Item Name within each tab is a tree menu that lists a number of filter entities that can be selected by the user. Operator users can select from a number of operators, including =, <, >, and Matches, among others. Value values can be selected from the tree menu or entered manually by the user. Note: String values must be placed surrounded by a single apostrophe ( ). Compound expressions can be written by using AND, OR, and parentheses. The Query button can be used to view the SQL. If an error message appears then the filter expression is not valid. Example 3-1. Filter expression The following filter expression constricts the data source to all process instances with the name ProcessLoan that were completed during the last day: PRO.Process-Name = 'LoanProcess' AND MSC.Finished-During-Last-Day = 'True' Note: The operator in this case AND can be entered by using the keyboard or selected from the icon pad. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 57

58 Defining Reports and Alerts with Process Reporting Services The filter tabs available for each report entity differ among entities. For instance, the work queue entity and the process execution entity have different sets of filter options. The table below summarizes the choices available. Please see Filtering report entities, page 89 for step-by-step instructions. A subset of these filters are available within a dashboard, too. Table 2. Report entity filters Filter tab name Standard (STD) Automation (AUT) Used for Defining filters based on a calendar, duration (if applicable), and performer data. Allows users to filter activities to include only those that are either Manual or Automatic. Applicable report entities All report entities Activity Execution All Activity Aggregation entities All Activity Performer Aggregation entities Processes and Activities (PRO and ACT) Miscellaneous (MSC) Queue (QUE) Allows users to create filters for specific processes and/activities. Contains options for filtering based on the status of an activity, its relative finish date, and whether the activity or process is currently ongoing. Ongoing process are also said to be in-flight. Allows users to filter queues by their name and/or ID. Activity Execution All Activity Aggregation entities Process Execution All Process Aggregation entities All Activity Performer Aggregation entities All business data report entities Activity Execution Process Execution Work Queue Events Work Queue 58 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

59 Defining Reports and Alerts with Process Reporting Services BAM-SDT (BSD) Alarm (ALM) Allows users to filter activity and process data by business data objects. Note: Business data filters are static and not dynamic. As a result, only business data fields are available as filter entities (for example, Customer_Name), rather than field values (for example, Customer_Name=Robert Long). This means that report designers must manually enter field values between the single quotes ( ) of the filter expression. Allows report designers to create filters based on alert name, alert status, severity, entity type, and entity name. Activity Execution Process Execution All business data reporting entities Alerts Understanding simple report types Simple reports use a Flash component that renders data driven animated charts. They are created by a multistep wizard located in the center of the user interface. It holds four tabs (Data Source, Chart Type, Chart Data, and Chart Properties) that represent each step in the report creation process. To navigate through the wizard, users click either Next/Back in the upper right or select the appropriate tab (chart type, chart data, etc.) at the bottom of the editor. In the Chart Type step, users select the basic format of the report. For example, a report can be represented as a pie chart or bar chart. Within the Chart Data tab users label one or more data series. In the Chart Properties step, users can change the font, add a legend, and work with other advanced properties. All properties have default values that can be changed. All configuration options are available in the Properties window located to the right of the wizard. A Preview window is located below the wizard and displays the result of the data source. The entity fields of a report are represented as columns. Making a column visible in a report and its relative order in the report are specified in the Chart Data tab. Even though an entity is selected in the data source, it can be hidden from the report by selecting No in the Visible field for a specific column. Order is determined by specifying the column of data (the entity field) for Category (X-axis) and one or more Value (Y-axis). Each chart type generates its report based on the order of the columns and on the format of the data EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 59

60 Defining Reports and Alerts with Process Reporting Services included in the report. This section describes the relationship between chart data and chart types for each report type available. Working with pie charts and bar charts Pie and bar charts take data from the first and second columns in the report. These charts include a category (X-axis) and a single value (Y-axis). Any column included in the data source can be selected as either the category or value. Note: For pie and bar charts, the value (Y-axis) must be numeric. This figure below displays the duration in hours (value) for each process instance (category). Figure 18. Process duration bar chart Working with gauge reports The purpose of a Gauge report is to provide a general understanding of how well processes are executing. The following example calculates the average duration (in hours) it takes for a process to complete. This average falls within one of three zones either green, yellow, or red that are configured by the report designer. Dial lower limit, upper limit and zone ranges are defined in the Chart Properties tab. For instance, the green zone extends from the dial s lower limit (zero) to 40 hours. This means that if the 60 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

61 Defining Reports and Alerts with Process Reporting Services average duration falls between 0 and 40 hours, then processes are executing smoothly, in a timely manner. In this example, however, the average process duration is which falls in the yellow zone. The yellow zone is defined in Range-2 and extends from 40 to 70 hours. And finally, the red zone ranges from 70 to the dial s upper limit of 100 hours. Figure 19. Process duration gauge In this example, a number of process instances were started, but not yet completed, within the last two days. But we don t see each and every process instance in the Data Source Preview window. This is because an aggregation reporting entity was used in the report definition. Among other things, aggregation entities allow you to calculate average process duration for a specific period of time (hour, day, week). The arrow in the dial gauge points to the average duration value of hours. Note: Average Duration (Hours) is the only entity field selected in the data source. Caution: The result set displayed in the Data Source Preview window can only contain one row. If multiple rows are returned, an error message is displayed. It may be helpful to use filtering to reduce the result set. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 61

62 Defining Reports and Alerts with Process Reporting Services Figure 20. Process duration dial gauge data source Working with bar + line charts Bar + Line charts include a single category (X-axis) and multiple values (Y-axis), called Series. Like other reports, the columns for both category and series are specified by the user. Multiple series allows users to include two or more dimensions of data with the same category in a bar chart. Each series can be expressed either as a line or a bar, as configured in the Type field of the Chart Data tab. Note: For bar with line charts, the series (Y-axis) must be numeric. The figure below displays a process duration report where duration is measured in both hours represented as a bar, and seconds represented as a line. Figure 21. Bar with line report 62 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

63 Defining Reports and Alerts with Process Reporting Services Working with table charts Reports formatted as a Table are the simplest to generate. These reports may contain several columns and since Y-axes are not a consideration, there are no rules about which columns should be numeric. Like other report types, the order in which columns are displayed is controlled by the order specified in the Chart Data tab. Figure 22. Table charts Understanding chart types and visual properties Each chart type has a number of visual properties that can be configured. This section lists the visual properties available for each chart type. Pie chart properties Animation (Yes/No) Background color Color Palette Font Format Numbers (Yes/No) Labels Subtitle Title EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 63

64 Defining Reports and Alerts with Process Reporting Services Values Bar and Bar + Line chart properties Animation (Yes/No) Axes Background color Font Format Numbers (Yes/No) Labels Legend Show Grid Background (Yes/No) SLA (used to specify a service level agreement value), shown as a horizontal line Subtitle Title Values Gauge properties Animation (Yes/No) Background Color Dial Lower Limit Dial Upper Limit Font Ranges (includes color, max and min values) Show Dial Value (Yes/No) Subtitle Title Table properties Background Color Font Header 64 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

65 Defining Reports and Alerts with Process Reporting Services Rows Color Subtitle Title Wrap Text (Yes/No) Understanding reports that use aggregation Process Reporting Services supports the notion of aggregation. Aggregation allows summary level reports to be designed, rather than reports that contain onlyinstance data. In the figure below, both the name of the process and its duration are displayed in the report. In fact, the Data Source Preview window shows a duration value for each instance of a process. The Simple Process, for example, has had two instances run; one that took 144 seconds and the other took 173 seconds. Figure 23. Report aggregation Aggregation allows report designers to calculate an average duration for each process. Aggregation is based on two principles: function and group-by. There are five basic arithmetic functions available: sum, count, average, max, and min. Aggregation requires each field in the data source to have a function according to the following rules: 1. Date fields only have Max and Min available, with Max as the default. 2. String fields only have Count available, which is also the default. 3. Numeric fields have all five functions available, with Count as the default. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 65

66 Defining Reports and Alerts with Process Reporting Services First, the data source of the report must be defined. Fields within the data source can then be aggregated. Once aggregation is defined, a field can still be added to the data source. When this happens, the new field is assigned the default aggregation based on it field type. The other principle of aggregation is grouping. Any field in the data source can be selected as a Group. Grouping indicates the data source field over which the function applies. There must be at least one group-by field selected. There may be multiple group-by fields selected. A group-by field cannot be assigned a function. In the figure below, process is selected as the group field. Together with the sum function, this report calculates the average duration (in seconds) for each process. Bear in mind, each process contains multiple process instances. Grouping takes individual process instances and collapses them so there is one row for each unique group-by field. Grouping makes the most sense when used on process name and ID and performer name and ID. Figure 24. Aggregation function and group-by The aggregation as defined above displays the results in the Data Source Preview window, where an average duration is calculated for each process. From here, the rest of the report can be designed, including selecting a chart type and configuring chart data. The same principles apply to reports that contain business data (SDTs or package object types) where business data fields can be aggregated. For example, a report can be designed to calculate the total amount of purchase orders (by using the SUM function on the field amount) for each state (where the field state is specified as the Group). Aggregating report data, page 81 contains the report aggregation step-by-step procedure. Caution: Typically, report aggregation performs calculations on process instance data. If there is a lot of instance data to be processed, for example, more than 500 rows of data, system performance will be compromised. As a result, BAM reports may begin taking a long time to load in the dashboard. If this is the case, you might 66 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

67 Defining Reports and Alerts with Process Reporting Services consider using the aggregation reporting entities that are shipped with the product. This topic is addressed in the following section. Note: Computed columns can be used to perform calculations on aggregated data. You cannot, however, aggregate computed columns. As a result, computed column fields do not appear in the Report Aggregation dialog. Understanding server aggregation Aggregating large amounts of instance data can be quite taxing to BAM and may eventually negatively impact system performance. In order to improve system performance it might make sense to use aggregation reporting entities. As described in Understanding the aggregation engine, page 26, every five minutes the aggregation engine runs a job that automatically aggregates process instance data and stores this data in special aggregation tables within the BAM database. Because the aggregation job is automatic and scheduled, it is considered server aggregation. There are nine aggregation tables each for process, activity, and performer entities that group instance level data into nine time periods (5 Minutes, 15 Minutes, etc). Example Minute process aggregation Suppose that, during the 5-minute interval from 1:00 to 1:05, three process instances started. The first one completed in 2 minutes, the second completed in 10 minutes, and the third completed in 9 minutes. The average duration is (2+10+9)/3 = 7 minutes. The following information would therefore be inserted into the 5 minute aggregation table: Process Start Interval 1:00 1:05 7 1:05 1: :10 1:15 15 Average Process Duration This table continues to be updated every five minutes with data for the next five minute time interval. Each of the other eight aggregation tables are derived from the 5 minute aggregation data. The 15 Minute aggregation table holds data that calculates average duration based on the 5 minute data rather basing this calculation on the instance data. That is, the 15 minute aggregation job aggregates 5 minute data, and not instance level data. This continues for the 30 minute aggregation which performs calculations on the 15 minute tables. The hourly aggregation data is calculated from the 30 minute data, and so on. Why is this important? Because reports that use aggregation entities display results only after the time period is over. For instance, you will not see any data displayed in reports that use the Process Execution Monthly entity until a month s time has passed. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 67

68 Defining Reports and Alerts with Process Reporting Services There are process, activity, and activity performer aggregation entities. Each report entity contains fields. The Process Execution 5 Minutes entity includes the following fields: Average Duration (milliseconds) calculates the average process duration in milliseconds. Average Duration (seconds) calculates the average process duration in seconds. Count of Completed Instances the number of process instances that completed within the time period. Count of Failed Instances the number of process instances that failed within the time period. Count of Ongoing Instances the number of process instances that were currently ongoing within the time period. Count of Started Instances the number of process instances that started within the time period. Finished Date and Time the end of the aggregation time period, for example, October 22, :10. Maximum Duration (milliseconds) the duration of the process instance within the time period that took the most time to complete. Minimum Duration (milliseconds) the duration of the process instance within the time period that took the least time to complete. Process the name of the process provides a context for all calculations. Process ID the process ID provides a context for all calculations. Start Date and Time the beginning of the aggregation time period, for example, October 22, :05. Version Number the version number of the process. There is a great deal of overlap in the fields available for each report entity. For example, the Process Execution Monthly report entity has exactly the same fields as Process Execution 5 Minutes. In addition, the only difference between the activity and performer entities is that activity aggregation entities contain fields like Activity and Activity ID, rather than Process and Process ID, or Performer Name and Performer ID. All of the average, count, max, and min calculations are the same for all entities. Reporting with aggregated data enhances system performance because the aggregation calculations have already been made. Suppose a user wants a graph to show the trend of process duration throughout the day. Using the Process Execution 30 Minutes report entity, the report designer could create an aggregate report that would run against no more than 48 rows (since one day contains 48 half hours). However, if the user had created a report that included instances, it might have to run against hundreds or even thousands of rows. 68 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

69 Defining Reports and Alerts with Process Reporting Services Understanding business data aggregation Aggregation entities can be made available for business data entities, too. In some cases, processes capture a lot of business data while they running. For this reason, aggregation tables and report entities are not automatically created for SDTs and package object types. If they were automatically created (as they are for process, activity, and performer objects) the BAM repository would quickly become quite full of data, most of which was not needed. Instead, BAM provides the tools for report designers to select fields, apply functions, and select a group-by field. Once configured, nine business data reporting entities are created beginning with the 5 minutes entity and continuing on to the Yearly entity. Configuring business data aggregation is based on the same principles as report aggregation. Example 3-3. Business data aggregation Let s suppose that nine loan origination processes started within a seven minute interval. For each process, the value of the loan amount and the state are captured. The table below represents how this instance data is stored in the database tables. Time Loan Amount State 1:00 200,000 NY 1:01 300,000 NJ 1:02 250,000 NY 1:02 100,000 NJ 1:04 300,000 NY 1:05 250,000 NJ 1:06 200,000 NY 1:07 300,000 NJ 1:07 250,000 NY Let s further suppose that report aggregation had been configured that provides a total loan amount for each state. At first, the report as designed worked well, but as time went on, BAM performance began to suffer. So, business data aggregation entities were created and used. In the figure below, the Business Data Aggregation window is used to select the loan amount field, which is summed, and the State field, which acts as the group-by. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 69

70 Defining Reports and Alerts with Process Reporting Services Figure 25. Business data aggregation The table below illustrates how BAM aggregates and stores the data based on the configuration. For each five minute interval the total loan amount is calculated (summed) for each state. Interval Loan Amount State 1:00 1:05 750,000 NY 1:00 1:05 650,000 NJ 1:05 1:10 450,000 NY 1:05 1:10 300,000 NJ This operation creates each of nine aggregation entities that include each of the selected fields, plus: Activity ID this field provides a context for the business data. Finished Date and Time the end of the aggregation time period, for example, October 22, :10. Instances count a count of processes instances for the time period. Start Date and Time the beginning of the aggregation time period, for example, October 22, :05. Configuring business data aggregation, page 109 outlines a step-by-step procedure for configuring business data aggregation. Understanding single drill-down reports A BAM dashboard supports two varieties of drill-down reports: single drill-down reports and multi-drill-down reports. Single drill-down reports are defined when a base report is linked with another published report, called a target. Once configured, single drill-down reports allow dashboard users to select a hyperlink which then changes the content of the base report to display the content of the target report. In addition, a trail of bread crumbs is displayed within the dashlet allowing users to navigate to the original, base 70 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

71 Defining Reports and Alerts with Process Reporting Services report. Target reports can also serve as a base report for another target. There is no limit to the number of drill-down layers used. Single drill-down reports can also open a URL in a new browser window. The URL must be absolute and specify the location of a web page in full. For example: Single drill-down reports are fully configured in PRS where a report designer is presented with a list of target reports or a field to enter the URL. The hyperlink within the base report correspond to a report s data source, and in particular X-axis and Y-axes data. For instance, if a table report contains five columns, then drill-downs can be configured for each column. A hand icon is displayed when the dashboard user scrolls over a hyperlink. Configuring single drill-down reports, page 95 addresses how to configure a single drill-down report. A filter expression can also be defined once a target report is selected. The filter expression is applied to the first entity in the report. Note: Drill-down reports are not available for gauge reports. Example 3-4. Single drill-down: base report In this example, a report that includes information about executing processes is used as a base report that is linked to an activity report. The drill-down relationship is defined for the Process Instance ID column which appears as a hyperlink to dashboard users. Once selected, the contents of the dashlet are populated with the activity report. The activity report displays only the activities for the selected process instance. This is achieved by defining a dynamic filter expression. Example 3-5. Single drill-down: target report Once a drill-down report is invoked, a trail of bread crumbs is displayed above the target report. This allows dashboard users to navigate back to the original, base report. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 71

72 Defining Reports and Alerts with Process Reporting Services Understanding the importance of filtering Filtering is a very important topic, especially when it comes to defining single drill-down reports. Most of the time the purpose of a single drill-down report is to navigate from level of information to more detailed information. If a filter were not defined in the example just discussed, the dashboard user would see all activities for every process instance rather than just the activities for the selected process instance. In this example, a dynamic filter expression has been defined. A dynamic filter expression means that the actual filter value is not fixed (static). Rather, the BAM system uses a value based on the actions of the dashboard user. Example 3-6. Dynamic filter for single drill-down report Continuing with the example, a dynamic filter expression has been defined by clicking the Filter button in the Drilldown window in PRS. This opens the Filter window. Any field included in the data source can be used in the filter expression. Dynamic filter values are selected by pressing Ctrl and spacebar on the keyboard, and then double-clicking the value. Configuring single drill-down reports, page 95 addresses how to configure a single drill-down report in greater detail. Understanding multi-drill-down reports Like single drill-down reports, multi-drill-down reports are also defined when a base report is linked to other published reports. Unlike single drill-down reports however, once a multi-drill-down report is invoked the content displayed in surrounding dashlets are updated rather than the contents of the base report. Configuring multi-drill-down reports, page 97 addresses how to configure a multi-drill-down report. Configuration involves both PRS and a dashboard. Example 3-7. Multi-drill-down report Process Instance List is the base report in this example. Its data source consists of the following fields: Start Date and Time, Finished Date and Time, Process, Process Instance ID, Version Number, and Duration. The process column in this table has a multi-drill-down relationship defined. This means that when a user clicks a specific loan process from within the table, the Process Details, Process Duration, and Process Diagram dashlets all refresh to display new reports with results limited to the process instance selected. 72 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

73 Defining Reports and Alerts with Process Reporting Services Figure 26. Multi-drill-down report in a dashboard Logging into Process Reporting Services This section includes the procedure for logging in to Process Reporting Services. Report designers must be assigned the ts_designer role in the Documentum repository. To log into Process Reporting Services 1. Double-click PRS.exe. The location of the program depends on your particular installation of Process Reporting Services. A Login window displays. 2. Select a repository from the pull-down list. 3. Enter a user name and password. 4. Click Ok. Note: If no repositories are listed it means that: the repository is not visible to the BAM server, or the URL connecting the BAM server to the docbase is not configured properly 5. To configure the URL click the Connect button and enter the URL. The address should be provided to you by your administrator. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 73

74 Defining Reports and Alerts with Process Reporting Services 6. Once the host URL is entered, click Ok. PRS validates the URL and returns the report designer to the server s login window where the user name and password are entered. Figure 27. PRS connection parameters Navigating Process Reporting Services The user interface of Process Reporting Services is divided into the following sections: Reports and Alerts Manager The report and alert managers are located on the left and display a folder tree view of report/alert categories that contain individual reports and alerts. Categories may contain subcategories. Reports and alerts must be saved within a category. Simple reports and Crystal Reports have different icons. Data sources are displayed beneath each report. Palette Reports and alerts are defined by selecting entities from the palette and placing them on the design canvas to the right. Design canvas Reports and alerts are designed on the canvas, located to the right of the palette. Entities expand to display entity fields. The relationship between entities is displayed with an arrow. Outline Outline provides a high level overview of a data source. If the data source contains many entities, click and drag within the outline image to quickly navigate. Data Source Preview After a data source is saved users can click the refresh button to view the results. Properties There are four steps to creating a simple report: defining a data source, selecting a chart type, formatting chart data, and selecting chart properties. The Properties tab presents users with all available configuration options available for each step. This tab is also used to display general information, such as the object ID of the report or category. 74 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

75 Defining Reports and Alerts with Process Reporting Services Figure 28. Process Reporting Services navigation Creating a report category Report categories hold reports or other report categories. PRS is shipped with a report category called Preconfigured Dashboard located under the Report Categories folder. This category holds all report definitions used in each preconfigured dashboard. For more information on the preconfigured dashboard please see Chapter 6, Working with Preconfigured Dashboards. Report categories can be added to either folder. To create a report category 1. Log into PRS. 2. Select the Reports tab. 3. To add a report category to the root, select Report Categories. 4. To add a report category anywhere else, select the appropriate report category. Note: A report category can only be added to another report category. 5. Select File > New > Category. Note: Users can also select New > Category from the report category right-click pop-up menu. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 75

76 Defining Reports and Alerts with Process Reporting Services 6. To select a Parent Category click the Browse... The default parent category was selected in Step Enter a category name. The name must be unique within a parent category. 8. Click Finish. Creating a simple report A simple report is created in four steps. First, a data source is defined. Then a chart type is selected and data formatted. Finally, additional report properties are configured. Once a chart type is selected, the design canvas graphically displays the report. As each configuration option is updated, the report is updated. It is important for you to understand the relationship between chart types and chart data configuration. This topic is addressed in Understanding simple report types, page 59. In addition, it is important for you to understand chart properties. This topic is addressed in Understanding chart types and visual properties, page 63. To create a simple report 1. Log into PRS. 2. Select the Reports tab. 3. Select a report category. 4. Select File > New > Simple Report. 5. To select a different, parent category click Browse. 6. Enter a report name. The name must be unique within a category. Caution: Report names must be less than 150 characters. 7. Click Finish. An empty data source is created as a child of the report. In addition, a simple report icon appears next to the report name. 76 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

77 Defining Reports and Alerts with Process Reporting Services Figure 29. Select report category and name 8. Within the data source builder select a report entity from the palette and then click once on the design canvas. Or, you can drag and drop entities. The entity and all entity fields are displayed. For more information on report entities, please see Understanding report entities, page 50, Working with business data entities, page 53, Working with activity and process aggregation entities, page 51, and Working with activity performer aggregation entities, page 52. Note: Once the report entity is added to the drawing area, the palette changes to include only those entities that are children of the added entity. This is also true when an entity has been selected by the report designer. 9. Place a check mark next to each entity field you want to add to the data source. The entity field is added as a column in the data source preview. For more information on entity fields and captions please see Working with entity fields and captions, page 55 and Editing entity field captions, page 101. Note: Entity field names must be unique within a data source. Figure 30. Select entity fields EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 77

78 Defining Reports and Alerts with Process Reporting Services 10. From the palette, click and drag a child entity and place it anywhere in the drawing area. An arrow is automatically drawn between the parent entity and the child entity. 11. Continue adding report entities and selecting entity fields as required. 12. Click the Refresh button to preview the data source. Figure 31. Data Source Preview Note: Report designers can specify the number of rows displayed in the preview by entering a value in. 13. Click either Next or the Chart Type tab located at the bottom of the report design canvas. 14. Select a chart type in the Properties window to the right. 15. Click either Next or the Chart Data tab. 16. Configure the chart data within the Properties window. For more information about chart types and chart data options please see Understanding simple report types, page 59. Figure 32. Format data series 17. Click either Next or the Chart Properties tab. 78 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

79 Defining Reports and Alerts with Process Reporting Services 18. Configure the chart properties in the Properties window. For more information regarding chart visual properties please see Understanding chart types and visual properties, page Select File > Save. Sorting report columns Reports can be sorted by a single column. Sorting is supported in all report types except for gauge reports. The sort feature allows users to select a single sort column and a direction, both of which are configured in the Chart Data tab. Any selected data source field can be used as the sort column. The data within a column can be sorted in either ascending or descending order. To sort report columns 1. Define the data source of the report and select the Chart Data tab. 2. Expand the Sort property. 3. Select a sort Column. 4. Select a sort Direction. 5. Click the Refresh button in the Data Source Preview window. Modifying bar chart labels Bar chart labels can be constrained to a specific number of characters. The Labels > Limit Characters property allows users to select how many characters of the label are displayed (up to 29). A limit of 0 displays all characters. The Direction property indicates whether the beginning of the label is truncated or the end of the label truncated. For example, if the process name is Process Sales Order and the label limit is 8, then es Order appears when left is selected as the direction, and Process appears when right is selected as the direction. To modify the length of bar chart labels 1. Create a Bar or Bar+Line chart. 2. Select the Chart Properties tab. 3. Open the Labels property. 4. Open the Limit Characters property. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 79

80 Defining Reports and Alerts with Process Reporting Services 5. Enter a label limit. 6. Select a direction. 7. Click the Refresh button in the Data Source Preview window. Choosing bar and pie chart colors Report designers can choose the color of each bar in a bar chart and each slice in a pie chart. The color of only the first 10 bars or slices can be changed. To choose bar and pie chart colors 1. Design either a bar chart or a pie chart. 2. Click the Chart Properties tab. 3. Click the browse button to the right of the color palette field. This opens the Color Palette window. 4. Each bar or slice has a corresponding color. Select the desired color from the drop-down list. 5. Click Ok in the Color Palette window. The new color is automatically applied to the bar or pie chart. 80 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

81 Defining Reports and Alerts with Process Reporting Services Figure 33. Bar and pie chart color palette Aggregating report data Report aggregation provides summary level reports and is configured by using the fields included in the report s data source. Aggregation involves selecting a function for one or more fields, and selecting a group-by field. There are five basic arithmetic functions available: sum, count, average, max, and min. The choice of arithmetic functions available is determined by the field type. For example, for date fields only the Max and Min functions can be selected. Grouping indicates the data source field over which the function applies. At least one group-by field must be selected.understanding reports that use aggregation, page 65 describes report aggregation in more detail. To aggregate report data 1. Define the data source of a report. Note: Aggregation requires the report to be open and selected from the tree menu on the left. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 81

82 Defining Reports and Alerts with Process Reporting Services 2. Click the Report Aggregation button. This opens the Aggregation window where all selected fields are displayed for each report entity. Note: Each field has a default function selected. This can be changed. In addition, a default group-by field is also selected. 3. Select the appropriate aggregation function for each field. 4. Select the group-by field. 5. Click Ok. This closes the Aggregation window and brings you back to the data source editor. Figure 34. Aggregating report data Note: The group-by field and the aggregation function are marked next to the field for each report entity. Scrolling over the aggregation displays its type. 82 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

83 Defining Reports and Alerts with Process Reporting Services Figure 35. Aggregation in data source editor Note: Aggregation applies to the data displayed in the Data Source Preview window. Click the Refresh button to see the aggregated data. Note: If a new field is selected, the default aggregation is automatically applied based on its field type. In addition, you must have at least one group-by field. Additional group-by fields can be removed from the data source. 6. Save the report. Removing report aggregation Report aggregation is removed in the Aggregation window. Once removed, data source fields will no longer have arithmetic functions applied to them. To remove report aggregation 1. Open the report and make sure it is selected on the left tree menu. 2. Click the Report Aggregation button. This opens the Aggregation window. 3. Click Remove Aggregation. 4. Click Ok. This brings you back to the Data Source Preview window. You will notice that the aggregation icons have been removed from the report entities. 5. Save the report. 6. Click the Refresh button in the Data Source Preview window to update the preview. Adding computed columns to a report BAM supports the notion of computed columns. After the data source of a report is defined the user can create additional fields that represent a function of one or more fields in EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 83

84 Defining Reports and Alerts with Process Reporting Services the original data source. The most obvious example of a computed column takes field values and either adds, substracts, multiplies, or divides it by some constant value. For example, a computed column expression can be defined that takes duration (minutes) and converts it to duration (hours): ${Duration (minutes)}/60 In another example, suppose you want to add Field1 and Field2 together. The computed column expression would be: ${Field1} + ${Field2} The syntax of the function is a JEP expression where fields in the data source are referred to by their name delimited by ${}. Users can access help with writing JEP expressions by clicking the Help icon. The primary purpose of a computed field is formatting. This means the user has control over the contents of the new column. Let s take an example that does not involve a computation. Let s suppose that you want to include performer name in a report. While a BAM report can include Performer Name, it is displayed with its technical name (for example, acct_processor) rather a business-oriented name (for example, Account Processor). The computed columns feature allows you to take all instances of acct_processor, and rename it to be Account Processor. The following logical if...else expression: takes all instances of the aa performer name and changes them to Account Processor takes all instances of the sales_processor performer name and changes them to Sales Processor takes all other performer names and changes them to Other Processor if (${Performer Name}=="aa", "Account Processor", (if (${Performer Name}=="sales_processo "Sales Processor", "Other Processor"))) Once refreshed, the Data Source Preview window shows: Example 3-8. Other uses of computed columns Computed columns can also be used to format date fields, comparing one value to another, and appending a suffix certain fields. Use Syntax Description Format date fields formatdate(${start Date and Time}, "mm/dd/yy") All start dates and times are converted to the mm/dd/yy format. Example: Oct 20, :05 AM is formatted as 10/20/ EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

85 Defining Reports and Alerts with Process Reporting Services Compareif (${cost} > 55, "Approved", one "Rejected") value to another Appendstr(${Duration (seconds)} * a 60) " minutes" suffix to values In this example, if a value in the cost column exceeds 55, then display the word Approved. Otherwise, display Rejected. In this example a new column is created that both converts duration into minutes, and adds the word minutes to the right of the value (example, 43 minutes). The name of the computed column must be unique within the data source. Expressions are validated by the system. If an expression is not valid, the Ok button remains grayed out. Only one computed column can be created at a time. Once added to the canvas, the Computed Columns entity is added to the data source, but does not have relationships with other entities. In addition, no child entities are available on the palette. Note: Computed columns can be used to perform calculations on aggregated data. You cannot, however, aggregate computed columns. As a result, computed column fields do not appear in the Report Aggregation dialog. Note: You cannot divide by zero. An error is displayed in PRS. To generate a report with computed columns 1. Define a data source, adding entities and entity fields. 2. Click the Computed Column button. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 85

86 Defining Reports and Alerts with Process Reporting Services Figure 36. Computed columns report entity 3. Enter a name for the computed column. The name must be unique within the data source. 4. Enter a computed column expression by: a. Placing your cursor in the Expression field. b. Press the Ctrl key and the spacebar on your keyboard simultaneously. This displays a list of fields that can be used in the expression. c. Double-click the first field used in the expression. d. Use the keypad to select a JEP operator or enter an operator manually (for example, *, /, +, and are supported). e. Enter a value after the operator. f. Click Ok. Note: Expressions are automatically validated by the system. If an expression is not valid, the Ok button is grayed out. 86 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

87 Defining Reports and Alerts with Process Reporting Services Figure 37. Computed column expression 5. Notice that the computed column report entity has been added to the report design. In addition, the computed column has been added to the Data Source Preview window. Click the Refresh button in the Data Source Preview window. Figure 38. Computed columns results EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 87

88 Defining Reports and Alerts with Process Reporting Services Adding a computed column Existing computed columns (in the example below, Performer s Name) can be made visible in the data source by deselecting (or selecting) the check to the left of the column. This procedure guides users in adding a new computed column to a data source. To add a new computed column 1. Select the computed column entity. The entity title turns orange. 2. Click the Computed Columns button. This opens the Computed Columns window where you can define a new computed column. Figure 39. Add computed column 3. Follow the procedure outlined in Adding computed columns to a report, page 83. Editing or deleting a computed column Computed columns can be edited or deleted. When Edit Column is selected, the user is brought to the Computed Columns window where changes can be made to the computed column name and the expression. Computed columns can be deleted in three ways: removing the Computed Columns entity from the canvas (this deletes all computed columns in one step), through the right-click menu (outlined below), or by removing entity fields from the data source that have also been used in a computed column expression. When entity fields are removed, the user is shown a list of those columns that will also be deleted, and is asked to continue. Figure 40. Edit computed column 88 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

89 Defining Reports and Alerts with Process Reporting Services To edit or delete a computed column 1. Select the Computed Column entity. The entity title turns orange. 2. Right-click the entity title and select Edit Column or Delete Column. Note: The computed columns entity can be removed from the data source by highlighting it and pressing the Delete key on the keyboard. Previewing a data source Previewing a data source is a step in creating both a simple report or a Crystal Report. Previewing a data source is useful in determining if there is execution data in the BAM database. All report entity filters are applied to the data source preview. Report designers can enter the number of rows to preview by entering a value in the Limit Rows field. Alternatively, all rows are returned when the Limit Rows checkbox is deselected. To preview a data source 1. Define a data source, adding entities and entity fields. Note: Entity field names must be unique within a data source. 2. Click the Refresh button. The first 100 rows of report data are displayed. You can choose the number of rows returned by entering a value in. Figure 41. Preview data source Filtering report entities Filter expressions are written by navigating a series of filter tabs, selecting a filter entity and entering a filter value. Each report entity has its own set of filters. For more information regarding filtering, please see Understanding report entity filtering, page 56. To filter a report entity 1. Right-click a report entity and select Filter. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 89

90 Defining Reports and Alerts with Process Reporting Services 2. Select the appropriate filter tab. Each tab contains a number of filter values. 3. Navigate the tree and double-click a filter value. This adds the value to the Filter Expression field. Note: The default operator is an equal sign (=). You can change this manually by removing the equal sign in the expression, and then choosing a new operator from the keypad. Note: If you want to define a compound filter expression, click either the And or Or button and continuing adding values. 4. Click Ok when you have completed defining the filter. Figure 42. Define data source entity filter Using filter variables A filter variable can be used to limit the data displayed in dashboard reports to that owned by a specific dashboard user. Filter variables provide dashboard users with report data that only they are permitted to see, while preventing them from seeing data that is not intended for them. Filter variables are not the hard coded values typical of most filter expressions. Rather, they are resolved during the execution of the report 90 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

91 Defining Reports and Alerts with Process Reporting Services when the value for the variable is replaced with the actual value of the user and his or her group. Filter variables work with any report where the username and/or default group is captured. Filter variables work as following: 1. Username and default group data must be captured while the process is running. This data can be captured in: a package attribute or SDT (the label of these attributes does not matter) performer name a custom reporting entity that has user name as one of its fields 2. The objects that capture username and default group data must be monitored at the beginning of the process. 3. The user and default group variables in the filter expression must be surrounded by an apostrophe. Note: The variables names are case insensitive, yield the same result. Creating a Crystal Report Process Reporting Services is capable of working with Business Objects Crystal Reports XI Release 2 application to generate advanced reports. A data source can be exported EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 91

92 Defining Reports and Alerts with Process Reporting Services from PRS to Crystal Reports where a user can format it. The external Crystal Reports application automatically starts. If it is not installed on the user s local machine then an error message appears. Once the formatting is complete the report is imported back into PRS (there is a synchronization function) where it can be published to the dashboard. Caution: This synchronization function assumes that the report is being imported from the same directory to which it was exported. Specific Crystal Reports procedures are not in scope for this documentation. Please refer to the Crystal Reports user guide for specific procedures. To create a Crystal Report 1. Log into PRS. 2. Select the Reports tab. 3. Select a report category. 4. Select File > New > Crystal Report. 5. To select a different parent category click Browse. 6. Enter a report name. The name must be unique within a category. Caution: Report names must be less than 150 characters. 7. Click Finish. An empty data source is created as a child of the report. In addition, a Crystal Report icon appears next to the report name. Figure 43. Select Report Location 8. Within the data source builder, click a report entity on the palette and then click once on the design canvas. Or, you can drag and drop entities. The entity and all entity fields are displayed. For more information on report entities, please see Understanding report entities, page 50, Working with business data entities, page 53, Working with activity and process aggregation entities, page 51, and Working with activity performer aggregation entities, page EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

93 Defining Reports and Alerts with Process Reporting Services Note: Once the report entity is added to the drawing area, the palette changes to include only those entities that are children of the added entity. 9. Place a check mark next to each entity field you want to add to the report. The entity field is added as a column in the data source preview. For more information on entity fields and captions please see Working with entity fields and captions, page 55 and Editing entity field captions, page 101. Figure 44. Add report entity 10. To add a child entity, click and drag a report entity from the palette and place it anywhere in the drawing area. An arrow is automatically drawn between the parent entity and the child entity. 11. Continue adding report entities and selecting entity fields as required. 12. Click the Refresh button located in the Preview Data Source window. Note: Report designers can specify the number of rows displayed in the preview by entering a value in. 13. Click the button. This automatically opens the Crystal Reports editor. Note: The report designer is prevented from making changes to the data source once the Open in Crystal Reports button is pressed. 14. Format the report with Crystal Reports. 15. From within Crystal Reports save the report using the Save function. Caution: Do not use Save As... The report must be saved to the same directory in which is was created. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 93

94 Defining Reports and Alerts with Process Reporting Services 16. Within PRS, right-click the report in the Reports tab and select Synchronize. This brings the updated report back into PRS. 17. Click the View tab to preview the report. The report can now be published to the BAM dashboard. Caution: Data cannot be refreshed from PRS into Crystal Reports by using the refresh menu option in Crystal Reports. Creating a report based on an existing data source A data source for one report can be used as the data source in another report. This is accomplished by copying and pasting the existing data source into the data source of the new report. This procedure completely overwrites the existing data source of the new report, and replaces it with the copied data source. To create a report based on an existing data source 1. Create and save a new report. 2. Then, from the list of reports on the left click the plus sign (+) to the left of the report containing the data source you want to copy. 3. Right-click the data source and select Copy. 4. Right-click the report containing the data source you want to replace and select Paste. 5. Click Ok at the prompt. Publishing draft reports All reports begin as a draft report. Draft reports are works in progress and cannot be displayed in the dashboard until they are published. Publishing makes a report available on the dashboard design palette. From here, a dashboard designer can use the report in one or more dashboards. To publish a report 1. Select the report from the Reports tab. 2. Select Published from the State pull-down list. This makes the report available to the dashboard. 94 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

95 Defining Reports and Alerts with Process Reporting Services 3. Save the report. Auto refreshing reports The auto-refresh feature automatically saves and reformats a report as a report designer moves through the Chart Type, Chart Data, and Chart Properties tabs. This is helpful for dashboard users who get immediate feedback on the look and feel of a report. Auto refresh is not available for the Data Source tab. To auto refresh reports 1. Create a new or update an existing report in the Report Editor. 2. Select the Auto Refresh check box. Configuring single drill-down reports Single drill-down reports are completely configured in PRS where report designers first select a data source series or column and then work in the Chart Data tab to select a report and filter or enter a URL. Understanding single drill-down reports, page 70 provides an overview of the single drill-down feature. Both published and draft reports can be configured as a source or target report. To configure a single drill-down report 1. Define a simple report. 2. Select either Pie, Bar, or Table as the chart type. 3. Within the Chart Data tab locate the series or column for which you are defining a drill-down report. 4. Click in the Drilldown field. 5. To define a drill-down to another report: a. Select the Report radio button. b. Browse to and select a target report. c. Click the Filter button to define a filter expression. d. Select a filter tab and filter tree item and move it to the Filter Expression field by double-clicking. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 95

96 Defining Reports and Alerts with Process Reporting Services e. Place your cursor within the single quotes and press the Ctrl and spacebar keys on your keyboard simultaneously. This provides a list of dynamic filter values. f. Double-click a dynamic filter value and click Ok to close the Filter window. Figure 45. Dynamic filter expression 6. To define a drill-down to a URL, select the URL radio button and enter a URL in the field provided. Note: The URL must be absolute and specify the location of a web page in full. For example: 7. Click Ok. Figure 46. Drill-down window 96 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

97 Defining Reports and Alerts with Process Reporting Services Configuring multi-drill-down reports Multi-drill-down reports are configured in two phases. First, as with single drill-down reports, the hyperlink is configured in PRS. Then, the group of dashlets that are updated once the hyperlink is selected is configured in the dashboard by a dashboard designer. This section outlines the procedure for configuring multi-drill-down reports in PRS, and then configuring multi-drill-down reports in a dashboard. Understanding multi-drill-down reports, page 72 provides an overview of the multi-drill-down feature. To configure a multi-drill-down report in PRS 1. Define a data source. The data source must include one or more of the following entity fields: Process ID, Process Instance ID, Activity ID, or Activity Instance ID. Note: This data, even if not visible in the report as configured in the Chart Data tab, are used as parameters that are passed to each of the surrounding dashlets. Without this data the multi-drill-down report does not work. 2. Selects the column or series for which the drilldown is defined. Currently, four dashboard events are supported: process, process instance, activity, and activity instance. A dashboard event is defined as a change in either a process ID, process instance ID, activity ID, or activity instance ID value. Caution: The selected dashboard event must also be selected as an entity field in the data source, even if the entity field is hidden from being displayed in the report. In this example, each time a process is selected in the table, the surrounding dashlets are updated to display process instance data. Therefore, Process Instance ID is selected as an entity field in the data source and Process Instance is selected from the Dashboard Event pull-down list. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 97

98 Defining Reports and Alerts with Process Reporting Services Figure 47. Multi-drill configuration in PRS The second part of a multi-drill-down report is configured within a dashboard. Within the Multi-Drill tab three columns are displayed: Event, Dashlet, and Target. The event column contains of a list of all dashboard events, and each dashboard event is repeated for each dashlet included in the dashboard. The dashlet column displays the name of each base report shown within the dashlet. The target column is configured to display the name of the report to be shown once an event is triggered. Continuing with the example, each time a process is selected in the Process Instance List report, the System processes status bars report changes to display process instance data in the Process Details report. The same logic applies to the started processes statistics and Process Diagram dashlets. To configure a multi-drill-down report in a dashboard 1. Create a dashboard and add the desired dashlets. 2. Select the Multi-Drill tab. 3. Select the checkbox corresponding to the dashboard event and dashlet combination for which the multi-drill is being defined. 4. Click the button within Target to select a target report. This opens the Content Chooser window. 5. Select a report and click Ok. 98 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

99 Defining Reports and Alerts with Process Reporting Services Figure 48. Multi-drill configuration in a dashboard Configuring Crystal Report drill-downs Configuring a drill-down report for a crystal report is performed exclusively in the Crystal Reports software application. This configuration involves selecting a column in the report and formatting a hyperlink. The hyperlink type must be website on the Internet and the URL must follow a particular convention. The URL begins by referencing the report servlet name directly, and then continues with the report type, report name, and path. The URL uses the following convention: dashboardreports?drtype=drilldown_type&reporttype=2&reportname=<report Name> &reportpath=<report Path>&filterExpression=<Filter Expression> Where: drtype=drilldown_type reporttype=2 this is the Crystal Reports type. Simple reports are type=1. reportname the name of the report as it is entered in PRS. reportpath the full path to the report. filterexpression filter expressions are optional. In addition, a formula can be used when a value from the source report is used as part of the filter to the target report. If you are using a formula, insert the URL in quotes. If you are referencing a field value from the report, add it outside the quotes. Example 3-9. Crystal Report drill-down report URL dashboardreports?drtype=drilldown_type&reportpath=/system/bam/report Categories /Crystal&reportName=Process Duration by Region&reportType=2&filterExpression= ACT.Activity-Name = '" + {datasource.activityactivity Execution1} + "'" For more information on the URL convention please see Displaying BAM reports in an enterprise portal, page 111. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 99

100 Defining Reports and Alerts with Process Reporting Services Editing reports A saved report can be opened and edited. All aspects of a simple report can be updated, including its data source, chart type, chart data, and other properties. Editing a data source involves adding new report entities, updating entity fields, and adding or editing filters. The Crystal Reports editor must be used to modify the format of a Crystal Report Note: The data source for a Crystal Report cannot be edited once the report is opened in the Crystal Reports editor. Note: The Next/Back navigation buttons used when creating a new report are not available when editing a report. You must navigate the report by using the Chart Type, Chart Data, and Chart Properties tabs. To edit a report 1. Locate the report in the Reports tab. 2. Right-click the report and select Open. Note: Reports can also be opened by double-clicking. 3. Edit the report. 4. Select File > Save. Deleting reports Reports can be deleted from within PRS. If the report is used in a dashboard, the dashboard user receives the following error message: This report cannot be displayed. Please contact your System Administrator. Any report designer can delete any report. To delete a report 1. Navigate the list of reports. 2. Select the report to be deleted. 3. Select Edit > Delete from the menu. You can also right-click the report and select Delete. 4. Click Ok at the prompt. 100 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

101 Defining Reports and Alerts with Process Reporting Services Exporting reports Users should export reports when they want to use them in another repository. Both the data source and all report properties are contained in an XML file that is imported back into PRS. To export a report 1. Navigate the list of reports. 2. Select the report to be exported. 3. Select File > Export from the menu. You can also right-click the report and select Export. 4. Select a directory and save the report. Importing reports Reports can be shared between repositories. First a report is exported. Then, the report is imported. To import a report 1. Navigate the Report Builder. 2. Select the category into which the report will be imported. 3. Select File > Import from the menu. 4. Select a report and import it. Editing entity field captions Changing the label of an entity field is an optional step taken when a report is defined. Entity field captions are changed in the Caption Editor window that is opened by right-clicking any report entity in the data source. Users can also click the caption editor button. The Caption Editor window displays only those data source fields that have been selected for all report entities. The second column of the window displays the name of the report entity to which the entity field belongs. Note: Any of the entity field captions can be changed within the Caption Editor window, even if they don t belong to the selected report entity. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 101

102 Defining Reports and Alerts with Process Reporting Services Figure 49. Caption editor To edit the caption of an entity field 1. Right-click a report entity and select Caption Editor. Or, click the caption editor button. 2. Change the label in the caption column. The caption can be any length. Caution: Entity field names must be unique within a data source. 3. Click Ok. This updates the name of the column in the data source preview. Using the data source undo/redo feature An undo/redo feature is available in the data source builder. It is not available for any other step in the report creation process. Within the data source builder this operation applies to adding and removing report entities, selecting entity fields, and defining filters, and editing a caption. Note: A save operation resets the undo/redo operations that can be performed. To undo/redo an action 1. To undo an action, select Undo from the Edit menu. 2. To redo an action, select Redo from the Edit menu. Note: The undo/redo feature can also be invoked with the right-click pop-up menu. 102 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

103 Defining Reports and Alerts with Process Reporting Services Creating an alert category Alerts are categorized within the Alerts tab. Alert categories can contain subcategories. To create an alert category 1. Log in to PRS. For more information on logging in, please see Logging into Process Reporting Services, page Select the Alerts tab. 3. Select Alert Categories or an existing subcategory on the left and then select File > New > Category. You can also right-click a category and select New > Category. 4. Enter a category name. 5. Select File > Save. Categories contain individual alerts. Creating an alert Process Reporting Services contains an alert builder that enables report designers to define process alerts in the system. Alerts are based on a data source that is evaluated by an alert engine. For each evaluation, the results of the alert are compared against an alert expression. An alert expression is a boolean-logic statement that is evaluated against the columns of the data source. This evaluation occurs periodically, at a scheduled interval by the alert engine on the BAM server. Expressions are comprised of entity fields, operators, and constants. Alert expressions can be simple or complex. Simple alert expressions are defined with one or two conditions, while complex alert expressions can contain many conditions. Evaluations occur every 15 seconds, and if there is a match, the contents of the alert list dashlet displayed in a dashboard are updated. In addition, notifications are sent to selected individuals that can then respond to and resolve the alert. The alert engine only retrieves data that was added since the last evaluation. recipients and the body of the alert message are configured when the alert is defined. For more information about the alert engine, please see Understanding the alert engine, page 27. Alerts are organized by category. There may be several alerts within a category, and there may also be several subcategories within a category. An alert can be opened, renamed, copied, and deleted. Example Simple alert expression In the example below an alert is triggered each time a loan origination process takes more than 24 hours to complete. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 103

104 Defining Reports and Alerts with Process Reporting Services Process="Loan Origination" AND Duration (hours) > 24 Example Complex alert expression In this example an alert is triggered based on insurance claim amount, claimant age, and address. Ongoing Duration (Hours) > 1 && ( (Customer Age > 20 && Customer Age < 30 && (Customer Residence == "NY" Customer Residence == "NJ") && Claim Amount > ) (Customer Age < 20 && Customer Residence == "NY" && Claim Amount > ) (Customer Age > 30 && Customer Residence == "MA" && Claim Amount > ) ) Report designers enter filter expressions by selecting from a list of available columns and entering boolean operators and values. Expressions are represented as a string and then evaluated using a Java Expression Parser (JEP). JEP is a Java library for parsing and evaluating mathematical expressions. String expressions are parsed and represented as a tree structure that is evaluated. The following JEP operators are supported: Table 3. JEP operators Name Modulus % Division / Multiplication * Symbol Addition, Subtraction +, Less or Equal, More or Equal <=, >= Less Than, Greater Than <, > Not Equal, Equal!=, == Boolean And Boolean Or For more information on JEP, please see index.html. An expression is automatically validated as it is typed. After an alert expression is defined, the report designer can select the role(s) of those individuals that should receive an notification when the alert is triggered. Using the notification feature is optional. Note: s are sent from the owner of the Documentum repository. The address of the repository s owner must be configured properly in order for s to be sent. && 104 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

105 Defining Reports and Alerts with Process Reporting Services In addition to an notification, other processes can be invoked automatically when an alert is triggered. Invoked processes must be designed to listen on an HTTP port. The BAM server is capable of starting a process configured to be triggered by a HTTP call. It is the responsibility of the report designer to enter the process parameters manually. The Documentum Process Builder User Guide provides more information on configuring an HTTP inbound activity template. Figure 50. Alert Builder user interface Note: IMPORTANT: Duration alerts require special consideration. If you want to be made aware of a process or activity that is exceeding a duration threshold as it is still being executed, then you must use the Incomplete Process Execution and Incomplete Activity Execution report entities, respectively. If you want to be made aware of those processes or activities that have exceeded a duration threshold after the process or activity is completed, then use the Process Execution or Activity Execution report entity. In addition, when defining either process or activities alerts that include duration, the Process Instance ID and Process ID or Activity Instance ID and Activity ID entity fields must be selected in the data source. To create an alert 1. Log in to PRS. 2. Select the Alerts tab. 3. Select an alert category. 4. Select File > New > Alert or right-click the alert category and select New > Alert. 5. To select a new, parent category click Browse. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 105

106 Defining Reports and Alerts with Process Reporting Services 6. Enter an alert name. 7. Click Finish. Caution: Alert names must be less than 150 characters. This adds the alert to the category in the Alerts tab and opens the Data Source tab. A data source can now be defined. 8. Build the alert by clicking, dragging, and placing objects from the palette onto the Data Source window. 9. Each object contains entity fields. To select an entity field, place a check mark to the left of the field name. Figure 51. Data Source Builder Note: Only fields that are selected are used in alert expressions. 10. Click the Alert tab located to the right of the DataSource tab. 11. To change the severity select a new Severity from the pull-down list. The severity level corresponds to the color of the alert icon displayed in the dashboard: Low = yellow Medium = orange High = red 12. To publish an alert, select Published from the State pull-down list. Published alerts are made available to the alert engine for evaluation. 13. Place your cursor in the Expression field and press the Ctrl key and spacebar on your keyboard simultaneously. This displays a list of entity fields that can be used in an alert expression. 14. To enter an alert expression: a. Double-click the first entity field included in the alert expression. This displays the field name in the Alert Expression field. 106 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

107 Defining Reports and Alerts with Process Reporting Services b. Enter an operator using your keyboard or the keypad. c. Enter a value after the operator. 15. Select an recipient from the Sent to: pull-down list. Use the Ctrl or Shift keys to select multiple recipients. Note: s are sent from the owner of the Documentum repository. The address of the repository s owner must be configured properly in order for s to be sent. 16. Enter a Message. The message forms the body of the alert To invoke a process in response to the alert, enter a value in the Process Parameters field. 18. Select File > Save. Figure 52. Alert Properties window Testing an alert Alerts can be tested within PRS to ensure they are working properly. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 107

108 Defining Reports and Alerts with Process Reporting Services To test an alert using PRS 1. Define an alert in PRS. 2. Click the Refresh button in the the Data Source Preview window. Note: The rows that match the alert expression are displayed in bold. Publishing an alert An alert must be published before it can be used in a dashboard. Publishing makes the alert available for evaluation by the alert engine. Unpublished alerts are not active. To publish an alert 1. Open an alert and click the Alerts tab to the right of the Data Source tab. 2. Select Published from thealert Status pull-down list 3. Save the changes. Opening an existing alert Alerts can be opened for editing and publishing. To open an alert 1. Select the alert within the Alerts tab. 2. Right-click and select Open or double-click the alert. Editing an existing alert Alerts can be updated. Once an alert is edited it must be saved. To edit an alert 1. Open the alert. 2. All aspects of an alert can be updated, including its data source and alert properties. 3. Select File > Save. 108 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

109 Defining Reports and Alerts with Process Reporting Services Configuring business data aggregation Business data aggregation entities can be created at the discretion of the report designer. Unlike aggregation entities for process, activity, and performer objects, objects containing business data do not automatically have aggregation entities defined. This is because these objects are often times quite large (containing many attributes) and complicated with a lot of data being captured and monitored. If business data aggregation entities were automatically created, there is the potential that much of that data is of no interest to the organization, and storing and monitoring wastes space and will eventually compromise system performance. Business data aggregation entities, then, are configured by the report designer who selects fields and functions, and a group-by column. Understanding reports that use aggregation, page 65 contains much more detailed information on aggregation. Understanding the aggregation engine, page 26 describes the work of the aggregation engine. The procedure below has the user selecting fields, an aggregation function, and a group-by field. This procedure creates aggregation tables in the BAM database. Only one aggregation can be defined for each SDT or package object type. An indicator is placed next to business data objects for which an aggregation is already defined. Once aggregation tables are defined and populated with data, the definition of the aggregation can only be updated by adding fields. In a existing aggregation, fields cannot be removed and the method of aggregation and the group-by field cannot be changed. These configuration options can only be changed if there is no data in the aggregation table. Similarly, an aggregation can only be deleted when there is no data stored in the aggregation table. For more information on deleting aggregation tables that contain data, please see Updating monitored business data, page 41. To configure business data aggregation 1. Log in to PRS. 2. Select Configuration > Business Data Aggregation. 3. Select a business data object from the pull-down list. A check mark next to the name indicates if aggregation is already defined for the selected object. 4. Select a field from the list of available fields. 5. Click the selection arrow to move the field to the list of selected fields on the right. This removes the field from the list of available fields. 6. Select an arithmetic function from the Aggregation pull-down list. 7. To specify a grouping entity, select the Group checkbox. Note: The same field cannot be both aggregated and grouped. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 109

110 Defining Reports and Alerts with Process Reporting Services 8. Click Ok. This creates all necessary tables in the BAM database and all report entities within PRS. Figure 53. Business data aggregation 9. Close and reopen PRS to view the new report entities located under the Business Data Aggregation report entity category located on the palette. Deleting business data aggregation Within PRS business data aggregation can only be deleted if business data is not already captured and stored in the aggregation tables. For more information on deleting business data aggregation tables that contain data, please see Updating monitored business data, page 41. Caution: This action cannot be reversed. In addition, all reports that use the business data aggregation entity are deleted. To delete business data aggregation 1. Log in to PRS. 2. Select Configuration > Business Data Aggregation. 3. Select a business data object from the pull-down list. 4. Click Delete Aggregation. 5. Click Ok. 6. Click Yes on the confirmation dialog. 110 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

111 Defining Reports and Alerts with Process Reporting Services Displaying BAM reports in an enterprise portal Displaying a report is not confined to a BAM dashboard. Reports can also be displayed in a existing web application. There are two methods for accessing a report by way of a URL. The first approach uses the object Id of the report. The second approach is based on the name of the report and the path to its location. Each approach also supports adding a filter expression and maximum rows returned parameter to the URL. Note: Reports may already contain filters defined in PRS. Filters specified within the URL are applied to the report after the PRS filter is applied. Option 1: Using a report ID With this option the URL must conform to the following convention: where: Host the IP address of the BAM server Port is the listen port of the BAM server Report Id the Docbase Id of the report Note: If displaying a Crystal Report, substitute repgen with crsrepgen Option 2: Using the path to the report With this option the URL must conform to the following convention: &reportname=<report_name> where: Host the IP address of the BAM server Port the listen port of the BAM server Path to Report the directory path to the report. Paths always begin with /System/BAM/Report Categories to be followed by user category (e.g. MyCategory). Report Name the name of the report as entered in PRS Note: If displaying a Crystal Report, substitute repgen with crsrepgen EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 111

112 Defining Reports and Alerts with Process Reporting Services Filter and maximum row parameters The sample URL below contains a filter and a maximum row parameter. These parameters can be used with either the report ID approach or with the path and name of the report approach. <Filter_Expression>&maxRows=<Value> where: Filter Expression a filter expression entered by the user. For more information about filter expressions please see Understanding report entity filtering, page 56. Value the number of rows to be returned in the report results set Example Report with filter This URL displays the Customer Details report (report ID c ) that only includes the Acme, Inc. customer. In addition, the maximum rows returned parameter is filterexpression=std.acustomer Name= Acme, Inc. &maxrows=10 Export report to PDF and Excel formats The Crystal Reports servlet (crrepgen) has a parameter in its URL that allows reports to be exported to either CSV or PDF format. The parameter is export= and can be set to one of two values: CSV or PDF. Instead of the Crystal Report viewer appearing, the browser prompts the user to save the report as either a CSV or PDF file. Example Crystal Reports exported to PDF This example exports a Crystal Report to PDF. The Flex servlet, which services simple reports, can also be exported to CSV by way of the export parameter. Simple reports cannot be exported to PDF. Example Simple report exported to CSV This example exports a simple report to CSV EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

113 Defining Reports and Alerts with Process Reporting Services Displaying process diagrams from within a J2EE web application Displaying a process diagram is not confined to a BAM dashboard. Diagrams can also be displayed in existing web application. This requires understanding the convention used for accessing an instance level process diagram by way of a URL. The URL incorporates an instance ID that is used as a unique identifier. For each instance there are two process instance IDs assigned. The first instance ID value is assigned as the process executes. This is called the external instance ID. To view diagrams according to the external instance ID you must use the following URL: Note: The instance ID exists as a variable within the session. Once configured the user clicks the link and the instance diagram is displayed. As information about the process instance is passed from the Process Engine to BAM, a second process instance ID value is assigned by BAM and stored in the BAM database. The instance ID value can be used as an alternative to the external instance ID. To view diagrams according to the ID assigned in BAM you must use the following URL: Note: It does not matter if you use the external instance ID or the instance ID. The process flow diagram is the same. Embedding a diagram as an object The URL conventions described so far open a new window that displays a process flow diagram. To embed the process diagram within a page, the convention below must be used. This method assumes that the page containing the embed tag is on the same server as the diagram dashlet. If not, then use the iframe method. While the example below is based on instance ID only, it applies to the external instance ID, as well: <HTML> <BODY> <embed src= type="image/svg+xml"/> </BODY> </HTML> EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 113

114 Defining Reports and Alerts with Process Reporting Services Embedding a diagram using iframes Embedding a diagram using iframes is recommended if the page containing the embed tag is not on the same server as the diagram dashlet. <HTML> <BODY> <iframe src=" width="320" height="300" scrolling="auto" name="processdiagram"> </iframe> </BODY> </HTML> 114 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

115 Chapter 4 Process Reporting Services Examples This chapter contains specific PRS examples. It is assumed that you understand basic PRS features and functions. Where applicable, cross references back into the main PRS documentation are provided. Designing a New Account Openings report, page 115 Designing a Total Deposits per City report, page 118 Calculating inter-activity duration, page 120 Designing a New Account Openings report This section provides an example of how to design a simple report that includes both business data and aggregation. This report is based on a new bank account application process where individuals can make a deposit to open either a checking account or a savings account. The purpose of this report is to count the number of checking accounts and saving accounts that have been opened. More specifically, this report counts the number of individual process instances that have been completed for each type of account. The count function is selected for the process ID field, since each process ID is unique. The account type attribute is selected as the group-by. This report is formatted as a bar chart. To design a New Account Openings report 1. Right-click a report category, select New > Simple Report, and name the report. 2. Place the process execution entity on the report design canvas and deselect all fields except for Process Instance ID. In this example you are going to count the number of process instances that open either a savings or checking account. 3. Select Business Data on the palette. Then, place the New_Account_Application entity on the canvas and deselect all fields except for AccountType. You are going to use report aggregation to count the number of process instances for each account type. Account type will be selected as the group. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 115

116 Process Reporting Services Examples Note: If you click the Refresh button in the Data Source Preview window, you will see process instance data. This view will change after you apply aggregation. Figure 54. New account openings data source 4. Click the Report Aggregation button on the data source toolbar. Then select the Group check box for the AccountType field and select Count for the Process Instance ID field. Then, click Ok. Note: If you click the Refresh button again in the Data Source Preview window, you will notice that the number of process instances are now counted for each account type. 116 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

117 Process Reporting Services Examples Figure 55. New account openings aggregation settings 5. Click the Chart Type tab. 6. Select Bar in the Properties window. Figure 56. New account openings chart type settings 7. Click the Chart Data tab. 8. Select AccountType as the category and select Process Instance ID as the Y-axis. From here you can configure a number of visual properties by clicking the Chart Properties tab. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 117

118 Process Reporting Services Examples Figure 57. New account openings chart data settings Designing a Total Deposits per City report This section provides an example of how to design a simple report that includes both business data and aggregation. This report is based on a new bank account application process where individuals can make a deposit to open either a checking account or a savings account. The purpose of this report is to calculate the total number of deposits (both checking and savings) for the city in which the deposit is made. Since multiple deposits can be made in each city, the city field is selected as the group and the amount values are added together. This report is formatted as a pie chart. To design a Total Deposits per City report 1. Right-click a report category, select New > Simple Report, and name the report. 2. Select Business Data on the palette. Then, place the New_Account_Application entity on the canvas and deselect all fields except for Amount and City. You are going to sum the amount field and group-by city. Note: If you click the Refresh button in the Data Source Preview window, you will see process instance data. This view will change after you apply aggregation. 118 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

119 Process Reporting Services Examples Figure 58. Total deposits per city data source 3. Click the Report Aggregation button on the lower toolbar. Then select the Group check box for the City field and select Sum for the Amount field. Then, click Ok. Note: If you click the Refresh button again in the Data Source Preview window, you will notice that the total deposit amount has been calculated for each city. Figure 59. Total deposits per city aggregation settings 4. Click the Chart Type tab. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 119

120 Process Reporting Services Examples 5. Select Pie in the Properties window. Figure 60. Total deposits per city chart type settings 6. Click the Chart Data tab. 7. Select City as the X-axis and select Amount as the Y-axis. From here you can configure a number of visual properties by clicking the Chart Properties tab. Figure 61. Total deposits per city chart data settings Calculating inter-activity duration BAM measures the duration of a single activity or the duration of an entire process, from start to finish. Sometimes it is useful to measure the time it takes to complete a subset of connected activities. This section provides an example of how to calculate inter-activity duration. Consider the simple process below where the time between the start of Activity-1 and the end of Activity-2 is measured. This time also happens to be equivalent to the duration of the entire process. 120 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

121 Process Reporting Services Examples To calculate inter-activity duration 1. Create a simple report with a data source that includes Activity Execution, Process Execution, and Activity Execution. Select to view the data source fields marked below. Creating a simple report, page 76 addresses how to define a data source. 2. Right-click the first Activity Execution report entity and select Filter. The Filter dialog opens. Select the first activity for which the inter-activity duration is measured. Filtering report entities, page 89 provides guidelines in defining a filter expression. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 121

122 Process Reporting Services Examples 3. Then, open the Filter dialog for the second Activity Execution entity and select the final activity for which the inter-activity duration is measured. 4. Once the report is saved, click the Refresh button in the Data Source Preview window. You should see results similar to the preview below. 122 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

123 Process Reporting Services Examples 5. The Computed Columns feature is used to calculate the difference in duration between two timestamps. Begin by clicking the Computed Columns icon. Adding computed columns to a report, page 83 provides more information on computed columns. 6. Enter a name for the computed column, place your cursor in the Expression field, and enter datediff(. 7. Then, press the Ctrl and spacebar keys on your keyboard simultaneously and select ${Finished Date and Time} from the list. 8. Enter a comma (,) and then select ${Start Date and TIme} from the autocomplete list.. 9. After ${Start Date and TIme}, enter )/1000. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 123

124 Process Reporting Services Examples 10. After saving the report, the Data Source Preview window displays the inter-activity duration. 124 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

125 Designing a BAM Dashboard Chapter 5 A BAM dashboard is a display environment for monitoring executing processes in real-time. The primary purpose of a dashboard is to provide line of business and IT personnel a tool for monitoring, understanding, and resolving process issues as they occur. Dashboards are configured by dashboard designers who use a drag-and-drop user interface to arrange dashlets on a dashboard. There are four types of dashlets and in each dashlet displays the content of a specific report, process diagram, or alert. Data for these elements are provided by the BAM server, Process Engine, and Process Builder by way of report services. At a technical level dashboards are applications developed within TaskSpace and displayed to dashboard users through a web browser. The dashboard is packaged as an EAR file that contains the set of predefined dashlets. Note: Dashboards require that Flash Player version 9 or higher and SVG Viewer version 3.x be installed on the user s machine. Figure 62. BAM dashboard architecture EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 125

126 Designing a BAM Dashboard The first step in designing a BAM dashboard is to prepare the process diagram for display in Process Builder. From here dashboard designers use TaskSpace to create a new dashboard within a dashboard application. Dashboards are comprised of dashlets. Role-based access to individual dashboards is also specified in TaskSpace by the dashboard designer. Dashboard users interact with dashboards displayed in TaskSpace to filter report results and resolve alerts. Figure 63. Dashboard designer and dashboard user interaction diagram This chapter addresses all aspects of dashboard configuration and use. It includes the following sections: Understanding the report dashlet, page 127 Understanding the process diagram dashlet, page 128 Understanding the alert list dashlet, page 128 Understanding the process simulation dashlet, page 129 Understanding dashlet filters, page 131 Understanding dashboard permissions, page 131 Understanding the dashboard interface, page 131 Creating sub-processes in Process Builder, page 132 Creating a new dashboard application, page 133 Designing a dashboard, page 133 Adding a dashboard to an application, page 135 Adding a dashboard tab, page 135 Assigning dashboards permissions, page EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

127 Designing a BAM Dashboard Configuring multi-drill-down reports in a dashboard, page 137 Adding process diagrams to a dashboard, page 139 Scheduling refresh periods, page 140 Configuring dashlet filters, page 141 Printing reports from a dashboard, page 142 Modifying dashboards, page 142 Removing dashboards, page 143 Deleting dashboards, page 143 Applying dashlet filters, page 144 Updating the status of an alert, page 144 Customizing a dashboard cascading style sheet (css), page 145 Understanding the report dashlet All reports defined in Process Reporting Services including Crystal Reports that are synchronized back into PRS can be displayed in a dashboard. There are 5 simple report types: pie charts, bar charts, bar + line charts, gauge reports, and table reports. For more information on simple report types please see Understanding simple report types, page 59. As a dashboard is created dashboard designers can select from a list of published reports organized by category. The list is available on the left tree menu. Note: Only published reports can be added to a dashboard. Dashboard users can interact with a report dashlet in one of two ways. First, dashboard users have the option of filtering report results. Once the filtering feature is activated, dashboard users will be able to select from a set of preconfigured dashlet filters. And second, if a report is configured as a drill-down report, then users will be able to open another report within the same dashlet. Drill-down reports are configured by report designers in PRS. When the base report is added to a dashboard then all linked drill-down reports are also added. Figure 64. Report dashlet EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 127

128 Designing a BAM Dashboard Understanding the process diagram dashlet The process diagram dashlet provides a graphical representation of an executing process instance. The image displayed in the process diagram dashlet is taken from Process Engine. It represents the process just as it is designed in Process Builder, with some additional information. Activities within a process that have been completed are annotated with a gear icon and green check mark. Activities that are currently being executed are displayed with a blue gear icon. Activities that have not been completed are gray. In addition, an alert icon is placed to the left of activities that trigger an alert. The color of the alert icon indicates severity, with red being the highest. The alert icon could also be orange or yellow. In some processes an activity could be performed multiple times, for example, if it is part of a loop. If this happens then a number is displayed in the upper left hand corner of each activity indicating the number of times each activity has been performed in the process instance. The numbers are displayed only when activities are performed more than once. Figure 65. Process diagram dashlet Understanding the alert list dashlet Data in the BAM execution tables and aggregation tables is periodically monitored by the alert engine. The alert engine is component of the BAM server that compares alert results against alert conditions. For more information about the alert engine, please see Understanding the alert engine, page 27. Alerts themselves are defined in PRS. When an alert is triggered the alert list dashlet is updated to include the name of the alerted entity (for example, the name of the process), the name of the alert (as entered in PRS) together with relevant information, like severity level, date, and status. Alerts also trigger s that are automatically generated and sent to one or more people. From within the body of the , dashboard users can click a link, log in to TaskSpace, and update the status of an alert. Alerts statuses are updated by clicking the Edit button. 128 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

129 Designing a BAM Dashboard For more information on working with an alert, please see Updating the status of an alert, page 144. In addition to updating the status, the alert dashlet has the following features: Group By Users can see the list of alerts grouped by Status, Severity, and Name. Sorting The table can be sorted by clicking the column headers. For example, clicking the Date header sorts the rows by date. Clicking the Status header sorts the table according to whether the alert is new, closed, or acknowledged. Caution: When defining either process or activity alerts that include duration, the Process Instance ID and Process ID or Activity Instance ID and Activity ID entity fields must be selected in the data source. Figure 66. Alert dashlet Understanding the process simulation dashlet Process execution data can be simulated. A simulated process provides a model for how well it will operate in the real-world, given a specific set of constraints. Different process scenarios can be designed by changing these constraints, and then saved. Simulation is meant to help identify bottlenecks, areas within the process where more work is coming in than can be completed. Simulation also provides an understanding of resource utilization, the percent of time each person involved in the process is completing actual work. Simulation also calculates the number of processes completed within a specific period of time. This is also called process throughput. Simulation involves many forms of advanced process analytics. The process simulation dashlet is designed to export execution data, for a specific time interval, from the BAM database to Process Simulator. Process Simulator is a simulation product that must be installed on the dashboard user s local machine. During export Process Simulator automatically launches and loads the exported data. From here simulation users analyze the process model. The following data is exported from BAM to Process Simulator: EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 129

130 Designing a BAM Dashboard Resources All resource assignments are included in the export to Process Simulator. This does not include the total number of resources applied to each activity. Inter-Arrival Rate This is a measure of frequency as indicated by the amount of time (in minutes) between two process instances starting. A distribution for inter-arrival rate can also be selected. Activity/Work Station Duration The average amount of time it takes to perform a specific step within a process. Routing In/Routing Out The percent of time a process travels down one particular path in a process. For more information please refer to the documentation available within Process Simulator. The documentation can be accessed by selecting the Help menu item. To simulate a process 1. Select a process from the list. 2. Click the Configuration button. 3. Select a time period from the Filter pull-down list. 4. Click Ok in the Choose Period window. Figure 67. Process simulation dashlet 5. Click Ok in the Process Simulation dashlet. The Process Simulator file can either be opened or saved. 130 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

131 Designing a BAM Dashboard Understanding dashlet filters Dashlet filtering is the mechanism by which report results are reduced to display a subset of data. Dashlet filters are configured by a dashboard designer who defines a list of filters on behalf of dashboard users. Dashboard users can then select which filters to apply when working with a dashlet. Configuring dashlet filters, page 141 addresses dashlet filter configuration. Caution: For some reports, filters may have already been applied within PRS, by a report designer. In this case a dashlet filter is applied after the report filter. Dashlet filters can be defined for base reports and associated drill-down reports, if any exist. This is required because a dashlet may actually contain multiple reports. Once a dashlet and report are selected, the dashboard designer selects one or more filter and chooses those filters that are initial filters and those that are mandatory. Initial filters are applied automatically as a dashlet loads for a dashboard user. Mandatory filters must be selected by dashboard users first, before report results are displayed. Understanding dashboard permissions Dashboard permissions are inherited from the underlying DocBase permission system. Dashboards are assigned to a TaskSpace tab, and it is for tabs that user permissions are assigned. A user may only view dashboard tabs that were assigned to its role. Permissions are only available for dashboards and do not apply to specific reports, diagrams, or alerts within a dashboard. As a result, only dashboard designers are able to add content to a dashboard. For more information on assigning permissions to a dashboard please see Assigning dashboards permissions, page 136. Understanding the dashboard interface A dashboard is displayed as a single page that is divided into rows. A page contains as many rows as needed. Rows are divided into dashlets that contain reports, diagrams, and alerts. A row can contain as many dashlets as needed. The width of a dashboard is fixed; there is no horizontal scrollbar. The height of a dashboard is not fixed. A vertical scroll bar is available. Dashlets can be re-sized by dragging the divider located between dashlets. When re-sized, other dashlets in the row are automatically re-sized. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 131

132 Designing a BAM Dashboard Note: The display of simple reports re-sizes proportionally to the size of the dashlet. This is not true for Crystal Reports. When Crystal Report dashlets are re-sized, the content displayed in the report does not re-size proportionally. The size of these reports is specified in Crystal Reports. The default width of a dashlet is dependent on the number of dashlets in the row. Scrollbars are displayed within a dashlet when the content of the report or diagram exceeds the space provided. Dashlets do not have a minimum size. Dashlets can be refreshed (both manual and scheduled), filtered, maximized, and configured as the target of a multi-drill-down report. Creating sub-processes in Process Builder Process Engine provides the BAM server with an image of each process instance, and data about the executing process. These images, called process diagrams, are displayed to dashboard users. The exact placement of each activity in the process is controlled within Process Builder. The image displayed in Process Builder and the process diagram displayed in a dashboard is the same. So, you may want to make adjustments to process diagrams in Process Builder. One element you can introduce into a process diagram is a sub-process. Oftentimes, a large or complicated process can become difficult to organize visually when there are many activities. To simplify the layout of a process, you may want to group related activities into sub-processes that represent related steps or functions in the process. Activities do not have be part of a sub-process. Subprocess, together with individual activities, are displayed in process flow diagram viewable in a dashboard. Sub-processes can be created using either top down modeling or bottom-up modeling. Top down modeling is addressed in the Documentum Process Builder User Guide. Bottom-up modeling is addressed in this procedure because it is assumed that the process designer is first concerned with developing the process, and then organizing its layout. To create a sub-process in Process Builder 1. Select the activities to include in the sub-process. You can select multiple activities by using the mouse to drag a rectangle around the activities you want to include in the sub-process or by holding down the Shift key and clicking the activities individually. The selected activities are surrounded with a green dashed line. 2. Select Tools > Sub-Process > Add to Sub-Process. The grouped activities appear in a colored rectangle that is labeled Sub-Process. 3. Right-click the sub-process and select Sub-Process Inspector to set the properties that are shared for all activities within the sub-process. 132 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

133 Designing a BAM Dashboard For more information on setting properties, please see the Documentum Process Builder User Guide. 4. Enter a name for the sub-process. 5. Click Ok. 6. You can click the new sub-process and drag it to the intended position in the window. Creating a new dashboard application TaskSpace provides capabilities for designing user interfaces for process-based software applications. A BAM dashboard is a specific type of application. Each dashboard application can hold multiple dashboards. Dashboards, in turn, hold dashlets that display a specific report, process diagram, or alert list. First a dashboard application must be created. Then, a dashboard is designed and added to the dashboard application. To create a new dashboard application 1. Log in to TaskSpace. For more information on logging in please refer to Logging in to TaskSpace, page Select the Configuration tab. 3. Click the New Application button located in the lower right corner of the window. 4. Enter a name in the field provided. This is the name of the application displayed in the URL. Do not use spaces. 5. Enter a title. The title is displayed in the user interface. 6. Click Ok. A URL is assigned to the new application. 7. Copy and paste the URL into a browser window. You are now ready to design a dashboard. Designing a dashboard A BAM dashboard is comprised of a series of dashlets arranged in rows and columns. Designers add a dashlet to the dashboard by selecting components from the tree view and placing it onto the dashboard canvas. As the component is dragged to the canvas its title is displayed with the appropriate icon. Dashlets can be added to an existing row or to a new row. Once placed on the canvas the dashlet outline is displayed as a red, dashed line. The same dashlet can be added multiple times. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 133

134 Designing a BAM Dashboard Dashboard designers can select from any of the available report dashlets, the alert list dashlet, the process diagram dashlet, or the process simluation dashlet. In addition, filter can be configured for any dashlet added to a dashboard. To design a dashboard 1. Launch a browser session and open the URL of the application to which the dashboard is being added. 2. Log in to TaskSpace. For more information on logging in please refer to Logging in to TaskSpace, page Select the Configuration tab. 4. Select the Dashboards node from the left tree menu. 5. Click the Create button located at the bottom right of the window. 6. Enter a Name and a Label. The label appears as the name of dashboard in the user interface. 7. Click Next. This opens the dashboard design canvas. 8. To add a report: a. Click to expand the Reports left tree menu. b. Continue expanding report categories until you locate the desired report. c. Click and drag a report to the dashboard design canvas. Note: You do not need to decide where to place the first dashlet, it is merely added to a blank canvas. From here forward you must decide where each dashlet should be positioned. Dashlets can be positioned to the right, left, top, or bottom of an existing dashlet by hovering the selected report over the divider bar, and releasing. 9. To add an alert list dashlet, click and drag Alert List to the dashboard design canvas. 10. To add a process diagram dashlet, click and drag Process Diagram to the dashboard design canvas. 11. To add a process simulation dashlet, click and drag Process Simulation to the dashboard design canvas. 12. To preview the dashboard as a dashboard user would see it, click the Configuration button. Click the Configuration button again to continue designing the dashboard. 13. To save your work and continue working, click Save. 14. To save the dashboard and go back to the component list page, click Finish. 134 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

135 Designing a BAM Dashboard Adding a dashboard to an application A dashboard must be added to a dashboard application. Dashboards can be added to multiple dashboard applications. To add a dashboard to an application 1. Launch a browser session and open the URL of the application with which you are working. 2. Log in to TaskSpace. For more information on logging in please refer to Logging in to TaskSpace, page Select the Configuration tab. 4. Select the Dashboards node from the left tree menu. 5. Click Add. A list of dashboards is displayed. 6. Select a dashboard from the list on the left and move it to the right with a selection arrow. 7. Click Ok. Adding a dashboard tab Dashboards are displayed within a tab in TaskSpace. This procedures creates a new tab in TaskSpace and adds a dashboard to it. To add a dashboard tab 1. Launch a browser session and open the URL of the application with which you are working. 2. Log in to TaskSpace. For more information on logging in please refer to Logging in to TaskSpace, page Select the Configuration tab. 4. Select Tabs from the left tree menu. A list of tabs is displayed. 5. Click Create. 6. Select Dashboard from the Select Tab Type pull-down list. 7. Click Next. 8. Enter a name in the field provided. Do not use spaces. 9. Enter a Label. The label appears as the name of tab in the user interface. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 135

136 Designing a BAM Dashboard 10. Select a dashboard from the Dashboard Component pull-down list. 11. Click Finish. Assigning dashboards permissions Dashboards are displayed within a tab. Roles are assigned access to TaskSpace tabs. This procedure has the user assigning a tab to a TaskSpace role. This procedure assumes that the role exists. To assign dashboard permissions 1. Launch a browser session and open the URL of the application with which you are working. 2. Log in to TaskSpace. For more information on logging in please refer to Logging in to TaskSpace, page Select the Configuration tab. 4. Select Roles from the left tree menu. A list of roles is displayed. 5. To assign permissions to a role that has already been added to the dashboard application: a. Select the role. b. Click the Edit button. c. Click the Manage button. d. Select a tab from the list of Available Tabs and move it to the list of Assigned Tabs by clicking the Add arrow. e. Continue adding tabs as necessary. f. Click Ok. 6. To assign permissions to a role that has not yet been added to the dashboard application: a. Click the Add button. b. Select a role from the pull-down list. c. Click Next. d. Select a tab from the list of Available Tabs and move it to the list of Assigned Tabs by clicking the Add arrow. e. Continue adding tabs as necessary. 136 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

137 Designing a BAM Dashboard f. Click Next. g. Configure the Global Search and click Next. h. Configure the Component Mappings and click Next. i. Configure the Menus and click Finish. Configuring multi-drill-down reports in a dashboard Multi-drill-down reports are configured in two phases. First, as with single drill-down reports, the hyperlink is configured in PRS. Then, the group of dashlets that are updated once the hyperlink is selected is configured in the dashboard by a dashboard designer. This section outlines the procedure for configuring multi-drill-down reports in PRS, and then configuring multi-drill-down reports in a dashboard. Understanding multi-drill-down reports, page 72 provides an overview of the multi-drill-down feature. To configure a multi-drill-down report in PRS 1. Define a data source. The data source must include one or more of the following entity fields: Process ID, Process Instance ID, Activity ID, or Activity Instance ID. Note: This data, even if not visible in the report as configured in the Chart Data tab, are used as parameters that are passed to each of the surrounding dashlets. Without this data the multi-drill-down report does not work. 2. Selects the column or series for which the drilldown is defined. Currently, four dashboard events are supported: process, process instance, activity, and activity instance. A dashboard event is defined as a change in either a process ID, process instance ID, activity ID, or activity instance ID value. Caution: The selected dashboard event must also be selected as an entity field in the data source, even if the entity field is hidden from being displayed in the report. In this example, each time a process is selected in the table, the surrounding dashlets are updated to display process instance data. Therefore, Process Instance ID is selected as an entity field in the data source and Process Instance is selected from the Dashboard Event pull-down list. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 137

138 Designing a BAM Dashboard Figure 68. Multi-drill configuration in PRS The second part of a multi-drill-down report is configured within a dashboard. Within the Multi-Drill tab three columns are displayed: Event, Dashlet, and Target. The event column contains of a list of all dashboard events, and each dashboard event is repeated for each dashlet included in the dashboard. The dashlet column displays the name of each base report shown within the dashlet. The target column is configured to display the name of the report to be shown once an event is triggered. Continuing with the example, each time a process is selected in the Process Instance List report, the System processes status bars report changes to display process instance data in the Process Details report. The same logic applies to the started processes statistics and Process Diagram dashlets. To configure a multi-drill-down report in a dashboard 1. Create a dashboard and add the desired dashlets. 2. Select the Multi-Drill tab. 3. Select the checkbox corresponding to the dashboard event and dashlet combination for which the multi-drill is being defined. 4. Click the button within Target to select a target report. This opens the Content Chooser window. 5. Select a report and click Ok. 138 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

139 Designing a BAM Dashboard Figure 69. Multi-drill configuration in a dashboard Adding process diagrams to a dashboard Process flow diagrams can be added to any dashboard. This procedure makes use of the multi-drill feature. Configuration begins in PRS and continues within the dashboard. Understanding multi-drill-down reports, page 72 addresses the underlying concepts of the multi-drill feature. To add process diagrams to a dashboard 1. Define a report in PRS with a data source that includes the Process Instance ID column. 2. Within the Chart Data tab define a drill-down and select the Dashboard Event radio button. 3. Select Process Instance from the pull-down list and then click Ok to close the Drilldown window. Figure 70. Add process diagram to dashboard PRS 4. Within a dashboard, place the report containing the drill-down definition on the dashboard design canvas. The example below shows that the Process Instance Duration report has been added. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 139

140 Designing a BAM Dashboard 5. Somewhere within the same dashboard, place the Process Diagram dashlet on the dashboard design canvas. Caution: You will not see anything in the process diagram dashlet when it is first added to a dashboard. Users must click the hyperlink defined in the base report. In this example, a process diagram is displayed when a process instance ID (displayed as a hyperlink) is selected in the Process Instance Duration report. Figure 71. Add process diagram to dashboard Scheduling refresh periods Refreshing provides a dashboard the most up-to-date monitoring data. Individual dashlets can be manually refreshed by a dashboard user by clicking the Refresh icon located on the menu bar of each dashlet. All dashlets within a dashboard can also be refreshed according to a schedule. The refresh time interval is restricted to 1 minute intervals. To schedule a refresh period 1. Open a dashboard for editing. 2. Select the Scheduler tab. 140 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

141 Designing a BAM Dashboard 3. Enter a Refresh Time in 1 minute intervals. 4. Click Save. Configuring dashlet filters Dashboard users can filter data displayed in report. The choices from which they can select are configured by the dashboard designer. Dashboard designers are presented with a list of possible filters within the Dashlet Filter tab. This list of possible filters represents a subset of filters available for the base report entity in PRS. For instance, a report based on the Process Execution report entity has a different set of filters than a report built with the Activity Execution report entity. Once a filter is defined it can be made available to the user. For more information on filter configuration, please see Understanding dashlet filters, page 131. The dashboard designer decides which filters are initial filters and those that are mandatory. Initial filters are applied automatically as the dashboard loads the dashlet. Dashlets containing mandatory filters display a message to the dashboard user informing them to apply a filter. Applying dashlet filters, page 144 provides instructions on how to select a filter. Once a filter is selected the report is loaded. To configure dashlet filters 1. Open a dashboard. 2. Click the Dashlet Filter tab. 3. Select a dashlet from the Dashlets pull-down list. 4. Select a report from the pull-down list. Note: Because of single drill-down reports, each dashlet can have multiple reports associated with it. 5. Place a check mark next to the filters you want to make available to a dashboard user. 6. To select an initial filter: a. Select the Edit Dashlet Initial Filter link. b. Select the filter value(s) in the Initial Filter window. c. Click Ok. 7. To make a filter mandatory, select Yes from the mandatory pull-down list. 8. Click Save. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 141

142 Designing a BAM Dashboard Printing reports from a dashboard Simple reports and Crystal Reports can be printed directly from a dashboard. A printed simple report does not include headers, footers, logos, the date, and page numbers. This type of advanced formatting is available in Crystal Reports. To print a simple report from a dashboard 1. Log into a dashboard and locate the report you want to print. 2. Click the Print button on the dashlet toolbar. 3. Select a printer and click Print. To print a Crystal report from a dashboard 1. Log into a dashboard and locate the report you want to print. 2. Click the Print this report icon. 3. Click Ok in the Print Report window. 4. Open or save the Crystal Reports PDF file. 5. Print the report from Adobe. Modifying dashboards All aspects of a dashboard can be edited including adding new dashlets, removing dashlets, and modifying filters, groups, and scheduling configurations. This procedure is for dashboard designers who need to edit pre-existing dashboards. To modify a dashboard 1. Launch a browser session and open the URL of the application containing the dashboard to be modified. 2. Log in to TaskSpace. For more information on logging in please refer to Logging in to TaskSpace, page Select the Configuration tab. 4. Select the Dashboards node from the left tree menu. 5. Select a dashboard from the list and click Edit. 6. To change the label, enter a new Label and click Next. Otherwise, accept the current label by clicking Next. This opens the dashboard design canvas. 142 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

143 Designing a BAM Dashboard 7. To add content to the dashboard click and drag a dashlet from the left tree menu and place it on the dashboard design canvas. 8. To remove a dashlet click the Close button. The close button is the x in the upper right corner of a dashlet. 9. To modify multi-drill-down reports click the Multi-Drill tab. 10. To modify the dashlet refresh period, click the Scheduler tab 11. To save your work and continue working, click Save. 12. To save the dashboard and go back to the component list page, click Finish. Note: Dashboard users will see the changes once they refresh their browser. Removing dashboards Dashboards can be removed from a dashboard application. This operation only removes the dashboard from the current application, it does not delete the dashboard from the repository. The dashboard can be added to other applications. To remove a dashboard from an application 1. Open a dashboard application. 2. Click the Configuration tab. 3. Click the Dashboards node from the left tree menu. 4. Select a dashboard. 5. Click the Remove button located in the lower right corner of the window. 6. Click Yes in the confirmation window. Deleting dashboards Dashboards can be deleted from the repository, and by extension, all dashboard applications to which it has been added. Caution: Once a dashboard is deleted it cannot be restored. If another application is using the dashboard when it is deleted, the contents of the dashboard will no longer display. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 143

144 Designing a BAM Dashboard To delete a dashboard 1. Open a dashboard application. 2. Click the Configuration tab. 3. Click the Dashboards node from the left tree menu. 4. Select a dashboard. 5. Click the Delete button located in the lower right corner of the window. 6. Click Yes in the confirmation window. Applying dashlet filters Filtering is a way of reducing a large set of process execution data into a subset of data. The filter options presented to dashboard users are configured by dashboard designers. A dashboard designer may have also configured initial filters and mandatory filters. Initial filters are applied automatically as the report loads. Mandatory filters must be selected first before the report is displayed. To apply dashlet filters 1. Click the Filter button within a dashlet. A list of filters is displayed. 2. Select a filter. 3. Select a filter value. 4. Click Ok. The dashlet is refreshed to display the filtered data. Updating the status of an alert An alert list dashlet presents dashboard users with a list of triggered alerts. Dashboard users can interact with this dashlet to select an alert status and enter a note. For a list of additional features available in the alert list dashlet please see Understanding the alert list dashlet, page 128. To respond to an alert 1. Click the alert link provided in the notification Log in to TaskSpace. 3. Locate the alert list dashlet. 144 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

145 Designing a BAM Dashboard 4. Select a row corresponding to an alert you want to update. 5. Click the Edit button. 6. Select and alert status and enter a note. 7. Click Ok. Customizing a dashboard cascading style sheet (css) The look and feel of a BAM dashboard can be customized. This is especially useful if you have customized the look and feel of TaskSpace, and want to apply similar styles to your dashboard. The dashboard cascading style sheet (.css) can be modified with the Dashboard Style Utility available on the EMC Download Center. The following procedure provides instructions in how to use the utility, it does not provide a comprehensive list of all styles that can and can t (shouldn t) be modified. Caution: Not all styles can be modified. It is very important that you understand how to work with cascading style sheets. To customize a dashboard cascading style sheet 1. Download the dashboard style utility zip file from the EMC Download Center. 2. Extracts the contents of the style utility zip file. It contains the following directories: flex-sdk3 these files form the foundation of Flex, and provide the core Flex compilers, the component library, and debugger. output This directory is empty at first, and will hold main.swf once the.css is compiled. src This directory holds the main.css file and source files related to the style and dashboard images copied from the TaskSpace.war in steps 3 and 4. At download time this directory is empty. 3. Copy main.css and all action script files (files with an.as extension) located under <TaskSpace.war>\taskspace\library\dashboard\swf\css\ to the dashboard_css\src\css directory of the style utility. 4. Copy the entire images directory located under <TaskSpace. war>\taskspace\library\dashboard to the dashboard_css\src\css\assets directory of the style utility. 5. Modify main.css. It is the responsibility of the user to understand how to make changes to a.css. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 145

146 Designing a BAM Dashboard 6. Double-click build-css.bat located under Dashboard Style Utility to run the utility. This compiles the modified main.css into main.swf that is placed in the output directory of the style utility. Note: The compilation is successful when there are no errors, and the utility displays output\main.swf. If there are errors, you must go back to the.css file, make the corrections, and run the style utility again. 7. Copy the newly compiled main.swf file from the output directory of the customization utility back into <TaskSpace.war>\taskspace\library\dashboard\swf\css\ 8. Copy the updated main.css source file from dashboard_css\src\css back to <TaskSpace.war>\taskspace\library\dashboard\swf\css\. 9. Copy the images directory from dashboard_css\src\css\assets back to <TaskSpace.war>\taskspace\library\dashboard. This step is only required when there are changes to any of the dashboard images. 146 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

147 Chapter 6 Working with Preconfigured Dashboards In an effort to ease dashboard configuration, three working, preconfigured BAM dashboards can be installed. Installation instructions are available in the Documentum Business Activity Monitor Installation Guide. Each preconfigured dashboard contains dashlets holding generic reports already defined in Process Reporting Services. Preconfigured dashboards provide two benefits: 1. A faster path to a working BAM dashboard. 2. A starter set of dashlets that you can add to or customize. There is a Process Monitor dashboard that displays information about process instances executing in Process Engine. The Process Summary dashboard provides aggregated views of processes, spanning longer time intervals. The Alert Monitor dashboard helps dashboard user manage and report on process and activity alerts. Working with preconfigured dashboards requires: that the preconfigured dashboards be installed (please see the Documentum Business Activity Monitor Installation Guide for more information) a process to be developed in Process Builder monitored settings to be configured in Process Builder and TaskSpace so there is data to display, a number of processes must be run once BAM is configured Note: Most reports displayed in the preconfigured dashboards are defined with aggregated report entities. It will take several minutes for results to initially be displayed in the dashboards. Dashboard designers may want to modify a dashboard by adding reports that are of particular value to their business. Reports that contain SDT or object type data, for example, should be added. This is because the preconfigured dashboards only contain reports defined with common data data that is available across all implementations of BAM. Start date, duration (minutes), and process name are all examples of common data. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 147

148 Working with Preconfigured Dashboards This documentation addresses each preconfigured dashboard with a description of each dashboard report and its relationships to other dashlets, if they exist. Specifically, this chapter is comprised of the following sections: Understanding the Process Monitor dashboard, page 148 Understanding the Process Summary dashboard, page 151 Understanding the Alert Monitor dashboard, page 156 Localizing the preconfigured dashboards, page 158 Note: All of the simple reports used in the Process Monitor and Process Summary dashboards can be modified. Crystal Reports should not be modified. Modifications involve changes to the data source, the chart type setting, chart data configuration, and chart properties. Therefore it is crucial that you understand the principles of reporting. Chapter 3, Defining Reports and Alerts with Process Reporting Services provides an entire chapter dedicated to reporting. Caution: You cannot change the name of reports used in any of the preconfigured dashboards. This creates an inconsistency in the dashboard and report results will not be displayed. Tip: It is recommended that you have each preconfigured dashboard and PRS open while you read through this documentation. This makes the descriptions of how each report is designed and formatted more clear. Understanding the Process Monitor dashboard The Process Monitor dashboard provides flow diagrams for each process that is executing as well as a number of reports that focus on the details of each process. Some of the reports also provide summary level information as it relates to all executing processes. This section provides a detailed description of each portlet and outlines specific changes that can be made. Understanding the List of Process Instances report List of Process Instances is a simple table report that lists all processes executing in the system, start and finish date/time information, duration, and version number. The Process column in this table is configured as a multi-drill-down report that updates: the Count of Started, In-flight, and Completed Processes report to display the Process Instance Details report the Count of Processes Started within the Last Month report to display the Process Duration report. 148 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

149 Working with Preconfigured Dashboards the Process Diagram dashlet to display a process flow diagram for the selected process. Understanding multi-drill-down reports, page 72 provides an overview of multi-drill-down reports. Configuring multi-drill-down reports, page 97 provides procedures for configuring multi-drill-down reports. The List of Process Instances report can be modified in PRS to include business data. Either an SDT or an object type can be added to this report by selecting the Business Data report entity category on the palette and moving business data object to the report design canvas. Figure 72. Add business data report entity Understanding the Count of Started, In-flight, and Completed Processes report This is a simple Bar+Line report built on the Process Execution 5 Minutes report entity. Counting, as a arithmetic function, is only available in report entities that aggregate data. The data source for this report includes entity fields that count the number of processes that have started, are in-flight, and completed. Each series that is counted is formatted as a bar within the Chart Data tab of PRS. This particular report entity is used because it provides near real-time data, with a count of processes updated every five minutes. In addition, this report entity is filtered to include only those processes that have started, are in-flight, or have completed since the last time the data was aggregated. Since the aggregation engine runs every five minutes, this report provides a count of processes that have either started, are in-flight, or completed within the last five minutes. This report provides a snapshot of data as processes move through various states. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 149

150 Working with Preconfigured Dashboards Example 6-1. Count of Started, In-flight, and Completed Processes report interpretation At 1:02 PM a single Loan Application process (a process instance) is started. The aggregation engine runs at 1:05 PM and within the report this instance is shown as both started and in-flight. At 1:10 PM the aggregation engine runs again, and while this process instance is still considered in-flight, it is not counted as started because it began at 1:02 PM, outside of the aggregation engine s five minute time interval. At 1:11 PM, the process instance is completed, but the instance is still considered in-flight because the aggregation engine has not run again. At 1:15 PM, the aggregation engine runs and this process instance is now considered completed. Understanding the Count of In-flight Processes report This is a simple report formatted as a pie chart that counts the number process instances currently running for each process version. This report is built with the Process Execution 5 Minutes report entity. Counting, as a arithmetic function, is only available in report entities that aggregate data. The data source for this report includes entity fields that count the number of processes that are in-flight. This particular report entity is used because it provides near real-time data, with a count of in-flight processes updated every five minutes. This report entity is filtered to include only those processes that are in-flight (MSC.On-Going-Instances > 0) since the last time the data was aggregated (STD.Latest-Aggregation = True ). Since the aggregation engine runs every five minutes, this report provides a count of processes that are in-flight within the last five minutes. Understanding the Count of Processes Started within the Last Month report This is a simple report formatted as a pie chart that counts the number of processes that have started within the last month. The term last month is defined as the last 30 days. The data source for this report uses the Process Execution Last Month Aggregation report entity and includes the Name, Version and Started entity fields. This particular report entity is an example of a custom report entity. It was created because the Process Execution Monthly reporting entity that comes with BAM is not sufficient as it only provides report results after BAM collects data for one month. All custom report entities are listed in the Uncategorized report entity category of PRS. Creating custom report entities requires an understanding of the BAM data model and DQL. The following figure provides a small sample of the DQL required to create this report entity. Chapter 8, Creating Custom Aggregation, Report, and Filter Entities provides a complete set of instructions. 150 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

151 Working with Preconfigured Dashboards Figure 73. Sample DQL Understanding the Process Instance Details report This is a simple report formatted as a table that includes activity and work queue details for specific processes selected in the List of Process Instances report. The Process Instance Details report is configured as a target in a multi-drill-down report. Understanding multi-drill-down reports, page 72 provides an overview of multi-drill-down reports. Configuring multi-drill-down reports, page 97 provides procedures for configuring multi-drill-down reports. Understanding the Process Duration report This report is formatted as a dial gauge that points to the duration (in minutes) of the process selected in the List of Process Instances report. The Process Duration report is configured as a target in a multi-drill-down report. Note: The dial gauge ranges configured in the Chart Properties tab of PRS should be changed. By default, range 1 extends from zero to 40, range 2 extends from 40 to 70, and range 3 extends from 70 to 100. These settings may not be sufficient for your processes. Understanding simple report types, page 59 provides an overview of gauge reports. Understanding the Process Summary dashboard The primary purpose of the Process Summary dashboard is provide dashboard users with a view of their processes, and then the ability to drill-down to activities. This dashboard in particular features two single drill-down reports that count the number of processes and activities for each workflow state (started, in-flight, completed) and duration statistics for processes and activities. There are also two Crystal Reports featured in this dashboard that focus on the number of work tasks pending and completed for each performer. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 151

152 Working with Preconfigured Dashboards Understanding the Count of Processes per State report This is a simple Bar+Line report, that for each process, calculates: the number of process instances that have started during the last month the number of process instances that are in-flight at the moment of aggregation the number of process instances that have completed during the last month the duration (in minutes) of the process instance that has taken the longest to complete (maximum duration) during that last month Note: Month is defined as 30 days. Example 6-2. Count of Processes per State report interpretation If a single Loan Application process (a process instance) starts on July 1st, 2008, a report generated on July 2nd counts this process instance as being both started and in-flight. Suppose the loan process is completed on July 15th. A report generated on July 16th counts this process instance as being both started and completed but no longer in-flight. On August 1st, this process instance is no longer included in the number of instances started calculation, because the process began more than one month ago but, it is still included in the number of instances completed calculation because it was completed within the last 30 days. On August 30th, this process instance is no longer included in any of the calculations for this report. The report entity used in the data source of this report is the Process Execution Last Month Aggregation custom report entity discussed earlier in this chapter (please see Understanding the Count of Processes Started within the Last Month report, page 150). This report is configured as the base for a single drill-down report that opens the Count of Activities per State report when a dashboard user selects the Count of Started Instances column. Understanding the Count of Activities per State report This is a simple Bar+Line report, that for each activity, calculates: the number of activity instances that have started during the last month the number of activity instances that are in-flight at the moment of aggregation the number of activity instances that have completed during the last month the duration (in minutes) of the activity instance that has taken the longest to complete (maximum duration) during that last month Note: Month is defined as 30 days. Similar to the Count of Processes per State base report, the data source for this target is defined with a custom report entity. Chapter 8, Creating Custom Aggregation, Report, 152 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

153 Working with Preconfigured Dashboards and Filter Entities addresses how these types of report entities are created. This report is displayed when a dashboard user clicks any of the Count of Started Instances columns in the Count of Processes per State report. This same logic used in interpreting the process report can be applied to this report. Understanding the In-flight Process Statistics report This is a simple Bar+Line report built with the Incomplete Process Execution 5 Minutes report entity. For each process, this report: counts the number of instances that are running provides the average duration (in minutes) process instances have been running provides the duration (in minutes) of the longest running process instance (maximum duration) These calculations are only available in report entities that aggregate data. The Incomplete Process Execution 5 Minutes report entity is used because it provides near real-time data, with calculations updated every five minutes. In addition, this report entity is filtered to include only those processes that are in-flight since the last time the data was aggregated. The aggregation engine runs every five minutes. The Count of Ongoing Instances column is configured as a single drill-down report that opens the In-flight Activity Statistics report when selected by a dashboard user. Example 6-3. In-flight Process Statistics report interpretation At 1:02 PM a single Loan Application process (a process instance) is started. The aggregation engine runs at 1:05 PM and this instance is now included in the report s in-flight calculation. At 1:10 PM the aggregation engine runs again, and this process instance is still counted as being in-flight because it has not yet completed. At 1:11 PM, the process instance is completed, but the instance is still considered in-flight because the aggregation engine has not run again. At 1:15 PM, the aggregation engine runs and this process instance is no longer included in the report s in-flight calculation. Understanding the In-flight Activity Statistics report The In-flight Activity Statistics report is configured as a single drill-down target report opened when a dashboard user clicks the Count of Ongoing Instances column in the In-flight Process Statistics report. This activity report is very similar to the process report. While the process report focuses on aggregated processes, the activity report focuses on aggregated activities. This means that each group of bars in the chart relate to aggregated activities, rather than specific activity instances. For each activity, this report calculates: EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 153

154 Working with Preconfigured Dashboards the number of activity instances that are running for the selected process the average duration (in minutes) activities within the selected process have been running the duration (in minutes) of the longest running activity instance (this is the maximum duration) TheIn-flight Activity Statistics report is a simple Bar+Line report built with the Incomplete Activity Execution 5 Minutes report entity. This particular report entity is used because it provides near real-time data, with calculations updated every five minutes. In addition, this report entity is filtered to include only those activities that are in-flight since the last time the data was aggregated. The aggregation engine runs every five minutes. This same logic used in interpreting the process report can be applied to this report. Understanding the Tasks Completed by Performer within the last 24 Hours report This is a Crystal Report that provides a count of work tasks completed by each performer within the last 24 hour time period. Crystal Reports is required to calculate the total number of tasks completed for each performer. Calculations are not available with simple reports. The report is based on the Activity Performer 5 Minutes report entity where the Performer Name and Completed entity fields are selected. The data source is filtered so that the result set displays rows for only those processes that have completed (MSC.Completed-Instances > 0) during the last day (STD.Ended-During-Last-Day = True ). After the data source was defined, the report was opened in Crystal Reports. The following graphic displays the raw data as it is first seen in Crystal Reports. The next step in Crystal Reports was to configure a group-by function on the Performer Name field and a sum function on the Completed field. 154 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

155 Working with Preconfigured Dashboards After the summary was configured, we see one row of data for each performer. In the final step, the Chart Expert in Crystal Reports was used to format the data as a bar chart. After the report was synchronized back into PRS, it was displayed by clicking the View tab. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 155

156 Working with Preconfigured Dashboards Understanding the Tasks Pending for each Performer report This is a Crystal Report that calculates the total number of work tasks in each performer s inbox. This type of calculation is only available in Crystal Reports. The number of pending work items is calculated by counting the number of activity instances that are in-flight for each performer. This calculation is made possible by using the Activity Performer 5 Minutes report entity where the On Going Instances and Performer entity fields are selected. This particular report entity is used because it provides near real-time data, with calculations updated every five minutes. In addition, this report entity is filtered to include only those activities that are in-flight (MSC.On-Going-Instances > 0) since the last time the data was aggregated (STD.Latest-Aggregation = True ). The aggregation engine runs every five minutes. Within Crystal Reports a sum function is applied to the ongoing column and a group-by function is applied to the performer column. Then, the report is formatted as a bar chart and synchronized back into PRS. Understanding the Alert Monitor dashboard The primary purpose of the Alert Monitor dashboard is to provide detailed information about processes and/or activities that have triggered alerts. Note: This preconfigured dashboard does not have corresponding alerts defined for it in PRS. It only contains reports about alerts. You must define alerts first, in PRS, and once triggered, the Alert Monitor dashboard is populated with data. All reports in this dashboard have been formatted in Crystal Reports. A description of how each report is formatted in Crystal Reports is provided, however, detailed instructions are not provided. Please see the Crystal Report documentation for more information. 156 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

157 Working with Preconfigured Dashboards Understanding the Alert List dashlet The Alert List dashlet displays a list of all processes and/or activities for which an alert has been triggered. Alerts are defined in the Alerts window of PRS. Once an alert is triggered, it populates the Alert List dashlet with the name of the process or activity, its status, the date of the alert, the name of the alert, the entity name (either a process name or an activity name), and the entity type. Understanding the alert list dashlet, page 128 provides more information about this dashlet. Creating an alert, page 103 provides guidelines for defining alerts in PRS. Dashboard users can interact with this dashlet to edit the status of an alert that has been triggered. Updating the status of an alert, page 144 addresses editing an alert. Understanding the Alert Resolution report When alerts are generated dashboard users have the option of selecting a status within the alert list dashlet. To update the status the user must click the Edit button for a specific process or activity. Within the edit window the dashboard user enters a note and selects a status. There are three statuses: New, Acknowledged, and Closed. The Alert Resolution report counts the number of each type of status and presents it in a bar chart. This report is defined as a Crystal Report that includes the Alert report entity and Status entity field in the data source. In Crystal Reports the report was formatted to count the number of alerts for each status. Understanding the Alerts per Process report The Alerts per Process report is a Crystal Report that displays a count of alerts per status for each process. This means that each process has a total of three bars in the report, with each bar representing the number of alerts that are New, Acknowledged, and Closed. Crystal Reports is required because the number of alerts for each status is counted. This method of aggregation is not available with simple reports. Within Crystal Reports a sum function is applied to each status column, and then a group-by function is applied to the process column. In addition, Crystal Reports was used to configure the Alerts per Process report as the base in a single drill-down report. When a dashboard user selects any of the processes, the Alerts per Activity report is displayed. Configuring Crystal Report drill-downs, page 99 addresses this type of drill-down report. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 157

158 Working with Preconfigured Dashboards Understanding the Alerts per Activity report The Alerts per Activity report is a Crystal Report that displays a count of alerts per status for each activity in the selected process. This means that each activity has a total of three bars in the report, with each bar representing a count of alerts that are New, Acknowledged, and Closed. Crystal Reports is required because the number of alerts for each status is counted. This method of aggregation is not available with simple reports. Within Crystal Reports a sum function is applied to each status column, and then a group-by function is applied to the activity column. In addition, Crystal Reports was used to configure the Alerts per Activity report as the target in a single drill-down report that is displayed when a dashboard user selects a process in the Alerts per Process report. Localizing the preconfigured dashboards Installing a localized version of BAM does not automatically localize the preconfigured dashboards shipped with the product. This is because the dashlets displayed in a dashboard are based on the reports as defined in PRS, which are labeled in English. Localizing a preconfigured dashboard involves changing the names of each report in PRS and then rebuilding the dashboard in TaskSpace. This procedure assumes that you are familiar with: Process Reporting Services the BAM dashboard design tool Crystal Reports. To localize preconfigured dashboards 1. Log into PRS and open the Preconfigured Dashboard report category. All preconfigured dashboard reports are saved in their own category. 2. Make a copy of each report by right-clicking the report and selecting Copy. Then, right-click on the report category to which it belongs and select Paste. 3. Right-click each copied report and select Rename. 4. Enter a new name for the report. 5. To localize simple report entity field captions, right-click the report entity within the Data Source window and select Caption Editor. Then, change the name of each selected entity field caption. 6. To localize Crystal Reports entity field captions, open each report in the Crystal Reports application. This is where captions must be modified. Then, the report must be saved and synchronized back into PRS. 158 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

159 Working with Preconfigured Dashboards 7. Single drill-down reports must be redefined in PRS: a. Begin by opening the localized version of the In-flight Process Statistics report. b. Select the Chart Data tab. c. Configure the localized version of the Processes in Flight column to drill-down to the localized version of the In-flight Activity Statistics report. d. Then, open the localized version of the Count of Processes per State report. e. Select the Chart Data tab. f. Configure the localized version of the Count of Started Instances column to drill-down to the localized version of the Count of Activities per State report. 8. Within TaskSpace, create three new dashboards. These should be localized versions of Process Monitor, Process Summary, and Alert Monitor. 9. Add the dashlets to each dashboard. Note: For a guide to laying out the report and diagram dashlets, please refer to the structure of each original preconfigured dashboard. 10. Configure the multi-drill-down reports for the localized version of the Process Monitor dashboard by selecting the Multi-Drill tab. 11. Then, configure the multi-drill-down reports as shown below. Note: The figure below shows the original reports. These be changed to the new, localized reports. Figure 74. Process Monitor multi-drill-down report configuration 12. Select the Dashlet Filter tab and configure the filter for the List of Process Instances report as shown below. Note: Your Dashlet Filter window will look different as it displays localized versions of the filters. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 159

160 Working with Preconfigured Dashboards Figure 75. Process Instance List report dashlet configuration 13. Open the Process Summary dashboard and configure the dashlet filters as follows. Note: Your Dashlet Filter window will look different as it displays localized versions of the filters. a. Select the Processes filter for the Count of Processes per State report. Figure 76. Count of Processes per State filter configuration b. Select the Processes filter for the In-flight Process Statistics report. Figure 77. In-flight Process Statistics filter configuration c. Select the Performer Name filter for the Tasks Completed by Performer report. 160 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

161 Working with Preconfigured Dashboards Figure 78. Tasks Completed by Performer filter configuration d. Select the Performer Name filter for the Tasks Pending for Each Performer report. Figure 79. Tasks Pending for Each Performer filter configuration 14. Once all changes have been made in the dashboard design tool, you must create new tabs within TaskSpace and then add each dashboard to a tab. 15. Tabs must be assigned to dashboard users. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 161

162 Working with Preconfigured Dashboards 162 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

163 Chapter 7 Working with BAM in a Production Environment BAM, like many technology solutions and business applications, is usually deployed in phases. The first phase of an implementation makes use of a BAM development environment. This is a technical environment used for designing and configuring processes for monitoring, and designing dashboards. Once development is complete the solution can be deployed to a BAM production environment. Production environments are comprised of processes executing and being monitored in the real world, with real performers and data. The production environment may already exist, or may be newly created. Both approaches migrate objects from the BAM development repositories. Process data is much more voluminous once BAM is operational in a production environment. As a result, the size of the BAM database needs monitoring and adjusting periodically. Allocating the appropriate space to a BAM database is very important. This topic is addressed in the Business Activity Monitor Installation Guide. In some cases it may be necessary to purge old data from the BAM database. Purge jobs can be scheduled to work against any of the execution database tables. This chapter addresses BAM production environment issues, including: Deploying BAM to a production environment, page 163 Monitoring BAM database table space, page 168 Modifying the number of records returned in a results set, page 168 Scheduling BAM database purging, page 168 Purging the Audit Trail database, page 170 Enhancing BAM system performance, page 170 Deploying BAM to a production environment The following section describes how to move a fully configured BAM solution from a development environment to a production environment. EMC Documentum Composer is the technology used for creating and maintaining BAM applications. Specifically, Composer provides the ability to: EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 163

164 Working with BAM in a Production Environment import a report that was developed in an existing repository install a report as part of the installation of an application import BAM configuration options from an existing repository install the BAM configuration options as part of the installation of an application import a BAM dashboard as part of importing a TaskSpace application detect a dashboard s references to reports and imports those reports as part of the TaskSpace application import There are two important things that Composer does not do, however. First, Composer does not create the BAM database. The BAM database must be created first, in the production environment. Second, Composer cannot be used to create new BAM objects. New BAM objects can be created from other client tools like Process Reporting Services and Process Builder. The approach outlined in this section should be used when BAM is migrated to a new production environment and when updates are being made to an existing production environment. The only difference is that updating an existing production environment simply overwrites objects that already exist and adds objects that are new. This section includes procedures for importing BAM artifacts from an existing repository and installing these artifacts onto a new repository. See the Documentum Composer User Guide for more information. To import BAM artifacts into Composer project 1. Log into Composer and create a new Documentum project. 2. Right-click anywhere in the left tree menu and select Import. 3. Select Artifacts From Repository and click Next. 164 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

165 Working with BAM in a Production Environment Figure 80. Composer import window 4. Select (or enter) the project into which the BAM artifacts are being imported. 5. Select (or enter) the repository containing the artifacts being imported. 6. Enter the user name and password of the selected repository and click Login. This authenticates the user makes the Next button active. 7. Click Next. Figure 81. Import artifacts from repository 8. Select an artifact type from the pull-down list based on the following: BAM Configuration this option imports all files used in the configuration of BAM. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 165

166 Working with BAM in a Production Environment TaskSpace Application this option imports BAM dashboards including all reports used in a dashboard. Report this option should only be used when you must update the definition of a report (or reports) that has already been migrated to production. Note: The report option is not appropriate for migrating a new BAM dashboard report to production. New reports make their way to production by way of a TaskSpace Application. 9. Each artifact type selected generates a list of individual artifacts. Select one or more artifacts from the Choose From Available Artifacts field and click Add. This moves the artifact(s) to the Selected Summary field. 10. Click Finish. Figure 82. Select BAM artifacts To install BAM artifacts into a new repository 1. Log into Composer. 2. Right-click anywhere in the left tree menu and select Install Documentum Project EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

167 Working with BAM in a Production Environment Figure 83. Install Documentum project 3. Select (or enter) the repository into which the BAM artifacts are being installed. 4. Enter the user name and password of the selected repository and click Login. This authenticates the user. 5. Select Overwrite from the Install Option pull-down list. 6. Click Finish. Figure 84. Select target repository EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 167

168 Working with BAM in a Production Environment Monitoring BAM database table space During installation, BAM databases should be sized to meet anticipated volumes of process data. The initial size of the database can be calculated using the BAM Database Sizing Calculator available on the EMC Download Center. In production environments the BAM database table space needs to be monitored and adjusted periodically. This should be done by a database administrator with tools provided by the database vendor. If required, BAM database tables can be purged. Scheduling BAM database purging, page 168 outlines a purging procedure. Modifying the number of records returned in a results set The number of records returned for a report can be increased or decreased by modifying the maxrows parameter in the jdbc-config.xml configuration file. Controlling the number of records retrieved is especially important for reporting, since large results sets can negatively impact system performance and may lead to an out of memory error. The default number of records returned is controlled by BAM and is set to 1,000. Note: This parameter can be set to zero (0). This sets the maximum number of rows returned to be a function of the JDBC driver. To modify the number of records returned in a results set 1. Open the bam-server.war or the bam-server.ear archive file. 2. Navigate to WEB-INF\classes\config\. 3. Open the jdbc-config.xml file. 4. Update the value entered in the <maxrows> element. 5. Save your changes. Scheduling BAM database purging A BAM database can quickly be filled with thousands of records. Therefore, the amount of space allocated to a BAM database during installation is very important. Calculating the size of a BAM database is addressed in the Business Activity Monitor Installation Guide. Once a BAM database nears its capacity, purging becomes important. The ability to schedule purging is available for the following database tables: Process Instance 168 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

169 Working with BAM in a Production Environment Activity Instance The BAM server uses Quartz to schedule purge jobs. A Basic schedule is configured using radio buttons and pull-down lists. Advanced schedules are configured by way of a cron expression. A cron expression is a string of text divided into 7 sections, with each section representing a different dimension of a schedule. These dimensions are: seconds minutes hours day of month month day of week year (optional) Each section has a defined set of allowed values and characters. For more information on defining cron expressions please refer to: org/quartz/crontrigger.html and TutorialLesson6.html. Both types of schedules include an interval buffer. An interval buffer is the amount of data to which the purge job does not apply. It provides a safety net in case data is mistakenly purged. For example, if the integration table is scheduled to purge every Wednesday at 12 noon with a 4 hour interval buffer, then the purge job would delete all data except that captured between 8 am and 12 noon on Wednesday. Note: There are several automatic purgers used for aggregated data. These purgers run on a daily basis at 11:00 PM and leave one week of data while deleting everything else. The table below summarizes the aggregation time period and type of data purged: Table 4. Automatic purgers 5 Minutes Activity, process, performer, incomplete activity, incomplete process 15 Minutes Activity, process, performer, incomplete activity, incomplete process 30 Minutes Activity, process, performer 1 Hour Activity, process, performer, incomplete activity, incomplete process To schedule purging 1. Log in to TaskSpace. For more information on logging in please see Logging in to TaskSpace, page Select the Administration tab. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 169

170 Working with BAM in a Production Environment 3. From the left tree menu select Server Management > Business Activity Monitoring > Clean History Data. 4. Select a BAM table. 5. Click the Edit button located at the bottom of the form. This opens a scheduler window. 6. To create a basic schedule: a. Select the Basic radio button. b. Select either the Weekly, Monthly, or Yearly radio button. c. Use the pull-down lists to select a scheduling time interval. d. Use the radio buttons and pull-down lists to select an interval buffer. e. Click Ok. 7. To create an advanced schedule with a cron expression: a. Select the Advanced radio button. b. Enter a cron expression in the field provided. c. Use the radio buttons and pull-down lists to select an interval buffer. d. Click Ok. Purging the Audit Trail database Business Activity Monitor formats and aggregates process data written to the Documentum Audit Trail database. Over time, audit trail entries can take up a lot of space in your repository, which compromises system performance. Once audit trail data is formatted and aggregated, it is no longer needed. Therefore, you must periodically purge these entries out of the database. Please refer to the Audit management (dm_auditmgt) and Modifying jobs sections of the Documentum Administrator User Guide for guidance in configuring a purge audit job. Enhancing BAM system performance BAM system performance should be monitored. There are two techniques for enhancing system performance. First, where appropriate, report designers should create reports by using aggregation entities (Process Execution 5 Minute, Activity Execution Daily, etc) and not instance report entities (Activity Execution, Process Execution). Reports run more quickly when aggregation entities are used. In addition, dashboard designers 170 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

171 Working with BAM in a Production Environment should not create very complicated filter expressions. Every AND/OR adds complexity, which slows down the report query. Even though these steps are taken, over time the BAM piping process may slow down. If this should occur and index on the Audit Trail table in Content Server should be created. To create an index on the Audit Trail table 1. Stop the Content Server application server. 2. Log in to IDQL and select the target repository. 3. Execute the following DQL statement: EXECUTE make_index WITH type_name='dm_audittrail',attribute='time_stamp' EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 171

172 Working with BAM in a Production Environment 172 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

173 Chapter 8 Creating Custom Aggregation, Report, and Filter Entities Process Reporting Services (PRS) is used for creating reports and alerts on the data that is stored by Business Activity Monitor. PRS includes many report and filter entities that expose the data in a variety of ways. Due to the wide variety of implementations, the predefined entities may not be sufficient. For example, if data aggregation is to be grouped in a customized manner or if a certain filter is missing. In these cases, new BAM reporting entities should be created that are tailored to meet the reporting requirements. The purpose of this chapter is to explain the concepts and procedures involved in creating custom aggregations, report entities, and filter entities. The intended audience for this chapter includes database administrators or database SQL developers with extensive knowledge in SQL. Note: Creating custom entities requires executing SQL statements and formulating DQL queries. Therefore, it is highly recommended that you save the statements in a file. This makes the transition from a development environment to a production environment much easier, since all entities must be recreated for each new deployment. The scenario presented in this chapter is based on an order fulfillment process. This process captures the details of each customer and the customer s order. This business data is modeled in Process Builder as an SDT. For marketing purposes, it may be interesting to look at the number of process instances according to the customers home state. For example, a report should show, for a given time period, the trend of new orders fulfilled from a particular state. The default process aggregation, however, makes no such state-by-state distinction, and will group all process instances for a given period of time. In such a case, it is necessary to define a custom aggregation. This chapter includes the following sections: Configuring BAM custom aggregation, page 174 Creating custom report entities, page 176 Creating custom filter entities, page 184 Understanding report entity tables, page 199 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 173

174 Creating Custom Aggregation, Report, and Filter Entities Configuring BAM custom aggregation The process of aggregation itself takes instance level data and, based on a series of aggregation jobs, collapses the data into the following time intervals: 5 minutes 15 minutes 30 minutes Hourly Daily Weekly Monthly Quarterly Yearly Not all time intervals are required. Custom aggregation allows the user to select the specific time intervals he or she is interested in creating. For instance, it is possible to schedule a custom aggregation job for the 5 minute time interval, but not for the 1 hour time interval. Conversely, a custom aggregation job can be scheduled for the 1 hour time interval, but not for any other time interval. The time interval must be specified in a DQL script that creates the custom aggregation objects. If there are no custom aggregations defined, then the jobs do not run. Defining a custom aggregation involves: Creating a custom table Creating a custom query Storing the custom query in a location that is visible to the repository Creating a bam_custom_aggr object that stores all values in the repository Example 8-1. Custom aggregation scenario A user wants to create a daily aggregation that counts the number of orders submitted for each state. The user must first create a custom table (called ORDERS_BY_STATE_D), and then create a custom query that inserts new data every day into this custom table. Note: All examples throughout this section assume that an Oracle database is being used. To configure BAM custom aggregation 1. Shut down the BAM server. 2. Run a SQL statement for the creation of a database table that contains the aggregation. This table will be used in Step #5 when you create the aggregation object in the repository. Note: The table must contain the following columns: START_JAVATIME, START_DATETIME, and END_DATETIME. 174 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

175 Creating Custom Aggregation, Report, and Filter Entities CREATE TABLE ORDERS_BY_STATE_D( STATE VARCHAR2(256), START_JAVATIME NUMBER, START_DATETIME TIMESTAMP, END_DATETIME TIMESTAMP, ORDER_COUNT NUMBER(38)); 3. Use the following sample to create a custom query that runs every day, and counts the number of customer orders for US state on a daily basis. This script is later saved in the repository. INSERT INTO ORDERS_BY_STATE_D(STATE, START_JAVATIME, START_DATETIME, END_DATETIME, ORDER_COUNT) SELECT SDT.ATTR0, :JAVATIME, :FROMDATE, :TODATE, COUNT(EXEC_PROCESS_INSTANCE.ID) FROM EXEC_PROCESS_INSTANCE, EB_ORDERSBYSTATE SDT WHERE END_DATETIME >= :FROMDATE AND END_DATETIME < :TODATE AND EXEC_PROCESS_INSTANCE.INSTANCEID = SDT.INSTANCEID GROUP BY SDT.ATTR0 Note: This script must contain three parameters: FROMDATE, TODATE, and JAVATIME. Note: ATTR0 is a column corresponding to the STATE field in the ORDERS_BY_STATE database table. The relationship between the column name and the field name is found in the def_sdt_field table. In addition, the table name for this particular SDT (EB_ORDERSBYSTATE) is found in the def_sdt_tables. 4. Store the query in a text file (.txt) in a location that is accessible to the repository, according to the DQL SETFILE command specification (for instance, c:\query.txt). You will be running the DQL SETFILE command in the next step. 5. Use the following sample to create the BAM custom aggregation object for daily aggregation. create bam_custom_aggr object set object_name = 'AggrCustomD', set table_script = 'CREATE TABLE ORDERS_BY_STATE_D( STATE VARCHAR2(256), START_JAVATIME NUMBER, START_DATETIME TIMESTAMP, END_DATETIME TIMESTAMP, ORDER_COUNT NUMBER(38))', setfile 'c:\query.txt' with content_format='text'; go Note: Valid object names values are listed in the following table. Table 5. Segments of report entity query AggrCustom5m AggrCustomQH AggrCustomHH 5 minutes 15 minutes 30 minutes EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 175

176 Creating Custom Aggregation, Report, and Filter Entities AggrCustomH AggrCustomD AggrCustomW AggrCustomM AggrCustomQ AggrCustomY Hourly Daily Weekly Monthly Quarterly Yearly 6. Create all necessary report and filter entities. To run reports against the aggregation table you must create reporting and filter entities in the BAM database. For more information please see Creating custom report entities, page 176 and Creating custom filter entities, page Restart the BAM server. Tip: If you need to debug the aggregation runtime query, please refer to bam-server.log available with the log folder of the application server directory. Creating custom report entities This section addresses how to create report entities and relationships, add entity fields to an existing report entity, and create an entity from a database function. Creating custom report entities Custom report entities can be created once database tables and/or views are available in the BAM schema. Custom report entities can also be created directly against the external tables through database links. Custom report entities provide the PRS report designer with objects with which to define a report s data source. The report entity contains entity fields that map to columns in the database. The procedure below builds on the example in the previous section. The result is a report entity for the ORDERS_BY_STATE_D table, calculating the number of customer orders received on a given date, for each state. At this point, the new entity is not related to other entities and does not have any filters defined. The example illustrates the minimum required data for a reporting entity to be operational. 176 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

177 Creating Custom Aggregation, Report, and Filter Entities Table 6. Segments of report entity query Entity Type Is Base Entity Entity Where (clause) GUI Display Data The process entity by which the report entity can be filtered. This affects the list of filters available for the report entity. Multiple report entities can have the same entity type, so that filters can be shared. Enter True if the report entity can be used as the first entity in a report. This is also called a base entity. The where clause for this entity, based on the tables selected. Always use the alias Entity Table[N].column name, where N is the index of the entity table. A unique name for the entity. This name is displayed to the report designer. Caution: When reporting on external data it is recommended that you not create the report entity on a database view that is based on a database link. Instead it is recommended that you create new tables based on external data and update regularly. You should create the report entity on the aggregation entity. To create a custom report entity 1. Shut down the BAM server. 2. Launch IDQL 32. It can be found on the system where Content Server is installed, under the %DM_HOME%\bin directory. 3. Execute the create object DQL statement below. This step creates the Orders By State Daily report entity. create bami_rg_entity object set entity_type='orders By State Daily', set is_base=true, append entity_where='1=1', set gui_display_data='orders By State Daily', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go 4. Execute the create object DQL statement below. This statement defines a relationship between a report entity and a custom defined table/view. This relationship is based on the report entity created in Step 3. The table/view must have already been created. In this example the new report entity will display data from a single table: ORDERS_BY_STATE_D (table_index=0). create bami_rg_entity_table object set entity_id=(select r_object_id from bami_rg_entity where gui_display_data ='Orders By State Daily'), EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 177

178 Creating Custom Aggregation, Report, and Filter Entities set table_index=0, set table_name='orders_by_state_d', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go 5. Execute the create object DQL statement below. This statement defines a key for the Orders By State Daily report entity which is used when applying filters to the report entity. create bami_rg_entity_key object set entity_table_id=(select et.r_object_id from bami_rg_entity_table et,bami_rg_entit e where et.entity_id=e.r_object_id and e.gui_display_data ='Orders By State Daily' and et.table_index=0), set key_index=0, set field_name='state', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go 6. Execute the create object statements below. This step defines the columns from each table that are exposed to the report designer as entity fields. If these statements are not executed, then no entity fields will be available. In this example, the Started Date and Time, Ended Date and Time, State, and Number of Orders entity fields are populated with data taken from the ORDERS_BY_STATE_D table. The relationship between the entity field name and the tables is defined by way of an index. The entity field can be selected by default within the report entity. This is specified in set select_as_default (True or False). The example also includes the convention for each supported database. This script adds the Start Date and Time field. create bami_rg_entity_field object set entity_table_id=(select t.r_object_id from bami_rg_entity_table t, bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = 'Orders By State Daily' and t.table_index=0), set field_index=0, append field_db_name='start_datetime', append field_db_name_oracle='start_datetime', append field_db_name_mssql='start_datetime', append field_db_name_db2='start_datetime', set field_gui_name='start Date and Time', set select_as_default=true, set select_rep_values_default=false, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go This script adds the End Date and Time field. 178 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

179 Creating Custom Aggregation, Report, and Filter Entities create bami_rg_entity_field object set entity_table_id=(select t.r_object_id from bami_rg_entity_table t, bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = 'Orders By State Daily' and t.table_index=0), set field_index=1, append field_db_name='end_datetime', append field_db_name_oracle='end_datetime', append field_db_name_mssql='end_datetime', append field_db_name_db2='end_datetime', set field_gui_name='end Date and Time', set select_as_default=true, set select_rep_values_default=false, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go This script adds the State field. create bami_rg_entity_field object set entity_table_id=(select t.r_object_id from bami_rg_entity_table t, bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = 'Orders By State Daily' and t.table_index=0), set field_index=2, append field_db_name='state', append field_db_name_oracle='state', append field_db_name_mssql='state', append field_db_name_db2='state', set field_gui_name='state', set select_as_default=true, set select_rep_values_default=false, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go This script adds the Number of Orders field. create bami_rg_entity_field object set entity_table_id=(select t.r_object_id from bami_rg_entity_table t, bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = 'Orders By State Daily' and t.table_index=0), set field_index=3, append field_db_name= ORDER_COUNT, append field_db_name_oracle= ORDER_COUNT, append field_db_name_mssql= ORDER_COUNT, append field_db_name_db2= ORDER_COUNT, set field_gui_name='number of Orders', set select_as_default=true, set select_rep_values_default=false, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 179

180 Creating Custom Aggregation, Report, and Filter Entities 7. Restart the BAM server for changes to take effect. The new report entity will be available in PRS. Creating relationships between two entities More complex reports are designed with multiple report entities arranged in parent-child relationships. For example, the Activity Execution entity is a child of Process Execution. These relationships are displayed in the report design palette in PRS. Custom report entities, too, can be defined to have parent-child relationships. It is possible to define relationships with other custom report entities, or with existing entities. Creating a relationship between two report entities requires that you know the parent entity id and the child entity id values. Entity id values are the r_object_id fields of the bami_rg_entity table. Use the following DQL statement to find the parent entity id and child entity id values: Select r_object_id, gui_display_data from bami_rg_entity go Where: r_object_id is the entity identification number, and gui_display_data is the name of the report entity as it is displayed in PRS Table 7. Segments of entity relations query Parent Entity Id Where Clause The parent entity for the relationship. The SQL Where Clause to relate the parent entity to the child entity. When referring to a Parent entity, you can only use Keys of the entity. To relate to any parent key value, you must use the following convention: parent_entity.id[key Index]. You can use any value from the Child entity. To relate to a child entity table, you should use the EntityTable[table index] alias. The Parent Keys and Child Keys lists are available while writing the Relation where clause. In the following example, a parent-child relationship is defined between two entities. The parent entity is Orders By State Daily, which was defined in the previous procedure. The child entity will be a new table that provides more details for every state in the United States. Assume that this table s structure is the following: CREATE TABLE US_STATES ( STATE_ABBREVIATION VARCHAR(256), STATE_FULLNAME VARCHAR2(256)) 180 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

181 Creating Custom Aggregation, Report, and Filter Entities To create a relationship between two report entities 1. Execute the create object statements below. These statement creates the report and field entities for the US_STATES table This script creates a US States report entity. create bami_rg_entity object set entity_type='us States', set is_base=true, append entity_where='1=1', set gui_display_data='us States', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go This script defines a relationship between the report entity and a table/view. create bami_rg_entity_table object set entity_id=(select r_object_id from bami_rg_entity where gui_display_data ='US States'), set table_index=0, set table_name='us_states', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go This script adds the State Abbrevation field. create bami_rg_entity_field object set entity_table_id=(select t.r_object_id from bami_rg_entity_table t, bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = 'US States' and t.table_index=0), set field_index=0, append field_db_name='state_abbreviation', append field_db_name_oracle='state_abbreviation', append field_db_name_mssql='state_abbreviation', append field_db_name_db2='state_abbreviation', set field_gui_name='state Abbreviation', set select_as_default=true, set select_rep_values_default=false, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go This script add the State Full Name field. create bami_rg_entity_field object set entity_table_id=(select t.r_object_id from bami_rg_entity_table t, bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = 'US States' and t.table_index=0), set field_index=1, append field_db_name='state_fullname', append field_db_name_oracle='state_fullname', append field_db_name_mssql='state_fullname', EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 181

182 Creating Custom Aggregation, Report, and Filter Entities append field_db_name_db2='state_fullname', set field_gui_name='state Full Name', set select_as_default=true, set select_rep_values_default=false, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go 2. Then, a relationship between US States and the Orders By State Daily report entity is defined. The following DQL statement first creates a new entity key object that is used in defining the relationship between the two report entities. The entity key object is used in the where clause in Step 3. create bami_rg_entity_key object set entity_table_id=(select et.r_object_id from bami_rg_entity_table et, bami_rg_entity e where et.entity_id=e.r_object_id and e.gui_display_data = 'US States' and et.table_index=0), set key_index=0, set field_name= STATE_ABBREVIATION, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go 3. Execute the create object statement below. This statement defines a relationship between the US States report entity and Orders By State Daily report entity. The where clause uses the entity key object created in Step 2. create bami_rg_relation object set parent_entity_id=(select r_object_id from bami_rg_entity where gui_display_data='orders By State Daily ), set child_entity_id=(select r_object_id from bami_rg_entity where gui_display_data='us States ), append where_clause='parent_entity.id0=entitytable0.state_abbreviation', set distinct_relation=false, set description_code='', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Adding a field to an existing entity There are times when an existing report entity does not contain an entity field that is required. In the procedure below the Sum of Orders field is added to the Orders By State Daily report entity. The field index value is set to 4 because it is the next identification value available for the report entity. The entity id value comes from the report entity to which the field is being added. The table index value comes from the table that contains 182 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

183 Creating Custom Aggregation, Report, and Filter Entities the entity field you are adding. The GUI name is displayed as the name of the entity field and caption. The example also includes the convention for each supported database. Note: It is assumed that a database table column named ORDER_SUM exists in ORDERS_BY_STATE_D table, which was not part of the previous examples. create bami_rg_entity_field object set entity_table_id=(select t.r_object_id from bami_rg_entity_table t, bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = Orders By State Daily and t.table_index=0), set field_index=4, append field_db_name= ORDER_SUM, append field_db_name_oracle= ORDER_SUM, append field_db_name_mssql= ORDER_SUM, append field_db_name_db2= ORDER_SUM, set field_gui_name='sum of order amounts', set select_as_default=false, set select_rep_values_default=false, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Adding a field to an existing entity using a database function Fields can also be added to an existing entity using a database function. When using an expression to construct the field value, you must encapsulate the first column name with <@ characters. If the BAM database is installed on MS SQL Server, then convert(varchar,<@start_datetime@>)+ +EntityTable0.name would be used. In the following example, the Formatted Sum of Orders column is added to the Orders By State Daily report entity. This column returns the Total Order Summary with a dollar sign, for example $100. Note: It is assumed that a database table column named ORDER_SUM exists in ORDERS_BY_STATE_D table, which was not part of the previous examples. create bami_rg_entity_field object set entity_table_id=(select t.r_object_id from bami_rg_entity_table t, bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = 'Orders By State Daily' and t.table_index=0), set field_index=5, append field_db_name='''$'' CHAR(<@ORDER_SUM@>)', append field_db_name_oracle='''$'' TO_CHAR(<@ORDER_SUM@>)', append field_db_name_mssql='''$'' + CONVERT(VARCHAR(20),<@ORDER_SUM@>)', append field_db_name_db2='''$'' TO_CHAR(<@ORDER_SUM@>)', set field_gui_name='formatted Sum of Orders', set select_as_default=true, set select_rep_values_default=false set acl_name='bam Admin ACL', EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 183

184 Creating Custom Aggregation, Report, and Filter Entities set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Creating custom filter entities Filter definitions are stored in the repository and are made visible in Process Reporting Services BAM dashboard Filters are meant be applied to a report entity, restricting its results to the rows that match the filter s condition. Creating a new filter entity can be divided into two parts: 1. The functional definition, which contains the SQL predicates that are appended to a report entity s query; and 2. The visual definition, which gives the filter its name and location in the filter tree. The functional definition involves creating filter entities. The visual definition involves: creating PRS and dashboard tree items creating tree item expressions creating filter token items defining filter entity relationships Each entity has one or more filters that relate to it. When relating a filter to an entity, you are defining its placement within the user interface and the SQL query to which it relates. In PRS, each filter is displayed within a tab on the Filter window. For web filters, all filter items that relate to a specific entity are displayed in the browser window. It is helpful to have PRS open when filters are defined. In this way it is possible to test changes made to your filter in runtime. After you have made a change you can refresh the filter by reopening the Filter window. While PRS can remain open, the BAM server must be restarted for the new filter definition to be available. This graphic shows the various parts of a BAM filter: 184 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

185 Creating Custom Aggregation, Report, and Filter Entities Figure 85. Filter display in PRS Creating filter entities Filter entities are stored in the bami_flt_entity object type. Each filter entity contains the query that is used by the filter engine during runtime. The table below summarizes each segment of a filter entity query. Table 8. Filter entity segment descriptions Entity Type Entity Key From Clause Entity Key Columns The name of the related report entity. When constructing a filter for a particular report entity, the filter s entity type should be the same as that of the report entity. The from clause of the entity. The tables referenced by this clause should refer to one or more of the bami_rg_entity_table objects that are part of the report entity s definition. The entity key column is used to join the entity and the filter. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 185

186 Creating Custom Aggregation, Report, and Filter Entities Entity Key Where Clause Symbol Entity Type Built-In The Where Clause of the base entity. This typically is non-constricting ( where 1=1 ). The primary use of the Where Clause is to connect the filter query to the base query. This is used for internal filters. Leave this empty for new entities. Always enter a 0 when defining a new entity, or leave blank. 1 is reserved for internal entities, and should not be used. Note: When creating new filter entities, all custom objects should be linked to /System/BAM/Custom Entities folder and all objects should have an ACL name BAM Admin ACL. Example 8-2. Create entity filter This example illustrates how a new filter entity with the name Orders By State Daily is created. create bami_flt_entity object set entity_type='orders By State Daily', set entity_key_columns='e.state', set entity_key_from_clause='orders_by_state_d e', set entity_key_where_clause='where EntityTable0.START_DATETIME=e.START_DATETIME ', set built_in=0 set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Note: EntityTable0, which is referenced in the where clause, is the alias of the ORDERS_BY_STATE_D table in the report entity Orders By State Daily. Creating filter tabs A tree item is contained in a single filter tab. The filter tab is a visual component of the filter tree, and is also used as a qualifier to the filter expression. For example, if the filter Activity-Name is in the STD tab, then the filter s expression would be STD.Activity-Name. Tabs are defined in the bami_filter_definition Documentum type. The bami_filter_definition type is a stub object that binds together several filter definitions. The object name of the bami_filter_defnition type should be unique because it is later referenced by the bami_filter_tree_item type, where the filter_id attribute is equal to r_object_id in the bami_filter_definition. The bami_filter_definition type is comprised of the following columns: 186 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

187 Creating Custom Aggregation, Report, and Filter Entities Column name object_name Definition A unique identifier for the filter tab. This object name should be unique within the entire BAM system. It will be referenced by the DQL scripts for creation of the tree items. A new filter may reference an existing filter tab. Usually, there is no need to create a new tab definition. Example 8-3. Create a filter definition object This script creates a State Filter Tab filter entity. create bami_filter_definition object set object_name='state Filter Tab', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Creating filter token items Filter token items are the fields used in constructing a filter expression. A unique object_name and filter item expression name (typed in UPPER CASE) must be entered. The values must be unique within the context of this filter definition. Filter token items are stored in the bami_flt_filter_token_items object type. Filter token items define the relationship between the tree item and the SQL queries that are executed on BAM server. Filter token items are used for internal purposes only. That is, you cannot see them on the user interface. Once defined, filter token items are used in defining the filter entity relationship. The bami_flt_filter_token_items type is comprised of the following attributes: Column name Object_name Filter_id filter_item_expr_name Definition This is a unique identifier for this filter. It could be equal to the filter item expression name (in case it is unique for the filter definition). r_object_id of the bami_flt_filter_definition object. The name of the item as it will be seen in the filter expression. Note: The filter item expression name must be capitalized and written without spaces. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 187

188 Creating Custom Aggregation, Report, and Filter Entities Example 8-4. Create filter token item This example creates filter token items according to State Name and State Full Name. create bami_flt_filter_token_items object set object_name='1', set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set filter_item_expr_name='state-name', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go create bami_flt_filter_token_items object set object_name='2', set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set filter_item_expr_name='state-full-name', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Defining filter entity relationships Filter entity relationships are defined in the bami_flt_filter_entity type. The bami_flt_filter_entity type is comprised of the following columns: Column name entity_type filter_id filter_item_id filter_entity_from_clause flt_sql_column_name_oracle, flt_sql_column_name_mssql, flt_sql_column_name_db2, flt_sql_column_name_sybase Definition Select the entity to which the filter relates. Refer to the bami_flt_entity type. Select the filter to be attached to the selected entity. Refer to the bami_filter_tree_item type. The filter item ID represents the token item unique identifier. Refer to the bami_flt_filter_token_items type. This is the from clause of the filter expression. It defines the table names that are part of the query. Column name is used to represent conditions defined by users. 188 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

189 Creating Custom Aggregation, Report, and Filter Entities flt_where_clause_oracle, flt_where_clause_mssql, flt_where_clause_db2, flt_where_clause_sybase filter_entity_token_name filentity_token_long_name filter_entity_order_by This is the where clause of the filter expression. It defines the filter condition. There is one field for each database dialect. This column represents the alias name assigned when the filter is used in a filter expression. This value replaces :FilterTokenName from the filter tree item expressions list. This field is shown in the label of the filter tab within PRS. Represents the order in which the filter tab is displayed in the list of tabs for this entity. All items must have the same value per filter. Note: At runtime, the SQL query generated for each filter item is structured as follows: [Report Entity Select Statement] AND Entity-Id IN (Select Entity-Id FROM [FILTENT_FROM_CLAUSE] WHERE [FILTENT_WHERE_CLAUSE] AND [FILTERITEM_SQL_COLUMNNAME] [Selected Operator] [Selected Value]) Example 8-5. Create filter entity relationship This example creates filters by state name and state full name on the Orders By State Daily entity. This script creates the filter entity for filtering by state create bami_flt_filter_entity object set entity_type='orders By State Daily', set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set filter_item_id=(select fti.r_object_id from bami_flt_filter_token_items fti,bami_filter_definition fd where fti.filter_id=fd.r_object_id and fd.object_name='state Filter Tab' and fti.object_name='1'), set filter_entity_token_name='stt', set filter_entity_from_clause='orders_by_state_d e', append flt_where_clause_oracle='1=1', append flt_where_clause_mssql='1=1', append flt_where_clause_db2='1=1', append flt_where_clause_sybase='1=1', set flt_sql_column_name_oracle='e.state', set flt_sql_column_name_mssql='e.state', set flt_sql_column_name_db2='e.state', set flt_sql_column_name_sybase='e.state', set filentity_token_long_name='state', set filter_entity_order_by=20, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 189

190 Creating Custom Aggregation, Report, and Filter Entities This script creates the filter entity for filtering by the full name of the state. create bami_flt_filter_entity object set entity_type='orders By State Daily', set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set filter_item_id=(select fti.r_object_id from bami_flt_filter_token_items fti,bami_filter_definition fd where fti.filter_id=fd.r_object_id and fd.object_name='state Filter Tab' and fti.object_name='2'), set filter_entity_token_name='stt', set filter_entity_from_clause='orders_by_state_d e, US_STATES st', append flt_where_clause_oracle='e.state=st.state_abbreviation', append flt_where_clause_mssql='e.state=st.state_abbreviation', append flt_where_clause_db2='e.state=st.state_abbreviation', append flt_where_clause_sybase='e.state=st.state_abbreviation', set flt_sql_column_name_oracle='st.state_fullname', set flt_sql_column_name_mssql='st.state_fullname', set flt_sql_column_name_db2='st.state_fullname', set flt_sql_column_name_sybase='st.state_fullname', set filentity_token_long_name='state', set filter_entity_order_by=20, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Creating PRS client filter tree items Filters within the PRS client are displayed in a tree-like structure. The structure of the tree is defined in the bami_filter_tree_item Documentum type. Web filters are also defined as part of this type, either as a subset of the PRS filters or in addition to them. The bami_filter_tree_item type is comprised of the following columns: Column name filter_id Internal_code tree_item_parent_id Definition r_object_id of the bami_filter_definition object. Identifier for internal use only. It should be unique for each filter tab. A unique internal code can be obtained by getting the maximum internal_code value from the existing filters, and adding 1 to the result. The r_object_id of the parent item identifier of this item in the tree structure. This field should be left blank if the filter is a top-level item in the tree. 190 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

191 Creating Custom Aggregation, Report, and Filter Entities tree_item_type_select object_name tree_item_data tree_item_last_level for_web data_type expression Enter N if the filter values are static. Enter Y when the filter values should be retrieved by querying the repository. For example, when a filter displays a list of performers or activities from which to choose, it is considered a dynamic (and not static) filter. Enter a label for the filter item. If this is a static filter, this will be the value of the filter tree item. If this is a dynamic filter, tree_item_data is the DQL statement that returns the dynamic filter values. This value specifies whether the tree item is the lowest level on the tree (leaf). Enter 1 if the tree item is the last level of the tree. Otherwise, enter 0. Enter either 0, 1 and 2, where: 0 = the filter is to be displayed in PRS only and not within a dashboard 1 = the filter item is to be displayed in PRS as well as the dashboard 2 = the filter item is to be displayed only in the dashboard The data type of the filter. It should contain one of the following values: String Boolean Date Note: These are the only values that are supported. The expression is displayed when the tree item is selected in PRS. The expression listed here is a template, with several variables to be substituted for real values during runtime. A generic expression can be described as follows: :FilterTokenName.[Filter Item Name] :Operator ':ItemValue' where: :FilterTokenName is the name of the filter definition tab [Filter Item Name] must correspond to an existing filter item. During runtime, the filter engine uses the upper case representation of the filter item from the expression. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 191

192 Creating Custom Aggregation, Report, and Filter Entities :Operator represents an operator value selected by the user. :ItemValue is the node value selected from the filter tree. When Type Select=Y, the software uses the actual value from the select statement rather than the hard coded item value in the bami_filter_tree_item type. Type Select can also be set to N. Dynamic filters: relating children levels to the parent If you are creating a filter whose values are taken from objects in the repository, then a DQL statement must be added to the tree_item_data field of the bami_filter_tree_item type. The result from executing the statement will be substituted for variables that are part of the expression. The convention of the DQL statement for dynamic filters stipulates that the first columns of the result set should always be alphanumeric either char or varchar. If, for example, the first three columns are alphanumeric, then the values would be substituted for the :ItemValue, :ItemValue2, and :ItemValue3 variables, respectively. The columns that follow the alphanumeric columns should be of the Object ID type. These columns are used when the dynamic tree item has child tree items, and the child tree items DQL must reference the IDs retrieved from the parent. In this case, the children s DQL should use a question mark (?) as a placeholder for all ID values. The filter engine substitutes the placeholder with the IDs of the parent in the same order that they appear in the result. The figure displays the filter items available for the Activity Execution report entity. Figure 86. Activity execution report entity filter The Processes root level tree item contains the following query: select object_name,r_object_id from dm_process where r_has_events=1 192 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

193 Creating Custom Aggregation, Report, and Filter Entities The following query relates the second entity to the root level: select r_act_name from dm_process where r_has_events=1 and r_object_id=? The values returned by the query should not be null. In the example above the r_act_name attribute in the DQL select statement should not contain null values. Example 8-6. Create a static state filter item This example adds a state filter that does not contain any children. create bami_filter_tree_item object set object_name='state', set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='1', set tree_item_last_level=0, set tree_item_type_select='n', set data_type='string', set for_web=0, set expression[0]=':filtertokenname.state-name :Operator ''''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Example 8-7. Create a static, second level of a tree In this example five static children are created for the State static filter. The children values are: CA, NY, MI, NJ, and NC. create bami_filter_tree_item object set object_name= CA, set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='2', set tree_item_parent_id=(select fti.r_object_id from bami_filter_definition fd, bami_filter_tree_item fti where fd.object_name='state Filter Tab' and fd.r_object_id=fti.filter_id and fti.internal_code='1'), set tree_item_type_select='n', set data_type='string', set tree_item_last_level=1, set for_web=0, set expression[0]=':filtertokenname.state-name :Operator '':ItemValue''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go create bami_filter_tree_item object set object_name= NY, set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='3', set tree_item_parent_id=(select fti.r_object_id from bami_filter_definition fd, bami_filter_tree_item fti where fd.object_name='state Filter Tab' and fd.r_object_id=fti.filter_id and fti.internal_code='1'), EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 193

194 Creating Custom Aggregation, Report, and Filter Entities set tree_item_type_select='n', set data_type='string', set tree_item_last_level=1, set for_web=0, set expression[0]=':filtertokenname.state-name :Operator '':ItemValue''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go create bami_filter_tree_item object set object_name= MI, set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='4', set tree_item_parent_id=(select fti.r_object_id from bami_filter_definition fd, bami_filter_tree_item fti where fd.object_name='state Filter Tab' and fd.r_object_id=fti.filter_id and fti.internal_code='1'), set tree_item_type_select='n', set data_type='string', set tree_item_last_level=1, set for_web=0, set expression[0]=':filtertokenname.state-name :Operator '':ItemValue''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go create bami_filter_tree_item object set object_name= NJ, set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='5', set tree_item_parent_id=(select fti.r_object_id from bami_filter_definition fd, bami_filter_tree_item fti where fd.object_name='state Filter Tab' and fd.r_object_id=fti.filter_id and fti.internal_code='1'), set tree_item_type_select='n', set data_type='string', set tree_item_last_level=1, set for_web=0, set expression[0]=':filtertokenname.state-name :Operator '':ItemValue''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go create bami_filter_tree_item object set object_name= NC, set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='6', set tree_item_parent_id=(select fti.r_object_id from bami_filter_definition fd, bami_filter_tree_item fti where fd.object_name='state Filter Tab' and fd.r_object_id=fti.filter_id and fti.internal_code='1'), set tree_item_type_select='n', set data_type='string', set tree_item_last_level=1, 194 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

195 Creating Custom Aggregation, Report, and Filter Entities set for_web=0, set expression[0]=':filtertokenname.state-name :Operator '':ItemValue''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Example 8-8. Create dynamic filter items Dynamic filters can be used instead of static filters. Dynamic filters provide dashboard users with lists of filter values generated directly from the database. For this to occur, all state names must be saved in a Documentum type. In this example the state_definition type is used. The script used to create and populate the type is shown next. This script creates the state definition type. CREATE TYPE state_definition ( state_name char(255), description char(255) REPEATING ) WITH SUPERTYPE dm_sysobject Go create state_definition object Set object_name= CA, Set state_name= California, Set description= State of California Go create state_definition object Set object_name= NY, Set state_name= New York, Set description= State of New York Go create state_definition object Set object_name= MI, Set state_name= Michigan, Set description= State of Michigan Go create state_definition object Set object_name= NJ, Set state_name= New Jersey, Set description= State of New Jersey' Go create state_definition object Set object_name= NC' Set state_name= North Carolina Set description= State of North Carolina Go This script creates the dynamic filter. This filter will select state names from the state_definition object. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 195

196 Creating Custom Aggregation, Report, and Filter Entities create bami_filter_tree_item object set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='10', set tree_item_parent_id=(select fti.r_object_id from bami_filter_definition fd, bami_filter_tree_item fti where fd.object_name='state Filter Tab' and fd.r_object_id=fti.filter_id and fti.internal_code='1'), set tree_item_type_select='y', set tree_item_data[0]='select object_name from state_definition', set data_type='string', set tree_item_last_level=1, set for_web=0, set expression[0]=':filtertokenname.state-name :Operator '':ItemValue''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Creating web client filter tree items Web filters have two levels. The first level is the root item that defines the filter item name. The second level is a dynamic list (DQL query) that displays as a pull-down list or checkbox. Example 8-9. Create a dashboard filter In this example a web filter item with the name State Name is created. For this root item a drop-down list of all state names is also created. In order to see this filter in the web only (web includes the BAM dashboard) the value 2 must be entered in the FOR_WEB attribute. create bami_filter_tree_item object set object_name='state Name', set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='20', set tree_item_last_level=0, set tree_item_type_select='n', set data_type='string', set for_web=2, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go create bami_filter_tree_item object set filter_id=(select r_object_id from bami_filter_definition where object_name='state Filter Tab'), set internal_code='21', set tree_item_parent_id=(select fti.r_object_id from bami_filter_definition fd,bami_filter_tree_item fti where fd.object_name='state Filter Tab' and 196 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

197 Creating Custom Aggregation, Report, and Filter Entities fd.r_object_id=fti.filter_id and fti.internal_code='20'), set tree_item_type_select='y', set tree_item_data[0]='select state_name from state_definition', set data_type='string', set tree_item_last_level=1, set for_web=2, set expression[0]=':filtertokenname.state-full-name :Operator '':ItemValue''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Custom Entities' go Create business data filters in the dashboard Business data filters are automatically created and available within PRS. However, these filters are not automatically available in the BAM dashboard. There may be times when it is required to expose these filters when a report is generated. The following example includes a DQL template to create each aspect of a web filter. In this case, the Product field that belongs to the Applicant SDT is added to the dashboard. The filter contains a dynamic list of field values that can be selected by a dashboard user. Example Create business data filter The following create object statement adds the word Product as the filter label. create bami_filter_tree_item object set object_name='product', set filter_id=(select r_object_id from bami_filter_definition where object_name= Monitored Data Filter Tab'), set internal_code='130' set tree_item_last_level=0, set tree_item_type_select='n', set data_type='string', set for_web=1, set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Internal' go Example Create dynamic drop-down list The following insert statement creates a dynamic pull-down list that displays all values for the Product field. create bami_filter_tree_item object set filter_id=(select r_object_id from bami_filter_definition where object_name=' Monitored Data Filter Tab '), set internal_code='131', set tree_item_parent_id=(select fti.r_object_id from bami_filter_definition fd, bami_filter_tree_item fti where fd.object_name='monitored Data Filter Tab' and fd.r_object_id=fti.filter_id and fti.internal_code='130'), EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 197

198 Creating Custom Aggregation, Report, and Filter Entities set tree_item_type_select='y', set tree_item_data[0]='select object_name from products', set data_type='string', set tree_item_last_level=1, set for_web=1, set expression[0]=':filtertokenname.applicantattr0 :Operator '':ItemValue''', set acl_name='bam Admin ACL', set acl_domain='dm_dbo', link '/System/BAM/Internal' go Note: You don t have to create the bami_flt_filter_token_items object, because it was already created. The name can be found by selecting the bami_filter_tree_item type. select r_object_id,object_name,expression from bami_filter_tree_item where filter_id=(select r_object_id from bami_filter_definition where object_name='monitored Data Filter Tab') and any expression is not null and object_name= Product go 198 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

199 Creating Custom Aggregation, Report, and Filter Entities Understanding report entity tables Business Activity Monitor report entities are virtual views that are built on top of an existing table space. In their simplest form, report entities are mapped in a one-to-one relationship to a table or view. In more complex cases report entities can have one-to-many relationships with several tables or views. For these complex uses cases it is recommended that a database view be created to represent the data for the report entity and then map the view to the report entity. Report entity tables are comprised of two types of tables: entity definition tables (mandatory tables) and entity relation tables (optional). The following text describes each of the entity definition tables. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 199

200 Creating Custom Aggregation, Report, and Filter Entities bami_rg_entity An entry into this table declares a new report entity. entity_type This is a unique name given to the report entity which is used later for filtering. gui_display_name This name should be the same as entity_type. is_base_entity This defines if the entity can be placed at the root of the report, or is only available as a child of another report entity. entity_where_clause If the entity represents a one-to-one relationship between the report entity and the table or view, then the value should be 1=1. If the report entity represents a one-to-many relationship, then the where_clause must contain a join expression which correlates the tables/views. For example, EntityTable0.CUSTOMER_ID=EntityTable1.CUSTOMER_ID. bami_rg_entity_table An entry into this table adds a table reference to the report entity. For example, if your report entity selects from table A, then table A must be defined in this object type. table_name A table/view name from which the report entity queries data. table_index This is a unique number that is assigned to a table. Once the select statement is generated, the table_name is referenced as EntityTable+table_index. entity_id This holds the id reference to bami_rg_entity entry that was created for the report entity. Within the DQL script it should have a value similar to: set entity_id=(select r_object_id from bami_rg_entity where gui_display_data = %name of the report entity% )) bami_rg_entity_field An entry into this table adds a field to the report entity. entity_table_id This holds the id of the bami_rg_table entry for the corresponding table. Within the DQL script it should have a value similar to: select t.r_object_id from bami_rg_entity_table t,bami_rg_entity e where t.entity_id=e.r_object_id and e.gui_display_data = %name of the report entity% and t.table_index= table_index). field_index This represents a unique index number for each field. This value must be unique within a specific report entity. field_db_name (oracle, mssql, db2) This represents the actual column name within the corresponding table. This value must be provided for each supported database. field_gui_name This is the name of the field as displayed in the user interface. 200 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

201 Creating Custom Aggregation, Report, and Filter Entities bami_rg_entity_key An entry into this table represents the primary key for the report entity. entity_table_id This is a foreign key reference to a bami_rg_entity_table entry. Within the DQL script it should have a value similar to: select r_object_id from bami_rg_entity_table et,bami_rg_entity e where et.entity_id=e.r_object_id and e.gui_display_data = %name of the report entity% and et.table_index= table_index). key_index Each entity key must have a unique index number within the context of the report entity. field_name This represents the column name of the key selected from the entry in the bami_rg_entity_table. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 201

202 Creating Custom Aggregation, Report, and Filter Entities 202 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

203 Entity Relation Diagrams Appendix A EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 203

204 Entity Relation Diagrams Figure 87. BAM database tables 204 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

205 Entity Relation Diagrams Figure 88. BAM report entities EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 205

206 Entity Relation Diagrams 206 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

207 Appendix B Report Entities This appendix contains a list of all report entities available in Process Reporting Services. Caution: Please contact EMC directly for a list of report entities for languages other than English. Activity Activity Execution Activity Events Incomplete Activity Execution Process Process Execution Process Events Incomplete Process Execution Queue Work Queue Work Queue Events EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 207

208 Report Entities Alert Alert Activity Aggregation Activity Execution 15 Minutes Activity Execution 30 Minutes Activity Execution 5 Minutes Activity Execution Daily Activity Execution Hourly Activity Execution Monthly Activity Execution Quarterly Activity Execution Weekly Activity Execution Yearly Incomplete Activity Execution 5 Minutes Incomplete Activity Execution Daily Incomplete Activity Execution Hourly Process Aggregation Process Execution 15 Minutes Process Execution 30 Minutes Process Execution 5 Minutes Process Execution Daily Process Execution Hourly Process Execution Monthly Process Execution Quarterly Process Execution Weekly Process Execution Yearly Incomplete Process Execution 5 Minutes Incomplete Process Execution Daily Incomplete Process Execution Hourly 208 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

209 Report Entities Performer Aggregation Activity Performer 15 Minutes Activity Performer 30 Minutes Activity Performer 5 Minutes Activity Performer Daily Activity Performer Hourly Activity Performer Monthly Activity Performer Quarterly Activity Performer Weekly Activity Performer Yearly EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 209

210 Report Entities 210 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

211 Database Views Appendix C EXEC_ACTIVITY_EVENTS_VIEW This view is used in the Activity Events report entity. EVENT_TYPE QUEUE_NAME QUEUE_ID ACTIVITY_NAME PERFORMER_ID PERFORMER_NAME EVENT_TYPE ID INSTANCEID ACTIVITY_ID V_FLT_QUEUE_END This view is used to filter the Work Queue reporting entity according to end date and time. QUEUE_ID EVENT_TIME V_FLT_QUEUE_START This view is used to filter the Work Queue reporting entity according to start date and time. EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 211

212 Database Views QUEUE_ID EVENT_TIME EXEC_QUEUE_MANAGEMENT_VIEW This view is used in the Work Queue reporting entity. QUEUE_ID QUEUE_NAME WORK_ITEMS_IN_QUEUE QUEUE_THRESHOLD CAPACITY ACQUIRED SUSPENDED DELEGATED USERS_ASSIGNED_TO_QUEUE EXEC_ACTIVITY_INSTANCE This view is used in the Activity Execution reporting entity. ID INSTANCEID ACTIVITY_ID START_DATETIME END_DATETIME NAME DURATION DURATION_MIN PROCESS_EVENT_ID PERFORMER_NAME PERFORMER_ID 212 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

213 Database Views QUEUE_ID RESOURCE_PROC_INSTANCE_ID ACTIVITY_TYPE EXEC_PROCESS_EVENTS_VIEW This view is used in the Process Events reporting entity. EVENT_TYPE NAME PERFORMER_ID PERFORMER_NAME EVENT_TIME ID INSTANCEID VERSION_NUMBER EXEC_QUEUE_EVENTS_VIEW This view is used in the Work Queue Events reporting entity. EVENT_TYPE QUEUE_NAME QUEUE_ID ACTIVITY_NAME PERFORMER_ID PERFORMER_NAME EVENT_TIME ID INSTANCEID ACTIVITY_ID EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 213

214 Database Views V_EXEC_PROCESS_INSTANCE This view is used in the Process Execution reporting entity. ID NAME INSTANCEID START_DATETIME END_DATETIME DURATION DURATION_MIN PERFORMER_ID STATUS VERSION_NUMBER V_ACT_EXECUTION This view is used for filtering the Activity Execution reporting entity. ID INSTANCEID ACTIVITY_ID START_DATETIME END_DATETIME DURATION NAME PERFORMER_NAME PERFORMER_ID V_INC_ACTIVITY_INSTANCE This view is used in the Incomplete Activity Instance report entity. 214 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

215 Database Views ID INSTANCEID ACTIVITY_ID START_DATETIME END_DATETIME NAME DURATION DURATION_MIN PROCESS_EVENT_ID PERFORMER_NAME PERFORMER_ID QUEUE_ID RESOURCE_PROC_INSTANCE_ID ACTIVITY_TYPE EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 215

216 Database Views 216 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

217 Index A Aggregation aggregation engine, 23 business data aggregation, 65, 109 custom, 174 example report, 115, 118 process aggregation, 65 report aggregation, 65, 81 Alerts alert list dashlet, 128, 157 create, 103 create category, 103 editing, 108 , 103 expressions, 103 opening, 108 overview, 27 publishing, 108 report example, 157 to 158 testing, 107 updating in dashboard, 128, 144 Audit trail configuration, 32 permissions, 33 purge, 170 B BAM administration activate monitoring, 40 data transfer latency configuration, 43 deactivate monitoring, 40 maximum data transfer latency idle time, 44 purge Audit Trail database, 170 purge scheduling, 168 update monitored data, 41 BAM Server activate, 40 aggregation engine, 23, 109 alert engine, 23, 103 connecting to, 39 data transfer latency configuration, 43 deactivate, 40 event pipe, 23 format engine, 23 gap filler, 23 maximum data transfer latency idle time configuration, 44 purge scheduling, 168 system performance, 170 Business Activity Monitor architecture, 23 configuration, 18 database, 168, 174 deployment process, 18 development vs. production modes, 163 personas, 18 C Composer moving to production, 163 Computed columns add to report, 83, 88 delete, 88 edit, 88 Crystal Reports create, 91 delete, 100 drill-down reports, 99 edit, 100 example, 154, 156 export to another repository, 101 export to CSV or PDF, 112 filter report entities, 89 import, 101 preview, 89 print, 142 publish, 94 synchronize, 91 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 217

218 Index Customizations aggregation, 174 filter entities, 184 report entities, 176 D Dashboard add tab, 135 add to dashboard application, 135 alert list dashlet, 128, 133, 144, 157 architecture, 125 create application, 133 creating filter tree items, 196 customization, 145 dashlet filtering, 131, 141, 144 delete, 143 design, 133 development to production, 163 edit, 142 multi-drill-down report configuration, 97, 137 permissions, 131, 136 personas, 126 preconfigured dashboard overview, 147 printing, 142 process diagram dashlet, 128, 133, 139 process simulation dashlet, 129, 133 published reports, 94 refresh period scheduling, 140 remove, 143 report dashlet, 127, 133 user interface overview, 131 Data source filter report entities, 89 preview, 89 records returned configuration, 168 reuse, 94 undo/redo, 102 Drill-down reports in Crystal Reports, 99 multi-drill-down report configuration, 97, 137 multi-drill-down report overview, 72 single drill-down configuration, 95 single drill-down report overview, 70 E Excel export Crystal Report, 112 export Simple Report, 112 F Filtering adding filter tabs, 186 creating business data filters, 197 creating filter token items, 187 creating filter tree items, 190, 196 custom entities, 184 dashlet, 131, 141, 144 defining entity relationships, 188 overview, 56 report entities, 89 single drill-down reports, 72 G Gap filler overview, 23 recovery period configuration, 42 M Monitoring activate, 40 audit trail configuration, 32 deactivate, 40 package types, 35 process variables, 36 structured data types, 34 P Package object types aggregation configuration, 109 to 110 creating custom filters, 197 monitoring configuration, 35 update data definitions, 41 PDF export Crystal Report, 112 Permissions Audit Trail, 33 dashboard, 131, 136 Process Reporting Services, 17 repository, 17 Preconfigured dashboard alert monitor, EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide

219 Index alert report examples, 157 to 158 bar+line report examples, 149, 152 to 153 Crystal Report example, 154, 156 gauge report example, 151 overview, 147 pie, bar chart example, 150 Process monitor, 148 process summary, 151 table chart example, 151 Process Builder audit trail configuration, 32 create sub-processes, 132 package type monitoring, 35 process variable monitoring, 36 structured data type monitoring, 34 update monitored data, 41 Process diagram add to dashboard, 139 dashlet, 128 display in J2EE application, 113 Process Reporting Services adding filter tabs, 186 architecture, 47 business data aggregation, 109 to 110 creating filter tree items, 190 custom entities, 173 display in enterprise portal, 111 filtering, 56 logging in, 73 multi-drill-down report configuration, 97, 137 multi-drill-down report overview, 72 palette, 50 personas, 48 report aggregation example, 115, 118 reporting entities, 50 simple reports, 59 single drill-down report configuration, 95 single drill-down report overview, 70 user interface navigation, 74 Process variables monitoring configuration, 36 Production environment database, 168 migrate from development, 163 purge scheduling, 168 records returned configuration, 168 system performance, 170 Q Queue monitoring understanding, 23 R Report manager creating categories, 75 deleting reports, 100 editing reports, 100 exporting reports, 101 importing reports, 101 Reporting entities activity and process, 50 aggregated entities, 50, 65 alert, 50 business data, 50 custom, 176 entity field captions, 55, 101 entity fields, 55, 182 to 183 filtering, 56 incomplete execution, 50 relationships with other entities, 54, 180 S Simple reports aggregation, 65, 81 auto-refresh, 95 bar+line charts, 62, 149, 152 to 153 chart properties, 63 color palette, 80 computed columns, 83 creating, 76 delete, 100 edit, 100 export to another repository, 101 export to CSV, 112 filter report entities, 89 gauge reports, 60, 151 import, 101 modify chart labels, 79 multi-drill-down configuration, 97, 137 overview, 59 pie and bar charts, 60, 150 preview, 89 print, 142 publish, 94 EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide 219

220 Index single drill-down configuration, 95 sort columns, 79 table charts, 63, 148, 151 Simulation process simulation dashlet, 129 Structured data types aggregation configuration, 109 to 110 creating custom filters, 197 monitoring configuration, 34 update data definitions, 41 used in reports, 115, 118 T TaskSpace add dashboard to application, 135 add tab, 135 create dashboard application, 133 delete dashboard, 143 design dashboard, 133 edit dashboard, 142 logging in, 37 remove dashboard, EMC Documentum Business Activity Monitor Version 6.5 SP1 Implementation Guide