Home > リファレンスガイド > フローコンポーネント > 独自のコンポーネントを開発する > コネクタビルダ

コネクタビルダ

コネクタビルダの使い方の詳細な説明は、Magic xpiのインストールフォルダ内にある"agic xpi Connector Builder PDF "を参照してください。

［コネクタビルダ］ダイアログボックスは、容易にMagic xpiコネクタを定義し、関連したリソースタイプを管理することができます。

このダイアログボックスには2つのペインがあります。左側のペインには、コネクタビルダーで作成されたコネクタのリストが表示されます。(Since version: 4.12)

このダイアログボックスには、以下のフィールドがあります。

フィールド

説明

一般的な詳細

名前

コンポーネントのためのプロジェクト内での必須なユニークな名前。入力された名前は、このプロジェクトの［ツールボックス］ペインで表示されます。次のような特殊文字は読み込めません。ピリオド（.）、疑問符（?）または、スラッシュ(/)。

説明

コンポーネントの説明文

id

コンポーネントId

コネクタのバージョン

コネクタのバージョン番号（最大長30桁）。デフォルトは1.0です。

メジャーバージョンを手動でインクリメントする場合は、このボタンをクリックしてください。マイナーバージョンは、コネクタを保存するたびに自動的にインクリメントされます。

 (Since version: 4.12)

アイコン

参照してコンポーネントのアイコンを選択するか、適切な拡張子(例えばicon.bmp)を持つファイル名を入力します。

ツールボックスグループ

新しいコンポーネントが［ツールボックス］ペインの中で保存してほしいカテゴリーを選択します。

  • Utilities

  • Converters

  • File Management

  • Conectors  (デフォルト)

  • Comunication

  • Mail

  • Messaging

  • Triggers

  • User Components

コネクタがまたトリガと定義された場合、［ツールボックス］ペインのトリガグループにも追加されます。

暗号化キー

8から56文字の独自の暗号化キーを定義します。このキーは、リソースとサービスのパスワードとライセンスのシリアル番号を暗号化したり、復号化するために使用されます

ライセンス機能

生成されたコンポーネントのライセンスで使用する最高10文字(文字のみ)のライセンス機能を定義します。

ライセンス取得

ライセンスシリアル番号(SN)

エンドカスタマーの製造ライセンスのシリアル番号（SN）を入力してください。

Email

ライセンスを送信する電子メール アドレスを入力します。

ライセンスシリアル番号(SN) と Email プロパティの値が入力されると、このボタンが有効になります。そのボタンをクリックしてライセンスを申請します。

エンドポイント

ボタンがクリックされると、このフィールドには、ライセンスが生成されたウェブサイトを指す URL が自動的に入力されます。

［ステップ］タブ：コネクタをステップと定義したい場合、［ステップを含む］チェックボックスを選択してください。

UIタイプ

ユーザインターフェイスのタイプを定義します。ドロップダウンリストから以下のどれかを選択してください：

  • Static (デフォルト) …… メソッドのインタフェースの場合はこのオプションを選択してください。

  • Dynamic

UI実装クラス

.NETのクラス名。［UIタイプ］プロパティ(上記)で Dynamic と設定された場合、これが必要になります。

［Generate UI Project］ボタンをクリックしてください。あらかじめ設定されたプロジェクトのテンプレートを作成するユーティリティが開来ます。このプロジェクトはコネクタのUI部分を開発する上でのj出発点になります。

リソース

選択すると、このコネクタがリソースを使用することを示します。［UIタイプ］プロパティ(上記)がダイナミックに設定されている時だけ、このチェックボックスは有効になります。このチェックボックスが選択されない場合は、チェックボックスは、どのリソースもスタジオのこのコネクタで利用できないことを示すだけなので、リソース構成は削除されません。

［Configure Resource］ボタンをクリックすると、［新規リソースタイプ］ダイアログボックスが開きます。

構成ダイアログはリソースを必要

このチェックボックスを選択すると、設定されたリソースがない時、コンポーネントの構成詳細に入力することができません。これはデフォルトでは、チェックされていません。［UIタイプ］プロパティ(上記)が Static に設定されると、このチェックボックスは無効になり、チェックされない状態になります。

実行テクノロジー

ドロップダウンリストから以下のテクノロジーのどれかを1つを選択してください：

  • Java

  • .NET (デフォルト)

  • Magic xpa

［UIタイプ］プロパティ(上記)がスタティックに設定されると、このチェックボックスは無効になります。

実行時実装クラス

Javaまたは.NETクラスの名前。［UIタイプ］プロパティ(上記)が Static に設定されると、このチェックボックスは無効になります。

