OnSheetInput - OnSheetからの入力
OnSheetからセルのデータを読み込み、ストリームまたはプロパティに出力します。本コンポーネントでは、フロー実行時に、次のようなことができます。
- ワークブック内の指定位置の値および表示値の取得
- ワークブック内の複数の指定領域に対するレコードの値および表示値の取得
本コンポーネントを使用するには、OnSheetビルダーを起動し、テンプレートとするOnSheetを参照してワークブック上のセルをコンポーネントのフィールド定義と関連づける必要があります。詳細については下記トピック「OnSheetビルダーの使い方」を参照してください。
OnSheetとの連携の概要や必要な設定については、OnSheetとの連携についてを参照してください。
■ストリーム情報
| 入力 | フォーマット | すべて |
|---|---|---|
| 接続数 | 無制限 | |
| 説明 | 入力ストリームは使用せず、すべて無視します。 | |
| 出力 | フォーマット | Record |
| 説明 |
OnSheetワークブック中の、OnSheetビルダーで定義したレコード領域の内容。 レコード領域が複数定義されている場合には、その数だけ出力ストリームが表示され、レコードの名前が各ストリームの名前となります。 フィールド名の定義はOnSheetビルダー上で行い、フローデザイナー上では変更できません。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| コネクション名 | connection | - | OnSheetサーバーへの接続情報を定義した汎用コネクションを指定します。 | ||||||
| ユーザーを指定する | boolean | - |
処理の実行に使用するユーザーをコネクションで定義されているユーザーを使用するか、
プロパティで指定するかを指定します。
|
||||||
| ユーザー名 | string | 入力＆出力 | ユーザーを指定するが「はい」の場合に処理に使用するユーザー名を指定します。 | ||||||
| パスワード | password | 入力＆出力 | ユーザーを指定するが「はい」の場合に処理に使用するユーザーのパスワードを指定します。 | ||||||
| テンプレート | string | 入力＆出力 |
OnSheetビルダーで使用するテンプレートとなるワークブックを指定します。 テンプレートの指定方法はワークブックプロパティと同じですが通常はOnSheetビルダーによって自動設定されるので変更する必要はありません。 ワークブックがない場合作成プロパティが「はい」の場合、ここで指定したワークブックが複製されます。 |
||||||
| ワークブック | string | 入力＆出力 |
処理を行うワークブックを指定します。 ワークブックの指定方法は以下のいずれかです。
|
||||||
| 空レコードを無視 | boolean | 入力＆出力 |
空行の扱いを指定します。
|
||||||
| ワークブックがない場合作成 | boolean | - | ワークブックで指定されたワークブックが存在しない時にワークブックを作成するかどうかを指定します。
|
||||||
| 共有設定を引き継ぐ | boolean | - |
ワークブックを作成する際にテンプレートとなったワークブックの共有設定を引き継ぐかどうかを指定します。
|
||||||
| シート | category | 入力＆出力 |
OnSheetビルダーで単一セル・レコードを定義したときのシート名が「定義上のシート名」にリストされます。各シートに対応する「読み込むシート名」に値を指定すると、定義したときのシート名に置き換えて、このシート名のセルからデータを読み込みます。 このプロパティはマッパーで値を変更可能なので、入力するシートをフロー中で動的に選択することができます。 |
||||||
| 単一セル | category | 入力 |
ワークブック中の、OnSheetビルダーで定義した単一セル領域です。フロー実行時に、対応するセルのデータがこのプロパティに読み込まれます。また、このプロパティは自動的にストリーム変数になります。本コンポーネントの後に連結したマッパーで、ストリーム変数として見えるようになっています。ストリーム変数については、「はじめに」-「詳細なトピック」-「フローの構成要素」-「変数」-「ストリーム変数」を参照してください。 フィールド名の定義はOnSheetビルダー上で行い、フローデザイナー上では変更できません。 |
||||||
| セル範囲 | category | 入力＆出力 |
OnSheetビルダーで設定した単一セルとレコードの名前とセル範囲がリストされます。 このプロパティに実行時にセル範囲を示す文字列を差し込むことで読み込むセルを動的に変更することができます。 セル範囲の指定は「A1:E10」のように左上端セルの位置と右下端セルの位置を「:」で区切った形式で指定します。 (単一セルの場合は「:」以降の右下端セルの指定は不要です。) 設定値がセル範囲を表していない場合や、元のレコード定義の列数と異なる場合はエラーになります。 (レコード定義の行数は元の定義と異なっていても構いません。) |
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラ メータ | エラー処理フロー へのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | なし | OnSheetサーバーに接続できなかった場合 |
| なし | OnSheetビルダーで定義したセルから読み込めない場合 | |||
| なし | フローのフィールド型への変換エラーが発生した場合 | |||
| なし | セル範囲の指定が不正な場合。 |
■コネクション設定
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行上のセルに設定された文字列がレコードのフィールド名になります。
- 単一セルダイアログ
-
単一セルタブで「追加」「変更」ボタンを押した時に表示されるダイアログです。
シート名 対象となるシート名を指定します。
メイン領域でタブを変更すると選択したタブ名に値が連動して変わります。セル位置 単一セルの位置を指定します。
単一セルがメイン領域に表示されている範囲内であればそのセルを選択することによって指定できます。 メイン領域の範囲外を指定する場合はテキストを直接編集してください。項目名 任意の名前を指定します。
レコードの設定項目
レコード範囲を設定するとタブ下部のテーブルで選択したレコードの設定を行うことができます。
| 列 | セルの列。レコード範囲の指定と連動するので編集できません。 |
|---|---|
| 行 | レコード行数が複数の場合のその行インデックス。レコード範囲の指定と連動するので編集できません。 |
| 終了条件 | レコード読み込みの終了条件を指定します。 セルの値が終了条件で指定した値と等しい場合はレコード範囲の途中であってもそこでレコードの読み込みを終了します。 |
| フィールド名 | 任意のフィールド名を指定します。 |
| 入力値 | セルの入力値を取得する場合チェックします。 チェックした場合レコードのフィールド定義に「<フィールド名>_input」という項目が追加されます。 セルに式が設定されている場合は入力値には「=D1+E1」のような式自体が設定されます。 |
| 表示値 | セルの表示値を取得する場合チェックします。 チェックした場合レコードのフィールド定義に「<フィールド名>_display」という項目が追加されます。 セルに書式設定がされている場合は書式適用後の値が設定されます。 |
単一セルの設定項目
単一セルを設定するとテーブルでセルの設定を行うことができます。
| セル位置 | シート名を含むセル位置。セル位置を変更する場合は変更ボタンから再設定します。 |
|---|---|
| 項目名 | 任意の項目名を指定します。 |
| 入力値 | セルの入力値を取得する場合チェックします。 チェックした場合単一セルの定義に「<項目名>_input」という項目が追加されます。 セルに式が設定されている場合は入力値には「=D1+E1」のような式自体が設定されます。 |
| 表示値 | セルの表示値を取得する場合チェックします。 チェックした場合単一セルの定義に「<項目名>_display」という項目が追加されます。 セルに書式設定がされている場合は書式適用後の値が設定されます。 |