EDIFACTReader Class
Properties Methods Events Config Settings Errors
The EDIFACTReader class is optimized for EDIFACT documents, providing a simple way to parse EDIFACT documents.
Class Name
IPWorksEDI_EDIFACTReader
Procedural Interface
ipworksedi_edifactreader_open(); ipworksedi_edifactreader_close($res); ipworksedi_edifactreader_register_callback($res, $id, $function); ipworksedi_edifactreader_get_last_error($res); ipworksedi_edifactreader_get_last_error_code($res); ipworksedi_edifactreader_set($res, $id, $index, $value); ipworksedi_edifactreader_get($res, $id, $index); ipworksedi_edifactreader_do_compileschema($res, $xsdschema, $binschema); ipworksedi_edifactreader_do_config($res, $configurationstring); ipworksedi_edifactreader_do_displayschemainfo($res); ipworksedi_edifactreader_do_displayxmlinfo($res); ipworksedi_edifactreader_do_flush($res); ipworksedi_edifactreader_do_generateack($res); ipworksedi_edifactreader_do_hasxpath($res, $xpath); ipworksedi_edifactreader_do_loadschema($res, $filename); ipworksedi_edifactreader_do_parse($res); ipworksedi_edifactreader_do_reset($res); ipworksedi_edifactreader_do_tryxpath($res, $xpath);
Remarks
The class allows you to parse an incoming EDI document. This class works in two states, loading an entire document at once, or streaming portions of the document. These states are controlled by the BuildDOM property. By default BuildDOM is set to bdEntireDocument which parses the entire document at once, allowing you to use the XPath property to navigate the document.
To save memory for larger documents, you can choose to parse only sections of the document, instead of the entire document. When BuildDOM is set to per interchange (bdInterchange ) or per transaction (bdTransaction), the respective section of the document will be available for use with XPath from within the corresponding Start and End events. Finally, you may choose to set BuildDOM to bdNone, which means no DOM will be built and all data will be available only through events, but also will use very little memory. Below are example steps to parse an entire document:
- First, use LoadSchema to load a schema file into the class. (Only necessary when preserving document structure).
- Open an EDI document or stream by setting input via InputFile or InputData and calling Parse.
- If BuildDOM is set to bdEntireDocument, the events of the class will fire as the document is parsed, and XPath may be set to access any part of the document.
If bdInterchange or bdTransaction are specified, Parse is called the entire document will be parsed, with only the specified section being saved in memory at any given time. This means if you wish to set XPath to navigate within the section of the document, you will need to do so within the events of the class to prevent further processing of the document while you access the section. When parsing is completely, only the most recently parsed section will be available for use with XPath
If bdNone is specified, then all document information must be obtained through the events fired during parsing.
During parsing, the class performs basic validation of the incoming document. If validation fails, a warning is generated (fired as an event).
The XPath navigation is done through the XPath property. For example:
EDIReader.XPath = "/IX[1]/FG[1]/TX[2]/N1Loop1[1]/N1[1]";
This example path means the following: Select the first N1 segment within the first iteration of the N1Loop1, within second transaction in the first functional group and interchange.
You can also make use of XPath conditional statements to locate the first element which matches a name=value. For example, you could use the following XPath to locate the path of the first element within any N1Loop1 that has a name=N101 and value=BT:
EDIReader.XPath = "IX[1]/FG[1]/TX[1]/N1Loop1[N101='BT']";
Note that the conditional statements will search the children, but not the grand children of the element on which the conditional statement is applied. For instance in the above example the children of N1Loop1 will be searched, but the grandchildren will not.
Additionally if the schema loaded is a ArcESB JSON schema the element Id (from the schema) can be used in the conditional statement. For instance instead of N101 the following is also acceptable:
EDIReader.XPath = "IX[1]/FG[1]/TX[1]/N1Loop1[98='BT']";
To display the structure of the parsed document use DisplaySchemaInfo. This is helpful when deciding how to navigate the document.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
BuildDOM | When True, an internal object model of the EDI document is created. |
EDIStandardVersion | The version of the EDI specification. |
ExtraData | Extra data that has not been parsed by the class. |
InputData | The data to parse. |
InputFile | The file to parse. |
Offset | Current offset of the document being parsed. |
SchemaFormat | The format of the schema file. |
XChildren | Number of child elements of the current segment. |
ElementCount | The number of records in the Element arrays. |
ElementComponentCount | Number of classes in the current element. |
ElementComponentIndex | The index of the selected class of the current element. |
ElementComponentName | The name of the class selected by ClassIndex , according to the Transaction Set schema. |
ElementComponentSchemaDesc | The textual description of the class from the loaded ArcESB JSON schema. |
ElementComponentSchemaName | The name of the class as taken from the schema. |
ElementComponentType | The data type of class selected by ClassIndex , according to the Transaction Set Schema. |
ElementComponentValue | The value of the class selected by ClassIndex . |
ElementDataType | The data type of this EDI element, according to the Transaction Set Schema. |
ElementName | The name of this EDI element, according to the Transaction Set schema. |
ElementRepeatCount | The number of times this element is repeated in the in the segment. |
ElementRepeatIndex | The index of the selected instance of this repeatable element. |
ElementSchemaDesc | The textual description of the element from the loaded ArcESB JSON schema. |
ElementSchemaName | The name of the element as taken from the schema. |
ElementValue | The value directly associated with this EDI element. |
XPath | Provides a way to point to a specific segment in the document. |
XSegment | The name of the current segment. |
XSegmentNumber | The number of the current segment. |
XSegmentType | Indicates the current segment type. |
XTag | The tag of the current segment. |
XTransactionCode | The transaction code of the current segment. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
CompileSchema | Compiles an existing XSD schema into an optimized binary representation. |
Config | Sets or retrieves a configuration setting. |
DisplaySchemaInfo | Returns a string showing the structure of the schema defining the document. |
DisplayXMLInfo | Returns a string showing the structure of the parsed document as XML. |
Flush | Flushes the parser and checks its end state. |
GenerateAck | Generates an EDI acknowledgement. |
HasXPath | Determines whether a specific element exists in the document. |
LoadSchema | Loads a schema file describing a Transaction Set. |
Parse | Parse the specified input data. |
Reset | Resets the parser. |
TryXPath | Navigates to the specified XPath if it exists. |
Event List
The following is the full list of the events fired by the class 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 class with short descriptions. Click on the links for further details.
ComponentDelimiter | The delimiter separating classes. |
CrossFieldValidationEnabled | Enables cross-field validation rules. |
ElementDelimiter | The delimiter character separating data elements. |
Encoding | The character encoding to be applied when reading and writing data. |
HasXPath | Determines if the specified XPath exists. |
ISA11IsRepetitionSeparator | Specifies whether the ISA11 value is treated as a Repetition Separator or Standard Identifier. |
ReleaseChar | The character used to escape delimiters within values. |
ResolveXPathOnSet | Determines whether or not the XPath is resolved when set. |
SegmentDelimiter | The delimiter character separating segments within the EDI document. |
StrictSchemaValidation | Specifies the behavior during schema validation. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
BuildDOM Property (IPWorksEDI_EDIFACTReader Class)
When True, an internal object model of the EDI document is created.
Object Oriented Interface
public function getBuildDOM(); public function setBuildDOM($value);
Procedural Interface
ipworksedi_edifactreader_get($res, 1 ); ipworksedi_edifactreader_set($res, 1, $value );
Default Value
0
Remarks
Set BuildDOM to bdEntireDocument (0) when you need to browse the current document through XPath.
Use bdInterchange (1) when parsing large documents to tell the class to only hold an internal object model of the current Interchange being parsed. When this value is used, and a new Interchange is encountered during parsing, the old interchange is cleared from memory. If the input contains a single Interchange, this is equivalent to using bdEntireDocument.
Use bdTransaction (2) when parsing large documents to tell the class to only hold an internal object model of the current transaction being parsed. When this value is used, and a new transaction is encountered during parsing, the old transaction is cleared from memory.
A value of bdNone (3) will tell the class to not save any internal state of the document being parsed, and thus XPath will be unavailable.
Data Type
Integer
EDIStandardVersion Property (IPWorksEDI_EDIFACTReader Class)
The version of the EDI specification.
Object Oriented Interface
public function getEDIStandardVersion();
Procedural Interface
ipworksedi_edifactreader_get($res, 2 );
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
ExtraData Property (IPWorksEDI_EDIFACTReader Class)
Extra data that has not been parsed by the class.
Object Oriented Interface
public function getExtraData();
Procedural Interface
ipworksedi_edifactreader_get($res, 3 );
Default Value
''
Remarks
This property will only be populated after the Flush method has been called and data exists in the internal parser which has not been processed.
This property is read-only and not available at design time.
Data Type
String
InputData Property (IPWorksEDI_EDIFACTReader Class)
The data to parse.
Object Oriented Interface
public function getInputData(); public function setInputData($value);
Procedural Interface
ipworksedi_edifactreader_get($res, 4 ); ipworksedi_edifactreader_set($res, 4, $value );
Default Value
''
Remarks
This property specifies the data to be parsed.
Input Properties
The class 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
Data Type
String
InputFile Property (IPWorksEDI_EDIFACTReader Class)
The file to parse.
Object Oriented Interface
public function getInputFile(); public function setInputFile($value);
Procedural Interface
ipworksedi_edifactreader_get($res, 5 ); ipworksedi_edifactreader_set($res, 5, $value );
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 class 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
This property is not available at design time.
Data Type
String
Offset Property (IPWorksEDI_EDIFACTReader Class)
Current offset of the document being parsed.
Object Oriented Interface
public function getOffset();
Procedural Interface
ipworksedi_edifactreader_get($res, 6 );
Default Value
0
Remarks
This property is useful for determining the location of possible EDI errors in the document.
This property is read-only and not available at design time.
Data Type
Long64
SchemaFormat Property (IPWorksEDI_EDIFACTReader Class)
The format of the schema file.
Object Oriented Interface
public function getSchemaFormat(); public function setSchemaFormat($value);
Procedural Interface
ipworksedi_edifactreader_get($res, 7 ); ipworksedi_edifactreader_set($res, 7, $value );
Default Value
0
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
XChildren Property (IPWorksEDI_EDIFACTReader Class)
Number of child elements of the current segment.
Object Oriented Interface
public function getXChildren();
Procedural Interface
ipworksedi_edifactreader_get($res, 8 );
Default Value
0
Remarks
This property describes the number of children of the current segment in the parsed document.
This property is read-only and not available at design time.
Data Type
Integer
ElementCount Property (IPWorksEDI_EDIFACTReader Class)
The number of records in the Element arrays.
Object Oriented Interface
public function getElementCount();
Procedural Interface
ipworksedi_edifactreader_get($res, 9 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- ElementComponentCount
- ElementComponentIndex
- ElementComponentName
- ElementComponentSchemaDesc
- ElementComponentSchemaName
- ElementComponentType
- ElementComponentValue
- ElementDataType
- ElementName
- ElementRepeatCount
- ElementRepeatIndex
- ElementSchemaDesc
- ElementSchemaName
- ElementValue
This property is read-only and not available at design time.
Data Type
Integer
ElementComponentCount Property (IPWorksEDI_EDIFACTReader Class)
Number of classes in the current element.
Object Oriented Interface
public function getElementComponentCount($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 10 , $elementindex);
Default Value
0
Remarks
Number of components in the current element.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
Integer
ElementComponentIndex Property (IPWorksEDI_EDIFACTReader Class)
The index of the selected class of the current element.
Object Oriented Interface
public function getElementComponentIndex($elementindex); public function setElementComponentIndex($elementindex, $value);
Procedural Interface
ipworksedi_edifactreader_get($res, 11 , $elementindex); ipworksedi_edifactreader_set($res, 11, $value , $elementindex);
Default Value
1
Remarks
The index of the selected component of the current element. ElementComponentIndex valid values are from 0 to (ElementComponentCount - 1).
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is not available at design time.
Data Type
Integer
ElementComponentName Property (IPWorksEDI_EDIFACTReader Class)
The name of the class selected by ClassIndex , according to the Transaction Set schema.
Object Oriented Interface
public function getElementComponentName($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 12 , $elementindex);
Default Value
''
Remarks
The name of the component selected by ElementComponentIndex, according to the Transaction Set schema.
The name is based on the position of the element within the segment. For instance "DTM0101".
See ElementComponentSchemaName for additional details.
Note: This property is only applicable when a ArcESB JSON schema is loaded.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementComponentSchemaDesc Property (IPWorksEDI_EDIFACTReader Class)
The textual description of the class from the loaded ArcESB JSON schema.
Object Oriented Interface
public function getElementComponentSchemaDesc($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 13 , $elementindex);
Default Value
''
Remarks
The textual description of the component from the loaded ArcESB JSON schema.
This property holds a human readable description of the component as obtained from the ArcESB JSON schema.
Note: This property is only applicable when a ArcESB JSON schema is loaded.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementComponentSchemaName Property (IPWorksEDI_EDIFACTReader Class)
The name of the class as taken from the schema.
Object Oriented Interface
public function getElementComponentSchemaName($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 14 , $elementindex);
Default Value
''
Remarks
The name of the component as taken from the schema.
ElementComponentName holds positional (ref) value like "DTM0101". ElementComponentSchemaName holds the Id taken from the schema.
For instance:
reader.XPath = "/IX/TX/DTM";
for (int i = 0; i < reader.XElements[0].ComponentCount; i++)
{
reader.XElements[0].ComponentIndex = i;
Console.WriteLine(reader.XElements[i].ComponentSchemaName + ": " + reader.XElements[i].ComponentValue);
}
When ElementComponentSchemaName is used this will use the name from the schema and will output values like:
2005: 137 2005: 137 2380: 201612151441
In contrast, if ElementComponentName was used the output would look like:
DTM0101: 137 DTM0101: 137 DTM0102: 201612151441
Note: This property is only applicable when a ArcESB JSON schema is loaded.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementComponentType Property (IPWorksEDI_EDIFACTReader Class)
The data type of class selected by ClassIndex , according to the Transaction Set Schema.
Object Oriented Interface
public function getElementComponentType($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 15 , $elementindex);
Default Value
''
Remarks
The data type of component selected by ElementComponentIndex, according to the Transaction Set Schema.
Possible values are:
AN | AlphaNumeric |
ID | Identifier; allowed values might be defined by the transaction set schema |
N | Numeric |
R | Floating-point number |
DT | DateTime |
TM | Time |
None | Type is unknown or not provided by the schema |
Composite | This element has multiple components |
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementComponentValue Property (IPWorksEDI_EDIFACTReader Class)
The value of the class selected by ClassIndex .
Object Oriented Interface
public function getElementComponentValue($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 16 , $elementindex);
Default Value
''
Remarks
The value of the component selected by ElementComponentIndex.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementDataType Property (IPWorksEDI_EDIFACTReader Class)
The data type of this EDI element, according to the Transaction Set Schema.
Object Oriented Interface
public function getElementDataType($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 17 , $elementindex);
Default Value
''
Remarks
The data type of this EDI element, according to the Transaction Set Schema.
Possible values are:
AN | AlphaNumeric |
ID | Identifier; allowed values might be defined by the transaction set schema |
N | Numeric |
R | Floating-point number |
DT | DateTime |
TM | Time |
None | Type is unknown or not provided by the schema |
Composite | This element has multiple components |
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementName Property (IPWorksEDI_EDIFACTReader Class)
The name of this EDI element, according to the Transaction Set schema.
Object Oriented Interface
public function getElementName($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 18 , $elementindex);
Default Value
''
Remarks
The name of this EDI element, according to the Transaction Set schema. The name is based on the position of the element within the segment. For instance "N101".
See ElementSchemaName for additional details.
Note: This property is only applicable when a ArcESB JSON schema is loaded.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementRepeatCount Property (IPWorksEDI_EDIFACTReader Class)
The number of times this element is repeated in the in the segment.
Object Oriented Interface
public function getElementRepeatCount($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 19 , $elementindex);
Default Value
1
Remarks
The number of times this element is repeated in the in the segment. If the element is not repeated this will return 0.
To access the repeated element values set ElementRepeatIndex.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
Integer
ElementRepeatIndex Property (IPWorksEDI_EDIFACTReader Class)
The index of the selected instance of this repeatable element.
Object Oriented Interface
public function getElementRepeatIndex($elementindex); public function setElementRepeatIndex($elementindex, $value);
Procedural Interface
ipworksedi_edifactreader_get($res, 20 , $elementindex); ipworksedi_edifactreader_set($res, 20, $value , $elementindex);
Default Value
1
Remarks
The index of the selected instance of this repeatable element. ElementRepeatIndex valid values are from 0 to (ElementRepeatCount - 1).
Setting ElementRepeatIndex will affect the value reported by all other properties.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is not available at design time.
Data Type
Integer
ElementSchemaDesc Property (IPWorksEDI_EDIFACTReader Class)
The textual description of the element from the loaded ArcESB JSON schema.
Object Oriented Interface
public function getElementSchemaDesc($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 21 , $elementindex);
Default Value
''
Remarks
The textual description of the element from the loaded ArcESB JSON schema.
This property holds a human readable description of the element as obtained from the ArcESB JSON schema.
Note: This property is only applicable when a ArcESB JSON schema is loaded.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementSchemaName Property (IPWorksEDI_EDIFACTReader Class)
The name of the element as taken from the schema.
Object Oriented Interface
public function getElementSchemaName($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 22 , $elementindex);
Default Value
''
Remarks
The name of the element as taken from the schema.
ElementName holds positional (ref) value like "N101". ElementSchemaName holds the Id taken from the schema.
For instance:
reader.XPath = "/IX/FG/TX/N1Loop1[1]/N1";
for (int i = 0; i < reader.XElements.Count; i++)
{
Console.WriteLine(reader.XElements[i].SchemaName + ": " + reader.XElements[i].Value);
}
When ElementSchemaName is used this will use the name from the schema and will output values like:
98: ST 93: BUYSNACKS PORT 66: 9 67: 1223334445
In contrast, if ElementName was used the output would look like:
N101: ST N102: BUYSNACKS PORT N103: 9 N104: 1223334445
Note: This property is only applicable when a ArcESB JSON schema is loaded.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
ElementValue Property (IPWorksEDI_EDIFACTReader Class)
The value directly associated with this EDI element.
Object Oriented Interface
public function getElementValue($elementindex);
Procedural Interface
ipworksedi_edifactreader_get($res, 23 , $elementindex);
Default Value
''
Remarks
The value directly associated with this EDI element.
Note that this property will be populated with the entire element contents when a composite element exists. The components of the composite element will also be parsed out into the ElementComponentName, ElementComponentType, and ElementComponentValue properties.
The $elementindex parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.
This property is read-only and not available at design time.
Data Type
String
XPath Property (IPWorksEDI_EDIFACTReader Class)
Provides a way to point to a specific segment in the document.
Object Oriented Interface
public function getXPath(); public function setXPath($value);
Procedural Interface
ipworksedi_edifactreader_get($res, 24 ); ipworksedi_edifactreader_set($res, 24, $value );
Default Value
''
Remarks
The path is a series of one or more segment accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.
The following are possible values for an element accessor:
IX | Refers to the Interchange (root) node |
FG | Refers to a Functional Group node |
TX | Refers to a Transaction Set node |
'name' | The first segment or loop of the current container with the given schema name |
name[i] | The i-th segment of the current container with the given schema-name |
[i] | The i-th segment of the current container |
[last()] | The last segment of the current container |
[last()-i] | The segment located at the last location minus i in the current container |
.. | The parent of the current container |
BuildDOM must be set to bdEntireDocument or bdTransaction prior to parsing the document for the XPath functionality to be available.
Example (Setting XPath)
Document root (Interchange) | EDIReaderControl.XPath = "/" |
N1 segment in the first transaction | EDIReaderControl.XPath = "/IX/FG/TX/N1Loop1/N1" |
3-th instance of the N2 segment | EDIReaderControl.XPath = "/IX/FG/TX/N1Loop1/N2[3]" |
Data Type
String
XSegment Property (IPWorksEDI_EDIFACTReader Class)
The name of the current segment.
Object Oriented Interface
public function getXSegment();
Procedural Interface
ipworksedi_edifactreader_get($res, 25 );
Default Value
''
Remarks
The name of the current segment according to the schema. The current segment is specified via the XPath property.
This property is read-only and not available at design time.
Data Type
String
XSegmentNumber Property (IPWorksEDI_EDIFACTReader Class)
The number of the current segment.
Object Oriented Interface
public function getXSegmentNumber();
Procedural Interface
ipworksedi_edifactreader_get($res, 26 );
Default Value
0
Remarks
The number of the current segment according to the schema. The current segment is specified via the XPath property.
This property is read-only and not available at design time.
Data Type
Integer
XSegmentType Property (IPWorksEDI_EDIFACTReader Class)
Indicates the current segment type.
Object Oriented Interface
public function getXSegmentType();
Procedural Interface
ipworksedi_edifactreader_get($res, 27 );
Default Value
0
Remarks
The current segment will be a control segment footer/header or a transaction data segment.
This property is read-only and not available at design time.
Data Type
Integer
XTag Property (IPWorksEDI_EDIFACTReader Class)
The tag of the current segment.
Object Oriented Interface
public function getXTag();
Procedural Interface
ipworksedi_edifactreader_get($res, 28 );
Default Value
''
Remarks
The current segment is specified via the XPath property.
This property is read-only and not available at design time.
Data Type
String
XTransactionCode Property (IPWorksEDI_EDIFACTReader Class)
The transaction code of the current segment.
Object Oriented Interface
public function getXTransactionCode();
Procedural Interface
ipworksedi_edifactreader_get($res, 29 );
Default Value
''
Remarks
The current segment is specified via the XPath property.
This property is read-only and not available at design time.
Data Type
String
CompileSchema Method (IPWorksEDI_EDIFACTReader Class)
Compiles an existing XSD schema into an optimized binary representation.
Object Oriented Interface
public function doCompileSchema($xsdschema, $binschema);
Procedural Interface
ipworksedi_edifactreader_do_compileschema($res, $xsdschema, $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 (IPWorksEDI_EDIFACTReader Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworksedi_edifactreader_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (IPWorksEDI_EDIFACTReader Class)
Returns a string showing the structure of the schema defining the document.
Object Oriented Interface
public function doDisplaySchemaInfo();
Procedural Interface
ipworksedi_edifactreader_do_displayschemainfo($res);
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 (IPWorksEDI_EDIFACTReader Class)
Returns a string showing the structure of the parsed document as XML.
Object Oriented Interface
public function doDisplayXMLInfo();
Procedural Interface
ipworksedi_edifactreader_do_displayxmlinfo($res);
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 (IPWorksEDI_EDIFACTReader Class)
Flushes the parser and checks its end state.
Object Oriented Interface
public function doFlush();
Procedural Interface
ipworksedi_edifactreader_do_flush($res);
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.
GenerateAck Method (IPWorksEDI_EDIFACTReader Class)
Generates an EDI acknowledgement.
Object Oriented Interface
public function doGenerateAck();
Procedural Interface
ipworksedi_edifactreader_do_generateack($res);
Remarks
This functionality is not yet implemented and is reserved for future use.
HasXPath Method (IPWorksEDI_EDIFACTReader Class)
Determines whether a specific element exists in the document.
Object Oriented Interface
public function doHasXPath($xpath);
Procedural Interface
ipworksedi_edifactreader_do_hasxpath($res, $xpath);
Remarks
This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath.
This method returns True if the xpath exists, False if not.
See XPath for details on the XPath syntax.
LoadSchema Method (IPWorksEDI_EDIFACTReader Class)
Loads a schema file describing a Transaction Set.
Object Oriented Interface
public function doLoadSchema($filename);
Procedural Interface
ipworksedi_edifactreader_do_loadschema($res, $filename);
Remarks
This method parses the File and loads it into an internal schema list. The class will attempt to automatically detect the SchemaFormat.
If the schema file does not exist or cannot be parsed as an EDI schema, the class fails with an error.
Parse Method (IPWorksEDI_EDIFACTReader Class)
Parse the specified input data.
Object Oriented Interface
public function doParse();
Procedural Interface
ipworksedi_edifactreader_do_parse($res);
Remarks
This method parsed the input data specified by InputFile or InputData.
During parsing the following events may fire:
- StartInterchange
- StartFunctionalGroup
- StartTransaction
- Segment
- StartLoop
- EndLoop
- EndTransaction
- EndFunctionalGroup
- EndInterchange
After Parse returns the document may be traversed by setting the XPath property.
The XPath navigation is done through the XPath property. For example:
EDIReader.XPath = "/IX[1]/FG[1]/TX[2]/N1Loop1[1]/N1[1]";
This example path means the following: Select the first N1 segment within the first iteration of the N1Loop1, within second transaction in the first functional group and interchange.
You can also make use of XPath conditional statements to locate the first element which matches a name=value. For example, you could use the following XPath to locate the path of the first element within any N1Loop1 that has a name=N101 and value=BT:
EDIReader.XPath = "IX[1]/FG[1]/TX[1]/N1Loop1[N101='BT']";
Note that the conditional statements will search the children, but not the grand children of the element on which the conditional statement is applied. For instance in the above example the children of N1Loop1 will be searched, but the grandchildren will not.
Additionally if the schema loaded is a ArcESB JSON schema the element Id (from the schema) can be used in the conditional statement. For instance instead of N101 the following is also acceptable:
EDIReader.XPath = "IX[1]/FG[1]/TX[1]/N1Loop1[98='BT']";
Input Properties
The class 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.InputData Notes
When setting data to parse via InputData fragments or complete documents may be specified. To parse data in chunks set InputData and call Parse for each fragment.
When the parser is finally reset via the Reset method, all buffered text is flushed out through the ExtraData property.
Since the class can be used to parse EDI data fragments, the internal buffer will not be cleared until Reset is called. If you plan to use this method to parse multiple complete EDI documents be sure to call Reset between calls.
Reset Method (IPWorksEDI_EDIFACTReader Class)
Resets the parser.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworksedi_edifactreader_do_reset($res);
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.
TryXPath Method (IPWorksEDI_EDIFACTReader Class)
Navigates to the specified XPath if it exists.
Object Oriented Interface
public function doTryXPath($xpath);
Procedural Interface
ipworksedi_edifactreader_do_tryxpath($res, $xpath);
Remarks
This method will attempt to navigate to the specified XPath parameter if it exists within the document.
If the XPath exists the XPath property will be updated and this method returns True.
If the XPath does not exist the XPath property is not updated and this method returns False.
EndFunctionalGroup Event (IPWorksEDI_EDIFACTReader Class)
Fires whenever a control segment is read that marks the end of an interchange.
Object Oriented Interface
public function fireEndFunctionalGroup($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 1, array($this, 'fireEndFunctionalGroup'));
Parameter List
'tag'
'controlnumber'
'count'
'fullsegment'
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 (IPWorksEDI_EDIFACTReader Class)
Fires whenever a control segment is read that marks the end of an interchange.
Object Oriented Interface
public function fireEndInterchange($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 2, array($this, 'fireEndInterchange'));
Parameter List
'tag'
'controlnumber'
'fullsegment'
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 (IPWorksEDI_EDIFACTReader Class)
Fires when the end of a loop is detected in a transaction set.
Object Oriented Interface
public function fireEndLoop($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 3, array($this, 'fireEndLoop'));
Parameter List
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 (IPWorksEDI_EDIFACTReader Class)
Fires whenever a control segment is read that marks the end of a transaction.
Object Oriented Interface
public function fireEndTransaction($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 4, array($this, 'fireEndTransaction'));
Parameter List
'tag'
'controlnumber'
'count'
'fullsegment'
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 (IPWorksEDI_EDIFACTReader Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 5, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 (IPWorksEDI_EDIFACTReader Class)
Fires whenever a new transaction set is encountered and no schema is found for it.
Object Oriented Interface
public function fireResolveSchema($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 6, array($this, 'fireResolveSchema'));
Parameter List
'transactioncode'
'standardversion'
Remarks
The ResolveSchema event will fire when a the class 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 class that can be used to parse the transaction.
After the event fires, if the class still doesn't have a matching schema, then it will attempt schema-less parsing of the transaction set.
Segment Event (IPWorksEDI_EDIFACTReader Class)
Fires whenever a data segment in a transaction set is read.
Object Oriented Interface
public function fireSegment($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 7, array($this, 'fireSegment'));
Parameter List
'tag'
'name'
'loopname'
'fullsegment'
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 (IPWorksEDI_EDIFACTReader Class)
Fires whenever a control segment is read that marks the start of a functional group.
Object Oriented Interface
public function fireStartFunctionalGroup($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 8, array($this, 'fireStartFunctionalGroup'));
Parameter List
'tag'
'controlnumber'
'fullsegment'
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 (IPWorksEDI_EDIFACTReader Class)
Fires whenever a control segment is read that marks the start of an interchange.
Object Oriented Interface
public function fireStartInterchange($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 9, array($this, 'fireStartInterchange'));
Parameter List
'tag'
'controlnumber'
'fullsegment'
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 (IPWorksEDI_EDIFACTReader Class)
Fires when the starting of a loop is detected in a transaction set.
Object Oriented Interface
public function fireStartLoop($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 10, array($this, 'fireStartLoop'));
Parameter List
'name'
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 (IPWorksEDI_EDIFACTReader Class)
Fires whenever a control segment is read that marks the start of a transaction.
Object Oriented Interface
public function fireStartTransaction($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 11, array($this, 'fireStartTransaction'));
Parameter List
'tag'
'controlnumber'
'code'
'fullsegment'
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 (IPWorksEDI_EDIFACTReader Class)
Fires whenever a validation warning is encountered.
Object Oriented Interface
public function fireWarning($param);
Procedural Interface
ipworksedi_edifactreader_register_callback($res, 12, array($this, 'fireWarning'));
Parameter List
'warncode'
'message'
'segmentnumber'
'segmenttag'
'technicalerrorcode'
'segmenterrorcode'
'elementerrorcode'
'elementposition'
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 (EDIFACTReader Class)
The class 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 class, access to these internal properties is provided through the Config method.EDIRFACTREADER Config Settings
This configuration option may be set in the StartInterchange event to specify the delimiter to be used.
This configuration option may be set in the StartInterchange event to specify the delimiter to be used.
Console.WriteLine(edireader.Config("HasXPath=IX/FG/TX/IT1Loop1/[2]"));
This configuration option may be set in the StartInterchange event to specify the escape character to be used.
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.
This configuration option may be set in the StartInterchange event to specify the delimiter to be used.
Base Config Settings
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 |
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 |
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
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 classes 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.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (EDIFACTReader Class)
EDIFACTReader 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. |