Glossary

The following is a glossary of some of the acronyms or terms used in the WQX Web Application or User Guide.  
If a definition includes a term that is also in the glossary, it is displayed like this with hypertext linking to additional terms and definitions.





How do I prepare my data for submission to WQX Web?

Acronym/Term

Definition

Activity

A general term for a field sampling event that produces one or more Result or Metric.  In WQX, an Activity tracks the location, date, and time of the sample or field measurement, as well as the equipment and methods used to collect, transport and store the sample. 

Activity ID

Each Activity must have its own Activity ID which is used to identify it in the system.  An Activity ID must be unique (within your Organization).  Accidentally reusing an Activity ID would result in data being overwritten in the system, so it's important to follow a standard that guarantees that each Activity ID is unique.

One simple approach to creating your Activity ID is to combine several pieces of information about your Activity (such as the location, date, and type of activity).  For example, a lab sample collected on 05/04/2013 at the "BearRiver1" Monitoring Location might have an ID of "BearRiver1-20130504-L" (where L represents lab data).  Field Measurements & Observations at the same location might have an ID of "BearRiver1-20130504-F" (where F represents field data).

If you collect several samples at a location, you might need to include the "Activity Start Time" (or something else) as part of your Activity ID to make sure that it is unique.

Activity Group

A collection of Activities that are related to each other.  Each Activity Group must have an ID, a Type and include at least two Activities.  The following types are currently supported: 

Field Set:  groups all of the field observations, measurements, and samples collected at a monitoring location on a specific date.

QC Sample:  groups the samples and their related QC sample(s).  For example, you might group a "Trip Blank" with all the samples from the trip.

Replicate:  links a replicate sample with the original sample (that it would be compared against)

Subsample:  groups composites, splits, or subsamples with their respective parent or related samples.

Attachment

Also known as an Attached Object (in WQX).  This is an external computer file that is attached to a record in the database.  The attachment may be a photo, a document, a spreadsheet, etc.  The following entities allow attachments: ProjectMonitoring LocationActivity, and Result.

A common attachment on a Project might be your QAPP Document. 

Monitoring Location or Activity might include a photo of the location. 

In locations where you collect continuous monitoring Results, EPA recommends that you create a summary Result (such as a 12-hour mean value) and then provide an attachment with the complete set of result values.

Biological Intent

An indicator of the type of biological result being providing.  The following values are allowed:

 

♦         "Population Census" is for providing the total number of a particular species found in a sample or collection effort.

♦         "Frequency Class" is for providing the number of a particular species that have certain attributes.  One or more frequency class descriptors and, optionally, a lower and upper bound determine the class being counted.

♣   Examples:  

-  the count of all Adult Males

-  the count of those with tumors

-  the count of those with a length between 5 and 10 cm

♦         "Group Summary" is for providing summary information about all of a particular species that were collected. 

♣   For example: the Maximum, Minimum, and Mean Weight of a particular species of fish.

♦         "Individual" is for reporting measurements for one individual.

♦         "Tissue" is for reporting analysis results of a tissue sample. 

♦         "Toxicity" is for reporting the results of toxicity testing on a species.

CDX

[The] Central Data Exchange.  EPA's name for their node on the Exchange Network.  Software, like WQX Web, communicates with CDX when it submits data to EPA and checks on the status of a data submission.

CDX has two types of accounts that can be created:

                        CDX-Web Account:  this account is used to log into the CDX web site and is required for every WQX Web User.

                        NAAS Account:  this account is used by a Node (or Node Client) to communicate directly with CDX.  WQX Web Users do not need a NAAS Account.

The CDX Help Desk can be reached at:

(888) 890-1995 or helpdesk@epacdx.net

Characteristic

The WQX element that identifies "what is being measured" in a field or lab result.  This is sometimes called the analyte or parameter name in other systems

For example, if you collected a Dissolved Oxygen measurement of 8.27 mg/l and then wanted to load this result into WQX Web, then the Characteristic would be "Dissolved oxygen (DO)".  Also, the Result Value would be "8.27" and the Result Unit would be "mg/l".

Characteristic Pick List or Choice List

The list of result values that are allowed for a specific characteristic.  Only a small number of characteristics include a "Pick List".  

For example, when the characteristic is set to "Turbidity severity (choice list)" the result value must be one of the following:

NONE, MILD, MODERATE, SERIOUS, EXTREME

Most characteristics with a pick list, include "(choice list)" in their name.  The WQX Web "Lookup Tables" page includes a link to the list of "Characteristics with [a] Pick List" and a link to the "Characteristic Pick List Value[s]" for each of those characteristics.

Conducting Organization

This is the name of the organization that collects a field sample or measurement. 

It's useful to understand that there are two organizations that can be referenced on an activity record in WQX. 

The [WQX] Organization (defined separately), is an official organization created in the WQX system.  It's the organization that manages a set of data and submits it to EPA.  When the term "organization" is used, it generally refers to a WQX Organization.

In cases where the organization that performs the field work is not the same as the official WQX Organization, you are allowed to list one or more "Conducting Organization" for your activity.  This might be the name of a contractor or external group that collected the sample.  These organizations do not have unique IDs and are not validated in any way.

Most smaller organizations do not use the Conducting Organization element, because they do their own field work.

Context

In WQX Web, context often refers to the bounds within which an identifier must be unique. 

For example, an "Analytical Method Context" is used to identify the organization that manages a set of Analytical Methods.  This may be a WQX Organization (like "UTAHDWQ") or an external organization (like "IDEXX").  For example, the IDEXX context includes an Analytical Method ID of "Colilert".  This does not prevent the "UTAHDWQ" context from also having an Analytical Method ID of "Colilert".  When you reference an Analytical Method ID (in an import file, for example) you must also provide an Analytical Method Context.

