SDK 开发指南

SDK 开发指南主要包括：

• 公共资源 SDK 接口：提供公共资源的管理，包括：数据层管理、存算引擎管理、数据源管理、配置环境管理、调度引擎管理、数据租户管理、主题管理。
• 数据开发 SDK 接口：提供轻量交换的开发执行能力，包括：作业流管理、作业流实例、告警组配置、告警配置、告警记录。

下载链接如下：

公共资源 SDK 接口说明

数据开发 SDK 接口说明

如需前端 SDK 示例（sdkdemo-ui），请通过 AME 客服售后》我的源代码申请，发起申请流程。

对应配套后端脚本如下：

-- 基于DWS项目的SDK接口，提供模板简易开发使用的能力，初始化脚本
-- AFC数据库执行，初始化SDKDEMO的菜单资源脚本
-- 先删除
DELETE FROM AFC_APPLICATION_TEMPLATE WHERE ID = 'sdk-demo-app-001';

DELETE FROM AFC_MENU_TEMPLATE WHERE ID in ('sdk-demo-menu-001', 'sdk-demo-menu-002', 'sdk-demo-menu-003',
                                           'sdk-demo-menu-004', 'sdk-demo-menu-005', 'sdk-demo-menu-006',
                                           'sdk-demo-menu-007', 'sdk-demo-menu-008');

DELETE FROM AFC_RES_GROUP_TEMPLATE WHERE ID = 'sdk-demo-resgroup-001';

DELETE FROM AFC_RESOURCE_TEMPLATE WHERE ID in ('sdk-demo-res-001', 'sdk-demo-res-002', 'sdk-demo-res-003',
                                               'sdk-demo-res-004', 'sdk-demo-res-005');
-- 删除模板数据 结束

-- 模板数据插入 开始
-- 数据开发平台应用导入
INSERT INTO AFC_APPLICATION_TEMPLATE(ID, NAME, CODE, TYPES, SECRET, URL, DESCRIPTION,
                                     IS_FIXED, EXTRA, IS_SHARE, ACCESS_TOKEN, REFRESH_TOKEN, OPEN_TYPE,
                                     MICRO_URL, MICRO_MARK, DIMENSION_CODE, IS_LOWCODE, BPS_TENANT_ID)
VALUES ('sdk-demo-app-001', 'SDK项目', 'SDK-DEMO', NULL, '6bea696636194716ac7da8319ef9478e', NULL, NULL,
        NULL, NULL, '0', 5, 30, 'microApp',
        '[{"id":1666762969201,"microMark":"design","microUrl":"/"}]', NULL, NULL, '0', NULL);


-- 数据开发平台菜单导入
INSERT INTO AFC_MENU_TEMPLATE(ID, NAME, CODE, RES_TPL_ID, DESCRIPTION, SORT_NO, IS_LEAF, TREE_LEVEL,
                              SEQ, PARENT_ID, IS_FIXED, OPEN_TYPE, MENU_ICON, IS_PLATFORM)
VALUES ('sdk-demo-menu-001', 'SDK项目', 'sdkdemo', NULL, NULL, 12, '0', NULL, NULL, 'root', NULL, NULL, 'tuandui3','2');
INSERT INTO AFC_MENU_TEMPLATE(ID, NAME, CODE, RES_TPL_ID, DESCRIPTION, SORT_NO, IS_LEAF, TREE_LEVEL,
                              SEQ, PARENT_ID, IS_FIXED, OPEN_TYPE, MENU_ICON, IS_PLATFORM)
VALUES ('sdk-demo-menu-002', '作业流', 'workFlow', NULL, NULL, 1, '0', NULL, NULL, 'sdk-demo-menu-001', NULL, NULL, 'tuandui3','2');
INSERT INTO AFC_MENU_TEMPLATE(ID, NAME, CODE, RES_TPL_ID, DESCRIPTION, SORT_NO, IS_LEAF, TREE_LEVEL,
                              SEQ, PARENT_ID, IS_FIXED, OPEN_TYPE, MENU_ICON, IS_PLATFORM)
VALUES ('sdk-demo-menu-003', '作业流管理', 'workflowManage', 'sdk-demo-res-001', NULL, 1, '1', NULL, NULL, 'sdk-demo-menu-002', NULL, NULL, 'data', '2');
INSERT INTO AFC_MENU_TEMPLATE(ID, NAME, CODE, RES_TPL_ID, DESCRIPTION, SORT_NO, IS_LEAF, TREE_LEVEL,
                              SEQ, PARENT_ID, IS_FIXED, OPEN_TYPE, MENU_ICON, IS_PLATFORM)
