X12Reader Module

Properties   Methods   Events   Config Settings   Errors  

The X12Reader module efficiently parses complete X12 transmissions, providing a convenient way to extract and explore data from all included transaction sets.

Syntax

EDISDK.X12Reader

Remarks

The class allows you to parse an incoming EDI document. To parse a document, first, use LoadSchema to load a schema file into the class. Next, select the document you want to process by setting InputFile or InputData and calling Parse.

As the class processes the document, its events will fire and the contents of the document will be available in the Interchange, FunctionalGroup, Message, Segment, Element, and Component properties. The corresponding *Index properties can be thought of as a path within the document. For example, setting the MessageIndex property will cause the SegmentCount property to be updated with the number of segments within the selected message, and then the SegmentIndex property can be used to select one of the segments within that message.

To manage the amount of memory used during processing, the BuildDOM property can be used to select how much of the message will be available in the properties at once:

• bdEntireDocument - The entire document will be available at once.
• bdInterchange - Only the current interchange and its contents will be available.
• bdMessage - Only the current message will be available.
• bdNone - Only the current segment and its elements will be available.

During parsing, the class performs basic validation of the incoming document. If an error is encountered, the ValidateWarning event will fire.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

AckType Property (X12Reader Module)

Specifies the type of ACK that will be generated by GenerateAck .

Syntax

• Swift
• Objective-C

public var ackType: X12ReaderAckTypes {
  get {...}
  set {...}
}

public enum X12ReaderAckTypes: Int32 {
  case at997 = 0
  case at999 = 1
  case atTA1 = 2
}

@property (nonatomic,readwrite,assign,getter=ackType,setter=setAckType:) int ackType;

- (int)ackType;
- (void)setAckType :(int)newAckType;

Default Value

0

Remarks

This setting specifies the type of ACK that will be generated when GenerateAck is called. Options include:

BuildDOM Property (X12Reader Module)

Specifies how much of the current document should be held in memory.

Syntax

• Swift
• Objective-C

public var buildDOM: X12ReaderBuildDOMs {
  get {...}
  set {...}
}

public enum X12ReaderBuildDOMs: Int32 {
  case bdEntireDocument = 0
  case bdInterchange = 1
  case bdTranSet = 2
  case bdNone = 3
}

@property (nonatomic,readwrite,assign,getter=buildDOM,setter=setBuildDOM:) int buildDOM;

- (int)buildDOM;
- (void)setBuildDOM :(int)newBuildDOM;

Default Value

0

Remarks

Set BuildDOM to bdEntireDocument (0) when you need to browse the current document.

Use bdInterchange (1) when parsing large documents to tell the component to only hold an internal object model of the current Interchange being parsed. When this value is used, and a new Interchange is encountered during parsing, the old interchange is cleared from memory. If the input contains a single Interchange, this is equivalent to using bdEntireDocument.

Use bdTranSet (2) when parsing large documents to tell the component to only hold an internal object model of the current transaction being parsed. When this value is used, and a new transaction is encountered during parsing, the old transaction is cleared from memory.

A value of bdNone (3) will tell the component to not save any internal state of the document being parsed, and thus browsing will be unavailable.

Component Property (X12Reader Module)

The current module.

Syntax

• Swift
• Objective-C

public var component: EDIElement {
  get {...}
}

@property (nonatomic,readonly,assign,getter=componentDataType) NSString* componentDataType;

- (NSString*)componentDataType;

@property (nonatomic,readonly,assign,getter=componentIsComposite) BOOL componentIsComposite;

- (BOOL)componentIsComposite;

@property (nonatomic,readonly,assign,getter=componentMaxLen) int componentMaxLen;

- (int)componentMaxLen;

@property (nonatomic,readonly,assign,getter=componentMinLen) int componentMinLen;

- (int)componentMinLen;

@property (nonatomic,readonly,assign,getter=componentSchemaDesc) NSString* componentSchemaDesc;

- (NSString*)componentSchemaDesc;

@property (nonatomic,readonly,assign,getter=componentSchemaName) NSString* componentSchemaName;

- (NSString*)componentSchemaName;

@property (nonatomic,readonly,assign,getter=componentValue) NSString* componentValue;

- (NSString*)componentValue;

 

Default Value

1

Remarks

When the current Element is a composite element, this property contains the component specified by ComponentIndex.

This property is read-only.

ComponentCount Property (X12Reader Module)

The number of modules in the current Element.

Syntax

• Swift
• Objective-C

public var componentCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=componentCount) int componentCount;

- (int)componentCount;

Default Value

0

Remarks

If the current Element is composite, this property contains the number of components within the element.

This property is read-only.

ComponentIndex Property (X12Reader Module)

The index of the current Module.

Syntax

• Swift
• Objective-C

public var componentIndex: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=componentIndex,setter=setComponentIndex:) int componentIndex;

- (int)componentIndex;
- (void)setComponentIndex :(int)newComponentIndex;

Default Value

1

Remarks

If the current Element is composite, this property is used to specify a Component within the element.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory. You can then use InterchangeIndex, FunctionalGroupIndex, MessageIndex, SegmentIndex, ElementIndex and ComponentIndex to navigate to a specific Component within the parsed document.