Most IDs, however, do not have an explicitly named "context".  Instead, the WQX Organization is the context for entities that are imported and for some organization-specific domain values.  For all other domain values, the context is the entire WQX System

Crosstab File

In WQX Web, a crosstab file is a special type of spreadsheet or flat file format where column headers contain data that relates to all the rows of the file.  A crosstab file is more concise than a standard file, because it avoids some of the repetition that occurs in a standard file and typically includes many of the same type of entities on a single row of the file.  For example you could include many results on a single row (rather than just one).  Many crosstab formats are supported in WQX Web, but the import configurations for them are quite a bit more difficult to set up.

Here is an example of a standard file (with one Activity and one Result per row):

Activity ID

Activity Type

Activity Start Date

Monitoring Location ID

Characteristic

Result

Unit

A1

Field Msr/Obs

5/4/1999

ML1

Temperature, water

1.5

deg C

A1

Field Msr/Obs

5/4/1999

ML1

Turbidity

-0.21

NTU

A1

Field Msr/Obs

5/4/1999

ML1

DO

6.5

mg/l

A2

Field Msr/Obs

8/8/1999

ML3

Temperature, water

15

deg C

A2

Field Msr/Obs

8/8/1999

ML3

Turbidity

4.3

NTU

A2

Field Msr/Obs

8/8/1999

ML3

DO

12

mg/l

 

And an example of the equivalent crosstab file (with one Activity and many Results per row):

 

Temperature, water

Turbidity

DO

Activity ID

Activity Type

Activity Start Date

Monitoring Location ID

deg C

NTU

mg/l

A1

Field Msr/Obs

5/4/1999

ML1

1.5

-0.21

6.5

A2

Field Msr/Obs

8/8/1999

ML3

15

4.3

12

CSV

Comma Separated Value.  A computer file format for a table where each piece of information is separated by a comma.

Files in this format can be imported into WQX Web.

Microsoft Excel has a "Save As" menu that allows you to convert your spreadsheet to other computer file formats.  If you choose the "CSV" type, then your file will be stored in a format where each column is separated by a comma character and each row is separated by a carriage return character.

Data

In computing, data is information that is stored in a format that is convenient to process. 

Data may come from a probe, a lab, or be hand entered into software.  Data is often stored in a flat filespreadsheet, or database.  The purpose of WQX Web is to convert this data into the format that is required for WQX.

Data Flow

A named standard for a specific type of data available on the Exchange Network.  Each data flow has a documented format (based on XML) that must be used when submitting that type of data to a node.  WQX is the only data flow that is used by the WQX Web application

Dataset

A dataset is a copy of the original data (from your spreadsheet or flat file) that has been imported into the WQX Web application.  A dataset is temporary and only becomes permanent once it has been exported and submitted to CDX (and receives a status of "Completed at CDX"). 

A dataset should be deleted once it has been successfully submitted to CDX.  If it is not deleted manually, it will be automatically deleted from the system (after a defined expiration period).  This prevents the system from getting overloaded with temporary data that is no longer used.

Domain Value or Lookup Value

A value within the list of allowed values for a specific element.  Each allowed value is unique (within a certain context)

For example, "Water" is a domain value for "Activity Media".  "Kick Net" is a domain value for "Sample Collection Equipment".

Domain Value List or Lookup Table

The list of allowed values for a specific element (or domain). 

For example, the domain value list for "Activity Media" includes: Air, Sediment, Soil, Water, etc.

element or Data Element

In WQX Web, an element is a piece of information stored in the database.  Examples of data elements are "Latitude", "Longitude", "Project Name" and "Activity Start Date". 

See also: Entity and Import Configuration.

Entity

A concept represented by a record in the database. 

ProjectsMonitoring Location, and Result are examples of entities.

Each entity has a set of elements whose values describe it. 

For example: each Project (entity) has Project ID, Project Name, and Project Description (elements) whose values describe that specific project. 

Entities and Elements are particularly relevant when working with Import Configurations

EPA

[United States] Environmental Protection Agency

Exchange Network

Short for the National Environmental Information Exchange Network (NEIEN).  The Exchange Network is an Internet-based system used by states, tribes, and other public/private organizations to securely share environmental data with one another and the EPA.  Partners exchange data using a software application known as a node. The largest trading partner on the Exchange Network is the EPA.  Their node is known by the acronym CDX.

  • Exchange Network - Click text to Visit this site for information on Water Quality Exchange (WQX) XML schema, data exchange template and Node information.

Flat File or Text File

"Flat File" refers to a computer file that is organized into rows and columns.  The term "flat" is used to differentiate it from file formats, like XML, that are hierarchical. "Text File" refers to a file that is plain text (i.e. no formatting or styling information, like fonts or colors, is included in the file).  These two terms are often used interchangeably to refer to a file that contains plain text (data) and just a few specific formatting characters, which are used to mark the columns and rows in the file.

These files often use tabs, pipes (|) or tildes (~) as delimiters (see Tab-delimited) and typically their file names end in ".txt".  When commas are used as a delimiter, the files typically end in ".csv" (see CSV). 

WQX Web can only read flat files, so spreadsheets must be converted to one of these formats before they can be imported.

IBI

Index of Biological Integrity (or Index of Biotic Integrity).  An IBI uses the results of fish assemblage surveys to assess the ecological quality of waters.  An IBI Score is the assessment score for a particular Monitoring Location on a particular date.  An IBI is one type of index that is supported by WQX and WQX Web.

ID, Identifier,  

or Unique Identifier

A series of letters, numbers and/or other characters that serve as a unique label for an entity or concept.  In WQX, IDs are not case-sensitive (e.g. "ABC-1" would be considered identical to "abc-1").

