WQX Web 3.0 User Guide Addendum July 8, 2015 United States Environmental Protection Agency Office of Water 1200 Pennsylvania Avenue, NW Washington, DC 20460 ------- WQX Web 3.0 User Guide Addendum Table of Contents 1. Introduction 3 2. Modernized User Interface 3 2.1 Drop-Down Menus 3 2.2 The Help Menu 4 2.3 "Log Out" Button 4 2.4 Improved List Pages 5 2.4.1 Separate Search Criteria and Data Tabs 5 2.4.2 Buttons Moved to Top of Page 6 2.4.3 More Efficient Searches by Location 6 2.4.4 Better Page Navigation in List Pages 8 2.4.5 More intuitive wildcard searches (where applicable) 9 3. New Metrics List Page 9 4. Support for Excel Import Files 10 5. Search Criteria Added to User List Page 12 6. Search Criteria Added to Organization List Page 12 7. Improved Support for Sharing "Template" Import Configurations 13 8. More Consistent Logging and Tracking of Import Errors 13 9. Saving an Import Configuration as a File 15 10. Automatic Padding of HUC Values With Leading Zeroes, If Needed 15 2 ------- WQX Web 3.0 User Guide Addendum 1. Introduction WQX Web version 3.0 contains dramatic changes to the user interface and additional changes to enhance the user experience and provide improved functionality. However, the core features and functionality of WQX Web remains the same in version 3.0 and the same basic process for using WQX Web to convert data files into the proper WQX-compatible format and submit them to WQX still apply. It will require significant effort to update the entire WQX Web User Guide to reflect all of the changes in version 3.0. For now, this addendum to the User Guide is being provided, which will highlight the most significant changes between version 2.12 and version 3.0. 2. Modernized User Interface 2.1 Drop-Down Menus WQX Web 3.0 no longer has the space-consuming navigation panel on the left side of every page. Instead, it uses a slim set of drop-down menus across the top of the page that only appear when you need them. Additionally, several pages that were used solely for navigation purposes have been replaced by the drop-down options available in the menu. The menu is organized from left to right in correlation to the typical work-flow needed to prepare and submit a dataset to WQX. AEPA Home Page Setup Home Page Domain Values Welcom This tool will as The following lint Edit or Review Pi WQX WATER QUALITY (CHANGE: organization-sp Create or Edit an looks like and t Import a File: Ir Submission File, Administrator Import Results & Activities (into the staging area) Import Metrics & Activities (into the staging area} Import Indexes (into the staging area) Import Activity Groups (into the staging area) Import Monitoring Locations (into the staging area) Import Monitoring Location Weights (into the staging area) Import Projects (into the staging area) Import a batch of IDs for records to delete from WQX Continue working with an existing dataset (in the staging area) Submit a WQX XML file directiy to CDX /ater Quality Exchange main or add values to ribes what your import file he source for your WQX Continue with an Existing Dataset: Continue where you left off on an existing dataset that was imported into the staging area and has not yet been submitted to CDX. 3 ------- WQX Web 3.0 User Guide Addendum 2.2 The Help Menu Included in the new menu is a "Help" menu, which provides links to a number of documents and web pages that can provide useful assistance in gaining familiarity with WQX and WQX Web. v>EPA HomePage Setup Domain Values 9 Import & Submit ReviewAdministrator Home Page Glossary of Terms Getting Started with WQX Web User Guide (ver. 2.1) User Guide Addendum (ver, 3.0) WQX Web Resources and Downloads EPA STORET Site WQX WATER QUALITY EXCHANGE Welcome! This tool will assist you with the creation of an XML file comps The following links will assist you with the most common features of Edit or Review Domain Values: Review the list of allowed values organization-specific lists of domain values. Create or Edit an Import Configuration: Create a reusable configuration that describes what your import file looks like and how it maps to WQX data elements. Import a File: Import a flat file or spreadsheet into a staging area that will be the source for your WQX Submission File, Continue with an Existing Dataset: Continue where you left off on an existing dataset that was imported into the staging area and has not yet been submitted to CDX. 2.3 "Log Out" Button The logout link is now a button displayed in the upper right hand corner of the application and is always available. It continues to provide the number of minutes remaining before your session will end (if there is no activity). It now updates each minute, rather than once every five minutes. v>EPA Home Page HomePage Setup H Domain Values Import & Submit H Review Administrator WQX WATER QUALITY EXCHANGE Welcome! This tool will assist you with the creation of an XML file compatible with the Water Quality Exchange The following links will assist you with the most common features of the application: Edit or Review Domain Values: Review the list of allowed values for a specific domain or add values to organization-specific lists of domain values. Create or Edit an Import Configuration: Create a reusable configuration that describes what your import file looks like and how it maps to WQX data elements. Import a File: Import a flat file or spreadsheet into a staging area that will be the source for your WQX Submission File. Continue with an Existing Dataset: Continue where you left off on an existing dataset that was imported into the staging area and has not yet been submitted to CDX. 4 ------- WQX Web 3.0 User Guide Addendum 2.4 Improved List Pages 2.4.1 Separate Search Criteria and Data Tabs WQX Web 3.0 implements an more efficient, tabbed search mechanism in the list pages. This mechanism reduces the amount of scrolling required when viewing data and allows for future expansion of the search criteria. You enter your search criteria in the "Search Criteria" tab and then query WQX for matching records by clicking the "Search" button at the top of the page. Activities Return I Search I Clear Search Criteria i Search Criteria Organization ID: Monitoring Locations: Project ID: Date (min): Activity Types: Activity ID: WQXTEST Contains The system will display any matching data in the tab named after the type of data for which you are searching (in this example we are searching for "Activities". Activities I | Return | Search | Clear Search Criteria | Export List to Excel | L Search Criteria Activities j Activity ID Results Metrics Date Activity Type Monitoring Location ID Monitoring 01-23-456-78 Results Metrics 02-02-2006 Sample-Routine RIBEACH-001-1 Sandy Beach 1 01-23-456-78-TB Results Metrics 02-02-2004 Quality Control Sample-Trip Blank 01-90882-8 Results Metrics 07-09-2001 Sample-Routine 01-90882-9 Results Metrics 07-09-2001 Sample-Routine 02-S120-M Results Metrics 08-01-2002 Sample-Routine 03-S102-A Results Metrics 06-17-2003 Sample-Composite Without Parents 03/14/00-2714-PCB-1999FALL Results Metrics 11-02-1999 Sample-Routine CHARM-G1 Gwynns Fal: i 03/14/00-2715-PCB-1999FALL Results Metrics 11-02-1999 Sample-Routine CHARM-G2 Gwynns Fal : :1c 03/14/00-2716-PCB-1999FALL Results Metrics 11-02-1999 Sample-Routine CHARM-J1 Jones Falls upstre. 03/14/00-2717-PCB-1999FALL Results Metrics 11-03-1999 Sample-Routine CHARM-J2 Jones Falls dov 03/14/2000-2546-AL-2000SP R Results Metrics 03-14-2000 Sample-Routine CHARM-G1 Gwynns Fal : lid 03/14/2000-2546-CD-2000SPR Results Metrics 03-14-2000 Sample-Routine CHARM-G1 Gwynns Fal s up:: 03/14/2000-2546-CHL-2000SPR Results Metrics 03-14-2000 Sample-Routine CHARM-G1 Gwynns Fal; up:: 03/14/2000-2546-CO-20005PR Results Metrics 03-14-2000 Sample-Routine CHARM-G1 Gwynns Fal: lid 03/14/2000-2546-CR-2000SPR Results Metrics 03-14-2000 Sample-Routine CHARM-G1 Gwynns Falls up 03/L4/2000-2546-CU-2000SPR Results Metrics 03-14-2000 Sam pie-Routine CHARM-G1 Gwynns Falls upst ? CHARM-Gi 5 ------- WQX Web 3.0 User Guide Addendum 2,4.2 Buttons Moved to Top of Page Buttons on all pages have been moved to the top of the page so that you can get to them quickly and easily (i.e.: you no longer have to scroll down to the bottom of the page to find the buttons). oEPA HomePage Setup 3 Domain Values Import & Submit 9 Review Activities Return T Search I Gear Search Criteria Search Criteria I Activities Activity ID Results Metrics 01-23-456-78 Results Metrics 02-02-2006 2.4.3 More Efficient Searches by Location Many of the list pages (under the new "Review" menu) allow you to include a list of Monitoring Location IDs in your search criteria. Activities Return Search Criteria Organization ID: WQXTEST Monitoring Locations: Project ID: Date (in in): Activity Types: Activity ID: Contains To select Monitoring Locations to use as search criteria, you click one of the buttons to the right of the "Monitoring Locations" field. o The first button, a magnifying glass button, takes you to the Monitoring Locations (list) page and allows you to search for your desired locations and select them using checkboxes. You then accept the selected locations by clicking the "Accept Locations" button on the Monitoring Locations page. 6 ------- WQX Web 3.0 User Guide Addendum Search and Select Monitoring Locations for Activities List Page | Accept Locations [ Cancel J Search J Clear Search Criteria J Show Selected Locations Only | Search Criteria Select Monitoring Locations All None Monitoring Location ID Monitoring Location Name 10463 WEL040-0009 in 10907 WMI040-0023 10908 WMI040-0024 n 10910 WMI040-0025 Once you accept the selected locations, the system returns you to the original list page and a Monitoring Locations drop-down list (on the Search Criteria tab) will be populated with the locations you selected and accepted. All items in the drop-down list will be selected. Activity Types: Activity ID: I Contains o The second button, a Clipboard button, pops open a small form with a single field that allows you to paste in a list of Monitoring Location IDs that you wish to use as search criteria. Monitoring Location IDs X Paste a set of Monitoring Location IDs below: 10453 10907 A 10908| V OK Cancel I 7 ------- WQX Web 3.0 User Guide Addendum For example, you might keep a list of Monitoring Locations you care about in a list in Excel or in a Word document. You can copy the list and then paste them into the pop-up form. After you click the "OK" button, the Monitoring Locations drop-down list (on the Search Criteria tab) will be populated with the locations you pasted into the pop-up form. All items in the drop-down list will be selected. Search Criteria Organization ID: Monitoring Locations: Project ID: Date (min): Activity Types: Activity ID: o Note that you can uncheck one or more of the check boxes next to a Monitoring Location ID (in the drop down list) if you wish to temporarily exclude a particular monitoring location from your search criteria Search Criteria Activities Grgfcj^ion ID: WQXTEST Monitoring Loca^H^^^j^ |AII items checked T Project ID: k 010463 010907 Date (min): 010908 [Ml Activity Types: | * | Activity ID: Contains w | 2.4.4 Better Page Navigation in List Pages The improved list pages also employ a more efficient page navigation mechanism that allows you to jump forward or backward in batches of pages, rather than one page at a time. 03/14/2000-2546-PIP-2000SPR Results Metri 03/14/2000-2546-PN-2000SPR Results Metri 03/14/2000- 2546 - P04-2 OGOS P R Results Metri 03/14/2Q00-2546-POC -2000S P R Results Metri 03/14/2000-2546-SI-2000 S PR Results Metri 03/14/2000-2546-TDN-2000SPR Results Metri 1 N 1 R^ 2 3 4 5 6 7 8 9 1C(^7~I 1 W 1 J) Click on the "..." link to load the next batch of 10 pages into the page list. 8 ------- WQX Web 3.0 User Guide Addendum 2.4.5 More intuitive wildcard searches (where applicable) In previous versions of WQX Web, wildcard searches were conducted in list pages by using the percent sign (%) as part of your search text. For example, in the Results list page, you could search for Results by Activity ID. If you wanted to review all results for Activities with Activity IDs beginning with the "LoganRiver", you would enter "LoganRiver%" into the Activity ID search criteria field. Beginning with version 3.0, search criteria fields that allow wildcard searches have a drop-down list of options in front of their search criteria text box. The options are: "=" means that you only wish to review values that exactly match what you type (or you will provide your own wildcard expression). "Starts with" means that you only want to review values that start with the text you type. "Ends with" means that you only want to review values that end with the text you type. "Contains" mean that want to review values that contain the text you type (i.e. any partial match). This is the default option. Organization ID:* Activity Type(s): Monitoring Locations: Activity ID: Characteristic: Taxon: Units: sEattion; Activity Date (min): Contains Starts With Ends With 3. New Metrics List Page A new Metric List Page has been added to the system in order to allow you to search for and review metrics that have been submitted to WQX. Click the "Metrics" link under the Review menu to open the Metrics list page. The new list page works similarly to other list pages. Please review Section 3.6.2 "List Page Features" in the WQX Web user guide for an explanation of features common to all list pages. Also see, section 2.4, above, for information about the improvements to WQX Web 3.0 list pages. 9 ------- WQX Web 3.0 User Guide Addendum Metrics Search Criteria Organization ID: Monitoring Locations: Project: Date (min): Activity ID: Activity Type{s): Metric Type: Contains 3 % EPT Individuals ~ % EPT Individuals One Metrics list page Search Criteria tab feature that is not common to other list pages is the ability to search for metrics of a specific type. Activity Date 09-15-1980 09-16-1980 05-14-1980 04-25-1980 05-16-1980 05-16-1980 04-18-1980 05-20-1980 08-05-1980 06-16-1980 06-16-1980 05-14-1980 05-06-1980 09-23-1980 09-22-1980 09-15-1980 09-15-1980 11-12-1980 11-12-1980 06-26-1980 10-01-1980 11-12-1980 04-18-1980 07-07-1980 12-11-1980 Activity Type Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sample-Routine Sam pie-Routine Sample-Routine Sample-Routine Sample-Routine Monitoring Location ID SB003 SB014 SB098 SB107 SB202 SB203 SB204 SB206 SB209 SB213 SB214 SB215 SB218 SB222 SB223 SB230 SB231 SB232 SB233 SB238 SB238 SB240 SB252 SB252 SB252 Metnc Type % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals- % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals - % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals % EPT Individuals 4. Support for Excel Import Files Prior to version 3,0, WQX Web could only import text files (e.g. tab or comma delimited files), adding an extra step to the process for anyone using Excel to manage or prepare their data for import and submission to WQX. Because Excel preserves formatting it's often more convenient than CSV/TXT files (which lose the formatting every time you close the file). Additionally the WQX Web Templates are provided in Excel files that had to be saved as text files before they could be imported into WQX Web. 10 ------- WQX Web 3.0 User Guide Addendum Now, when importing data, the system includes Excel as one of the supported file types and is able to open, read, and import the data from the appropriate tab in the Excel spreadsheet. vvEPA HomePage Setup 9 Domain Values^j Import & Submit H Review Administrator^* Help B Import File Continue I Cancel Import Configuration and Type of File Type of Data: Import Configuration: Type of File: Worksheet(s) to Import: Generated Values Activities and Results Mark M. LeBaron ~ 2011-21-ActivitiesNResults ~ 2123 Microsoft Excel (xlsx) .st" worksheet is the left-most tab of the Excel Workbook) Element Value Organization ID GQLDMARK New or Existing Data: CSV (Comma delimited} Microsoft Excel (xlsx) Microsoft Excel 97-2003 (xls) Text {Pipe delimited) Text (Tab delimited) Text (Tilde delimited) Q This file contains new data only. Log an error if the unique ID of a record in the file matches a record in WQX (to prevent me from accidentally overwriting existing data). 0 This file contains existing data only. Log an error if the unique ID of a record in the file does not match a record in WQX (to prevent me from creating duplicate data). This file may contain new and/or existing data. Don 't log errors for unique IDs. Just provide summary counts of new/existing records (on the Dataset Summary Page) Import File(s) Import File: Attachments File: Choose File , No file chosen Choose File No file chosen .xlsx, .xlsm, .zip .zip &EPA Home Page Setup Import File Domain Values Import & Submit Administrator Import Configuration and Type of File Type of Data: Activities and Results Import Configuration: Mark M. LeBaron ~ 2011-21-ActivitiesNResults ~ 2123 ~] Type of File: Microsoft Excel (xlsx) '1 Worksheet(s) to Import: 2nd, 3rd ^ Aiote: the "1st" worksheet is the left-most tab of the Excel Workbook) 01st rt File? Generated Values Ž2nd Element Value *Ž3rd Organization ID GOLDMARK ~ -4th ~ 5th New or Existing Data: .g. This file contains new da' Log an error if the unit ~ 6th notches a record in WQX (to prevent me from accidentally overwriting existing data). This file contains existinc Log an error if the uniq ~ 7th oes not match a record in WQX (to prevent me from creating duplicate data). This file may contain new Don 'f log errors for uni ~ 8th y counts of new/existing records (on the Dataset Summary Page) Import File(s) ~ 9th Import File: | Choc ~ 10th .xlsx, .xlsm, .zip Attachments File: | Choc Qllth .zip ~ 12th 11 ------- WQX Web 3.0 User Guide Addendum Note: the WQX Web 3.0 Import Configuration page has been modified to allow you to specify that your file is an Excel spreadsheet and also indicate which worksheet (i.e. tab of the spreadsheet) contains data to be imported. Import Configuration | Return J Save J Cancel | Delete J Save As j Save To File J Change User Rights J Enable Expert Mode J Show Columns as Numbers J Type: Owner: Monitoring Locations Rvan Joraensen Chanae Owner Name-* Ryan - Monitoring Location Simple Description: A V File Type:* [ Microsoft Excel (xlsx) T Worksheet(s) to Import J 1st ~ ] (note: the "1st" worksheet is the left-most tab of the Excel Workbook) fH This is a template (shared with all users) You may wish to change the "File Type" setting in the import configurations that you use, so that you don't need to keep changing this setting each time you import a file 5. Search Criteria Added to User List Page System administrators can now search for a particular user, rather than having to search visually by scrolling through the list of users. Users I 1 Add New J Export to Excel 1 User Full Name: [ Contains ~] Q Show Disabled Users J Full Name ~ Ļ Login i 'Ļ* 3 pi e WOX Web 3 Test User wqxweb3testuser asd WOX Ruies Test User wqxtestuser Test User 9 testuser9 Test User 8 testuser8 Leech L Test User 7 testuser? Test User 6 testuser6 Test User 5 testuserS Test User 4 testuser4 6. Search Criteria Added to Organization List Page System administrators can now search for a particular organization, rather than having to search visually by scrolling through the list of organizations. 12 ------- WQX Web 3.0 User Guide Addendum Organizations Add New Organization Name: [ Contains ~] ^ ID Name 10 RG12-13 Organization 12-13 TESTORG999 Test Org Ninety Nine Nine WOXTEST Test Organization WOXTEST NEW99 Test Organization 7. Improved Support for Sharing "Template" Import Configurations In the previous versions of WQX Web, every new WQX Web user was automatically granted rights to certain existing "template" Import Configurations. But there was no convenient way to manage them. WQX Web 3.0 allows system administrators to easily manage the list of "template" Import Configurations and provide a number of new features to support them. System administrators can flag an import configuration as a "template" and it will automatically be shared with all WQX Web users. Import Configuration Templates can include attached documents that users can download from the Import Configuration Page within WQX Web (rather than having to go to the STORET web site for them). These documents could include an example import file, documentation, etc. An import configuration will always include "(template)" at the end of its name (whenever it's displayed on a web page) so it's clear to users that it is a shared template. Import Configuration Return | Save I Cancel I Delete I Save As I Save To File I Change User Rights I Enable Expert Mode I Show Columns as Numbers Type: Activities and Results Owner: fyan Joraensen Chanae Owner Name:* Training Results Description: A V File Type:* Microsoft Excel (xlsx) Ļģ ] Worksheet(s) to Import 1st T (note: the "1st" worksheet is the left-most tab of the Excel Workbook) [V] This is a template {shared with all users) Template Use: Copy Required Attached Files: Add File Name Training Results Documentation.docx Trainina Results Example.xlsx 8. More Consistent Logging and Tracking of Import Errors WQX 2.1 presented validation errors in two ways on the Dataset Summary page: 13 ------- WQX Web 3.0 User Guide Addendum 1. A count of the number of warnings, errors, and messages was displayed and a link was provided to the "Event Log", where you could review the details; 2. A separate list of counts was provided for certain types of errors (e.g. Max Length Exceeded, or Invalid Domain Value). Each link would navigate to a corresponding page where you could correct the error. There was also a count of "Other" errors, which represented all other errors (that couldn't be corrected). This link took you to the Event Log. This approach was confusing and had some inconsistencies. In WQX Web 3.0 we have reworked the "Other" validation errors, so that most fall within a category that can be corrected (if you choose to make corrections within WQX Web). WQX Web 3.0 also provides a much more consistent and clear summary of the validation issues that were found while importing your file, as well as a consistent way to review those errors (either in the Event Log or on a Resolution Page - where they can be corrected). Dataset Details I Return | Delete J Export Si Submit to CDX Dataset Information: Type: Activities and Results Import Configuration: Results Derro - all Types of validation errors Organization ID: WQXTEST Status: Imported Import Event Start Time: 07-08-2015 01:08:49 PM End Time: 07-08-2015 01:08:52 PM File Name: Results Demo - All types of validation errors.xlsx Event Log: View all validation errors and warnings Message Type Total Rjesolved Event Log Resolution Message 6 View Loa None Needed Max Length Exceeded 2 1 View Loa Resolve Online Domain Value Invalid 20 0 View Loa Resolve Online Value or Format Invalid 1 0 View Loa Resolve Online Required Value Missing 3 0 View Loa Resolve Online Risk of Overwriting Data 7 0 View Loa Resolve in Import File Inconsistent Data 12 0 View Loa Resolve in Import File Note that there is a link at the top of the table (summarizing your validation issues), which is titled "View all validation errors and warnings". When you click this link you will be taken to the Event Log page an it will display all validation errors and warnings. Otherwise, you can click one of the "View Log" links to view just one type of validation error (or warning or message) in the Event Log. Also note that the "Resolution" column provides links, titled "Resolve Online". When you click on one of these links, you will be taken to a Resolution Page, where you can correct these validation errors with the WQX Web system (if you wish to do so). Note that there are also a couple types of errors that cannot be corrected with WQX Web. These are noted by the label stating "Resolve in Import File". It is 14 ------- WQX Web 3.0 User Guide Addendum recommended that you review and resolve these errors first (in your import file) before addressing the other types of errors. 9. Saving an Import Configuration as a File WQX Web Import Configurations can be saved to a file and restored from a file for the purposes of: backing up import configurations for safe keeping; archiving old import configurations that are no longer used; providing WQX Web template import configuration files that match template data spreadsheet files; sharing import configurations between users. Prior to WQX Web version 3.0, however, the file format created by one version of WQX Web was not guaranteed to be compatible with newer versions of WQX Web, and sometimes restoring an import configuration to the system failed. This unreliability limited their usefulness. Starting with WQX Web 3.0, Import Configurations can be reliably saved as a file and later imported back into the system no matter whether they were created in that version of WQX Web or an earlier version (as long as the earlier version was version 3.0 or later). 10. Automatic Padding of HUC Values With Leading Zeroes, If Needed When HUCs beginning with a leading zero are imported into Excel, they are often treated as numbers by default and Excel removes any leading zeros. If needed, WQX Web version 3.0 automatically pads HUC 8 and HUC 12 values during import with leading zeroes to restore them to their appropriate length/format. 15 ------- |