首页 宜搭 用户指南 付费功能

付费功能

体验版本宜搭使用中无法使用以下功能,需要付费版本(标准版、尊享版)才可使用,且部分功能是尊享版特有功能(例如:高级流程设计器、数据准备等),本文将介绍这些付费功能的使用。

高级流程编辑器

尊享版可使用,宜搭专业版可创建 5 个高级流程设计器

1. 基本介绍

为满足流程需求,宜搭提供了高级的流程设计器,它不仅能满足了普通设计器的几乎所有功能,还在此基础上增强了部分功能。例如增加了分支、聚合等组件;同时也对组件功能及设置进行了增强,区分基础和高级设置;可以自定义执行人规则和完成策略;支持普通流程编辑器升级为高级流程编辑器。

相关学习视频https://www.yuque.com/yida/video/chs483

注:普通流程编辑器升级到高级流程编辑器后,不支持再退回到普通流程编辑器。

设计器整体可以分为 5 个功能区域:

  • 节点区

  • 快捷操作区

  • 流程设计区

  • 属性设置区

  • 保存与帮助

高级设置编辑器

1.1 节点区

节点区提供了高级流程设计器支持的所有功能节点,用户可以按照需要将节点拖拽到流程设计区中

开始节点

是高级流程设计里面发起的节点,流程发起开始操作会伴随着公式校验还是关联操作,节点提交规则的作用是在用户提交流程或者审批人处理流程时通过一些公式校验判断用户是否能执行此操作。

人工节点

可根据自身需求自定义审批人规则。

自动节点

自动节点的主要作用是通过第三方服务选项进行回调,第三方服务需要先进行服务注册,然后即可在第三方服务中选择。

分支节点

高级流程中支持分支节点的配置,当流程走到分支节点之后,根据分支节点上的规则配置决定流程接下去往哪个分支上走,实现了条件状语,如果……那么……的效果。

聚合节点

流程中有多条并行的分支,需要多条分支都完成之后才能继续往下走的时候可以使用聚合节点,只有聚合节点所有入线上的节点都执行完,整个流程才会继续执行,实现等待的效果。

抄送节点

当审批流程发起后,需要对应的人员查看/知晓该审批单,但是无需审批的场景。

结束节点

结束节点代表了整个流程的终点,正确配置的流程应该一步一步最终走到这个节点,代表流程结束。

1.2 快捷操作区

快捷操作区提供在设计流程图时常用的快捷方式如下:

  • 撤销:撤销当次在流程设计页面添加/删除的节点和线;

  • 剪切:把选中的节点或者线放入到剪切板,使用快捷键粘贴即可快速复制对应的节点以及线;

  • 复制:复制线、审批节点;

  • 放大:把整个流程图进行放大;

  • 缩小:把整个流程图进行缩小;

  • 网格:开启网格后设计器页面会有网格小点,关闭后设计器页面纯灰色背景

  • 层级前置:有多个节点出现重叠时可将需要的节点进行前置;

  • 层级后置:有多个节点出现重叠时可将不常用的节点进行后置。

1.3 流程设计区

这里是设计流程图的主要区域,用户可以随意拖入节点,通过线连接的方式实现流程流转。

1.4 属性设置区

属性区展示了每种节点支持的属性设置,在这里可以对节点进行个性化、功能类的设置。

1.5 保存&发布流程

当流程节点、节点规则设置完后需及时保存以及发布流程,否则新提交的数据仍使用旧流程。

2. 流程属性

2.1 流程变量

在流程的基础属性中,提供了该流程对应页面的所有表单项,以供你在流程设计器时的使用,当你需要增加额外的属性时,在流程对应的表单设计中增加字段即可,流程变量里就会自动加载到,如下图所示:

流程变量

2.2设置手写签名

宜搭对于流程审批的审批人节点支持手写签名的功能,用户通过在移动端设置自己的签名用于在审批时进行展示。