Most entities that you import have an element that is its ID (e.g. Project ID, Monitoring Location ID, Activity ID, Activity Group ID, Index ID, and Metric ID).  Many other elements are constrained to a list of allowed values (i.e. lookup table), which are referenced by their ID (although the element may not include "ID" in its name).  Examples include: Sample Collection Method ID, Metric Type ID, Characteristic Name, and Result Laboratory Comment Code.

In WQX Web, uniqueness is enforced within a specific context (see "Context")

Index

Each occurrence of a biological or habitat assessment record within the system.  For example, if a habitat assessment is performed each year, for 3 years, on each of 5 monitoring locations, then there will be 15 Index records in the system.  Each one will store the habitat assessment score for a particular Monitoring Location on a particular date. 

An Index Score is generally determined by totaling or averaging a group of Metric Scores for a particular Monitoring Location on a particular date.

Index Type

This element describes the type of Index being evaluated. 

Before an Organization can import their [Biological or Habitat] Index data, they must manually enter  their list of Index Types into WQX Web.

For example:  Before importing your IBI data, you must first create an Index Type for your organization.  The Index Type ID could be "IBI" and the Index Type Name could be "Index of Biotic Integrity".   Each organization can create as many Index Types as they wish.

Import Configuration

A definition or map for each type of file that is imported into WQX Web. 

WQX Web provides a web page where a user can create their own import configurations.  Import Configurations allow you to list each column that you have in your import file and map it to data elements that exist in WQX.  You can create (and save) an unlimited number of Import Configurations, and you can share them with others, as needed.  When you import a file into WQX Web, you must select an import configuration (by its name).  This tells WQX Web what type of data you are importing and how it should interpret the data in your file.

WQX Web includes a handful of import configurations that have been created and shared with all users.  There are also some example Excel Spreadsheets that can create files that match these shared import configurations.  These Excel Spreadsheets are referred to as Templates (see also "Templates")

If a user relies entirely on Templates, then they do not need to create their own import configurations.  However, creating your own import configurations may reduce the work needed (in the long run) to get your data imported into WQX Web.

Metric

Each instance of a quantifiable component used in a biological or habitat assessment.  A Metric has a score and a value (which is optional). 

For example:  a metric for "Riparian Vegetation Zone Width" may have a value of "12.5 ft." and a score of "4".

A metric is not required to be, but generally is, part of a biological or habitat assessment (whose final assessment score is stored in an Index record). 

For example: the total of all the metric scores for an IBI determines the overall IBI score.

Like Results, each Metric in WQX must be part of an Activity.  Metrics do not have a [Unique] ID.  Because of this, there is no way to add, update, or delete an individual Metric via an import file.  You must always import an entire Activity and all of its Metrics, even when only one metric has changed.

Metric Type

This element describes the type of metric that is being evaluated. 

Before an organization can begin importing their Metric data, they must first create the list of Metric Types that they will be using. 

Examples of habitat metric types are "Riparian Veg Zone Width" and "Bank Stability". 

Examples of biological metric types are "Percent of Tolerant Species" and "Percent of Hybrids".

Monitoring Location

Also known as a site or station.  This is the location (on a water body) where samples or field measurements and observations are collected. 

Before an organization's ActivitiesResultsMetrics or Indexes can be imported, their Monitoring Locations List must be imported and submitted to CDX.

Updating a Monitoring Location will not affect the Activities, Metrics, or Results below it.  However, deleting a Monitoring Location will delete the Activities, Metrics and Results below it.

NAAS

Network Authentication and Authorization Services.  The NAAS is used on the Exchange Network to validate a user before gaining access to a node

WQX Web uses a single NAAS Account when it communicates with CDX, so WQX Web Users do not need to have their own individual NAAS Account.

Node or Node Client

Software used to send or receive data on the Exchange Network

Nodes can submit data to, and request data from, other nodes as well as receive data and respond to requests for data from other nodes.  The most significant node on the Exchange Network is CDX (operated by the EPA).  A limited node, known as a Node Client, is built into WQX Web, so that it can submit data to CDX.

Organization

or

WQX Organization

A state, tribe, volunteer monitoring group, or other public/private organization that manages water monitoring data. 

A physical organization may have multiple Organization records in WQX.  For example, a state or tribe may choose to have separate Organizations [in WQX] for their beach monitoring program and their other monitoring programs.  In WQX, an Organization is the entity that is the parent of all other entities (e.g. Projects, Monitoring Locations, Activities, etc.).  Each Organization has a unique ID (which is approved by the EPA).  Likewise, a user must be assigned rights to an Organization before he/she is allowed to import data belonging to it.

Pick List

A list of allowed values.

In the WQX Web Application, a pick list may be displayed in a dropdown list, or a full page list (also called the "Pick List").  The user can then select their choice from the list to complete the input operation.

Probe or Sonde

A water quality monitoring instrument, that may be stationary or may move up and down a water column, measuring, but not limited to, the following water characteristics: temperature, conductivity, salinity, dissolved oxygen, pH, turbidity, and depth

Sonde is French for probe

Project

Typically refers to a water monitoring project with specific objectives and procedures.  However, in WQX Web, a project is an entity created to group monitoring data for a variety of reasons.  A project may represent an actual monitoring project, a source of funding (or program), or a department or group within the organization who is interested in a specific set of data.

Before an organization's ActivitiesResultsMetrics or Indexes can be imported, their Projects List must be imported and submitted to CDX.

Updating a Project will not affect the Activities, Metrics, or Results below it.  However, deleting a Project will delete the Activities, Metrics, and Results below it (unless the Activity relates to more than one Project).

A Project must include a Project ID, Project Name, and either a Project Description or Project Attachment (often for the QAPP).  Each Activity in WQX must be linked to a Project, and can, optionally, be linked to multiple Projects.

QAPP

Quality Assurance Project Plan.  Documents the planning, implementation, and assessment procedures for a particular project, as well as any specific quality assurance and quality control activities. All work performed or funded by EPA, that involves the acquisition of environmental data, must have an approved Quality Assurance Project Plan.

