EDPManual v2.1
EDPManual v2.1
April 2008
1.0 INTRODUCTION
The Environmental Quality Information System (EQuIS) Data Processor (EDP) has been made available to
data providers in order to check their Electronic Data Deliverable (EDD) files prior to submittal to EPA
Region 5. The EDP is used to ensure EDD files are formatted as described in the ‘Comprehensive
Electronic Data Deliverable Specification Manual’. If the EDP detects errors, the errors can be viewed
directly within the EDP or via an error log. After the errors are corrected by the data provider, the EDP
should be re-run to assure that no errors remain. The EDD files can then be signed and submitted and
posted to the Region 5 EDD .ftp site for incorporation into the regional database.
The EDP is a product of EarthSoft, Inc. and replaces the two previous Region 5 EDD checker applications,
the Electronic Laboratory Data Checker (ELDC) and the Electronic Field Data Checker (EFDC). The EDP
is a single application that checks all EDD files and provides much easier use with a straight-forward
interface for identifying and correcting errors.
The sole purpose of this document is to assist EPA Region 5 data providers in the installation and use of the
EDP in conjunction with submitting EDD data files to Region 5. Therefore, this document only provides
information pertaining to the specific requirements of the Region 5 EDD specifications and is not intended
to be a comprehensive EDP Manual. For more detailed discussion of the functionality and technical
specifications of EDP, please refer to EarthSoft’s web site at www.earthsoft.com.
• Required Fields;
• Field Lengths;
• Data Types;
• Valid Dates;
• Reference Values;
• Duplicate Rows;
• Range Checking; and
• Record Parent-Child Relationships.
The EDP installation application can be downloaded from the EPA Region 5 GEOS EDD Support website
at http://www.epa.gov/region5/superfund/edman/edpinfo.html. Click on the ‘Download the EDP’ link to
begin the download process.
Open the directory where the EDP installation application was downloaded and double-click the file. The
install wizard will guide you step by step through the installation procedure. It is important to note that
during installation you should have no other programs running.
Click the next button. The License Agreement screen will appear. Select ‘I accept the license agreement’
radio button and click the ‘Next’ button.
Enter full name and organization and select the desired setting. Click the ‘Next’ button.
Select the destination folder for the application files. Click the ‘Next’ button.
Click the icon next to EPA Region 5 Format Files and select ‘Entire feature will be installed on local hard
drive’ and then click the ‘Next’ button.
Click the ‘Next’ button and you will be presented with the Editing and Auditing screen.
Selecting ‘Yes’ will allow you to make edits directly to the data in the EDD file via the EDP. Selecting
‘No’ will not permit any editing to the EDD file via the EDP and all edits to the file must be done directly to
the EDD text file after exiting the EDP. You also have the option of auditing all changes that are made to
the data files. A log is created that includes the date and time, the user, the original value, and the new
value. If Audit is selected, you will also have to select a directory to which the auditing files will be stored.
Once the selection is made, click the ‘Next’ button.
Click the ‘Next’ button to begin the installation. When the installation is done, you will be presented with a
window that verifies that the EDP has been successfully installed. Click the ‘Finish’ button to exit the
installation.
Once installed, the EDP must be registered. Start the EDP application by selecting
Start>All Programs>EarthSoft>EQuIS Data Processor.
The EDP application will start and a blank screen appears. Select ‘Format’ from the upper menu.
The ‘Software Registration’ screen will appear. Click the first link to the registration request page.
Enter the requested information in the ‘Key Request’ form. When all information has been entered, click
‘Submit’. After the registration form has been evaluated by Region 5, a registration key will be sent to the
e-mail address provided in the registration form.
Once the registration key has been received, register the EDP by starting the application, Start>All
Programs>EarthSoft>EQuIS Data Processor. The above screen appears. Click ‘Register’ button.
Enter the registration key sent via e-mail in the ‘New Key Codes’ field and click the ‘Save Key(s)’ button.
A screen stating that the registration succeeded should appear. The EDP is now registered and ready for
use.
Start the application by selecting Start>All Programs>EarthSoft>EQuIS Data Processor from the Windows
‘Start’ menu.
The EDP will open. Select the ‘EPA Region 5’ tab located at the bottom of the screen (as indicated by the
arrow in the example below). The Region 5 file formats are displayed along the left side of the window.
An empty table with the field names associated with the highlighted file type is displayed along the top.
Each of the EDD file types listed in the EDP corresponds to the EDD files described in the Region 5
‘Comprehensive Electronic Data Deliverable Specification Manual’ and ‘Basic Electronic Data Deliverable
Specification Manual’. In the screen below, the ‘EPAR5DATAPROVIDER_v2’ format has been selected
and its associated fields are displayed across the top.
Fields with red text are ‘Required’ fields and cannot be left blank; they must be populated with data.
Information about each field is provided when the cursor is placed over the field name (As indicated in the
example below).
Files are checked either by loading individually created EDD files into EDP, by loading a single Access
database created with individual tables named according to the naming conventions, or by loading an Excel
spreadsheet with tabs named according to the naming conventions.
To load a single EDD file, first, select the format type of the EDD file to be checked from the format list at
the left. In the example below, an EPAR5SMP_v2 file is going to be checked, therefore, the
EPAR5SMP_v2 format has been selected. Next, load the EDD data file by clicking the EDD icon located in
the top menu bar (as indicated by arrow 1 in the example below) or right-click on the format type and select
‘Load Data File’ (as indicated by arrow 2 in the example below).
Use the Browse window to locate the EDD file and select ‘Open’. The data file will load to the EDP and be
checked during loading. Data will be displayed in the table and any detected errors will be shaded. Note: If
the data file contains header rows, EDP will identify fields in the header rows as errors unless each header
row is preceded by a pound-sign character (#).
To load a single EDD file containing multiple format sections, click the EDD button from the menu bar
(Arrow 1 above), use the browsing window to locate the EDD file, and select ‘Open’. The EDP will then
load the constituent parts of the EDD into the appropriate locations and display any errors. Note: This
method may take several minutes.
In the screen below, rows 4, 7, and 13 have errors. Each type of error is shaded differently. Place the cursor
over the error to show the type of error (Arrow 1). To hide header rows that appear as errors, highlight the
header rows, select ‘Set as Comment Row’ (Arrow 2) from the top menu, and then uncheck ‘Comment
Rows’ also located in the top menu (Arrow 3). To unhide the header row, re-check the ‘Comment Rows’
box.
To view only the rows with errors, check the box next to ‘Errors Only’ located in the top menu bar (as
indicated by the arrow in the example below). To restore all the rows, uncheck the ‘Errors Only’ box.
To clear the data from EDP, select ‘Clear’ from the top menu, then select ‘Clear EDD’ (as indicated by the
arrow in the example below). The EDD file will be cleared from the EDP viewer. Note: Clearing the data
from the EDP will not delete the EDP file; it only removes the file from the viewer.
EDP produces an error log that can be saved as an HTML formatted file. In the top menu, select ‘Error
Log’ to view and save the error details or ‘Summary’ to view and save a summary of the errors (as indicated
by the arrows in the example below). Use the Browse window to locate the desired location and select
‘Save’. The error log will then be saved in the selected folder.
As stated above, the data are being checked for errors by the EDP as the EDD files are loading. The fields
with errors will be shaded different colors depending on the type of error. The types of errors being checked
for by the EDP are described in Appendix A.
A description of the error is provided when the cursor is placed over the field. In the example below, the
sample_matrix_code value in line 7 is not a valid value.
Note: If data providers believe that a new reference value is required, they should follow the process
described in the ‘Comprehensive Electronic Data Deliverable Specification Manual’ to request that the
value be added.
The ‘Find and Replace’ function allows users to search the file for a specified value and then replace it with
another value. This function is useful when there are a number of similar values that need to be changed.
The ‘Find and Replace’ function is activated by selecting the binoculars icon located in the Data menu
(as indicated by the arrow in the example below). The ‘Find and Replace’ dialog will appear. Type the
value to be replaced in the ‘Find What’ field and the new value in the ‘Replace With’ field. Select ‘Find’ to
view fields with the value and ‘Replace’ to replace the original value with the new value.
To save the changes made to the EDD data file, click the checked notepad icon located in the upper-
right corner of the EDP and then select Save>EDD. Use the Browse window to locate the folder where the
EDD file is to be saved and click ‘Save’. Any changes made to the EDD will now be saved.
Note: Only the individual EDD file selected in the left-hand format field and displayed in the main
workspace will be saved. Therefore each EDD file should be saved separately, as appropriate.
The ‘Sign and Submit’ function of the EDP allows all files within an EDD to be compiled into the final Data
Package which is subsequently submitted to Region 5. During the ‘Sign and Submit’ process, the EDP will
name all loaded files from the Region 5 format according to predetermined naming conventions before
compressing them into a single .zip file. Also included in the .zip file is a user certificate, which consists of
the username and password assigned upon registration of the EDP, as well as the 12 character EPA ID of the
site for which data is being submitted. This user certificate identifies to which sites a user is allowed to
submit data, in addition to providing security authentication required for the automatic upload of data from
the Region 5 .ftp site.
To create a Data Package using the ‘Sign and Submit’ function, a user must first ensure that all files to be
included in the data submission have been loaded into the EDP. Select the checked notepad icon in the
upper-right corner of the screen and then select ‘Sign and Submit’ from the menu list.
This will open the ‘Sign and Submit’ authentication screen. This should be populated with your Region 5
provided user name, password, and the 12 character EPA ID for the site pertaining to the EDD files.
After entering the correct authentication information, click the ‘Submit’ button. Next select the location
where you would like the .zip file saved and ensure that the file name of the ‘Data Package’ matches the
required naming conventions. Click the ‘Save’ button.
After the EDD files have been checked by the EDP and the ‘Sign and Submit’ process has been completed,
the Data Package is ready for submittal to EPA Region 5. Please follow the procedures for submitting EDD
files described in Region 5’s ‘Comprehensive Electronic Data Deliverable Specification Manual’ or ‘Basic
Electronic Data Deliverable Specification Manual’ found on the EPA Region 5 GEOS EDD Support
website located at http://www.epa.gov/region5superfund/edman.
Periodically, EPA Region 5 will post an updated reference value file (.rvf) on the Region 5 GEOS EDD
Support website located at http://www.epa.gov/region5superfund/edman. Follow the steps below to update
the reference values in the EDP application:
1. Download the most recent reference value file from EPA Region 5 GEOS EDD Support website.
2. Replace the existing reference value file, ‘EPAR5.rvf’, located in the C:\Program
Files\EarthSoft\EQuIS\Formats\EPAR5 folder, with the downloaded file.
3. The next time EDP is started, the new reference values will be loaded.
If Region 5 makes changes to the format of the existing EDD, the EDP application will need to be updated
with a new format file. Follow the steps below to update the format file in the EDP application:
1. Download the most recent format file from EPA Region 5 GEOS EDD Support website,
http://www.epa.gov/region5superfund/edman.
2. Replace the existing format file, ‘EPAR5.xse’, located in the C:\Program
Files\EarthSoft\EQuIS\Formats\EPAR5 folder, with the downloaded file.
3. The next time EDP is started, the new format files will be loaded.
Note: Region 5 does not expect to make changes to the format in the near future; however, if changes
are made, Region 5 will provide notification of the format changes to all data providers.
APPENDIX A
This appendix describes the errors identified by the EDP.
5. Out of Range
The value is not within the allowable range of values. Most numeric fields will not
allow a negative value to be entered. Only certain exceptions are made for field
measurements.
6. Duplicate Row
Two or more records have the same values in the primary key fields. The primary
key fields are the fields that make each record in the file unique. No two records can
have the same values in the primary keys. For example, the EPAR5LOC file has the
sys_loc_code field as the primary keys. Two records that both have ‘MW-01’ in the
sys_loc_code fields would be considered duplicate records. To make each record
unique, one record would have to be changed so that the sys_loc_code was
something other than ‘MW-01’. Refer to Section 2.6 of the ‘Comprehensive EDD
Specification Manual’ for further discussion of duplicate records.
7. Orphan Row
The record is missing a required parent record. Records that depend on information
(i.e., child records) from another record (i.e., parent record) must reference the
parent record and the parent record must exist in the corresponding file. For
example, each row in the EPAR5TRS file must include a sys_sample_code that
corresponds to a sys_sample_code reported in the EPAR5SMP file. If a record in the
EPAR5TRS file has a sys_sample_code of GWSMP-006 then a record must also be
included in the EAPR5SMP file with a sys_sample_code of GWSMP-006. If a record
in the EPAR5TRS file has a sys_sample_code that is not included in the EPAR5SMP
file, an ‘orphan record’ error will be identified. See Section 2.6 of the
‘Comprehensive EDD Specification Manual’ for further discussion of child/parent
records.
Note: When checking the EPAR5BAT file, the EPAR5TRSQC file must be checked through the
EDP prior to checking the EPAR5BAT file, otherwise all records in the EPAR5BAT file will
be identified as ‘Orphan Row’ Errors. The EPAR5BAT file is only submitted if an
EPAR5TRSQC file is submitted.
11. Parent_sample_code is Required Where sample_type_code = BD, FD, FR, FS, LR,
MS, SD, or MSD
Identifies records that have a sample_type_code (EPAR5SMP, Column 5) of ‘BD’,
‘FD’, ‘FR’, ‘FS’, ‘LR’, ‘MS’, ‘SD’, or ‘MSD’ but are missing the appropriate
parent_sample_code (EPAR5SMP, Column 7). The above sample_type_codes
signify duplicates, and the sample identifier (i.e., sys_sample_code) of the original
sample from which the duplicate was derived must be populated in the
parent_sample_code (EPARSMP, Column 7) field. The parent_sample_code value
must match the sys_sample_code of the original sample and the original sample
must also be reported as a separate record in the EPAR5SMP file (i.e., there should
be a record for the original sample and a separate record for the duplicate sample).