开放事件,让平台更开放,让集成更实时!

科技   2024-11-29 07:45   广东  

🎉 金蝶云·苍穹V7.0新特性系列文章重磅上线

每工作日早上07:45

准时为你带来最新产品资讯


你是否还在为系统间数据同步的延迟而烦恼?

是否还在为API轮询导致的高资源消耗而头疼?

今天,小编给大家介绍苍穹开放平台新特性——“开放事件”,帮大家把这些烦恼统统解决!只需简单几步配置,便能在平台单据操作或关键业务动作发生时触发事件,将最新的业务数据实时推送给订阅的系统或相关用户。这不仅能够实现系统间的实时集成,更能大大提升平台的开放性!

👇点击下方音频,1分钟快速了解开放事件,详情阅读全文噢~
















适用版本














金蝶云·苍穹V6.0.6及以上(自定义事件和脚本插件功能需V7.0.1以上版本)



适用对象














实施交付、开发人员、运维人员



特性介绍














1. 工作原理


开放事件(OpenEvent),将苍穹平台的业务单据操作或关键业务动作以事件消息的方式快速触达对接系统,以便对接系统实时做出个性化响应,避免频繁的轮询API。


图 1 工作原理


2. 特性展示                          


步骤一:定义开放事件

路径:开放服务云>OpenAPI>开放事件>开放事件定义

打开开放事件管理列表,用户可按需创建两种类型的开放事件:操作事件和自定义事件。


  • 操作事件:指操作业务单据时产生的事件,如单据保存、审核等事件。

  • 自定义事件:指在特定的业务逻辑或场景下产生的事件,由应用程序逻辑控制并调用开放事件提供的SDK主动触发,如最小库存事件等。


1)定义操作事件

点击“新增”,进入操作事件新增界面。填写事件编码、名称、业务对象、操作等信息,并通过选择业务对象属性作为事件参数。完成单据录入后,点击“保存”并启用。


图 2 新增操作事件类型的开放事件


2)定义自定义事件

点击“新增自定义事件”,进入自定义事件新增界面。填写事件编码、名称、所属应用信息,并根据实际业务需要录入事件参数。完成单据录入后,点击“保存”并启用。

注意:自定义事件定义的参数必须与应用程序中调用SDK传递的事件参数一致,不然事件触发会报错。


图 3 新增自定义事件类型的开放事件


步骤二:订阅事件

路径:开放服务云>OpenAPI>开放事件>事件推送订阅

1)打开事件推送订阅列表,点击“新增”进入订阅新增界面,分为基本信息、推送配置和已订阅事件三部分内容。填写订阅批号、名称、描述等基本信息。


图 4 新增事件推送订阅


2)推送配置:推送方式默认选择“Webhook回调”,对接方需提供无需授权访问的Webhook回调地址用以接收事件消息,并录入回调业务方和回调地址字段。


图5 Webhook回调配置


如有加签、加密、断言等需求,可按需配置:


  • 签名加密:如果事件传输数据的安全性要求比较高,可配置签名和加密策略,避免传输过程中被恶意篡改或数据泄露。

  • 请求断言:在请求回调地址时,默认不报错不超时则为事件推送成功,如用户有特殊断言需求,可在请求断言脚本中编写逻辑。

  • 接口测试:回调配置完成后,用户可点击“测试”按钮,以验证所配置的回调地址的连通性。

  • 错误重试:默认错误时重试3次,可修改成不重试。


对于有些对接方,提供的对接接口有认证和参数格式要求,推送方式可选择“脚本插件”,用户可编写脚本处理第三方接口的认证和参数格式转换等问题。

脚本内支持复杂逻辑运算、微服务调用、API接口调用等,满足用户按需灵活扩展的需求。


图6 脚本插件配置


3)选择订阅事件:选择需要订阅的事件,可以一次订阅多个事件。


图7 选择订阅事件


步骤三:查看事件推送日志

路径:开放服务云>OpenAPI>开放事件>推送日志

1)进入推送日志列表,可查看历史的推送日志记录,可通过执行时间、实例ID、状态、触发事件编码、触发事件、回调业务方等多字段搜索查询日志。


图 8 推送日志列表


2)勾选失败状态的日志记录,点击“手工重试”,系统会向回调地址再次推送事件消息,重推后会刷新当前日志记录,展示最新一次推送的详细数据和执行结果。


图 9 手工重推二次确认


3)点击某条日志记录执行时间,进入日志详情页面,可查看事件推送基本信息、报错日志、推送数据和返回数据等信息。


图 10 推送日志详情



亮点价值














  • 提升异构系统集成实时性:开放事件能够实现近乎实时的通信,确保外部系统能迅速对平台上的业务变化做出响应。

  • 增强灵活性和可扩展性:通过事件集成降低平台与外部系统之间的耦合度,外部系统可以轻松地添加、删除或修改事件处理逻辑,从而更好地适应不断变化的业务需求。

  • 提升平台开放性:开放事件可提供开箱即用的事件服务,有助于加速平台开放性建设,进而促进平台生态繁荣。



相关链接














  • 开放事件介绍

https://vip.kingdee.com/link/s/l3f6W


  • 事件对接说明

https://vip.kingdee.com/link/s/lBpTl



划重点















  • 开放事件特性已支持单据操作事件自定义事件。操作事件可零代码配置,将业务单据的操作定义为事件,自定义事件则通过SDK在指定业务场景下触发。

  • 事件推送订阅功能监听开放事件,通过Webhook或脚本插件将业务变更推送至对接系统,确保信息即时同步。

  • 事件推送日志记录,可查看推送记录和详情,并支持出错时手动重试,方便用户管理推送过程。



#往期推荐#

# 告别API轮询,高效事件集成的终极秘诀都在这儿!

# 企业集成新策略:事件网格,让企业数据实时流动!

# 慢接口预警,您优化接口性能的好帮手

# 定制化API日志记录,要什么你来定

对文章有任何疑问或建议,欢迎评论区留言~

PaaS平台那些事
分享苍穹最新特性、功能使用和开发小技巧、最佳实践等,做苍穹用户的知心朋友
 最新文章