QA/QC

Quality Assurance/Quality Control

Result

This entity describes the results of a field measurement, sampling event, observation, or laboratory analysis. 

Each result in WQX, must be part of an Activity.  Unlike most other entity in WQX, Results do not have a Unique ID.  Because of this, there is no way to add, update, or delete an individual Result via an import file.  You must always import an entire Activity and all of its Results. 

Example: You collect five Results from your multi-parameter probe at a site.  You import and then submit these Results to CDX as part of a single Activity.  You then discover a correction that needs to be made to one of the Results.  To avoid any data being dropped from WQX, you need to import and resubmit the entire Activity including all five Results, rather than just the one result that changed.

Spreadsheet

A computer file for data in tabular form (i.e. rows and columns).  Rows are often referenced with numbers and columns are often referenced with letters.  The file can also include functions, formatting information, charts, comments, etc.

The most common spreadsheet software is Microsoft Excel.  Others include OpenOffice Calc and Google Docs Spreadsheets.

Before a spreadsheet's data can be used by WQX Web, it must be converted to a simpler, flat file format.

STORET

STOrage and RETrieval [System].  The original name for the software and database [system], created by the EPA in the late 1960's, to hold ambient water monitoring data throughout the country.  In 1999, EPA created a new system, Modernized STORET, which it provided freely for organization to manage their own data.  They also created a national database known as the STORET Data Warehouse.  At that time the original STORET system became known as Legacy STORET.  In 2006, EPA released WQX and a few years later retired the [Modernized] STORET System. 

Today, STORET refers to the  STORET Data Warehouse that holds data from the Modernized STORET System and from WQX.

STORET is also the name for the helpdesk, at The EPA, which supports WQX, WQX Web and the STORET Data Warehouse.  The helpdesk can be reached at:

(800) 424-9067 or STORET@epa.govWQX@epa.gov                    

System

Another term for a software application (and database).  For example, the "WQX Web" System.

Tab-Delimited File

A computer file format for a table where each piece of information is separated by a tab character.

Files in this format can be imported into WQX Web.

Microsoft Excel has a "Save As" menu that allows you to convert your spreadsheet to other computer file formats.  If you choose the "Text (tab delimited)" type, then your file will be stored in a format where each column is separated by a tab character and each row is separated by a carriage return character.

Template

An Excel Spreadsheet that EPA provides to users of WQX Web.  Users can enter their data into one of these spreadsheet and use it to create a file that can be imported into WQX Web. 

WQX Web Templates are just one way to build a data file that can be imported into WQX Web.  WQX Web can import files in a wide variety of formats, but if you use your own format, you will also need to create your own import configuration  to match it (or modify an existing import configuration). 

Transaction_ID

What is the transaction ID? It is a alphanumeric code that the acquirer and the issuer can use to identify a transaction. Each transaction processed by the exchange network service provider is issued a reference known as a Transaction_ID. This is typically a long alphanumeric code generated by the product initiating the transaction. It is available after the transaction is settled, and is a unique identifier that both the acquirer and the issuer can use to identify a transaction. 

Download documents from Exchange Network by Transaction ID

The Exchange Network Services Center utilizes three methods for the exchange of environmental information:
- Send Info: Submit documents or information to another system on the Exchange Network.
- Get Info: Retrieve information from another system on the Exchange Network. This information is retrieved immediately through query services or requested and then downloaded through solicit services.
- Download: Download a document from another system on the Exchange Network with a transaction or document ID. 

User

An individual who uses a system (i.e. software).  Someone with a CDX-Web Account who has been granted access to the WQX Web System is a WQX Web User. 

A user must provide their login name and password before gaining access to WQX Web.  EPA must grant a user with rights to a specific Organization before the user is allowed to view, import, or submit data for that Organization.

WQX

Water Quality Exchange.  The data flow (at CDX) and the system at the EPA which receives ambient water monitoring data from organizations throughout the United States.  WQX was developed by Gold Systems in 2006.  It replaced the STORET System. Water Quality Exchange Homepage URL: https://www.epa.gov/waterdata/water-quality-data

WQX Web

Software created for the EPA, by Gold Systems, to assist users with converting their electronic data files into the format that is required for WQX. Water Quality Data UPLOAD with WQX/WQX Web/API URL: https://www.epa.gov/waterdata/water-quality-data-upload-wqx

XML

Extensible Markup Language.  A common standard for formatting data for computer systems to read.  XML is a hierarchical format where child data can be nested within parent data.  This is the basis for all data exchanged on the Exchange Network (including WQX).  It is more difficult for humans to create and/or read than a spreadsheet (such as the WQX Web Templates) or a flat file.  WQX Web Users should not generally need to work with XML documents directly.

Top of Page

Preparing my data for submission to WQX Web.

Validation rules specify permissible attribute configurations and general relationships on an element.
They are used to check elements in a dataset based on a specific requirement or constraint.
Validation rules verify that the data a user enters in a record meets the standards you specify before the user can save the record.

STEP#

1

WQX Business Rule 3.0

 

Rule #1

When ElectronicAddressText or ElectronicAddressTypeName is reported, both must be reported.

 

Rule #2

When TelephoneNumberText or TelephoneNumberTypeName is reported, both must be reported.

 

Rule #3

When AddressText or AddressTypeName is reported, both must be reported.

 

Rule #4

When HorizonitalCollectionMethodName is “Interpolation-Map“, SourceMapScale must be reported.

 

Rule #5

When VerticalMeasure's MeasureValue is reported, the following also must be reported: VerticalMeasure's MeasureUnitCode,  VerticalCollectionMethodName,     VerticalCoordinateReferenceSystemDatumName.

 

