Micro Focus. Enterprise View Portal. Report Wizard Guide Step by Step

Transcription

1 Micro Focus Enterprise View Portal

2 Copyright 2008 Micro Focus (IP) Ltd. All rights reserved. Micro Focus (IP) Ltd. has made every effort to ensure that this book is correct and accurate, but reserves the right to make changes without notice at its sole discretion at any time. The software described in this document is supplied under a license and may be used or copied only in accordance with the terms of such license, and in particular any warranty of fitness of Micro Focus software products for any particular purpose is expressly excluded and in no event will Micro Focus be liable for any consequential loss. Animator, COBOL Workbench, EnterpriseLink, Mainframe Express, Micro Focus, Net Express, REQL and Revolve are registered trademarks, and AAI, Analyzer, Application Server, Application to Application Interface, AddPack, AppTrack, AssetMiner, CCI, DataConnect, Dialog System, Enterprise Server, Enterprise Server with MTO, EuroSmart, FixPack, LEVEL II COBOL, License Server, Mainframe Access, Mainframe Manager, Micro Focus COBOL, Micro Focus Studio, Micro Focus Server, Object COBOL, OpenESQL, Personal COBOL, Professional COBOL, Server Express, SmartFind, SmartFind Plus, SmartFix, SourceConnect, SupportLine, Toolbox, VS COBOL, WebSync, and Xilerator are trademarks of Micro Focus (IP) Ltd. IBM and CICS are registered trademarks, and IMS, DB2, DB2/390, DB2 Connect Enterprise Edition, DB2 Connect Personal Edition, COBOL for OS/390, Enterprise Systems Architecture/390, ESA/390, MVS, MVS/ESA, OS/390, S/390, System/390, VSE/ESA and MFS are trademarks, of International Business Machines Corporation. Netscape Enterprise Server is a trademark of Netscape Communications Corporation. Internet Information Server, Windows 95, Windows 98, Windows NT 4.0, Windows ME and Windows 2000 are registered trademarks of Microsoft Corporation. Pentium is a registered trademark of INTEL Corporation. Borland Database Engine and Midas are trademarks of Inprise Corporation. Oracle is a trademark of Oracle Corporation Inc. UNIX is a registered trademark of The Open Group. Solaris, Ultra Sparc and Java are trademarks of Sun Microsystems, Inc. Linux, GCC compiler, GNU CTAGS, GNU DIFF, Samba and KDE/GNOME refer to Open Source tools. This product includes modified versions of software developed by the Apache Software Foundation (as described on the Apache web site). The YGrep Search Engine is Copyright (c) Yves Roumazeilles. All other trademarks are the property of their respective owners. No part of this publication, with the exception of the software product user documentation contained on a CD-ROM, may be copied, photocopied, reproduced, transmitted, transcribed, or reduced to any electronic medium or machine-readable form without prior written consent of Micro Focus (IP) Ltd. Contact your Micro Focus

3 representative if you require access to the modified Apache Software Foundation source files. Licensees may duplicate the software product user documentation contained on a CD- ROM, but only to the extent necessary to support the users authorized access to the software under the license agreement. Any reproduction of the documentation, regardless of whether the documentation is reproduced in whole or in part, must be accompanied by this copyright statement in its entirety, without modification. U.S. GOVERNMENT RESTRICTED RIGHTS. It is acknowledged that the Software and the Documentation were developed at private expense, that no part is in the public domain, and that the Software and Documentation are Commercial Computer Software provided with RESTRICTED RIGHTS under Federal Acquisition Regulations and agency supplements to them. Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at DFAR et. seq. or subparagraphs (c)(1) and (2) of the Commercial Computer Software Restricted Rights at FAR , as applicable. Contractor is Micro Focus (IP) Ltd, 9420 Key West Avenue, Rockville, Maryland Rights are reserved under copyright laws of the United States with respect to unpublished portions of the Software.

4 4

5 5 Table of Contents 1. ABOUT THIS GUIDE REQUIRED FILES PAGE INDEX FILES index.xml index.properties MONDRIAN HYPER-CUBE FILE REPORT FILES Properties File Xaction File Xml File Xreportspec CREATE A NEW REPORT OVERVIEW STEP STEP STEP STEP

