VDATranslator Control

Properties Methods Events Config Settings Errors

The VDATranslator control is optimized for VDA translation, providing a simple way to convert VDA documents to and from XML or JSON.

Syntax

VDATranslator

Remarks

The control provides a way to convert VDA to XML or JSON and vice versa.

Getting Started

The control will convert a document from the format specified by InputFormat to the format specified by OutputFormat. In practice this allows for converting to XML or JSON from EDI and vice versa.

Before translating from EDI to XML or JSON it is recommended to load a schema using the LoadSchema method. This ensures additional information can be included in the XML or JSON document. If a schema is specified the XML or JSON will include types and descriptions as element attributes which are useful for interpreting the data.

EDI elements may optionally be renamed when creating XML. To define how an element is renamed add a renaming rule by calling AddRenamingRule.

After calling Translate the resulting output will contain the EDI, XML or JSON data as defined by OutputFormat. If the output data is XML the ExportXMLSchema method may be called to export a schema (.xsd) defining the structure of a valid XML document. XML documents which adhere to this document may be translated from XML to EDI.

Input and Output Properties

The control will determine the source and destination of the input and output 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. The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data is written to this property if no other destination is specified.

Property List

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


InputData	The data to translate.
InputFile	The file to translate.
InputFormat	The format of the input data.
OutputData	The translated data.
OutputFile	The file to which the translated data will be written.
OutputFormat	The format of the output data.
Overwrite	Whether to overwrite the file.
RenamingRule	The rule defining how EDI elements are renamed when translating to XML or JSON.
RenamingRuleCount	The number of renaming rules.
RenamingRuleIndex	The index of the current renaming rule.
SchemaFormat	The format of the schema file.
Suffix	What to append after each segment delimiter.
UseSchemaName	Whether the output XML uses element names based on name defined in the schema.

Method List

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


AddRenamingRule	This method adds a renaming rule to define how an EDI element is renamed when translating to XML.
Config	Sets or retrieves a configuration setting.
DisplaySchemaInfo	Returns a string showing the structure of the schema defining the document.
ExportXMLSchema	Exports a XML schema.
GenerateAck	Generates an EDI acknowledgement.
LoadRenamingRules	Loads a set of renaming rules from file.
LoadSchema	Loads a schema file describing a Transaction Set.
Reset	Resets the state of the control.
SaveRenamingRules	Saves the current renaming rule set to a file.
Translate	Translates the specified data.

Event List

The following is the full list of the events fired by the control 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	Fired when information is available 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.
Warning	Fires whenever a validation warning is encountered.

Config Settings

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


ComponentDelimiter	The delimiter character to use to separate controls.
CrossFieldValidationEnabled	Enables cross-field validation rules.
ElementDelimiter	The delimiter character to use to separate data elements.
Encoding	The character encoding to be applied when reading and writing data.
IncludeEmptyElements	Whether to include empty data elements in a composite element.
IncludeFooters	Whether to include footer information in the XML.
JSONElementPrefix	An optional prefix for reserved names when translating to JSON.
LastIXControlNumber	The control number of the most recently parsed interchange.
LastTransactionControlNumber	The control number of the most recently parsed transaction.
ReleaseChar	The character to use to escape delimiters within values.
RenamingRulesData	The renaming rules data.
RepetitionChar	The repetition character.
SegmentDelimiter	The delimiter character to use to separate segments.
StrictSchemaValidation	Specifies the behavior during schema validation.
UseXMLComments	Whether the human readable description is stored as an attribute or XML comments.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

InputData Property (VDATranslator Control)

The data to translate.

Syntax

vdatranslatorcontrol.InputData[=string]

Default Value

Remarks

This property specifies the data to be translated. This may be set to EDI data or XML/JSON data. To specify the type of data held by the property set InputFormat.

Input and Output Properties

The control will determine the source and destination of the input and output 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. The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

InputFile Property (VDATranslator Control)

The file to translate.

Syntax

vdatranslatorcontrol.InputFile[=string]

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. To specify the type of data in the input file set InputFormat.

Input and Output Properties

The control will determine the source and destination of the input and output 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. The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

