OnSheetOutput - OnSheetへの出力

OnSheetのワークブックを更新します。本コンポーネントでは、フロー実行時に、次のようなことができます。

本コンポーネントを使用するには、OnSheetビルダーを起動して、ワークブック上のセルをコンポーネントのフィールド定義と関連づける必要があります。詳細については下記トピック「OnSheetビルダーの使い方」を参照してください。

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

■ストリーム情報

入力フォーマットRecord
接続数1
説明 ワークブックに書き込むレコードです。
OnSheetビルダーで定義したレコード領域に書き込みます。書出し処理で詳細なアクセス方法を指定可能です。
レコード領域が複数定義されている場合には、その数だけ入力ストリームが表示され、レコードの名前が各ストリームの名前となります。
フィールド名の定義はOnSheetビルダー上で行い、フローデザイナー上では変更できません。
レコード領域にすべてのレコードが書ききれなかった場合、エラーになります。
出力フォーマットRecord
説明 入力ストリームをそのまま出力します。

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

名前プロパティ型マッピング説明
コネクション名connection- OnSheetサーバーへの接続情報を定義した汎用コネクションを指定します。
ユーザーを指定するboolean- 処理の実行に使用するユーザーをコネクションで定義されているユーザーを使用するか、 プロパティで指定するかを指定します。
はい [true] - プロパティでユーザー名とパスワードを指定します。
いいえ [false] - コネクションで定義されているユーザー名とパスワードを使用します。
ユーザー名string入力＆出力ユーザーを指定するが「はい」の場合に処理に使用するユーザー名を指定します。
パスワードpassword入力＆出力ユーザーを指定するが「はい」の場合に処理に使用するユーザーのパスワードを指定します。
テンプレートstring入力＆出力 OnSheetビルダーで使用するテンプレートとなるワークブックを指定します。
テンプレートの指定方法はワークブックプロパティと同じですが通常はOnSheetビルダーによって自動設定されるので変更する必要はありません。
ワークブックがない場合作成プロパティが「はい」の場合、ここで指定したワークブックが複製されます。
ワークブックstring入力＆出力 処理を行うワークブックを指定します。
ワークブックの指定方法は以下のいずれかです。
  • 「corp1/workspace1/book1」のように法人名から指定。
  • 「workspace1/book1」のようにワークスペースから指定。法人名はコネクションで定義した値になります。
  • 「book1」のようにブック名のみを指定。ワークスペースはログインユーザーの個人ワークスペースになります。
  • 「55」のようにワークブックIDを指定
