SDKツールガイド

  1. SDK付属ツールについて
    1. ANT
  2. コンポーネントウィザード
    1. 基本設定
    2. Javaクラスの設定など
    3. 入力ストリーム設定
    4. 出力ストリーム設定
    5. プロパティ設定
    6. ソースコード設定
    7. buildファイル設定
  3. マッパー関数ウィザード
    1. 基本設定
    2. Javaクラスの設定など
    3. 入出力の設定
    4. プロパティ設定
    5. ソースコード設定
    6. buildファイル設定
  4. ウィザードで生成されるファイル
    1. build.xml
    2. srcフォルダ
    3. resourceフォルダ
    4. ヘルプについて
  5. 作成したjarファイルのインストール
  6. jarファイルのアンインストール

1 SDK付属ツールについて

フローサービスでは標準でJavaInterpreterコンポーネント/マッパー関数があり任意のJavaコードを実行することができます。
それらの右クリックメニューからSDKでコンポーネント/マッパー関数を作成するためのファイル一式を生成することができます。

ここではそれぞれのウィザードの使い方と生成されるファイルの説明、作成したjarファイルのフローサービスへのインストール方法を説明します。

1.1 ANT

SDKで開発を行うためにはJava環境でのビルドツールとして広く使われているApacheのANTが必要です。
ANTはApache ANT Projectからフリーでダウンロードできるので詳細な使用方法についてはそちらを参照してください。

2 コンポーネントウィザード

コンポーネントウィザードはJavaInterpreterコンポーネントの右クリックメニュー「カスタムコンポーネントの作成」から実行できます。
以下にウィザードの各画面での入力項目について説明します。

2.1 基本設定

  1. コンポーネント名
    コンポーネント名を指定してください。
    コンポーネント名はフローサービス内の全コンポーネントで一意である必要があります。
    他社の作成したコンポーネントとの名前のバッティングを防ぐため「<会社名>.<コンポーネント名>」のように名前の付け方を工夫してください。
    原則として「.」の入っていないコンポーネント名は絶対に使用しないでください。また、「/」は使用できません。
  2. 表示名
    コンポーネントの表示名を指定してください。
    通常フローのユーザーが目にするコンポーネント名はここでの設定値になります。
    省略した場合はコンポーネント名が表示名になります。
    表示名に「/」は使用できません。
  3. アイコンファイル
    パレットに表示するアイコンファイル(32 * 32ピクセル png)を指定してください。
  4. パレットのタブ
    インストール時にコンポーネントを載せるパレットのタブ名を指定してください。
    既存のタブを選択することも新たなタブを追加することもできます。
  5. ツールチップ
    コンポーネントのツールチップを入力してください。
    ツールチップはパレットのアイコン上でマウスカーソルをとめた時に表示されます。

2.2 Javaクラスの設定など

  1. クラス名
    生成するJavaソースコードのクラス名を指定してください。
  2. パッケージ名
    生成するJavaソースコードのpackage名を指定してください。
  3. 生成したファイルを保存するフォルダ
    生成したファイル一式を保存するフォルダを指定してください。
    複数コンポーネント(またはマッパー関数)をひとつのjarファイルにまとめる場合は、ここでの指定を同じ場所にします。

2.3 入力ストリーム設定

  1. 入力をそのまま出力する
    入力ストリームをそのまま出力する場合はチェックしてください。
    JavaInterpreterコンポーネントのプロパティ値から自動設定されるので通常は変更する必要はありません。
  2. 受け入れ可能なストリーム数
    JavaInterpreterコンポーネントでは受け入れ可能なストリーム数(=接続可能なコンポーネント数)はひとつに制限されていますが、カスタムコンポーネントでは複数の入力を受け入れることができます。
    必要な場合は変更してください。
  3. 受け入れ可能なストリーム型
    JavaInterpreterコンポーネントではすべてのストリーム型を受け入れることができますが、カスタムコンポーネントでは接続可能なストリーム型を制限することができます。
    作成するコンポーネントで受け入れるストリーム型にだけチェックを入れて下さい。
  4. 入力ストリームの初期値
    受け入れ可能なストリーム型の中から一番使用頻度の高いであろうストリーム型を設定してください。
    リンク線の接続時に入出力のストリーム型がマッチしない場合には、デザイナーがこの情報を元にストリーム型を変更することがあります。

