HL7Validator Component

Properties   Methods   Events   Config Settings   Errors  

HL7Validator is a lightweight EDI validation component designed for simple document validation.

Syntax

TibeHL7Validator

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.

EDIStandardVersionThe version of the EDI specification.
InputDataThe data to parse.
InputFileThe file to parse.
SchemaFormatThe format of the schema file.
ValidationErrorCountThe number of records in the ValidationError arrays.
ValidationErrorColumnThe column number in the EDI document where the error occurred.
ValidationErrorElementErrorCodeThe error code which may be used in the IK403 property of a 999.
ValidationErrorElementPositionThis property holds the position of the element where the error occurred.
ValidationErrorErrorCodeThe ErrorCode property contains the type of error encountered.
ValidationErrorLineThe line number in the EDI document where the error occurred.
ValidationErrorMessageMessage is a textual description of the error.
ValidationErrorSegmentErrorCodeThe error code which may be used in the IK304 property of a 999.
ValidationErrorSegmentNumberThis property is the index of the segment where the error occurred.
ValidationErrorSegmentTagThis property specifies the tag name of the segment where the error occurred.
ValidationErrorTechnicalErrorCodeThis property holds a technical error code that helps identify structural issues with the 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.

CompileSchemaCompiles an existing XSD schema into an optimized binary representation.
ConfigSets or retrieves a configuration setting.
DisplaySchemaInfoReturns a string showing the structure of the schema defining the document.
DisplayXMLInfoReturns a string showing the structure of the parsed document as XML.
FlushFlushes the parser and checks its end state.
LoadSchemaLoads a schema file describing a Transaction Set.
ResetResets the parser.
ValidateValidates 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.

EndFunctionalGroupFires whenever a control segment is read that marks the end of an interchange.
EndInterchangeFires whenever a control segment is read that marks the end of an interchange.
EndLoopFires when the end of a loop is detected in a transaction set.
EndTransactionFires whenever a control segment is read that marks the end of a transaction.
ErrorFired when information is available about errors during data delivery.
ResolveSchemaFires whenever a new transaction set is encountered and no schema is found for it.
SegmentFires whenever a data segment in a transaction set is read.
StartFunctionalGroupFires whenever a control segment is read that marks the start of a functional group.
StartInterchangeFires whenever a control segment is read that marks the start of an interchange.
StartLoopFires when the starting of a loop is detected in a transaction set.
StartTransactionFires whenever a control segment is read that marks the start of a transaction.
ValidationErrorFires whenever a validation error is encountered.

Config Settings


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

ComponentDelimiterThe delimiter separating components.
CrossFieldValidationEnabledEnables cross-field validation rules.
ElementDelimiterThe delimiter character separating data elements.
EncodingThe character encoding to be applied when reading and writing data.
ExtraDataExtra data that has not been parsed by the component.
HasXPathDetermines if the specified XPath exists.
ISA11IsRepetitionSeparatorSpecifies whether the ISA11 value is treated as a Repetition Separator or Standard Identifier.
MaxValidationErrorsThe maximum number of errors to save in the ValidationErrors property.
ReleaseCharThe character used to escape delimiters within values.
ResolveXPathOnSetDetermines whether or not the XPath is resolved when set.
SegmentDelimiterThe delimiter character separating segments within the EDI document.
StrictSchemaValidationSpecifies the behavior during schema validation.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseFIPSCompliantAPITells the component whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

EDIStandardVersion Property (HL7Validator Component)

The version of the EDI specification.

Syntax

__property String EDIStandardVersion = { read=FEDIStandardVersion };

Default Value

""

Remarks

This property will be populated after parsing begins and the correct version string for is located via the schema, such as 004010 for X12.

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

Data Type

String

InputData Property (HL7Validator Component)

The data to parse.

Syntax

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

Default Value

""

Remarks

This property specifies the data to be parsed.

Input Properties

The component will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops.

Data Type

String

InputFile Property (HL7Validator Component)

The file to parse.

Syntax

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

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input Properties