Rule #6

 Either ProjectDescriptionText or Project's AttachedBinaryObject must be reported.

 

Rule #7

Activity Depth/Height can be reported in only one of the following two ways (but not both):  
a. Specific depth using ActivityDepthHeightMeasure's MeasureValue. 
b. Depth Range using ActivityTopDepthHeightMeasure's MeasureValue and ActivityBottomDepthHeightMeasure's MeasureValue. 
             i.    This method must be used when ActivityTypeCode is “Sample-Integrated Vertical Profile“.

 

Rule #8

When ActivityTypeCode contains the word 'Logger', DataLoggerLineName must be reported.

 

Rule #9

When ActivityMediaName is "Tissue" then BiologicalIntentName must also be "Tissue" (and visa-versa)

 

Rule #10

When ActivityMediaName (or BiologicalIntentName) is "Tissue", then SampleTissueAnatomyName must be reported.

 

Rule #11

When ActivityMediaName is "Biological" then AssemblageSampledName must be reported

 

Rule #12

When ResultDetectionConditionText is 'Not Detected', 'Present Above Quantification Limit' or 'Present Below Quantification Limit', then DetectionQuantitationLimitTypeName and DetectionQuantitationLimitMeasure must be reported.

 

Rule #13

CharacteristicName and ResultStatusIdentifier must be reported.

 

Rule #14

When DetectionQuantitationLimit's MeasureValue is reported, DetectionQuantitationLimit's MeasureUnitCode must be reported.

 

Rule #15

ActivityDescription’s MonitoringLocationIdentifier may be required depending on the value provided for ActivityTypeCode.  See the domain value list for ActivityTypeCode for more information.

 

Rule #16

ResultAnalyticalMethod may be required depending on the value provided for ActivityTypeCode.  See the domain value list for ActivityTypeCode for more information.    
a. However, ResultAnalyticalMethod is never required if BiologicalIntentName is "Individual", "Population Census", "Frequency Class", or "Group Summary"

 

Rule #17

ResultSampleFractionText may be required depending on the value provided for CharacteristicName.
See the domain value list for CharacteristicName for more information.

 

Rule #18

ResultAnalyticalMethod’s MethodIdentifierContext must either match a value from the AnalyticalMethodContext domain list or it must be the same as the value for the OrganizationIdentifier provided in the submission file.   
a. If the MethodIdentifierContext matches a value from the domain list, then the MethodIdentifier must also match a value from the AnalyticalMethod domain list (for that Context).  Furthermore, MethodName, MethodQualifierTypeName, and MethodDescriptionText are not required and will be ignored (since only the Identifier and IdentifierContext are needed to uniquely identify the Analytical Method).      
b. If the MethodIdentifierContext matches your OrganizationIdentifier (indicating your own method), then MethodIdentifier and MethodName are both required, but do not need to match a value from the domain list (since they are your own).  Additionally, MethodQualifierTypeName and MethodDescriptionText can be provided, but are optional, to further describe the Analytical Method used.

 

Rule #19

ProjectIdentifier, MonitoringLocationIdentifier, ActivityIdentifier, IndexIdentifier and ActivityGroupIdentifier must be unique within an Organization.  The value for each of these identifiers may occur only once in a submission file.   
a. Unique identifiers are treated as case-insensitive by WQX.  For example, the following three identifiers would be treated as identical:  “Mx571”, “mx571”, “MX571”.

 

Rule #20

ResultMeasure's ResultMeasureValue may be constrained to a list of domain values depending on the value provided for CharacteristicName. 
See the domain value list for CharacteristicName for more information.

 

Rule #21

If a numeric value is reported for ResultMeasureValue, then ResultMeasure's MeasureUnitCode and ResultValueTypeName are required.    
a. The exception to this is when the ResultMeasureValue is a Characteristic Pick List Value. 
These do not have units.

 

Rule #22

If a CountyCode is reported then a StateCode must also be reported.

 

Rule #23

If NetTypeName = "Net/Horizontal Tow" then BoatSpeedMeasure is required.

 

Rule #24

If NetTypeName is reported then the SampleCollectionEquipmentName must be one that relates to that type of equipment.

 

Rule #25

ActivityMetric's MetricTypeIdentifierContext must either match a value from the MetricTypeContext domain list or it must be the same as the value for the OrganizationIdentifier provided in the submission file.     
a. If the MetricTypeIdentifierContext matches a value from the domain list, then the MetricTypeIdentifier must also match a value from the MetricType domain list (for that Context).  Furthermore, MetricTypeName, MetricTypeCitation, MetricTypeScaleText, and FormulaDescriptionText are not required and will be ignored (since only the Identifier and IdentifierContext are needed to uniquely identify the MetricType).       
b. If the MetricTypeIdentifierContext matches your OrganizationIdentifier (indicating your own metric), then MetricTypeIdentifier and MetricTypeName are both required, but do not need to match a value from the domain list (since they are your own).  Additionally, MetricTypeCitation, MetricTypeScaleText, and FormulaDescriptionText can be provided, but are optional, to further describe the Metric Type used.

 

Rule #26

If BiologicalIntentName is "Group Summary" then GroupSummaryCount or GroupSummaryWeightMeasure must be reported

 

Rule #27

If BiologicalIntentName is "Frequency Class" then Result's CharacteristicName must be "Count"

 

Rule #28

If BiologicalIntentName is "Population Census" then Result's CharacteristicName must be "Count" or "Total Sample Weight"

 

Rule #29

FrequencyClassDescriptorUnitCode may be required depending on the value provided for FrequencyClassDescriptorCode.  See the domain value list for FrequencyClassType for more information.

 

Rule #30

FrequencyClassInformation's LowerClassBoundValue and UpperClassBoundValue may be required depending on the value provided for FrequencyClassDescriptorCode.  See the domain value list for FrequencyClassType for more information

 

