Official |[Excel] Read from Named Range

Operation name

Read from Named Range

Function overview

Reads Excel data from a named range.

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 Excel file path. The Browse button launches a file chooser that allows you to select a file.	A file with ".xlsx" or ".xlsm" extension is processed as an Excel workbook, and a file with other extensions is processed as an Excel 2003 workbook. 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.
Range name	Required	Available	Select or enter the named range of the Excel file specified in File.	Case-sensitive.
Column list	Optional	-	Specify the columns. Each column can be operated with the following buttons: Up Moves the selected column upward by one row. Down Moves the selected column downward by one row. Add Adds a column. Delete Deletes the column.	Column names set in Column list will be displayed in Mapper schema.
Column list/Column name	Required	Available	Enter the column name. The first row of the range specified in File can be set as a column name using the Update column list property action.
Column list/Type	Required	Not available	Select the type of Column name. General (Default) Text Number Date

Property actions

Item name	Description	Remarks
Update column list	Get column names and types from the first row values of the range specified in File and set them in Column list.	Disabled when the specified file doesn't exist or a variable is set in File. Note When the value of a target cell is empty, a different type from that of the target cell might be set to Column list/Type.

Read settings

Item name	Required/Optional	Use of variables	Description	Remarks
Do not get first row as value	Optional	Not available	Select whether or not to handle the first row of the specified range as data. Selected Don't handle as data. Not selected (Default) Handle as data.
Read cell formula	Optional	Not available	Select whether or not to read cell formula as data. Selected Read formula as data. Not selected (Default) Don't read formula as data.	Note Disabled when an Excel workbook is specified in File.

Item name

Required/Optional

Use of variables

Description

Remarks

Do not get first row as value

Optional

Not available

Select whether or not to handle the first row of the specified range as data.

Selected

Don't handle as data.

Not selected

(Default)

Handle as data.

Read cell formula

Optional

Not available

Select whether or not to read cell formula as data.

Selected

Read formula as data.

Not selected

(Default)

Don't read formula as data.

Note

Disabled when an Excel workbook is specified in File.

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 Column list 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.

Note

When the file specified in File is an Excel workbook, mass data processing can't be performed.

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.
filePath	The file path 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

When the target cell value is empty, the read data will be null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Excel connector