IBM TRIRIGA Application Platform Version 3.3.2 Reporting: Creating Cross-Tab Reports in BIRT Cheng Yang Application Developer IBM TRIRIGA Copyright International Business Machines Corporation 2013. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
ii
CONTENTS List of Figures... iv Revision History... v 1 Introduction... 6 2 Prerequisites... 7 3 Creating a cross-tab BIRT report... 7 4 Product documentation... 15 iii
LIST OF FIGURES Figure 1: Sales Reporting Details... 6 Figure 2: Sample Sales Report... 6 Figure 3: Export the starter report... 7 Figure 4: Import the starter report... 7 Figure 5: Open the rptdesign file... 8 Figure 6: Double-click the data set... 8 Figure 7: Change the field type... 8 Figure 8: Choose New Data Cube... 9 Figure 9: Drag and drop under Groups (Dimensions)... 9 Figure 10: Group the date by year... 10 Figure 11: Drag and drop under Summary Fields (Measures)... 10 Figure 12: Select the function to be SUM... 11 Figure 13: Expand the Data Cube... 11 Figure 14: Drag and drop a cross -tab element... 12 Figure 15: Select Preview... 12 Figure 16: View the report... 13 Figure 17: Set the columns and data set... 13 Figure 18: Put the cross tab into the footer... 13 Figure 19: Delete the summarized field... 14 Figure 20: Drag and drop a Dynamic Text field... 14 Figure 21: View the report again... 15 iv
REVISION HISTORY Date Version Comments 05 Dec 2013 1.0 Initial version. v
1 Introduction This document provides instructions for creating a simple IBM TRIRIGA cross-tabulation (or cross-tab) report in Business Intelligence and Reporting Tools (BIRT). It also includes tips and an example that may be helpful for the report designer to create this type of report. For example, if you need a TRIRIGA report to show the sales total by year for each sales category using the data (see Sales Reporting Details below) it will look something like the Sample Sales Report (see further below). In TRIRIGA, this type of data can be presented nicely by a cross-tab report in BIRT. Figure 1: Sales Reporting Details Figure 2: Sample Sales Report 6
2 Prerequisites This document assumes that the reader has a basic understanding of the IBM TRIRIGA Application Platform and the fundamental concept that is required to operate the webbased IBM TRIRIGA system. The Eclipse - BIRT Report Designer must be installed. 3 Creating a cross-tab BIRT report Step 1: Export the starter report from the IBM TRIRIGA query in Report Manager. Figure 3: Export the starter report Step 2: In Eclipse - BIRT Report Designer, create a new Report Project and import the starter report into the project folder. Figure 4: Import the starter report 7
Step 3: Expand the Project Folder and then open the rptdesign file. Figure 5: Open the rptdesign file Step 4: Double-click the data set in Data Explorer. Figure 6: Double-click the data set Step 5: Select Output Columns, change the field type from Java Object to an appropriate type for each field. For example, change the data type to be Date for the "Date" defined field. However, keep the "Sales Total" field as Java Object. The reason is given later. Figure 7: Change the field type 8
Notes: All starter reports have all of the output columns that are modeled as Java Objects. Using Java Objects as the data types for IBM TRIRIGA data provides you with increased flexibility in development reports. However, unlike the regular table, which you can display the Java Objects columns on the report directly, the cross-tab report needs to have the data with correct data type before they can be used for Groups or Summaries in the data cube. Otherwise, the data cube cannot be created correctly, and it may show exceptions or errors when you run the cross-tab report. Step 6: In Data Explorer, right-click on Data Cubes, and then choose New Data Cube. Figure 8: Choose New Data Cube Step 7: Drag "Sales Category" field from Available Fields and drop it under the Groups (Dimensions). Figure 9: Drag and drop under Groups (Dimensions) 9
Step 8: Drag "Sales Date" field from Available Fields and drop it under the Groups (Dimensions). Different from "Sales Category", "Sales Date" is a Date type field, which you can group the dates by any of the time periods. In this example, group the date by year. Figure 10: Group the date by year Step 9: Drag the "Sales Total" field from Available Fields and drop it under the Summary Fields (Measures). Double-click the field, and select the function to be SUM. Figure 11: Drag and drop under Summary Fields (Measures) 10
Figure 12: Select the function to be SUM Notes: As mentioned earlier in step 5, you changed the field type from Java Object to an appropriate type for each field. However, the "Sales Total" is left as Java Object. The reason is that you must use this field as source to get the IBM TRIRIGA user-preferred format after you aggregate the numbers inside of BIRT. Before the field can be used for calculation, you must access its native SQL value by using the object's getnativevalue() method. For example: datasetrow["triitem trirepercentrentitem trisalestotalnu"].getnativevalue() Step 10: Expand the Data Cube to verify its contents. Figure 13: Expand the Data Cube 11
Step 11: Select Palette, drag a cross-tab element from the palette, and drop it to the report. Insert the data from the data cube into the cross tab. In this example, place the "Sales Category" into rows area, "Sales Year" into columns area and "Sales Total" into summarized area. Figure 14: Drag and drop a cross-tab element Step 12: Select Preview to view the report. Figure 15: Select Preview 12
Figure 16: View the report Notes: You may notice that some of the cells are blank and the numbers do not display in the appropriate format. If you would like to show zero for the null value, and also format those numbers in the IBM TRIRIGA user-preferred format, continue with the following steps. Step 13: Select the palette, drag a table element from the palette, and drop it to the report. Set the Number of columns to 1, and then select the data set. Figure 17: Set the columns and data set Step 14: Remove the header row and detail row from the table. Put the cross tab into the footer of that table. Figure 18: Put the cross tab into the footer 13
Step 15: Delete the summarized field, drag a Dynamic Text field from the palette, and drop it to the summarized area. Write the following code in the express builder to format the number in IBM TRIRIGA user-preferred format. Figure 19: Delete the summarized field Figure 20: Drag and drop a Dynamic Text field For example: TRIRIGA.formatNumber( data["triitem trirepercentrentitem trisalestotalnu_salescategory/triitem trirepercentrentitem trisalescategorycl_salesyear/year"], row._outer["triitem trirepercentrentitem trisalestotalnu"].getuom() ) Notes: The field that used for getuom() is from the outer table. 14
Step 16: Select Preview to view the report again. Now the report shows the number in the same format as you defined in IBM TRIRIGA. Figure 21: View the report again 4 Product documentation Review the IBM TRIRIGA 10.3.2 and IBM TRIRIGA Application Platform 3.3.2 information centers for more information about IBM TRIRIGA products. Depending on the topic, this paper might or might not supersede the standard documentation. In most cases, this paper overrides related information but only for the product version to which this paper applies. Review the latest Release Notes for your installed IBM TRIRIGA product version, as they might contain specific information that overrides topics in this paper. 15
Copyright IBM Corporation 2013 IBM United States of America Produced in the United States of America US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PAPER AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes may be made periodically to the information herein; these changes may be incorporated in subsequent versions of the paper. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this paper at any time without notice. Any references in this document to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation 4205 South Miami Boulevard Research Triangle Park, NC 27709 U.S.A. 16
All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information is for planning purposes only. The information herein is subject to change before the products described become available. If you are viewing this information softcopy, the photographs and color illustrations may not appear. Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered 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 "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. 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 or registered trademarks of Oracle and/or its affiliates. Other product and service names might be trademarks of IBM or other companies. 17