1. Home
  2. Knowledge Base
  3. GeoHECHMS
  4. Generate Report Command

Generate Report Command

An important aspect of performing an engineering study is documenting the study findings in an engineering report. The Generate Report command of GeoHECHMS allows users to create engineering reports detailing the hydrology study. Most aspects of the report are automatically generated by the software so that users do not have to worry about adding different figures, graphs, tables, and more into a report document.

Once the report is created, it can then be saved as a template to be used in other engineering projects. In addition, users can simply adopt a previous engineering report for use as a template by modifying the report to fit the current engineering study.

To use the Generate Report command, follow the steps below:

  1. From the Results ribbon menu, select the Generate Report command.
    Generate Report command
  2. The Generate Report dialog box will be displayed.
    Generate Report dialog box

The below sections describe how to generate a report for a project and interact with the above dialog box.

General Settings

The General Settings panel is used to specify general format settings for the report pages.
General Settings panel

The following entries are provided on this panel:

  • Paper size
    This dropdown combo box lists standard sizes of paper. Note that the content of the dropdown combo box changes based on project units. The user can select the desired paper size. The selected size is stored at the application level and recalled for future applications.
  • Page numbering
    This dropdown combo box lists different page numbering formats. The following formats are available:

    1. Page # (default)
    2. Page # of ##
      Note that page numbering is not available for the Cover Page or the Table of Contents section.
  • Watermark
    This editable dropdown combo box lists watermarks that can be included in the page background. This entry is saved at the project level. The user can click the [Add New Watermark] button to create new watermarks. In this way, the user can enter something in a foreign language (i.e., German) to be placed as the page watermark.
    Watermark dropdown entry

    In addition, the user can rename or even delete the CONFIDENTIAL and DRAFT entries by clicking the pencil icon next to this entry.
  • Title page date format
    This dropdown entry allows the user to select the date format for the title page from the listed formats.
  • Numeric Formatting
    This section contains a Use delimiters for large number formatting checkbox option. By default, this checkbox is checked. It causes the software to format large numbers using a delimiter.
  • Report Template
    This section allows the user to choose either the default or custom template for generating the report. Clicking the [Edit] button opens the custom template file for editing the cover page template. The user can click the [Restore] button to restore the cover template to factory default.
  • Page Header and Footer
    The section allows the user to include header and footer sections in the report pages. By default, this section is enabled. The user can define the header and footer text for odd and even pages in the respective entry fields of this section. Note that only two lines of text are allowed. If the user unchecks the Page Header and Footer checkbox, then the header and footer will not be included in the pages, and this section will be disabled.

Title Page

The Title Page panel is used to define the contents of the report title page.
Title Page panel

If the Title Page Contents checkbox option is checked, then the following entries are enabled:
  • Company logo
    This entry defines the company logo to be placed at the top of the page. Note that this entry is stored at the application level so that the next report already includes the company logo. Clicking the […] lookup button will display the Select Corporate Logo dialog box that allows the user to select the company logo file.
    Select Corporate Logo dialog box
  • Project title, Project subtitle, Prepared for and Prepared by
    These entry fields allow the user to define content for the project’s title, subtitle, prepared for, and prepared by headings. The defined entries are stored at the application level and recalled the next time the application is used.
  • Report date
    This checkbox option allows the user to include a date on the report’s title page. By default, this entry displays the current date. However, the user can click on the calendar control to select an alternative date. Note that the format of the listed date will be based on the computer’s location settings. For example, dates in the USA are formatted differently than in Europe. In addition, the user can manually type in the date—”July 2021″, for example— where it is just a month and year, with no date listed. If this entry is unchecked, no date will be listed on the title page.

Project Map

The Project Map panel is used to define the project map to be displayed in the generated report. If the user unchecks the Project Map checkbox, then the project map will not be included in the report. Note that this panel is disabled if the user has not defined a base map layer for the project. Refer to this article in our knowledge base to learn how to add a base map layer to your project.

The Project Map panel has three major subpanels, as described below:

Project Area

The Project Area subpanel displays an independent base map view of the main Map View. Initially, the subpanel shows the current Map View extents, but the user can zoom and pan this view using the mouse cursor. It is used to determine the extents of the project area map to be shown in the report.
Project Map panel

The user can select the project base map from several high-quality base maps available in the Project base map provider dropdown combo box. The Use grayscale base map checkbox is unchecked by default but saved at the application level when activated. Selecting this checkbox would cause the base map to be in grayscale rather than in color.

