Skip to main content

Introduction to XEP for .NET

XEP is a lightweight SDK that provides high-performance .NET technology for persisting simple to moderately complex object hierarchies. XEP projects the data in .NET objects as persistent events (database objects that store a persistent copy of the data fields) in an InterSystems IRIS® database. XEP is optimized for acquiring and persisting data at the highest possible speed.

InterSystems IRIS provides .NET SDKs for easy relational and object database access. This book discusses XEP object access. See Using .NET with InterSystems Software for relational access.

Requirements and Configuration

This section specifies requirements and provides instructions for configuring your environment to use XEP.


  • The .NET Framework, version 2.0, 4.0, or 4.5.

  • InterSystems IRIS.

Computers that run your .NET client applications do not require InterSystems IRIS, but they must have a connection to the InterSystems IRIS Server and must be running a supported version of the .NET Framework.


  • When installing InterSystems IRIS, select the Setup Type: Development option.

  • If InterSystems IRIS has been installed with security level 2, open the Management Portal and go to System Administration > Security > Services, select %Service_CallIn, and make sure the Service Enabled box is checked.

    If you installed InterSystems IRIS with security level 1 (minimal) it should already be checked.


Your .NET project must include references to the following files. Different versions of these files are located in appropriately named subdirectories of <install-dir>/dev/dotnet/bin (for example, <install-dir>/dev/dotnet/bin/v4.0.30319 contains the file for .NET 4.0). Use the appropriate files for the release that will be used to compile your project:

  • InterSystems.Data.XEP.dll — is provided for the 4.0 and 4.5 releases of the .NET Framework.

  • InterSystems.Data.IRISClient.dll — is provided in different versions, one for each supported release of the .NET Framework.

In order to run XEP applications:

  • The InterSystems IRIS User namespace must exist and must be writable.

  • Your PATH environment variable must include <install-dir>/bin. If your PATH includes multiple instances of <install-dir>/bin (for example, if you have installed more than one instance of InterSystems IRIS) only the first one will be used, and any others will be ignored.

FeedbackOpens in a new tab