Fixed-Length Wizard

Fixed-Length Wizard is a wizard with the ability to define schema of fixed-length text file by drag&drop operation.

Refer to "Fixed-length text file" for details about fixed-length files

To launch Fixed-Length Wizard

You can click the [Fixed-Length Wizard] in the configuration dialog for the fixed-length format definition in the Global Resource to launch the Fixed-Length Wizard.

Fixed-Length Wizard Screen Structure

Screen Element Number	Name	Description	Remarks
(1)	Structure definition	Define structures of a fixed length file to read. This adapter reads a fixed length file by following the definition.	The structure definition is a tree structure which has a structure definition icon as a root element.
(2)	Column list	Define structures of the output data. Data only defined in the structure definition is read.	Elements set in the structure definition can be added to the column list. The column list has the same structure as the Table model type. Refer to "Table model type" for details.
(3)	Group		Groups are shown as blue icons.
(4)	Record		Records are shown as green icons.
(5)	Field		Fields are shown as yellow icons.
(6)	Remove(Structure definition)	Delete the element selected in the tree of the [Structure Definition].	You can also operate to select [Delete] in the right-click menu of the element.
(7)	Edit	Show the definition dialog of the element selected in the tree of the [Structure definition].	You can also operate to select [Property] in the right-click menu of the element.
(8)	Add	Add an element to the [Column list] selected in the tree of the [Structure definition].
(9)	Remove(Column list)	Delete the element selected in the tree of the [Column list].	You can also operate to select [Delete] in the right-click menu of the element.
(10)	Up	Move up the order of the element selected in the tree of the [Column list].
(11)	Down	Move down the order of the element selected in the tree of the [Column list].

Structure Definition Configuration

Define data structures of a fixed length file to read.

Group Configuration

Configure groups by the following steps.

Select [Add]-[Group] in the right click menu for structure definition icons.

Configure properties in the "Group definition" dialog.

Basic settings

Item name	Required / Optional	Description	Remarks
Group name	Required	Enter a name of the group.
Occurrence	Optional	Enter occurrence of the group.	Enabled when the [Unlimited] is not checked.
Omittable	Optional	Select whether to omit the [Occurrence]. [Checked]: (default) Omit the [Occurrence]. [Not Checked]: Enter the [Occurrence].
Unlimited	Optional	Select whether to set unlimited to the [Occurrence]. [Checked]: (default) Set unlimited to the [Occurrence].l [Not Checked]: Set a limit to the [Occurrence].

Click the [Finish] button to add the group to the structure definition.

Record Configuration

Configure records by the following steps.

Select [Add]-[Record] in the right click menu for structure definition icons or group icons.

Configure properties in the "Record definition" dialog.

Basic settings

Item name	Required / Optional	Description	Remarks
Record name	Required	Enter a name of the record.
Occurrence	Optional	Enter occurrence of the record.	Enabled when the [Unlimited] is not checked.
Omittable	Optional	Select whether to omit the [Occurrence]. [Checked]: (default) Omit the [Occurrence]. [Not Checked]: Enter the [Occurrence].
Unlimited	Optional	Select whether to set unlimited to the [Occurrence]. [Checked]: (default) Set unlimited to the [Occurrence].l [Not Checked]: Set a limit to the [Occurrence].

Click the [Finish] button to the record to the structure definition.

Field Configuration

Configure fields by the following steps.

Select [Add]-[field] in the right click menu for record icons.

Configure properties in the "Field definition" dialog.

Basic settings

Item name

Required / Optional

Description

Remarks

Field name

Required

Enter a name of the field.

Field type

Required

Select a type of the field.

[String]:(default)
[Numeric]:
[Date]:
[Tag]:
[Numeric(Zoned decimal)]:
[Numeric(Packed decimal)]:

Specify encoding

Optional

Select or enter any encoding.

Use only the canonical name supported by Java SE Runtime Environment 8 when specifying the encoding directly in the field.

Refer to "Supported Encodings"(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html) for details.

Enabled when [String] or [Tag] is selected in [Field type].
When [Specify encoding] is not checked, uses [Encoding] in [Read settings].

Field length

Required

Enter the length of the entire field in bytes.

Starting position

Automatically displayed the start position of the field in the record.

