On this Page:

Tagged Values on UN/EDIFACT Classes

<<EDIFACTInterchange>> and <<X12Interchange>>

Tagged ValueValueDescriptionValues/Example
composeEmptyAttributestrue/false

Builder 6.0.17.1If set to true on composing an Edifact or X12 document, the EDIFACT Adapter will write delimiters for all empty attributes. If set to false, no delimiters will be written for empty attributes.

If this tagged value is not set, the Runtime will assume a default value true.

  • All models with EDIFACT/X12 definitions imported before Builder 6.0.17.1, where this tagged value is not present, will use the Runtime default.
    To change this tagged value, you can change the tagged value in the import file to false, or re-import the EDIFACT/X12 definition. The importer then will automatically set this value to false.
  • All models with EDIFACT/X12 definitions imported with Builder 6.0.17.1 or later will have this value set to false. You then can change the tagged value in the import file to true.
trueWrite delimiters for empty attributes.
falseOmit empty attributes.Omit empty attributes.
releaseCharacterany single characterIf, on composing an Edifact document, an attribute value contains a reserved character, the EDIFACT Composer adds the releaseCharacter in front of each reserved character. EDIFACT Parser removes the releaseCharacter from the input.
A list of reserved characters can be defined in tagged value reservedCharacters (see below).
releaseCharacter="?"
reservedCharactersArray of character

List of special characters that need to be escaped by a releaseCharacter (see above). On composing, a release character will be added in front of each reserved character. While parsing, the release character will be removed.

All segmentTerminator, component-DataElementSeparator, dataElementSeparator and releaseCharacter must be marked as reserved characters.

reservedCharacters= "", ":", "+", "?"
segmentTerminatorany StringDelimiter in between segments, default is "~" (tilde sign) for X12 and "'" (tick mark) for EDIFACT.segmentTerminator= "<newline>"

<<EDIFACTMessage>> and <<X12Transaction>>

Any Interchange record contains meta data about the record, like the optional UNA segment or the trailing UNB, UNG or UNZ segments. In between these segments, the message content is defined.
The introduction to the message content is virtual object Message with stereotype <<EDIFACTMessage>>. This object has no representation within the EDIFACT message string and is created by its triggeringSegment . The behavior is similar to <<EDIFACTFunctionGroup>> (see below).

Tagged ValueValueDescriptionExample
triggeringSegmentany StringSegment identification to create an instance of the EDIFACT message. On compose, the message is only created, if a segment with the correct identification is delivered. If it is missing, no message element will be created.triggeringSegment="UNH"

<<EDIFACTFunctionGroup>> and <<X12FunctionGroup>>

Logical grouping element without representation within the UN/EDIFACT interchange. Groups UN/EDIFACT messages of one type for multiplicity occurrence within the UN/EDIFACT interchange.

Tagged ValueValueDescriptionExample
triggeringSegmentany StringSegment identification to create an instance of the <<EDIFACTSegmentGroup>>. On compose, the segment group is only created if a segment with the correct identification is delivered. If it is missing, no segment group will be created.triggeringSegment="UNH"

<<EDIFACTSegmentGroup>> and <<X12Loop>>

Logical grouping element without representation within the UN/EDIFACT interchange. Groups two or more segments for multiplicity occurrence within the UN/EDIFACT interchange.

Tagged ValueValueDescriptionExample
parseMacro{macro expression}

parseMacro is executed on parsing a EDIFACT Message. A macro can contain multiple commands that have to be separated by commas or spaces. For details on macro commands see: Macro Expression.

GetCounter(0)
composeMacro

composeMacro is executed on composing a EDIFACT message. A macro can contain multiple commands that have to be separated by commas or spaces. For details on macro commands see: Macro Expression.

triggeringSegmentany StringSegment identification to create an instance of the <<EDIFACTSegmentGroup>>. On compose, the segment group is only created if a segment with the correct identification is delivered. If it is missing no segment group will be created.

<<EDIFACTSegment>> and  <<X12Segment>>

Segment element within EDIFACT structure.

Tagged ValueValueDescriptionExample
parseMacro{macro expression}The page XBRIDGE2:@self was not found  -- Please check/update the page name used in the MultiExcerpt-Include macroGetCounter(0)
composeMacroThe page XBRIDGE2:@self was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro
dataElementSeparatorany single characterdelimiter in between elements, default is "*" for X12 and "+" for EDIFACTdataElementSeparator= "*"
suppressEscapingtrue/falseSwitch for enable or disable escaping.suppressEscaping= false

<<EDIFACTCompositeDataElement>> and <<X12CompositeDataElement>>

