Dslink-Saas系统操作手册

Dslink-Saas系统操作手册

一、数据主页

1、搜索连接器。

2、连接流、连接器、触发器、执行动作数量视觉图

3、根据当前用户准荐对应的连接器

4、系统消息通知

图示:

二、连接器市场

1、连接器类型

连接器分为四大类、每个类型下面的连接器乂通过功能性进行分类展示

O

2、连接器展示

展示具体功能分类下面的连接器，如果当前用户订阅了某个连接器，就会被标注出来

3、连接器搜索

可以根据服务商名称或者连接器名称进行搜索查询

4、连接器市场详情

显示连接器的服务商、描述详情。左侧展示连接器下面发布的触发器资源和对应的描

述信息，右侧展示执行动作资源与对应的描述信息，在这个页面可以对连接器进行订阅使用

和取消订阅功能

*

三、连接流市场

功能研发中…

四、我的连接

1、连接器

1.1、新增连接器

用户可以根据自己掌握的资源或者公司组织提供的业务上的资源进行新增特定场景分

类的连接器，可以选择四种进行新增，当前仅支持《应用连接器》，在创建连接器的时候

需要选择一个对应的场景分类

*Ma*

1.2,连接器展示

添加的连接器会在贝面展示，展示的属性有连接器名称、连接器类型、连接器关联

的类目、连接器的状态、还有连接器的操作功能。连接器展示分为自建连接器、订阅连接

器，订阅连接器就是用户自己在连接器订阅的连接器资源，来进行使用，订阅连接器分为免

费与收费两种，在订阅的时候需要进行相关的配置。

♦・费・IR•C

1.3、连接器查询

在连接器展示页面，可以快速的查询到自己需要使用的连接器信息，可以选择连接器

类型，杳询连接器的名称3

■MTV

・1

on*

on3U»

1.4,连接器详情

在功能中展示连接器的图标，连接器名称、连接港描述。显示使用到当前连接器资源

的连接流看板。下面左侧显示当前连接器的触发器信息、，添加触发器入口，右侧显示当前连

接器的执行动作资源列表，添加执行动作入口。通过‘更多'可以进入触发器或者执行动作

详情列表。

1.5,连接器编辑

点击连接器编辑功能，可以修改连接器的基本信息。

o三

1.6、连接器发布、下架

点击连接器上架、下架功能，可以将连接器发布到连接器市场、或者从连接器市场下

架。

•I

1.7.连接器删除

1.8、触发器

1.8.1、新增触发器

新增触发器，填写触发器名称信息与描述。配置触发器数据模型，可以直接通过正

确的json文件导入，可以动态添加参数字段、与字段类型，字段标题与字段描述，数据字

段的必选与非必选。字段类型支持string,number,arrayobject-,boolean五种类型，

在类型未object时候，可以继续添加其子节点

6S”

1.8.2、触发器展示

新增的触发器会显示触发器名称、触发器描述、触发器状态以及触发器的操作功能

・I

1.8.3、触发器查询

在触发器页面可以通过触发器名称进行一个模糊查询相关的触发器

Z1T*no”

wow

1.8.4、触发器编辑

点击编辑功能，用户可以重新定义触发器名称、描述信息，和数据模型配置。

IKZS

MW

1.8.5、触发器发布

点击触发器发布功能，可以将当前的触发器发布到连接器市场中进行资源共享，前

提是连接器需要先发布。

1.8.6、触发器删除

点击触发器删除操作，可以将触发器资源进行删除，注意的是删除操作是不可逆的。

1.8.7、触发器详情

点击触发器名称可以进入到触发器详情，可以显示已经配置好的触发器信息。

1.9、执行动作

191、新增执行动作

新增执行动作分为三步：

1、填写基本信息，执行动作名称、执行动作描述、创建方式，鉴权方式，填写接口路径,

填写密钥，填写动作类型

2、填写入参配置，入参配置包含请求头、请求体、URL查询参数、URL路径参数，可以通

过json数据文件进行导入生成，也可以手动进行动态数据字段、数据类型、数据标题、数

据描述添加。

3、出参的配置，可以通过json数据格式文件进行生成，也可以通过手动去动态添加数据字

段、字段类型、字段标题、字段描述等信息。调用成功规范，可以去动态设置返回的数据成

功状态标志，判断返回的结果数据是否是一个成功的状态。

^^3

192、执行动作展示

新增的执行动作会显示执行动作名称、执行动作描述、执行动作状态以及执行动作

的操作功能

193、执行动作查询

在执行动作页面可以通过执行动作名称进行一个模糊查询到相关的执行动作

194、执行动作编辑

点击编辑功能，用户可以重新定义执行动作名称、描述信息，和三个步骤中的数据

定义。

三an

195、执行动作发布与下架

点击执行动作发布功能，可以将当前的执行动作发布到连接器市场中进行资源共享,

前提是连接器需要先发布，同时也可以将已经发布的执吁动作下架。

MBWE11

196、执行动作删除

点击执行动作删除操作，可以将执行动作资源进行删除，注意的是删除操作是不可

逆的。

1.9.7、执行动作详情

点击执行动作名称可以进入到触发器详情，可以显示己经配置好的执行动作信息。

1.9.8、调用成功规范

设置执行动作出参的调用规范，在连接流运行过程中，会通过调用成功规范来校验执

行动作是否执行成功。如图所示：

