EPA/823/B11/001 December 2011
http://water.epa.gov/grants funding/beachgrants/datausers index.cfm
#notify
CDX
CENTRAL DATA
EXCHANGE
Beach Notification Database User Guide
(For Notification Schema v2.2)
Contract Number GS-35F-4797H
Task Order #1518
TDD 10.02eBeaches
Version 2.2.2
December 23, 2011
-------
Table of Contents
Table of Contents i
List of Exhibits ii
Revision Log iv
Changes from v2.2.1 v
1 Introduction 1
1.1 Document Purpose 1
2 How to Submit Data 2
2.1 Submit Data via CDX 2
2.2 Detailed XML Processing Notes 4
3 How to Understand the XML Submission 6
3.1 Elements in the XML Schema and XML Files 6
3.2 Use of Effective Date and Status Indicator Data Elements 53
4 How to Decode the Error Messages 54
4.1 System Generated Error Messages 54
4.2 Common Causes of Error Messages 57
4.3 Oracle Generated Error Messages 61
5 How to Understand Beaches that are Similar Points of Access 62
6 Appendix A—Schema Graphics 63
7 Appendix B—Example XML File 73
8 Appendix C—Procedure Type Codes 79
9 Appendix D—Water Body Codes 82
10 Appendix E—Horizontal Collection 83
11 Appendix F—Addition Notifications 86
12 Appendix G—Pollution Source Identification 90
13 Appendix H—Data Entry Forms 95
14 Appendix I—Summary Reports 98
15 Appendix J—CDX Web Messages 104
Beach Notification Database User Guide December 23, 2011
i
-------
List of Exhibits
Exhibit 2-1 Custom Data Submission Steps 2
Exhibit 2-2 Data Transfer Diagram 4
Exhibit 3-1 Organization Information Schema 8
Exhibit 3-2 Person Information Schema 15
Exhibit 3-3 Beach Information Schema 21
Exhibit 3-4 Beach Attribute Information Schema 25
Exhibit 3-5 Beach Activity Information Schema 34
Exhibit 3-6 Beach Role Information Schema 41
Exhibit 3-7 Beach Coordinate Information Schema 45
Exhibit 3-8 Organization Information Schema 48
Exhibit 3-9 Beach Procedure Information Schema 50
Exhibit 3-10 Hearder Information Schema 52
Exhibit 4-1 PRAWN Error Messages 54
Exhibit 4-2 Common Error Messages 57
Exhibit 6-1 Beach Data Submission 63
Exhibit 6-2 Organization Detail 64
Exhibit 6-3 Organization Person Detail 65
Exhibit 6-4 Beach Name Detail 66
Exhibit 6-5 Beach Activity Detail 68
Exhibit 6-6 Beach Role Detail 69
Exhibit 6-7 Beach Coordinate Detail 70
Exhibit 6-8 Beach Procedure Detail 71
Exhibit 6-9 Year Completion Indicators 72
Exhibit 8-1 Procedure Type Codes 79
Exhibit 9-1 Water Body Name 82
Exhibit 9-2 Water Body Type 82
Exhibit 10-1 Horizontal Collection Method Name 83
Exhibit 10-2 Horizontal Collection Reference Datum Name 84
Exhibit 11-1 Example Notification XML Document 86
Exhibit 11-2 Custom XML Generation 88
Exhibit 12-1 Access Database 91
Exhibit 12-2 XML Schema 93
Exhibit 13-1 Forms 95
Beach Notification Database User Guide December 23, 2011
-------
Exhibit 13-2 Main Menu 96
Exhibit 13-3 Return to Main Menu 97
Exhibit 14-1 Reports 98
Exhibit 14-2 Beach Actions 99
Exhibit 14-3 Beach Attributes 100
Exhibit 14-4 Beach Monitoring Frequency 101
Exhibit 14-5 Possible Pollution Sources 102
Exhibit 14-6 Possible Pollution Sources (cont.) 103
Exhibit 15-1 Your CDX eBeaches Data Submission 104
Exhibit 15-2 Validation Message 105
Exhibit 15-3 Final Email 106
Beach Notification Database User Guide December 23, 2011
-------
Revision Log
Date
7/21/10
12/23/11
Version
No.
2.2.1
2.2.2
Description
Added Appendix J CDX Messages
Added XML Schema changes
introduced in v2.2
Author
E.Richards
E.Richards
Reviewer
C.Kilgore
Review
Date
Beach Notification Database User Guide
December 23, 2011
iv
-------
Changes from v2.2.1
Page*
7
10
12
14
22
25
29
29
30
30
30
35
36
53
56
63
66
66
66
66
72
81
98
99
100
101
Description
3.1.1 - New State Contact details in the Organization Information section.
Notes on submitting an Organization's website information.
New State Contact data elements.
3.1.2 - Notes on assigning Beach Contacts.
New Water Body Names.
New Swim Season Start/End Date requirements.
New ALGAE Pollution Source domain value.
New Beach Website data element.
New Dormant Beach data element.
New Reporting Frequency data elements.
New Beach Criterion data elements.
New Activity Stop Date notes.
New ALGAE Reason Type domain value.
4.1- New PRAWN Error Messages pertaining to Beach Criterion data.
4.2 - New Trouble Shooting Tips for the Beach Criterion data.
New State Contact details.
New Reporting Frequency details.
New Dormant Beach detail.
New Beach Criterion details.
New Beach Website detail.
Additional XML example data.
Appendix D - New Water Body Names.
Minor changes to the Beach Actions report.
Minor changes to the Beach Attributes report.
Minor changes to the Beach Monitoring Frequency report.
Minor changes to the Possible Pollution Sources report.
Beach Notification Database User Guide
December 23, 2011
-------
Introduction
1.1 Document Purpose
The purpose of this document is to introduce representatives from state beach programs to the PRogram tracking, beach Advisories,
Water quality standards, and Nutrients (PRAWN) database. All state beach program and notification (advisory and closing) data will
be stored in PRAWN. In particular, this guide is intended for officials from State beach programs, the EPA's Beaches program, and
any database administrators in charge of a state database.
The document can be used to explain the following about beach data submissions to EPA:
• Chapter 2 — explanation on how data is transferred from the originator (in most cases State Beach programs) through CDX to the EPA.
Details about the transfers are separated into a second subsection for a more technical audience.
• Chapter 3 — explanation of the data that needs to be submitted to EPA and how that data should be formed within the XML document. Each
section of the XML schema is explained in detail, and a specific section is devoted to explaining the use of the effective date and status
indicator elements.
• Chapter 4 —explanation of the errors that the PRAWN database will produce due to logic and/or technical errors in the path between the
creation of the XML document and the loading of data into PRAWN.
Beach Notification Database User Guide December 23, 2011
1
-------
How to Submit Data
States that need to submit Beach information to EPA need to take advantage of EPA's Central Data exchange (CDX) initiative to submit their data
through a website.
2.1 Submit Data via CDX
The Central Data eXchange (CDX) is an Office of Environmental Information (OEI) initiative to provide a single point of entry for
incoming data into EPA. CDX will maintain a set of web pages where, once registered, States can log in and upload data files to EPA.
Additional information on CDX and the Exchange Network can be found at: http://www.epa.gov/cdx.
The diagram in Begining on the upper left side, the object labeled "State Database" starts the flow of information and can be followed through
to the "PRAWN Database".
Exhibit 2-2 describes how data can be submitted from a State database to EPA's PRAWN database via CDX. For information on how
to create a custom data submission, please see Exhibit 11-2. The following table describes the steps involved in the process:
Exhibit 2-1 Custom Data Submission Steps
State Steps
1. Register in 3 places:
A) Register with CDX via the CDX HelpDesk. Send an
email to epacdx@csc.com or call 888-890-1995
B) Register any new beaches with the EPA to create a
unique EPA Beach ID for each beach in the state.
C) Register water quality stations in WQX submissions
(http://www.epa.gov/storet/wqx.html)
2. Create an XML document containing the appropriate
data (see Chapter 3 for the data to be included) using
a local copy of the schema.
3. Upload the XML document from a local State
computer to CDX via CDX's website:
https://cdx. epa.gov/SSL/cdx/login. asp
5. Visit MyCDX Inbox for error/success log messages.
If a CDX error log is received, go back to Step 2 and
fix the errors.
CDX Automated Steps
4. Archive the file and validate the XML
document against the schema. If errors are
found, send a CDX error log to the State user;
otherwise, skip to Step 6.
PRAWN Automated Steps
Beach Notification Database User Guide
December 23, 2011
2
-------
State Steps
9. Make a second visit to MyCDX Inbox. If a PRAWN
error log is received, go back to Step 2 and fix the
errors.
CDX Automated Steps
6. Once the XML document passes validation,
add the header information and transfer the
XML document to the PRAWN XML Parser.
8. If a PRAWN error log is created, pass it along
to the State.
11. If a PRAWN success log is created, pass it
along to the State.
PRAWN Automated Steps
7. Validate the XML document against the business
rules. If errors are found, create an error log to CDX;
otherwise, skip to Step 10.
10. When the XML file is received that passes the
business rules, parse the data into the database and
create a success log.
Beach Notification Database User Guide
December 23, 2011
3
-------
Begining on the upper left side, the object labeled "State Database" starts the flow of information and can be followed through to the "PRAWN
Database".
Exhibit 2-2 Data Transfer Diagram
State
Database
XML
Local State
Computer
XML
Header info
added to XML
(if automated)
(if manual)
XML
PRAWN XML
Parser
Beach and
Activity Data
PRAWN
Database
2.2 Detailed XML Processing Notes
The following technical notes support the processes described in the previous two sections of this chapter:
• Empty tags, such as "" or "", will not be accepted.
• If the XML submission passes the validation routine, information about the submission will be inserted into the following four
XML tags: Submissionldentifier, SubmittingAgencyldentifier, SubmittingUserldentifier, and SubmissionDate. Lhese four tags are
enclosed in tags labeled Headerlnformation. Lhe Headerlnformation tag must appear second in the file, after the
BeachDataSubmission tag.
Beach Notification Database User Guide
December 23, 2011
4
-------
When the XML load process is complete, any errors will be written to an error file with the same name, with a .log extension
instead of the .xml extension.
Beach Notification Database User Guide December 23, 2011
5
-------
3 How to Understand the XML Submission
This chapter describes the XML data files and the associated XML schema to be used for the PRAWN database.
3.1 Elements in the XML Schema and XML Files
The XML schema for the data submissions to PRAWN provides a template for the XML files to be submitted. This schema describes
the data elements to be included in the XML document and is also used to validate it. Files are accepted or rejected based on their
conformity to the schema.
A graphical version of this schema is provided in Appendix A and an example XML document is provided in Appendix B of this
document. Please refer to these appendices when creating an XML document.
This section contains descriptions of the data elements in the PRAWN XML Schema. For each table in the following sections, the
following information is provided:
• Data Element: The name of the data element stored in the XML data file.
• XML Tag Name: The XML key associated with the data element.
• XML Data Type: The XML data type for this element.
• Length: The maximum length for the data element for character and numeric data types.
• Req'd (Y/N): This value indicates if the column is required in the XML data file. Please note that empty tags such as
or will not be accepted when the element is not required.
• Comments: Additional comments related to the XML data element.
For questions on the conventions and formats used in the schema, reference the Exchange Network's XML Schema Design Rules and
Conventions'.
1 The Exchange Network's XML Schema Design Rules and Conventions can be found here: http://www.exchangenetwork.net/dev_schema/drc.htm
Beach Notification Database User Guide December 23, 2011
6
-------
3.1.1 Organization Information
The organization information section of the XML submission contains data related to the organizations involved in the Beach Act
Grant Program, such as organization code, organization name, organization description, and contact information. These data elements
will be included in the XML file when organization data needs to be added or updated in the PRAWN database.
The State Contact list is located on the EPA's beach web page and multiple State Contacts can be submitted for one organization.To
submit updates for the State Contact list, include the State Contact XML elements listed in the following table in this section.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/OrganizationDetail/".
Beach Notification Database User Guide December 23, 2011
7
-------
Exhibit 3-1 Organization Information Schema
Data Element
Organization
Identifier
Example:
987654321098
XML Tag Name
Organizationldentifier
XML Data
Type
STRING
Organization Type I OrganizationNameDetail I STRING
Code /OrganizationTypeCode
Example:
STATE_AGNCY
Organization Name
OrganizationNameDetail
Example: Maine /OrganizationName
Department of
Environmental
Protection
Organization
OrganizationNameDetail
Description Text /OrganizationDescription
Example: Maine Text
DEP
Organization
OrganizationNameDetail
STRING
STRING
STRING
Abbreviation Text /OrganizationAbbreviatio |
Example: MDEP
nText
Req'd
(Y/N)
Y
Y
Y
N
N
Length
12
12
60
255
30
Access Table Mapping
ORGANIZATION. ID,
Comment
An organization refers to the entity associated
PERSON. FK_ORGANIZATION_I with a Notification submitted to PRAWN. The
D, type of entity is noted in the 'Organization
MAILING_ADDRESS.FK_ORGAN Type Code' field.
IZATION_ID, EPA will maintain a list of valid Organization
ELECTRONIC ADDRESS. FK OR Identifiers for all organizations that are stored
GANIZATION ID, in the PRAWN database. These identifiers
BEACH ORGANIZATION ROLE
ASSIGN. FK ORGANIZATION ID
must be unique, as they will be used to
update organization-level data.
ORGANIZATION. ORGANIZATIO This value must be set to one of the following:
N_CODE
ORGANIZATION. NAME
ORGANIZATION. DESCRIPTION
ORGANIZATION.ABBREVIATION
STATE_AGNCY (State Agency)
EPA (U.S. EPA)
PUB_INT_GRP (Public Interest Group)
LOCAL_GOV (Local Government)
PRIVATE (Private Company)
OW(U.S. EPA Office of Water)
OW_DIV (U.S. EPA Office of Water Division)
OW_BRANCH (U.S. EPA Office of Water
Branch)
This value is required if any organization
name information is included in the XML data
file.
This value is required if any organization
name information is included in the XML data
file.
Beach Notification Database User Guide
December 23, 2011
8
-------
Data Element
Organization
Mailing Address
Type Code
Example: MAILING
Organization
Mailing Address
Street Line 1 Text
Example: 14 Main
Rd.
Organization
Mailing Address
Street Line 2 Text
Example: Suite 4
Organization
Mailing Address
Street Line 3 Text
Example: Building
12
Organization
Mailing Address
City Text
Example: Augusta
Organization
Mailing Address
State Code
Example: ME
XML Tag Name
OrganizationMailingAddr
essDetail/MailingAddres
sTypeCode
OrganizationMailingAddr
essDetail/MailingAddres
sStreetLinelText
OrganizationMailingAddr
essDetail/MailingAddres
sStreetLine2Text
OrganizationMailingAddr
essDetail/MailingAddres
sStreetLineSText
OrganizationMailingAddr
essDetail/MailingAddres
sCityName
OrganizationMailingAddr
essDetail/StateCode
XML Data
Type
STRING
STRING
STRING
STRING
STRING
STRING
Req'd
(Y/N)
Y
Y
N
N
Y
Y
Length
12
100
100
100
50
2
Access Table Mapping
MAILING ADDRESS.MAILING A
DDRESS_CODE
MAILING_ADDRESS.LINE_1
MAILING_ADDRESS.LINE_2
MAILING_ADDRESS.LINE_3
MAILING_ADDRESS.CITY
MAILING ADDRESS.STATE PO
STAL_CODE
Comment
This value must be set to one of the following:
SHIPPING (Shipping Address)
MAILING (Mailing Address)
OTHER (Other Address)
This value is required if any organization
mailing address information is included in the
XML data file.
This value is required if any organization
mailing address information is included in the
XML data file.
This value is required if any organization
mailing address information is included in the
XML data file.
This value is required if any organization
mailing address information is included in the
XML data file.
This value must be a valid 2-character State
Postal Code.
Beach Notification Database User Guide
December 23, 2011
9
-------
Data Element
Organization
Mailing Address
Zip Code
Example: 04333
Organization
Mailing Address
Effective Date
Example: 2003-01-
01100:00:00
Organization
Mailing Address
Status Indicator
Example: ACTIVE
XML Tag Name
OrganizationMailingAddr
essDetail/AddressPostal
Code
OrganizationMailingAddr
essDetail/MailingAddres
sEffectiveDate
OrganizationMailingAddr
essDetail/MailingAddres
sStatuslndicator
XML Data
Type
STRING
DATE
STRING
Req'd
(Y/N)
Y
Y
Y
Length
12
8
Access Table Mapping
MAILING_ADDRESS.ZIP_CODE
MAILING ADDRESS.EFFECTIVE
_DATE
MAILING_ADDRESS.STATUS
Comment
This value is required if any organization
mailing address information is included in the
XML data file.
This value must be in one of the following
numeric formats:
#####
or
I/I/I/I/If ////////
This value is required if any organization
mailing address information is included in the
XML data file.
The date should be entered in the XML file in
the following format: YYYY-MM-
DDTHH:MI:SS
This value should be set to the date on which
the mailing address information became
effective or will become effective.
**Please see Section 3.2 Use of Effective
Date and Status Indicator Data Elements for
more information.
This value is required if any organization
mailing address information is included in the
XML data file.
This value must be set to "ACTIVE" or
"INACTIVE".
**Please see Section 3.2 Use of Effective
Date and Status Indicator Data Elements for
more information.
Beach Notification Database User Guide
December 23, 2011
10
-------
Data Element
Organization
Electronic Address
Type Code
Example: URL
XML Tag Name
OrganizationElectronicA
ddressDetail/ElectronicA
ddressTypeCode
Organization 1 OrganizationElectronicA
Electronic Address ddressDetail/ElectronicA
Text ddressText
Example:
http://www.maine.g
ov/dep/blwq/beach.
htm
Organization
Electronic Address
OrganizationElectronicA
ddressDetail/ElectronicA
Effective Date ddressEffectiveDate
Example: 2003-01-
01TOO:00:00
Organization
Electronic Address
OrganizationElectronicA
ddressDetail/ElectronicA
Status Indicator ddressStatuslndicator
Example: ACTIVE
XML Data
Type
STRING
STRING
DATE
STRING
Req'd
(Y/N)
Y
Y
Y
Y
Length
12
255
8
Access Table Mapping
ELECTRONIC ADDRESS.ELECT
RONIC_ADDRESS_CODE
ELECTRONIC ADDRESS.ADDR
ESS
ELECTRONIC ADDRESS.EFFEC
TIVE_DATE
ELECTRONIC ADDRESS.STATU
S
Comment
This value must be set to one of the following:
EMAIL (E-mail)
URL (URL)
OTHER (Other)
This value is required if any organization
electronic address information is included in
the XML data file.
**Please use the URL code to submit
electronic address information pertaining to
an Organization's website.
This value is required if any organization
electronic address information is included in
the XML data file.
This value is required if any organization
electronic address information is included in
the XML data file.
The date should be entered in the XML file in
the following format: YYYY-MM-
DDTHH:MI:SS
This value should be set to the date on which
the electronic address information became
effective or will become effective.
Please see Section 3.2 Use of Effective Date
and Status Indicator Data Elements for more
information.
This value is required if any organization
electronic address information is included in
the XML data file.
This value must be set to "ACTIVE" or
"INACTIVE".
Please see Section 3.2 Use of Effective Date
and Status Indicator Data Elements for more
information.
Beach Notification Database User Guide
December 23, 2011
11
-------
Data Element
Organization
Telephone Type
Code
Example: VOICE
Organization
Telephone Number
Example: 207-287-
3901
Organization
Telephone
Effective Date
Example: 2003-01-
01TOO:00:00
Organization
Telephone Status
Indicator
Example: ACTIVE
State Contact First
Name
Example: Jane
XML Tag Name
OrganizationTelephone
Detail/TelephoneTypeC
ode
OrganizationTelephone
Detail/TelephoneNumbe
rText
OrganizationTelephone
Detail/EffectiveDate
OrganizationTelephone
Detail/Statuslndicator
ContactFirstName
XML Data
Type
STRING
STRING
DATE
STRING
STRING
Req'd
(Y/N)
Y
Y
Y
Y
N
Length
12
12
8
50
Access Table Mapping
TELEPHONE.TELEPHONE COD
E
TELEPHONE.TELEPHONE NUM
BER
TELEPHONE.EFFECTIVE_DATE
TELEPHONE.STATUS
ORGANIZATION. STATE CONTA
CT_FIRST_NAME
Comment
This value must be set to one of the following:
FAX (Fax)
VOICE (Voice)
PAGER (Pager)
CELL (Cellular/Mobile)
OTHER (Other)
This value is required if any organization
telephone information is included in the XML
data file.
This value is required if any organization
telephone information is included in the XML
data file.
This value must be in the following
alphanumeric format:
XXX-XXX-XXXX
This value is required if any organization
telephone information is included in the XML
data file.
The date should be entered in the XML file in
the following format: YYYY-MM-
DDTHH:MI:SS
This value should be set to the date on which
the telephone information became effective or
will become effective.
**Please see Section 3.2 Use of Effective
Date and Status Indicator Data Elements for
more information.
This value is required if any organization
telephone information is included in the XML
data file.
This value must be set to "ACTIVE" or
"INACTIVE".
**Please see Section 3.2 Use of Effective
Date and Status Indicator Data Elements for
more information.
This value represents the first name of the
State contact.
Beach Notification Database User Guide
December 23, 2011
12
-------
Data Element
State Contact Last
Name
Example: Smith
State Contact
Agency Name
Example:
Department of
Health
State Contact
Telephone
Example: 703-
321-4466
State Contact
Electronic Address
Text
Example:
Hardy. Tom@epa.g
ov
XML Tag Name
ContactLastName
ContactAgencyName
ContactTelephoneNumb
erText
ContactElectronicAddre
ssText
XML Data
Type
STRING
STRING
STRING
STRING
Req'd
(Y/N)
N
N
N
N
Length
50
60
12
255
Access Table Mapping
ORGANIZATION. STATE CONTA
CT_LAST_NAME
ORGANIZATION. STATE CONTA
CT_AGENCY
ORGANIZATION. STATE CONTA
CT_TELEPHONE_NUMBER
ORGANIZATION. STATE CONTA
CT_ELECTRONIC_ADDRESS
Comment
This value represents the last name of the
State contact.
This value represents the name of State
contact's agency.
This value must be in the following
alphanumeric format:
XXX-XXX-XXXX
This value represents the electronic address
information of the State contact.
Beach Notification Database User Guide
December 23, 2011
13
-------
3.1.2 Person Information
The person information section of the XML submission contains data related to the people associated with the beaches overseen by the
National Beach Watch Program. Examples of this data include person identifier code, name, title, and contact information. These data
elements will be included in the XML file when person data needs to be added or updated in the PRAWN database.
In the XML schema, each person is affiliated with exactly one organization. However, each organization can be associated with many
people.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/OrganizationDetail/OrganizationPersonDetail/".
If assigning beach contacts please specify "Public Contact" as the beach role. Reference Section 3.1.6 on assigning beach roles.
Beach Notification Database User Guide December 23, 2011
14
-------
Exhibit 3-2 Person Information Schema
Data Element
Person Identifier
Example: JOSM
Person Status
Indicator
Example: ACTIVE
Person First Name
Example: John
Person Last Name
Example: Smith
Person Middle
Initial
Example: S
Person Suffix
Example: Jr.
XML Tag Name
Personldentifier
PersonNameDetail/Pers
onStatuslndicator
PersonNameDetail/First
Name
PersonNameDetail/Last
Name
PersonNameDetail/Pers
onMiddlelnitial
PersonNameDetail/Nam
eSuffixText
XML Data
Type
STRING
STRING
STRING
STRING
STRING
STRING
Req'd
(Y/N)
Y
Y
Y
Y
N
N
Length
12
8
50
50
2
5
Access Table Mapping
PERSON. ID,
BEACH PERSON ROLE ASSIG
N.FK PERSON ID,
Comment
Submitting organizations will need to maintain
a list of valid Person Identifiers for all people
that are stored in the PRAWN database.
ELECTRONIC_ADDRESS.FK_PE These identifiers must be unique within each
RSONJD, organization, as they will be used to update
MAILING_ADDRESS.FK_PERSO organization-level data (for example, with an
N ID, organization there can only be 1 person
TELEPHONE.FK PERSON ID identified as "JOSM", but there could be
PERSON.ACTIVE
PERSON. FIRST_NAME
PERSON. LAST_NAME
PERSON. MIDDLE INITIAL
PERSON. SUFFIX
another person identified as "JOSM" in
another organization).
This value if required if any person name
information is included in the XML data file.
This value must be set to "ACTIVE" or
"INACTIVE".
This value if required if any person name
information is included in the XML data file.
This value if required if any person name
information is included in the XML data file.
The two characters in the 'Person Middle
Initial' can be used as needed by the
submitting state. For example, if there are two
people within a given organization called 'Bob
A Smith', using the second letter of the Middle
Name as the second letter of the 'Person
Middle Initial' can be a valuable method used
to differentiate between the two. Or, a period
can be inserted after the first letter. Or, the
second space can be left blank.
Beach Notification Database User Guide
December 23, 2011
15
-------
Data Element
Person Title
Example: Mr.
Person Mailing
Address Type
Code
Example:
SHIPPING
Person Mailing
Address Street
Line 1 Text
Example: 14 Main
Rd.
Person Mailing
Address Street
XML Tag Name
PersonNameDetail/Nam
ePrefixText
PersonMailingAddressD
etail/MailingAddressTyp
eCode
PersonMailingAddressD
etail/MailingAddressStre
etLinelText
PersonMailingAddressD
etail/MailingAddressStre
Line 2 Text etLine2Text
Example: Suite 4
Person Mailing
Address Street
PersonMailingAddressD
etail/MailingAddressStre
Line 3 Text etLineSText
Example: Building
12
Person Mailing
PersonMailingAddressD
Address City Text etail/MailingAddressCity
Example: Augusta
Person Mailing
Address State
Code
Example: ME
Name
PersonMailingAddressD
etail/StateCode
XML Data
Type
STRING
STRING
STRING
STRING
STRING
STRING
STRING
Req'd
(Y/N)
N
Y
Y
N
N
Y
Y
Length
60
12
100
100
100
50
2
Access Table Mapping
PERSON.TITLE
MAILING ADDRESS.MAILING A
DDRESS_CODE
MAILING_ADDRESS.LINE_1
MAILING_ADDRESS.LINE_2
MAILING_ADDRESS.LINE_3
MAILING_ADDRESS.CITY
MAILING_ADDRESS.STATE_PO
Comment
This value must be set to one of the following:
• SHIPPING (Shipping Address)
m MAILING (Mailing Address)
m OTHER (Other Address)
This value is required if any person mailing
address information is included in the XML
data file.
This value is required if any person mailing
address information is included in the XML
data file.
This value is required if any person mailing
address information is included in the XML
data file.
This value is required if any person mailing
STAL_CODE address information is included in the XML
data file.
This value must be a valid 2-character State
Postal Code.
Beach Notification Database User Guide
December 23, 2011
16
-------
Data Element
XML Tag Name
XML Data
Type
Req'd
(Y/N)
Length
Access Table Mapping
Comment
Person Mailing
Address Zip Code
Example: 04333
PersonMailingAddressD STRING | Y
etail/AddressPostalCode
12
MAILING ADDRESS.ZIP CODE
This value is required if any person mailing
address information is included in the XML
data file.
This value must be in one of the following
numeric formats:
or
Person Mailing
Address Effective
Date
Example: 2003-01-
01700:00:00
PersonMailingAddressD
etail/MailingAddressEffe
ctiveDate
DATE
MAILING_ADDRESS.EFFECTIVE
DATE
This value is required if any person mailing
address information is included in the XML
data file.
The date should be entered in the XML file in
the following format: YYYY-MM-
DDTHH:MI:SS
This value should be set to the date on which
the mailing address information became
effective or will become effective.
Please see Section 3.2 Use of Effective Date
and Status Indicator Data Elements for more
information.
Person Mailing
Address Status
Indicator
Example: ACTIVE
PersonMailingAddressD
etail/MailingAddressStat
uslndicator
STRING
MAILING ADDRESS.STATUS
This value is required if any person mailing
address information is included in the XML
data file.
This value must be set to "ACTIVE" or
"INACTIVE".
Please see Section 3.2 Use of Effective Date
and Status Indicator Data Elements for more
information.
Beach Notification Database User Guide
December 23, 2011
17
-------
Data Element
XML Tag Name
XML Data
Type
Req'd
(Y/N)
Length
Access Table Mapping
Comment
Person Electronic
Address Type
Code
Example: EMAIL
PersonElectronicAddres STRING | Y
sDetail/ElectronicAddres
sTypeCode
12
ELECTRONIC_ADDRESS.ELECT
RONIC ADDRESS CODE
This value must be set to one of the following:
• EMAIL (E-mail)
m URL (URL)
m OTHER (Other)
This value is required if any person electronic
address information is included in the XML
data file.
Person Electronic
Address Text
Example:
Smith. Bob@maine.
gov
PersonElectronicAddres
sDetail/ElectronicAddres
sText
STRING
255
ELECTRONIC_ADDRESS.ADDRE
SS
This value is required if any person electronic
address information is included in the XML
data file.
Person Electronic
Address Effective
Date
Example: 2003-01-
01700:00:00
PersonElectronicAddres DATE
sDetail/ElectronicAddres
sEffectiveDate
ELECTRON IC_ADDRESS. EFFEC
TIVE DATE
This value is required if any person electronic
address information is included in the XML
data file.
The date should be entered in the XML file in
the following format: YYYY-MM-
DDTHH:MI:SS
This value should be set to the date on which
the electronic address information became
effective or will become effective.
Please see Section 3.2 Use of Effective Date
and Status Indicator Data Elements for more
information.
Person Electronic
Address Status
Indicator
Example: ACTIVE
PersonElectronicAddres
sDetail/ElectronicAddres
sStatuslndicator
STRING
ELECTRONIC
S
ADDRESS.STATU
This value is required if any person electronic
address information is included in the XML
data file.
This value must be set to "ACTIVE" or
"INACTIVE".
Please see Section 3.2 Use of Effective Date
and Status Indicator Data Elements for more
information.
Beach Notification Database User Guide
December 23, 2011
18
-------
Data Element
XML Tag Name
XML Data
Type
Req'd
(Y/N)
Length
Access Table Mapping
Comment
Person Telephone
Type Code
Example: CELL
PersonTelephoneDetail/
TelephoneTypeCode
STRING
Y
12
TELEPHONE.TELEPHONE_TYPE
CODE
This value must be set to one of the following:
• FAX (Fax)
m VOICE (Voice)
m PAGER (Pager)
m CELL (Cellular/Mobile)
m OTHER (Other)
This value is required if any person telephone
information is included in the XML data file.
Person Telephone
Number
Example: 207- 287-
1111
PersonTelephoneDetail/
TelephoneNumberText
STRING
12
TELEPHONE.TELEPHONE_NUM
BER
This value is required if any person telephone
information is included in the XML data file.
This value must be in the following
alphanumeric format:
• XXX-XXX-XXXX
Person Telephone
Effective Date
Example: 2003-01-
01700:00:00
PersonTelephoneDetail/
Effect iveDate
DATE
TELEPHONE.EFFECTIVE DATE
This value is required if any person telephone
information is included in the XML data file.
The date should be entered in the XML file in
the following format: YYYY-MM-
DDTHH:MI:SS
This value should be set to the date on which
the telephone information became effective or
will become effective.
Please see Section 3.2 Use of Effective Date
and Status Indicator Data Elements for more
information.
Person Telephone
Status Indicator
Example: ACTIVE
PersonTelephoneDetail/
Statuslndicator
STRING
TELEPHONE.STATUS
This value is required if any person telephone
information is included in the XML data file.
This value must be set to "ACTIVE" or
"INACTIVE".
Please see Section 3.2 Use of Effective Date
and Status Indicator Data Elements for more
information.
Beach Notification Database User Guide
December 23, 2011
19
-------
3.1.3 Beach Information
The Beach Information section of the XML submission contains data, such as beach name, beach description, state code, and county
code, related to the beaches overseen by the National Beach Program. These data elements will be included in the XML file when
beach information needs to be added or updated in the PRAWN database.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/BeachDetail/".
Beach Notification Database User Guide December 23, 2011
20
-------
Exhibit 3-3 Beach Information Schema
Data Element
Beach Identifier
Example:
ME234898
Beach Name
Example: Sandy
Beach Point
Beach Description
Text
Example: Rocky,
big waves, no
pollution
Beach Comment
Text
Example: A nice
place to surf
Beach State Code
Example: ME
XML Tag Name
Beachldentifier
BeachNameDetail/Pro
gramlnterestName
BeachNameDetail/Pro
gramlnterestDescriptio
nText
BeachNameDetail/Pro
gramlnterestComment
Text
BeachNameDetail/Pro
gramlnterestStateCode
XML Data
Type
STRING
STRING
STRING
STRING
STRING
Req'd
(Y/N)
Y
Y
Y
N
Y
Length
8
60
255
255
2
Access Table Mapping
BEACH. ID,
BEACH ACTIVITY.FK BEACH
ID,
BEACH PROCEDURE ASSIG
N. FK BEACH ID,
BEACH PERSON ROLE ASSI
GN. FK BEACH ID,
BEACH ORGANIZATION ROL
E ASSIGN. FK BEACH ID,
BEACH LATITUDE LONGITUD
E COORDINATE.FK BEACH 1
D
BEACH. NAME
BEACH. DESCRIPTION
BEACH. COMMENT
BEACH. STATE POSTAL COD
E
Comment
EPA maintains a list of valid Beach
Identifiers for all beaches that are stored in
the PRAWN database. Each new identifier
must be registered with EPA before it can
be submitted. These identifiers must be
unique, as they will be used to update
beach-level data.
*Send request for new Beach ID to
ebeaches@cqifederal.com
This value is required if any beach name
information is included in the XML data file.
This value is required if any beach name
information is included in the XML data file.
This is an optional field that can be used to
store other information about the particular
beach that is not included in an official
description.
This value is required if any beach name
information is included in the XML data file.
This value must be a valid 2-character
State Postal Code.
Beach Notification Database User Guide
December 23, 2011
21
-------
Data Element
Beach FIPS
County Code
Example: 23001
Water Body Name
Code
Example:
ATLANTIC
Water Body Type
Code
Example:
OPEN_COAST
XML Tag Name
BeachNameDetail/Pro
gramlnterestFIPSCoun
tyCode
BeachNameDetail/Wat
erBodyNameCode
BeachNameDetail/Wat
erBodyTypeCode
XML Data
Type
STRING
STRING
STRING
Req'd
(Y/N)
Y
N
N
Length
5
12
12
Access Table Mapping
BEACH. FIPS_COUNTY
BEACH.WATERBODY_NAME
BEACH.WATERBODY_TYPE
Comment
This value is required if any beach name
information is included in the XML data file.
This value must be a valid 5 digit code
representing a county, as assigned by the
Federal Information Processing Standards
Publications (FIPS). The first two digits
represent the state, while the last three
digits represent the specific county.
FIPS county codes can be found at
http://www.itl.nist.gov/fipspubs/co-
codes/states.htm
This value can be chosen from a list in
Appendix D.
This value is optional for all states except
those on the Great Lakes.
If Water Body Name (above) is NOT
assigned to INLAND, this value must be set
to one of the following:
• OPEN_COAST (Open Coast)
• SND_BY_INLT (Sound, Bay, or Inlet)
If Waterbody Name (above) IS assigned to
INLAND, this value must be set to one of
the following:
• STILL_WATER (Still Water)
• FLOW_WATER (Flowing Water)
This value is optional for all states except
those on the Great Lakes.
Beach Notification Database User Guide
December 23, 2011
22
-------
Data Element
Beach
XML Tag Name
BeachNameDetail/Bea
Accessibility Type chAccessibilityDetail/B
Example- eachAccessibilityType
PUB_PRV_ACC
Beach
Accessibility
BeachNameDetail/Bea
chAccessibilityDetail/B
Comment eachAccessibilityCom
Example: Public ment
Property at the
end of a road.
XML Data
Type
STRING
STRING
Req'd
(Y/N)
Y
N
Length
12
255
Access Table Mapping
BEACH. ACCESS_TYPE
BEACH.ACCESS_COMMENT
Comment
This value is required if any beach name
information is included in the XML data file.
The value must be set to one of the
following:
• PUB_PUB_ACC (Public Beach with
Public Access)
m PRV_PRV_ACC (Private Beach with
Private Access)
m PUB_PRV_ACC (Public Beach with
Private Access)
m PRV_PUB_ACC (Private Beach with
Public Access)
This is an optional field that can be used to
store other information about the beach
access that is not included in an official
description.
Beach Notification Database User Guide
December 23, 2011
23
-------
3.1.4 Beach Attribute Information
The beach attribute section of the XML submission contains data related to beach information that may change over time, such as
beach extent (length), swim season length, and monitoring frequency.
States should submit one 'Beach Attribute Detail' section each year for each beach.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/BeachDetail/BeachAttributeDetail/".
Beach Notification Database User Guide December 23, 2011
24
-------
Exhibit 3-4 Beach Attribute Information Schema
Data Element
Attribute Effective
Year
Example: 2006
Beach Extent
Length Measure
Example: 5
Beach Extent
Length Unit of
Measure
Example: Ml
Swim Season
Start Date
Example:
1/1/2007
XML Tag Name
AttributeEffectiveYear
BeachExtentDetail/Ext
entLengthMeasure
BeachExtentDetail/Ext
entUnitOfMeasureCod
e
BeachSwimSeasonLen
gthDetail/SwimSeason
StartDate
XML Data
Type
STRING
NUMBER
STRING
DATE
Req'd
(Y/N)
Y
Y
Y
Y
Length
4
14
12
n/a
Access Table Mapping
BEACH ATTRIBUTE.EFFECTIV
E YEAR
BEACH ATTRIBUTE.EXTENT
LENGTH
BEACH ATTRIBUTE.EXTENT
UNITS
BEACH ATTRIBUTE.
SWIM_SEASON_START_DATE
Comment
This value is required if any beach attribute
information is included in the XML data file.
Attribute Effective Year is appended to
each of the beach extent, swim season,
and monitoring frequency records in
PRAWN to distinguish the change over
time.
This value must be updated every year,
even if the subsequent attribute information
does not change, in order to verify the
correct information for a beach.
This value is required if any beach name
information is included in the XML data file.
This value is the numeric equivalent of the
length of a beach, along with the units of
measure below.
This value must be set to one of the
following:
Ml (Miles)
FT (Feet)
YDS (Yards)
M (Meters)
KM (Kilometers)
This value is required if any beach name
information is included in the XML data file.
The Swim Season Start Date and Swim
Season End Date are required if any beach
name information is included in the XML
data file. Beach Season Length and Beach
Season Unit of Measure are optional to
include. For example, if a beach is not open
everyday between start and end dates, you
can set open days.
This value is the date the beach swim
season starts for the year.
Beach Notification Database User Guide
December 23, 2011
25
-------
Data Element
Swim Season End
XML Tag Name
BeachSwimSeasonLen
Date gthDetail/SwimSeason
Example: EndDate
12/31/2007
Beach Season
Length
Example: 150
Beach Season
Unit of Measure
Example: DAYS
BeachSwimSeasonLen
gthDetail/SwimSeason
LengthMeasure
BeachSwimSeasonLen
gthDetail/SwimSeason
UnitOfMeasureCode
XML Data
Type
DATE
NUMBER
STRING
Req'd
(Y/N)
Y
N
N
Length
n/a
14
12
Access Table Mapping
BEACH ATTRIBUTE.
SWIM_SEASON_END_DATE
BEACH ATTRIBUTE.SWIM SE
ASON_LENGTH
BEACH ATTRIBUTE.SWIM SE
ASONJJNITS
Comment
The Swim Season Start Date and Swim
Season End Date are required if any beach
name information is included in the XML
data file. Beach Season Length and Beach
Season Unit of Measure are optional to
include. For example, if a beach is not open
everyday between start and end dates, you
can set open days.
This value is the date the beach swim
season ends for the year.
The Swim Season Start Date and Swim
Season End Date are required if any beach
name information is included in the XML
data file. Beach Season Length and Beach
Season Unit of Measure are optional to
include. For example, if a beach is not
open everyday between start and end
dates, you can set open days.
This value is the numeric equivalent of the
amount of time in a swim season, along
with the units of measure below.
This value must be set to one of the
following:
DAYS (Days)
WEEKS (Weeks)
MONTHS (Months)
The Swim Season Start Date and Swim
Season End Date are required if any beach
name information is included in the XML
data file. Beach Season Length and Beach
Season Unit of Measure are optional to
include. For example, if a beach is not open
everyday between start and end dates, you
can set open days.
Beach Notification Database User Guide
December 23, 2011
26
-------
Data Element
Swim Season
XML Tag Name
MonitoringFrequencyD
XML Data
Type
NUMBER
Monitoring etail/SwimSeasonFreq
Frequency uencyMeasure
Example: 10
Off Season
Monitoring
Frequency
Example: 2
Monitoring
MonitoringFrequencyD
etail/OffSeasonFreque
ncyMeasure
MonitoringFrequencyD
Frequency Unit of etail/MonitoringFreque
Measure
Example:
PER_WEEK
ncyUnitOfMeasureCod
e
NUMBER
STRING
Req'd
(Y/N)
Y
Y
Y
Length
14
14
12
Access Table Mapping
BEACH_ATTRIBUTE.SWIM_M
Comment
This value is required if any beach attribute
ONITOR_FREQ information is included in the XML data file.
BEACH ATTRIBUTE.OFF MO
NITOR_FREQ
BEACH ATTRIBUTE.MONITOR
_FREQ_UNITS
This value is the numeric equivalent of the
frequency of monitoring performed during
the designated Swim Season, as defined in
the previous tags. The Swim Season
Monitoring Frequency corresponds to the
units of measure below.
If monitoring is not performed on the beach
during the swim season, please enter a 0
(zero) for this value.
This value is required if any beach attribute
information is included in the XML data file.
This value is the numeric equivalent of the
frequency of monitoring performed outside
of the designated Swim Season, as defined
in the previous tags. The Off Season
Monitoring Frequency corresponds to the
units of measure below.
If monitoring is not performed on the beach
during the off season, please enter a 0
(zero) for this value.
This value must be set to one of the
following:
PER_DAY (Per Day)
PER_WEEK (Per Week)
PER_MONTH (Per Month)
PER_YEAR (Per Year)
This value is required if any beach attribute
information is included in the XML data file.
This value corresponds to both the Swim
Season and Off Season Monitoring
Frequencies. For example, if the Swim
Season Monitoring Frequency Measure is
10, and the Units are PER_WEEK, the
frequency reads "The beach is monitored
1 0 times per week during the swim
season."
Beach Notification Database User Guide
December 23, 2011
27
-------
Data Element
Monitored
Irregularly
Indicator
Example: Y
Monitored
Irregularly
Comment
Pollutions
Sources Indicator
Example: Y
Pollutions
Sources
Investigated
Indicator
Example: Y
XML Tag Name
Monitoredlrregularly
Monitored IrregularlyCo
mment
NoPollutionSourcesInd
icator
PollutionsSourcesUnin
vestigatedlndicator
XML Data
Type
BOOLEA
N
Text
BOOLEA
N
BOOLEA
N
Req'd
(Y/N)
Y
N
Y
Y
Length
1
255
1
1
Access Table Mapping
BEACH ATTRIBUTE.
MONITOREDJRREGULARLY
BEACH ATTRIBUTE.
MONITORED IRREGULARLY
COMMENT
POLLUTION_SOURCES
POLLUTION SOURCES INVE
STIGATED
Comment
This value is required if any beach attribute
information is included in the XML data file.
This should be "Y" if the beach is monitored
irregularly and "N" otherwise.
Any comments the about the regularity of
the monitoring.
This should be "Y" if there are any possible
pollution sources for the beach. This should
be "N" if pollution sources were investigated
and none were found.
Note, see Appendix G for more information
on populating data for pollution sources.
This should be "Y" if the beach pollution
sources have been investigated and "N"
otherwise.
Note, see Appendix G for more information
on populating data for pollution sources.
Beach Notification Database User Guide
December 23, 2011
28
-------
Data Element
Beach Pollution
XML Tag Name
BeachPollutionSource
Source Code Detail/BeachPollutionS
Example: ourceCode
SEWER LINE
Beach Pollution
Source
BeachPollutionSource
Detail/BeachPollutionS
Description ourceDescription
XML Data
Type
STRING
STRING
Req'd
(Y/N)
N
N
Length
12
255
Access Table Mapping
BEACH POLLUTION. POLLUTI
ON_SOURCE
BEACH POLLUTION. POLLUTI
ON_COMMENT
Comment
This value must be set to one of the
following:
AGRICULTURAL (Agricultural Runoff)
ALGAE (Algae Sources)
BOAT (Boat Discharge)
CAFO (Concentrated Animal Feeding
Operation)
CSO (Combined Sewer Overflow)
POTW (Publicly-Owned Treatment Works)
RUNOFF (Non-storm Related/Urban/Dry
weather runoff)
SEPTIC (Septic System Leakage)
SEWERJJNE (Sewer Line
Leak/Break/Blockage)
SSO (Sanitary Sewer Overflow)
STORM (Storm Related/Wet-Weather
Runoff)
WILDLIFE (Wildlife)
UNKNOWN (Unknown)
OTHER (Other-Specify in Description Field)
This value is designed to allow states to
store pollution sources impacting a given
beach. These may include "possible"
sources, identified by a citable study or
attributed to by a credible person or entity;
even if not confirmed to a level suitable for
use in a court of law.
**Note that submitting a beach with no
potential pollution sources is identical to
saying that no pollution sources are known
to impact that beach.
This is an optional field that can be used to
store other information about the beach
pollution source that is not included in an
official description.
This field can also specify the species of
Algae, see STORET Biological names
standard.
http://www.epa.aov/storet/links.html
Beach Notification Database User Guide
December 23, 2011
29
-------
Data Element
Beach Website
URL
Beach Tier
Ranking
Example: 2
Beach Act Beach
Indicator
Example: Y
Beach Dormant
Indicator
Example: Y
Reporting
Frequency
Example: 3
XML Tag Name
BeachWebsite
BeachTierRanking
BeachActBeachlndicat
or
BeachDormantlndicato
r
ReportingFrequencyM
easure
XML Data
Type
Text
NUMBER
(0-9)
BOOLEA
N
BOOLEA
N
NUMBER
Req'd
(Y/N)
N
Y
Y
N
N
Length
255
1
1
1
14
Access Table Mapping
BEACH ATTRIBUTE.BEACH
WEBSITE
BEACH ATTRIBUTE.BEACH T
IER
BEACH ATTRIBUTE.BEACH A
CT_BEACH
BEACH ATTRIBUTE.BEACH D
ORMANT
BEACH ATTRIBUTE.REPORT
FREQ
Comment
This value represents the URL State's can
use to specify the website page of a beach.
This value is required if any beach attribute
information is included in the XML data file.
The ranking system for this value is set by
individual states, so the ranges may differ
(e.g., State A may have tiers 1 and 2, while
State B may have tiers 1 , 2, and 3)
States with no tier system should enter a
value of '1' for all beaches.
This value is required if any beach attribute
information is included in the XML data file.
This should be "Y" if the beach qualifies as
a BEACH Act beach and "N" otherwise.
This should be "Y" if the beach is not
expected to be monitored or managed to
report actions for at least a year/season.
If expected to be non-reporting
(deactivated) for longer, ask EPA to set
historical flag to "Y".
This value is the numeric equivalent of the
frequency of notification reporting
performed during the year. The Reporting
Frequency corresponds to the units of
measure below.
If notification reporting is not being done on
the beach report the frequency as 0 and set
the dormant flag to "Y".
If the notification reporting is not
determined please enter 0.
Beach Notification Database User Guide
December 23, 2011
30
-------
Data Element
Reporting
Frequency Unit of
Measure
Example:
PER_WEEK
Indicator Name
Example: ECOLI
Water Type Name
Example:
MARINE
XML Tag Name
ReportingFrequencyUn
ItOfMeasureCode
IndicatorName
WaterTypeName
XML Data
Type
STRING
STRING
STRING
Req'd
(Y/N)
N
N
N
Length
12
12
12
Access Table Mapping
BEACH ATTRIBUTE.REPORT
FREQJJNITS
BEACH ATTRIBUTE CRITERO
N.INDICATOR_NAME
BEACH ATTRIBUTE CRITERO
N . WATE R_TYPE_N AM E
Comment
This value must be set to one of the
following:
PER_DAY (Per Day)
PER_WEEK (Per Week)
PER_MONTH (Per Month)
PER_YEAR (Per Year)
This value corresponds to the Reporting
Frequency. For example, if the Reporting
Frequency Measure is 1, and the Units are
PER_WEEK, the frequency reads "The
beach is reported once per week during the
year."
This value must be set to one of the
following:
ENTERO (Enterococci)
FECAL (Fecal Coliform)
TOTAL (Total Coliform)
ECOLI (E. coli)
OTHER (Other-Please specify in the
Description field)
This value is designed to allow states to
notify the BEACON user under which
conditions a beach activity occurs.
Multiple criteron entries may be included for
a single beach.
This value must be set to one of the
following:
MARINE
FRESH
BOTH
This value represents the water type used
in reporting the criterion data.
Beach Notification Database User Guide
December 23, 2011
31
-------
Data Element
Measure Type
Name
Example: SSM
Measure Value
Example: 35
Measure Unit
Code
Example:
CFU/WOml
Criterion
Comment
XML Tag Name
MeasureTypeName
MeasureValue
MeasureUnitCode
CriterionComment
XML Data
Type
STRING
NUMBER
STRING
STRING
Req'd
(Y/N)
N
N
N
N
Length
12
14
12
255
Access Table Mapping
BEACH ATTRIBUTE CRITERO
N.MEASURE_TYPE_NAME
BEACH ATTRIBUTE CRITERO
N.MEASURE_VALUE
BEACH ATTRIBUTE CRITERO
N.MEASURE_UNIT_CODE
BEACH ATTRIBUTE CRITERO
N.CRITERION_COMMENT
Comment
This value must be set to one of the
following:
GM
SSM
STV
This value represents the measure type
used in reporting the criterion data. Multiple
measure type names may exist for a single
indicator.
This value is the numeric measure
representing the criterion data, along with
the units of measure below.
This value is the string unit code
representing the criterion data.
This value can contain a string of
characters or a URL to a document that
explains the local advisory and closure
action decision procedures.
Beach Notification Database User Guide
December 23, 2011
32
-------
3.1.5 Beach Activity Information
The beach activity section of the XML submission contains data related to beach advisories and closures, such as activity type code,
activity name, activity description text, and activity reason. These data elements will be included in the XML file when activity or
closure information needs to be added to the PRAWN database. Beach activity information can only be added to the PRAWN
database; it cannot be updated. Since activities require a start and stop date, only completed activities should be submitted.
States should submit one 'Beach Activity Detail' section per any one of the Activity Type Codes. Multiple 'Beach Activity Detail'
sections can appear under one 'Beach Detail' section.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/BeachDetail/BeachActivityDetail/".
Beach Notification Database User Guide December 23, 2011
33
-------
Exhibit 3-5 Beach Activity Information Schema
Data Element
Activity Type
Code
Example:
CLOSURE
Activity Name
Example: Closure
34
Activity Actual
Start Date
Example: 2002-
04-12102:00:00
XML Tag Name
ActivityTypeCode
ActivityName
ActivityActualStartDate
XML Data
Type
STRING
STRING
DATE
Req'd
(Y/N)
Y
Y
Y
Length
12
60
Access Table Mapping
BEACH ACTIVITY.ACTIVITY C
ODE
BEACH_ACTIVITY.NAME
BEACH ACTIVITY.ACTUAL ST
ART DATE
Comment
This value must be set to one of the
following:
CONTAM_ADV (Contamination Advisory)
CLOSURE (Closure)
PERM_CLOSURE (Permanent Closure)
RAIN_ADV (Rain Advisory)
This value is required if any beach activity
information is included in the XML data file.
States should submit one 'Beach Activity
Detail' section per any one of the above
activities.
Activity Type Code and Activity Name are
related in so far as the Activity Name can
be used to keep track of the various activity
types by assigning a local name to the
various activities. There is not an Identifier
in this portion of the data submission to aid
in this endeavor.
This value is required if any beach activity
information is included in the XML data file.
Activity Type Code and Activity Name are
related in so far as the Activity Name can
be used to keep track of the various activity
types by assigning a local name to the
various activities. There is not an Identifier
in this portion of the data submission to aid
in this endeavor.
This value is required if any beach activity
information is included in the XML data file.
The date should be entered in the XML file
in the following format: YYYY-MM-
DDTHH:MI:SS
Beach Notification Database User Guide
December 23, 2011
34
-------
Data Element
Activity Actual
Stop Date
Example: 2002-
04-16106:30:00
Activity Reason
Type
Example:
ELEV_BACT
XML Tag Name
ActivityActualStopDate
Act ivityReason Detail/A
ctivityReasonType
XML Data
Type
DATE
STRING
Req'd
(Y/N)
Y
Y
Length
60
Access Table Mapping
BEACH ACTIVITY.ACTUAL ST
OP_DATE
BEACH_ACTIVITY_REASON.T
Comment
The date should be entered in the XML file
in the following format: YYYY-MM-
DDTHH:MI:SS
**Note a place holder can be used if the
actual stop date is unavailable. Use the
following timestamp to submit the stop date
in a later submission: 1900-01-01TOO:00:00
This value must be set to one of the
YPE following:
(BEACH ACTIVITY REASON. C
LASS = 'REASON')
ELEV_BACT (Monitoring that revealed
elevated bacteria levels)
RAINFALL (Preemptive-Rainfall)
SEWAGE (Preemptive-Sewage discharge
or spill)
CHEMJDIL (Preemptive-Chemical or oil
discharge or spill)
MODEL (Model prediction)
POLICY (Policy dictates action)
OTHER (Other-Please specify in the
Description field)
This value is required only if beach activity
information AND beach activity reason
information is included in the XML data file.
The Beach Activity Reason Type field is
used to supply information regarding the
reason for the activity denoted in the
Activity Type Code field.
Any number of Reason Detail sections may
be submitted (consecutively in the XML file)
to associate many reasons to a single
activity.
**Note that activities with Type
'ELEV_BACT' must submit at least one
Monitoring Station Identifier.
Beach Notification Database User Guide
December 23, 2011
35
-------
Data Element
Activity Reason
XML Tag Name
Act ivityReason Detail/A
Description Text ctivityReasonDescripti
Example: onText
Exceeded Water
Quality Standards
Activity Source
Type
ActivitySourceDetail/Ac
tivitySourceType
Example: CSO
Activity Source
ActivitySourceDetail/Ac
XML Data
Type
STRING
STRING
STRING
Description Text tivitySourceDescription
Example: Visible Text
from CSO
Req'd
(Y/N)
N
Y
N
Length
255
60
255
Access Table Mapping
BEACH_ACTIVITY_REASON.D
Comment
The Beach Activity Reason Description field
ESCRIPTION is used to supply additional information
(BEACH ACTIVITY REASON. C regarding the reason for the activity
LASS = 'REASON')
BEACH ACTIVITY REASON.T
YPE
(BEACH ACTIVITY REASON. C
LASS = 'SOURCE')
BEACH_ACTIVITY_REASON.D
denoted in the Activity Type Code field.
This value must be set to one of the
following:
AGRICULTURAL (Agricultural Runoff)
ALGAE (Algae Sources)
BOAT (Boat Discharge)
CAFO (Concentrated Animal Feeding
Operation)
CSO (Combined Sewer Overflow)
POTW (Publicly-Owned Treatment Works)
RUNOFF (Non-storm
Related/Urban/Dryweather runoff)
SEPTIC (Septic System Leakage)
SEWERJJNE (Sewer Line
Leak/Break/Blockage)
SSO (Sanitary Sewer Overflow)
STORM (Storm Related/Wet-Weather
Runoff)
WILDLIFE (Wildlife)
UNKNOWN (Unknown)
OTHER (Other-Specify in Description Field)
This value is required only if beach activity
information AND beach activity source
information is included in the XML data file.
The Beach Activity Source Type field is
used to supply information regarding the
source of the activity denoted in the Activity
Type Code field.
The Beach Activity Source Type field is
ESCRIPTION used to supply additional information
(BEACH ACTIVITY REASON. C regarding the source of the activity denoted
LASS = 'SOURCE') in the Activity Type Code field.
Beach Notification Database User Guide
December 23, 2011
36
-------
Data Element
Activity Indicator
Type
Example:
PREEMPT
Activity Indicator
Description Text
Example: To
avoid more
actions
XML Tag Name
ActivitylndicatorDetail/
ActivitylndicatorType
ActivitylndicatorDetail/
ActivitylndicatorDescri
ptionText
XML Data
Type
STRING
STRING
Req'd
(Y/N)
Y
N
Length
60
255
Access Table Mapping
BEACH ACTIVITY REASON.T
YPE
(BEACH ACTIVITY REASON. C
LASS = ' INDICATOR')
BEACH ACTIVITY REASON. D
ESCRIPTION
(BEACH ACTIVITY REASON. C
LASS = ' INDICATOR')
Comment
This value must be set to one of the
following:
PREEMPT (Preemptive)
ENTERO (Enterococci)
TOTAL_COL (Total Coliform)
FECAL_COL (Fecal Coliform)
ECOLI (E. coli)
RATIO (Total/Fecal Ratio)
OTHER (Other-Please specify in the
Description field)
This value is required only if beach activity
information AND beach activity indicator
information is included in the XML data file.
The Beach Activity Indicator Type field is
used to supply information regarding the
indicator for the activity denoted in the
Activity Type Code field.
The comment field can also specify the
species of Algae, see STORET Biological
names standard.
http://www.epa.aov/storet/links.html
This value is required only if beach activity
information AND beach activity indicator
information is included in the XML data file.
Beach Notification Database User Guide
December 23, 2011
37
-------
Data Element
Activity Monitoring
Station ID
Example:
21MEBCH|Station
1
Activity
Description Text
Example: The
lifeguards closed
the beach
Activity Comment
Text
Example: The
police were not
present
Activity Start
Measure
Example: 2
Activity Extent
Length Measure
Example: 5
XML Tag Name
ActivityMonitoringStati
onldentifier
ActivityDescriptionText
ActivityCommentText
Act ivity Exte ntD eta i I/Act
IvityExtentStartMeasur
e
Act ivity Exte ntD eta i I/Act
IvityExtentLengthMeas
ure
XML Data
Type
STRING
STRING
STRING
NUMBER
NUMBER
Req'd
(Y/N)
N
N
N
N
Y
Length
65
255
255
14
14
Access Table Mapping
BEACH ACTIVITY STATION. S
TATIONJD
BEACH ACTIVITY.DESCRIPTI
ON
BEACH_ACTIVITY.COMMENT
BEACH ACTIVITY.EXTENT ST
ART_MEASURE
BEACH ACTIVITY.EXTENT LE
NGTH
Comment
This value corresponds to the combination
of a valid, pre-registered STORET
organization ID and the valid, pre-
registered STORET station ID that
impacted the activity.
The two IDs must be joined together with a
"pipe" ("|") character (e.g.,
'OrglD|StationlD').
Any number of Monitoring Station IDs may
be submitted (consecutively in the XML file)
to associate many stations to a single
activity.
This value is required if the Activity Reason
Type is 'ELEV BACT'.
This is an optional field that can be used to
describe anything about the activity itself.
An example might be, "The lifeguards
closed the beach."
This is an optional field that can be used to
store other information about the particular
activity. An example might be, "The police
were not present."
This value is the numeric equivalent of the
location or mile marker where the length of
affected beach begins. The activity extent
length (below) is added to the activity start
measure to understand the exact extent of
beach that was affected by the activity.
For example, a start measure of 2 with an
extent length of 5 and a unit of measure
code of mi means the activity affected the
beach from mile marker 2 to mile marker 7.
This value is required only if any beach
activity information AND any beach activity
extent information is included in the XML
data file.
See Activity Start Measure (above) for an
explanation of the use of this value.
Beach Notification Database User Guide
December 23, 2011
38
-------
Data Element
Activity Unit of
Measure Code
Example: Ml
XML Tag Name
Act ivity Exte ntD eta i I/Act
IvityUnitOfMeasureCod
e
XML Data
Type
STRING
Req'd
(Y/N)
Y
Length
12
Access Table Mapping
BEACH ACTIVITY.EXTENT U
NIT_OF_MEASURE
Comment
This value must be set to one of the
following:
Ml (Miles)
FT (Feet)
YDS (Yards)
M (Meters)
KM (Kilometers)
This value is required only if any beach
activity information AND any beach activity
extent information is included in the XML
data file.
Beach Notification Database User Guide
December 23, 2011
39
-------
3.1.6 Beach Role Information
The beach role section of the XML submission allows submitting states to provide data related to the Organization and/or Person
performing roles for a given beach. This section includes data elements, such as beach role type code, organization identifier, and
person identifier. These data elements will be included in the XML file when beach role information needs to be added or updated in
the PRAWN database.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/BeachDetail/BeachRoleDetail/".
Beach Notification Database User Guide December 23, 2011
40
-------
Exhibit 3-6 Beach Role Information Schema
Data Element
Beach Role Type
Code
Example: LOCAL
XML Tag Name
BeachRoleTypeCode
XML Data
Type
STRING
Req'd
(Y/N)
Y
Length
12
Access Table Mapping
BEACH ORGANIZATION ROL
E ASSIGN. ORG ROLE CODE,
BEACH PERSON ROLE ASSI
GN. PERSON ROLE CODE
Comment
People/organizations are assigned a role
on a beach via the 'Beach Role Type Code'
field.
For beach/organization assignments, this
value must be set to one of the following:
LOCAL (Lead Local Agency)
STATE (Lead State Agency)
CONTRACTOR (Contractor)
SUBCONTRACT (Subcontractor)
RESPONDENT (Respondent)
DETERM_AUTH (Determination Authority)
ISSUAN_AUTH (Issuance Authority)
REOPEN_AUTH (Reopening Authority)
LAB (Laboratory)
COLLECTOR (Sample Collector)
ANALYZER (Sample Analyzer)
OTHER (Other)
UNKNOWN (Unknown)
For beach/person assignments, this value
must be set to one of the following:
STATE (Lead State Contact)
LOCAL (Lead Local Contact)
COLLECTOR (Sample Collector)
Beach Notification Database User Guide
December 23, 2011
41
-------
Data Element
Beach Role Type
Code (cont.)
Beach Role
Organization
Identifier
Example:
987654321098
Beach Role
Person Identifier
Example:
123456789012
Beach Role
Effective Date
Example: 2003-
01-01100:00:00
XML Tag Name
BeachRoleOrganizatio
nldentifier
BeachRolePersonldent
ifier
BeachRoleEffectiveDat
e
XML Data
Type
STRING
STRING
DATE
Req'd
(Y/N)
Y
N
Y
Length
12
12
Access Table Mapping
BEACH ORGANIZATION ROL
E ASSIGN. FK ORGANIZATIO
N ID,
PERSON. FK ORGANIZATION
ID
BEACH PERSON ROLE ASIG
N.FK_PERSON_ID
BEACH ORGANIZATION ROL
E ASSIGN. EFFECTIVE DATE,
BEACH PERSON ROLE ASSI
GN. EFFECTIVE DATE
Comment
ANALYZER (Sample Analyzer)
RESPONDENT (Respondent)
TECHNICAL (Technical Contact)
PUBLIC (Public Contact)
DETERM_AUTH (Determination Authority)
ISSUAN_AUTH (Issuance Authority)
REOPEN_AUTH (Reopening Authority)
INFO_TECH (Information Technology
Authority)
This value is required if any beach role
information is included in the XML data file.
A beach is associated with an organization
via this field. To do so, enter the
Organization Identifier in the Beach Role
Organization Identifier field.
This value must correspond to a valid
Organization Identifier in the XML file or in
the PRAWN database.
A beach can be associated with a person
via this field. To do so, enter the Person
Identifier in the Beach Role Person
Identifier field in addition to entering the
Organization Identifier in the Beach Role
Organization Identifier field.
The Beach Role Person Identifier must
correspond to a valid Person Identifier in
the XML file or in the PRAWN database.
This value is required if any beach role
information is included in the XML data file.
The date should be entered in the XML file
in the following format: YYYY-MM-
DDTHH:MI:SS
This value should be set to the date on
which the beach role information became
effective or will become effective.
Please see Section 3.2 Use of Effective
Date and Status Indicator Data Elements
for more information.
Beach Notification Database User Guide
December 23, 2011
42
-------
Data Element
Beach Role
Status Indicator
Example: ACTIVE
XML Tag Name
BeachRoleStatuslndic
ator
XML Data
Type
STRING
Req'd
(Y/N)
Y
Length
8
Access Table Mapping
BEACH ORGANIZATION ROL
E ASSIGN. STATUS,
Comment
This value is required if any beach role
information is included in the XML data file.
BEACH PERSON ROLE ASSI This value must be set to "ACTIVE" or
GN. STATUS "INACTIVE".
Please see Section 3.2 Use of Effective
Date and Status Indicator Data Elements
for more information.
Beach Notification Database User Guide
December 23, 2011
43
-------
3.1.7 Beach Coordinate Information
The beach coordinate section of the XML submission allows submitting states to provide data related to the end points of a given
beach. This section includes data elements, such as latitude measure, longitude measure, source map scale, horizontal collection
method name, and horizontal coordinate reference system datum name. These data elements will be included in the XML file when
beach coordinate information needs to be added or updated in the PRAWN database.
Beach Notification Database User Guide December 23, 2011
44
-------
Exhibit 3-7 Beach Coordinate Information Schema
Data Element
Latitude Measure
Example:
34.141592
Longitude
Measure
Example:-
74.141592
Source Map Scale
Numeric
Example:
12500
Horizontal
Collection Method
Name
Example:
INTERPOLATION
-MAP
INTERPOLATION
-SATELLITE
GPS
Horizontal
Coordinate
Reference
System Datum
Name
Example:
NAD27
NAD83
XML Tag Name
LatitudeMeasure
LongitudeMeasure
SourceMapScaleNume
ric
HorizontalCollectionMe
thodName
HorizontalCoordinateR
eferenceSystemDatum
Name
XML Data
Type
NUMBER
NUMBER
NUMBER
STRING
STRING
Req'd
(Y/N)
Y
Y
C
Y
Y
Length
6-8
6-9
14
150
6
Access Table Mapping
BEACH LATITUDE LONGITUD
E COORDINATES.START LAT
ITUDE
BEACH LATITUDE LONGITUD
Comment
The measure of the angular distance on a
meridian north or south of the equator.
Signed Decimal Latitude with positive
values north of the Equator.
E COORDINATES.END LATIT
UDE
BEACH LATITUDE LONGITUD
E COORDINATES.START
LONGITUDE
The measure of the angular distance on a
meridian east or west of the prime
meridian.
BEACH_LATITUDE_LONGITUD Signed Decimal Longitude with negative
E COORDINATES.END values west of Greenwich.
LONGITUDE
BEACH LATITUDE LONGITUD
E COORDINATES.SOURCE M
AP_SCALE
BEACH LATITUDE LONGITUD
The number that represents the relative
distance on the ground for one unit of
measure on the map or photo.
This field is mandatory only when the
Horizontal Collection Method Name used is
INTERPOLATION MAP.
The name that identifies the method used
E_COORDINATES.REF_H_CO to determine the latitude and longitude
LLECTION_METHOD_NAME coordinates for a point on the earth.
BEACH LATITUDE LONGITUD
E COORDINATES.REF H REF
ERENCE DATUM NAME
The name that describes the system used
in determining the latitude and longitude
coordinates.
Beach Notification Database User Guide
December 23, 2011
45
-------
Data Element
Description
Example:
Short Description.
XML Tag Name
BeachCoordinateDescr
iptionText
XML Data
Type
STRING
Req'd
(Y/N)
N
Length
255
Access Table Mapping
BEACH LATITUDE LONGITUD
E COORDINATES.DESCRIPTI
ON
Comment
This is an optional field that can be used to
store other information about the particular
beach's coordinates.
Beach Notification Database User Guide
December 23, 2011
46
-------
3.1.8 Year Completion Indicators
The Year Completion Indicators section of the XML submission allows submitting states to notify the EPA when they have finished
submissions for the year. This section includes data elements, such as Notification Data Complete Indicator, Monitoring Data
Complete Indicator, and Location Data Complete Indicator. These data elements will be included in the XML file when states wish to
notify that the EPA that they have finished submitting data for the year.
NOTE: To generate a submission with the Notification Access database with year completion information, you can now use the
Custom XML Generation form. This includes end of year completion information with your normal xml submission. There are no
tables to fill out to generate this submission.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/YearCompletionlndicators/".
Beach Notification Database User Guide December 23, 2011
47
-------
Exhibit 3-8 Organization Information Schema
Data Element
Completion Year
Example: 2007
Notification Data
Completion Indicator
Example: Y
Monitoring Data
Completion Indicator
Example: Y
Location Data
Completion Indicator
Example: Y
XML Tag Name
CompletionYear
NotificationDataCompletio
nlndicator
MonitoringDataCompletion
Indicator
LocationDataCompletionln
dicator
XML Data
Type
NUMBER
BOOLEAN
BOOLEAN
BOOLEAN
Req'd
(Y/N)
N
N
N
N
Length
4
N/A
N/A
N/A
Access Table Mapping
N/A
N/A
N/A
N/A
Comment
This value is required if any year completion data
is included in the XML data file.
This value indicates what year the data has been
submitted for.
This can be created using the End Of Year
Submission Generation form.
This value indicates whether or not the Notification
data has all been submitted for the calendar year.
This can be created using the End Of Year
Submission Generation form.
This value indicates whether or not the Monitoring
data has all been submitted for the calendar year.
This can be created using the End Of Year
Submission Generation form.
This value indicates whether or not the Location
data has all been submitted for the calendar year.
This can be created using the End Of Year
Submission Generation form.
Beach Notification Database User Guide
December 23, 2011
48
-------
3.1.9 Beach Procedure Information
The beach procedure section of the XML submission contains data related to the procedures used by beaches for monitoring,
notification, issuance, and reopening. This section includes data elements, such as procedure type code, procedure description text,
and procedure identifier. These data elements will be included in the XML file when beach procedure information needs to be added
or updated in the PRAWN database.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/BeachDetail/BeachProcedureDetail/".
Beach Notification Database User Guide December 23, 2011
49
-------
Exhibit 3-9 Beach Procedure Information Schema
Data Element
Procedure Type
Code
Example:
IA_RADIO
Procedure
XML Tag Name
ProcedureTypeCode
ProcedureDescriptionT
Description Text ext
Example:
Announce the
advisory on the
local radio station
Procedure
Identifier
Example:
675849302019
Procedure Beach
Procedureldentifier
ProcedureBeachldentif
XML Data
Type
STRING
STRING
STRING
STRING
Identifier ier
Example:
ME234898
Req'd
(Y/N)
Y
Y
Y
Y
Length
12
255
12
12
Access Table Mapping
PROCEDURE.PROCEDURE C
ODE
PROCEDURE.DESCRIPTION
PROCEDURE.ID
BEACH_PROCEDURE_ASSIG
Comment
This value must be set to a valid procedure
type code. See Appendix C fora list of valid
codes.
This value is required if any beach
procedure information is included in the
XML data file.
This value is required if any beach
procedure information is included in the
XML data file.
Submitting organizations will need to
maintain a list of valid Procedure Identifiers
for all procedures that are stored in the
PRAWN database. These identifiers must
be unique within each organization, as they
will be used to update organization-level
data. (For example, with an organization
there can only be 1 procedure identified as
"AB123", but there could be another
procedure identified as "AB123" in another
organization.)
This value must correspond to EITHER a
N.FK_BEACH_ID valid Beach Identifier and/or a valid
Program Interest Identifier in the XML file or
in the PRAWN database.
Any number of Procedure Beach Identifiers
may be submitted (consecutively in the
XML file) to associate many beaches
and/or program interests to a single
procedure.
Beach Notification Database User Guide
December 23, 2011
50
-------
3.1.10 Header Information
The header information section of the XML file contains information regarding the data submission, such as submission date,
submitting user, and submitting agency These keys should not be included in the XML file submitted by the submitting agency.
Instead, once an XML file has been successfully submitted to CDX, these XML keys will be added to the file by the CDX web
application.
All XML elements in this section are located in the following position on the XML element hierarchy—
"BeachDataSubmission/HeaderDetail/".
Beach Notification Database User Guide December 23, 2011
51
-------
Exhibit 3-10 Hearder Information Schema
Data Element
XML Tag Name
XML Data
Type
Req'd
(Y/N)
Length
Access Table Mapping
Comment
Submitting Agency
Identifier
Example: KYDEP
SubmittingAgencyldentifier STRING Y
12
This key will be inserted into the file by the
CDX web application.
The list of valid Submitting Agency
Identifiers will be maintained as part of the
CDX registration process.
Submitting User
Identifier
Example: BSMITH
SubmittingUserldentifier STRING Y
12
This key will be inserted into the file by the
CDX web application.
The list of valid Submitting User Identifiers
will be maintained as part of the CDX
registration process.
Submission
Identifier
Example:
111111111111
Submissionldentifier
STRING Y
12
Submission Date
Example: 2003-01-
01TOO:00:00
Submission Date
DATE
This key will be inserted into the file by the
CDX web application.
This value will uniquely identify each
submission and will be generated by the
CDX web applicatioji.
This key will be inserted into the file by the
CDX web application.
The date should be entered in the XML
file in the following format: YYYY-MM-
DDTHH:MI:SS
Beach Notification Database User Guide
December 23, 2011
52
-------
3.2 Use of Effective Date and Status Indicator Data Elements
The Effective Date and Status Indicator data elements are used to set the effective dates in the PRAWN database for mailing
addresses, electronic addresses, telephone numbers, beach/person roles, and beach/organization roles. For each of these types of data,
the PRAWN database tracks the Start Date and Stop Date. For example, the database may track that a fax telephone number was valid
starting on January 1, 2001. If this telephone number was updated and the new fax number was valid on July 1, 2001, a new record is
added in the database with a Start Date of July 1, 2001 and the same date is added as the Stop Date for the previous telephone number.
To set this information correctly, the XML schema uses two data elements—Effective Date and Status Indicator—with mailing
address, electronic address, telephone, beach/person role, and beach/organization role data. Furthermore, the user must specify the
appropriate Type Code value (e.g., "FAX", VOICE", etc. for telephone number) so that the correct address, telephone number,
beach/person role, or beach/organization role is updated.
To update these types of data, these three data elements should be populated as follows:
• To update an address, electronic address, telephone number, beach/person role assignment, or beach/organization assignment, the
Effective Date and Status Indicator fields should be set as follows:
o Effective Date should be set to the date on which the new address, telephone number, or assignment will become valid.
o Status Indicator should be set to "ACTIVE".
o Type Code should be set to the type of information to be updated. (For example, this might be set to "STATE" for
BeachRoleTypeCode.)
o This will update the Stop Date for the current data and will create a new record with the updated data and the associated Start
Date.
• To indicate that an address, electronic address, telephone number, beach/person role assignment, or beach/organization assignment is no
longer valid and there is no replacement data, the Effective Date and Status Indicator fields should be set as follows:
o Effective Date should be set to the date on which the address, telephone number, or assignment will become invalid.
o Status Indicator should be set to "INACTIVE".
o Type Code should be set to the type of information to be updated. (For example, this might be set to "SHIPPING" for
MailingAddressTypeCode.)
This will update the Stop Date for the current data but will not create a new record, since there is no new data.
Beach Notification Database User Guide December 23, 2011
53
-------
How to Decode the Error Messages
This chapter provides detailed information regarding the error messages that may be produced during data transfer. This chapter
assumes that the XML submission has passed XML schema validation before being processed by the data loading software.
This section describes system generated error messages associated with the validation and loading of National Beach Program data to
the PRAWN database. The following table details the specific error codes and messages that may be produced during data loading and
provides a short description of each error and appropriate corrective actions. It should be noted that error messages will be followed by
XML tag value(s) to describe the location in the XML document where the error occurred. For instance, the error message
'OrganizationName is required for adding/editing an Organization' would be followed by the text' [Organizationldentifier = X]'
where 'X' is the identifier for the Organization where the error occurred.
All errors encountered during the processing and loading of an XML data submission will be written to an Error Log File that can be
sent to CDX and used for reporting feedback to data submitters. In addition to PRAWN system generated errors, Oracle specific error
messages will also be written to this file (see Section 4.3 for more information).
Exhibit 4-1 PRAWN Error Messages
Error Code
BCH-0101
BCH-0102
BCH-0103
BCH-0201
BCH-0202
BCH-0301
Error Message
Organizationldentifier must be unique for adding an
Organization to the PRAWN system.
[Organizationldentifier = 'X']
Organizationldentifier not found in the PRAWN system.
[Organizationldentifier = 'X']
OrganizationTypeCode is invalid. [Organizationldentifier =
'X'; OrganizationTypeCode ='X']
Personldentifier must be unique within an Organization.
[Organizationldentifier = 'X'; Personldentifier = 'X']
Personldentifier not found within the specified
Organization. [Organizationldentifier = 'X'; Personldentifier
= 'X]
MailingAddressTypeCode is invalid. [Organizationldentifier
= 'X'; MailingAddressTypeCode = 'X'j
Description/Corrective Action
All new Organization records must have a previously unused value for
Organization Identifier in the PRAWN system. Confirm that you are using
the assigned Organizationldentifier.
You are attempting to edit a record that does not exist. Please confirm that
you have entered the correct Organization Identifier for the record you are
attempting to edit or change OrganizationTransactionType to add if you
wish to create a new Organization record.
A value unknown to the PRAWN system has been submitted for
OrganizationTypeCode. Please see Chapter 3 for a list of valid values.
All new Person records must have a value for Person Identifier that is
previously unused by the referenced Organization in the PRAWN system.
You are attempting to edit a record that does not exist within the specified
Organization. Please confirm that you have entered the correct Person
Identifier for the record you are attempting to edit or change
PersonTransactionType to add if you wish to create a new Person record.
A value unknown to the PRAWN system has been submitted for
MailingAddressTypeCode. Please see Chapter 3 for a list of valid values.
Beach Notification Database User Guide
December 23, 2011
54
-------
Error Code
BCH-0302
BCH-0303
BCH-0401
BCH-0501
BCH-0502
BCH-0601
BCH-0602
BCH-0603
BCH-0604
BCH-0605
BCH-0606
BCH-0607
BCH-0608
Error Message
MailingAddressStateCode is invalid.
[Organizationldentifier = 'X'; MailingAddressStateCode =
'X']
MailingAddressZipCode is invalid. [Organizationldentifier
= 'X'; MailingAddressZipCode = 'X']
ElectronicAddressTypeCode is invalid.
[Organizationldentifier = 'X'; ElectronicAddressTypeCode
= 'X]
TelephoneNumber is invalid. [Organizationldentifier = 'X';
TelephoneNumber = 'X']
TelephoneTypeCode is invalid. [Organizationldentifier =
ProgramlnterestStateCode is invalid. [Beachldentifier =
'X; ProgramlnterestStateCode ='X']
Beachldentifier must be unique for adding a Beach to the
PRAWN system. [Beachldentifier -X]
Beachldentifier registered but not previously submitted to
the PRAWN system. [Beachldentifier = 'X;
BeachNameTransactionTypeCode = 'X']
Beachldentifier not registered with EPA. [Beachldentifier =
'X]
ProgramlnterestFIPSCountyCode is invalid.
[Beachldentifier = 'X'; ProgramlnterestFIPSCountyCode =
'X]
WaterBodyNameCode cannot be combined with
WaterBodyTypeCode. [Beachldentifier = 'X';
WaterBodyNameCode = 'X; WaterBodyTypeCode = 'X']
Beach Extent/Swim Season/Monitoring Frequencies
already defined for the year on beach. [Beachldentifier =
'X; AttributeEffectiveYear = 'X]
IndicatorName is invalid. [Beachldentifier = 'X']
Description/Corrective Action
MailingAddressStateCode must be a valid 2-digit State Postal Code (such
as CA for California). Confirm that you are using a valid state code.
Provide a MailingAddressZipCode in one of the following numeric formats:
or
//////// It-!/ //////
A value unknown to the PRAWN system has been submitted for
ElectronicAddressTypeCode. Please see Chapter 3 for a list of valid values.
Provide a TelephoneNumber in one of the following alphanumeric formats:
XXX-XXX-XXXX
A value unknown to the PRAWN system has been submitted for
ProgramlnterestStateCode must be a valid 2-digit State Postal Code (such
as CA for California). Confirm that you are using a valid state code.
All new Beach records must have a previously unused value for Beach
Identifier in the PRAWN system. Confirm that you are using the assigned 8-
digit Beachldentifier.
You are attempting to edit a record that does not exist. Please confirm that
you have entered the correct Beach Identifier for the record you are
attempting to edit or change Beach Transaction Type Code to add if you
wish to create a new Beach record.
You are attempting to submit notification data for a beach with an identifier
that has not been assigned by EPA. Contact your EPA beach coordinator
for the appropriate beach identifier.
ProgramlnterestFIPSCountyCode must be valid 5-digit FIPS County Code.
Confirm that you are using a valid code, and that it matches the two letter
State code submitted as ProgramlnterestStateCode.
The Waterbody Name Code submitted for the beach must correspond to an
acceptable Waterbody Type Code. Please see Chapter 3 for acceptable
matches (e.g., a Name of INLAND may only have a Type of STILL WATER
or FLOW WATER).
The Beach Attribute information (Beach Extent/Swim Season/Monitoring
Frequencies/Beach Tier/Pollution Source) you have submitted already
exists for that particular beach, for that particular year. Please either revise
the Attribute Effective Date to the appropriate year, or contact the EPA
Beach program manager to ensure the proper information is stored in the
PRAWN system.
A value unknown to the PRAWN system has been submitted for
IndicatorName. Please see Chapter 3 for a list of valid values.
Beach Notification Database User Guide
December 23, 2011
55
-------
Error Code
BCH-0609
BCH-0610
BCH-0611
BCH-0701
BCH-0702
BCH-0703
BCH-0704
BCH-0705
BCH-0706
BCH-0801
BCH-0802
BCH-0803
Error Message
WaterTypeName is invalid. [Beachldentifier = 'X']
MeasureTypeName is invalid. [Beachldentifier = 'X']
MeasureUnitCode is invalid. [Beachldentifier = 'X']
ActivityTypeCode is invalid. [Beachldentifier = 'X';
ActivityName = 'X'; ActivityTypeCode = 'X']
ActivityMonitoringStationldentifer not found in the
STORE! system. [Beachldentifier = 'X'; ActivityName =
'X; ActivityMonitoringStationldentifier = 'X']
Activities with elevated bacteria (ELEV_BACT) as reasons
must have at least one valid STORE! Station ID.
[Beachldentifier = 'X'; ActivityName = 'X']
Activity Reason/Source/Indicator Description must be
included if Activity Reason/Source/Indicator Code is
OTHER. [Beachldentifier = 'X; ActivityName = 'X]
ActivityActualStartDate year does not match year of
ActivityActualStopDate. [Beachldentifier = 'X';
ActivityName = 'X; ActivityActualStartDate = 'X;
ActivityActualStopDate = 'X']
ActivityActualStopDate occurs prior to
ActivityActualStartDate. [Beachldentifier = 'X;
ActivityName = 'X; ActivityActualStartDate = 'X;
ActivityActualStopDate = 'X']
BeachRoleTypeCode is invalid. [Beachldentifier = 'X';
BeachRoleOrganizationldentifier = 'X';
BeachRoleTypeCode = 'X']
BeachRoleOrganizationldentifier not found in the PRAWN
system. [Beachldentifier = 'X';
BeachRoleOrganizationldentifier = 'X']
BeachRolePersonldentifier not found in the PRAWN
system. [Beachldentifier = 'X';
BeachRoleOrganizationldentifier = 'X';
BeachRolePersonldentifier = 'X']
Description/Corrective Action
A value unknown to the PRAWN system has been submitted for
WaterTypeName. Please see Chapter 3 for a list of valid values.
A value unknown to the PRAWN system has been submitted for
MeasureTypeName. Please see Chapter 3 for a list of valid values.
A value unknown to the PRAWN system has been submitted for
MeasureUnitCode. Please see Chapter 3 for a list of valid values.
A value unknown to the PRAWN system has been submitted for
ActivityTypeCode. Please see Appendix B for a list of valid values.
You are attempting to submit a monitoring station ID that has not been
registered with STORET. Check the validity of the Station ID and if valid,
ensure is has been registered as a monitoring station in STORET. Contact
your EPA beach coordinator for further information.
You are attempting to report a notification activity based on elevated
bacteria levels without submitting a valid STORET Station ID. Each activity
with a Reason Type Code of 'ELEV_BACT' must have at least one
Monitoring Station ID.
You are attempting to submit either a Reason, a Source, or an Indicator for
an activity labeled with type 'OTHER' without submitting a description for
the Reason, Source, or Indicator.
You are attempting to submit an Activity that is spanning multiple years.
Activities may only be submitted for one year at a time. Should an activity
actually go on for more than one year, it is required that the initial activity
end on December 31st 11:59:59pm of the current year and a new activity
start again on January 1st 12:00:00am of the next year.
You are attempting to submit an Activity whose stop date occurred before it
was started. Please correct the dates so the stop date is after the start date.
A value unknown to the PRAWN system has been submitted for
BeachRoleTypeCode. Please see Chapter 3 for a list of valid values.
You are attempting to associate a role with an Organization that does not
exist in the PRAWN system. Please confirm that you have entered the
correct Organization Identifier and that the information for that Organization
has been previously submitted and successfully processed by the PRAWN
system.
You are attempting to associate a role with a person that does not exist in
the PRAWN system. Please confirm that you have entered the correct
Person Identifier and that the information for that Person has been
previously submitted and successfully processed by the PRAWN system.
Beach Notification Database User Guide
December 23, 2011
56
-------
Error Code
BCH-0804
BCH-0901
BCH-0902
BCH-0903
BCH-0904
Error Message
BeachRolePersonldentifiercannot be assigned a role on a
beach without a role assignment for the person's parent
organization on the same beach. [Beachldentifier = 'X';
BeachRoleOrganizationldentifier = 'X';
BeachRolePersonldentifier = 'X']
Procedureldentifier must be unique for adding a
Procedure to the PRAWN system. [Procedureldentifier =
'X]
Procedureldentifier not found in the PRAWN system.
[Procedureldentifier = 'X]
ProcedureTypeCode is invalid. [Procedureldentifier = 'X';
ProcedureBeachldentifier not found in the PRAWN
system. [Procedureldentifier = 'X;
ProcedureBeachldentifier = 'X']
Description/Corrective Action
You are attempting to associate a Person with a Beach without having
associated that Person's Organization to the beach. Please check that the
Organization Role Information precedes the Person Role Information in the
XML file.
All new Procedure records must have a value for Procedure Identifier that is
previously unused by the referenced Organization in the PRAWN system.
To update an existing Procedure, including assigning more beaches to the
Procedure, change the ProcedureTypeCode to 'EDIT'.
You are attempting to edit a record that does not exist. Please confirm that
you have entered the correct Procedure Identifier for the record you are
attempting to edit or change ProcedureTransactionType to add if you wish
to create a new Procedure record.
A value unknown to the PRAWN system has been submitted for
You are attempting to associate a procedure with a beach that does not
exist in the PRAWN system. Please confirm that you have entered the
correct Beach Identifier and that the information for that Beach has been
previously submitted and successfully processed by the PRAWN system.
4.2 Common Causes of Error Messages
When troubleshooting an error log returned by the PRAWN system, please refer to the following chart for help with some of the most
common errors (full-text error messages can be found in section 4.3). If the error is not resolved following the suggestions below,
please contact ebeaches@cgifederal.com.
Exhibit 4-2 Common Error Messages
Error Code
BCH-0101
BCH-0102
BCH-0103
Troubleshooting Tip
Please check the value of the OrganizationNameTransactionTypeCode tag (ORGANIZATION. TRANSACTION in the Notification
Access Database). Generally, this error occurs if the related Organizationld already exists in PRAWN and has been submitted
with an OrganizationNameTransactionTypeCode of ADD.
Please check the value of the OrganizationNameTransactionTypeCode tag (ORGANIZATION. TRANSACTION in the Notification
Access Database). Generally, this error occurs if the related Organizationld does not yet exist in PRAWN and has been submitted
with an OrganizationNameTransactionTypeCode of EDIT.
Please check the value of the OrganizationTypeCode tag (ORGANIZATION. ORGAN IZATION_CODE in the Notification Access
Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate Organization Type
(most often 'STATE_AGENCY' is input instead of 'STATE_AGNCY', which is the correct value). Please see Chapter 3 for
additional information.
Page(s)
N/A
N/A
8
Beach Notification Database User Guide
December 23, 2011
57
-------
Error Code
BCH-0201
BCH-0202
BCH-0301
BCH-0302
BCH-0303
BCH-0401
BCH-0501
BCH-0502
BCH-0601
BCH-0602
BCH-0603
Troubleshooting Tip
Please check the value of the PersonNameTransactionTypeCode tag (PERSON. TRANSACTION in the Notification Access
Database). Generally, this error occurs if the related Personld already exists in PRAWN and has been submitted with an
PersonNameTransactionTypeCode of ADD.
Please check the value of the PersonNameTransactionTypeCode tag (PERSON. TRANSACTION in the Notification Access
Database). Generally, this error occurs if the related Personld does not yet exist in PRAWN and has been submitted with an
PersonNameTransactionTypeCode of EDIT.
Please check the value of the MailingAddressTypeCode tag (MAILING_ADDRESS.MAILING_ADDRESS_CODE in the
Notification Access Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate
Mailing Address Type. Please see 3 for additional information.
Please check the value of the MailingAddressStateCode tag (MAILING_ADDRESS.STATE_POSTAL_CODE in the Notification
Access Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate the correct
state. Please confirm that a valid state code is being used.
Please check the value of the MailingAddressZipCode tag (MAILING_ADDRESS.ZIP_CODE in the Notification Access
Database). Generally, this error is the result of an incorrectly formatted Zip Code. The correct formats are either '//////////' (ZIP) or
'I/I/I/I/I/ II II II II' pIP+l) Please °ee 3 for additional information
Please check the value of the ElectronicAddressTypeCode tag (ELECTRONIC_ADDRESS.ELECTRONIC_ADDRESS_CODE in
the Notification Access Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate
Electronic Address Type Please see Chapter 3 for additional information.
Please check the value of the TelephoneNumbertag (TELEPHONE. TELEPHONE_NUMBER in the Notification Access
Database). Generally, this error is the result of an incorrectly formatted telephone number. The correct format is 'XXX-XXX-
XXXX'. Please see Chapter 3 for additional information.
Please check the value of the TelephoneTypeCode tag (TELEPHONE. TELEPHONE_CODE in the Notification Access
Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate Telephone Type. Please
see Chapter 3 for additional information.
Please check the value of the ProgramlnterestStateCode tag (BEACH. STATE_POSTAL_CODE in the Notification Access
Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate the correct state. Please
confirm that a valid state code is being used.
Please check the value of the BeachNameTransactionTypeCode tag (BEACH. TRANSACTION in the Notification Access
Database). Generally, this error occurs if the related Beachld already exists in PRAWN and has been submitted with a
BeachNameTransactionTypeCode of ADD.
Please check the value of the BeachNameTransactionTypeCode tag (BEACH. TRANSACTION in the Notification Access
Database). Generally, this error occurs if the related Beachld has been registered with the EPA, but has not yet been submitted to
PRAWN, and has been submitted with a BeachNameTransactionTypeCode of EDIT.
Page(s)
N/A
N/A
9, 16
9, 16
10, 17
11, 18
12, 19
12, 19
21
N/A
N/A
Beach Notification Database User Guide
December 23, 2011
58
-------
Error Code
BCH-0604
BCH-0605
BCH-0606
BCH-0607
BCH-0608
BCH-0609
BCH-0610
BCH-0611
BCH-0701
BCH-0702
Troubleshooting Tip
Please check the value of the Beachldentifiertag (BEACH. ID in the Notification Access Database). Generally, this error occurs if
the related Beachld has not yet been registered with the EPA, or has been misspelled in the submission.
Please check the value of the ProgramlnterestFIPSCountyCode tag (BEACH. FIPS_COUNTY in the Notification Access
Database). Generally, this error is the result of a misspelling in the standard 5-digit FIPS County Code. Please confirm that the
correct FIPS Code is being used.
Please check the value of the WaterBodyNameCode tag (BEACH. WATERBODY_NAME in the Notification Access Database)
and the WaterBodyTypeCode tag (BEACH.WATERBODY_TYPE in the Notification Access Database). Generally, this error is the
result of a misspelling in of one of the valid values used to indicate Water Body Name or Water Body Type. Please see Appendix
D in the Beach Notification Data User Guide for additional information.
Please check the value of the appropriate tag: ExtentLengthMeasure (BEACH_ATTRIBUTE.EXTENT_LENGTH in the Notification
Access Database), SwimSeasonLengthMeasure (BEACH_ATTRIBUTE.SWIM_SEASON_LENGTH in the Notification Access
Database), SwimSeasonFrequencyMeasure (BEACH_ATTRIBUTE.SWIM_MONITOR_FREQ in the Notification Access
Database), OffSeasonFrequencyMeasure (BEACH ATTRIBUTE. OFF MONITOR FREQ in the Notification Access Database) for
the related year(AttributeEffectiveYear, BEACH_ATTRIBUTE.EFFECTIVE_YEAR in the Notification Access Database). Beach
Attribute data (Beach Extent/Swim Season/Monitoring Frequencies) has already been submitted for this calendar year. If this is
incorrect, or you have questions, please contact eBeaches@cgifederal.com.
Please check the value of the IndicatorName tag (BEACH_ATTRIBUTE_CRITERON. INDICATOR_NAME in the Notification
Access Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate Indicator Name.
Please check Chapter 3 for additional information.
Please check the value of the WaterTypeName tag (BEACH_ATTRIBUTE_CRITERON.WATER_TYPE_NAME in the Notification
Access Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate Water Type
Name. Please check Chapter 3 for additional information.
Please check the value of the MeasureTypeName tag (BEACH_ATTRIBUTE_CRITERON.MEASURE_TYPE_NAME in the
Notification Access Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate
Measure Type Name. Please check Chapter 3 for additional information.
Please check the value of the MeasureUnitCode tag (BEACH_ATTRIBUTE_CRITERON.MEASURE_UNIT_CODE in the
Notification Access Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate
Measure Unit Code. Please check Chapter 3 for additional information.
Please check the value of the ActivityTypeCode tag (BEACH_ACTIVITY.ACTIVITY_CODE in the Notification Access Database).
Generally, this error is the result of a misspelling in of one of the valid values used to indicate Activity Type. Please check Chapter
3 and Appendix B in the Beach Notification Data User Guide for additional information.
Please check the value of the ActivityMonitoringStationldentifiertag (BEACH_ACTIVITY_STATION.STATION_ID in the
Notification Access Database). Generally, this error occurs if the related Stationld has not been properly formatted
("Orgld|Stationld"), has not yet been registered with STORET, or has been misspelled in the submission.
Page(s)
21
22
22
25, 26, 27
3-18
3-18
3-18
3-18
34
38
Beach Notification Database User Guide
December 23, 2011
59
-------
Error Code
BCH-0703
BCH-0704
BCH-0705
BCH-0706
BCH-0801
BCH-0802
BCH-0803
BCH-0804
BCH-0901
BCH-0902
Troubleshooting Tip
Please check the value of the ActivityMonitoringStationldentifiertag (BEACH_ACTIVITY_STATION.STATION_ID in the
Notification Access Database). Generally, this error occurs if the related Stationld has been omitted, but has also been known to
occur if a BCH-0702 error (incorrectly formatted Stationld) has occurred in the same submission.
If the ActivityReasonType (BEACH ACTIVITY REASON. TYPE in the Notification Access Database where
BEACH_ACTIVITY_REASON. CLASS = Reason), ActivitySourceType (BEACH_ACTIVITY_REASON.TYPE in the Notification
Access Database where BEACH ACTIVITY REASON. CLASS = Source), or ActivitylndicatorType
(BEACH_ACTIVITY_REASON.TYPE in the Notification Access Database where BEACH_ACTIVITY_REASON. CLASS =
Indicator) are equal to OTHER, the corresponding description field must be filled in.
The ActivityActualStartDate (BEACH_ACTIVITY.ACTUAL_START_DATE in the Notification Access Database) year does not
match the ActivityActualStopDate (in the Notification Access Database) year. Activities can only occur during one calendar year.
In the event that an event does cross into another year, it must be split into two activities, one for each year.
ActivityActualStartDate (BEACH_ACTIVITY.ACTUAL_START_DATE in the Notification Access Database) occurs after the
ActivityActualStopDate (in the Notification Access Database). The order of these dates must be reversed in order to achieve a
successful submission.
Please check the value of the BeachRoleTypeCode tag (BEACH_ORGANIZATION_ROLE_ASSIGN.ORG_ROLE_CODE and
BEACH_PERSON_ROLE_ASSIGN.PERSON_ROLE_CODE in the Notification Access Database). Generally, this error is the
result of a misspelling in of one of the valid values used to indicate Beach Role Type. Please check Chapter 3 in the Beach
Notification Data User Guide for additional information.
Please check that the Organizationldentifier (ORGANIZATION. ID in the Notification Access Database) has already been
submitted to PRAWN. Generally this error occurs if the Organization in question does not already exist in PRAWN, but has also
been known to occur if BCH-0101, BCH-0102, and/or BCH-0103 errors (related Organizationlds) have occurred in the same
submission.
Please check that the Personldentifier (PERSON. ID in the Notification Access Database) has already been submitted to PRAWN.
Generally this error occurs if the Person in question does not already exist in PRAWN, but has also been known to occur if BCH-
0201 and/or BCH-0202 errors (related Personlds) have occurred in the same submission.
Please check the order of the Organization and Person assignments on a given beach. Persons cannot be assigned a role on a
beach until the Organization they belong to has been assigned a role on that beach.
Please check the value of the ProcedureTransactionTypeCode tag (PROCEDURE. TRANSACTION in the Notification Access
Database). Generally, this error occurs if the related Procedureld already exists in PRAWN and has been submitted with an
ProcedureTransactionTypeCode of ADD.
Please check the value of the ProcedureTransactionTypeCode tag (PROCEDURE. TRANSACTION in the Notification Access
Database). Generally, this error occurs if the related Organizationld does not yet exist in PRAWN and has been submitted with an
ProcedureTransactionTypeCode of EDIT.
Page(s)
38
35, 36, 37
34
34
41
8
15
42
N/A
N/A
Beach Notification Database User Guide
December 23, 2011
60
-------
Error Code
Troubleshooting Tip
Page(s)
BCH-0903
Please check the value of the ProcedureTypeCode tag (PROCEDURE.PROCEDURE_CODE in the Notification Access
Database). Generally, this error is the result of a misspelling in of one of the valid values used to indicate Procedure Type. Please
see Appendix C in the Beach Notification Data User Guide for additional information.
50
BCH-0904 Please check to be sure that the Beachld listed in the ProcedureBeachldentifier tag
(BEACH_PROCEDURE_ASSIGN.FK_BEACH_ID in the Notification Access Database) has been entered into PRAWN.
Generally, this error occurs if the related Beachld has not yet been submitted to PRAWN, but an association between a
procedure and the related Beachld has been submitted.
50
4.3 Oracle Generated Error Messages
In addition to error messages generated by the PRAWN system, it is also possible that Oracle specific errors may occur during XML
processing. These errors would most likely be associated with the administration and maintenance of the Oracle database instance (for
example, exceeding the allocated table space size). Oracle specific errors will be captured by the XML data loading software and
reported in the Error Log File together with the PRAWN system generated errors. Oracle specific errors will be prefixed with the text
'Oracle Error:' and will contain the error message number and text produced by the Oracle database at the time the error occurred.
Beach Notification Database User Guide
December 23, 2011
61
-------
5 How to Understand Beaches that are Similar Points of Access
This chapter provides detailed information regarding similar points of access. This chapter assumes that the XML submission has
passed XML schema validation before being processed by the data loading software.
1. Enter Beach Information and Beach Attribute Information prior to Beach Extent Length, go to step 2.
2. Is this entry a SPA? If yes, you may enter an actual length that does not exceed: 100 ft. If no go to step 3.
3. Enter Beach Extent Length (note: a separate length will be calculated from your L/L data as indexed to the RAD to enable mapping and
for allotment formula calculations.)
4. Enter Swim Season Monitoring Frequency and so on.
Beach Notification Database User Guide December 23, 2011
62
-------
6 Appendix A—Schema Graphics
This appendix provides a graphical representation of the Beaches Notification v2.0 XML Schema. The figures that follow offer an
expanded view of each of the four major sections that comprise a Beach Data Submission (Organization Detail, Person Detail, Beach
Detail, and Beach Procedure Detail).
• Dashed lines represented optional elements, solid lines represent mandatory elements.
o Please note: Empty tags (e.g., ) for optional elements cannot appear in the XML
file.
• The figures O..QO and I..QO mean that the field may be repeated, as long as the repetitions are next to each other, as many times
as the user wishes.
o For example, a user may submit as many BeachDetail sections as necessary in a single file.
o I..QO means that there must be at least one field included and O..QO means the field is entirely optional.
• A + sign at the end of the box means more elements exist under that element.
Exhibit 6-1 Beach Data Submission
-|j,bch: Organization Detail [4]
--|j,bch: Beach Detail £)
Beach Data Submi ssi on "J^l—(-»—)3-H D--<>°
•-lj,bch: Beach Procedure Detail 111
D..ro
- -!j,bch:Year Completion Indicators [4]
Beach Notification Database User Guide December 23, 2011
63
-------
Exhibit 6-2 Organization Detail
~l>ch:Oiy,iniz.it ionklentifiei
^bchiOi ij,iniz,itk>iiN,imeDet,iil [J]
—IjbchiOrganizationTypeCode
—!„ l>ch:0i ganizationllame
- -i ,bcb:OrganizationDescri|>tionText i
I!
- -jjbclvOiganizationAbbieiNationText I
... £j|—[ ••• JEh
—|J,l)ch:MailingA(l(lressTy|)eCo(le
—|~l)ch:
--|Jlbch:Mailin{|Acl(lressStreetLine2..
--^fochiMailingAdiliessStreetLineJ..
—|J,l)cli:M.iilin(jA(l(liessCityll.inie
—l^hchiElectronicAddressTypeCode
OrganizationDetail |j—(——JEH- - -;, l)ch:0i ganizationElectronicAdd... ^ —(——JEH
—\r l>cli:Electi onic Addr essText
O..CO
—|j, l>ch:Electi onicAtltliessEff ectiv e...
—|.,l>cli:ElectionicAcli:Tele|)boiieEffectiMeDate ]
—Ij.bclKTelepboneStatuslndicatoi
Beach Notification Database User Guide
December 23, 2011
64
-------
Exhibit 6-3 Organization Person Detail
Organiziitior>PeriQnCriail
—[fbcll
—jfcfh Fe^on Stylus Indicator ]
—E£l
-:ftt'h":Njr>Vpr«fii(ftJ(t *
1 — [Ib^h; Elodf Ofii
— |jibc-lv
-[;bol-i Mai I irii
—[;bcr.
rtss Postal Code |
— g
Beach Notification Database User Guide
December 23, 2011
65
-------
—{;bch:Beschldertlttier
Exhibit 6-4 Beach Name Detail
—|;bch: Program Interest Name [
—l^boh: Program Interest Descri pti Q ... |
- ijbch: Program Interest Comment...
—|^boh: Program Interest State Code |
—IfbEhiProgramlnterestFIPSCQun..-
—| ,boh iBeashtecessibilityDetail 1^1
'- !jbch:Beachfccessibi I ityComment !
Beach Notification Database User Guide
December 23, 2011
66
-------
Exhibit 6-5 Beach Attribute Detail
—|,,l>ch;BeachSwiniSeasQiiLenatli...
- Jtf IKh:Re|>oi tiiKjFi equencyDetail Ejjj [ •-- J3—
bch:Atti ibiiteEffectiveYear
—l^bchiSwimSe
—fchcteSwimSe
—|]|l)ch:SwimSe,isonStflitDate ,
—fchchiSwimSeasonEinlDate
— l^h
i e<|uencyMeasui e
—|J,l>ch:Re|>oitinf...
— j^hchrMo
l g - [ ••• J3~
— |J,l>c
h:BeachPolkitionSQurceDetJil|
—l^h
;bch:BeachActBeachlndicatoi
jKh:Be,H:h(>oim->htliich:BeachCriterionDetail j
O..QD
bch:Be,ichPollirtionSouiceCo(le
f bch:Monitoi inch:BeiichWel>site !
--|~l>ch:CiiteiionCommeirt ;
Beach Notification Database User Guide
December 23, 2011
67
-------
Exhibit 6-5 Beach Activity Detail
I Beach Detail Q
—fcbch: Beach Identiti er]
-|.»bch: Beach Name Detail tj]
-;/bch:Beach«tribute Detail
--!,,bch: Beach Role Detail
- - - - - - - - - - - - - - - - -
&>ch:fclivilytelu3l Start Date |
i -.
- Ijbch ^diuilylto^iarif>9$tyionl
V%^.1i%'i %-.-.% % -» ^. -. -. -. '. -. % -. -. -. -B ", n
0
;.bch:AdiMlyEi(tenl Detail
--|};beh: Activity Extent Start Measure !
[jjbch:tetiuityEKtent Length Measure |
IJbch :teti vi ty Extent Unit CT Measu ."~~|
Beach Notification Database User Guide
December 23, 2011
68
-------
Exhibit 6-6 Beach Role Detail
| Beach Petal l~|]—[-—)3-
—fcbch: Beach Identif I er|
•^bch: Beach Name Detail Ep
- |;bch: Beach.<*tri bute Detai I \±\
-|^bch:BeachMivityDetail lil
-_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -v-T' i
D..05
— fcbch: Beach RoleType Code |
— l^bchiBeachRoleQrganigatiQnld...
: Beach Rol e Detai I p —(-"—)3—[• - l^bch: Beach Rol e Person kdentifi_er |
p-_-_-^-_-_-_-^-_-_-_-^-_-_^^.
: Beach Role Effective Date
|
—l^bch: Beach Role Status Indicator
Beach Notification Database User Guide
December 23, 2011
69
-------
Exhibit 6-7 Beach Coordinate Detail
g]
Beach Notification Database User Guide
December 23, 2011
70
-------
Exhibit 6-8 Beach Procedure Detail
--'j,bch: Beach Detail
'.-_-_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_ -_-
O..K
Beach Data Submission ij—{ ••• JE1-
-',bch: Organization Detail 0
'_____ _______________ I
•-!j,bch: Beach Procedure Detail 1=1—(-»*«-)=l—
D..K.
-|^bch:PrQcedureTypeCode |
-|^bch: Procedure Descri pti onText
: Procedure Identif i er
: Procedure Beach Identifier [1
1..B
-!j,bch: Year Completion Indicators
Beach Notification Database User Guide
December 23, 2011
71
-------
Exhibit 6-9 Year Completion Indicators
Beach Data Submission Ep-
l (3
---v>"
O.JB
0
- :^t>ch eiichff o
• •jbehrMonitoring Data Complete!...
•5bch:LocationDataCompletelnd... j
Beach Notification Database User Guide
December 23, 2011
72
-------
7 Appendix B—Example XML File
The following is text from an example XML file that would be sent to PRAWN from a State. The file appears with spacing to provide
a more clear view of the data. The spacing is not required or standard.
234 9fwe
PRIVATE
Tested
Testeddesc
TD
MAILING
123 Long Drive
Suite 534
The Last Stop
Testerville
"^StcitsCods ^"VA"^ / StcitsCods^*
45387
2002-05-05T12:00:00-05:00
ACTIVE
EMAIL
my@my.com
2001-01-01TOO:00:00
ACTIVE
VOICE
123-456-7890
2001-01-01TOO:00:00-05:00
ACTIVE
9e8ef7
ACTIVE
Johnny
Jones
J
Jr
Mr.
Beach Notification Database User Guide December 23, 2011
73
-------
MAILING
830 My Drive
Suite 223
The last row
The Big House
VA
27886
2001-01-01T12:00:00-05:00
ACTIVE
EMAIL
agnes.flemming@vdh.Virginia.gov
2001-01-01T12:00:00-05:00
ACTIVE
VOICE
617-254-0845
2001-01-01TOO:00:00
ACTIVE
Johnny
Jones
Tested
617-254-0845
my@my.com
394e785
LOCAL GOV
testing
testingdesc
T
foi34eO
ACTIVE
Chris
Johnson
Manager
Beach Notification Database User Guide December 23, 2011
74
-------
JH
ACTIVE
Jill
Holander
EMAIL
my@my.com
2001-01-01TOO:00:00
ACTIVE
AK162093
Demo Beach
For Demonstration
Delete this record.
NV
21000
ATLANTIC
OPEN COAST
PUB_PUB_ACC
Test Comment.
2002
28 . 45
MK/ExtentUnitOfMeasureCode>
2001-05-OK/SwimSeasonStartDate>
2001-09-30
|