The component will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops.

This property is not available at design time.

Data Type

String

SchemaFormat Property (HL7Validator Component)

The format of the schema file.

Syntax

__property TibeHL7ValidatorSchemaFormats SchemaFormat = { read=FSchemaFormat, write=FSetSchemaFormat };
enum TibeHL7ValidatorSchemaFormats { schemaAutomatic=0, schemaBinary=1, schemaBizTalk=2, schemaSEF=3, schemaBOTS=4, schemaAltova=5, schemaJSON=6 };

Default Value

schemaAutomatic

Remarks

Set SchemaFormat before calling the LoadSchema method to specify the loading schema format.

The following schema formats are supported:

0 (schemaAutomatic - default) The schema type is automatically determined based on file extension.
1 (schemaBinary) A binary schema that was previously compiled by calling CompileSchema.
2 (schemaBizTalk) BizTalk (XSD): http://msdn.microsoft.com/en-us/library/aa559426(v=BTS.70).aspx
3 (schemaSEF) TIBCO Standard Exchange Format (SEF): https://docs.tibco.com/products/tibco-foresight-edisim-6-18-0
5 (schemaAltova) Altova: http://www.altova.com/
6 (schemaJSON) JSON

Data Type

Integer

ValidationErrorCount Property (HL7Validator 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:

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

The column number in the EDI document where the error occurred.

Syntax

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

Default Value

0

Remarks

The column number in the EDI document where the error occurred. This value may be used in conjunction with the ValidationErrorLine property to determine the exact location within the EDI document 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

ValidationErrorElementErrorCode Property (HL7Validator Component)

The error code which may be used in the IK403 property of a 999.

Syntax

__property String ValidationErrorElementErrorCode[int ValidationErrorIndex] = { read=FValidationErrorElementErrorCode };

Default Value

""

Remarks

The error code which may be used in the IK403 field of a 999.

Note: This property is specific to X12 documents and is not applicable to other document types.

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

ValidationErrorElementPosition Property (HL7Validator Component)

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

Syntax

__property int ValidationErrorElementPosition[int ValidationErrorIndex] = { read=FValidationErrorElementPosition };

Default Value

0

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

The ErrorCode property contains the type of error encountered.

Syntax

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

Default Value

0

Remarks

The ValidationErrorErrorCode property contains the type of error encountered. Possible values are:

0 The component is not required but is present.
1 Invalid segment count.
2 Invalid transaction count.
3 Invalid group count.
4 Invalid interchange control number.
5 Invalid group control number.
6 Invalid transaction control number.
10 A required data element is missing.
11 Invalid field length.
12 Invalid field value.
13 A required component is missing.
14 The data element is not defined but is present.
30 Required segment is missing.
31 Required loop is missing.
32 Occurrences exceeds the schema defined limit.
33 Occurrences is less than the schema defined minimum.
40 Paired rule validation failed, the pair of elements must be present.
41 At least one of element is required, see message for list of elements.
42 Exclusion validation failed, only one of the elements can be present.
43 Conditional rule validation failed.
44 List conditional rule validation failed.
45 First then none validation failed. The presence of an element requires that other specific elements must not be present.
46 Only one or none of the elements can be present.

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

The line number in the EDI document where the error occurred.

Syntax

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

Default Value

0

Remarks

The line number in the EDI document where the error occurred. This value may be used in conjunction with the ValidationErrorColumn property to determine the exact location within the EDI document 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

ValidationErrorMessage Property (HL7Validator Component)

Message is a textual description of the error.

Syntax

__property String ValidationErrorMessage[int ValidationErrorIndex] = { read=FValidationErrorMessage };

Default Value

""

Remarks

ValidationErrorMessage 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

ValidationErrorSegmentErrorCode Property (HL7Validator Component)

The error code which may be used in the IK304 property of a 999.

Syntax

__property String ValidationErrorSegmentErrorCode[int ValidationErrorIndex] = { read=FValidationErrorSegmentErrorCode };

Default Value

""

Remarks

The error code which may be used in the IK304 field of a 999.

Note: This property is specific to X12 documents and is not applicable to other document types.

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

ValidationErrorSegmentNumber Property (HL7Validator Component)

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

Syntax

__property int ValidationErrorSegmentNumber[int ValidationErrorIndex] = { read=FValidationErrorSegmentNumber };

Default Value

0

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 (HL7Validator 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

ValidationErrorTechnicalErrorCode Property (HL7Validator Component)

This property holds a technical error code that helps identify structural issues with the document.

Syntax

__property String ValidationErrorTechnicalErrorCode[int ValidationErrorIndex] = { read=FValidationErrorTechnicalErrorCode };

Default Value

""

Remarks

This property holds a technical error code that helps identify structural issues with the document. For instance when parsing an X12 document this will hold values that may be used for TA1 error codes.

Note: This property is specific to X12 documents and is not applicable to other document types.

Possible values are:

001The Interchange Control Numbers in the header ISA 13 and trailer IEA02 do not match.
014Invalid interchange date value (non-numeric characters or wrong length).
015Invalid interchange time value (non-numeric characters or wrong length).
022The ISA segment is missing elements (invalid control structure).
024Invalid interchange content (e.g., Invalid GS segment).

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

CompileSchema Method (HL7Validator Component)

Compiles an existing XSD schema into an optimized binary representation.

Syntax

void __fastcall CompileSchema(String XsdSchema, String BinSchema);

Remarks

This method parses XsdSchema and generates an optimized binary representation that is saved into the path referenced by BinSchema. Binary schemas are smaller and require less resources when loading later using LoadSchema

If the schema file does not exists or cannot be parsed as an EDI schema, the component throws an exception.

Config Method (HL7Validator 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.

DisplaySchemaInfo Method (HL7Validator Component)

Returns a string showing the structure of the schema defining the document.

Syntax

String __fastcall DisplaySchemaInfo();

Remarks

After calling LoadSchema this may be called to obtain information about the structure of the schema defining the document. If the desired XPath is not known this helps determine the structure so that the correct XPath can be built.

Note: A valid schema must be loaded via LoadSchema.

For instance: Console.WriteLine(component.DisplaySchemaInfo()); Will output text like:

  ST[0,1]
  BIG[0,1]
  NTE[0,100]
  CUR[0,1]
  REF[0,12]
  YNQ[0,10]
  PER[0,3]
  N1Loop1[0,200]
    N1[0,1]
    N2[0,2]
    N3[0,2]
    N4[0,1]
    REF_2[0,12]
    PER_2[0,3]
    DMG[0,1]
  ITD[0,999999]
  DTM[0,10]
  FOB[0,1]
  PID[0,200]
  MEA[0,40]
  PWK[0,25]
  PKG[0,25]
  L7[0,1]
  BAL[0,999999]
  INC[0,1]
  PAM[0,999999]
  LMLoop1[0,10]
    LM[0,1]
    LQ[0,100]
  N9Loop1[0,1]
    N9[0,1]
    MSG[0,10]
  V1Loop1[0,999999]
    V1[0,1]
    R4[0,999999]
    DTM_2[0,999999]
  FA1Loop1[0,999999]
    FA1[0,1]
    FA2[0,999999]
  IT1Loop1[0,200000]
    IT1[0,1]
    CRC[0,1]
    QTY[0,5]
    CUR_2[0,1]
    IT3[0,5]
    TXI[0,10]
    CTP[0,25]
    PAM_2[0,10]
    MEA_2[0,40]
    PIDLoop1[0,1000]
      PID_2[0,1]
      MEA_3[0,10]
    PWK_2[0,25]
    PKG_2[0,25]
    PO4[0,1]
    ITD_2[0,2]
    REF_3[0,999999]
    YNQ_2[0,10]
    PER_3[0,5]
    SDQ[0,500]
    DTM_3[0,10]
    CAD[0,999999]
    L7_2[0,999999]
    SR[0,1]
    SACLoop1[0,25]
      SAC[0,1]
      TXI_2[0,10]
    SLNLoop1[0,1000]
      SLN[0,1]
      DTM_4[0,1]
      REF_4[0,999999]
      PID_3[0,1000]
      SAC_2[0,25]
      TC2[0,2]
      TXI_3[0,10]
    N1Loop2[0,200]
      N1_2[0,1]
      N2_2[0,2]
      N3_2[0,2]
      N4_2[0,1]
      REF_5[0,12]
      PER_4[0,3]
      DMG_2[0,1]
    LMLoop2[0,10]
      LM_2[0,1]
      LQ_2[0,100]
    V1Loop2[0,999999]
      V1_2[0,1]
      R4_2[0,999999]
      DTM_5[0,999999]
    FA1Loop2[0,999999]
      FA1_2[0,1]
      FA2_2[0,999999]
  TDS[0,1]
  TXI_4[0,10]
  CAD_2[0,1]
  AMT[0,999999]
  SACLoop2[0,25]
    SAC_3[0,1]
    TXI_5[0,10]
  ISSLoop1[0,999999]
    ISS[0,1]
    PID_4[0,1]
  CTT[0,1]
  SE[0,1]

DisplayXMLInfo Method (HL7Validator Component)

Returns a string showing the structure of the parsed document as XML.

Syntax

String __fastcall DisplayXMLInfo();

Remarks

After the EDI document has been parsed this method may be called to obtain information about the document structure. The parsed data is represented as XML when queried. This shows all parsed data and may be useful for testing and debugging purposes. For instance: Console.WriteLine(component.DisplayXMLInfo()); Will output text like:

<IX tag="ISA" ISA01="00" ISA02="          " ISA03="00" ISA04="          " ISA05="ZZ" ISA06="ACME           " ISA07="ZZ" ISA08="WAYNE_TECH     " ISA09="160707" ISA10="1544" ISA11="U" ISA12="00401" ISA13="000000006" ISA14="0" ISA15="T" ISA16=">">
  <FG tag="GS" GS01="IN" GS02="ACME" GS03="WAYNE_TECH" GS04="20160707" GS05="1544" GS06="6" GS07="T" GS08="004010">
    <TX tag="ST" ST01="810" ST02="0001">
      <BIG tag="BIG" BIG01="20150708" BIG02="3003014445" BIG03="" BIG04="0476553272" BIG05="" BIG06="" BIG07="DR"/>
      <CUR tag="CUR" CUR01="SE" CUR02="USD"/>
      <REF tag="REF" REF01="8M" REF02="0056"/>
      <N1Loop1>
        <N1 tag="N1" N101="BY" N102="Company" N103="92" N104="544380"/>
        <N3 tag="N3" N301="Address"/>
        <N4 tag="N4" N401="City" N402="CA" N403="Postal Code"/>
      </N1Loop1>
      <N1Loop1>
        <N1 tag="N1" N101="ST" N102="Name" N103="92" N104="0607047800010"/>
        <N3 tag="N3" N301="Address"/>
        <N4 tag="N4" N401="City" N402="" N403="200131" N404="US"/>
      </N1Loop1>
      <N1Loop1>
        <N1 tag="N1" N101="RE" N102="Name" N103="92" N104="5095956"/>
        <N3 tag="N3" N301="Address"/>
        <N4 tag="N4" N401="City" N402="IL" N403="Postal Code"/>
      </N1Loop1>
      <IT1Loop1>
        <IT1 tag="IT1" IT101="20" IT102="2500" IT103="EA" IT104="36.96" IT105="" IT106="BP" IT107="335S0594"/>
        <REF_3 tag="REF" REF01="KK" REF02="0099778154"/>
        <REF_3 tag="REF" REF01="PO" REF02="0476553272" REF03="20"/>
      </IT1Loop1>
      <TDS tag="TDS" TDS01="9240000"/>
      <CTT tag="CTT" CTT01="1"/>
    </TX>
  </FG>
</IX>

Flush Method (HL7Validator Component)

Flushes the parser and checks its end state.

Syntax

void __fastcall Flush();

Remarks

When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state.

Any extra un-parsed data will be populated in the ExtraData property after this method is called.

LoadSchema Method (HL7Validator Component)

Loads a schema file describing a Transaction Set.

Syntax

void __fastcall LoadSchema(String FileName);

Remarks

This method parses the File and loads it into an internal schema list. The component will attempt to automatically detect the SchemaFormat.

If the schema file does not exist or cannot be parsed as an EDI schema, the component raises an exception.

Reset Method (HL7Validator Component)

Resets the parser.

Syntax

void __fastcall Reset();

Remarks

When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.

Reset must also be used as signal to the parser that the current stream of text has terminated.

Validate Method (HL7Validator Component)

Validates the specified EDI document.

Syntax

void __fastcall Validate();

Remarks

This method validates the EDI document specified by InputFile or InputData.

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); }

EndFunctionalGroup Event (HL7Validator Component)

Fires whenever a control segment is read that marks the end of an interchange.

Syntax

typedef struct {
  String Tag;
  String ControlNumber;
  int Count;
  String FullSegment;
} TibeHL7ValidatorEndFunctionalGroupEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorEndFunctionalGroupEvent)(System::TObject* Sender, TibeHL7ValidatorEndFunctionalGroupEventParams *e);
__property TibeHL7ValidatorEndFunctionalGroupEvent OnEndFunctionalGroup = { read=FOnEndFunctionalGroup, write=FOnEndFunctionalGroup };

