EdiFabric 11.0.0 is a .NET SDK that parses, generates, validates, acknowledges, and splits EDI files. These examples cover EDIFACT, EANCOM, IATA PADIS, and EDIGAS.
EdiFabric does not include communication components (AS2 or SFTP), a dashboard, or a UI. It is a library you call from your own application.
The .NET 6 projects compile the same sources as the .NET Framework 4.8 projects. Both solutions reference EdiFabric 11.0.0 and the template packages from NuGet. The examples target .NET 6 for backward compatibility. EdiFabric 11.0.0 also ships targets for .NET 8, .NET 9, and .NET 10. To evaluate one of those, change TargetFramework in the project file and rebuild.
| Path | Purpose |
|---|---|
NET 6/EdiFabric.Examples.EDIFACT.sln |
.NET 6 solution |
NET Framework 4.8/EdiFabric.Examples.EDIFACT.sln |
.NET Framework 4.8 solution |
NET Framework 4.8/EdiFabric.Examples.EDIFACT.Common/Config.cs |
Serial key shared by every example |
NET Framework 4.8/EdiFabric.Examples.EDIFACT.Demo/Program.cs |
Runnable walkthrough: read, then validate |
Files/ |
Sample EDIFACT, EANCOM, and EDIGAS interchanges |
- Visual Studio 2022, or the .NET SDK. Download Visual Studio.
- .NET 6 for
NET 6/EdiFabric.Examples.EDIFACT.sln. The projects set<TargetFramework>net6.0</TargetFramework>so they stay compatible with existing .NET 6 apps. EdiFabric 11.0.0 also providesnet8.0,net9.0, andnet10.0. To evaluate a later version, change that property (for example tonet8.0) and rebuild. - .NET Framework 4.8 for
NET Framework 4.8/EdiFabric.Examples.EDIFACT.sln.
- Sign up free for Community to get an evaluation serial key. Community never expires, requires no credit card, and is limited to 250 operations per day for non-production use. After signup, retrieve your serial from Your Account.
- Paste that serial into
TrialSerialKeyinNET Framework 4.8/EdiFabric.Examples.EDIFACT.Common/Config.cs. The .NET 6 projects link this file, so one edit covers both solutions.
NuGet restore pulls EdiFabric 11.0.0, EdiFabric.Templates.Edifact 3.0.0, and, where a project needs them, EdiFabric.Templates.Padis and EdiFabric.Templates.Edigas.
Sign up free for Community at edifabric.com/pricing and put your serial in Config.TrialSerialKey. Then open a solution, set EdiFabric.Examples.EDIFACT.Demo as the startup project, and run it.
From the command line:
cd "NET 6/EdiFabric.Examples.EDIFACT.Demo"
dotnet runThe demo reads Files/Edifact/PurchaseOrders.txt, parses every message with EdifactReader, and validates each one with IsValid. Set a breakpoint at the end of Main and inspect ediItems.
To translate your own file, change the path in EdiFabric.Examples.EDIFACT.Demo/Program.cs.
Every example calls License.SetSerial before it reads or writes. On Community that is the call to use. See Licensing for Developer and Enterprise.
using EdiFabric.Core.Model.Edi;
using EdiFabric.Framework.Readers;
using EdiFabric.Templates.EdifactD96A;
License.SetSerial(serial); // from your Community or paid plan
var ediStream = File.OpenRead(@"Files\Edifact\PurchaseOrders.txt");
List<IEdiItem> ediItems;
using (var ediReader = new EdifactReader(ediStream, "EdiFabric.Templates.Edifact"))
ediItems = ediReader.ReadToEnd().ToList();
var purchaseOrders = ediItems.OfType<TSORDERS>();EdifactReader takes the stream and the template assembly name. ReadToEnd loads the interchange into memory. For large files, use the streaming samples in ReadEDI.
After a message parses, IsValid checks it against the template. ValidateEDI shows custom codes, data types, and control segments. AcknowledgeEDI builds a CONTRL for a valid group, an invalid group, and duplicates.
foreach (var message in ediItems.OfType<EdiMessage>())
{
if (message.HasErrors)
continue;
MessageErrorContext mec;
if (!message.IsValid(out mec))
{
var validationIssues = mec.Flatten();
}
}WriteEDI builds an interchange with EdifactWriter: UNB, then the message. The same project covers custom delimiters, a postfix after each segment, batches, and empty data elements.
using (var stream = new MemoryStream())
{
using (var writer = new EdifactWriter(stream))
{
writer.Write(SegmentBuilders.BuildUnb("1"));
writer.Write(invoice);
}
}| Project | What it shows |
|---|---|
EdiFabric.Examples.EDIFACT.Demo |
Read a file and validate each message |
EdiFabric.Examples.EDIFACT.ReadEDI |
Read to end, stream, batch, split on a repeating loop, corrupt files, partner templates, custom UNB/UNG |
EdiFabric.Examples.EDIFACT.WriteEDI |
Write to a stream or file, delimiters, new lines, batches, empty elements, no auto trailers |
EdiFabric.Examples.EDIFACT.ValidateEDI |
Validate after read and before write, custom codes, UNOA/UNOB, UNB and UNG |
EdiFabric.Examples.EDIFACT.AcknowledgeEDI |
Generate and read CONTRL |
EdiFabric.Examples.EDIFACT.JSON |
Serialize and deserialize JSON |
EdiFabric.Examples.EDIFACT.XML |
XmlSerializer and DataContractSerializer |
EdiFabric.Examples.EDIFACT.CSV |
Import and export CSV |
EdiFabric.Examples.EDIFACT.DB |
Save and reload an ORDERS message with EF Core (create the database before you run it) |
EdiFabric.Examples.EDIFACT.MapEDI |
Map with AutoMapper and XSLT |
EdiFabric.Examples.EDIFACT.ModifyTemplates |
Parse a partner-specific ORDERS template |
EdiFabric.Examples.EDIFACT.Templates |
Example EDI templates |
Each project reads a sample file and writes the same message back out.
| Project | Message |
|---|---|
EdiFabric.Examples.EANCOM.INVOIC.Syntax3 |
EANCOM INVOIC, syntax 3 |
EdiFabric.Examples.EDIFACT.BAPLIE |
SMDG BAPLIE bayplan |
EdiFabric.Examples.EDIFACT.CUSCAR |
US Customs CUSCAR |
EdiFabric.Examples.EDIFACT.PAXLST |
US Customs PAXLST |
EdiFabric.Examples.EDIFACT.PNRGOV |
IATA PADIS PNRGOV |
EdiFabric.Examples.EDIGAS.NOMINT |
EDIGAS NOMINT |
EdiFabric.Examples.EDIFACT.DESADV |
EDIFACT DESADV |
EdiFabric.Examples.EDIFACT.IFTMIN |
EDIFACT IFTMIN |
EdiFabric.Examples.EDIFACT.IFTSTA |
EDIFACT IFTSTA |
EdiFabric.Examples.EDIFACT.INVOIC |
EDIFACT INVOIC |
EdiFabric.Examples.EDIFACT.ORDERS |
EDIFACT ORDERS |
EdiFabric.Examples.EDIFACT.ORDRSP |
EDIFACT ORDRSP |
EdiFabric.Examples.EDIFACT.PRICAT |
EDIFACT PRICAT |
For another version on a paid plan, add that model as C# files. See EDI templates.
Note
Sign up free for the Community plan
to get an evaluation serial key. Community never expires, requires no credit
card, and is for non-production evaluation, learning, and prototyping
(250 operations per day). After signup, copy your serial from
Your Account
into Config.TrialSerialKey.
One operation is one parse, generate, validate, or acknowledge call. The 250-a-day
quota is shared across ediFabric .NET, Native, and Cloud. If you hit it, calls
throw LicenseException with error 639. Upgrade at
edifabric.com/pricing to continue.
Use of the product is subject to the EULA.
| Plan | What works | Recommended |
|---|---|---|
| Community | License.SetSerial only. Online check. 250 operations per day. Non-production. |
License.SetSerial |
| Developer | License.SetSerial and License.EnsureToken (EnsureToken caches the result for 1 day) |
License.EnsureToken |
| Enterprise | License.SetSerial, License.GetToken / License.SetToken |
License.SetToken (offline tokens) |
// Community: authorize against the license server
License.SetSerial(serial);
// Developer (recommended): 1-day built-in cache; refreshes if the token expires within N seconds
License.EnsureToken(serial, seconds: 3600);
// Enterprise: set an offline token
License.SetToken(token);The examples call License.SetSerial(Config.TrialSerialKey). On Developer, call License.EnsureToken instead. TokenFileCache.Set() in EdiFabric.Examples.EDIFACT.Common is the manual GetToken / SetToken cache, for when you want to store the token yourself.
License failures throw LicenseException. ErrorCode is the number below, and Message is the text.
Error 639 means the Community daily quota was exceeded. Upgrade your plan at edifabric.com/pricing if you wish to continue.
| Code | Message |
|---|---|
| 1 | The suggested output buffer size is too small |
| 501 | Unexpected error occured. Contact support@edifabric.com for assistance |
| 611 | The input buffer is either null or its size is nill |
| 612 | The logger failed to log |
| 613 | The map configuration file is invalid |
| 614 | The output capacity must be positive |
| 615 | Models map must be set before parsing or splitting |
| 616 | Mode must be any of: 1 - Parse, 2 - Parse and Validate, 3 - Parse and Validate and Acknowledge |
| 617 | Parser failed. Contact support@edifabric.com and include a sample project/file to reproduce the issue |
| 618 | Validation failed. Contact support@edifabric.com and include a sample project/file to reproduce the issue |
| 619 | Validation serializer failed. Contact support@edifabric.com and include a sample project/file to reproduce the issue |
| 620 | The token is invalid. Contact support@edifabric.com for assistance |
| 621 | The configuration file is invalid |
| 622 | The split segment ID must not be blank |
| 623 | Call start_split before splitting |
| 624 | The result can't be retrieved. Contact support@edifabric.com and include a sample project/file to reproduce the issue |
| 625 | Result buffer size mismatched |
| 626 | Call start_merge before merging |
| 627 | The output buffer is either null or its size is nill |
| 628 | The serial number is missing or incorrect. GetToken doesn't work with developer license. Contact support@edifabric.com for assistance |
| 629 | License was not installed. Contact support@edifabric.com for assistance |
| 630 | No license to use this version. Contact support@edifabric.com for assistance |
| 631 | The token has expired. Get and set a new token to continue. Contact support@edifabric.com for assistance |
| 632 | The token is missing. Set token to continue. Contact support@edifabric.com for assistance |
| 633 | Reached the maximum number of licenses. Set token to continue. Contact support@edifabric.com for assistance |
| 634 | Environment not recognized for licensing or reached the maximum number of licenses. Contact support@edifabric.com for assistance |
| 635 | Serial or token not found. Either set token or serial to continue. Contact support@edifabric.com for assistance |
| 636 | The rate to get serials was exceeded for your license. Wait for 60 seconds and try again or upgrade your license. Contact support@edifabric.com for assistance |
| 637 | Invalid JSON. Enable logging for additional details |
| 638 | The operation is not supported by your license |
| 639 | Your license has reached its daily call limit. Upgrade your plan at edifabric.com to continue using the product. |
The models published on NuGet, such as EdiFabric.Templates.Edifact, EdiFabric.Templates.Padis, EdiFabric.Templates.Edigas, and EdiFabric.Templates.X12, are for evaluation only. They are a Community plan limitation. These examples reference them so you can run the samples on Community.
Paid plans provide every template as plain C# files. Add them to the solution by following How to create EDI template projects. For evaluation and the Community plan, you can still download the templates in compiled form by following the same article.
The same classes validate as well as parse. EdiFabric supports the EDIFACT, EANCOM, and IATA versions. If a transaction is missing, ask for it.
- EDIFACT
- EANCOM D93A, D96A, and D01B
- IATA PADIS
- EDIGAS 4.0
- EdiNation spec library (no registration)
The source code in these example projects is strictly for demonstrational purposes and is provided "AS IS" without warranty of any kind, whether expressed or implied, including but not limited to the implied warranties of merchantability and/or fitness for a particular purpose.