【分享】在集简云上架应用如何配置一个触发动作？

如何配置一个触发动作？

1 什么是触发动作？

触发动作是指当一个事件发生时，触发数据流程。 而产生触发事件的应用系统就是触发系统。

例如：当用户提交表单信息后，自动发送一个企业微信消息通知客服或者销售团队进行跟进，那么“当用户提交表单”就是一个触发事件。而产生触发事件的表单系统就是触发应用。

触发动作中数据的产生有两种方式：

• 实时触发：由应用系统自动在触发事件产生时推送数据到集简云，集简云自动响应并执行。
• 定时触发：由集简云每1-15分钟（由用户的付费版本决定）定时去应用系统中查询是否有新的数据，如果有新的数据将自动触发流程。

在集简云开发者平台配置一个触发动作有如下步骤：

• 动作信息设置: 配置动作的名称与描述等基本信息
• 动作字段设置：触发动作非必要，如果您在触发执行前需要对数据进行筛选设置时才需要配置此字段，例如只有当满足某个条件时才执行触发。
• 动作接口参数设置：配置触发动作接口调用时需要的参数。

下面我们逐一说明各个配置：

2 动作信息设置：

动作信息是用户在前端看到的动作名称与描述设置，示例：

动作信息设置包含以下几个模块：

• 动作名称：在前端展现给用户的动作名称，例如：当有新订单时，非必填，如果不填写则以字段key做为字段名称
• 动作Key：用于接口调用时的唯一字段标识，字段key应该为英文字母，例如API_Key，用户在前端不可见此字段
• 动作功能描述：描述此动作的功能，用户可以在前端看到此动作功能描述，示例：当有新增订单时同步数据并触发流程。
• 动作是否可见：选择用户是否可以在前端选择和使用此动作

3 动作字段设置 （非必要）

触发动作非必要，如果您在触发执行前需要对数据进行筛选设置时才需要配置此字段。

例如：Zoho CRM的当模块中有数据变化触发动作，需要选择哪个模块有数据变化时才执行触发，此时可以设置一个动作字段（下拉类型），让用户在前端进行选择：

4 动作接口参数设置

在这个部分配置如何调用我们的应用接口。与执行动作不同，触发动作的触发方式分为2种：

• 数据推送：如果我们的应用接口包含数据推送或者数据订阅功能，可以配置为此方式。此方式配置后可进行实时触发。每当有数据推送过来时触发流程
• 主动拉取：如果我们的应用接口没有实时推送数据接口，但是有查询数据列表的接口可以使用主动拉取的方式触发。集简云将定时拉取数据列表，并进行排重判断是有新增数据，如果有新数据则触发流程，没有新增数据则不会触发流程。

我们先讲解一下配置“数据推送”方式

4.1 数据推送触发动作接口参数设置：

4.1.1 订阅接口配置

订阅接口是通过接口订阅一个指定事件，例如在Zoho CRM的接口文档：

https://www.zoho.com.cn/crm/help/developer/api/subscription/enable.html

配置接口参数：

注意：事件订阅地址为集简云系统自动生成，您只需要填写一个订阅地址变量{{bundle.targetUrl}} 即可

4.1.2 取消订阅接口配置：

取消订阅是用于用户取消授权后，集简云自动解除对消息的订阅。例如：Zoho CRM的接口文档：https://www.zoho.com.cn/crm/help/developer/api/subscription/unsubscribe.html

下面我们说明一下 主动拉取触发配置

4.2 主动触发动作接口参数设置

主动拉取会定时读取接口数据（默认为15分钟1次），您需要返回一个数据列表，集简云内置的排重功能会判断是否有新增数据，并触发流程。

我们以读取Zoho CRM联系人列表为示例，当联系人列表有新增数据时触发流程。

接口文档：

https://www.zoho.com.cn/crm/help/developer/api/get-records.html

这里联系人模块的key为“Contacts”.

使用主动拉取读取数据列表时，需要：

• 排序：您的数据列表是按照一定顺序排序的，例如：当触发动作为：有新增数据时，应该使用数据的创建时间排序。当触发动作为：有数据更新时，应该使用更新时间排序。
• 唯一ID: 数据列表中的每条数据需要一个唯一ID，集简云将使用这个ID作为数据排重的依据。

Zoho CRM查询记录列表接口的排序字段为“sort_order”, 因为我们需要查询最新的数据，因此我们需要使用倒序，字段值填写“desc”

从Zoho CRM的接口文档可以看到每条数据都有一个唯一ID: id

因此我们在“数据唯一标识”字段填写“id”

更多关于接口中常用的变量，可以参考文档：

编译变量&使用方式

集简云在Jinja2模版语法的基础之上，提供了一些自定义的模版函数，如下： Jinja2基本语法请参考：http://doc.yonyoucloud.com/doc/jinja2-docs-cn/index.html

5 动作样本设置：

动作样本是让用户可以更简单的理解数据返回的参数是什么意思，由于集简云主要面向非技术人员，因此这个设置可以让用户更简单的使用我们的应用。推荐配置。

示例：下方是微信公众号配置样本后的示例：

通过样本数据设置可以将原本接口返回的参数转化为用户可以读懂的中文。

动作样本的配置方法：

进入我们的动作配置，接口配置:

1 我们可以写入一个json格式的数据样本

2 点击“生成输出字段按钮”，集简云会自动列出字段key转译表格

3 在第二列填写字段key对应的中文名称

4 字段描述：设置字段补充信息，比如:如果一个性别字段返回的字段值为0，我们可以填写字段值说明，例如：0-未知，1-男，2-女，集简云将在前端展现此内容，帮助用户更好的使用我们的应用：

6 如何测试触发动作：

我们可以在集简云创建流程测试触发动作：

点击创建流程，在集简云流程创建中搜索我们的应用名称即可开始测试。