6 6

7 7 1. About this Guide This guide will help you create a new report in Enterprise View Portal. You will work through the whole process step by step starting from scratch. The reports are created with the Pentaho Report Design Wizard a third party tool that we supply with the installation of the Portal. The screenshots in the examples are for the version of the tool that we supply with this installation of Enterprise View Portal 5.6. This document does not describe how this tool works: it explains how to use it in the process of creating new portal reports. For additional information you should read the original Pentaho documentation.

8 8

9 9 2. Required Files 2.1. Page Index files EV Portal is composed of several web pages. Each page has a folder associated with it to contain the definition of all the reports that have to be displayed in the page. Each folder must contain two other files: index.xml index.properties These files are necessary to make the folder visible as a Portal page index.xml This file contains the displayed title and the description of the corresponding Portal page. These fields should not be modified directly. The index.properties file reads the index.xml using % prefix as in the following example: <index> <name>%name</name> <description>%description</description> <icon>sample.png</icon> <visible>true</visible> <display-type>icons</display-type> </index> The <icon> tag lets you set the page icon. If the icon file is not in the same folder, it must be put there. You can set the value of the <visible> tag to false so as not to display the page in the Portal but without deleting the whole folder. This can be useful while you are developing the page. Do not change the <display-type> value unless you know what you are doing (see the Pentaho documentation) index.properties This file contains the title and the description of the corresponding Portal page. These fields are not directly used to create the page, but are referred to by index.xml through the % prefix. name=my Page Title description=my page description 2.2. Mondrian Hyper-cube File All data available in the Portal is described through a hyper-cube containing a multi-dimensional view of the information. Hyper-cubes are xml files with the extension *.mondrian.xml.

10 10 The predefined hyper-cubes should be sufficient for your needs, so the hyper-cubes generation is not documented here. They all are located in mfev-portalserver/webapps/root/mf-solution/microfocus_common/mondrian_cubes Report Files Each report is composed of four files, as highlighted in the following image taken from Pentaho Design Studio: MyReportName.properties MyReportName.xaction MyReportName.xml MyReportName.xreportspec Properties File This file is very simple. It contains only the title, the description and the sequence number of the report as they appear in the related Portal page. For example: description=this Analysis will allow you to navigate into global inventory information at Application Level title=0. Inventory Analysis - Current Note that the 0. string is not displayed but is used to put the reports in the page in order in this case, the report will always be the first report in the page. Pentaho does not require a strict numbering sequence (missing and duplicate numbers are allowed) but we advise you avoid duplication and use the same number of digits for all the reports in a page. For example, if your page contains more than ten records, start with 00, 01 and so on.

11 Xaction File This file describes all the components of the report, together with related properties, and the actions to perform. It will be described in more detail later Xml File This file describes the layout of the report. It will be described in more detail later Xreportspec This file is used only by the Report Wizard. It contains all the information needed to generate (or re-generate) the report.

12 12

13 13 3. Create a New Report 3.1. Overview EV Portal provides a set of templates to reduce the time needed to create a new report. In the current release, four templates are available: Dynamic Inventory Software Quality Change Traffic Outsource Manager To see the available templates in the Portal, select Pivot Analysis from the main menu and find the Report Templates section. You need to identify the template you need. For example, assuming you want a Software Quality Trend Analysis report, click on the Software Quality item. You will see the following: Notice that two templates are available for Software Quality: Current Status Analysis and Trend Analysis. This is common to all predefined templates. Each template is composed of two items: JPivot Analysis and Report Template. Pay attention to the name of the Mondrian hyper-cube (Quality_Data.mondrian.xml in the example) and the prefix of Template files (Quality_Trend_Report in the example) Now we have all the information needed to create the report Step 1 This main step includes several smaller steps that you have to follow: 1. Open Pentaho Design Studio. 2. Copy the four template files from the Report_Templates folder to the section where you want the new report to appear (in this case, Software Quality folder).

