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.

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.

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:

• InputFile
• InputData

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:

• InputFile
• InputData

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:

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:

• ValidationErrorColumn
• ValidationErrorElementErrorCode
• ValidationErrorElementPosition
• ValidationErrorErrorCode
• ValidationErrorLine
• ValidationErrorMessage
• ValidationErrorSegmentErrorCode
• ValidationErrorSegmentNumber
• ValidationErrorSegmentTag
• ValidationErrorTechnicalErrorCode

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:

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:

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:

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:

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

Base Config Settings

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.