EDIFACTValidator Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TedEDIFACTValidator

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 component depends largely on the schema's definition.

When the Validate method is called the component 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

DelimiterComponent Property (EDIFACTValidator Component)

The character used to separate the components in a composite element.

Syntax

__property String DelimiterComponent = { read=FDelimiterComponent, write=FSetDelimiterComponent };

Default Value

":"

Remarks

The character used to separate the components in a composite element.

This property is not available at design time.

Data Type

String

DelimiterDecimal Property (EDIFACTValidator Component)

The character used to separate the integer portion of a numeric value from the fractional portion.

Syntax

__property String DelimiterDecimal = { read=FDelimiterDecimal, write=FSetDelimiterDecimal };

Default Value

"."

Remarks

The character used to separate the integer portion of a numeric value from the fractional portion.

This property is not available at design time.

Data Type

String

DelimiterElement Property (EDIFACTValidator Component)

The delimiter used to separate elements within a segment.

Syntax

__property String DelimiterElement = { read=FDelimiterElement, write=FSetDelimiterElement };

Default Value

"+"

Remarks

The delimiter used to separate elements within a segment.

This property is not available at design time.

Data Type

String

DelimiterRelease Property (EDIFACTValidator Component)

The character used to escape other characters within a property.

Syntax

__property String DelimiterRelease = { read=FDelimiterRelease, write=FSetDelimiterRelease };

Default Value

"?"

Remarks

The character used to escape other characters within a field. For example, with the default EDIFACT delimiters, "?+" should be considered "+" character that appears within a field, not an element separator.

This property is not available at design time.

Data Type

String

DelimiterRepetition Property (EDIFACTValidator Component)

The character used to indicate a repeating element or component.

Syntax

__property String DelimiterRepetition = { read=FDelimiterRepetition, write=FSetDelimiterRepetition };

Default Value

"*(syntax 4) or empty(syntax 3)"

Remarks

The character used to indicate a repeating element or component.

This property is not available at design time.

Data Type

String

DelimiterSegment Property (EDIFACTValidator Component)

The character used to terminate a segment.

Syntax

__property String DelimiterSegment = { read=FDelimiterSegment, write=FSetDelimiterSegment };

Default Value

"'"

Remarks

The character used to terminate a segment.

This property is not available at design time.

Data Type

String

InputData Property (EDIFACTValidator Component)

The EDI message, specified as a string.

Syntax

__property String InputData = { read=FInputData, write=FSetInputData };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

InputFile Property (EDIFACTValidator Component)

The file containing the EDI message.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

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.

This property is not available at design time.

Data Type

String

ValidationErrorCount Property (EDIFACTValidator Component)

The number of records in the ValidationError arrays.

Syntax

