How To Create a Report in Report Studio

Transcription

1 How To Create a Report in Report Studio This topic leads you through the process of creating and saving a new report. You will use the method of creating a report that is based on the design of sample reports. Following step-by-step instructions, you will learn how to complete these tasks: Build a multi-page report with a multi-element Trend chart Create the queries that are used to gather data for prompts Build a prompt page to select the subjects, granularity, and time range and to organize prompts into selection fields Create a query that specifies how ehealth gathers data from the ehealth database to satisfy the input prompts entries Populate the report, which defines the pages that the user sees after the report runs Save the report to a location on the ehealth system Note: When the content language is set to French, custom expressions have to use a semi-colon instead of a comma as an expression list delimiter. These expressions generally take the form of IN (num1, num2,..., numx), but any expression list defined in Report Studio has to use the semi-colon delimiter for French. You can use the comma as a delimiter for all other languages. Page 1

2 Step 1: Create a New Line Chart Report To create a line-chart report 1. Start Report Studio by clicking the link on the Report Center home page. The Welcome dialog appears. Close the dialog. 2. Click File, New. The New dialog appears. 3. Select Chart and then click OK. The Insert Chart dialog appears. 4. Select Line under Chart group. Chart types appear on the right. 5. Select Line (first row, second choice) under Chart type and then click OK. Report Studio queries the ehealth database to populate the Insertable Objects list, which defines the data that you can add to your report. This process often takes a few minutes. The following graphic shows Insertable Objects on the left and the drop zones for the Line chart on the right. Page 2

3 Step 2: Create Report Prompt Queries Most reports require the user to respond to one or more prompts for the information to include in a report. For these types of reports, you must also create a prompt page and the queries that are used to gather the ehealth data used in the prompts. Step 3 describes how to design the prompt page that the user sees. This step describes how to create the data queries used in the prompts. Prompts within a page typically include values like the subject of the report, the report time ranges or report period, as well as the granularity or sample sizes for the data (for example: as-polled, hourly, or daily values). The following procedures describe how to create a query for each type of prompt. To create a subject prompt query 1. Select Query Explorer in the Explorer Bar and click Queries. The work area displays Dimensions, Facts, Filters, and Tabular Data areas. 2. Click the Toolbox tab in the Insertable Objects area and double-click Query. Two queries named Query1 and Query2 appear. 3. Select Query2, and in the Properties area, change Name to Subject Prompt. Query1 will be used for the chart data in Step Double-click the Subject Prompt query. 5. Click the Source tab in the Insertable Objects area and then expand General Dimensions, Element/Group, Element and drag Element Name into Data Items twice. Page 3

4 6. Expand Key Information under Element and drag Element UID into Data Items. 7. Click Element Name1 under Data Items, and in Properties, change Name to Upper Element Name. 8. Change Expression to upper([general Dimensions].[Element].[Element Name]) Then click OK. 9. Expand Measurements, LAN/WAN in the Insertable Objects area. 10. Drag LAN/WAN Filter into Detail Filters. The subject prompt query appears as shown in the following graphic. Page 4

5 To create a sample size prompt query 1. Select Query Explorer in the Explorer Bar and click Queries. Note: In the right pane, an icon appears for the subject query that you created in the previous procedure. 2. Click the Toolbox tab in the Insertable Objects area and double-click Query. A Query2 icon now appears in the right pane. 3. Select Query2 and in the Properties area, change Name to Sample Size Prompt. 4. Double-click the Sample Size Prompt query. 5. Click the Source tab in the Insertable Objects area, expand General Dimensions and Measurement Granularity, and then drag the entire Measurement Granularity folder into Data Items. The Sample Size Prompt query appears as shown in the following graphic. Page 5

