55.6. 外部コンポーネント

Business Central では、外部コンポーネントをページに追加できます。コンポーネントはデフォルトで無効になっています。外部コンポーネントを有効にするには、dashbuilder.components.enable システムプロパティーの値を true に変更します。

外部コンポーネントの場所が設定され、dashbuilder.components.dir システムプロパティーで設定されます。このシステムプロパティーのデフォルト値は /tmp/dashbuilder/components です。コンポーネント ID として使用される親ディレクトリーを持つ components ディレクトリー下のコンポーネントを設定する必要があります。たとえば、コンポーネント ID が mycomp で、コンポーネントディレクトリーが /tmp/dashbuilder/components の場合、コンポーネントのベースディレクトリーは /tmp/dashbuilder/components/mycomp になります。

Business Central は components ディレクトリーの manifest.json ファイルをチェックします。manifest.json には、1 つ以上の name テキストパラメーターが含まれている必要があります。

表55.3 manifest.json ファイルの説明

パラメーター詳細

name

Components セクションに表示されるコンポーネントの名前。

icon

Components セクションに表示されるコンポーネントのアイコン。

noData

コンポーネントがデータセットを必要としないことを示すフラグ。

parameters

パラメーターの一覧は ComponentParameter タイプを使用しています。サポートされるパラメータータイプには、nametypecategorydefaultValuelabelmandatory、および comboValues が含まれます。

manifest.json ファイルのサンプル

{
    "name": "Heat Map Experiment",
    "icon": "fa fa-bell-o",
    "parameters": [
        {
            "name": "svg",
            "type": "text",
            "defaultValue": "",
            "label": "SVG XML",
            "category": "SVG Content"
            "mandatory": true
        },
        {
            "name": "svgUrl",
            "type": "text",
            "defaultValue": "",
            "label": "SVG URL",
            "category": "SVG URL"
            "mandatory": true
        }
        ,
        {
            "name": "ksProcessId",
            "type": "text",
            "defaultValue": "",
            "label": "Process ID",
            "category": "Kie Server"
            "mandatory": true
        }
    ]
}

55.6.1. 外部コンポーネントの作成

以下の手順では、外部コンポーネントを作成してページに追加する方法を説明します。

手順

  1. コンポーネントディレクトリーの下のコンポーネントを親ディレクトリーとともに設定します。

    たとえば、コンポーネント ID が mycomp で、コンポーネントディレクトリーが /tmp/dashbuilder/components の場合、コンポーネントのベースディレクトリーは /tmp/dashbuilder/components/mycomp になります。

  2. コンポーネントディレクトリーに manifest.json ファイルを作成します。
  3. HTML コンテンツを含む index.html ファイルを作成します。
  4. 端末アプリケーションで EAP_HOME/bin に移動します。
  5. 外部コンポーネントを有効にするには、dashbuilder.components.enable システムプロパティーの値を true に設定します。

    $ ~/EAP_HOME/bin/standalone.sh -c standalone-full.xml
    -Ddashbuilder.components.dir={component directory base path} -Ddashbuilder.components.enable=true
  6. Business Central で、Menu → Design → Pages に移動します。

    外部コンポーネント は、Components ペインで利用できます。

  7. Components ペインで、External Components を展開し、必要なコンポーネントタイプをエディターのキャンバスにドラッグします。
  8. Save をクリックします。