Remarks

The EndFunctionalGroup event will fire when a control segment marking the end of a functional group is read. The Tag parameter contains the tag of the segment, such as GE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartFunctionalGroup event. Count contains the value of the count element included in the closing segment, which identifies the number of transactions in a functional group.

EndInterchange Event (HL7Validator Component)

Fires whenever a control segment is read that marks the end of an interchange.

Syntax

typedef struct {
  String Tag;
  String ControlNumber;
  String FullSegment;
} TibeHL7ValidatorEndInterchangeEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorEndInterchangeEvent)(System::TObject* Sender, TibeHL7ValidatorEndInterchangeEventParams *e);
__property TibeHL7ValidatorEndInterchangeEvent OnEndInterchange = { read=FOnEndInterchange, write=FOnEndInterchange };

Remarks

The EndInterchange event will fire when a control segment marking the end of an interchange is read. The Tag parameter contains the tag of the segment, such as IEA. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartInterchange event.

EndLoop Event (HL7Validator Component)

Fires when the end of a loop is detected in a transaction set.

Syntax

typedef struct {
} TibeHL7ValidatorEndLoopEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorEndLoopEvent)(System::TObject* Sender, TibeHL7ValidatorEndLoopEventParams *e);
__property TibeHL7ValidatorEndLoopEvent OnEndLoop = { read=FOnEndLoop, write=FOnEndLoop };

