WeCube-Platform 插件开发规范

imageName  -- 镜像名，对应镜像包load出来的镜像，例如：service-mt:v0.6 、wecmdb:v0.1
containerName  --  容器名，为了避免容器重名， 建议命名为镜像包+版本号，例如： service-mt-v0.6、 wecmdb-v0.1
portBindings  -- 端口映射参数，必须是“{{ALLOCATE_PORT}}:21000”格式，{{ALLOCATE_PORT}}是WeCube分配的端口，冒号后面是容器提供服务的端口
volumeBindings  -- 卷绑定参数，必须是“{{BASE_MOUNT_PATH}}/service-mt/log:/log”格式， {{BASE_MOUNT_PATH}}是WeCube配置的默认绑定路径,可通过系统参数BASE_MOUNT_PATH配置
envVariables  -- 容器环境变量， 容器启动所需参数，例如envVariables="DB_HOST={{DB_HOST}},DB_PORT={{DB_PORT}},DB_SCHEMA={{DB_SCHEMA}},DB_USER={{DB_USER}},DB_PWD={{DB_PWD}},CORE_ADDR={{CORE_ADDR}}"

1.在register.xml中的系统参数部分定义 新的系统参数，例如：
    <systemParameters>
        <systemParameter name="CMDB_VAR1" defaultValue='aaa' scopeType='global'/>
        <systemParameter name="CMDB_VAR1" defaultValue='bbb' scopeType='plugin-package'/>
    </systemParameters>
2.register.xml中的docker部分使用自定义参数：
    <resourceDependencies>
        <docker imageName="wecmdb:v0.1" containerName="wecube-plugins-wecmdb" portBindings="{{ALLOCATE_PORT}}:8081" envVariables="VAR1={{CMDB_VAR1}},VAR2={{CMDB_VAR2}}"/>
    </resourceDependencies>
3.插件包上传后，xml所定义的参数会写入到system_variable表里；
4.用户可以通过WeCube的“系统参数”菜单可以修改参数值（可选）
5.创建插件实例时，会找到envVariables中两个大括号中的变量名，然后以system_variable的value替换（若value为空，则使用defaultValue）。然后将替换后的值以env变量的方式传入到容器中。

action - API的主要动作，有多个单词请使用驼峰命名方式，不允许带空格或其他连接符
path - API的path
httpMethod - http方法，支持标准的http方法取值，纯大写字母，如'GET'、'POST'
isAsyncProcessing - 是否异步接口，取值范围有'Y'(是)和'N'（否）,默认'N'
type - 取值范围有'EXECUTION'（执行类）和'APPROVAL'（审批类）,不声明时默认'EXECUTION'

datatype  --  数据类型
mappingType  --  参数类型，目前支持system_variable、context、entity三种
required  --  是否必输
mappingEntityExpression  -- 模型表达式，当mappingType为entity的时候，该字段有效

输入参数
{
    "requestId": "request-001",  //仅异步调用需要用到
    "operator": "admin",  //操作人
    "inputs": [  
        {},
        {},
        {}
    ]
}

输出参数
{
    "resultCode": "0",  //调用插件结果，"0"代表调用成功，"1"代表调用失败
    "resultMessage": "success",  //调用结果信息，一般用于调用失败时返回失败信息
    "results": {
        "outputs": [
            {},
            {},
            {}
        ]
    }
}

<interface action="create" path="/service-mgmt/v1/tasks" httpMethod='POST' isAsyncProcessing="Y" type="APPROVAL">
    <inputParameters>
        <parameter datatype="string" mappingType='system_variable' mappingSystemVariableName='CALLBACK_URL' required='Y'>
            callbackUrl
        </parameter>
        <parameter datatype="string" mappingType='constant' required='Y'>taskName</parameter>
        <parameter datatype="string" mappingType='constant' required='Y'>roleName</parameter>
    </inputParameters>
    <outputParameters>
        <parameter datatype="string">errorCode</parameter>
        <parameter datatype="string">errorMessage</parameter>
        <parameter datatype="string">taskResult</parameter>
    </outputParameters>
</interface>

{
    "requestId": "request-001",
    "operator": "admin",
    "inputs": [
        {
            "callbackParameter": "callback001",
            "taskName": "task-001",
            "roleName": "admin",
            "callbackUrl": "/v1/process/instances/callback"
        },
        {
            "callbackParameter": "callback002",
            "taskName": "task-002",
            "roleName": "admin",
            "callbackUrl": "/v1/process/instances/callback"
        }
    ]
}

{
    "resultCode": "0",
    "resultMessage": "success",
    "results": {
        "outputs": [
            {
                "callbackParameter": "callback001",
                "errorCode": "0",
                "errorMessage": "",
                "taskResult": "Approve"
            },
            {
                "callbackParameter": "callback002",
                "errorCode": "1",
                "errorMessage": "Reject this request",
                "taskResult": "Reject"
            }
        ]
    }
}

<menus>
    <menu code='JOBS_TASK_MANAGEMENT' cat='JOBS' displayName="Task Management">/task-management</menu>
</menus>

ui.zip
└─dist
    ├─css
    ├─fonts
    ├─img
    └─js

wecmdb-v1.0.zip 
 +-  register.xml                         -- [必选] 注册描述文件
 +-  image.tar                            -- [必选] 后端服务docker镜像包
 +-  ui.zip                               -- [可选] 前端资源包
 +-  init.sql                             -- [可选] 初始化数据库表结构sql
 +-  upgrade.sql                          -- [可选] 连续版本升级数据库sql