基于事件的 API 调用

本文档描述了使用事件作为触发点来调用 M3 API 的概念。M3 API 的触发器通过用户自定义的 API 调用执行,包括所选的事件信息作为通过 API 调用发送的参数列表。此功能可以调用任何入站 M3 API 交易。

遵循以下步骤

  1. 事件订阅。打开 (CMS045) 中,添加对要用于 API 调用的 M3 表的订阅。M3 表的名称用作事件名称,而 M3 用作发布者。

  2. 必须为基于事件的 API 调用激活订阅,并且还必须将其设置为活动状态。

    定义 API 调用

  3. API 调用的定义在基于事件的 API 调用。打开 (CMS041) 中执行。

    应在何时调用 API

    定义何时应使用筛选器调用 API,其中“Value changed”、“Equal to”等逻辑表达式可用于特定字段。

    除了来自 API 的回复之外,可以使用任何 M3 入站交易。只有来自 API 的错误消息才会存储在相关日志中。

    从性能和数量的角度看,重要的是筛选器的定义正确,并且在交易数量少于生产环境的环境中进行了全面测试。由于正常的 M3 环境每秒生成几百个事件,因此定义不明确的筛选器会快速生成大量警报消息。

    发布定义步骤

  4. 定义了警报后,必须先重启相应的自动作业,然后已更新的订阅才能在事件中心中激活并且新定义更新为缓存。

    子系统。打开 (MNS050) 中重启自动作业,并为自动作业子系统(通常名为 ASJ)选择相关选项“子系统中的作业”(选项 11)。

  5. 在列表中查找自动作业 CMS913(事件订阅 - 事件日志)。

  6. 结束该作业,并在其停止后将其重启。

排除故障

错误日志已连接到 API 调用。从 API 返回的错误调用或错误消息将使用事件的主键以及触发原始事件的功能进行记录。根据这些信息,可以重新处理导致该事件的操作,或者在问题得到更正时重新触发 API。

排除故障的另一种方法是在服务器视图中打开自动作业的概念日志,或者在云环境中打开管理页面。激活后,将生成一个新事件,然后查看写入自动作业日志的概念日志。在自动作业中执行的每项验证都以可读文本的形式写入日志。

对 API 的实际调用从标准批处理程序 CMS326(管理修复程序/作业驱动程序)执行,该程序随后会保持与 API 的通信并更新日志文件。从自动作业的角度看,对 API 的调用只是一种“触发后不管”的类型,不会等待来自接收方的任何回复。