# シートの削除処理

## オペレーション名

シートの削除

## 機能概要

指定されたExcelブックのシートを削除します。

## プロパティ

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

##### 基本設定

項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考
--- | --- | --- | --- | ---
名前 | 必須 | 使用不可 | スクリプトキャンバス上での名前を入力します。 |

##### 必須設定

項目名 | 必須/省略可 | 変数の使用 | 説明 | 補足
--- | --- | --- | --- | ---
ファイル | 必須 | 使用可 | Excelブック形式のファイルパスを入力します。 [参照]ボタンを押下するとファイルチューザが起動し、ファイルの選択ができます。 | 拡張子が「.xlsx」と「.xlsm」であるExcelブック形式のファイルパスを指定します。 ファイルパスはDataAnyware 2.0ファイルシステムの絶対パスで指定してください。 パス区切り文字「/」以外のDataAnyware 2.0ファイルシステムの使用禁止文字は使用できません。
シート一覧 | 省略可 | - | 削除対象のシートを指定します。 |
シート一覧/シート名 | 必須 | 使用可 | [ファイル]で指定したExcelファイルに含まれる、削除するシートを選択または入力します。 | 大文字小文字を区別します。

##### トランザクション

項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考
--- | --- | --- | --- | ---
トランザクション処理を行う | 省略可 | 使用不可 | トランザクション処理を行うかどうかを選択します。 [チェックあり]: トランザクション処理を行います。 [チェックなし]:(デフォルト) トランザクション処理を行いません。 詳細については、「ファイル系アダプタのトランザクション」を参照してください。 |

##### コメント

項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考
--- | --- | --- | --- | ---
コメント | 省略可 | 使用不可 | このアダプタの簡単な説明を記述することができます。 説明を記述すると、仕様書に反映させることができます。 |

## スキーマ

### 入力スキーマ

ありません。

### 出力スキーマ

ありません。

## トランザクション

トランザクションをサポートしています。
[トランザクション]の[トランザクション処理を行う]にチェックを入れた場合のみトランザクションは有効になります。

## PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名 | 説明 | 備考
--- | --- | ---
message_category | エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 | デフォルト値はnullです。
message_code | エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 | デフォルト値はnullです。
message_level | エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 | デフォルト値はnullです。
error_type | エラー発生時、発生したエラーの種類が格納されます。 | デフォルト値はnullです。 エラーの種類は、以下のような形式となります。 例:「java.io.FileNotFoundException」 CustomerVision DataAnyware 2.0のバージョンにより、格納される内容が変わる可能性があります。
error_message | エラー発生時、発生したエラーのメッセージが格納されます。 | デフォルト値はnullです。 CustomerVision DataAnyware 2.0のバージョンにより、格納される内容が変わる可能性があります。
error_trace | エラー発生時、発生したエラーのトレース情報が格納されます。 | デフォルト値はnullです。 CustomerVision DataAnyware 2.0のバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

## 仕様制限

- Excelブックのみ対応しています。
- [シート一覧]に複数の設定をした場合、順に処理を行います。
- 全てのシートを削除することはできません。1つ以上の非表示ではないシートを残す必要があります。

## 主な例外

例外名 | 原因 | 対策
--- | --- | ---
InvalidPropertyConfigurationException ファイルパスが指定されていません。 | [ファイル]が指定されていません。 | [ファイル]を指定してください。
InvalidPropertyConfigurationException 対応していない形式のブックが指定されています。 | [ファイル]に対応していない形式のブックが指定されています。 | [ファイル]に対応している形式のブックを指定してください。
FileIsDirectoryException | [ファイル]に入力されたパスがディレクトリです。 | [ファイル]にはファイルパスを入力してください。
FileIsLockedException | [ファイル]に指定されたファイルがロックされています。 | エクスプローラやCLIからロックの解除を行ってください。
java.lang.IllegalStateException No visible sheet found. | 表示可能なシートが見つかりませんでした。 | [ファイル]に指定されたファイルに、表示可能なシートが1つ以上存在することを確認してください。
java.io.FileNotFoundException | [ファイル]に指定されたファイルが存在しません。 | [ファイル]を確認してください。
java.io.FileNotFoundException 別のプロセスが使用中です。 | [ファイル]に指定されたファイルが別のプロセスによって使用されています。 | 別のプロセスで使用されていないかを確認してください。
SheetNotFoundException 存在しないシート名が指定されました。 | [シート名]に指定されたシートが存在しません。 | [シート名]には存在するシート名を指定してください。

## 注意事項

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