InfoMaster REPORT DESIGNER

Transcription

1 InfoMaster REPORT DESIGNER

2 TABLE OF CONTENTS About Customized Advanced Reports... 2 Pre-Defined Advanced Reports... 2 Create Custom Advanced Report... 4 Goal: Final Report... 4 Creating custom report: step 1, Setup and Adding the Data... 5 Adding a Summary Table of Rehab Actions Vs Pipe Count, Pipe Length Adding a Bar Chart of Pipe Materials Vs Pipe Length Adding a Bar Chart of Risk Vs Pipe Length Saving the Report Template as.repx File Page 1

3 ABOUT CUSTOMIZED ADVANCED REPORTS InfoMaster s Advanced Reports option gives users the ability to create PDF reports based on the results data from an InfoMaster model. It is a very flexible feature, but with flexibility comes complexity. This User Guide is designed to assist users looking to apply this powerful, but more advanced, InfoMaster function. InfoMaster s Advanced Reports can be found in the Toolbox of the IM Operation Center. InfoMaster comes with some pre-built Advanced Reporting options as well as the option to customize PDF reports. All Advanced Reports are essentially built off of two files:.json and.repx files. JSON files are open file documents which essentially store all the data the user would like to include in an Advanced Report. REPX files store the desired report template to display the data and results. This combination of raw data and an adjustable report template give InfoMaster users almost infinite options in creating PDF reports. PRE-DEFINED ADVANCED REPORTS InfoMaster users do not have to build custom reports from scratch or even design a report at all to create their first PDF report. InfoMaster comes downloaded with a few options already built in. These options include reports based on Survey Import, Work Manager, and Rehabilitation data. The following steps demonstrate how users can generate one of these Advanced Reports. 1. In the Toolbox within the IM Operation Center, right-click on Advanced Report and click New. 2. Enter Example, Rehab Analysis for the ID and Description. 3. Click Next in the initial window to accept the name and description. 4. In the next window, users select the type of report they d like to create. Select Rehabilitation Plan -> Facility Rehabilitation Plan and click Next. Page 2

4 5. In the next window, select a facility type which you have run Rehab Analysis for, the specific Rehab Analysis, and then click Next. Note that for some report types this step will not be required. 6. The last window allows users to choose the scope which this report should include. Users can also click Advanced Options to edit where and in what format this report is saved. Click Finish to generate and view the report 7. Once the report has been created, it can be recalled from the IM Operation Center so long as the InfoMaster project and PDF report are not moved. Page 3

5 CREATE CUSTOM ADVANCED REPORT The following steps outline how users can create their own custom reports. Custom Advanced Reports can be created when the user is looking for specific results to display and communicate not found within the pre-defined options. GOAL: FINAL REPORT At the end of this section, we want to create a rehab summary report that has: 1. A table listing all of the rehab action with Total Pipes Count, Pipes Count (Percent), Total Length (Miles), and Pipe Length Percent 2. A Pie Chart that show rehab action with its corresponding percentage. 3. A Bar Chart that plots Pipe Material Vs Pipe Length (Miles) 4. A Bar Chart that plots Pipe Age Vs Pipe Length (Miles) Page 4

6 CREATING CUSTOM REPORT: STEP 1, SETUP AND ADDING THE DATA 1. In the Toolbox within the IM Operation Center, right-click on Advanced Report and click New. 2. Enter Example, Rehab Analysis for the ID and Description. 3. Click Next in the initial window to accept the name and description. 4. Now click Library Manager. Here is where all the different PDF report types are shown. Pre-defined reports cannot be edited, but they can be copied and the copies can be edited. Here you can also create brand new report types from scratch. 5. Click Custom and then New to create a brand new custom report. Name it Custom. 6. In the following window, keep the default Report Title and Category and click Next >. 7. The Report Template Library will now appear. Here is where users can choose which data to include in the Advanced Report. This is where you can import raw data from.json files or reference tables from within your InfoMaster database or Table of Contents. Users can also create relationships between tables in this window. Page 5

7 9. Right click on the box on the left, and select Add Table 10. In the new dialog box, using InfoMaster Data option, select Gravity Main and Rehab Summary tab 11. In the same dialog, Query Builder can be used to create query string to filter data. In Select Columns tab, columns of the selected table can be included/excluded by checking/un-checking them. Right clicking will bring up a menu to Select All or Un-Select All. Page 6

