EDIFACTReader Class

Properties   Methods   Events   Config Settings   Errors  

The EDIFACTReader class efficiently parses complete EDIFACT transmissions, providing a convenient way to extract and explore data from all included messages.

Class Name

EDISDK_EDIFACTReader

Procedural Interface

 edisdk_edifactreader_open();
 edisdk_edifactreader_close($res);
 edisdk_edifactreader_register_callback($res, $id, $function);
 edisdk_edifactreader_get_last_error($res);
 edisdk_edifactreader_get_last_error_code($res);
 edisdk_edifactreader_set($res, $id, $index, $value);
 edisdk_edifactreader_get($res, $id, $index);
 edisdk_edifactreader_do_config($res, $configurationstring);
 edisdk_edifactreader_do_generateack($res);
 edisdk_edifactreader_do_getelementvalue($res, $path);
 edisdk_edifactreader_do_loadschema($res, $fileordata, $messagename);
 edisdk_edifactreader_do_parse($res);
 edisdk_edifactreader_do_reset($res);
 edisdk_edifactreader_do_schemacode($res, $schemaid, $codelistid, $value, $description);
 edisdk_edifactreader_do_schemacodelist($res, $schemaid, $codelistid, $description);
 edisdk_edifactreader_do_schemacomposite($res, $schemaid, $compositeid, $description);
 edisdk_edifactreader_do_schemaelement($res, $schemaid, $elementid, $datatype, $minlength, $maxlength, $codeid, $description);
 edisdk_edifactreader_do_schemaelementref($res, $schemaid, $parentid, $elementid, $refid, $required, $maxcount);
 edisdk_edifactreader_do_schemaend($res);
 edisdk_edifactreader_do_schemagroup($res, $schemaid, $grouppath, $groupid, $required, $maxcount);
 edisdk_edifactreader_do_schemamessage($res, $schemaid, $messageid, $description);
 edisdk_edifactreader_do_schemasegment($res, $schemaid, $segmentid, $description);
 edisdk_edifactreader_do_schemasegmentref($res, $schemaid, $segmentpath, $segmentid, $required, $maxcount);
 edisdk_edifactreader_do_schemastart($res, $schemaid);
 edisdk_edifactreader_do_validate($res);

Remarks

The class allows you to parse an incoming EDI document. To parse a document, first, use LoadSchema to load a schema file into the class. Next, select the document you want to process by setting InputFile or InputData and calling Parse.

As the class processes the document, its events will fire and the contents of the document will be available in the Interchange, FunctionalGroup, Message, Segment, Element, and Component properties. The corresponding *Index properties can be thought of as a path within the document. For example, setting the MessageIndex property will cause the SegmentCount property to be updated with the number of segments within the selected message, and then the SegmentIndex property can be used to select one of the segments within that message.

To manage the amount of memory used during processing, the BuildDOM property can be used to select how much of the message will be available in the properties at once:

• bdEntireDocument - The entire document will be available at once.
• bdInterchange - Only the current interchange and its contents will be available.
• bdMessage - Only the current message will be available.
• bdNone - Only the current segment and its elements will be available.

During parsing, the class performs basic validation of the incoming document. If an error is encountered, the ValidateWarning event will fire.

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

AckType Property (EDISDK_EDIFACTReader Class)

Specifies the type of ACK that will be generated by GenerateAck .

Object Oriented Interface

public function getAckType();
public function setAckType($value);

Procedural Interface

edisdk_edifactreader_get($res, 1 );
edisdk_edifactreader_set($res, 1, $value );

Possible Values

EDIFACTREADER_ACKTYPE_FUNCTIONAL_CONTRL(0), 
EDIFACTREADER_ACKTYPE_TECHNICAL_CONTRL(1)

Default Value

0

Remarks

This setting specifies the type of ACK that will be generated when GenerateAck is called. Options include:

This property is not available at design time.

Data Type

Integer

BuildDOM Property (EDISDK_EDIFACTReader Class)

Controls how much of the document will be stored during parsing.

Object Oriented Interface

public function getBuildDOM();
public function setBuildDOM($value);

Procedural Interface

edisdk_edifactreader_get($res, 2 );
edisdk_edifactreader_set($res, 2, $value );

Possible Values

EDIFACTREADER_BUILDDOM_ENTIRE_DOCUMENT(0), 
EDIFACTREADER_BUILDDOM_INTERCHANGE(1), 
EDIFACTREADER_BUILDDOM_MESSAGE(2), 
EDIFACTREADER_BUILDDOM_NONE(3)

Default Value

0

Remarks

This property controls how much of the document will be stored in an internal model during parsing:

This property is not available at design time.

Data Type

Integer

ComponentDataType Property (EDISDK_EDIFACTReader Class)

The type of data contained in the element.

Object Oriented Interface

public function getComponentDataType();

Procedural Interface

edisdk_edifactreader_get($res, 3 );

Default Value

''

Remarks

The type of data contained in the element.

Possible values for EDIFACT include:

Possible values for X12 include:

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

Data Type

String

ComponentIsComposite Property (EDISDK_EDIFACTReader Class)

Specifies whether the element is a simple or composite element.

Object Oriented Interface

public function getComponentIsComposite();

Procedural Interface

edisdk_edifactreader_get($res, 4 );

Default Value

false

Remarks

Specifies whether the element is a simple or composite element. If true, the element is a composite element that contains other components.

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

Data Type

Boolean

ComponentMaxLen Property (EDISDK_EDIFACTReader Class)

For a simple element, this specifies the maximum length of the element according to the schema.

Object Oriented Interface

public function getComponentMaxLen();

Procedural Interface

edisdk_edifactreader_get($res, 5 );

Default Value

0

Remarks

For a simple element, this specifies the maximum length of the element according to the schema.

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

Data Type

Integer

ComponentMinLen Property (EDISDK_EDIFACTReader Class)

For a simple element, this specifies the minimum length of the element according to the schema.

Object Oriented Interface

public function getComponentMinLen();

Procedural Interface

edisdk_edifactreader_get($res, 6 );

Default Value

0

Remarks

For a simple element, this specifies the minimum length of the element according to the schema.

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

Data Type

Integer

ComponentSchemaDesc Property (EDISDK_EDIFACTReader Class)

The description of the element as specified in the schema.

Object Oriented Interface

public function getComponentSchemaDesc();

Procedural Interface

edisdk_edifactreader_get($res, 7 );

Default Value

''

Remarks

The description of the element as specified in the schema.

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

Data Type

String

ComponentSchemaName Property (EDISDK_EDIFACTReader Class)

The name of the element as specified in the schema.

Object Oriented Interface

public function getComponentSchemaName();

Procedural Interface

edisdk_edifactreader_get($res, 8 );

Default Value

''

Remarks

The name of the element as specified in the schema.

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

Data Type

String

ComponentValue Property (EDISDK_EDIFACTReader Class)

If the element is a simple element, this property contains its value.

Object Oriented Interface

public function getComponentValue();

Procedural Interface

edisdk_edifactreader_get($res, 9 );

Default Value

''

Remarks

If the element is a simple element, this field contains its value.

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

Data Type

String

ComponentCount Property (EDISDK_EDIFACTReader Class)

The number of classes in the current Element.

Object Oriented Interface

public function getComponentCount();

Procedural Interface

edisdk_edifactreader_get($res, 10 );

Default Value

0

Remarks

If the current Element is composite, this property contains the number of components within the element.

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

Data Type

Integer

ComponentIndex Property (EDISDK_EDIFACTReader Class)

The index of the current Class.

Object Oriented Interface

public function getComponentIndex();
public function setComponentIndex($value);

Procedural Interface

edisdk_edifactreader_get($res, 11 );
edisdk_edifactreader_set($res, 11, $value );

Default Value

1

