|
|
Home >
Online Product Documentation >
Table of Contents >
Properties Reference
Properties Reference
This section provides reference information for input file properties displayed in the
Properties window. It covers the following topics:
Input File Properties
|
Property
|
Description
|
Editable
|
Affects XML
|
|
Input File
|
The URL of the file you are using as the input file.
|
Yes. You can select a new input file from this field.
|
No
|
|
Input Encoding
|
Encoding detected by Stylus Studio.
|
Yes
|
No
|
|
Physical Size
|
The size of the input file in bytes.
|
No
|
No
|
|
Portion Loaded
|
The size of the input file in bytes loaded into Stylus Studio.
|
No
|
No
|
|
Characters Loaded
|
The number of characters loaded. For especially large files, Stylus Studio does not read the entire file as only a sample is required to define a converter. The finished converter, however, reads any file you open it with in its entirety.
|
No
|
No
|
|
Character Unicode Value
|
The Unicode value of the character under the cursor.
|
No
|
No
|
|
Root Element Name
|
The name you want to assign to the root element in the XML output. Optional.
|
Yes
|
Yes
|
|
Namespace Prefix
|
The string you want to use for the namespace prefix in the XML output. Optional
|
Yes
|
Yes
|
|
Output Encoding
|
The Encoding you want to use for the XML output by the converter. The default is RAW.
|
Yes
|
Yes
|
|
Indent XML?
|
Whether or not you want to indent the XML output.
|
Yes
|
Yes
|
Table 22. Input File Properties
XML Output File Properties
|
Property
|
Description
|
Editable
|
Affects XML
|
|
XML Output URL
|
The URL to which you want the XML output when the converter is run. Optional. If no value is specified, stdout is used.
|
Yes
|
Yes
|
|
Root Element Name
|
The name you want to assign to the root element in the XML output. Optional.
|
Yes
|
Yes
|
|
Namespace Prefix
|
The string you want to use for the namespace prefix in the XML output. Optional
|
Yes
|
Yes
|
|
Namespace
|
The namespace you want to use for the XML document output by the converter.
|
Yes
|
Yes
|
|
Output Encoding
|
The Encoding you want to use for the XML output by the converter. The default is RAW.
|
Yes
|
Yes
|
|
DOCTYPE System ID
|
The URL of the System DTD you want to associate with the XML document output by the converter.
|
Yes
|
Yes
|
|
DOCTYPE Public ID
|
The Public ID of the DTD you want to associate with the XML document output by the converter.
|
Yes
|
Yes
|
|
XML Schema Document
|
The URL of the XML Schema document you want to associate with the XML document output by the converter.
|
Yes
|
Yes
|
|
XML Schema Namespace
|
The namespace you want to use with the XML Schema document.
|
Yes
|
Yes
|
|
Indent XML?
|
Whether or not you want to indent the XML output.
|
Yes
|
Yes
|
Table 23. XML Output File Properties
Region Properties
|
Note
|
|
Each region has its own field and row properties. In addition, some properties apply only to line-oriented regions. These properties are marked with an asterisk.
|
|
Property
|
Description
|
Editable
|
Affects XML
|
|
Region Type
|
The type of the region that currently has focus.
|
Yes. You can change the region type from this field.
|
No
|
|
Region Element Name
|
The name you want to assign to this region in the XML output. Optional.
|
Yes
|
Yes
|
|
Element Name Source
|
Whether the source for the element names in this region is user-supplied, is taken from the first row in the region, or is based on the WS-EDI standard.
|
Yes
|
Yes
|
|
Rows to Skip
|
The number of rows, starting at the beginning of the region, you want to omit from output.
|
Yes
|
Yes
|
|
Omit from Output
|
Whether or not you want to omit the entire region from output.
|
Yes
|
Yes
|
|
Size
|
The region's size in characters.
|
No
|
No
|
|
Portion of File
|
The starting and ending offsets of the current region.
|
No
|
No
|
|
Row Count
|
The number of rows in the current region.
|
No
|
No
|
|
Row Length
+
|
The number of characters in the current row.
|
No
|
No
|
|
Line Terminator*
|
The type of line terminator character detected by Stylus Studio.
|
Yes
|
No
|
|
Separator*
|
The type of field separator character detected by Stylus Studio.
|
Yes
|
No
|
|
Delimiter Pairs*
|
Sets of delimiting characters detected by Stylus Studio.
|
Yes
|
No
|
|
Comment String
|
String used by the Convert to XML adapter - if the beginning of a row matches the string in this field, the adapter interprets the row as a comment and does not output it in the XML.
|
Yes
|
Yes
|
|
Escape Characters*
|
Allows you to distinguish escape characters from separators - if a character in the input file is preceded by an Escape Character, that character is not treated as delimiting character, separator, or subsequent escape character.
|
Yes
|
Yes
|
|
Toss Characters*
|
Characters outside delimiting characters that should be ignored.
|
Yes
|
Yes
|
|
Key=Value Character
|
Allows you to set the separator for key=value pairs as seen in the input file.
|
Yes
|
Yes
|
|
Component Separator*
|
The type of character used to separate sub-fields detected by Stylus Studio. If this character appears in a string, the string is split into sub-fields when the input file is converted to XML.
|
Yes
|
Yes
|
|
Sub-Component Separator*
|
The type of character used to separate sub-fields detected by Stylus Studio. If this character appears in a string, the string is split into sub-fields when the input file is converted to XML.
|
Yes
|
Yes
|
|
Region Terminator
|
The type of region terminator character detected by Stylus Studio.
|
Yes
|
No
|
|
Collapse Consecutive Field Separators*
|
Whether or not multiple consecutive field separators should be treated as one. For example, if this property is set to
Yes, X,,Y,,Z is treated as X,Y,Z. This property is most useful when spaces are used as delimiting characters.
|
Yes
|
Yes
|
|
Double Delimiter to Escape
|
Whether or not to treat a pair of delimiting characters within a delimited string as escaped characters. For example, if this property is set to
Yes,
"abc""xyz" is treated as
abc"xyz.
|
Yes
|
Yes
|
Table 24. Region Properties
* This property is for line-oriented regions only.
+ This property is for fixed-width regions only.
Row Properties
|
Property
|
Description
|
Editable
|
Affects XML
|
|
Row Element Name
|
The name you want to assign to all rows in the region. The default value is row.
|
Yes
|
Yes
|
|
Match Pattern
|
A regular expression you can use to filter rows in a region. Only rows that match the pattern you specify are output to XML.
|
Yes
|
Yes
|
|
Current Row Length
|
The length of the current row.
|
No
|
No
|
|
Fields in Current Row
|
The number of fields in the current row.
|
No
|
No
|
|
Max Fields in Row
|
The number of fields in the row that contains the largest number of fields.
|
No
|
No
|
Table 25. Row Properties
Field Properties
|
Note
|
|
Each region has its own field and row properties. In addition, some properties apply only to line-oriented regions. These properties are marked with an asterisk.
|
|
Property
|
Description
|
Editable
|
Affects XML
|
|
Field Element Name
|
The name you want to use for field elements in the XML output. The default value is field.
|
Yes
|
Yes
|
|
Component Element Name
|
The name you want to use for sub-fields detected by Stylus Studio (based on the Component Separator character) in the XML output. The default value is component.
|
Yes
|
Yes
|
|
Sub-Component Element Name
|
The name you want to use for sub-fields detected by Stylus Studio (based on the Sub-Component Separator character) in the XML output. The default value is subcomponent.
|
Yes
|
Yes
|
|
Source Data Type
|
The data type of the current field. Stylus Studio provides support for the following data types:
String, Boolean, number, date, time, byte, short, integer, long, float, double. Note that some properties are type-specific.
See
Type-Specific Properties for information on properties that are associated with specific data types.
|
No
|
Yes
|
|
Target Data Type
|
Not currently used.
|
|
|
|
Number
|
The number of the field in which the cursor is located. Starting with 1 from the left-most field.
|
No
|
No
|
|
Cursor Position
|
The offset of the cursor's current location from the start of the current field.
|
No
|
No
|
|
Offset
|
The offset of the start of the current field. Measured from the start of the row.
|
No
|
No
|
|
Length
|
The length of the current field in characters.
|
No
|
No
|
|
Max Field Length *
|
The length of the longest of all the instances of this field.
|
No
|
No
|
|
Value
|
The value of the current field.
This value also appears in the status bar.
|
No
|
No
|
Table 26. Field Properties
* This property is for line-oriented regions only.
Type-Specific Properties
This section describes the properties that are specific to a given data type.
|
Property
|
Applies to Data Type
|
Description
|
Affects XML
|
|
Architecture
|
BCD
|
Specifies the architecture type for Binary Coded Decimal (BCD).
|
Yes
|
|
Base
|
Number
|
The numeric base of the number. Decimal (base 10) is assumed by default, but base 2 through base 36 are recognized.
|
Yes
|
|
`C' rules for octal and hex
|
Number
|
Determines how numeric values are treated. If this property is set to True and the value begins with 0x, the value is treated as hexadecimal (base 16). If the value begins with 0, it is treated as octal (base 8). Otherwise, it is treated as base 10.
|
Yes
|
|
Decimal
|
Number
|
The decimal separator character. Defaults to the standard platform symbol, which is typically a period or comma.
|
Yes
|
|
Endian
|
Double, Float, Integer, Long,
Short
|
Determines whether the first byte in binary multi-byte values is the least significant (Little) or the most significant (Big). The default is Little, which is the native mode on Stylus Studio platforms.
|
Yes
|
|
l False Output As
l True Output As
l Unknown Output As
|
Boolean
|
Strings output based on matching strings specified in the False Value Match List and True Value Match List.
|
Yes
|
|
l False Value Match List
l True Value Match List
|
Boolean
|
Semicolon-separated lists of values. If the field value matches a string specified in the False Value Match List, the string specified in the False Output As property is output; likewise for values that match those specified in the True Value Match List.
If there are no matches with either the false or true match lists, the value specified in the Unknown Output As property is output.
|
Yes
|
|
Format
|
Date
|
Specifies the order of the day, month, and year in date strings. Convert to XML can determine date format if names are used for months.
Dates are recognized in many formats, with and without delimiting characters, including:
|
Yes
|
|
l Left Padding
l Right Padding
|
Boolean, Date, Number, String, Time
|
Allows you to specify characters you want removed from the left and right sides, respectively, of a field. Applies to characters within delimiting characters.
|
Yes
|
|
Lookup List
|
All
|
Allows you to specify a list of lookups and associated values. Values are substituted for the lookup when the input file is converted to XML.
|
Yes
|
|
Normalize White Space
|
String
|
Converts any tabs, linefeeds, or carriage returns to spaces. Also removes leading and trailing white space and collapses consecutive white space characters to a single space. The default is False.
|
Yes
|
|
Notes
|
All
|
Allows you to add internal comments for a field.
|
No
|
|
Omit from Output
|
All
|
Allows a field to be omitted from XML output based on its presence or value. Valid values include:
l Only When Empty. This is the default.
l When Empty or Zero.
l Always
l Never
|
Yes
|
|
Packed
|
BCD
|
For Binary Coded Decimal (BCD) fields, whether or not it is packed.
|
Yes
|
|
Scaling Factor(10^n)
|
BCD,
Byte, Comp3,
Double, Float, Integer, Long, Number, Short,
Zoned
|
Scales a number by moving the decimal point. Use a positive value to move the decimal point to the left; use a negative value to move the decimal point to the right. To enter a scaling factors from 10
-16 to 10
16, just enter the exponent value.
Example: Entering an exponent of 3 will cause any numbers to be multiplied by 1000 (10
3) before being output to XML.
|
Yes
|
|
Separator
|
Date,
Time
|
Character used to separate date and time components. Date values commonly use spaces, slashes, dashes, and periods; time values commonly use colons, periods, and spaces. The platform setting is used by default.
|
Yes
|
|
Signed
|
Byte, Integer, Long,
Short
|
Whether the numeric form is signed or unsigned.
|
Yes
|
|
Thousands Separator
|
Number
|
Character used to separate thousands. Typically a comma, though periods, spaces, and other characters can be used. Defaults to the platform symbol.
|
Yes
|
|
Use Currency Conventions
|
Number
|
Determines whether values are treated as positive or negative. If the value contains DR or DB (or dr or db), it is treated as positive. If it contains CR or cr, or is surrounded by parentheses, it is treated as a negative.
|
Yes
|
|
Window for Two-Digit Years
|
Date
|
Allows you to specify the century start-date for years that use a two-digit format. For example, if you enter 1950, years with a value from 50-99 will be output as 1950-1999; years with a value of 00-49 will be output as 2000-2049.
|
Yes
|
|
XML Output Form
|
All
|
Whether to output the current row value as a child element or attribute of the <row> element. The default is element. If this field is set to True, components and subcomponents within that value are not recognized, so the entire field is used as the attribute value, instead of being broken up.
|
Yes
|
Table 27. Type-Specific Properties
Specifying Control Characters
Lists of symbols are used to designate characters for properties like Field Component Separator, Line Terminator, and Field Separator.
Individual symbols can be expressed in several forms. Numbers and letters, for example, can be entered using single quotes, such as `A', `B', `C'. Control characters or other Unicode values can be expressed using their decimal value, or their hex value by preceding it with 0x - 128 or 0x80, for example. In addition, certain control characters have alternate mnemonic representations, and Stylus Studio supports them, as well.
When entering multiple symbols for a given property, separate symbols using a comma.
The following table summarizes commonly used control characters. For more information, visit
http://www.unicode.org
.
|
Decimal
|
Hex
|
Mnemonic
|
Control Key
|
|
0
|
0x00
|
NUL
|
^@, '\0'
|
|
1
|
0x01
|
SOH
|
^A
|
|
2
|
0x02
|
STX
|
^B
|
|
3
|
0x03
|
ETX
|
^C
|
|
4
|
0x04
|
EOT
|
^D
|
|
5
|
0x05
|
ENQ
|
^E
|
|
6
|
0x06
|
ACK
|
^F
|
|
7
|
0x07
|
BEL or BELL
|
^G, '\a'
|
|
8
|
0x08
|
BS
|
^H, '\b'
|
|
9
|
0x09
|
TAB or HT
|
^I, '\t'
|
|
10
|
0x0A
|
LF
|
^J, '\n'
|
|
11
|
0x0B
|
VT
|
^K, '\v'
|
|
12
|
0x0C
|
FF
|
^L, '\f'
|
|
13
|
0x0D
|
CR
|
^M, '\r'
|
|
14
|
0x0E
|
SO
|
^N
|
|
15
|
0x0F
|
SI
|
^O
|
|
16
|
0x10
|
DLE
|
^P
|
|
17
|
0x11
|
DC1 or XON
|
^Q
|
|
18
|
0x12
|
DC2
|
^R
|
|
19
|
0x13
|
DC3 or XOFF
|
^S
|
|
20
|
0x14
|
DC4
|
^T
|
|
21
|
0x15
|
NAK
|
^U
|
|
22
|
0x16
|
SYN
|
^V
|
|
23
|
0x17
|
ETB
|
^W
|
|
24
|
0x18
|
CAN
|
^X
|
|
25
|
0x19
|
EM
|
^Y
|
|
26
|
0x1A
|
SUB
|
^Z
|
|
27
|
0x1B
|
ESC
|
^[
|
|
28
|
0x1C
|
FS
|
^\
|
|
29
|
0x1D
|
GS
|
^]
|
|
30
|
0x1E
|
RS
|
^^
|
|
31
|
0x1F
|
US
|
^_
|
|
127
|
0x7F
|
DEL
|
|
|
128
|
0x80
|
|
|
|
129
|
0x81
|
|
|
|
130
|
0x82
|
BPH
|
|
|
131
|
0x83
|
NBH
|
|
|
132
|
0x84
|
IND
|
|
|
133
|
0x85
|
NEL
|
|
|
134
|
0x86
|
SSA
|
|
|
135
|
0x87
|
ESA
|
|
|
136
|
0x88
|
HTS
|
|
|
137
|
0x89
|
HTJ
|
|
|
138
|
0x8A
|
VTS
|
|
|
139
|
0x8B
|
PLD
|
|
|
140
|
0x8C
|
PLU
|
|
|
141
|
0x8D
|
RI
|
|
|
142
|
0x8E
|
SS2
|
|
|
143
|
0x8F
|
SS3
|
|
|
144
|
0x90
|
DCS
|
|
|
145
|
0x91
|
PU1
|
|
|
146
|
0x92
|
PU2
|
|
|
147
|
0x93
|
STS
|
|
|
148
|
0x94
|
CCH
|
|
|
149
|
0x95
|
MW
|
|
|
150
|
0x96
|
SPA
|
|
|
151
|
0x97
|
EPA
|
|
|
152
|
0x98
|
SOS
|
|
|
153
|
0x99
|
|
|
|
154
|
0x9A
|
SCI
|
|
|
155
|
0x9B
|
CSI
|
|
|
156
|
0x9C
|
ST
|
|
|
157
|
0x9D
|
OSC
|
|
|
158
|
0x9E
|
PM
|
|
|
159
|
0x9F
|
APC
|
|
|
160
|
0xA0
|
NBSP
|
|
|
173
|
0xAD
|
SHY
|
|
Table 28. Commonly Used Control Characters
|
Cart
