OnSheetWorkbookDelete - OnSheetワークブックの削除

OnSheetのワークブックを削除します。

OnSheetとの連携の概要や必要な設定については、OnSheetとの連携についてを参照してください。

■ストリーム情報

入力	フォーマット	すべて
	接続数	無制限
	説明	入力ストリームは使用せず、すべて無視します。
出力	フォーマット	すべて
	説明	入力ストリームをそのまま出力します。

■コンポーネントプロパティ

名前	プロパティ型	マッピング	説明
コネクション名	connection	-	OnSheetサーバーへの接続情報を定義した汎用コネクションを指定します。
ユーザーを指定する	boolean	入力＆出力	処理の実行に使用するユーザーをコネクションで定義されているユーザーを使用するか、 プロパティで指定するかを指定します。 はい [true] - プロパティでユーザー名とパスワードを指定します。 いいえ [false] - コネクションで定義されているユーザー名とパスワードを使用します。
ユーザー名	string	入力＆出力	ユーザーを指定するが「はい」の場合に処理に使用するユーザー名を指定します。
パスワード	password	入力＆出力	ユーザーを指定するが「はい」の場合に処理に使用するユーザーのパスワードを指定します。
ワークブック	string	入力＆出力	削除するワークブックを指定します。 ワークブックの指定方法は以下のいずれかです。 「corp1/workspace1/book1」のように法人名から指定。 「workspace1/book1」のようにワークスペースから指定。法人名はコネクションで定義した値になります。 「book1」のようにブック名のみを指定。ワークスペースはログインユーザーの個人ワークスペースになります。 「55」のようにワークブックIDを指定
完全に消去	boolean	入力＆出力	完全な削除を行うかどうかを指定します。 はい [true] - ワークブックは完全に削除されます。 いいえ [false] - ワークブックはゴミ箱に移動されます。

■トランザクション処理

コミット	何もしません。
ロールバック	何もしません。

■エラー処理

タイプ	パラ メータ	エラー処理フロー へのストリーム	エラー コード	説明
汎用	なし	コンポーネントの入力ストリーム	なし	WebAPIの実行でエラーになった場合

■コネクション設定

OnSheetコンポーネントを使用するためにはあらかじめ汎用コネクションにOnSheetサーバー接続用の設定をしておく必要があります。コネクション設定では以下のパラメータを定義します。

パラメータ名	設定内容
url	OnSheetサーバーのWebAPIのURLを指定します。 URLは通常「http://<ホスト名>/api/v1/rpc」です。
appKey	OnSheetサーバーのアプリケーションキーを指定します。 アプリケーションキーの生成方法についてはOnSheetのWebAPIガイドを参照してください。
organisation	OnSheetサーバーにログインするユーザーの法人名を指定します。
user	OnSheetサーバーにログインするユーザー名を指定します。
password	OnSheetサーバーにログインするユーザーのパスワードを指定します。
useProxy	FSMCで設定したプロキシーサーバを使用する場合「true」を指定します。 プロキシサーバを使用しない場合は設定不要です。