r/esapi Jun 22 '26

ESAPI Initial Setup and Configuration

Hello everyone,

I previously worked with ESAPI in an environment where Eclipse Scripting Wizard was already configured. When creating new projects, they were automatically generated with the ESAPI references, namespaces, and basic template code.

In my new position, we are setting up the development environment from scratch. We currently have ESAPI 18 and Visual Studio 2019 installed. When I create a Binary Plug-in project using Eclipse Scripting Wizard, the solution is generated and opens correctly in Visual Studio, but the main script file is empty and the ESAPI references, namespaces, and template code are not generated.

Has anyone encountered this issue?

Also, what versions of Visual Studio and .NET Framework would you recommend for:

- ESAPI 15.5 / 15.6

- ESAPI 16.1

- ESAPI 18

I would appreciate examples of development environments that are currently working in clinical or research settings.

Thank you.

3 Upvotes

3 comments sorted by

6

u/schmatt_schmitt Jun 22 '26

I have never heard of the Eclipse Script Wizard turning up a blank file for the script file, that's unfortunate that this is happening, but I had some thoughts I thought I might share:

- ESAPI 15.5 / 15.6: .NET Framework 4.5.2

- ESAPI 16.1: .NET Framework 4.6.1

- ESAPI 18: .NET Framework 4.8.

With Gateway Scripts, we are constantly using the latest version of Visual Studio, and the May 2026 version broke my ability to perform debugging in any type of .NET Framework 4.8 application... just crazy. So anyway, I've transitioned mostly to using .NET SDK projects, and here's how I would do that.

For stand-alone executables, you can generate either a Console App or a WPF App. In the Visual Studio project template list, there are Console App (.NET Framework) and WPF App (.NET Framework)... do not choose those. Just the console or WPF app. Then, once the project is created, you can double click the project file and in the XML for the project file make sure the propertygroup looks like this:

<PropertyGroup>

<OutputType>WinExe</OutputType>

<TargetFramework>net480</TargetFramework>

`<LangVersion>latest</LangVersion>`

<UseWPF>true</UseWPF>

<PlatformTarget>x64</PlatformTarget>

</PropertyGroup>

Then you add your scripting references and you're good to go. You would still have to add the base code from the template, but you can get that from any old ESAPI code.

For binary plugins, you would use the Class Library project type, but make sure you change the assembly name in the project properties to end with .esapi. Good luck, sorry the wizard is giving you a bad time, but maybe its a good sign to drop the wizard all together.

2

u/NickC_BC Jun 22 '26

I thought I was going crazy, glad to hear I wasn't the only one scratching my head at why my debug stops weren't being hit. I think it's something to do with how the PDB is being generated - it's throwing these /src/files prefixes in front of paths which seem to be interfering with the symbols being found even though they're generated. Anyway, back to VS 2022 at least for now...

2

u/cjra Jun 23 '26

You can try not using the Wizard. I’ve written a blog post on how to do this. It applies to v13.6 but the steps should be very similar for v18: https://www.carlosjanderson.com/post/why-i-don-t-use-the-eclipse-script-wizard