Issue closing segment-group with identical segments across groups

[mathias-olsen]

Hello there 👋,

First and foremost I would like to say that you've done a great job with the development of this library.

I have encountered one issue with parsing EDIFACT files of the BAPLIE template, specifically to the version D95B: https://www.truugo.com/edifact/d95b/baplie/

The issue that I am facing is that there are two consecutive segment groups:
GRP1: "TDT", "LOC", "DTM", "RFF", "FTX"
GRP2: "LOC", "GID", GDS", "FTX", "MEA", "DIM, "TMP", "RNG", "LOC," RFF"

Since the first segment group contains a mandatory LOC segment, a conflict arises once the next segment group is encountered, as that starts with LOC.

I have defined the segment-group segments like this: [EdiSegmentGroup("TDT", "LOC", "DTM", "RFF", "FTX")]

And here is an example of the EDIFACT file:

UNB+UNOA:1+XXX+8194-8195+250117:0526+39447142'
UNH+1+BAPLIE:D:95B:UN:SMDG22'
BGM++XXX+9'
DTM+137:2501170526:201'
---
See from below this line for segment group 1:
---
TDT+20+XXXX+1++XXX:172+++XXX:103::XXX'
LOC+5+XXXXX:139:6+XXX'
DTM+132:2501161400:201'
DTM+133:2501170730:201'
---
See from below this line for segment group 2:
---
LOC+147+0140586::5'
MEA+WT++XXX:8566'

When debugging the EdiSerializer, I can see that the segment-group level is not closed until MEA is encountered, since the 2nd encounter of LOC is still considered to be part of the first segment-group.

From what I can tell this issue occurs because the EdiSerializer doesn't consider ordering of the segments within a group, but I might be wrong in this observation.

Question: Is there any way to force the serializer to respect the segment-groups above with the current built-in toolkit? I am still very new to the codebase, so I haven't investigated all of the capabilities of structuring POCO's to force the structure.

[jmorgan-habs]

Hi, I'm actually running into this same exact issue a year later. The partially functional WIP source code for my model is below along with a relevant block diagram of the 2.2 BAPLIE spec. Any suggestions would be appreciated, and I'm happy to provide more detail if needed!

internal class Baplie2x : Baplie
{
    [EdiSegment(Mandatory = true, Description = "Beginning of Message")]
    [EdiPath("BGM")]
    public class BGM
    {
        #region Properties

        [EdiValue("X(35)", Path = "BGM/1", Mandatory = true)]
        public string MessageNumber { get; set; }

