IBM Cognos 8 Business Intelligence Metric Studio Version 8.4.1 User Guide Product Information This document applies to IBM Cognos 8 Version 8.4.1 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Information Centers (http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/index.jsp). Copyright Licensed Materials - Property of IBM © Copyright IBM Corp. 2005, 2009. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM, the IBM logo, ibm.com, and Cognos are trademarks or registered trademarks of International Business Machines Corp., in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at www.ibm.com/legal/copytrade.shtml. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Table of Contents Introduction 9 Chapter 1: What’s New? 11 New Features in Version 8.4 11 New Portlets 11 Add Comments to Strategy Elements 11 New Features in Version 8.3 11 New Portlets 11 Add Actions to Impact Diagrams 12 Specify a Derived Index for a Metric Type 12 Multi-format User-defined Columns 12 Changed Features in Version 8.3 12 Strategy Management 12 More Insightful Impact Diagrams 13 Reporting Improvements 13 Chapter 2: Performance Management with Metric Studio 15 Scorecards 15 Metric Types 16 Metrics 16 Strategies 17 Scorecarding Models 17 Franchise Model 17 Functional Model 19 Balanced Model 20 Building IBM Cognos 8 Applications 21 The Great Outdoors Company Samples 22 Chapter 3: Planning Your Scorecarding Environment 23 Choosing Data Sources 24 Choosing How to Load Data into Metric Studio 24 Configuration and Customization Workflow 25 Chapter 4: Creating a Metric Studio Application 27 Create a Metric Store 27 Metric Package 27 Business Calendar 27 Standard Calendar 28 Manufacturing Calendar 29 Custom Calendar 29 Create a Metric Package 31 View the Business Calendar Settings 31 Score Calculations 32 Change Tolerance-based Score Calculations 34 Licensed Materials – Property of IBM © Copyright IBM Corp. 2005, 2009. 3 Table of Contents Chapter 5: Importing and Exporting Data 37 Specify Import Settings 37 Define an Import Source 38 Increase Security When Loading Data into a SQL Server 43 Specify Load and Data Calculation Options 43 Re-creating an Application 44 Loading Data into Staging Tables 44 Handling Rejected Data 45 Import Previously Rejected Data 47 Load Data from Staging Tables into the Metric Store 47 Exporting Data from the Metric Store 47 Scheduling Imports and Exports 48 Upgrading Tab-delimited Files 48 Chapter 6: Preparing Data for Staging 51 Tab-delimited Files 51 Object Loading Order 52 Updating the Scorecard Environment Using Tab-delimited Files 53 Adding an Import Source, Creating a Custom Calendar, and Setting Security Permissions 54 Creating a Scorecard and Adding a Metric to a Scorecard 56 Creating Metric Types and Metrics 57 Creating Strategies and Strategy Elements 60 Creating Diagrams 61 Adding Reports 62 Chapter 7: Creating Scorecard Structures in Metric Studio 65 Create a Scorecard 65 Create a Metric Type 66 Create a Metric 71 Create a Derived Index Metric 74 Create a Qualifier 75 Add Metric Shortcuts to a Scorecard 75 Viewing and Modifying Metrics and Scorecards 76 Add Reports in Metric Studio 76 Change the Properties of an IBM Cognos 8 Report 79 Report Parameters 79 Custom Parameters 82 Specify How Prompt Values Are Inserted for an IBM Cognos 8 Report 82 Modify an IBM Cognos 8 Report 83 Organizing Metrics by Strategy 84 Create a Strategy 84 Create a Strategy Element 85 Add Metrics to a Strategy Element 87 Add Comments to a Strategy Element 87 Add Projects to a Strategy Element 88 Diagrams 88 Modify an Impact Diagram 90 Create a Custom Diagram 91 Add a Custom Diagram to a Scorecard, Metric Type, or Metric 92 4 Metric Studio Table of Contents Add or Delete a Metric from a Diagram 93 Create a Background Image File 94 Chapter 8: Security and Permissions 95 Redefine Owner Permissions 96 Set Explicit Permissions for a Scorecard, Metric Type, Metric, Strategy, or Strategy Element 96 Specify the Metric Store Administrator 97 Chapter 9: Customizing the User Experience 99 Status Indicators 99 Set the Number of Status Indicators 101 Specify the Type of Status Indicators 101 Add New Status Indicator Graphics 101 Set Background Color for Status of Strategy Element 102 Change Trend Calculation 102 Specify a Custom Unit of Measurement 103 Specify Custom Columns That Will Be Available to Users 103 Change the Destination of a Link 105 Change the Format of Metric Names 105 Change the Time Span of the Metric Store 105 Specify the Default Display Settings for History Charts 106 Specify Calendar Labels 107 Tokens to Create Time Periods 108 Syntax 110 Change User Interface Strings 112 Language Translation 112 Translate a Single Text Field 112 Translating Multiple Text Fields 113 Chapter 10: Analysis Reports 115 The Framework Manager Model 115 Scorecard Star Schema 117 Projects Star Schema 118 Project Comments Star Schema 120 Metrics Star Schema 120 Metric Comments Star Schema 121 Actions Star Schema 122 Action Comments Star Schema 123 Impacting Metrics Star Schema 123 Strategies Star Schema 124 Analysis Reports 125 Default Analysis Reports 125 Custom Analysis Reports 126 Working with the Model 127 Presentation View 127 Model View 128 Source View 128 Metric Functions 128 Compatibility Folder 129 The Linked Reports Query Subject 129 User Guide 5 Table of Contents Guidelines for Reporting 130 Chapter 11: Monitoring Performance 133 Set the Home Page for Metric Studio 134 Determine the Diagram Identifier 134 Watch List 134 Add a Metric to the Watch List 134 Add Email Notification for a Metric 135 Delete a Metric from the Watch List 135 Specify Email Notification Conditions for the Watch List 135 Choose the Period to Monitor 136 Metric Analysis 137 Metrics on a Scorecard 138 History Charts 139 Metric Impacts 140 Diagrams 140 Reports 142 Printing Metric Information 142 Improving the Performance of a Metric 143 Add a Comment 143 Create an Action 143 Update an Action 144 Tracking Projects 144 Create a Project 144 Update the Project Status 146 Add a Task to a Project 146 Update the Task Status 148 Reorder Projects on a Scorecard 148 Reorder Tasks for a Project 149 Updating Metric Values 149 Update a Metric Value 149 Update Multiple Metric Values on a Scorecard 150 Appendix A: Troubleshooting 151 Metric Studio Log Files 151 Metric Studio Support Bundle 151 Metric Studio Reports Fail Because of an Oracle Internal Error 152 Metric Studio Errors Occur When Loading Data into an Oracle Database 153 Oracle Errors Occur When Using the cmm_uninstall Script 153 Error When Attempting to Run Metric Studio on SQL Server 2005 153 Data from a Relational Database Source or a Flat File Data Source Does Not Appear 154 A Metric Maintenance Task Fails to Run 155 You Do Not Have Permission to Access This Metric Package. Contact Your System Adminis- trator. 155 Failed to Check the Metrics Store Install Status Error When Using DB2 8.2.3 155 Errors Occur When Importing Tab-delimited Files into a DB2 Metric Store 156 Required User Permissions for the Metric Store Database (MS SQL Server) 156 Error When Viewing a History Chart or Diagram on a DB2 Server with the 8.2 JDBC Driver 156 Oracle 9.2 Package Initialization Error if NLS_LANG Environment Variable is Not Set Appropriately Before Starting Up IBM Cognos 8 Tomcat Server 156 6 Metric Studio Table of Contents Appendix B: Tab-delimited Files 159 Object Stage File (.cmo) 160 Metric Type Stage File (.cmm) 168 Object Link Stage File (.cml) 177 Value Stage File (.cmv) 180 Stage Diagram File (.cdo) 184 Stage Object Note File (.cmn) 190 Stage Custom Parameters File (.cmp) 192 Time Periods Stage File (.cal) 194 Stage Policy File (.cms) 195 Import Source Currency Stage File (.ccm) 198 Import Source Reportlet Stage File (.crm) 199 Import Source Time Levels Stage File (.ctl) 200 Import Source Time Periods Stage File (.ctp) 200 Stage Project File (.pro) 201 Time Language Text Stage File (.tlt) 204 Time Levels Stage File (.lvl) 205 Stage Unit File (.unt) 206 Cube Query Stage File (.ccq) 208 Stage Watchlist File (.cwl) 209 Equations (.equ) 211 Equation Items (.eqi) 211 Appendix C: Staging Tables 213 Object_stage Table 214 Metric_type_stage Table 215 Object_link_stage Table 218 Kpi_value_stage Table 219 Stage_diagram Table 220 Stage_object_note Table 222 Stage_custom_params Table 223 Time_periods_stage Table 223 Stage_policy Table 224 Import_source_cu_stage Table 224 Import_source_rp_stage Table 225 Import_source_tl_stage Table 225 Import_source_tp_stage Table 226 Stage_project Table 226 Time_language_text_stage Table 227 Time_levels_stage Table 227 Stage_unit Table 228 Cube_query_stage Table 228 Stage_watchlist Table 229 Glossary 231 Index 233 User Guide 7 Table of Contents 8 Metric Studio Introduction This document is intended for use with Metric Studio. Metric Studio is a Web product for managing organizational performance by monitoring and analyzing metrics, projects, and other performance measures at all levels of the organization. Audience To use this guide, you should be familiar with ● scorecarding concepts ● database and data warehouse concepts ● security issues For application authors, this document includes background information and step-by-step procedures for creating a scorecarding environment. It explains how to create scorecards, metric types, and metrics; how to load data into Metric Studio; and how to enhance the scorecarding environment.