Read Fixed-Length File

Operation Name

Function overview

Reads a file of fixed-length.

Data model

Data model of this type of component is table model type.

Properties

For information about using variables, refer to "variables".

Basic settings

Item name	Required / Optional	Use of Variables	Description	Remarks
Name	Required	Not available	Enter the name on the script canvas.

Required settings

Item name	Required / Optional	Use of Variables	Description	Remarks
File	Required	Available	Enter the file path to read a fixed-length. Click [Browse] button to activate the file Selectr and Select the file.	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 "/".
Format	Required	Not available	Select a file format definition that is fixed for global resources. How to set the "Fixed-Length Wizard" Please for more information. [Add]: Adds new global resource. [Edit]: Global resource settings can be edited with "Edit Resource list".

Property Action

Item name	Description	Remarks
Preview	Start the previewer, display the contents of the file specified in [File].	Disables when specified file dose not exist, or variables are set in [File]. Encode specified in [Encoding] is displayed. You can not edit the file contents. Files with file size smaller than 1MB can be displayed in previewer.If the file size exceeds 1MB, 1MB size contents from the beginning of the file are displayed.

Read settings

Item name	Required / Optional	Use of Variables	Description	Remarks
Encoding	Required	Available	Select or input read file encode. 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.	For information regarding the default values used, refer to "Default encoding".
New line code	Required	Not available	Select a new line code. [AUTO]: (default) Implementation-dependent [NONE]: [CR]: Primarily Mac OS (Version 9) [LF]: Primarily UNIX/Linux [CR + LF]: Primarily Microsoft Windows
Retrieves the suppressed characters as empty string	Optional	Not available	Select whether to retrieve the value of the field as an empty string or as null if it consists of suppressed character. [Checked]: Retrieved as empty string [Not Checked]:(default) Retrieved as null
Retrieves the suppressed characters of the numeric type as 1 digit suppressed character	Optional	Not available	If the numeric data field is composed only of padding characters, this will determine whether the value of this filed is retrieve as a single padding character. [Checked]: Retrieved as a single padding character [Not Checked]:(default) Retrieved as null or empty character.	Determined accordingly to the selection made for the [Retrieves the suppressed characters as empty string]. None numeric padding character is retrieved either as an empty string or null according to the selection for the [Retrieves the suppressed characters as empty string]. Zone Decimal and Pack Decimal values cannot be retrieved either as null or empty character.

Data processing method

Item name	Required / Optional	Use of Variables	Description	Remarks
Mass data processing	Required	Not available	Select a data processing method. [Use script settings]: (default) Use adapter to set script properties of the data process. [Disable]: Mass data processing is not performed. [Enable]: Mass data processing is performed.

Comment

Item name	Required / Optional	Use of Variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

The number of columns varies depending on the [Format]

See "Schema of Table Model" for details regarding schema structure.

Loading schema in Mapper

Schema is loaded automatically.

For any details, please refer to the 'Editing Schema'

Mass data processing

Mass data processing is supported.

PSP Usage

PSP is supported.

For details on PSP, refer to "Parallel Stream Processing".

Available component variables

Component variable name	Description	Remarks
count	Return number of read columns.	The value defaults to null. Null when using Parallel Stream Processing.
message_category	Stroes the category to which corresponding message code belongs to, when an error occurs.	The value defaults to null.
message_code	Stores its corresponding message code of occured error.	The value defaults to null.
message_level	Stores the severity of the corresponding message code of the occured error.	The value defaults to null.
error_type	Stores the type of the occured error.	The value defaults to null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The message may vary depending on the DataSpider Servista version.
error_message	Stores the error message for the occured error.	The value defaults to null. The message may vary depending on the DataSpider Servista version.
error_trace	Stores stack trace of the occurred error.	The value defaults to null. The message may vary depending on the DataSpider Servista version or the client application used.

Null and empty string

If the data in the field is composed only of padding characters, it is retrieved either as null or empty character, according to the selection for the [Retrieves the suppressed characters as empty string]

If the [Field type]is numeric and the padding character is also numeric, the value of the field can be retrieved as a single suppressed character with the [Retrieves the suppressed characters of the numeric type as 1 digit suppressed character] checked.

Example:(The length of the fields are all 5)

Filed type	Padding character	Field value	[Retrieves the suppressed characters as empty string]	[Retrieves the suppressed characters of the numeric type as 1 digit suppressed character]	Value retrieved
String	a	aaaaa	Not Checked	Not Checked	null
String	a	aaaaa	Checked	Not Checked	Empty character
Number	0	00000	Not Checked	Not Checked	null
Number	0	00000	Checked	Not Checked	Empty character
Number	0	00000	Not Checked	Checked	0
Number	a	aaaaaa	Not Checked	Checked	null
Number	a	aaaaaa	Checked	Checked	Empty character

If the record defined in the input data structure does not exists, the data of the fields in that record becomes null.

Specification Limits

About naming conventions
- Exists between those elements with the same name in same parent element, can not be read properly.
  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.
About the number of occurrences for group/record
- 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] error does not occur even when the time of occurrence of the group is less than the specified occurrence.
- If the [Occurrence] of the record is [Omittable] error does not occur even when the time of occurrence of the record is less than the specified occurrence.
About the field length
- The length of the field is specified in bytes.Byte length depends on the specified encoding.
- The maximum value in the field length is 9999.
About the date type field
- Time and date appear in a string is dependent on what the default locale.If the default locale if the deal date is unreadable, so please read as a string.
About mass data processing
- Read data is output as a group. For mass data records in the group so, OutOfMemoryError might occur.
Others
- External characters are not supported.
- When field in [Column list] is deleted by [Structure definition], field remains in [Column list].
- If select group by [Structure definition] and add field to [Column list], field order cannot be ensured
- Tag, an unspecified number of occurrences do not have data carriage returns, the analysis can not determine the exact criteria for the structural analysis can not be switched.
- Running log is a "transaction" and is intended implicitly defined to summarize the structure of the group is no limit occurrences.

Main exceptions

Exception name	Cause	Solution
ResourceNotFoundException Resource definition could not be found.Name:[]	The [Format] is not specified.	Specify the [Format].
ResourceNotFoundException Resource definition could not be found.Name:[<Global Resource Name>]	The resource definition specified in the [Format] is not found.	Make sure the global resource specified in the [Format].
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify the [<Property name>].
FileIsDirectoryException	Path input in [File] is directory.	Input file path in [File].
StructuredTextParseException Could not read the file in the specified format.	The file specified in the [File] can not be parsed by the format specified in the [Format].	Make sure the [File] or [Format].
java.io.FileNotFoundException	The file specified in [File] does not exist.	Check the [File].
java.io.UnsupportedEncodingException	The encoding that is not supported is specified in [Encoding].	Specify an encoding that is supported in Java SE Runtime Environment 8. Refer to "Supported Encodings"(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html) for details.