Remarks

If the current Element is composite, this property is used to specify a Component within the element.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory. You can then use InterchangeIndex, FunctionalGroupIndex, MessageIndex, SegmentIndex, ElementIndex and ComponentIndex to navigate to a specific Component within the parsed document.

This property is not available at design time.

Data Type

Integer

DelimiterComponent Property (EDISDK_EDIFACTReader Class)

The character used to separate the classes in a composite element.

Object Oriented Interface

public function getDelimiterComponent();
public function setDelimiterComponent($value);

Procedural Interface

edisdk_edifactreader_get($res, 12 );
edisdk_edifactreader_set($res, 12, $value );

Default Value

':'

Remarks

The character used to separate the components in a composite element.

This property is not available at design time.

Data Type

String

DelimiterDecimal Property (EDISDK_EDIFACTReader Class)

The character used to separate the integer portion of a numeric value from the fractional portion.

Object Oriented Interface

public function getDelimiterDecimal();
public function setDelimiterDecimal($value);

Procedural Interface

edisdk_edifactreader_get($res, 13 );
edisdk_edifactreader_set($res, 13, $value );

Default Value

'.'

Remarks

The character used to separate the integer portion of a numeric value from the fractional portion.

This property is not available at design time.

Data Type

String

DelimiterElement Property (EDISDK_EDIFACTReader Class)

The delimiter used to separate elements within a segment.

Object Oriented Interface

public function getDelimiterElement();
public function setDelimiterElement($value);

Procedural Interface

edisdk_edifactreader_get($res, 14 );
edisdk_edifactreader_set($res, 14, $value );

Default Value

'+'

Remarks

The delimiter used to separate elements within a segment.

This property is not available at design time.

Data Type

String

DelimiterRelease Property (EDISDK_EDIFACTReader Class)

The character used to escape other characters within a property.

Object Oriented Interface

public function getDelimiterRelease();
public function setDelimiterRelease($value);

Procedural Interface

edisdk_edifactreader_get($res, 15 );
edisdk_edifactreader_set($res, 15, $value );

Default Value

'?'

Remarks

The character used to escape other characters within a field. For example, with the default EDIFACT delimiters, "?+" should be considered "+" character that appears within a field, not an element separator.

This property is not available at design time.

Data Type

String

DelimiterRepetition Property (EDISDK_EDIFACTReader Class)

The character used to indicate a repeating element or class.

Object Oriented Interface

public function getDelimiterRepetition();
public function setDelimiterRepetition($value);

Procedural Interface

edisdk_edifactreader_get($res, 16 );
edisdk_edifactreader_set($res, 16, $value );

Default Value

'*(syntax 4) or empty(syntax 3)'

Remarks

The character used to indicate a repeating element or component.

This property is not available at design time.

Data Type

String

DelimiterSegment Property (EDISDK_EDIFACTReader Class)

The character used to terminate a segment.

Object Oriented Interface

public function getDelimiterSegment();
public function setDelimiterSegment($value);

Procedural Interface

edisdk_edifactreader_get($res, 17 );
edisdk_edifactreader_set($res, 17, $value );

Default Value

'''

Remarks

The character used to terminate a segment.

This property is not available at design time.

Data Type

String

ElementDataType Property (EDISDK_EDIFACTReader Class)

The type of data contained in the element.

Object Oriented Interface

public function getElementDataType();

Procedural Interface

edisdk_edifactreader_get($res, 18 );

Default Value

''

Remarks

The type of data contained in the element.

Possible values for EDIFACT include:

Possible values for X12 include:

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

Data Type

String

ElementIsComposite Property (EDISDK_EDIFACTReader Class)

Specifies whether the element is a simple or composite element.

Object Oriented Interface

public function getElementIsComposite();

Procedural Interface

edisdk_edifactreader_get($res, 19 );

Default Value

false

Remarks

Specifies whether the element is a simple or composite element. If true, the element is a composite element that contains other components.

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

Data Type

Boolean

ElementMaxLen Property (EDISDK_EDIFACTReader Class)

For a simple element, this specifies the maximum length of the element according to the schema.

Object Oriented Interface

public function getElementMaxLen();

Procedural Interface

edisdk_edifactreader_get($res, 20 );

Default Value

0

Remarks

For a simple element, this specifies the maximum length of the element according to the schema.

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

Data Type

Integer

ElementMinLen Property (EDISDK_EDIFACTReader Class)

For a simple element, this specifies the minimum length of the element according to the schema.

Object Oriented Interface

public function getElementMinLen();

Procedural Interface

edisdk_edifactreader_get($res, 21 );

Default Value

0

Remarks

For a simple element, this specifies the minimum length of the element according to the schema.

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

Data Type

Integer

ElementSchemaDesc Property (EDISDK_EDIFACTReader Class)

The description of the element as specified in the schema.

Object Oriented Interface

public function getElementSchemaDesc();

Procedural Interface

edisdk_edifactreader_get($res, 22 );

Default Value

''

Remarks

The description of the element as specified in the schema.

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

Data Type

String

ElementSchemaName Property (EDISDK_EDIFACTReader Class)

The name of the element as specified in the schema.

Object Oriented Interface

public function getElementSchemaName();

Procedural Interface

edisdk_edifactreader_get($res, 23 );

Default Value

''

Remarks

The name of the element as specified in the schema.

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

Data Type

String

ElementValue Property (EDISDK_EDIFACTReader Class)

If the element is a simple element, this property contains its value.

Object Oriented Interface

public function getElementValue();

Procedural Interface

edisdk_edifactreader_get($res, 24 );

Default Value

''

Remarks

If the element is a simple element, this field contains its value.

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

Data Type

String

ElementCount Property (EDISDK_EDIFACTReader Class)

The number of elements in the current Segment.

Object Oriented Interface

public function getElementCount();

Procedural Interface

edisdk_edifactreader_get($res, 25 );

Default Value

0

Remarks

This property contains the number of elements in the current Segment.

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

Data Type

Integer

ElementIndex Property (EDISDK_EDIFACTReader Class)

The index of the current Element.

Object Oriented Interface

public function getElementIndex();
public function setElementIndex($value);

Procedural Interface

edisdk_edifactreader_get($res, 26 );
edisdk_edifactreader_set($res, 26, $value );

Default Value

1

Remarks

This property is used to specify an Element within the current Segment.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory. You can then use InterchangeIndex, FunctionalGroupIndex, MessageIndex, SegmentIndex and ElementIndex to navigate to specific Element within the parsed document.

This property is not available at design time.

Data Type

Integer

FGroupAppPassword Property (EDISDK_EDIFACTReader Class)

The application password as specified in the functional group header.

Object Oriented Interface

public function getFGroupAppPassword();
public function setFGroupAppPassword($value);

Procedural Interface

edisdk_edifactreader_get($res, 27 );
edisdk_edifactreader_set($res, 27, $value );

Default Value

''

Remarks

The application password as specified in the functional group header.

This is an alphanumeric field with a value up to 14 characters long.

This property is not available at design time.

Data Type

String

FGroupAppRecipientIdentification Property (EDISDK_EDIFACTReader Class)

The name or code of the intended recipient of the message group.

Object Oriented Interface

public function getFGroupAppRecipientIdentification();
public function setFGroupAppRecipientIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 28 );
edisdk_edifactreader_set($res, 28, $value );

Default Value

''

Remarks

The name or code of the intended recipient of the message group.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

FGroupAppRecipientIDQualifier Property (EDISDK_EDIFACTReader Class)

The qualifier for the recipient's identification (if it contains a code value).

Object Oriented Interface

public function getFGroupAppRecipientIDQualifier();
public function setFGroupAppRecipientIDQualifier($value);

Procedural Interface

edisdk_edifactreader_get($res, 29 );
edisdk_edifactreader_set($res, 29, $value );

Default Value

''

Remarks

The qualifier for the recipient's identification (if it contains a code value).

This is an alphanumeric field with a value up to 4 characters long.

This property is not available at design time.

Data Type

String

FGroupAppSenderIdentification Property (EDISDK_EDIFACTReader Class)

The name or code of the message group's sender.

Object Oriented Interface

public function getFGroupAppSenderIdentification();
public function setFGroupAppSenderIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 30 );
edisdk_edifactreader_set($res, 30, $value );

Default Value

''

Remarks

The name or code of the message group's sender.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

FGroupAppSenderIDQualifier Property (EDISDK_EDIFACTReader Class)

The qualifier for the sender's identification (if it contains a code value).

Object Oriented Interface

public function getFGroupAppSenderIDQualifier();
public function setFGroupAppSenderIDQualifier($value);

Procedural Interface

edisdk_edifactreader_get($res, 31 );
edisdk_edifactreader_set($res, 31, $value );

Default Value

''

Remarks

The qualifier for the sender's identification (if it contains a code value).

This is an alphanumeric field with a value up to 4 characters long.

This property is not available at design time.

Data Type

String

FGroupAssociationAssignedCode Property (EDISDK_EDIFACTReader Class)

The assigned code for the message type.

Object Oriented Interface

public function getFGroupAssociationAssignedCode();
public function setFGroupAssociationAssignedCode($value);

Procedural Interface

edisdk_edifactreader_get($res, 32 );
edisdk_edifactreader_set($res, 32, $value );

Default Value

''

Remarks

The assigned code for the message type.

This is an alphanumeric field with a value up to 6 characters long.

This property is not available at design time.

Data Type

String

FGroupControllingAgency Property (EDISDK_EDIFACTReader Class)

A code value that indicates the agency responsible for maintaining the message specifications.

Object Oriented Interface

public function getFGroupControllingAgency();
public function setFGroupControllingAgency($value);

Procedural Interface

edisdk_edifactreader_get($res, 33 );
edisdk_edifactreader_set($res, 33, $value );

Default Value

''

Remarks

A code value that indicates the agency responsible for maintaining the message specifications.

This is an alphanumeric field with a value up to 3 characters long.

This property is not available at design time.

Data Type

String

FGroupDate Property (EDISDK_EDIFACTReader Class)

The date that the group of messages was prepared.

Object Oriented Interface

public function getFGroupDate();
public function setFGroupDate($value);

Procedural Interface

edisdk_edifactreader_get($res, 34 );
edisdk_edifactreader_set($res, 34, $value );

Default Value

''

Remarks

The date that the group of messages was prepared.

This property is not available at design time.

Data Type

String

FGroupGroupIdentification Property (EDISDK_EDIFACTReader Class)

The identification value for the functional group.

Object Oriented Interface

public function getFGroupGroupIdentification();
public function setFGroupGroupIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 35 );
edisdk_edifactreader_set($res, 35, $value );

Default Value

''

Remarks

The identification value for the functional group.

This is an alphanumeric field with a value up to 6 characters long.

This property is not available at design time.

Data Type

String

FGroupMessageRelease Property (EDISDK_EDIFACTReader Class)

The message release number for the message type appearing in the message group.

Object Oriented Interface

public function getFGroupMessageRelease();
public function setFGroupMessageRelease($value);

Procedural Interface

edisdk_edifactreader_get($res, 36 );
edisdk_edifactreader_set($res, 36, $value );

Default Value

''

Remarks

The message release number for the message type appearing in the message group.

This is an alphanumeric field with a value up to 3 characters long.

This property is not available at design time.

Data Type

String

FGroupMessageVersion Property (EDISDK_EDIFACTReader Class)

The message version number for message type appearing in the functional group.

Object Oriented Interface

public function getFGroupMessageVersion();
public function setFGroupMessageVersion($value);

Procedural Interface

edisdk_edifactreader_get($res, 37 );
edisdk_edifactreader_set($res, 37, $value );

Default Value

''

Remarks

The message version number for message type appearing in the functional group.

This is an alphanumeric field with a value up to 3 characters long.

This property is not available at design time.

Data Type

String

FGroupReferenceNumber Property (EDISDK_EDIFACTReader Class)

The reference number for the functional group.

Object Oriented Interface

public function getFGroupReferenceNumber();
public function setFGroupReferenceNumber($value);

Procedural Interface

edisdk_edifactreader_get($res, 38 );
edisdk_edifactreader_set($res, 38, $value );

Default Value

''

Remarks

The reference number for the functional group.

This is an alphanumeric field with a value up to 14 characters long.

This property is not available at design time.

Data Type

String

FGroupTime Property (EDISDK_EDIFACTReader Class)

The time that the group of messages was prepared.

Object Oriented Interface

public function getFGroupTime();
public function setFGroupTime($value);

Procedural Interface

edisdk_edifactreader_get($res, 39 );
edisdk_edifactreader_set($res, 39, $value );

Default Value

''

Remarks

The time that the group of messages was prepared.

This property is not available at design time.

Data Type

String

FunctionalGroupCount Property (EDISDK_EDIFACTReader Class)

The number of FunctionalGroups in the current Interchange.

Object Oriented Interface

public function getFunctionalGroupCount();

Procedural Interface

edisdk_edifactreader_get($res, 40 );

Default Value

0

Remarks

This property contains the number of FunctionalGroups in the current Interchange.

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

Data Type

Integer

FunctionalGroupIndex Property (EDISDK_EDIFACTReader Class)

The index of the current FunctionalGroup.

Object Oriented Interface

public function getFunctionalGroupIndex();
public function setFunctionalGroupIndex($value);

Procedural Interface

edisdk_edifactreader_get($res, 41 );
edisdk_edifactreader_set($res, 41, $value );

Default Value

1

Remarks

This property is used to specify a FunctionalGroup within the current Interchange.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory, including all interchanges, and functional groups. You can then use InterchangeIndex and FunctionalGroupIndex to navigate to a specific FunctionalGroup within the parsed document.

This property is not available at design time.

Data Type

Integer

Group Property (EDISDK_EDIFACTReader Class)

Specifies the group to load segments from.

Object Oriented Interface

public function getGroup();
public function setGroup($value);

Procedural Interface

edisdk_edifactreader_get($res, 42 );
edisdk_edifactreader_set($res, 42, $value );

Default Value

''

Remarks

When this property is set, only segments from the specified group and iteration will be available through the Segment properties.

A path for a group consists of the name of the group followed by an index indicating the iteration, like this:

reader.Group = "CPSGroup[2]";

If the group is nested inside of another group, the parent and child are connected by a ".":

reader.Group = "CPSGroup[2].LINGroup[2]"; That can be repeated if a group is nested more than one level deep.

This property is not available at design time.

Data Type

String

InputData Property (EDISDK_EDIFACTReader Class)

The EDI message, specified as a string.

Object Oriented Interface

public function getInputData();
public function setInputData($value);

Procedural Interface

edisdk_edifactreader_get($res, 43 );
edisdk_edifactreader_set($res, 43, $value );

Default Value

''

Remarks

Set this property to specify the input EDI message as a string. The message can then be parsed with Parse.

This property is not available at design time.

Data Type

String

InputFile Property (EDISDK_EDIFACTReader Class)

The file containing the EDI message.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

edisdk_edifactreader_get($res, 44 );
edisdk_edifactreader_set($res, 44, $value );

Default Value

''

Remarks

Set this property to specify a file to read the input EDI message from. The message can then be parsed with Parse.

This property is not available at design time.

Data Type

String

InterchangeAckRequest Property (EDISDK_EDIFACTReader Class)

If this property is '1', an ACK was requested in response to this interchange.

Object Oriented Interface

public function getInterchangeAckRequest();
public function setInterchangeAckRequest($value);

Procedural Interface

edisdk_edifactreader_get($res, 45 );
edisdk_edifactreader_set($res, 45, $value );

Default Value

''

Remarks

If this field is '1', an ACK was requested in response to this interchange.

This property is not available at design time.

Data Type

String

InterchangeAgreementIdentifier Property (EDISDK_EDIFACTReader Class)

The identifier for the communication agreement used by the interchange.

Object Oriented Interface

public function getInterchangeAgreementIdentifier();
public function setInterchangeAgreementIdentifier($value);

Procedural Interface

edisdk_edifactreader_get($res, 46 );
edisdk_edifactreader_set($res, 46, $value );

Default Value

''

Remarks

The identifier for the communication agreement used by the interchange.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

InterchangeApplicationReference Property (EDISDK_EDIFACTReader Class)

If the interchange contains only one type of message, this can contain the identifier for the type of message.

Object Oriented Interface

public function getInterchangeApplicationReference();
public function setInterchangeApplicationReference($value);

Procedural Interface

edisdk_edifactreader_get($res, 47 );
edisdk_edifactreader_set($res, 47, $value );

Default Value

''

Remarks

If the interchange contains only one type of message, this can contain the identifier for the type of message.

This is an alphanumeric field with a value up to 14 characters long.

This property is not available at design time.

Data Type

String

InterchangeCharacterEncoding Property (EDISDK_EDIFACTReader Class)

The character encoding used by the interchange.

Object Oriented Interface

public function getInterchangeCharacterEncoding();
public function setInterchangeCharacterEncoding($value);

Procedural Interface

edisdk_edifactreader_get($res, 48 );
edisdk_edifactreader_set($res, 48, $value );

Default Value

''

Remarks

The character encoding used by the interchange.

This is an alphanumeric field with a value up to 3 characters long, and is only present for EDIFACT syntax 4.

This property is not available at design time.

Data Type

String

InterchangeCodeListVersionNumber Property (EDISDK_EDIFACTReader Class)

The identifier for the communication agreement used by the interchange.

Object Oriented Interface

public function getInterchangeCodeListVersionNumber();
public function setInterchangeCodeListVersionNumber($value);

Procedural Interface

edisdk_edifactreader_get($res, 49 );
edisdk_edifactreader_set($res, 49, $value );

Default Value

''

Remarks

The identifier for the communication agreement used by the interchange.

This is an alphanumeric field with a value up to 6 characters long.

This property is not available at design time.

Data Type

String

InterchangeDate Property (EDISDK_EDIFACTReader Class)

The date that the interchange was prepared.

Object Oriented Interface

public function getInterchangeDate();
public function setInterchangeDate($value);

Procedural Interface

edisdk_edifactreader_get($res, 50 );
edisdk_edifactreader_set($res, 50, $value );

Default Value

''

Remarks

The date that the interchange was prepared.

This property is not available at design time.

Data Type

String

InterchangeProcessingPriorityCode Property (EDISDK_EDIFACTReader Class)

A 1-character code that requests a specific processing priority for the interchange.

Object Oriented Interface

public function getInterchangeProcessingPriorityCode();
public function setInterchangeProcessingPriorityCode($value);

Procedural Interface

edisdk_edifactreader_get($res, 51 );
edisdk_edifactreader_set($res, 51, $value );

Default Value

''

Remarks

A 1-character code that requests a specific processing priority for the interchange.

This property is not available at design time.

Data Type

String

InterchangeRecipientIdentification Property (EDISDK_EDIFACTReader Class)

The identification for the interchange's recipient.

Object Oriented Interface

public function getInterchangeRecipientIdentification();
public function setInterchangeRecipientIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 52 );
edisdk_edifactreader_set($res, 52, $value );

Default Value

''

Remarks

The identification for the interchange's recipient.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

InterchangeRecipientIDQualifier Property (EDISDK_EDIFACTReader Class)

The qualifier for the recipient identification code.

Object Oriented Interface

public function getInterchangeRecipientIDQualifier();
public function setInterchangeRecipientIDQualifier($value);

Procedural Interface

edisdk_edifactreader_get($res, 53 );
edisdk_edifactreader_set($res, 53, $value );

Default Value

''

Remarks

The qualifier for the recipient identification code.

This is an alphanumeric field with a value up to 4 characters long.

This property is not available at design time.

Data Type

String

InterchangeRecipientInternalIdentification Property (EDISDK_EDIFACTReader Class)

More specific recipient identification for internal use.

Object Oriented Interface

public function getInterchangeRecipientInternalIdentification();
public function setInterchangeRecipientInternalIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 54 );
edisdk_edifactreader_set($res, 54, $value );

Default Value

''

Remarks

More specific recipient identification for internal use.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

InterchangeRecipientInternalSubIdentification Property (EDISDK_EDIFACTReader Class)

A sub-identification string for the receiver for internal use.

Object Oriented Interface

public function getInterchangeRecipientInternalSubIdentification();
public function setInterchangeRecipientInternalSubIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 55 );
edisdk_edifactreader_set($res, 55, $value );

Default Value

''

Remarks

A sub-identification string for the receiver for internal use.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

InterchangeRecipientPassword Property (EDISDK_EDIFACTReader Class)

A password to be verified by the recipient, such as a system or network password.

Object Oriented Interface

public function getInterchangeRecipientPassword();
public function setInterchangeRecipientPassword($value);

Procedural Interface

edisdk_edifactreader_get($res, 56 );
edisdk_edifactreader_set($res, 56, $value );

Default Value

''

Remarks

A password to be verified by the recipient, such as a system or network password.

This is an alphanumeric field with a value up to 14 characters long.

This property is not available at design time.

Data Type

String

InterchangeRecipientPasswordQualifier Property (EDISDK_EDIFACTReader Class)

A qualifier for the recipient password.

Object Oriented Interface

public function getInterchangeRecipientPasswordQualifier();
public function setInterchangeRecipientPasswordQualifier($value);

Procedural Interface

edisdk_edifactreader_get($res, 57 );
edisdk_edifactreader_set($res, 57, $value );

Default Value

''

Remarks

A qualifier for the recipient password.

This is an alphanumeric field with a value up to 2 characters long.

This property is not available at design time.

Data Type

String

InterchangeReferenceNumber Property (EDISDK_EDIFACTReader Class)

A reference number for the interchange.

Object Oriented Interface

public function getInterchangeReferenceNumber();
public function setInterchangeReferenceNumber($value);

Procedural Interface

edisdk_edifactreader_get($res, 58 );
edisdk_edifactreader_set($res, 58, $value );

Default Value

''

Remarks

A reference number for the interchange.

This is an alphanumeric field with a value up to 14 characters long.

This property is not available at design time.

Data Type

String

InterchangeSenderIdentification Property (EDISDK_EDIFACTReader Class)

The identification for the interchange's sender.

Object Oriented Interface

public function getInterchangeSenderIdentification();
public function setInterchangeSenderIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 59 );
edisdk_edifactreader_set($res, 59, $value );

Default Value

''

Remarks

The identification for the interchange's sender.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

InterchangeSenderIDQualifier Property (EDISDK_EDIFACTReader Class)

The qualifier for the sender identification code.

Object Oriented Interface

public function getInterchangeSenderIDQualifier();
public function setInterchangeSenderIDQualifier($value);

Procedural Interface

edisdk_edifactreader_get($res, 60 );
edisdk_edifactreader_set($res, 60, $value );

Default Value

''

Remarks

The qualifier for the sender identification code.

This is an alphanumeric field with a value up to 4 characters long.

This property is not available at design time.

Data Type

String

InterchangeSenderInternalIdentification Property (EDISDK_EDIFACTReader Class)

More specific sender identification for internal use.

Object Oriented Interface

public function getInterchangeSenderInternalIdentification();
public function setInterchangeSenderInternalIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 61 );
edisdk_edifactreader_set($res, 61, $value );

Default Value

''

Remarks

More specific sender identification for internal use.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

InterchangeSenderInternalSubIdentification Property (EDISDK_EDIFACTReader Class)

A sub-identification string for the sender for internal use.

Object Oriented Interface

public function getInterchangeSenderInternalSubIdentification();
public function setInterchangeSenderInternalSubIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 62 );
edisdk_edifactreader_set($res, 62, $value );

Default Value

''

Remarks

A sub-identification string for the sender for internal use.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

InterchangeSyntaxIdentifier Property (EDISDK_EDIFACTReader Class)

A identifier specifying the controlling agency and valid character set.

Object Oriented Interface

public function getInterchangeSyntaxIdentifier();
public function setInterchangeSyntaxIdentifier($value);

Procedural Interface

edisdk_edifactreader_get($res, 63 );
edisdk_edifactreader_set($res, 63, $value );

Default Value

''

Remarks

A identifier specifying the controlling agency and valid character set.

This is an alphanumeric field with a value up to 4 characters long.

This property is not available at design time.

Data Type

String

InterchangeSyntaxVersionNumber Property (EDISDK_EDIFACTReader Class)

A 1-character numeric value indicating the syntax version.

Object Oriented Interface

public function getInterchangeSyntaxVersionNumber();
public function setInterchangeSyntaxVersionNumber($value);

Procedural Interface

edisdk_edifactreader_get($res, 64 );
edisdk_edifactreader_set($res, 64, $value );

Default Value

''

Remarks

A 1-character numeric value indicating the syntax version.

This property is not available at design time.

Data Type

String

InterchangeTestIndicator Property (EDISDK_EDIFACTReader Class)

If this property is '1', the interchange is a test interchange.

Object Oriented Interface

public function getInterchangeTestIndicator();
public function setInterchangeTestIndicator($value);

Procedural Interface

edisdk_edifactreader_get($res, 65 );
edisdk_edifactreader_set($res, 65, $value );

Default Value

''

Remarks

If this field is '1', the interchange is a test interchange.

This property is not available at design time.

Data Type

String

InterchangeTime Property (EDISDK_EDIFACTReader Class)

The time that the interchange was prepared.

Object Oriented Interface

public function getInterchangeTime();
public function setInterchangeTime($value);

Procedural Interface

edisdk_edifactreader_get($res, 66 );
edisdk_edifactreader_set($res, 66, $value );

Default Value

''

Remarks

The time that the interchange was prepared.

This property is not available at design time.

Data Type

String

InterchangeCount Property (EDISDK_EDIFACTReader Class)

The number of Interchanges in the document.

Object Oriented Interface

public function getInterchangeCount();

Procedural Interface

edisdk_edifactreader_get($res, 67 );

Default Value

0

Remarks

This property contains the number of Interchanges in the current document.

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

Data Type

Integer

InterchangeIndex Property (EDISDK_EDIFACTReader Class)

The index of the current Interchange.

Object Oriented Interface

public function getInterchangeIndex();
public function setInterchangeIndex($value);

Procedural Interface

edisdk_edifactreader_get($res, 68 );
edisdk_edifactreader_set($res, 68, $value );

Default Value

1

Remarks

This property is used to specify an Interchange within the document.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory, including all interchanges. You can then use InterchangeIndex to navigate to specific Interchange within the parsed document.

This property is not available at design time.

Data Type

Integer

MsgAssociationAssignedCode Property (EDISDK_EDIFACTReader Class)

A code assigned to the message by the controlling organization.

Object Oriented Interface

public function getMsgAssociationAssignedCode();
public function setMsgAssociationAssignedCode($value);

Procedural Interface

edisdk_edifactreader_get($res, 69 );
edisdk_edifactreader_set($res, 69, $value );

Default Value

''

Remarks

A code assigned to the message by the controlling organization.

This is an alphanumeric field with a value up to 6 characters long.

This property is not available at design time.

Data Type

String

MsgCodeListVersionNumber Property (EDISDK_EDIFACTReader Class)

The version number of the code list that should be used.

Object Oriented Interface

public function getMsgCodeListVersionNumber();
public function setMsgCodeListVersionNumber($value);

Procedural Interface

edisdk_edifactreader_get($res, 70 );
edisdk_edifactreader_set($res, 70, $value );

Default Value

''

Remarks

The version number of the code list that should be used.

This is an alphanumeric field with a value up to 6 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgCommonAccessReference Property (EDISDK_EDIFACTReader Class)

A reference value to associate this message with related messages.

Object Oriented Interface

public function getMsgCommonAccessReference();
public function setMsgCommonAccessReference($value);

Procedural Interface

edisdk_edifactreader_get($res, 71 );
edisdk_edifactreader_set($res, 71, $value );

Default Value

''

Remarks

A reference value to associate this message with related messages.

This is an alphanumeric field with a value up to 35 characters long.

This property is not available at design time.

Data Type

String

MsgControllingAgency Property (EDISDK_EDIFACTReader Class)

A code that identifies the controlling agency for this message type.

Object Oriented Interface

public function getMsgControllingAgency();
public function setMsgControllingAgency($value);

Procedural Interface

edisdk_edifactreader_get($res, 72 );
edisdk_edifactreader_set($res, 72, $value );

Default Value

''

Remarks

A code that identifies the controlling agency for this message type.

This is an alphanumeric field with a value up to 3 characters long.

This property is not available at design time.

Data Type

String

MsgFirstAndLastTransfer Property (EDISDK_EDIFACTReader Class)

A single-character property that indicates the first and last messages in a related set.

Object Oriented Interface

public function getMsgFirstAndLastTransfer();
public function setMsgFirstAndLastTransfer($value);

Procedural Interface

edisdk_edifactreader_get($res, 73 );
edisdk_edifactreader_set($res, 73, $value );

Default Value

''

Remarks

A single-character field that indicates the first and last messages in a related set.

This property is not available at design time.

Data Type

String

MsgMessageImplControllingAgency Property (EDISDK_EDIFACTReader Class)

A code value that identifies the controlling agency for the message implementation.

Object Oriented Interface

public function getMsgMessageImplControllingAgency();
public function setMsgMessageImplControllingAgency($value);

Procedural Interface

edisdk_edifactreader_get($res, 74 );
edisdk_edifactreader_set($res, 74, $value );

Default Value

''

Remarks

A code value that identifies the controlling agency for the message implementation.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageImplIdentification Property (EDISDK_EDIFACTReader Class)

Identifies the message implementation.

Object Oriented Interface

public function getMsgMessageImplIdentification();
public function setMsgMessageImplIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 75 );
edisdk_edifactreader_set($res, 75, $value );

Default Value

''

Remarks

Identifies the message implementation.

This is an alphanumeric field with a value up to 14 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageImplRelease Property (EDISDK_EDIFACTReader Class)

Identifies the release number for the message implementation.

Object Oriented Interface

public function getMsgMessageImplRelease();
public function setMsgMessageImplRelease($value);

Procedural Interface

edisdk_edifactreader_get($res, 76 );
edisdk_edifactreader_set($res, 76, $value );

Default Value

''

Remarks

Identifies the release number for the message implementation.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageImplVersion Property (EDISDK_EDIFACTReader Class)

Identifies the version number for the message implementation.

Object Oriented Interface

public function getMsgMessageImplVersion();
public function setMsgMessageImplVersion($value);

Procedural Interface

edisdk_edifactreader_get($res, 77 );
edisdk_edifactreader_set($res, 77, $value );

Default Value

''

Remarks

Identifies the version number for the message implementation.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageRelease Property (EDISDK_EDIFACTReader Class)

Identifies the release number for the message.

Object Oriented Interface

public function getMsgMessageRelease();
public function setMsgMessageRelease($value);

Procedural Interface

edisdk_edifactreader_get($res, 78 );
edisdk_edifactreader_set($res, 78, $value );

Default Value

''

Remarks

Identifies the release number for the message.

This is an alphanumeric field with a value up to 3 characters long.

This property is not available at design time.

Data Type

String

MsgMessageSubsetControllingAgency Property (EDISDK_EDIFACTReader Class)

A code value that identifies the controlling agency for the message subset.

Object Oriented Interface

public function getMsgMessageSubsetControllingAgency();
public function setMsgMessageSubsetControllingAgency($value);

Procedural Interface

edisdk_edifactreader_get($res, 79 );
edisdk_edifactreader_set($res, 79, $value );

Default Value

''

Remarks

A code value that identifies the controlling agency for the message subset.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageSubsetIdentification Property (EDISDK_EDIFACTReader Class)

Identifies the message subset.

Object Oriented Interface

public function getMsgMessageSubsetIdentification();
public function setMsgMessageSubsetIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 80 );
edisdk_edifactreader_set($res, 80, $value );

Default Value

''

Remarks

Identifies the message subset.

This is an alphanumeric field with a value up to 14 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageSubsetRelease Property (EDISDK_EDIFACTReader Class)

Identifies the release number for the message subset.

Object Oriented Interface

public function getMsgMessageSubsetRelease();
public function setMsgMessageSubsetRelease($value);

Procedural Interface

edisdk_edifactreader_get($res, 81 );
edisdk_edifactreader_set($res, 81, $value );

Default Value

''

Remarks

Identifies the release number for the message subset.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageSubsetVersion Property (EDISDK_EDIFACTReader Class)

Identifies the version number for the message subset.

Object Oriented Interface

public function getMsgMessageSubsetVersion();
public function setMsgMessageSubsetVersion($value);

Procedural Interface

edisdk_edifactreader_get($res, 82 );
edisdk_edifactreader_set($res, 82, $value );

Default Value

''

Remarks

Identifies the version number for the message subset.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageType Property (EDISDK_EDIFACTReader Class)

A code identifying the message's type.

Object Oriented Interface

public function getMsgMessageType();
public function setMsgMessageType($value);

Procedural Interface

edisdk_edifactreader_get($res, 83 );
edisdk_edifactreader_set($res, 83, $value );

Default Value

''

Remarks

A code identifying the message's type.

This is an alphanumeric field with a value up to 6 characters long.

This property is not available at design time.

Data Type

String

MsgMessageTypeSubFunctionIdentification Property (EDISDK_EDIFACTReader Class)

A code identifying the sub-function of the message's type.

Object Oriented Interface

public function getMsgMessageTypeSubFunctionIdentification();
public function setMsgMessageTypeSubFunctionIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 84 );
edisdk_edifactreader_set($res, 84, $value );

Default Value

''

Remarks

A code identifying the sub-function of the message's type.

This is an alphanumeric field with a value up to 6 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgMessageVersion Property (EDISDK_EDIFACTReader Class)

Identifies the version number for the message.

Object Oriented Interface

public function getMsgMessageVersion();
public function setMsgMessageVersion($value);

Procedural Interface

edisdk_edifactreader_get($res, 85 );
edisdk_edifactreader_set($res, 85, $value );

Default Value

''

Remarks

Identifies the version number for the message.

This is an alphanumeric field with a value up to 3 characters long.

This property is not available at design time.

Data Type

String

MsgReferenceNumber Property (EDISDK_EDIFACTReader Class)

A unique reference number for the message.

Object Oriented Interface

public function getMsgReferenceNumber();
public function setMsgReferenceNumber($value);

Procedural Interface

edisdk_edifactreader_get($res, 86 );
edisdk_edifactreader_set($res, 86, $value );

Default Value

''

Remarks

A unique reference number for the message.

This is an alphanumeric field with a value up to 14 characters long.

This property is not available at design time.

Data Type

String

MsgScenarioControllingAgency Property (EDISDK_EDIFACTReader Class)

Identifies the controlling agency for the message scenario.

Object Oriented Interface

public function getMsgScenarioControllingAgency();
public function setMsgScenarioControllingAgency($value);

Procedural Interface

edisdk_edifactreader_get($res, 87 );
edisdk_edifactreader_set($res, 87, $value );

Default Value

''

Remarks

Identifies the controlling agency for the message scenario.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgScenarioIdentification Property (EDISDK_EDIFACTReader Class)

The identifier for the message scenario.

Object Oriented Interface

public function getMsgScenarioIdentification();
public function setMsgScenarioIdentification($value);

Procedural Interface

edisdk_edifactreader_get($res, 88 );
edisdk_edifactreader_set($res, 88, $value );

Default Value

''

Remarks

The identifier for the message scenario.

This is an alphanumeric field with a value up to 14 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgScenarioRelease Property (EDISDK_EDIFACTReader Class)

The message scenario's release number.

Object Oriented Interface

public function getMsgScenarioRelease();
public function setMsgScenarioRelease($value);

Procedural Interface

edisdk_edifactreader_get($res, 89 );
edisdk_edifactreader_set($res, 89, $value );

Default Value

''

Remarks

The message scenario's release number.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgScenarioVersion Property (EDISDK_EDIFACTReader Class)

The message scenario's version number.

Object Oriented Interface

public function getMsgScenarioVersion();
public function setMsgScenarioVersion($value);

Procedural Interface

edisdk_edifactreader_get($res, 90 );
edisdk_edifactreader_set($res, 90, $value );

Default Value

''

Remarks

The message scenario's version number.

This is an alphanumeric field with a value up to 3 characters long. This field only appears in EDIFACT syntax version 4.

This property is not available at design time.

Data Type

String

MsgSequenceOfTransfers Property (EDISDK_EDIFACTReader Class)

Specifies the message's position in a sequence.

Object Oriented Interface

public function getMsgSequenceOfTransfers();
public function setMsgSequenceOfTransfers($value);

Procedural Interface

edisdk_edifactreader_get($res, 91 );
edisdk_edifactreader_set($res, 91, $value );

Default Value

''

Remarks

Specifies the message's position in a sequence.

This is an alphanumeric field with a value up to 2 characters long.

This property is not available at design time.

Data Type

String

MessageCount Property (EDISDK_EDIFACTReader Class)

The number of message in the current Interchange or FunctionalGroup.

Object Oriented Interface

public function getMessageCount();

Procedural Interface

edisdk_edifactreader_get($res, 92 );

Default Value

0

Remarks

This property contains the number of messages in the current Interchange or FunctionalGroup.

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

Data Type

Integer

MessageIndex Property (EDISDK_EDIFACTReader Class)

The index of the current Message.

Object Oriented Interface

public function getMessageIndex();
public function setMessageIndex($value);

Procedural Interface

edisdk_edifactreader_get($res, 93 );
edisdk_edifactreader_set($res, 93, $value );

Default Value

1

Remarks

This property is used to specify a Message within the current Interchange or FunctionalGroup.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory, including all interchanges, functional groups, and messages. You can then use InterchangeIndex, FunctionalGroupIndex and MessageIndex to navigate to a specific Message within the parsed document.

This property is not available at design time.

Data Type

Integer

SegmentOptional Property (EDISDK_EDIFACTReader Class)

Specifies whether the segment is required or optional.

Object Oriented Interface

public function getSegmentOptional();

Procedural Interface

edisdk_edifactreader_get($res, 94 );

Default Value

false

Remarks

Specifies whether the segment is required or optional. If true, the element is optional.

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

Data Type

Boolean

SegmentPath Property (EDISDK_EDIFACTReader Class)

Contains the path to the segment, including the groups that the segment is contained in.

Object Oriented Interface

public function getSegmentPath();

Procedural Interface

edisdk_edifactreader_get($res, 95 );

Default Value

''

Remarks

Contains the path to the segment, including the groups that the segment is contained in.

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

Data Type

String

SegmentSchemaPath Property (EDISDK_EDIFACTReader Class)

Contains a numeric representation of the path to the segment, using the indexes within the schema, such as \\4[3]\\5[6]\\7[8] .

Object Oriented Interface

public function getSegmentSchemaPath();

Procedural Interface

edisdk_edifactreader_get($res, 96 );

Default Value

''

Remarks

Contains a numeric representation of the path to the segment, using the indexes within the schema, such as \4[3]\5[6]\7[8].

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

Data Type

String

SegmentTag Property (EDISDK_EDIFACTReader Class)

The tag of the segment, such as BGM , DTM , FTX , etc.

Object Oriented Interface

public function getSegmentTag();

Procedural Interface

edisdk_edifactreader_get($res, 97 );

Default Value

''

Remarks

The tag of the segment, such as BGM, DTM, FTX, etc.

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

Data Type

String

SegmentCount Property (EDISDK_EDIFACTReader Class)

The number of segments in the current Message.

Object Oriented Interface

public function getSegmentCount();

Procedural Interface

edisdk_edifactreader_get($res, 98 );

Default Value

0

Remarks

This property contains the number of elements in the current Message.

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

Data Type

Integer

SegmentIndex Property (EDISDK_EDIFACTReader Class)

The index of the current segment.

Object Oriented Interface

public function getSegmentIndex();
public function setSegmentIndex($value);

Procedural Interface

edisdk_edifactreader_get($res, 99 );
edisdk_edifactreader_set($res, 99, $value );

Default Value

1

Remarks

This property is used to specify a Segment within the current Message.

Note: When BuildDOM is set to bdentiredoc, after Parse is called the entire EDI document is parsed and stored in memory. You can then use InterchangeIndex, FunctionalGroupIndex, MessageIndex and SegmentIndex to navigate to specific Segment within the parsed document.

This property is not available at design time.

Data Type

Integer

ValidateOnParse Property (EDISDK_EDIFACTReader Class)

When True , the class will validate any documents it parses.

Object Oriented Interface

public function getValidateOnParse();
public function setValidateOnParse($value);

Procedural Interface

edisdk_edifactreader_get($res, 100 );
edisdk_edifactreader_set($res, 100, $value );

Default Value

false

Remarks

When this property is set to True, the class will perform validation on the document when Parse is called. The ValidateWarning event will fire for each error it encounters.

This property is not available at design time.

Data Type

Boolean

Config Method (EDISDK_EDIFACTReader Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GenerateAck Method (EDISDK_EDIFACTReader Class)

Generates an ACK in response to the most recently parsed message.

Object Oriented Interface

public function doGenerateAck();

Procedural Interface

edisdk_edifactreader_do_generateack($res);

Remarks

After parsing a message, call this method to generate an ACK that you can send back in response. The type of ACK generated can be controlled by setting the AckType property.

GetElementValue Method (EDISDK_EDIFACTReader Class)

Returns the value of the element or class at the specified path.

Object Oriented Interface

public function doGetElementValue($path);

Procedural Interface

edisdk_edifactreader_do_getelementvalue($res, $path);

Remarks

This method returns the value of the element at the specified path. The path starts at the current Message and consists of groups (with indexes to indicate the iteration), a segment tag, and 1-2 indexes to indicate the element or component.

For a simple element the path should include the path to a specific iteration of a group (as in the Group property), followed by a segment tag and an index for the element position within the segment, each separated by a ".":

reader.GetElementValue("CPSGroup[2].LINGroup[2].LIN.1");

When selecting a component of a composite element, the component index should be added after the element index:

reader.GetElementValue("CPSGroup[2].LINGroup[2].QTY.1.2");

LoadSchema Method (EDISDK_EDIFACTReader Class)

Loads schema information from a file or string data.

Object Oriented Interface

public function doLoadSchema($fileordata, $messagename);

Procedural Interface

edisdk_edifactreader_do_loadschema($res, $fileordata, $messagename);

Remarks

This method loads schema information for use when parsing, validating, and translating messages.

The FileOrData parameter can be set to the path of a file containing schema data, or can be set to the contents of a schema file directly.

MessageName can be set to the name of a specific message to load only the specified message's schema information. If left empty or set to "*", the entire schema will be loaded.

Parse Method (EDISDK_EDIFACTReader Class)

Parse the EDI document and fire parsing events.

Object Oriented Interface

public function doParse();

Procedural Interface

edisdk_edifactreader_do_parse($res);

Remarks

This method parses the input EDI document, firing the following events as it parses:

• StartInterchange
• StartFunctionalGroup
• ResolveSchema
• StartMessage
• StartGroup
• Segment
• EndGroup
• EndMessage
• EndFunctionalGroup
• EndInterchange

When multiple input sources are specified, only the highest-priority input will be used, in the following order:

1. SetInputStream
2. InputFile
3. InputData

Reset Method (EDISDK_EDIFACTReader Class)

Resets all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

edisdk_edifactreader_do_reset($res);

Remarks

This method resets all properties of the component to their default values as specified in the property definitions.

SchemaCode Method (EDISDK_EDIFACTReader Class)

Defines a code value within a list of codes.

Object Oriented Interface

public function doSchemaCode($schemaid, $codelistid, $value, $description);

Procedural Interface

edisdk_edifactreader_do_schemacode($res, $schemaid, $codelistid, $value, $description);

Remarks

Creates a schema definition for a code value within a particular list of codes.

This method can be used when defining a schema instead of loading one from a file.

SchemaCodeList Method (EDISDK_EDIFACTReader Class)

Defines a list of codes.

Object Oriented Interface

public function doSchemaCodeList($schemaid, $codelistid, $description);

Procedural Interface

edisdk_edifactreader_do_schemacodelist($res, $schemaid, $codelistid, $description);

Remarks

Creates a schema definition for an empty list of codes. SchemaCode can be used to add code values to the list.

This method can be used when defining a schema instead of loading one from a file.

SchemaComposite Method (EDISDK_EDIFACTReader Class)

Defines a composite element.

Object Oriented Interface

public function doSchemaComposite($schemaid, $compositeid, $description);

Procedural Interface

edisdk_edifactreader_do_schemacomposite($res, $schemaid, $compositeid, $description);

Remarks

Creates a schema definition for a composite element. SchemaElementRef can be used to add components to the element.

This method can be used when defining a schema instead of loading one from a file.

SchemaElement Method (EDISDK_EDIFACTReader Class)

Defines a simple element.

Object Oriented Interface

public function doSchemaElement($schemaid, $elementid, $datatype, $minlength, $maxlength, $codeid, $description);

Procedural Interface

edisdk_edifactreader_do_schemaelement($res, $schemaid, $elementid, $datatype, $minlength, $maxlength, $codeid, $description);

Remarks

Creates a schema definition for a simple element.

This method can be used when defining a schema instead of loading one from a file.

SchemaElementRef Method (EDISDK_EDIFACTReader Class)

Adds a reference to an element in a segment or composite element.

Object Oriented Interface

public function doSchemaElementRef($schemaid, $parentid, $elementid, $refid, $required, $maxcount);

Procedural Interface

edisdk_edifactreader_do_schemaelementref($res, $schemaid, $parentid, $elementid, $refid, $required, $maxcount);

Remarks

Adds a reference to an element to the specified parent, which can be the most recently defined segment or composite element.

This method can be used when defining a schema instead of loading one from a file.

SchemaEnd Method (EDISDK_EDIFACTReader Class)

Ends a schema definition.

Object Oriented Interface

public function doSchemaEnd();

Procedural Interface

edisdk_edifactreader_do_schemaend($res);

Remarks

Ends a schema definition when a schema is being defined manually instead of loaded from a file.

SchemaGroup Method (EDISDK_EDIFACTReader Class)

Defines a group of segments.

Object Oriented Interface

public function doSchemaGroup($schemaid, $grouppath, $groupid, $required, $maxcount);

Procedural Interface

edisdk_edifactreader_do_schemagroup($res, $schemaid, $grouppath, $groupid, $required, $maxcount);

Remarks

Creates a schema definition for a group of segments. SchemaSegmentRef can be used to add references to defined segments.

This method can be used when defining a schema instead of loading one from a file.

SchemaMessage Method (EDISDK_EDIFACTReader Class)

Defines a message.

Object Oriented Interface

public function doSchemaMessage($schemaid, $messageid, $description);

Procedural Interface

edisdk_edifactreader_do_schemamessage($res, $schemaid, $messageid, $description);

Remarks

Creates a schema definition for a message. SchemaSegmentRef and SchemaGroup can be used to add segment references and groups to the message.

This method can be used when defining a schema instead of loading one from a file.

SchemaSegment Method (EDISDK_EDIFACTReader Class)

Defines a segment.

Object Oriented Interface

public function doSchemaSegment($schemaid, $segmentid, $description);

Procedural Interface

edisdk_edifactreader_do_schemasegment($res, $schemaid, $segmentid, $description);

Remarks

Creates a schema definition for a segment. SchemaElementRef can be used to add component references to the segment.

This method can be used when defining a schema instead of loading one from a file.

SchemaSegmentRef Method (EDISDK_EDIFACTReader Class)

Adds a reference to a segment in a message or group.

Object Oriented Interface

public function doSchemaSegmentRef($schemaid, $segmentpath, $segmentid, $required, $maxcount);

Procedural Interface

edisdk_edifactreader_do_schemasegmentref($res, $schemaid, $segmentpath, $segmentid, $required, $maxcount);

Remarks

Adds a reference to a segment to the specified path.

This method can be used when defining a schema instead of loading one from a file.

SchemaStart Method (EDISDK_EDIFACTReader Class)

Starts a schema definition.

Object Oriented Interface

public function doSchemaStart($schemaid);

Procedural Interface

edisdk_edifactreader_do_schemastart($res, $schemaid);

Remarks

Starts manually defining a schema, as an alternative to loading one from a file.

Validate Method (EDISDK_EDIFACTReader Class)

Validate the EDI document and warn about any errors encountered.

Object Oriented Interface

public function doValidate();

Procedural Interface

edisdk_edifactreader_do_validate($res);

Remarks

This method parses the input EDI document, firing the ValidateWarning event for any non-blocking errors it encounters.

EndFunctionalGroup Event (EDISDK_EDIFACTReader Class)

Fires at the end of a functional group while parsing.

Object Oriented Interface

public function fireEndFunctionalGroup($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 1, array($this, 'fireEndFunctionalGroup'));

Parameter List

 'tag'
 'messagecount'
 'referencenumber'

Remarks

This event fires when the class encounters the end of a functional group while parsing a document.

EndGroup Event (EDISDK_EDIFACTReader Class)

Fires at the end of a group while parsing a message.

Object Oriented Interface

public function fireEndGroup($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 2, array($this, 'fireEndGroup'));

Parameter List

 'name'
 'schemaindex'

Remarks

This event fires when the class encounters the end of a group while parsing a message.

EndInterchange Event (EDISDK_EDIFACTReader Class)

Fires at the end of an interchange while parsing.

Object Oriented Interface

public function fireEndInterchange($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 3, array($this, 'fireEndInterchange'));

Parameter List

 'tag'
 'groupcount'
 'referencenumber'

Remarks

This event fires at the end of an interchange while parsing a document.

EndMessage Event (EDISDK_EDIFACTReader Class)

Fires at the end of a message while parsing.

Object Oriented Interface

public function fireEndMessage($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 4, array($this, 'fireEndMessage'));

Parameter List

 'tag'
 'segmentcount'
 'referencenumber'

Remarks

This event fires when the class encounters the end of a message while parsing a document.

Error Event (EDISDK_EDIFACTReader Class)

Fires when an error occurs during message processing. Normally, the class fails with an error.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

ConnectionId is the associated client Id, ErrorCode contains an error code, and Description 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 (EDISDK_EDIFACTReader Class)

Fires whenever a new EDIFACT message is encountered and no schema is found for it.

Object Oriented Interface

public function fireResolveSchema($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 6, array($this, 'fireResolveSchema'));

Parameter List

 'messageversion'
 'messagetype'

Remarks

This method fires when the class encounters an EDIFACT message it has not loaded a schema for. The parameters of the event can be used to locate the correct schema and load it with LoadSchema.

MessageVersion - The EDIFACT version of the message, such as D97A.

MessageType - The type of message, such as INVOIC.

After the event fires, if the class still doesn't have a matching schema, then it will attempt schema-less parsing of the EDIFACT message.

Segment Event (EDISDK_EDIFACTReader Class)

Fires at the end of a Segment while parsing.

Object Oriented Interface

public function fireSegment($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 7, array($this, 'fireSegment'));

Parameter List

 'tag'
 'schemapath'
 'optional'
 'elementcount'
 'schemaindex'
 'segmentindex'
 'maxcount'
 'path'

Remarks

Fires at the end of a Segment while parsing a document

StartFunctionalGroup Event (EDISDK_EDIFACTReader Class)

Fires at the beginning of a functional group while parsing.

Object Oriented Interface

public function fireStartFunctionalGroup($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 8, array($this, 'fireStartFunctionalGroup'));

Parameter List

 'tag'
 'appsenderidentification'
 'apprecipientidentification'
 'datetime'
 'referencenumber'

Remarks

This event fires when the class encounters the start of a functional group while parsing a document.

StartGroup Event (EDISDK_EDIFACTReader Class)

Fires at the beginning of a group while parsing a message.

Object Oriented Interface

public function fireStartGroup($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 9, array($this, 'fireStartGroup'));

Parameter List

 'name'
 'schemaindex'
 'maxcount'
 'path'

Remarks

This event fires when the class encounters the start of a group while parsing a message.

StartInterchange Event (EDISDK_EDIFACTReader Class)

Fires at the beginning of an interchange while parsing.

Object Oriented Interface

public function fireStartInterchange($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 10, array($this, 'fireStartInterchange'));

Parameter List

 'tag'
 'syntaxidentifier'
 'syntaxversion'
 'senderidentification'
 'recipientidentification'
 'datetime'
 'referencenumber'

Remarks

This event fires at the beginning of an interchange while parsing a document.

StartMessage Event (EDISDK_EDIFACTReader Class)

Fires at the beginning of a message while parsing.

Object Oriented Interface

public function fireStartMessage($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 11, array($this, 'fireStartMessage'));

Parameter List

 'tag'
 'messagerelease'
 'messagetype'
 'referencenumber'
 'schemaloaded'

Remarks

This event fires when the class encounters the start of a message while parsing a document.

ValidateWarning Event (EDISDK_EDIFACTReader Class)

Fires to warn about validation errors.

Object Oriented Interface

public function fireValidateWarning($param);

Procedural Interface

edisdk_edifactreader_register_callback($res, 12, array($this, 'fireValidateWarning'));

Parameter List

 'position'
 'line'
 'column'
 'errorcode'
 'errormessage'
 'errortype'

Remarks

When the class encounters a non-blocking error while validating a document, this event fires with information about the error.

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.

EDIFACTReader Config Settings

Trappable Errors (EDIFACTReader Class)

EDIFACTReader Errors