2.4 出力ストリーム設定

  1. 出力可能なストリーム型
    カスタムコンポーネントが出力できるストリーム型をチェックしてください。
    デフォルトではJavaInterpreterコンポーネントに設定されているストリーム型のみチェックが入っています。
    それ以外の型も出力可能である場合はチェックを追加してください。
  2. 出力ストリームの初期値
    出力可能なストリーム型の中から一番使用頻度の高いであろうストリーム型を設定してください。
    パレットからコンポーネントをドロップした時のストリーム型がここでの設定値になります。

2.5 プロパティ設定

カスタムコンポーネントに定義するプロパティの設定を行います。
デフォルトではJavaInterpreterコンポーネントのパラメータータブでの定義内容が設定されているので必要に応じて変更してください。
(ウィザードではあまり細かい設定はできないので慣れてくると生成されたJavaソースコードと定義ファイルを直接変更する方が簡単です。)

  1. プロパティ名
    プロパティ名を指定してください。
    デフォルトではJavaInterpreterコンポーネントに設定されたパラメーター名が入っています。
    名前にはJavaの識別子として使用可能な名前を指定してください。
  2. 表示名
    プロパティの表示名を指定してください。
    省略した場合はプロパティ名が表示名になります。
    表示に日本語を使用する場合でもプロパティ名は英語とし、表示名で日本語を指定することを推奨します。

  3. プロパティ型を指定します。
    フローサービスで使用可能なプロパティ型すべてがここで設定できるわけではありません。
    ドロップダウンリストにないプロパティ型を使用する場合はファイル生成後に直接定義ファイルを変更してください。
    プロパティ型の詳細については定義ファイルリファレンスを参照してください。
  4. エディタ
    プロパティ型が「string」の場合にのみ指定可能です。
    プロパティエディタに複数行入力可能なダイアログを使用する場合は「multiline」を指定します。
    指定がない場合はプロパティエディタは1行テキストの入力ダイアログになります。
  5. デフォルト値
    プロパティのデフォルト値を設定してください。
    プロパティ型が「choice」または「editableChoice」の場合はその選択肢を改行区切りで入力してください。
  6. 必須
    プロパティ値が必須項目の場合はtrueを指定してください。
    必須とするとインスペクタ上でプロパティ名が太字で表示されます。
  7. ツールチップ
    プロパティのツールチップを指定してください。
  8. マッピング
    プロパティがマッピング可能であるかどうかを指定してください。

コンポーネントをダブルクリックした時に何らかのプロパティ設定を行う場合は「ダブルクリック時にプロパティエディタを起動する」に チェックを入れて編集するプロパティ名を選択してください。

2.6 ソースコード設定

デフォルトではJavaInterpreterコンポーネントで設定されたソースコードがimport文とそれ以外に分かれて設定されていて、ここで編集することもできます。

高度な設定では次の2つの項目を設定できます。

この二つにチェックを入れておくと生成されるソースコードが変更なしでコンパイルが通る確率が上がります。
ただしJavaでのプログラミング作法としてはあまりよろしくないので、慣れてきたらチェックを外してソースコードを自分で修正するようにした方が良いです。

そもそも自動生成されるソースコードはJavaInterpterのソースコードをそのまま実行するためにdoExecuteの返り値をObjectとし、型をチェックして分岐すると いう冗長なコードになっています。
行う処理が決まっていればこれらはもっと簡潔に書きなおせるので、できるだけソースコードは自分で修正するようにしてください。

2.7 buildファイル設定

  1. build.xmlを生成
    build.xmlを生成する場合はチェックしてください。
    複数のカスタムコンポーネントをひとつのjarファイルにまとめる場合、2つ目以降のコンポーネントではウィザードの2ページ目で既存のbuild.xmlがあるフォルダ を指定した上でチェックを外します。
  2. jarファイル名
    生成するjarファイル名を指定します。
    標準で提供されるコンポーネント/マッパー関数のjarファイル名はすべて「fcXXXX.jar」のように「fc」で始まる名前となっています。標準で提供されるコンポーネント/マッパー関数とのjarファイル名のバッティングを避けるために、「fc」で始まるjarファイル名は使用しないでください。
  3. バージョン番号
    jarファイルのバージョン番号を指定してください。
    バージョン番号の振り方には特に規定はありません。
    (標準で提供されるjarファイルのバージョン番号は原則「4.0」になっています。)
  4. すぐにビルドを実行する
    マシンにANTがインストールされていて実行可能な場合はチェックを入れるとウィザード終了後すぐにビルドが実行され、実行結果がダイアログで表示されます。
  5. ASTERIA WARPサーバーのインストールパス
    同一マシン上にASTERIA WARPサーバ−がインストールされている場合はそのインストールフォルダーを指定します。
    指定がある場合はANTでが行えるようになります。