Delimiters Property (X12Reader Module)

Contains the delimiters for the EDI Document.

Syntax

• Swift
• Objective-C

public var delimiters: X12Delimiters {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=delimiterComponent,setter=setDelimiterComponent:) NSString* delimiterComponent;

- (NSString*)delimiterComponent;
- (void)setDelimiterComponent :(NSString*)newDelimiterComponent;

@property (nonatomic,readwrite,assign,getter=delimiterElement,setter=setDelimiterElement:) NSString* delimiterElement;

- (NSString*)delimiterElement;
- (void)setDelimiterElement :(NSString*)newDelimiterElement;

@property (nonatomic,readwrite,assign,getter=delimiterRepetition,setter=setDelimiterRepetition:) NSString* delimiterRepetition;

- (NSString*)delimiterRepetition;
- (void)setDelimiterRepetition :(NSString*)newDelimiterRepetition;

@property (nonatomic,readwrite,assign,getter=delimiterSegment,setter=setDelimiterSegment:) NSString* delimiterSegment;

- (NSString*)delimiterSegment;
- (void)setDelimiterSegment :(NSString*)newDelimiterSegment;

 

Default Value

1

Remarks

This property contains the delimiters that will be used when parsing the X12 document. If the document uses delimiters other than the default, change the properties of this object to parse the document correctly.

This property is read-only.

Element Property (X12Reader Module)

The current element.

Syntax

• Swift
• Objective-C

public var element: EDIElement {
  get {...}
}

@property (nonatomic,readonly,assign,getter=elementDataType) NSString* elementDataType;

- (NSString*)elementDataType;

@property (nonatomic,readonly,assign,getter=elementIsComposite) BOOL elementIsComposite;

- (BOOL)elementIsComposite;

@property (nonatomic,readonly,assign,getter=elementMaxLen) int elementMaxLen;

- (int)elementMaxLen;

@property (nonatomic,readonly,assign,getter=elementMinLen) int elementMinLen;

- (int)elementMinLen;

@property (nonatomic,readonly,assign,getter=elementSchemaDesc) NSString* elementSchemaDesc;

- (NSString*)elementSchemaDesc;

@property (nonatomic,readonly,assign,getter=elementSchemaName) NSString* elementSchemaName;

- (NSString*)elementSchemaName;

@property (nonatomic,readonly,assign,getter=elementValue) NSString* elementValue;

- (NSString*)elementValue;

 

Default Value

1

Remarks

This property contains the element within the current Segment specified by ElementIndex.

This property is read-only.

ElementCount Property (X12Reader Module)

The number of elements in the current Segment.

Syntax

• Swift
• Objective-C

public var elementCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=elementCount) int elementCount;

- (int)elementCount;

Default Value

0

Remarks

This property contains the total number of elements in the current Segment.

This property is read-only.

ElementIndex Property (X12Reader Module)

The index of the current Element.

Syntax

• Swift
• Objective-C

public var elementIndex: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=elementIndex,setter=setElementIndex:) int elementIndex;

- (int)elementIndex;
- (void)setElementIndex :(int)newElementIndex;

Default Value

1

Remarks

This property is used to specify an Element within the current Segment.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory. You can then use InterchangeIndex, FunctionalGroupIndex, MessageIndex, SegmentIndex and ElementIndex to navigate to specific Element within the parsed document.

FunctionalGroup Property (X12Reader Module)

The current FunctionalGroup.

Syntax

• Swift
• Objective-C

public var functionalGroup: X12FunctionalGroup {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=FGroupAppReceiverCode,setter=setFGroupAppReceiverCode:) NSString* FGroupAppReceiverCode;

- (NSString*)FGroupAppReceiverCode;
- (void)setFGroupAppReceiverCode :(NSString*)newFGroupAppReceiverCode;

@property (nonatomic,readwrite,assign,getter=FGroupAppSenderCode,setter=setFGroupAppSenderCode:) NSString* FGroupAppSenderCode;

- (NSString*)FGroupAppSenderCode;
- (void)setFGroupAppSenderCode :(NSString*)newFGroupAppSenderCode;

@property (nonatomic,readwrite,assign,getter=FGroupDate,setter=setFGroupDate:) NSString* FGroupDate;

- (NSString*)FGroupDate;
- (void)setFGroupDate :(NSString*)newFGroupDate;

@property (nonatomic,readwrite,assign,getter=FGroupFunctionalIdentifierCode,setter=setFGroupFunctionalIdentifierCode:) NSString* FGroupFunctionalIdentifierCode;

- (NSString*)FGroupFunctionalIdentifierCode;
- (void)setFGroupFunctionalIdentifierCode :(NSString*)newFGroupFunctionalIdentifierCode;

@property (nonatomic,readwrite,assign,getter=FGroupGroupControlNum,setter=setFGroupGroupControlNum:) NSString* FGroupGroupControlNum;

- (NSString*)FGroupGroupControlNum;
- (void)setFGroupGroupControlNum :(NSString*)newFGroupGroupControlNum;