注意:电子手签的签名结果没有经过 CA 认证,并不具备法律效应。

设置手写签名

2.3 合并规则

通过设置合并规则,您可以控制某些节点的合并操作,流程将按照合并设置,自动执行或者跳过满足条件的节点

例如:需要在执行节点一的时候系统自动执行节点二,则可以设置合并规则,选择所需要跳过以及默认执行的动作即可。

特别说明:逐级审批是指这个节点审批人是多个人的情况下,会按照前后顺序将任务逐个分配给这些审批人,并且只有上一个人操作完了才会把任务发给下一个人。

合并规则

2.4普通消息

普通消息,具体是指「根据流程内日期字段发送通知规则」。

路径:先在流程表单上添加一个日期组件 >> 高级流程编辑器 >> 点击空白处 >> 高级设置 >> 普通消息 >> 日期规则 >> 选择表单上的日期组件 >> 保存

流水号

标准版及以上专享

https://www.yuque.com/yida/support/un4nkn 中可设置表单的流水号

若开启了流水号,表单新提交实例时,会自动生成流水号。

1. 操作步骤

1.1 设置路径

表单页面 >> 设置 >>页面设置 >>基础设置>> 用户提交表单/流程后会自动生成流水号

表单设置

1.2 编辑流水号格式

点击编辑之后在流水号格式弹框中,可对流水号格式的前缀、日期格式、最小后缀位数、日期计算时区、后缀清零规则进行设置。

设置流水号格式

1.3 设置完成

注意:在流水号的格式弹框中点击了确认,下一步还需要点击基础设置下的保存按钮才算设置成功。

保存设置页面

2. 最终效果

3. 常见问题

3.1 如何将流水号填充到表单的字段中?

https://www.yuque.com/yida/subject/zn9bts

3.2 如何将流水号填充到流程的字段中?

https://www.yuque.com/yida/subject/oglbsw

3.3 尊享版本提交的表单生成流水号后,可以进行修改吗?

系统内置字段流水号不支持修改,如果是设置的函数,在流程表单中生成的流水号,这种同步生成的流水号支持修改。

3.4 若提交的表单数超过了最小后缀位数且未到重置时间,流水号会重新计算吗?

不会重新计算,会自动进位展示流水号,例如:设置最小后缀位数为 1 ,表单提交至第 10 条数据时就会自动展示 10。

3.5 如何将流水号插入到目标表单中?

流水号需要表单提交后系统生成才能回填到表单字段中,可通过 2 种方式实现将流水号插入目标表单中。

方法一:普通表单可将业务规则配置在表单编辑状态执行规则;

方法二:使用集成自动化新增流水号数据到目标表单。

批量发起

注:流程表单中的批量发起功能为标准版及以上专享功能

1. 什么是批量发起

宜搭流程表单,支持应用管理员在应用后台通过上传 Excel 文件来批量发起流程。

当前批量发起支持以下功能:

(1)支持代人发起流程;Excel 中有一列数据是发起人的信息,批量发起流程时可以指定人员列作为流程发起人。

(2)支持「宜搭平台」公共账号发起流程,比如为了跟进外部用户投诉 case 的处理过程,流程发起人则不合适是某个人,而应该是公共账号发起。

(3)支持根据 Excel 中某一列数据动态决定流程的处理人。比如一个记录外部客户跟进信息的一个 Excel,其中一列是跟进人。那么在流程发起时,就可以指定这一列数据作为流程的处理人。

(4)支持按批次删除批量发起的数据,当批量发起失败,或者不符合预期时,可以按批次直接删除数据。

(5)Excel 列数据格式说明。

2. 批量发起案例场景

场景描述:

部门现在想对一个季度以来优秀员工进行奖励,希望每个优秀员工的主管可以给各自的员工写「提名词」。主管写好提名词后,会有消息通知员工来领取礼物。

2.1 操作步骤

流程表单编辑页面