3 マッパー関数ウィザード

マッパー関数ウィザードはJavaInterpreter関数の右クリックメニュー「カスタム関数の作成」から実行できます。
以下にウィザードの各画面での入力項目について説明します。

3.1 基本設定

  1. マッパー関数名
    マッパー関数名を指定してください。
    マッパー関数名はフローサービス内の全マッパー関数で一意である必要があります。
    他社の作成したマッパー関数との名前のバッティングを防ぐため「<会社名>.<マッパー関数名>」のように名前の付け方を工夫してください。
    原則として「.」の入っていないコンポーネント名は絶対に使用しないでください。
  2. 表示名
    マッパー関数の表示名を指定してください。
    通常フローのユーザーが目にするマッパー関数名はここでの設定値になります。
    省略した場合はマッパー関数名が表示名になります。
  3. アイコンファイル
    パレットに表示するアイコンファイル(32 * 32ピクセル png)を指定してください。
  4. パレットのタブ
    インストール時にマッパー関数を載せるパレットのタブ名を指定してください。
    既存のタブを選択することも新たなタブを追加することもできます。
  5. ツールチップ
    マッパー関数のツールチップを入力してください。
    ツールチップはパレットのアイコン上でマウスカーソルをとめた時に表示されます。

3.2 Javaクラスの設定など

  1. クラス名
    生成するJavaソースコードのクラス名を指定してください。
  2. パッケージ名
    生成するJavaソースコードのpackage名を指定してください。
  3. 生成したファイルを保存するフォルダ
    生成したファイル一式を保存するフォルダを指定してください。
    複数マッパー関数(またはコンポーネント)をひとつのjarファイルにまとめる場合は、ここでの指定を同じ場所にします。

3.3 入出力の設定

  1. 最小入力数
    マッパー関数が動作するために最低限必要な入力数を指定してください。
    入力が必要ない場合は0を指定します。
  2. 最大入力数
    マッパー関数に接続できる入力リンクの最大数を指定してください。
  3. 出力数
    マッパー関数の出力数を指定してください。
    デフォルトではJavaInterpreter関数の出力数プロパティ値が設定されているので通常は変更する必要はありません。

3.4 プロパティ設定

カスタムマッパー関数に定義するプロパティの設定を行います。
追加するプロパティを必要に応じて設定してください。
(ウィザードではあまり細かい設定はできないので慣れてくると生成されたJavaソースコードと定義ファイルを直接変更する方が簡単です。)

  1. プロパティ名
    プロパティ名を指定してください。
  2. 表示名
    プロパティの表示名を指定してください。
    省略した場合はプロパティ名が表示名になります。
    表示に日本語を使用する場合でもプロパティ名は英語とし、表示名で日本語を指定することを推奨します。

  3. プロパティ型を指定します。
    フローサービスで使用可能なプロパティ型すべてがここで設定できるわけではありません。
    ドロップダウンリストにないプロパティ型を使用する場合はファイル生成後に直接定義ファイルを変更してください。
    プロパティ型の詳細については定義ファイルリファレンスを参照してください。
  4. エディタ
    プロパティ型が「string」の場合にのみ指定可能です。
    プロパティエディタに複数行入力可能なダイアログを使用する場合は「multiline」を指定します。
    指定がない場合はプロパティエディタは1行テキストの入力ダイアログになります。
  5. デフォルト値
    プロパティのデフォルト値を設定してください。
    プロパティ型が「choice」または「editableChoice」の場合はその選択肢を改行区切りで入力してください。
  6. 必須
    プロパティ値が必須項目の場合はtrueを指定してください。
    必須とするとインスペクタ上でプロパティ名が太字で表示されます。
  7. ツールチップ
    プロパティのツールチップを指定してください。

マッパー関数をダブルクリックした時に何らかのプロパティ設定を行う場合は「ダブルクリック時にプロパティエディタを起動する」に チェックを入れて編集するプロパティ名を選択してください。

3.5 ソースコード設定

デフォルトではJavaInterpreter関数で設定されたソースコードがimport文とそれ以外に分かれて設定されていて、ここで編集することもできます。

高度な設定では次の2つの項目を設定できます。