@property (nonatomic,readwrite,assign,getter=FGroupResponsibleAgencyCode,setter=setFGroupResponsibleAgencyCode:) NSString* FGroupResponsibleAgencyCode;

- (NSString*)FGroupResponsibleAgencyCode;
- (void)setFGroupResponsibleAgencyCode :(NSString*)newFGroupResponsibleAgencyCode;

@property (nonatomic,readwrite,assign,getter=FGroupTime,setter=setFGroupTime:) NSString* FGroupTime;

- (NSString*)FGroupTime;
- (void)setFGroupTime :(NSString*)newFGroupTime;

@property (nonatomic,readwrite,assign,getter=FGroupVersion,setter=setFGroupVersion:) NSString* FGroupVersion;

- (NSString*)FGroupVersion;
- (void)setFGroupVersion :(NSString*)newFGroupVersion;

 

Default Value

1

Remarks

This property contains the current FunctionalGroup within the Interchange

This property is read-only and not available at design time.

Please refer to the FunctionalGroup type for a complete list of fields.

This property is read-only.

FunctionalGroupCount Property (X12Reader Module)

The number of FunctionalGroups in the current Interchange.

Syntax

• Swift
• Objective-C

public var functionalGroupCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=functionalGroupCount) int functionalGroupCount;

- (int)functionalGroupCount;

Default Value

0

Remarks

This property contains the number of FunctionalGroups in the current Interchange.

This property is read-only.

FunctionalGroupIndex Property (X12Reader Module)

The index of the current FunctionalGroup.

Syntax

• Swift
• Objective-C

public var functionalGroupIndex: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=functionalGroupIndex,setter=setFunctionalGroupIndex:) int functionalGroupIndex;

- (int)functionalGroupIndex;
- (void)setFunctionalGroupIndex :(int)newFunctionalGroupIndex;

Default Value

1

Remarks

This property is used to specify a FunctionalGroup within the current Interchange.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory, including all interchanges, and functional groups. You can then use InterchangeIndex and FunctionalGroupIndex to navigate to a specific FunctionalGroup within the parsed document.

InputData Property (X12Reader Module)

The EDI message, specified as a string.

Syntax

• Swift
• Objective-C

public var inputData: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputData,setter=setInputData:) NSString* inputData;

- (NSString*)inputData;
- (void)setInputData :(NSString*)newInputData;

Default Value

""

Remarks

Set this property to specify the input EDI message as a string. The message can then be parsed with Parse.

InputFile Property (X12Reader Module)

The file containing the EDI message.

Syntax

• Swift
• Objective-C

public var inputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

""

Remarks

Set this property to specify the input EDI message as a file. The message can then be parsed with Parse.

If the file is not found or cannot be opened, an error will be returned.

Note: If both InputFile and InputData are set, InputData takes precedence.

Interchange Property (X12Reader Module)

The current Interchange.

Syntax

• Swift
• Objective-C

public var interchange: X12Interchange {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=interchangeAckRequest,setter=setInterchangeAckRequest:) NSString* interchangeAckRequest;

- (NSString*)interchangeAckRequest;
- (void)setInterchangeAckRequest :(NSString*)newInterchangeAckRequest;

@property (nonatomic,readwrite,assign,getter=interchangeAuthorizationInfo,setter=setInterchangeAuthorizationInfo:) NSString* interchangeAuthorizationInfo;

- (NSString*)interchangeAuthorizationInfo;
- (void)setInterchangeAuthorizationInfo :(NSString*)newInterchangeAuthorizationInfo;

@property (nonatomic,readwrite,assign,getter=interchangeAuthorizationInfoQualifier,setter=setInterchangeAuthorizationInfoQualifier:) NSString* interchangeAuthorizationInfoQualifier;

- (NSString*)interchangeAuthorizationInfoQualifier;
- (void)setInterchangeAuthorizationInfoQualifier :(NSString*)newInterchangeAuthorizationInfoQualifier;

@property (nonatomic,readwrite,assign,getter=interchangeDate,setter=setInterchangeDate:) NSString* interchangeDate;

- (NSString*)interchangeDate;
- (void)setInterchangeDate :(NSString*)newInterchangeDate;

@property (nonatomic,readwrite,assign,getter=interchangeInterchangeControlNum,setter=setInterchangeInterchangeControlNum:) NSString* interchangeInterchangeControlNum;

- (NSString*)interchangeInterchangeControlNum;
- (void)setInterchangeInterchangeControlNum :(NSString*)newInterchangeInterchangeControlNum;

@property (nonatomic,readwrite,assign,getter=interchangeInterchangeControlVersionNum,setter=setInterchangeInterchangeControlVersionNum:) NSString* interchangeInterchangeControlVersionNum;

- (NSString*)interchangeInterchangeControlVersionNum;
- (void)setInterchangeInterchangeControlVersionNum :(NSString*)newInterchangeInterchangeControlVersionNum;

@property (nonatomic,readwrite,assign,getter=interchangeReceiverID,setter=setInterchangeReceiverID:) NSString* interchangeReceiverID;