Rule #31

Biological Intent Name and Subject Taxonomic Name must be reported when Activity Media Name is "Biological" or "Tissue"

 

Rule #32

Either Result Measure Value and/or Result Detection Condition Text must be reported

 

Rule #33

Measure Unit is required when Measure Value is supplied

 

Rule #34

Measure Value is required when Measurement Unit is supplied

 

Rule #35

ResultMeasureQualifierCode will support new WQX 3.0 measure qualifiers as independent child elements <MeasureQualifierCode> in parent <ResultMeasure> with a maximum number of 6 codes.

 

Rule #36

Habitat Selection Method is required when Activity Assemblage is "Benthic Macroinvertebrates"

 

Rule #37

Target Count is required when the Activity Assemblage is "Benthic Macroinvertebrates"

 

Rule #38

Proportion Sample Processed Numeric is required when the Activity Assemblage is "Benthic Macroinvertebrates"

 

Rule #39

Proportion Sample Processed Numeric will be set to NULL when value is equal to 0.000000001 and the Activity Assemblage is "Benthic Macroinvertebrates"

 

Rule #40

Proportion Sample Processed Numeric must be a positive number between 0 and 1"

 

Rule #41

Removed (v3.0) Sample Collection Method is required when Activity Type Code contains the word "Sample"

 

Rule #42

Statistical N-Value Numeric must be a positive whole number

 

Rule #43

Analytical Method is required when submitting a Comparable Analytical Method

 

Rule #44

Comparable Analytical Method Identifier Context must match a national value from the domain list

 

Rule #45

If ResultDetectionQuantitationLimit is reported, then DetectionQuantitationLimitTypeName and DetectionQuantitationLimitMeasure are required

 

Rule #46

ResultAnalyticalMethod may be required depending on the value provided for CharacteristicName. 
See the domain value list for CharacteristicName for more information

 

Rule #47

MethodSpeciation may be required depending on the value provided for CharacteristicName. 
See the domain value list for CharacteristicName for more information

 

Rule #48

Lab Sample Preparation Method is optional.

 

Rule #49

Sample Preparation Method, Sample Container Type Name, Sample Container Color Name, and Sample Transport Storage Description are all optional.

 

Rule #50

When AssemblageSampledName is reported then ActivityMediaName must be 'Biological' or 'Tissue'.

 

 

Entity (schema)

Mandatory Elements

 Project

Project ID (ProjectIdentifier),

Project Name (ProjectName),

Project Description (ProjectDescriptionText)

 Monitoring Location

Monitoring Location ID (MonitoringLocationIdentifier),    

Monitoring Location Name (MonitoringLocationName),    

Monitoring Location Type (MonitoringLocationTypeName),                     

Monitoring Location Latitude (MonitoringLocationGeospatial/LatitudeMeasure),

Monitoring Location Longitude (MonitoringLocationGeospatial/LongitudeMeasure),      

Monitoring Location Horizontal Collection Method (MonitoringLocationGeospatial/HorizontalCollectionMethodName ),         

Monitoring Location Horizontal Reference Datum (MonitoringLocationGeospatial/HorizontalCoordinateReferenceSystemDatumName)

 Activity and Result

Project ID (ProjectIdentifier),

Monitoring Location ID (MonitoringLocationIdentifier),    

Activity ID (ActivityIdentifier),        

Activity Type (ActivityTypeCode),  

Activity Media Name (ActivityMediaName),          

Activity Start Date (ActivityStartDate),       

Characteristic Name (CharacteristicName), 

Result Value (ResultMeasure/ResultMeasureValue),          

Result Unit (ResultMeasure/MeasureUnitCode),     

Result Status ID (ResultStatusIdentifier),     

Result Value Type (ResultValueTypeName)

 Activity Group

Activity ID (ActivityIdentifier),        

Activity Group ID (ActivityIdentifier),        

Activity Group Type (ActivityIdentifier),    

Activity Group Name (ActivityIdentifier)

 Index

Monitoring Location ID (MonitoringLocationIdentifier),    

Index ID (IndexIdentifier),    

Index Type ID Index Score (IndexScore),     

Index Date (IndexCalculatedDate)

 Metric

Project ID (ProjectIdentifier),

Monitoring Location ID (MonitoringLocationIdentifier),    

Activity ID (ActivityIdentifier),        

Activity Type (ActivityTypeCode),  

Activity Media Name (ActivityMediaName),          

Activity Start Date (ActivityStartDate),       

Metric Type ID (MetricTypeIdentifier),       

Activity Metric Score (MetricScore),

Activity Metric Value (MetricValueMeasure/MeasureValue),        

Activity Metric Value Unit (MetricValueMeasure/MeasureUnitCode)

 Monitoring Location Weights

Project ID (ProjectIdentifier),            

Monitoring Location ID (MonitoringLocationIdentifier),    

Weighting Factor Measure (LocationWeightingFactorMeasure/MeasureValue),   

Weighting Factor Unit (LocationWeightingFactorMeasure/MeasureUnitCode),    

Status Name (LocationStatusName),

Reference Location Type (ReferenceLocationTypeCode),  

Reference Location Start Date (ReferenceLocationStartDate)

 

 

ENTITY (schema)

Relationship - one to many

Maximum assignments

Organization

ElectronicAddress (0 or more)

UNLIMITED

ElectronicAddress

ElectronicAddressText

 

ElectronicAddress

ElectronicAddressTypeName

 

Organization

Telephonic (0 or more)

UNLIMITED

Telephonic

TelephoneNumberText

 

Telephonic

TelephoneNumberTypeName

 

Telephonic

TelephoneExtensionNumberText

 

Organization

OrganizationAddress (0 or more)

UNLIMITED

OrganizationAddress

AddressTypeName

 

OrganizationAddress

AddressText

 

OrganizationAddress

