【公式】[Excel(POI)]シート書き込み

オペレーション名

シート書き込み

機能概要

入力データをExcelファイルに書き込みます。

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。

ただし、[書式・コメントをMapperで指定して書き込む]にチェックを入れた場合、XML型となります。

プロパティ

= 備考 =

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。
入力データ	必須	使用不可	スクリプトキャンバス上にあるコンポーネントを選択します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
ファイルパス	必須	使用可	Excelファイルのファイルパスを入力します。 [参照]ボタンをクリックするとファイルチューザーが起動し、ファイルの選択ができます。	注意ファイルパスはHULFT Square ストレージの絶対パスで指定してください。パス区切り文字「/」以外のHULFT Squareストレージの使用禁止文字は使用できません。
シート名	必須	使用可	シート名を選択または入力します。	大文字小文字を区別しません。プロパティアクション[シート名の一覧を取得する]からシート名の一覧を取得できます。
列一覧	必須	-	列を指定します。各列は以下のボタンで操作することができます。 [上へ] 選択している列の順序を一つ上に上げます。 [下へ] 選択している列の順序を一つ下に下げます。 [追加] 列を追加します。 [削除] 列を削除します。	プロパティアクション[列一覧を取得する]から自動で設定できます。
列一覧/書き込み対象	必須	使用不可	この列に書き込むかを選択します。
列一覧/列	必須	使用可	書き込む列を入力して指定します。	列はA1形式またはR1C1形式の列で指定できます。 A1形式で列指定する場合例：「A」「B」 R1C1形式で列指定する場合例：「1」「2」
列一覧/見出し	省略可	使用不可	列の見出しを入力します。	[見出し]に設定した値がMapperのスキーマに表示されます。 [最初の行に見出しを書き込む]にチェックが入っている場合、設定した値を書き込みます。
列一覧/型	必須	使用不可	[列]の型を選択します。 [文字列] (デフォルト) 内部データ型はStringです。 [数値] 内部データ型はBigDecimalです。 [日付] 内部データ型はDateです。 [時間] 内部データ型はDateです。 [真偽値] 内部データ型はbooleanです。	内部データ型の詳細については、「内部データ型」を参照してください。 [時間]を選択した場合、年月日の値は使用されません。
列一覧/表示形式設定	必須	使用不可	表示形式の設定方法を選択します。 [表示形式を指定する] セルの表示形式を指定します。 [セルの表示形式を利用する] (デフォルト) 書き込み先セルの表示形式を利用します。 [開始行の表示形式を利用する] 書き込み開始行の表示形式を利用します。	[セルの表示形式を利用する]または[開始行の表示形式を利用する]を選択した場合、[列一覧/表示形式]で設定した表示形式は使用されません。
列一覧/表示形式	省略可	使用可	書き込み先のセルに設定する表示形式を選択または入力します。
書式・コメントをMapperで指定して書き込む	省略可	使用不可	書式・コメントを書き込むための要素を入力スキーマに設定するかどうかを選択します。 [チェックあり] 書式・コメントを書き込むための要素を入力スキーマに設定します。 [チェックなし] (デフォルト) 書式・コメントを書き込むための要素を入力スキーマに設定しません。	[チェックあり]の場合、入力スキーマはXML型となります。詳細については、「入力スキーマ」を参照してください。

プロパティアクション

項目名	説明	備考
シート名の一覧を取得する	[ファイルパス]で指定したファイルからシート名の一覧を取得します。	指定したファイルが存在しない場合、または[ファイルパス]にスクリプト変数が設定されている場合は無効になります。
列一覧を取得する	[ファイルパス]で指定したファイルの[シート名]から列情報を取得して、 [列一覧]に設定します。	指定したファイルが存在しない場合、または [ファイルパス]・[シート名]にスクリプト変数が設定されている場合は無効になります。 1行目のセルから列情報を取得し、セルの値を[見出し]として設定します。 [開始条件]に行番号が設定されている場合には、その行のセルから列情報を取得します。対象セルが空白の場合、その列は設定されません。注意サイズが大きいファイルを[ファイルパス]に指定した場合、OutOfMemoryErrorが発生することがあります。

開始条件設定

項目名	必須/省略可	変数の使用	説明	備考
開始条件設定を有効にする	省略可	使用不可	開始条件設定を有効にするかどうかを選択します。 [チェックあり] 開始条件設定を有効にします。 [チェックなし] (デフォルト) 開始条件設定を無効にします。
開始条件	省略可	-	書き込み開始条件を指定します。各列は以下のボタンで操作することができます。 [上へ] 選択している列の順序を一つ上に上げます。 [下へ] 選択している列の順序を一つ下に下げます。 [追加] 列を追加します。 [削除] 列を削除します。	[開始条件設定を有効にする]にチェックを入れた場合、有効になります。開始条件が満たされた場合、書き込みが開始されます。開始条件が満たされない場合、データは書き込まれません。
開始条件/列(見出し)	必須	使用不可	書き込み開始条件のチェックを行う対象の[列]を選択または入力します。	[必須設定]の[列一覧]に設定されている[列]が表示されます。 [見出し]が設定されている場合は<列>(<見出し>) が表示されます。 [列]には[列一覧]に設定されていない列も設定可能です。
開始条件/行番号	必須	使用可	書き込み開始条件のチェックを行う対象の行番号を入力します。 [(行番号を指定しない)]を選択した場合、全行を対象に書き込み開始条件のチェックを行います。	入力した行番号の行を対象に、セルの値を[条件値]と比較します。
開始条件/条件値	必須	使用可	書き込み開始条件の条件値を入力します。 [(条件値を指定しない)]を選択した場合、セルの値に関わらず条件を満たします。 [(空白のセル)]を選択した場合、セルが空白であれば条件を満たします。 [(空白ではないセル)]を選択した場合、セルが空白でなければ条件を満たします。	セルの型が数値、日付または時間の場合、条件値は判定されません。
複数条件の規則	必須	使用不可	[開始条件]を複数設定した場合の条件判定の規則を選択します。 [いずれかの条件を満たした行を開始行とする] (デフォルト) 複数設定した条件のうち、いずれかを満たした行を開始行とします。 [順不同で判定し、すべての条件を満たした行を開始行とする] 設定した開始条件のすべてを満たした行を開始行とします。 [上から順に判定し、すべての条件を満たした行を開始行とする] すべての条件を満たした行を開始行とします。設定した開始条件のうち、上位の条件が満たされた場合にその下位の条件が判定対象となります。	[順不同で判定し、すべての条件を満たした行を開始行とする]を選択した場合の詳細一度条件を満たした開始条件は後続の条件判定では判定されず、満たしたものとみなします。 [上から順に判定し、すべての条件を満たした行を開始行とする]を選択した場合の詳細一度条件を満たした開始条件は後続の条件判定では判定されず、満たしたものとみなします。上位の条件が満たされない場合、下位の条件は判定されません。
書き込み開始をスキップする行数	省略可	使用可	[開始条件]で設定した書き込み開始行から書き込みを開始するまでにスキップする行数を入力して指定します。	0または未入力の場合、スキップせずに[開始条件]で設定した書き込み開始行から書き込みます。 [開始条件]で設定した書き込み開始行が5行目、[書き込み開始をスキップする行数]に2を指定した場合、7行目から書き込みを開始します。

書き込み設定

項目名	必須/省略可	変数の使用	説明	備考
最初の行に見出しを書き込む	省略可	使用不可	書き込みを開始した最初の行に見出しを書き込むかどうかを選択します。 [チェックあり] 最初の行に[見出し]を「標準」形式で書き込みます。 [チェックなし] (デフォルト) 見出しは書き込みません。
上書き	省略可	使用不可	指定したファイルにデータが存在した場合、上書きするかどうかを選択します。 [チェックあり] (デフォルト) 指定したシートに上書きします。 [チェックなし] 上書きしません。指定したシートが存在する場合はエラーとなります。	書き込み先にシートが存在しない場合、シートを作成します。
挿入	省略可	使用不可	指定したファイルにデータを書き込む際、挿入を行うかどうかを選択します。 [チェックあり] 書き込みを開始した行に挿入します。 [チェックなし] (デフォルト) 書き込みを開始した行から上書きします。	[上書き]にチェックを入れた場合、有効になります。開始条件を設定した場合には、開始行に挿入されます。
ターゲットシートの削除	省略可	使用不可	指定したファイルにデータを書き込む前に、指定したシートを削除するかどうかを選択します。 [チェックあり] シートを削除します。指定したシートが存在しない場合は無視されます。 [チェックなし] (デフォルト) シートを削除しません。	[上書き]にチェックを入れた場合、有効になります。
シートの追加位置	必須	使用不可	シートを作成する際に追加する位置を選択します。 [先頭に追加する] (デフォルト) 先頭にシートを追加します。 [末尾に追加する] 末尾にシートを追加します。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このコネクターの簡単な説明を記述することができます。

スキーマ

入力スキーマ

[書式・コメントをMapperで指定して書き込む]にチェックを入れない場合
- テーブルモデル型となります。
- [列一覧]の設定により、カラム数が異なります。
= 備考 =
スキーマ構造については、「テーブルモデル型」を参照してください。

[書式・コメントをMapperで指定して書き込む]にチェックを入れた場合

XML型となります。

スキーマ構造については、以下のとおりです。

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

要素名	属性名	説明	備考
table	-
row	-
column	-	セルに書き込む値を表します。	[列一覧]で設定した列ごとに出現します。
format	-	セルに書き込む書式・コメントを表します。	この要素には、「Excel書式生成」ロジックから出力された文字列を入力してください。「Excel書式生成」ロジックから出力されない書式・コメントは書き込まれません。書き込まれない書式については、書き込み先セルの書式が使用されます。

出力スキーマ

ありません。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

= 備考 =

詳細については、「スキーマ編集」を参照してください。

トランザクション

トランザクションをサポートしています。

PSPでの使用について

[書式・コメントをMapperで指定して書き込む]にチェックを入れない場合
- PSPで使用できます。
[書式・コメントをMapperで指定して書き込む]にチェックを入れた場合
- 入力スキーマがXML型となるため、PSPで使用できません。

= 備考 =

PSPについては、「パラレルストリーミング処理」を参照してください。

使用できるコンポーネント変数

コンポーネント変数名	説明	備考
count	書き込んだデータの件数が格納されます。	デフォルト値はnullです。
filePath	ファイルのパスが格納されます。	デフォルト値はnullです。
message_category	エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。	デフォルト値はnullです。
message_code	エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。	デフォルト値はnullです。
message_level	エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。	デフォルト値はnullです。
error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。

メッセージコード、例外メッセージ、制限事項

コネクター	メッセージコード	例外メッセージ	制限事項
Excel(POI) コネクターのメッセージおよび制限事項

注意事項

繰り返し処理中に配置する場合は繰り返し処理(データ件数)の注意事項を参照してください。

シート書き込み処理