- (NSString*)interchangeReceiverID;
- (void)setInterchangeReceiverID :(NSString*)newInterchangeReceiverID;

@property (nonatomic,readwrite,assign,getter=interchangeReceiverIDQualifier,setter=setInterchangeReceiverIDQualifier:) NSString* interchangeReceiverIDQualifier;

- (NSString*)interchangeReceiverIDQualifier;
- (void)setInterchangeReceiverIDQualifier :(NSString*)newInterchangeReceiverIDQualifier;

@property (nonatomic,readwrite,assign,getter=interchangeSecurityInfo,setter=setInterchangeSecurityInfo:) NSString* interchangeSecurityInfo;

- (NSString*)interchangeSecurityInfo;
- (void)setInterchangeSecurityInfo :(NSString*)newInterchangeSecurityInfo;

@property (nonatomic,readwrite,assign,getter=interchangeSecurityInfoQualifier,setter=setInterchangeSecurityInfoQualifier:) NSString* interchangeSecurityInfoQualifier;

- (NSString*)interchangeSecurityInfoQualifier;
- (void)setInterchangeSecurityInfoQualifier :(NSString*)newInterchangeSecurityInfoQualifier;

@property (nonatomic,readwrite,assign,getter=interchangeSenderID,setter=setInterchangeSenderID:) NSString* interchangeSenderID;

- (NSString*)interchangeSenderID;
- (void)setInterchangeSenderID :(NSString*)newInterchangeSenderID;

@property (nonatomic,readwrite,assign,getter=interchangeSenderIDQualifier,setter=setInterchangeSenderIDQualifier:) NSString* interchangeSenderIDQualifier;

- (NSString*)interchangeSenderIDQualifier;
- (void)setInterchangeSenderIDQualifier :(NSString*)newInterchangeSenderIDQualifier;

@property (nonatomic,readwrite,assign,getter=interchangeTime,setter=setInterchangeTime:) NSString* interchangeTime;

- (NSString*)interchangeTime;
- (void)setInterchangeTime :(NSString*)newInterchangeTime;

@property (nonatomic,readwrite,assign,getter=interchangeUsageIndicator,setter=setInterchangeUsageIndicator:) NSString* interchangeUsageIndicator;

- (NSString*)interchangeUsageIndicator;
- (void)setInterchangeUsageIndicator :(NSString*)newInterchangeUsageIndicator;

 

Default Value

1

Remarks

This property contains the current Interchange within the document specified by InterchangeIndex.

This property is read-only.

InterchangeCount Property (X12Reader Module)

The number of Interchanges in the document.

Syntax

• Swift
• Objective-C

public var interchangeCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=interchangeCount) int interchangeCount;

- (int)interchangeCount;

Default Value

0

Remarks

This property contains the number of Interchanges in the current document.

This property is read-only.

InterchangeIndex Property (X12Reader Module)

The index of the current Interchange.

Syntax

• Swift
• Objective-C

public var interchangeIndex: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=interchangeIndex,setter=setInterchangeIndex:) int interchangeIndex;

- (int)interchangeIndex;
- (void)setInterchangeIndex :(int)newInterchangeIndex;

Default Value

1

Remarks

This property is used to specify an Interchange within the document.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory, including all interchanges. You can then use InterchangeIndex to navigate to specific Interchange within the parsed document.

Loop Property (X12Reader Module)

Specifies the loop to load segments from.

Syntax

• Swift
• Objective-C

public var loop: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=loop,setter=setLoop:) NSString* loop;

- (NSString*)loop;
- (void)setLoop :(NSString*)newLoop;

Default Value

""

Remarks

When this property is set, only segments from the specified loop and iteration will be available through the Segment properties.

A path for a loop consists of the name of the loop followed by an index indicating the iteration, like this:

reader.Loop = "N1Loop[2]";

If the loop is nested inside of another loop, the parent and child are connected by a ".":

reader.Loop = ""AK2Loop[2].AK3Loop[1]"; That can be repeated if a loop is nested more than one level deep.

Segment Property (X12Reader Module)

The current segment.

Syntax

• Swift
• Objective-C

public var segment: EDISegment {
  get {...}
}

@property (nonatomic,readonly,assign,getter=segmentOptional) BOOL segmentOptional;

- (BOOL)segmentOptional;

@property (nonatomic,readonly,assign,getter=segmentPath) NSString* segmentPath;

- (NSString*)segmentPath;

@property (nonatomic,readonly,assign,getter=segmentSchemaPath) NSString* segmentSchemaPath;

- (NSString*)segmentSchemaPath;

@property (nonatomic,readonly,assign,getter=segmentTag) NSString* segmentTag;

- (NSString*)segmentTag;

 

Default Value

1

Remarks

This property contains the segment within the current Message specified by SegmentIndex.

This property is read-only.

SegmentCount Property (X12Reader Module)

The number of segments in the current TransactionSet.

Syntax

• Swift
• Objective-C

public var segmentCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=segmentCount) int segmentCount;

- (int)segmentCount;

Default Value

0

Remarks

This property contains the number of elements in the current TransactionSet.

This property is read-only.

SegmentIndex Property (X12Reader Module)