Remarks

The EndLoop event will fire after the last segment in a loop is read. Each EndLoop event is paired with one StartLoop event.

EndTransaction Event (HL7Validator Component)

Fires whenever a control segment is read that marks the end of a transaction.

Syntax

typedef struct {
  String Tag;
  String ControlNumber;
  int Count;
  String FullSegment;
} TibeHL7ValidatorEndTransactionEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorEndTransactionEvent)(System::TObject* Sender, TibeHL7ValidatorEndTransactionEventParams *e);
__property TibeHL7ValidatorEndTransactionEvent OnEndTransaction = { read=FOnEndTransaction, write=FOnEndTransaction };

Remarks

The EndTransaction event will fire when a control segment marking the end of a transaction is read. The Tag parameter contains the tag of the segment, such as SE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartTransaction event. Count contains the value of the count element included in the closing segment, which identifies the number of segments in a transaction set.

Error Event (HL7Validator Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibeHL7ValidatorErrorEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorErrorEvent)(System::TObject* Sender, TibeHL7ValidatorErrorEventParams *e);
__property TibeHL7ValidatorErrorEvent 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.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

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

The ErrorCode parameter contains an error code, and the Description parameter 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 (HL7Validator Component)

Fires whenever a new transaction set is encountered and no schema is found for it.

