分享
RPA 参数表单动态渲染规范与工具使用指南
输入“/”快速插入内容
🤠
RPA 参数表单动态渲染规范与工具使用指南
用户4481
用户4481
7月2日修改
RPA参数选择.html
24.38KB
一、 背景与目的:为什么我们需要这个?
在构建企业级 RPA应用系统时,我们面临一个核心挑战:
不同 RPA 机器人所需的运行参数千差万别。
•
比如,“财务报表生成机器人”需要选择
报表月份
和
业务部门
。
•
而“服务器巡检机器人”则需要输入
目标服务器 IP
和选择
巡检深度
。
为了实现一个统一、通用且
用户体验友好
的“应用运行选择界面”,我们需要一种机制,让前端能够根据不同的 RPA 应用,
动态地渲染出对应的参数填写表单
。
然而, 影刀RPA底层的参数类型局限,无法原生支持“下拉框”、“日期选择器”、“文件上传”等复杂前端 UI 组件的配置。
本规范与工具的诞生,正是为了解决这一痛点。
采用“
约定大于配置
”的思想,创新性地将前端 UI 组件的渲染规则,以轻量级 JSON 的形式“隐藏”在 影刀RPA原生的
“描述” (Description)
字段中。前端通过解析这段 JSON,即可完美、动态地呈现出符合业务需求的复杂表单。
这套方案不仅绕过了底层平台的限制,还具有极高的灵活性和可扩展性,真正实现了“配置驱动 UI”。
二、 核心原理与设计边界
设计严格遵循以下边界,以保证系统的简洁与高效:
1.
外部表格管“变量名”:
影刀RPA中定义的“参数名称”(如“报表类型”、“日期范围”),天然作为前端表单的
Label(标题)
,同时也是传给 RPA 机器人的
Key(变量名)
。
2.
内部 JSON 管“高级渲染”:
“描述”字段纯粹负责 UI 组件的高级渲染控制(如组件类型、是否必填、下拉选项列表等)。
3.
极简与向下兼容:
采用标准的 JSON 格式,且强制压缩为单行。未来若需新增组件属性(如限制数字输入的最大值),只需在 JSON 中增加对应字段即可,老数据不受影响,平滑升级。
三、 参数配置属性详解
在“描述”字段填写的单行 JSON 中,包含了前端渲染表单所需的各类指令。以下是支持的各个属性的具体作用解释:
通用属性(适用于大部分组件)
•
type
(必填, 字符串):
核心字段,决定前端将该参数渲染成什么类型的组件。目前支持:
input
(单行文本),
number
(数字),
select
(下拉选择),
date
(日期选择),
file
(文件上传),
checkbox
(开关/复选)。
•
required
(可选, 布尔值):
决定该字段在 RPA 运行时是否强制要求用户必须填写。填写
true
表示必填,如果不填用户将无法提交任务。
•
placeholder
(可选, 字符串):
输入框内默认显示的灰色提示文字。通常用于指导用户应该输入什么格式的内容(例如:“请输入邮箱地址...”)。
特有属性
•
multiple
(可选, 布尔值):
仅在使用
select
(下拉选择)
组件时有效。开启后 (
true
),下拉框支持同时勾选多个选项。
•
options
(使用
select
时必填, 数组):
下拉组件的核心配置。它是一个包含对象的数组。
◦
label
:
用户在界面上看到的选项名称(中文)。
◦
value
:
用户选中该项后,实际传递给 RPA 脚本处理的真实数据。两者可以相同也可以不同。
◦
示例:
[{"label": "研发部", "value": "dept_rd"}, {"label": "销售部", "value": "dept_sales"}]
•
format
(可选, 字符串):
仅在使用
date
(日期选择)
组件时建议配置。用于规定日期选择器最终返回给 RPA 的数据格式,如
YYYY-MM-DD
。RPA 接收到的日期字符串将严格按照此规则组装,避免格式解析报错。
四、 JSON 规范生成器工具使用指南