报表开发规范手册

开发环境：首先在开发环境（设计器）开发，修改，内部测试通过。

测试环境：然后发布到测试环境供业务人员测试，关键用户测试通过。

生产环境：最后发布到生产环境，供最终用户使用。

2. finedb数据库

开发环境、测试环境、生产环境使用的finedb数据库必须分离开

开发环境和测试环境使用生产环境上的finedb数据库的副本

3. 数据连接的数据库

非填报报表：报表使用的业务数据库，除了填报报表外，三个环境可以连同样的库，因为只是取数据出来展现，不会涉及到数据库表的增删改。

填报报表：填报报表使用到的数据库表，开发环境、测试环境、生产环境，需要区分开来，因为在开发测试过程中会涉及数据的增删查改，报表未上线之前，不建议使用生产环境的数据库表来调试。

远程设计使用方法请参考：远程设计

内网通过vpn连接远程设计时，需要检查网络是否通、vpn权限是否正常。

远程设计的权限区别于平台的模板权限控制，需要管理员给开发人员分配相关的模板及数据连接远程设计权限，否则切换远程设计报错用户名密码错误。

具体设置方法请参见：给用户分配远程设计权限示例

1. 协同开发或模块开发过程中，需保证UI风格相对一致，配色可以使用设计器的预定义配色去控制。

详情请参见：图表预定义配色

1. 整体备份模板

手动备份整个工程文件，或者在决策平台开启自动备份或者手动备份。

开发时，在开发环境、测试环境，开启自动备份，默认备份路径为../backup，备份文件存储在工程的%FR_HOME%/webapps/webroot/backup文件夹下。

用户可修改 backup 文件夹为其他文件夹，但是不支持保存到非工程路径下。

需要定期将备份文件移动到其他服务器或者其他目录，避免大量的备份文件导致应用过大，以及一台服务器出故障导致工程损坏。

2. 单张模板备份

1）优先在开发环境调整、验证与测试。

2）如果没有开发环境，必须先模板备份(名称可以加上日期后缀，比如*** _V20210627.cpt)，基于备份的模板做修改调整，不影响正式使用。

3）模板调整修改需记录在案，方便追踪，可以使用设计器的模板版本管理功能。

详情请参见：模板版本管理

2. 目录名需做到见名知意，与业务模块相关。

例如：

财务：FINANCE

人事：HR

营销：MARKET

3. 下层目录建议用‘_’来分隔命名

例如：

营销的销售二级目录名：MARKET_SALE

营销的回款部分：MARKET_GETIN

5. 建议独立创建测试目录TEST，作为各实施人员或运维人员自己的测试空间

二级目录为TEST+下划线+名字

例如：TEST_NAME

例如：MARKET_SALE_001

3. 准备一张报表映射excel，可以放在文件管理系统中，根据开发情况及时更新。

形如：

1. 参数面板数据集：以para_开头

例如：地区选择下拉框的数据集para_area

2. 数据字典数据集：以dic_开头

例如：产品映射字典数据集dic_product

3. 报表主体数据集：以report_开头

例如：客户销售数据report_customerSaleData

4. 图表数据集：以chart_开头

例如：产品占比图表chart_productRatio

4. 变量名是不区分大小写的, 但不能用保留字

比如true、false；FALSE、TRUE，因为写公式引用的时候容易搞错，跟保留字冲突

5. 全局参数：以g开头

例如：gSaleGroup，gProduct，gPerson

6. 模板参数：以p开头

例如：pDate，pCurrency，pUnit

7. 数据集参数：以s开头

例如：sCompany，sProject

2. 格式：条件类型_具体功能

例如：列宽_隐藏projguid列

2. 格式：超链接类型_具体功能

例如：网络报表_跳转到明细

FVS 组件命名规则

1. 不允许使用复制组件自动填充的名称

例如：表格1_页面1_c1、表格1_页面1_c1_c1

2. 每个组件应按照组件类型+序号+页面的形式，方便后期维护调整

例如：表格1_页面1、表格2_页面1、表格1_页面2

3. 每个组件名称中加上实际用途

例如：表格1_页面1_销量明细、饼图1_页面1_销量占比

1. 每个悬浮元素名称中加上实际用途，方便后期维护调整

例如：Float0_sale_detail_line_chart

1. 图块多的报表（如驾驶舱、大屏）使用 FVS 可视化看板开发

8. 控件数据字典数据量大且重复数据多时，避免直接使用数据库表

建议专门创建专用的数据字典数据集

2. 填报报表设置参数，新增导入时不展现数据

查询修改时尽可能添加过滤控件，减少查询结果集

3. 业务主键字段通常设置不可修改

如必须修改则应用数据库表中代理主键UUID字段做填报主键，新增数据时公式赋值新的UUID

4. 没有导入需求时，尽可能在单元格做即时校验

有导入需求时则应将所有校验设置在提交校验中

5. 填报的数据库表设计

设计思路：

1）要有自己的主键，有主键在做数据的修改、流程流转时很有用，不用去用很多字段确定唯一的记录

6. 填报报表设计

在页面的单元格中写参数$fine_username，公式now()。分别记录填报的用户，页面打开的时间。

1）添加E1、F1两个单元格，分别写入公式now()和$fine_username，这两个单元格不扩展，并隐藏。

2）设置填报属性，这里要勾选上未修改不更新，注意使用该功能时，填报属性中的值一定要是单元格，不能填公式，所以上一步特地新加了两个单元格。

2. 参数采用26个英文字母和0－9这十个自然数，加上下划线_组成，共36个字符，不出现其他字符。

采用英文单词或英文短语（包括缩写）作为名称，参照字典表给出的基础命名，没有的去翻译，不使用无意义的字符或汉语拼音。

5. 涉及到不同TAB模块的同样指标的参数，参数名建议带上对应TAB模块的名称，

以地区参数为例，例如：TAB1AREA、TAB2AREA

1. 中文字体里，建议使用宋体、仿宋、黑体、楷体、隶书、幼圆。

另外，思源黑体、思源宋体、庞门正道标题体、文泉驿系列、站酷系列，以及方正的楷体、黑体、仿宋、书宋，都可以免费商用

3. 明细表示例

4. 不同报表的标题，字体、字号应一致。

若出现表头，或是二级标题，字体应小于主标题，大于正文，建议加粗

正文，字体、字号应一致

5. 图表中涉及文字的地方有标题、标签、轴标签、提示。

这四类，同类应保持字体、字号一致。

标题字号一般大于其他三类。

建议这四类，字体一致，后三类字号一致。

1. 所有标题居中；数字的小数位一致。

2. 明细文字，格式统一，都居左或居中。

3. 明细表第一行、第一列空出来，留出点余白。

行高最好一致，自动换行不建议开，字数不一致的情况下，会导致行高不一，显得很乱。

6. 图表标题居中。

坐标轴标题，若有，如Y轴标题，则位置应保持一致，都居上或居中。

1. 字体颜色一般都是黑色，特殊情况，如数值预警高亮，因地制宜。

2. 表头加背景色，不建议大红大紫那些过于鲜艳的颜色，建议蓝色或灰色等。

表头字色根据背景色调整，建议白色、灰色等。

3. 明细表建议设置奇偶行的间隔色，以达到好区分不同行的目的。

颜色同样不可过于鲜艳，建议灰色或淡蓝色等。

4. 明细表配色示例

1. 根据背景颜色来设置标题等字体颜色。

如图表都是暗色系，那文字的颜色建议白色这样的亮色系。