The Exchange Network can be used to exchange an infinite variety of data, and Exchange Network partners routinely create new exchanges for doing so. This guide describes high level steps and best practices for creating a new exchange and ensuring that it meets stakeholder needs, complies with relevant technology and data standards, and can be used by others on the Exchange Network. It is also available for download in PDF format. For further information, please see the Build an Exchange section of the Exchange Network website and refer to Exchange Design Guidance and Best Practices.
How do I get started? |
1. |
Decide What Data You Want to Exchange |
Data exchanges help you meet business needs that involve sharing information. A need may be mandatory reporting of environmental data to an oversight agency, or it might be sharing monitoring data to get the complete picture of influences on an ecosystem. To avoid duplication, check out the list of current data exchanges on the Exchange Network website. If the exchange you are interested in already exists, please consult the Join an Existing Exchange Getting Started Guide. |
|
|
|
2. |
Get Funding |
Some Exchange Network partners have used their own funding for building data exchanges; others have applied for federal money through the Exchange Network Grant Program. To learn if your new data exchange project might be eligible for the Exchange Network Grant Program, please read the Apply for an Exchange Network Grant Getting Started Guide and visit the EPA Exchange Network Grant Program Web pages. You may also consider applying for funding through programmatic grants. |
|
|
|
3. |
Convene an Integrated Project Team of Stakeholders |
Exchanges are typically designed by an Integrated Project Team (IPT) that helps develop ideas, scope the exchange, and develop exchange-related products. There are no strict rules for forming an IPT, but it helps to have a range of perspectives and expertise in both program and technical areas. A model IPT might include:
- Business area experts from two or more organizations, each with a programmatic interest in the data,
- Technical experts familiar with the data systems of each of the pilot data exchange partners, and
- Technical experts familiar with XML schema design and Exchange Network technologies and standards.
|
|
|
|
4. |
Scope Requirements |
The IPT begins by developing the scope of the exchange, including:
- The type of exchange: regular submissions from one partner to another OR data publishing that allows partners to pull data from each other’s Nodes (some hybrid exchanges draw on both), and
- Key overarching design items, including the data exchange design and architecture, what data will be exchanged, the frequency of transactions, and other items.
|
|
|
|
5. |
Develop Exchange Related Products |
Each IPT should produce a series of products to enable others to participate in the exchange. The Flow Documentation Checklist provides a complete catalogue of the required products. Below is a partial list:
- XML Schema - Defines the form and structure of the data being exchanged.
- IPTs are encouraged to get free advice by using early engagement services for a short technical review that can help resolve problems early in the process.
- XML schema should be consistent with
- There are several documents related to schema development and use on the Exchange Network that schema developers should consult:
- Data Exchange Template (DET) - Lists each data element in the schema with definitions, validation rules, and example content (a human-readable version of the schema).
- Normally, IPTs develop a DET at the same time they develop the schema.
- Use the DET Template on the Exchange Network website to produce a user friendly resource.
- Example XML Instance Document - Sample XML file based on the exchange schema.
- You can download example XML instance documents from some data exchange pages on the Exchange Network website. (For example, see the instance document for the National Emissions Inventory.)
- Create an example XML file any time after developing a schema and before publishing the exchange.
- Flow Configuration Document (FCD) - Captures the detailed data exchange processing rules governing the data exchange using narrative text, diagrams and examples.
- Use the FCD Template on the Exchange Network website to guarantee a user friendly aid.
- Use Agreement (optional) - Defines the non-technical terms and conditions of participation in the exchange.
- Individual agreements may be worked out with each partner to reflect their unique needs. Often it is helpful to create a template for the agreement, especially if the exchange is not driven by well-documented historical reporting requirements.
- You may find these resources helpful:
- Schema Conformance Report - Describes findings from a comparison of the final draft schema with the guidelines for schema design prepared by Exchange Network governance. For assistance, see the Schema Conformance Report Preparation and Review Process v2.0.
|
|
|
|
6. |
Test Exchange Components |
Testing should be conducted for as many use scenarios as possible to ensure that as many potential flaws as possible are discovered and addressed before the exchange is used broadly. The EPA CDX Schematron (see SchematronValidation and Guidance) and the CDX Test Node may be useful during testing. |
|
|
|
7. |
Publish and Maintain Your Data Exchanges |
When testing and quality control/assurance have been finalized, it is time to seek a final review and invite Exchange Network partners to join the exchange, known as “publishing an exchange.”
- A schema conformance review must be done by the Network Technology Group before the exchange can be posted on the Exchange Network website.
- For publishing steps, refer to the Publish a Data Exchange pages on the Exchange Network website.
- Change Management Principles, Rules and Procedures are extremely important to:
- Finalize exchange resources before releasing them to the broader Exchange Network community,
- Observe proper version control practices for these resources, and
- Make updates to keep pace with changing business needs, standards, and technologies.
|
Who can I talk to? |
|
|