SupplementalAddressText

 

OrganizationAddress

LocalityName

 

OrganizationAddress

StateCode

 

OrganizationAddress

PostalCode

 

OrganizationAddress

CountryCode

 

OrganizationAddress

CountyCode

 

 

 

 

Project

AttachedBinaryObject (0 or more)

UNLIMITED

AttachedBinaryObject

BinaryObjectFileName

 

AttachedBinaryObject

BinaryObjectFileTypeCode

 

Project

ProjectMonitoringLocationWeight (0 or more)

UNLIMITED

ProjectMonitoringLocationWeight

MonitoringLocationIdentifier

 

ProjectMonitoringLocationWeight

LocationWeightFactorMeasure

 

ProjectMonitoringLocationWeight

MeasureValue

 

ProjectMonitoringLocationWeight

MeasureUnitCode

 

 

 

 

Activity

ProjectIdentifier (1 or more)

UNLIMITED

Activity

ActivityConductingOrganizationText (0 or more)

UNLIMITED

Activity

AttachedBinaryObject (0 or more)

UNLIMITED

AttachedBinaryObject

BinaryObjectFileName

 

AttachedBinaryObject

BinaryObjectFileTypeCode

 

 

 

 

ActivityGroup

ActivityIdentifier (2 or more)

UNLIMITED

 

 

 

MonitoringLocation

AlternateMonitoringLocationIdentity (0 or more)

UNLIMITED

AlternateMonitoringLocationIdentity

MonitoringLocationIdentifier

 

AlternateMonitoringLocationIdentity

MonitoringLocationIdentifierContext

 

MonitoringLocation

AttachedBinaryObject (0 or more)

UNLIMITED

AttachedBinaryObject

BinaryObjectFileName

 

AttachedBinaryObject

BinaryObjectFileTypeCode

 

ActivityMetric

IndexIdentifier (0 or more)

UNLIMITED

 

 

 

Result

MeasureQualifierCode (0 or 6)

SIX (6)

Result

HabitName (0 or 3)

THREE (3)

HabitName

VoltinismName

 

HabitName

TaxonomicPollutionTolerance

 

HabitName

TaxonomicPollutionToleranceScaleText

 

HabitName

TrophicLevelName

 

Result

FunctionalFeedingGroupName (0 or 3)

THREE (3)

Result

FrequencyClassInformation (0 or 3)

THREE (3)

FrequencyClassInformation

FrequencyClassDescriptorCode

 

FrequencyClassInformation

FrequencyClassDescriptorUnitCode

 

FrequencyClassInformation

LowerClassBoundValue

 

FrequencyClassInformation

UpperClassBoundValue

 

Result

ResultDetectionQuantitationLimit (0 or more)

UNLIMITED

ResultDetectionQuantitationLimit

DetectionQuantitationLimitTypeName

 

ResultDetectionQuantitationLimit

DetectionQuantitationLimitMeasure

 

ResultDetectionQuantitationLimit

MeasureValue

 

ResultDetectionQuantitationLimit

MeasureUnitCode

 

ResultDetectionQuantitationLimit

DetectionQuantitationLimitCommentText

 

Result

LabSamplePreparation (0 or more)

UNLIMITED

LabSamplePreparationMethod

MethodIdentifier

 

LabSamplePreparationMethod

MethodIdentifierContext

 

LabSamplePreparationMethod

MethodName

 

LabSamplePreparationMethod

MethodQualifierTypeName

 

LabSamplePreparationMethod

MethodDescriptionText

 

LabSamplePreparation

PreparationStartDate

 

LabSamplePreparation

PreparationStartTime

 

PreparationStartTime

Time

 

PreparationStartTime

TimeZoneCode

 

LabSamplePreparation

PreparationEndDate

 

LabSamplePreparation

PreparationEndTime

 

PreparationStartTime

Time

 

PreparationStartTime

TimeZoneCode

 

LabSamplePreparation

SubstanceDilutionFactor

 

Result

AttachedBinaryObject (0 or more)

UNLIMITED

AttachedBinaryObject

BinaryObjectFileName

 

AttachedBinaryObject

BinaryObjectFileTypeCode

 

 

 

STEP#

2

Data Dictionary (Data Exchange Template)

 

 

 WQX – Water Data Exchanges URL: https://www.exchangenetwork.net/data-exchange/wqx/
   

Download the Data Exchange Template (excel file) - data dictionary and element definition.

   

Download the Flow Configuration Document (acrobat file) - 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.

    WQX Domain Values tables provide data elements to assist data owners and users in conforming to a consistent nomenclature and can be queried to determine the EPA-supplied values.

 

STEP#

3

Data Template  

 

URL:

https://www.epa.gov/waterdata/water-quality-exchange-web-template-files

 

A

What are lookup tables?
Sometimes a data element in WQX Web can only have a value from a specified
list of choices; called a Domain Value List (DVL). Sometimes these lists are
called pick lists or lookup tables:
♦ Sample Collection Methods – These are referenced by the activities you
wish to enter or import into the system.
♦ Sample Preparation Methods – These are referenced by the activities
you wish to enter or import into the system.
♦ Analytical Methods (where your method isn't already available in the
US EPA or other standard method "context" tables) - These are referenced by
the sample results you wish to enter or import into the system.
♦ Sample Preservation Methods – required under certain conditions.
All organizations using WQX Web have access to reference the lookup tables.
We recommend reviewing lookup table values at least annually.
Be sure any changes to analytical methods, etc.
are reflected in the lookup table values.
Characteristics (Name or PickList) – These are referenced by the results you
wish to enter or import into the system. The object, property, or substance which is evaluated or enumerated.
Taxon (SubjectTaxonomicName) – These are referenced by the results
you wish to enter or import into the system.
The name of the organism sampled as part of a biological sample.