设置审批人

Excel 文件内容展示如下:

Excel 批量发起

数据管理的批量发起

注意:流程批量发起人支持自定义

支持自定义选择以下三种类型作为数据发起人:

①宜搭平台

②当前导入 Excel 的用户

③表单中人员搜索框选择的人员(假如人员搜索框选了多个人,默认取第一个人员)。若选择人员搜索框的值作为发起人,但是表单中成员组件的值又为空, 会发起失败

展示图为「申请人」为表单中的人员搜索框组件

对于错误的数据,点击可直接查看导入失败的数据(成功导入的数据不会展示):

删除本批次数据:

以上为了演示批量导入的功能,演示的是导入失败的场景,以上导入失败是由于导入的 userid 格式错误,下面演示下成功导入的案例:

格式修改正确后,可以成功导入:

:成员组件的格式:若用工号导入,格式为 「名1(工号),姓名2(工号2)」, 注意,是英文( )

若用「员工 userId」导入,格式为 「姓名1[员工userId],姓名2[员工userId]」, 注意,是英文[ ]

3. 常见问题

3.1 为什么批量发起失败 ?

批量发起失败时,请检查以下问题

(1)应用是否已上线,只有当应用上线后,才能成功批量发起;

(2)发起人是否自定义为表单中的成员组件,若是,检查人员搜索框是否有值,若有值,请检查格式是否正确;

(3)当前最多只允许导入1000 条数据,且文件大小不超过 20MB;

(4)仅支持 (*.xls 和 *.xlsx) 文件;

(5)请确保您需要导入的 sheet 表头中不包含空的单元格,否则该 sheet 页数据系统将不做导入;

(6)批量导入的数据不支持以“内置变量”作为条件的过滤;

(7)导入文件不支持 Excel 公式计算,如 SUM,=H2*J2 等;

(8)目前导入图片/附件会转存,占用一定附件容量

3.2 批量导入时选择发起人为【宜搭平台】后如何进行审批?

当流程表单审批人设置为发起人本人,导入数据将发起人选择【宜搭平台】,那流程数据的审批节点则会显示【宜搭平台】为审批人,并且无法操作审批。

此时只能通过下面这个开放接口去执行审批,更多详情可点击此处查看。

  • 接口:/yida_vpc/process/executePlatformTask.json

  • 参数

参数名

描述

是否必填

示例

备注

appType

应用ID

APP_PBKT0MFBEBTDO8T7SLVP

systemToken

应用密钥

hexxyyddd

在应用数据中获取。

userId

钉钉的userId

yida_pub_account

写死 yida_pub_account

language

语言

zh_CN

可选值:zh_CN/en_US

默认:zh_CN

procInstId

流程实例ID

f30233fb-72e1-4af4-8cb8-c7e0ea9ee530

outResult

审批结果

  • agree

  • disagree

formDataJson

更新的表单数据

参考:附录1保存/更新表单数据格式说明。参数有的组件更新,没有的组件保持不变。明细的值只能统一更新,无法只更新明细下某个组件的值

remark

审批意见

确认同意

noExecuteExpressions

是否不执行校验&关联操作

y

本任务节点有绑定校验规则或者关联操作时,

y -> 不执行校验规则&关联操作

n -> 执行校验规则&关联操作

不传默认为n,即会执行校验规则&关联操作

4. Excel 各组件数据导入格式

如图所示:

批量导入增强

标准版及尊享版

体验版支持基础的批量导入功能。详情请参考https://www.yuque.com/yida/support/andrke

批量导入默认不会触发校验规则、关联业务规则和第三方服务回调等服务。

1. 批量导入增强功能介绍

1.1 允许导入时同时触发校验规则、关联业务规则和第三方回调服务

在导入时,可以勾选同时触发校验规则、关联业务规则和第三方服务回调的按钮,勾选后将会触发规则。

如图:

1.2 允许批量删除本批次数据

