Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Tivoli® Tivoli Common Reporting Development and Style Guide Version 1.2.0.1 SC2

Tivoli® Tivoli Common Reporting Development and Style Guide Version 1.2.0.1 SC23-8861-01 Tivoli® Tivoli Common Reporting Development and Style Guide Version 1.2.0.1 SC23-8861-01 Note Before using this information and the product it supports, read the information in “Notices” on page A-1. Fourth Edition (September 2009) This edition applies to version 1.2.0.1 of Tivoli Common Reporting and to all subsequent releases and modifications until otherwise indicated in new editions. © Copyright International Business Machines Corporation 2007, 2009. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Table of Contents Table of Contents WHAT’S NEW..............................................................................................................................................3 TABLE OF CONTENTS.............................................................................................................................4 SECTION 1 TIVOLI COMMON REPORTING OVERVIEW ............................................................... 7 1.1 GETTING STARTED WITH TIVOLI COMMON REPORTING .................................................................................... 7 1.2 REPORT CONTENT IS KEY ............................................................................................................................ 7 SECTION 2 TOOLS ...................................................................................................................................... 9 2.1 OVERVIEW ................................................................................................................................................. 9 2.2 EDUCATIONAL MATERIALS .......................................................................................................................... 9 2.3 JAVA ......................................................................................................................................................... 9 2.4 ECLIPSE AND BIRT .................................................................................................................................... 9 2.5 DATABASE DRIVERS .................................................................................................................................. 10 2.5.1 IBM DB2® .................................................................................................................................... 10 2.5.2 Microsoft™ SQL Server ................................................................................................................ 11 2.5.3 Oracle ............................................................................................................................................ 11 2.5.4 How to Add a JDBC Driver and Configure a JDBC Datasource ................................................. 11 SECTION 3 STYLE GUIDELINES .......................................................................................................... 15 3.1 DOCUMENT LAYOUT ................................................................................................................................ 16 3.1.1 Overall Document Style ................................................................................................................ 16 3.1.2 Overall Document Color Pallet .................................................................................................... 17 3.2 REPORT HEADER ...................................................................................................................................... 18 3.3 REPORT INTRODUCTION ............................................................................................................................. 18 3.3.1 Report Title .................................................................................................................................... 18 3.3.2 Report Sub-Title ............................................................................................................................ 18 3.3.3 Secondary Title .............................................................................................................................. 19 3.3.4 Parameters .................................................................................................................................... 19 3.4 INFORMATION SECTIONS ............................................................................................................................ 21 3.4.1 Section Title ................................................................................................................................... 21 3.4.2 Charts ............................................................................................................................................ 22 3.4.3 Standard Tables ............................................................................................................................. 29 3.4.4 Grouping Tables ............................................................................................................................ 31 3.4.5 Form Elements ............................................................................................................................. 33 3.5 REPORT DESCRIPTION ............................................................................................................................... 34 3.6 MESSAGE DIALOG BOXES ......................................................................................................................... 34 3.7 COLLAPSIBLE SECTIONS ............................................................................................................................ 36 3.8 REPORT FOOTER ....................................................................................................................................... 36 3.9 SAMPLE REPORTS LAYOUTS ........................................................................................................................ 37 SECTION 4 CREATING REPORTS AND REPORT PACKAGES ................................................... 40 4.1 INTRODUCTION .......................................................................................................................................... 40 4.2 TIVOLI COMMON REPORTING STYLE PACKAGE ............................................................................................. 40 4.2.1 Style Package Description ........................................................................................................... 40 4.2.2 Importing Style Package into BIRT .............................................................................................. 42 4.2.3 Creating your BIRT Project ......................................................................................................... 42 4.2.4 Modify the BIRT settings for resources and templates ................................................................. 43 4.2.5 Report Naming Convention ........................................................................................................... 43 4.3 TIVOLI COMMON REPORTING LIBRARY ....................................................................................................... 44 © Copyright IBM Corp. 2007, 2009 4.3.1 TCR Theme .................................................................................................................................... 46 4.3.2 Report Parameters ........................................................................................................................ 47 4.3.3 Report Items .................................................................................................................................. 47 4.3.4 TCR Master Page .......................................................................................................................... 47 4.4 REPORT TEMPLATES .................................................................................................................................. 48 4.4.1 Using TCR Templates ................................................................................................................... 49 4.4.2 Using the Table Template ............................................................................................................. 52 4.4.3 Using the Group Table Templates ................................................................................................ 55 4.4.4 Using the Chart Template ............................................................................................................ 58 4.4.5 Using the Chart Table Combo Template ...................................................................................... 64 4.5 SAMPLE REPORTS ...................................................................................................................................... 65 4.5.1 TableWithDrillthrough Sample Report ......................................................................................... 65 4.5.2 ChartsWithDrillthrough Sample Report ....................................................................................... 67 4.5.3 DynamicColumnSort Sample Report ............................................................................................ 70 4.5.4 DynamicChartDimensions Sample Report .................................................................................... 70 4.5.5 ExpandCollapseSections Sample Report ...................................................................................... 72 4.5.6 DynamicQuery Sample Report ...................................................................................................... 75 4.5.7 DynamicTableColumnsAndVisibilityControl Sample Report ....................................................... 76 4.5.8 MessageDialogs Sample Report .................................................................................................... 76 4.5.9 QuickLinks Sample Report ............................................................................................................ 77 4.5.10 ParameterValidation Sample ...................................................................................................... 77 4.5.11 StatusBasedColoringChart Sample ............................................................................................. 78 4.5.12 TableFooterWithTotals Sample Report ....................................................................................... 79 4.5.13 DateRangeParameters Sample Report ........................................................................................ 81 4.5.14 CascadingParameters Report ..................................................................................................... 84 4.5.15 DependentDatasets Sample Report ............................................................................................. 86 4.5.16 TableUsingStatusIcons Sample Report ....................................................................................... 87 4.5.17 MultipleSelectListBoxParameter Report ..................................................................................... 88 4.6 SCRIPTS ................................................................................................................................................... 89 4.6.1 ReportUtils.js ................................................................................................................................. 89 4.6.2 DateTime.js ................................................................................................................................... 89 4.6.3 ModifyQuery.js .............................................................................................................................. 90 4.6.4 Logger.js ........................................................................................................................................ 90 SECTION 5 BEST PRACTICES ............................................................................................................... 91 5.1 PROJECTS AND LIBRARIES ........................................................................................................................... 91 5.2 GENERAL REPORT PROPERTIES .................................................................................................................... 92 5.3 GLOBALIZATION / LOCALIZATION ................................................................................................................ 92 5.3.1 Setting Up Basic Globalization ..................................................................................................... 93 5.3.2 Globalizing Strings Embedded in HTML Text .............................................................................. 93 5.3.3 Globalizing Report Title and Description ..................................................................................... 94 5.3.4 Globalizing Report Element Names .............................................................................................. 94 5.4 DATA SOURCES ........................................................................................................................................ 95 5.4.1 JNDI Naming Convention ............................................................................................................. 95 5.5 DATA SETS .............................................................................................................................................. 96 5.6 TIMESTAMPS ............................................................................................................................................ 97 5.6.1 Timestamps in Charts ................................................................................................................... 97 5.6.2 Timestamps in Tables and Parameters ......................................................................................... 98 5.6.3 Timestamp in Footer ..................................................................................................................... 98 5.7 CHARTS ................................................................................................................................................... 99 5.8 USEFUL HINTS AND TIPS ........................................................................................................................... 99 5.8.1 BIRT Designer ............................................................................................................................... 99 5.8.2 Tables ............................................................................................................................................ 99 5.8.3 Charts ............................................................................................................................................ 99 APPENDIX A TERMINOLOGY .......................................................................................................... 101 © Copyright IBM Corp. 2007, 2008 5 © Copyright IBM Corp. 2007, 2008 6 Section 1 Section 1Tivoli Common Reporting Overview Tivoli Common Reporting Overview 1.1 1.1 Getting Started With Tivoli Common Reporting Getting Started With Tivoli Common Reporting The purpose of this guide is to provide assistance on how to create reports that meet the Tivoli® Common Reporting (TCR) guidelines and integrate well into the Tivoli Common Reporting software. TCR provides a software component, report definition guidelines, and report templates that can be used by Tivoli products, business partners, and customers. These guidelines enable consistency in report styles and report generation, providing a common look and feel, as well as quicker and easier report creation. Using product supplied reports as the starting point, customers and business partners can easily create customized extensions that fit into the overall reporting system, yet meet their individualized needs. The following is a quick overview of the steps necessary to develop reports that smoothly integrate into Tivoli Common Reporting. 1. Obtain all prerequisite tools required for building your reports. 2. Decide how to deploy your reports within Tivoli Common Reporting. 3. Determine what reports your customers need, based on your product, customer expertise or customer interviews. 4. Learn the templates and libraries in the TCR style package. 5. Using the templates and libraries, design and test your reports using the BIRT report designer. 6. Install and test your reports in Tivoli Common Reporting. 1.2 1.2 Report Content Is Key Report Content Is Key Producing high-value, consistent reports for Tivoli products requires user interaction, design analysis and innovation, and development discipline. • High Value: Each report should provide information that is important to running the business, improving productivity, or showing the return on investment made in products and processes that use those products. In order to achieve this value, you must have a deep understanding of how your customers’ processes work, and what drives the cost and service delivery and support structures. To achieve this value requires: o Outside-In Design work to identify and validate reporting content that users will find valuable and useful in their environments. o Analysis of the visual display of the information and innovation of techniques to “get the message across” quickly and effectively. o Integration of design across products and processes to fully understand how to obtain the proper metrics and performance indicators and ensure high quality of the data being produced. • Consistent: As users look at the reports produced from different Tivoli products, reports written by business partners, and reports developed in- house, there should be leverage gained from understanding the previous reports and quickly identifying related information. This leverage can © Copyright IBM Corp. 2007, 2008 7 only be obtained when reports are visually consistent in their appearance, layout, function, and especially terminology and semantics of the data. Achieving this consistency means: o Visual-appearance standards for features such as graphics splashes, titles, fonts, and color schemes. o Layout standards for features such as chart sizes and locations, and templates for combining information on a single page. o Algorithmic and analytical standards, such as statistical process control charts with mean and standard deviation consistency, and consistent use of aggregations (sums, averages, and counts). o Consistency in the underlying data used to produce reports. This consistency means that individual data objects must be semantically equivalent and labeled in the same way. Timestamps must be represented syntactically in the same way, and when compared, must represent the same context. This document assists in achieving the consistency and high value goals by providing a standardized set of report styles and samples upon which visually effective, easy to read reports can be developed. Tivoli Common Reporting also provides a set of tools that enable consistency in report access, viewing and management , thereby improving the overall investment in reporting. Consistent use of these report styles, samples and tools across multiple product, business partner and customer-written reports provides the basis for achieving the goals in this section. © Copyright IBM Corp. 2007, 2008 8 Section 2 Section 2Tools Tools 2.1 2.1 Overview Overview The standard development tool for all reports created for Tivoli Common Reporting is Business Intelligence and Reporting Tools (BIRT). BIRT is an open source tool based on the popular Eclipse development platform, which is also open source. Both are written in Java™ and rely on a Java runtime environment. 2.2 2.2 Educational Materials Educational Materials The Tivoli Common Reporting Web page at IBM® developerWorks® (http://www.ibm.com/developerworks) is a reference source for many useful reporting hints and tips. The developersWorks page contains forums on report development topics, hints and tips sections on useful reporting techniques, and pointers to the reports that are available for Tivoli products. The Eclipse Web site at eclipse.org has a number of articles and tutorials on BIRT. A number of forums are also available on the Internet for users of BIRT to exchange hints, tips and problems. The uploads/s3/ tcr-style-guide.pdf