refvals Format

<< 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 and EQuIS Professional

Export(s): RefVals EDD

 

Note: Exports will not work as expected if the data were imported using a different format, as each format has different mappings, checks, etc.

 

 

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: This format  is included in the installation of EDP Standalone and EQuIS Professional in the \Formats\EarthSoft folder.

 

 

Overview: See Standard EQuIS Formats to see what tables the refvals format populates.

 

 

Limitations/Assumptions:

The refvals format is sometimes not self referential. For example, if the RT_COMPANY_TYPE section is populated with a record for 'Consultant', the 'Consultant' value will be flagged as a "Reference value not found" in the RT_COMPANY section. Either of the below methods can be used to add the parent reference values so they may be referenced by the child record in the EDD:

Add New Reference Values using EDP Right-Click Feature or

Use multiple Create steps on the same EDD. This moves the new parent reference values to the package tables, leaving behind the child records that are in error. After the parent reference values are moved to the package tables, refresh the EDD, and the child records are now not in error. Create again to move the child records to the package and then Commit the package.

 

 

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 your {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.

 

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.

 

 

Troubleshooting

 

Symptoms: This error may occur in EDP during the Commit stage while using the REFVALS EDD Format:

 

"System.Data.SqlClient.SqlException (0x80131904): The server failed to resume the transaction. Desc:5600000001.

 

The transaction active in this session has been committed or aborted by another session."

 

Cause/Details: This error typically occurs when the RT_GROUP_MEMBER.MEMBER_TYPE value in the EDD does not match code in the RT_GROUP.GROUP_TYPE field.

 

Resolution/Workaround: Review the EDD and update where necessary so that the RT_GROUP_MEMBER.MEMBER_TYPE value matches the same code as the parent RT_GROUP.GROUP_TYPE record.