Alignment

Required

Select the alignment of the field.

[Right]: (Default)
Right-align the field.
[Left]:
Left-align the field.

Suppressed character

Required

Select the character suppressed.

[List]: (Default)
Select from single-byte space(default), single-byte zero, double-byte space, double-byte zero.
[Direct]:
Type the characters to be suppressed directly.
[Code]:
Enter the characters to be suppressed in the character code.

When [Code] is selected, specify byte stream in encoding specified in [Encoding](When [Specify encoding] is not checked, use the [Encoding] of [Read settings] in Read fixed-length file).Hexadecimal (prefix "0x" (number zero and alphabet x ) can be input.
Example: In the case of tab

Encoding	Code
Shift_JIS	0x09
Windows-31J	0x09
EUC-JP	0x09
ISO-8859-1	0x09
ISO-2022-JP	0x09
US-ASCII	0x09
UTF-8	0x09
UTF-16	0xfe,0xff,0x00,0x09
UTF-16BE	0x00,0x09
UTF-16LE	0x09,0x00
EBCDIC(Cp930)	0x05

Field properties (field type settings)

Item name

Required / Optional

Description

Remarks

Tag

Optional

Enter a tag (record identification code).

Enabled when [Tag] is selected in [Field type].

Date format

Optional

Select or enter a date format.

Year	Meaning	Display	Example
y	Year	Number	1996
M	Month	Text or number	July or 07
d	Day	Number	10
h	Hour (1-12)	Number	12.
H	Hour (0-23)	Number	0
m	Minute	Number	30
s	Second	Number	30
S	Millisecond	Number	978

Enabled when [Date] is selected in [Field type].
The default is "$yy$MM$dd".

Number of decimal places

Optional

Enter the number of decimal places.

Enabled when [Numeric(Zoned decimal)] or [Numeric(Packed decimal)] is selected in [Field type].

Zone nibble

Optional

Enter a nibble of the zone.

Enabled when [Numeric(Zoned decimal)] is selected in [Field type].
If you specify an zone nibble of 1 to 3 digits, zone nibble filled to 4 digits with "0" is set.
If omitted, the zone nibble is set based on the [Encoding] of [Read settings] in Read Fixed-length processing.Zone nibble set by the typical encoding is as shown below.

Encoding Zone nibble

Shift_JIS 0011

Windows-31J 0011

EUC-JP 0011

ISO-8859-1 0011

ISO-2022-JP 0011

US-ASCII 0011

UTF-8 0011

UTF-16 0011

UTF-16BE 0011

UTF-16LE 0000

EBCDIC(Cp930) 1111

Sign format

Optional

Select the format of the code.

[None]: (default)
Select if there is no sign.
[Leading]:
Select when the sign is put into the first digit(Leading).
[Leading (Separate)]:
Select when the sign is put as a separate byte before the first digit(Leading Separate).
[Trailing]:
Select when the sign is put into the last digit(Trailing).
[Trailing (Separate)]:
Select when the sign is put as a separate byte after the last digit(Trailing Separate).

Enabled when [Numeric(Zoned decimal)] or [Numeric(Packed decimal)] is selected in [Field type].

Positive nibble

Optional

Enter a positive nibble.

Enabled when any sign format except the [None] in the [Sign format] is selected.
When a positive nibble is specified is less than 4 digits, the positive nibble will be 4 digits which consist of he specified value and "0" added.
"1100" is set when omitted.

Negative nibble

Optional

Enter a negative nibble.

Enabled when any sign format except the [None] in the [Sign format] is selected.
When a negative nibble is specified is less than 4 digits, the negative nibble will be 4 digits which consist of he specified value and "0" added.
"1101" is set when omitted.

Nibbles is a unit of information amount, it equal to 4 bits.

Click the [Finish] button to add the field to the structure definition.

Column List Configuration

Define an output format of the data to read by the structure definition.

Add element

Select an element in the [Structure definition], and click [Add] button of structure definition tree to add the field to the [Column list].

}Only fields can be added to the column list.

When a filed is selected and added to the column list, the last selected field will be added to the [Column list].

When a group or a record is selected and added to the column list, fields in the group or record will be added to the column list.

In the following cases, the order of the field added to the list columns can not be guaranteed.