当我们发现导入的数据是有误的,我们可以通过「删除本批数据」删除本次导入的数据。

如图:

按导入批次删除

标准版及尊享版

1. 操作入口

路径:找到对应的流程表单/表单 >> 数据管理 >> 导入记录/批量发起记录

2. 按批次删除规则

当前流程表单的批量发起和表单的批量导入都可以删除本批次数据

附件在线编辑

未升级到新版信息架构的组织,请点此查看使用手册

注:附件在线编辑为尊享版专享功能

附件组件提供在线编辑功能

1. 前置说明

目前附件编辑仅支持 word、ppt、Excel三种 office 文档,扩展名如下:

Excel 系列: et,xls,xlt,xlsx,xlsm,xltx,xltm,csv

word 系列: doc,docx,txt,dot,wps,wpt,dotx,docm,dotm

ppt 系列:ppt,pptx,pptm,pptm,ppsm,pps,potx,potm,dpt,dps

:附件预览格式除了以上类型外,还包含 pdf格式。

2. 如何开启附件在线编辑功能

如果需要使用附件在线编辑的功能,首先附件组件需要打开 「在线编辑」开关

如图:

表单编辑页面

在线编辑的开关打开后,仅说明该表单有在线编辑的能力,但是如果需要在提交数据后编辑上传的附件,还需要配置权限。

:表单/流程表单配置权限的方式不一致,请参考以下路径

表单:找到对应表单 >> 设置 >> 页面权限 >> 查看状态 >> 编辑 >> 字段权限 >> 自定义、设置字段 >> 附件开启可编辑权限即可

表单的权限设置页面

流程表单:找到对应流程表单 >> 流程 >> 审批人 >> 本节点内容展示>>在附件一栏选选择可操作(审批人在审批时有权限就可以进行在线编辑)

新版流程表单

配置好后,点击表单详情进去可以对附件进行在线编辑,如图所示:

3. 在线编辑使用说明

3.1 自动保存功能

编辑页面在每次编辑完后都会自动保存,也可以通过 「Ctrl+S」 手动保存。

一般不建议用户频繁保存,每次手动保存都会生成一个新的版本,系统保存版本有限制,次数限制是 10 次,超出后会自动删除老的版本。

3.2 协作记录

可以通过右上角可以点击查看 「协作记录」, 协作记录可以查看每一个操作过该文档的用户编辑记录。

如图所示:

:页面上 「历史版本」 功能暂不开放

宜搭关联组织

尊享版专享

1. 如何开通

已正式发布,支持开通使用,关联组织需要付费开通;

开通路径:【管理后台(oa.dingtalk.com)】>>【增值服务】>>【产品专区】>>【关联组织】>>【立即购买】,选择商品规格和使用时长,【立即支付】并支付订单即可。

目前付款方式有:支付宝、银行汇款。

手机钉钉可以开通试用组织关联,路径如下:

【手机钉钉】-【通讯录】-【管理】-【关联组织】-【开通试用】即可;

订单支付成功后,企业主管理员可在【手机钉钉】-【通讯录】-【管理】-【互联平台】-查看到【关联组织】的入口;主管理员也可给其他的子管理员分配关联组织的权限。

2. 关联组织介绍

企业通过钉钉的「关联组织」功能,将下级组织与上级组织建立关联,关联的时候,选择全部或部门下级组织的成员加入关联组织。

3. 宜搭能力介绍

基于关联组织能力,宜搭支持搭建跨组织协同的应用,可以实现以下场景:

  • 上级组织搭建宜搭应用

  • 上级组织将应用分发到下级组织工作台

  • 下级组织的关联成员或行业通讯录成员,访问应用进行数据填报、发起申请

  • 上级组织统一管理填报数据和审批申请

其中,行业通讯录:是指组织外的成员,例如村组织的居民、教育组织的学生家长

以下功能介绍,以县镇村组织的「村集体采购」业务场景为例,教育局学校场景同理。