書出し処理choice入力＆出力 OnSheetビルダーで定義したワークブック上のレコード領域に対する出力方法を指定します。レコードを特定するキーとなるフィールドは、OnSheetビルダー上で設定します。
レコード領域にすべてのレコードが書ききれなかった場合、エラーになります。追加, 挿入(キー指定)で出力する場合でも、レコード領域に空白行がない場合はエラーになります。レコード領域は自動的には拡張されません。
レコード領域が非常に大きく定義されている場合には、上書きの方がクリア＆上書きよりも速度的に有利です。
クリア＆上書き [Override] - レコード領域をクリアして先頭行から出力します。
上書き [OverrideNonClear] - レコード領域をクリアせずに先頭行から出力します。
追加 [Append] - レコード領域のキーとなるフィールド値が最後に一致した行の後ろに追加します。キー指定がない、またはキーと一致するものがない場合は最終空白行に追加します。
挿入(キー指定) [Insert] - レコード領域のキーとなるフィールド値が最初に一致した行の前に挿入します。キー指定がない、またはキーと一致するものがない場合は先頭行に挿入します。
更新(キー指定) [Update] - レコード領域のキーとなるフィールド値が最初に一致した行のみ更新します。キー指定がない、またはキーと一致するものがない場合は最終空白行に追加します。
削除(キー指定) [Delete] - レコード領域のキーとなるフィールド値が最初に一致した行のみ削除します。キー指定がない場合、全レコードを削除します。
キーと一致するものがない場合はなにもしません。
ワークブックがない場合作成boolean-ワークブックで指定されたワークブックが存在しない時にワークブックを作成するかどうかを指定します。
はい [true] - ワークブックが存在しない時はワークブックを作成します。
いいえ [false] - ワークブックが存在しない時はワークブックを作成せずエラーになります。
共有設定を引き継ぐboolean- ワークブックを作成する際にテンプレートとなったワークブックの共有設定を引き継ぐかどうかを指定します。
はい [true] - ワークブック作成時に共有設定を引き継ぎます。
いいえ [false] - ワークブック作成時に共有設定を引き継ぎません。
数値がnullの場合の処理choice入力＆出力 シート上のセルに数値を書き込む際、数値がNullの場合に書き込む値を指定します。
0を書き込む [true] - 0を書き込みます。
空文字列を書き込む [false] - 空文字列を書き込みます。
シートcategory入力＆出力 OnSheetビルダーで単一セル・レコードを定義したときのシート名が「定義上のシート名」にリストされます。各シートに対応する「書き出すシート名」に値を指定すると、定義したときのシート名に置き換えて、このシート名のセルからデータを出力します。
このプロパティはマッパーで値を変更可能なので、出力するシートをフロー中で動的に選択することができます。
単一セルcategory入力＆出力 ワークブック中の、OnSheetビルダーで定義した単一セル領域です。フロー実行時に、対応するセルにこのプロパティの値を書き込みます。
フィールド名の定義はOnSheetビルダー上で行い、フローデザイナー上では変更できません。
セル範囲category入力＆出力 OnSheetビルダーで設定した単一セルとレコードの名前とセル範囲がリストされます。
このプロパティに実行時にセル範囲を示す文字列を差し込むことで読み込むセルを動的に変更することができます。
セル範囲の指定は「A1:E10」のように左上端セルの位置と右下端セルの位置を「:」で区切った形式で指定します。 (単一セルの場合は「:」以降の右下端セルの指定は不要です。)
設定値がセル範囲を表していない場合や、元のレコード定義の列数と異なる場合はエラーになります。
(レコード定義の行数は元の定義と異なっていても構いません。)

■トランザクション処理

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

■エラー処理

タイプパラ
メータ		エラー処理フロー
へのストリーム		エラー
コード		説明
汎用 なし コンポーネントの入力ストリーム なし レコード領域が一杯で書き込めなかった場合。
なし ワークブックで指定されたワークブックに書き込めなかった場合
なし セル範囲の指定が不正な場合。

■コネクション設定

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

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

■OnSheetビルダーの使い方

本コンポーネントをダブルクリックするとコネクションに指定された接続情報を使用してOnSheetビルダーが起動します。

OnSheetビルダーの画面構成

ユーザー名
現在ログインしているユーザーのユーザー名が表示されます。
標準ではコネクションに設定されたユーザーが使用されますが、「ユーザーの変更」ボタンから別ユーザーに変更することも可能です。
ワークブック
ログインしているユーザーで参照可能なワークブックの選択リストです。
メイン領域に選択したワークブックの内容が表示されます。
最新の情報に更新
ワークブック一覧とメイン領域に表示しているワークブックの内容をOnSheetサーバーから再取得します。
メイン領域(画面左テーブル)
選択したワークブックのセル内容が表示されます。
表示されるのは各セルの文字情報のみで、罫線、フォント、背景色などは取り込まれません。また、表示範囲はA〜Z列、50行のみです。表示される範囲外であっても、処理対象を指定するダイアログ（後述）で直接入力して表示範囲外を定義することができます。
レコードタブ
入出力を行うレコード範囲の設定を行うタブです。
「追加」ボタンを押すとレコード範囲の設定ダイアログが表示されます。レコードを追加するとタブの下部テーブルにレコード情報が表示され、編集することができます。（レコード情報の内容はOnSheetInputコンポーネントとOnSheetOutputコンポーネントで異なります。） 「変更」「削除」ボタンでは設定したレコード情報の変更、削除が行うことができます。
単一セルタブ
入出力を行う単一セルの設定を行うタブです。
「追加」ボタンを押すと単一セルの設定ダイアログが表示されます。単一セルを追加するとタブのテーブルに単一セル情報が表示され、編集することができます。（単一セル情報の内容はOnSheetInputコンポーネントとOnSheetOutputコンポーネントで異なります。）「変更」「削除」ボタンでは設定した単一セルの変更、削除が行うことができます。
レコード追加ダイアログ