8 Click Next and the dialog will close. The selected table will be added to the tree on the left. The table can be expanded to show all columns. To create the final report, pipes attributes such as Install Year, Pipe Length, and Pipe Material need to be included. Therefore, pipe s table need to be added to this Dataset. 12. Right clicking on the Rehab Summary table and select Add Table 13. In the new dialog, select Gravity Main table. Query string can be entered, if needed. Columns can also be included/excluded under the Select Columns tab Page 7

9 14. Click Next and the dialog will close. The pipe table should now be added to the tree under the Rehab Summary table. Select this gravity main or pressurized main table by left click it, its property should be shown on the right. Its name and its relationship with Rehab Summary table can be edited now. One or more pair of columns can be used as keys. In this example, PipeID from Rehab Summary and FacilityID from Pipe table will be selected as the keys. Click Save in the toolbar when all changes are made. 15. Once the Pipe table is added to the tree and the relationship set, Install Year, Pipe Material, and Pipe Length can be added onto Rehab Summary table for the reporting purpose. Right click on Rehab Summary table s name or any of its columns names and select Add Calculated Field Page 8

10 16. In the new dialog, expand Rehab Summary tree and then expand the Gravity Main or Pressurized Main table tree. Locate InsallDate field, click on Max on the right, and the double click on the InstallDate field. Max( Child(ssGravityMain).InstallDate) should be entered into the box under Field=. Field name is also entered if there is none. It can be changed to anything desired name. Select Date as the type. Click Validate and OK. 17. Repeat the process for Field Pipe Material (Text) and Pipe Length (Decimal). Page 9

11 18. Repeat one more time to add a field name Pipe Length in Miles. Again use the Pipe Length field in the pipe table, but this time divide it by The formula should read Max( Child(ssGravityMain).PipeLength )/5280. Select Decimal as the data type. 19. At the end, you should see the four added fields in the tree. Click Save as to save this dataset as a.json file for future. This file can be brought into InfoMaster to generate other reports. Click Next. Page 10

12 Creating custom report: step 2, Report Template 1. Click New (Layout), InfoMaster will start loading data and a blank report designer will open. This Report Template Library Window can display different.repx files you may wish to use as a custom report. You can create new templates here, load saved ones, and edit saved templates as well. In the Field List on the right, the tables selected earlier are shown with the fields that were added. Page 11

13 Adding a Report Title, Date, and Time 2. Add a title INFOMASTER REHAB REPORT and a date to the top of every page. To do this, a Page Header Band needs to be added to the report. Right click inside the Detail select Insert Band -> PageHeader 3. A Page Header Band will be repeated on every page, A Report Header Band will only appear once at the beginning of the report. In the Tool Box on the left, drag Label into Page Header Band and type in INFOMASTER REHAB REPORT. Resize the label by dragging the edge of the label. With the label selected, change its property on the Property Grid on the right. Locate its Font property and change it to Calibri, Bold, and size 24. Locate its Foreground Color property and change it desired color. 4. In the Tool Box on the left, drag Page Info next to the PageHeader or report title. Click on the arrow on the upper right of the Page Info and select Current Date and Time under Page Information. You can also change the format displayed by clicking Format under Page Info Tasks. Resize the Page Info by dragging the edge. With it selected, change its property on the Property Grid on the right. Locate its Font property and change it to Calibri, Bold, and size 10. Locate its Foreground Color property and change it desired color. Page 12

14 5. Right click inside the detailband1, select Insert Band -> GroupHeader A Group Header is repeated once for each group. In this report, no groups are specified so this band will only appear once. 6. Repeat step 3 to add a label into Group Header and enter Rehab Breakdown Change its Font, Foreground Color, and Background color as desired. Page 13

15 ADDING A SUMMARY TABLE OF REHAB ACTIONS VS PIPE COUNT, PIPE LENGTH 7. In Tool Box, drag Pivot Grid into your GroupHeader1. Adjust the size and click on the arrow on top. Select Facility Rehabilitation Plan as the Data Source. Then click Run Designer at the bottom 8. A Pivot Grid Designer will open. The Pivot Grid Designer allows users to choose from all the field types within the.json file and create pivot tables from them. Existing fields in Rehab Summary are listed under Field List. Double click on Actions, PipeID (twice), and Pipe Length in Miles (twice). Five fields are added and shown in the middle column. 9. Click on Actions, on the property grid on the right, locate Area property and change it to Row Area. 10. Click on the first PipeID, on the property grid on the right, locate Caption property and enter Total Pipes Count. Locate under Data, locate Summary Type, and change the type to Count. Under Behavior, locate Area property and change it to Data Area. Page 14

16 11. Click on the second PipeID, locate Caption and change to Pipes Count (Percent). Locate Summary Type and change it to Count. Locate Summary Display Type and change it to Percent Of Column Grand Total. Locate Area property and change it to Data Area. 12. Click on Pipe Length in Miles, change Caption to Total Length (Miles). Locate and expand Total Cell Format, enter Numeric in FormatType and #,###.## in Format String. Locate Area property and change it to Data Area. 13. Click on the second Pipe Length in Miles and change Caption to Pipe Length (Percent). Locate Summary Display Type and change it to Percent Of Column Grand Total. Locate Area property and change it to Data Area. 14. Click on the Layout on the left, if everything is done corrently. The table should looks similar to the one below. Reorder and resize as needed. Close the designer and click Save if prompted. 15. Back in the report designer, highlight the Pivot Grid and locate its property on the right. Inside the property grid, locate and expand View Options, locate Show Data Headers and change it to No. Page 15

17 Adding a Pie Chart of Rehab Action Vs Pipe Length Percentage 16. In the report designer, drag Chart from the Tool Box from the left into the same Group Header Band. A Chart Wizard will open. Locate and select Pie as the Chart Type. Click Next. 17. Select color and style for the Pie, Click Next. 18. Default Series. Click Next. Page 16

18 19. In the Data section, select the Series Binding tab. Locate and change Argument to Actions column. 20. In the same section, locate and change Binding mode to Summary Function. Click on the eclipse in Summary Function. A Summary Function dialog will open. Change the dropdown to SUM, and select Pipe Length in Miles as the column. Click OK. Page 17

19 21. At this point, the Pie chart is ready. More options (Title, Label, Color, etc ) can be change in the wizard. On the left, click on Point Labels and then click on the Point Options tab. Change Point view to Argument and Values. This will show both the Rehab Action and the percent value. Click Finish. Page 18

20 ADDING A BAR CHART OF PIPE MATERIALS VS PIPE LENGTH 22. Right click inside the detailband1, select Insert Band -> GroupHeader, click on the arrow on top to re-order the bands if needed. This second band should be after your band containing the table and pie chart. With the Group Header Band selected, locate Page Break property in the Property Grid and change it to Before the Band. 23. Create a label Pipe Material Breakdown and change its Font, Color, and style as desired. Drag in Chart from the Tool Box and select Bar as the Chart Type. Click Next. 24. In Appearance, Choose its color and style. Click Next 25. In Series section, there will be two series by default for Bar chart. Only one is needed. Click Remove to delete one. Click Next. Page 19

21 26. In Data section, navigate to Series Binding tab. Change Argument to Material field from Rehab, change Binding mode to Summary Function, and point Summary Function to Pipe Length in Miles from Rehab. 27. In Point Labels section, Point Options tab, make sure Value format is number and Value precision is set to 2 so that the numbers will be properly formatted. Page 20

22 28. In Axes section, select Primary AxisX in the dropdown box on the upper right. Go into Elements tab -> Title tab and check Visible to add a title to the X-axis. Change Text to Material. 29. Change to Primary AxisY on the dropdown on the upper right, repeat the process and add Length In Miles to the Y-axis. Page 21

23 30. Change any other options as desired. Click Finish. Resize the Bar chart on the report designer as desired. ADDING A BAR CHART OF RISK VS PIPE LENGTH 31. If you have a Risk analysis you d like to report, repeat step in the last section with the exception on step 26. Choose Risk as the report argument instead of the Material in step 26. SAVING THE REPORT TEMPLATE AS.REPX FILE 32. The report is now complete. Click File -> Save and name it anything you want. Page 22

24 33. Close the Report Designer. The template name and path should be listed and now you can proceed to generate the report in any format you want. This report format will now be saved in your Report Template Library. Page 23