2、连接流

2.1、新增连接流

新建连接流分为两步，一是填写连接流基本信息，包含连接流名称、连接流描述、选

择控制台（下面做控制台解释），二是配置具体流程，这两步也可以分开来操作。

1、创建连接流基本信息

2、创建单条具体连接流程，用户可以点击十号选择连接器、选择连接器的触发器，配置触

发器中的数据。选择连接器的时候，这里可以选择自建连援器和已订阅的三方连接器来使用。

数据字段可以配置为默认值、表达式。接着可以选择执行动作，同样可以选择自建连接器或

者已订阅的三方连接器中的执行动作，然后进行数据配置，执行动作的数据字段可以动态的

做连接映射、固定值和表达式。

二

二

』

3、创建分支连接流，操作步骤跟创建单条步骤是一样的，只是在每个节点可以扩展多个分

支出来，根据设置的条件或者条件组来设置连接流程的走向。

2.2、连接流展示

连接流展示功能会显示出自建连接流和己订阅连接流，显示连接流名称、连接流描述、

创建人、创建时间、连接流状态、连接流操作功能。

2.3、连接流查询

在连接流展示页面，可以快速的查询到自己需要使月的连接流信息，根据连接流的名称

查询。

O"ma

MM

2.4、连接流详情

点击连接流名称可以查看已经配置的连接流程详情。

2.5、连接流编辑

点击连接流编辑功能，可以对已经配置的连接流基本信息、具体流程进行修改。

2.6、连接流发布

点击连接流发布功能，可以将已经配置好的连接流发布到连接流市场让其他用户安装

使用（暂未开放）。

田K

0I

逢i—■□

2.7、连接流删除

点击连接流删除功能，可以删除已经配置好的连接流，前提是这个连接流是没有被发

布和没有在运行中状态。

3、连线映射

3.1、多级出参

3.2、字段映射

如果上级业务节点的数据字段是当前节点入参所需要的数据，这时候可以做一个连线映

射上，如果上级出参数据的一个字段需要被当前节点入参多个节点使用到，还可以做一个一

对多的映射。

4、公式面板

在设置流程节点条件的时候、设置入参字段表达式的时候需要用到表达式，这里可以在

公式面板中使用到」经存在的场景内置函数、四目运算将，逻辑运算。

4.1、四目运算表达式

这里可以通过力口、减、乘、除来进行数据的计算设置。

4.2、内置函数表达式

内置函数代表许多需要对返回的出参数据做一个操作的场景，例如时间字段处理，生

成，字符串转换，数值比较，计算等等。面板下方式函数使用的提示。

4.3、逻辑运算表达式

逻辑运算可以结合运算表达式和函数表达式一起使用，例如通过函数计算出值然后与一

个设置的值或者固定的值进行一个大于、小于、等于的判断。

5、控制台

5.1、控制台新增

填写控制台名称、控制台描述可以新增控制台。

o三

5.2、控制台显示

显示控制台卡片信息，控制台名称、控制台描述、连接流数量信息、运行统计。

5.3、控制台导入

功能待研发

5.4、控制台导出

功能待研发

5.5、基本信息

显示当前控制台的基本信息

5.6、连接流配置

5.6.1＞连接流显示

显示当前控制台的连接流程信息，连接流ID、连接流名称、连接流描述、连接流运

行的状态、操作功能。

5.6.2、任务配置

填写配置任务名称、运行时间配置运行时间是一个范围，可以提前设置，延迟运行，

配置类型有三种1、选择执行配置2、选择执行时间（只执行一次）3、输入执行配置，就

是cron表达式。

5.6.3、运行（可延迟运行）

根据配置的任务时间来运行，可以提前设置好时间，到了时间自动运行

5.6.4、连接流触发

连接流的触发方式有两种，一种是通过配置任务时间定时运行，或者在某个时刻运

行一次。第二种是通过触发器的方式触发连接流运行（这个方式会在后面给出触发方式）。

5.7、运行记录

记录当前控制台运行中的连接流程的运行记录（目前这个运行记录保留7天时间），

可以通过运行记录来查看连接流程的正常日志和错误日志，发生错误的流程节点，可错误的

详细信息，简单排查问题。

5.7.1、运行记录显示

显示所有运行记录列表、流程名称、调用类型、触发时间、执行状态、运

行时耗、失败原因、查看详情。

,1

5.7.2、运行记录查询

可以选择失败记录、成功记录、所有记录,可以选择某一个连接流，可以

选择一个时间范围。

，,•

MWiwixai-

M«[HIM

■■l

5.7.3、运行记录详情

点击运行记录详情，会展示每个流程节点的运行情况，单击进入，可以查

看错误码信息，请求头、请求体，响应头、响应体等信息，可以通过错误信息查

看到错误原因。

•xs

五、数据管理

功能待研发…

六、上架钉钉连接器案例

1、打开钉钉开放平台

链接：

1、查询用户详情功能

源6«・叩me

・”

2、在dslink-saas中新增执行动作，接口路径填写钉钉开放文档中基本信息中的数据，如图:

、打打开版平Nwiwn

m1」.・

B<xlye»

O

3、根据钉钉开放文档，需要Query参数、Body参数

\UIJRBIVHH««n

■«*

Qu»ry>0

a»■a«e

l・W

>r.T'^WW

入6•oc”：：f.

4、接下来配置dslink-saa