引擎配置文件
本文主要介绍引擎配置文件需配置的内容以及如何配置,主要有以下可配置内容:
流程名称
菜单栏图标
客户端主页图片
流程描述
主数据实体
主实体卡片重写
主实体筛选重写
前置RPA
后置RPA
授权信息
配置总览
同一RPA引擎在网络中只能有一个在工作。使用中心数据库进行引擎锁管理。
{
"processName": "采集订单详情",
"menuBarIcon": {
"selected": "test.png",
"unSelected": "test.png"
},
"homeImage": "purchase.png",
"describe": "根据已有的订单号,到目标系统采集订单的详情信息并保存。启动请点击右侧开始执行按钮。",
"masterEntity": "purchase",
"masterCard": {
"omit": "post",
"title": {
"field": "purchaseNo",
"logo": "purchaseNo.png"
},
"brief": [{
"field": "enquiryNo",
"img": "enquiryNo.png"
}, {
"field": "purchaseTime",
"img": "purchaseTime.png"
}]
},
"masterFilters": [
"purchaseNo",
"enquiryNo",
"purchaseTime",
"requisitions",
"consigneePhone"
],
"preRpa": {
"tips": "请调整下方采集到的数据,更新完成后,请选择需要进行下一步操作的数据。",
"path": "com.zlyd.businessprocess.XXXPreRpaProcess"
},
"postRpa": {
"tips": "正在进行后置处理中,请稍后。",
"path": "com.zlyd.businessprocess.XXXPostRpaProcess"
},
"authorizations": [
{ "key": "fox_gz_system", "title": "FOXGZ系统" },
{ "key": "fii_gz_system", "title": "FIIGZ系统" }
]
}
引擎名称
processName:添加引擎名称,客户端上需要展示引擎标题时使用,最好根据引擎的功能命名,填写填写名称即可,英文或中文都可以,英文名就是文件名,不单独指定,指定中文名不超过12个半角字符。。
菜单栏图标
menuBarIcon:添加引擎对应的菜单栏图标,当鼠标点击图标时可进行引擎的切换,这里有两种状态图标需要添加,selected表示选中,unselected表示未选中,填写图片名称即可,图片命名不能使用中文,格式为png,大小限制为24X24 px,存放在工程配置文件主目录下的images文件夹内,在客户端上的效果如图所示。
客户端主页图片
homeImage:添加引擎图片,这个图片将会在主页卡片列表和引擎主页展示,填写图片名称即可,图片命名不能使用中文,格式为png,大小限制为125X135 px,存放在工程配置文件主目录下的images文件夹内。
引擎描述信息
describe:添加引擎简介信息,这个信息将会在主页卡片列表和引擎主页展示,如下图所示。
主数据实体
masterEntity:添加引擎主实体,表示这个引擎操作的数据主要来自这个实体,如下图中采集订单详情这个引擎对应的主实体就是采购单实体,填写对应的实体名称即可,一个引擎对应一个主数据实体,多个引擎不能使用同一个主数据实体。
主实体卡片重写
masterCard:主实体卡片重写,在这里可以更改前面实体配置中卡片展示的字段,根据当前引擎的需求决定是否重写,重写的格式对应3.2中实体卡片配置。
主实体筛选重写
masterFilters:主实体筛选框重写配置,在这里可以更改前面实体配置中写好的用于筛选的字段,根据当前引擎需求决定是否重写,重写的格式对应3.2中实体筛选配置。
前置RPA
preRpa:前置RPA配置,在RPA平台生成时可以为空。
提示
tips:流程执行前的说明。
引擎基类
path:脚本实例的类完全限定名,需要继承引擎基类。
后置RPA
postRpa:后置RPA配置,在RPA平台生成时可以为空。
提示
tips:流程执行前的说明。
引擎基类
path:脚本实例的类完全限定名,需要继承引擎基类。
授权信息
authorizations:给客户端添加当前引擎执行过程中涉及的需要授权的系统信息,需填写系统关键字key和系统名称title,系统自动配给出 auth.${key}.account和auth.${key}.password两个环境变量用于缓存授权系统的账号和密码,需要注意的是这里添加的授权应全部属于工程配置文件中的授权系统。 引擎开始之前需要输入目标系统的账号存入auth.${key}.account和auth.${key}.password中,引擎可以调用这两个变量获取账号和密码去目标系统登录作业,在客户端设置页可以选择缓存的策略“临时”、“永久”、和“永不”,选择永久缓存的话后面引擎执行重复系统操作的时候就不需要再输入授权账号和密码了。
系统代号
key:系统关键字相当于系统的代号在,系统代号命名只允许包含英文、数字和下划线。
系统名称
title:这是用于客户端页面上显示的系统名称,没有特定的命名规则,中英文都可。