Syntax

typedef struct {
  String TransactionCode;
  String StandardVersion;
} TibeHL7ValidatorResolveSchemaEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorResolveSchemaEvent)(System::TObject* Sender, TibeHL7ValidatorResolveSchemaEventParams *e);
__property TibeHL7ValidatorResolveSchemaEvent OnResolveSchema = { read=FOnResolveSchema, write=FOnResolveSchema };

Remarks

The ResolveSchema event will fire when a the component encounters the header segment of a new transaction set, but it finds no schema corresponding to it already loaded.

TransactionCode contains the code of the transaction, such as "810" or "APERAK".

StandardVersion contains the version of the transaction, such as "004010" or "D95A".

When processing this event, the caller can use LoadSchema() to load a new schema into the component that can be used to parse the transaction.

After the event fires, if the component still doesn't have a matching schema, then it will attempt schema-less parsing of the transaction set.

Segment Event (HL7Validator Component)

Fires whenever a data segment in a transaction set is read.

Syntax

typedef struct {
  String Tag;
  String Name;
  String LoopName;
  String FullSegment;
} TibeHL7ValidatorSegmentEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorSegmentEvent)(System::TObject* Sender, TibeHL7ValidatorSegmentEventParams *e);
__property TibeHL7ValidatorSegmentEvent OnSegment = { read=FOnSegment, write=FOnSegment };

