<< Click to Display Table of Contents >> Navigation:  EQuIS Library > Formats > EarthSoft Interface Formats > Scribe Format

Format Name: Scribe

File Name: Scribe.zip

Source: Available for the EarthSoft Primary Point of Contact (POC) on the EarthSoft Community Center Downloads dashboard from the All Items > Formats folder.

Export(s): Not applicable

Enumeration File: Scribe-enum.xml

 

Description: The EQuIS Scribe format is used to import data to Scribe Desktop from an EQuIS database. Scribe is a software tool developed by the United State Environmental Protection Agency's Environmental Response Team (ERT) to assist in the process of managing environmental data. Scribe Desktop publishes projects and data to Scribe.NET as a way of storing and sharing between Scribe Desktop clients and/or enterprise SQL database clients. More information about Scribe can be accessed from the Scribe website.

 

The EQuIS Scribe format can be used in conjunction with the Scribe - LabResults Report to export data. See the Potential Workflow section of the report article for details. See the Scribe Interface page on how to use the Scribe button in EQuIS Professional to export data.

 

Installation Instructions: Download the Scribe format from the EarthSoft Community Center, unblock the *.zip file and extract the contents.

 

Overview: The EQuIS Scribe format consists of sections that mimic specific Scribe EDD templates provided by the USEPA. These EDD templates can be accessed from Scribe Materials by downloading the Scribe_EDD_Templates.zip file. The following sections are included in the EQuIS Scribe format:

•PropertyInfo (Scribe – EDDProperty)

•Location (Scribe – EDDLocation)

•Instruments (Scribe – EDDInstruments)

•Monitoring (Scribe – EDDMonitoringData)

•SamplesAir (Scribe – EDDAirSampling)

•SoilGasSampling (Scribe – EDDSoilGasSampling)

•SamplesSoil (Scribe – EDDSoilSampling)

•SamplesWater (Scribe – EDDWaterSampling)

•LabAnalysis (Scribe – EDDLabAnalysis)

•LabResults (Scribe – EDDLabResults)

 

 

 

Limitations/Assumptions: The checks and mappings in any EDD format involve assumptions. Here is a list of those assumptions and limitations for the EQuIS Scribe format:

•Test Alternate Key (TAK) fields in the format: The IDENTIFIER field does not exist in the Scribe format. If “Identifier” is toggled in the database test-level key fields, an error message will appear for DT_TEST upon the Create step.

•Confirm Scribe valid values based on your USEPA region. For instance, EPAR9 and EPAR2 Superfund have unique valid values that can be downloaded from Scribe Materials.

•The following values must exist in the database prior to import:

•PropertyInfo Section

•The PropertyType must exist in the RT_SUBFACILITY_TYPE table as SUBFACILITY_TYPE.

•The PropertyState must exist in the RT_STATE table as STATE_CODE.

•Location Section

•The GPS_CorrectionType must exist in the RT_COMPANY table as COMPANY_CODE.

•The Datum must exist in the RT_COORD_HORZ_DATUM table as HORZ_DATUM_CODE.

•The GeoMethod must exist in the RT_COORD_HORZ_METHOD table as HORZ_COLLECT_METHOD_CODE.

•The Surf_Units must exist in the RT_UNIT table as UNIT_CODE.

•The ElevMethod must exist in the RT_COORD_ELEV_METHOD table as ELEV_COLLECT_METHOD_CODE.

•The ElevDatum must exist in the RT_COORD_ELEV_DATUM table as ELEV_DATUM_CODE.

•"DATAPROVIDER" must exist in the RT_COMPANY_TYPE table as COMPANY_TYPE.

•The GPS_Collected_By must exist in the RT_COMPANY table as COMPANY_CODE.

•The Coord_Sys_Desc must exist in the RT_COORD_TYPE table as COORD_TYPE_CODE.

•Instruments Section

•The Instrument_Type must exist in the DT_EQUIPMENT table as EQUIPMENT_TYPE.

•"Cal_Isotope" must exist in the RT_EQUIPMENT_PARAM_TYPE table as PARAM_CODE.

•"Efficiency" must exist in the RT_EQUIPMENT_PARAM_TYPE table as PARAM_CODE.

•"Ref_Cal_Point" must exist in the RT_EQUIPMENT_PARAM_TYPE table as PARAM_CODE.

•"Detector_ID" must exist in the RT_EQUIPMENT_PARAM_TYPE table as PARAM_CODE.

•"Detector_Type" must exist in the RT_EQUIPMENT_PARAM_TYPE table as PARAM_CODE.

•"Mode" must exist in the RT_EQUIPMENT_PARAM_TYPE as table PARAM_CODE.

•Monitoring Section

•The Mon_Parameter must exist in the RT_ANALYTE table as CHEMICAL_NAME.

