Official |[Fixed-Length] Read Fixed-Length File

Operation name

Read Fixed-Length File

Function overview

Reads a fixed-length file.

Data model

The data model of this component is table model type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
File	Required	Available	Enter the file path of a fixed-length file to read. The Browse button launches a file chooser that allows you to select a file.	Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.
Format	Required	Not available	Select a format definition for fixed-length files registered in data format resources. = Remarks = For how to configure settings, refer to Fixed-Length Wizard. Add A new data format resource can be added. Edit Data format resource settings can be edited in > HULFT INTEGRATE > Data Formats.

Item name

Required/Optional

Use of variables

Description

Remarks

File

Required

Available

Enter the file path of a fixed-length file to read.

The Browse button launches a file chooser that allows you to select a file.

Note

Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

Format

Required

Not available

Select a format definition for fixed-length files registered in data format resources.

= Remarks =

For how to configure settings, refer to Fixed-Length Wizard.

Add: A new data format resource can be added.
Edit: Data format resource settings can be edited in > HULFT INTEGRATE > Data Formats.

Property actions

Item name	Description	Remarks
Preview	The previewer is started, and the contents of the file specified in File is displayed.	Disabled when the specified file doesn't exist or a variable is set in File. The contents are displayed with the encoding specified in Encoding. The contents of the file can't be edited. The maximum file size that can be displayed in the previewer is 1MB. If the file size exceeds 1MB, the contents up to 1MB from the beginning of the file will be displayed.
Fixed-Length Wizard	The Fixed-Length Wizard is launched. For details, refer to Fixed-Length Wizard.

Read settings

Item name	Required/Optional	Use of variables	Description	Remarks
Encoding	Required	Available	Select or enter an encoding for the file to read. When you enter encoding, specify one of the encodings supported in Java SE Runtime Environment 8. = Remarks = For details, refer to "Supported Encodings" (http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html).	The default encoding selected for Encoding of file type connectors is UTF-8.
New line code	Required	Not available	Select a newline code. NONE CR LF CR+LF (Default)	If you used the Fixed-length connector on or before February 26, 2023 with AUTO specified, the processing is performed with LF set. When you update the script, specify LF.
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's composed only of characters that are the same as the suppressed character. Selected Retrieve as an empty string Not selected (Default) Retrieve as null
Retrieves the suppressed characters of the numeric type as 1 digit suppressed character	Optional	Not available	If the data in a numeric field is composed only of characters that are the same as the numeric suppressed character, select whether to retrieve the value of the field as a single numeric suppressed character. Selected Retrieve as a single numeric suppressed character. Not selected (Default) Retrieve as null or an empty string.	Note When this isn't selected, null or an empty string is retrieved depending on the selection for Retrieves the suppressed characters as empty string. Even when this is selected, if the numeric data field has a none-numeric suppressed character, null or an empty string is retrieved depending on the selection for Retrieves the suppressed characters as empty string. Numeric (zoned decimal) and numeric (packed decimal) values can't be retrieved either as null or an empty string.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

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

Schemas

Input schema

None.

Output schema

The number of columns varies depending on the Format settings.

= Remarks =

For schema structure, refer to Table model type .

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Parallel Stream Processing

PSP is supported.

= Remarks =

For details on PSP, refer to Parallel Stream Processing.

Available component variables

Component variable name	Description	Remarks
count	The number of read data records is stored.	The default value is null. Note Value isn't stored when using PSP.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Null and empty strings

If the data in the field is composed only of characters that are the same as the suppressed character, it's retrieved either as null or an empty string.

Whether it's retrieved as null or an empty string depends on the selection for Retrieves the suppressed characters as empty string.

If the Field type is numeric and the suppressed character is also numeric, the value of the field can be retrieved as a single suppressed character by selecting Retrieves the suppressed characters of the numeric type as 1 digit suppressed character.

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

Field type	Suppressed 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 selected	Not selected	null
String	a	aaaaa	Selected	Not selected	Empty string
Number	0	00000	Not selected	Not selected	null
Number	0	00000	Selected	Not selected	Empty string
Number	0	00000	Not selected	Selected	0
Number	a	aaaaaa	Not selected	Selected	null
Number	a	aaaaaa	Selected	Selected	Empty string

If the record defined in the input data structure doesn't exist, the data of the fields in that record becomes null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Fixed-Length connector