# 使用指南

本篇文档是对核心概念讲解的扩展,包含流程状态解释、触发器详细配置、操作详细配置、日志服务等。

强烈建议先阅读快速入门,在了解了如何创建一个IPaaS流程的基础上再来阅读本篇文档。

# 流程状态

  • 发布状态:流程创建后即处于未发布状态,当流程发布后,发布状态即一直保持为已发布,且不可更改为未发布状态。

  • 运行状态:当流程发布后,流程状态默认置为运行中状态,只有已发布且处于运行中的流程才是可执行的,用户通过切换运行状态来控制流程是否可执行;当运行状态被设置为未运行状态时,流程即处于不可执行状态。

下图中只有第一个流程才是正常可执行的:

流程状态

# 触发器配置

根据需要选择类型:

  • 事件通知:监听第三方应用某个触发事件到达时,则执行流程块。举例🌱:微信公众号粉丝关注消息即为一个事件通知类型的触发事件。

  • webhook:当外部开发者调用由Aboter生成的指定URL时,则执行流程块。一般用于在第三方代码中直接调用的方式来触发流程。

  • 定时触发:当用户希望在指定时间到达后,则执行流程块。举例🌱:每天下午六点钟执行即为一个定时触发类型的触发事件。

触发器类型

# 事件通知类型

列表展示了支持的全部触发事件,根据需要选择相应的触发事件:

触发器合集

# 事件配置

  • 普通鉴权:指通过填写连接器应用key和密钥的方式来完成触发事件的订阅,一般需要登录到相关应用的管理后台查看密钥信息并填写至此,可参考第三方应用

普通鉴权

  • oauth鉴权:指通过网页授权的方式来完成触发事件的订阅,只需通过下拉选择已授权账号或通过授权账号完成用户授权即可。

oauth鉴权

  • 主动订阅:指除了要进行鉴权参数配置之外,还需配置订阅参数的触发事件。订阅接口的调用发生在用户更新(保存、发布)流程时,如果订阅失败则会导致流程更新失败并toast提示失败原因,订阅失败则触发事件不会如期触发。参数配置通常包含鉴权参数和订阅参数两部分:

主动订阅配置

# 预览

预览信息是根据触发器内置信息及配置信息自动生成的,主要用于展示当前触发器的完整信息,通常不可编辑:

  • 应用名称:该触发事件所属的连接器名称。

  • 事件名称:触发事件名称。

  • 帮助文档:触发配置帮助文档。

  • 监听地址:触发事件监听地址,即事件推送地址。

  • 调用成功返回:调用触发事件地址成功,返回给触发事件调用方的数据结构示例;如果调用失败,则返回数据为:{ errCode: xx, msg: xx }

  • 传输数据示例:触发事件的推送数据结构示例,会统一把推送数据(比如有些推送数据为xml格式)转化为json格式,在流程块中可访问内置的_data.trigger变量来获取实际推送数据。

预览信息

# webhook类型

# 调用配置

  • 请求类型:接口请求方法,只支持GET和POST方法。

  • 调用成功返回:接口调用成功时返回给调用方的数据结构;如果调用失败,则返回数据为:{ errCode: xx, msg: xx }

  • 传输数据示例:接口调用时的推送数据结构示例,只支持JSON格式的传参数据,在流程块中可访问内置的_data.trigger变量来获取实际推送数据。

webhook调用配置

# 预览

预览信息是根据该webhook配置信息自动生成的,主要用于展示当前webhook触发器的完整信息,通常不可编辑:

  • 调用地址:webhook调用地址,当开发者调用该地址时将触发流程块执行。

  • 调用成功返回:同调用配置,仅用于展示,不可编辑。

  • 传输数据示例:同调用配置,仅用于展示,不可编辑。

# 定时触发类型

用户可通过配置不同的定时类型,来实现不同的定时执行策略,定时触发无预览信息展示。

  • 定时类型:每月、每周、每天、每小时、每几分钟;其中每几分钟是指每隔多少分钟运行一次。

  • 执行时间:具体的执行时间点。

举例🌱:每天早上8点钟执行,配置如下

定时配置