Remarks

The Segment event will fire when a data segment is read. The Tag parameter contains the tag of the segment. Name contains the name of the segment as defined in the associated transaction set schema. LoopName contains the name of the loop or group this segment is present in (such as N1Loop1).

StartFunctionalGroup Event (HL7Validator Component)

Fires whenever a control segment is read that marks the start of a functional group.

Syntax

typedef struct {
  String Tag;
  String ControlNumber;
  String FullSegment;
} TibeHL7ValidatorStartFunctionalGroupEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorStartFunctionalGroupEvent)(System::TObject* Sender, TibeHL7ValidatorStartFunctionalGroupEventParams *e);
__property TibeHL7ValidatorStartFunctionalGroupEvent OnStartFunctionalGroup = { read=FOnStartFunctionalGroup, write=FOnStartFunctionalGroup };

Remarks

The StartFunctionalGroup event will fire when a control segment marking the start of a functional group structure is read. The Tag parameter contains the tag of the segment, such as GS. ControlNumber contains the control number associated with the segment.

StartInterchange Event (HL7Validator Component)

Fires whenever a control segment is read that marks the start of an interchange.

Syntax

typedef struct {
  String Tag;
  String ControlNumber;
  String FullSegment;
} TibeHL7ValidatorStartInterchangeEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorStartInterchangeEvent)(System::TObject* Sender, TibeHL7ValidatorStartInterchangeEventParams *e);
__property TibeHL7ValidatorStartInterchangeEvent OnStartInterchange = { read=FOnStartInterchange, write=FOnStartInterchange };

Remarks

The StartInterchange event will fire when a control segment marking the start of an interchange structure is read. The Tag parameter contains the tag of the segment, such as ISA. ControlNumber contains the control number associated with the segment.

StartLoop Event (HL7Validator Component)

Fires when the starting of a loop is detected in a transaction set.

Syntax

typedef struct {
  String Name;
} TibeHL7ValidatorStartLoopEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorStartLoopEvent)(System::TObject* Sender, TibeHL7ValidatorStartLoopEventParams *e);
__property TibeHL7ValidatorStartLoopEvent OnStartLoop = { read=FOnStartLoop, write=FOnStartLoop };

Remarks

The StartLoop event will fire when the tag of a loop trigger segment is read. The Name parameter contains the schema-provided name of the loop, such as "N1Loop1".

StartTransaction Event (HL7Validator Component)

Fires whenever a control segment is read that marks the start of a transaction.

Syntax