Region Area

The Region Area subpanel displays an independent base map view of the main Map View. Initially, it shows the current Map View extents four times, but the user can zoom and pan this view using the mouse cursor. It is used to determine the extents of the region area map to be shown in the report. The map view window defines the final project area map.
Project Map panel - Region Area subpanel

The user can select the region base map from several high-quality base maps available in the Region base map provider dropdown combo box. The Include project area border, color checkbox is used to include a border around the region area. The user can select the color for the bordering lines from the dropdown palette. By default, this checkbox is checked.

Map Preview

The Map Preview subpanel displays the project map constructed using the project area map and the region area map. This subpanel represents the project map that will be included in the generated report.
Project Map panel - Map Preview subpanel

The user cannot adjust the project area map and the region area map from this subpanel. The user will need to return to the other two subpanels to make those adjustments. However, the user can draw basic elements on top of the project map, such as lines, shaded polygons, arrows, and text using the [Edit] button. On clicking the [Edit] button, the software will display the Edit Project Map dialog box. This dialog box contains a Diagram Editor (explained below) that allows the user to edit the Map Preview.

Edit Project Map dialog box

The user can add annotations and a North Arrow to the project map and perform other edits. Upon returning from the Edit Project Map dialog box, the Map Preview panel is updated with the changes made.

Contents

The Contents panel is used to define the entire contents of the generated report.
Contents panel

The Contents panel is divided into two sections as described below.

Include Scenarios

This section is used to define which scenarios should be included in the report.

Scenario

This column lists the available scenarios that are contained in the project. The user can toggle on and off the checkboxes next to the scenario name to include or exclude them from the generated report. Note that the current scenario is shown as selected if the analysis results are available. The other scenarios are shown as not selected.

Not all scenarios need to be defined for an output report. However, at least one scenario needs to be defined to generate a report for the project.

Custom Title

This column allows the user to change the scenario name to be listed in the engineering report. It allows the user to place a more meaningful name for the scenario being reported.

Computed

This column shows whether the analysis results are available to be included in the report. If the analysis results are available, this read-only entry states ‘Computed.’ If the analysis results are not available, the entry states, ‘Not Computed’ and the row is disabled.

Order

By default, the scenarios are listed in alphabetical order. However, this column can be used to change the order that the scenarios are reported in the file.

Include Report Sections

The section is used to define which sections of the report should be included in the generated report.

Report Section

This column lists all the available report sections. The user can toggle on and off the checkboxes next to the section name to include or exclude them from the generated report.

Custom Title/Options

This column allows the user to change the report section name to be listed in the engineering report. It allows the user to place a more meaningful name in the report section. For example, the user may want to translate the report section title into a different language (i.e., German).

Routing Diagram

The Routing Diagram panel is used to edit the HEC-HMS routing elements in the routing diagram. The user can grab the elements and move them around on the Routing Diagram panel to make the routing diagram more understandable. Note that the elements will stay linked together during these modifications.
Routing Diagram panel

The following options are available in the Routing Diagram panel:
  • Select scenario
    The user can select the scenario for editing using the Select Scenario dropdown combo box. This combo box lists all the scenarios that were selected in the Contents panel. As the user switches between scenarios in the combo box, the diagram preview window is updated to represent the selected scenario.
  • Reset Diagram
    On clicking the [Reset Diagram] button, the current diagram resets to show the routing elements as represented on the Map View.
  • Zoom and Pan Tools
    In the upper-left corner of the diagram preview, several zoom and pan tools provide the user more control in viewing the elements and routing symbols. To learn how to use these tools, refer to this article in our knowledge base.
  • Edit
    On clicking the [Edit] button, the software will display the Edit Schematic Diagram dialog box.
    Edit Schematic Diagram dialog boxThe above dialog box contains a Diagram Editor (explained below) that allows the user to edit the routing diagram and copy the edits from one scenario to another.
  • Display Options
    This section provides various display options to the user as described below:

    1. Display grid
      The Display grid checkbox displays a background grid on the canvas. This checkbox is checked by default.
    2. Snap to grid
      The Snap to grid checkbox causes the elements to snap to the background grid. This checkbox is unchecked by default. If the Display grid checkbox is unchecked, the Snap to grid checkbox option is disabled.
    3. Display element labels
      The Display element labels checkbox controls the display of the element labels next to the elements on the canvas. This checkbox is checked by default.
    4. Display routing arrows
      The Display routing arrows checkbox controls the display of the arrowheads on the ends of the routing arrows on the canvas. This checkbox is checked by default.
    5. Element size
      The Element size spin control allows the user to adjust the size of the elements on the canvas.
    6. Element label size
      The Element label size spin control allows the user to adjust the size of the element labels.
    7. Leader thickness
      The Leader thickness spin control allows the user to adjust the thickness of the routing arrows connecting the HEC-HMS elements on the canvas.