TIP

触发器组件为特殊流程组件,编辑触发器组件不受流程编排语法规则的限制。

# 操作配置

一个操作即指某个动作,一个动作通常对应一个API接口。比如通过apiSpace查询手机号码归属地信息即为一个操作。操作在流程块中运行,通过在左侧【应用连接器】组件菜单中拖动目标连接器到流程块中即完成了连接器组件的添加。

右侧编辑区分类展示了该连接器支持的全部操作,根据需要选择相应的操作:

连接器操作列表

# 鉴权配置

此处为鉴权参数的配置,一般第三方应用接口都需要先通过鉴权才能够调用。此处鉴权参数和事件配置中鉴权参数一般是公用的,鉴权分为普通鉴权oauth鉴权

  • 普通鉴权:直接通过appKey及密钥或固定的apiKey方式调用连接器业务接口。

举例🌱:公众号鉴权参数为appKey, appSecret,需要登录公众号后台去查看,然后填写到此处。

鉴权配置

  • oauth鉴权:需要网页授权动态生成token来调用连接器业务接口,token存在有效期的限制,过期则需重新进行用户网页授权。

举例🌱:新浪微博即为oauth鉴权方式,通过【授权账号】进行网页授权或直接下拉选择已授权账号。

鉴权配置

# 参数配置

此处为操作的业务参数配置,建议查看对应连接器的API文档,相关信息请查看第三方应用

  • 返回值:流程变量,用于存放操作的实际返回数据,该变量可在接下来的流程中访问。

操作返回值

# 预览

预览信息是根据操作内置信息自动生成的,主要用于展示当前操作的信息,通常不可编辑:

  • 应用名称:该操作所属的连接器名称。

  • 操作名称:操作的名称。

  • 帮助文档:操作配置帮助文档。

  • 返回示例:操作返回的数据示例,点击【编辑】可查看数据结构;操作的实际返回数据将存储到参数配置的返回值变量中。

# 测试操作

为方便在调试流程时进行操作传参的测试,点击【测试操作】会根据当前操作所配置的传参发起测试请求,并把结果返回展示,可根据测试结果来调整操作传参。由于测试操作不存在流程上下文环境,参数值为变量时发起测试操作会导致测试报错,所以测试操作时的所有传参均为实际值而非变量时才会正确返回数据。但在实际流程中参数的值很多填入的为变量,此时测试操作会提示失败,属正常现象无需处理。

测试操作

WARNING

注意:应用连接器组件同时适用于IPaaS流程RPA流程。本质上应用连接器组件是一个普通的流程组件,所以对于操作的配置要符合流程编排的语法规则。比如上面在填写鉴权参数和操作传参时,如果是字符串类型的值都应该加双引号,否则流程默认会当成变量来对待,导致运行流程失败。访问流程编排了解更多。

# 日志服务

无论是流程开发还是线上运行,根据日志进行流程调试跟踪问题都是非常有用和必要的。

# 日志打印

通过拖动左侧【基本命令】->【日志】中的日志组件(根据需要选择合适的日志组件)到流程块中,即可以完成日志组件的添加。

举例🌱:在公众号收到粉丝关注流程中打印公众号推送的数据,并且打印流程块中操作的返回数据。

日志打印

# 日志查看

点击【日志】即可查看最近60天的流程运行记录,点击【查看日志】可查看日志内容。根据日志内容是否符合预期,可以轻松的调试和跟踪流程。

  • 日志名称:根据流程开始运行的时间自动生成。

  • 运行状态:流程本次运行状态;如果显示运行失败,则可以根据日志信息查找流程失败原因。

  • 开始时间:流程开始运行的时间。

  • 结束时间:流程结束运行的时间。

查看日志

# 应用市场

WARNING

注意:由于IPaaS流程通常需要配置用户的账号等信息(appKey或者手动授权之类),所以这里只是提供了模板,安装成功后需要用户自行完成必要的配置。

为方便用户快速上手IPaaS流程,Aboter提供了应用市场的功能,应用市场上放置了常用的IPaaS模板。访问【应用市场】->【IPaaS应用】,直接安装即可获取模板流程。