Tivoli Common Reporting V2.x. Reporting with Tivoli Data Warehouse

Transcription

1 Tivoli Common Reporting V2.x Reporting with Tivoli Data Warehouse Preethi C Mohan IBM India Ltd. India Software Labs, Bangalore preethi.mohan@in.ibm.com Copyright IBM Corporation 2012 This document is the sole property of IBM India Ltd. No part of this document may be reproduced in any form or by any means - electronic, mechanical, photocopying, recording or otherwise without the prior written permission of IBM India Ltd. 1

2 Document Control Revision Date Author Summary of Changes 1.1 Jul 27, 2012 Preethi C Mohan First version 1.2 Aug 1, 2012 Preethi C Mohan Added step 5 in Exercise Aug 31,2012 Preethi C Mohan Inserted exercise 4 on filters 1.4 Oct 29, 2012 Preethi C Mohan Inserted exercise 6 on custom data in reports 1.5 May 28, 2013 Preethi C Mohan - Added candletime and Timezone information in Introduction - Updated exercise 4 to show multiple server selection 1.6 Jun 3, 2013 Preethi C Mohan - Updating exercise on drill down - Added exercise 10 on Import package Reviewers Name Dan Krissell Agnieszka Marzec Title Tivoli Common Reporting Architect Information Developer 2

3 Table of Content Introduction... 4 Help Information... 5 Exercise 1 Creating the data source and data model... 6 Exercise 2 Use direct SQL Exercise 3 Use Tivoli Common Reporting Template Exercise 4 Use filter to view data of single or multiple server Exercise 5 Use summarized tables of Tivoli Data Warehouse Exercise 6 Use custom tables in report Exercise 7 Add a chart to the report Exercise 8 Add a drill down capability Exercise 9 Export report package Exercise 10 Import report package

4 Introduction This document provides a set of exercises which help to learn the basic features of Cognos. These exercises use Tivoli Data Warehouse as the data source. This document is intended for a user who wants to create Cognos reports by fetching data from the Tivoli Data Warehouse (TDW) populated by IBM Tivoli Monitoring agents. The exercises use tables from ITM Windows OS Agent. However, you can use similar tables that are present in your Tivoli Data Warehouse. This document does not cover the installation of Tivoli Common Reporting. It assumes that both Tivoli Common Reporting and Cognos Framework Manager are already installed. It also assumes that the database server/client is already installed on the system and Tivoli Data Warehouse database is reachable. Note: TCR 2.x does not support JDBC data source connection. Hence, database server/client should be setup on the TCR machine. Advice for novice users is to execute these exercises in a sequential order of 1 to 7. Some steps are explained in detail in the first few exercises. And the following exercises assume you know those steps as you have already tried them in the initial exercises. Tivoli Data Warehouse Timestamp field Tivoli Data Warehouse uses Candletime format to represent the date/time of the data recorded. WRITETIME is the column in the Warehouse which contains the date/time in Candletime format. Cognos understands only Timestamp format. So, this document covers the section of converting Candletime to Timestamp for a report. Candletime format: Candletime: Candletime Format: CYYMMddhhmmssSSS where C Century, YY Year, MM Month, dd Day, hh Hour, mm Minute, ss Second, SSS - Milliseconds CYY - (to be added to candle time assumes 1900 as the base) Century with year = = 113 Year = = 2013 Timestamp: :15:

5 Help Information This document is not meant to replace any existing Tivoli Common Reporting help document. When using Cognos Framework Manager, for details on any property, use the Help menu available in the tool. For help when using Tivoli Common Reporting web console, use the Help links. There are Help menus in Query and Report studios as well. Online Tivoli Common Reporting information center: 21/ic-home.html 5

