You are on page 1of 185

fl fi











fi fl






























































































































































































































































































• fi
• fi


• fi

• fi





















fi fi











¸ ’






fi —
















• fi






fi fi


































































• fi

• fi

• fi
fi fi
fi fi

fi fi ¸

























































fi fi
fi fi

− − fi













− fi











fi —

‘ ’



fi fi


























¸


• —


• —


• —




















































fi fi







































fi fi

fi fi


fi fi

















fi fi fi
fi fi

“ ”
fi fi
fi fi
fi fi fi
fi fi fi
’ ’








fi fi






fi fi ¸





























































































fi fi
























fi fi


































• fi



























fi fi










fi fi
’ fi ’





¸


fi fi fi






































¸



















fi fi

























¸ fi






• fi















































fi fi








fl fi













fi fi




























“ ”











fi fi

¸















fi fi















• fi








• fi









• fi

• fi


• fi

• fi

• fi












• fi
• fi


• fi
• fi


• fi






fi fi










fi fi






















fi fi






• —









• —
• — fi
• —








fi fi




• —
• —


• —

• —



































− − fi −

− −































































• fi
‘ ’


















fl fi




































fi fi













fi fi


• fi
• fi
• fi




“ ”




’ fi























• fi
• fi


• fi



























fi fi


















































fi fi












































fi ‘ ’

















fi fi











































































fi fi























fi fi












fi ’




’ ’



























fi fi


‘ ’ fi
‘ ’



fi fi

fi fi fi
















fi fi














’ ’
































‘ ’ fi
‘ ’










fi fi




















































’ ’












fi fi

¸















fi fi














• —
• — fi
• —
• —
• —

• —
• —
• —
• —
• — fi







• —
• —
• — fi
• —


• — fi

• —
• — fi
• —
• — fi

• — fi








• —
• —
• — fi
• — fi

• —
• — fi
• — fi
• —
• — fi
































fi fi fi
fi ’












































































































• fi fi



































































’ ’






























































fi fi



fl fl






fi fi



fi fi




fi fi







fi fi

fi fi




































































fi fi








fi fi

































fi fi
fl fi



— —

fi fi














fi fl

fl fl




































































fi fi


























fi fi





























fi fi

fi fi

















fi fi

















































fi fi












































fi fl















































fi fl






















fi fi fi fi













fi fi












































fi fi















































fi fl
’ ’
















fi fi





















































































fi fi












— fi —



• —
• —
• —
• —































































































fi fi





fl ’






fi fi






































































































































fi ’ fi











• fi








































































fi fi fi


































… fi







’ ’
” ’

’ ” ’ ’ fi










fi fi









fi fi






















































fi “ ”

















— fi —





































’ fi
















































¸




















fi fi





fi fi












fi fi






































“ ”










fi fi













fi fi































• fi


















fi fi





































































































































• fi
• fi
• fi






• fi
• fi
• fi

• fi
• fi











fi fi



























• fi



• fi
• fi
• fi


• fi




‘ ’ fi fi





























‘ ’












fi fi





















fi fi fi























• fi









fi fi

¸ fi



¸ fi






fi fi




































fi fi fi



fi fi




































Copyright © 2004 - 2008 EMC Corporation. All rights reserved. Published January 2008 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.

Table of Contents

Preface Chapter 1

.......................................................................................................................... 11
Congure Business Activity Monitor

..................................................... 15
15 16 17 17 18 18 19 19 20 21 22 22 23 24 25 26 27 27 29 30 30 30 33 34 34 36 37 37 38 38 39 39 40 40 41 41 41 42

Technical requirements ............................................................................... Expertise requirements ............................................................................... Understanding the connection architecture .................................................. Opening processes into BAM ...................................................................... Understanding the impact of opening a process............................................ Verifying process flow definition ............................................................. Verifying resource assignment ................................................................. Verifying business object definition .......................................................... Verifying business object assignment ....................................................... Performing iterative import ......................................................................... Working with pre-aggregation..................................................................... Aggregating by time ............................................................................... Aggregating business object data by time ................................................. Activating business object monitoring .......................................................... Working with business object filters and indexes .......................................... Activating and deactivating process monitoring ........................................... Understanding machine clock settings ......................................................... Configuring the Workflow Publish Events job .............................................. Testing connectivity .................................................................................... Verifying configuration ............................................................................... Verifying status of BAM export agent ...................................................... Using the BAM diagnostic utility ............................................................. Importing structured business data.............................................................. Make External Data Accessible to BAM Database ......................................... Incorporating external data into BAM ...................................................... Creating a database view ........................................................................ Assigning business objects to inputs ............................................................ Synchronizing workgroups ......................................................................... Configuring email ...................................................................................... Monitoring queues ..................................................................................... Configuring queue monitoring ................................................................ Generating queue monitoring reports ...................................................... Work queue ....................................................................................... Work queue events ............................................................................. Queue work item events ..................................................................... General Parameter Configuration Settings .................................................... Portal ..................................................................................................... AlarmWorkgroupProvider ......................................................................

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

3

Table of Contents

MailServiceJNDI..................................................................................... AlarmDistributor.................................................................................... HTTP Configuration ........................................................................... Web Service Configuration .................................................................. AlertTemplate ........................................................................................ ReportSubCategories .............................................................................. FiveMinAggrDelayMilliseconds .............................................................. Pipe ....................................................................................................... DelayBeforeMarkingSchedulerAlivenessMilliseconds ............................... Scheduler Parameter Configuration Settings ................................................. Process Aggregation Jobs ........................................................................ Activity Aggregation Jobs ....................................................................... Data Aggregation Jobs ............................................................................ Alarm Engine Jobs .................................................................................. Chapter 2 Dene BAM Reports and Alerts ............................................................. Understanding BAM reporting entities ........................................................ Working with execution entities .............................................................. Working with incomplete execution entities ............................................. Working with business object entities ....................................................... Working with queue entities .................................................................... Working with alert entities ...................................................................... Working with aggregated entities ............................................................ Understanding entity fields ......................................................................... Reporting on activity performers ................................................................. Understanding report types ........................................................................ Generating BAM reports ............................................................................. Generating a process duration report ....................................................... Generating a process duration dial gauge ................................................. Generating a process duration per zip code report .................................... Generating an activity duration by zip code report ................................... Sample Alerts ............................................................................................. Task Duration Alert ................................................................................ Report Manager Window .................................................................... Alert Builder Window......................................................................... Entity Fields (for Incomplete Activity Execution) .................................. Alert Builder Window......................................................................... Computed Columns ........................................................................... Report Properties ............................................................................... Alert Testing ...................................................................................... Report Preview Window ..................................................................... High Value Mortgage Rejection Alert ....................................................... Report Manager Window .................................................................... Alert Builder Window......................................................................... Entity Fields (for Customer) ................................................................ Alert Builder Window......................................................................... Entity Filter Window .......................................................................... Alert Builder ...................................................................................... Computed Columns ........................................................................... Report Properties ............................................................................... Alert Testing ...................................................................................... Report Preview Window ..................................................................... Drilldown Reports ...................................................................................... Working with report scripts......................................................................... Understanding queue monitoring and reports ..............................................

42 42 42 43 44 44 44 44 45 45 45 46 46 46 49 49 50 50 50 50 51 51 51 52 52 52 53 56 59 64 70 70 70 70 70 71 71 72 73 73 73 73 73 74 74 74 75 75 77 77 77 77 78 80

4

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

Table of Contents

Queue Monitoring Configuration ............................................................ Queue Monitoring Reports ...................................................................... Work Queue ....................................................................................... Work Queue Events ............................................................................ Queue Work Item Events .................................................................... Chapter 3 Design Dashboard Using WebLogic Portal ........................................... WSRP Overview ......................................................................................... Design BAM dashboard with Weblogic Portal version 9.2.............................. Design Dashboard Using JBoss Portal ................................................. Creating BAM and JBoss users ....................................................................

80 81 81 81 82 83 83 84 93 93

Chapter 4

Configuring portlets ................................................................................... 98 Adding portlet instances to dashboard ....................................................... 101 Chapter 5 Work with Precongured JBoss Dashboard ........................................ Previewing the preconfigured dashboard ................................................... Working with the Instances Level page ...................................................... Working with the Instance Monitor portlet ............................................. Working with the diagram portlet.......................................................... Working with the In-flight Process/Activity Instances report ................... Working with the Process/Activity Instances Summary report ................. Working with the Tasks Completed by Performer report ......................... Working with the Alerts page .................................................................... Working with the Alerts portlet ............................................................. Working with an alert diagram portlet ................................................... Working with the Activity Details of Alerted Process report .................... Working with the Alerts Status report .................................................... Working with the Executive page .............................................................. Working with the In-flight Process Overview report ............................... Working with the In-flight Activities Overview report ............................ Working with the Performers of Selected Activity report ......................... Working with the Process Instances Started in the Last Week report .................................................................................................. Working with the In-flight Processes Overview (completed 24h) report ........................................................................................... Modify portlet instances to display a different report or diagram ................. Add a new page to the preconfigured dashboard ........................................ Design Dashboard Using WebSphere Portal Congure Portlet Preferences 103 104 105 105 107 108 111 113 115 115 117 118 120 121 121 123 124 125 127 129 131

Chapter 6 Chapter 7

....................................... 133
141 141 143 145 149 151 154 156 158

............................................................. Configuring an alert portlet ....................................................................... Configuring a diagram portlet ................................................................... Configuring report portlets ....................................................................... Understanding process filters and user access rights ............................... Configuring an instance monitor portlet .....................................................
Specifying default sort and date/time format for instance monitor and alert portlet ........................................................................................ Building hyperlinks between reports ......................................................... Working with portlet groups in Weblogic Portal .........................................

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

5

Table of Contents

Working with drill down reports ............................................................... Chapter 8 Dashboard User Procedures ............................................................... Portlet Groups .......................................................................................... Alert Portlet ............................................................................................. Feature Overview ................................................................................. Working with Alerts ............................................................................. Diagram Portlet ........................................................................................ Drilldown Reports ................................................................................ Activity Multiplicity ............................................................................. Process Alert and Drill Down ................................................................ Working with dashboard reports ............................................................... Instance Monitor Portlet ............................................................................ Feature Overview ................................................................................. Chapter 9 Deployment Procedures ...................................................................... Deployment Architecture .......................................................................... Deploying BAM in a Basic WebLogic Server Domain .................................. Windows ............................................................................................ Linux and Solaris .................................................................................. The BAM Database ................................................................................... Business Process Analysis Database Sizing ................................................. BAM Database Sizing ............................................................................... Example............................................................................................... Deploying BAM in an Existing WebLogic Domain ...................................... Clustering ................................................................................................ Moving from Development to Production .................................................. Use Case 1: BAM Moves into Production (first time) ............................... Database Clean Up ........................................................................... BAM Database Connection Configuration .......................................... Audit Trail Configuration.................................................................. Use Case 2: BAM Production Environment is Running ........................... Move Business Process Definition and Mapping ................................. Define Execution Tables .................................................................... Move Report and Alerts .................................................................... Chapter 10 Maintenance Procedures ..................................................................... Business Object Changes ........................................................................... Add a Business Object Field .................................................................. Modify a Business Object Field .............................................................. Delete a Business Object Field ............................................................... Aggregation Change ................................................................................. Export Report and Alerts Definition....................................................... Working with process versions ..................................................................

158 159 159 160 161 162 162 163 163 164 164 165 166 167 167 168 168 169 169 170 170 170 171 172 176 177 177 177 178 178 178 178 179 181 181 181 182 182 182 183 184

6

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

........ Process entity fields ............... Figure 32....................................................................... Figure 30............................ Figure 2........................... Enter portal name and URL .................................................................................... Defining an SLA within Computed Columns ...................................................... Figure 25.............. Example business data report with SLA ...................................................... Figure 34... Figure 36............ Select resources in the library ................................................................... Process duration report definition................................ Figure 21............................................................................................................................. Figure 19...................... Figure 26....................................................................................................................................................... Figure 15............ Report properties ............................ Entering SLA values ............................. Figure 29............................................................................................................................. Business object aggregation .............................. Report properties ................... Average activity duration with SLA ................. Figure 8....................................................... Figure 7.................... Process entity fields ................................................ Figure 33................... A Portal as a WSRP Consumer ........................ An Alert Based on Business Data ..................................................................... Figure 5............................................... Preview window ............................................................................................ Create new book.............. Figure 22... Figure 31..................................................................................................................... Add new page ..................................................................................... Figure 14......... Figure 3.......................... Figure 12........................... Figure 20.................... Object identifier used in view .. Figure 18............................................ Computed columns window ................... Figure 10................ Begin to create new desktop ............. Activity execution entity fields .......... Figure 28........................... Figure 35............................................................................... 23 35 53 54 55 55 56 56 57 58 59 60 60 61 61 61 62 63 64 65 65 66 66 67 68 69 72 75 76 84 85 86 86 87 88 89 90 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 7 ......................... Create new page ................................................... Dial gauge report properties.............. Figure 9............................. Report fields................ Report fields.......................................Table of Contents List of Figures Figure 1..................... Process entity fields ... Filtering with Business Data .............................. Figure 27.................................... Create new desktop ............................................................... Figure 11..... Figure 16............................................................ Figure 6............................................ Figure 24................................................... Entity fields for address type .. Address type entity fields ................... Figure 37............. Process duration per zip code report definition.................................................... Figure 17...................................................... Figure 13.................... Process duration report definition....... Figure 23............................................... Activity duration by zip code report definiton ............................................................................... Anatomy of a dial gauge ......................... Figure 4................................................... Preview filter................................. Entering Duration Threshold in Computed Columns ................................................... Computed columns in dial gauge ................................................

.................. Copy portlet ............................................................. Figure 78.......................... Figure 69................................ Figure 79.............. Figure 46................... Figure 43............ Figure 51................................................... Figure 50.. Figure 44........................................ Add user to work group............... Figure 53........................... Sample In-flight Process Overview report ............... Sample alert portlet .. Enter preference value ............................................. Figure 52............. Figure 61.... Figure 47..................................................................................... Process dial gauge computed columns window ............................................................................................................................. Figure 58................................................................................. Create instance ....................................................... Figure 55......................... Filter expression window ................................................. Figure 65.......................................... Figure 41...................................................................... Figure 42........................ Update portlet-instances.............................................................. Figure 73............................................................. Add new page ............................... Assign administrator’s access to new user ......................................... Figure 77........................................... Figure 74............................... Delete portlet instance ........................................................................................................................ New portal page ............ Portlet preferences .... List of BAM dashboard portlets ......................................................... Figure 40.............. Figure 67........................ Figure 76................................... Sample process instance summary bar chart ................................................. Sample Activity Details of Alerted Process report ................................................................. Figure 71......................................................... Initiate portlet configuration...... Sample In-flight Process Overview (24h) report .................................................. Sample instance monitor portlet ..................... Create new JBoss user ............................... Figure 70.......................................................................... Sample diagram portlet......... Figure 49..................... Sample diagram portlet..... Sample Alerts Status report .......................... Figure 39......... Sample Tasks Completed by Performer report .................................................................................... Figure 48............................... Figure 56...................... Modify alert condition and severity ........ Figure 57... Figure 72............................................. Global java script window ....... Sample process instance dial gauge ....................... Add portlet instance to page............................... Figure 63............... Figure 64........................................ Diagram portlet .. Add users to security roles ..................................... 90 91 92 94 95 95 97 98 99 99 100 100 101 102 106 108 109 111 112 114 116 117 118 119 121 123 124 125 126 127 128 129 130 131 134 135 135 136 137 137 138 142 144 8 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide ......................................................................Table of Contents Figure 38.................................. Figure 45.................................................................................................................................................. Portlet preferences ........... Figure 60....... Figure 80...................................................................................................... Figure 68....................................... Figure 59.......... Name portlet instance ............. Alert portlet ........... Add portlets to page .............................................................. Sample Performers of Selected Activity report .... Configure portlet ............................. Add contents to page .......... Enter portlet preferences ......................................................... Figure 54......................................... Figure 66........................................................................................ Sample In-flight Activities Overview report ................................................................................ Figure 75......................................................................................... Choose layout and add portlets ............................... Locate portlet instance ................... Select portlet .........................................xml ............ Figure 62...............

............................................................. Figure 82.. List of processes for admin user .......... The BAM Deployment Architecture ...................... Figure 88........................ Figure 91..................................................................................... User administration window ................................................................................ Figure 92.................................. Figure 94..................... Figure 86... Two Portlets within a Portlet Group .......................... Instance monitor portlet .................... Figure 84................................................................................... Reviewing process version number in UDA ............. JBoss Portal user administration ..................................... Example Report Portlet ........................ Report portlet — edit mode ............ Process version naming convention ................................. Figure 89......... Figure 87..... Figure 90...................................................................................... Figure 95..........Table of Contents Figure 81.................. Example Alert Portlet...................................... Report portlet — display mode....... 146 147 150 150 151 152 160 161 163 165 166 168 182 185 185 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 9 ................................................... Figure 85.... Figure 93.............................................................................. Figure 83............................ Example Instance Monitor Portlet .................................... Example Diagram Portlet ......................... Business Object Field Aggregation ................................................................................

....... 16 WebLogic Server Cluster parameters....... Table 4......Table of Contents List of Tables Table 1... Table 3.......................................... 183 183 10 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide ............... Table 2....... Business Activity Monitor Technical Requirements ............................... 174 Process Instances with Business Data ...................................................... 16 Business Activity Monitor Expertise Requirements ............................................... Business Data Aggregation ................................... Table 5....................................

a dashboard designer to design a BAM dashboard. Maintenance Procedures Intended Audience The intended audience for this document includes all roles involved with implementing a Business Activity Monitor solution.Preface This document describes how to configure. Define BAM Reports and Alerts Chapter 3. It is assumed that the audience is familiar with basic Process Analyzer features. This guide contains the following sections: • • • • • • • • • • Chapter 1. BAM is based on the Process Analyzer but includes extensions for defining alerts and reports that can be displayed in the dashboard. Configure Business Activity Monitor Chapter 2. This type of effort typically involves a number of roles: a process developer or BAM administrator to configure the technology. It provides the ability to generate alerts in real time and creates a dashboard view that shows process status and performance statistics. Design Dashboard Using JBoss Portal Chapter 5. and maintain a process monitoring solution with Business Activity Monitor (BAM). Design Dashboard Using WebSphere Portal Chapter 7. BAM gives business users insight into processes executing in the Documentum Process Engine. Dashboard User Procedures Chapter 9. Revision History The following changes have been made to this document. Design Dashboard Using WebLogic Portal Chapter 4. deploy. Configure Portlet Preferences Chapter 8. a business analyst to design BAM reports and alerts. Deployment Procedures Chapter 10. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 11 . Work with Preconfigured JBoss Dashboard Chapter 6. and a database administrator to maintain the BAM database.

