Official |[Excel(POI)] Write Specified Cell

Operation name

Write Specified Cell

Function overview

Writes input data to a specified cell of an Excel file.

Data model

The data model of this component is table model type.

If Specify format/comment in Mapper to write is selected, it's XML 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.
Input data	Required	Not available	Select a component on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
File path	Required	Available	Enter the Excel file path. 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.
Cell list	Required	-	Specify cells. Each row can be operated with the following buttons: Up Moves the selected row upward by one row. Down Moves the selected row downward by one row. Add Adds a row. Delete Deletes the row.
Cell list/Sheet name	Required	Available	Select or enter the sheet name.	Case-insensitive. When the sheet name doesn't exist in the write destination, a sheet is created. You can get sheet names using the property action Get sheet name list.
Cell list/Cell address	Required	Available	Specify the cell address to be written.	Cell addresses can be specified in A1 format or R1C1 format. To specify in A1 format Ex: "A1" "B2" To specify in R1C1 format Ex: "R1C1" "R5C12"
Cell list/Cell label	Optional	Not available	Enter the label of the cell.	Values set in Cell Label will be displayed in Mapper schema. They're not used during execution.
Cell list/Type	Required	Not available	Select the type of the cell. String (Default) Internal data type is String. Numeric value Internal data type is BigDecimal. Date Internal data type is Date. Time Internal data type is Date. Boolean Internal data type is boolean.	For more details on internal data types, refer to Internal data types. When you select Time, the value of date isn't used.
Cell list/Number settings	Required	Not available	Select the setting method of the number format. Specify Number Specify the number format of the cell. Use Number of cell (Default) Use the number format of the write target cell.	When Use Number of cell is selected, the number format set in Column list/Number isn't used.
Cell list/Number	Optional	Available	Select or enter the number format to set to the write target cell.
Specify format/comment in Mapper to write	Optional	Not available	Select whether or not to set elements for writing format/comment in the input schema. Selected Elements to write format/comment are set in the input schema. Not selected (Default) Elements to write format/comment aren't set in the input schema.	When this field is selected, the input schema will be in XML type. = Remarks = For details, refer to Input schema.

Property actions

Item name	Description	Remarks
Get sheet name list	Get sheet names from the file specified in File path.	Disabled when the specified file doesn't exist or script variables are set in File path.

Write setting

Item name	Required/Optional	Use of variables	Description	Remarks
Position where you add a sheet	Required	Not available	When you create a sheet, select the position where you add it. Append at the beginning (Default) Append a sheet at the beginning. Append at the end Append a sheet at the end.

Item name

Required/Optional

Use of variables

Description

Remarks

Position where you add a sheet

Required

Not available

When you create a sheet, select the position where you add it.

Append at the beginning

(Default)

Append a sheet at the beginning.

Append at the end

Append a sheet at the end.

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

When Specify format/comment in Mapper to write isn't selected
- It's table model type.
- The number of columns varies depending on the Cell list settings.
- = Remarks =
  For schema structure, refer to Table model type .

When Specify format/comment in Mapper to write is selected

It's XML type.

The schema structure is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<table>
  <row>
    <column>
      <format></format>
    </column>
    <column>
      <format></format>
    </column>
       :
  </row>
</table>

Element name	Attribute name	Description	Remarks
table	-
row	-
column	-	Represents the value to be written in the cell.	Appears once for each row set in Cell list.
format	-	Represents the format/comment to be written in the cell.	In this element, enter a string that is output from "Generate Excel Format" logic. Only the format/comment that is output from "Generate Excel Format" logic will be written. When format isn't written, the format of the write destination cell is used.

Output schema

None.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Transaction

Transaction is supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
filePath	The file path is stored.	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.

Message codes, exception messages, and limitations

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

Notes

When this operation is placed in a loop operation, refer to Notes of Loop by Number of Data.