Filter:
Submit Search

Read Sheet

Operation name

Read Sheet

Function overview

Reads a worksheet from the spreadsheet on Google Drive.

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

Connect To

Required

Not available

Select a connection resource.

Add

A new connection resource can be added.

Edit list

Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

 

Folder Path

Optional

Available

Select or enter an absolute path of a folder on Google Drive which starts with slash "/".

  • If omitted, the root folder "/" is used.

File Name

Required

Available

Enter the file name of the spreadsheet.

 

Sheet Name

Optional

Available

Select or enter the sheet name of the spreadsheet.

  • When sheet name is omitted, or the specified sheet doesn't exist, the first sheet will be read.

  • Case-insensitive.

Columns

Optional

-

Specify the columns.

Each column in the column list 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.

 

Columns/Column Name

Optional

Available

Enter the column name.

 

Property actions

Item name

Description

Remarks

Refresh folder path list

Get folder paths in the specified destination and set them to Folder path.

  • If Destination is specified/edited or a folder has been added/edited on Google Drive, the changes can be reflected using this property action.

Refresh file list

Get file names in the specified folder path and set them to File name.

  • If Folder path is specified/edited or a file has been added/edited on Google Drive, the changes can be reflected using this property action.

  • If a variable is set to Folder path, this action will be invalid.

Refresh sheet list

Get sheet names from the specified file and set them to Sheet name.

  • If File name is specified/edited, or a sheet has been added/edited on Google Sheet, the changes can be reflected using this property action.

  • If a variable is set to Folder path or File name, this action will be invalid.

Refresh columns

Retrieve the column names from the first row values of the specified spreadsheet and set them to Columns.

  • If Sheet name is specified/edited, or a column has been added/edited on Google Sheet, the changes can be reflected using this property action.

  • If a variable is set to Folder Path, File Name, or Sheet Name, this action will be invalid.

  • When Start Condition is set, the row that meets the condition specified in Start Condition becomes the target row.

Start/End condition

Item name

Required/Optional

Use of variables

Description

Remarks

Specify Condition To Start Reading

Optional

Not available

Select whether to specify a condition to start reading.

Selected

Specify the condition to start reading.

Not selected

(Default)

Don't specify the condition to start reading.

 

Start condition

Optional

Not available

Select a condition to start reading.

Start From Cell Matched To Specified String

(Default)

Start reading from the cell that matches Matched String.

Starts From Specified Cell Address

Start reading from Cell Address.

  • Enabled when Specify Condition To Start Reading is selected.

  • Depending on selected item, the corresponding input field (Matched String/Cell Address) is displayed.

Matched String

Optional

Available

Enter the matching string as the condition to start reading.

  • Enabled when Start From Cell Matched To Specified String is selected in Start Condition.

  • Case-sensitive.

Cell address

Optional

Available

Enter the cell address as the condition to start reading.
Example: A1

  • Enabled when Starts From Specified Cell Address is selected in Start Condition.

  • If omitted, this operation reads from A1.

  • Case-sensitive.

Specify Condition To Stop Reading

Optional

Not available

Select whether to specify a condition to end reading.

Selected

Specify the condition to end reading.

Not selected

(Default)

Don't specify the condition to end reading.

 

End Condition

Optional

-

Specify the condition to end reading.

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.

  • Enabled when Specify Condition To Stop Reading is selected.

  • The read target will be all rows until and including the row before the row to end reading.

= Remarks =

For details, refer to Conditions to end reading.

End Condition/Column Name

Optional

Not available

In Column Name, select the column to check for the condition to end reading.

 

End Condition/Row Number

Optional

Available

Enter the number of the row to check for the condition to end reading.

When (Not specified) is selected, all rows are checked for the condition to end reading.

  • When omitted, all rows are checked for the condition to end reading.

End Condition/Condition

Optional

Available

Enter the value of the condition to end reading.

If (Not specified) is selected, regardless of the value of the cell, the row specified in Row Number is the row to end reading.

  • When omitted, checking will be performed considering the empty string as the condition value.

End Condition/Logical Operator

Required

Not available

Select a boolean operator for Condition.

AND

(Default)

OR

 

Setting Of Reading

Item name

Required/Optional

Use of variables

Description

Remarks

Ignore The First Row

Optional

Not available

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

Selected

Don't handle as data.

Not selected

(Default)

Handle as data.

 

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.

 

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 Columns settings.

= Remarks =

For schema structure, refer to XML Framework.

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

In mass data processing, when you save the result data in a file, data is temporary stored in the memory. Therefore, when the data amount is huge, OutOfMemoryError may occur even with mass data processing enabled.

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 rows read is returned.

  • The default value is null.

Note

Value isn't stored when using PSP.

folderPath

The folder path to the spreadsheet read is returned.

  • The default value is null.

fileName

The name of the spreadsheet read is returned.

  • The default value is null.

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.

Conditions to end reading

  • If Specify Condition To Stop Reading isn't selected or End Condition isn't specified, all rows in the spreadsheet will be read.

  • When multiple OR boolean operators are specified in End Condition/Logical Operator, the following row is the row to end reading.

    • The row that matches any of the conditions

  • When multiple AND boolean operators are specified in End Condition/Logical Operator, the following row is the row to end reading.

    • If (Not specified) is selected for every Row number, the first row that matches all conditions

    • If a row number is specified in Row number, the last row by which all conditions are matched

    Example:

    Spreadsheet to be read

    Row number

    Column 1

    Column 2

    Column 3

    Column 4

    1

    AAA

    BBB

    CCC

    DDD

    2

    EEE

    FFF

    GGG

    HHH

    3

    III

    JJJ

    KKK

    LLL

    4

    AAA

    BBB

    CCC

    DDD

    5

    EEE

    FFF

    GGG

    HHH

    6

    III

    JJJ

    KKK

    LLL

    Condition to end reading (When row numbers aren't specified)

    Column name

    Row number

    Condition

    And/Or

    Column 1

    (Not specified)

    EEE

    AND

    Column 2

    (Not specified)

    FFF

    AND

    The row to end reading is the second row and only the first row is read.

    Condition to end reading (When row numbers and condition values are specified)

    Column name

    Row number

    Condition

    And/Or

    Column 1

    2

    EEE

    AND

    Column 2

    5

    FFF

    AND

    The row to end reading is the fifth row and four rows are read.

    Condition to end reading (When row numbers are specified and condition values aren't specified)

    Column name

    Row number

    Condition

    And/Or

    Column 1

    2

    (Not specified)

    AND

    Column 2

    7

    (Not specified)

    AND

    The row to end reading is the seventh row and six rows are read.

    Condition to end reading (When a condition with one row number specified and one not specified are mixed)

    Column name

    Row number

    Condition

    And/Or

    Column 1

    4

    (Not specified)

    AND

    Column 2

    (Not specified)

    FFF

    AND

    The row to end reading is the fifth row and four rows are read.

  • When (Not specified) is selected in both Row Number and Condition, processing will end without reading even a single row.

Message codes, exception messages, and limitations

Connector

Message code

Exception message

Limitations

Messages and limitations of the Google Sheets connector

check

check

check

Policies     (c) Saison Technology Co.,Ltd. 2021

TOP