•The Mon_Meas_Units must exist in the RT_UNIT table as UNIT_CODE.

•The Mon_Criteria_Units must exist in the RT_UNIT table as UNIT_CODE.  

•The Mon_Meas_Surface must exist in the RT_MATRIX  table as MATRIX_CODE.

•The Instrument_Type must exist in the RT_EQUIPMENT_TYPE table as EQUIPMENT_TYPE.

•The Datum must exist in the RT_COORD_HORZ_DATUM table as HORZ_DATUM_CODE.  

•The GeoMethod must exist in the RT_COORD_HORZ_METHOD table as HORZ_COLLECT_METHOD_CODE.  

•The Surf_Units must exist in the RT_UNIT table as UNIT_CODE.  

•The ElevMethod must exist in the RT_COORD_ELEV_METHOD tavle as ELEV_COLLECT_METHOD_CODE.  

•The ElevDatum must exist in the RT_COORD_ELEV_DATUM table as ELEV_DATUM_CODE.    

•The Mon_Source must exist in the RT_SAMPLE_METHOD table as METHOD_CODE.

•SamplesAir Section

•The SampleType must exist in the RT_SAMPLE_TYPE table as SAMPLE_TYPE_CODE.

•The Matrix must exist in the RT_MATRIX table as MATRIX_CODE.

•The Volume_Units must exist in the RT_UNIT table as UNIT_CODE.  

•The Flow_Units must exist in the RT_UNIT table as UNIT_CODE.  

•The Datum must exist in the RT_COORD_HORZ_DATUM table as HORZ_DATUM_CODE.    

•The GeoMethod must exist in the RT_COORD_HORZ_METHOD table as HORZ_COLLECT_METHOD_CODE.    

•The Surf_Units must exist in the RT_UNIT table as UNIT_CODE.    

•The ElevMethod must exist in the RT_COORD_ELEV_METHOD table as ELEV_COLLECT_METHOD_CODE.

•The ElevDatum must exist in the RT_COORD_ELEV_DATUM table as ELEV_DATUM_CODE.      

•The Coll_Method must exist in the RT_SAMPLE_METHOD table as METHOD_CODE.

•The Coord_Sys_Desc must exist in the RT_COORD_TYPE table as COORD_TYPE_CODE.

•The Media_Type must exist in the RT_EQUIPMENT_TYPE table as EQUIPMENT_TYPE.

•The SampleCollection must exist in the RT_SAMPLE_METHOD table as METHOD_CODE.

•The Samp_No must exist in the DT_SAMPLE table as SYS_SAMPLE_CODE.

•"Start_Date" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Flow_Units" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Pre_Cal" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Start_Count" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Stop_Date" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Post_Cal" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Avg_Flow" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Stop_Count" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Time_Counter" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Total_Time" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Start_Temp" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Start_Pres" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Stop_Temp" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Stop_Pres" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Pre_Magnehelic" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Post_Magnehelic" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Orifice_ID" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•"Samp_Con" must exist in the RT_SAMPLE_PARAM_TYPE table as PARAM_CODE.

•The Analyses must exist in the RT_ANALYTIC_METHOD table as ANALYTIC_METHOD.

•The Preservation must exist in the RT_PRESERVATIVE table as PRESERVATIVE.

•SoilGasSampling Section

•The SampleType must exist in the RT_SAMPLE_TYPE table as SAMPLE_TYPE_CODE.  

•The Matrix must exist in the RT_MATRIX table as MATRIX_CODE.  

•The Samp_Depth_Units must exist in the RT_UNIT table as UNIT_CODE.

•The Datum must exist in the RT_COORD_HORZ_DATUM table as HORZ_DATUM_CODE.

•The GeoMethod must exist in the RT_COORD_HORZ_METHOD table as HORZ_COLLECT_METHOD_CODE.

•The Surf_Units must exist in the RT_UNIT table as UNIT_CODE.    

•The ElevMethod must exist in the RT_COORD_ELEV_METHOD table as ELEV_COLLECT_METHOD_CODE.  

•The ElevDatum must exist in the RT_COORD_ELEV_DATUM table as ELEV_DATUM_CODE.    

•The Coord_Sys_Desc must exist in the RT_COORD_TYPE table as COORD_TYPE_CODE.    

•The Preservation must exist in the RT_PRESERVATIVE table as PRESERVATIVE.      

•The Analyses must exist in the RT_ANALYTIC_METHOD table as ANALYTIC_METHOD.  

•The Coll_Method must exist in the RT_SAMPLE_METHOD table as METHOD_CODE.  

•The Samp_No must exist in the DT_SAMPLE table as SYS_SAMPLE_CODE.  

•SamplesSoil Section

•The SampleType must exist in the RT_SAMPLE_TYPE table as SAMPLE_TYPE_CODE.  