Diagram Editor

On clicking the [Edit] buttons of the Map Preview and Routing Diagram panels, the Edit Project Map and Edit Schematic Diagram dialog boxes will be displayed. These dialog boxes contain a Diagram Editor that allows the user to perform edits on the project map and routing diagram that will be reflected in the generated report.

Diagram Editor for editing the project map:
Edit Project Map - diagram editor

Diagram Editor for editing the routing diagram:
Edit Schematic Diagram - diagram editor

Note that the Diagram Editor grid size automatically changes as the user zooms in and out of the drawing canvas.

The below sections describe the functionality of various ribbon menu commands provided in the Diagram Editor.

Home Ribbon Menu

The Home ribbon menu contains the following commands:

  • Save Edits
    This command saves the user’s work in the Diagram Editor and returns the user to the previous dialog box.
  • Discard Edits
    This command discards the user’s work in the Diagram Editor. It then returns the user to the previous dialog box with the original diagram (before any changes were made).
  • Copy to Scenarios
    This command can be used to select the drawn entities to copy to other scenario diagrams. Note that this command is only functional in the Edit Schematic Diagram dialog box.

    Selecting this command will display the Copy To Scenarios dialog box.

    Copy To Scenarios dialog boxClicking the [Pick] button closes the Copy To Scenarios dialog box and allows the user to select diagram elements from the Diagram Workspace (other than base map elements and HEC-HMS elements) to duplicate on the other scenario diagrams. The user can select diagram elements, then right-click and choose Done from the displayed context menu or press the Enter key. The Copy To Scenarios dialog box will be redisplayed. The user can then select the scenarios from the Copy To Scenario Diagrams section to copy the selected elements and click the [Copy] button.

  • Undo
    This command implements the undo stack and allows the user to undo the changes.
  • Redo
    This command implements the redo stack and allows the user to restore any previously undone actions using the Undo command.
  • Restore
    This command restores the Diagram Editor to the original state (before any changes were made).
  • Paste
    This command pastes the objects copied to the Windows clipboard on the drawing canvas.
  • Delete
    This command deletes the selected objects from the drawing canvas.
  • Cut
    This command removes the selected objects from the drawing canvas and copies them to the Windows clipboard.
  • Copy
    This command copies the selected objects from the drawing canvas to the Windows clipboard.
  • Format Painter
    This command allows the user to quickly apply the same formatting, such as color, font style and size, and border style, to multiple objects in the drawing canvas. To learn how to use this command, refer to this article in our knowledge base.
  • Draw Text
    This command allows the user to click on the drawing canvas and insert a resizing word wrap text frame. The user can grab the corners and sides of the text frame to resize it. Clicking in the middle of the text frame allows the user to move the text frame to a different location. The user can type the text inside the frame. Once the user adds text, it will be displayed at the top of the frame, aligned based upon the text justification selected (i.e., left, center or right).
  • Draw Polyline
    This command allows the user to draw linear and curvilinear polylines on the drawing canvas.
  • Draw Shape
    This command allows the user to draw various basic geometrical shapes, block arrows, flow chart symbols, and containers on the drawing canvas.
  • Draw Callout
    This command allows the user to place a note with an arrow pointing to a feature of interest. After selecting this command, the user can click on a point in the drawing canvas to place the callout note and draw the callout polyline bend points or arrowhead. Note that holding down the [Shift] key while drawing arrowheads creates orthogonal lines. Once finished, the user can press the [Enter] key or right-click and choose Done from the displayed context menu.

    The user can drag parts of the callout object and move them independently of other parts. Clicking and dragging the corner and mid-point grips of the note text block allows the user to resize the block. While resizing, the text will reflow within the text block (i.e., word wrap) if there are no hard carriage returns.
  • North Arrow
    Selecting this command will display the North Arrow dialog box listing all the North Arrow symbols supported by the software.
    North Arrow dialog boxThe user can select the North Arrow symbol to display and click the [OK] button. After the user has selected a North Arrow symbol from the dialog box, that symbol is remembered for the next project.
  • Scale Bar
    This command allows the user to insert a scale bar on the project map. Scale bars visually indicate distance and feature size on the map. Note that this command works only to edit the Map Preview’s project map.
    Selecting this command will display the Scale Bar dialog box that provides different scale bar styles.
    Scale Bar dialog boxThe user can select the scale bar style and click the [OK] button. The software will then prompt the user to click at a location in the Diagram Workspace to place the selected scale bar. Once the user has added a scale bar to the layout, it can be modified. The user can select and drag the scale bar to adjust its position and resize it horizontally to use different gradations. The user can also change the appearance of the scale bar by adjusting the properties for the scale bar using commands in the Properties group of the Home ribbon menu.
  • Text Formatting Section
    This section provides various commands to format the text on the drawing canvas. The user can select the font type, color, and size, use text highlighter, bold, italicize, and underline text, and if required, clear all the text formatting with a single click.
  • Line Color
    This menu item defines the color of polylines and the outer boundaries of the shapes (i.e., circles, polygons, and rectangles). Selecting this item will display a color palette to choose the desired color.
  • Fill Color
    This menu item defines the color fill for the shapes (i.e., circles, polygons, and rectangles). Selecting this item will display a color palette to choose the desired color.
  • Line Weight
    This menu item defines the line weight of polylines and the outer boundaries of the shapes (i.e., circles, polygons, and rectangles). Selecting this item will display a line weight selection dialog box to choose the line weight.
  • Line Style
    This menu item defines the line styling of the drawn polyline (i.e., dashed or solid lines).
  • Line Ends
    This menu item displays a submenu allowing the user to define arrowheads on drawn polylines. The following commands are provided in the submenu:

    1. No Arrowhead – This command removes the arrowhead from the polyline.
    2. Arrowhead Front – This command places an arrowhead at the front of the polyline (endpoint). Note that the arrowhead is automatically sized based upon the line weight.
    3. Arrowhead Rear – This command places an arrowhead at the rear of the polyline (start point). Note that the arrowhead is automatically sized based upon the line weight.
    4. Arrowhead Both Ends – This command places arrowheads at both ends of the polyline.
    5. Swap Arrowhead Ends – This command is only enabled if the user has selected a single polyline with a single arrowhead. It swaps the arrowhead from the front to the end of the polyline (and vice versa).
  • Group Elements
    This menu item displays a submenu that allows the user to group and ungroup selected elements. At least two elements need to be selected on the drawing canvas to enable this menu item.
  • Lock Elements (Stretch Goal)
    This menu item displays a submenu that allows the user to lock and unlock selected elements from moving. At least one element needs to be selected on the drawing canvas to enable this menu item.
  • Bring to Front
    This menu item displays a submenu that allows the user to change the draw order of selected elements. At least one element needs to be selected on the drawing canvas to enable this menu item. The submenu contains the following commands:

    1. Bring to Front – Moves selected elements above all elements.
    2. Bring Forward – Moves selected elements forward.
    3. Send Backward – Moves selected elements backward.
    4. Send to Back – Moves selected elements below all other elements.
  • Align Left
    This menu item displays a submenu that allows the user to change the alignment of selected elements. At least two elements need to be selected on the drawing canvas to enable this menu item. The submenu contains the following commands:

    1. Align Left – Aligns the selected elements to the left.
    2. Align Center – Aligns the selected elements to the center.
    3. Align Right – Aligns the selected elements to the right.
    4. Align Top – Aligns the selected elements to the top.
    5. Align Middle – Aligns the selected elements to the middle.
    6. Align Bottom – Aligns the selected elements to the bottom.
  • Export Image
    Selecting this command will display the Windows Save As dialog box, allowing the user to save the contents of the drawing canvas to a graphic file.
  • Print
    Selecting this command will display the Print Preview dialog box, allowing the user to print the contents of the drawing canvas.
    Print Preview dialog box