If you add fields to the list columns to select multiple fields in the structure definition
If you add fields to the list columns to select multiple records in the structure definition

Structure definition file export / import function

The column list and structure definitions defined in the wizard, can be saved in CSV file format, and the the column list and structure definitions can be restored from the file.

Once structure definition file is created, it can be used in both read and write process.

Structure Definition File Specifications

The encoding of structure definition file is Shift_JIS.

Groups , record and fields settings defined by the structure definition, can be represented in the following CSV format.

Groups

Columns	Type	Character that can be specified	Required / Optional	Remarks
1	Prefix	GROUP or G	Required	Does not distinguish on upper/lower cases.
2	Group name	Any string	Required
3	Occurrence	Number of 0 to 2147483647	Optional	"Unlimited" is set when omitted.
4	Required	true or false	Optional	"false" is set when omitted.

Example

Group name	HeaderGroup
Occurrence	Unlimited
Required	false

GROUP,HeaderGroup,,

Record

Columns	Type	Character that can be specified	Required / Optional	Remarks
1	Prefix	RECORD or R	Required	Does not distinguish on upper/lower cases.
2	Record name	Any string	Required
3	Occurrence	Number of 0 to 2147483647	Optional	"Unlimited" is set when omitted.
4	Required	true or false	Optional	"false" is set when omitted.

Example

Record name	HeaderRecord
Occurrence	Unlimited
Required	false

RECORD,HeaderRecord,,

Field

Columns

Type

Character that can be specified

Required / Optional

Remarks

Prefix

FIELD or F

Required

Does not distinguish on upper/lower cases.

Field name

Any string

Required

Type

Each type of character that can be specified is as follows.

Type	Character that can be specified
String	string or S
Number	numeric or N
Tag	tag or T
Date	date or D
Zoned decimal	zoned or Z
Packed decimal	packed or P

Required

Does not distinguish on upper/lower cases.

Type setting

Tag or date format

Optional

Required when Type is "tag" or "date".

Encoding

If the type is a string field, you can specify any encoding.

Use only the canonical name supported by Java SE Runtime Environment 8 when specifying the encoding directly in the field.

Refer to "Supported Encoding" for details.

Optional

If omitted, the process of reading a fixed length file [Read settings] the [Encoding] is used.

Length

Numbers from 0 to 9999

Required

Suppressed character

Suppress any character

Required

You can not specify the character encoding.
If empty, [Suppression mode] is "direct input", [Suppressed character] is "empty" when.

Align

Align	Character that can be specified
Right align	Right or R
Left align	Left or L

Optional

Right Align is set when omitted.
Does not distinguish on upper/lower cases.

Number of decimal places

Number between 0 to 2147483647

Optional

Enables when Type is "Zoned decimal" or "Packed decimal.
"0" is set when omitted.

Sign format

Sign format	Character that can be specified
None	None or N
Leading	Leading or L
Trailing	Trailing or T
Leading (separate)	Leading.Separate or LS
Trailing (separate)	Trailing.Separate or TS

Optional

Enables when Type is "Zoned decimal" or "Packed decimal.
"None" is set if omitted.
Does not distinguish on upper/lower cases.

Zone nibble

4-digit number of 0 or 1

Optional

Enables when Type is "Zoned decimal".

12.

Positive nibble

4-digit number of 0 or 1

Optional

Enables when Type is "Zoned decimal" or "Packed decimal.

Negative nibble

4-digit number of 0 or 1

Optional

Enables when Type is "Zoned decimal" or "Packed decimal.

Output

true or false

Optional

Specifies whether to output fields defined structure. "true" when output.
"false" is set when omitted.

Example

Field name	Header
Type	String
Encoding	Windows-31J
Length	10
Padding character	single-byte space
Align	Left alignment

FIELD,Header,S,,Windows-31J,10, ,L,,,,,,

Export structure definition file

Export the following structure definition.

Select [Export] from [Structure definition file] menu.

Select or enter the destination file, and Press [Finish].
Specify the absolute path of the DataSpider file system as the file path.
Constrained characters of DataSpider File System cannot be used except for path separator "/".
Click [Browse] button to activate the file Selectr and Select the file.
Click [Preview] button to display the contents of the specified in file.

