Frequent Questions Water Quality Exchange (WQX)
General WQX Questions
- What is STORET and how it relate to WQX?
- Can you explain the terms "Legacy STORET," "Legacy Data Center," "Modernized STORET," "Distributed STORET Database," "Water Quality Exchange" and "STORET Data Warehouse?"
- How do I submit or get data into the WQX?
- How do I set up an Exchange Network Account?
- How do I set up a WQX Web Account?
- What is WQX? Is WQX a database?
- What is WQX Web and how is it different from WQX?
- What is the Exchange Network and how does it relate to WQX?
- How do I get data into the Water Quality Portal or How’s My Waterway?
- How do you open a WQX processing report?
- What's the relationship between EPA monitoring data in WQX and USGS monitoring data in NWIS?
- Is there a document that describes the parameter codes in Legacy STORET?
- How do you join the WQX Listserv?
- Who are the WQX Coordinators?
- Is there a User Guide for WQX Web?
- What should I do if I sent an email to the WQX Help Desk and have not heard back?
Downloading WQX Data
- How can I obtain water quality data maintained in WQX or in the STORET Legacy Data Center?
- How do I reference or cite data from the Water Quality Portal?
- How can I search and download data by Water Body ID/Name?
Submitting Data to WQX Web
- How do I prepare my data for submission to WQX Web?
- How do I access the WQX 3.0 schema validation rules and Flow Configuration Document?
- How do I access the WQX 3.0 schema definitions and Data Exchange Template?
- What are the required fields in the WQX Web Template Files?
- How do I troubleshoot WQX Web Import Error Messages?
Questions about WQX Domain Values
- How do I request new Domain Values?
- How do I handle retired taxon and retired characteristic?
- Are there example data submission text files available?
- I made a mistake in submitting my file is there any way to correct the error(s)?
- My WQX Web submissions have had the status pending for a long time, should I be worried?
- I received an error stating "connection was forcibly closed by host" or "Out of Memory", what do I do?
- How do I create Sample Collection Methods for my Organization ID?
- Why do I receive the following Import Error Message: Sample Collection Method does not have a valid Organization ID?
- How do I enter continuous data with the data logger results in WQX?
Submitting data to WQX using a Node or Node Client
- Are there example data submission XML files available?
- I made a mistake in submitting my file is there any way to correct the error(s)?
- My WQX submissions have had the status pending for a long time, should I be worried?
- I received an unauthorized access error, what do I do?
- What is the difference between the WQX Node's Test and Production environments?
General STORET/ WQX Questions
What is STORET and how does it relate to WQX?
STORET refers overall to "STORage and RETrieval", an electronic data system for water quality monitoring data developed by EPA. STORET has taken various forms since the 1960's (see next FAQ). Since about 2000, STORET has referred to a local data management system ("Modernized STORET") as well as data repository ("STORET Data Warehouse") developed for purposes of assisting data owners manage data locally and share data nationally. Up until September 2009, the distributed STORET database has been used to compile data at the national level in the STORET Data Warehouse. As of September 2009, the Water Quality Exchange, or WQX framework, provides the main mechanism for submitting data to the STORET Data Warehouse. Up until September 2009, both the distributed STORET database and STORET Warehouse has been used to submit and compile data at a national level. As of September 2009, the Water Quality Exchange, or WQX framework, provides the main mechanism for submitting data to EPA. The STORET Data Warehouse has now been replaced with the Water Quality Portal (WQP), which compiles data at a national level with multiple partners.
Can you explain the terms "Legacy STORET", "Legacy Data Center", "Modernized STORET", "Distributed STORET Database", "Water Quality Exchange" and "STORET Data Warehouse"?
"Legacy STORET" is the term we use when we mean the original (mainframe) STORET Water Quality File. From 1965 until 1998, this system was known simply as "STORET", and was the only STORET database. Storing data in it and retrieving data from it could only be accomplished by someone with a mainframe User ID and with specialized training. Since the middle of 1999, it has not been possible to use this system for data entry and in the year 2000 it became unusable for retrieval as well.
In order to preserve the data content of Legacy STORET, EPA created the "Legacy Data Center". It uses modern relational database technology and is housed on a UNIX/Oracle database server. The general public may browse or download its data, using a standard web browser such as Microsoft IE. All the data content from the Legacy STORET database was copied to this new database server during 1999 and the mainframe Legacy STORET was shut down. Data is no longer being placed in the Legacy Data Center, but the public can still access data from the STORET ftp site. ALL Legacy Data has been archived and can be downloaded by STATE. ALL STORET Legacy Data for each state is accessible via compressed self-extracting flat files delimited by <tabs>.
"Modernized STORET" refers to the system created to replace Legacy STORET for the storage and retrieval of water quality and biological data. Unlike its predecessor, Modernized STORET is a distributed database system, installed on personal computers all over the country for use by data owners. Often times, we refer to Modernized STORET as the "distributed STORET database". Up until September 2009, local STORET owners could upload mirror images of their STORET data for inclusion in the STORET Data Warehouse. This upload of the distributed STORET databases to the STORET Data Warehouse is no longer supported by EPA, rather users must submit data via the Water Quality Exchange, or WQX.
The "Water Quality Exchange", or WQX, is the primary framework for submitting data to the Water Quality Portal. WQX uses the technology, standards and protocols of the National Environmental Information Exchange Network, or Exchange Network, to provide a means for data partners to share water quality monitoring data to the Water Quality Portal. WQX is not a distributed database, but rather a standard set of data elements that all data partners map to in order to share data.
The "Water Quality Portal" has replaced STORET Data Warehouse as EPA's main repository of water quality monitoring data, including data that has been submitted via Modernized STORET as well as data that is now submitted via WQX. The Water Quality Portal houses millions of water quality records. This data continues to be provided by other federal agencies, region, states and tribal partners as well as voluntary organizations.
How do I submit or get data into the WQX?
There are two options available for you to share your data with WQX.
- Node Exchange Network: custom xml file
- WQX Web: spreadsheet import tool generates xml file
Visit Water Quality Data Upload with WQX to determine which option better suits your needs.
How do I set up an Exchange Network Account?
To set up a Node Exchange Network account visit the Exchange Network - Resources for a Custom Upload page.
On this page you will select the link to Exchange Network - Water Quality Exchange
Information on setting up an account is listed under the Supplemental Information Section.
How do I set up a WQX Web Account?
To set up a WQX Web Account, please visit the WQX Web Account Registration page for instructions.
What is WQX? Is WQX a database?
The Water Quality Exchange (WQX) is a framework that allows states, tribes and other data partners to submit and share water quality monitoring data via the web to the Water Quality Portal. WQX uses the technology, standards and protocols of the National Environmental Information Exchange Network, or Exchange Network, to provide a means for data partners to share water quality monitoring data to the Water Quality Portal. WQX is not a distributed database, but rather a standard set of data elements that all data partners map to in order to share data. States, tribes and others who store water quality data in a personal database and have the ability to generate XML files, can now submit data directly to the publicly accessible Water Quality Portal using the WQX framework.
What is WQX Web and how is it different from WQX?
WQX Web is a web-based application designed to assist smaller organizations with submitting data via WQX. With WQX, users submit WQX XML that they have already created via Exchange Network nodes or node clients. With WQX Web, users log into a web site where they have access to WQX Web for data submission. WQX Web converts spreadsheets and text files (such as comma or tab-delimited files) into a valid WQX XML submission file (based on the WQX schema). While WQX defines the framework for which data is submitted to the Water Quality Portal, WQX Web is a web-based tool with a user interface that provides for data submission using the WQX schema.
What is the Exchange Network and how does it relate to WQX?
The National Environmental Information Exchange Network, or Exchange Network, is an EPA and state partnership that provides a secure framework for sharing environmental information over the internet. Many different types of environmental data are shared over the Exchange Network, including air quality data, hazardous waste handling information, or even standardized chemical names used across EPA. WQX is the water quality monitoring data flow on the Exchange Network.
How do I get data into the Water Quality Portal or How's My Waterway?
In order to make your data available in the Water Quality Portal and How’s My Waterway you will first need to load the data into WQX. The Water Quality Portal is refreshed with WQX data Wednesday and Friday mornings around 2 a.m. Eastern Time.
The Water Quality Portal shares WQX data with How’s My Waterway. To find Water Quality Portal data in How’s My Waterway look at the Community page under the Overview tab (monitoring locations) and under the Monitoring tab after performing a search.
How do you open a WQX processing report?
When data is submitted/imported to WQX Web, WQX logs warnings or errors that it encounters into an "Event Log". Once the import has completed, the "Dataset Summary Page" will display the following:
• the number of valid and invalid records
• the number of each type of validation error and, in some cases, a link to a page where that type of error can be corrected.
• a link to the Event Log where you can review all errors and warnings encountered while processing the file.
ProcessingReport.xml is created by WQX when a submission file fails to load. There are two ways to view this report: As XML or as a web report (in the browser). Generally, the web report is much simpler to read (although it only provides a summary of the errors).
Extract this file from download file: ProcessingReport.zip, Open with Excel, Apply Stylesheet to read the data submission formatted report.
What's the relationship between EPA monitoring data in WQX and USGS monitoring data in NWIS?
In the past, the USGS and STORET/WQX have agreed to utilize common definitions and formats, to promote a common view of data between their two systems. The full text of this agreement, made in 2000, is available online. NWIS and STORET/WQX have met this agreement by creating common web services. These web services provide data out in a WQX schema format. The Water Quality Portal is a collaborative publishing tool to front-end these common web services and schema format.
Is there a document that describes the parameter codes in Legacy STORET?
Legacy STORET parameter codes can be found by clicking on the following URL https://gaftp.epa.gov/storet/ and selecting the zip file labeled ALL_STORET_parameters_codes.zip. The zip files contain two text files, one text file containing the list of parameter codes and the other text file containing associated information on the parameter codes, including the definitions of the data columns. The Water Quality Portal has a separate and independent parameter code list maintained by United States Geological Survey (USGS). To retrieve definitions of USGS National Water Information System (NWIS) parameter codes and parameter groupings, reference their website.
How do I join the WQX Listserv?
You can find the information to join the WQX Listserv here.
Who are the WQX Coordinators?
You can find the WQX Coordinators here.
Is there a User Guide for WQX Web?
Yes. The user guide is available online.
What should I do if I sent an email to the WQX Help Desk and have not heard back?
You should receive a helpdesk acknowledgement of email/phone receipt within 24 hours. Please follow-up with a help desk response exceeds 48 hours. Please note that email messages may be spam filtered. Contact us via our person-to-person telephone support at 800-424-9067 or email WQX@epa.gov . It is available from 8:00 am to 6:00 pm (ET). Please leave a message with your name, phone number and email address.
Downloading STORET/WQX Data
How can I obtain water quality data maintained in the WATER QUALITY PORTAL or in the Legacy Data Center?
Anyone with a web browser and internet access can browse and download monitoring data from the Water Quality Portal or Legacy Data Center. On the left hand side bar of this webpage, simply go to the link called Data download. Access to the Water Quality Portal allows you to click the link to download data or choose to look at any of the tutorials first. You can no longer obtain data directly from the Legacy Data Center (LDC); however, all data previously available at the LDC is now available through the Water Quality Portal. The LDC (Legacy Data Center) contains historical water quality data dating back to the early part of the 20th century and collected up to the end of 1998. The public can also access data from the ftp site.
How do I reference or cite data from the Water Quality Portal?
Anyone with a web browser and internet access can browse and download monitoring data from the Water Quality Portal. The recommended basic format to reference published data from the Water Quality Portal is as follows:
The basics of a reference is:
- National Water Quality Monitoring Council, YYYY, Water Quality Portal, accessed month DD, YYYY, at https://www.waterqualitydata.us
Reference Example:
National Water Quality Monitoring Council, 2020, Water Quality Portal, accessed June 09, 2020, at https://www.waterqualitydata.us (2013). Sampling Parameter, Date Range-from 2006 to 2009.
How can I search and download data by Water Body ID/Name?
On the Water Quality Portal Data Download page, query with the following parameters:
- Site ID
Enter the Water Body ID or Water Body Name
Submitting data to WQX Web
How do I prepare my data for submission to WQX Web?
Data loaded into WQX Web must be properly formatted. Visit the Water Quality Exchange Template Files page to identify the correct template for your data. The templates will provide guidance on how to format your data.
Note, One-On-One assistance is available to users who need help formatting and learning how to load their data into WQX Web. Please contact the WQX Help Desk for assistance.
How do I access the WQX 3.0 schema validation rules and Flow Configuration Document?
Download the WQX Flow Configuration Document - data validation rules, services and schema. The principle document which captures the detailed data exchange processing rules governing WQX using narrative text, diagrams and examples.
Visit: WQX 3.0 schema validation rules
How do I access the WQX 3.0 schema definitions and Data Exchange Template?
What are the required fields in the WQX Template Files?
ProjectIdentifier, ProjectName, MonitoringLocationIdentifier, MonitoringLocationName, Latitude, Longitude, ActivityIdentifier, ActivityTypeName, ActivityStartDate
How do I troubleshoot WQX Import Error Messages?
The WQX Team has developed a WQX Web Error Resolution document which is comprehensive list to troubleshoot WQX Web Import Errors.
Visit: Water Quality Exchange Web Error Resolution (PDF) | WQX Web
Questions about Domain Values
How do I request new Domain Values?
To request a new domain value, Review the current WQX Domain Value Service and Downloads page. Email your request to wqx@epa.gov with documentation (definitions and URL references).
Visit the Domain Services and Download page.
How do I handle retired taxon and retired Characteristics?
Example: When a taxa name has “retired” in its name (as in “Cricotopus/Orthocladius sp.***retired***use Cricotopus, Orthocladius”), how is that taxa entered into WQX? Would I use “Cricotopus, Orthocladius” or the entire “Cricotopus/Orthocladius sp.***retired***use Cricotopus, Orthocladius”?
Answer: When a taxon is “retired” it means there exists a more preferred taxon name. Meaning or implying that other means of representing the entity are preferred.
The data submitter has two options:
- Submit using the entire name: “Cricotopus/Orthocladius sp.***retired***use Cricotopus, Orthocladius”
- Using the preferred name for less ambiguity
- In this case… “Orthocladius”
- with or without Additional element name Unidentified Species = “sp” or sp1
- Or … “Cricotopus”
- In this case… “Orthocladius”
Answer: When a characteristic is “retired” it means there exists a more preferred characteristic name. Meaning or implying that other means of representing the entity are preferred.
The data submitter has two options:
- Submit using the entire name: “1,1,2-Trichlorotrifluoroethane***retired***use CFC-113”
- Using the preferred name “CFC-113” for less ambiguity
Are there example data submission text files available?
Yes. Example WQX Web data text files and XML files are provided below.
Note: WQX XML files should follow the business rules for the current WQX 3.0 Schema. All previous examples are also available for reference with the link above.
There are also examples of how to build configurations using your own text/excel/CSV files utilizing the WQX Web User Guide. Found under the Help Tab once you log into WQX Web.
I made a mistake in submitting my files is there any way to correct the error?
Yes. Previously submitted WQX Web data can be changed by performing an update operation or a delete operation. WQX Web update operations will delete existing data associated with an Activity, Monitoring location, or a Project and replace it with the resubmitted data. Data will only be updated to the level specified, i.e. if a Monitoring Location name is updated only, associated activities and results data will not be changed.
Alternatively, performing a delete operation will remove all levels of data associated with a specific component, deleting a Monitoring Location will also delete all activities and results from the system that are associated with the Monitoring Location.
My WQX Web submissions have had the status pending for a long time, should I be worried?
When submitting through WQX Web, if your submitted file is ending for over 30 minutes, cancel the submission, delete the dataset, then resubmit your file a few moments later. If you are not able to delete your submitted file, proceed to reimport the file, when prompted by WQX Web if you would like to delete the previous dataset, select OK.
I received an error stating "connection was forcibly closed by host" or "Out of Memory", what do I do?
In WQX Web, if you receive the error message "EJB Exception:; nested exception is :java.rmi.RemoteException: ; nested exception is: java.lang.OutOfMemoryError: unable to create new native thread" or the error message "connection forcibly closed by the remote host" please wait a few moments, then resubmit your dataset. This error often is caused by high amounts of traffic.
How do I create Sample Collection Methods for my Organization ID?
BEFORE Importing Results be aware of the following:
- Sample Collection Methods are now optional for WQX 3.0 and above
- For WQX Web, all sample collection method ids must be pre-registered
Steps to register sample collection method in WQX Web:
- WQX Web, Lookup Tables, EDIT SAMPLE_COLLECTION_METHOD
- Scroll to blank cells and populate
- “Enter a Sample Method ID" “Enter Org ID” "Enter a Sample Method Name"
- Save
(WQX Web) |
Adding Sample Collection Methods Sample Collection Method ID and a related Context (Method Source): Identifies sample collection or measurement method procedures. Where a documented sample collection method has been employed, this enables the data provider to indicate the documented method that was employed during the field sample collection. The Context is almost always going to be your Organization ID. If possible, list actual methods your organization uses, rather than just ‘QAPP’ since ‘QAPP’ is not very descriptive. Fill in as many of the data elements as you can so that the data will be meaningful. ID: MyCollectionMethod Context: DemoOrg Name: My Collection Method Description: Dip it. Dip it good. |
---|
Why do I receive the following Import Error Message: "Sample Collection Method does not have a valid Organization ID?"
Each Organizational owned sample collection method should use the organization Identifier as the default context:
- WQX now restricts registering national or non-organizational for context such as HACH, APHA, USEPA, USGS, ASTM, etc…
- WQX Helpdesk can assist with registering any national sample collection method contexts upon request. This will allow validation upon re-submission.
How do I enter continuous data with the data logger results into WQX?
Discrete data logger results can be submitted to WQX with interval readings using the WQX 3.0 Continuous Template (ZIP)(3 MB)
Our recommendation for continuous monitoring data is to report to WQX a single activity in which you store the actual probe readings using every (4 hours, 2 hours or evenly distributed) intervals and to which you attach at the activity level a binary object formatted as text (".txt") file or compressed (".zip") file format for archiving the complete raw set of probe readings downloaded from the data logger. This works equally well for the fixed data logger and for the so-called CTD cast, when the data logger is deployed off the side of a ship or pier and allowed to freely descend through the water column and report continuously the readings of its probes.
The CTD typically also yields results for thermocline, halocline and pycnocline depths, which can be added to the results associated with the activity. An additional comment could be included to indicate that this activity is a fixed data logger. The activity information and the "Document/Graphic" file will be available on the Water Quality Portal after export to EPA.
The Continuous Monitor Data Results Template is provided to assist in formatting the regular results obtained using a portable data logger, such as YSI probe.
Owner – Config Name | Type of Data |
---|---|
.WQX 3.0 - Template Continuous (Template) ~ 7047 | Results & Activities |
.WQX 3.0 - Template Project (Template) ~ 7039 | Projects |
.WQX 3.0 - Template Monitoring Location (Template) ~ 7040 | Monitoring Locations |
Submitting data to WQX using a Node or Node Client
Are there example data submission XML files available?
Yes. Example WQX XML files are provided below.
Note: WQX XML files should follow the business rules for the current WQX 3.0 Schema. All previous examples are also available for reference with the link above.
- WQX Web supports direct XML file submission to CDX: “Import and Submit” menu
- NGN endpoints are the following:
- Production Node:
- Node 1.1 - https://cdxnodengn.epa.gov/cdx-enws10/services/NetworkNodePortType_V10
- Node 2.0 - https://cdxnodengn.epa.gov/ngn-enws20/services/NetworkNode2Service
- Node 2.1 - https://cdxnodengn.epa.gov/ngn-enws20/services/NetworkNode2ServiceConditionalMTOM
- Test Node:
- Node 1.1 Test - https://testngn.epacdxnode.net/cdx-enws10/services/NetworkNodePortType_V10
- Node 2.0 Test - https://testngn.epacdxnode.net/ngn-enws20/services/NetworkNode2Service
- Node 2.1 Test –https://testngn.epacdxnode.net/ngn-enws20/services/NetworkNode2ServiceConditionalMTOM
I made a mistake in submitting my files is there any way to correct the error?
Yes. Previously submitted WQX data can be changed by performing an update operation or a delete operation. WQX update operations will delete existing data associated with an Activity, Monitoring location, or a Project and replace it with resubmitted data. Data will only be updated to the level specified, i.e. if a Monitoring Location name is updated only, associated activities and results data will not be changed.
Alternatively, performing a delete operation will remove all levels of data associated with a specific component, deleting a Monitoring Location will also delete all activities and results from the system that are associated with the Monitoring Location.
Note: WQX XML files should follow the business rules for the current WQX 3.0 Schema. All previous examples are also available for reference with the link above.
My WQX Web submissions have had the status pending for a long time, should I be worried?
We know this is an issue for WQX, please contact the WQX Helpdesk at WQX@epa.gov for further assistance. Or contact STORET/WQX Support for assistance via toll free phone number 1-800-424-9067.
I received an unauthorized access error, what do I do?
Contact the WQX Help Desk at WQX@epa.gov if you receive an error stating "User "youremailadress@franklin.gov" has not been granted access to the "yourorganization" organization. Please Contact STORET/WQX Support for assistance.
What is the difference between the WQX Node's Test and Production environments?
The WQX Node's Test environment is primarily for new WQX users. Every new user must make one successful submission to a Test environment endpoint prior to being permitted to submit through the Production environment. For more information on submitting through the WQX Test and Production environments please click on the following link.
- Exchange Network - Water Quality Exchange - Visit this site for information on WQX XML schema, data exchange template and Node information.
Note: WQX XML files should follow the business rules for the current WQX 3.0 Schema. All previous examples are also available for reference with the link above.