EDIFACTValidator Module

Properties   Methods   Events   Config Settings   Errors  

The EDIFACTValidator module validates EDIFACT documents against the specified standard, ensuring compliance and correctness.

Syntax

EDISDK.EDIFACTValidator

Remarks

This component provides a simple way to validate an EDI document and obtain details about any validation errors.

Before calling Validate call LoadSchema to load the schema for the document to be validated. The schema defines many validation rules such as minimum and maximum lengths, minimum and maximum occurrences, and more. The validation performed by the class depends largely on the schema's definition.

When the Validate method is called the class will attempt to validate the document. If errors are found during validation the ValidationErrors property will be populated with details of each error.

Inspect the ValidationErrors property for information on any errors that were encountered.

Validation Example validator.InputFile = @"C:\EDIFACT_Files\INVOIC_InvalidRepeat.edi"; validator.LoadSchema(@"C:\EDIFACT_Schemas\D97A.xml", "INVOIC"); validator.Validate(); foreach (EDIFACTValidationErrorDetail error in validator.ValidationErrors) { Console.WriteLine(error.ErrorCode + ": " + error.ErrorMessage); }

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.

Delimiters Property (EDIFACTValidator Module)

Contains the delimiters for the EDI Document.

Syntax

• Swift
• Objective-C

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

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

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

@property (nonatomic,readwrite,assign,getter=delimiterDecimal,setter=setDelimiterDecimal:) NSString* delimiterDecimal;

- (NSString*)delimiterDecimal;
- (void)setDelimiterDecimal :(NSString*)newDelimiterDecimal;

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

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

@property (nonatomic,readwrite,assign,getter=delimiterRelease,setter=setDelimiterRelease:) NSString* delimiterRelease;

- (NSString*)delimiterRelease;
- (void)setDelimiterRelease :(NSString*)newDelimiterRelease;

@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

""

Remarks

This property contains the delimiters that will be used when parsing the EDIFACT 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.

InputData Property (EDIFACTValidator 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 (EDIFACTValidator 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 a file to read the input EDI message from. The message can then be parsed with Parse.

ValidationErrors Property (EDIFACTValidator Module)

Collection of validation errors for the current document.

Syntax

• Swift
• Objective-C

public var validationErrors: Array<EDIFACTValidationErrorDetail> {
  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;

- (int)validationErrorMessageIndex:(int)validationErrorIndex;

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

- (int)validationErrorSegmentIndex:(int)validationErrorIndex;

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

Default Value

""

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 (EDIFACTValidator 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.

LoadSchema Method (EDIFACTValidator 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.

Reset Method (EDIFACTValidator Module)

Resets all properties to their default values.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method resets all properties of the component to their default values as specified in the property definitions.

Validate Method (EDIFACTValidator 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.

Error Event (EDIFACTValidator Module)

Fires when an error occurs during message processing. Normally, the component fails with an error.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

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

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the class .

ConnectionId is the associated client Id, ErrorCode contains an error code, and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ResolveSchema Event (EDIFACTValidator Module)

Fires whenever a new EDIFACT message is encountered and no schema is found for it.

Syntax

• Swift
• Objective-C

func onResolveSchema(messageVersion: String, messageType: String)

- (void)onResolveSchema:(NSString*)messageVersion :(NSString*)messageType;

Remarks

This method fires when the class encounters an EDIFACT message it has not loaded a schema for. The parameters of the event can be used to locate the correct schema and load it with LoadSchema.

MessageVersion - The EDIFACT version of the message, such as D97A.

MessageType - The type of message, such as INVOIC.

After the event fires, if the class still doesn't have a matching schema, then it will attempt schema-less parsing of the EDIFACT message.

ValidateWarning Event (EDIFACTValidator 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.

EDIFACTDelimiters Type

The delimiters used in the EDIFACT document.

Remarks

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

• Component
• Decimal
• Element
• Release
• Repetition
• Segment

Fields

Constructors

public init()

EDIFACTValidationErrorDetail Type

Contains the details of a validation error.

Remarks

This represents an error that was encountered while validating an EDIFACT 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
• MessageIndex
• Position
• SegmentIndex
• SegmentTag

Fields

Config Settings (EDIFACTValidator Module)

EDIFACTValidator Config Settings

Trappable Errors (EDIFACTValidator Module)

EDIFACTValidator Errors