Debugging EQuIS Formats in Visual Studio

<< Click to Display Table of Contents >>

Navigation:  EDP > Customizability >

Debugging EQuIS Formats in Visual Studio

Follow the steps below for debugging EQuIS formats in Visual Studio.


1.Create a new Class Library (.NET Framework) project with the name being the same as the format, and select 4.7.2 as the .NET Framework.

2.In My Project, complete the steps listed below.

a.In the Application tab found in Project > Properties, delete the Root Namespace.

b.In the Compile tab found in Project > Properties, delete the Build Output Path, and make sure Platform is set to Any CPU.

c.In the Debug tab, select Start External Program, then select either the EQuIS or EDP executable.

d.In the References tab, add EarthSoft.Common.dll and EarthSoft.EDP.dll, and in the properties window (or right-click) change Copy Local to false.

3.In the Solution Explorer window, select Show All Files and delete all files under My Project.

4.Delete the Class1.vb file, and then add all format files (.xsd, .vb, -enum.xml, -export.xml) to the project. If it adds others, like .Designer.vb, .xsc, or .xss under the .xsd, then those can be deleted.

5.Optional: Embed the *.xsd and *-export.xml (if present) in the assembly (see Securing EDD Formats).

6.Ensure that the assembly is strongly-named and that your custom public key token is correctly entered in the ST_CONFIG table (see Approve Strongly Named Custom Assemblies).


The format is ready to debug. The constructor (New) and AddDataHandlers methods will be executed when the format opens. This is a good place to start debugging.


If the preference is that the .vb file does not show under the .xsd, then build the project and open the project file in any text editor (e.g. notepad). Find the line where the .vb is included and delete the line below it that says it is dependent upon the .xsd




<xs:element name="Sample_Date" type="xs:date" nillable="true" edd:format="dd-MMM-yyyy">



Note: Adding the log4net.dll file to the Visual Studio Project References may assist when identifying errors.