EDI Adapter Properties

Adapter properties are the same for both Data Interchange Format (DIF), Super Data Interchange Format (SDI), and Symbolic Link Format (SLK) adapters.

Adapter Name in URL

EDI

Property Name
Name in URL
Description
Line separator
newline
Used when converting EDI to XML, and XML to EDI when the Add linefeeds between segments on write property (eol) is set to yes. The default is crlf. See Line Separator Values for a list of values.
Encoding
encoding
The encoding for the input file when it is not XML; or the encoding for the output file when it is not XML. The default is
utf-8.
Enable validation
val
Validates the XML against the structure in the relevant EDI dictionary. An error is generated if the EDI dialect (EDIFACT, X12, for example) isn't recognized; an error is also generated if the dialect is recognized, but the message type isn't. Missing mandatory segments, or segments not specified for a particular group will also generate errors. Consider leaving this option on (Yes, the default). If this option is off (No), the adapter is unable to synchronize its position within the EDI dictionary, preventing nested loops from being generated with the output. When possible, leave this property set to Yes and ensure that the EDI input conforms to the specification.
Comment code list data
decode
Adds to each code that is looked up in a table a comment that explains the code's value. For example, <!--Production Data--> in the following code:
<ISA15><!--I14: Interchange Usage Indicator-->P<!--Production Data--></ISA15>
Turn off this and Comment element types (field) to disable all comment generation.
Comment element types
field
Creates a comment at the start of each element that includes the element's name and number. For example, <!--I14: Interchange Usage Indicator--> in the following code:
<ISA15><!--I14: Interchange Usage Indicator-->P<!--Production Data--></ISA15>
Turn off this and Comment code list (decode) to disable all comment generation.
Strict validation on value lengths
len
Checks each value against the upper and lower length limits defined in the EDI specification.
Strict segment-ordering checking
seg
Relaxes the rules that require that segments come in the specified order. However, if this property is off (No), some looping constructs might break, resulting in data being grouped in correctly.
Force error if value not in code list
tbl
Generates an error if the value for an element is not in the codelist associated with that element. If this property is off (No), values are not checked for the presence of a codelist.
Strict datatype content checking
typ
Ensures that only characters that are appropriate for a given field are included in the value for that field. For example, this property ensures that dates are valid and numbers are well-formed.
Treat all segments as optional
opt
If set to Yes (No is the default), Stylus Studio assumes that all segments are optional. This property can be useful if your provider declines to provide segments that are considered mandatory according to the EDI specification, but you are aware of what the missing values are.
This property is not used if Enable validation (val) is set to Yes.
Add linefeeds between segments on write
eol
Allows you to put each segment on its own line when converting XML to EDI. (Extra linefeeds are ignored when converting EDI to XML.) If this property is set to Yes (the default), the value specified in the Line separator (newline) property is used to separate each segment. The normal segment output character is also generated.
Namespace prefix
prefix
Namespace prefix to be added, with the Namespace URI, to the root element. The prefix alone is added to all elements.
Namespace URI
uri
Namespace URI to be added, with the Namespace prefix, to the root element. If the prefix is set, but the URI is not, the prefix is ignored.
Loop element name
loop
Used to change the group element name. By default, segment loops are wrapped in <GROUP_#> elements, where # denotes the segment group number. The loop element name can be any valid element name, with the following exceptions for these characters:
# - the segment group number is used instead.
$ - the name of the first segment of the group is inserted into the element name instead.
@ - the portion of the loop element name before the @ symbol is used as the element name. If nothing occurs before the @ symbol, GROUP is used, and the portion after, if any, is used as the attribute name. The attribute value is the group number or the first segment name within the group, depending on whether a # or $ is within the attribute name.
Table 155. Properties for EDI Adapters

 
Free Stylus Studio XML Training: