Skip to content

Latest commit

 

History

98 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EdiFabric C# .NET Examples for VDA

EdiFabric 11.0.0 is a .NET SDK that parses, generates, validates, and splits EDI files. These examples cover the German automotive standard VDA, including delivery instruction 4905.

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.VDA.sln .NET 6 solution
NET Framework 4.8/EdiFabric.Examples.VDA.sln .NET Framework 4.8 solution
NET Framework 4.8/EdiFabric.Examples.VDA.Common/Config.cs Serial key shared by every example
NET Framework 4.8/EdiFabric.Examples.VDA.Read/ReadVDA.cs Read a 4905 delivery instruction
Files/ Sample VDA files

Requirements

  • Visual Studio 2022, or the .NET SDK. Download Visual Studio.
  • .NET 6 for NET 6/EdiFabric.Examples.VDA.sln. The projects set <TargetFramework>net6.0</TargetFramework> so they stay compatible with existing .NET 6 apps. EdiFabric 11.0.0 also provides net8.0, net9.0, and net10.0. To evaluate a later version, change that property (for example to net8.0) and rebuild.
  • .NET Framework 4.8 for NET Framework 4.8/EdiFabric.Examples.VDA.sln.
  1. 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.
  2. Paste that serial into TrialSerialKey in NET Framework 4.8/EdiFabric.Examples.VDA.Common/Config.cs. The .NET 6 projects link this file, so one edit covers both solutions.

NuGet restore pulls EdiFabric 11.0.0 and EdiFabric.Templates.Vda 3.0.0.

Getting started

Sign up free for Community at edifabric.com/pricing and put your serial in Config.TrialSerialKey. Then open a solution, set EdiFabric.Examples.VDA.Read as the startup project, and run it.

From the command line:

cd "NET 6/EdiFabric.Examples.VDA.Read"
dotnet run

The project reads Files/Vda_4905_02.txt and Files/Vda_4905_02_Batch.txt with VdaReader. VDA has no envelope that names the message, so each sample passes a MessageContext factory that recognizes record 51102 as message 4905 and loads EdiFabric.Templates.Vda.

To translate your own file, change the path in EdiFabric.Examples.VDA.Read/ReadVDA.cs.

Usage

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;
using EdiFabric.Framework.Readers;
using EdiFabric.Templates.Vda;

License.SetSerial(serial);   // from your Community or paid plan

var ediStream = File.OpenRead(@"Files\Vda_4905_02.txt");

List<IEdiItem> ediItems;
using (var ediReader = new VdaReader(ediStream, MessageContextFactory))
    ediItems = ediReader.ReadToEnd().ToList();

var deliveryInstructions = ediItems.OfType<TS4905>();

MessageContextFactory inspects the first record. When it starts with 51102, it returns a MessageContext for "4905" and loads assembly EdiFabric.Templates.Vda. ReadToEnd loads the file into memory. Read also shows a batch file and an async read.

Writing VDA

Write builds a 4905 delivery instruction with TS4905Builder and writes it with VdaWriter. The same project writes a batch and writes asynchronously.

var deliveryInstruction = TS4905Builder.BuildDeliveryInstruction(22, 23);

using (var stream = new MemoryStream())
{
    using (var writer = new VdaWriter(stream, Environment.NewLine))
    {
        writer.Write(deliveryInstruction);
    }
}

Examples by feature

Project What it shows
EdiFabric.Examples.VDA.Read Read one 4905, read a batch of 4905 messages, and read asynchronously
EdiFabric.Examples.VDA.Write Write one 4905, write a batch, and write asynchronously

For another message on a paid plan, add that model as C# files. See EDI templates.

Licensing

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.VDA.Common is the manual GetToken / SetToken cache, for when you want to store the token yourself.

Error codes

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.

EDI templates

The models published on NuGet, such as EdiFabric.Templates.Vda, EdiFabric.Templates.X12, and EdiFabric.Templates.Edifact, are for evaluation only. They are a Community plan limitation. These examples reference EdiFabric.Templates.Vda 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 VDA messages. If a message is missing, ask for it.

Warranty

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.

Links

2026 © EdiFabric

About

EdiFabric C# .NET Examples for VDA

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages