Framework EDI Reference. Methods and Properties
ediSchema. TriggerSegmentReference

Reference a data segment definition in the ASC/X12 Transaction Set or UN/EDIFACT Message table based on the value of the data element that is read from or assigned to the subject document.

Syntax:

• <lRetVal> = object.TriggerSegmentReference (<sTransactionSetID>, <lTableArea>, <sLoopSection>, <sSegmentId>, <lElementPosition>, <lSubElementPosition>, <sElementValue>, < lTargetRelativePosition >, <vLoopId>)

Parameters:

• sTransaction Set ID – Identifier of ASC/X12 Transaction Set or UN/EDIFACT Message of data segment reference.
• lTableArea – The area or table number of the segment reference in the transaction set/message.
• sLoopSection – The loop section of the segment reference. The loop section describes all loops that nests a segment reference beginning from the segment ID of lowest (outermost) loop and ending with the immediate loop, all separated by semi-colon. Example, a segment reference N4 that is in the immediate loop N1 which is in the immediate loop PO1 will have the loop section definition PO4;N1.
• sSegmentId – Identifier of the segment reference.
• lElementPosition – Data element position within the segment reference that contain the value.
• lSubElementPosition – If the previous element position describes the position of a composite element then this sub element position is the position of a component element within the composite element that contain the value.
• sElementValue – The value of the data element that will trigger a reference to an alternate segment definition.
• lTargetRelativePosition  – Relative position of the segment definition that is to be referenced if the element value is encountered.  The position of the first definition is 1 and increases incrementally by one for each successive alternate definitions.
• vLoopId – Optional.  Loop ID of the segment reference.

Returns:

Returns 1 if successful; otherwise 0 if unsuccessful.

Remarks:

This method allows an alternate segment definition to be reference if a specific value is encountered from or assigned to the document.  For example, consider the following segment definitions in ASC/X12 Transaction Set 276 at position 100:

There are 2 segment definitions for data segment at position 100, the first is defined to be mandatory and the second is optional.  If the following conditions are to be implemented:

• If the first element of segment REF has value 1K then use the segment definition at relative position 1.
• If the first element of segment REF has value BLT then use the segment definition at relative position 2.

then TriggerSegmentReference is stated as follows:

Dim oSef As Fredi.ediSchema

:

oSef.TriggerSegmentReference "276", 2, "HL;TRN", "REF", 1, 0, "1K", 1, "2200D"
oSef.TriggerSegmentReference "276", 2, "HL;TRN", "REF", 1, 0, "BLT", 2, "2200D"

The alternate segment definitions can be included in the SEF file under the .PRIVATE EDIdEv section so that the definitions do not have to be written into your program.  The syntax of the definitions in the SEF file have the same order of parameters as the TriggerSegmentReference method, separated by the forward-slash. e.g. .SEGMENT1 276/2/HL;TRN/REF/1/0/1K/1/2200D.

Each alternate segment definitions must have the following properties identical to the first definition:

• Loop Section
• Segment Identifier
• Segment Position
• Loop Tag
• Area/Table

If trigger segment definitions are stated both in the SEF file and in the program, the trigger segment definitions in the program overrides the definitions in the SEF file.

Example:

oSef.TriggerSegmentReference "276", 2, "HL;TRN", "REF", 1, 0, "1K", 1, "2200D"
oSef.TriggerSegmentReference "276", 2, "HL;TRN", "REF", 1, 0, "BLT", 2, "2200D"
oSef.TriggerSegmentReference "276", 2, "HL;TRN", "REF", 1, 0, "EA", 3, "2200D"
oSef.TriggerSegmentReference "276", 2, "HL;TRN", "REF", 1, 0, "1K", 1, "2200E"
oSef.TriggerSegmentReference "276", 2, "HL;TRN", "REF", 1, 0, "BLT", 2, "2200E"
oSef.TriggerSegmentReference "276", 2, "HL;TRN", "REF", 1, 0, "EA", 3, "2200E"
Set oAck = oEdiDoc.GetAcknowledgment
oAck.EnableFunctionalAcknowledgment = True
oAck.MapDataElementLevelError 13209, 5
oEdiDoc.LoadEdi sEdiFile
oAck.Save spath & sAckfile

The equivalent of the above trigger segment definition in a SEF file:

.SEGMENT1 276/2/HL;TRN/REF/1/0/1K/1/2200D
.SEGMENT2 276/2/HL;TRN/REF/1/0/BLT/2/2200D
.SEGMENT3 276/2/HL;TRN/REF/1/0/EA/3/2200D
.SEGMENT4 276/2/HL;TRN/REF/1/0/1K/1/2200E
.SEGMENT5 276/2/HL;TRN/REF/1/0/BLT/2/2200E
.SEGMENT6 276/2/HL;TRN/REF/1/0/EA/3/2200E