14 14 3. Identify the Mondrian hyper-cube (as described in the Mondrian Hyper-cube file paragraph in the Required files chapter) and copy it to the same folder you copied the template files. 4. Rename the.properties and.xaction files to prevent them from being automatically updated by the Report Design Wizard (for example, rename them as _properties and _xaction) Step 2 Open the Report Design Wizard and from File > Open select the xreportspec file (the copied template). The following form appears: Click Next.

15 15 If this is the first time you have used the Report Design Wizard, you need to setup the repository connection. Otherwise, go to Step 3. First check if the Oracle JDBC driver exists in the Report Design Report directory.

16 16 If the driver does not exist, copy it from <EV_PORTAL_HOME>\common\lib into the <REPORT_WIZARD_HOME>\lib directory and restart the Report Wizard in order to load the newly added ojdbc14.jar file. <EV_PORTAL_HOME> and <REPORT_WIZARD_HOME> are the directories where EV Portal and the Pentaho Report Wizard are installed. Click Add under Connection Information. Be sure the connection type is set to JNDI.

17 17 You will see the following screen: You have to set the last three parameters. Set Connect String in the following way: Oracle_Port:Oracle_Service_Name where: Oracle_User The EV repository schema Oracle_PWD The Oracle password associated with the schema Oracle_Server_Name The IP address of the Oracle server (provided by the Oracle DBA) Oracle_Port The listening port of the Oracle server (usually 1521) Oracle_Service_Name The Oracle database SID (provided by the Oracle DBA) Set the User Name and Password parameters with the same values used in the connection string for Oracle_User and Oracle_PWD. Click Test to verify the connection and then click OK.

18 Step 3 Click Browse to select the Mondrian hyper-cube copied in Step 1. The Query you see is the default query of the template, without filters and parameters. The fastest way to set the desired behavior is to use the JPivot directly in the Portal.

19 19 Open the Portal in your browser and click OLAP Navigator (the first button in the row of buttons at the top of the page) to set filters and parameters as shown in the following example: When you click OK you can see a preview of the data that will be inserted in the report. When you reach the desired data you are ready to copy the Mondrian query. Click Show MDX (the second button in the row) to see the query text. Copy and paste the query text in the Report Wizard.

20 20 Click Preview to see the result. A warning message will appear on your screen : Report meta-data does not match current result-set, update report spec (recommended)? Click Yes to display the preview on your screen.

21 21 Exit the Preview and click Next. Here you can select the items you want to see in the report and the grouping criteria. Click Preview to see the result of your changes. When you are ready, click Next to set the visual properties of the report for each detail and group field that has been defined:

22 22 This is a simple text field with fixed size and left alignment. The above is a numeric field computing average values.

23 23 The above is a group field with related properties. To learn how to customize the report, we recommend you try various options and look at the result in the preview. When you are satisfied, click Next to set the properties for the whole page: If you want, you can set more advanced options: After a last look at the preview to verify that the report appears as you want it to, click Publish.

24 24 Click Browse to select a Portal folder and save your work, then click OK. A message saying Publish to location was successful. will appear. Create JBoss Datasource is checked by default. Uncheck it. Publishing does not save the xreportspec file (needed to modify the report in the future). To save it, select File > Save in the main menu of the Report Wizard Step 4 Go back into the Pentaho Design Studio and refresh your project by right-clicking your folder or the whole project and selecting Refresh. The new generated files will appear. (If they don t, refresh the Design Studio workspace.)

25 25 Delete the automatically generated.properties and.xaction files and restore the previously renamed files (with the underscore in the example). Modify the.xaction file. Double-click it and the following screen will appear:

26 26 Select OLAP in Process Action and copy the same MDX query you copied from JPivot to Report Designer in the Query field. Change the Mondrian Schema File with the hyper-cube file you copied in your report.

27 27 Now select Pentaho Report to verify that the name of the xml file (Report Specification) is the same as that previously specified (in our example we used the name Quality_Trend_Report). Save the xaction by clicking Save (or selecting it from the File menu) and you are ready. Now restart the Portal to see the new report.

28 28 Note: We recommend that you never modify the original templates directly but instead copy them. Use the same name for all of the four report files we call this Report Name. Don t use the same Report Name in different folders. Pentaho allows this, but it risks confusion and difficulties in reorganizing the Portal structure.

29 29