•The Matrix must exist in the RT_MATRIX table as MATRIX_CODE.  

•The Samp_Depth_Units must exist in the RT_UNIT table as UNIT_CODE.

•The Datum must exist in the RT_COORD_HORZ_DATUM table as HORZ_DATUM_CODE.

•The GeoMethod must exist in the RT_COORD_HORZ_METHOD table as HORZ_COLLECT_METHOD_CODE.

•The Surf_Units must exist in the RT_UNIT table as UNIT_CODE.    

•The ElevMethod must exist in the RT_COORD_ELEV_METHOD table as ELEV_COLLECT_METHOD_CODE.  

•The ElevDatum must exist in the RT_COORD_ELEV_DATUM table as ELEV_DATUM_CODE.  

•The Coll_Method must exist in the RT_SAMPLE_METHOD table as METHOD_CODE.

•The Coord_Sys_Desc must exist in the RT_COORD_TYPE table as COORD_TYPE_CODE.  

•The Analyses must exist in the RT_ANALYTIC_METHOD table as ANALYTIC_METHOD.  

•The Preservation must exist in the RT_PRESERVATIVE table as PRESERVATIVE.

•SamplesWater Section

•The SampleCollection must exist in the RT_SAMPLE_METHOD table as METHOD_CODE.

•The SampleType must exist in the RT_SAMPLE_TYPE table as SAMPLE_TYPE_CODE.  

•The Matrix must exist in the RT_MATRIX table as MATRIX_CODE.  

•The Samp_Depth_Units must exist in the RT_UNIT table as UNIT_CODE.

•The ConductUnits must exist in the RT_UNIT table as UNIT_CODE.    

•The Diss02Units must exist in the RT_UNIT table as UNIT_CODE.      

•The Preservation must exist in the RT_PRESERVATIVE table as PRESERVATIVE.      

•The Analyses must exist in the RT_ANALYTIC_METHOD table as ANALYTIC_METHOD.  

•The Datum must exist in the RT_COORD_HORZ_DATUM table as HORZ_DATUM_CODE.

•The GeoMethod must exist in the RT_COORD_HORZ_METHOD table as HORZ_COLLECT_METHOD_CODE.

•The Surf_Units must exist in the RT_UNIT table as UNIT_CODE.    

•The ElevMethod must exist in the RT_COORD_ELEV_METHOD table as ELEV_COLLECT_METHOD_CODE.  

•The ElevDatum must exist in the RT_COORD_ELEV_DATUM table as ELEV_DATUM_CODE.  

•The Coll_Method must exist in the RT_SAMPLE_METHOD table as METHOD_CODE.

•The Coord_Sys_Desc must exist in the RT_COORD_TYPE table as COORD_TYPE_CODE.  

•LabAnalyses Section

•The Turnaround_Units must exist in the RT_UNIT table as UNIT_CODE.

•LabResults Section

•The Matrix must exist in the RT_MATRIX table as MATRIX_CODE.  

•The Sample_Type_Code must exist in the RT_SAMPLE_TYPE table as SAMPLE_TYPE_CODE.

•The Analytical_Method must exist in the RT_ANALYTICAL_METHOD table as ANALYTIC_METHOD.

•The Extraction_Method must exist in the RT_PREP_METHOD table as PREP_METHOD.

•The Cas_no must exist in the RT_ANALYTE table as CAS_RN.

•The Results_Units must exist in the RT_UNIT table as UNIT_CODE.  

•The MDL_Units must exist in the RT_UNIT table as UNIT_CODE.  

•The Quantitation_Limit_Units must exist in the RT_UNIT table as UNIT_CODE.  

•The Reporting_Limit_Units must exist in the RT_UNIT table as UNIT_CODE.  

•The Result_Type_Code must exist in the RT_RESULT_TYPE table as RESULT_TYPE_CODE.

•The Test_Type must exist in the RT_TEST_TYPE table as TEST_TYPE.

•The SubSample_Amount_Unit must exist in the RT_UNIT table as UNIT_CODE.  

•The Final_Volume_Unit must exist in the RT_UNIT table as UNIT_CODE.  

 

For custom checks and additional default mappings, please see the EDD Description file for the Scribe format.

 

 

Scribe Remapping: A solution to integrating reference values where an internal code might differ from an external code is remapping those specific values in Professional. This is especially useful when trying to standardize code in a database. For example, Scribe uses “T” as a reference value and perhaps the EQuIS database is setup to use “Total” as a reference value. A remap code would be applied when generating the Scribe - LabResults Report so that the report uses Scribe’s "T”, but the database would store that value as “Total”.

 

 

More information on an alternative way to create a remap set can be accessed from the Remap Sets - Creating a Set article.

 

 

EQuIS Table Mappings: