The "HPMS Help Articles" page is the culmination of all articles in the HPMS category. This page eliminates the need to click between articles.
Screen Overview
The HPMS Manager interface has 3 functional areas upon first entering the application: (1) Map Frame, (2) Legend Menu, and (3) Tabs and Control Ribbon. Each of these are shown in the image below, with corresponding numbers to the list above.
(1) Map Frame
The Map Frame is used to display the route network, HPMS data, validation results, and query results in visual form. When the user initially opens the application, a map with state and parish boundaries is shown. A variety of controls for the Map Frame permit the user to zoom to an area of interest if desired.
(2) Legend Menu
The Legend Menu displays a list of available map layers that can be turned on/off by clicking the appropriate checkbox. The legend menu is displayed or hidden by clicking the arrow control (carat) to its immediate right.
(3) Tabs and Controls Ribbon
The HPMS Manager interface has 8 tabs: Map, Edit, Validations, Sample Adequacy, Submittals, Reports, System Administration, and Help. Each tab contains a set of controls displayed in ribbon format. When a tab is selected, the corresponding set of controls is displayed. These controls are sectioned on the tab's ribbon by general function. For example, the Edit tab hosts thirteen controls that are categorized into four sections: Data Editing, Management, Data Cleaning, and Route Info. Similarly, the other seven tabs have controls which are categorized into sections. The image below shows the Edit tab and its format.
Status Types
There are three status icons that can appear throughout the application. These icons are:
| Icon | Type | Description |
| Success | Indicates that no errors were encountered while importing data for the item. | |
| Warning | Indicates that a non-fatal error occurred while importing data for the item. Hovering over the icon will display details of the error. | |
| Fatal Error | Indicates that a fatal error occurred while importing data for the item. Hovering over the icon will display details of the error. |
Map Display
The map display can be changed using a range of controls on the Map Tab and specific mouse interactions with the map. The mouse, whether attached to a laptop or an independent object, can be used to navigate the Map interface. There are four ways a user can utilize the mouse for this function:
| Mouse Action | Description |
| Pan | Click, hold, and drag the map to re-center. |
| Trackwheel Zoom | Zoom in by rolling the mouse wheel forward and zoom out by rolling the mouse wheel backward. |
|
|
Zoom in by selecting this button beside the Legend. |
|
|
Zoom out by selecting this button beside the Legend. |
There are also five sections on the Map Tab ribbon that control the map display: Navigate, Identify, Find Segments, Basemap, and iVision. Each section is easily identifiable by its title on the menu bar. The image below shows the sections in red boxes.
(1) Navigate
PMG makes the map experience easy for users by providing familiar icons on the Map tab to aid their navigation. There are eight icons on this section of the tab:
-
-- Full Extent: Zooms the Map to the initial, full extent of the application
-- Zoom In: Zooms the Map in one level
-- Zoom Out: Zooms the Map out one level
-
-- Zoom Area: Zooms the Map to a user drawn extent
-- Previous Extent: Zooms the Map to the previous map extent
-- Next Extent: Zooms the Map to the next map extent
-- Zoom to Query Results: Zooms the Map to the extent of a user query
-- Clear Map: Clears the results displayed on the map
Each icon listed is designed to work directly with the map, giving users a spacial experience with the HPMS data. Users can reference this list as a reminder of the functionality of the icons, but they can also simply hover their mouse over the unknown icon to display its given name.
(2) Identify
The second section on the Map tab helps users identify important information while navigating the map. The application hosts two icons in this section:
-
-- Identify Feature: A tool that can be used to click on any of the GIS features displayed on the map and retrieve basic information.
-
-- Identify Route: A tool that can be used to provide a list of routes near a selected location on the map.
Just as with the Navigate section, both icons here are designed to work directly with the map, giving users a spacial experience with the HPMS data. Users can reference this list as a reminder of the functionality of the icons, but they can also simply hover their mouse over the unknown icon to display its given name.
(3) Find Segments
The third section on the Map tab hosts search tools that allow the user to select information to find specific segments on the map. These tools provided vary from those in the other Map tab sections, for they include picklists or are linked to pop-up interfaces. The five tools on the Find Segments section are described below.
| Icons | Names | Type | Description |
| Data Dropdown | Picklist | Specifies the HPMS Overlay data for finding route segments. | |
| Map Color Dropdown | Picklist | Specifies the color when mapping route segments. | |
| Route | Pop-Up | Changes the Find Segments function to Route Search mode, enabling selections and filtering. | |
| Sample | Pop-Up | Changes the Find Segments function to Samples Search mode, permitting the user to search for a specific HPMS Sample Section. | |
| More Filters | Pop-Up | Changes the Find Segments function to More Filters Search mode, permitting the user to search for Segments using various filters. |
Route
The Route pop-up menu hosts two lookup options: Statewide Route and LRS ID Route. All filters in Statewide Route are picklists, and the sole filter in LRS ID Route is in textbox format. By selecting filters under one of these options, the other lookup option (Statewide Route/LRS ID Route) will automatically become disabled. Once the user enters the desired information and selects the "Find" button, the HPMS Segments along the selected route will be mapped.
Sample
The Sample pop-up menu hosts a singular picklist for filtering. The user can select a Sample Section from this picklist and click the "Find" button to show a specific HPMS Sample on the map. The user can also hold their mouse over the mapped segment which will display Sample data in a pop-up menu.
More Filters
The More Filters pop-up will give the user access to some of the same filters as on the Route pop-up. However, there will be an extra option beyond Statewide Route Lookup and LRS ID Route Lookup: Other Filters. There is also an extra picklist available under Statewide Route Lookup-- System Type-- which designates route searches as On-System or Off-System. Just as in the Route pop-up, selecting either Statewide Route Lookup or LRS ID Route Lookup will disable the other. When the user has filled the desired filters, they can select the "Find" button to map HPMS Segments based on the selected filters and open a report containing data for the mapped segments.
(4) Basemap
Selecting the Basemap control button () opens a picklist of available basemaps that can be used as a backdrop to the GIS layers and business data. The available basemaps on the current HPMS application are Imagery, Imagery with Labels, National Geographic, Oceans, OpenStreetMap, Terrain with Labels, and Streets.
(5) iVision
The iVision control button () is enabled once a Route and location are identified. Clicking on this tool will open a new browser tab that will link to LADOTD’s “iVision” application and display images at the selected location.
Edit Tab
The Edit tab provides controls for editing data, viewing data, and saving edits previously applied to the HPMS data. There are 4 sections for the Edit ribbon: Data Editing, Management, Data Cleaning, and Route Info.
Icons
Each icon on this tab, except for the Select from Map icon, leads to an editing interface. These icons and their specific roles are listed below by section.
Data Editing
The following tools are provided under the Data Editing group:
-
-- Select from Map: Used to interactively click on a route and begin editing.
-
-- Basic Editor: Opens the interface to search, create, and edit HPMS Data.
Management
The following tools are provided under the Management group:
-
-- Edit Log: Opens the interface to view recorded edits to Data Tables.
-
-- Save Data to Source: Opens the interface to view edits to Data Tables and to update source data.
-
-- Edit Groups: Opens the interface to manage columns (Edit Groups) displayed in Basic Editor.
-
-- Edit Rules: Opens the interface to view and edit validation rules.
Data Cleaning
The following tools are provided under the Data Cleaning group:
-
-- Fix Events Gaps: Opens the interface to find and fix gaps in Roads and Highways events.
-
-- Snap Events to Route: Opens the interface to find and fix measure offsets between routes and events.
-
-- Fix Event Offsets: Opens the interface to find and fix measure offsets between events.
-
-- Fix Events Overlaps: Opens the interface to find and fix overlapping events.
-
-- Check Event IDs Report: Opens the interface to generate reports of duplicate or missing event IDs.
Route Info
The following tools are provided under the Route Info group:
-
-- View Concurrencies: Opens the window which displays all locations where there are overlaps in the route network.
-
-- View Translations: Opens the window which displays all locations where there are translations in the route network.
Select From Map
This is a tool that is located on the Data Editing section of the Edit tab. When Select from Map () is chosen, the user can click anywhere on the map to open a picklist of routes near the selected location. After selecting a route from this list, the user can open the Basic Editor tool by clicking the "Basic Editor" link at the bottom of the "Identity Route Results" pop-up.
Basic Editor
This is a tool that is located on the Data Editing section of the Edit tab. While the Basic Editor can be accessed through the Select from Map pop-up, it can also be accessed directly through the Basic Editor icon (). The Basic Editor interface is used to search, create, and update data in the HPMS Data Tables. The interface is divided into 4 sections: (1) Required Information, (2) Data Items, (3) Button Controls, and (4) Expand and Collapse Controls.
(1) Required Information
The Required Information section of the interface is used to specify which HPMS Overlay data and data items will be displayed in the table. There are some controls offered in this section.
| Controls | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Edit Group Dropdown | Select which columns will appear in the table. |
| Enter Route Button | Open the Enter Route interface to input route information. |
| Find Button | Select the route and return to the Basic Editor. |
| Reset Button | Clear the fields. |
(2) Data Items
The Data Items table will display data for the full extent of the selected route. This table is used for viewing and editing these data items. It consists of four static columns (Parish, Route ID, From Measure, and To Measure) and additional columns characteristic of the chosen Edit Group. The Data Table connects to the Map interface through the table rows. When a row in the table is clicked, the map will zoom in and highlight the corresponding segment in the Map Frame. When the segment is clicked, the map will zoom to the feature and highlight the corresponding row in the table.
The Data Table also indicates where gaps exist in the selected route in its effort to display the full extent of a route. Records will be inserted into the table indicating where gaps begin and end; these will not be editable.
Data Items can be edited by clicking in the desired cell in the table, prompting picklists or textboxes to appear. After performing edits, the row will be checked for validation errors. If a new value fails a validation check, an Error icon () will appear in the Error icon column (second column). Hovering over an error icon will display a description of the error.
Rows can be deleted by clicking the checkboxes in the first column of the table and selecting the “Delete Selected Rows” link. Changes to the table cannot be saved if new gaps or overlaps are created by deleting or adding a new row.
(3) Button Controls
The following controls are provided in this section of the Basic Editor:
| Icons | Name | Used To... |
| Save to Source | Commit changes to original source data items. | |
| Add Row | Insert a row into the table. New rows will appear at the top of the table. | |
| Delete Selected Rows | Delete a row or rows from the table. The records that will be deleted must be selected in the first column of the table. | |
| Save Changes | Save changes to the HPMS Overlay. | |
| Discard Changes | Discard changes since the last save operation. | |
| Status Log | Display a log of changes, errors, or updates during the edit session. |
(4) Expand and Collapse Controls
The Basic Editor can be expanded and collapsed using the Maximize and Minimize buttons in the top right corner of the data table. If the Basic Editor is expanded (), it will fill the entire screen. If it is collapsed (
), the only trace of the Basic Editor will be displayed in a singular bar at the bottom of the screen, with the Required Information portion shown.
Edit Log
This is a tool that is located on the Management section of the Edit tab. The Edit Log interface () provides a viewable history of changes made to each HPMS Data table. Results can be filtered based on a user, data item, county, system code, or route name. The table below lists these filter controls' function, alongside the other controls in this interface.
| Control | Used To... |
|
Data Dropdown |
Select the HPMS Data Table to use when viewing the selected interface. |
|
Refresh Date Dropdown |
Specify whether all edits, or only edits performed after a selected refresh date, are displayed in the Edit Log data. |
| User Dropdown | Select a user when filtering the results. |
| Data Item Dropdown | Select a data item when filtering the results. |
| Parish Dropdown | Select a Parish when filtering the results. |
| System Code Dropdown | Select a System Code when filtering the results. |
| Route Name Dropdown | Select a Route Name when filtering the results; this picklist is only populated after a System Code is chosen. |
| Filter Button | Filter the results based on the selected filter items. |
| Open as PDF Button | Open a copy of the Edit Log table in a PDF format. |
| Open in Excel Button | Open a copy of the Edit Log table in an Excel format or save a copy of the Edit Log table in a local Excel file. |
| Clear Historical Data Link | Open a pop-up menu to clear data from the Edit Log. |
| Navigation Dropdown | Increase/decrease the number of records to display. |
| Retrieve Previous 20,000 Records/Retrieve Next 20,000 Records | Enable links for users to view the edits in batches of 20,000 records. |
Clear Historical Data
The pop-up window that results from selecting the Clear Historical Data link allows the user to delete all historical data edits or to delete historical data within a specific date range. If the user selects "All," all historical data edits will be deleted. If the user selects "Date Range," a Begin Date and an End Date must be specified. The textboxes or calendar icons next to these dates can be utilized to enter the necessary dates. After the desired options have been selected, the Delete button can be used to delete the data. The Cancel button can be used to exit out of the interface without deleting any data.
NOTE: When selecting a date range, it is important to note that the From Date is inclusive while the To Date is exclusive. For example, if the user has selected 10/01/2018 as the From Date and 10/31/2018 as the To Date, all log entries from 10/01/2018 to 10/30/2018 will be deleted. Any log entries recorded on 10/31/2018 will not be deleted.
Save Data to Source
This is a tool that is located on the Management section of the Edit tab. The Save Data to Source interface () provides the option to save data edits stored in HPMS Manager back to the source data from which the HPMS overlay originates. This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| User Dropdown | Select a user when filtering the results. |
| Data Item Dropdown | Select a data item when filtering the results. |
| Parish Dropdown | Select a parish when filtering the results. |
| System Code Dropdown | Select a system code when filtering the results. |
| Route Name Dropdown | Select a route name when filtering the results; this picklist is only populated after a System Code is chosen. |
| Show Import Edits Checkbox | Give the option to show edits created during the populate/refresh process. |
| Only show edits user can save to source Checkbox | Filter out edits that cannot be saved to source. |
| R&H Radio Buttons | Filter by either R&H data items, Non-R&H data items, or all items. |
| Filter Button | Filter the results based on the selected filter items. |
| Open as PDF Button | Open a copy of the Edit Log table in a PDF format. |
| Open in Excel Button | Open a copy of the Edit Log table in an Excel format or save a copy of the Edit Log table in a local Excel file. |
| Save to Data Source Button | Save the selected edits back to the source data. |
| Navigation Dropdown | Increase/decrease the number of records to display. |
| Retrieve Previous 20,000 Records/Retrieve Next 20,000 Records | View the edits in batches of 20,000 records. |
Edit Groups
This is a tool that is located on the Management section of the Edit tab. The Edit Groups interface () is used to create, save, or delete groupings of columns designated for editing. The Edit Groups interface specifies which columns will be shown in Basic Editor. There are some controls offered in this interface:
| Control | Used To... |
| Edit Group Dropdown | Select an existing Edit Group to view, edit, or delete. |
| Add New Button | Create a new Edit Group. |
| Add Button | Select and add an Available Column to Selected Columns. |
| Remove Button | Select and remove one column from Selected Columns. |
| Remove All Button | Remove all Selected Columns. |
| Up and Down Arrow Buttons | Select and reorder columns within an Edit Group. The column order in the "Selected Columns" box will reflect the display order in Basic Editor. |
| Group Name Textbox | Edit, view, or input the unique Edit Group name. The group name can be changed by clicking in the textbox, editing the name, and clicking the Save Changes button. |
| Select/Deselect TOPS Link | Add/remove the TOPS items in Selected Columns. |
| Delete Button | Delete the currently selected Edit Group. |
| Save Changes Button | Save changes made to the selected Edit Group. |
| Discard Changes Button | Discard changes made to the selected Edit Group. |
| Plus and Minus Buttons | Modify the Selected Columns and customize the output of Basic Editor. Data items are categorized by functional area and can be expanded and collapsed using these buttons. |
Edit Rules
This is a tool that is located on the Management section of the Edit tab. The Edit Rules menu option () opens the Validation Rules Maintenance interface which is used to view and modify the FHWA HPMS validation rules used for validation reports. The Validation Rules interface consists of 6 components: (1) Rule Type Control, (2) Reset Controls, (3) Rule List, (4) Rule Definition Table, (5) Condition Definition Tables, and (6) Save/Discard Controls.
The designated numbers for the component descriptions below correspond to the numbers on the image above.
- Rule Type Control: This control picklist is used to switch between different rule type categories.
-
Reset Controls: There are two control buttons provided for resetting rules in the interface.
- Reset Selected Rule to Default -- Used to reset the failure message, rule definition, and condition definitions for a selected rule to the default FHWA value.
- Reset All Rules to Defaults -- Used to reset the failure message, rule definition, and condition definitions for all rules to the default FHWA values.
- Rule List: This table provides a list of all HPMS Data Items and failure messages for the selected Rule Type.
-
Rule Definition Table: This table is used for adding rule criteria to a selected HPMS Data Item and rule type. The user can specify any combination of available data items to create a rule.
- The Logical column provides query operators (equal, not equal, greater than, less than, etc.).
- The Condition column can be filled using the Condition Definition Table.
- The "+" button will appear under the "+/-" column on the next available row, allowing additional criteria to be added to the rule.
- The "X" button will appear under the "+/-" column on filled rows to allow their removal.
- The Join and Parentheses columns allow the user to group or create condition rule criteria.
- Condition Definition Tables: These tables are used for adding condition criteria to a selected rule criterion and for specifying the condition type, value, and arithmetic operator.
-
Save/Discard Controls: There are two control buttons provided in the Validation Rules Maintenance for saving or discarding data.
- Save Changes -- Used to save changes to a selected rule.
- Discard Changes -- Used to discard the changes to a selected rule.
Fix Event Gaps
This is a tool that is located on the Data Cleaning section of the Edit tab. The Fix Event Gaps interface () is used to find and correct gaps that exist in the source data for a Roads and Highways event. This interface hosts these controls:
| Controls | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Event Dropdown | Select the data item that will be used to check for gaps. |
| Statewide/Parish Radio Button | Choose between retrieving all segments or a subset of segments that are within a specified parish boundary. |
| System Types Checkboxes | Select which route systems will be used when checking for event gaps. If none are selected, all route system types will be used. The Select All button can also be used to select all categories. |
| Route Types Checkboxes | Select which route types will be used when checking for event gaps. If none are selected, all route types will be used. The Select All button can also be used to select all categories. |
| Exclude Non-Inventory Routes Checkbox | Specify if non-inventory routes will be excluded when checking for event gaps. |
| Find Gaps Button | Find all segments where gaps exist according to the selected filters. |
| Save Changes Button | Update the gaps found for the selected rows. |
| Discard Changes Button | Discard any changes made to the interface. |
| Save Data to Source? Checkbox | Save the selected edits back to source events. |
| Export to Excel Link | Export the gaps found to an Excel file. |
Snap Events to Route
This is a tool that is located on the Data Cleaning section of the Edit tab. The Snap Events to Route interface () is used to find and fix micro gaps or overlaps that exist between a Roads and Highways event and the end of routes. This interface hosts these controls:
| Controls | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Event Dropdown | Select the data item that will be used to check for event/route offsets. |
| System Types Checkboxes | Select which route systems will be used when checking for offsets. If none are selected, all route system types will be used. The Select All button can also be used to select all categories. |
|
Route Types Checkboxes |
Select which route types will be used when checking for offsets. If none are selected, all route types will be used. The Select All button can also be used to select all categories. |
| Exclude Non-Inventory Routes Checkbox | Specify if non-inventory routes will be excluded in the results. |
| Find Events Button | Find all segments where offsets exist according to the selected filters. |
| Save Changes Button | Update the offsets found for the selected rows. |
| Discard Changes Button | Discard any changes made to the interface. |
|
Export to Excel Link |
Export the offsets found to an Excel file. |
Fix Events Offsets
This is a tool that is located on the Data Cleaning section of the Edit tab. The Fix Event Offsets interface () is used to find measure offsets that exist between data items. Measures of a data item can be updated to match the measures of another data item. This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Statewide/Parish Radio Button | Choose between retrieving all segments or a subset of segments that are within a specified parish boundary. |
| Event to Fix Dropdown | Choose which Event to update. |
| Event to Compare Dropdown | Choose which Event will be used as the control for measure comparisons. |
| Tolerance Textbox | Set a tolerance value for finding offsets. |
| Find Offsets Button | Find all segments where the measures of the Event to Fix item does not match the Event to Compare item. |
| Save Changes Button | Update the measures of the selected rows. |
| Discard Changes Button | Discard any changes made to the interface. |
Fix Event Overlaps
This is a tool that is located on the Data Cleaning section of the Edit tab. The Fix Event Overlaps interface () is used to find and correct overlaps that exist within a Roads and Highways event. This interface hosts these controls:
| Controls | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Event Dropdown | Select the data item that will be used to check for overlaps. |
| System Types Checkboxes | Select which route systems will be used when checking for event overlaps. If none are selected, all route system types will be used. The Select All button can also be used to select all categories. |
| Route Types Checkboxes | Select which route types will be used when checking for event overlaps. If none are selected, all route types will be used. The Select All button can also be used to select all categories. |
| Exclude Non-Inventory Routes Checkbox | Specify if non-inventory routes will be excluded when checking for event gaps. |
| Find Overlaps Button | Find all segments where overlaps exist according to the selected filters. |
| Save Changes Button | Resolve the overlaps found for the selected rows. |
| Discard Changes Button | Discard any changes made to the interface. |
| Export to Excel Link | Export the overlaps found to an Excel file. |
| Edit Source Link | Open the source event data for the selected segment to resolve overlaps in a given row. |
Check Event IDs Report
This is a tool that is located on the Data Cleaning section of the Edit tab. Having a unique identifier-- Event ID-- for each event in the Roads and Highways (R&H) environment is important for temporality and data integrity within an R&H database. There should be no duplicate or missing Event IDs in any R&H event. The Check Event IDs Report interface () is used to check for these conditions. This interface hosts these controls:
| Control | Used To... |
| Data Table | Select the HPMS Data Table to use when viewing the selected interface. |
| Event ID Check Radio Button | Choose between checking for Missing or Duplicate Event IDs. |
| Report Type Radio Button | Choose between Summary and Detail report formats. |
| Events Checkboxes | Select which events will be checked for invalid Event IDs. If none are selected, all events will be used. The Select All button can also be used to select all categories. |
| Select All Link | Select all checkboxes in the Events section. |
| Open as PDF Button | Open a copy of the table in a PDF format. |
| Open in Excel Button | Open a copy of the table in an Excel format or save a copy of the table in a local Excel file. |
View Concurrencies
This is a tool that is located on the Route Info section of the Edit tab. The View Concurrencies interface () presents a list of route overlaps with related measures of the subordinate and dominant routes. As indicated by the name, the user will have view-only access to the data presented on this interface. This interface has one dropdown box which allows the user some control over its content.
| Control | Used To... |
| Data Table Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
View Translations
This is a tool that is located on the Route Info section of the Edit tab. The View Translations interface () presents a list of route translations with related measures for both route networks. As indicated by the name, the user will have view-only access to the data presented on this interface. This interface has one dropdown box which allows the user some control over its content.
| Control | Used To... |
| Data Table Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
Validation Tab
The Validations tab is used to execute and view HPMS validation reports before submitting data. There are four sections on this ribbon: HPMS Validations, Completeness, Summaries, and Management.
Icons
Each icon on this tab leads to an interface. These icons and the specific roles of their interfaces are listed below by section.
HPMS Validations
The following tools are provided under the HPMS Validations group:
-
-- Route/LRS: Opens the interface to run route ID, geometry, and measure validations.
-
-- Sample Sections and TOPS: Opens the interface to run validations for Sample Sections and TOPS items.
-
-- Import: Opens the interface to run import validations for the HPMS Data Items.
-
-- Cross: Opens the interface to run cross validations for the HPMS Data Items.
-
-- Coverage: Opens the interface to run coverage validations for the HPMS Data Items.
Completeness
The following tools are provided under the Completeness group:
-
-- Missing Full Extent Coverage: Opens the interface to run validations for data item completeness.
Summaries
The following tools are provided under the Summaries group:
-
-- Validation Report: Opens the interface to run all validations.
Management
The following tools are provided under the Management group:
-
-- Modify Editor Columns: Opens the interface to configure the display of the Validation Editor.
Route/LRS
This is a tool that is located on the HPMS Validations section of the Validations tab. The Route/LRS interface () provides options to validate route ID, geometry, and measure conformity. These tools run the source R&H route data and are useful in identifying Route ID and LRS data quality issues, such as duplicate Route IDs and measures out of range. This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Network Name Dropdown | Select the Route Network (Statewide or LRS ID) to validate. |
| "Select the validation to run" Checkboxes | Select and run validations individually or all at once. |
| Open as PDF Button | Open a copy of the Edit Log table in a PDF format. |
| Open in Excel Button | Open a copy of the Edit Log table in an Excel format or save a copy of the Edit Log table in a local Excel file. |
Validations
There are four types of Route/LRS Validations the user can run. These options will be located under the "Select the validation to run" section and will be recognizable in their checkbox form.
- Route is Empty -- Checks to see if all route records contain a Route ID value.
- Invalid Geometry Type -- Checks to see if all route geometries meet the route geometry requirements.
- Duplicate Route ID -- Checks to see if all route records contain a unique Route ID value.
- Invalid Measure -- Checks to see if all route record measures meet the route measure requirements.
To the right of each validation option is a question mark. This symbol will provide reference information on FHWA validations in a pop-up window.
Sample Sections and TOPs
This is a tool that is located on the HPMS Validations section of the Validations tab. The Sample Sections and TOPS Validations interface () provides options to validate samples and TOPS items (Functional System, Urban Code, Facility Type, Through Lanes, and AADT). This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| "Select the locations to check" Radio Button | Create a statewide report or a report for results at a specific location. If the user selects the Specific Location option, the Parish, System Code, Route Name, Direction, Feature Type, and Sequence # picklists become available. The LRS ID textbox also becomes available. The user can choose to select options from the picklists OR fill the LRS ID textbox. |
| "Select the validation to run" Options | Provide options for 5 different Sample Sections and TOPS validation reports. |
| Output Controls | Open the report in a PDF format or in a new pop-up window. |
| Columns Missing Link |
Display a list of columns that are missing which prevent the reports from running. If all necessary columns are present in the selected Data table, this message will not appear. NOTE: The Verify Sample Coverage report is the only report that can be processed without all necessary columns. |
Report Types
There are five report types found under the "Select the validation to run" section.
- Verify Sample Length: Validates if sample sections meet the suggested length guidelines.
- Verify Sample Coverage: Validates if sample sections contain the required data items for reporting. The report can also include data items that are optional for reporting if the user selects the "Include Optional Sample Panel Data Items" checkbox.
- Check for Homogenous TOPS: Validates that the five TOPS items are homogeneous across entire sample sections.
- Invalid Sample Location: Validates if sample sections are on valid route segments.
- Verify TOPS Coverage: Validates if the five TOPS items are present on sample sections.
To the right of each validation option is a question mark. This symbol will provide an explanation of the function of each report directly in the interface. Users can consult this pop-up or the help guide for a reminder of each type's function.
Validation Edit Menu
The Sample Sections and TOPs validation checks have the Validation Edit Menu capability on each row of their reports. The Validation Edit Menu provides the user with the ability to correct validation errors. The interface will be populated with HPMS Data Items along the route corresponding to the selected record in the validation report. This interface provides four types of controls:
| Control | Used To... |
| Validation Information | Display general information about the selected validation report (Sample Sections & TOPS, Import, Cross, or Coverage). |
| Edit Controls Table |
View and edit Data Items along a given route; automatically scrolls to the record corresponding to the selected record in the validation report. Data Items are editable by clicking in the desired cell.
Seven static columns are displayed in the Edit Controls table: Checkbox Selector, Error Icon ( |
| Status Log | Keep a log of the changes made in the current instance and alert the user if a change corrected an issue or caused a validation error. |
| Save Controls (Save Changes/Discard Changes/Save to Source) | Save pending changes, discard changes made in the current session, or commit changes to original source data items. |
Import, Cross, and Coverage
These are tools that are located on the HPMS Validations section of the Validations tab. The Import, Cross, and Coverage Validation interfaces (,
,
) are used to run validation reports for one or more Data Items. This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Location Controls | Create a statewide report or a report for results at a specific location. If the user selects the Specific Location option, the Parish, System Code, Route Name, Direction, Feature Type, and Sequence # picklists become available. The LRS ID textbox also becomes available. The user can choose to select options from the picklists OR fill the LRS ID textbox. |
| "Select the validation to run" Options | Provide the Data Items to include in the validation report; users can click the individual checkboxes, the "Select TOPS Data Items" link, or the "Select All" link. |
|
Output Controls |
Open the report in a PDF format or in a new pop-up window. |
Validation Edit Menu
The Import, Cross, and Coverage validation checks have the Validation Edit Menu capability on each row of their reports. The Validation Edit Menu provides the user with the ability to correct validation errors. The interface will be populated with HPMS Data Items along the route corresponding to the selected record in the validation report. This interface provides four types of controls:
| Control | Used To... |
| Validation Information | Display general information about the selected validation report (Sample Sections & TOPS, Import, Cross, or Coverage). |
| Edit Controls Table |
View and edit Data Items along a given route; automatically scrolls to the record corresponding to the selected record in the validation report. Data Items are editable by clicking in the desired cell.
Seven static columns are displayed in the Edit Controls table: Checkbox Selector, Error Icon ( |
| Status Log | Keep a log of the changes made in the current instance and alert the user if a change corrected an issue or caused a validation error. |
| Save Controls (Save Changes/Discard Changes/Save to Source) | Save pending changes, discard changes made in the current session, or commit changes to original source data items. |
Missing Full Extent Coverage
This is a tool that is located on the Completeness section of the Validations tab. The Missing Full Extent Coverage validation check () allows DOTs to check and confirm the completeness of data items beyond HPMS & FHWA requirements. The check will identify where specified data items do not have full coverage, null values, or dangles against routes. This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| "Select the locations to check" Radio Button | Create a statewide report or a report for results at a specific location. If the user selects the Specific Location option, the Parish, System Code, Route Name, Direction, Feature Type, and Sequence # picklists become available. The LRS ID textbox also becomes available. The user can choose to select options from the picklists OR fill the textbox. |
| Data Items | Select the Data Items to validate by checking the checkboxes; the "Select All" link can also be used. |
| Output Controls | Open the report in a PDF format or in a new pop-up window. |
Validation Report
This is a tool that is located on the Summaries section of the Validations tab. The Validation Report interface () is used to run all validations and generate a summary report. The summary report provides counts of all validations performed and hyperlinks to run individual reports in the Report window. This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Network Name Dropdown | Select the Route Network to validate. |
| Validations Checkboxes | Include validation categories in the summary report. |
| Run Validation Summary Button | Run the selected validation categories and present the results in a Summary Report Window. |
Modify Editor Columns
This is a tool that is located on the Management section of the Validations tab. The Modify Editor Columns tool () is used to add informational or decision-making columns to the HPMS Validation rules. These columns appear in conjunction with the columns used in executing the rule when editing data in the Validation Editor.
To add additional columns, the user must first select a Validation Type category from the picklist at the top of the interface. Then, the "Data Item" picklist below will be populated with the HPMS Items that have rules in the selected category. After selecting a Data Item, the required columns will be displayed, and additional columns can be added. While new columns can be added, the required columns cannot be deleted.
Informational columns are associated to a rule by clicking the “Add New Row” link and selecting the column to be associated. To delete a column, the user can select the checkbox by the desired row and click the “Delete Selected Rows” link.
Once columns are associated to the validation rule, the user can click the "Save Changes" button to store the columns. These columns will be displayed in the Validation Editor once the rule is validated.
Sample Adequacy Tab
The Sample Adequacy tab is used to create and manage sample data and to review TOPS data items. There are only two sections on this tab: Sample Adequacy and Maintenance.
Icons
Each icon on the tab leads to an interface. These icons/interfaces and their specific roles are listed below by section.
Sample Adequacy
The following tools are provided under the Sample Adequacy group:
-
-- Create TOPS: Opens the interface which is used to create a Table of Potential Samples (TOPS) data table based on the data in a HPMS Data Table. All other interfaces cannot be used until this step is performed.
-
-- Adjust TOPS: Opens the interface which is used to merge small segments together based on TOPS items.
-
-- Split Sample by TOPS: Opens the interface which is used to split a sample based on breaks in any of the TOPS data items (AADT, Facility Type, Functional Class, Through Lanes, and Urban Code).
-
-- Check Adequacy: Opens the interface which is used to view the number of unsampled TOPS sections, required samples, and current samples for each Sample Panel (Functional System, Volume Group, and Urban Area stratum).
-
-- Potential Samples: Opens the interface which is used to identify and add samples.
-
-- Expansion Factors: Opens the interface which is used to calculate and view expansion factors for Sample Panels.
-
-- Sample Risk Analysis: Opens the interface which is used to review current Samples Panels for samples that are at risk of moving to a higher or lower volume group.
-
-- Delete Samples: Open the interface which is used to review samples from the sample panel.
Maintenance
The following tools are provided under the Maintenance group:
-
-- Precision Level: Open the interface which is used to edit the Confidence Level and Precision Rate values used in the Check Adequacy interface.
Create TOPs
This is a tool that is located on the Sample Adequacy section of the Sample Adequacy tab. The Create TOPS interface () allows the user to generate a Table of Potential Samples (TOPS) data set. This is a necessary action that must occur before TOPS data can be reviewed. The output data set from this interface will include all TOPS items. This interface hosts the Data Table and Year dropdown controls, alongside the Create TOPS instigation button. If edits have occurred to the HPMS Data Table since the last creation of TOPS, the TOPS dataset will need to be recreated.
| Control | Used To... |
| "using Data" Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Create TOPs for Year Dropdown | Select the year to use when viewing the selected interface. |
| Create TOPs Button | Instigates the creation of the new TOPs. |
Adjust TOPs
This is a tool that is located on the Sample Adequacy section of the Sample Adequacy tab. The Adjust TOPS interface () is used to find small segments where the five TOPS data items do not align at exact measures. This interface is divided into three tabs: Summary, Detail, and Changes.
The Summary Tab is used to identify segments where TOPS data items do not align at exact measures. The Details Tab is used to compare the number of TOPS locations and number of required samples from the original TOPS set against the number of TOPS locations and number of required samples from the modified TOPS set per Functional System, Urban Code, and Volume Group stratum. The Changes tab is used to identify where the five TOPS data items do not align at exact measures and what their new values will be if the modified data set is saved. All three tabs (Summary, Detail, and Changes) host similar sections on their interfaces. Those sections are:
(1) Data Table Information
The Data Table Information section contains general information about the currently selected Data Table. This section hosts two controls.
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
(2) Data To Adjust
The Data To Adjust section is used to define how segments will be merged. It has some important controls:
| Control | Used To... |
| Statewide/Parish Radio Buttons | Adjust the data for the entire state or by individual parish. |
| Parent TOPS Data Item Precedence List | Specify the order for obtaining attribute values that will determine how small segments will be merged into adjacent segments (up/down arrows). |
| Measure Tolerance Textbox | Specify the maximum segment length to merge; includes feet/miles picklist. |
| View TOPS Changes Button (Summary Section ONLY) | Process the selected TOPS dataset by assessing which segments will merge based on the measure tolerance and precedence set. |
(3) TOPS Changes Summary
This portion hosts a table, or a visual representation of the data generated from the Data Table and Data To Adjust inputs. Each table is slightly different depending on the chosen tab.
(4) Button Controls
The bottom of the interface hosts two button controls:
| Control | Used To... |
| Update TOPS | Update the selected HPMS Data Table and TOPS table with the modified TOPS set. |
| Cancel | Exit out of Adjust TOPS without committing changes. |
Split Sample by TOPs
This is a tool that is located on the Sample Adequacy section of the Sample Adequacy tab. The Split Sample by TOPS interface () is used to find samples where the TOPS data items change along the sample. In this interface, sample sections can be split into multiple samples based on changes in the TOPS items. The interface also provides the ability to disassociate a section of sample based on the changes in TOPS items. The interface is divided into 3 sections: Data Table Information, Sample Data Grid, and Button Controls.
(1) Data Table Information
The Data Table Information section contains general information about the selected Data Table. This section hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Break on AADT Change Checkbox | Determine whether AADT will be used as a criteria for splitting samples. |
| Check Samples Button | Execute the Split Sample by TOPS function and populate the Data Grid based on the Data Year, Data Table, and Break on AADT options. |
(2) Sample Data Grid
The Sample Data Grid shows the results of the Check Samples function, indicating where TOPS item changes occur across a sample length. Segments then can be disassociated with a sample by using the checkboxes in the left-hand column. There are some controls found here:
| Control | Used To... |
| Save To Source Checkbox | Enforce that changes to the HPMS Data Tables are also applied to the HPMS Samples data source. |
| Export to Excel Link | Export the current table to Excel format. |
(3) Button Controls
There are two button controls that help users determine the saved/unsaved state of their inputted data. These controls are:
| Control | Used To... |
| Save Changes | Disassociate marked segments and update the TOPS table. |
| Discard Changes | Exit out of Split Sample by TOPS without committing changes. |
Check Adequacy
This is a tool that is located on the Sample Adequacy section of the Sample Adequacy tab. The Check Sample Adequacy interface () is used to view the number of unsampled TOPS, required samples, and current samples for each stratum (Functional System, Volume Group, and Urban Code grouping). This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| View Adequacy Button | Display the Check Sample Adequacy data for the selected HPMS Data Table. |
| Carets | Allow users to expand or collapse the stratum data. |
Potential Samples
This is a tool that is located on the Sample Adequacy section of the Sample Adequacy tab. The Potential Samples interface () is used to identify locations where additional samples can be added to meet HPMS sample requirements. The interface provides a reviewable list of sections that includes unsampled TOPS sections and existing sample sections. The Potential Samples interface is divided into 5 sections: Data Table Information and Stratum Information, Data Completeness, Potential Sample Table, Sample Table, and Button Controls.
(1) Data Table Information and Stratum Information
The Data Table Information and Stratum Information section contains general information about the currently selected HPMS Data Table and the selected stratum. This section hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Volume Group Dropdown | Select from which volume group to view samples.* |
| Functional System Dropdown | Select from which functional system to view samples.* |
| Urban Code Dropdown | Select from which Urban Code to view samples.* |
| Find Now Button | Find TOPS sections based on the Functional System, Urban Code, Volume Group, and HPMS Data Table selected. |
*Auto-populated if redirected to this screen from Check Adequacy or Expansion Factors.
(2) Data Completeness
Beyond the filtering dropdowns, the interface also allows segments to be returned and ordered by the completeness of data. There are some controls provided here:
| Control | Used To... |
| Percentage of Data Items with Values Checkbox | Order the segments by the completeness of the data. |
| AADT not within [#]% of Volume Group Upper/Lower Bounds Checkbox | Provide the option to show which segments do not meet an AADT value within a specified percentage. |
| Prioritize/Weight Data Items Link | Open the “Prioritize/Weight” interface where the user can specify the order of priority for data items. |
| Select Priority Method Radio Button | Allow users to set the priority method to "By Ordering" or "By Weighting."* |
| Double Arrows ( |
Move data items to the top/end of the list.* |
| Single Arrow ( |
Move data items up/down one row.* |
| Set Priority Button | Confirm the priority order of the data items.* |
*All controls listed here are located on the Prioritize/Weight Data Items interface which is accessible through the Data Completeness section.
(3) Potential Sample Table
The Potential Sample Table will be populated with TOPS sections within the specified Volume Group, Functional System, and Urban Code selected. There is one control offered in this section:
| Control | Used To... |
| Row Checkboxes | Add segments as a sample. |
(4) Sample Table
The Sample Table displays the number of required samples, existing samples, samples that are needed to meet requirements (calculated by number of existing minus the number of required), and total amount of samples. This section will only be populated after the "Find Now" button is clicked. The "Selected" and "Total" Samples will increase or decrease as segments are selected as samples.
(5) Button Controls
The final section of this interface consists of four buttons. These buttons are:
| Control | Used To... |
| Save to Source Checkbox | Enforce that changes applied to the HPMS Data Tables are also applied to the HPMS Samples data source. |
| Random Select | Open the Select Random Samples interface which will select segments at random based on user specifications. |
| Add Samples | Add samples to the stratum. |
| Cancel | Exit the Potential Samples interface without adding samples. |
Number Colors
The Potential Sample Table hosts various numbers in its columns which can appear in different colors. The table below lists each color and its associated meaning.
| Color | Indicates that... |
| Green | Segments are current samples. |
| Orange | Segments do not meet segment length requirements. |
| Red | Segments do not meet AADT criteria. |
| Blue | A link is present. This is only available in the Completeness column which shows how many data items exist along the sample section of the total data items collected. The link leads to a pop-up list showing which data items exist for the sample. |
Expansion Factors
This is a tool that is located on the Sample Adequacy section of the Sample Adequacy tab. The Expansion Factors interface () is used to calculate expansion factors for each Functional System, Urban Code, and Volume Group stratum. This interface hosts these controls:
| Controls | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| View Expansion Factors Button | View expansion factors previously calculated for the selected HPMS Data Table. |
| Calculate Expansion Factors Button | Calculate expansion factors for the selected HPMS Data Table. |
|
Show Problematic Factors Only Checkbox |
Filter expansion factors that do not exceed a maximum of 100.000, the FHWA recommended value. |
Sample Risk Analysis
This is a tool that is located on the Sample Adequacy section of the Sample Adequacy tab. The Sample Risk Analysis interface () is used to review Functional System, Urban Code, and Volume Group stratums to locate samples that are near the upper or lower ranges of a volume group. The Sample Risk Analysis interface is divided into 4 sections: Data Table Information, Risk Analysis Parameters, Sample Risk Stratum Table, and Sample Risk Detail Table.
(1) Data Table Information
The Data Table Information section contains general information about the currently selected HPMS Data Table. This section hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
(2) Risk Analysis Parameters
The Risk Analysis Parameters section provides the user with three search options, or controls:
| Control | Used To... |
| At Risk Samples have AADT within % of Volume Group Upper/Lower Bounds | Identify AADT values within a range of the limits of a volume group that are at risk of moving to a different volume group; required. |
| Show Stratums with At Risk Samples comprising % of the Number of Required Samples | Filter stratums that do not have a certain percentage of at-risk samples; select a symbol from the picklist, then specify a percentage in the textbox. |
| Show Stratums with At Risk Samples | Filter stratums that do not have a certain number of at-risk samples; select a symbol from the picklist, then specify an amount in the textbox. |
| Perform Analysis Button | Instigate the HPMS data analysis; the Sample Risk Stratum Table will be populated with information based on the parameters specified. |
(3) Sample Risk Stratum Table
The Sample Risk Stratum Table displays the number of required samples, provided samples, at-risk samples, and the percentage of at-risk samples to provided samples for each stratum based on the parameters set in the Risk Analysis Parameters. There are some important elements in this section:
| Element | Used To... |
| Export to Excel Link | Display the information as a report. |
| Rows Returned Count | Display the number of rows in the table. |
By clicking on a row in the Sample Risk Stratum Table, the row will highlight, and the Sample Risk Detail Table section will be populated with data.
(4) Sample Risk Detail Table
The Sample Risk Detail Table will remain blank until one of the rows in the Sample Risk Stratum Table is selected. When a row is selected, the Sample Risk Detail heading will change to reflect that selection, and the Sample Risk Detail Table will be populated with samples that can be found in the selected HPMS Data Table. Users can also opt to select the "Only Show At Risk Samples" checkbox which will exclude samples that are not at risk.
Delete Samples
This is a tool that is located on the Sample Adequacy section of the Sample Adequacy tab. The Delete Samples interface () will allow users to delete existing samples from the selected overlay table and source data. This interface hosts these controls:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Find Samples Button | Populate the sample list based on the data table selected. |
| Samples Grid | Show a checkbox list of available samples associated with the current data table. |
| Save to Source Checkbox | Delete checked samples from the source when used in conjunction with the Save Changes button. |
| Save Changes Button | Delete checked samples from the overlay data table and from the source data when the Save to Source checkbox is checked. |
| Discard Changes Button | Discard changes to the sample list without saving. |
Precision Level
This is a tool that is located on the Maintenance section of the Sample Adequacy tab. The Precision Level interface () is used to adjust confidence levels and precision rates for each Functional Class and Urban code combination. These values will then be used in the Check Adequacy interface when checking for adequate sampling among the Functional Class and Urban Code groupings. This interface hosts these controls:
| Control | Used To... |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Editable Precision Grid | Modify confidence levels and precision rates. |
| Save Changes | Apply changes set in the Precision Grid to the HPMS Data Tables. |
| Discard Changes | Discard changes to the Precision Grid without saving. |
Submittals Tab
The Submittals tab provides controls to create files for submittal to FHWA. There are four sections on this tab: Section Files, Summary Files, Catalog Files, and Maintenance.
Icons
Each icon on the tab leads to an interface. These icons/interfaces and their specific roles are listed below by section.
Section Files
The following tools are provided under the Section Files group:
-
-- ARNOLD Segments: Opens the interface which is used to generate route network output.
-
-- Road Segments: Opens the interface which is used to create files for the HPMS Submittal process.
-
-- Sample Limits: Opens the interface which is used to generate a text file of Samples Locations.
Summary Files
The following tools are provided under the Summary Files group:
-
-- County: Opens the interface which is used to edit and export county summary data.
-
-- Non-Federal Aid: Opens the interface which is used to edit and export non-federal aid summary data.
Catalog Files
The following tools are provided under the Catalog Files group:
-
-- Road Event Collection: Opens the interface which is used to update and create files for the HPMS Submittal process.
-
-- Road Estimates: Opens the interface which is used to view and edit estimate values.
Maintenance
The following tools are provided under the Maintenance group:
-
-- Population: Opens the interface which is used to view and edit estimated population values for urban areas.
-
-- Land: Opens the interface which is used to view and edit Land Area for urban areas.
ARONLD Segments
This is a tool that is located on the Section Files portion of the Submittals tab. The Arnold Segments interface () provides options to generate Route outputs in Shapefile, File Geodatabase, or text file format directly from the HPMS Manager product. This interface hosts these controls:
| Control | Used To... |
| Data Table Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Version Textbox | Show the selected version; cannot be edited. |
| File Type Dropdown | Select Shapefile, File Geodatabase, or text file as the output format. |
| Reference Network Radio Button | Choose between Statewide or LRS ID Routes. |
| Generate Files By Radio Button | Choose between outputting all routes or a certain route type. |
| Route Types Checkboxes | Select a specific route type (Interstate, US Route, State Route, or Local); only made available after the "Route Type" radio button is selected. |
There are three file types that can be selected on this interface: Shapefile, File Geodatabase, and text file. Each file type produces specific fields in its outputs. The table below outlines the characteristic fields of the file types.
| File Type | Fields |
| Shapefile and File Geodatabase |
For R&H route data sources, the output will include routes from the selected R&H source network modified to include additional fields required by FHWA: BeginDate and StateID. |
| Text File | For file data sources, the output will include the following fields required by FHWA: BeginDate, StateID, RouteID, BeginPoint, EndPoint, and IsDiv. |
Road Segments
This is a tool that is located on the Section Files portion of the Submittals tab. The Road Segments interface () provides options to create one or more section files for the various HPMS Data Items. The Road Segments interface is divided into 3 sections: Data Table Information, File Creation Options, and Tab Options.
(1) Data Table Information
The Data Table Information section contains general information about the currently selected Data Table. This section hosts one control.
| Control | Used To... |
| Data Table Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
(2) File Creation Options
The File Creation section contains multiple options to specify how the Road Segment files are created. This section hosts these controls:
| Control | Used To... |
| Create Individual Files Radio Button | Create individual section files based on grouping specified in the Group Files picklist. |
| Create One File Radio Button | Create one section file, instead of multiple, for all selected data. |
| Group Files By Dropdown | Group output files by Route Type, Date Item, or Route Type and Data Item. |
| Reference Network Radio Buttons | Output files using either the Statewide Routes or LRS ID Routes for reference. |
| Exclude Nulls Checkbox | Exclude sections where an HPMS Data Item does not exist from the generated section file. |
| Break on Sample Sections Checkbox | Split output segment data where samples exist. |
(3) Tab Options
The Road Designations, Road Events, and Road Identifications internal tabs specify which routes/route types and data elements are to be included in the Road Segments output files. Each tab hosts these controls:
| Control | Used To... |
| Route Box |
Select one or more routes/route types to be included in the generated section file. To do this, the user must first select an option in the picklist: Route Type or Select Route(s). If Route Type is Chosen: Select one or more route type checkboxes manually or through the "Select All" link. If Select Route(s) is Chosen: Select routes by entering a complete Route LRS (Parish, System Code, Route Name, Direction, and Feature Type picklists), then clicking "Add Route >". Multiple routes can be added before generating the section files by following this pattern. |
| Data Items Box | Select one or more data items to be included in the generated section file. |
| Select All Link |
Under Routes: Select all available Route Types for segment file creation. Under Data Items: Select all available HPMS Data Items for segment file creation. |
| Select TOPS Data Items Link | Select all TOPS data items for section file creation. |
| Create Section Files Button | Generate the section files based on selected criteria. |
Sample Limits
This is a tool that is located on the Section Files portion of the Submittals tab. The Sample Limits interface () provides options to generate a text file of Sample Locations. This interface hosts these controls:
| Control | Used To... |
| Data Table Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Reference Network | Output files using either the Statewide Routes or LRS ID Routes for reference. |
| Generate Files By Radio Buttons and Route Type Checkboxes | Select which Samples will be included in the output table. Files can be generated for All Samples or for a subset of samples based on the selected Route Types. |
| Create Files Button | Generate the sample file based on selected criteria. |
County
This is a tool that is located on the Summary Files section of the Submittals tab. The County Summaries interface () provides options to import, edit, and export county summary data. This interface hosts these controls:
| Control | Used To... |
| Data Table Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Recalculate Button | Calculate the summary data using data from the HPMS overlay rather than a text file; rows selected for Override will not be recalculated. |
| Choose File Button | Import county summary data from a selected file. |
| Export to Pipe Delimited File Link | Export the county summary data to a pipe delimited file. |
| Save Changes Button | Save changes made to the county summary data. |
| Discard Changes Button | Discard changes made to the county summary data. |
Non-Federal Aid
This is a tool that is located on the Summary Files section of the Submittals tab. The Non-Federal Aid Summaries interface () provides options to import, edit, and export non-federal aid summary data. This interface hosts these controls:
| Control | Used To... |
| Data Table Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Growth Rate % Textbox | Specify the growth rate percent to be applied to the non-federal aid summary data. |
| Apply Growth Button | Apply the specified growth rate to the non-federal aid summary data. |
| Recalculate Button | Calculate the summary data using data from the HPMS overlay rather than a text file; rows selected for Override will not be recalculated. |
| Rural - Local AADT Textbox | Enter the appropriate AADT values. |
| Rural - Minor Collector AADT Textbox | Enter the appropriate AADT values. |
| Small Urban - Local AADT Textbox | Enter the appropriate AADT values. |
| Choose File Button | Import non-federal aid summary data from a selected file. |
| Export to Pipe Delimited File Link | Export the non-federal aid summary data to a pipe delimited file. |
| Save Changes Button | Save changes applied to the non-federal aid summary data. |
| Discard Changes Button | Discard changes applied to the non-federal aid summary data. |
Road Event Collection
This is a tool that is located on the Catalog Files section of the Submittals tab. The Road Event Collection interface () provides options to view and edit data collection metadata. This interface hosts these controls:
| Control | Used To... |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Choose File Button | Import road event collection metadata from a selected file. |
| Export to Pipe Delimited File Link | Export the road event collection metadata to pipe delimited file. |
| Save Changes Button | Save changes to road event collection metadata. |
| Discard Changes Button | Discard changes to temporarily applied to road event collection metadata. |
Road Estimates
This is a tool that is located on the Catalog Files section of the Submittals tab. The Road Estimates interface () provides options to view and edit estimate values. This interface hosts these controls:
| Control | Used To... |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Choose File Button | Import estimate data from a file. |
| Export to Pipe Delimited File Link | Export estimate data to a pipe delimited file. |
| Save Changes Button | Save changes applied to estimate data. |
| Discard Changes Button | Discard changes temporarily applied to estimate data. |
Population
This is a tool that is located on the Maintenance section of the Submittals tab. The Population interface () provides options to view and edit estimated population values for urban areas. This interface hosts these controls:
| Control | Used To... |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| State Population Textbox | Enter a Total State Population value. |
| Save Changes Button | Save changes applied to the estimated population data. |
| Discard Changes Button | Discard changes applied to the estimated population data. |
| Total Percent Textbox | View an automatically calculated sum of all Percent Distribution values. |
| Total Estimated Population Textbox | View an automatically calculated sum of all Estimated Population values for each urban area. |
The Estimated Population data-- the information displayed on the table in the interface-- can be edited by selecting a Year and entering a State Population value. The data in the Percent Distribution column is used to calculate the Estimated Population for each urban area. If the user wishes to edit the Percent Distribution, they can select the cell in the desired row which will enable user updates.
Land
This is a tool that is located on the Maintenance section of the Submittals tab. The Land interface () provides options to view and edit Land Area for urban areas. This interface hosts five controls:
| Control | Used To... |
| Year Dropdown | Select the year to use when viewing the selected interface. |
| Land Area (Sq. Miles) Column | Enter a new land area value for an entry row. |
| Save Changes Button | Save any changes made to the interface. |
| Discard Changes Button | Discard any changes made to the interface since the last save. |
| Total Land Area Textbox | View an automatically calculated sum of all Land Area values. |
The Land Area data--the information displayed on the table in the interface-- can be edited by selecting a Year to modify. Then, the user can locate and select the desired cell under the Land Area (Sq. Miles) column which will enable user updates.
Reports Tab
The Reports tab is used to run preconfigured reports or to create custom reports. There are two sections on this tab: Reports and Status.
Icons
Each icon on the tab leads to an interface. These icons/interfaces and their specific roles are listed below by section.
Reports
The following tools are provided under the Reports group:
-
-- HPMS (Standard Reports): Opens the interface providing access to several preconfigured reports.
-
-- Advanced: Opens the interface which is used to create custom reports.
Status
The following tools are provided under the Status group:
-
-- HPMS Report Status: Opens the interface used to view and update the progress of the HPMS report.
HPMS or Standard Reports
This is a tool that is located on the Reports section of the Reports tab. The HPMS or Standard Reports interface () provides a list of preconfigured reports that the user can open in either a PDF or Excel format. The Standard Reports interface consists of 4 components: HPMS Data Dropdown, Report Selection Control, Filter Controls, and Output Controls.
(1) HPMS Data Dropdown
This section hosts one control:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
(2) Report Selection Control
There are several preconfigured reports that can be accessed in this interface. These reports and their functions can be viewed in the table below.
| Report | Lists the... |
| Certified Mileage by County | Mileage for Interstate, State, Local, and other routes, grouped by County. |
| Certified Mileage by County - Detailed | Mileage for Interstate, State, Local, and other routes, grouped by County, along with each route that is included in the group and the associated mileage. |
| Consistency Report | Length (in miles) of AADT, Through Lanes, Ownership, and Control, grouped by F_System. |
| Extent and Travel – Interstate by Route Number | Miles, Lane Miles, and Vehicle Miles for each Interstate route. |
| Extent and Travel – Interstate by Route Number (Comparison) | Miles, Lane Miles, and Vehicle Miles for each Interstate route for 2 years. Includes the percent change for Miles, Lane Miles, and Vehicle Miles. |
| Extent and Travel – Statewide Summary | Miles, Lane Miles, and Vehicle Miles by Small Urban, Rural, All Urbanized, and All Urban areas, grouped by Urban Code and F_System. |
| Extent and Travel – Statewide Summary (Comparison) | Miles, Lane Miles, and Vehicle Miles by Small Urban, Rural, All Urbanized, and All Urban areas, grouped by Urban Code and F_System for 2 years. Includes the percent change for Miles, Lane Miles, and Vehicle Miles. |
| Extent and Travel – Urbanized Summary | Miles, Lane Miles, and Vehicle Miles for each Urban Code, grouped by Urban Code and F_System. |
| Extent and Travel – Urbanized Summary (Comparison) | Miles, Lane Miles, and Vehicle Miles for each Urban Code, grouped by Urban Code and F_System for 2 years. Includes the percent change for Miles, Lane Miles, and Vehicle Miles. |
| Extent and Travel on the NHS | Miles, Lane Miles, and Vehicle Miles for each NHS type, grouped by NHS and F_System. |
| Extent and Travel on the NHS (Comparison) | Miles, Lane Miles, and Vehicle Miles for each NHS type, grouped by NHS and F_System for 2 years. Includes the percent change for Miles, Lane Miles, and Vehicle Miles. |
| Ownership Report | Mileage for each Ownership value, grouped by Ownership and F_System. |
Users should note that the four comparison reports calculate the percent change in data between the selected year and the year prior to the selected year. If no data exists for the prior year, the option to run the non-comparison version of the report will be disabled.
(3) Filter Controls
The Filter Controls are used to return a specific result set when running a Standard Report. There are three available filters that can be applied to the reports: Parish, Roadway Type, and Number of Lanes. However, not all filters are applicable for all preconfigured report types. Below is a list of reports and their applicable filters; these filters are optional when running reports.
| Report Type | Applicable Filters |
| Certified Mileage by County | N/A |
| Consistency Report | County, Roadway Type, Number of Lanes |
| Extent and Travel – Interstate by Route Number | County, Number of Lanes |
| Extent and Travel – Interstate by Route Number (Comparison) | County, Number of Lanes |
| Extent and Travel – Statewide Summary | N/A |
| Extent and Travel – Statewide Summary (Comparison) | N/A |
| Extent and Travel – Urbanized Summary | N/A |
| Extent and Travel – Urbanized Summary (Comparison) | N/A |
| Extent and Travel on the NHS | County, Route Type, Number of Lanes |
| Extent and Travel on the NHS (Comparison) | County, Route Type, Number of Lanes |
| Ownership Report | County |
(4) Output Controls
The user can choose to run and open a report as a PDF or Excel sheet by using the buttons in this section.
Advanced Reports
This is a tool that is located on the Reports section of the Reports tab. The Advanced Reports interface () provides a set of tools to create user defined queries and reports. The Advanced Reports interface consists of 7 components: Report Title, Data Dropdown, Precision and Identity Column Controls, Query Builder, Available Output Columns, Output Field Controls, and Selected Output Columns.
(1) Report Title
The Report Title section allows users to specify a name for a set of search criteria for future recall. The user can enter an appropriate name that characterizes the selected search elements in the provided textbox.
(2) Data Dropdown
This section host one control:
| Control | Used To... |
| Data Dropdown | Select the HPMS Data Table to use when viewing the selected interface. |
(3) Precision and Identity Column Controls
There are two controls in this section. These two controls apply general settings to the output report.
| Control | Used To... |
| Decimal Places Textbox | Set the maximum number of decimal places displayed for numeric values in the output report. Data with higher precision will be rounded to this specified decimal place. |
| Identity Columns Button | Automatically add a preconfigured set of columns to the Selected Output Columns list at the bottom of the form. Parish, Route ID, From Measure, and To Measure are added when the Identity Columns button is pressed. |
(4) Query Builder
The Query Builder section is used to specify a combination of available data elements for creating a custom query and report. Below are some of the controls that aid this process.
| Control | Used To... |
| Category Dropdown | Select the Business data types. |
| Item Dropdown |
Select an Item refined by the Category selection. |
| Logical Dropdown | Provide query operators (equal, not equal, greater than, less than, etc.). |
| Value Dropdown | Select valid values for the data column or type in where set values do not exist. |
| Add/Item (+ and X) Buttons | Add additional criteria to the query (+) or remove criteria from a query (X). The remove option is not presented in the first row since the Advanced Report must have at least one search criteria. |
| Join Dropdown | Group or create conditional queries; used in conjunction with the parentheses controls. |
| Parentheses Textboxes | Group or create conditional queries; used in conjunction with the join control. |
| Reset Criteria Button | Clear all criteria and reset the form. |
| Enter SQL Button | Switch the query criteria window to a SQL entry window. In this mode, the Enter SQL button will change to “Enter Criteria” which can be used to switch back to the traditional query builder mode. |
| Verify SQL Button | Validate the entered SQL statement when in SQL entry mode. |
| Run Report Button | Execute the query based on the selected criteria. At least one output column must be selected to enable the Run Report button. |
(5) Available Output Columns
The Available Output Columns list is used to select the data items to include in reports. Data items are categorized by functional area and can be expanded and collapsed using the "+" and "-" buttons. This list can be used in conjunction with the Output Field Controls and Selected Output Columns to customize the output of reports.
(6) Output Field Controls
The following controls are used in conjunction with the Available Output Columns list and Selected Output Columns list to customize report outputs.
| Control | Used To... |
| Add Button | Add fields from the Available Output Columns list to the Selected Output Columns list. |
| Remove Button | Remove a field from the Selected Output Columns list. |
| Remove All Button | Remove all fields from the Selected Output Columns list. |
(7) Selected Output Columns
The Selected Output Columns box is used to specify the data columns to be included in the output report. The box will be initially blank until columns are loaded using the Identity Column Control or the Output Field Controls. There are some controls offered in this section:
| Control | Used To... |
| Sort Order Up/Down Arrows | Indicates that the currently selected item is in ascending (up arrow) or descending (down arrow) sort mode. This arrow is located in the actual table, and its current direction can be changed by clicking the arrow. |
| Reorder the Report Column Sequence: Double Up Arrows | Move a selected item to the top of the list. |
| Reorder the Report Column Sequence: Up Arrow | Move a selected item up one row in the list. |
| Reorder the Report Column Sequence: Down Arrow | Move a selected item down one row in the list. |
| Reorder the Report Column Sequence: Double Down Arrows | Move a selected item to the bottom of the list. |
| Save Query Button | Open a popup form used to save the query to the database. |
| Load Query Button | Reload previously saved queries from a pickable list. |
Output
Once an Advanced Report query is executed, the results are displayed in a separate pop-up window. The Report Name, Search Criteria, Run Date, and Number of Records will be displayed at the top of the report. There are also some controls included at the top of the report. These are:
| Control | Used To... |
| Map Symbol Color | Select from a picklist of colors to display results on a map. |
| Map | Toggle to the Map Frame and highlight the selected records in the desired map symbol color. |
| Open the Windows Print Dialog to customize and print the results. | |
| View in Excel | Prompt the user to open the file in Excel or save the results locally in Excel format. |
HPMS Report Status
This is a tool that is located on the Status section of the Reports tab. The HPMS Report Status interface () provides options for tracking and updating the progress of the HPMS Submittal process. There are controls offered at the top of the interface.
| Control | Used To... |
| Completion Status Dropdown | Select the intended Data Table. |
| Section File Submittal Status Link | Open the Section File Submittal Status interface. |
| Progress Bar | Show the percentage of complete items; this will update as items are as marked complete/incomplete. |
Sections
The HPMS Report Status section contains 3 sections: Section Validations, Sample Validations, and Submittal Files.
(1) Section Validations
The Section Validations section is used to view the progress of the Route Import, Event Import, Coverage, and Cross Check validations. This section displays the number of invalidations found, along with the latest date each validation was performed.
(2) Sample Validations
The Sample Validations section is used to view the progress of the Sample Validations. This section displays the number of invalidations found for each Sample validation report, along with the latest date each validation was performed.
(3) Submittal Files
The Submittal Files section is used to view the progress of the various files required for HPMS Submittals. This section also contains a link to open the Section File Submittal Status interface.
Section File Submittal Status Interface
The user can click on the Section File Submittal Status link to open the Section File Submittal Status interface. This interface is used to track which Section Files have been created through the Section Files interfaces.
System Administration Tab
The System Administration tab is used to manage and maintain system administration functions for HPMS Manager. There are 3 sections on this tab: Maintenance, Configuration, and Utilities.
Icons
Each icon on the tab, except Flush Cache, leads to an interface. These icons/interfaces and their specific roles are listed below by section.
Maintenance
The following tools are provided under the Maintenance group:
-
-- Code Lists: Opens the interface which is used to edit application code lists.
-
-- Users: Opens the interface which is used to add and edit user information and privileges.
-
-- Versions: Opens the interface which is used to remove hanging locks and delete versions not properly deleted when saved to source.
-
-- Flush Cache: Removes the data on the cache and refreshes the page.
Configuration
The following tools are provided under the Configuration group:
-
-- Data Sources: Opens the interface which is used to create and manage data sources.
-
-- Data Tables: Opens the interface which is used to create and manage data tables.
-
-- System: Opens the interface which is used to edit configuration values used throughout HPMS Manager.
Utilities
The following tools are provided under the Utilities group:
-
-- Merge Files: Opens the interface which is used to merge multiple files into one output file.
-
-- Export Data: Opens the interface which is used to extract data from the HPMS Overlay table to a variety of other formats.
Code Lists
This is a tool that is located on the Maintenance section of the System Administration tab. The Code List interface () is used to edit the various code lists used throughout the HPMS Manager application. System Administration permissions are required to view this interface. The Code List interface consists of 3 components: Code List Controls, Editor Fields, and Button Controls.
(1) Code List Controls
There are some controls offered in the Code List Maintenance interface.
| Control | Used To... |
| Code List Dropdown | Select the code list to view and edit. |
| Code List Table | Display all valid values in the currently selected code list and edit codes and their display order. |
| Reorder the code items: Double Up Arrows | Move a selected code item to the top of the list. |
| Reorder the code items: Up Arrow | Move a selected code item up one row in the list. |
| Reorder the code items: Down Arrow | Move a selected code item down one row in the list. |
| Reorder the code items: Double Down Arrows | Move a selected code item to the bottom of the list. |
(2) Editor Fields
The Editor Fields provide options to edit the value and name of a selected code item. Selected items will also have additional fields available in this section which are specific to the item. If a user wishes to mark a code as obsolete, they can click the Obsolete Code checkbox which will prevent the code item from appearing in picklists throughout the application.
(3) Button Controls
The following button controls are provided in the Code List Maintenance interface:
| Control | Used To... |
| Add New Code Button | Add a new code to the selected code list. |
| Sort Codes A-Z Button | Alphabetically sort the codes for the selected code list. |
| Save Changes Button | Save the changes for the selected code list. |
| Discard Changes Button | Discard the changes applied to the selected code list. |
Users
This is a tool that is located on the Maintenance section of the System Administration tab. The User Maintenance interface () provides options to add new users, edit user information, and edit data privileges. System Administration permissions are required to view this interface. The User Maintenance interface consists of 4 components: User Type Control, User Table, Edit Fields, and Button Controls.
(1) User Type Control
The User Type Control is used to switch the view of user types in the user table. There are three view types:
- Active -- Only view active users in the user table.
- Inactive -- Only view inactive users in the user table.
- All -- View both active and inactive users in the user table.
(2) User Table
The User Table provides a list of users included in the selected User Type (active, inactive, or all). The last name search box can be used to jump to a given user. To delete a user, select the checkbox on the first column of the table for the desired row/entry, then click the “Delete Selected” link.
(3) Edit Fields
The Edit Fields section provides options to edit general information about the currently selected user. There are eight fields in this section:
| Field | Used To... |
| Last Name Textbox | Edit the last name of the selected user; required. |
| First Name Textbox | Edit the first name of the selected user; required. |
| Username Textbox | Edit the username of the selected user; required. |
| Email Address Textbox | Edit the email address of the selected user. |
| User Status Dropdown | Edit the status of the selected user. |
| Edit Permissions Link | Open a pop-up menu to edit the permissions of the currently selected user. |
| Permissions Table | View the list of permissions assigned to the selected user. |
| Data Privileges Link | Open a pop-up menu to edit the data privileges of the currently selected user. A summary of settings is shown in the data privileges table, listed as Yes or No respectively for Save to Overlay and Save to Source options. |
(4) Button Controls
The following button controls are provided in the User Maintenance interface:
| Control | Used To... |
| Add New User Button | Add a new user to the application. |
| Save Changes Button | Save changes applied to the selected user. |
| Discard Changes Button | Discard changes applied in the current session. |
Edit Permissions/Data Privileges Pop-ups
The Edit Permissions pop-up allows user permissions, or the allocated abilities of the user, to be added or removed. The Data Privileges pop-up lists the HPMS items and measures privileges that can be assigned to a user.
Edit Permissions
There are two tables on this pop-up interface: Available and Current. The Available table lists the permissions that can be assigned to a user while the Current table lists the permissions already assigned to a user. This interface also hosts some controls.
| Control | Used To... |
| Add (>) Button | Add permissions from the Available permissions list to the Current permissions list. |
| Remove (<) Button | Remove permissions from the Current permissions list. |
All permissions listed in the two tables have titles which indicate their role. For example, the Advanced Reports permission gives access to the Advanced Reports interface found in the Reports tab.
Data Privileges
This interface consists of a table with three columns: Data Item, Can Save to Overlay, and Can Save to Source. It also hosts some controls.
| Control | Used To... |
| Save to Overlay Checkbox | Edit and save items to an HPMS Overlay table. |
| Save to Source Checkbox | Edit and save items to source data layers. |
| Select All Overlay/Deselect All Overlay Link | Select or deselect all save to overlay privileges for the selected user. |
| Select All Source/Deselect All Source Link | Select or deselect all save to source privileges for the selected user. |
Versions
This is a tool that is located on the Maintenance section of the System Administration tab. The Versions interface () is used to manage temporary versions and file locks obtained by the HPMS Manager application. System Administration permissions are required to view this interface. This interface hosts three controls.
| Control | Used To... |
| Versions Table | Display a list of temporary versions created by HPMS Manager that have not been posted. |
| Locks Table | Feature class locks that are currently held by the temporary versions. |
| Delete Selected Button | Delete versions checked in the Version display list and release associated locks. |
Data Sources
This is a tool that is located on the Configuration section of the System Administration tab. The Data Source interface () is used to edit data sources using the dropdown control and to add data sources using the Add New button. HPMS Manager supports multiple data source types. The Connection Parameters section of the interface will reflect relevant information for the selected data source type (File, Database (SQL Server or Oracle), Map Service, and Access Database).
File Data Source
In the File Data Source Type, the user can load or delete files. To take these actions, the interface provides these controls.
| Control | Used To... |
| Data Source Type Dropdown | Select the data source type. |
| Show/Add Files Button | View the files located in the selected file share. Clicking this button will open the Files Found interface. |
| Select All to Delete Link | Select all files for deletion. |
| Select All to Load/Reload Link | Select all files to be loaded/reloaded into the database. |
| View Log Link | View details from the last files loaded for the selected data source. |
| Shortcut Dropdown | Enter a shortcut for the data source. |
| Delete Source Button | Delete the selected data source. |
| Save Changes Button | Save changes to the selected data source and loaded or reloaded files. |
| Discard Changes Button | Discard changes temporarily applied to the selected data source. |
| Verify Source Button | Verify the database entry. |
| Files Found Interface | Select the files to add to the data source, upload more files to the file share, or open existing files in the file share; appears when clicking the “Show/Add Files” button. |
Data Tables
This is a tool that is located on the Configuration section of the System Administration tab. The Data Tables interface () is used to create and manage the HPMS overlay data tables that will be used throughout the application. This interface serves 3 core purposes:
- Data Table Creation -- Used to create new Data Tables.
- Data Table Management -- Used to edit and delete previously created Data Tables.
- Data Table Definition -- Used to alter the definition of a selected Data Table.
Data Table Creation
To create a new data table, the user can select the "Create New" button in the Data Tables interface. The resulting pop-up is divided into four sections:
- Basic Information Fields -- Used to enter general information needed to create a Data Table.
- Temporal Information Controls -- Used to specify if the Data Table will retrieve temporal data.
- Setup Information Controls -- Used to copy a Data table definition from a previously created Data Table.
- Button Controls -- Used to create or cancel the creation of a Data Table.
There are some controls hosted on the "Create New" interface.
| Control | Section | Used To... |
| Name Textbox | Basic Information Fields | Enter a name for the Data Table; required. |
| Description Textbox | Basic Information Fields | Enter a description for the Data Table. |
| Year Textbox | Basic Information Fields | Specify the year of the Data Table; required. |
| Type Dropdown | Basic Information Fields | Specify that the Type for the Data Table is HPMS Manager. |
| Get Latest Data Radio Button | Temporal Information Controls | Only retrieve the latest data for the Data Table. |
| Filter Date Radio Button | Temporal Information Controls | Apply a date filter to the Data Table. |
| Create New Radio Button | Setup Information Controls | Create a new Data table definition. |
| Copy From Radio Button | Setup Information Controls | Copy the Data Table definition from a previously created Data Table. Use the dropdown provided to select the desired Data table. |
| Create Button | Button Controls | Create a new Data table based on the information provided. |
| Cancel Button | Button Controls | Close the Create New interface without creating a new Data table. |
Data Tables Management
The Data Table Management functionality is concentrated in the static controls and the Data Table Information tab controls. All controls are described below.
| Controls | Location | Used To... |
| Data Table Dropdown | Static Controls | Select the Data table to view/edit. |
| Set Official Button | Static Controls | Set the Data Table as Official; opens the Set Official Data Table window. |
| Populate/Refresh Data Table Button | Static Controls | Populate/refresh the Data table information. |
| Delete Data Table Button | Static Controls | Delete the Data Table displayed. |
| Save Changes Button | Static Controls | Save changes applied in the Data Table configuration interface. |
| Discard Changes Button | Static Controls | Discard changes temporarily applied in the Data Table configuration interface. |
| Save Data Table as Source Button | Static Controls | Save the current Data Table as a data source table for new overlays. This is useful for creating new overlays where a previous overlay may be the most current representation of specific data items. |
| Name Textbox | Data Table Information (Information box) | Enter a name for the data table; required. |
|
Year Textbox |
Data Table Information (Information box) | Specify the year of the data table; required. |
| Description Textbox | Data Table Information (Information box) | Enter a description for the data table. |
| Filtered as of Date Textbox | Data Table Information (Information box) | Specify a date filter for the data table; calendar selection also available. |
| Data Table Type Dropdown | Data Table Information (Information box) | Specify a HPMS Data Table Type. |
| Created On Message | Data Table Information (Statistics box) | Show the creation date of the selected data table; automatically filled. |
| Refreshed On Message | Data Table Information (Statistics box) | Show the date the selected data table was last populated/refreshed; automatically filled. |
| Approved for Guest Checkbox | Data Table Information (Statistics box) | Determine if guest users can use the selected data table throughout the application. |
| Is Locked Checkbox | Data Table Information (Statistics box) | Restrict or “lock” other users from editing or deleting a data table. |
| Locked By Message | Data Table Information (Statistics box) | Show which user has locked the data table. |
| Email Locked Users Link | Data Table Information (Statistics box) | Send an email to the “Locked By” users. |
Data Table Definition
The Data Table Definition functionality is concentrated in the Required Items and Attributes tabs.
Required Items Tab
The Required Items must be defined before an overlay can be populated or refreshed. There are two mandatory items required by HPMS Manager: Routes and Sample Section Locations. Each of these items have their own internal tabs on the Required Items tab. Once an overlay is populated, an icon will appear next to the title of the tab, indicating the status of the imported data. Each time the overlay is populated or refreshed, this icon will be updated to reflect the import status. There are three possible statuses:
| Icon | Type | Description |
| Success | Indicates that no errors were encountered while importing data for the item. | |
| Warning | Indicates that a non-fatal error occurred while importing data for the item. Hovering over the icon will display details of the error. | |
| Fatal Error | Indicates that a fatal error occurred while importing data for the item. Hovering over the icon will display details of the error. |
This Route internal tab is used to specify the route network to use when retrieving route data. There are two data source types in this tab: R&H or Non-R&H. The table below outlines the controls provided for each data source option.
| Control | Data Source Type | Used To... |
| "Is R&H" Checkbox | N/A | Specify whether the Route data is a Roads and Highways (R&H) data source. |
| Map Service Dropdown | R&H | Select the map service that the route network data is located in. |
| Network Name Dropdown | R&H | Select the route network; auto-filled after selecting a Map Service. |
| Version Dropdown | R&H | Select the Geodatabase version; auto-filled after selecting a Map Service. |
| Filters Textbox | R&H | Enter a valid SQL filter the Populate process uses to filter a subset of data from the selected route network. |
| Data Source Dropdown | Non-R&H | Select the data source for route network data; required. |
| Table Name Dropdown | Non-R&H | Select the table where the route data is located; auto-filled once a data source is selected. |
| Route ID Dropdown | Non-R&H | Specify the Route ID field for the route data. |
| From Measure Dropdown | Non-R&H | Specify the From Measure field for the route data. |
| To Measure Dropdown | Non-R&H | Specify the To Measure field for the route data. |
| From Date Dropdown | Non-R&H | Specify the From Date field when applying temporal data filters. This field is only required if the selected data table contains temporal data. |
| To Date Dropdown | Non-R&H | Specify the To Date field when applying temporal data filters. This field is only required if the selected data table contains temporal data. |
| Filters Textbox | Non-R&H | Enter a valid SQL filter the Populate process uses to filter a subset of data from the selected table. |
The Sample Section Locations internal tab is used to enter the data source for sample data. Both data source types (R&H or Non-R&H) are on this interface as well. The table below outlines the controls provided for each data source option.
| Control | Data Source Type | Used To... |
| "Is R&H" Checkbox | N/A | Specify whether the Route data is a Roads and Highways (R&H) data source. |
| Version Dropdown | R&H | Specify which Geodatabase version to use for the sample data; required. |
| Event Name Dropdown | R&H | Specify which event contains the sample data information; required. |
| Source Column Dropdown | R&H | Specify which column to use for the Sample ID field in the HPMS Data table; required.* |
| Filters Textbox | R&H | Enter a SQL filter that can be used to filter a subset of data from the selected event table. |
| Data Source Dropdown | Non-R&H | Select the data source for the sample data; required. |
| Table Name Dropdown | Non-R&H | Specify the table that contains sample data; required.* |
| Column Dropdown | Non-R&H | Specify the Sample ID field in the HPMS Data table; required.* |
| Route ID Dropdown | Non-R&H | Specify the Route ID field for the sample data; required.* |
| From Measure Dropdown | Non-R&H | Specify the From Measure field for the sample data; required.* |
| To Measure Dropdown | Non-R&H | Specify the To Measure field for the sample data; required.* |
| From Date Dropdown | Non-R&H | Specify the From Date field when applying temporal data filters.* |
| To Date Dropdown | Non-R&H | Specify To Date field when applying temporal data filters.* |
| Filters Textbox | Non-R&H | Enter a valid SQL filter that can be used to retrieve a subset of data from the selected table. |
| Allow Save to Source Checkbox | Non-R&H | Permit the update of sample section source data for database source types. |
*Once a table is selected, the dropdown will be filled with a list of columns found in the selected table.
Attributes Tab
The Attributes tab is used to define the sources and parameters for each of the HPMS data items. There are four internal tabs on this interface:
- R&H Events -- Used to add HPMS Data Items to the selected HPMS Data table using a registered Roads and Highways event as the source data.
- Non-R&H Events -- Used to add HPMS Data Items to the selected HPMS Data table from a file or database table source.
- Parent/Child Events -- Used to add data items where the source data has a parent data item.
- Derived Events -- Used to add derived data items.
There are some static controls on the Attributes tab.
| Control | Used To... |
| Version Dropdown | Specify the Geodatabase version to use when retrieving event data; required. |
| Delete Selected Rows Link | Delete all selected items from the data items table. |
| Copy Selected Rows Link | Copy the selected items from the data items table. |
| Add New Row Link | Add a new row to the data items table. |
| Attributes Complete Message | Track the number of HPMS Data items added to the selected HPMS Data table. |
Similar to the other Data Table Definitions tab, Required Items, the Attributes tab hosts status columns in each of their internal tabs. Once an overlay is populated, an icon will appear beside the associated data item, indicating the status of the imported data. Each time the overlay is populated or refreshed, this icon will be updated to reflect the import status of the tab data. There are three possible statuses:
| Icon | Type | Description |
| Success | Indicates that no errors were encountered while importing data for the item. | |
| Warning | Indicates that a non-fatal error occurred while importing data for the item. Hovering over the icon will display details of the error. | |
| Fatal Error | Indicates that a fatal error occurred while importing data for the item. Hovering over the icon will display details of the error. |
Data items can be deleted from any table on the Attributes tab by clicking the checkbox to the left of each desired item or using the checkbox in the table header to select all data items for deletion. Once items are selected, the user can click the “Delete All Selected” link to permanently delete the items from the Data table definition.
System
This is a tool that is located on the Configuration section of the System Administration tab. The System interface () provides options to change configuration values used by HPMS Manager. Parameters-- items under the "Name" column-- are editable by clicking in the desired row in the Value column. Once a row has been selected, the value field will become editable. Then, the user can edit the desired parameter by typing into the given textbox. The save and discard changes buttons are made available in this interface to confirm or deny the changes to the configuration parameters. The following parameters are modifiable:
| Parameter | Description |
| Advanced Reports Show Statistics | Displays the report statistics for Advanced Reports. |
| Advanced Reports Table Length | Number of rows displayed in an Advanced Reports table. |
| Excel Format | Format to use when creating Excel files (XLSX or XLS). |
| Max Invalid Records Displayed | Maximum number of invalid records to be displayed in the Invalid Data Report interface. |
| Report Cell Background Color 1 | Background color for the table cells of HPMS Validation and Standard Report tables. |
| Report Cell Background Color 2 | Background color for the table cells of HPMS Validation and Standard Report tables. |
| Report Header Background Color | Background color for the header of HPMS Validation and Standard Report tables. |
| Report Header Text Color | Text color for the header of HPMS Validation and Standard Report tables. |
| Report Left Column Text Color | Left column text color of the table cells of HPMS Validation and Standard Report tables. |
| Report Subheader Text Color | Sub-header text color of the table cells of HPMS Validation and Standard Report tables. |
Merge Files
This is a tool that is located on the Utilities section of the System Administration tab. The Merge Files tool () allows users to import and merge multiple files into one file. Files must have the same header information to be merged. If the user selects the Merge Files icon, a new form will open that will allow users to browse to a folder location and select multiple files to merge. The user can specify the output file name in the Merged File Name textbox. When the Merge Files button is pressed, the application will check that all files have the same header information, including column names and separating characters. Once validated, the output will be downloaded in the browser where the user can either open the file or save it to a location.
Export Data
This is a tool that is located on the Utilities section of the System Administration tab. The Export Data interface () provides a menu and parameters to extract data from the HPMS Overlay table and convert them into a variety of formats for use in other applications. The following controls are provided in the Export Data interface:
| Control | Used To... |
| Data Table Dropdown | Select the HPMS Data table to be used when creating the Export Files. |
| Precision Textbox | Specify the decimal precision that will be used to export measure data. |
| File Type Dropdown | Specify the output file format. |
| Exclude Nulls Checkbox | Specify whether records with NULL values for the specified data item will be included in the output file. |
| Reference Network Radio Button | Specify the route network on which all output files will be based. |
| Create Individual Files Radio Button (File Grouping Option) | Create individual export files for each selected HPMS Data Item. Files will be saved in a downloadable zip file. |
| Create One File Radio Button (File Grouping Option) | Create one export file containing the data for all selected HPMS Data Items. |
| Data Items Checkboxes | Select individual or groups of files for export. |
| Select/Deselect All Link | Select/deselect all available HPMS Data Items for export file creation. |
| Export Data Button | Generate the export files based on selected criteria. |
Workflow
If the user wishes to view a summary of the workflow for this application, they can click here.
Comments
0 comments
Please sign in to leave a comment.