业务流程:村干部(采购人员)/村民发起申请——村党支部书记会签——抄送村民代表、片长、联村干部——村监会主任审核——副书记办理——区县物价局领导班子审批

流程

3.1 上级组织搭建支持关联组织的应用

通过不同村、镇的接口人配置,可以实现:各村成员提交的单据,流转给各村对应的审批人。

审批节点

审批人规则

如果用其他方式,则无法实现按照组织和上级组织过滤的效果。

宜搭首页 >> 右上角设置 >> 接口人设置 >> 新增接口人

接口人设置

针对各接口人,设置各部门的接口人

设置各部门的接口人

接口人详细功能说明,见「接口人设置」章节。

此处为语雀内容卡片,点击链接查看:https://www.yuque.com/go/doc/30485650

审批节点审批人

简易流程设计器介绍:

此处为语雀内容卡片,点击链接查看:https://www.yuque.com/yida/support/brbaos

审批人规则

高级流程设计器介绍:

此处为语雀内容卡片,点击链接查看:https://www.yuque.com/yida/support/lgrp0w

3.2 是否允许行业通讯成员访问该应用

可访问应用的群体分为两类:

(1)关联组织内的成员

(2)行业通讯录成员(例如县域行业的村民、教育行业的学生及家长)

在应用设置的应用成员设置中,可通过开关控制行业通讯录成员是否可以访问该应用。

行业通讯录成员

3.3 上级组织将应用分发到下级组织工作台

开通了关联组织即会有分发应用这个按钮,

路径:宜搭应用 >> 应用发布 >> 关联组织应用分发

应用分发

如果勾选了自动安装,那么分发应用之后就会自动安装到工作台,没有勾选,在分发应用时会发一个通知确认是否安装到工作台。

应用分发页面

3.4 下级组织被加入关联组织的成员访问应用

(1)下级组织在手机钉钉工作台可见此应用,被加入关联组织的成员或行业通讯录成员,即可访问表单,提交申请;

手机工作台

(2)村、镇审批人(接口人)、县审批人,收到审批任务(钉钉通知、宜搭任务中心),进行审批,审批结束,发起人收到审批完成消息通知。(操作同宜搭原有功能)

发起申请,审批人接收到通知

此处为语雀内容卡片,点击链接查看:https://www.yuque.com/yida/support/fkfhud

此处为语雀内容卡片,点击链接查看:https://www.yuque.com/go/doc/33100978

3.5 上级组织查看数据

上级组织可在应用管理后台的「数据管理」中查看所有人员提交的全部数据。

查看数据

如需设置数据的查看权限,可进行数据查看权限管控

此处为语雀内容卡片,点击链接查看:https://www.yuque.com/go/doc/44503379

4. 收费策略

1、关联组织是钉钉独立的收费产品功能,如需在宜搭中使用,需要先购买该功能;

2、宜搭对关联组织无单独收费,但宜搭的关联组织应用仅尊享版支持;

3、应用可使用人数及资源量均依赖主组织的宜搭规格及资源量;

新功能上线期间非尊享版用户可免费体验,此功能有效期为 2021 年 6 月 3 日~ 2021 年 9 月 2 日,

2021 年 9 月 2 日后未购买尊享版宜搭的用户的关联组织应用,其关联组织不再可用。

例: 主组织-共 100 人,60 人使用宜搭 分支组织 A- 共 50 人, 30 人使用宜搭 分支组织 B- 共 80 人,80 人使用宜搭 宜搭需购买 license 数为:主组织 60 + 分支 A 30 + 分支 B 80 =170

5. 常见问题

5.1 下级组织能否访问上级组织通讯录,比如下级组织成员是否可以在宜搭表单内选择到上级组织的成员或部门?

目前下级组织无法访问上级组织的通讯录。

5.2 上级组织应用管理员在配置流程规则时,是否可以选择到下级组织的任意成员参与审批?