__property int ValidationErrorCount = { read=FValidationErrorCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ValidationErrorColumn
• ValidationErrorComponentIndex
• ValidationErrorElementIndex
• ValidationErrorErrorCode
• ValidationErrorErrorMessage
• ValidationErrorErrorType
• ValidationErrorFGroupIndex
• ValidationErrorInterchangeIndex
• ValidationErrorLine
• ValidationErrorMessageIndex
• ValidationErrorPosition
• ValidationErrorSegmentIndex
• ValidationErrorSegmentTag

The array indices start at 0 and end at ValidationErrorCount - 1.

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

Data Type

Integer

ValidationErrorColumn Property (EDIFACTValidator Component)

The column number where the error occurred.

Syntax

__property int ValidationErrorColumn[int ValidationErrorIndex] = { read=FValidationErrorColumn };

Default Value

0

Remarks

The column number where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorComponentIndex Property (EDIFACTValidator Component)

This property holds the position of the element where the error occurred.

Syntax

__property int ValidationErrorComponentIndex[int ValidationErrorIndex] = { read=FValidationErrorComponentIndex };

Default Value

1

Remarks

This property holds the position of the element where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorElementIndex Property (EDIFACTValidator Component)

This property holds the position of the element where the error occurred.

Syntax

__property int ValidationErrorElementIndex[int ValidationErrorIndex] = { read=FValidationErrorElementIndex };

Default Value

1

Remarks

This property holds the position of the element where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorErrorCode Property (EDIFACTValidator Component)

The ErrorCode property contains the type of error encountered.

Syntax

__property String ValidationErrorErrorCode[int ValidationErrorIndex] = { read=FValidationErrorErrorCode };

Default Value

"0"

Remarks

The ValidationErrorErrorCode property contains the type of error encountered.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

String

ValidationErrorErrorMessage Property (EDIFACTValidator Component)

ErrorMessage is a textual description of the error.

Syntax

__property String ValidationErrorErrorMessage[int ValidationErrorIndex] = { read=FValidationErrorErrorMessage };

Default Value

""

Remarks

ValidationErrorErrorMessage is a textual description of the error.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

String

ValidationErrorErrorType Property (EDIFACTValidator Component)

Indicates the level of the document where the error was encountered.

Syntax

__property int ValidationErrorErrorType[int ValidationErrorIndex] = { read=FValidationErrorErrorType };

Default Value

0

Remarks

Indicates the level of the document where the error was encountered. Possible values include:

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorFGroupIndex Property (EDIFACTValidator Component)

This property holds the position of the functional group where the error occurred.

Syntax

__property int ValidationErrorFGroupIndex[int ValidationErrorIndex] = { read=FValidationErrorFGroupIndex };

Default Value

1

Remarks

This property holds the position of the functional group where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorInterchangeIndex Property (EDIFACTValidator Component)

This property holds the position of the interchange where the error occurred.

Syntax

__property int ValidationErrorInterchangeIndex[int ValidationErrorIndex] = { read=FValidationErrorInterchangeIndex };

Default Value

1

Remarks

This property holds the position of the interchange where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorLine Property (EDIFACTValidator Component)

The line number where the error occurred.

Syntax

__property int ValidationErrorLine[int ValidationErrorIndex] = { read=FValidationErrorLine };

Default Value

0

Remarks

The line number where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorMessageIndex Property (EDIFACTValidator Component)

This property holds the position of the message where the error occurred.

Syntax

__property int ValidationErrorMessageIndex[int ValidationErrorIndex] = { read=FValidationErrorMessageIndex };

Default Value

1

Remarks

This property holds the position of the message where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorPosition Property (EDIFACTValidator Component)

This property holds the byte position in the EDI stream where the error occurred.

Syntax

__property __int64 ValidationErrorPosition[int ValidationErrorIndex] = { read=FValidationErrorPosition };

Default Value

0

Remarks

This property holds the byte position in the EDI stream where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Long64

ValidationErrorSegmentIndex Property (EDIFACTValidator Component)

This property is the index of the segment where the error occurred.

Syntax

__property int ValidationErrorSegmentIndex[int ValidationErrorIndex] = { read=FValidationErrorSegmentIndex };

Default Value

1

Remarks

This property is the index of the segment where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

Integer

ValidationErrorSegmentTag Property (EDIFACTValidator Component)

This property specifies the tag name of the segment where the error occurred.

Syntax

__property String ValidationErrorSegmentTag[int ValidationErrorIndex] = { read=FValidationErrorSegmentTag };

Default Value

""

Remarks

This property specifies the tag name of the segment where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

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

Data Type

String

Config Method (EDIFACTValidator Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Loads schema information from a file or string data.

Syntax

void __fastcall LoadSchema(String fileOrData, String 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 Component)

Resets all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

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

Validate Method (EDIFACTValidator Component)

Validate the EDI document and warn about any errors encountered.

Syntax

void __fastcall Validate();

Remarks

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

Error Event (EDIFACTValidator Component)

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

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TedEDIFACTValidatorErrorEventParams;
typedef void __fastcall (__closure *TedEDIFACTValidatorErrorEvent)(System::TObject* Sender, TedEDIFACTValidatorErrorEventParams *e);
__property TedEDIFACTValidatorErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the component raises an exception.

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 Component)

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

Syntax

typedef struct {
  String MessageVersion;
  String MessageType;
} TedEDIFACTValidatorResolveSchemaEventParams;
typedef void __fastcall (__closure *TedEDIFACTValidatorResolveSchemaEvent)(System::TObject* Sender, TedEDIFACTValidatorResolveSchemaEventParams *e);
__property TedEDIFACTValidatorResolveSchemaEvent OnResolveSchema = { read=FOnResolveSchema, write=FOnResolveSchema };

Remarks

This method fires when the component 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 component still doesn't have a matching schema, then it will attempt schema-less parsing of the EDIFACT message.

ValidateWarning Event (EDIFACTValidator Component)

Fires to warn about validation errors.

Syntax

typedef struct {
  __int64 Position;
  int Line;
  int Column;
  String ErrorCode;
  String ErrorMessage;
  int ErrorType;
} TedEDIFACTValidatorValidateWarningEventParams;
typedef void __fastcall (__closure *TedEDIFACTValidatorValidateWarningEvent)(System::TObject* Sender, TedEDIFACTValidatorValidateWarningEventParams *e);
__property TedEDIFACTValidatorValidateWarningEvent OnValidateWarning = { read=FOnValidateWarning, write=FOnValidateWarning };

Remarks

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

Config Settings (EDIFACTValidator Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

EDIFACTValidator Config Settings

Trappable Errors (EDIFACTValidator Component)

EDIFACTValidator Errors