6 To create a report header query 1. Select Query Explorer in the Explorer Bar and click Queries. 2. Click the Toolbox tab in the Insertable Objects area and double-click SQL (not Query). New Query2 and SQL icons appear in the right pane. 3. Click Query2, and in the Properties area, change Name to Query for Report Header. 4. Click the SQL icon next to the Query for Report Header query. 5. Set the Data Source to ehealthdb in the Properties area. 6. Double-click the SQL icon next to the Query for Report Header query and enter the following: Note: The following should be one long line. Do not lose the spacing at the ends of the lines in this document. select current_date CURRENT_DATE_TIME, nh_report_period_to_date(#prompt('select Report Period','text')#,'begin',#prompt('Report Period Begin','text')#,#prompt('Report Period End','text')#) REPORT_PERIOD_BEGIN, nh_report_period_to_date(#prompt('select Report Period','text')#,'end',#prompt('Report Period Begin','text')#,#prompt('Report Period End','text')#) REPORT_PERIOD_END, nh_report_resolve_uids(#prompt('element UIDs','text')#,'element','names') ELEMENT_NAMES from dual 7. Click Validate and then OK. 8. Select Query Explorer in the Explorer Bar, click Query for Report Header, and verify that the following four items are under Data Items: Page 6 CURRENT_DATE_TIME REPORT_PERIOD_BEGIN

7 REPORT_PERIOD_END ELEMENT_NAMES These items are shown in the following graphic. Page 7

8 Step 3: Create the Report Prompt Page The prompt page, usually the first page that appears when users run a report, contains the fields where users specify values. The queries that you created in the previous step provide the content for the prompts to which users must respond. The prompt page that you will create organizes the prompts into selection fields. To create the prompt page 1. Select Page Explorer in the Explorer Bar and click Prompt Pages. 2. Click the Toolbox tab in the Insertable Objects area and double-click Page. 3. Double-click Prompt Page1. 4. Click the Toolbox tab from Insertable Objects and drag 'Table with 2 Prompt Fields & Date/Time Prompt' to the center of the Prompt page. Results are shown in the following graphic. Page 8

9 To create the subject prompt 1. Click the first Text Item (Label) in the Report Parameters table: 2. Change Text to Elements in the Properties area. 3. Click the Toolbox tab in the Insertable Objects area and drag the Select & Search Prompt into the cell to the right of the Elements: Text Item. The Prompt Wizard dialog appears. 4. Create a new parameter named Element UIDs and click Finish: 5. Click the Select & Search Prompt and in the Properties area change Query to Subject Prompt. 6. Change Use Value to Element UID. 7. Change Display Value to Element Name. 8. Change Multi-Select to Yes. 9. Click the ellipsis next to Sorting. The Sorting window opens. 10. Double-click Upper Element Name under Data Items to add it to Sort List and click OK. Page 9

10 Page 10

11 To create the sample size prompt 1. Click the second Text Item (Label) in the Report Parameters table. 2. Change Text to Sample Size in the Properties area. 3. Click the Toolbox tab in the Insertable Objects area and drag a Value Prompt into the cell to the right of the Sample Size: Text Item. The Prompt Wizard dialog appears. 4. Create a new parameter named Measurement Granularity and click Finish. 5. Click the Value Prompt area, and in the Properties area, change Query to Sample Size Prompt. 6. Change Use Value to Granularity Type. 7. Change Display Value to Granularity. 8. Click the ellipsis next to Sorting. The Sorting window opens. 9. Double-click List Order under Data Items to add it to Sort List and click OK. 10. Click the ellipsis next to Default Selections in the Properties area, General section. The Default Selections dialog appears. 11. Click the Add a new Default Selection icon. The Add dialog appears. 12. Click Simple Selection, enter B, and click OK twice. Page 11

12 Step 4: Create the Report Data Query The Report Data Query specifies how ehealth gathers the data used for the input prompts and how that data is used to query the ehealth database when the report runs. To create a report data query 1. Select Query Explorer in the Explorer Bar and click Query1. 2. Change Name to Report Data in the Properties area. 3. Locate the Insertable Objects area on the Model page, expand General Dimensions, Date/Time, Date Time, and then drag Date and Time (shown in the following graphic) into Data Items. 4. Change Pre-Sort to Sort ascending in the Properties area. 5. Expand General Dimensions, Element/Group, Element and drag Element Name into Data Items twice. 6. Click Data Items, Element Name1, and in Properties, change Name to Upper Element Name. 7. Change Expression to upper([general Dimensions].[Element].[Element Name]) Then click OK. 8. Change Pre-Sort to Sort ascending in the Properties area. 9. Expand Measurements, LAN/WAN, Prompted LAN/WAN Measurements. 10. Scroll down and drag Bytes/sec into Data Items. 11. Click the Toolbox tab in the Insertable Objects area and double-click Filter. The Tabular Model Filter dialog appears. 12. Enter the following in the Expression editor: Note: The following should be one long line. Do not lose the spacing at the ends of the lines in this document. ([General Dimensions].[Date Time].[Date and Time] >= nh_report_period_to_date(?select Report Period?,'begin',?Report Period Begin?,?Report Period End?)) AND ([General Dimensions].[Date Page 12

13 Time].[Date and Time] <= nh_report_period_to_date(?select Report Period?,'end',?Report Period Begin?,?Report Period End?)) 13. Click OK. 14. Click the Toolbox tab in the Insertable Objects area and double-click Filter. The Tabular Model Filter dialog appears. 15. Enter the following in the Expression editor: [General Dimensions].[Element].[Element UID] IN?Element UIDs? 16. Click OK. Your report data query appears as shown in the following graphic. Page 13

14 Create a new report data query with different variable 1. Select Query Explorer in the Explorer Bar and double click Queries. 2. Right click the Report Data query icon, and then select Copy 3. Right Click the right pane blank area, and then select Paste. A new query Report Data1 appears 4. Double Click the Report Data1 icon. 5. Locate the Insertable Objects area on the Source tab, expand Measurements, LAN/WAN, Prompted LAN/WAN Measurements. 6. Scroll down and drag Bandwidth Utilizations into Data Items. 7. In the Data Items area, select Bytes/sec, click Delete icon in the Report Studio toolbar to delete it. Now you have two queries for different charts. Page 14

15 Step 5: Populate the Chart Populating the chart is the process for specifying and defining the output report or the pages that the user sees after running the report. In this step, you will define the content of the line chart report and specify a limit for the number of elements that appear in the report. To populate the chart 1. Select the Page Explorer button in the Explorer Bar and click Page1 under Report Pages. 2. Click the Combination Chart to select the entire chart. 3. Verify that the Query is set to Report Data in the Properties area, under Data. 4. Open Size & Overflow in the Properties area under Positioning, set Width to 800 px (pixels) and Height to 500 px, and then click OK. 5. Click the Data Items (middle) tab in the Insertable Objects area. 6. Locate the area under the Report Data query folder and drag the following items to the chart as follows: Bytes/sec to the Measures field Date and Time to the Categories field Element Name to the Series field 7. Click Element Name on the chart to select it 8. Click the ellipsis next to Sorting in the Properties area. The Sorting window opens. 9. Double-click Upper Element Name under Data Items to add it to Sort List and click OK. 10. Click Date and Time on the chart to select it. 11. Click the ellipsis next to Sorting in the Properties area. The Sorting window opens. 12. Double-click Date and Time under Data Items to add it to Sort List and click OK. The results are shown in the following graphic. Page 15

16 Page 16

17 Add a new Chart with different Variable 1. Select Page Explorer in the Explorer Bar and click Page1, under Report Pages. 2. Click the Toolbox tab in the Insertable Objects area. 3. Drag a Block to the area below existing combination chart, and then click to select the new added block. 4. Click the Toolbox tab in the Insertable Objects area. 5. Drag a Chart into the new block, and then select Line Chart in Chart Group, and Line in Chart Type, click OK. The new chart is created. 6. Click the Combination Chart to select the entire new chart. 7. Verify that the Query is set to Report Data1 in the Properties area, under Data. 4. Open Size & Overflow in the Properties area under Positioning, set Width to 800 px (pixels) and Height to 500 px, and then click OK. 5. Click the Data Items (middle) tab in the Insertable Objects area. 6. Locate the area under the Report Data1 query folder and drag the following items to the chart as follows: Bandwidth Utilization to the Measures field Date and Time to the Categories field Element Name to the Series field 7. Click Element Name on the chart to select it. 8. Click the ellipsis next to Sorting in the Properties area. The Sorting window opens. 9. Double-click Upper Element Name under Data Items to add it to Sort List and click OK. 10. Click Date and Time on the chart to select it. 11. Click the ellipsis next to Sorting in the Properties area. The Sorting window opens. 12. Double-click Date and Time under Data Items to add it to Sort List and click OK. Now the new chart is ready. Page 17

18 Page 18

19 To limit the number of elements in the output to Select Page Explorer in the Explorer Bar and click Prompt Page1. The prompt page that you created earlier appears in the right pane. 2. Double-click the right-most yellow HTML Item at the bottom of the page. This icon is shown in the following graphic. The HTML editor window appears. 3. Enlarge the HTML editor window and scroll all the way to the right. 4. Find the following string: nhinithandlers("default") 5. Change "default" to the following: "numelemcheck" 6. Click the Select & Search Prompt for Elements in the prompt page area, and in the Properties area, set the Name to the following: ID_nhrc Page 19

20 Step 6: Complete and Save the Report After you enter the information for the report, you must save the report to a location on the ehealth system. You can save it to the My Folders area or to the Public Folders area, where other report consumers, with appropriate permissions, can run it. To complete and save the report 1. Select Page Explorer in the Explorer Bar and click Page1, under Report Pages. 2. Click the Toolbox tab in the Insertable Objects area. 3. Drag Title/Subtitle/Date/Time Header into the header area of the report. 4. Click View from Report Studio menu, and then select Page Structure. The Page Structure tree view appears in the right pane, select the Repeater Table. 5. Verify that the Query is set to Query for Report Header in the Properties area, under Data. 6. Click the ellipsis next to Properties. The Properties window opens. Page 20

21 7. Click Select All to select the four data items and click OK 8. Click File, Save and type the name for the report. 9. Click OK. The report is now ready to run. Page 21

22 PS: Schedule Reports You can schedule reports and automate them to start during the night and finish before you arrive at work. Running reports during off-peak hours helps to reduce impacts on the ehealth system during peak hours, especially when reports take a long time to run. You typically save a report as a report view or as saved report to review the report when you want to see it. To schedule a report 1. Click the Schedule icon for a report. The Schedule page appears. 2. Specify the options for how often you want the report to run as well as the start and end options. Note: As a best practice, do not use the No end date option. Schedules should have specific end dates to prevent the performance impact of many scheduled reports that continue to run even though you may no longer read them. 3. (Optional) Do the following to override the default prompt values (or if default prompt values are not set for the report): a. Scroll to Prompt values at the bottom of the page and select Override the default values. b. Click Set... to set the prompt values for the scheduled report. The Prompt Page appears. c. Complete the required fields on the Prompt Page. d. Click Finish to save your settings and exit the Prompt Page. 4. Specify the output formats and delivery methods. 5. Click OK. The schedule is saved. Page 22