VALUES ('sdk-demo-menu-004', '作业流实例', 'workflowInstance', 'sdk-demo-res-002', NULL, 2, '1', NULL, NULL, 'sdk-demo-menu-002', NULL, NULL, 'data', '2');

INSERT INTO AFC_MENU_TEMPLATE(ID, NAME, CODE, RES_TPL_ID, DESCRIPTION, SORT_NO, IS_LEAF, TREE_LEVEL,
                              SEQ, PARENT_ID, IS_FIXED, OPEN_TYPE, MENU_ICON, IS_PLATFORM)
VALUES ('sdk-demo-menu-005', '告警管理', 'alertManage', NULL, NULL, 2, '0', NULL, NULL, 'sdk-demo-menu-001', NULL, NULL, 'tuandui3','2');
INSERT INTO AFC_MENU_TEMPLATE(ID, NAME, CODE, RES_TPL_ID, DESCRIPTION, SORT_NO, IS_LEAF, TREE_LEVEL,
                              SEQ, PARENT_ID, IS_FIXED, OPEN_TYPE, MENU_ICON, IS_PLATFORM)
VALUES ('sdk-demo-menu-006', '告警配置', 'alertPlugin', 'sdk-demo-res-003', NULL, 1, '1', NULL, NULL, 'sdk-demo-menu-005', NULL, NULL, 'data', '2');
INSERT INTO AFC_MENU_TEMPLATE(ID, NAME, CODE, RES_TPL_ID, DESCRIPTION, SORT_NO, IS_LEAF, TREE_LEVEL,
                              SEQ, PARENT_ID, IS_FIXED, OPEN_TYPE, MENU_ICON, IS_PLATFORM)
VALUES ('sdk-demo-menu-007', '告警组管理', 'alertGroup', 'sdk-demo-res-004', NULL, 2, '1', NULL, NULL, 'sdk-demo-menu-005', NULL, NULL, 'data', '2');
INSERT INTO AFC_MENU_TEMPLATE(ID, NAME, CODE, RES_TPL_ID, DESCRIPTION, SORT_NO, IS_LEAF, TREE_LEVEL,
                              SEQ, PARENT_ID, IS_FIXED, OPEN_TYPE, MENU_ICON, IS_PLATFORM)
VALUES ('sdk-demo-menu-008', '告警记录', 'alertInfo', 'sdk-demo-res-005', NULL, 3, '1', NULL, NULL, 'sdk-demo-menu-005', NULL, NULL, 'data', '2');

-- 数据开发平台资源组数据导入
INSERT INTO AFC_RES_GROUP_TEMPLATE(ID, NAME, CODE, TYPES, RES_TPL_TYPE, DESCRIPTION, APP_TPL_ID,
                                   BUSINESS_OBJ_ID, IS_FIXED, SORT_NO, IS_PLATFORM)
VALUES ('sdk-demo-resgroup-001', 'SDK-DEMO', 'sdkDemo', NULL, NULL, NULL, 'sdk-demo-app-001',NULL, NULL, 50, '2');

-- 数据开发-项目配置资源导入
INSERT INTO AFC_RESOURCE_TEMPLATE (ID, NAME, CODE, TYPES, APP_TPL_ID, RES_GROUP_TPL_ID, DESCRIPTION, BUSINESS_OBJ_ID,
                                   CONTENT, IS_FIXED, ROLE_TPL_CODE, SUB_TYPE, IS_PLATFORM, REUSE_TYPES)
VALUES ('sdk-demo-res-001', '作业流管理', 'workflowManage', 'url', 'sdk-demo-app-001',
        'sdk-demo-resgroup-001', null, null,
        '{"openType":"microApp","mark":"workflowManage","url":null,"params":null,"microUrl":null,"microMark":"design","isLowOrHigh":"high","resourceCode":null,"formStatus":null,"resourceType":null,"viewType":null,"appCode":"DWS","query":null,"processDefName":null,"biId":null,"biType":null,"bicode":null}',
        null, 'afc-role-tenant-manager',
        null, '2', null);