Clarified that the SLA. As a result there are several Process Analyzer functions used in implementing BAM.com) by navigating to: Support > Request Support > Software Customer Guide and Offerings. This is addressed in Define BAM Reports and Alerts chapter. the BAM user interface and the Process Analyzer interface are the same.1. Added clarity to the format of the database URL within the verifying configuration section of the Configure Business Activity Monitor chapter.Preface Revision Date January 2008 Description Removed a section in Chapter 3 that addresses Weblogic Portal 8. Added a procedure for adding a new page to the preconfigured dashboard.1. Added content that describes how to modify preconfigured dashboard portlet preferences to access a new report.function works for a 2D bar chart but does not work for a 3D bar chart. Enhanced the introductory section of the Work with Preconfigured JBoss Dashboard chapter. the documentation set for this product includes: • Process Analyzer User Guide 12 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . The Customer Guide to EMC Software Support Services provides a thorough explanation of Documentum’s support services and policies.6. In addition to this manual. All BAM settings are configured in the Process Analyzer client — that is. Note: You must register online at Powerlink before using it.EMC. You can download this document from the Powerlink website (http://powerlink. Support information EMC Documentum’s technical support services are designed to make your deployment and management of Documentum products as effective as possible. Related documentation The Business Activity Monitor technology monitors processes executing in the Process Engine.6 producer and consumer setup. Also removed how to design a BAM dashboard using WebLogic Portal 8.

Preface • Process Suite Implementation Guide EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 13 .

Preface 14 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

and store the data so it is available for BAM dashboard alerts and reports. The audience for this guide is IT professionals responsible for configuring the BAM environment. This document also does not address defining BAM alerts and reports. This integration enables users to: • • • • Design process in the Process Analyzer. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 15 . These topics are addressed in other documentation. and export to Process Builder for development Develop processes in Process Builder. which publishes critical business data back into BAM Use the BAM Report Generator to define real-time reports and alerts Publish reports and alerts to a dashboard environment. It is not the intention of this document to address the full business process lifecycle where To Be process designs in the Process Analyzer are shared with developers for implementation. It is assumed that a developed XPDL is available within the customer’s environment.Chapter 1 Congure Business Activity Monitor Documentum Business Activity Monitor (BAM) provides capabilities to monitor business processes executing in the Process Builder. Technical requirements The following table summarizes the hardware and software requirements for BAM. from which a monitoring solution will be configured. or building BAM dashboards. format the data. This document describes all procedures required to configure BAM to accept execution data from Process Builder.

the amount of business data being tracked. BAM Administrator 16 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . 9. a T1 link may be used. This includes importing processes and business data. version 6 SP1 with the following supported databases: Oracle 9. Connectivity Requirements Bandwidth and Firewall Requirements Expertise requirements The following table summarizes the expertise required by each of the roles involved configuring BAM.Congure Business Activity Monitor Table 1. Business Activity Monitor Expertise Requirements Database Administrator A database administrator is required to create the initial BAM schema. Table 2. The preferred way to connect is through a LAN. 2005 DB2 8. and then will perform maintenance activities once the application is in production. Administrators are also responsible for all general parameter settings such as specifying an alert email template. 10g MS SQL 2000. For remote connections. The BAM administrator is responsible for all configuration procedures. Performance will depend on the amount of data to be monitored. their frequency of execution. configuring drilldown report categories.0 BAM Database Sizing The size of the BAM database depends on the number of processes to be monitored. and activating monitoring. and the period of time to retain the data (before it is purged). and configuring the agent process between Process Builder and BAM.2. Database access uses JDBC over TCP/IP The default BAM connection to the Process Builder Audit Trail database will not run across firewalls. Business Activity Monitor Technical Requirements Product Versions Business Activity Monitor.

Opening processes into BAM This procedure takes a developed XPDL file from a shared folder and opens (imports) it into BAM. Opening a process creates an exact duplicate of the process in the BAM database. JBoss. work groups. or Websphere Administrator BAM runs over Weblogic and Websphere clusters. These types of installations require an administrator. Configuration can begin once Process Builder and BAM are connected. Process Builder pushes execution data to the BAM database. It is from this directory that Process Developers open XPDL files into the Process Builder. The first directory specifies the default location in which exported XPDL files are saved. Once this data is extracted. The shared folder must be defined separately. which is rendered in the Process Designer window. Knowledge of Xpath expressions is required for business data mapping.Congure Business Activity Monitor The BAM Administrator must have XML expertise. WebLogic. The procedure below guides you in configuring the shared folders. Database access makes use of a JDBC connection. it is formatted and pre-aggregated. and email. Now the data is ready for the user to create BAM reports and alerts. The second default directory specifies the location in which XPDL files are saved from within the Process Builder. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 17 . Administrators are also responsible for configuring users. On a periodic basis. roles. Bringing a process into BAM is not only required as part of BAM configuration. Understanding the connection architecture The connection between Process Builder and BAM is configured in Process Builder. it provides the business analyst with a process that can be analyzed. It is from this location that XPDL files are opened in BAM. information about the execution is stored in the Audit Trail database. As Process Builder executes a business process. This procedure automatically: • • • • • Defines the process level of the hierarchy Creates each activity in the process Defines Business Objects Assigns Business Object usage Assigns the Process Builder activity template as a user defined resource Before opening a process two default directories must configured.

To create a shared folder 1.Congure Business Activity Monitor Note: The shared folders must be created within a shared directory. click Ok. Click the Open button on the Open Process from Developer window. You can see the process flow diagram by selecting the Process Designer tab. From the Process List window select the process you want to open. This opens the Configure Shared Folder window. Understanding the impact of opening a process Opening a process into BAM automatically defines a process in the hierarchy. the software checks to see if there are any duplicate entries. Note: Each process listed is located in Process Builder shared folder. To open process into BAM 1. and assigns business objects to inputs/outputs. assigns resources. Click the Select Process button. Select Application > Administration > Configure Shared Folders. Verifying process ow denition When the import is complete you see that the process level within the hierarchy is created and below is listed each activity. 2. Select File > Open Process from Developer. 3. This opens a standard browse window where you can select the BAM and Process Builder shared folders. 2. defines business objects. Click Ok. 5. Note: Process names cannot be greater the 80 characters. 6. Note: The Create a New Process radio button is the only valid option for this procedure. Select a deliverable in the hierarchy. At the end of the load process you will see a load log report that you can close. The process is defined as the child of a deliverable. 3. Click Browse for each folder. As the data loads. 4. 18 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Once selected.

This assignment is automatic and is not necessary for BAM.Congure Business Activity Monitor Verifying resource assignment If you right-click an Activity and select Properties. you will notice that the Activity template within Process Builder is assigned as the Resource for each Activity. Please refer to the Process Builder User Guide for more information regarding Observation Points. For example. Packages capture data within a Documentum form. which are the elementary data fields (numeric. and stores process data sent by the process engine export agent. etc. string. Verifying business object denition The Business Activity Monitor receives. This data includes the structure of the process (as described above) and all associated business data. SDT. SDTs contain fields that are organized (structured) by category. The specific field values that are exported to BAM are configured in the Process Builder. You must use Observation Points in the Process Builder if you want package data to be sent to BAM.). Data Objects contain Business Object Fields. Structured Data Types (SDTs). you will see the package. corresponding Business Objects are automatically created. the import automatically creates the Business Object and Data Object. and process variables. Note: A Business Object only represents the structure of the data. created by the Forms Builder. Processes can contains several SDTs and several process variables. process variables are not structured and are only used within the context of a specific process. Note: Since process variables are not structured. and can be reused across processes. The following naming convention applies to the Business Object: <Process Name>_BO_VAR EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 19 . Business Object − the name of the package or SDT. Business Objects represent structured data in BAM and contain one (or more) Data Objects. When you select Application − Business Object − Business Object Definition from the menu. Each Business Object consists of 3 levels: 1. Note: SDT names cannot be longer than 60 characters. As an XPDL file is imported into BAM. formats. At this point in the configuration the Business Object does not contain any actual business data. HTTP Post. Unlike SDTs. business data takes the form of packages. and process variable as a Business Object. In the Process Builder. Process variables allow users to attach a single or group of fields to a specific process.

This is the only method for updating an Xpath expression. After the import. and all fields are selected by default. Simply click in the Xpath expression field. Note: If you need to edit the Xpath expression. All fields of the Business Object are automatically selected. Longer names will interfere with process monitoring. Note: If more than one package or SDT is associated with an activity. structured data types. you will see that each Business Object Field is mapped to the corresponding data field within the SDT with an Xpath Expression. 3. Business Objects correspond to packages. Select the Data Object. The Xpath expression is important because it provides BAM with the ‘address’ of the business data within the Process Builder. each carrying a single Business Object. This means that Business Objects are automatically assigned to the appropriate Inputs/Outputs. Business Object Fields − represent data fields Note: Process and process variable names within Process Builder should be kept to less than 80 characters in length. 3. then the import procedure creates the Business Object and assigns it to the Input of the activity. This mapping is performed automatically during the import process. Click the Structure tab. or process variable. 20 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . business data is not visible to BAM. If an activity uses either a package. To locate the Xpath Expression: 1. SDT. Each is assigned to a process within the Process Builder and then used by specific activities within the process. 2. Scroll to the right until you see the Xpath Expression column. then multiple Inputs are created. Without these mappings. Data Objects − represent groups of Business Object Fields. Verifying business object assignment Business Object usage is also specified as the XPDL file is imported into BAM.Congure Business Activity Monitor The following naming convention applies to the Data Object: <Process Name>_DO_VAR 2. In SDTs the name of the Business Object is also the name of the Data Object. Click the plus (+) sign to expand each level. you can do so within this window. and process variables used in the Process Builder. and select File — Save. make the change.

As the data loads. Click Open. The original process remains unchanged. 5. 4. At the end of the load you will see a load log that you can close. 3.Congure Business Activity Monitor Performing iterative import The logic of a business process can be changed in Process Builder by a process developer. Click the Select Process button within the Open Process from Developer window to locate and select the process you want to import. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 21 . If this happens. etc). From the hierarchy select the process you want to update. If changes originate in the Process Builder then an iterative import is the simplest method for updating the process in BAM. This deletes the original process in the Process Analyzer and inserts the new process. Select from the among the three radio buttons: • Replace an Existing Process — Completely overwrites the selected Process. 2. 6. • • Note: You have the option of renaming the process as it imports. To perform iterative import 1. these changes should also be made in BAM. Merge into Existing Process — A true merge that completely updates the original process. It is important that the process in BAM and Process Builder be consistent. the software checks to see if there are any duplicate entries. Iterative import provides incremental updates to BAM without overwriting activity properties (timing data. Merge and Create a New Process — Creates a new Process in the hierarchy (with a unique name) that incorporates the changes from the imported XPDL file with the existing processes. then the values imported from Process Builder trump those in BAM. Note: You must select a process. Iterative import is not supported for subprocesses. Select File > Open Process from Developer. Iterative import is especially useful if the process developer is recommending changes to the process. and the business analyst wants to review and approve these changes. All Process Analyzer meta-data (User Defined Attributes) is lost in the operation. notes. From here you can generate diagrams and reports. an activity is considered manual in one model but automated in another). If there are competing attributes (for example. user defined attributes.

Instance level durations Suppose two process instances start within the same 5-minute time interval. 1 day. activity execution and business object execution data based on the following time intervals: 5 minutes. the pre-aggregation settings are optional. and stored in BAM. For process and activity execution data. being extracted. 1 week. In fact. 30 minutes. 15 minutes. The benefit of pre-aggregation is realized when you have thousands of instances running. The first process (called P1) took 2 minutes to complete. The report generator can be used to aggregate values in the same manner. 1 hour. scalability and more efficient data storage. Pre-aggregation should not be confused with the aggregation function used in building BAM reports. a value of 6 minutes is placed into the average duration column for this 5-minute interval: Start Interval 1:00 − 1:05 Average Duration 6 minutes 22 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . 1 Quarter and 1 year.Congure Business Activity Monitor Working with pre-aggregation BAM uses an aggregation engine that pre-aggregates execution data stored in the database. Aggregating by time The aggregation engine aggregates process execution. the following time-based metrics are automatically calculated: • • • • • • Average Duration Number of successful instances Number of failed instances Maximum Duration Minimum Duration Sum of Duration Example 1-1. Pre-aggregation allows for better performance. while the second process (called P2) took 10 minutes to complete: Start Time 1:00 1:02 End Time 1:02 1:12 Process P1 P2 Instance Duration 2 minutes 10 minutes In the pre-aggregated table. Reports can be generated directly on the aggregated database tables. 1 month.

the transaction data is stored initially in instance tables. If you choose not to enter an aggregation type the software automatically calculates a count metric for the group. The Group entity specifies the business object field values used as the basis for the aggregation. and then another business object field selected as the group by entity. Time 1:00 1:01 Loan Amount 20 30 State NY NJ EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 23 . This form of aggregation requires an arithmetic function be selected for a business object field. and Min are available aggregation types. Multiple group by fields can be selected.Congure Business Activity Monitor Both instance-level and aggregated data can be reported on. Process instances with business object data From a database perspective. In this case aggregation is specified within the Business Object Definition window. This provides a total loan amount requested for each state during each 5 minute time interval. Sum. Figure 1. Average. State is the group field and loanAmount is summed. Business object aggregation Example 1-2. In the figure below. Max. Aggregating business object data by time Pre-aggregation also applies to business objects.

Select Application > Business Object > Business Object Definition from the menu. When monitoring is activated for a business object. Select a method of aggregation in the Aggregation column. Click the Structure tab. Activating business object monitoring You need to activate each business object you want to monitor after it’s been assigned. You will generally want to monitor some. Click Save (the diskette icon located on the toolbar). the index is created on state).Congure Business Activity Monitor 1:02 1:02 1:04 1:05 1:06 1:07 1:07 25 10 30 25 20 30 25 NY NJ NY NJ NY NJ NY From this data BAM calculates and stores aggregated data. Interval 1:00 − 1:05 1:00 − 1:05 1:05 − 1:10 1:05 − 1:10 Loan Amount 75 65 45 30 State NY NJ NY NJ As shown. After 24 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . 3. Locate the data object with the business object fields you want to aggregate. 6. an index is created on the aggregation execution tables for all fields that are grouped (in the example above. Select a group by field. but not all. 5. of the business object fields. 4. the loan amount total for New York state was 75. The total for New Jersey was 65. To specify business object aggregation 1. processes starting between 1:00 and 1:05. Multiple fields can be grouped. 2.

The mechanism for creating filters lies with a user defined attribute on the business object field entity. Tip: A monitor symbol is added to the business object icon indicating that it is being monitored. 3. Each activated business object is now available as a reporting entity. right-click the business object and select Disable BAM Reporting. data object. business object field tables are created in the BAM database. The ability to create indexes for business object fields is also controlled through this UDA. To disable monitoring. First. Select File > New Report from the menu. Working with business object lters and indexes One important by-product of activating a business object is the automatic creation of business object field filter entities. Right-click the business object you want to monitor and select Monitor Business Object. if desired. 2. Second. Repeat step 2 for each business object to be monitored. and business object field report entities are created. The UDA is called Monitoring and contains two fields: Use as filter and Create Index. These entities allow users to filter report results by values entered on a Process Builder form. Select Application > Reports from the menu. These tables hold field-level data generated by an executing process. 2. To verify report entities created 1. business object field filters can be used to calculate the total dollar value of all customer orders submitted in Massachusetts. By default. the use as filter field is set to true so that each business object field also creates a filter entity. To activate business object monitoring 1. The value “Massachusetts” is business data captured on the Order Form as the process executes. use the check boxes to specify the specific fields you want to monitor. Select Application > Business Object > Business Object Definition from the menu. Indexes help to improve the performance of the BAM software by optimizing the EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 25 . This opens the Business Object Definition window. For example. business object field filter entities are automatically created. business object.Congure Business Activity Monitor the business object is assigned. And third. These entities form the foundation for business reports displayed in the dashboard. You can change the Use as filter value to ’false’. Monitoring a business object results in three things.

8. Within the Business Object Definition window. Click Ok. In a high transaction environment. A popup warning is displayed if you try to rename. Right-click a process (or subprocess) and select BAM process Monitoring. Activating and deactivating process monitoring Monitoring can begin once all configuration steps are completed and business objects are monitored. which allows monitoring to begin. This places a check mark next to the BAM process monitoring right-click menu item and a monitor icon next to the process in the hierarchy. 2. To modify business object eld lters and indexes 1. Click the UDA tab. but you can change this setting to true. 6. Click Save (the diskette icon located on the toolbar). you must right-click the business object and select Synchronize BO Definition with BAM. 7. This populates the audit trail database with the name of the process. select a business object field. an index is not created (false) on a business object field. 3. By default. 26 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .Congure Business Activity Monitor way in which data is retrieved from the database. Place your cursor in the Value field. Caution: Monitoring is automatically stopped if the process or activity names are changed. Subprocesses can also be monitored. Update the field to either true or false. 5. The only requirement is that you execute the process at least once in Process Builder before you start monitoring. 4. If the filter or the index value is modified while the business object is monitored. Note: You must have at least one activity in the process for the monitor icon to be displayed in the hierarchy. To activate monitoring 1. a lot of data is generated in a short period of time. Click the Assign button.

Conguring the Workow Publish Events job To publish data to the BAM reporting database.db2. the time for Process Builder would be 13:32:05 and for BAM would be 16:32:05. For example.ear\bpm. Oracle: jdbc_url = jdbc:oracle:thin:@<host>:<port>:<sid> jdbc_driver = oracle. Right-click the monitored process (or subprocess) and select BAM process Monitoring.jdbc. Understanding machine clock settings You must validate that the system clocks of the Process Builder machine and BAM are synchronized to within 5 seconds if possible with an outer limit of 30 seconds. if there is a three hour time difference between Process Builder and BAM.DatabaseName=<database> jdbc_driver = com.Congure Business Activity Monitor To deactivate monitoring 1.jdbc. perform the following steps.microsoft. This removes the check mark from the BAM process monitoring right-click menu item and the monitor icon next to the process in the hierarchy.jcc.2\domains\DctmDomain\upload\MethodServer\ bpm.SQLServerDriver To use your own JDBC drivers. If the Process Builder machine and the BAM machine are located in different time zones. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 27 .ibm. The export agent uses the JDBC drivers that are located in the following location when Documentum is installed on C:\Documentum: C:\Documentum\bea9. not the hours. you must configure the dm_WFPublishEvents job with the connection parameters for the target database. The dm_WFPublishEvents job publishes data from the Process Builder audit trail to the BAM database where it can be used to create BAM reports.war\WEB-INF\lib JDBC drivers for the following database platforms are shipped with Process Builder.OracleDriver DB2: jdbc_url = jdbc:db2://<host>:<port>:/<database> jdbc_driver = com. only the minutes and seconds of each clock must be synchronized.DB2Driver SQL Server: jdbc_url = jdbc:sqlserver://<host>:<port>.sqlserver.

4. Click OK to return to the Jobs list page. Never set the job to Active.2\domains\DctmDomain\upload\MethodServer\ bpm. 2. first remove an argument by selecting the argument and clicking Remove. c.Info page. Place your JDBC drivers in the following location when Documentum is installed on C:\Documentum: C:\Documentum\bea9. Using Documentum Administrator.war\WEB-INF\lib 2. 5. The system displays the Jobs list page. Select the job and select Tools > Run to run the job. Restart the Java Method Server. b. Select the dm_WFPublishEvents job and then select View > Properties > Info. Note: The default for the dm_WFPublishEvents job is configured as Inactive and should remain inactive. Click OK to save the changes. Edit the arguments to include connectivity information for the following values: jdbc_url jdbc_user_name jdbc_user_password jdbc_driver a. To add connectivity parameters to the job: 1. connect to the repository and navigate to Job Management > Jobs. Type the connectivity parameter in the Enter new value box. d. The system displays the Job Properties . Click Add. Note: The job only needs to be run once to establish the connectivity parameters. 6. To edit the connectivity parameters. Click Edit to access the Method Arguments page to enter connectivity parameters for the job.Congure Business Activity Monitor To load other JDBC drivers: 1. Click the Methods tab. 3. 28 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .ear\bpm.Method page appears. The Job Properties .

This is a predefined report that enables you to test that transactions are coming through to the BAM database. Click Ok on the Filter window. Start Date and Time. 2. Instance. and Status. The log4j. The default log level is set to WARN. Navigate through BAM Drilldown Reports > Process Monitor. Verify that BAM is up and running.bpm.2\domains\DctmDomain\upload\MethodServer\bpm. This section does not address all of the various BAM reports that can be defined with the Report Generator.properties file. Run a few transactions through Process Builder. 5. For detailed instructions on BAM reporting.com. Select Object > Run Report from the menu.Congure Business Activity Monitor To change logging levels The export agent uses log4j for logging.logger. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 29 .2\domains\DctmDomain\servers\DctmServer_MethodServer_ <HostName>\logs\bpm-runtimepublish. 3. Select the Generic report. 7. You can change the log level in the log4j. You should see a report with transaction data in the following columns: Process.publish 2. Testing connectivity You can use the Report Generator to test that Process Builder transactions are populating the BAM database. the default it is: C:\Documentum\bea9. Restart the Java Method Server for the logging level changes to take effect. When Documentum is installed on C:\Documentum. 6.log 3. the default location for the file is: C:\Documentum\bea9.ear \APP-INF\classes 1.documentum. Duration (milliseconds). 4. You can change it to INFO or DEBUG to obtain more information. To test connectivity 1.publish=WARN. log4j. When Documentum is installed on C:\Documentum.properties also defines which file contains the log messages. Within BAM select Application > Reports from the menu. External Instance ID. please refer to the BAM Report and Alert Definition chapter.

1970 4:00:00 AM for the date and time. If the export agent is not configured properly the user sees January 1.Congure Business Activity Monitor Verifying conguration Monitoring a process is dependant on successfully connecting the Process Builder audit trail database with BAM database. Failure to monitor execution data can also stem from process engine. Verifying status of BAM export agent The BAM client uses an export agent status utility to determine if the export agent is up and running. This opens the Agent Status window. it is recommended that you use the BAM diagnostic utility. 30 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . The diagnostic report can be interpreted by a customer or sent to EMC Technical Support. If this job is not configured then execution data is not monitored by BAM. To verify the status of BAM export agent 1. and BAM server machine clocks not being synchronized correctly. The utility should be used only in cases where BAM fails to monitor all records of a specific process. If execution data is not being monitored it is recommended that you first check the BAM export agent. This section introduces the BAM export agent as a method for determining if the dm_WFPublishEvents job is configured properly. Select Application > Administration > BAM Configuration > Agent Status from the menu. If the agent is configured properly and events are still not monitored then you should use the BAM diagnostic utility to identify if machine clock settings are the problem. This connection is defined by configuring the dm_WFPublishEvents job in Documentum Administrator. Otherwise.log. The results of the tests are displayed in a report file called BAMDiagnosticUtilityReport. The diagnostic utility automates a series of tests and is typically used by a technical resource within the customer or by EMC Technical Support. This section also introduces the BAM diagnostic utility as a tool for analyzing process events and comparing machine clocks. content server. Using the BAM diagnostic utility If the export agent is configured correctly and events are still not being monitored. a current date and time is displayed. The Agent Status window provides the last date and time the export agent connected to the BAM database.

or if it’s scheduled to monitor it in the future. These clocks must be synchronized. This means that the diagnostic utility will analyze process instance data sent from the Process Builder within the last 2 hours. it means that some events are not being monitored. The default setting usually provides enough data to be analyzed. The report will indicate if the latency between the two clocks is greater than the PipeStatelessProcessDelayMilliseconds value. The process instance ID is used for this calculation. • • Checks the export agent keep alive time and indicates whether the BAM clock is behind the process builder machine. The default time interval is 2 hours. The PipeStatelessProcessDelayMilliseconds parameter closes the gap between the process builder clock and the BAM clock. Checks the following for each instance that is not being monitored: — Is the process instance set for monitoring in BAM? — Does this process instance have a start event? — What is the difference in time between when the start event is recorded in the BAM database and the actual execution time as recorded in the Process Builder? Note: This test compares the PipeStatelessProcessDelayMilliseconds value to the latency between the BAM clock and the Process Builder clock. This includes the database type. Counts the number of process instances that were not formatted. If you are EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 31 . and password. and the number that were fully formatted. but not to the exact second. although this can be changed.Congure Business Activity Monitor The BAM utility: • • • • • Checks the time of the local machine clock Checks the time of the BAM database clock Counts all events exported to BAM from Process Engine for a specific time period. the number that were partially formatted. Checking the event record time and comparing it to the last pipe run indicates if BAM already monitored this time period. — How does the event record time compare to the last pipe run time? The last pipe run represents the last record monitored by BAM. Configuration consists of entering the time interval over which BAM execution data is analyzed. The time period is configured by the user. If there is a difference. username. Checks that the BAM last pipe run is not greater than the current time. The second aspect of configuration is optional. During the installation the diagnostic utility is automatically populated with all required connection parameters to the BAM database. the URL. Calculates the number of process instances being monitored Counts the number of process start and process end events and compares this value to the expected number of events. • • The BAM diagnostic utility must be configured prior to being run.

Enter the database connection string in the dbURL field. 2. in the parameter bamversion=D6SP1 there is no space between the equal sign (=) and D6SP1. To congure the BAM diagnostic utility 1. Note: The default is version 6 SP1. you must update these parameters in the configuration file. d. This utility can also be used with version 6. This is a text file that can be opened with any editor. Enter a database type in the dbType field. You must execute a single SQL command if you run the diagnostic utility and receive an insert_time column not found error. 5. 32 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Navigate to . and db2. then you can download the correct driver from the vendor’s website and copy it to the drivers folder. Note: All JDBC drivers are included with the installation. Valid values are oracle. For example.. To specify a time interval. Open the config.. Enter the database password in the dbPass field. To use the diagnostic utility with a different database: a.. c..DatabaseName=DBNAME Note: Make sure that SelectMethod=cursor is inserted between the hostname/port and the database name. enter a value in the bamversion field. If there is no suitable JDBC driver found. Example database URL The following example is based on a SQL Server database: dbURL=jdbc:microsoft:sqlserver://DBHOSTNAME:1049. Caution: Don’t put a space between a field and it’s value. This is addressed in the troubleshooting procedure. b. Enter the database user in the dbUser field.SelectMethod= cursor. e.properties file. enter a value in the analyzePastHours field. The drivers folders is located at . 3. Note: A pound sign (#) placed before a parameter is considered a remark and is ignored by the software.\Server\bam-diagnostic-utility.\Server\bam-diagnostic-utility\conf. 4. To specify a version of BAM. sqlserver. Example 1-3. Enter the appropriate database driver in the dbDriver field.Congure Business Activity Monitor using the diagnostic utility on a different database.

This sample guides you in interpreting the log file. 3.. the log file can be sent to EMC Technical Support.bat located under . Importing structured business data There may be times when you’ll want to import a package. or process variables separately from a process flow. Note: If exceptions are generated when the tool is run. Review the BAMDiagnosticUtilityReport. For example.\Server\bam-diagnostic-utility. You are now ready to run the diagnostic utility. This generates a report ..log file. SDT.bat located under . Save your changes. This is addressed in the troubleshooting procedure below. an SDT may not be available when a process is originally imported. This checks the version of the BAM diagnostic utility. 2. Or..Congure Business Activity Monitor Note: You only need to enter a simple user name. Launch bam-diagnostic-utility.\Server\bam-diagnostic-utility.. instead of the user name plus connection parameters. Alternatively. If you receive an insert_time column not found error while running the diagnostic utility.\Server\bam-diagnostic-utility. Connect to the BAM database. 2..log file located under . then you must execute a SQL command against the database. then you should run . To troubleshoot the BAM diagnostic utility 1..\bam-diagnostic-utility-check_version. Sybase: ALTER TABLE BPM_PROCESS_EVENT ADD INSERT_TIME TIMESTAMP DEFAULT GETDATE(). For assistance in interpreting the .\Server\bam-diagnostic-utility. the XPDL does not contain the business object EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 33 . review the Sample BAM Diagnostic Report file available under . Run the following command appropriate for the database type: • • • • Oracle: ALTER TABLE BPM_PROCESS_EVENT ADD INSERT_TIME TIMESTAMP DEFAULT CURRENT_TIMESTAMP... To run the BAM diagnostic utility 1. 6.. MS SQL: ALTER TABLE BPM_PROCESS_EVENT ADD INSERT_TIME DATETIME DEFAULT GETDATE() DB2: ALTER TABLE BPM_PROCESS_EVENT ADD INSERT_TIME TIMESTAMP DEFAULT CURRENT_TIMESTAMP.log file.

Open the project into which you want to import the SDT. 4. The business object structure is automatically created.Congure Business Activity Monitor definition. The import procedure defines a business object and establishes the mappings of the data fields. To import structured business data 1. The only difference between these scenarios is with respect to the syntax of the SQL statement that creates the view. Select Application > Business Object > Business Object from the menu. In this case. This value is used to join database tables into a view. The Business Object can now be assigned to inputs. Incorporating external data into BAM Incorporating external data into BAM is based on bringing an object identifier into BAM. This value must be captured in the executing process. 3. The object identifier is a unique value specific to the external schema. The import procedure creates the business object definition in BAM without affecting the processes. Other times these databases are located on different database servers. Locate and select the XPDL file containing the SDT to be imported. The procedure for incorporating an object identifier into the BAM database is the same for each scenario. This opens the Business Object Library window. Make External Data Accessible to BAM Database Exposing external data to the BAM database is based on creating a database view. Linked Server (SQL Server). and stored in the BAM repository. Two prerequisites must be met: 34 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Verify the business object was created by selecting Application > Business Object > Business Object Definition from the menu. a business object must still be assigned to the appropriate inputs/outputs and monitoring activated. Right-click and select Import from Documentum XPDL. 5. Views created from databases that reside on different servers requires the use of Database Link (Oracle). or Federated Systems (DB2). In each case an object identifier must be brought into the BAM database from which a view is created. 2. Sometimes the Business Activity Monitor database and the external database are located on the same database server.

Congure Business Activity Monitor • • the automated process must incorporate the external application identifier into the process. For Oracle.microsoft. Figure 2. database SELECT privileges must be granted to the BAM database user. a link between databases must be created. The graphic below represents the relationship between an external enterprise schema and the BAM database. this technology is called Linked Server (http://msdn2.A database link allows you to access schema objects in one database from objects in another database.aspx). Within a SQL statement the table on the other database is referenced by adding @dblink (when using Oracle) to the table or view name. Once the database link is created it can be used to view tables in another database.com/en-us/library/ms188279. data from the customer table (customer name. this feature is called Database Link. for example) can be included in BAM dashboard reports and alerts.software. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 35 .com/ps/products/db2/ info/vr82/pdf/en_US/iiyfpe81.pdf). This is required for creating the database view. In SQL Server.ibm. For DB2 this technology is called Federated Systems (ftp://ftp. Object identier used in view When schemas reside on different databases. Once the view is created.

name of object identifer field] 3. Caution: Linking databases may negatively impact system performance. The view joins data from the external schema with the BAM schema. To create a database view 1. Connect to the BAM database. Select the SDT as reportable. Use the following convention to create a view from tables residing on the same database server: Create view [enter a name for the view] as select [the fields you want to include in the view] from [the local table name]. Configure BAM. Creating a database view A database view joins data from the external schema with the BAM schema. 2.[name of external table] where [name of local table. Activate the business object for monitoring. 3.database link] Once your view is created you can proceed with defining custom report and filter entities. The SQL syntax varies slightly when the database schemas are located on different database servers. Use the following convention to create a view from data on different database servers: Create view from [table. The example below uses Oracle. 36 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Import the developed XPDL into the BAM application. Develop the automated workflow where Process Integrator is used to capture the object identifier value from the external database. You are now ready to create the database view. Incorporating external data into BAM 1.Congure Business Activity Monitor The database link must be defined on the BAM database. 4. This creates the business object execution tables that you need in order to create the database view. 5. This value should be stored within an SDT. [the name of the external schema].name of object identifier field] = [name of external schema. 2.

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 37 . so after the synchronization procedure you still need to enter email information into BAM. To assign business object to inputs 1. Select the check box next to the fields you want to monitor. such as LDAP or Active Directory. 5. The procedure below guides you in importing groups and user information into BAM. 3. Multiple work groups can be defined each consisting of one or more people. Select a process from the hierarchy. This procedure does not import email information from the security provider. You can then synchronize BAM with the security provider. 2. You should create the report entity on the aggregation entity. One step in defining an alert is to specify the responsible parties (also called work groups) that will receive the alert email. Select Input/Output from the Activity Connections drop down list. Assigning business objects to inputs Business objects that are manually imported must be assigned to the input of the activity to be monitored. Double-click the input to which you want to assign the business object. 8. 6. This opens the Properties window. Select the Business Object tab. Click Choose business object (the button to the right of the name field). You are encouraged to work with the WebLogic Security Administration Utility or an external tool. From here you can activate business object monitoring from within the Business Object Definition window. 4.Congure Business Activity Monitor Caution: It is recommended that you not create the report entity on a database view that is based on a database link. Select a business object from the list and click Ok. This procedure is not required if the business object is imported with the process flow definition. Click the Save & Close button. Click the Process Designer tab. Synchronizing workgroups Alerts are defined by business users within BAM. 7.

To congure email 1. Select Object > Synchronize with Security Provider. Instead of automatically routing work to a specific performer within a process. Create and deploy the new mail service. However.Congure Business Activity Monitor To synchronize workgroups 1. This opens the User Administration window.. Enter an email address for each user. Configure a new mail session with the following parameters: Name JNDI Name Properties PAMail PAMail mail. Select Services and then select Mail. 4. 5. Conguring email Alert messages will be sent by email to the parties responsible for taking corrective action.host= SMTP Server Address mail. Click Save (the diskette icon located on the toolbar). Within the BAM client select Application > Administration > User Administration from the menu.g. Monitoring queues The Process Builder supports queue management. 2. Log into WebLogic Console.smtp. Sometimes it is necessary for a process to route work to specific performers. select the Additional Data tab. work items are routed to a queue where 38 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . for “Central Operations”) 4. After the data is synchronized.from= The Email address of the sender of alerts (e. 3. there may be times when any number of performers can complete a specific activity. Processes can be comprised of activities and queues. A queue holds work items (activities) until they are claimed and completed by a user. This is where queues become useful. 3. In this procedure the email service is configured. 2.

called Events: • • • • • • • • Started Completed Aborted Acquired Unacquired Delegate Suspend Unsuspended For more information on queue management. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 39 . A queue is defined in the Documentum Administrator application and assigned as the performer of a manual activity. Each report entity is selected within the report builder of the Business Activity Monitor client application and contains entity fields. Work items can exist in a number of different states.Congure Business Activity Monitor they can be selected and completed by any number of performers. Conguring queue monitoring No additional configuration is required for queue monitoring. please see the Documentum Webtop User Guide. however. Work Queue Events. first out order. and Queue Work Item Events. Queue work items are selected by performers for completion. Generating queue monitoring reports Queue monitoring reports are built by using any of three basic report entities: Work Queue. All work items in a queue are monitored. If the process is not monitored. even if the process to which the work item belongs is not monitored. Tasks are usually processed in a first in. users (a list of performers that can claim work items within the queue). There is one caveat. then you cannot report on the relationship between a queue work item and it’s parent process. Each queue is uniquely named and is characterized by thresholds (the maximum number of work items allowed in the queue). and policies (rules that govern how the queue operates). All queue definitions are automatically exported by the Export Agent to the BAM database.

It includes the following entity fields: • • • • • • • • • • Queue Name: The name of the queue. Capacity: The number of work items in the queue divided by the queue threshold. Performer Name: The name of the performer completing the task. and allows users to add a relationship to the Activity Execution entity. Queue ID: System generated identification number. Items Suspended: The number of work items suspended. Active Users: The number of performers assigned to the queue. Work Items in Queue: Total number of work items currently in the queue. expressed as a percent. Event Type: The type of event. Items Acquired: The number of work items claimed by users. Queue Threshold: The total number of work items allowed in the queue. PA-Queue-ID: BAM assigns an identification number to each work queue that is monitored. Activity Name: The name of the activity. BAM ID: BAM assigns an identification number to the activity or process if it is being monitored. The Queue Details report entity includes the following fields: • • • • • • • • • • Event Time: The time of the event. Queue Name: The name of the queue. Activity External Instance ID: System generated activity instance identification number. Queue ID: System generated identification number. 40 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Entity ID: System generated identification number assigned to each activity with a corresponding event in a queue.Congure Business Activity Monitor Work queue This report entity replaces the current queue management report available within the Documentum Administrator. Please refer to the list of event types above. Work queue events This report entity displays all events for a queue. This report can be filtered by queue name or queue ID. Activity Execution data is displayed only if the parent process of the activity is also monitored. Performer ID: System generated performer identification number. Items Waiting: The number of work items not yet acquired by a performer.

Event Type: The type of event. Performer ID: System generated performer identification number. and by calendar. To change a value. Activity Name: The name of the activity. BAM ID: BAM assigns an identification number to the activity or process if it is being monitored. Queue work item events The Queue Work Item Events entity focuses on tasks first. This report can be filtered by queue name. Queue ID: System generated identification number. Please refer to the list of Event Types above. This portal could be the customer’s EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 41 . and then provides queuing information. Performer Name: The name of the performer completing the task. External Instance ID: System generated identification number. Queue Name: The name of the queue. and by calendar. queue ID. Entity ID: System generated identification number assigned to each activity with a corresponding event in a queue. using the General Parameters Configuration window. queue ID. process hierarchy values. Portal When a user receives an alert email message. This report entity includes the following fields: • • • • • • • • • • Event Time: The time of the event. This window is accessed by selecting Application > Administration > BAM Configuration > General Parameters Configuration from the menu. right-click it and select Edit. A relationship to the Activity Execution entity can be added to this report only if the parent process of the activity is also monitored. General Parameter Conguration Settings There are several other settings that you can make.Congure Business Activity Monitor This report can be filtered by queue name. Each parameter is described below. the message contains a link that redirects the user to a portal for further investigation. process hierarchy values.

This variable receives the details of the alert passed to it from BAM. and it is the responsibility of the Process Developer to define a process that listens for incoming events. the exact parameter name (Alert) must be entered in the URL Parameter Name field within BAM (see below).Congure Business Activity Monitor enterprise portal or the Process Navigator. Once configured. triggeredalert) is defined within the properties of a process. the alert initiates an outbound HTTP message that is received by the Process Builder.1 SP3 where BEA’s WebLogic Integration is the process execution engine. Once an alert is triggered an email message is typically sent to responsible parties for resolution. AlarmDistributor Alerts identify problems. but is supported in Business Activity Monitor Version 6. The message includes the details of the alert. workgroup values can be defined either in the Navigator or in WebLogic. HTTP Conguration 1. Finally. a URL parameter must be configured (for example. or watch-events in executing business processes. Alerts can also trigger processes through a Web Service. Use the Web Address element to specify the HTTP address of the target portal. This requires a separate configuration in Process Builder. It is also possible to trigger a new process in the Documentum Process Engine as a way to respond to an alert. Web services are not supported in this release of Documentum Business Activity Monitor. Select Application > BAM Configuration > General Parameters Configuration from the menu. issues. The process variable can also be used in decision split activities within the Process Builder. Alert ) in the HTTP Post Inbound activity and mapped to the process variable (triggeredalert). 42 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . AlarmWorkgroupProvider Set the source for Workgroup definition. Then. MailServiceJNDI Enter the JNDI name for the Email service. First a process variable (for example.

Open the first sendAlertHTTPPostDocBase1 node and enter the following: • URL — the location of the process to be triggered. Alerts are sent once Activate=true. Click Save. The URL convention is: http://<server>:<port>/bps/html/suffix1 where: server — the name of the machine on which the Documentum Content Server is installed port — the port number configured in the Process Integrator bps — this must be entered as is html — this must be entered as is suffix1 — name of the suffix as defined in the HTTP activity within the Process Builder • Activate — contains the values of true or false. Open the first sendAlertWS node and enter the following: • URL — the address of the server on which WebLogic Integration runs. If the alert is sent via webservice. This is achieved by defining a list of URLs to which you want the alert sent. From the left. • URL Parameter Name — The URL parameter as defined in the Process Builder.Congure Business Activity Monitor 2. You can add new recipients by copying and pasting the sendAlert XML element within the Text tab. Each recipient name must be unique. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 43 . then this must be webservice. Click the + sign to open the Recipients node. Web Service Conguration 1. open the Alarm Distributor item. 3. • Send Protocol — If the alert is sent via HTTP Post. 4. 3. then the send protocol must be HTTP Post. • Activate — contain the values of true or false. From the left. open the Alarm Distributor item. 4. Click the + sign to open the Recipients node. Alerts are sent once Activate=true. Select Application > BAM Configuration > General Parameters Configuration from the menu. Note: You can send alerts to multiple destinations. 2. You can also edit the name of the recipient in the Text view so that it is meaningful to you. 5.

The default is 5 minutes. 5. then the send protocol must be webservice. The collection process consists of several steps: accept data from Process Builder. If the alert is sent via HTTP Post.. Pipe Set the delay interval for the Pipe process to wait for Audit Trail information. and Activity. set the number of database rows (BatchRowsValue) that are transferred from the Audit Trail database to the BAM database for each iteration. and aggregate data. • Send Protocol — If the alert is sent via webservice. By default these are Process. FiveMinAggrDelayMilliseconds This setting allows you to set the aggregation delay interval. Sub-process. 44 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . not the select. Always select the archiving delay value plus N (30000+) Milliseconds. AlertTemplate The Alarm Distributor web service method should accept Subject and Template as Alert Template parameters. This means that if no instance is detected in the event table for more than the delay interval. format data. insert data into BAM.Congure Business Activity Monitor • Method Name — The name of the remote method that is called when the alert is generated. The result is that every duration alert for ongoing processes and/or activities will have this delay. Click Save. This refers to the insert. It is not required that you make any modifications. then the send protocol must be HTTP Post. the BAM engine will not wait for events. You need to allow enough time for formatting to complete before starting aggregation. ReportSubCategories This feature allows you to change the names of the Report Categories for BAM Drilldown Reports. In addition.

BAM DB purge ExecActivityInstancePurger .opensymphony. BPMProcessEventPurger .Internal Use Process Aggregation Jobs Aggregates5mProcess AggregatesQHProcess AggregatesHHProcess AggregatesHProcess AggregatesDProcess AggregatesWProcess AggregatesMProcess AggregatesQProcess AggregatesYProcess EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 45 . In the XML tree the name of each job is found under: quartz −> job -> job-detail −> name.com/quartz/. the engine assumes that the server is down and starts the scheduler on a different node.Activity Instance purge FormatGeneric .Congure Business Activity Monitor DelayBeforeMarkingSchedulerAlivenessMilliseconds This is a failover parameter that allows you to specify delay values in a clustered environment. Scheduler Parameter Conguration Settings The Scheduler Parameter Configuration window contains information regarding all jobs triggered periodically using the BAM built-in Quartz Scheduler. This window is accessed by selecting Application − Administration − BAM Configuration − Scheduler Parameters Configuration from the menu. If the node fails for more than the specified duration (or up to double this value). For more information please refer to: http://www.Triggers the AlertHistory task which moves alerts to the history table. The BAM engine scheduler runs on one node (server) in the cluster. • • • • AlertHistory .

Congure Business Activity Monitor Activity Aggregation Jobs Aggregates5mAct AggregatesQHAct AggregatesHHAct AggregatesHAct AggregatesDAct AggregatesWAct AggregatesMAct AggregatesQAct AggregatesYAct Data Aggregation Jobs AggrData5m AggrDataQH AggrDataHH AggrDataH AggrDataD AggrDataW AggrDataM AggrDataQ AggrDataY Alarm Engine Jobs AlarmGenerator AlarmGenerator5M AlarmGeneratorQH AlarmGeneratorHH AlarmGeneratorH 46 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

the following jobs are included: [Server Name]Pipe. and [Server Name]ProcessFormat.Congure Business Activity Monitor AlarmGeneratorD AlarmGeneratorW AlarmGeneratorM AlarmGeneratorQ AlarmGeneratorY In addition. for each configured server. [Server Name]DataFormat. [Server Name]ActivityFormat. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 47 .

Congure Business Activity Monitor 48 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

All this information becomes available in the BAM database. This includes. Some report entities have an aggregation dimension.Chapter 2 Dene BAM Reports and Alerts BAM enables the user to detect problem conditions that may exist in executing processes. When an alert condition exists. BAM reporting entities are divided into execution entities. Understanding BAM reporting entities BAM reports are defined by selecting one or more reporting entities. process and activity start and end times and also the key data associated with the executing processes (Business Object Fields). to diagnose these problems to determine their root cause. The type of entity you select depends on the type of report you are generating. The underlying assumptions of BAM are: • • • All processes to be monitored are captured in the Business Activity Monitor application The processes are executing in Process Builder Alerts and Reports have been defined in BAM to monitor these executing processes As the processes execute. The BAM Alert Engine automatically scans the information looking for alert conditions. business object entities. an email message will be sent to the responsible parties. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 49 . and to correct them. It also provides valuable historical information about process execution to enable long-term process improvement. An alert condition exists if a threshold set for the process has been exceeded. as well. the Process Builder Audit Trail database ‘pushes’ execution data and statistics to the BAM database. and alert entities. incomplete execution entities. for each process instance. queue entities.

page 80. and hourly. These columns are selected in the Entity Fields window. Working with incomplete execution entities Use either the Incomplete Process Execution entity or the Incomplete Activity Execution entity to monitor processes and/or activities that are in-flight (not yet completed). In-flight data is displayed when any of the Ongoing entity fields are selected. these entities allow you to monitor Ongoing Duration in seconds. daily. Both report entities have all nine corresponding aggregation entities defined. Business object entities have all nine corresponding aggregation entities. 50 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Specifically. Queue report entities do not have corresponding aggregation entities. When business object monitoring is activated execution tables are automatically created in the BAM database. work items. Working with business object entities Business objects are defined when SDTs are imported into BAM. These entities are used to generate reports that monitor queues as they relate to performers. Working with queue entities There are three queue report entities: Queue Work Item Events. Each incomplete execution entity has three corresponding aggregation entities: 5 minutes. and events. Activating monitoring also creates business object report entities. Work Queue Events. These entities should be selected when reporting on processes and activities that have been completed. These tables store business object field values populated as the process executes. They can also be selected as children of the Process Execution and Activity Execution entities as the report is defined. hours.Dene BAM Reports and Alerts Working with execution entities There are two execution entities with which to work: Process Execution and Activity Execution. Work Queue. These entities can also be used to generate reports on in-flight processes or activities. please see Understanding queue monitoring and reports. minutes. These entities can be selected as base entities (the first entity in the report) within the Report Builder. For more information about queue report entities. and days.

The incomplete execution entities have only three corresponding aggregation entities: 5 minutes. hourly. overall system performance is enhanced. and activity performer entities (for more information about activity performer entities. they provide users a quick and easy way to design aggregation reports. For example. and hourly. Alert report entities do not have corresponding aggregation entities. Select the Show Aggregated Entities check box in the Report Builder window. weekly. To display aggregation entities 1. the report displays data for each and every process and/or activity instance. daily. • • • • Select the Display check box to add/remove fields Use the Caption field to change the label of the column in the BAM report Select an aggregation method for entity fields containing numeric data Use Group By to create subtotals for aggregated entities EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 51 . Working with aggregated entities Aggregation entities are associated with BAM execution entities. an Activity Execution 15 minutes table. and alert roles. Aggregated entities provide two benefits. Activity Execution. page 52). Simply double-click the BAM report entity (after it is added to the report) to expose the list of fields. alert history. Entity field data is taken directly from the Audit Trail database and can be included in any BAM report. And second. and yearly. monthly. and Activity Performer. daily.Dene BAM Reports and Alerts Working with alert entities Alert entities are available for reporting on alert status. For example. please see Reporting on activity performers. Understanding entity elds As with BPA reporting. The time intervals are 5 minutes. on the other hand. 30 minutes. There are nine time intervals defined for Process Execution. the Process Execution entity lists all completed process instances. Querying this data is much faster than having BAM perform these calculations on instance-level data. First. each BAM reporting entity is accompanied by a list of entity fields. quarterly. Aggregated entities. Aggregated data is stored in aggregation tables in the BAM database. When an aggregation entity is not used. the BAM database contains an Activity Execution 5 minutes table. 15 minutes. group instance data into specific time intervals. incomplete execution entities. and so on. business object entities.

On the list of entities you will see Activity Performer entities divided into the following time periods: 5 Minutes. Much like a stop light. including: • • • • • • • Activity Performer Name Average Duration Maximum Duration Minimum Duration Completed Failed Understanding report types You can choose from a variety of report formats. Generating BAM reports This section provides you with four different sample reports. pie charts. Yearly. completed by “Performers”. In addition. Monthly.Dene BAM Reports and Alerts Reporting on activity performers BAM supports the monitoring of human activities. Obviously. Hourly. To display these entities you must select the Show Aggregated Entities checkbox. BAM captures the name of the Performer and the Performer ID. the arrow of a Dial Gauge points to either green. Quarterly. depending on how your processes perform against a predefined criteria. 15 Minutes. both of which can be used in reports and alerts. depending on how you’d like to see the data. You can also generate bar charts. yellow. and line graphs. 30 Minutes. Grid Reports organize the data in rows and columns. Each Performer entity provides you a number of Entity Fields. It is assumed that you are familiar with reporting in general. BAM includes Performer aggregation reporting entities that allow you to assess an individual’s performance over specific time intervals. You can even generate a very special report called a Dial Gauge. the BAM reports you’re interested in are probably quite different from these examples. Weekly. you must be familiar with: • • Defining a report Selecting and deselecting entity fields 52 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . More specifically. Both the Performer and the Performer ID are available as Entity Fields within all Activity Execution report entities. These samples are meant only as a guide to help you understand how to approach BAM reporting. and step-by-step instructions on how they were defined. Daily. or red.

Open the report builder and bring the process execution entity to the right. 4. Process duration report denition 2. Figure 3. Select the Duration (minutes) check box. Double-click the selected process execution entity. This opens the Entity Fields window. Within the Entity Fields window deselect the Duration (milliseconds) check box. Click Ok to close the Entity Fields window. Each entity field becomes a column in the report and each cell displays the relevant execution data (Start Date and Time. To generate a process duration report 1. Process name. This report results are displayed in rows and columns. 5. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 53 .Dene BAM Reports and Alerts • • • • Using preview and entity filters Applying aggregation and grouping Using computed columns Previewing reports Generating a process duration report This report displays the duration (in minutes) for each process. 3. Duration data is more useful when reported in minutes. and Duration in minutes).

7.Dene BAM Reports and Alerts Figure 4. Back in the Report Builder window. To build a filter expression use the tabs provided. 54 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . There are a number of ways in which to filter the data. select Object > Run Report. Process entity elds 6. This opens the Filter window.

9. Figure 6. It generates an error. The report results are displayed in the Preview window. Preview lter 8. After the filter is defined. Exit the preview window and save the report. click Ok. Caution: Do not use special characters (like commas and hyphens) in report names. Preview window EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 55 .Dene BAM Reports and Alerts Figure 5.

Figure 8. the gauge report consists of a dial and a single arrow pointing to the average duration value. Rather than displaying the report results in rows and columns. This report requires that you work with computed columns to specify ranges for each gauge zone. The graphic below explains how a gauge report is formatted. Figure 7. Process duration report denition 56 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Anatomy of a dial gauge To generate a process duration gauge 1.Dene BAM Reports and Alerts Generating a process duration dial gauge This particular report calculates the average amount of time it takes to complete a group of process instances. Open the Report Builder and bring the Process Execution report entity to the right.

Figure 9. 4. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 57 . This opens the Entity Fields window. Click Ok at the summary rows prompt. This provides a single value for the aggregation. 5. select Object > Report Properties. select Average for the duration (minutes) entity. Process entity elds 7. Click Ok. 13. Select the Show summary data only check box. Select DIAL-GAUGE as the graph style. 9. Select Yes from the Graph pull-down list. Click Ok. 10. Duration data is more useful when reported in minutes. Deselect Start Date and Time. 12. 3. In the Aggregation column. and Duration (milliseconds). Click the General tab. 8. Process. rather than showing the values for each process instance. 6.Dene BAM Reports and Alerts 2. Select the Duration (minutes) check box. Double-click the process execution entity. 11. This brings you back to the Report Builder. Back in theReport Builder window.

yellow. The Computed Columns window is where you define ranges for each of the three Zones (green. For each expression. numeric value. instead of a static. red). enter a value. 58 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . and click Ok. Select Object > Computed Columns. Note: The Value is the only expression based on a computation. Dial gauge report properties 14. you must highlight the row and click Edit Expression. and Value. 15.Dene BAM Reports and Alerts Figure 10. the Grade.

The report results are displayed in the Preview window. Computed columns in dial gauge 16. You are now ready to run the report. click Ok. BAM reports. Caution: Do not use special characters (like commas and hyphens) in report names. There are a number of ways in which to filter the data. Select Object > Run Report. After the filter is defined. This report offers EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 59 . The report described below is just an example. This opens the Filter window. Generating a process duration per zip code report This report calculates the average time to complete a process for each zip code. 17. Zip code in this example is a field on a form. 19.Dene BAM Reports and Alerts Figure 11. Exit the preview window and save the report. To build a filter expression use the tabs provided. It generates an error. especially those involving business data. 18. vary greatly.

Deselect all fields except for Duration (minutes). 5. Example business data report with SLA To generate process duration by zip code report 1. This opens the Entity Fields window. Figure 13. This brings you back to the Report Builder. Select Average as the method of aggregation for the Duration (minutes) field. look for the addressType entity and bring it to the right so it is nested under Process Execution. 60 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Open the Report Builder and bring the Process Execution entity to the right. It incorporates an SLA (service level agreement) value that is displayed as a single line through the bar chart. The SLA feature allows you to compare actual execution data with desired execution data. 6. Click Ok. Double-click the process execution entity. Process duration per zip code report denition 3. Figure 12. 2. On the left.Dene BAM Reports and Alerts one additional feature. 4.

Click the Edit Expression button. Figure 16. Click and drag the zip column so it’s before Duration (minutes). Click Ok. Report elds 12. 10. Process entity elds 7. 8. Deselect all fields except for zip. Select the Group By check box for zip. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 61 . This is where you can arrange the order of the columns in your report. Select Object > Computed Columns from the menu. 9. This brings you back to the Report Builder. Address type entity elds 11. Figure 15. 13. Double-click the addressType entity. This opens the Computed Columns window. In this report the Computed Columns window is used to define an SLA value that displays a line through the bar chart.Dene BAM Reports and Alerts Figure 14. At the bottom of the Report Builder window there is a Report fields region. This provides a summary report where a single process duration value is listed for each zip code.

Click Ok. 20. You must enter the dash (-) after the ‘A’. 22. Do not use BAR3D or BAR3D3D. 19. Select BAR as the Graph Style. 62 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Click Ok. Select Object > Report Properties from the menu. 16. Figure 17. 17. 15. Enter SLA. Click Ok.in the Caption field. Select the Show summary data only check box. Note: You must set the Graph Style to BAR for the service level agreement line to display. 23. Dening an SLA within Computed Columns 18. Select Yes from the Graph pull-down list. Select the General tab. Enter a numeric value in the Edit expression window.Dene BAM Reports and Alerts 14. 21. This populates the expression field in the Computed Columns window.

It generates an error. Report properties 24. click Ok. 26. This opens the Filter window. The report results are displayed in the Preview window. After the filter is defined. Select Object > Run Report. 25. Caution: Do not use special characters (like commas and hyphens) in report names. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 63 . Exit the preview window and save the report. You are now ready to run the report. There are a number of ways in which to filter the data. 27. To build a filter expression use the tabs provided.Dene BAM Reports and Alerts Figure 18.

Dene BAM Reports and Alerts Generating an activity duration by zip code report This report is very similar to the process duration by zip code report. Average activity duration with SLA To generate an activity duration by zip code report 1. Figure 19. Although the report structures differ between reports. 2. you will also learn how to build a preview filter expression. On the left. the same principles apply: average time is calculated for each zip code and a service level agreement (SLA) value is entered by using the computed columns feature. Since this report focuses on a specific activity. 64 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . search for addressType and bring it to the right so it is nested under activity execution. Open the Report Builder and bring the Activity Execution report entity to the right. except that it focuses on a specific step within the process rather than the process as a whole.

Double-click the activity execution entity. In addition. Later. 7. you will convert seconds to minutes in the Computed Columns feature. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 65 . Click Ok. Click Ok. Back in the Report Builder double-click the addressType entity and deselect all fields except for zip. 5.Dene BAM Reports and Alerts Figure 20. 4. 8. select the Group By check box for zip. Deselect all fields except for Duration (seconds). Activity duration by zip code report deniton 3. Activity execution entity elds 6. Figure 21. This opens the Entity Fields window.

Click the New button. This is where you can arrange the order of the columns in your report. Figure 23. Enter a caption in the Computed Columns window. 16.Dene BAM Reports and Alerts Figure 22. This provides a summary report where a single duration value is listed for each zip code. This opens the Computed Columns window. Enter /60 after Duration (second). Report elds 10. 66 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . You will use the Computed Columns window to enter an SLA value. 15. Click the Edit Expression button. This opens the Edit expression window. Click and drag the zip column so it’s before Duration (seconds). 13. 14. At the bottom of the Report Builder window there is a Report fields region. Click Ok. 11. Select Object > Computed Columns. Entity elds for address type 9. 12. This converts seconds to minutes. Select Average as the method of aggregation 17. Select Duration (second).

19.as the name of the caption. Enter a numeric value in the Edit expression window. Click Ok.Dene BAM Reports and Alerts Figure 24. Enter SLA. Click the Edit Expression button. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 67 . 21. Make sure you put a dash (-) after the A. Computed columns window 18. 20.

Select Yes for Graph. Select Object > Report Properties from the menu. Select the Show summary data only check box. Do not use BAR3D or BAR3D3D. Entering SLA values 22. 28.Dene BAM Reports and Alerts Figure 25. 68 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Click Yes at the summary rows prompt 24. 29. 27. 25. Click Ok in the Computed Columns window. Click Ok. 26. 23. Click the General tab. Note: You must set the Graph Style to BAR for the service level agreement line to display. Select BAR for Graph Style.

Dene BAM Reports and Alerts

Figure 26. Report properties

30. You are now ready to run the report. Select Object > Run Report. This opens the Filter window. 31. To build a filter expression use the tabs provided. There are a number of ways in which to filter the data. 32. After the filter is defined, click Ok. The report results are displayed in the Preview window. 33. Exit the preview window and save the report. Caution: Do not use special characters (like commas and hyphens) in report names. It generates an error.

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

69

Dene BAM Reports and Alerts

Sample Alerts
Task Duration Alert
This task introduces the basic techniques used to create alerts in BAM. You will learn how to construct a simple alert that monitors the duration of a specific activity as it executes. This alert monitors an activity in an executing process. The metric we are monitoring is the activity duration. If, in a running process instance, the duration of the activity in question exceeds a pre-set threshold, then an alert will be generated and an email message will be sent to the responsible parties. The alert message will convey activity name, start time, duration, the activity ID, and activity instance ID. The key concepts involved in this task are: incomplete activity execution entity, thresholds for activity duration, alert distribution, and filtering.

Report Manager Window
1. Within the Report Manager, right-click the Alerts category and select New Alert. This opens the Alert Builder window.

Alert Builder Window
1. Within the Alert Builder bring the Incomplete Activity Execution entity to the right. You must select this entity because you want to be alerted each time an Activity starts, but does not finish within a specific period of time. Then, double-click the Incomplete Activity Execution entity. This opens the Entity Fields window.

2.

Entity Fields (for Incomplete Activity Execution)
1. By default, the following fields are already selected: Start Date and Time, Activity, Activity-Instance, and Activity ID. In addition to these fields, you must select an Ongoing Duration value and click Ok. In this example we have selected Ongoing Duration (Minutes). Note: Each Entity Field is displayed within the details of the alert.

70

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

Dene BAM Reports and Alerts

Alert Builder Window
1. Back in the Alert Builder, right-click under Selected Report Entities and choose Computed Columns. This is where you define the threshold for the Activity’s duration.

Computed Columns
1. You will build an Alert expression in the Computed Columns window. The Alert expression defines the activity duration threshold, which, if exceeded, triggers an email to a ’responsible party’. Begin by selecting the Alert row and clicking the Edit Expression button. Use the column values within the Edit expression window to define the Alert threshold. In this case an alert is triggered when an Activity has started, but has not completed within 10 minutes. Click Ok to go back to the Computed Columns window. Click the Edit Expression button to assign a Severity to the Alert: • 3 = High (colors the Activity in the diagram portlet Red) • 2 = Medium (colors the Activity in the diagram portlet Orange) • 1 = Low (colors the Activity in the diagram portlet Yellow)

2.

3.

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

71

click the General tab. Then. 3. Then. You are now ready to test the Alert. Entering Duration Threshold in Computed Columns Report Properties 1. 72 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . select the Block Alert checkbox. 2. Click the Workgroups button and select from the list. right-click and select Report Properties.Dene BAM Reports and Alerts Figure 27. 4. If you do not yet want the alert to be operational. You must specify the person(s) you want to receive the alert email. Back in the Alert Builder. click Ok. Check the Send Alert Email checkbox for alert emails to be generated.

bring the Customer entity to the right so it is nested under Activity Execution. Then. This opens the Entity Fields window. And more specifically. then the threshold as defined has been exceeded and the alert triggered. Report Manager Window 1. Since the alert is based on business data. If you see a ‘1’. Alert Builder Window 1. (Optional) Define a filter and then click Ok. Within the Alert Builder bring the Activity Execution entity to the right. This brings up the Filter window. Within the Alert Builder. You must focus on the Alert column. Report Preview Window The Alert will display as a Grid report. an alert is triggered when a mortgage loan application greater than $300. The Customer entity was chosen because it holds the loan amount Business Object Field. you must include a single Business Object Field (XML element) in the alert: loan amount. you must include a Business Object in the definition of the alert. This procedure assumes that you have entered sampled execution data into Process Builder. 2.Dene BAM Reports and Alerts Alert Testing 1. 2. Within the Report Manager. It is recommended that you test the alert before making it widely available. right-click and select Preview.000 USD is rejected by the bank. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 73 . It is on this specific field that an Alert Expression is defined. right-click the Alerts category and select New Alert. Double-click the Customer entity. This opens the Alert Builder window. If you see a ‘0’ then the alert has not been triggered. High Value Mortgage Rejection Alert In this example.

Back in the Alert Builder. right-click the Customer entity and select Set Entity Filter. right-click approvalStatus -> rejected. Then. 74 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Double-click the Customer entity and de-select creditRating.Dene BAM Reports and Alerts Entity Fields (for Customer) 1. and select Insert Item into Filter Expression. Alert Builder Window 1. 2. Entity Filter Window 1. This is because the Alert Expression you build is based on the amount of the loan. This populates the Filter Expression. You will define a filter so that the alert is applied only to those loan applications that have been rejected. Click Ok to close the Filter window. Navigate the Standard tab. select loanAmount and click Ok.

which. Back in the Alert Builder. right-click under Selected Report Entities and select Computed Columns. You will build an Alert expression in the Computed Columns window. Begin by selecting the Alert row and clicking Edit Expression. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 75 . Computed Columns 1. triggers an email to a ’responsible party’. This opens the Computed Columns window. if exceeded.Dene BAM Reports and Alerts Figure 28. The Alert expression defines the loan amount threshold. Filtering with Business Data Alert Builder 1.

Figure 29. In this case an alert is triggered when a loan application greater than $300. Use the column values within the Edit expression window to define the Alert threshold. Click the Edit Expression button to assign a Severity to the Alert: • 3 = High (colors the Activity in the diagram portlet Red) • 2 = Medium (colors the Activity in the diagram portlet Orange) • 1 = Low (colors the Activity in the diagram portlet Yellow) 3. Click Ok to go back to the Computed Columns window. An Alert Based on Business Data 76 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .000 is rejected.Dene BAM Reports and Alerts 2.

right-click under Selected Report Entities and choose Report Properties. 4. Then. select the Block Alert checkbox. a drilldown window opens. Click Ok. Check the Send Alert Email checkbox for an alert email to be generated. then the threshold as defined has been exceeded and the alert triggered. and no others. Report Preview Window The Alert will display as a Grid report. Right-click the value and select Insert Item into Filter Expression. When the report link is selected. Click the Workgroups button and select from the list. 4. click Ok. right-click and select Preview. Alert Testing 1. If you see a ‘1’. 2.Dene BAM Reports and Alerts Report Properties 1. Therefore. 2. You must focus on the Alert column. In this example. It is recommended that you test the alert before making it widely available. 3. This populates the Filter Expression. Then. If a user clicks an activity in the diagram. Drilldown Reports The BAM Dashboard also offers Drilldown Reports which are accessed directly from within the process diagram portlet. click the General tab. If you see a ‘0’ then the alert has not been triggered. another window opens EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 77 . Back in the Alert Builder. the Filter Expression is defined to look just at this Activity step. You are now ready to test the Alert. This brings up the Filter window. Then. You must specify the person(s) you want to receive the alert email. In the example below the drilldown window lists all available reports associated with Activities. the action of either approving or rejecting a loan application occurs just before the Check for Loan Approved Activity. Within the Alert Builder. 3. Begin by selecting the Process Hierarchy tab. If you do not yet want the alert to be operational. navigate to and select the Filter value.

Process Reports. Working with report scripts Report scripting enables you to customize the look and feel of report outputs This section addresses procedures for: • • • • • centering text within a column changing the color of text within a column expanding the width of a column formatting the text of a column labeling the Y axis in a report To center text within a column 1. you will see Activity Reports. The mechanics of defining a drilldown report are the same as any other report. Enter colForeground[1] = java. After a report is defined. Drilldown reports are automatically available once they are saved within their associated category. To change the color of text within a column 1. Enter colAlignment[1] = StyleReport. the Report Manager contains a pre-existing structure in which drilldown reports are saved. Report results are automatically filtered to include data pertaining to the selected Activity. And beneath this.Color.blue. Each drilldown subcategory contains individual reports that you define. At the top most level is the BAM Drilldown Reports category.H_CENTER. Drilldown reports can be either static or dynamic. select Object > Table Java Script from the menu. select Object > Table Java Script from the menu. and Sub-process Reports. Click Ok. Run the report. etc. 2. The only caveat is that they must be defined and saved within a specific Report Category.awt. 3. After a report is defined. 2.. 4. 78 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . These are considered sub-categories. Note: The value within the brackets [ ] relates to the position of the column within the report.Dene BAM Reports and Alerts displaying the report results.. Out of the box. the second column is [1]. The first column is value [0]. the third column is [2].

select Object > Table Java Script from the menu. 4. the third column is [2]. Run the report. select Object > Table Java Script from the menu. To expand the width of a column 1. etc. Enter yTitle =’My Value’. Enter colWidth[0] = 170. 2. the second column is [1]. 3. The first column is value [0].NumberFormat.text. After a report is defined. 2. 3. 3. The first column is value [0]. After a report is defined. the second column is [1]. To format cells as currency 1. etc.Dene BAM Reports and Alerts Note: The value within the brackets [ ] relates to the position of the column within the report. 2. select Object > Chart Java Script from the menu. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 79 . 4. Click Ok. 4. Run the report.getCurrencyInstance(). Run the report. Note: If you want to hide a column enter 0 for the value. After a report is defined. 3. Note: The value within the brackets [ ] relates to the position of the column within the report. the third column is [2]. Note: The value within the brackets [ ] relates to the position of the column within the report. where the value after the equal sign (=) represents pixels. 4. where My Value represents the name of the axis. To label the Y axis in a report 1. The first column is value [0]. Enter format[2] = java. Run the report. Click Ok. the third column is [2].. Click Ok. etc. Click Ok. the second column is [1].

All queue definitions are automatically exported by the Export Agent to the BAM database. then you cannot report on the relationship between a queue work item and it’s parent process. and policies (rules that govern how the queue operates). There is one caveat. even if the process to which the work item belongs is not monitored. A queue is defined in the Documentum Administrator application and assigned as the performer of a manual activity. Sometimes it is necessary for a process to route work to specific performers. Tasks are usually processed in a first in. Processes can be comprised of activities and queues. however. All work items in a queue are monitored. However. work items are routed to a queue where they can be selected and completed by any number of performers. A queue holds work items (activities) until they are claimed and completed by a user. If the process is not monitored. Work items can exist in a number of different states. called Events: • • • • • • • • Started Completed Aborted Acquired Unacquired Delegate Suspend Unsuspended For more information on Queue Management.Dene BAM Reports and Alerts Understanding queue monitoring and reports The Process Builder supports Queue Management. Queue work items are selected by performers for completion. Instead of automatically routing work to a specific performer within a process. 80 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Queue Monitoring Conguration No additional configuration is required for queue monitoring. users (a list of performers that can claim work items within the queue). Each queue is uniquely named and is characterized by thresholds (the maximum number of work items allowed in the queue). first out order. there may be times when any number of performers can complete a specific activity. please see the Documentum Webtop User Guide. This is where queues become useful.

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 81 . and allows users to add a relationship to the Activity Execution entity. It includes the following Entity Fields: • • • • • • • • • • Queue Name — the name of the queue. The Queue Details report entity includes the following fields: • • • • Event Time — the time of the event. Active Users — the number of performers assigned to the queue. Queue ID — system generated identification number. This report can be filtered by Queue name or Queue ID. Queue Details. Activity Name — the name of the activity. Items Acquired — the number of work items claimed by users. expressed as a percent. PA-Queue-ID — BAM assigns an identification number to each work queue that is monitored. Each report entity is selected within the Report Builder of the Business Activity Monitor client application and contains Entity Fields. and Queue Work Items. Queue Name — the name of the queue. Capacity — the number of work items in the queue divided by the queue threshold. Work Queue Events This report entity displays all events for a queue. Work Queue This report entity replaces the current Queue Management report available within the Documentum Administrator.Dene BAM Reports and Alerts Queue Monitoring Reports Queue monitoring reports are built by using any of three basic report entities: Queue Management. Activity Execution data is displayed only if the parent process of the activity is also monitored. Work Items in Queue — total number of work items currently in the queue. Items Suspended — the number of work items suspended. Queue ID — system generated identification number. Items Waiting — the number of work items not yet acquired by a performer. Queue Threshold — the total number of work items allowed in the queue.

Performer ID — system generated performer identification number. Queue Name — the name of the queue. Queue Work Item Events The Queue Work Item Events entity focuses on tasks first. Please refer to the list of Event Types above. Activity Name — the name of the activity. Queue ID — system generated identification number. Performer ID — system generated performer identification number. Please refer to the list of Event Types above. External Instance ID — system generated identification number. and then provides queuing information. 82 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . and by Calendar. Entity ID — system generated identification number assigned to each activity with a corresponding event in a queue. Event Type — the type of event. This report can be filtered by Queue Name. Process Hierarchy values. This report entity includes the following fields: • • • • • • • • • Event Time — the time of the event. Process Hierarchy values. This report can be filtered by Queue Name. BAM ID — BAM assigns an identification number to the activity or process if it is being monitored. Performer Name — the name of the performer completing the task.Dene BAM Reports and Alerts • • • • • • Activity External Instance ID — system generated activity instance identification number. Event Type — the type of event. Queue ID. A relationship to the Activity Execution entity can be added to this report only if the parent process of the activity is also monitored. and by Calendar. BAM ID — BAM assigns an identification number to the activity or process if it is being monitored. Queue ID. Entity ID — system generated identification number assigned to each activity with a corresponding event in a queue.

The end user accesses the portal from a browser. The WSRP Producer is a Web service that offers one or more portlets and implements a set of WSRP interfaces that provide a common set of operations for consumers. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 83 . A WSRP portlet is not a Web service in its own right (it cannot be accessed directly).Chapter 3 Design Dashboard Using WebLogic Portal WSRP Overview This document describes the procedures for deploying the Documentum Business Activity Monitor (BAM) Dashboard in a WSRP environment. complete with a WSDL and a set of endpoints. A producer can also provide a run-time environment (or a container) for deploying and managing several portlets. WSRP uses web services to communicate between a portlet and a portal. A producer can offer just one portlet. A WSRP Portlet is a pluggable user interface component that lives inside a WSRP producer and is accessed remotely through the WSRP interface defined by that producer. The WSRP Consumer is a Web service client that invokes producer-offered WSRP Web services and provides an environment for users to interact with portlets offered by one or more producers. The portal retrieves the HTML markup from the producer. The WSRP producer is a true Web service. instead it must be accessed through its parent WSRP producer. The most common example of a WSRP consumer is a portal.

com/developerworks/ library/ws-wsrp/ More information on WSRP architecture can be found at: http://ws.2 This section describes how to design a BAM dashboard using Weblogic Portal version 9.Design Dashboard Using WebLogic Portal Figure 30. and specifically. The WSRP Consumer and Producer are configured in BEA’s WebLogic Portal. how to configure the Producer and the Consumer.org/wsrp4j/ arch/ The sections that follow explain how to configure the BAM Dashboard to work in a WSRP configuration.ibm.2.apache. The BAM Dashboard is deployed over BEA’s WebLogic Server. and 84 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . A Portal as a WSRP Consumer An introduction to WSRP can be found at: http://www-128. Design BAM dashboard with Weblogic Portal version 9. creating a portal. This involves launching the Weblogic administration console.

Enter portal name and URL 7. 6. pages. Enter a Portal Name and Partial URL without spaces. 8. Click the Create New Desktop button. The procedure below provides a general overview. Figure 31. This section does not address individual portlet preferences. and portlets (content). This adds the portal to the menu on the left. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 85 .Design Dashboard Using WebLogic Portal adding portlets to the dashboard. Click the Portals link from the menu on the left Click the Create New Portal button. 3. Click the Create New Portal button. click Portal Management. Select the new portal from the tree on the left. It is assumed that you have expertise in using WebLogic Portal.2 1. 2. It is not a comprehensive guide. 5. 4. To design dashboard using Weblogic Portal version 9. Launch the Weblogic Portal administration console. A dashboard consists of books. On the home page. For more information please refer to the BEA documentation.

Enter a Book Name. Begin to create new desktop 9. Select resources in the library 11. Select the Create New Book radio button. 86 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Select the Select resources in the library radio button. Click Next. 12. Figure 33.Design Dashboard Using WebLogic Portal Figure 32. 10.

Click Next. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 87 . Click Next. 17. Enter a title for the new desktop. Figure 34. To select a menu level. Create new book 16. enter text in the Description field. Enter a Partial URL. 15. select a value from the Menu pull-down list. 18.Design Dashboard Using WebLogic Portal 13. 14. To enter a description of the book.

Click Next. Create new desktop 19. 88 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . 21. Click Finish. 24. Select the new book from the tree on the left. Select the Browse Contents tab.Design Dashboard Using WebLogic Portal Figure 35. 20. 22. Review your desktop properties. Your new desktop is created. 23. Click the Add New Page button.

To choose a theme. Add new page 25. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 89 . To choose a layout. 27. 26. select a value from the Theme pull-down list. You may want to create the login page first. select a value from the Layout pull-down list. 28. Note: You must create a login page that contains the login portlet.Design Dashboard Using WebLogic Portal Figure 36. Click Create. Enter a page Title.

Click the Add button. 34.Design Dashboard Using WebLogic Portal Figure 37. Click the Add Contents button. 31. 90 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Select the check box for the portlet(s) you want to add to the page. Figure 38. Select Portlets from the drop-down list. Create new page 29. Select the new page from the tree on the left. 30. Add contents to page 32. 33. Select the Edit Contents tab.

Click Update. Click the Save Changes button on the Edit Contents tab. To change the name of a portlet: a. Select a portlet from the tree on the left. For more information. 39. Enter a new title. Click the Portlet Preferences tab. You are now ready to enter portlet preferences. Add portlets to page 36. 37. b. d. c. Click the Save button. please see Chapter 7. e. 38. Select the portlet from the tree on the left. Configure Portlet Preferences EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 91 . Figure 39. Click the Edit icon. 35. Click the Title & Description tab.Design Dashboard Using WebLogic Portal Note: You can add multiple portlets of the same type to a single page.

Design Dashboard Using WebLogic Portal Figure 40. Portlet preferences 92 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

Creating BAM and JBoss users In order for data to be transferred between the Business Activity Monitor and the dashboard. This is not a reliable environment and you are advised to configure JBoss Portal to use a database. the user is Test. 2. a user with administrative permissions must be created. Select System in the Access Profile Group field. For this new User. Caution: When BAM is installed on JBoss Portal. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 93 . To create a BAM and JBoss user 1. Begin by creating a new user in the BAM client. you must: • • • Select Both as the User Type. Verify that the user has access to all projects within the Project Access tab. In this example. Please see the JBoss technical documentation for instructions. the portal is using an embedded in-memory database for portal configuration data.Chapter 4 Design Dashboard Using JBoss Portal The purpose of this chapter is to describe how to design a BAM dashboard application using the JBoss portal technology. The BAM dashboard is comprised of four portlets that are shipped with Business Activity Monitor: • • • • Alert Portlet Diagram Portlet Report Portlet Instance Monitor Portlet A BAM dashboard is developed by first creating a BAM and JBoss user and then arranging portlets on a page within the dashboard.

this time by selecting the PaProcessPortal role. Add users to security roles 8. 7. Highlight PA_Administration and click the Change button. Launch your browser and go to: http://<server_machine>:8080/pa-web (where <server_machine> is the name or IP address of the machine where the BAM server is installed). click Ok to apply your changes. Figure 41. Move the Test user from the list of Available Users to the list of Selected Users. 6. 4. From the tree on the left navigate to User and Role → Security Role. Click the To Administrator link. 9. Click the Change button under Work Group User List. 11. Login to Navigator Administration by entering portal as both the user name and password. 10. This brings you to the Process Navigator. Repeat steps 7–8. 94 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Then. Continue by navigating to Content → Workgroup. Caution: You must have purchased Process Navigator to proceed. The new user must be added to both the PA_Administration role and the PaProcessPortal role.Design Dashboard Using JBoss Portal 3. 5.

where <server_machine> is the name or IP address of the machine where the BAM server is installed. 18. enter the same user name and password for the user created in Step 1. Add user to work group 12. 16. Move the Test user from the list of Available Users to the list of Selected Users. 15. Then. Create a new user by clicking the create one link located on the left. Once the BAM server is started. Click Create User. Figure 43. 19. the user name and password are Test. In this case. Validate that the User has been created. Create new JBoss user 17. The JBoss Portal window opens. Restart the BAM server so the changes will take affect.Design Dashboard Using JBoss Portal Figure 42. 14. under User portlet. 13. Within the Create New User window. Logout from the Process Navigator and exit the browser session. open the following URL: http://<server_ machine>:8080/portal. Click the Standard Login link and enter the user name and password. click Ok to apply your changes. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 95 . The values entered for all other fields are not important.

23. Click the Standard Login link on the left and enter admin as both the user name and the password. 24. select the Administrators checkbox and deselect the Users checkbox. you must now login as the Administrator. 25. 21. under User Portlet. Then. 22. Then. click the Assign roles button. Click Logout. Click the Roles link to the right of the Test User you created. On the next screen.Design Dashboard Using JBoss Portal 20. 96 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . click the List of all the users link located under User portlet on the left. With the new JBoss User created.

Assign administrator’s access to new user 26. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 97 .Design Dashboard Using JBoss Portal Figure 44. Click Logout to log out of JBoss and end the browser session.

Design Dashboard Using JBoss Portal

Conguring portlets
You are now ready to build a BAM dashboard using JBoss Portal. A BAM dashboard consists of portlet instances arranged on a page. Portlet instances are derived from the four portlets that are shipped with the dashboard. Portlet instances display a specific diagram or report. Each page in the dashboard can contain many portlet instances. The procedures below guide you in the creation of a BAM dashboard with JBoss Portal.

To congure portlets
1. Open a JBoss Portal session by going to: http://<server_machine>:8080/portal (where <server_machine> is the name or IP address of the machine where the BAM server is installed). Click the Standard Login link. Log in with the JBoss administrator user you created (for example, ’Test’). Select the Admin tab. Click Portlets located under Management Portlet.

2. 3. 4. 5.

Figure 45. Initiate portlet conguration

Note: All portlets are displayed on a series of pages. There are a number of portlets shipped with JBoss Portal. The BAM dashboard portlets are listed as: • • • • 6. local./pa-dashboard.ReportPortlet local./pa-dashboard.Alerts local./pa-dashboard.Diagram local./pa-dashboard.InstanceMonitor

The remainder of this procedure uses the report portlet as an example. Click the local./pa-dashboard.ReportPortlet link. You will see a create instance field on the right.

98

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

Design Dashboard Using JBoss Portal

Figure 46. List of BAM dashboard portlets

7.

Enter a name for the portlet instance and click Create instance. This adds the instance to a list. As a naming convention, enter the name of the report, alert, or process as it’s named in BAM.

Figure 47. Create instance

8. 9.

Click the Instances link under Management Portlet. Locate the instance you created and select it. New instances are always added to the last page.

10. You must now enter portlet preferences by clicking the pencil icon. Each portlet has a unique set of preferences. Portlet preferences are addressed in the Design Dashboard Procedures chapter. For more information, please see Chapter 7, Configure Portlet Preferences.

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

99

Design Dashboard Using JBoss Portal

Figure 48. Portlet preferences

11. Enter the preference value and click Append.
Figure 49. Enter preference value

100

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

Navigate the portal and select the new page. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 101 . Adding portlet instances to dashboard Portlet instances are added to pages within the BAM dashboard. The page is added to the default portal. click the Instances link under Management Portlet. Expand +root and select default. 4. This section explains how to create a new portal.Design Dashboard Using JBoss Portal 12. If you must work with another portlet instance. Enter a name for the new page. 2. Continue entering preference values as necessary. Add new page 5. Figure 50. To add portlet instances to dashboard 1. a new page. 3. Click the Portal link under Management Portal. Click Add page. and add portlets to pages.

Add portlet instance to page 9. From here you can continue adding portlet instances and preview the dashboard with Preview link. in the field to the left of the picklist. For information on how to configure the look and feel of a dashboard developed in JBoss portal. Enter the name of the portlet instance again. Figure 51. 7.com/jbportal/v2. please see http://docs.Design Dashboard Using JBoss Portal 6. Click Add center. From the picklist select the portlet instance you want to add. 8.jboss.4/reference-guide/en/html_single/ 102 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

Naturally. for example. The instance level page displays process flow diagrams and contains reports with information about in-flight and completed processes. The preconfigured dashboard contains some generic reports that are already defined in the report manager. 2. The alerts page displays activities that have triggered an alert and allows users to gather more information about each alert. These reports are noted in the sections below. In an effort to ease dashboard configuration. however. Reports that contain business object data. and Executive. data is not displayed in these reports until the aggregation period is complete. Users were responsible for creating their own reports and mapping them to the dashboard. the BAM dashboard built with JBoss Portal was a tabula rasa--a blank slate. Some of the preconfigured dashboard reports use time-based aggregation. duration (minutes). The executive page contains reports with process summary information and drill down reports that provide greater detail. As a result. Alerts. users will want to change the dashboard by modifying and/or adding reports that are of particular value to their business. The preconfigured dashboard provides two benefits: 1. monitoring settings to be configured in BAM. Not all reports can be modified. This is because the preconfigured dashboard only contains reports defined with standard data — data that is available across all implementations of BAM. A faster path to a working BAM dashboard.Chapter 5 Work with Precongured JBoss Dashboard In the Version 6 release. Start date. and users will see the dashboard come alive as soon as the first few process instances are executed. should be added. a preconfigured dashboard has been developed that provides users with a working dashboard available out-of-the-box. These reports are consumed by a dashboard that contains three pages: Instance Level. All that is required is for a process to be developed in Process Builder. A starter set of portlets that you can add to or customize. This is because many reports use scripting to enhance report formatting or define links to drill down reports. Note: The preconfigured dashboard will only display data when at least one (and ideally many) process instances are executed. and process name are all examples of standard data. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 103 .

Design Dashboard Using JBoss Portal Chapter 7. or alerts. This documentation does not describe how to design a dashboard or configure portlet preferences. 104 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . As a prerequisite. and Executive tab to review the results. although this could have been changed during installation. Where appropriate. The portlets display content from either diagrams. These sections include procedures for modifying reports. 2.Work with Precongured JBoss Dashboard You must know how to use scripting if you want to make changes. This section guides you in previewing the dashboard. The first section describes how to view the dashboard once several processes are executed. The final section describes how to modify portlet preferences to display a different report. Click through the Instances Level. Enter admin as the login name and admin as the password. 3. Related documentation: Chapter 4. reports. Additional sections provide an in-depth description of specific portlets and their behavior. The instance page is the default. Alerts. it is recommended that that you run several process instances before previewing the dashboard. The default port is 8080. Once configured. When you preview the dashboard you will see three tabs (or books) that each contain several portlets. The next three sections describe the contents of each page. This documentation is divided into five sections. The preconfigured dashboard is only available for JBoss Portal but the report definitions can be consumed by WebLogic Portal and WebSphere Portal. specific modifications for each report are noted. No special installation is required. To preview pre-congured dashboard 1. a process must be developed in Process Builder and configured in BAM. Configure Portlet Preferences Previewing the precongured dashboard The preconfigured dashboard is populated by data taken from executing processes. Go to http://<servermachine>:<port>/portal/auth/portal/Preconfigured Dashboard where <servermachine> is the name or IP address of the machine on which the BAM server is installed and <port> is the server HTTP port number. report by report. if applicable.

or adding a business object so it is nested under the Process Execution entity. This displays a process flow diagram in the diagram portlet located just below the instance monitor portlet. and status). duration. The instance monitor portlet displays all process instances and select data (like start time. The generic report is defined with the Process Execution report entity. One major benefit of the instance monitor portlet is the ability for users to open a process instance diagram by clicking the View Instance button. The generic report can be modified by adding or removing columns. Columns displayed in the portlet are selected in the Entity Fields window of this entity.Work with Precongured JBoss Dashboard Working with the Instances Level page The Instances Level page provides flow diagrams for each process that is executing as well as a number of reports that focus on the details of each process. Working with the Instance Monitor portlet The first portlet in the Instance Level tab is an instance monitor portlet. The instance monitor portlet is based on the Generic report defined in the BAM client under BAM drilldown reports > Process Monitor. 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. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 105 .

Select Application > Reports. 106 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . You can also add a business object by selecting it from the entities on the left and adding it to the report. Navigate through BAM Drilldown Reports > Process Monitor. Open the BAM client. 2. 8. Double-click the Process Execution entity.Work with Precongured JBoss Dashboard Figure 52. 7. 9. Click Ok. 6. Right-click the Generic report and select Edit. 4. Either log back into the BAM dashboard or click the Reset View button within the portlet. 5. This opens the Entity Fields window. Select File > Save. Sample instance monitor portlet To modify the generic report 1. Place (or remove) a check mark in the display column for the entity fields you want to add (or remove). Note: You cannot remove the process or instance columns. 3.

Working with the diagram portlet When users first log into the preconfigured dashboard. Activities with a solid black border have been completed. The in-flight reports are formatted as a dial gauge. The diagram portlet shows which activities have an alert. these same reports display process data. The ongoing activities report cannot be modified because it uses scripting. dashed border are in-process. Users click the name of the report which opens a new window to display the report results. and allows users to open drilldown reports. All other columns can be repositioned. This report is formatted as a bar chart and displays the number of activities that are in-flight. Another interesting aspect to the diagram portlet is that it is dynamically linked to four other reports in the Instance Level tab: one pair of reports addresses in-flight processes and activities. The other pair of reports display process and activity instance summaries. The list of drilldown reports can be supplemented with other reports. the in-flight and summary reports display activity data. as is.Work with Precongured JBoss Dashboard Caution: The first two columns must remain in order. The preconfigured dashboard lists Ongoing Activities as the drilldown report. The summary reports are formatted as a bar chart. Each report is discussed in the following sections. When a user selects an activity in the diagram portlet. Drilldown report contents are automatically filtered to display data for the selected activity. To view an instance level process flow diagram the user must click a View Instance button within the instance monitor portlet. those activities that are completed. a list of drilldown reports is displayed. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 107 . If the Summary View button is selected in the diagram portlet. In addition. and their collective duration. Activities with a gray border have not been completed and activities with a blue. the diagram portlet displays Process Not Found. Once selected. to the right of each activity is a drilldown report icon.

Open BAM Drilldown Reports.Work with Precongured JBoss Dashboard Figure 53. Sample diagram portlet To add a drilldown report 1. Open the BAM client. Right-click Activity Reports and select New Report. Working with the In-ight Process/Activity Instances report This particular report portlet displays either a count of processes or activities that are in-flight. 4. Define and save the report. 3. 2. Select Application > Reports. this report counts the number of activity instances (for 108 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Note: Activity drilldown reports must be saved under the Activity Reports category. depending on the how the user chooses to see the data. The report is immediately available as a drilldown report. 5. If a user selects an activity in the diagram portlet.

Forty or more process instances running simultaneously may indicate a severe problem. The total number is then filtered to include only those that are Ongoing. The process gauge displays data from the Inflight Process Instances report and is saved under the same report category as the activity report. which means the process is running smoothly. the arrow points to the green zone. If there are between 20 and 40 instances running the arrow points to the yellow zone (caution). Figure 54. Process — Instance or Activity — Instance). The process report is defined with the Process Execution entity.Work with Precongured JBoss Dashboard the selected activity) that are currently in process. The zones can be modified within the Computed Columns window of each report. then the dial gauge changes to count the number of process instances that are currently on going. The ongoing filter is defined on the report entity. page 56. The activity gauge displays data from the Inflight Activity Instances report defined in the BAM client. please see Generating a process duration dial gauge. Zones are meant to represent how well processes are executing. For example. Sample process instance dial gauge EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 109 . If the user selects the Summary View button. This report is saved under Preconfigured dashboard > Instance Level > Inflight Instances Gauges and is defined with the Activity Execution report entity. if there are between zero and 20 process instances in-flight. The report results are displayed in a gauge that consists of an arrow and three zones. Each report counts the total number of instances that are executing (for example. For more information on defining dial gauge reports.

6. Update the value. 5. 110 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Open the BAM client. 8.Work with Precongured JBoss Dashboard To modify the zones of the process and activity dial gauge 1. Select Application > Reports. Right-click either the In-flight Activity Instances report or the In-flight Process Instances report. Navigate through Preconfigured dashboard > Instance Level > In-flight Instances Gauges. Click Ok in the Edit expression window. Select the value you want to modify. 2. 7. 4. 3. Select Object > Computed Columns. Select Edit. Either log back into the BAM dashboard or click the Refresh button within the portlet. 11. 12. 9. 10. Click Ok in the Computed Columns window. Click Edit Expression. Select File > Save. This opens the Computed Columns window. 13.

If a user selects an activity in the diagram portlet. If the user selects the Summary View button.Work with Precongured JBoss Dashboard Figure 55. are in-flight. Each EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 111 . this report calculates the number of activity instances (for the selected activity) that have started. or have completed. or have completed in the past 24 hours. This is because the report is built with an aggregation entity. are in-flight. Note: Once processes are executed it takes 24 hours for data to be displayed in this report. Process dial gauge computed columns window Working with the Process/Activity Instances Summary report The instances summary report is also dynamically linked to the process diagram. depending on the how the user chooses to see the data. or have completed. are in-flight. then the report calculates the number of process instances that have started. This report calculates the number of process or activities instances that have started.

Figure 56. BAR3D. Four columns are selected in the Entity Fields window: Process/Activity. Sample process instance summary bar chart 112 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . The only change you can make to this report is to modify the format of the bar chart to either BAR. For more information on aggregated entities please see Working with aggregated entities. Completed. This report is saved under Preconfigured dashboard > Instance Level > Instance Summary Bar Charts and is defined with the Activity Execution Hourly report entity. The activity summary report displays data from the Activity Instance Bar Chart report defined in the BAM client. Caution: This report makes considerable use of scripting and as such is tightly bound to the structure of the data source. For more information on graphing report results please see the Graphing report results section of the Process Analyzer User Guide. The process summary report displays data from the Process Instance Bar Chart report that is saved under the same report category as the activity report. and On Going Instances.Work with Precongured JBoss Dashboard report is formatted as a bar chart. Note: Aggregation entities are displayed in the Report Builder window by selecting the Show Aggregated Entities check box. Do not add or remove columns. This report is defined with the Process Execution Daily entity. Count of Started Instances. or BAR3D3D. Each entity field is summed and bar chart settings are selected in the General tab of the Report Properties window. page 51.

In the Tasks Completed by Performer report columns can be added and the completed work items column can be removed. 7. or BAR3D3D in the Graph Style field. The two reports are linked together by a script entered in the Table Java Script window of the Report Builder. This report demonstrates the dashboard’s drilldown report capability. Select either BAR. 5. the completed entity field is summed. 10. The procedure below is based on the Tasks Completed by Performer report. please see Building hyperlinks between reports. Select Application > Reports. In addition. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 113 . page 156. 6. 3. After a report is defined. Select File > Save. 9. the Table Java Script window is opened by selecting Object > Table Java Script from the menu. Each performer’s name is linked to another report called Selected Performer. in which the Performer Name and Completed entity fields are selected. Either log back into the BAM dashboard or click the Refresh button within the portlet. Columns cannot be deleted and their order must remain as is. 2. Working with the Tasks Completed by Performer report The final report in the Instance Level page is the Tasks Completed by Performer report. Right-click Process Instances Bar and select Edit. 4. Open the BAM client. For more information on defining hyperlinks between reports. Click the General tab. This opens the Report Builder window. Click Ok. The report is defined with the Activity Performer 5 Minutes report entity. 8. which is part of the instance group.Work with Precongured JBoss Dashboard To modify the format of the bar chart 1. Navigate through Preconfigured dashboard > Instance Level > Instance Summary Bars. Only columns can be added in the Selected Performer report. Select Object > Report Properties from the menu. The Performer name column must remain the first column. This report calculates the number of work items completed within the last five minutes for each performer in the process. This report displays the name of the process and counts the number of activity instances completed by the performer. BAR3D.

Work with Precongured JBoss Dashboard Figure 57. 6. 3. 10. Caution: If you select the Failed column. For specific fields you must select the appropriate aggregation. 8. then you should select Max as the aggregation. Either log back into the BAM dashboard or click the Refresh button within the portlet. Select File > Save. This opens the Entity Fields window. 7. 5. Navigate through Preconfigured dashboard > Instance Level > Performer Tables. 9. Sample Tasks Completed by Performer report To modify the Tasks Completed by Performer report 1. Click Ok. Open the BAM client. Select Application > Reports. Double-click the Activity Performer 5 Minutes report entity. you must select Sum as the aggregation. 4. Right-click the Tasks Completed by Performer report and select Edit. 2. 114 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Place (or remove) a check mark in the display column for the entity fields you want to add (or remove). If you select Maximum Duration.

or red). Alert notification is available with alert and diagram portlet. The Activity Duration Alert is the only alert defined in the preconfigured dashboard. the entity name (either a process name or an activity name). The first icon indicates the alert severity (either yellow. and date. For more information on defining alerts. and the entity type. The columns of the alert portlet are fixed and cannot be modified. Diagnosing and managing alerts is addressed with the Activity Details of Alerted Process and Alert Status reports. Once an alert is triggered. the name of the alert. The alert condition and severity can be modified to suit your needs. The second icon allows users to manage the alert by entering comments and closing the alert. Working with the Alerts portlet The first portlet in the Alerts page is an alert portlet. severity. page 70. its status. The list of alerts can be filtered by status. The third icon allows users to view a process flow diagram in the diagram portlet located just below the alert portlet. and all tools necessary for diagnosing and correcting a problem. please see Sample Alerts. Alerts are defined in the Report Builder window of the BAM client. The alert portlet lists all processes or activities for which an alert has been triggered. All alerts defined in the BAM client operate immediately and are displayed in the same alert portlet. The left most column contains three icons. This section addresses each portlet in detail and provides any procedures required to configure underlying reports or alerts.Work with Precongured JBoss Dashboard Working with the Alerts page The primary purpose of the Alerts page is to provide a list of process/activity alerts. the date of the alert. The alert threshold is defined as an expression in the Computed Columns window. It is defined with the Incomplete Activity Execution report entity and is designed to be triggered when any activity within a process is taking more than five minutes to complete. it populates the alert portlet with the name of the process or activity. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 115 . Alerts must be defined and saved within the Alerts report category. orange.

Select Application > Reports. b. 4. Update the alert expression. 7. click Ok in the Edit expression window. To modify the severity of the alert (the severity corresponds to the colors of the alert icon in the diagram portlet): a. This opens the Computed Columns window. 8.Work with Precongured JBoss Dashboard Figure 58. Right-click Activity Duration Alert and select Edit. Once the alert is updated. Click the Edit expression button. Click the Edit Expression button. 9. you must first select it from the Entity Fields window of the report entity. 116 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Open the BAM client. 5. 10. Select the Severity row. Note: The entities listed in the Columns field have been selected as entity fields within the report entity. 3. 6. Open the Alerts category. Sample alert portlet To modify alert condition and severity 1. select Object > Computed Columns. If you need to use a different column in your alert. This opens the Edit expression window. 2. Select the value you want to modify. This opens the Report Builder window. To modify the alert condition.

Clicking an alerted activity in EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 117 . 11. Either log back into the BAM dashboard or click the Refresh button within the portlet. Click Ok in the Computed Columns window. 2 (orange). Select File > Save. 12. Process instances are displayed when the View Instance icon is selected within the alert portlet.Work with Precongured JBoss Dashboard c. or 3 (red) as the severity level. 13. Click Ok in the Edit expression window. It is either displaying a summary view of a process diagram (the abstract process) or individual process instances. orange. e. An alert icon (either yellow. Modify alert condition and severity Working with an alert diagram portlet The diagram portlet has two modes. Figure 59. Enter either 1 (yellow). The diagram portlet indicates which activities have an alert. d. or red) is placed in the lower left corner of affected activities.

Work with Precongured JBoss Dashboard the diagram portlet refreshes the alert portlet to display all alerts for the selected activity. This report displays all activities in order for each process listed. The rest of the report includes columns for performer. in-process (dashed. the diagram indicates which activities are completed (black border). The Activity Details of Alerted Process report located just below the diagram portlet provides a greater understanding of performers and activity durations. 118 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Sample diagram portlet Working with the Activity Details of Alerted Process report The content displayed in this report portlet is dynamically linked to the process diagram portlet above it. Drilldown reports can also be access from within the diagram portlet. blue border). This report is meant to help identify and resolve process problems. This report includes the same information as the Processes report. and not completed (gray border). It is possible for a single activity to have multiple alerts. When a summary level process diagram is displayed in the diagram portlet. When an instance level process diagram is displayed the results of the Process Activities report are shown. the results of the Processes report defined in the BAM client is displayed. In addition to alerting. The color of the alert icon corresponds to its severity level. Figure 60. For more information on drilldown reports. the first column of the report is sorted by activity. please see to Working with the diagram portlet. however. page 107.

Select Application > Reports. The report definition of each of these reports can be modified by adding or removing columns. add any relevant business objects and select the appropriate entity fields. 2. 6. Navigate through Preconfigured Dashboard > Alarms. Figure 61. This opens the Report Builder window. Note: These reports are good candidates for adding business object data. When editing the report. Sample Activity Details of Alerted Process report To modify the Processes or Process Activities report 1. To add a column to the Process Activities report. The purpose of this report is to pinpoint the activities within an alerted process requiring attention. The order of all columns can also be changed. double-click the Activity Execution entity. 5.Work with Precongured JBoss Dashboard activity start and finish time. To add a column to the Processes report. Open the BAM client. 4. 3. double-click either the Process Execution or the Activity Execution entity. and duration. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 119 . Right-click either the Processes or Process Activities report and select Edit.

Caution: This report makes considerable use of scripting and as such is tightly bound to the structure of the data source. Working with the Alerts Status report When alerts are generated and resolved the dashboard user has the option of selecting a status within the alert portlet. Within the edit window the user can enter a note and select a status. Either log back into the BAM dashboard or click the Refresh button within the portlet. 10. 8. Select File > Save. For more information on managing alerts.Work with Precongured JBoss Dashboard 7. Acknowledged. Do not modify this report. Place (or remove) a check mark in the display column for the entity fields you want to add (or remove). 120 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . There are three statuses: New. 9. and Closed. page 160. The Alerts Status report counts the number of each type of status and presents it in a pie chart. This report is defined with the Alert report entity. To update the status the user must click the Edit button for a specific process instance. please see Alert Portlet. Click Ok.

These reports also provide the executive with the ability to drill down (via hyperlink) from one report level to another. Aggregation is also used to report average duration for a group of processes. This person is concerned with processes performance over time. Aggregation is used in a report that counts the number of in-flight processes. Sample Alerts Status report Working with the Executive page The audience of the Executive page is the mid. The reports available in this page feature aggregation.Work with Precongured JBoss Dashboard Figure 62. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 121 .to upper-level executive concerned with how processes are generally running. The first portlet in particular features a three layer drill down report. Working with the In-ight Process Overview report The first report portlet displayed in the executive page is the In-flight Process Overview report. plus the duration of the work item that is taking the longest to complete (Oldest Work Item). This report presents a bar chart that calculates the number of in-flight process instances (the blue bar) and the average amount of time (in seconds) processes take to complete. Below the chart is a table of the same data.

For more information on defining a drill down.Work with Precongured JBoss Dashboard This report portlet is based on the Ongoing Process Overview report defined in the BAM client. and Process-ID columns are selected in the Entity Fields window. BAR3D. This report also features extensive use of table. This particular portlet demonstrates the dashboard’s report drilldown capability. The activity report. in turn. is linked to yet another report called Ongoing Activity Details by Performer report. Duration (seconds). please see Building hyperlinks between reports. The report is available under the Preconfigured Dashboard > Executive report category. Caution: This report makes considerable use of scripting and as such is tightly bound to the structure of the data source. This report uses the Process Execution report entity where the Process. or BAR3D3D) in the Report Properties window. The Oldest Work Item column is added in the Computed Columns window. page 156. You are able to modify the bar chart format (choose either BAR. chart. and global scripts. The activity report is displayed when the user selects a process in the process overview report. Process-Instance. 122 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Do not add or remove columns. Within the Table Java Script window. The computed columns expression is defined to report the maximum duration (in seconds) of a work item The computed columns window is opened by selecting Object > Computed Columns in the Report Builder window. a hyperlink is defined between the Ongoing Processes Overview report and theOngoing Activities Overview report.

Work with Precongured JBoss Dashboard Figure 63. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 123 . Like the process overview report. the activity report counts the total number of in-flight activity instances and calculates the average amount of time (in seconds) it takes to complete each instance. Do not add or remove columns. This report is linked to the Performers of Selected Activity report. Caution: This report makes considerable use of scripting and as such is tightly bound to the structure of the data source. The performers report displays when a user selects an activity in the table of the In-flight Activities Overview report. The activity overview report is saved in the same report category as the process overview report and is defined with the Process Execution and Activity Execution report entities. Sample In-ight Process Overview report Working with the In-ight Activities Overview report The content of the Ongoing Activities Overview report is displayed when a specific process name is selected in the table of the In-flight Processes Overview report.

BAR3D. Figure 64.Work with Precongured JBoss Dashboard You are able to modify the bar chart format (choose either BAR. or BAR3D3D) in the Report Properties window. This report is based on the Activity Execution entity and displays the name of each performer. The first three columns 124 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . counts the number of activities being worked on. Sample In-ight Activities Overview report Working with the Performers of Selected Activity report The content of the Ongoing Activity Details by Performer report is displayed when a specific activity name is selected in the table of the In-flight Activities Overview report. and the duration of the oldest workitem. the average ongoing duration (in seconds).

Work with Precongured JBoss Dashboard

are selected in the Entity Fields window of the report entity. The Oldest Work Item column is added in the Computed Columns widow. The computed columns expression is defined to report the maximum duration (in seconds) of a workitem. The computed columns window is opened by selecting Object > Computed Columns in the Report Builder window. You can add, remove, and change the order of columns in this report.
Figure 65. Sample Performers of Selected Activity report

Working with the Process Instances Started in the Last Week report
The Process Instances Started in the Last Week report portlet displays data from the Instances Started in the Past Week report defined in the BAM client. Note: Once processes are executed it takes one week for data to be displayed in this report. This is because the report is built with an aggregation entity. This is a grid report that lists each process instance, it’s start date and time, and provides a count of all process instances that were started. Each of these columns is selected in the Entity Field window of the Process Execution Daily report entity. This report is filtered to include only those processes that were completed within the last week. The filter is defined on the Process Execution Daily entity. This filter can be modified. You can also add, remove, and change the order of columns in this report. Since this report uses aggregation, you must make sure to select the appropriate aggregation for each column that’s added.

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

125

Work with Precongured JBoss Dashboard

To update the report entity lter
1. 2. 3. 4. 5. 6. 7. Open the BAM client. Select Application > Reports. Navigate through Preconfigured Dashboard > Executive. Right-click the Instances Started in the Past Week report and select Edit. This opens the Report Builder window. Right-click the Process Execution Daily report entity and select Set Entity Filter. This opens the Filter window. Use the tabs to build a filter expression by locating a filter value, right-clicking, and selecting Insert Item into Filter Expression. Click Ok.

Figure 66. Filter expression window

8. 9.

Select File > Save. Either log back into the BAM dashboard or click the Refresh button within the portlet. Caution: You must also remember to change the report title as displayed in the dashboard to reflect the update.

126

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

Work with Precongured JBoss Dashboard

To update the report name displayed in the dashboard
1. Select Object > Global Java Script from the menu. This opens the Global Java Script window. Note: For other reports the reportTitleID may be configured in either the Table or Chart Java Script windows. 2. 3. Modify the name of the report. Click Ok.

Figure 67. Global java script window

4. 5.

Select File > Save. Either log back into the BAM dashboard or click the Refresh button within the portlet.

Working with the In-ight Processes Overview (completed 24h) report
The In-flight Processes Overview (completed 24h) report portlet displays data from the Ongoing Processes Overview, completed 24h report defined in the BAM client. Note: Once processes are executed it takes 24 hours for data to be displayed in this report. This is because the report is built with an aggregation entity. This report presents a bar chart that calculates the number of in-flight process instances that have ended during the past day (the blue bar) and the average amount of time (in seconds) these processes take to complete. Below the chart is a table of the same data, including the duration of the work item that is taking the longest to complete. The Oldest Work Item column is added by using in the Computed Columns window. The

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide

127

Caution: This report makes considerable use of scripting and as such is tightly bound to the structure of the data source. For more information on modifying an entity filter. The format of the bar chart can be modified in this report. the report entity is filtered to include only those processes that have ended during the past day. For more information on modifying the bar chart format. please see the procedure in Working with the Process Instances Started in the Last Week report.Work with Precongured JBoss Dashboard computed columns expression reports the maximum duration (in seconds) of a workitem The computed columns window is opened by selecting Object > Computed Columns in the Report Builder window. In addition. and Process-Instance columns are selected in the Entity Fields window. The report entity filter can also be modified. Figure 68. Do not add or remove columns. Duration (seconds). page 125. This report is built on the Process Execution report entity where the Process. please see the procedure in Working with the Process/Activity Instances Summary report. page 111. Sample In-ight Process Overview (24h) report 128 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

Among other things. Update portlet-instances. although this could have been changed during installation.xml file for editing. For more information regarding portlet preferences. When the BAM server is restarted. please refer to: http://docs. Once preferences are modified in portlet-instances.\Server\thirdparty\jboss-4. Update the report name <value> field with the name of the new report. For more information on modifying portlets. It is possible to change the preferences so that a portlet displays the content of a different diagram or report.jboss. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 129 .xml you must locate the old instance and delete it.xml file located in . please refer to Chapter 7. Open the portlet-instances. The procedure below describes how to update portlet preferences and shows how to locate and delete the portlet instance associated with the Instances Started in the Past Week report displayed on the Executive page.4/reference-guide/en/html/xmldescriptors. You must locate the updated portlet instance and delete it.0. To modify a portlet instance to display a different report 1. 5\server\default\deploy\pa-pa. 4.ear\pa-dashboard. 3.war\WEB-INF. the portlet instance is recreated with the new preferences. preferences specify the report or diagram to display within the portlet. Configure Portlet Preferences.. The default port is 8080.Work with Precongured JBoss Dashboard Modify portlet instances to display a different report or diagram Each portlet is configured with a number of preferences.. Save your changes. Each portlet has its own <deployment> tag.xml 5.org/jbportal/v2. These preferences are configured in the portlet-instances. 2. Locate the portlet you want to update.html. Open the JBoss Portal designer by going to: http://<servermachine>:<port>/portal where <servermachine> is the name or IP address of the machine on which the BAM server is installed and <port> is the server HTTP port number. Figure 69.

Navigate through root > Preconfigured Dashboard > Executive. 130 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . 7. 8. Note: It is possible for there to be a difference in names between the name displayed in the tree and the instance name as it appears in the drop down list. 10. 13. Figure 70. 12. Click the Standard Login link. The next time the BAM server is deployed the changes you made in the . This displays the name of the corresponding instance on the right. Enter admin as the login name and password. From the tree select the Instances Started in the Past Week link. Locate the instance you want to delete. Click the Instances link. 9. Click the red ’x’ to delete the portlet instance.Work with Precongured JBoss Dashboard 6. Locate portlet instance 11. Click the Admin tab.xml file are reflected in the dashboard.

ear\pa-dashboard.war\WEB-INF.0. Log back into the preconfigured dashboard.. 2. Restart the BAM server. Open the dashboard-object. To add a new page to the precongured dashboard 1.xml file located under .\Server\thirdparty\jboss-4. The new report is now displayed in the dashboard. 15. Add a new page to the precongured dashboard This section describes how to add new pages to the preconfigured dashboard. Shut down the dashboard and the BAM server.Work with Precongured JBoss Dashboard Figure 71. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 131 . If this change is not made all modifications made to the preconfigured dashboard are lost.xml file and then using the JBoss Portal interface to add new pages and portlet instances. This requires updating the dashboard-object. Replace all instances of <if-exists>overwrite</if-exists> with <if-exists>keep</ if-exists>. 5\server\default\deploy\pa-pa. 16. Delete portlet instance 14..

Click the Standard Login link. 5. 4. 6. The default port is 8080. Enter admin as the login name and password. 132 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Open the JBoss Portal designer by going to: http://<servermachine>:<port>/portal where <servermachine> is the name or IP address of the machine on which the BAM server is installed and <port> is the server HTTP port number. You can now add portlet instances and pages. page 101. For more information. although this could have been changed during installation. page 98 and Adding portlet instances to dashboard.Work with Precongured JBoss Dashboard 3. please see Configuring portlets.

Check that the following dashboard portlets are listed: • • • • 6. On the left select Portlet Management → Portlets. With the portal server running.Chapter 6 Design Dashboard Using WebSphere Portal Once deployed you can begin building a BAM dashboard with WebSphere portal. To build BAM dashboard using WebSphere Portal 1. Click Administration. Alerts Diagram Portlet Instance Monitor Report Portlet Click the Copy button to create a portlet instance. 5. Portlet instances are derived from the four portlets that are shipped with the dashboard. 2. Each page in the dashboard can contain many portlet instances. This displays a list of all available portlets across a number of pages. log in to WebSphere Portal Administration application. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 133 . 3. Portlet instances display a specific diagram or report. 4. Click the Next Page button until you locate the page containing the BAM dashboard portlets. A BAM dashboard consists of portlet instances arranged on a page.

As a naming convention. You do not need to enter anything in the application name field. or process as it’s named in BAM. 8. Click Ok.Design Dashboard Using WebSphere Portal Figure 72. This adds your portlet instance to the list of portlets. 134 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Copy portlet 7. Under Manage Portlets enter a name for the portlet instance (the second field). alert. enter the name of the report.

Begin by clicking Configure portlet.Design Dashboard Using WebSphere Portal Figure 73. you must modify the portlet parameters of each portlet instance. Then. Congure portlet EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 135 . Figure 74. Continue adding as many portlet instances as are necessary. Name portlet instance 9. 10.

Each portlet contains its own set of parameters. please refer to the Design Dashboard Procedures chapter of the Business Activity Monitor User Guide. Continue adding parameter values as appropriate. 16. Log in to WebSphere Portal Administration application and select Portal User Interface → Manage Pages → New Page 136 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . 13. On the next window. 14.Design Dashboard Using WebSphere Portal 11. Enter portlet preferences 12. To enter a parameter value. For a detailed description of preferences for each portlet type. enter a parameter value and click Ok. Figure 75. 15. click Edit parameter. Restart the portal server. Click Ok on the Manage Portlets window once you have entered all parameters. It is now time to add the portlets to a page in the dashboard.

New portal page 17. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 137 . Choose layout and add portlets 20. Click Add portlets. Select a layout on the Edit Layout screen. You can also select a theme and a Navigation type.Design Dashboard Using WebSphere Portal Figure 76. 18. Figure 77. Enter a name for the page and click Ok. Select a portlet and click Ok. 19.

2. 3. Save your changes.Design Dashboard Using WebSphere Portal Figure 78. An incorrect port number prevents all reports. and graphs within the dashboard from being displayed. click Done. charts. Once all portlets are added. 4. Navigate to the server profile on which pa-pa.ear\classes. Verify that the portlet displays data. Open the pa-app-config.ear is deployed and locate <your_profile>\installedApps\Business Process Analyser. In some deployments of the pa-dashboard application the port number within the Websphere profile must be changed. Select portlet 21. To update WC_defaulthost port 1. 5. In Step 4 of the deployment procedure you made note of the WC_defaulthost port number. Search for <portnumber> and enter the WC_defaulthost port number value. You will use this number in the update WC_default port procedure.xml file. 138 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Stop the Websphere application server. 22.

EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 139 . Start the Websphere application server.Design Dashboard Using WebSphere Portal 6.

Design Dashboard Using WebSphere Portal 140 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

status. with associated information such as date. In Documentum BAM. the dashboard is packaged as an EAR file. It contains the basic building blocks — a set of predefined portlets — that are populated in a portal framework.Chapter 7 Congure Portlet Preferences The BAM dashboard is a display environment for monitoring executing processes in real-time. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 141 . This chapter is intended for the dashboard designer and describes how to enter preferences for the four portlets: • • • • Alert portlet — lists outstanding alerts Diagram portlet — displays a view of the process diagram Report portlet — displays report results Instance monitor portlet — provides a list of process instances It is assumed that the dashboard designer is familiar with the portal environment in which the dashboard is developed. Supported portal environments include JBoss Portal. and WebSphere Portal. and the entity on which the alert was generated. Conguring an alert portlet The alert portlet presents a list of alerts. The dashboard designer customizes the dashboard layout as well as the behavior of the portlets by entering portlet preferences. Weblogic Portal. of different severity levels.

Required/Optional Optional height Optional 142 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Alert portlet To congure an alert portlet 1. or Websphere). Enter the alert portlet preferences according to the table below: Parameter width Description The width of the table displaying the alerts measured in pixels. open it for editing. After an alert portlet instance is added to the BAM dashboard. Note: Working with portlet instances and preferences requires you to be familiar with the portal development environment (either JBoss. The height of the table displaying the alerts measured in pixels. WebLogic.Congure Portlet Preferences Figure 79. 2.

If the alert portlet is defined to be part of the same portlet group as the diagram portlet. Optional NoScrollRows Optional 3. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 143 . If no height value is entered. with red being the highest (severity 3). If a user clicks the document icon to the right of the activity he or she is able to choose from among a list of drill-down reports. The color of the alert icon indicates severity. in-process activities are displayed with a dashed border. Completed activities have a solid border. The height parameter takes priority over this value. When assigning other portlets to the same group. and future activities are gray. you must use the same portlet group ID. An alert icon placed to the left of an activity indicates that an alert was triggered. then clicking the alert icon displays a list of alerts for individual activities. Save your changes. Defines the number of rows displayed in the portlet without the need to scroll.Congure Portlet Preferences portletGroupId This can be any value you choose. Conguring a diagram portlet The diagram portlet displays a process map according to parameters specified in the portlet preferences. the NoScrollRows parameter is enforced.

WebLogic. Enter the diagram portlet preferences according to the table below: Preference ParentName Description This represents the parent of ItemName in the process hierarchy. Diagram portlet To congure a diagram portlet 1. Required/ Optional Required width Optional 144 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . the parent of the Prepare Mortgage Loan for Underwriting process is the Mortgage Request deliverable.Congure Portlet Preferences Figure 80. open it for editing. 2. or Websphere). For example. After the diagram portlet instance is added to the BAM dashboard. Width of the diagram measured in pixels. Note: Working with portlet instances and preferences requires you to be familiar with the portal development environment (either JBoss.

The project name is top level of the process hierarchy. Once the Save & Show Report button is clicked. Report portlets are configured by entering preference values in the fields provided.Congure Portlet Preferences ItemName Enter the name of the process diagram you want to display. ACTINS. and aggregation parameters that are specified by the user. graph. the ItemName Prepare Mortgage Loan for Underwriting (at the process level in the process hierarchy) displays all Activities within this particular process. PROINS preferences must also be used. It designates the Portlet Group to which the Portlet belongs. In contrast. It corresponds to a level of the process hierarchy. reports can be included in a group. Display mode shows the report results when the user first enters the dashboard. if the user clicks on an activity. activity. If used the ACT. or activity instance. edit mode displays a number of filter. whereas if she clicks an activity instance. The behavior of the report portlet will reflect the user’s selection in the diagram portlet. The portlet preferences identify the report to be displayed when the dashboard user selects an entity in the diagram. she will see one report. Required height ProjectName Optional Required portletGroupId Optional 3. The dashboard user will be able to select different types of process entities in the diagram: process. The default report portlet view can be set to either display mode or edit mode. For example. Just as with diagrams. process instance. Groups are controlled by the portletGroupID preference. Conguring report portlets This section describes how to configure report portlets. Grouping links report portlet behavior to a diagram portlet. Enter a unique String to specify a Group ID for the Portlet. The name of the project the ItemName value belongs to. Height of the diagram measured in pixels. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 145 . Save your changes. she will see a different report. For example. the report results are displayed. PRO.

Congure Portlet Preferences Figure 81. Report portlet — display mode 146 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

open it for editing.Congure Portlet Preferences Figure 82. Note: Working with portlet instances and preferences requires you to be familiar with the portal development environment (either JBoss. Enter the report portlet preferences according to the table below: EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 147 . WebLogic. After the report portlet instance is added to the BAM dashboard. 2. Report portlet — edit mode To congure a report portlet 1. or Websphere).

Used to specify the report that will be shown if the user selects an activity instance in the diagram portlet. Required Optional 148 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .Congure Portlet Preferences Preference Edit Mode as Default Description This preference controls whether the report portlet automatically opens in edit mode where you can specify any number of filters before the report results are displayed in the portlet Valid values are: true and false (false is the default preference value) Required/ Optional Optional width ACTINS Value indicating the width of the report measured in pixels. This value must be the exact name of the report. This value represents a default filter that is automatically applied to the report results displayed in the portlet. This value must be the exact name of the report. Used to specify the report that will be shown if the user selects an abstract process in the diagram portlet. Optional Required when portlet groups are used type Init Filter Expression Enter reportType into this field. Optional Required when portlet groups are used height PRO Value indicating the height of the report measured in pixels. It is recommended that you use the BAM client to test the filter expression and then paste it into this field.

the admin user is assigned access only to the DocuCorp project. right-click and select Edit. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 149 . This particular BAM database contains many projects that are not appropriate for the admin user. PRO. Required when portlet groups are used ACT Used to specify the report that will be shown if the user selects an abstract activity in the diagram portlet. This value must be the exact name of the report. This includes entering a user name. Then right-click under Selected Report Entities and select Report Properties. The process drop-down list includes only those processes that belong to the project(s) assigned to the user in the BAM client. This value must be the exact name of the report. each new user is provided to access each project. You can copy the name of the report from the BAM Client. Understanding process lters and user access rights User security is applied to reports that contain a Process filter. password. In the example below. Required when portlet groups are not used Leave blank when portlet groups are used since the only possible reports will be of type ACT. you must use the same portlet group ID. 3. By default. and PROINS Optional portletGroupID This can be any value you choose. ACTINS. Required when portlet groups are used repName Enter the name of the report from which this Portlet will retrieve data. Save your changes. The user must first be created in the User Administration window of the BAM client.Congure Portlet Preferences PROINS Used to specify the report that will be shown if the user selects a process instance in the diagram portlet. With the Report Manager window open. When assigning other portlets to the same group. and selecting (or removing) projects from the Project Access tab.

please see Creating BAM and JBoss users. Figure 84. The example below shows the dashboard creation window in JBoss Portal. User administration window The same person must also be defined as a user in the dashboard. It is important that the user be defined with the same user name and password as entered in the BAM client.Congure Portlet Preferences Figure 83. JBoss Portal user administration 150 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . The same approach must be taken with WebLogic and Websphere Portal. For more information on defining a BAM and dashboard user in JBoss. page 93.

all four processes are part of the DocuCorp project. In the example below. If you look at the generic report definition you’ll see the following entity fields: • • • • • • Start Date and Time Process Duration (milliseconds) Process-Instance External Instance ID Status Each entity field represents a column in the instance monitor portlet.Congure Portlet Preferences When a report with a process filter is edited. The generic report is provided out-of-the-box to get you started. The generic report is available within the report manager of the BAM client under BAM Drilldown Reports > Process Monitor. In fact. you can create your own instance monitor provided that you: • • • • save them under BAM Drilldown Reports > Process Monitor category use the Process Execution report entity designate Process (selected in the Entity Fields window) to be the first column in the report designate Process-Instance (selected in the Entity Fields window) to be the second column in the report EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 151 . List of processes for admin user Conguring an instance monitor portlet The instance monitor portlet is populated with data taken from the Generic report that comes shipped with the BAM software. only those processes belonging to the project to which the user has access are listed. Figure 85.

Note: Working with portlet instances and preferences requires you to be familiar with the portal development environment (either JBoss.Congure Portlet Preferences Figure 86. or Websphere). open it for editing. After an instance monitor portlet instance is added to the BAM dashboard. 2. Generic is the default value. Enter the instance monitor portlet preferences according to the table below: Preference ReportName Description Enter the name of the report from which this portlet retrieves data. Instance monitor portlet To congure an instance monitor portlet 1. WebLogic. Required/ Optional Required 152 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

Congure Portlet Preferences processList This is a multi-value parameter where a list of processes can be entered. enter the next process name. the NoScrollRows parameter is enforced. and click the Append button. In Note: For Weblogic Portal you must select the Multi-Value checkbox. Save your changes. and then click the Append button. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 153 . 3. and click Add another value. instance monitor portlet measured in pixels. Enter false (default) to display a process diagram icon. Note: For JBoss Portal. width height Value indicating the width of the instance monitor portlet measured Value indicating the height of the in pixels. Clicking the process diagram icon displays an instance level process diagram. Optional Optional portletGroupId Optional ShowInstanceId Required NoScrollRows Defines the number of rows displayed in the portlet without the need to scroll. This can be any value you choose. To enter another value. enter a value. Enter true to display the instance ID. The height parameter takes priority over this value. When assigning other portlets to the same group. you must enter process names individually. edit the preference. If no height value is entered. you must use the same portlet group ID.

To specify a default sort for the instance monitor portlet: a. Enter either ASEC or DESC in the MonitorSortDefaultOrder field. To specify default sorting for instance monitor and alert portlets 1. 2. Enter a value corresponding to the default sort column in the MonitorSortDefaultColumn field. Note: The first column is value 0. 9. Shut down the BAM server. the second column is 1. Start the BAM server.ear\pa-dashboard. Configuring the date and time format occurs in two files: DashboardProperties. etc.war\WEBINF\classes\com\pa\portlet To specify sorting for WebLogic installations. b. navigate to …\Server\thirdparty\jboss4. users must select whether values in a selected column are displayed in descending or ascending order. Save your changes.0. b.properties and pa-app-config. Both can be changed. 5. Open the DashboardProperties.ear\pa-dashboard.properties file. 8. For sorting. 3.5\server\default\deploy\pa-pa. navigate to …\Server\paprofile\installedApps\BusinessProcessAnalyzer. 4. Enter either ASEC or DESC in the AlertsSortDefaultOrder field. Column sorting is configured in DashboardProperties. the second column is 1.xml. To specify a default sort for the alert portlet: a. Note: The first column is value 0. Date and time data can be displayed in one of 13 formats.Congure Portlet Preferences Specifying default sort and date/time format for instance monitor and alert portlet Users have specific ways in which they want to see columns sorted in the instance monitor and alert portlets. To specify sorting for JBoss installations. To specify sorting for WebSphere installation. navigate to …\Server\pa-domain\applications\pa-dashboard. Enter a value corresponding to the default sort column in the AlertsSortDefaultColumn field.war\WEBINF\classes\com\pa\portlet. Users may also want to see date and time data formatted in a particular way.properties file. etc.ear\dashboard\WEBINF\classes\com\pa\portlet. 7. 6. 154 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

war\WEB-INF\classes\com\pa\portlet. Use the choices below to enter a date and time format in the SimpleDateFormat field.ear\pa-dashboard. 4 Jul 2001 12:08:56 -0700 010704120856-0700 09. Pacific Daylight Time 0:08 PM. 6.\Server\thirdparty\jboss-4. Jul 4.0. war\WEB-INF\classes\com\pa\portlet. a.04. navigate to …\Server\pa-domain\applications\pa-dashboard. To specify a date and time format for JBoss installations. PDT 02001. You must now modify the date and time format in the pa-app-config.. To specify a date and time format for WebSphere installation. To specify a date and time format for WebLogic installations.yy H:mm H:mm:ss:SSS yyyy. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 155 . ”yy h:mm a Hh ’o”clock’ a. 2. navigate to …\Server\pa-profile\installedApps\BusinessProcessAnalyzer.April.MM. Save your changes. ’01 12:08 PM 12 o’clock PM. d MMM yyyy HH:mm:ss Z yyMMddHHmmssZ dd.0. For JBoss installations. Date and Time Pattern yyyy. 5\server\default\deploy\pa-pa.ear\classes.July.xml file.09 AD 06:15 PM 2007-July-26 22:30:22 455 3. Result 2001.ear\dashboard\WEBINF\classes\com\pa\portlet.MMMMM.ear\pa-dashboard. 8. Shut down the BAM server.dd GGG hh:mm aaa yyyy-MMM-dd HH:mm:ss S 7.. MMM d.Congure Portlet Preferences To congure date and time format 1. navigate to …\Server\thirdparty\jboss-4.MM.properties file. z yyyyy. navigate to . 5. Open the DashboardProperties.07.dd G ’at’ HH:mm:ss z EEE.5\server\default\deploy\pa-pa.dd GGG hh:mm aaa EEE. zzzz K:mm a. 4.04 AD 12:08 PM Wed.04 AD at 12:08:56 PDT Wed.MMMMM.98 18:15 18:15:55:624 1998.

k++) { if (String(table[k][X]). For WebLogic installations.) and will allow the designer to create hyperlinks between reports.Congure Portlet Preferences b. Select Object > Table Java Script from the menu. j++) { 156 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .length. 10... j < table[k].ear\pa-dashboard. k++) for(var j = 0. 3. legend. Add the following code: setHyperlink(Y. To add a hyperlink to a specic Table Cell 1. etc.Server\paprofile\installedApps\BusinessProcessAnalyzer. 9. navigate to . "ReportName"). 11.\Server\pa-domain\autodeploy\papa. Save your changes.ear\classes. The scripting language will give much greater control over chart properties (color. navigate to ..length.length.war\WEBINF\classes\ c. Define a report within the Report Builder. In the <SimpleDateFormat> element enter the same date and time format entered in Step 5. k < table. axes. "ReportName"). Open the pa-app-config. X. Users can use a scripting language to customize and enhance reports.. the content of the cell X.equals('CellContens')) setHyperlink(k. 2. 12. } Where X is a column number starting from 0 You can run multiple loops by using: for(var k = 1. k < table. For Websphere installations. Building hyperlinks between reports After a report is defined. Where: Y is a row number starting from 0 X is a column number starting from 0 With this. You can also assign hyperlinks for a cell dynamically: for(var k = 1. X.xml file.Y hyperlinks to "ReportName". Start the BAM server.

Add the following code: Chart1. Select Object > Table Java Script from the menu. Select Object > Table Java Script from the menu. hyperlink.length. X. "ReportName"). 3. j. 2. } To add a hyperlink with lter expression 1.setHyperlink(new java. "Filter-Expression = '" + table[k] [X] + "'").Y. hyperlink).Congure Portlet Preferences if (String(table[k][j]). setHyperlink(k.awt. "PH.equals('CellContens')) setHyperlink(k.Ref('ReportName').W).H. } Where X is a column number starting from 0 To add hyperlink to a dial gauge 1. hyperlink). EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 157 .Ref('ReportName').Process Matches '%'") You also can use it in a loop for multiple hyperlinks: for(var k = 1. k < data. Select Object > Table Java Script from the menu.Y specifies the rectangle (area) starting point H.setParameter("expression". Where: X. 3.Y.g.H. Add the following code: Painter1. "ReportName").setParameter("expression".report. X. Define a report within the Report Builder. 2.W). 2.Hyperlink. setHyperlink(Y.setHyperlink(new java. k++) { hyperlink=new inetsoft. hyperlink.Rectangle(X. Where: Y is a row number X is a column number Filter-Expression is a BPA Filter Expression (e.Hyperlink.Rectangle(X. Define a report within the Report Builder.awt. "ReportName").W specifies the height and width of the rectangle (area) To add a hyperlink to a graph 1. 3. Define a report within the Report Builder.report. Add the following code: hyperlink=new inetsoft. "Filter-Expression").

the Add button disappears. Click the Save Portlet Preference button. Working with drill down reports BAM drill down reports are accessed directly from within a process diagram. 4. 5. 2. Enter a string that identifies the portlet group (like “group1”) in the Preference Value(s) field. They are automatically available within the dashboard as soon as they are defined. It is important that each Portlet Group have a unique name.Congure Portlet Preferences Where: X. Deselect the Multi-Valued checkbox. When the document icon to the right of an activity is selected a list of drill down reports is displayed.Y specifies the rectangle (area) starting point H. one of which is Activity Reports.W specifies the height and width of the rectangle (area) Working with portlet groups in Weblogic Portal There are specific settings you must apply when using portlet groups in Weblogic Portal. Drill down reports are opened by clicking on the report name. 3. To use portlet groups in Weblogic Portal 1. Leave the Is Modifiable checkbox selected. 158 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Drill down reports do not require any configuration. The BAM Drilldown Reports category contains sub-categories. Drill down reports are defined in the Report Builder window of the BAM client and must be saved within the BAM Drilldown Reports category. Each report defined under the Activity Reports category is available when the dashboard user clicks an activity in the diagram portlet. Press the Edit button to the right of the portletGroupId. When it is deselected.

which displays a view of the process diagram Report Portlet. we digress for a moment to discuss the notion of a Portlet Group. These portlets allow the Dashboard user to view and interact with process execution data.Chapter 8 Dashboard User Procedures The Dashboard is a display environment for monitoring process execution in real-time. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 159 . It describes the Dashboard portlets and their behavior. suppose we want to know the duration of a process instance. One way to do this is to use two portlets as shown below. For example. which shows either a BAM report or a BPA report Instance Monitor Portlet. which provides a list of process instances Before we look in detail at these portlets. This document is intended for the Dashboard user. It contains the basic building blocks—a set of pre-defined portlets—that can be displayed in a portal framework. Portlet Groups The behavior of one portlet can be made to depend on another portlet. which lists outstanding alerts Diagram Portlet. Portlet Groups enable the synchronization of multiple portlets. The Dashboard offers the following pre-built portlets: • • • • Alert Portlet.

Alert Portlet The Alert Portlet presents a list of alerts. Any number of portlets can be placed in the same Portlet Group. the Dial Gauge will change accordingly. Then the duration of the process instance will be displayed in the second portlet (a "Dial Gauge"). Now select a different process instance in the Instance Monitor. Two Portlets within a Portlet Group Select a process instance from the first portlet (an "Instance Monitor"). of different severity levels. with associated information such as date. and the entity on which the alert was generated. For example. These two portlets are chained together because they belong to the same Portlet Group. 160 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . we could have created another Dial Gauge portlet that would measure the cost of the process instance. status.Dashboard User Procedures Figure 87.

For example. When an alert is defined. closed. if the dashboard user now selects a process instance. the Above Severity dropdown. For example.Dashboard User Procedures Figure 88. clicking the Date header sorts the rows by date. Filter Options: Users can filter the list using the Status dropdown. These users receive the alert and are responsible for responding to it. In addition. Tool Tip for Notes: If Notes have been defined for an Alert. To see all alerts press the Show All button in the upper right corner. it is associated with a group of users. Clicking the Status header sorts the table according to whether the Alert is new. A user can belong to one or to multiple alert groups. it will normally display only those alerts that pertain to the Portlet Group. or acknowledged. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 161 . the user can view the text by placing the mouse pointer over the Edit icon. you could see the alarms generated today by entering today’s date into the Date field. the list of alerts will be filtered to that instance. Note: Important Note: If the Alert Portlet is defined as part of a Portlet Group. Example Alert Portlet Feature Overview Show All Button: Displays all alerts for the alert group(s) in which the user is a member. or by entering a value into the Date field. Sorting: The table can be sorted by clicking the column headers.

An alert icon is placed to the left of Activities to indicating an alert was triggered for the associated Activity. 3. If a user clicks the document icon to the right of the Activity he or she are able to choose from among a list of drill down reports. The middle icon is the Edit icon which allows the user to add a note to the alert and choose a status. The following commands are available when editing: 1. Add Note: Creates a new line in the note text area and inserts the following text <user name> <date>. orange. and future Activities are gray. The color of the alert icon indicates severity. Alert View: Returns user to the list of alerts without saving the note. Completed activities are bordered with a solid black line. The third icon is the Instance icon. 2. Diagram Portlet The Diagram Portlet displays a process map according to parameters specified in the portlet preferences. 162 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . or yellow.Dashboard User Procedures Working with Alerts On the left hand side of the Portlet are three columns of icons. The first icon. then clicking the alert icon displays a list of alerts for individual Activities. If the Alert Portlet is defined to be part of the same Portlet Group as the Diagram Portlet. Save: Saves changes and returns user to the list of alerts. indicates the severity level of the alert. 4. Restore Note: Removes all new notes from the Notes field. colored either red. Clicking it will display a diagram of the process instance. with red being the highest (Severity 3). Activities in process are displayed with a dashed border.

It presents a list of reports from which the user can choose.Dashboard User Procedures Figure 89. if the user clicks "Activity Details. These reports provide additional information on the activity (or activity instance). Activity Multiplicity In some processes an activity could be performed multiple times. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 163 . a drilldown window opens. These numbers represents the Activity Multiplicity. touch time. resources. Example Diagram Portlet Drilldown Reports If the user clicks an activity in the Diagram Portlet. For example. This list of reports can be customized by the dashboard designer to meet the needs of the business. for example." then a report will appear that shows the activity owner. the number of times each Activity has been performed in the process instance. Note that the numbers are displayed only when activities are performed more than once. that is. etc. Notes. If you look closely at a Diagram Portlet for such a process. you may notice numbers in the upper left hand corner of each activity rectangle. if it is part of a loop.

Clicking the alarm icon (Process Alert) filters the alert list to show only alerts for the specific process instance under consideration. Working with dashboard reports BAM reports are defined in the BAM client and displayed in the dashboard. the report size. 2. In the upper left corner of this portlet you will see an alarm icon and to the left of it. and summary data settings. Each report contains a unique set of filter criteria. click Reset Settings. To revert filter settings to their default value. This version includes an alert indicator on the process itself and allows users to drill down to process reports to understand the nature of the alert. To edit report lter 1. 4. others contain bar charts and pie charts. Report data is refreshed by clicking the Refresh button. Clicking the report icon (Process Drilldown) opens a dialog window showing all available process-level reports. This displays the report results. 5.Dashboard User Procedures Process Alert and Drill Down Alerts can be defined for a process rather than individual activities. There is even a special type of report called a dial gauge. Reports come in all shapes and sizes. 164 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . a report icon. you do not know if there is a process-level alert. if you look at a diagram in the dashboard. Some contain just rows and columns. The reports in the drilldown list are defined in the Report Manager under the category BAM Drill Down. or summary data settings. Select a filter (or filters). report size. Click Save. The report can be exported to a number of formats. 3. make the selection under General Settings. However. the user is only presented with a list of processes that belong to the project to which the user is assigned access within the BAM client. Dashboard users have the option of filtering the data displayed in a report. Editing a report also includes modifying graphs. Click edit (the pencil icon in the upper right corner of the report). To modify a graph (if applicable). If the report contains a Process filter. Reports that span multiple pages include navigation arrows.

such as the start and finish time of each instance. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 165 . Example Report Portlet Instance Monitor Portlet The Instance Monitor displays instances of each process.Dashboard User Procedures Figure 90. together with relevant information. The dashboard designer can configure a specific subset of abstract processes that will be displayed in the Instance Monitor.

166 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .Dashboard User Procedures Figure 91. Example Instance Monitor Portlet Feature Overview Apply Filter: You can filter the list of process instances either by the name of the abstract process or by the date of the instance. Reset: Press this button to undo the filter and return the list to its original state. Show All: Press this button to list all process instances. Instance: If you press the Instance icon a process map of the instance will be displayed in a Diagram Portlet (assuming that a Portlet Group has been defined).

including: Deployment Architecture It is essential that the BAM database be backed up on a regular basis since it contains important enterprise process data. it is meant to serve as a general reference document. The database can be duplicated as a whole or per process (using manual PAPX transfers). the database should be duplicated again.Chapter 9 Deployment Procedures Documentum Business Activity Monitor (BAM) provides capabilities to monitor business processes executing in the Process Builder. This document describes procedures required to deploy BAM in a production environment. This document does not include step-by-step instructions. This document is intended for: • • • • • IT Technical Staff Database Administrators BAM Administrators WebLogic Server WebLogic Portal This document assumes that the reader has expertise in BEA’s WebLogic Platform. we recommend that the database be duplicated. Before developing a Process Builder application. Once you move to application testing and production. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 167 .

To change BAM to a Basic domain you should complete the following steps: Windows 1.Deployment Procedures Figure 92.cmd script located in the following folder: <BAM Installation Folder>\Server\templates 168 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . In most production environments. The BAM Deployment Architecture Deploying BAM in a Basic WebLogic Server Domain A standard BAM installation automatically deploys a complete WebLogic Platform domain. it is essential to change the BAM domain to a standard domain. For Process Analyzer licenses the domain should be a “Basic” WebLogic Server domain. For production installations of BAM it is recommended that WebLogic Portal is installed on a different domain. Execute the cleanupDomain. This separates the execution and monitoring environments which eliminates intrusions.

Please follow the specific backup and recovery instructions provided by your RDBMS vendor.cmd script remove the following commands: • assign all Applications to Target "pa-server" • assign all Services to Target "pa-server". Within the createDomain.cmd script.xml.cmd script change the reference to the template file pa-wlsWithRole. /repository. Within the createDomain. Once all changes have been made.jar. It is important that you follow the guidelines established for your specific database during the installation. Modify the WebLogic Domain creation script by navigating to <BAM Installation Folder>\Server\templates.jar instead of pa-platformWithRole.sh script remove the following commands: • assign all Applications to Target pa-server • assign all Services to Target pa-server 3. Within the createDomain.sh script change the reference to the template file pa-wlsWithRole. Execute the cleanupDomain.properties 2. /sree. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 169 . 3. execute the createDomain. execute the createDomain.properties 2.Deployment Procedures This command deletes all domain files from the domain root except the following specific BAM folders and files: /applications. Modify the WebLogic Domain creation script by navigating <BAM Installation Folder>\Server\templates. The BAM Database The BAM installation supports a number of databases.jar. /repository. Linux and Solaris 1.sh script located in the following folder: <BAM Installation Folder>/Server/templates This command deletes all domain files from the domain root except the following specific BAM folders and files: /applications. Once all changes have been made. /sree.sh script.xml.jar instead of pa-platformWithRole. Within the createDomain.

then: 23MB * 365 = 8 Gig Multiply by 1.2 for indexes 4. Multiply by the number of days that you wish to save instance data. 3. For Character values. please allow for 150 MB of database space per 10.2 for aggregation data and alerts Multiply by 1. 6. use an average size value. then the total required database space is: 8Gig * 1.44 for aggregation and index space. 5. Multiply by 1. Example The daily data volume in a system is as follows: • • • 10. Activity instances per day − Average Record size = 100 Bytes Process instances per day − Average Record size = 200 Bytes For each data collection point. BAM Database Sizing The BAM database size depends on the following parameters: 1.Deployment Procedures Business Process Analysis Database Sizing For a BPA only database. For numerical values. To calculate the required daily database size: 10000*200 + 150000*100 + (((3*20) + (4*20))*5)*10000 = ~23 MB If instance data is saved for 1 year. The average string length is 20 characters.000 Activity instances 5 data collection points. 2. collecting XML data with the following fields: 3 Numbers and 4 Strings. use 20 bytes. calculate size of record (According to data types) and instances per day.000 Process instances 150.44 =~ 12 Gig 170 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .000 Activities in the system.

protocol=smtp. Install BAM.sybase.smtp. you should replace pa-server with your server name.host=[Enter SMTP host address]" Targets="pa-server"/> 3.jdbc2.debug= false.databaseName=ProAct?JCONNECT_VERSION=6.url=jdbc:sybase:Tds:localhost:2638/ProAct?JCONNECT_ VERSION=6.xml File Add the following to the config.SybDriver" Name="pa-default-pool" Password="proact" Properties="user= ProAct.xml file within your domain.serverName=localhost" Targets="pa-server" TestConnectionsOnReserve="true" TestTableName="version" URL="jdbc:sybase:Tds:localhost:2638/ProAct?JCONNECT_VERSION=6"/> <JDBCTxDataSource JNDIName="DBPool" Name="ProActivity Data Source" PoolName="pa-default-pool" Targets="pa-server"/> <JMSConnectionFactory JNDIName="ConnectionFactory" Name="ProActivity JMS Connection Factory" Notes="Used by BAM" Targets="pa-server"/> <JMSServer Name="ProActivtyJMSServer" Notes="ProActivty JMS Server used by BAM" Targets="pa-server"> <JMSTopic JNDIName="BAMRefresh" Name="ProActivtyRefreshJMSTopic" Notes="ProActivty JMS Topic used by BAM to refresh information"/> <JMSTopic JNDIName="BAMAlerts" Name="ProActivtyAlertsJMSTopic" Notes="ProActivty JMS Topic used by BAM to invoke web-services"/> </JMSServer> <MailSession JNDIName="PAMail" Name="ProActivity Mail" Notes="ProActivity Mail Session" Properties="mail. you will not be able to move the software to a different folder at a later time.mail.portNumber=2638. For each Targets attribute. Complete a standard installation of BAM. Copy Files EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 171 . Modify Your Domain config.transport.Deployment Procedures Deploying BAM in an Existing WebLogic Domain Complete the following steps if BAM must be installed on an existing WebLogic Server domain. 2.from=[Enter Mail address From]. 1.userName= ProAct. <JDBCConnectionPool DriverName="com. Please note that the installation location is not transferable.jdbc.mail.mail.networkProtocol=Tds.

including BAM specific parameters.ear and pa-dashboard. a shared file system for an instance is not required. Launch the BAM Client to Test Deployment Clustering For better performance and fail over support. The procedure outlined below contains all steps required to deploy BAM in a clustered environment. it is used solely for BAM. Start your WebLogic Domain Add Security Roles Add the following Roles and Groups.Role reference: PA_Administration • PaProcessPortalUsers .Deployment Procedures Copy the following 2 files from <BAM Installation Directory>\Server\pa-domain to the domain root folder: • sree.Role reference: PBAMUsers 6. Deploy BAM Applications Deploy pa-pa. The extracted . JMS support is not required in a BPA only domain.xml 4. In a clustered deployment. all persistent data is saved in the database and as a result.com/wls/docs81/cluster/index.ear within your platform using WebLogic Console.bea. Global Roles: • PaProcessPortal • PA_Administration • PBAMUsers Groups: • Administrators (A default Group) . 5.html 172 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . For complete WebLogic cluster documentation.properties • repository.Role reference: PaProcessPortal • PA_Administrators .Role reference: PA_Administration • PBAMUsers . please see: http://edocs. BAM allows for clustered deployment. It is assumed that you know how to create clusters in WebLogic.ear files are located in: <BAM Installation Directory>\Server\pa-domain\applications 7.

[Server Name/Ip address]:8021 Example Cluster Address qa10:8011.cmd node2 http://[Server Name/Ip address]:7001 Balancer: Name: balancer Port: 8031 Host: Server Name Start up command line for this node: startManagedWebLogic. node 2. Select Yes on the Managed Servers. Clusters. 6. Configure the Administration Server according to the parameters below: Name: paAdmin Port: 7001 Host: [Server Name]/Ip address 5.Deployment Procedures Using the Configuration Wizard: 1. 3.cmd node1 http://[Server Name/Ip address]:7001 Node 2: Name: node2 Port: 8021 Host: Server Name Start up command line for this node: startManagedWebLogic.111 Multicast port: 9011 (verify the port isn’t used) Cluster address: [Server Name/Ip address]:8011. Configure Clusters. 4. Begin by creating a new WebLogic Configuration. 2. select the next Servers in the cluster: node 1. Within the Assign Servers to Clusters window. Then. and Machine Options window. Select Custom configuration.0. qa10:8021 8. select Basic WebLogic Platform Domain. Node 1: Name: node1 Port: 8011 Host: Server Name Start up command line for this node: startManagedWebLogic.0. Configure the Managed Server. Example Structure Cluster: Name: clusterA Multicast address: 237.cmd balancer http://[Server Name/Ip address]:7001 7. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 173 .

Select Yes within the Messaging (JMS) Options window. 10. 18. Configure the JDBC connection pools. Assign Servers to the machine. and password The defaultPool. 15. 13. user name. • Create JDBCConnectionPool Name "pa-default-pool" as the defaultPool • Set the Driver to the relevant Oracle driver • Enter the database details. Define the JMS connection name and enter ConnectionFactory as the JNDI name. 14. Perform the following within the Configure JDBC Data Sources window: • Insert JDBC Data Source Name • The JNDI name must be DBPool • Select pa-default-pool as Pool name 16. 19. Select Yes on the JDBC Options window.URL will update according to the parameters entered. Select the Create HTTP Proxy checkbox and select balancer from the pull-down menu. 17. WebLogic Server Cluster parameters Name Machine_1 Machine_2 Machine_3 Address localhost localhost localhost Listen Port 5555 6666 7777 11. Accept the default and click Next on the following screens: • JMS Destination Key(s) 174 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Table 3. You must verify the Node manager Listen ports aren’t used. Click Next on the Configure JDBC Multipools window. It should be successful. Enter the following parameters in the Configure Machines window.Deployment Procedures 9. In the case of an Oracle database. you must add a new connction. Test the pa-default-pool connection. node1 to Machine_1 node2 to Machine_2 paAdmin to Machine_3 balancer to Machine_3 12.

Accept the default and click Next on the following screens: • Configure JMS Queues • Configure JMS Distributed Topics • Configure JMS Distributed Queues • Assign JMS Distributed Destinations to Servers or Clusters • Configure JMS Distributed Topics Members • Configure JMS Distributed Queues Members 24. These can also be added via the Console screen. click Next. 27. 32. Create a Server within the Configure JMS Servers window. You can also assign a Group to another Group. Then. Click the Group tab to add Groups. 29. 26. JDNI Name: BAMRefresh • Name: ProActivtyAlertsJMSTopic. Accepts the default values on the next two windows. 21. Within the Console. 35. Enter (or use the default) username name and password. Use the Console to deploy the BAM application. 22. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 175 . select Target Application. Select the Server tab and enter the following: • Name: ProActivtyRefreshJMSTopic. Next. select Yes. On the Groups and Global Roles window. On the Targeting Options window. 37. navigate to and select the application. Assign the New Server to a WebLogic Server. Run WebLogic Administrator Server. Select the appropriate Mode and SDK for your target environment. Accept the suggested default values on the next two windows. Enter a platform name in the Configuration Name field and click Create. From here you can assign Users to Groups. if not already chosen. Then. you will assign roles to Users and Groups. 33. 31. 28. 36. 25. you can add Users or Groups.Deployment Procedures • Configure JMS Template(s) • Configure JMS File Stores • Configure JMS JDBC Stores 20. JDNI Name: BAMAlerts 23. select the Yes radio button. 30. Then. 34.

Within the Data Sources folder on the left. Configuring Process Builder (Use Case 1 only) Configuring BAM (Use Case 1 only) Moving Business Process definitions and mappings to Process Builder Moving Business Objects and Execution tables Moving Report Entities and Filters Moving Report and Alert Definitions The BAM Administrator is primarily responsible for: • • • • • • 176 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . When the Server has started. This action checks the connection between the BAM Client and the Server. open the BAM Data Source. 43. Verify it’s targeted to ClusterA. open BAM JMS Connection Factory. Moving from Development to Production The following section describes how to move a fully configured BAM solution from a development/staging environment to a production environment. select pa-default-pool (located under Connection Pools). 47. Restart the Weblogic Administrator Server. Verify that it is targeted to ClusterA. and incremental updates need to be moved from development. Select the clusterA checkbox and click Continue. localhost (or server name):8021. Launch the BAM Client. Use Case 2: BAM is already running in production. Within the Connection Factories folder on the left. Click the Deploy button. Within the tree structure on the left. Enter the User Name and Password. 44. and Node 2 (in order). 45. 41. Within the Logon window. run Node 1. 42.Deployment Procedures 38. Click Ok. balancer. click the Connection button and enter the Server URL: t3://localhost (or server name):8011. Verify that it is targeted to ClusterA. 40. These procedures should be performed by the BAM Administrator. 46. 39. Moving from a development environment to a production environment involves two different use cases: • • Use Case 1: BAM is moving to production for the first time.

BAM Database Connection Conguration Responsible: Weblogic Administrator and DBA EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 177 . This deletes all related execution tables. Run the cleanExecutionTables.sql script against the database. All unnecessary data needs to be removed. 3. Import the database into the production environment. Note: Your development cycles may be configured differently. This script removes all test data from the BAM execution tables and prepares them for production. In either case you must remove unnecessary data before moving the database to production. 1. Use the BAM Client to remove all unused Projects and Processes from the Process Hierarchy. Backup the BAM database. This document assumes that a staging environment is not being used. then you must remove the business data entity from the report prior to disabling monitoring. The script is located in the Utility Scripts folder of the database .Deployment Procedures Use Case 1: BAM Moves into Production (rst time) In this use case. Export the database. and production environments. right-click on an assigned Business Object. The report definitions can then be exported to . Use the BAM Client to remove all unused business data execution tables.xml and restored later. You might use development. 6. the BAM database is populated with test execution data. executes several ‘clean up’ scripts. select the Business Object tab. 2.zip file. filters. and modifies a few configuration settings. staging. It is the DBA’s responsibility to determine which execution tables are unused. and select Disable Monitoring. Within the Input/Output Properties window. and all reports using these entities. Database Clean Up Responsible: DBA and BAM Administrator During the development phase. 5. 4. Note: If you want to keep the report definitions that use business data entities. while others just use a development and production environment. report entities. the BAM Server accesses the BAM development environment.

This creates the process and maintains all mappings. The export includes the process definition. Dene Execution Tables Responsible: BAM Administrator You must then define all business data execution tables within the production environment. and Business Object assignments (including the XPATH expression). Business Object definitions. Move Business Process Denition and Mapping Responsible: BAM Administrator Your first step in configuring a new process in production is to export the process from the development environment. This is required. if BAM is currently monitoring two processes and a third monitored process must be added to production. for instance. This is done by activating monitoring (via Monitor Business-Object) within the Business Object tab of the Input/Output Properties window. Audit Trail Conguration Responsible: BAM Administrator and DBA Reset the parameters in the Process Builder Export Agent to point to the new database. 178 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . The instructions below guide you in this particular use case. If the Monitor Business-Object option is disabled it is because the Business Object is already being monitored. you must use Weblogic Console to point the BAM Server to the correct database. Use Case 2: BAM Production Environment is Running In this use case you move only some of the elements from the development environment into the production environment.Deployment Procedures Once the ‘cleaned up’ database is imported into production. Activating monitoring creates related execution and aggregation tables in the BAM database. You must then import the PAPX file into the production environment. Descriptions of other scenarios can be found in the Maintenance Procedures section of this document.

Move Report and Alerts Responsible: BAM Administrator 1. You may create a new category if it does not exist. Open the BAM Client in the development environment. Within the Report Manager. You must import alerts into the Alerts category. already exists in production and has the same structure as defined in the development environment. Right-click the category into which you want to import the report and/or alert and select Import report definition. The report definition and all filters are saved within an . 4. right-click each report and/or alert you want to export and select Export report definition.Deployment Procedures Note: This section assumes that the Business Object of the new process either does not yet exist in production. 3. 2.xml file. Open the BAM Client in the production environment. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 179 . OR.

Deployment Procedures 180 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide .

The synchronization automatically adds the Business Object Field column to the Data Object table. None of the procedures outlined below require that you disable Business Object monitoring. Business Objects and Data Objects have corresponding tables in BAM. and creates the filter and index. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 181 . Once the field is added. the user must: • • • enter the XPath Expression specify whether filter entities and indexes should be created select the Business Object usage within the Input tab of the Activity Properties window All changes must be saved. Business Object Fields are represented as columns within a Data Object table that store business data values passed from the Process Builder Export Engine. Business Object Changes There are a few use cases for managing changes in a monitored Business Object.Chapter 10 Maintenance Procedures The sections to follow describe how to maintain a BAM production environment if there is a Business Object structure change or a change to the aggregation settings. Add a Business Object Field Business Object Fields can be added manually while the Business Object is monitored. and then the user must right-click the Business Object and select Synchronize BO Definition with BAM. adds the field to the Business Object reporting entity. Different use cases call for different procedures.

This commits the changes to the database. Business Object Field Aggregation 182 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Aggregation formulas are specified in the Business Object Definition window. the user must save the changes and then right-click the Business Object and select Synchronize BO Definition with BAM. as well). The delete operation only removes the Business Object Field from the user interface. However. Delete a Business Object Field It is possible to delete a Business Object Field from the Business Object Definition window. These tables continue to hold Business Object Field data and can still be used in reports (reporting entities remain unchanged. Aggregation Change This section addresses how to handle Business Object Field aggregation formula changes. Once these changes are made within the Business Object Definition window.Maintenance Procedures Modify a Business Object Field Monitored Business Objects Fields can only be modified with respect to its filter and index settings within the UDA tab. Figure 93. all associated business data stored in the database remains.

and reports that reference these entities. Table 4. the aggregation engine aggregates loan amount by region. a DBA needs to remove/add the column from/to the index. report entities. (within the Business Object Assignment window) the operation deletes all related execution tables. Multiple fields can be grouped. the following rows are created in the aggregation tables. Whenever the aggregation formula changes (adding or removing the group field). the index is created on region). Table 5. Business Data Aggregation Start Time 1:00 1:00 1:05 1:05 End Time 1:05 1:05 1:10 1:10 LoanAmount 75 65 45 30 Region NY NJ NY NJ When monitoring is activated for a Business Object an index is created on the aggregation execution tables for all fields that are grouped (in the example above. EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 183 . Process Instances with Business Data Time 1:00 1:01 1:02 1:02 1:04 1:05 1:06 1:07 1:07 loanAmount 20 30 25 10 30 25 20 30 25 region NY NJ NY NJ NY NJ NY NJ NY When applied to the data above.Maintenance Procedures In the example above. Export Report and Alerts Denition When Business Object monitoring is disabled.

along with all report definitions. you must add a new diagram portlet to the dashboard where the ItemName preference reflects the new name of the old process. This requires that the new version be opened into a deliverable and configured as if it were a new process. 1. Working with process versions There may be situations when two different versions of a business process are deployed and running simultaneously in Process Builder.Maintenance Procedures There are some cases when the User wants to disable monitoring. In the example below. 4. Process data from the original process is kept. Select the deliverable level of the hierarchy. Any deliverable can be used. 184 EMC Documentum Business Activity Monitor Version 6 SP1 User Guide . Select File > Open Process from Developer from the menu. 3.xml file. If the new process has a lower version number than the original process then the version number is added to the newly imported process. Process version numbers automatically populate the Process Version user defined attribute. and enable monitoring again. This keeps data from the original process and the new process separate. the import procedure adds the version number to the name of the original process. 2. Disable monitoring and make the required changes to the Business Object. the new Claim Process must be activated by selecting BAM process monitoring. Caution: If you must still monitor data from the old process while the new process is running. right-click the report/alert you want to export and select Export report definition. The original process continues to be monitored.xml file and then imported back into BAM once the Business Object structure is modified and monitoring is re-activated. Import the reports into a selected category (create the category if it does not exist). Within the Report Manager. it can first be exported as an . This is typically done during proof of concepts in a development environment. Import the alerts into the Alerts category. Click the Select Process button. Instead of losing the report definition. To import and monitor a new process version 1. modify the structure of the Business Object. The new version is not annotated with a version number. Do not merge updates from the new process with a preexisting process. 2. If the new process is a higher version. The newly imported process must have monitoring activated. 3. and you want to monitor both. Save the .

Process version naming convention To review process version user dened attribute 1.Maintenance Procedures 4. Figure 95. 3. Click the UDA tab. 4. Right-click the process and select BAM process monitoring. Figure 94. Review the version number in the ProcessVersion field. 5. Reviewing process version number in UDA EMC Documentum Business Activity Monitor Version 6 SP1 User Guide 185 . Select the process and click Ok. The new process is imported into the hierarchy. Select Object > Properties from the menu. Select the process. 2.