# 变更记录 |产品版本（季度版本号/patch补丁号）|更新内容|更新日期| |-|-|-| |V6.0.6|初始版本|2024.01.17| --- # 1 简介 ## 1.1 功能介绍 用于快速将苍穹平台各类业务数据的变化定义为业务事件，供对接方订阅使用，同时提供事件增删改查、目录治理等功能。 ## 1.2 应用场景 1、苍穹平台标准业务事件资产开发和治理，包括事件规范、资产目录等。 2、开发者配置平台开放事件供第三方系统订阅使用。 ## 1.3 面向用户 事件开发者 ## 1.4 系统路径 【开放服务云】-【OpenAPI】-【开放事件】-【开放事件管理】 ## 1.5 关键字段/按钮说明 ### 1.5.1 字段说明 | 字段名称 | 字段说明 | | ---------- | ------------------------------------------------------------ | | 基本信息 | | | 事件编码 | 事件的唯一标识，全局唯一。
编码规则为：{isvc}.kemopenevt.{catagoryCode}.{eventcode}，全部转换成英文小写
{isvc}：表示开发商标识，如果开发商标识是“kingdee”，则会省略
kemopenevt： 表示开放事件指定的数据源，系统预置不可修改
{catagoryCode}：表示事件所属分类的编码，此处是 云编码+“.”+应用编码
{eventCode}：用户输入的事件编码 | | 事件名称 | 事件的名称 | | 使用状态 | 使用状态分为：可用、禁用 | | 事件类型 | 目前仅支持操作事件，即执行业务对象的操作时触发的事件 | | 业务对象 | 产生事件的业务对象 | | 所属应用 | 产生事件的业务对象所属的应用 | | 操作 | 产生事件的业务对象操作。可选择系统预置的该业务对象的操作方式，包括：保存、删除、审核等 | | 开发商标识 | 配置事件的用户所属开发商的标识。非本开发商的数据不允许修改。 | | 事件描述 | 事件的描述信息 | | 事件参数 | | | 参数名称 | 事件触发是传递参数的名称 | | 参数类型 | 参数的数据类型 | | 多值 | 参数是否是多值，如果为是则此参数以数组形式推送 | | 说明 | 参数的描述说明 | | 示例 | 参数的示例值 | ### 1.5.2 按钮说明 | 按钮名称 | 功能说明 | | ---------------- | ------------------------------------------------------------ | | 事件操作按钮 | | | 新增 | 新增单个事件 | | 复制 | 勾选某个事件复制出来一个新的事件数据 | | 删除 | 删除事件，仅禁用状态下的数据可删除，支持批量操作 | | 启用 | 启用事件，支持批量操作 | | 禁用 | 禁用事件，支持批量操作 | | 导入\导出 | 导入导出功能主要用于数据分享和数据跨环境迁移，支持导出dts、导出zip、导入dts
导出dts：支持多条事件导出成一个dts文件，单个文件最多支持20条事件数据
导出zip：支持多条事件导出成一个zip包，zip包内每一个事件存放一个dts文件里面，单个zip包最多可导出20条事件数据
导入dts：支持解析dts数据，并导入成事件数据。单次最多导入20条事件数据。 | | 事件参数操作按钮 | | | 添加属性 | 弹出对象选择弹窗，支持批量勾选，点击确定后会自动填充数据到事件参数列表中 | | 预览 | 点击按钮，可预览事件参数的JSON结构 | | 删行 | 点击按钮，删除勾选行数据，支持批量删除 | # 2 主要操作 ## 2.1 查询开放事件 开放事件列表是左树右表的方式展示，左树显示事件所属云和应用信息，右表显示所选左树下的事件数据。（事件会根据所选的业务对象自动挂到相应的应用下） 开放事件支持按云和应用过滤，也支持输入关键字对事件编码、名称筛选，也支持字段表头搜索。  ## 2.2 配置开放事件 **- 前提条件**：保证需要监听的业务对象已经具备对应的操作。 **- 操作步骤如下：** 1）在开放事件管理列表点击【新增】按钮，打开开放事件新增页面。 2）录入事件基本信息：包括事件编码、事件名称、业务对象、操作、事件描述等信息 3）选择事件传递的参数，可选择业务对象上的字段。然后可以手工填写业务事件参数的示例值。  事件详情页面，点击事件参数列表上的【预览】操作，会弹窗显示已配置事件参数的 JSON 格式。 key值表示参数名称，value值表示参数示例。  4）编辑完成后点击【保存】，并点击【启用】事件数据。 *注意：事件新建保存后默认是“禁用”状态，需进行启用操作后方可被订阅使用*
## 2.3 修改开放事件 只有禁用状态的数据才可以直接编辑修改，启用状态的数据不可编辑，需要先进行禁用操作。 操作步骤如下： 1）对于启用状态的事件，事件详情页点击【修改】按钮，页面会提示用户是否禁用事件数据。  *注意：事件如果已经被订阅，那禁用时会提示需要先撤销订阅。*
 2）事件禁用成功后，页面进入可编辑状态，用户可以编辑修改事件数据。 3）编辑完成后点击【保存】，并点击【启用】事件数据。 ## 2.4 导入开放事件 事件的导入导出功能主要用于数据的跨环境迁移和事件数据的分享，用户可以从某个环境配置好事件数据后导出dts文件，再去其他环境进行导入，避免重复配置。 事件导入支持新建事件数据，也支持更新事件数据。 操作步骤如下： 1）开放事件列表页，点击【导入dts】按钮，进入导入dts文件的弹窗。  2）点击【上传文件】按钮，上传准备好的事件的dts文件。允许上传多个dts文件，也支持多个事件放在一个dts文件中导入。单次导入最多支持20条事件数据导入。  3）点击【开始解析】按钮，解析dts文件，并展示解析出来的数据资源以便用户确认数据。主资源列表显示解析出来的事件数据，依赖资源列表显示解析出来的依赖数据，主要包括事件分类数据、数据源数据。  **逻辑说明：** ① 主资源导入方式 - 覆盖：若系统内已存在此资源就进行覆盖，如果不存在就进行新增。 ② 依赖资源导入方式 - 关联：若系统内存在此资源就直接将主资源关联上，依赖资源本身不做覆盖。若系统内不存在，就新增此依赖资源并将主资源关联上。 - 覆盖：直接新增或者更新这条依赖资源，并将主资源关联上。 **按钮说明：** 【差异比较】：勾选某条资源点击此按钮，显示数据比较弹窗，可查看这条资源已存在的数据和导入的数据的差异。  【设为覆盖模式】：勾选资源点击此按钮，将该资源的导入方式变更为“覆盖”。 【设为关联模式】：勾选资源点击此按钮，将该资源的导入方式变更为“关联”。 4）确认解析的数据和导入方式都正确后，点击【导入】按钮，系统执行导入操作，导入成功后，回到开放事件列表即可查看到导入的最新数据。  **特殊注意：** 1、**导入后事件数据状态都会置为“禁用”**，需要手工启用。 2、如果事件已被订阅，不允许做事件导入更新，导入时会报错。 # 3 注意事项 1、新增开放事件时**默认是禁用状态**的，配置完后记得先启用方可使用。 2、禁用事件时会检查事件是否有配置到事件推动订阅中，如需禁用事件请先撤销事件订阅。 3、单条事件消息最大支持4096个字节，**在配置事件参数时请尽量选择必要参数**。