MXParser 1.1.0

dotnet add package MXParser --version 1.1.0
NuGet\Install-Package MXParser -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MXParser" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MXParser --version 1.1.0
#r "nuget: MXParser, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MXParser as a Cake Addin
#addin nuget:?package=MXParser&version=1.1.0

// Install MXParser as a Cake Tool
#tool nuget:?package=MXParser&version=1.1.0

MX (ISO 20022) Message Parser

MXParser is the dotnet library which help to parse MX (ISO 20022) messages in the fastest way possible. It will parse the ISO 20022 message with the predefined rule sets.

Parsing Score

The library can parse the given 60.6MB xml data file in 00:00:19 seconds with 4 Cores 8 Logical Processor with 16 MB of RAM.

Install Package

  1. Install the MXParser NuGet package.
  • .NET CLI
  dotnet add package MXParser
  • Package Manager
Install-Package MXParser

Usage Example

using System.Data;
using System.Diagnostics;
using MXParser;

public class Program
{
  private static async Task Main(string[] args)
  {
      Stopwatch stopwatch = new();
      stopwatch.Start();
      IParsingService parsingService = new ParsingService(new ParsingJsonRules(@"data\parsing_rules.json"), "Document");
      await parsingService.ParseXmlAsync(@"data\camt.053.xml", (DataSet ds, Guid messageUniqueId, Guid uniquiId) =>
      {
        //DataSet ds: camt.053.xml will have multiple messages in a file and this dataset will have the parsed data of the given message. Each message parsed will be callbacked over here for the further process.
         // messageUniqueId :  As camt.053 will have multiple message, each message will identified with the given messageUniqueId. 
         // uniqueId: this id is represent the unique file Id. Meaning each passed file has been represent by the given Id. 
          Task task = Task.Run(() =>
          {
              // either we can transform to CSV/Excel or transfered to DB using bulk DB operation
              string dateTime = DateTime.Now.ToString("ddmmyyyyHHmmssfff");
              foreach(DataTable dt in ds.Tables)
              {
                  ExportDataTableToCsv(dt, @$"export\{messageUniqueId}_{dt.TableName}_{uniquiId}.csv");
              }
             
          });
          return task;
      });
      stopwatch.Stop();
      TimeSpan elapsedTime = stopwatch.Elapsed;

      // Print the elapsed time
      Console.WriteLine("Elapsed Time: " + elapsedTime);
      Console.Read();
  }

  static void ExportDataTableToCsv(DataTable dataTable, string filePath)
  {
      if (!File.Exists(filePath))
      {
          File.Create(filePath).Close();
      }
      // Create a StreamWriter to write to the CSV file
      using (StreamWriter writer = new StreamWriter(filePath))
      {
          // Write the header row with column names
          foreach (DataColumn column in dataTable.Columns)
          {
              writer.Write(column.ColumnName);
              writer.Write(",");
          }
          writer.WriteLine(); // Move to the next line

          // Write the data rows
          foreach (DataRow row in dataTable.Rows)
          {
              foreach (object item in row.ItemArray)
              {
                  writer.Write(item);
                  writer.Write(",");
              }
              writer.WriteLine(); // Move to the next line
          }
      }
  }

}

Parsing Rules

Please follow the Parsing Rules example given in the data directory of the repository. Mapping Rules should follow below model class structure

public class MappingRules
{
    public string Namespace { get; set; }
    public List<MappingTable> Mappings { get; set; }
}

public class MappingTable
{
    public string NodeName { get; set; }
    public string XPath { get; set; }
    public IList<MappingColumn> Columns { get; set;}
}

public class MappingColumn
{
    public int OrderNumber { get; set; }
    public string NodeName { get; set; }
    public string XPath { get; set; }
    public string DataType { get; set; }
    public int MinLength { get; set; }
    public int MaxLength { get; set; }
    public int fractionDigits { get; set; }
    public int totalDigits { get; set; }
}

Override the Parsing Rules

The given example is in json file. Suppose you want to store Parsing rules in Database. Now you need to override the ParsingRules class method DeserializeRules.

For Example:

public class ParsingDatabaseRules : ParsingRules
{
    public override void DeserializeRules()
    {
      //MapParsingRules is of type IList<MappingRules>?
        MapParsingRules = GetMyRulesFromDB();
    }
}

Sample Files

camt.053.xml

parsing_rules.json

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 79 3/14/2024
1.0.0 68 3/14/2024