All - The Entire Domain Lists (ZIP) | (XML) tables provide data elements to assist data owners and users in conforming to a consistent nomenclature and can be queried to determine the EPA-supplied values.

 

B

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.

 

C

Adding Analytical Methods to the Lookup Tables. Adding characteristic analytical methods to the lookup tables is very similar to adding sample collection methods to the sample collection methods lookup table. The only real difference is that you would choose Analytical Method from the Lookup Tables page. Allows for the optional association of an analytical method employed either in the Lab or in the Field with any result.

 

D

Adding Sample Preparation Methods to the Lookup Tables Adding sample preparation methods to the lookup tables is very similar to adding sample collection methods to the sample collection methods lookup table. The only real difference is that you would choose Sample Preparation Method from the Lookup Tables page. This section describes a sample preparation procedure which may be conducted on an initial Sample or on subsequent subsamples to prepare for analysis.

 

E

Import Your List of Projects data into the WQX Web validation area and then submit the data to CDX.
Each organization must have at least one project in WQX Web because every activity recorded in WQX Web must be associated with at least one project. Your organization may wish to have more than one project so that you can search, sort, or filter your activities by project. Examples of projects might include “Annual 106 Monitoring” or “2013 Summer Special Nutrient Study”.

 

F

Import your list of Monitoring locations data into the WQX Web validation area and then submit the data to CDX. Monitoring Locations are records that represent the physical site where you took a sample or made an observation. A unique ID, a name, the coordinates for the location, horizontal reference datum, and horizontal collection method are all required data elements.

 

G

Import activities and results data into the WQX Web validation area and then submit the data to CDX. If your data is in electronic files… For any data you have in electronic spreadsheet or text files (NOT .pdf files) the goal should be to import that data into WQX Web so you don't have to enter it manually. You can think of it as three steps:
1. Create Projects, Monitoring Locations, Activities and Results import configuration to match your file. This is how you tell WQX Web how to read your file. As long as you continue to use the same file format for future data, you can continue to use the same import configuration.
2. Import the file of data into WQX Web using the Import -> menu item
3. After successfully importing your file and resolving any validation errors, you then migrate the files into the WQX Web area and generate XML file submissions to CDX.

 

STEP#

4

Data Management (Best Practices)

 

 

Updating a Project will not affect the Activities, Metrics, or Results below it.
However, deleting a Project will delete the Activities, Metrics, and Results below it
(unless the Activity relates to more than one Project).
Updating a Monitoring Location will not affect the Activities, Metrics, or Results
below it
. However, deleting a Monitoring Location will delete the Activities, Metrics
and Results below it.
Each Activity must have its own Activity ID which is used to identify it in the
system. An Activity ID must be unique (within your Organization). Accidentally
reusing an Activity ID would result in data being overwritten in the system, so it's
important to follow a standard that guarantees that each Activity ID is unique.
Each result in WQX, must be part of an Activity. Unlike most other entities in
WQX, Results do not have a Unique ID. Because of this, there is no way to add,
update, or delete an individual Result via an import file. You must always import
an entire Activity and all of its Results.
Example: You collect five Results from your multi-parameter probe at a site. You
import and then submit these Results to CDX as part of a single Activity. You then
discover a correction that needs to be made to one of the Results. To avoid any
data being dropped from WQX, you need to import and resubmit the entire
Activity including all five Results, rather than just the one result that changed.

   

WQX 3.0 will address quality assurance by applying supported best practices and business rules. Good QA/QC ensures that your data can be reused by another user for analysis, as well as safeguarding against misuse. New version 3.0 supported QA/QC business rules are outlined via both the WQX 3.0 Flow Configuration Document and guidance documents at the WQX website (www.epa.gov/waterdata/water-quality-data-wqx):

   

WQX Node/ Node Client Data Submitter - Submitting data through a Node or Node Client is more suited for larger flow volumes (i.e. states). For more information on submitting data through a Node or Node Client to WQX, Click Here.

The NGN endpoints are the following:

Production Node:

Test Node:

 

   

Where to Direct General Node /Node Client Questions?

  1. I received the error message "Unauthorized Access. User "node@dep.state.franklin.us" has not been granted access to the "Franklin_WQX" organization. Please Contact STORET/WQX Support for assistance." Please contact the WQX helpdesk at WQX@epa.gov and provide a description of the issue.
  2. I received the error message "Invalid NAAS User ID "Guillen@Franklin.gov". If you believe this should be valid, contact STORET/WQX Support to confirm that your User ID has been set up in the WQX System. Additionally, your Organization may need to be set up." Please contact the WQX helpdesk at WQX@epa.gov.
  3. For issues with your NAAS ID or password contact the Node helpdesk at 1-877-827-0260 or email nodehelpdesk@epacdx.net.
   

Where to Direct WQX Web Questions?

  1. I need help with account registration or authorized access for my CDX Username "firstnamelastname". Please Contact STORET/WQX Helpdesk at WQX@epa.gov.
  2. For issues with your CDX Username or password: Forgot your Password? Forgot your User ID?  Call the CDX helpdesk toll-free line at 888-890-1995 or (970) 494-5500 for International callers. By email helpdesk@epacdx.net.
   

 Frequent Questions about WQX click text

   

 Learn More about Water Quality Data 
General Information, Data Assistance, Tools, Training Videos, User Community, and Funding. Learn how to get "1 on 1" data assistance with WQX .

   

 ALERT - WQX and WQX Web support the following filesize restrictions: 

  1. For WQX dataflow, CDX allows uncompressed files (xml and attachments) less than 350 MB
  2. For WQX Web, Cloud services allows uncompressed files (spreadsheet/text and attachments) less than 100 MB

Any Questions? Contact the WQX Helpdesk at WQX@epa.gov.

Top of Page

Contact Us to ask a question, provide feedback, or report a problem.