RPA命名规范

1. 命名规范

1.1 概述

描述了了关于RPA开发过程中的各种文件、参数的命名规范。

1.2 文件夹及文件

需要注意的是,如果客户明确指定了文件的命名规则,请首先参考客户给定的规则来进行命名。

1.2.1 流程外层文件夹的命名规范应当为一个业务流程建立一个流程文件夹和组件文件夹,命名为业务流程的中文名称或已知的英文名称(如:云账单样张核对流程、数据监测流程等); 

1.2.2 项目文件夹的命名规范名称应当以项目英文简写若遇空格以【_】代替,或帕斯卡命名法:

1.2.3 流程xaml文件的命名规范名称应当以实现功能英文简写若遇空格以【_】代替,或帕斯卡命名法:通常可以使用:【实现功能英文简写】_【xaml】 组成;若有调用其他子流程,可以建立Main.xaml,在Main.xaml调用子流程文件命名的长度应当遵循精炼原则,不超过100个字符

1.2.4 过程中产生的文件及文件夹的命名规范流程过程中可能产生一些过程文件或是输出文件。对于此类文件,如果是客户明确提出了名称要求的,需遵循客户提供的命名规则进行;若没有明确的命名规则,则可参考以下规则: 中文文字/英文字母/下划线【_】组成 通常可使用:【流程名称】_【文件用途/文件名称】_[生成日期/月份].扩展名

1、 发票对账流程_发票处理记录表_202001.xlsx

2、 报表下载流程_管理报表模板.xlsx

1.2.5 流程配置相关文件存储路径:流程配置相关的文件,若客户有明确提出所需存储的路径和名称(比如放在共享文件盘的指定文件夹中),则应遵循客户要求;否则,则建议将配置文件存储在项目文件Data的目录下,比如“C:\UiPath\xxx公司RPA项目_财务部_发票验证流程\InvoiceVerification\Data”。文件命名:如果是特定流程专用的配置文件,则建议在文件命名时标明。如“C:\UiPath\xxx公司RPA项目_财务部_发票验证流程\InvoiceVerification\Data\DailyReportProcessDepositType_ Config.XLSX”如果是多个流程使用的配置文件,则不要在文件名字体现流程名称,请以Config命名如:“C:\UiPath\xxx公司RPA项目_财务部_发票验证流程\InvoiceVerification\Data\ Config.XLSX”。

1.3 Sequence及Activities Display Name命名规范名称当以中文为主,着重突出当前Sequence实现的功能,若使用英文避免出现语法错误

1.4 变量命名规范名称应当以英文字母、数字和下划线(_)组成,[_]表示声明变量的基本类型以此增强可读性;名称应当以英文字母开头,每个单词的首字母大写,其后字母小写;下划线后的如果是英文单词,单词首字母小写;如果是多个单词,后续单词的首字母大写;单词缩写应当全部大写;流程变量的命名长度建议不超过50个字符

选择不同名称的Scope,代表变量使用范围不要申明名称相同变量错误示例: 此外,推荐使用英文作为开头来命名变量,可以方便以后搜索过滤

基本类型的命名应包含【参数描述】_【可选扩展描述】_【类型缩写】_,例如: 字符串 XXX[_YYY]_ str 数字 XXX[_YYY]_ int 布尔 XXX[_YYY] bool 其他类型同理可推

1、 name_str

2、 btnSearchImageExist_bool 

3、 productName_str

4、 serachElements_bool

1.5 其他类型(数组、对象)数组、对象在变量名称中,应当至少标识出最外层对象的类型:

数组 YYY[_ZZZ]_arr_XXX 对象 YYY[_ZZZ]_obj_XXX

1、 ticketName_arr_str

2、 order_arr_obj

1.6 屏幕捕获元素

所有屏幕捕获元素,必须使用有意义的变量做为标识:

模块/窗口标识_控件名称[_可选扩展标识]_【控件类型】

按钮: XXX[_YYY]_btn

输入框:XXX[_YYY]_ipt

下拉框: XXX[_YYY]_sel

选择框:XXX[_YYY]_chb

文字显示:XXX[_YYY]_lbl

复选按钮:XXX[_YYY]_chkb

单选按钮:XXX[_YYY]_rdb

超链:XXX[_YYY]_ref

表格:XXX[_YYY]_tbl

列表XXX[_YYY]_lst

同理类推其他类型

1.7 备注

使用中文备注,可清晰知晓变量声明含义及流程范围代码功能实现变量备注添加方式:1、 在Variable栏目,点击声明完成的变量,右键单击,出现弹窗

2、 点击Edit Annotation

3、 输入备注信息并点击ok即可

在Sequence及Activities添加备注添加方式:

1、 选中Sequence或Activities,右键单击,出现弹窗

2、 点击Annotations,选择Add Annotations

3、 输入备注信息即可

1.8 名称变更已在开发中的流程需要修改文件名称或变量名称时,需要注意名称变更可能造成的影响,并对影响一一进行处理。PS:鉴于以下影响,强烈建议在流程设计时,尽量避免使用常量来指定文件名称及路径,而最好采用配置化参数的方式来进行设计,将文件名称、路径等参数放在外部配置表中进行读取,从而使得其发生更改时,只需要手动修改配置表中的参数而无需修改流程中的逻辑节点。

1.8.1 流程文件夹的名称变更流程文件夹的名称若发生变更,需要检查流程中与文件存取、写入相关的步骤是否收到影响;如果流程中对于文件的操作使用了常量来指定绝对路径,则可能导致流程处理发生问题。

1.8.2 xaml流程文件的名称变更若xaml流程文件的名称发生改变,需要检查该xaml文件是否被其他流程引用;若有引用,则需要手动对相关流程中的引用模块重新定义路径参数的值,并修改传递的参数。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,347评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,435评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,509评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,611评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,837评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,987评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,730评论 0 267
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,194评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,525评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,664评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,334评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,944评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,764评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,997评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,389评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,554评论 2 349

推荐阅读更多精彩内容

  • 1.贪心算法 基本概念 所谓贪心算法是指,在对问题求解时,总是做出在当前看来是最好的选择。也就是说,不从整体最优上...
    大地蛋阅读 800评论 0 0
  • 小说和电影总是有一些距离的,更何况是日本小说和中国电影,在踏入电影院前,我一直在想会如何改编呢?场景的转换,日本人...
    莜薇阅读 279评论 0 1
  • 由于在IE中存在bug,对于某些函数,typeof操作符返回'object',所以,应该根据对象的字符串表示来判断...
    何幻阅读 330评论 0 0
  • 今夜听枫落,晓看残月升。 闲坐亭台上,相思无故人。 又见你时,仿佛时光好远,对你微微一笑,安静走开。我不知道岁月带...
    末子夕_25a6阅读 222评论 0 1
  • 画中仙 月近黄昏照寒鸦,新船嫩藕芽,渔网落霞。细雨湿流光,更湿他衣冠。 一.乍见...
    莫鸣阅读 516评论 0 2