6 Exercise 1 Creating the data source and data model The purpose of the exercise: Create a data source in Cognos Administration. Create a data model and publish it. This exercise also shows how to use the WRITETIME field which is in Candletime format. (Note: It does not handle Timezone) Procedure 1. List the report requirements. For e.g.: Show the CPU utilization of all the computers in a report. 2. Design the report. For e.g.: A table showing the list of servers and their CPU utilization over time. Provide a time range selection. 3. Identify the database table where you would get the required data. For e.g.: Database: WAREHOUS ITM Agent: Windows OS Agent Table: NT_Processor_DV, NT_Processor_HV Columns: WRITETIME, Server_Name, AVG_%_Processor_Time 4. Add data source in the Administration Log in to Tivoli Integrated Portal. ( Expand Reporting and click Common Reporting. Click Launch in the top right corner and select Administration. 6

7 4.3. In the Administration window, click the Configuration tab and select Data Source Connections Click the Add Data Source icon Enter WAREHOUS as the name for the data source and click Next Choose DB2 as the database type and click Next Enter WAREHOUS as the DB2 database name Scroll down and select the Password checkbox under Signons. Enter the database user name and password. 7

8 4.9. Click Test the connection Click the Test button. The output will look like this: Click Close. Click Close again to close the test the connection window Click Next on the Specify the DB2 connection string window Click Finish on the Specify the commands window A new entry WAREHOUS is visible in your data source list: 5. Create a data model using Framework Manager to fetch the data Open Framework Manager (For e.g.: C:\IBM\tivoli\tipv2Components\TCRComponent\cognos\bin\FM.exe). On Windows, you can use the shortcut to launch it. 8

9 5.2. Click Create a new project. Enter Test as the project name and click OK Accept all security pop-up windows. Provide Tivoli Integrated Portal user name and password wherever you are prompted for it Select the language and click OK Select Data Sources as the Metadata Source. Click Next Select WAREHOUS from the data source list and click Next ITMUSER is the schema name for WAREHOUS. Expand it and go to the Views directory Select NT_Processor_DV and NT_Processor_HV. Click Next Select to Import with default values Click Finish. 9

10 5.11. Create namespaces in the data model Create a namespace called Database View under WAREHOUS and move NT_Processor_HV and NT_Processor_DV under the Database View Create Consolidation View and Presentation View namespaces Create a query subject by right clicking on Consolidation View and selecting Create->Query Subject. Call it CPU Usage NT. Click OK. 10

11 Drag WRITETIME, Server_Name, and AVG_%_Processor_Time from NT_Processor_DV and drop them into the Query Items section. 11

12 Cognos does not understand WRITETIME field [Refer introduction section for more details on WRITETIME]. So, lets convert Candletime to Timestamp. Click Add to create a new query item for Timestamp. Add the following expression cast((cast((cast(substring([consolidation View].[CPU Usage - NT].[WRITETIME], 1, 3), integer) ) as char(4)) + '-' + substring([consolidation View].[CPU Usage - NT].[WRITETIME], 4,2) + '-' + substring([consolidation View].[CPU Usage - NT].[WRITETIME], 6,2) + ' ' + substring([consolidation View].[CPU Usage - NT].[WRITETIME], 8,2) + ':' + substring([consolidation View].[CPU Usage - NT].[WRITETIME], 10,2)+ ':' + substring([consolidation View].[CPU Usage - NT].[WRITETIME], 12,2) + '.000') as timestamp) Click OK Click the Test tab and test the query. The data should appear in the tab. 12

13 Click OK Change the usage of the Timestamp to Attribute Right click Consolidation View->CPU Usage NT and create a shortcut. Drag the shortcut and drop it into the Presentation View. Rename the shortcut to CPU Usage NT. 13

14 5.12. Create a package and publish it. Right click Packages. Click on Create->Package Enter Test Package as the package name. Click Next Select the Database and Consolidation Views in the hidden mode and the Presentation View in the full selection mode. Click Next Click Finish. 14

15 Click Yes to open the Publish Package wizard Click Next on the Select Location Type wizard page Click Next on the Add Security wizard page Click Publish on the Options wizard page to publish the package, and then Finish. Ignore any warnings that might be displayed After saving the model, it appears unsaved. It is expected behavior. The model has been published and you can save it before closing Verify if your package is published in Tivoli Integrated Portal Login to Tivoli Integrated Portal ( using the Internet Explorer browser Expand Reporting and click Common Reporting. Check if the Test Package is visible under Public Folders. Note: Click Refresh if you cannot see the package. 6. From the Launch menu, open Report Studio. Choose the Test Package from the list, and select Create a new report or template. Choose Blank from the pop-up window and click OK. 15

16 7. A report with a default page is created. Hover your mouse cursor over the Page Explorer and it will expand to show the pages. 8. Click Page 1 and load a list of data. From the toolbox, drag a set of blocks and then a List and drop it into Page When a list is dragged into the Page, notice that the Query tab in the Insertable Objects window contains a new query. This query is linked to the list. 10.Now add data items into the list by dragging and dropping the data items into page1. 16

17 11.Right click on the list and click Go to Query. 12.In the Query, select AVG_%_Processor_Time and in the properties section, set the Aggregate Function fields to Average. 13.Run the report by clicking Run->Run Report - HTML 14.The report output appears in a new browser window. 15.You can update the column title names in the report to suit your needs. 17

18 Exercise 2 Use direct SQL The purpose of the exercise: Fetch data from a direct SQL instead of the query from the data model. 1. Create new blank report. 2. Hover your mouse cursor on Query Explorer. When it expands, click Queries. 3. From the Insertable objects pane, drag SQL and drop it into Query Explorer. 4. In the properties section of the SQL, select WAREHOUS as the data source and set the SQL to: Select * from ITMUSER. NT_Processor_DV Note: Copying the strings from this document to Report Studio changes the format of the double quotes. In case Cognos throws an error, just remove the double quotes manually in Cognos page and re-add it. 18

19 5. Now, go to the properties of Query 1 and set Processing to Limited Local. 6. Go into Query 1 and add Timestamp data item. Add a new data item called Timestamp and set the expression to the following: cast((cast((cast(substring([sql1].[writetime], 1, 3), integer) ) as char(4)) + '-' + substring([sql1].[writetime], 4,2) + '-' + substring([sql1].[writetime], 6,2) + ' ' + substring([sql1].[writetime], 8,2) + ':' + substring([sql1].[writetime], 10,2)+ ':' + substring([sql1].[writetime], 12,2) + '.000') as timestamp) 7. Update the aggregate function properties of AVG_%_Processor_Time to Average. (Refer the step showed in Exercise 1) 8. Go to the Page Explorer -> Page 1, add blocks and a list. List comes with a new Query called Query 2. 19

20 9. Now change the query of the list to Query Now add data items from the Data Items tab to the page into the list. 11.Run the report. 20

21 Exercise 3 Use Tivoli Common Reporting Template The purpose of the exercise: Use Tivoli Common Reporting template to create a report. Shows how to use the date prompt in the report. 1. Open Report Studio. Choose Create a new report or template and select TCR Template. Click OK. 2. By default, a prompt page and Page 1 is created. The prompt page contains the date prompt set in it and a hint on how to use it. 21

22 3. Go to Page1 and add a list on the page. Add data items to the list (like in Exercise 1) 4. Go to Query 1 (from the Query Explorer or right click the list and click Go to Query) 5. From the Insertable Objects->Toolbar tab, drag and drop a Filter into the Details Filter box on the right hand side. When the Detail Filter Expression window comes up, add the following text string in the Expression Definition: #prompt('tcrdatefilter','token','1=1', '[Timestamp]')# 6. Save the report. Name it Test Report. The report will appear under the Test Package in the main Common Reporting window. 22

23 7. Run the report 8. In the prompt page, select Date Range (below), and in the date ranges, choose a date range which is a subset of the data you have in the database. 9. Click Finish. The report will show the table with data within the specified date range. 23

24 Exercise 4 Use filter to view data of single or multiple server The purpose of the exercise: Learn how to view data for a selected server by adding a filter to the prompt page. 1. Go to the prompt page of the report, drag and drop a Value Prompt from the Insertable Objects->Toolbox tab into the row below the date controls. 2. You will get a pop-up Prompt Wizard Value Prompt. 24

25 Provide the name as Param_Server and click Next. 3. Now comes the step of creating the filter. Click on the ellipses ( ) button next to the Package item. This will open the Package Item window: 25

26 Choose Server_Name and click OK. 4. Click Next on the Prompt Wizard Value Prompt window. 5. Now, you choose where the filter should be applied. This lists all the queries present in the report. Query1 is listed which was created in Exercise 3 above. Choose Query1 and click Next. 6. This step allows you to populate the control by creating a new query to fetch the list of servers from the database. Set the name as Query_ServerList. And click Finish. 26

27 7. On the prompt page, you will see a combo box added. 8. Now, put a label for this combo box by dragging and dropping a Text Item from the Toolbox tab into the prompt page in front of the combo box. Set the name as Server Name. Prompt page definition will look as shown below 9. Note that the Server Name style is not matching with the other labels. So, copy the style of the other label by following the steps below: 27

28 a. Select the text End Date (not the entire column, just the text) as shown below b. In the toolbar on top of the page, you will find an icon which says Pick up Style, click on it. This will copy the style of the text End Date c. Now, select the text Server Name and click on the Apply Style icon in the toolbar 10. Now the prompt page appears as follows 11. We want to copy the style of the column as well. So, select the entire column of End Date and follow the same steps as shown in Step 9 to copy the style and apply it to the column of Server Name 12. The prompt page will appear as follows 28

29 13.Lets look at the other changes that the wizard Prompt Wizard Value Prompt did. a. Go to the Query Explorer, you will find a new query added there Query_ServerList b. Now, open the Query1 in it, under Detail Filters section, you will find a new filter added there for server name. c. Double click on the filter and you will see the following expression in the filter [Presentation View].[CPU Usage - NT].[Server_Name] =?Param_Server? Note: When a parameter is used in a filter, it will be surrounded by? 14. Now, run the report by clicking on the menu Run->Run Report HTML 29

30 Select a server and click on Run. 15. Output will look something like this. Save the report. 16. Lets try to do multiple selection of servers now. a. Go to the prompt page. b. Select the drop down (or Value Prompt) for server c. Go to the properties view i. Click Multi-Select and select Yes ii. For Select UI property, choose Check box group 30

31 d. Notice the change on the prompt design page e. Now, open the query (i.e. query1) used for the list on main page. And update the server filter to use in instead of = as follows: [Presentation View].[CPU Usage NT].[Server_Name] in?param_server? 17. Run the report 18. This will allow you to select multiple servers on the prompt page and the report will show the data for the selected servers only. 31

32 Exercise 5 Use summarized tables of Tivoli Data Warehouse The purpose of the exercise: Learn how to query the summarized tables or views in Tivoli Data Warehouse dynamically in a report. 1. Open the Test data model in the Framework Manager. 2. Go to Parameter Maps and create a new Parameter Map named NT_Processor_View 3. Add the parameters for NT_Processor for all summarizations with Daily as the default value. Note that Daily is set to 1 because it is recommended to use Daily as default table or view. 32

33 4. To access this parameter inside the model, you must use the following text string in the query subjects: #$[NT_Processor_View]{prompt('Summarization','token')}# where Summarization is the name of the parameter for the summarization selection combo box to be used in the report prompt page. Go to the query CPU Usage NT in the Consolidation View and replace [NT_Processor_DV] with the text string above in all the query items except Timestamp. Timestamp does not need any change as it does not use [NT_Processor_DV].[WRITETIME]. It references the WRITETIME data item from the same query subject. For example: For WRITETIME, replace the following: [Database View].[NT_Processor_DV].[WRITETIME] With: [Database View].#$[NT_Processor_View]{prompt('Summarization','token')}#.[WRITETIME] 5. Click OK. In the prompt window asking for Summarization, enter 1. It will validate and update the query subject. 6. Save the model. 7. Ensure that Database View and Consolidation View are packaged in the model in the hidden mode. Right click on Packages->Test Package->Edit Definition. 33

34 8. Publish the model (right click on Packages->Test Package and click Publish Packages). Ignore the error messages. 9. Open the saved report Test Report (or a copy of it) in Report Studio. 10.The report will prompt for summarization and when you provide 1, it returns a set of errors. 11.Now, add the summarization control on the prompt page. a. Go to prompt page and add a text field named Summarization. Select the style of the text from other labels and apply it to the Summarization label. b. Add the Value prompt to the prompt page. i. Provide Summarization as new parameter name and click Next. ii. Click Next without changing the default values. Click Finish. c. Add static choices in the properties of the Value prompt. 34

35 d. Add Conditional display values for all the supported summarizations. For this example, I will add only Daily and Hourly. e. Update the Default Selections in the same properties section to Daily. f. Save the report g. Run the report. In the prompt page, select All in the first drop down and select Hourly in the Summarization field. 35

36 h. View the output. Notice the hourly data appearing in the table. 12.Save the report. 36

37 Exercise 6 Use custom tables in report The purpose of the exercise: Group the servers in the Warehouse and filter the reports based on the groups. Assumption: The production environment would have groups defined and populated as part of the customization in the solution. 1. For this exercise, I will create a table in the Warehouse database (with the same schema name as ITM which is ITMUSER in my setup) a. Table: GROUP_SERVER CREATE TABLE ITMUSER.GROUP_SERVER (GROUP_NAME VARCHAR (250) NOT NULL, SERVER_NAME VARCHAR (250) NOT NULL) 2. This table will contain the mapping of group name to server names. 3. In my setup, I have added 2 groups and linked the servers to them INSERT INTO ITMUSER.GROUP_SERVER VALUES ('Critical Servers Group', 'winserver1'), ('Critical Servers Group', 'bladex1_acchassis_aem'), ('Non-Critical Servers Group', 'bladex1_acchassis_custom') 4. Open the saved report Test Report in Report Studio. 5. Go to Query Explorer, and add 3 queries a. Add SQL query to fetch the group server map. Query: select * from ITMUSER.GROUP_SERVER When you double click on Query_GroupList, ensure to set the Processing in properties view to Limited Local. Under the Data Items view you will see GROUP_NAME and SERVER_NAME listed. Ensure to set the aggregate functions for both data items as None in the properties view of the Data Item. b. Add a Query named Query_ServerDetails to fetch the server data. From Insertable Objects view, drag and drop Server_Name, Timestamp, AVG_%_ProcessorTime from CPU Usage NT into Query_ServerDetails query. 37

38 c. Now, add another query joining the above 2 queries.. Go to Query Explorer, drag and drop Join and name the query as Query_Group_Server. Now drag and drop Query_GroupList in the first box of the join, and Query_ServerDetails in the second box of the join. Now, double click on the link and set the join condition by clicking on New Link button. Ensure to select SERVER_NAME and Server_Name from the queries. 38

39 Click OK. Now, double click on Query_Group_Server and ensure to set the Processing in properties view to Limited Local. Now, drag and drop the data items from the 2 queries. Ensure to set aggregate functions of data items GROUP_NAME, Server_Name and Timestamp to None. 6. Now, go to the prompt page, add the label Group Name. (If you have used the report created in previous exercises, then you can remove the server list combobox and the Server Name label to avoid confusion.) 7. Drag and drop a Value prompt to the prompt page. Provide the parameter name as Param_GroupList and click Finish. 8. A new combo box will appear on the prompt page. In the properties view, set the Query to Query_GroupList. And set the Use Value and Display Value to GROUP_NAME. 39

40 9. The prompt page layout will look like this 10. Now go back to Queries Explorer, and double click on Query_Group_Server. Add a filter to this joined query, so that the servers from the selected group are only shown in the report. Filter Expression: [Query_GroupList].[GROUP_NAME] =?Param_GroupList? 11.Now, go to Page 1, and from the Data Items tab of the Insertable Objects view, drag and drop Query_Group_Server onto Page1. 40

41 12. Run the report 13. On the prompt page, you will see combo box with 2 group names in the Group Name combobox. 14. Select Critical Servers Group and Click Finish 41

42 15.To group the column by GROUP_NAME and Server_Name, go back to Page 1 on report studio, and select the respective column individually and select icon from the toolbar. Or click on menu item Structure- >Group/Ungroup. It will appear like this on Page 1 16.Now, run the report with same input 17.List in the report would look like this 42

43 18. Save the report. 43

44 Exercise 7 Add a chart to the report The purpose of the exercise: Learn how to add a chart to the report. Note: You can use a copy of the report created from Exercise 4 here. 1. Drag a line chart and drop it above the table. 2. Drag the data items and drop them into the chart. Drop the Timestamp in x-axis, AVG_%_Processor_Time in y-axis and Server_Name in Series box 44

45 3. Right click on the chart and select Go to Query. 4. In the query, select AVG_%_Processor_Time, and set its aggregate functions to average in the properties. 5. Save the report 6. Run the report with Daily. 45

46 7. Now, try the report with Hourly. 46

47 47

48 Exercise 8 Add a drill down capability The purpose of the exercise: Learn how to add a drill down capability for Timestamp in the chart. 1. Open the data model in Framework Manager 2. Open the Consolidation View-> CPU Usage NT, add query items that represent Year, Month, Day, Hour. For Year, the query item expression is: cast(substring([consolidation View].[CPU Usage - NT].[WRITETIME], 1, 3), integer) For Month, the query item expression is: cast(substring([consolidation View].[CPU Usage - NT].[WRITETIME], 4,2),integer) For Day, the query item expression is: cast(substring([consolidation View].[CPU Usage - NT].[WRITETIME], 6, 2), integer) 3. Click OK. 4. In the Project Viewer, select ([Consolidation View].[CPU Usage - NT].[Year] and set the Usage field in the properties view to Attribute. Do the same for Month, Day and Hour 5. Create a folder called Dimensions under the Consolidation View. Click Next. Click Finish. 6. Under the Dimensions folder, create a Regular dimension called Time Dimension. Drag and drop Year, Month and Day from ([Consolidation View].[CPU Usage - NT] into the hierarchies section. a. Rename the first row to Period. 48

49 b. Under Hierarchies, select Year. In the levels section below, click on the Role button.. Under Default Roles tab, select _businesskey. 49

50 Under the levels, add another level called Year Caption. And set the expression as follows: cast([consolidation View].[CPU Usage - NT].[Year], char(4)) For the Role, select _membercaption. Add similar entries for Month and Day. Click OK. 50

51 7. Create a shortcut of Time Dimension and move it to the Presentation View 8. Publish the model. Ignore any Info messages. 9. Open Test Report in Report Studio. 10.Cut the Timestamp in the x-axis of the line chart and drop Period from Time Dimension. 11. For Hierarchy, choose Root members 51

52 12.Go to the Data menu and select Drill Behavior. 13.Select the Allow drill-up and drill-down option. 14.Click OK. 15.Run the report. 16.The output of the report will show the chart with average value for all years. When you drill down, it shows the years in x-axis, then month, and then days. If you choose hourly summarization, another layer of drill down will show you the hours. 52

53 53

54 Exercise 9 Export report package The purpose of the exercise: Learn how to export a report package. 1. Open Tivoli Integrated Portal console. Go to Common Reporting- >Reporting->Launch->Administration. In the Configuration tab, click Content Administration and then the New Export icon. 2. Enter Test Package as the export name and follow the New Export wizard. 3. In the Select the public folders content New Export wizard pane, scroll the section to the right and click Add. 4. Select Test Package and move it to the other set. Click OK. Now, select the checkbox for Test package and move on to the next panes. 54

55 5. Ensure an archive name is provided in the box. 6. When you complete the New Export wizard, click Finish, and then Run. 7. The archive file is in the following location: <TCR_HOME>\tipv2Components\TCRComponent\cognos\deployment For e.g., on Windows: C:\IBM\tivoli\tipv2Components\TCRComponent\cognos\deployment 55

56 Exercise 10 Import report package The purpose of the exercise: Learn how to import a report package into another instance of TCR. 1. Copy the report package (that was exported in the previous exercise) from the deployment folder of current TCR to the deployment folder of the new TCR. 2. Open Tivoli Integrated Portal console. Go to Common Reporting->Reporting- >Launch->Administration. In the Configuration tab, click Content Administration and then the New Import icon. 3. Choose Test Package 4. Click Next. 5. Provide name as Test Package. Click Next. 6. Select checkbox of Test Package. Click Next. 7. Click Next. Click Next. Click Finish. Click Run. Click OK. 8. Go back to Connection page from the Launch menu bar. The Test Package will be listed under the Public Folders. And all reports under it. 56

57 57