"Export completion" dialog will appear when export succeeded.

Exported content is as follows.

GROUP,Group,,false
RECORD,Record,,false
FIELD,Tag,tag,HDR,Windows-31J,3, ,L,0,,,,,false
FIELD,String,string,,Windows-31J,5, ,L,0,,,,,true
FIELD,Numeric,numeric,,,3, ,R,0,,,,,true
FIELD,Date,date,$yyyy/$MM/$dd,,10, ,R,0,,,,,false
FIELD,Zoned decimal,zoned,,,2, ,L,0,T,,1100,1101,false
FIELD,Packed decimal,packed,,,2, ,L,0,T,1111,1100,1101,false

<= field output to column list
<= field output to column list

Import Structure Definition File

Import the following structure definition file .

GROUP,group,,false
RECORD,record,,false
FIELD,Tag,tag,HDR,3, ,L,0,,,,,false
FIELD,String,string,,Windows-31J,5, ,L,0,,,,,true
FIELD,Number,numeric,,,3, ,R,0,,,,,true

<= field output to column list
<= field output to column list

Select [Import] from [Structure definition file] menu.

Select or enter the import file, and Press [Finish].
Specify the absolute path of the DataSpider file system as the file path.
Constrained Characters of DataSpider File System except for path separator "/" cannot be used.
Click [Browse] button to activate the file Selectr and Select the file.
Click [Preview] button to display the contents of the specified in file.
If Structure definition already exists, an alert box appears to check whether to overwrite.

The structure definition will be shown in the Wizard if following dialog will appear when export succeeded.

Note when editing the structure definition file

Groups with a parent record need to be written under their parent group.
Example: When record A is defined under group A

[OK]

GROUP,A group,,false
RECORD,A record,,false

[NG]

GROUP,A group,,false
GROUP,B group,,false
RECORD,A record,,false

<= A record becomes the child record of group B.

As above, records that the parent field must be written under the parent record.

Export the file structure definition / import is, DataSpider will be on the file system.

The structure definition file is encoded depends on the default encoding of the server environment.

Specification Limits

External characters are not supported.

Applied when string manipulation (e.g. alignment, suppress) are once all converted to "Unicode".Therefore, depending on the character code, it may not be the intended result.

Groups can not be contain themselves (Groups can not be nested).Only component of the group is a record.

Elements with the same parent element cannot have the same name.
Specifically, it applies for the following elements.
- Groups
- Records directly beneath the structure definition
- Records in the same group
- Fields in the same record
Record group name field is required.

The tag is handled as string.The tag does not support other types.

When blank lines appear in the middle of the file to read, an error will occur.However, a blank line appears only at the end of the file to read, no error will occur.

Time and date appear in a string is dependent on what the default locale.If date data which can not be parsed by the default locale is read, read the data as a string.

If the [Occurrence] of the group is [Unlimited], when the corresponding input data appears, checks whether it can be applied to the data analysis of the next group.If applicable, apply to the next group.If not applicable, use the group to analysis and move on.

If the [Occurrence] of the record is [Unlimited], when the corresponding input data appears, checks whether it can be applied to the data analysis of the next record.If applicable, apply to the next record.If not applicable, use the record to analysis and move on.

If the [Occurrence] of the record or the group is [Unlimited], the maximum value is Integer.MAX_VALUE of Java which is 2147483647.

If the [Occurrence] of the group is [Omittable], no error occurs occur when the time of occurrence of the group is less than the specified occurrence.

If the [Occurrence] of the record is [Omittable], no error occurs when the time of occurrence of the record is less than the specified occurrence.

The maximum value in the field length is 9999.

When a field in the column list is deleted in the structure definition, the field remains in the column list.

If select group by structure definition and add field to column list, field order cannot be ensured.

The length of the field is specified in bytes.Byte length depends on the specified encoding.

The order of fields in the column list follows the order of fields which are read in the structure definition.Can not read correctly if the order of fields switches in the column list.

If export/import structure definition that certain group (A group) and record(A record) belonging to the same class but in the lower part, A record becomes child item of A group.
Example:
A value that needs to escape when displayed normally in "[" or"]" cannot be used as a group name, a record name, or a field name.

If the [Suppressed character] is blank, suppression processing is not performed.