A EDIFACT segment has one or more data elements. A data element may consist of a single data item, e.g. "2310 Delivery month" in which case it is called a simple data element, or it may consist of several data items, e.g. the composite data element "C198 PRODUCT IDENTIFICATION" which consists of two data elements, 7020 Article Number and 7823 Article Number Qualifier. In this case it is called a composite data element and is modeled with <<EDIFACTCompositeDataElement>>.

Tagged ValuesValueDescriptionExample
parseMacro{macro expression}The page XBRIDGE2:@self was not found  -- Please check/update the page name used in the MultiExcerpt-Include macroGetCounter(0)
composeMacroThe page XBRIDGE2:@self was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro
dataElementSeparatorany single characterdelimiter in between complex elements, default is ":" for X12 and EDIFACTdataElementSeparator= ":"
suppressEscapingtrue/falseSwitch for enable or disable escaping.suppressEscaping= false

<<EDIFACTServiceStringAdvice>>

For class UNA, a special stereotype <<EDIFACTServiceStringAdvice>> is defined. The reason is, that the class UNA must be position based instead of delimited. The ISA class has the analogous meaning for X12 messages.  
Tagged Values: none

UN/EDIFACT Association Ends

Association End Specifications

SettingDescriptionExample
Namegiven name to reference the Association to the child elementUNG
Multiplicitydeclare the possible multiplicity of an associated element.0..*
Visibilitydeclares the visibility of the associated Classpublic
Navigabledefines if the Class on the association end is navigabletrue
Is Uniquedeclares the association name to be uniquetrue

Tagged Values

<<FlatFileRecord>>

Tagged ValueValueDescriptionExample

order

any Integer

define the order within the associations. The order is taken for composing and parsing.

This tagged value is mandatory.

 order=1

<<FlatFileSubRecord>>

Tagged ValueValueDescriptionExample
evaluationOrderany Integerdefine the order for checking all conditions on the source class element.evaluationOrder=1

UN/EDIFACT Adapter Actions

Tagged Values

NameMandatoryDescriptionAllowed Values
action(tick)Specify the action of the adapter: parse or compose.composeCompose a file or file blob from a given EDI data structure.
parseParse an EDI file or file blob to an EDI data structure.
alias
Specify an alias that links to an input file defined in the component diagram.a valid <<FileAlias>>

Parameters Action "parse"

NameTypeDirectionMandatoryDescriptionAllowed ValuesExample
nameStringin((tick))Specify a full path to an EDI File containing a UN/EDIFACT or X12 message.
Alternatively, you can parse EDI data from a Blob object (see parameter data). Note, that the name parameter takes priority over data.

tmp/myFile.txt
dataBlobin((tick))Provide the EDI data to be parsed.
Alternatively, you can specify a path to an EDI File in the file system (see parameter name). Note, that the name parameter takes priority over data.



encodingStringin
Provide the encoding of the EDI data to be parsed as specified in the Charset Definitions appendix.any valid encoding (see Charset Definitions)UTF-8
defaultISO-8859-1 (Latin1)
localeNumbersLocalein
Specify how number values will be treated, when parsed from the EDI data (decimal point, currency symbol, ...). You can overwrite the system locales here, if the file was written with divergent locales. Refer to Number Formatting for more information.defaultsystem locales
<any>Any
<<EDIFACTInterchange>>
<<X12 Interchange>>
out(tick)The adapter returns a parsed EDI object. The class defining the type of this object should have stereotype <<EDIFACTInterchange>>  or <<X12 Interchange>>.


Parameters Action "compose"

NameTypeDirectionMandatoryDescriptionAllowed ValuesExample
<any>Any
<<EDIFACTInterchange>>
<<X12 Interchange>>
in(tick)Provide an object containing the EDI data. The class defining the type of this object should have stereotype <<EDIFACTInterchange>>  or <<X12 Interchange>>.


encodingStringin
Provide the encoding of the EDI data to be composed as specified in the Charset Definitions appendix.any valid encoding (see Charset Definitions)UTF-8
defaultISO-8859-1 (Latin1)
localeNumbersLocalein
Specify how number values will be treated, when composed to the EDI data (decimal point, currency symbol, ...). You can overwrite the system locales here, if the file was written with divergent locales. Refer to Number Formatting for more information.defaultsystem locales
nameStringin((tick))Specify a full path to a file, if you want to write the <<EDIFACTInterchange>>  or <<X12 Interchange>> object to the file system.
Alternatively, you can compose the EDI data to a Blob object (see parameter data). Note, that the name parameter takes priority over data.

tmp/myFile.txt
dataBlobout((tick))If you want to compose the  <<EDIFACTInterchange>>  or <<X12 Interchange>> object to a Blob object, use this parameter as output of the compose action.
Alternatively, you can write the composed EDI data directly to the file system (see parameter name). Note, that the name parameter takes priority over data.



  • No labels