目前只能配置和选择到参与关联的部门与成员。

5.3 上级组织是否能控制下级组织成员的表单发起或数据查询权限?

可以进行控制的。

5.4 可以分发给到下级组织的应用数量是否有限制?

目前没有限制。

5.5 下级组织是否需要开通宜搭,如果不需要开通。下级组织的使用人数是否会占用上级组织的账号数量?

下级组织不需要开通宜搭,但是下级组织的使用人数会占用上级组织的数据量以及账号使用数量。

5.6 如果下级组织用户保留了应用访问方式,比如链接。在应用卸载后是否有可能通过访问链接继续访问应用?

安装与卸载只是控制了应用在对应组织工作台的可见性,并未实质性关闭了应用的访问入口,如果保留了其他应用访问方式,卸载后依然可以访问上级组织的应用。如要进行控制,可以通过应用设置 >> 是否允许行业通讯录访问该页面 >> 权限设置,进行配置。

5.7 可以选择到下级组织家校通讯录人员吗?

目前不支持选择下级组织家校通讯录的人员。

6. 本期暂不支持的能力点(持续迭代中)

6.1 OpenAPI

管理员通过宜搭提供的 OpenAPI,操作带有行业通讯录的成员变量(例如村民的 userid)

6.2 下级组织修改/删除数据

目前下级组织可以配置数据查看权限,暂不支持下级组织修改和删除数据;

6.3 逻辑编排&集成自动化

使用宜搭的逻辑编排,操作与行业通讯录成员相关的规则,则触发逻辑不生效

6.4 报表

上级组织可以查看报表,下级组织暂不支持报表查看;

6.5 钉钉待办

行业通讯录提交的数据,目前钉钉待办无法生成,审批人可以通过钉钉消息通知和宜搭的任务中心处理审批单。

应用分发

应用分发权限,仅针对宜搭中级认证服务商开放。

1. 功能简介

应用分发是为了帮助服务商快速地将当前企业下开发的应用,部署到客户企业的宜搭租户下,并且服务商开发人员可以通过专门的通道进入到客户企业下,完成一些定制化功能的开发属性配置

2. 操作步骤

2.1 应用开发者发布应用

(1)进入宜搭工作台点击 >> 我的应用 >> 在页面显示的应用中找到需要分发的应用,点击下拉小三角,选择分发此应用的选项

我的应用

注:如果点击应用后没有「分发此应用」的按钮,请确定目前登录的账号是否是通过宜搭中级认证服务商的账号。

(2)确认要分发的应用信息后,点击「复制应用分发链接」按钮,此时会生成一条购买该应用的地址

复制应用分发链接

2.2 应用使用者购买

(1)ISV 开发人员可以将复制的应用分发链接发送给自己的客户,客户点击该链接,登录到需要购买应用的组织,点击 >> 购买应用 >> 按钮,完成应用购买,如图所示:

注:如果客户是钉钉企业里面的普通员工,那么点击该链接,会弹出「没有权限」的报错提示,客户必须是钉钉企业内的管理员才可购买,如下图所示:

2.3 应用开发者登录到用户企业进行应用配置

(1)客户购买成功后,应用开发人员可以进入订单中心,找到对应的分发订单,选择远程维护。

(2)选择远程维护之后,会跳转登录至用户的企业,并打开对应的应用,此时就可以以目标客户的企业应用管理员的身份来进行应用维护了。

2.4 应用使用者可以进行应用状态的更改

(1)客户在我的应用下点击应用表单右下角的小箭头,可以开启「关闭开发状态」的按钮,那么 ISV 开发人员就无法远程维护该应用。

关闭开发状态

(2)同理,客户如果在应用设置中,打开了「申请维护」的按钮,ISV 开发人员就可以远程维护该应用。

申请维护

3. 附录

【特别注意】

1、应用发送到用户企业之后,流程表单需要重新配置流程

