56.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 检查组件目录中的 manifest.json 文件。manifest.json 必须至少包含一个 名称 文本参数。

表 56.5. manifest.json 文件描述

参数描述

name

组件部分下显示的 组件名称

icon

组件部分下显示 的组件 图标。

noData

表示组件不需要数据集的标记。

parameters

参数列表使用 ComponentParameter 类型。支持的参数类型包括 name,type,category,defaultValue,label,mandatory, 和 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
        }
    ]
}

56.6.1. 创建外部组件

以下流程描述了如何在页面中创建和添加外部组件:

流程

  1. 使用父目录在 components 目录下设置组件。

    例如,如果组件 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

    外部组件在组件 窗格中 可用。

  7. Components 窗格中,展开 External 组件,并将所需的组件类型拖到 canvas。
  8. 点击 Save