InputFormat Property (VDATranslator Control)

The format of the input data.

Syntax

vdatranslatorcontrol.InputFormat[=integer]

Possible Values

vifXML(0), 
vifJSON(1), 
vifVDA(5)

Default Value

Remarks

This property specifies the format of the input data. The value set here, along with OutputFormat, determines how the data is converted when Translate is called.

Possible values are:

0 (ifXML)
1 (ifJSON)
5 (ifVDA)

Before calling Translate, both InputFormat and OutputFormat must be specified. Translation from XML or JSON to EDI and vice versa are supported. If InputFormat is ifXML or ifJSON, OutputFormat must be an EDI format. Similarly, if InputFormat is an EDI format, OutputFormat must be ofXML or ofJSON.

This property is not available at design time.

Data Type

Integer

OutputData Property (VDATranslator Control)

The translated data.

Syntax

vdatranslatorcontrol.OutputData[=string]

Default Value

Remarks

This property will be populated with the translated data after calling Translate if OutputFile and SetOutputStream are not set.

Input and Output Properties

The control will determine the source and destination of the input and output 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. The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

OutputFile Property (VDATranslator Control)

The file to which the translated data will be written.

Syntax

vdatranslatorcontrol.OutputFile[=string]

Default Value

Remarks

This property specifies the file to which the translated data will be written. This may be set to an absolute or relative path. This should be set before calling Translate.

Input and Output Properties

The control will determine the source and destination of the input and output 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. The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Data Type

String

OutputFormat Property (VDATranslator Control)

The format of the output data.

Syntax

vdatranslatorcontrol.OutputFormat[=integer]

Possible Values

vofXML(0), 
vofJSON(1), 
vofVDA(5)

Default Value

Remarks

This property specifies the format of the output data. The value set here, along with InputFormat, determines how the data is converted when Translate is called.

Possible values are:

0 (ofXML)
1 (ofJSON)
5 (ofVDA)

This property is not available at design time.

Data Type

Integer

Overwrite Property (VDATranslator Control)

Whether to overwrite the file.

Syntax

vdatranslatorcontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property specifies whether the file is overwritten. If set to False (default) the control fails with an error when attempting to write to a file which already exists. If set to True the control will overwrite the existing file. This property is applicable to the following methods:

SaveRenamingRules
Translate
ExportXMLSchema

Data Type

Boolean

RenamingRule Property (VDATranslator Control)

The rule defining how EDI elements are renamed when translating to XML or JSON.

Syntax

vdatranslatorcontrol.RenamingRule[=string]

Default Value

Remarks

The renaming rule specified by RenamingRuleIndex. Renaming rules are optional.

The renaming rule defines how EDI elements are renamed when translating to XML or JSON. The format is:

ediname:xmlanme

For instance: "UNH1:MsgRefNumber".

Note: Renaming rules are not required when converting from XML or JSON to EDI.

This property is not available at design time.

Data Type

String

RenamingRuleCount Property (VDATranslator Control)

The number of renaming rules.

Syntax

vdatranslatorcontrol.RenamingRuleCount

Default Value

Remarks

This property returns the current number of renaming rules.

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

Data Type

Integer

RenamingRuleIndex Property (VDATranslator Control)

The index of the current renaming rule.

Syntax

vdatranslatorcontrol.RenamingRuleIndex[=integer]

Default Value

-1

Remarks

This property specifies the current renaming rule. Valid values are from 0 to RenamingRuleCount - 1.

When set RenamingRule is populated with the renaming rule identified by the index.

This property is not available at design time.

Data Type

Integer

SchemaFormat Property (VDATranslator Control)

The format of the schema file.

Syntax

vdatranslatorcontrol.SchemaFormat[=integer]

Possible Values

schemaAutomatic(0), 
schemaBinary(1), 
schemaBizTalk(2), 
schemaSEF(3), 
schemaBOTS(4), 
schemaAltova(5), 
schemaJSON(6)

Default Value

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

Suffix Property (VDATranslator Control)

What to append after each segment delimiter.

Syntax

vdatranslatorcontrol.Suffix[=integer]

Possible Values

suffixNone(0), 
suffixCR(1), 
suffixLF(2), 
suffixCRLF(3)