2、应用发送到用户企业之后,通知模板需要重新进行配置

3、应用发送到用户企业之后,三方服务需要重新进行配置

4. 常见问题

4.1 如何成为宜搭服务商?

点击此处申请

4.2 应用分发给客户,客户有编辑权限吗?

客户在提交订单申请后,服务商组织管理员在平台管理 >> 订单中心 >> 对应订单 >>发送应用 >> 开启应用全部编辑权限即可。

数据准备

  • 在数据分析和使用前,对原始数据进行清洗,融合、转换等处理,将零散数据汇聚整合,形成标准化数据集,为可视化分析和数据化决策提供支持。

数据工厂

  • 基于宜搭应用的数据管理视角,将所有与数据相关的功能统一收敛到新版【数据工厂】中,【数据工厂】是一个完整的数据加工车间,可以用于管理数据物料、加工数据物料、聚合数据资产、创建实时和离线的数据集、管理数据集权限。

  • 在数据工厂中,可以看到独立的 【数据准备】功能入口,每个数据准备实例是可以在列表页管理和查看。

使用场景

  • 宜搭作为企业低代码应用开发平台,支持宜搭内应用数据、企业外部数据库数据、企业外部文件型数据、钉钉官方数据(今年内支持通讯录、OA、考勤等数据),利用0代码ETL方案(Extraction-Transformation-Loading),做宜搭内各种数据集的加工处理。

版本限制

只支持宜搭尊享版和混合云版

快速使用

选择数据准备tab,点击新建【数据准备】按钮,会自动跳转至数据准备的可视化搭建页面。

拖入一个或多个 【输入节点】,按照实际需要配合【关联】、【合并】、【聚合】、【清洗】节点实现数据加工,最后将处理好的数据连接至一个【输出】节点,配置好数据集名称,点击保存、发布、运行即可。

每个通过校验规则的数据准备实例,会默认每个小时自动运行一次,根据当时最新数据更新输出节点对应的数据集。

逻辑编排

点此查看逻辑编排详解

服务注册

标准版及以上专享

1. 功能介绍

服务注册是使用服务回调功能的前置步骤,即将需要使用到的第三方服务的接口注册到宜搭平台上来,主要的功能在于设置接口的出入参信息、验权加密信息、权限控制、接口描述信息等,以便在使用时可以快速引用。

目前,宜搭平台提供的服务注册主要包括以下两种类型:

  • HTTP:面向普通企业用户(包括阿里内部生态公司企业用户)

  • GATEWAY:仅面向阿里内部生态公司企业用户

特别说明:该功能入口仅面向企业的主管理员、子管理员以及应用管理员开放,如需要使用到该功能,请向所属企业的管理员申请获取使用授权。授权入口:平台管理 >>平台权限管理。更多详细操作,请参考平台权限管理。

授权操作如下:

宜搭首页

平台权限管理

2. 基本使用

服务注册操作入口:平台管理(小螺丝图标)>> 服务注册

宜搭首页

整个面板的功能区域包括如下 5 个部分:

(1)服务注册:左侧边栏切换到该栏目,可以展示如下的服务注册的功能页面。

(2)新增服务:点击该按钮,可以新增一条新的服务注册信息。

(3)搜索服务名称:根据服务名称进行模糊搜索,搜索结果进行分页展示。

(4)修改基本信息:点击该条目后,会弹出该服务注册的详情信息,可以针对既有的服务注册的信息进行修改。

(5)删除:点击该条目后,可以删除该项服务注册信息。

服务注册页面

3. 服务注册类型

3.1 HTTP 类型的服务注册

在注册的页面,点击新增服务按钮,类型选择为HTTP, 即可创建HTTP类型的服务注册。HTTP类型的服务注册,包含:名称、使用人员(平台所有人 or 指定人员)、Url完整地址、签名验证(目前仅支持MD5、SHA256签名验证)、参数列表、服务描述。

