EDIFACTValidator Component
Properties Methods Events Configuration Settings Errors
EDIFACTValidator is a lightweight EDI validation component designed for simple document validation.
Syntax
nsoftware.IPWorksEDI.Edifactvalidator
Remarks
This component provides a simple way to validate an EDI document and obtain details about any validation errors.
EDI Validation
Before calling Validate set SchemaFormat and 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 ValidationError event will fire with details about each error as it is encountered. After the document has been validated 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 = "files/EDIDocuments/MyEDIDoc.txt";
validator.LoadSchema("my_schemas/00501/RSSBus_005010X222A1_837.json");
validator.Validate();
foreach (ValidationErrorDetail error in validator.ValidationErrors) {
Console.WriteLine(error.ErrorCode + ": " + error.Message);
}
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
EDIStandardVersion | The version of the EDI specification. |
InputData | The data to parse. |
InputFile | The file to parse. |
SchemaFormat | The format of the schema file. |
ValidationErrors | Collection of validation errors for the current document. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
CompileSchema | Compiles an existing XSD schema into an optimized binary representation. |
Config | Sets or retrieves a configuration setting. |
DisplaySchemaInfo | Returns a string showing the structure of the schema defining the document. |
DisplayXMLInfo | Returns a string showing the structure of the parsed document as XML. |
Flush | Flushes the parser and checks its end state. |
LoadSchema | Loads a schema file describing a Transaction Set. |
LoadSchemaStream | Loads a schema stream describing a Transaction Set. |
Reset | Resets the parser. |
SetInputStream | Sets the stream from which the component will read the data to parse. |
Validate | Validates the specified EDI document. |
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.
EndFunctionalGroup | Fires whenever a control segment is read that marks the end of an interchange. |
EndInterchange | Fires whenever a control segment is read that marks the end of an interchange. |
EndLoop | Fires when the end of a loop is detected in a transaction set. |
EndTransaction | Fires whenever a control segment is read that marks the end of a transaction. |
Error | Information about errors during data delivery. |
ResolveSchema | Fires whenever a new transaction set is encountered and no schema is found for it. |
Segment | Fires whenever a data segment in a transaction set is read. |
StartFunctionalGroup | Fires whenever a control segment is read that marks the start of a functional group. |
StartInterchange | Fires whenever a control segment is read that marks the start of an interchange. |
StartLoop | Fires when the starting of a loop is detected in a transaction set. |
StartTransaction | Fires whenever a control segment is read that marks the start of a transaction. |
ValidationError | Fires whenever a validation error is encountered. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
CacheJSONSchemas | Whether to cache JSON schemas. |
ClearSchemaCache | Clears the cached JSON schemas. |
ComponentDelimiter | The delimiter separating components. |
CrossFieldValidationEnabled | Enables cross-field validation rules. |
ElementDelimiter | The delimiter character separating data elements. |
Encoding | The character encoding to be applied when reading and writing data. |
ExtraData | Extra data that has not been parsed by the component. |
HasXPath | Determines if the specified XPath exists. |
ISA11IsRepetitionSeparator | Specifies whether the ISA11 value is treated as a Repetition Separator or Standard Identifier. |
MaxValidationErrors | The maximum number of errors to save in the ValidationErrors property. |
ReleaseChar | The character used to escape delimiters within values. |
ResolveXPathOnSet | Determines whether or not the XPath is resolved when set. |
SegmentDelimiter | The delimiter character separating segments within the EDI document. |
StrictSchemaValidation | Specifies the behavior during schema validation. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |