Making Changes to Format Files

Warnings:

•If changes are made to an EarthSoft standard format, it is required that the format be renamed. The procedure for doing so is explained below. This will also prevent the customized format from being overwritten during EQuIS upgrades.

•Standard EarthSoft formats are encrypted and can be customized to meet specific needs, if desired. Customized formats are intended for internal use only and distribution to external parties is prohibited, unless expressly licensed.

•If the format is available on the EarthSoft download site, then the modified format should be returned to EarthSoft, together with documentation regarding the modifications, and a specific request to update the format on the download site.

Change the EQuIS Format File Names

1.Copy the EFWEDD.xsd and the EFWEDD.vb files and rename them as desired (e.g., EFWEDD_custom.xsd and EFWEDD_custom.vb).

2.Open the renamed files. This can be done by using Microsoft Notepad or any XML editor.

3.Search the files for the text "EFWEDD" and replace this with the file name selected in Step 1 (above) (e.g., replace "EFWEDD" with "EFWEDD_custom").

Note: In this example, there are three instances of the text "EFWEDD" in the *.vb, as well as eight instances in the *.xsd, that will need to be replaced. This step is very important, because a *.dll file is created that is needed for the format files to work properly. This *.dll file is created the first time the format file is used, and is saved in the
C:\Documents and Settings\<user name>\Local Settings\Temp in Windows XP, or
C:\Users\<user name>\AppData\Local\Temp in Windows 7.

Any time any alterations are made to the format files (*.xsd and *.vb files), this *.dll flle will need to be deleted so that it may be recompiled with the updated rules.

4.Save the changes made to the format files.

5.EQuIS Build 7.22.1 introduced many improvements in security which affect the use of custom formats. For more information, please see Securing EDD Formats for additional steps.

Other Common Changes to Format Files

Issue 1

Alter the *.xsd format file to represent the Alternate Test Key values (or Test Level Key Fields) that have been established in the specific EQuIS database.

Notes:

•The *.xsd format file contains the mapping and definition for the sections of the format.

•It is important that the text listed above is entered in the same order under each statement listed. This means that each statement needs to have the field in the same order as the statement above (the standard EFWEDD.xsd is set up this way).

1.Save the changes made to the format.

2.Delete the <FormatFileName>.dll from the C:\Documents and Settings\<user name>\Local Settings\Temp directory (Windows XP) or C:\Users\Michael\AppData\Local\Temp directory (Windows 7).

3.Open the format file in EDP and ensure the changes made in the steps above have been successful.

Issue 2

Alter the *.vb format to change or "turn off" the format's rule (e.g. "QC_SPIKE_MEASURED should not be less than QC_ORIGINAL_CONC").

Note: The *.vb format file contains the custom handling and business rules for the format.

1.Open the *.xsd format file that in the preferred favorite XML editor.

2.Search for the rule to change or "turn off" (e.g., QC_SPIKE_MEASURED should not be less than QC_ORIGINAL_CONC - on line 153, depending on the XML editor using).

3.Place an apostrophe (') in front of the rule or check to comment the rule out - (turning off the check).

Note: There may be multiple lines for each rule that the *.vb enforces. Be sure to comment out all of the lines related to the rule.

4.Save the changes made to the format.

5.Delete the <FormatFileName>.dll from the C:\Documents and Settings\<user name>\Local Settings\Temp directory (Windows XP) or C:\Users\<user name>\AppData\Local\Temp directory (Windows 7).

6.Open the format file in EDP and ensure the changes made in the steps above have been successful.

Note: It is highly recommended to note all of the alterations made to the EFWEDD format so future users will be able to take advantage of future EFWEDD format files.

Issue 3

Alter the *.xsd format to allow or restrict the reporting of negative analytical result values.

1.Open the *.xsd format file in a favorite XML editor.

2.Search for the "Result_Value" element name.

3.Nested within this section of code, there is code [minInclusive value] that restricts the value to be a positive number, as below.

<xs:restriction base="xs:decimal">

<xs:totalDigits value="19" />

<xs:minInclusive value="0" />

</xs:restriction>

4.Setting the minInclusive number to a negative number, such as "-100000", will allow negative numbers to be loaded with the format.

a.To restrict the loading of negative numbers, change the minInclusive value to "0".

Note: This restriction base code may not be present in all formats, but may be added.

5.Save the changes made to the format.

6.Open the format file in EDP and ensure the changes made in the steps above have been successful.

Note: It is highly recommended to note all of the alterations made to the format so future users will be able to take advantage of future format files.

Office Hours Video

The Office Hour video Creating Custom EDD Formats can be viewed on YouTube.

For more information on EQuIS Format files, please see EQuIS Format Files.