この二つにチェックを入れておくと生成されるソースコードが変更なしでコンパイルが通る確率が上がります。
ただしJavaでのプログラミング作法としてはあまりよろしくないので、慣れてきたらチェックを外してソースコードを自分で修正するようにした方が良いです。

マッパー関数のソースコードはコンポーネントに比べて単純なので、そのまま動作する可能性は高いです。
生成されるコードもそれほど冗長にはならないのでそのまま使用しても特に問題はありません。

ただしJavaInterpreter関数には追加のプロパティを定義する機能がないので、その場合はソース修正が必要になります。

3.6 buildファイル設定

  1. build.xmlを生成
    build.xmlを生成する場合はチェックしてください。
    複数のカスタム関数をひとつのjarファイルにまとめる場合、2つ目以降の関数ではウィザードの2ページ目で既存のbuild.xmlがあるフォルダ を指定した上でチェックを外します。
  2. jarファイル名
    生成するjarファイル名を指定します。
    標準で提供されるコンポーネント/マッパー関数のjarファイル名はすべて「fcXXXX.jar」のように「fc」で始まる名前となっています。標準で提供されるコンポーネント/マッパー関数とのjarファイル名のバッティングを避けるために、「fc」で始まるjarファイル名は使用しないでください。
  3. バージョン番号
    jarファイルのバージョン番号を指定してください。
    バージョン番号の振り方には特に規定はありません。
    (標準で提供されるjarファイルのバージョン番号は原則「4.0」になっています。)
  4. すぐにビルドを実行する
    マシンにANTがインストールされていて実行可能な場合はチェックを入れるとウィザード終了後すぐにビルドが実行され、実行結果がダイアログで表示されます。
  5. ASTERIA WARPサーバーのインストールパス
    同一マシン上にASTERIA WARPサーバーがインストールされている場合はそのインストールフォルダーを指定します。
    指定がある場合はANTでが行えるようになります。

4 ウィザードで生成されるファイル

ウィザードで生成されるアウトプットはすべてウィザードの2ページ目で指定した出力フォルダに保存されます。
コンポーネントの場合もマッパー関数の場合も生成されるファイルの種類は同じです。
以下で生成される主要なファイルについて説明します。

4.1 build.xml

ANTのビルドファイルです。
主要なタスクとして次のものが定義されています。

4.2 srcフォルダ

ウィザードの2ページ目で指定されたパッケージ名とクラス名でJavaのソースファイルが生成されます。
またソースファイルと同じ場所にデザイナーで使用する定義ファイルも生成されます。

4.3 resourceフォルダ

ウィザードの1ページ目で指定したアイコンファイルとバージョン情報ファイル(version.xml)が生成されます。
version.xmlはビルド時にウィザード最終ページで指定したバージョンとビルドナンバー(ビルドを実行するごとにインクリメントされる)が 埋め込まれてjarファイルの中に組み込まれます。

4.4 ヘルプについて

ビルドを実行するとヘルプファイルの雛型とそれを元にヘルプのHTMLがdocフォルダに生成されます。
ヘルプの詳細についてはヘルプ書式ガイドを参照してください。

5 作成したjarファイルのインストール

完成したjarファイルのフローサービスおよびフローデザイナーへの完全なインストール手順は次のようになります。

  1. フローサービス停止
  2. [DATA_DIR]/system/lib/componentsに作成したjarファイルをコピー
  3. フローサービス起動
  4. フローデザイナーでフローサービスに接続
  5. メニューの「ツール > コンポーネント/マッパー関数の取得」でjarファイルを取得
  6. フローデザイナー再起動

(やっていること自体はbuild.xmlのcpタスクと同じです。)

コンポーネント、マッパー関数のjarファイル以外に独自のライブラリを使用している場合は 「[DATA_DIR]/system/lib/userlib」にjarファイルをコピーしてください。

6 jarファイルのアンインストール

インストールしたjarファイルをアンインストールする手順は次のようになります。

サーバー

  1. フローサービス停止
  2. [DATA_DIR]/system/lib/componentsからjarファイルを削除
  3. フローサービス起動

デザイナー

  1. メニューの「ツール > コンポーネント/マッパー関数の削除」でjarファイルを削除
  2. デザイナー再起動

サーバーの方はjarファイルを削除するだけですが、デザイナーでは停止状態でjarファイルだけを削除しても定義ファイルやアイコンなどの 関連ファイルが残ってしまうので必ずメニューから削除してください。