下面针对创建一个完整的 HTTP 类型的服务注册所需信息进行详细介绍:

  1. 类型:选择类型:HTTP。

  2. 名称:创建服务时,可以根据自己需要来填写。名称建议带有业务含义,以便在服务列表页面可以进行检索查询。

  3. 管理员:可以查看服务注册里面的接口详情并且可以修改相关的配置,包括修改增加其他管理员等。

  4. 平台公共服务:该勾选该栏目时,表示该服务注册可以为平台所有应用管理员使用。

  5. 使用人员:相当于该服务注册授权给哪些人去使用,被授权的人员可以在表单里面配置服务注册的时候可以选择到该服务注册。

  6. url 完整地址:需要访问的HTTP接口对应的完整地址,例如:

    https://www.aliwork.com/test

  7. MD5 签名验证:MD5(32位大写)签名验证,当选择加密时需要额外输入加密密钥(自定义),宜搭在发起请求时会使用该密钥和所有入参一起进行加密,加密的字符串会以默认参数:__signature(流程里的自动节点使用的参数名是sign)传递给目标服务。目标服务验证签名时需要将所有参数值进行去重(宜搭内部使用TreeSet处理,调用时需要保证服务端参数名不重复)升序排序,每个参数值之间使用$分隔,并在末尾拼接密钥后进行 MD5 加密,例如:当参数值为123,密钥为test时的加密串为123$test

  8. SHA256签名验证:当选择开启加密时,需要额外输入加密密钥(自定义),宜搭在发起请求时会使用该密钥和所有入参一起进行加密,加密的字符串会以默认参数:__hmacSha256 传递给目标服务,加密算法使用HmacSHA256算法,结果使用Base64转换成UTF8的字符串。目标服务验证签名时需要将所有参数名进行去重然后使用参数值(宜搭内部使用TreeSet处理,调用时需要保证服务端参数名不重复)升序排序,每个参数值之间使用$分隔。

  9. 参数列表:方法中需要用到的参数。

  10. 服务描述:对服务作用或其他功能的说明信息。

特别说明:

  • 宜搭侧回调时的请求的HTTP类型为POST

  • Body体的参数类型为:application/x-www-form-urlencoded; charset=UTF-8

即:content-type:application/x-www-form-urlencoded; charset=UTF-8

3.2 GATEWAY 类型的服务注册

在注册的页面,点击新增服务按钮,类型选择为GATEWAY, 即可创建 GATEWAY 类型的服务注册。GATEWAY类型的服务注册,包含:类型、名称、使用人员(平台所有人 or 指定人员)、 Url 相对地址、参数列表、服务描述。下面针对创建一个完整的GATEWAY类型的服务注册所需信息进行详细介绍:

  1. 类型

    :选择类型:GATEWAY,该类型仅面向阿里内部生态公司企业用户,普通企业用户请选择HTTP类型。

  2. 名称

    :创建服务时,可以根据自己需要来填写。名称建议带有业务含义,以便在服务列表页面可以进行检索查询。

  3. 平台公共服务

    :该勾选该栏目时,表示该服务注册可以为平台所有应用管理员使用。

  4. 使用人员

    :可以理解为服务的管理者;且管理员可以对自己创建的服务进行查看、修改。

  5. Url相对地址

    :需要访问的 GATEWAY 接口对应的相对地址。

  6. 参数列表

    :方法中需要用到的参数。

  7. 服务描述

    :对服务作用或其他功能的说明信

4. 本章小结

以上就是服务注册的全部内容,主要包括了 HTTP 类型的服务回调以及 GATEWAY 类型的服务回调的注册,但是操作完服务注册之后仅仅只是完成了第一步,接下来需要到具体的表单或者流程页面中进行引用配置了,详细的使用说明请参考服务回调。

服务回调

点此查看服务回调详解

阿里云首页 宜搭 相关技术圈