Default Value

Remarks

If Suffix is different from suffixNone, trailing (suffix) characters are appended after each segment delimiter. This is useful if you want to have a carriage return/line feed after each segment to make the document more readable.

This property is not available at design time.

Data Type

Integer

UseSchemaName Property (VDATranslator Control)

Whether the output XML uses element names based on name defined in the schema.

Syntax

vdatranslatorcontrol.UseSchemaName[=boolean]

Default Value

False

Remarks

This setting specifies whether the XML element name written to output is taken from the Id of the element defined in the schema. It is only applicable to ArcESB JSON schemas. For instance, given an EDIFACT document with the segment:

BGM+380:::TAX INVOICE

When this setting is True the XML generated may look like:

<BGM type="Segment">
<C002 type="Composite" desc="DOCUMENT/MESSAGE NAME">
<_1001 desc="Document/message name, coded">380</_1001>
<_1131 desc="Code list qualifier"></_1131>
<_3055 desc="Code list responsible agency, coded"></_3055>
<_1000 desc="Document/message name">TAX INVOICE</_1000>
</C002>

Where the elements "_1001", "C002", etc. are taken from the Id values of the EDI elements in the schema files.

Note: In order to produce valid XML, elements that would begin with a digit are prefixed with the "_" character.

In contrast if False (default) the XML generated may look like:

<BGM type="Segment">
<BGM01 type="Composite" desc="DOCUMENT/MESSAGE NAME">
<BGM0101 desc="Document/message name, coded">380</BGM0101>
<BGM0102 desc="Code list qualifier"></BGM0102>
<BGM0103 desc="Code list responsible agency, coded"></BGM0103>
<BGM0104 desc="Document/message name">TAX INVOICE</BGM0104>
</BGM01>

The default value is False. This setting is only applicable when using ArcESB JSON schemas.

Data Type

Boolean

AddRenamingRule Method (VDATranslator Control)

This method adds a renaming rule to define how an EDI element is renamed when translating to XML.

Syntax

vdatranslatorcontrol.AddRenamingRule Rule

Remarks

This method adds a renaming rule. The rule defining how EDI elements are renamed when translating to XML. Renaming rules are optional.

The renaming rule defines how EDI elements are renamed when translating to XML or JSON. The format is:

ediname:xmlanme

For instance: "UNH1:MsgRefNumber".

Note: Renaming rules are not required when converting from XML or JSON to EDI.

Config Method (VDATranslator Control)

Sets or retrieves a configuration setting.

Syntax

vdatranslatorcontrol.Config ConfigurationString

Remarks

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

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

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

Syntax

vdatranslatorcontrol.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]

ExportXMLSchema Method (VDATranslator Control)

Exports a XML schema.

Syntax

vdatranslatorcontrol.ExportXMLSchema SchemaFile

Remarks

This method exports a XML schema describing the valid format of the XML document.

After translating a document from EDI to XML, this method may be called to export a schema (.xsd) describing the structure of a valid XML documents. XML documents which adhere to this document may be translated from XML to EDI.

This method is helpful if XML will be generated outside of the control and later converted to EDI by the control.

The SchemaFile parameter specifies the absolute or relative path to the file on disk.

GenerateAck Method (VDATranslator Control)

Generates an EDI acknowledgement.

Syntax

vdatranslatorcontrol.GenerateAck

Remarks

This functionality is not yet implemented and is reserved for future use.

LoadRenamingRules Method (VDATranslator Control)

Loads a set of renaming rules from file.

Syntax

vdatranslatorcontrol.LoadRenamingRules RuleFile

Remarks

This method loads a set of renaming rules from a file on disk. The RenamingRuleCount will reflect the number of rules that were loaded. When loading a rule file all previously loaded rules will be replaced.

The RuleFile parameter specifies the absolute or relative path to the file on disk.

LoadSchema Method (VDATranslator Control)

Loads a schema file describing a Transaction Set.

Syntax

vdatranslatorcontrol.LoadSchema FileName

Remarks

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

If the schema file does not exist or cannot be parsed as an EDI schema, the control fails with an error.

