/// <summary>
/// Builds a collection of <see cref="FunctionalGroupResponse"/> objects from Transactions
/// </summary>
/// <param name="x12Stream">Stream containing X12 Transactions</param>
/// <param name="encoding">Stream encoding for proper reading</param>
/// <returns>Collection of <see cref="FunctionalGroupResponse"/> objects</returns>
public virtual List <FunctionalGroupResponse> AcknowledgeTransactions(Stream x12Stream, Encoding encoding)
{
var responses = new Dictionary <string, FunctionalGroupResponse>();
using (var reader = new X12StreamReader(x12Stream, encoding, this.ignoredChars))
{
X12FlatTransaction trans = reader.ReadNextTransaction();
while (!string.IsNullOrEmpty(trans.Transactions.First()))
{
string[] isaElements = reader.SplitSegment(trans.IsaSegment);
string[] gsElements = reader.SplitSegment(trans.GsSegment);
string functionalIdentifierCode = gsElements[1];
string groupControlNumber = gsElements[6];
string versionIdentifierCode = gsElements[8];
if (!responses.ContainsKey(groupControlNumber))
{
responses.Add(
groupControlNumber,
new FunctionalGroupResponse
{
SenderIdQualifier = isaElements[5],
SenderId = isaElements[6],
FunctionalIdCode = functionalIdentifierCode,
GroupControlNumber = groupControlNumber,
VersionIdentifierCode = versionIdentifierCode
});
}
TransactionSetResponse response = this.AcknowledgeTransaction(reader, functionalIdentifierCode, versionIdentifierCode, trans.Transactions[0]);
responses[groupControlNumber].TransactionSetResponses.Add(response);
trans = reader.ReadNextTransaction();
}
}
return(responses.Values.ToList());
}
protected virtual TransactionSetResponse AcknowledgeTransaction(X12StreamReader reader, string functionalCode, string versionIdentifierCode, string transaction)
{
string[] stElements = reader.SplitSegment(transaction);
var response = new TransactionSetResponse
{
TransactionSetIdentifierCode = stElements[1],
TransactionSetControlNumber = stElements[2]
};
if (stElements.Length >= 4)
{
response.ImplementationConventionReference = stElements[3];
}
var transactionSpec = _specFinder.FindTransactionSpec(functionalCode, versionIdentifierCode, response.TransactionSetIdentifierCode);
if (transactionSpec == null)
{
response.SyntaxErrorCodes.Add("1"); // Transaction Set Not Supported
response.AcknowledgmentCode = AcknowledgmentCodeEnum.R_Rejected;
return(response);
}
#region Validate against transaction specification
Stack <ContainerInformation> containers = new Stack <ContainerInformation>();
var transactionContainer = new ContainerInformation {
Spec = transactionSpec
};
containers.Push(transactionContainer);
List <SegmentInformation> segmentInfos = new List <SegmentInformation>();
string[] segments = transaction.Split(new char[] { reader.Delimiters.SegmentTerminator }, StringSplitOptions.RemoveEmptyEntries);
for (int i = 0; i < segments.Length; i++)
{
string[] elements = segments[i].Split(reader.Delimiters.ElementSeparator);
var segmentInfo = new SegmentInformation {
SegmentId = elements[0], SegmentPosition = i + 1, Elements = elements
};
segmentInfo.Spec = _specFinder.FindSegmentSpec(versionIdentifierCode, segmentInfo.SegmentId);
segmentInfos.Add(segmentInfo);
ContainerInformation currentContainer = containers.Peek();
switch (segmentInfo.SegmentId)
{
case "ST":
case "SE":
segmentInfo.LoopId = "";
transactionContainer.Segments.Add(segmentInfo);
break;
case "HL":
string hlNumber = segmentInfo.Elements[1];
string hlParentNumber = segmentInfo.Elements[2];
string hlLevelCode = segmentInfo.Elements[3];
var hlSpec = transactionSpec.HierarchicalLoopSpecifications.FirstOrDefault(hls => hls.LevelCode == hlLevelCode);
if (hlSpec != null)
{
while (!(containers.Peek().Spec is TransactionSpecification))
{
if (containers.Peek().HLoopNumber == hlParentNumber)
{
break;
}
containers.Pop();
}
segmentInfo.LoopId = hlSpec.LoopId;
var hlContainer = new ContainerInformation {
Spec = hlSpec, HLoopNumber = hlNumber
};
hlContainer.Segments.Add(segmentInfo);
containers.Peek().Containers.Add(hlContainer);
containers.Push(hlContainer);
}
else
{
response.SegmentErrors.Add(CreateDataElementError(segmentInfo, 3, "I6", hlLevelCode)); //Code Value Not Used in Implementation
response.AcknowledgmentCode = AcknowledgmentCodeEnum.X_Rejected_ContentCouldNotBeAnalyzed;
return(response); // end validation if HL cannot be recognized since hl spec will not be available
}
break;
default:
bool matchFound = false;
do
{
var matchingLoopSpecs = currentContainer.Spec.LoopSpecifications.Where(ls => ls.StartingSegment.SegmentId == segmentInfo.SegmentId).ToList();
if (matchingLoopSpecs.Count > 0)
{
IContainerSpecification matchingLoopSpec = null;
if (matchingLoopSpecs.Count == 1)
{
matchingLoopSpec = matchingLoopSpecs.First();
}
else
{
string entityCode = elements[1];
matchingLoopSpec = matchingLoopSpecs.FirstOrDefault(ls => ls.StartingSegment.EntityIdentifiers.Exists(ei => ei.Code == entityCode));
}
if (matchingLoopSpec != null)
{
segmentInfo.LoopId = matchingLoopSpec.LoopId;
var loopContainer = new ContainerInformation {
Spec = matchingLoopSpec
};
loopContainer.Segments.Add(segmentInfo);
containers.Peek().Containers.Add(loopContainer);
containers.Push(loopContainer);
matchFound = true;
}
else
{
response.SegmentErrors.Add(CreateSegmentError(segmentInfo, "6")); //Segment Not in Defined Transaction Set
response.AcknowledgmentCode = AcknowledgmentCodeEnum.X_Rejected_ContentCouldNotBeAnalyzed;
return(response);
}
}
else if (currentContainer.Spec.SegmentSpecifications.Exists(ss => ss.SegmentId == segmentInfo.SegmentId))
{
segmentInfo.LoopId = currentContainer.Spec.LoopId;
currentContainer.Segments.Add(segmentInfo);
matchFound = true;
}
else
{
if (currentContainer.Spec is TransactionSpecification)
{
response.SegmentErrors.Add(CreateSegmentError(segmentInfo, "2")); // Unexpected segment
response.AcknowledgmentCode = AcknowledgmentCodeEnum.X_Rejected_ContentCouldNotBeAnalyzed;
return(response); // end validation if unrecognized segment encountered (cannot guarantee we are pointing at correct container)
}
else
{
containers.Pop();
currentContainer = containers.Peek();
}
}
} while (!matchFound);
break;
}
response.SegmentErrors.AddRange(ValidateSegmentAgainstSpec(segmentInfo));
}
response.SegmentErrors.AddRange(ValidateContainerAgainstSpec(transactionContainer));
#endregion
#region Validate transaction trailer
var trailerSegment = segmentInfos.FirstOrDefault(si => si.SegmentId == "SE");
if (trailerSegment == null)
{
response.SyntaxErrorCodes.Add("2"); //Transaction Set Trailer Missing
}
else
{
if (trailerSegment.Elements.Length <= 2 || trailerSegment.Elements[2] != response.TransactionSetControlNumber)
{
response.SyntaxErrorCodes.Add("3"); // Transaction Set Control Number in Header and Trailer Do Not Match
}
if (trailerSegment.Elements.Length >= 2)
{
int segmentCount;
int.TryParse(trailerSegment.Elements[1], out segmentCount);
if (segmentCount != segmentInfos.Count)
{
response.SyntaxErrorCodes.Add("4"); // Number of Included Segments Does Not Match Actual Count
}
}
else
{
response.SyntaxErrorCodes.Add("4"); // Number of Included Segments Does Not Match Actual Count
}
}
#endregion
if (response.SegmentErrors.Count > 0 || response.SyntaxErrorCodes.Count > 0)
{
if (response.SegmentErrors.Count > 0)
{
response.SyntaxErrorCodes.Add("5"); //One or More Segments in Error
}
if (response.AcknowledgmentCode == AcknowledgmentCodeEnum.A_Accepted)
{
response.AcknowledgmentCode = AcknowledgmentCodeEnum.E_Accepted_ButErrorsWereNoted;
}
}
return(response);
}
/// <summary>
/// Builds a <see cref="TransactionSetResponse"/> object from the provided stream
/// </summary>
/// <param name="reader">Stream to pull transaction set data from</param>
/// <param name="functionalCode">Function group code to associate with transaction set</param>
/// <param name="versionIdentifierCode">Specification version code</param>
/// <param name="transaction">Transaction segment string to be parsed</param>
/// <returns>Transaction set response whether the set is valid, and the segment data</returns>
protected virtual TransactionSetResponse AcknowledgeTransaction(X12StreamReader reader, string functionalCode, string versionIdentifierCode, string transaction)
{
string[] transactionElements = reader.SplitSegment(transaction);
var response = new TransactionSetResponse
{
TransactionSetIdentifierCode = transactionElements[1],
TransactionSetControlNumber = transactionElements[2]
};
if (transactionElements.Length >= 4)
{
response.ImplementationConventionReference = transactionElements[3];
}
TransactionSpecification transactionSpec = this.specFinder.FindTransactionSpec(
functionalCode,
versionIdentifierCode,
response.TransactionSetIdentifierCode);
if (transactionSpec == null)
{
response.SyntaxErrorCodes.Add("1");
response.AcknowledgmentCode = AcknowledgmentCode.R_Rejected;
return(response);
}
var containers = new Stack <ContainerInformation>();
var transactionContainer = new ContainerInformation {
Spec = transactionSpec
};
containers.Push(transactionContainer);
var segmentInfos = new List <SegmentInformation>();
string[] segments = transaction.Split(new[] { reader.Delimiters.SegmentTerminator }, System.StringSplitOptions.RemoveEmptyEntries);
for (int i = 0; i < segments.Length; i++)
{
string[] elements = segments[i].Split(reader.Delimiters.ElementSeparator);
var segmentInfo = new SegmentInformation {
SegmentId = elements[0], SegmentPosition = i + 1, Elements = elements
};
segmentInfo.Spec = this.specFinder.FindSegmentSpec(versionIdentifierCode, segmentInfo.SegmentId);
segmentInfos.Add(segmentInfo);
ContainerInformation currentContainer = containers.Peek();
switch (segmentInfo.SegmentId)
{
case "ST":
case "SE":
segmentInfo.LoopId = string.Empty;
transactionContainer.Segments.Add(segmentInfo);
break;
case "HL":
string hloopNumber = segmentInfo.Elements[1];
string hloopParentNumber = segmentInfo.Elements[2];
string hloopLevelCode = segmentInfo.Elements[3];
HierarchicalLoopSpecification hloopSpec = transactionSpec.HierarchicalLoopSpecifications.FirstOrDefault(hls => hls.LevelCode == hloopLevelCode);
if (hloopSpec != null)
{
while (!(containers.Peek().Spec is TransactionSpecification))
{
if (containers.Peek().HLoopNumber == hloopParentNumber)
{
break;
}
containers.Pop();
}
segmentInfo.LoopId = hloopSpec.LoopId;
var hloopContainer = new ContainerInformation {
Spec = hloopSpec, HLoopNumber = hloopNumber
};
hloopContainer.Segments.Add(segmentInfo);
containers.Peek().Containers.Add(hloopContainer);
containers.Push(hloopContainer);
}
else
{
response.SegmentErrors.Add(this.CreateDataElementError(segmentInfo, 3, "I6", hloopLevelCode));
response.AcknowledgmentCode = AcknowledgmentCode.X_Rejected_ContentCouldNotBeAnalyzed;
}
break;
default:
bool matchFound = false;
do
{
var matchingLoopSpecs = currentContainer.Spec.LoopSpecifications.Where(ls => ls.StartingSegment.SegmentId == segmentInfo.SegmentId).ToList();
if (matchingLoopSpecs.Count > 0)
{
IContainerSpecification matchingLoopSpec;
if (matchingLoopSpecs.Count == 1)
{
matchingLoopSpec = matchingLoopSpecs.First();
}
else
{
string entityCode = elements[1];
matchingLoopSpec = matchingLoopSpecs.FirstOrDefault(ls => ls.StartingSegment.EntityIdentifiers.Exists(ei => ei.Code == entityCode));
}
if (matchingLoopSpec != null)
{
segmentInfo.LoopId = matchingLoopSpec.LoopId;
var loopContainer = new ContainerInformation {
Spec = matchingLoopSpec
};
loopContainer.Segments.Add(segmentInfo);
containers.Peek().Containers.Add(loopContainer);
containers.Push(loopContainer);
matchFound = true;
}
else
{
response.SegmentErrors.Add(this.CreateSegmentError(segmentInfo, "6"));
response.AcknowledgmentCode = AcknowledgmentCode.X_Rejected_ContentCouldNotBeAnalyzed;
return(response);
}
}
else if (currentContainer.Spec.SegmentSpecifications.Exists(ss => ss.SegmentId == segmentInfo.SegmentId))
{
segmentInfo.LoopId = currentContainer.Spec.LoopId;
currentContainer.Segments.Add(segmentInfo);
matchFound = true;
}
else
{
if (currentContainer.Spec is TransactionSpecification)
{
response.SegmentErrors.Add(this.CreateSegmentError(segmentInfo, "2"));
response.AcknowledgmentCode = AcknowledgmentCode.X_Rejected_ContentCouldNotBeAnalyzed;
return(response);
}
containers.Pop();
currentContainer = containers.Peek();
}
}while (!matchFound);
break;
}
response.SegmentErrors.AddRange(this.ValidateSegmentAgainstSpec(segmentInfo));
}
response.SegmentErrors.AddRange(this.ValidateContainerAgainstSpec(transactionContainer));
var trailerSegment = segmentInfos.FirstOrDefault(si => si.SegmentId == "SE");
if (trailerSegment == null)
{
response.SyntaxErrorCodes.Add("2");
}
else
{
if (trailerSegment.Elements.Length <= 2 || trailerSegment.Elements[2] != response.TransactionSetControlNumber)
{
response.SyntaxErrorCodes.Add("3");
}
if (trailerSegment.Elements.Length >= 2)
{
int segmentCount;
int.TryParse(trailerSegment.Elements[1], out segmentCount);
if (segmentCount != segmentInfos.Count)
{
response.SyntaxErrorCodes.Add("4");
}
}
else
{
response.SyntaxErrorCodes.Add("4");
}
}
if (response.SegmentErrors.Count > 0 || response.SyntaxErrorCodes.Count > 0)
{
if (response.SegmentErrors.Count > 0)
{
response.SyntaxErrorCodes.Add("5");
}
if (response.AcknowledgmentCode == AcknowledgmentCode.A_Accepted)
{
response.AcknowledgmentCode = AcknowledgmentCode.E_Accepted_ButErrorsWereNoted;
}
}
return(response);
}