typedef struct {
  String Tag;
  String ControlNumber;
  String Code;
  String FullSegment;
} TibeHL7ValidatorStartTransactionEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorStartTransactionEvent)(System::TObject* Sender, TibeHL7ValidatorStartTransactionEventParams *e);
__property TibeHL7ValidatorStartTransactionEvent OnStartTransaction = { read=FOnStartTransaction, write=FOnStartTransaction };

Remarks

The StartTransaction event will fire when a control segment marking the start of a transaction is read. The Tag parameter contains the tag of the segment, such as ST. ControlNumber contains the control number associated with the segment. Code contains the transaction code (such as 810).

ValidationError Event (HL7Validator Component)

Fires whenever a validation error is encountered.

Syntax

typedef struct {
  int ErrorCode;
  String Message;
  int SegmentNumber;
  String SegmentTag;
  String TechnicalErrorCode;
  String SegmentErrorCode;
  String ElementErrorCode;
  int ElementPosition;
  int Line;
  int Column;
} TibeHL7ValidatorValidationErrorEventParams;
typedef void __fastcall (__closure *TibeHL7ValidatorValidationErrorEvent)(System::TObject* Sender, TibeHL7ValidatorValidationErrorEventParams *e);
__property TibeHL7ValidatorValidationErrorEvent OnValidationError = { read=FOnValidationError, write=FOnValidationError };

Remarks

This event will fire with errors as the EDI document is validated. The ErrorCode parameter contains the type of error encountered. Message is a textual description of the problem. SegmentNumber is the index of the segment where the problem was found. SegmentTag holds the tag name of the segment. ElementPosition is the position of the element where the error occurred.

The Line and Column parameters identify the location within the EDI document where the error occurred.

Possible ErrorCode values are:

0 The component is not required but is present.
1 Invalid segment count.
2 Invalid transaction count.
3 Invalid group count.
4 Invalid interchange control number.
5 Invalid group control number.
6 Invalid transaction control number.
10 A required data element is missing.
11 Invalid field length.
12 Invalid field value.
13 A required component is missing.
14 The data element is not defined but is present.
30 Required segment is missing.
31 Required loop is missing.
32 Occurrences exceeds the schema defined limit.
33 Occurrences is less than the schema defined minimum.
40 Paired rule validation failed, the pair of elements must be present.
41 At least one of element is required, see message for list of elements.
42 Exclusion validation failed, only one of the elements can be present.
43 Conditional rule validation failed.
44 List conditional rule validation failed.
45 First then none validation failed. The presence of an element requires that other specific elements must not be present.
46 Only one or none of the elements can be present.

X12 Specific Parameters

The following parameters are available in all validator components but are only applicable to X12 document validation at this time.

SegmentErrorCode holds the error code that may be used in the IK304 field of a 999. ElementErrorCode holds the error code that may be used in the IK403 field of a 999.

TechnicalErrorCode holds a technical error code that helps identify structural issues with the document. For instance when parsing an X12 document this will hold values that may be used for TA1 error codes. When parsing X12 documents the following codes are applicable:

001The Interchange Control Numbers in the header ISA 13 and trailer IEA02 do not match.
014Invalid interchange date value (non-numeric characters or wrong length).
015Invalid interchange time value (non-numeric characters or wrong length).
022The ISA segment is missing elements (invalid control structure).
024Invalid interchange content (e.g., Invalid GS segment).