Settings Ribbon Menu

The Settings ribbon menu provides commands for adjusting the properties of the drawing canvas grid.
Diagram editor - Settings ribbon menuThe following commands are provided in this ribbon menu:

  • Page Color – Displays a color palette that allows the user to set the diagram canvas page color.
  • Show Grid – Shows and hides the background grid.
  • Grid Color – Displays a color palette that allows the user to set the background color for the grid.
  • Snap to Elements – Snaps the elements together using connection points.
  • Snap to Grid – Snaps the elements to the background of the grid.

Resize a Picture, Shape, Text Box, or Other Object

After selecting an object, maybe a picture or a text box, the user has several options for resizing the object as described below:

Resize by dragging

Select the object, move the mouse pointer over one of the handles and then click and drag the mouse.

Dragging while keeping the center in the same place

  1. Select the object.
  2. Hold down the Ctrl key.
  3. Move the mouse pointer over one of the handles and then click and drag the mouse.
  4. Release the mouse button before you release the Ctrl key.

Dragging while maintaining the object’s proportions

  1. Select the object.
  2. Hold down the Shift key.
  3. Move the mouse pointer over one of the corner handles and then click and drag the mouse.
  4. Release the mouse button before you release the Shift key.

Dragging while maintaining the proportions and keeping the center in the same place:

  1. Hold down the Ctrl+Shift keys.
  2. Move the mouse pointer over one of the handles and then click and drag the mouse.
  3. Release the mouse before you release the Ctrl+Shift keys.

Time Series Plots

The Time Series Plots panel is used to define custom time series plots to be included in the generated report. This is helpful when the user wants to compare different hydrographs from various scenarios and elements.
Time Series Plots panel

The Time Series Plots panel is divided into two sections, as described below.

Define Time Series Plots

This section provides a data grid that allows the user to define multiple time series plots to be included in the generated report. The order of the time series plot in the table defines the sequence in which multiple plots will be placed on a single page.

The following columns are present in the data grid:

  • Time Series Plot Title
    This editable field allows the user to define what title should be placed at the top of the time series plot. If the user defines a plot element and does not define a plot title, a default title of Time Series Plot ## is used, where ## represents a unique number.
  • Number Plot Elements Defined
    This read-only field represents the number of HEC-HMS elements defined for the time series plot.
  • Order
    By default, the time series plots are listed in the order that the user defines them. However, this column can be used to change the order that the time series plots are placed in the report.
  • Number of time series plots per page
    This dropdown combo box allows the user to specify the number of time series plots to place on each report page. The time series plots are then scaled to fit on the page accordingly.

Define Time Series Plot Elements

This section provides a data grid that allows the user to define the HEC-HMS elements that are included in the time series plot being defined. The previously defined time series plot title is included in the section header. Note that a maximum of 16 rows of elements can be defined in the table, corresponding to the 16 unique colors available for the plot.

The following entries are present in the data grid:

  1. Scenario
    This dropdown combo box lists the scenarios selected in the Include Scenarios section of the Contents panel. The scenarios are listed in the order that they are defined in the Include Scenarios section.
  2. Element Type
    This dropdown combo box lists all the elements (in singular form) that can be defined in an HEC-HMS model, in alphabetical order:

    • Diversion
    • Junction
    • Reach
    • Sink
    • Source
    • Storage Area
    • Subbasin
  3. Element ID
    This dropdown combo box is disabled until the user has selected a scenario and an element type. Once the dropdown combo box is enabled, it lists all the element IDs corresponding to the scenario and element type selected in alphabetical order.
  4. Output Variable
    This dropdown combo box lists all the output variables for the selected HEC-HMS element. The content of the dropdown combo box changes based upon what element type is selected as described below:
    Diversion Output VariablesJunction Output VariablesSink Output VariablesSource Output VariablesStorage Area Output VariablesSubbasin Output Variables
    • Diverted Flow [cfs] [cms]
    • Flow [cfs] [cms]
    • Flow [cfs] [cms]
    • Flow [cfs] [cms]
    • Elevation [ft] [m]
    • Runoff [cfs] [cms]
    • Inflow [cfs] [cms]
    • Reach Output Variables
    • Inflow [cfs] [cms] (default)
    • Outflow [cfs] [cms] (default)
    • Inflow [cfs] [cms]
    • Stage [ft] [m]
    • Outflow [cfs] [cms] (default)(ft)
    • Storage [acre-ft] [m³]
  5. Order
    By default, the time series plot elements are listed in the order the user defines them. However, this column can be used to change the order as desired.

Generating Report

Once the report specifications are defined, the user can specify the path to save the generated report using the […] lookup button. Then, click the [Generate] button to generate the report at the specified location. The report will be generated either as a pdf or word document.
Report Output Options section

The Overwrite existing report file checkbox causes the software to overwrite the existing report file. By default, this option is checked. Uncheck this option if you don’t want to overwrite the existing report.

The Open report file for viewing and editing checkbox allows the user to view the just created report file and make changes to it. By default, this option is checked.

About the Author Chris Maeder

  • Was this Helpful?
  • YesNo

Was this article helpful?

Related Articles