Reset Method (VDATranslator Control)

Resets the state of the control.

Syntax

vdatranslatorcontrol.Reset

Remarks

Reset resets the state of the control. All properties will be set to their default values.

SaveRenamingRules Method (VDATranslator Control)

Saves the current renaming rule set to a file.

Syntax

vdatranslatorcontrol.SaveRenamingRules RuleFile

Remarks

This method saves the current renaming rule set specified by RenamingRule, RenamingRuleIndex, and RenamingRuleCount to a file on disk. These rules may be reloaded at a later time by calling LoadRenamingRules.

The RuleFile parameter specifies the absolute or relative path to the file on disk.

Translate Method (VDATranslator Control)

Translates the specified data.

Syntax

vdatranslatorcontrol.Translate

Remarks

This method translates the specified data.

The control will convert a document from the format specified by InputFormat to the format specified by OutputFormat. In practice this allows for converting to XML or JSON from EDI and vice versa.

EDI elements may optionally be renamed when creating XML. To define how an element is renamed add a renaming rule by calling AddRenamingRule.

Input and Output Properties

The control will determine the source and destination of the input and output 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. The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data is written to this property if no other destination is specified.

EndFunctionalGroup Event (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_EndFunctionalGroup(Tag As String, ControlNumber As String, Count As Integer, FullSegment As String)

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 (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_EndInterchange(Tag As String, ControlNumber As String, FullSegment As String)

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 (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_EndLoop()

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 (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_EndTransaction(Tag As String, ControlNumber As String, Count As Integer, FullSegment As String)

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 (VDATranslator Control)

Fired when information is available about errors during data delivery.

Syntax

Sub vdatranslatorcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

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 (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_ResolveSchema(TransactionCode As String, StandardVersion As String)

Remarks

The ResolveSchema event will fire when a the control 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 control that can be used to parse the transaction.

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

Segment Event (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_Segment(Tag As String, Name As String, LoopName As String, FullSegment As String)

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 (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_StartFunctionalGroup(Tag As String, ControlNumber As String, FullSegment As String)

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 (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_StartInterchange(Tag As String, ControlNumber As String, FullSegment As String)

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 (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_StartLoop(Name As String)

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 (VDATranslator Control)

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

Syntax

Sub vdatranslatorcontrol_StartTransaction(Tag As String, ControlNumber As String, Code As String, FullSegment As String)

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

Warning Event (VDATranslator Control)

Fires whenever a validation warning is encountered.

Syntax

Sub vdatranslatorcontrol_Warning(WarnCode As Integer, Message As String, SegmentNumber As Integer, SegmentTag As String, TechnicalErrorCode As String, SegmentErrorCode As String, ElementErrorCode As String, ElementPosition As Integer)

Remarks

The Warning event will fire during parsing of a segment of an EDI document. The WarnCode parameter contains the type of warning 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. 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. ElementPosition is the position of the element where the error occurred.

It's very important to note that segment validation happens right in the middle of the parsing process. Because of this, the Warning event will usually fire long before the validated segment becomes the current segment for the parser state. This means you cannot access the parser properties to examine the current segment in relation with the Warning event when the event fires.

Possible WarnCode 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.

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:


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

Config Settings (VDATranslator Control)

The control 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 control, access to these internal properties is provided through the Config method.

VDATranslator Config Settings

ComponentDelimiter: The delimiter character to use to separate components.

When set, this changes the default delimiter to use to separate components within a data element. The default value depends on the EDI specification being used. This should be set after setting EDIStandard. Setting EDIStandard resets the default delimiter value.

CrossFieldValidationEnabled: Enables cross-field validation rules.

If true, cross-field validation rules present in the document schema will be checked. The default value is false. Note, Bots Schema Files do not support syntax rules, therefore CrossFieldValidation rules will never execute for these schemas.

ElementDelimiter: The delimiter character to use to separate data elements.

When set, this changes the default delimiter to use to separate data elements within a segment. The default value depends on the EDI specification being 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".

IncludeEmptyElements: Whether to include empty data elements in a composite element.

When translating to EDIFACT or X12 this setting specifies whether empty data elements of a composite element will be included. For instance when set to True (default) a segment may look like:

PYT+8+COLLECT:::+25'

When set to False empty data elements are not include and a segment may look like:

PYT+8+COLLECT+25'

IncludeFooters: Whether to include footer information in the XML.

This setting specifies whether footer information is included in the translated XML. For EDIFACT this includes UNT, UNE, and UNZ. For X12 this include GE, SE, and IEA. The default value is True.

JSONElementPrefix: An optional prefix for reserved names when translating to JSON.

This setting optionally specifies a prefix to prepend to the meta, type, desc, and value JSON elements when translating to JSON. This may be set to any ASCII character if desired. For instance:

//use the '@' character translator.Config("JSONElementPrefix=@"); Will result in JSON like:

{
	"@meta": {
		"@type": "Interchange",
		"ISA01": {
			"@desc": "Authorization Information Qualifier",
			"@value": "00"
		},

The default value is empty string and no prefix is used.

LastIXControlNumber: The control number of the most recently parsed interchange.

This setting may be queried from within events. For instance from within the Warning event it may be desirable to know which interchange control number the warning applies to; in that case querying this setting from within Warning will return the expected value.

LastTransactionControlNumber: The control number of the most recently parsed transaction.

This setting may be queried from within events. For instance from within the Warning event it may be desirable to know which transaction control number the warning applies to; in that case querying this setting from within Warning will return the expected value.

ReleaseChar: The character to use to escape delimiters within values.

When set, this changes the default escape character. The default value depends on the EDI specification being used.

RenamingRulesData: The renaming rules data.

This setting may be used to get or set renaming rules without using a file on disk. When calling SaveRenamingRules or LoadRenamingRules set the RuleFile parameter of the method to empty string to use the value in this setting instead of a file on disk. For instance: //Save Renaming Rules editranslator.SaveRenamingRules(""); string ruleData = editranslator.Config("RenamingRulesData");

//Load Renaming Rules editranslator.Config("RenamingRulesData=" + ruleData); editranslator.LoadRenamingRules("");

RepetitionChar: The repetition character.

When set, this changes the default repetition character. The default value depends on the EDI specification being used.

SegmentDelimiter: The delimiter character to use to separate segments.

When set, this changes the default delimiter to use to separate segments within an EDI document. The default value depends on the EDI specification being 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.

UseXMLComments: Whether the human readable description is stored as an attribute or XML comments.

When translating to XML the human readable description of the element will be included in the output. This setting specifies whether the description is present as an attribute of the XML element, or preceding the XML element as a XML comment. For instance:

UseXMLComments is True or 1:

<!--Entity Identifier Code-->
<N101><!--Ship To-->ST</N101>

UseXMLComments is False or 0 (default):

<N101 desc="Entity Identifier Code">ST</N101>

The special value 2 tells the control to omit all comments. For instance:

UseXMLComments is 2:

<N101>ST</N101>

This setting is False (0) by default.

Base Config Settings

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:


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

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

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 to mask sensitive data. The default is .

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

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

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

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

This setting is set to by default on all platforms.

Trappable Errors (VDATranslator Control)

VDATranslator Errors


	20305 The file exists and Overwrite is set to False.
	21001 Input/Output error
	21002 No stream or file name were specified for the component
	21003 Unexpected end of file (EOF).
	21004 Segment not found.
	21005 Segment not found in schema.
	21006 Schema not found.
	21011 Invalid Writer state.
	21012 Segment does not have the specified element or component.
	21013 Invalid XPath.
	21014 DOM tree unavailable (set BuildDOM and reparse).
	21015 Document contains incomplete segments.
	21016 Document contains an open EDI structure (interchange, functional group or transaction) with no matching footer segment.
	21045 Error while reading schema file.
	21101 Component is busy.
	21100 Unexpected error.
	21001 Input/Output error
	21002 No stream or file name were specified for the component
	21003 Unexpected end of file (EOF).
	21004 Segment not found.
	21005 Segment not found in schema.
	21006 Schema not found.
	21011 Invalid Writer state.
	21012 Segment does not have the specified element or component.
	21045 Error while reading schema file.
	21100 Unexpected error.