This property is used to specify a Segment within the current TransactionSet .

Syntax

• Swift
• Objective-C

public var segmentIndex: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=segmentIndex,setter=setSegmentIndex:) int segmentIndex;

- (int)segmentIndex;
- (void)setSegmentIndex :(int)newSegmentIndex;

Default Value

1

Remarks

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory. You can then use InterchangeIndex, FunctionalGroupIndex, TransactionSetIndex and SegmentIndex to navigate to specific Segment within the parsed document.

TransactionSet Property (X12Reader Module)

The current TransactionSet.

Syntax

• Swift
• Objective-C

public var transactionSet: X12TransactionSet {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=transSetImpConventionReference,setter=setTransSetImpConventionReference:) NSString* transSetImpConventionReference;

- (NSString*)transSetImpConventionReference;
- (void)setTransSetImpConventionReference :(NSString*)newTransSetImpConventionReference;

@property (nonatomic,readwrite,assign,getter=transSetTransactionSetControlNum,setter=setTransSetTransactionSetControlNum:) NSString* transSetTransactionSetControlNum;

- (NSString*)transSetTransactionSetControlNum;
- (void)setTransSetTransactionSetControlNum :(NSString*)newTransSetTransactionSetControlNum;

@property (nonatomic,readwrite,assign,getter=transSetTransactionSetIDCode,setter=setTransSetTransactionSetIDCode:) NSString* transSetTransactionSetIDCode;

- (NSString*)transSetTransactionSetIDCode;
- (void)setTransSetTransactionSetIDCode :(NSString*)newTransSetTransactionSetIDCode;

 

Default Value

1

Remarks

This property contains the TransactionSet within the current Interchange or FunctionalGroup specified by TransactionSetIndex.

This property is read-only.

TransactionSetCount Property (X12Reader Module)

The number of TransactionSets in the current FunctionalGroup.

Syntax

• Swift
• Objective-C

public var transactionSetCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=transactionSetCount) int transactionSetCount;

- (int)transactionSetCount;

Default Value

0

Remarks

This property contains the count of TransactionSets in the current FunctionalGroup.

This property is read-only.

TransactionSetIndex Property (X12Reader Module)

The current TransactionSet index.

Syntax

• Swift
• Objective-C

public var transactionSetIndex: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=transactionSetIndex,setter=setTransactionSetIndex:) int transactionSetIndex;

- (int)transactionSetIndex;
- (void)setTransactionSetIndex :(int)newTransactionSetIndex;

Default Value

1

Remarks

This property contains the index of the current TransactionSet within the current FunctionalGroup.

ValidateOnParse Property (X12Reader Module)

When true, the module will validate any documents it parses.

Syntax

• Swift
• Objective-C

public var validateOnParse: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=validateOnParse,setter=setValidateOnParse:) BOOL validateOnParse;

- (BOOL)validateOnParse;
- (void)setValidateOnParse :(BOOL)newValidateOnParse;

Default Value

False

Remarks

When this property is set to True, the class will perform validation on the document when Parse is called. The ValidateWarning event will fire for each error it encounters.

ValidationErrors Property (X12Reader Module)

Collection of validation errors for the current document.

Syntax

• Swift
• Objective-C

public var validationErrors: Array<X12ValidationErrorDetail> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=validationErrorCount) int validationErrorCount;

- (int)validationErrorCount;

- (int)validationErrorColumn:(int)validationErrorIndex;

- (int)validationErrorComponentIndex:(int)validationErrorIndex;

- (int)validationErrorElementIndex:(int)validationErrorIndex;

- (NSString*)validationErrorErrorCode:(int)validationErrorIndex;

- (NSString*)validationErrorErrorMessage:(int)validationErrorIndex;

- (int)validationErrorErrorType:(int)validationErrorIndex;

- (int)validationErrorFGroupIndex:(int)validationErrorIndex;

- (int)validationErrorInterchangeIndex:(int)validationErrorIndex;

- (int)validationErrorLine:(int)validationErrorIndex;

- (long long)validationErrorPosition:(int)validationErrorIndex;

- (int)validationErrorSegmentIndex:(int)validationErrorIndex;

- (NSString*)validationErrorSegmentTag:(int)validationErrorIndex;

- (int)validationErrorTransactionSetIndex:(int)validationErrorIndex;

Default Value

1

Remarks

After calling Validate this property contains details of any validation errors. Validation errors are also accessible through the ValidateWarning event as the document is validated.

This property is read-only.

Config Method (X12Reader Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GenerateAck Method (X12Reader Module)

Generates an ACK in response to the most recently parsed TransactionSet.

Syntax

• Swift
• Objective-C

public func generateAck() throws -> String

- (NSString*)generateAck;

Remarks

After parsing a TransactionSet, call this method to generate an ACK that you can send back in response. The type of ACK generated can be controlled by setting the AckType property.

GetElementValue Method (X12Reader Module)

Returns the value of the element or component at the specified path.

Syntax

• Swift
• Objective-C

public func getElementValue(path: String) throws -> String

- (NSString*)getElementValue:(NSString*)path;

Remarks

This method returns the value of the element at the specified path. The path starts at the current Message and consists of loops (with indexes to indicate the iteration), a segment tag, and 1-2 indexes to indicate the element or component.

For a simple element the path should include the path to a specific iteration of a loop (as in the Loop property), followed by a segment tag and an index for the element position within the segment, each separated by a ".":

reader.GetElementValue("N1Loop[2].N4.4");

When selecting a component of a composite element, the component index should be added after the element index:

reader.GetElementValue("AK2Loop[2].AK3Loop[1].AK4.1.1");

LoadSchema Method (X12Reader Module)

Loads schema information from a file or string data.

Syntax

• Swift
• Objective-C

public func loadSchema(fileOrData: String, messagename: String) throws -> Void

- (void)loadSchema:(NSString*)fileOrData :(NSString*)messagename;

Remarks

This method loads schema information for use when parsing, validating, and translating messages.

The FileOrData parameter can be set to the path of a file containing schema data, or can be set to the contents of a schema file directly.

MessageName can be set to the name of a specific message to load only the specified message's schema information. If left empty or set to "*", the entire schema will be loaded.

Parse Method (X12Reader Module)

Parse the EDI document and fire parsing events.

Syntax

• Swift
• Objective-C

public func parse() throws -> Void

- (void)parse;

Remarks

This method parses the input EDI document, firing the following events as it parses:

• StartInterchange
• StartFunctionalGroup
• ResolveSchema
• StartTransactionSet
• StartLoop
• Segment
• EndLoop
• EndTransactionSet
• EndFunctionalGroup
• EndInterchange

When multiple input sources are specified, only the highest-priority input will be used, in the following order:

1. SetInputStream
2. InputFile
3. InputData

Reset Method (X12Reader Module)

Sets the component to its initial state.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

When called the class clears all inputs and outputs, and resets all properties to their default values.

SchemaCode Method (X12Reader Module)

Defines a code value within a list of codes.

Syntax

• Swift
• Objective-C

public func schemaCode(schemaId: String, codeListId: String, value: String, description_: String) throws -> Void

- (void)schemaCode:(NSString*)schemaId :(NSString*)codeListId :(NSString*)value :(NSString*)description;

Remarks

Creates a schema definition for a code value within a particular list of codes.

This method can be used when defining a schema instead of loading one from a file.

SchemaCodeList Method (X12Reader Module)

Defines a list of codes.

Syntax

• Swift
• Objective-C

public func schemaCodeList(schemaId: String, codeListId: String, description_: String) throws -> Void

- (void)schemaCodeList:(NSString*)schemaId :(NSString*)codeListId :(NSString*)description;

Remarks

Creates a schema definition for an empty list of codes. SchemaCode can be used to add code values to the list.

This method can be used when defining a schema instead of loading one from a file.

SchemaComposite Method (X12Reader Module)

Defines a composite element.

Syntax

• Swift
• Objective-C

public func schemaComposite(schemaId: String, compositeId: String, description_: String) throws -> Void

- (void)schemaComposite:(NSString*)schemaId :(NSString*)compositeId :(NSString*)description;

Remarks

Creates a schema definition for a composite element. SchemaElementRef can be used to add components to the element.

This method can be used when defining a schema instead of loading one from a file.

SchemaElement Method (X12Reader Module)

Defines a simple element.

Syntax

• Swift
• Objective-C

public func schemaElement(schemaId: String, elementId: String, dataType: String, minLength: Int32, maxLength: Int32, codeId: String, description_: String) throws -> Void

- (void)schemaElement:(NSString*)schemaId :(NSString*)elementId :(NSString*)dataType :(int)minLength :(int)maxLength :(NSString*)codeId :(NSString*)description;

Remarks

Creates a schema definition for a simple element.

This method can be used when defining a schema instead of loading one from a file.

SchemaElementRef Method (X12Reader Module)

Adds a reference to an element in a segment or composite element.

Syntax

• Swift
• Objective-C

public func schemaElementRef(schemaId: String, parentId: String, elementId: String, refId: String, required: Bool, maxCount: Int32) throws -> Void

- (void)schemaElementRef:(NSString*)schemaId :(NSString*)parentId :(NSString*)elementId :(NSString*)refId :(BOOL)required :(int)maxCount;

Remarks

Adds a reference to an element to the specified parent, which can be the most recently defined segment or composite element.

This method can be used when defining a schema instead of loading one from a file.

SchemaEnd Method (X12Reader Module)

Ends a schema definition.

Syntax

• Swift
• Objective-C

public func schemaEnd() throws -> Void

- (void)schemaEnd;

Remarks

Ends a schema definition when a schema is being defined manually instead of loaded from a file.

SchemaGroup Method (X12Reader Module)

Defines a group of segments.

Syntax

• Swift
• Objective-C

public func schemaGroup(schemaId: String, groupPath: String, groupId: String, required: Bool, maxCount: Int32) throws -> Void

- (void)schemaGroup:(NSString*)schemaId :(NSString*)groupPath :(NSString*)groupId :(BOOL)required :(int)maxCount;

Remarks

Creates a schema definition for a group of segments. SchemaSegmentRef can be used to add references to defined segments.

This method can be used when defining a schema instead of loading one from a file.

SchemaMessage Method (X12Reader Module)

Defines a message.

Syntax

• Swift
• Objective-C

public func schemaMessage(schemaId: String, messageId: String, description_: String) throws -> Void

- (void)schemaMessage:(NSString*)schemaId :(NSString*)messageId :(NSString*)description;

Remarks

Creates a schema definition for a message. SchemaSegmentRef and SchemaGroup can be used to add segment references and groups to the message.

This method can be used when defining a schema instead of loading one from a file.

SchemaSegment Method (X12Reader Module)

Defines a segment.

Syntax

• Swift
• Objective-C

public func schemaSegment(schemaId: String, segmentId: String, description_: String) throws -> Void

- (void)schemaSegment:(NSString*)schemaId :(NSString*)segmentId :(NSString*)description;

Remarks

Creates a schema definition for a segment. SchemaElementRef can be used to add component references to the segment.

This method can be used when defining a schema instead of loading one from a file.

SchemaSegmentRef Method (X12Reader Module)

Adds a reference to a segment in a message or group.

Syntax

• Swift
• Objective-C

public func schemaSegmentRef(schemaId: String, segmentPath: String, segmentId: String, required: Bool, maxCount: Int32) throws -> Void

- (void)schemaSegmentRef:(NSString*)schemaId :(NSString*)segmentPath :(NSString*)segmentId :(BOOL)required :(int)maxCount;

Remarks

Adds a reference to a segment to the specified path.

This method can be used when defining a schema instead of loading one from a file.

SchemaStart Method (X12Reader Module)

Starts a schema definition.

Syntax

• Swift
• Objective-C

public func schemaStart(schemaId: String) throws -> Void

- (void)schemaStart:(NSString*)schemaId;

Remarks

Starts manually defining a schema, as an alternative to loading one from a file.

Validate Method (X12Reader Module)

Validate the EDI document and warn about any errors encountered.

Syntax

• Swift
• Objective-C

public func validate() throws -> Void

- (void)validate;

Remarks

This method parses the input EDI document, firing the ValidateWarning event for any non-blocking errors it encounters.

EndFunctionalGroup Event (X12Reader Module)

Fires at the end of a functional group while parsing.

Syntax

• Swift
• Objective-C

func onEndFunctionalGroup(tag: String, transactionCount: Int32, controlNumber: String)

- (void)onEndFunctionalGroup:(NSString*)tag :(int)transactionCount :(NSString*)controlNumber;

Remarks

This event fires when the class encounters the end of a functional group while parsing a document.

EndInterchange Event (X12Reader Module)

Fires at the end of a interchange while parsing.

Syntax

• Swift
• Objective-C

func onEndInterchange(tag: String, groupCount: Int32, controlNumber: String)

- (void)onEndInterchange:(NSString*)tag :(int)groupCount :(NSString*)controlNumber;

Remarks

This event fires when the class encounters the end of a interchange while parsing a document.

EndLoop Event (X12Reader Module)

Fires at the end of a loop while parsing.

Syntax

• Swift
• Objective-C

func onEndLoop(name: String, index: Int32)

- (void)onEndLoop:(NSString*)name :(int)index;

Remarks

This event fires when the class encounters the end of a loop while parsing a document.

EndTransactionSet Event (X12Reader Module)

Fires at the end of a transaction set while parsing.

Syntax

• Swift
• Objective-C

func onEndTransactionSet(tag: String, segmentCount: Int32, controlNumber: String)

- (void)onEndTransactionSet:(NSString*)tag :(int)segmentCount :(NSString*)controlNumber;

Remarks

This event fires when the class encounters the end of a transaction set while parsing a document.

Error Event (X12Reader Module)

Fires when a parsing error occurs.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

This event fires when the class encounters a parsing error while processing a document.

ResolveSchema Event (X12Reader Module)

Fires to request schema information for a specific transaction set.

Syntax

• Swift
• Objective-C

func onResolveSchema(versionNumber: String, transactionSetIDCode: String)

- (void)onResolveSchema:(NSString*)versionNumber :(NSString*)transactionSetIDCode;

Remarks

LoadSchema can be called from within this event to load the schema information for the specified transaction set.

Segment Event (X12Reader Module)

Fires at the end of a Segment while parsing.

Syntax

• Swift
• Objective-C

func onSegment(tag: String, schemaPath: String, optional: Bool, elementCount: Int32, schemaIndex: Int32, segmentIndex: Int32, maxCount: Int32, path: String)

- (void)onSegment:(NSString*)tag :(NSString*)schemaPath :(BOOL)optional :(int)elementCount :(int)schemaIndex :(int)segmentIndex :(int)maxCount :(NSString*)path;

Remarks

Fires at the end of a Segment while parsing a document with the Parse method. The parameters provide information about the segment that was just parsed: Tag: The segment tag (e.g., "ISA", "GS", "ST", etc.).

SchemaPath: The schema path for the segment, if schema information is available.

Optional: A boolean indicating whether the segment is optional (true) or required (false) according to the schema.

ElementCount: The number of elements in the segment.

SchemaIndex: The index of the segment in the schema, if schema information is available.

SegmentIndex: The index of the segment within the current transaction set.

MaxCount: The maximum number of times this segment can occur in the current context, according to the schema.

Path: The full path to the segment within the message structure.

StartFunctionalGroup Event (X12Reader Module)

Fires at the beginning of a functional group while parsing.

Syntax

• Swift
• Objective-C

func onStartFunctionalGroup(tag: String, appSenderCode: String, appReceiverCode: String, dateTime: String, controlNumber: String)

- (void)onStartFunctionalGroup:(NSString*)tag :(NSString*)appSenderCode :(NSString*)appReceiverCode :(NSString*)dateTime :(NSString*)controlNumber;

Remarks

This event fires when the class encounters the start of a functional group while parsing a document.

StartInterchange Event (X12Reader Module)

Fires at the beginning of an interchange while parsing.

Syntax

• Swift
• Objective-C

func onStartInterchange(tag: String, senderID: String, receiverID: String, dateTime: String, controlNumber: String)

- (void)onStartInterchange:(NSString*)tag :(NSString*)senderID :(NSString*)receiverID :(NSString*)dateTime :(NSString*)controlNumber;

Remarks

This event fires at the beginning of an interchange while parsing a document.

StartLoop Event (X12Reader Module)

Fires at the beginning of a loop while parsing a transaction set.

Syntax

• Swift
• Objective-C

func onStartLoop(name: String, index: Int32, maxCount: Int32, path: String)

- (void)onStartLoop:(NSString*)name :(int)index :(int)maxCount :(NSString*)path;

Remarks

This event fires when the class encounters the start of a loop while parsing a transaction set.

StartTransactionSet Event (X12Reader Module)

Fires at the beginning of a transaction set while parsing.

Syntax

• Swift
• Objective-C

func onStartTransactionSet(tag: String, versionNumber: String, transactionSetIDCode: String, controlNumber: String, schemaLoaded: Bool)

- (void)onStartTransactionSet:(NSString*)tag :(NSString*)versionNumber :(NSString*)transactionSetIDCode :(NSString*)controlNumber :(BOOL)schemaLoaded;

Remarks

This event fires when the class encounters the start of a transaction set while parsing a document.

ValidateWarning Event (X12Reader Module)

Fires to warn about validation errors.

Syntax

• Swift
• Objective-C

func onValidateWarning(position: Int64, line: Int32, column: Int32, errorCode: String, errorMessage: String, errorType: Int32)

- (void)onValidateWarning:(long long)position :(int)line :(int)column :(NSString*)errorCode :(NSString*)errorMessage :(int)errorType;

Remarks

When the class encounters a non-blocking error while validating a document, this event fires with information about the error.

EDIElement Type

An element of an EDI document.

Remarks

This represents an element appearing in an EDI document.

• DataType
• IsComposite
• MaxLen
• MinLen
• SchemaDesc
• SchemaName
• Value

Fields

Constructors

public init()

EDISegment Type

A segment of an EDI document.

Remarks

This represents a segment appearing in an EDI document.

• Optional
• Path
• SchemaPath
• Tag

Fields

Constructors

public init()

X12Delimiters Type

The delimiters used in the X12 document.

Remarks

This type contains fields specifying the various delimiters used within the X12 document.

• Component
• Element
• Repetition
• Segment

Fields

Constructors

public init()

X12FunctionalGroup Type

A functional group of messages.

Remarks

This type represents a functional group of messages, with fields describing the values from the GS segment.

• AppReceiverCode
• AppSenderCode
• Date
• FunctionalIdentifierCode
• GroupControlNum
• ResponsibleAgencyCode
• Time
• Version

Fields

Constructors

public init()

X12Interchange Type

An interchange containing functional groups and transaction sets.

Remarks

This type represents an X12 interchange, with fields describing the values from the ISA segment.

• AckRequest
• AuthorizationInfo
• AuthorizationInfoQualifier
• Date
• InterchangeControlNum
• InterchangeControlVersionNum
• ReceiverID
• ReceiverIDQualifier
• SecurityInfo
• SecurityInfoQualifier
• SenderID
• SenderIDQualifier
• Time
• UsageIndicator

Fields

Constructors

public init()

X12TransactionSet Type

An X12 transaction set.

Remarks

This type represents an X12 transaction set, with fields describing the values from the ST segment.

• ImpConventionReference
• TransactionSetControlNum
• TransactionSetIDCode

Fields

Constructors

public init()

X12ValidationErrorDetail Type

Contains the details of a validation error.

Remarks

This represents an error that was encountered while validating an X12 document. The fields contain a description of the error and where in the document it occurred.

• Column
• ComponentIndex
• ElementIndex
• ErrorCode
• ErrorMessage
• ErrorType
• FGroupIndex
• InterchangeIndex
• Line
• Position
• SegmentIndex
• SegmentTag
• TransactionSetIndex

Fields

Config Settings (X12Reader Module)

X12Reader Config Settings

Trappable Errors (X12Reader Module)

X12Reader Errors