<< Click to Display Table of Contents >> Navigation: EQuIS Library > Formats > EarthSoft Standard Formats > refvals Format |
Format Name: refvals
File Name: refvals.zip
Source: EDP Standalone, EQuIS Professional, and EQuIS Enterprise (only in format installation folder)
Export(s): Yes (see section below)
Enumeration File: Not applicable
Description: This format contains an EDD section for each of the reference value tables within the EQuIS Database Schema. Use this format to import, update, and/or export reference values.
Installation Instructions: The refvals format is included in the installation of EDP Standalone and EQuIS Professional in the \Formats\EarthSoft folder. This format is also provided with the installation of EQuIS Enterprise but requires configuration to be available in the Enterprise EDP EDD Upload widget. If the format should be configured for EQuIS Enterprise, an administrator will need to define the commit type and other EDP Enterprise elements as defined in the Workflow Widget and Add or Modify Enterprise EDP Formats articles.
Overview: See Standard EQuIS Formats to see what tables the refvals format populates.
Import Reference Values from Existing .rvf File: EQuIS databases do not come with a set of reference values. This allows administrators to choose and customize their own list of reference values, without cluttering the reference tables with values that may not end up being used. Reference values can be loaded using one of the sets of reference values in *.rvf form, distributed by a regulatory agency. The following steps outline the process for loading one of these *.rvf files as your initial reference value sets.
1.Create a reference value file. See Creating a Reference Value File from Professional EDP for additional information.
2.Using Windows Explorer, navigate to the saved (*.rvf) file and rename the (*.rvf ) file extension to (*.xml). Select Yes when prompted to confirm changing the file name extension. For example, references.rvf would become references.xml.
3.Open EDP Professional by first opening EQuIS Professional and then clicking EDP.
4.Click Format.
5.Open the refvals.zip format (e.g., C:\Program Files\EarthSoft\EQuIS\Formats\EarthSoft\refvals.zip or, per-user installation, %localappdata%\Programs\EarthSoft\EQuIS\Formats\EarthSoft\). Click Open.
6.Click EDD and select the {references}.xml file.
Warnings When Creating EDD Files: •The included values must match the expected values in the appropriate sections of the format. •The .txt file name(s) must match the appropriate section name(s) in the format. •The Excel file's Worksheet name(s) must match the appropriate section name(s) in the format. •Professional and EDP do not recognize superscript values as unique values in the database and will cause a Primary Key violation. Do not use superscript text in the EQuIS database (e.g., in RT_UNIT.UNIT_CODE). |
7.Fix any errors (status_flag, ebatch, and display_order columns should have been removed previously).
8.Save the *.xml file, if necessary.
9.Create and Commit the package using the appropriate commit type.
10.See Confirm Status of Recently Imported Reference Values to confirm if the reference value data from a previously loaded EDD is active.
EQuIS Table Mappings:
•AT_COMPANY •AT_COMPANY_PERSON •AT_EQUIPMENT_PARAMETER •AT_GEO_UNIT •RT_ACTION_LEVEL_TYPE •RT_ANALYTE •RT_ANALYTE_DETAIL •RT_ANALYTE_VAR •RT_ANALYTIC_METHOD •RT_BASIN •RT_COMPANY_TYPE •RT_COMPANY •RT_COORD_ELEV_DATUM •RT_COORD_ELEV_METHOD •RT_COORD_GEOMETRIC_TYPE •RT_COORD_HORZ_DATUM •RT_COORD_HORZ_METHOD •RT_COORD_TYPE •RT_COORD_VERIFICATION •RT_DOWNHOLE_POINT_PARAM_TYPE •RT_EQUIPMENT_PARAM_TYPE •RT_EQUIPMENT_TYPE •RT_FACILITY_PARAM_TYPE •RT_FILE_PARAM_TYPE |
•RT_FILE_TYPE •RT_FINDING_TYPE •RT_FRACTION •RT_FREQUENCY •RT_GEO_UNIT_TYPE •RT_GEOLOGIC_UNIT •RT_GROUP •RT_GROUP_MEMBER •RT_LAND_USE •RT_HOLDING_TIME •RT_LOCATION_PARAM_TYPE •RT_LOCATION_TYPE •RT_LOOKUP •RT_MATERIAL •RT_MATRIX •RT_MATRIX_CLASS •RT_MEASURE_DATUM •RT_MEDIUM •RT_MTH_ANL_GROUP •RT_MTH_ANL_GROUP_MEMBER •RT_NOTE_TYPE •RT_PARAM_TYPE •RT_PREP_METHOD •RT_PRESERVATIVE |
•RT_QUALIFIER •RT_REMAP •RT_REMAP_DETAIL •RT_RESULT_PARAM_TYPE •RT_RESULT_TYPE •RT_SAMPLE_METHOD •RT_SAMPLE_PARAM_TYPE •RT_SAMPLE_TYPE •RT_SOIL_GAS_PARAM_TYPE •RT_STATE •RT_STREAM •RT_SUBFACILITY_PARAM_TYPE •RT_SYMBOL •RT_TASK_PARAM_TYPE •RT_TASK_TYPE •RT_TEST_BATCH_TYPE •RT_TEST_PARAM_TYPE •RT_TEST_TYPE •RT_TIMEZONE •RT_TIMEZONE_OFFSET •RT_UNIT •RT_UNIT_CONVERSION_FACTOR •RT_VALID_CODE •RT_WELL_SEGMENT_TYPE |
Export: The Refvals EDD export will pull data into the sections of the format from the database tables of the same name. For records to be exported, their STATUS_FLAG must be either ‘A’ or ‘R’ and match the selection made in the sole parameter for the export. If no selection is made, the export will pull in all records with STATUS_FLAG values of either ‘A’ or ‘R’.
Note: Exports will not work as expected if the data were imported using a different format, as each format has different mappings, checks, etc. |
Copyright © 2024 EarthSoft, Inc. • Modified: 20 Oct 2024