プラグインの構成

「通信」タブでは、REST プラグインのインスタンスを追加してパラメーターを構成することができ、ユーザーインターフェースで直接プラグインの開始と停止が可能です。

RESTful API と組み込みウェブアプリケーションのどちらも、有効な場合、プラグインの実行中にのみ使用できます。

MERLIC RTE Setup で構成を有効にする

MERLIC RTE Setup の「通信」タブでプラグインの構成を有効にするには、まず MERLIC RTE を起動し、次の手順を実行する必要があります。

  1. MERLIC RTE Setup を開き、「通信」タブに移動します。MERLIC RTE が起動していない場合は、「通信」タブから直接起動できます。
  2. 左側にあるプラグインインスタンスのリストに「REST」プラグインを追加します。

  3. プラグインが現在は実行されていないことを確認してください。そうでない場合、パラメーターを構成することはできません。プラグインの現在の状態は、プラグインインスタンスのリストに示されるステータスアイコンで確認できます。ステータスにアイコン が表示される場合、プラグインが実行中です。この場合は、MERLIC RTE Setup の下側にある「プラグインの停止」ボタンをクリックして停止する必要があります。代わりにステータスにアイコン が表示される場合、プラグインは実行されていません。下図の例では、REST プラグインの選択したインスタンスが現在実行されていないため、構成が可能です。

  4. 左側で REST プラグインを選択するとそのパラメーターが表示され、構成を開始できます。

「通信」タブの右側には、選択した REST プラグインのパラメーターが表示されます。

Plug-in Parameters

このタイプのパラメーターは、通信プラグインの一般的なパラメーターを表しますが、「通信」タブの構成エリアでは調整することはできません。これらのパラメーターは、プラグインのバージョン番号、ログレベルの現在のパラメーター値、プラグインのアクセスレベルを表すこともあります。これらの値は、それぞれ異なる場所または異なる方法で設定する必要があります。

Version

このパラメーターでは、プラグインの実装時に定義されたバージョン番号が表示されます。これには、メジャー、マイナー、メンテナンスバージョンがあります。新しいプラグインインスタンスを追加したときにも表示されます。バージョンは任意です。したがって、実装時にバージョン番号の定義を省略することもできます。

Log level

このパラメーターは、プラグインインスタンスのログレベルを示します。デフォルトのログレベルは、MERLIC RTE Setup でプラグインインスタンスを追加するときのそれぞれの MERLIC RTE プロセスのログレベルに設定されています。

Access level

このパラメーターはプラグインに設定されているアクセスレベルを示します。REST プラグインの場合、アクセスレベルはデフォルトで「monitor and control」に設定されています。つまり、プラグインは「イベント」を受信して「アクション」を送信することができます。アクセスレベルは、プラグインの実装で定義されている機能と相関関係があります。アクセスレベルは MERLIC RTE Setup では調整できません。

Supports rapid validation

このパラメーターは、プラグインが現在のプラグイン構成の即時検証をサポートしているかどうかを示します。このプラグインでは、チェックボックスにチェックが入っていることで「高速検証」がサポートされていることが示されています。これは、MERLIC RTE Setup の「通信」タブで編集可能なパラメーターを変更するたびにプラグインの構成が検証されることを意味します。プラグインが高速検証をサポートしていない場合、プラグインの構成は構成を保存するときにのみ検証されます。

User Parameters

「User parameters」は、プラグインに構成可能なパラメーターを示します。パラメーターはカテゴリごとに表示され、展開したり閉じたりすることができます。

以下の項では、カテゴリごとのパラメーターについて説明します。

HTTP Server

このカテゴリのパラメーターは、HTTP サーバーの設定を定義します。

以下の図では、パラメーターの概要と、それぞれのデフォルト設定を示しています。パラメーターについては、図の後に詳細な説明があります。

IP address

このパラメーターは、サーバーが接続を監視するネットワークインターフェースのインターネットプロトコルアドレス (IP アドレス) を定義します。このパラメーターは、インターネットプロトコルバージョン 4 (IPv4) とバージョン 6 (IPv6) のどちらのアドレスにも対応しています。

デフォルトでは「127.0.0.1」に設定されているので、RESTful API と組み込みウェブアプリケーションにはローカルマシンからのみアクセス可能です。同じネットワーク内の別のデバイスからアクセスしたい場合は、そのネットワーク内のローカルマシンで対応する IP アドレスを指定する必要があります。

Port

このパラメーターは、サーバーが新しい接続を監視するポートを定義します。デフォルト設定値は「8040」です。

Serve built-in web app

このパラメーターは、組み込みウェブアプリケーションを上記で指定したシステムで提供されるかどうかを定義します。デフォルトでは、このオプションが有効になっており、プラグインがデフォルト設定で実行されている場合、http://127.0.0.1:8040 のウェブブラウザでウェブアプリケーションを確認できます。

In-Memory Database

このカテゴリのパラメーターは、イベント、結果、エラーのバッファ容量の設定を定義します。アクションとジョブの容量は 1MB に構成されており、変更はできません。

以下の図では、パラメーターの概要と、それぞれのデフォルト設定を示しています。パラメーターについては、図の後に詳細な説明があります。

Event store capacity

このパラメーターは、イベントの保存に使用されるバッファのサイズを定義します。デフォルト設定値は 64 MB です。

Result store capacity

このパラメーターは、結果の保存に使用されるバッファのサイズを定義します。デフォルト設定値は 128 MB です。

Error store capacity

このパラメーターは、エラー情報を格納するバッファのサイズを定義します。デフォルト設定値は 16 MB です。

Data retention rate

このパラメーターは、各バッファが容量に達したためにメモリが再利用されるとき、バッファに保持されるメモリの比率を定義します。デフォルト設定値は 70% です。つまり、メモリの 30 % が再利用され、70 % は保持されるということです。

指定した保持率は、容量がちょうど 1 MB のアクションおよびジョブを含めて、データベース内の全データタイプのバッファに適用されます。