［実行プロジェクト作成］ボタンをクリックすると、あらかじめ設定されたプロジェクトのテンプレートを作成するユーティリティが開きます。このプロジェクトは、コネクタの実行部分の開発のための出発点になります。

実行時に必要なリソース

実行中にコンポーネントを使用する時にリソースが必須かどうかを定義します。このチェックボックスはデフォルトで選択され、［UIタイプ］プロパティ(上記)がスタティックに設定されると、このチェックボックスは無効になり、チェックされない状態になります。

メソッド(DAM)インタフェース

［UIタイプ］プロパティ(上記)がダイナミックに設定されると、デフォルトはチェックされない状態になります。［UIタイプ］プロパティがスタティックに設定されると、デフォルトはチェック状態で、読み込み専用になります。

［Configure Methods］ボタンをクリックすると、［ロードメソッド］ダイアログボックスが開きます。すでにメソッドを定義し読み込んだら、［メソッド設定］ダイアログボックスが開きます。

スタティックなXMLインタフェースにメソッドを映す

(スタティックUIでのみ有効)

［UIタイプ］プロパティ(上記)がスタティックに設定され、［メソッド(DAM)インタフェース］プロパティ(上記)がチェックされた場合のみ、このパラメータは有効になります。

選択されると、コネクタはメソッドのためにXMLインタフェースを持ちます。

［トリガ］タブ：コネクタをトリガと定義したい場合は、［トリガを含める］のチェックボックスを選択してください。

UIタイプ

ユーザインターフェイスのタイプを定義します。ドロップダウンリストから以下のどれかを選択してください：

  • Static (デフォルト)

  • Dynamic

UI実装クラス

.NETのクラス名。［UIタイプ］プロパティ(上記)で Dynamic と設定された場合、これが必要になります。 Static と設定された場合は無効になります。

［UI プロジェクト作成］ボタンをクリックしてください。あらかじめ設定されたプロジェクトのテンプレートを作成するユーティリティが開来ます。このプロジェクトはコネクタのUI部分を開発する上でのj出発点になります。

サービス

選択されると、このコネクタがサービスを使用することを示します。［UIタイプ］プロパティ(上記)がダイナミックに設定される時だけ、このチェックボックスは有効です。このチェックボックスが選択されないと、チェックボックスが、どのサービスもスタジオのこのコネクタでは利用できない

ことを示すだけなので、サービス構成は削除されません。

［サービス設定］ボタンをクリックすると、［新規サービスタイプ］ダイアログボックスが開きます。

トリガーは、ローカルエージェントとの互換性を持たせることもできます。トリガーを設定している間、以下の条件を満たす必要があります。

  • サービスが定義され、ステップタブで構成されたリソースにリンクされている。

  • トリガー呼び出しタイプの値が外部に設定されている。

  • ランタイム技術の値は、Java に設定されています。その他のランタイム技術はサポートされていません。

  • ランタイム実装クラスのパスが提供されています。

Since version: 4.12

サービス実施クラス

［検証］ボタンと作成された他のすべての動作ボタンのために、サービスインタフェースを実装する.NETクラス名。

［サービス］チェックボックスが選択され、［UIタイプ］プロパティ(上記)でスタティックと設定された場合のみ、有効になります。

構成ダイアログはリソースを必要

このチェックボックスを選択すると、設定されたサービスがない時、コンポーネントの構成詳細に入力することができません。これはデフォルトでは、チェックされていません。［UIタイプ］プロパティ(上記)が Static に設定されると、このチェックボックスは無効になり、チェックされない状態になります。

トリガ呼出しタイプ

コンポーネントのためにトリガ呼出しタイプを定義します。ドロップダウンリストから以下のどれかをを選択してください。

  • Polling  (デフォルト)

  • External

  • Endpoint (Since version: 4.6)

UI type プロパティ（上記）が Static に設定されているときに Endpoint を選択した場合、Magic xpi Studio で生成されたトリガー UI には必須の Endpoint フィールドが含まれます。

エンドポイント トリガーは、Magic xpi エンジンの下で実行されていないトリガーを表します。Endpoint トリガーはすべてのプロジェクトで一意です（単一の空間で一意です）。このようなトリガーの例としては、IIS/Apache の下で動作する HTTP トリガーがあります。

スタジオのSDKトリガーのエンドポイント名は、大文字と小文字を区別します。同じ名前で、異なるフローで異なる大文字小文字の異なる2つのトリガーを定義すると、2つの異なるエンドポイントとみなされます。

Standalone Invoker.zipファイルは、<Magic xpi installation>/Runtime/Supportフォルダ内にあり、外部アプリケーションからMagic xpiを起動するために必要なすべてのファイルを保持しています。

 