レコードタブで「追加」「変更」ボタンを押した時に表示されるダイアログです。

シート名対象となるシート名を指定します。
メイン領域でタブを変更すると選択したタブ名に値が連動して変わります。
レコード範囲レコード領域となる範囲を指定します。
レコード領域がメイン領域に表示されている範囲内であればドラッグによって選択できます。 メイン領域の範囲外を指定する場合はテキストを直接編集してください。
レコード名任意の名前を指定します。
レコード行数1レコードの行数を指定します。

「フィールド名自動設定」がチェックされている場合はレコード範囲の1行上のセルに設定された文字列がレコードのフィールド名になります。

単一セルダイアログ

単一セルタブで「追加」「変更」ボタンを押した時に表示されるダイアログです。

シート名対象となるシート名を指定します。
メイン領域でタブを変更すると選択したタブ名に値が連動して変わります。
セル位置単一セルの位置を指定します。
単一セルがメイン領域に表示されている範囲内であればそのセルを選択することによって指定できます。 メイン領域の範囲外を指定する場合はテキストを直接編集してください。
項目名任意の名前を指定します。

レコードの設定項目

レコード範囲を設定するとタブ下部のテーブルで選択したレコードの設定を行うことができます。

列セルの列。レコード範囲の指定と連動するので編集できません。
行レコード行数が複数の場合のその行インデックス。レコード範囲の指定と連動するので編集できません。
キーにする書き込み処理が「追加」「挿入」「更新」「削除」の場合にキーとなるフィールドであるかどうかを指定します。
フィールド名任意のフィールド名を指定します。
フィールドに値を差し込むことでシートにその値が書き込まれます。
値の設定では「=sum(J7:J16)」のように式を設定することも可能です。
背景色セルの背景色を設定する場合チェックします。
チェックした場合レコードのフィールド定義に「<フィールド名>_background」という項目が追加されます。
色の指定には「CCCCCC」のようにRGB16進数を使用します。(色名では指定できません)
文字色セルの文字色を設定する場合チェックします。
チェックした場合レコードのフィールド定義に「<フィールド名>_fontColor」という項目が追加されます。
色の指定には「CCCCCC」のようにRGB16進数を使用します。(色名では指定できません)
文字フォントセルの文字フォントを設定する場合チェックします。
チェックした場合レコードのフィールド定義に「<フィールド名>_fontName」という項目が追加されます。
文字サイズセルの文字サイズを設定する場合チェックします。
チェックした場合レコードのフィールド定義に「<フィールド名>_fontSize」という項目が追加されます。

単一セルの設定項目

単一セルを設定するとテーブルでセルの設定を行うことができます。

セル位置シート名を含むセル位置。セル位置を変更する場合は変更ボタンから再設定します。
項目名任意の項目名を指定します。
項目に値を差し込むことでシートにその値が書き込まれます。
値の設定では「=sum(J7:J16)」のように式を設定することも可能です。
背景色セルの背景色を設定する場合チェックします。
チェックした場合単一セルの定義に「<項目名>_background」という項目が追加されます。
色の指定には「CCCCCC」のようにRGB16進数を使用します。(色名では指定できません)
文字色セルの文字色を設定する場合チェックします。
チェックした場合単一セルの定義に「<項目名>_fontColor」という項目が追加されます。
色の指定には「CCCCCC」のようにRGB16進数を使用します。(色名では指定できません)
文字フォントセルの文字フォントを設定する場合チェックします。
チェックした場合単一セルの定義に「<項目名>_fontName」という項目が追加されます。
文字サイズセルの文字サイズを設定する場合チェックします。
チェックした場合単一セルの定義に「<項目名>_fontSize」という項目が追加されます。