Config Settings (HL7Validator 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.

HL7Validator Config Settings

ComponentDelimiter:   The delimiter separating components.

After parsing an EDI document, this configuration option will return the delimiter used to separate components within data elements of the EDI document.

This configuration option may be set in the StartInterchange event to specify the delimiter to be used.

CrossFieldValidationEnabled:   Enables cross-field validation rules.

If true (default), cross-field validation rules present in the document schema will be checked.

Note, Bots Schema Files do not support syntax rules, therefore CrossFieldValidation rules will never execute for these schemas.

ElementDelimiter:   The delimiter character separating data elements.

After parsing an EDI document, this configuration option will return the delimiter used to separate data elements within segments of the EDI document.

This configuration option may be set in the StartInterchange event to specify the delimiter to be used.

Encoding:   The character encoding to be applied when reading and writing data.

If the data contains non-ASCII characters this setting should be specified so characters are properly preserved. This value should be set to a valid character set such as "UTF-8" or "ISO-8859-1".

ExtraData:   Extra data that has not been parsed by the component.

This setting will only be populated after the Flush method has been called and data exists in the internal parser which has not been processed.

HasXPath:   Determines if the specified XPath exists.

This setting can be used to query if an XPath exists before setting XPath. For instance: Console.WriteLine(edireader.Config("HasXPath=IX/FG/TX/IT1Loop1/[2]"));

ISA11IsRepetitionSeparator:   Specifies whether the ISA11 value is treated as a Repetition Separator or Standard Identifier.

By default this value is True and the ISA11 value is treated as a Repetition Separator in all documents with version 004040 or greater. Set this value to False to treat ISA11 as a Standard Identifier instead of a Repetition Separator.

MaxValidationErrors:   The maximum number of errors to save in the ValidationErrors property.

This setting specifies the maximum number of errors that will be kept in the ValidationErrors property. Once this limit is exceeded the ValidationError event will continue to fire but details will not be saved in the ValidationErrors property. The default value is 200.

ReleaseChar:   The character used to escape delimiters within values.

After parsing an EDI document, this configuration option will return the escape character used to escape delimiters within values within the EDI document.

This configuration option may be set in the StartInterchange event to specify the escape character to be used.

ResolveXPathOnSet:   Determines whether or not the XPath is resolved when set.

When true, the component will fully resolve a detailed path when XPath is specified. In this case, the XPath property will contain the XSegment s name as well as the indices when queried after being set.

If this value is set to false, the exact string will be returned when the XPath property is queried from the last time it was set.

For example, the following code will print the string "/[1]/[1]/[1]/[10]" when this value is false, and would print "/IX[1]/FG[1]/TX[1]/IT1Loop1[4]" when this value is true: reader.XPath = "/[1]/[1]/[1]/[10]"; Console.WriteLine(reader.XPath);

In another example, the following code sample will print "IX/FG/TX/IT1Loop1" when false and would print "/IX[1]/FG[1]/TX[1]/IT1Loop1[1]" when true: reader.XPath = "IX/FG/TX/IT1Loop1"; Console.WriteLine(reader.XPath);

This is useful in cases where the full XPath including indices is needed for future processing.

SegmentDelimiter:   The delimiter character separating segments within the EDI document.

After parsing an EDI document, this configuration option will return the delimiter used to separate segments within the EDI document.

This configuration option may be set in the StartInterchange event to specify the delimiter to be used.

StrictSchemaValidation:   Specifies the behavior during schema validation.

This setting specifies what happens when performing schema validation and a validation warning occurs. By default this value is set to 1 (Warn) and the Warning event will fire, but processing will not stop. See the WarnCode parameter list in the Warning event for details about possible validation warnings. Possible values for this setting are:

0 (Ignore) All validation warnings will be ignored. Warning will not fire with warnings.
1 (Warn - default) The Warning event will fire with all validation warnings.
2 (Error) All validation warnings are treated as errors and will cause an exception. Processing will stop immediately.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseFIPSCompliantAPI:   Tells the component whether or not to use FIPS certified APIs.

When set to true, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (HL7Validator Component)

HL7Validator Errors

1000   Input/Output error
1001   No stream or file name were specified for the component
1002   Unexpected end of file (EOF).
1003   Segment not found.
1004   Segment not found in schema.
1005   Schema not found.
1010   Invalid Writer state.
1011   Segment does not have the specified element or component.
1012   Invalid XPath.
1013   DOM tree unavailable (set BuildDOM and reparse).
1014   Document contains incomplete segments.
1015   Document contains an open EDI structure (interchange, functional group or transaction) with no matching footer segment.
1044   Error while reading schema file.
1100   Component is busy.
1099   Unexpected error.