Magic xpi 4.12では、ポーリングとエンドポイントトリガーの呼び出しタイプはサポートされていません。

フロー呼出し時の動作

コンポーネントのフロー呼出しの動作を定義します。ドロップダウンリストから以下のどれかをつを選択します。

  • Sync-Wait …… フロー呼出しは同期的です。フローが定義された最大インスタンス数内にある場合、メッセージを待ちます。

  • Sync-No Wait(デフォルト) …… フロー呼出しは同期的です。しかし、フローがその定義された最大インスタンス数内にある場合、メッセージを待つことなく、エラーが直ちに返ります。

  • Async …… フロー呼出しは非同期です。メッセージが一旦スペースにあり、フローが結果の戻りを待たなかったら、メソッド呼出は戻ってきます。

非同期の呼出しは、コールバックメソッドを持つメッセージングトリガのような戻り値のないトリガに対して適しています。

同期呼出しは、TCPトリガのような戻り値のあるトリガに適しています。

実行テクノロジー

ドロップダウンリストから以下のテクノロジーのどれかを1つを選択してください：

  • Java

  • .NET (デフォルト)

  • Magic xpa

  • ローカル エージェントでは、ランタイム テクノロジーの値が Java に設定されているトリガーのみがサポートされます。他のランタイムテクノロジーはサポートされていません。

  • Magic xpi 4.12では、.NETとMagic xpaのランタイムテクノロジーはサポートされていません。

このパラメータは、以下の場合は無効です。

  • ［トリガ呼出しタイプ］がエンドポイントに設定された場合。 (Since version: 4.6)

実行時実装クラス

Javaまたは.NETクラスまたはMagic xpa.ecfファイルの名前。［UIタイプ］プロパティ(上記)が Static に設定されると、このチェックボックスは無効になります。

［実行プロジェクト作成］ボタンをクリックすると、あらかじめ設定されたプロジェクトのテンプレートを作成するユーティリティが開きます。このプロジェクトは、コネクタの実行部分の開発のための出発点になります。

［UIタイプ］プロパティが Dynamic に設定され［トリガ呼出しタイプ］が Endpoint に設定されると、このパラメータは無効になります。(Since version: 4.6)

実行にはサービスが必要

実行中にコンポーネントの使用する時にサービスが必須であるかどうかを定義します。このチェックボックスはデフォルトで選択され、［UIタイプ］プロパティ(上記)が Static に設定され、無効でチェックされない状態になります。

引数の設定：［UIタイプ］プロパティ(上記)がスタティックに設定される時だけ、このセクションは有効になります。［新規］、［削除］そして［全て削除］のボタンを使用することで引数の追加や削除を行うことができます。

名前

Magic xpiへの外部呼出しによってコンポーネントに送られる引数の名前。特殊文字で開始することはできません。

タイプ

引数のデータタイプ。ドロップダウンリストから以下のどれかを1つを選択してください：

  • Alpha

  • Numeric

  • Logical

  • Date

  • Time

  • BLOB

長さ

Magic xpiに引数のフォーマットをどのように定義するかを指定する文字列。例えば、15文字の英数字パラメータには、15の書式定義があります。

日付を定義する書式は、DD/MM/YYYY になります。

方向

引数の方向が入力または出力パラメータのどちらであるかを定義します。ドロップダウンリストから以下のどれかをつを選択してください：

  • In

  • Out

  • トリガはいくつかのInパラメータを持つことができますが、Returnパラメータは1つだけです。

  • ポーリングトリガは、Inパラメータのみを持つことができます。

  • 外部トリガは、リターンパラメータと同様にInを持つことができます。

ツールティップ

カーソルが引数上にホバリングする時に表示されるツールティップ。

ボタンをクリックして、［ツールティップ説明］ボックスに必要なツールティップに入力してください。

値タイプ

引数の値タイプを表示する方法。ドロップダウンリストから以下のどれかを選択してください：

  • Expression

  • Variable

  • Combo

［リソース] タブ： [リソースを含める] ボタンをクリックします。ユーザー定義のリソースタイプを変更したい場合は、[一般的な詳細]タブの[リソースを含める]ボタンをクリックします。新しいリソースを追加する方法の詳細については、ここをクリックしてください。

［エラー] タブ：［エラー詳細］ダイアログボックスが開きます。ここでは、新しいコンポーネントのためにエラーのセットを定義することができます。コンポーネントに対して任意のエラーコードを定義することができます。新しいエラーは、［グローバルエラー］リポジトリに追加され、コンポーネントXMLファイルに追加されます。

 

Since version:

4.5

Since version:

4.12 新規インタフェース