        [EdiValue("X(3)", Path = "BGM/2", Mandatory = true)]
        public string MessageFunction { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Dangerous Goods", Mandatory = true)]
    [EdiPath("DGS")]
    public class DGS
    {
        #region Properties

        [EdiValue("X(3)", Path = "DGS/0", Mandatory = true)]
        public string DangerousGoodsRegulations { get; set; }

        [EdiValue("X(7)", Path = "DGS/1/0", Mandatory = true)]
        public string HazardCodeIdentification { get; set; }

        [EdiValue("X(7)", Path = "DGS/1/1")] public string HazardSubstanceItemPageNumber { get; set; }

        [EdiValue("9(4)", Path = "DGS/2")] public string UNDGNumber { get; set; }

        [EdiValue("9(3)", Path = "DGS/3/0")] public string ShipmentFlashpoint { get; set; }

        [EdiValue("X(3)", Path = "DGS/3/1")] public string MeasureUnitQualifier { get; set; }

        [EdiValue("X(3)", Path = "DGS/4")] public string PackingGroup { get; set; }

        [EdiValue("X(6)", Path = "DGS/5")] public string EMSNumber { get; set; }

        [EdiValue("X(4)", Path = "DGS/6")] public string MFAG { get; set; }

        [EdiValue("X(4)", Path = "DGS/8/0")] public string HazardIdentifiationNumber { get; set; }

        [EdiValue("X(4)", Path = "DGS/8/1")] public string SubstanceIdentificationNumber { get; set; }

        [EdiValue("X(4)", Path = "DGS/9/0")] public string DangerousGoodsLabelMarking { get; set; }

        [EdiValue("X(4)", Path = "DGS/9/1")] public string DangerousGoodsLabelMarking2 { get; set; }

        [EdiValue("X(4)", Path = "DGS/9/2")] public string DangerousGoodsLabelMarking3 { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Dimensions")]
    [EdiPath("DIM")]
    public class DIM
    {
        #region Properties

        [EdiValue("X(3)", Path = "DIM/0", Mandatory = true)]
        public string DimensionQualifier { get; set; }

        [EdiValue("X(3)", Path = "DIM/1/0", Mandatory = true)]
        public string MeasureUnitQualifier { get; set; }

        [EdiValue("9(15)", Path = "DIM/1/1")] public string LengthDimension { get; set; }

        [EdiValue("9(15)", Path = "DIM/1/2")] public string WidthDimension { get; set; }

        [EdiValue("9(15)", Path = "DIM/1/3")] public string HeightDimension { get; set; }

        #endregion
    }

    [EdiSegment(Mandatory = true, Description = "Date/Time/Period")]
    [EdiPath("DTM")]
    public class DTM
    {
        #region Properties

        [EdiValue("X(3)", Path = "DTM/0/0", Mandatory = true)]
        public string Qualifier { get; set; }

        [EdiValue("X(35)", Path = "DTM/0/1", Mandatory = true)]
        public string DateTimePeriod { get; set; }

        [EdiValue("X(3)", Path = "DTM/0/2", Mandatory = true)]
        public string FormatQualifier { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Equipment Attached")]
    [EdiPath("EQA")]
    public class EQA
    {
        #region Properties

        [EdiValue("X(3)", Path = "EQA/0", Mandatory = true)]
        public string EquipmentQualifier { get; set; }

        [EdiValue("X(17)", Path = "EQA/1", Mandatory = true)]
        public string EquipmentIdentificationNumber { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Equipment Details", Mandatory = true)]
    [EdiPath("EQD")]
    public class EQD
    {
        #region Properties

        [EdiValue("X(3)", Path = "EQD/0", Mandatory = true)]
        public string EquipmentQualifier { get; set; }

        [EdiValue("X(17)", Path = "EQD/1", Mandatory = true)]
        public string EquipmentIdentificationNumber { get; set; }

        [EdiValue("X(4)", Path = "EQD/2")] public string EquipmentSizeAndTypeIdentification { get; set; }

        [EdiValue("X(3)", Path = "EQD/4")] public string EquipmentStatus { get; set; }

        [EdiValue("X(3)", Path = "EQD/5")] public string FullEmptyIndicator { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Free Text")]
    [EdiPath("FTX")]
    public class FTX
    {
        #region Properties

        [EdiValue("X(3)", Path = "FTX/0", Mandatory = true)]
        public string TextSubjectQualifier { get; set; }

        [EdiValue("X(3)", Path = "FTX/2")] public string TextReference { get; set; }

        [EdiValue("X(70)", Path = "FTX/3/0", Mandatory = true)]
        public string FreeText { get; set; }

        [EdiValue("X(70)", Path = "FTX/3/1")] public string FreeText2 { get; set; }

        [EdiValue("X(70)", Path = "FTX/3/2")] public string FreeText3 { get; set; }

        [EdiValue("X(70)", Path = "FTX/3/3")] public string FreeText4 { get; set; }

        [EdiValue("X(70)", Path = "FTX/3/4")] public string FreeText5 { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Nature of Cargo")]
    [EdiPath("GDS")]
    public class GDS
    {
        #region Properties

        [EdiValue("X(3)", Path = "GDS/0", Mandatory = true)]
        public string NatureOfCargo { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Goods Item Details")]
    [EdiPath("GID")]
    public class GID
    {
        #region Properties

        [EdiValue("9(8)", Path = "GID/1/0")] public string NumberOfPackages { get; set; }

        [EdiValue("X(17)", Path = "GID/1/1")] public string TypeOfPackagesIdentification { get; set; }

        #endregion
    }

    [EdiSegmentGroup("TDT", "LOC", "DTM", "RFF", "FTX", Mandatory = true)]
    public class GRP1 : TDT
    {
        #region Properties

        public List<LOC_G1> PlaceLocationIdentification { get; set; }
        public List<DTM> DateTimePeriod { get; set; }
        public RFF Reference { get; set; }

        #endregion
    }

    [EdiSegmentGroup("LOC", "GID", "GDS", "FTX", "MEA", "DIM", "TMP", "RNG", "LOC", "RFF", "EQD")]
    public class GRP2 : LOC_CONT
    {
        #region Properties

        public GID GoodsItemDetails { get; set; }
        public List<GDS> NatureOfCargo { get; set; }
        public List<FTX> FreeText { get; set; }
        public List<MEA> Measurements { get; set; }
        public List<DIM> Dimensions { get; set; }
        public TMP Temperature { get; set; }
        public RNG RangeDetails { get; set; }
        public List<LOC_PORT> PlaceLocationIdentification2 { get; set; }
        public List<RFF> Reference { get; set; }
        public List<GRP3> Group3 { get; set; }
        public List<GRP4> Group4 { get; set; }

        #endregion
    }

    [EdiSegmentGroup("EQD", "EQA", "NAD", "DGS")]
    public class GRP3 : EQD
    {
        #region Properties

        public List<EQD> EquipmentDetails { get; set; }
        public List<EQA> EquipmentAttached { get; set; }
        public NAD NameAndAddress { get; set; }

        #endregion
    }

    [EdiSegmentGroup("DGS", "FTX")]
    public class GRP4 : DGS
    {
        #region Properties

        public List<DGS> DangerousGoods { get; set; }
        public FTX FreeText { get; set; }

        #endregion
    }

    public class Interchange
    {
        #region Properties

        public UNB Header { get; set; }
        public UNZ Trailer { get; set; }
        public List<Message> Messages { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Place/Location Identification", Mandatory = true)]
    [EdiPath("LOC")]
    public class LOC
    {
        #region Properties

        [EdiValue("X(3)", Path = "LOC/0", Mandatory = true)]
        public string PlaceLocationQualifier { get; set; }

        [EdiValue("X(25)", Path = "LOC/1/0", Mandatory = true)]
        public string PlaceLocationIdentification { get; set; }

        [EdiValue("X(3)", Path = "LOC/1/1", Mandatory = true)]
        public string PlaceLocationIdentificationCLQ { get; set; }

        [EdiValue("X(3)", Path = "LOC/1/2", Mandatory = true)]
        public string PlaceLocationIdentificationCLRA { get; set; }

        [EdiValue("X(25)", Path = "LOC/2/0")] public string RelatedPlaceLocationOneIdentification { get; set; }

        [EdiValue("X(3)", Path = "LOC/2/1")] public string RelatedPlaceLocationOneIdentificationCLQ { get; set; }

        [EdiValue("X(3)", Path = "LOC/2/2")] public string RelatedPlaceLocationOneIdentificationCLRA { get; set; }

        [EdiValue("X(25)", Path = "LOC/3/0")] public string RelatedPlaceLocationTwoIdentification { get; set; }

        [EdiValue("X(3)", Path = "LOC/3/1")] public string RelatedPlaceLocationTwoIdentificationCLQ { get; set; }

        #endregion
    }

    [EdiCondition("147", Path = "LOC/0")]
    public class LOC_CONT : LOC;

    [EdiAny]
    [EdiCondition("5", Path = "LOC/0")]
    [EdiCondition("61", Path = "LOC/0")]
    public class LOC_G1 : LOC;

    [EdiAny]
    [EdiCondition("9", Path = "LOC/0")]
    [EdiCondition("11", Path = "LOC/0")]
    [EdiCondition("13", Path = "LOC/0")]
    [EdiCondition("64", Path = "LOC/0")]
    [EdiCondition("68", Path = "LOC/0")]
    [EdiCondition("70", Path = "LOC/0")]
    [EdiCondition("76", Path = "LOC/0")]
    [EdiCondition("83", Path = "LOC/0")]
    [EdiCondition("97", Path = "LOC/0")]
    [EdiCondition("152", Path = "LOC/0")]
    public class LOC_PORT : LOC;

    [EdiSegment(Description = "Measurements", Mandatory = true)]
    [EdiPath("MEA")]
    public class MEA
    {
        #region Properties

        [EdiValue("X(3)", Path = "MEA/0")] public string MeasurementApplicationQualifier { get; set; }

        [EdiValue("X(3)", Path = "MEA/2/0")] public string MeasureUnitQualifier { get; set; }

        [EdiValue("9(18)", Path = "MEA/2/1")] public string MeasurementValue { get; set; }

        #endregion
    }

    [EdiMessage]
    public class Message
    {
        #region Properties

        public UNH Header { get; set; }
        public BGM BeginningOfMessage { get; set; }
        public DTM DateTimePeriod { get; set; }
        public GRP1 Group1 { get; set; }
        public List<GRP2> Group2 { get; set; }
        public UNT Trailer { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Name and Address")]
    [EdiPath("NAD")]
    public class NAD
    {
        #region Properties

        [EdiValue("X(3)", Path = "NAD/0", Mandatory = true)]
        public string PartyQualifier { get; set; }

        [EdiValue("X(35)", Path = "NAD/1/0", Mandatory = true)]
        public string PartyIdIdentification { get; set; }

        [EdiValue("X(3)", Path = "NAD/1/1", Mandatory = true)]
        public string PartyIdIdentificationCLQ { get; set; }

        [EdiValue("X(3)", Path = "NAD/1/2", Mandatory = true)]
        public string PartyIdIdentificationCLRA { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Reference")]
    [EdiPath("RFF")]
    public class RFF
    {
        #region Properties

        [EdiValue("X(3)", Path = "RFF/0/0", Mandatory = true)]
        public string ReferenceQualifier { get; set; }

        [EdiValue("X(35)", Path = "RFF/0/1", Mandatory = true)]
        public string ReferenceNumber { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Range Details")]
    [EdiPath("RNG")]
    public class RNG
    {
        #region Properties

        [EdiValue("X(3)", Path = "RNG/0", Mandatory = true)]
        public string RangeTypeQualfier { get; set; }

        [EdiValue("X(3)", Path = "RNG/1/0", Mandatory = true)]
        public string MeasureUnitQualifier { get; set; }

        [EdiValue("9(18)", Path = "RNG/1/1", Mandatory = true)]
        public string RangeMinimum { get; set; }

        [EdiValue("9(18)", Path = "RNG/1/2", Mandatory = true)]
        public string RangeMaximum { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Details of Transport", Mandatory = true)]
    [EdiPath("TDT")]
    public class TDT
    {
        #region Properties

        [EdiValue("X(3)", Path = "TDT/0", Mandatory = true)]
        public string TransportStageQualifier { get; set; }

        [EdiValue("X(17)", Path = "TDT/1", Mandatory = true)]
        public string ConveyanceReferenceNumber { get; set; }

        [EdiValue("X(17)", Path = "TDT/4/0", Mandatory = true)]
        public string CarrierIdentification { get; set; }

        [EdiValue("X(3)", Path = "TDT/4/1", Mandatory = true)]
        public string CarrierIdentificationCLQ { get; set; }

        [EdiValue("X(3)", Path = "TDT/4/2", Mandatory = true)]
        public string CarrierIdentificationCLRA { get; set; }

        [EdiValue("X(9)", Path = "TDT/7/0", Mandatory = true)]
        public string IdOfMeansOfTransportIdentification { get; set; }

        [EdiValue("X(3)", Path = "TDT/7/1", Mandatory = true)]
        public string IdOfMeansOfTransportIdentificationCLQ { get; set; }

        [EdiValue("X(3)", Path = "TDT/7/2", Mandatory = true)]
        public string IdOfMeansOfTransportIdentificationCLRA { get; set; }

        [EdiValue("X(35)", Path = "TDT/7/3", Mandatory = true)]
        public string IdOfMeansOfTransport { get; set; }

        [EdiValue("X(3)", Path = "TDT/7/4")] public string NationalityOfMeansOfTransport { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Temperature")]
    [EdiPath("TMP")]
    public class TMP
    {
        #region Properties

        [EdiValue("X(3)", Path = "TMP/0", Mandatory = true)]
        public string TemperatureQualifier { get; set; }

        [EdiValue("9(3)", Path = "TMP/1/0", Mandatory = true)]
        public string TemperatureSetting { get; set; }

        [EdiValue("X(3)", Path = "TMP/1/1", Mandatory = true)]
        public string MeasureUnitQualifier { get; set; }

        #endregion
    }

    [EdiSegment(Mandatory = true, Description = "Interchange Header")]
    [EdiPath("UNB")]
    public class UNB
    {
        #region Properties

        [EdiValue("X(4)", Path = "UNB/0/0", Mandatory = true)]
        public string SyntaxIdentifier { get; set; }

        [EdiValue("9(1)", Path = "UNB/0/1", Mandatory = true)]
        public string SyntaxVersionNumber { get; set; }

        [EdiValue("X(35)", Path = "UNB/1", Mandatory = true)]
        public string SenderIdentification { get; set; }

        [EdiValue("X(35)", Path = "UNB/2", Mandatory = true)]
        public string RecipientInformation { get; set; }

        [EdiValue("9(6)", Path = "UNB/3/0", Mandatory = true)]
        public string DateOfPreparation { get; set; }

        [EdiValue("9(4)", Path = "UNB/3/1", Mandatory = true)]
        public string TimeOfPreparation { get; set; }

        [EdiValue("X(14)", Path = "UNB/4", Mandatory = true)]
        public string InterchangeControlReference { get; set; }

        [EdiValue("X(35)", Path = "UNB/9")] public string CommunicationsAgreementId { get; set; }

        #endregion
    }

    [EdiSegment(Mandatory = true, Description = "Message Header")]
    [EdiPath("UNH")]
    public class UNH
    {
        #region Properties

        [EdiValue("X(14)", Path = "UNH/0", Mandatory = true)]
        public string MessageReferenceNumber { get; set; }

        [EdiValue("X(6)", Path = "UNH/1/0", Mandatory = true)]
        public string MessageTypeIdentifier { get; set; }

        [EdiValue("X(3)", Path = "UNH/1/1", Mandatory = true)]
        public string MessageTypeVersionNumber { get; set; }

        [EdiValue("X(3)", Path = "UNH/1/2", Mandatory = true)]
        public string MessageTypeReleaseNumber { get; set; }

        [EdiValue("X(2)", Path = "UNH/1/3", Mandatory = true)]
        public string ControllingAgency { get; set; }

        [EdiValue("X(6)", Path = "UNH/1/4", Mandatory = true)]
        public string AssociationAssignedCode { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Message Trailer", Mandatory = true)]
    [EdiPath("UNT")]
    public class UNT
    {
        #region Properties

        [EdiValue("9(6)", Path = "UNT/0", Mandatory = true)]
        public string NumberOfSegments { get; set; }

        [EdiValue("X(14)", Path = "UNT/1", Mandatory = true)]
        public string MessageReferenceNumber { get; set; }

        #endregion
    }

    [EdiSegment(Description = "Interchange Trailer", Mandatory = true)]
    [EdiPath("UNZ")]
    public class UNZ
    {
        #region Properties

        [EdiValue("9(6)", Path = "UNZ/0", Mandatory = true)]
        public string InterchangeControlCount { get; set; }

        [EdiValue("X(14)", Path = "UNZ/1", Mandatory = true)]
        public string InterchangeControlReference { get; set; }

        #endregion
    }
}

[cleftheris]

@jmorgan-habs Hi and thanks for your interest in the library. First of all this issue is a corner case I believe is not covered completely by EDI.Net and the reason behind it is that the transmission has actually ambiguous implicit structure as you have correctly pointed out.

The only way for the library to improve the parsing/deserialization of such a structure (Serialization is not an issue because its WYSIWYG) is to take into account the occurrence limits stated in the spec. At the moment there has been work done regarding the count min max of structural elements using a EdiPathFragment notation (EdiPathFragment.IsRange). But this is currently limited to Elements and Component structures. If I find time this is a good use case to make this work somehow for Segments as well.

So the short answer is that this structure is not fully supported for deserializing without workarounds like [EdiCondition] for discriminating between the LOC segments but not sure if there is such a value that would discriminate them in the first place.

[jmorgan-habs]

Thanks for the reply. In fact, the LOC segments can be distinguished using their value at LOC/0. This is what the model I posted above is attempting to do, but it wasn't quite working in my tests. Since I left that comment, I've actually gotten a revised version of that model working by making a small tweak to TryCreateContainer to get it to honor condition attributes when looking at segment groups. I'm also working through getting models for Baplie versions 1.5 and 3.1 completed, and I can submit a pull request with my changes once those are all set.