Fixed-Length Write Wizard

Fixed-Length Write Wizard is a wizard with the ability to set the necessary schema definitions for generating fixed-length data from input data.

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

To launch Fixed-Length Write Wizard

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

Fixed-Length Write Wizard Screen Structure

Screen Element Number	Name	Description	Remarks
(1)	Column list	Define structures of the input data. Add fields which has the same number of columns in the input data and define structures which are the name, the type, the alignment, and the padding, etc. to the fields added.	The column list has the same structure as the Table model type. Refer to "Table model type" for details.
(2)	Structure definition	Define structures of the output data. Define groups and records in the Structure Definition and add fields added in the column list to the groups and records added by drag and drop.
(3)	Field(Column list)		Fields are shown as yellow icons.
(4)	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.
(5)	Add	Add a field to the [Column list].	You can also operate to select [Add]-[Field] in the right-click menu of the "Column".
(6)	Edit(Column list)	Show the definition dialog of the field selected in the tree of the [Column list].	You can also operate to select [Property] in the right-click menu of the element.
(7)	Group		Groups are shown as blue icons.
(8)	Record		Records are shown as green icons.
(9)	Fixed Value Field	By adding fixed field to structure definition, it can be defined as constant field.	Fixed Value Fields are shown as yellow icons checked.
(10)	Field(Structure Definition)		Fields are shown as yellow icons.
(11)	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.
(12)	Edit(Structure definition)	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.

Column List Configuration

Define a structure definition which defines columns of the input data as fields and define a record in the fixed-length data.

Field Configuration

Configure fields by the following steps.

Operate either as follows to open "Field definition" dialog.
- Right-click "Column" icon, and select [Add]-[Field].
- Click [Add] button .

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)]:	The records with the first field as [Tag] are treated as "Tag Records". If the same tag records exist in several rows, only the first row will be output.
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.	When data in the input data is longer than the specified field length, data which is cut by the field length will be written.
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.
Padding character	Required	Select a padding character. [List]: (Default) Select from single-byte space(default), single-byte zero, double-byte space, double-byte zero. [Direct]: Enter a padding character directly. [Code]: Enter the character code of a padding character.

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.

Specify 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 column list.

Structure Definition Configuration

Define structure of the output data.

Group Configuration

Configure groups by the following steps.

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

Configure properties in the "Group definition" dialog.

Basic settings

Item name	Required / Optional	Description
Group name	Required	Enter a name of the group.
Occurrence	Optional	Not used in write operation.
Omittable	Optional	Not used in write operation.
Unlimited	Optional	Not used in write operation.

Click the [Finish] button to 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 and show the "Record definition" dialog.

Configure properties in the "Record definition" dialog.

Record Properties

Item name	Required / Optional	Description
Record name	Required	Enter a name of the record.
Occurrence	Optional	Not used in write operation.
Omittable	Optional	Select whether to write the input data corresponding to the record to each and every row. [Checked]: If the input data corresponding to the record is the same with the row before, output data could be omitted. The output data is omitted when all the following conditions are matched. In the subsequent records, there are no record with the [Omittable] which is "Not Checked". In the subsequent records, record with the [Omittable] which is "Checked" exists, and the input data corresponding to the record is the same with 1 row before. In the subsequent record, there is a record with the first field being tag field, and the input data corresponding to the record is the same with 1 row before. It is not the end row of the input data. [Not Checked]: (default) Records are always written to each row.
Unlimited	Optional	Not used in write operation.

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

Field Configuration

Configure fields by the following steps.

Select a field defined in the [Column list] and do drag and drop the record to a record defined in the [Structure Definition].
Add a field to the structure definition and link the fields.

Fixed Value Field Configuration

Configure fields by the following steps.

Select [Add]-[field] in the right click menu for record icons and show the "Field definition" dialog.

Configure properties in the "Field definition" dialog.
Refer to "Field Configuration(Column list)" for details.
The [Field name] is written as an output value.

Click the [Finish] button to add the fixed value field to 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.

Group

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".

Specify 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, uses [Encoding] in [Write settings] of Write Fixed-length process.

Length

Numbers from 0 to 9999

Required

Padding character

Any padding character

Required

You can not specify the character encoding.
When left empty, the [Padding mode] is [List] and the [Padding character] is [Space].

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 column list field to structure definition."true" when output.
"false" is set when omitted.

Example:

Field name	Header
Type	String
Specify encoding	Windows-31J
Length	10
Padding character	single-byte space
Align	Left align

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,,,,,true
FIELD,String,string,,Windows-31J,5, ,L,0,,,,,true
FIELD,Number,numeric,,,3, ,R,0,,,,,true
FIELD,Date,date,$yyyy/$MM/$dd,,10, ,R,0,,,,,true
FIELD,Zoned decimal,zoned,,,2, ,L,0,T,,1100,1101,true
FIELD,Packed decimal,packed,,,2, ,L,0,T,1111,1100,1101,true

Import Structure Definition File

Import the following structure definition file .

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

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.

When writing, depending on the string manipulation (e.g. padding, left and right alignment) results, if data is not fit neatly into the specified length field, the unfit part will be well filled with padding characters.

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

The field name is required.

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

When the number of fields defined in column list is fewer than the number of columns of XML data, only the data as the number of the number of fields defined in column list will be written.

When the number of fields defined in column list is more than the number of columns of XML data, an error will occur and the writing operation will fail.

The maximum value in the field length is 9999.

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

Newline characters are written with the [Encoding] in the [Write Settings] in the Write Fixed-Length File operation.

Starting position of field of structure definition is calculated based on the length of field added to parent record.Field starting position in the list column is calculated based on the length of the field added to the column.

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.

The slash ("/") cannot be used as a field name.

The [Padding character] is the "Direct", it is necessary to specify one or more bytes of padding characters.

Elements with the same parent element cannot have the same name.
Specifically, it applies for the following elements.
- Group
- Records directly under the structure definition icon
- Records in the same group
- Fields in the same record