フロー変数の設定

「フロー変数」は、フロー内でのみ設定や参照が可能な変数です。フローデザイナーのウィンドウ右下に表示される変数ペインを使って定義や編集ができます。ここでは、フロー変数を追加し、フロー内の別の場所から参照できるよう、変数に値を設定する方法を説明します。

ファイルパス用のフロー変数を追加する

1.フローウィンドウの右下の「変数」タブをクリックし変数ペインを表示す

HINT

フローデザイナーウィンドウの右下に表示される領域は、「変数」タブをクリックしたときは変数ペイン、「ストリーム」タブをクリックしたときはストリームペインにそれぞれ切り替えられます。

フロー変数とは
フロー内でのみ設定や参照が可能な変数を「フロー変数」といいます。フロー開始時に初期化され、フロー終了までの間、有効です。同一プロジェクトであってもフローが別であれば、フロー変数は別に定義します。新しいフロー変数を定義する場合は、変数ペインへ追加します。

2.「変数名」の入力欄に変数名を入力する

HINT

変数の命名規則
変数名に利用できる文字列として、以下の条件があります。
　•!\"#$%&'()=~^|\\@`+*;:{}[],.<>/?\t を除く文字が使用可能　
　•先頭 1 文字目に数字は使用不可
　•名前の長さには制限なし
　•英字の大文字と小文字は区別される
　•半角空白や日本語を使用できるが、使用する場合、Velocity コンポーネントやプロパティ式では、get を含める get 記法 ( 例 :「$flow.get("var1")」) で記述する

3.必要に応じデータ型やその他の定義を設定する

変数ペインで変数を追加すると、マッピングウィンドウの「フロー変数」の項目にその変数が追加されます。

HINT

フロー変数の定義
変数ペインの「フロー変数タブ」で、変数名とデータ型、初期値、公開の有無などを定義します。「公開」にチェックマークを付けると、外部からの変数の参照が可能になります。また、「変更」のチェックマークを外すと、変更不可の変数となり、マッパーの右側には表示されなくなります。変更不可にする場合、フロー変数に初期値を定義して定数的な使い方をすることができます。

ストリーム変数の種類
ストリーム変数を使う場合、以下の3つの方法を利用できます。
　•フローサービスで予約された名前を使うフローサービス定義のストリーム変数(例:FilePath ストリーム変数)
　•コンポーネントのプロパティで定義したフィールドをストリーム変数として使うコンポーネント定義のストリーム変数(例:HTTPStart コンポーネントの Cookie プロパティ)
　•ユーザーが任意の名前で定義して使うユーザー定義のストリーム変数

フロー変数に値を設定する

1.マッピングウィンドウ右側の変数フィールドに、定義済みのフロー変数を表示し、変数の値に設定したい入力値をマッピングする

マッピングにより入力値が、変数の値として設定されます。

HINT

変数ペインの下部にある「変数ナビ」欄には、フロー変数のフロー内での参照・設定位置が表示されます。

ストリーム変数を定義するには
前出の FilePath 変数のように、自動的に設定されるストリーム変数もありますが、独自のストリーム変数を定義することもできます。それには、マッパーのインスペクタにある「マッパー変数」タブで変数名、データ型、初期値を定義し、ストリーム変数項目で「はい」を選択します。初期値は省略可能です。