*2 J— 1_ t I n-it.-f.jn t-i--. j-t. -Ira jn.
fcnwironmentat iiitormaion
Chesapeake Bay
Non Point Source Best Management Practices
Flow Configuration Document
Version 1.1
January 24,2006
1
-------
Change History
Version
Date
Revision Description
1.0
September 21, 2005
First draft
1.1
November 9, 2005
Final Draft
Changed Title Page to include NEIEN and CBPO logos
Change BMPFuIIRefresh to GetBMPFul/Refresh throughout
document.
Merge Appendix B into section 1.2
Rename Appendix D Date Exchange Template to
Appendix C NPS BMP Data Model
Change BMP to NPS BMP throughout document
Change IPT to Technical Team throughout document
Change all references of'monthly' refreshes to 'quarterly'
1.1
Change second sentence to read: Three states
and the Chesapeake Bay Program Office (CBPO)
are now pursuing exchanges of NPS BMP data
using the CBPO's Vortex (assembler of data sets
for the CBPO model), and similar systems in those
states.
Add Vortex as last word of first bullet
Change second bullet to read: To integrate NPS
BMP records across the states for use at CBPO.
Change first sentence of last paragraph to read:
The success or failure of the regional exchange
hinges on implementing the first flow.
2.1 Changed '...informal structural exchanges...' in first
sentence to '...informal annual exchanges...'
2.1.1 Rephrased Paragraphs 1 and 2
2.1.3 Rename Section "Formatting the VI.0 Schema"
Figure 2 Changed BMPAddUpdate to GetBMPFullRefresh
2.2.4 Removed Last Paragraph
3.1.1 Wordsmith 'other universe' references
4.0 "NPS BMP Processing" renumber to 3.1.3
4.0 Change second sentence of first paragraph to read:
"All partners agree that under future funding, the Data
Services may be expanded..."
4.1 Change all references to GetBMPByStateld to
GetBMPFullRefresh
5.1 - Change second paragraph to read: The CBPO team
prepares a document that explains any data or formatting
errors found with the files.
Change reference to CDX to read: NAAS (via CDX)
Change wording of some of the past issues to
better reflect problem and specify how CBPO will
handle in it's flow
2
-------
Changed VADCR Data from 'Oracle' to 'MySQL' in Figure 3
5.2.3 Modified paragraph to include XML file vs. DB access
5.3 Added 'GetBMPbyType
Updated all table and figure numbers and ensured proper
references for tables, figures and sections.
Added signature page
1.1
January 24, 2006
Final
3
-------
Acknowledgements:
List of Technical Team Members
Name
Affiliation
Brian Burch
Chesapeake Bay Program Office
Jennifer Gumert (Chair)
Pennsylvania Department of Environmental Protection
Marc Chambers
Virginia Department of Environmental Quality
Karl Huber
Virginia Department of Conservation Resources
Ming Jiang
Maryland Department of Environment
Dudley Hackett
Pennsylvania Department of Environmental Protection
Phani Eturu
Virginia Department of Environmental Quality
Robin Pellicano
Maryland Department of Environment
Debra Ness
Pennsylvania Department of Environmental Protection
Connie Dwyer
U.S. Environmental Protection Agency
-------
PURPOSE of this Document
The purpose of this document is to broadly define the Chesapeake Bay Program Office Non
Point Source (NPS) Best Management Practices (BMPs) data flow configuration.
APPROVAL OF THE Flow Configuration Document:
Signatory- Nancie Imler, Information Management Subcommittee, Chair
Signatory- Brian Burch, Chesapeake Bay Program Office, Data Center Manager
Signatory- Jennifer Gumert, PA Department of Environmental Protection, Network Node
Manager
Signatory- Karl Huber, VA Department of Conservation and Recreation, GIS/Data Center
Manager
Signatory- Ming Jiang, MD Department of Environment, Network Node Manager
5
-------
Table of Contents
1.0 Purpose 8
1.1 Background and History on the Chesapeake Bay Program 8
1.2 Caveats and Looking Ahead 9
1.3 Components of the Chesapeake Bay Network Exchange 10
2.0 Chesapeake Bay Network Exchange Components 12
2.1 Overview of the NPS BMP Flow Issues and Options 12
2.1.1 Establishing the Network Exchange 12
2.1.2. Identifying Changed NPS BMP Data: GetBMPByChangeDate 13
2.1.3 Formatting The VI.0 Schema 13
2.1.4 Business Rules by Payload Operations 13
2.2 Using the Exchange Network Document (Header) to Package NPS BMP Data 13
2.2.1 Exchange Network Document and Payload Parameters and Allowable Values 14
2.2.2 Header Structure 15
2.2.3 Payload Structure 15
3.0 Configurations for the NPS BMP Exchange Flows 19
3.1 NPS BMP Exchange Flows: GetBMPFullRefresh 19
3.1.1 Overview 19
3.1.2 GetBMPFullRefresh Configuration Details 19
3.1.3 NPS BMP Processing 20
4.0 Data Services 21
4.1 Query{GetBMPFullRefresh} 21
4.2 Data Services Schema 21
5.0 NPS BMP Processing, Feedback and Data Services 22
5.1 Processing 22
5.2 Feedback and Messaging 25
5.2.1 Request Credentials 25
5.2.2 Receive Token 25
5.2.3 Pass Token and Solicit 25
5.2.4 Validate Token 25
5.2.5 Validation received 25
5.2.6 Execute Solicit 25
5.2.7 Return Data 25
5.2.8 GetStatus 25
5.2.9 Return XML File 26
5.3 Other Services being considered by CBPO 26
Appendices 28
A. NPS BMP Data Model Documentation 29
B. Future Version Data Services 31
C. NPS BMP DATA MODEL 35
D. Simple checklist for implementing the NPS BMP Flow 56
E. ExchangeNetworkDocument Instance File 59
F. Data Services Schema 62
6
-------
List of Tables:
Table 1 Requirements for the NPS BMP Exchange Flows 12
Table 2 Flow and Payload Operations Overview 12
Table 3 NPS BMP Business Rules 13
Table 4 Header and Payload: Allowable Values 14
Table 5 GetBMPFullRefresh Configuration 20
Table 6 GetBMPFullRefresh Configuration Detail 21
List of Figures:
Figure 1 Components of the Chesapeake Bay Network Exchange 11
Figure 2 Exchange Network Document Structure 15
Figure 3 CBPO NPS BMP Data Flow Diagram 26
7
-------
1.0 Purpose
This document describes the recommended approaches for the Network exchange of Non
Point Source (IMPS') Best Management Practices (BMPNPS_BMP) Non Point Source (NPS)
data. The state/EPA BMPNPS BMP Integrated Project Team (BMfiNPS BMP Technical Team)
developed the approach and specific options documented within this document through
regular meetings and test implementations over the course of many months. The BMPNPS
BMP Technical Team will revise this document periodically to incorporate new information
gained from these exchanges and to include suggested improvements as suggested by new
Flow implementations.
1.1 Background and History on the Chesapeake Bay
Program
Over the last four decades both EPA and states have worked to improve their integration of
environmental data, generally beginning with the Facility Registry System. Three states
and the Chesapeake Bay Program Office (CBPO) are now pursuing exchanges of BMPNPS
BMP data using the CBPO's BMPVortex (assembler of data sets for the CBPO model").
System (BMPS), and similar systems in those states. The Chesapeake Bay States and the
CBPO are pursuing these cross-agency and cross-system BMPNPS BMP exchanges for many
reasons:
• to take advantage of investments states have made in BMRNPS BMP data and to
improve the data in the CBPO's BMPVortex. Svotom (BMPS")
•to use CBPO's BMPS investment to improve states' Non Source Point BMP data
• to integrate "kick-start" state BMPNPS BMP integration efforts by using BMPS records
across the states for use at CBPOas a starting point or supplement to state efforts
• to provide BMPNPS BMP data (or data services in Network parlance) to state or CBPO
partners for value-added integration in their own applications and services, which
include:
o other EPA programs
o state partner agencies with shared interests
Network pioneers have developed and piloted many early Exchange Network technologies.
These pilots, while important as testing grounds for the technologies, did not attempt to
unify or standardize flow configuration information.—Without standardization, many Partners
have simply worked individually with various data flows to make the flow work.—This
approach was useful in initiating the implementation of data flows, but it has load to a
proliferation of data flow approaches.—Perhaps most importantly, without a standardized sot
of BMP Data Services^, the essential Network capabilities of the flow, such as small, but
more frequent exchanges, cannot bo demonstrated.
This Network Flow Configuration Document identifies and documents the specific
approaches recommended for this Flow. It is the recommended by the BMPNPS BMP
1 A shared service that uses the Query or Solicit methods to retrieve data based on supplied parameters
from a Network Node.
8
-------
Technical Team that all new implementers of the BMPNPS BMP Network Exchange2 follow
this guidance, and that BMPNPS BMP Network Exchange pioneers transition to the
approaches identified in these recommendations. Agencies interested in establishing a
BMPNPS BMP Network Exchange can view this document as a set of instructions. It will
allow implementers to expect that the core information describing the &MPNPS BMP Network
Exchange will remain stable. Future modifications to this document and the &MP-NPS BMP
Network Exchange are likely to take the form of additions or enhancements. Some of these
are discussed in Section 1.2 and Appendices B.
The success or failure of the regional exchange hinges on implementing the first flow.
BMPNPS BMP information underpins a substantial portion of the data that partners will
exchange. More importantly, the BMPNPS BMP Network Exchange will set precedence for
subsequent flows and contribute to long-term Network sustainability.
1.2 Caveats and Looking Ahead
This document does not describe every possible NPS BMP Network Exchange scenario. The
NPS BMP Technical Team has identified several unresolved issues and focus areas. Some
may be addressed in an immediate follow-on effort to expand Version 1.0 (this version') of
the FCD and some will probably have to wait until sufficient experience actually processing
updates from many states has been compiled. These future functions can be organized as
follows:
¦ Enhancing the NPS BMP Data Services
The Technical Team, in an effort to produce timely documentation, agreed to proceed
with only one data service between the states and the CBPO. but acknowledged that
the CBPO Node mav offer a more robust set of services. These services are essential
to demonstrating the ability of the Network to provide new kinds of data access via
"data service publishing."
¦ Refinements and Minor Additions to the NPS NPS BMP Schema/Format
It is anticipated that there will be reguired changes to the NPS NPS BMP schema.
Rather than noting these changes in a modified version of the FCD. the CBPO will
provide:
; A field for partners to indicate a URL at which additional detail on a NPS BMP
can be found (to support HTML drill through'). This addition allows a very
powerful integration via simple "cross-site linkages" between partner
websites. This can be one of the most simple and visible wavs that the
Network supports integration.
¦ Refinements to NPS BMP Services to Data Partners
As thev become available, more states mav use NPS BMP services a part of their NPS
BMP reconciliation process. Several ideas were considered but deferred for
enhancing these services:
• NPS BMP mav be able to provide more detailed feedback on new data linked
to parent NPS BMP records as that data becomes available.
• NPS BMP mav be able to expose, for use by others, some of the reconciliation
logic it uses to identify candidate duplicate NPS BMP records.
¦ Refinements to the Shared Business Process for NPS BMP Reconciliation
2 The group of data services, flows, and processing feedback that allow the exchange of BMP data
between partners on the Exchange Network.
9
-------
As more experience is gained it mav be useful to further define standard processes
for more advanced NPS BMP exchange and reconciliation processes including:
• Better coordination of beoin and end dates, and what these mean to partners.
• Incorporating a fullv standardized codes list for kev fields (i.e. NPS BMP Type or
Status")
• Identifying a sophisticated error tracking and data checking service - The current
NPS BMP will focus on gross errors and linkages and will provide detailed, record-
bv-record feedback to submitters that mav be further refined in the future.
The BMP Network Exchange is an attempt to do a now thing in a now way.—Given the
complexity and number of interrelationships with other data inherent in—BMP information;
this document does not describe every possible BMP Network Exchange scenario.—The BMP
IPT has identified several unresolved issues and focus areas. A subsequent effort should
address the following:
•Finishing the BMP Data Services—The IPT agreed to proceed with only one data
service (full refresh) (see Appendix C for future services)
•Refinements and Additions to the BMP Data Schema—A field for partners to indicate
a URL at which additional detail on a BMP can bo found (to support HTML drill
through)
•Refining/integrating/coordinating the BMP Network Exchange Business Process3"
•Incorporating a fully standardized codes list for key fields (i.e. BMP Typo or Status)
•Identifying a sophisticated error tracking and data chocking service—The current
BMP will focus on gross errors and linkages and will provide detailed, rocord-by-
record feedback to submitters that may bo further refined in the future.
1.3 Components of the Chesapeake Bay Network Exchange
| The BMPNPS BMP Network Exchange can be regarded as having three inter-related parts.
See Figure 1 for an illustration of these parts and their relationship to each other. A brief
description of these elements is provided here and a more detailed description of each part
may be found in sections 2 and 3.
1] BMP-NPS BMP Exchange Flows use the Exchange Network Submit, Query, and Download
methods to exchange some or all of a Partner's BMPNPS BMP data. The NPS BMP Technical
Team expects the first generation of BMPNPS BMP Flows to be used primarily to transfer
data to the CBPO's BMPNPS BMP Application through the CBPO's Network Node. As a result,
there are specific CBPO processing rules associated with every Flow option.
3 A combination of network service interactions that allow a Partner to perform exchanges of BMP data on
the Exchange Network (See Network Exchange Protocol V1.1 Section 5.5).
10
-------
2] Common BMPNPS BMP Exchange Data Services use Exchange Network Solicit and Query
methods to support a parameter-driven request for BMPNPS BMP data. Currently, only one
Data Service is recommended for all partners (see Section 4.1).
| 3] BMP-IMPS BMP Processing, Feedback, and Unique Data Services describe how, once CBPO
has received data, it provides feedback.
BMP Exchange
Flows
Common BMP
Exchange Data
Services
BMPS Processing
Feedback and
Unique Data
Services
All BMP Full
Refresh
GelBMPFullRefresh
Error Processing
Figure 1 Components of the Chesapeake Bay Network Exchange
11
-------
2.0 Chesapeake Bay Network Exchange
Components
2.1 Overview of the BMPNPS BMP Flow Issues and Options
The BMPNPS BMP flow began with informal annual exchanges between states and CBPO.
These were summarized BMPNPS BMP data from states to CBPO. Once the state prepared
the new BMPNPS BMP information, they manually transmitted their refreshed BMPNPS BMP
data to CBPO. CBPO ran the data through the BMPNPS BMP integration application, and then
loaded it into BMPassembler decks for the Chesapeake Bay model. By using the Exchange
Network, Partners can improve the efficiency and timeliness of the BMPNPS BMP Network
Exchange by proposing more frequent, smaller exchanges and providing data on-demand
for the ad hoc information requests. To adapt the BMPNPS BMP Flow to the Network and
improve current practice, the BMPNPS BMP Technical Team identified the following
requirements:
Requirement for the Network Flow
Proposed Chesapeake Bay
Network Exchange
Payload Operation
Standardize the "GetBMPFullRefresh" approach to be
used for synchronization/initial exchanges
GetBMPFullRefresh
Table 1 Requirements for the-BMPNPS BMP Exchange Flows
2.1.1 Establishing the Network Exchange
| For most Partners, establishing a routine BMPNPS BMP Network Exchange will be an
iterative process. The process reflects a series of decisions influenced by technical
infrastructure (e.g., table structure), and the Partners' resources, and needs. See Appendix
D for a list of activities required for BMPNPS BMP Network Exchange implementation.
Partners will use the GetBMPFullRefresh BMPNPS BMP Exchange Flow (See Section 3.1) to
"initialize" BMPNPS BMP data and then provide or service one of the "update" Flows for
routine updates to BMPNPS BMP data that has changed.
To accommodate differences in Partner infrastructures, resources, and needs, as well as the
existence of two governing schema, the BMPNPS BMP Technical Team recommends four
BMPNPS BMP Exchange Flows for partners to select from. The BMPNPS BMP Exchange Flow
is listed in Table 2 and is described in detail in Section 3.0. In practice, CBPO will use one
| approach for its routine quarterly BMPNPS BMP updates (e.g., GetBMPFullRefresh).
BMPNPS BMP
Exchange Flow
Name (Exchange
Options)
Network Web Method
Allowed Payload
Operation Types
(see Section 2.2)
C2: All BMP Full
Refresh
Solicit/Notify Download
GetBMPFullRefresh
Table 2 Flow and Payload Operations Overview
12
-------
2.1.2. Identifying Changed &MPNPS BMP Data:
GetBMPByChangeDate
| By far the biggest design choice facing BMPNPS BMP Exchange Flow implementers will be
how they detect and collect the changed data for Best Management Practices core data.
While all state and federal BMPNPS BMP data systems will be able to produce information
compatible with the BMPNPS BMP schema, some may have taken different approaches to
tracking and identifying changes to that data. CBPO, as a collector of data from multiple
sources, tracks by full refresh. States, however, often design their systems with different
requirements, and, as a result, their systems may take a wide range of auditing approaches
- from very fine (i.e. field level) - to course (i.e. BMPNPS BMP level).
2.1.3 Formatting The VI.0 Schema Format
The selected schema format (consolidated) is optimized for working interactively with
| BMPNPS BMP information and takes advantage of XML's ability to enforce referential
integrity, by requiring child data to be imbedded within the context of its parent data.
2.1.4 Business Rules by Payload Operations
GetBMPFullRefresh Payload Operation
| For the BMPNPS BMP Exchange Flows with the GetBMPFullRefresh payload operation, the
business rules are:
Sender
Sends all BMPNPS BMP data for all Non Point Sources in the aareed
universe. No other business rules apply.
CBPO/ Recipient
Non Point Sources in the current store are compared to the new
"GetBMPFullRefresh" transmission. Those missing in the new
transmission are inferred as deleted. Data from this BMPNPS BMP
may or may not show up subsequently as new data under an existing
BMPNPS BMP.
Table 3 NPS BMP Business Rules
2.2 Using the Exchange Network Document (Header) to
Package BMPNPS BMP Data
The BMPNPS BMP Network Exchange uses the newly developed Exchange Network
Document Schema [citation], as a "wrapper" for the BMPNPS BMP Network Exchange. This
wrapper:
• Carries a very simple set of key metadata such as an ID and author of the data
package, and the "operation" intended by the sender for each of the payloads it
contains.
• As agreed by the Technical Team, will be zipped if larger than 20 MB, as a courtesy
to the CBPO.
13
-------
2.2.1 Exchange Network Document and Payload Parameters
and Allowable Values
A general overview of the Exchange Network Document is found in Section 2.2.2. Table 4
below identifies the parameters and allowable values to use the Exchange Network
| Document to carry BMPNPS BMP data.
Element
Name
Required
Allowable Values for BMPNPS BMP
Flow Version 1.0
Example Values for
BMPNPS BMP Flow
Version 1.0
Header
Id:
Yes
any (unique over that organization)
20f8afa8-26f2-46e7-
bl3c-6de32bcd9266
Author:
Yes
any
BMP Profiler
Organization:
Yes
any
VADEQ
Title:
Yes
any
VA BMP FullRefresh
(Open Text Field any
meaningful information
for the sender)
DataService:
No
GetBMPData
GetBMPFullRefresh
Property
Yes
Name: Schema
Value: GetBMP
Schema
GetBMP
Contactlnfo:
No
any
mchambers@VADEQ.gov
Payload
Payload
Operation
Yes
GetBMPFull Refresh
BMPAdd
Schema
Reference
Yes
http://
BMPID_BMPList_vl.0.xsd
xsi: noNamespaceSchema
Locati on=" http://www.cb
po.gov
/enviro/html/bmp_demo/
presentations/
BMOID_BMPList_vl.0.xsd
">
Table 4 Header and Payload: Allowable Values
14
-------
2.2.2 Header Structure
| The BMPNPS BMP Technical Team recommends the following conventions for structuring the
payloads of the "Exchange Network Document" for each flow option. While the use of the
Exchange Network Document is not delineated in the Protocol and Specification, failure to
| follow these recommendations is likely to cause a 6MPNPS BMP Network Exchange to fail.
| Any BMfiNPS BMP Network Exchange transaction (e.g. The response to a
GetBMPFullRefresh) is composed of one Exchange Network Document, that gives users one
transaction ID per document. The functionality for a Submit to carry multiple files (via a
doc array) is not used. However, as described above a single Exchange Network Document
may have multiple payloads as child elements. These can all be sent but each must be of
| the same payload operation, however this is not relevant to the ftMPNPS BMP flow at this
time.
The NPS BMP Consolidated Schema only has one payload with one payload operation. For
| the BMftNPS BMP Network Exchange, the Submit method is only allowed to carry one file.
GetBMPFullRefresh
Exchange Network Document
Figure 2 Exchange Network Document Structure
2.2.3 Payload Structure
Each Exchange Network Document is composed of a header and the payload (see Figure 2).
The payload is composed of the NPS BMP Schema file. Refer to Table 4 for a list of
allowable Payload Operation values.
Text Box 1 below contains a segment of an XML instance document with a header and
corresponding payload. Note that each of the payload files carries the identical Payload
15
-------
Operation= GetBMPFullRefresh. Although the Exchange Network Document has the ability
| to carry payload for different operation types, the BMPNPS BMP FCD VI.0 imposes a
restriction of 1 Operation per Exchange Network Document. A Full Sample of the XML
instance document can be found in Appendix E.
16
-------
Brian Burch
EPA-CBP
BMP Full Refresh
2005-l 1-1 l
<
xn
xsi
H
p Full Refresh of BMP Data
GetBMPFullRefresh
Brian Burch 410-267-5736
^ distribution_list@cbpo
E distribution_list@state.pa.us
R distribution_list@state.md.us
distribution_list@state.va.us
Confidential
. Schema
^—
{
110004792047
ABC Co.
Stationary
N
N
02
P 54
A 17070301
Y
L
0 123 NE 3RD ST
BEND
p. 41017
DESCHUTES
OR
OREGON
United States
97701
OregonDEQ
2004-02-19
1 GEO-LOC
67
Text Box 1 Sample Header and Payload Instance
17
-------
2.2.4 Payload Validation and the Exchange Network Document
Nodes should validate the XML data files to the governing schema prior to sending them to
a Partner, to ensure that payloads are properly formatted. At least during the initial
implementation of the Flow, Nodes should locally validate payloads (even if it is done
manually) to ensure that are structured properly. This extra step is recessary if the N.
Network is to take advantage of at least the basic syntax checking capabilities of XML. As
noted below, implementers can do this validation in one or two steps (first the payload,
then the Exchange Network Document).
| The BMRNPS BMP Technical Team chose the structure of the Exchange Network Document
(with one wrapper Schema embedding another) so that schema developers would not have
to modify their schema by manually inserting the header elements. Thus tho ontiro
Exchange Network Document is governed by two schemas, one for the Exchange Network
Document itself and one for tho pavloadtwo schemas. one for the Exchange Network
Document itself and one for the pavload governs the entire Exchange Network Document.
This is indicated bv tho "schema location" taosThe "schema location" taos indicate this for
Exchange Network Document and each payload.
18
-------
3.0 Configurations for the BMPNPS_BMP Exchange
Flows
This section contains descriptions, including parameter values for Network messaging, for
each BMPNPS BMP Exchange Flow.
3.1 BMPNPS BMP Exchange Flows: GetBMPFullRefresh
3.1.1 Overview
As the name indicates, this Flow is used to send a full refresh (or the initial load) of all
| shared BMPNPS BMP data for all Non Point Sources. One payload option is available for the
NPS BMP Schema VI.0. The header of the Exchange Network Document shows the sending
Partner's Schema details, as described in Section 2.2.1.
Sending Partners can use GetBMPFullRefresh for at least three purposes:
• "Initial Load" for the Flow, when the Partner intends to use one of the other options
| for-routine updates
• As quarterly "refresh" of data
• As a way to resynchronize or reset systems periodically after a change or
reconfiguration or to fix an error that cannot be efficiently handled in an update file.
Examples may include recovery from a corrupted data transfer, state re-assignment
| or re-mapping of some key fields. BMPNPS BMP Partners anticipate a quarterly total
refresh.
Note that the universe of Non Point Source BMPs sent as part of the GetBMPFullRefresh
| operation may only be a subset of that Partner's sharable BMPNPS control measure
universe. States should work with CBPO data stewards to identify additional controls to
exchange.
3.1.2 GetBMPFullRefresh Configuration Details
FCD Specification Area
Value
Notes
Flow Name
All BMP Files Full Refresh
All BMP Full Refresh
Network
Method/parameters
Flow=BMP
Payload Schema
NPSBMP 1.0
See header
property below
Header Property
Name= "Schema" Value =
NPSBMP vl.O
See Sections 2.2.1
and 2.2.3
Payload Operation
GetBMPFullRefresh
Payload
Formatting/Structure
See Section 2.2
File over 20 MB
should be zipped
before attachment
Payload File Naming
Convention
N/A
19
-------
FCD Specification Area
Value
Notes
GetStatus Responses
All standard
GetStatus
responses as
defined in the
Protocol and
Specification.
Timing
Expected to be quarterly, or as
initiated/requested by CBPO.
NAAS Authorized User Accts
CDX must authorize Submit/BMP
Table 5 GetBMPFullRefresh Configuration
3.1.3 4.0 BMPNPS BMP Processing
CBPO Processing of the GetBMPFullRefresh Flow is exactly the same for each state flows.
Additionally, CBPO processes data unique to that originating state - i.e., if two states use
a system called FP that both had a BMPNPS BMP with the same StateBMPIdentifier they
would not be treated as one BMPNPS BMP. The business logic applied in CBPO
Processing to each record is:
• If "StateBMPIdentifier" and "StateBMPSystemAcronymName" already exist, compare
and update the information provided. If appropriate, comparison and update is done
for each module/file of information using the NPS BMP keys for that module
• If "StateBMPIdentifier" and "StateBMPSystemAcronymName" do not exist, a new
BMPNPS BMP record is created with the submitted information.
• If "StateBMPIdentifier" and "StateBMPSystemAcronymName" already exist but NOT
contained in the most recent GetBMPFullRefresh payload, the BMPNPS BMP record is
flagged as deleted.
20
-------
4.0 Data Services
This Version 1.0 FCD specifies only one data service GetBMPFullRefresh, between the
partner states and the CBPO. All Partners agree that the Data Services may be expanded
to provide additional services by the CBPO Node, i.e. Retrieval of BMPNPS BMPs by
Watershed (refer to page 21). Appendix BG describes potential future data services.
Subsequent versions of the FCD will address additional Data Services.
4.1 Query{GetBMPFullRefresh}
Data Service Name
GetBMPFullRefresh
Data Service Type
Query
Data Service Parameters,
Order, and Format
State USPS (string), State BMP Identifier (string),
State BMP System Acronym Name (string)
Return Method (If Solicit)
n/a
Payload Format (Schema)
BMPID_BMPList_vl.0.xsd
Data Service Timing/Initiation
User Defined/Ad Hoc
Naming Convention
BMPID.GetBMPFullRefresh_v. 1.0
Security
A State should authorize all users to Query its Node.
NAAS Authorized User Accts
Partner Specific
Other Security
Partner Specific
Encryption
N/A
Signature
N/A
Data Service Management and
Workflow
No Workflow
Data Service Status/Fault
Conditions
Protocol and Specification Default Conditions
Table 6 GetBMPFullRefresh Configuration Detail
4.2 Data Services Schema
A Schema exists documenting all the &MP-NPS BMP Data Services. A copy of the Schema
will be located in Appendix R-F_and on the Network Registry.
21
-------
5.0 BMP-NPS BMP Processing, Feedback and Data
Services
5.1 Processing
When a state first submits files through the node, the files are processed and analyzed by
the CBPO team in a test environment. The CBPO team prepares a document which explains
anv datadocument that explains anv data or formatting errors found with the files. The
state corrects the errors and resubmits the files. This process continues until all errors have
been corrected and all issues resolved. The CBPO team then coordinates with Network
Authentication and Authorization Services (NAASICPX- via the Central Data Exchange (CDX")
and the state to set up a production account and to grant access to the CBPO production
servers. This will allow the state to submit their files to the production environment for
| loading to the BMPNPS BMP production database. Once a Partner has provided baseline data
to CBPO, the preferred exchange mechanism involves scheduling queries against the
submitting node on a quarterly basis. At this point, the state node is considered operational
in the production environment.
The types of issues that have been discovered in the review of several state XML data
exchanges and included in the feedback documents are summarized below:
Schema Validation
| XML files that were not structured properly against the corresponding schemas. The data
values were not between the appropriate tags, mandatory fields were empty, and incorrect
tag names were used. If States validate their XML files against the schemas before
submitting them through CBPO Node, it will save time for both the sending and receiving
partners.
Unnecessary information
Files contained only a mailing address of the record, and no other information. Each mailing
address included in these files also appeared in the Mailing Address file, so this information
was redundant and unnecessary. An Alternative Name file containing no alternative names
was also received; each record contained only the StateSystemAcronymName and the
Stateldentifier. Again, if there is no information to provide for a specific file, that file should
not be generated.
Corrupted/Bad Data
Files had extraneous characters or incorrect values in the data fields. This could have been
caused by a rich text or some other type of formatted text and may be corrected if the files
are first saved as plain ASCII text. Some fields had long strings of spaces instead of being
blank. Some data values were simply invalid such as telephone numbers = "0" and dates =
"1-1-1111", or codes that were not recognized by the source application.
Data Gaps
Files had major data gaps, such as files with no address information for any of the records.
Duplicate Records
22
-------
| Duplicate records7 or more than one record with the same Id were submitted. The fields
that determine a unique record for this exchange are: BMP State Unique Identifier,
EventStatus and EventDate. A duplication of records results in an exponential growth rate,
and this, in turn, has resulted in huge file sizes, which caused numerous processing
problems for some of the other data flows..
The purpose of the CBPO gMPVortex system is to assemble record accurate, up-to-date
BMPNPS BMP identification information and active activities occurring at the Non Point
Source that are of environmental concern (e.g., cite example from Program Team
fref&Aoricultural - contour farming: Urban") Typically, a BMPNPS BMP covers a specified time
period; at the end of the time period the Non Point Source record is modified with now , and
at the end of the time period the NPS BMP is no longer in it's active life span. It is then
possible for another installation of the same BMP to occur at the same site, but the record
associated with this new practice will have a different EventStatus and EventDate. Any
details of NPS BMPs not described in the XML schema may be kept at the state level, but an
attempt to transfer these unique attributes to CBPO should not occur. CBPO does not keep
track of each time a BMP changes. CBPO is only concerned with ...
-------
Schema Version (VI.0, V2.3)
Schema Type (Consolidated)
Comments
-------
5.2 Feedback and Messaging
Several data flows exist between the CBP Node, the States and the NAAS Network
Athontication and Authorization Services (NAAS) through the Central Data Exchange (CDX)
CDX. These flows are documented in Figure 3.- in the order of each flow's execution.
Following is a description of each flow, and any messaging anticipated to be implemented
for each:
5.2.1 Request Credentials
This flow is passed from the CBP Node to the NAAS through CDX. When credentials have
been verified, a token will be passed back to CBPO. If an invalid connection is attempted, a
message will be received from CDX.
5.2.2 Receive Token
This flow passes a token that verifies CBP credentials, which will be passed to the state node
that is being solicited.
5.2.3 Pass Token and Solicit
This flow passes the token received from NAAS to the state node that is being solicited.
Some states (VA) will respond to the solicit by returning the XML file it generates on a
quarterly basis. Other states might create a web service that will generate the XML file
after the solicit, which would require the establishment of a query account for the CBPO, in
order to access the state database. A message is passed if the token is not recognized, or if
an invalid connect to the database is attempted.
5.2.4 Validate Token
This flow validates the token received. A message is passed if the token is not recognized
or is invalid.
5.2.5 Validation received
| This flow-is indicates that the token is valid and the solicit can be executed.
5.2.6 Execute Solicit
This flow executes the query. If there is a problem with the source system a message will
be returned to the CBP from the state node.
5.2.7 Return Data
This flow passes the data requested from the state database to the CBP Node.
5.2.8 GetStatus
This flow is passed from the CBP Node to the State Node, then back to the CBP Node. This
flow indicates the status of the submission.
25
-------
5.2.9 Return XML File
| This flow 4s-implements the translation and load process to the CBP BMPNPS BMP database.
An error report is generated for records that fail the validation routines.
.-_VA DCR-
Data
(MySQL;
6a)
6b)
f'—i
a
i—i
i
MDE
DDDDDDD
Node
(X aware)
DDDDDDD va deo
DDDDDDD , „ ,
^ Node
(Xaware)
PADEP
Node
(Xaware)
STATE
NODES
Chesapeake Bay Program
Non Point Source
Best Management Practices
Data Flow
cbbmp.vsd
II 18 2005
Figure 3 CBPO NPS BMP Data Flow Diagram
5.3 Other Services being considered by CBPO
Additional Services which the CBPO may consider with future funding are described below.
• GetBMPByHUCCode
| This service provides &MPNPS BMP information for specific HUC Code.
Parameters:
• p_tranid
• p_stcode
• p_huccode
• p_Servicerequestname
• GetBMPByStateldentifier
| This service provides &MPNPS BMP information for specific State Identifier.
26
-------
Parameters:
• p_tranid
• p_Regid
• p_Servicerequestname
• GetBMPByBMPName
| This service provides &MPNPS BMP information for specific -BMPNPS BMP name.
Parameters:
• p_tranid
• p_stcode
• p_bmpname
• p_Servicerequestname
• GetBMPByCountyName
This service provides BMP information for a specific County.
Parameters:
• p_tranid
• p_stcode
• p_countyname
• p_Servicerequestname
• GetBMPByType
This service provides BMP information for a specific BMP Type.
Parameters:
• p_tranid
• p_stcode
• p_bmptype
• p_Servicerequestname
27
-------
Appendices
28
-------
A. B-M-PNPS BMP PET-Data Model Documentationdocumontation
The attached BMPNPS BMP Data Exchange Template (DETIData Model spreadsheets
provides a more human readable version of BMPNPS BMP ID schemas. Thjsese spreadsheets
lists each of the data (XML) elements of the schema along with:
The schema and tag name of that data element
| > A definition of the element, based on the BMPNPS BMP Data Standards definition
where applicable, and/or along with other details of the purpose of that data
element, and in some cases, examples data values.
> The list of permitted values (based on the XML schema's enforced enumerated list).
> Whether the data element is required or not (for a file based on that specific
schema).
> The data type for that data element - e.g., A = string, D = Date, and the length
| prescribed by the BMPNPS BMP Data Standards (although not enforced by the
schema in most cases).
> Any formatting rules that apply - either enforced by the schema or not (e.g., must
be YYYY-MM-DD).
| One intended use of thjsese spreadsheets is as a basis for a Partner's initial mapping of
these data elements to the fields available in the Partner's source database(s). It is
anticipated that this will be a necessary analysis and documentation step that each Partner
will employ, albeit for internal use only.
29
-------
B. Looking Ahead to Version 1.1 and beyond
The BMP Network Exchange trios to do a now thing in a now way. Given the complexity and
number of inter-relationships with other data inherent to BMP information, this document
does not answer every possible BMP Network Exchange scenario.—Specifically, BMP IPT has
identified the following unresolved issues and focus areas. Some may bo addressed in an
immediate follow-on effort to expand version 1. 0 (this version) of the FCD and some will
probably have to wait until sufficient experience actually processing updates from many
states has boon compiled.
These future functions can bo organized as follows:
Enhancing the BMP Data Services
The IPT, in an effort to produce timely documentation, agreed to proceed with only one data
service between the states and the CBPO, but acknowledged that a more robust sot of
services may bo offered by the CBPO Node (see appendix C). Those services are essential to
demonstrating the ability of the Network to provide now kinds of data access via "data
service publishing."
Refinements and Minor Additions to the BMP Schema/Format
It is anticipated that there will bo required changes to the BMP schema. Rather than noting
those changes in a modified version of the FCD, the CBPO will provide:
/ \ IIV-IU 1 >_» 1 1 LI IV-I L W II LH 1 1 V 1 LH L V« 1 ll^l 1 UVJKJ 1 LI Wl 1 1 UV^LU II V-/ 1 1 LH 1—J 1 1
R-be
integration via simple "cross-site linkages" between partner websites. This ca
one of the most simple and visible ways that the Network supports integration-
Refinements to BMP Services to Data Partners
As they become available, more states may use BMP services a part of their BMP
reconciliation process. Several ideas wore considered but deferred for enhancing those
services:
BMP may bo able to provide more detailed feedback on now data linked to parent
BMP records as that data becomes available.
BMP may bo able to expose, for use by others, some of the reconciliation logic it uses
to identify candidate duplicate BMP records-
Refinements to the Shared Business Process for BMP Reconciliation
As more oxporionco is gained it may bo useful to further define standard processes for more
advanced BMP exchange and reconciliation processes including:
Bettor coordination of the begin and end dates, and what those moan to partners.
Resolving how partners address the rare situations whore???
30
-------
€B. Future Version Data Services
Ultimately, the future of the CBPO Exchange Network will emphasize the ability to support
ad-hoc querying of data through a Node, over the ability to support replication of large sets
of data across organizations. The current version of the FCD provides a mechanism to
replicate BMPNPS BMP identification data across Partners. The envisioned GetBMP data
service will provide a mechanism to allow Partners to much more selectively inquire upon
BMPNPS BMP data based on a wide variety of parameters. Some examples of the uses of
this data service are found in Table 6 below.
Data Service Name
GetBMP
Data Service Type
Query
Data Service Parameters,
Order, and Format
See list below, plus flags to indicate which major
sections of the schema are desired in the payload
(e.q., HUC Codes, Countv, -BMPNPS BMP TvDe)
Return Method (If Solicit)
n/a
Payload Format (Schema)
BMPID_BMPList_vl.0.xsd
Data Service Timing/Initiation
User Defined/Ad Hoc
Naming Convention
BMPID.GetBMP_v. 1.0
Security
NAAS Authorized User Accts
Partner Specific
Other Security
Partner Specific
Encryption
N/A
Signature
N/A
Data Service Management and
Workflow
No Workflow
Data Service Status/Fault
Conditions
Protocol and Specification Default Conditions
Table 6 Uses of NPS BMP GetBMP Data Service
Parameter List Notes
No equivalent element in schema
A few parameters are not directly supported by the Schema (identifiable by the lack of a
XML Tag associated with the parameter). For example, one might want to see all -BMP-NPS
BMPs in EPA Region V, even though this is not a data item.
Multiple Parameter Boolean Logic
All parameters are ANDed together. If a single parameter allows multiple values, then those
would be ORed together. So if one wanted to query all Non Point Sources in the Counties of
'Avery' and 'Bowen' the Boolean logic would be County = 'Avery' OR 'Bowen'. If additional
parameters such as HUC code was used, the logic would be (County = 'Avery' OR'Bowen'
AND HUC = 02050101.
Wildcards
For parameters where the use of wildcards is appropriate, there are only two cases:
1. the data starts with the parameter value (e.g., HUC starts with 3)
31
-------
2. the parameter is a text string that should allow any combination of the (RDBMS
vendor independent) SQL wildcards - i.e., '%'.
Permitted Values
Many of the parameters are based on enumerated lists (i.e., 'look up codes', such as
| BMPNPS_BMP Types), and should be supported by the Node's
Data Services. GetPermitted Values query.
-------
APPENDIX D
33
-------
34
-------
—DC. Date Exchange TemplateNPS BMP DATA MODEL
35
-------
Major Data
Group
Compound
Data Block
Data Block
Name
Definition/Business Rules
Datatype
Length
ELEMENT
3
REQUIRED
XML Tag
01
SUBMITTER
CONTACT
INFORMATION
INDIVIDUAL
IDENTITY
Mddle Name
The middle name or initial of
an individual.
A(10)
11-88457:1
Y
MiddleName
01
SUBMITTER
CONTACT
INFORMATION
INDIVIDUAL
IDENTITY
First Name
The given name of an
individual.
A(30)
1-88488:1
Y
FirstName
01
SUBMITTER
CONTACT
INFORMATION
INDIVIDUAL
IDENTITY
Individual
Identifier
The identification number that
uniquely represents an
individual.
N(9)
1-98005:1
Y
Individualldentifier
01
SUBMITTER
CONTACT
INFORMATION
INDIVIDUAL
IDENTITY
Individual Title
Text
The title held by a person in an
organization
A(40)
1-5452:1
Y
IndividualT itleT ext
01
SUBMITTER
CONTACT
INFORMATION
INDIVIDUAL
IDENTITY
Last Name
The surname of an individual.
A(30)
1-5414:1
Y
LastName
01
SUBMITTER
CONTACT
INFORMATION
INDIVIDUAL
IDENTITY
Name Prefix
Text
The text that describes the title
that precedes an individual's
name.
A(15)
1-5418:1
N
N amePrefixT ext
01
SUBMITTER
CONTACT
INFORMATION
INDIVIDUAL
IDENTITY
Name Suffix
Text
Additional title that indicates
lineage or professional title.
A(20)
1-32494
N
NameSuffixText
01
SUBMITTER
CONTACT
INFORMATION
ADDRESS
Mailing
Address
The exact address where a mail
piece is intended to be
delivered, including urban-style
street address, rural route, and
PO Box. The address
information will apply to the
individual at the organization
defined as the primary contact
person. If any part of he
address is inserted, all mailing
elements are mandated.
A(50)
1-6183:1
C
MailingAddress
01
SUBMITTER
CONTACT
INFORMATION
ADDRESS
Mailing
Address City
Name
If any part of he address is
inserted, all mailing elements
are mandated.
A(30)
1-5450:1
C
MailingAddressCityName
36
-------
01
SUBMITTER
CONTACT
INFORMATION
ADDRESS
Mailing
Address State
Name
The name of the state or
province where mail is
delivered. The mailing country
will be derived from the State
information, where, for
Canadian addresses, the
Province code will be used. If
any part of the address is
inserted, all mailing elements
are mandated.
A(35)
1-5386
C
MailingAddressStateName
01
SUBMITTER
CONTACT
INFORMATION
ADDRESS
Mailing
Address Zip
Code
The combination of the 5-digit
Zone Improvement Plan (ZIP)
code and the four-digit
extension code (if available)
that represents the geographic
segment that is a subunit of the
ZIP code, assigned by the U.S.
Postal Service to a geographic
location to facilitate mail
delivery; or the postal zone
specific to the country other
than the U.S., where the mail is
delivered. If any part of he
address is inserted, all mailing
elements are mandated.
A(14)
1-32398
C
MailingAddressZipCode
01
SUBMITTER
CONTACT
INFORMATION
AGENCY
IDENTITY
Agency Code
The code that represents a
federal, state, or local agency
A(80)
Y
Agency Code
01
SUBMITTER
CONTACT
INFORMATION
AGENCY
IDENTITY
Agency Code
List Identifier
The name of a list of agency
codes. Can be used to identify
the URL of a source that
defines the set of currently
approved values.
N
Agency CodeListldentifier
01
SUBMITTER
CONTACT
INFORMATION
AGENCY
IDENTITY
Agency Name
A description of the agency
code.
A(80)
Y
AgencyName
01
SUBMITTER
CONTACT
INFORMATION
PHONE - Email
Electronic
Address Text
The text that describes an
electronic mail address of the
person who is the point of
contact for the organization.
A(100)
1-88451:1
Y
ElectronicMailAddressText
01
SUBMITTER
CONTACT
INFORMATION
PHONE - Email
Telephone
Number
The telephone number
including area code and
extension of the person who is
the point of contact for the
organization
A(15)
1-5706:1
Y
T elephoneNumber
37
-------
01
SUBMITTER
CONTACT
INFORMATION
STATE
IDENTITY
State Code
A code designator used to
identify a principal
administrative subdivision of
the United States, Canada, or
Mexico.
A(5)
1-88492:1
Y
StateCode
01
SUBMITTER
CONTACT
INFORMATION
STATE
IDENTITY
State Code List
Identifier
A designator specifying the
code set used to provide a state
code. Can be used to identify
the URL of a source that
defines the set of currently
approved permitted values.
N
StateCodeListldentifier
01
SUBMITTER
CONTACT
INFORMATION
STATE
IDENTITY
State Name
A name used to identify a
principal administrative
subdivision of the United
States, Canada, or Mexico.
A(35)
1-42:1
Y
StateName
01
SUBMITTER
CONTACT
INFORMATION
TRIBAL
IDENTITY
Tribal Code
The code that represent
American Indian tribes and
Alaskan native entities.
A(3)
1-88453:1
N
TribalCode
01
SUBMITTER
CONTACT
INFORMATION
TRIBAL
IDENTITY
Tribal Code
List Identifie r
The name of a list of tribal
codes. Can be used to identify
the URL of a source that
defines the set of currently
approved values.
N
T ribalCodeListldentifier
01
SUBMITTER
CONTACT
INFORMATION
TRIBAL
IDENTITY
Tribal Name
The name of the American
Indian tribe or Alaskan Native
entity.
A(200)
1-63877:1
N
TribalName
02
NPS BMP
IDENTITY
SOURCE OF
DATA
ADDRESS
Mailing
Address
The exact address where a mail
piece is intended to be
delivered, including urban-style
street address, rural route, and
PO Box. The address
information will apply to the
individual at the organization
defined as the primary contact
person. If any part of he
address is inserted, all mailing
elements are mandated.
A(50)
1-6183:1
C
MailingAddress
02
NPS BMP
IDENTITY
SOURCE OF
DATA
ADDRESS
Mailing
Address City
Name
If any part of he address is
inserted, all mailing elements
are mandated.
A(30)
1-5450:1
C
MailingAddressCityName
38
-------
02
NPS BMP
IDENTITY
SOURCE OF
DATA
ADDRESS
Mailing
Address State
Name
The name of the state or
province where mail is
delivered. The mailing country
will be derived from the State
information, where, for
Canadian addresses, the
Province code will be used. If
any part of he address is
inserted, all mailing elements
are mandated.
A(35)
1-5386
C
MailingAddressStateName
02
NPS BMP
IDENTITY
SOURCE OF
DATA
ADDRESS
Mailing
Address Zip
Code
The combination of the 5-digit
Zone Improvement Plan (ZIP)
code and the four-digit
extension code (if available)
that represents the geographic
segment that is a subunit of the
ZIP code, assigned by the U.S.
Postal Service to a geographic
location to facilitate mail
delivery; or the postal zone
specific to the country other
than the U.S., where the mail is
delivered. If any part of he
address is inserted, all mailing
elements are mandated.
A(14)
1-32398
C
MailingAddressZipCode
02
NPS BMP
IDENTITY
SOURCE OF
DATA
DATA ACCESS
TYPE
Data Source
Access Method
Describes the method by which
the data set may be accessed.
Values are "Node",
"Document", "OnRequest"
A(10)
Y
DataSourceAccessMethod
02
NPS BMP
IDENTITY
SOURCE OF
DATA
DATA ACCESS
TYPE
Data Source
Location
Provides the Internet address at
which the data source is
located. This will be required
when the Data Source Access
Method is "Node" or
"Document". For node-based
data sources, this data element
will provide the location at
which the relevant node's Web
services can be identified as the
first step in accessing the data
itself.
A(255)
C
DataSourceLocation
02
NPS BMP
IDENTITY
SOURCE OF
DATA
DATA ACCESS
TYPE
Data Source
Name
The name by which the data
source is commonly known.
A(60)
Y
DataSourceName
39
-------
02
NPS BMP
IDENTITY
SOURCE OF
DATA
DATA ACCESS
TYPE
Refresh Date
Date on which the metadata
registry record for this data
source was last updated. Will
be generated by Data Catalog
upon data submission. Will be
reported as a 4-digit year. 2-
digit month, and 2-digit day in
YYYMMDD format.
D(8)
Y
RefreshDate
02
NPS BMP
IDENTITY
SOURCE OF
DATA
DATA ACCESS
TYPE
Availability
Description
Provides a general indication of
what access can be applied to
this result information. This
would be used by the Exchange
trading partners to describe the
sensitivity of the information
and what kind of distribution
restrictions there may be.
A(255)
N
AvailabilityDescription
02
NPS BMP
IDENTITY
SOURCE OF
DATA
INDIVIDUAL
IDENTITY
First Name
The given name of an
individual.
A(30)
1-88488:1
Y
FirstName
02
NPS BMP
IDENTITY
SOURCE OF
DATA
INDIVIDUAL
IDENTITY
Individual
Identifier
The identification number that
uniquely represents an
individual.
N(9)
1-98005:1
Y
Individualldentifier
02
NPS BMP
IDENTITY
SOURCE OF
DATA
INDIVIDUAL
IDENTITY
Individual Title
Text
The title held by a person in an
organization
A(40)
1-5452:1
Y
IndividualT itleT ext
02
NPS BMP
IDENTITY
SOURCE OF
DATA
INDIVIDUAL
IDENTITY
Last Name
The surname of an individual.
A(30)
1-5414:1
Y
LastName
02
NPS BMP
IDENTITY
SOURCE OF
DATA
INDIVIDUAL
IDENTITY
Mddle Name
The middle name or initial of
an individual.
A(10)
11-88457:1
Y
MiddleName
02
NPS BMP
IDENTITY
SOURCE OF
DATA
INDIVIDUAL
IDENTITY
Name Prefix
Text
The text that describes the title
that precedes an individual's
name.
A(15)
1-5418:1
N
N amePrefixT ext
02
NPS BMP
IDENTITY
SOURCE OF
DATA
INDIVIDUAL
IDENTITY
Name Suffix
Text
Additional title that indicates
lineage or professional title.
A(20)
1-32494
N
NameSuffixText
02
NPS BMP
IDENTITY
SOURCE OF
DATA
PHONE - Email
Electronic
Address Text
The text that describes an
electronic mail address of the
person who is the point of
contact for the organization.
A(100)
1-88451:1
Y
ElectronicMailAddressText
02
NPS BMP
IDENTITY
SOURCE OF
DATA
PHONE - Email
Telephone
Number
The telephone number
including area code and
extension of the person who is
the point of contact for the
organization
A(15)
1-5706:1
Y
T elephoneNumber
40
-------
02
NPS BMP
IDENTITY
SOURCE OF
DATA
PROVIDING
ORGANIZATION
DETAILS
Providing
Organization
Contact Name
The name of the individual at
the organization who may be
contracted for questions
regarding the data or the data
exchange submission. This may
be the project lead for the data
collection, the agency data
manager or another individual
as deemed appropriate by the
organization depending on the
data being exchanged. A
contact name will always be
required for each organization,
although a generic title may be
provided if a specific individual
is not known.
A(70)
Y
ProvidingOrganizationContactName
02
NPS BMP
IDENTITY
SOURCE OF
DATA
PROVIDING
ORGANIZATION
DETAILS
Providing
Organization
Identifier
A number or code used to
uniquely identify the
organization for reference
purposes. This must be unique
to each organization providing
data through the Exchange for
reference purposes. This
identifier will be assigned by
the Data Catalog Administrator.
A(30)
Y
ProvidingOrganizationldentifier
02
NPS BMP
IDENTITY
SOURCE OF
DATA
PROVIDING
ORGANIZATION
DETAILS
Providing
Organization
Name
The legal, formal name and
acronym of the organization
that is providing the data being
exchanged. This may represent
the agency as a whole or some
unit of the agency as deemed
appropriate by the organization.
A(80)
Y
Providing OrganizationName
02
NPS BMP
IDENTITY
SOURCE OF
DATA
PROVIDING
ORGANIZATION
DETAILS
Providing
Organization
Type
Describes the categorization of
the organization for analysis
purposes. Valid values are:
Federal, Tribal, State or
Provincial, Local, Public or
Volunteer, Non-Profit,
Educational, Commercial,
Other
A(20)
Y
EntityType
02
NPS BMP
IDENTITY
SOURCE OF
DATA
PROVIDING
ORGANIZATION
DETAILS
Providing
Organization
Web URL
The text that describes a web
address of the organization that
is providing the data being
exchanged. This web address
may represent the home page of
the organization, program,
A(100)
N
ProvidingOrganizationURL
41
-------
project, or other website as
appropriate.
03
NPS BMP
IDENTITY
NPS BMP
IDENTITY
MEASURE
Measure Unit
Code
The code that represents the
unit for measuring the item. If
the NPS BMP Component is
entered, the measure unit
elements for component are
mandated. If no component is
entered, the measure unit
elements are mandated at the
NPS BMP level.
A(12)
1-5302:1
C
MeasureUnitCode
03
NPS BMP
IDENTITY
NPS BMP
IDENTITY
MEASURE
Measure Unit
Code List
The name of a list of unit of
measure codes. Can be used to
identify the URL of a source
that defines the set of currently
approved values.
N
MeasureUnitCodeList
03
NPS BMP
IDENTITY
NPS BMP
IDENTITY
MEASURE
Measure Unit
Name
A description of the unit of
measure code. If the NPS BMP
Component is entered, the
measure unit elements for
component are mandated. If no
component is entered, the
measure unit elements are
mandated at the NPS BMP
level.
A(40)
1-5304:1
C
MeasureUnitName
03
NPS BMP
IDENTITY
NPS BMP
IDENTITY
MEASURE
Measured
Value
The recorded dimension,
capacity, quality, or amount of
something ascertained by
measuring or observing. If the
NPS BMP Component is
entered, the measure unit
elements for comp onent are
mandated. If no component is
entered, the measure unit
elements are mandated at the
NPS BMP level.
N(7)
1-6135:1
C
MeasuredValue
03
NPS BMP
IDENTITY
NPS BMP
IDENTITY
NPS BMP
Name
Name of the Non Point Source
Best Management Practice
Y
03
NPS BMP
IDENTITY
NPS BMP
IDENTITY
NPS BMP State
Unique
Identifier
The state's unique number
scheme for the NPS BMP
Y
42
-------
03
NPS BMP
IDENTITY
NPS BMP
IDENTITY
NPS BMP
Type
Type of Non Point Source Best
Management Practice
(agricultural, urban)
Y
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Coordinate
Data Source
Code
The code that represents the
party responsible for providing
the latitude and longitude
coordinates. Derived from EDR
Latitude/Longitude Data
Standard.
A(3)
1-5310:1
N
CoordinateDataSource
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Coordinate
Data Source
Name
The name of the code that
represents the party responsible
for providing the latitude and
longitude coordinates.
A(35)
N
C oordinateDataSourceName
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Data Collection
Date
The calendar date when data
were collected
Date (8)
1-5296:1
Y
DataC ollectionDate
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Geometric
Type Code
The code that represents the
geometric entity represented by
one point or a sequence of
latitude and longitude points
A(3)
1-5614:1
N
GeometricTypeC ode
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Geometric
Type Code List
Identifier
The name of a list of geometric
type codes. Can be used to
identify the URL of a source
that defines the set of currently
approved values.
N
GeometricTypeC odeListldentifier
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Geometric
Type Name
The name that identifies the
geometric entity represented by
one point or a sequence of
latitude and longitude points
A(6)
1-5761:1
N
GeometricTypeName
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Horizontal
Accuracy
Measure
The measure of the accuracy (in
meters) of the latitude and
longitude coordinates. Derived
from EDR Latitude/Longitude
Data Standard.
N(6)
1-5264:1
N
HorizontalAccuracy Measure
43
-------
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Horizontal
Collection
Method Code
Text
The code that represents the
method used to determine the
latitude and longitude
coordinates for a point on the
earth. If the Horzonatal
Collection Method is entered
and the Horizontal Reference
Datum Code is null, then
popluate the Horizontal
Reference Datum Code
associated with the entered
Horizontal Collection Method.
Values include: "ADDRESS
MATCHING-HOUSE
NUMBER", "ADDRESS
MATCHING-NEAREST
INTERSECTION",
"ADDRESS MATCHING-
OTHER", "ADDRESS
MATCHIN G-PRIMAR Y
NAME", "ADDRESS
MATCHING-STREET
CENTERLINE", "CENSUS
BLOCK/GROUP -1990-
CENTROID", "CENSUS
BL OC K/TRAC T-1990-
CENTROID", "CENSUS
BLOCK -1990 - CENTROID",
"CENSUS-OTHER",
"CLASSICAL SURVEYING
TECHNIQUES", "GPS -
UNSPECIFIED", "GPS
CARRIER PHASE
KINEMATIC RELATIVE
POSITION", "GPS CARRIER
PHASE STATIC RELATIVE
POSITION", "GPS CODE
(PSEUDO RANGE)
DIFFERENTIAL", "GPS
CODE (PSEUDO RANGE)
PRECISE POSITION", "GPS
CODE (PSEUDO RANGE)
STANDARD POSITION (SA
OFF)", "GPS CODE (PSEUDO
RANGE) STANDARD
POSITION (SA ON)", "GPS,
WITH CANADIAN ACTIVE
A(60)
1-5238:1
Horizont alC ollectionMethodC odeT ext
44
-------
CONTROL SYSTEM",
"INTERPOLATION -
DIGITAL MAP SRCE
(TIGER)", "INTERPOLATION
- SPOT", "INTERPOLATION -
MSS", "INTERPOLATION -
TM", "INTERPOLATION-
MAP", "INTERPOLATION-
OTHER",
"INTERPOLATION-PHOTO",
"INTERPOLATION-
SATELLITE", "LORANC",
"PUBLIC LAND SURVEY -
EIGHTH SECTION",
"PUBLIC LAND SURVEY -
FOOTING", "PUBLIC LAND
SURVEY - SIXTEENTH
SECTION", "PUBLIC LAND
SURVEY-QUARTER
SECTION", "PUBLIC LAND
SURVEY-SECTION",
"UNKNOWN", "ZIP CODE-
CENTROID", "ZIP+2
CENTROID", "ZIP+4
CENTROID"
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Horizontal
Reference
Datum Code
The code that represents the
reference datum used in
determining latitude and
longitude coordinates or
vertical measure.
A(3)
1-5308:1
N
HorizontalReferenceDatumCode
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Horizontal
Reference
Datum Code
List Identifier
The name of a list of
geographic reference datum
codes. Can be used to identify
the URL of a source that
defines the set of currently
approved values.
HorizontalReferenceDatumCodeListlde
45
-------
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Horizontal
Reference
Datum Name
The name that describes the
reference datum used in
determining latitude and
longitude coordinates or
vertical measure. Values are
NAD27, NAD83, WGS84,
UNKNOWN.
A(7)
1-5292:1 (N)
N
HorizontalReferenceDatumName
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Latitude
Measure
The measure of the angular
distance on a meridian north or
south of the equator. Derived
from EDR Latitude/Longitude
Data Standard. Will
accommodate signed values. If
the user enters any of the
latitude fields, all must be
entered.
N(8.6)
1-5518:1
N
L atitudeMeasure
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Location
Comments Text
The text that provides
additional information about the
geographic coordinates.
A(150)
1-5616:1
N
LocationCommentsText
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Longitude
Measure
The measure of the angular
distance on a meridian east or
west of the prime meridian.
Derived from EDR
Latitude/Longitude Data
Standard. Will accommodate
signed values. If the user enters
any of the longitude fields, all
must be entered.
N(9.6)
1-5520:1
N
L atitudeMeasure
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Reference Point
Code
The code that represents the
place for which geographic
coordinates were established. If
Horizontal Data Collection
Method is entered, then
Reference Point Code should be
entered.
A(3)
1-5608:1
C
ReferencePointCode
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Reference Point
Code List
Identifier
The name of a list of
geographic reference point
codes. Can be used to identify
the URL of a source that
defines the set of currently
approved permitted values.
N
ReferencePointCodeListldentifier
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Reference Point
Text
The text that identifies the place
for which geographic
coordinates were established.
A(60)
1-5288:1
N
ReferencePointT ext
46
-------
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Source Map
Scale Number
The number that represents the
proportional distance on the
ground for one unit of measure
on the map or photo. Derived
from EDR Latitude/Longitude
Data Standard.
N(10)
1-5318:1
N
SourceMapScaleNumber
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Verification
Method Code
The code that represents the
process used to verify the
latitude and longitude
coordinates.
A(3)
1-5268:1
N
VerificationMethodC ode
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Vertical
Accuracy
Measure
The measure of the accuracy of
the elevation measurement
expressed in the same units of
measure used to quantify the
Vertical Measure. Derived from
EDR Latitude/Longitude Data
Standard. This element is
required if an elevation
measurement is provided.
A(8)
1-5312:1
N
VerticalAccuracy Measure
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Vertical
Collection
Method Code
The code for the method used
to establish the elevation or
depth of the sampling site.
A(3)
1-5314:1
N
VerticalCollectionMethodCode
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Vertical
Collection
Method Text
The code name for the method
used to establish the elevation
or depth of the sampling site.
Values are: "GPS CARRIER
PHASE STATIC RELATIVE
POSITION", "GPS CARRIER
PHASE KINEMATIC
RELATIVE POSITION", "GPS
CODE (PSEUDO RANGE)
DIFFERENTIAL", "GPS
CODE (PSEUDO RANGE)
PRECISE POSITION", "GPS
CODE (PSEUDO RANGE)
STANDARD POSITION (SA
OFF)", "GPS CODE (PSEUDO
RANGE) STANDARD
POSITION (SA ON)",
"CLASSICAL SURVEYING
TECHNIQUES", "OTHER",
"ALTIMETRY", "PRECISE
LEVEL ING-BENCH MARK",
"LEVELING-NON BENCH
MARK CONTROL POINTS",
"TRIGONOMETRIC
A(60)
1-5326
C
VerticalCollectionMethodText
47
-------
LEVELING",
"PHOTOGRAMMETRIC",
"TOPOGRAPHIC MAP
INTERPOLATION"
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Vertical
Measure
The measure of elevation (i.e.,
the altitude), in meters, above
or below a reference datum.
Derived from EDR
Latitude/Longitude Data
Standard. Will accommodate
signed values.
N(10)
1-5612:1
VerticalMeasure
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Vertical
Measure Unit
Text
The code representing the name
of the standard of measurement
used to describe the elevation
value. The element is required
if an elevation measurement is
provided.
A(10)
C
VerticalMeasureType
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Vertical
Reference
Datum Code
The code for the reference
datum used to determine the
vertical measure.
Latitude/Longitude Data
Standard and FRS data flow
XML schema definitions.
A(3)
1-5306:1
N
VerticalReferenceDatumC ode
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
GEOGRAPHIC
LOCATION
DESCRIPTION
Vertical
Reference
Datum Name
The name of the reference
datum used to determine the
vertical measure.
Latitude/Longitude Data
Standard and FRS data flow
XML schema definitions.
A(60)
C
VerticalReferenceDatumName
48
-------
Values are: "NAVD88",
"NGVD29", "MEAN SEA-
LEVEL", "LOCAL TIDAL
DATUM", "OTHER"
NPS BMP
GEOGRAPHIC
LOCATION
Federal
Hydrologic
A standard code that identifies
the federally recognized
hydrologic unit in which the
majority of the BMP resides.
At a minimum the code would
identify the fourth order
hydrologic unit system (8
characters) but should identify
the fifth (10) and sixth (12)
order units for states with
completed National Watershed
04
IDENTITY
DESCRIPTION
HUC
Unit Code
Boundary Datasets
A(12)
1-70865:1
N
HUCode
04
NPS BMP
IDENTITY
GEOGRAPHIC
LOCATION
DESCRIPTION
County and
State FIPS
Code
The code that represents the
county or county equivalent anc
the state or state equivalent of
the United States.
A(5)
1-11:1
N
County StateFIPSCode
05
NPS BMP
IDENTITY
EVENT
FUNDING
Amount
The amount of the eligible cost
in whole dollars
Real (12)
1-24181
N
05
NPS BMP
IDENTITY
EVENT
FUNDING
Event Funding
Source
Optional field used for
indicating the funding source
for performing an implementer
specific event.
A(3)
1-79286:1
N
05
NPS BMP
IDENTITY
EVENT STATUS
Status Code
Status code is the target or
event code representing the
current status of a project
milestone
(MILESTONE_TYPE). The
related date is contained in
MILESTONE_DATE
A(2)
1-24300:1
Y
05
NPS BMP
IDENTITY
EVENT STATUS
Status Code
Date
Date of the project Milestone
Date (8)
Y
05
NPS BMP
IDENTITY
1
EVENT STATUS
Status
Description
STATUS_DESC is the
description of the
STATUS_CODE representing
the current status of a project
milestone
(MILESTONE TYPE)
A(160)
1-24302:1
Y
49
-------
06
NPS BMP
IDENTITY
NPS BMP
COMPONENT
IDENTITY
LAND USE
New Land Use
New Land Use with installation
of the NPS BMP Component
N
06
NPS BMP
IDENTITY
NPS BMP
COMPONENT
IDENTITY
LAND USE
Prior Land Use
Land Use prior to installation of
the NPS BMP Component
N
06
NPS BMP
IDENTITY
NPS BMP
COMPONENT
IDENTITY
MEASURE
Measure Unit
Code
The code that represents the
unit for measuring the item. If
the NPS BMP Component is
entered, the measure unit
elements for component are
mandated. If no component is
entered, the measure unit
elements are mandated at the
NPS BMP level.
A(12)
1-5302:1
C
MeasureUnitCode
06
NPS BMP
IDENTITY
NPS BMP
COMPONENT
IDENTITY
MEASURE
Measure Unit
Code List
The name of a list of unit of
measure codes. Can be used to
identify the URL of a source
that defines the set of currently
approved values.
N
MeasureUnitCodeList
06
NPS BMP
IDENTITY
NPS BMP
COMPONENT
IDENTITY
MEASURE
Measure Unit
Name
A description of the unit of
measure code. If the NPS BMP
Component is entered, the
measure unit elements for
component are mandated. If no
component is entered, the
measure unit elements are
mandated at the NPS BMP
level.
A(40)
1-5304:1
C
MeasureUnitName
06
NPS BMP
IDENTITY
NPS BMP
COMPONENT
IDENTITY
MEASURE
Measured
Value
The recorded dimension,
capacity, quality, or amount of
something ascertained by
measuring or observing. If the
NPS BMP Component is
entered, the measure unit
elements for component are
mandated. If no component is
entered, the measure unit
elements are mandated at the
NPS BMP level.
N(7)
1-6135:1
C
MeasuredValue
06
NPS BMP
IDENTITY
NPS BMP
COMPONENT
IDENTITY
NPS BMP
Component
Name
Name of the Non Point Source
Best Management Practice
Component
Y
50
-------
06
NPS BMP
IDENTITY
NPS BMP
COMPONENT
IDENTITY
NRCS Practice
Code
National Resource
Conservation System Practice
Code, if applicable.
N
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
The nature or genre of the
content of the resource.
A(100)
N
BinaryObject
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Content
The value of this element is the
actual document. If embedded
in the XML payload, this will
be base64 encoded. If the
document is sent as an
attachment, this element will be
empty but with an attribute of
the content ID referencing the
attached document. Either the
object itself must be provided
or the URL. Where the object
itself is provided, the file name,
type and content format
elements must be provided.
base64
binary
N
Content
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Content Format
The physical or digital
manifestation of the resource.
Typically, Format will include
the media -type or dimensions
of the resource. Format may be
used to identify the software,
hardware, or other equipment
needed to display or operate the
resource. Examples of
dimensions include size and
duration. Recommended best
practice is to select a value
from a controlled vocabulary
(for example, the list of Internet
Media Types (MIME) defining
computer media formats.).
Examples: "image/jpeg",
"text/html", "video/mpeg".
A(100)
C
Binary ObjectContentTypeText
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Contributor
An entity responsible for
making contributions to the
content of the resource.
A(50)
N
BinaryObjectC ontributor
51
-------
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Coverage
The extent or scope of the
content of the resource.
Typically, Coverage will
include spatial location (a place
name or geographic
coordinates), temporal period (a
period label, date, or date
range), or jurisdiction (such as a
named administrative entity),
Recommended best practice is
to select a value from a
controlled vocabulary (for
example, the Thesaurus of
Geographic Names (TGN) and
to use, where appropriate,
named places or time periods in
preference to a numeric
identifiers such as sets of
coordinates or date ranges.
A(100)
N
Binary ObjectCoverage
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Creator
An entity primarily responsible
for making the content of the
resource
A(100)
N
Binary ObjectCreator
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Date
A date of an event in the
lifecycle of the resource.
Typically, Date will be
associated with the creation or
availability of the resource.
Recommended best practice for
encoding the date value is
defined in profile of ISO 8601
(W3CDTF) and includes
(among others) dates of the
form YYYY-MM-DD.
Date
N
Binary Obj ectDate
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Description
An account of the content of the
resource.
A(2000)
N
Binary ObjectDescription
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
File Name
Included in the Node Document
object. The descriptive name
for the object document,
including file extension. Either
the object itself must be
provided or the URL. Where
the object itself is provided, the
file name, type and content
elements must be provided.
A(255)
C
Name
52
-------
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Identifier
An unambiguous reference to
the resource within a given
context. Recommended best
practice is to identify the
resource by means of a string or
number conforming to a formal
identification system. Formal
identification systems include
but are not limited to the
Unifo rm Resource Identifier
(URI) (including the Uniform
Resource Locator (URL)), the
Digital Object identifier (DOI),
and the International Standard
Book Number (ISBN).
A(12)
N
Binary Obj ectldentifierT ext
07
PROJECT
BINARY
OBJECTS
Binary Object
Language
A language of the intellectual
content of the resource.
Recommended best practice is
to use RFC 3066 (RFC3066),
which, in conjunction with ISO
639, defines two - and three-
letter primary language tags
with optional subtags.
Examples include "en" or "eng"
for English, "akk" for Akkadian
and "en-GB" for English used
in the United Kingdom.
A(20)
N
Binary Obj ectL anguage
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Publisher
An entity responsible for
making the resource available
A(12)
N
Binary Obj ectPublisher
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Relation
A reference to a related
resource.
A(100)
N
Binary Obj ectRelation
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Rights
Information about rights held in
and over the resource.
A(100)
N
Binary ObjectRights
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Size
Indicates the size in bytes of the
binary object (nonNegative
Integer). May be useful for
sender to determine how best to
handle file.
N(14)
N
Binary Ob j ect Size
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Source
A reference to a resource from
which the present resource is
derived.
A(100)
N
Binary Obj ectSource
53
-------
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Subject
A topic of the content of the
resource. Recommended best
practice is to select a value
from a controlled vocabulary or
formal classification scheme.
A(100)
N
Binary Obj ectSubj ect
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Title "
A name given to the resource
A(255)
N
BinaryObjectTitleText
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
Type
Included in the Node Document
object. Describes the general
type of the document object
(XML, flat, ZIP). Erther the
object itself must be provided
or the URL. Where the object
itself is provided, the file name,
type and content elements must
be provided.
A(5)
C
BinaryObjectType
07
NPS BMP
IDENTITY
PROJECT
BINARY
OBJECTS
Binary Object
url"
Describes the location of the
document where available on
the web. Either the object itself
must be provided or the URL.
A(100)
N
Binary Obj ect URL
54
-------
55
-------
DE. Simple checklist for implementing the BMPNPS_BMP Flow
#
Task Description
Specifics for Data Provider
Specifics for Data Consumer
1
Node must be implemented and pass all automated
test tools at httDs://test.eDacdxnode.net/test/ and
become "Ready to Flow"4
Node builders should not start building their Node
from scratch. Many resources are available on the
Network Website fwww.exchanaenetwork.net ) or
throuqh the Node Mentorinq Group5
Same for both Data Provider and
Consumer
Same for both Data Provider and
Consumer
2
Node Security Administrator must set up a test
NAAS account by calling the Network Help Desk at
888-890-1995 (Select Option 2) or by e-mail, send
support requests to nodehelpdesk@csc.com.
Same for both Data Provider and
Consumer
Same for both Data Provider and
Consumer
3
Node Implementers must implement the
appropriate security-specific web services as
defined in the Network Security Documents6.
Please Once tested, the Node Security
Administrators must get a production NAAS
account.
Note: If the Flow implementers is different from
the Node Administrator and is not familiar with
general Network Security requirements, the Flow
implementer must coordinate with their Node
Security Administrator.
Same for both Data Provider and
Consumer
Same for both Data Provider and
Consumer
4 For a functional definition of a Node "Ready to Flow" please see the document entitled Node, Flow, and Client Definitions and Implementation
Statuses located at http://www.exchanaenetwork.net
5 The Node Mentoring Group can be contacted by emailing or calling any of the members. Contact list available at
http://www.exchanaenetwork. net/common/content.asp?en=TA676220&cat=&sea=Yes&set=Both&sca=Yes&sct=Lona&pri=5&ead=tb&sad=lt
6 Security Documents are available to only Node Security Administrators and are available through the Network Help Desk
56
-------
5
Flow Implemented must identify and meet with
potential Network Partners to initiate the process of
implementing the Flow.
Note: In instances where the Data Consumer is the
public, then this step may be skipped.
If the data consumer is EPA, then the
Data Provider must contact Chris
Clark, Patrick Garvey, and Mash
Eslami to establish Partner to
CDX/FRS connectivity.
If a Data Provider is already offering
the exchange to other partners. Data
consumers may not have to do much
work. Data Consumers should check
the Exchange Network website or
contact the data provider to obtain
documentation governing the
exchange.
6
If an FCD for the flow Exists, Partners must
coordinate and decide what options from the FCD
will be implemented. (Generally concurrent with
Step 5.
Data Providers should invest a small
amount of time identifying if there are
efforts by other partners that may be
leveragable to jumpstart the Flow
Implementation.
Data Consumers may be able to
utilize existing client functionality to
minimize programming efforts to
implement the Flow.
7
Work with Partner to Establish Flow Test Procedures
All appropriate NAAS security
clearances should be clarified
between partners and coordinated
with Node Security Administrators.
All appropriate NAAS security
clearances should be clarified
between partners and coordinated
with Node Security Administrators.
8
Node Security Administrator must set up Node to
support the Exchange. (See #7)
See #7
See #7
9
Partners Test Flow
If the exchange is with EPA, Partner's
should contact the Help Desk to
arrange testing.
10
Partners Modify, Implement, and Document actual
Flow
11
Partners should post Partner-Specific Flow
documentation on the Network Registry and/or
Network Website as appropriate.
12
If appropriate, Establish TPA
13
Establish that the Node is in Production for &MP-NPS
BMP7
7 For a functional definition of a Node "Ready to Flow" please see the document entitled Node, Flow, and Client Definitions and Implementation
Statuses located at http://www.exchanaenetwork.net
57
-------
Appendix F
58
-------
-ER ExchangeNetworkDocument Instance File
|