INSERT INTO AFC_RESOURCE_TEMPLATE (ID, NAME, CODE, TYPES, APP_TPL_ID, RES_GROUP_TPL_ID, DESCRIPTION, BUSINESS_OBJ_ID,
                                   CONTENT, IS_FIXED, ROLE_TPL_CODE, SUB_TYPE, IS_PLATFORM, REUSE_TYPES)
VALUES ('sdk-demo-res-002', '作业流实例', 'workflowInstance', 'url', 'sdk-demo-app-001',
        'sdk-demo-resgroup-001', null, null,
        '{"openType":"microApp","mark":"workflowInstance","url":null,"params":null,"microUrl":null,"microMark":"design","isLowOrHigh":"high","resourceCode":null,"formStatus":null,"resourceType":null,"viewType":null,"appCode":"DWS","query":null,"processDefName":null,"biId":null,"biType":null,"bicode":null}',
        null, 'afc-role-tenant-manager', null, '2', null);
INSERT INTO AFC_RESOURCE_TEMPLATE (ID, NAME, CODE, TYPES, APP_TPL_ID, RES_GROUP_TPL_ID, DESCRIPTION, BUSINESS_OBJ_ID,
                                   CONTENT, IS_FIXED, ROLE_TPL_CODE, SUB_TYPE, IS_PLATFORM, REUSE_TYPES)
VALUES ('sdk-demo-res-003', '告警配置', 'alertPlugin', 'url', 'sdk-demo-app-001',
        'sdk-demo-resgroup-001', null, null,
        '{"openType":"microApp","mark":"alertPlugin","url":null,"params":null,"microUrl":null,"microMark":"design","isLowOrHigh":"high","resourceCode":null,"formStatus":null,"resourceType":null,"viewType":null,"appCode":"DWS","query":null,"processDefName":null,"biId":null,"biType":null,"bicode":null}',
        null, 'afc-role-tenant-manager', null, '2', null);
INSERT INTO AFC_RESOURCE_TEMPLATE (ID, NAME, CODE, TYPES, APP_TPL_ID, RES_GROUP_TPL_ID, DESCRIPTION, BUSINESS_OBJ_ID,
                                   CONTENT, IS_FIXED, ROLE_TPL_CODE, SUB_TYPE, IS_PLATFORM, REUSE_TYPES)
VALUES ('sdk-demo-res-004', '告警组管理', 'alertGroup', 'url', 'sdk-demo-app-001',
        'sdk-demo-resgroup-001', null, null,
        '{"openType":"microApp","mark":"alertGroup","url":null,"params":null,"microUrl":null,"microMark":"design","isLowOrHigh":"high","resourceCode":null,"formStatus":null,"resourceType":null,"viewType":null,"appCode":"DWS","query":null,"processDefName":null,"biId":null,"biType":null,"bicode":null}',
        null, 'afc-role-tenant-manager', null, '2', null);
INSERT INTO AFC_RESOURCE_TEMPLATE (ID, NAME, CODE, TYPES, APP_TPL_ID, RES_GROUP_TPL_ID, DESCRIPTION, BUSINESS_OBJ_ID,
                                   CONTENT, IS_FIXED, ROLE_TPL_CODE, SUB_TYPE, IS_PLATFORM, REUSE_TYPES)
VALUES ('sdk-demo-res-005', '告警记录', 'alertInfo', 'url', 'sdk-demo-app-001',
        'sdk-demo-resgroup-001', null, null,
        '{"openType":"microApp","mark":"alertInfo","url":null,"params":null,"microUrl":null,"microMark":"design","isLowOrHigh":"high","resourceCode":null,"formStatus":null,"resourceType":null,"viewType":null,"appCode":"DWS","query":null,"processDefName":null,"biId":null,"biType":null,"bicode":null}',
        null, 'afc-role-tenant-manager', null, '2', null);

-- DWS数据库执行脚本
-- DWS插入默认项目信息（若存在冲突需要手动修改ID值）
INSERT INTO DWS_PRJ_PROJECT (ID, CODE, NAME, TYPES, SCHEDULE_CODE, DATA_LEVELS, DATA_TENANT_CODE, REMARK, CREATE_USER, UPDATE_USER, CREATE_TIME, UPDATE_TIME, TENANT_ID, IS_DEFAULT)
VALUES ('4', 5281516048127, 'defaultProject', 'dev', NULL, '{\"dataLevels\":[\"ODS\"]}', NULL, '默认项目,简易模板开发', '1', '1', '2024-07-16 14:58:04', '2024-07-16 14:58:07', 'sys_tenant', '1');