报告制作规范

<< Click to Display Table of Contents >>

当前位置:  系统运维 > 构建健康的系统 

报告制作规范

复制链接

1.命名规范

1)数据源命名

数据源命名要准确,避免产生误会。

如果一个类型的数据原有多个ip,可以名称后面添加ip,例如:mysql_136,mysql_137;也可以按数据库的业务用处命名,例如:mysql_工时数据,mysql_销售数据。

2)数据集命名

按照主题、子主题、数据集名称的层级去设定分布,名称和报表互相对应。

如果有集市,创建一个SQL文件夹和一个集市文件夹分别存储。

3)报表命名

按照主题,子主题,报表名称的层级去设定报表分布。

若存在历史版本报表,要单独创建文件夹和正式版本区分开。

报表文件夹的层级不能超过8层。

4)定时任务作业名称

作业文件夹名称与数据集文件夹一致;作业名称与数据集一致。

5)报表中组件命名

组件名称不使用空格、-、+@#$[]{}<>字符,规范的组件命名对脚本维护、业务参数传递等功能具有良好的指导意义,便于后期运维人员进行维护。

组件要重命名,名称要有意义,尤其是报表组件很多,有脚本,过滤器的情况下,不重命名的话,过滤器和脚本看起来就很费劲。

隐藏的组件名称以_hidden_开头,方便后续报表维护。

6)表达式命名

表达式要体现数据的特征,避免过长过短,避免使用特殊字符。

2.内容制作规范

1)各标签页组件在布局上宽度尽量保持一致。

多个标签页自适应的时候,会以宽度最大的标签页的自适应比例进行放大,如果宽度不一致,则会出现页面留白。也建议直接通过V10.1的组合报告将多个报告进行组合,不用多标签报告形式。

2)脚本编写的基本要求

a)脚本要有必要的注释。

b)尽量统一写到页面级别上,即下图所示的位置,便于排查。必须写在组件上的脚本时修改组件视图层的脚本,比如在组件视图数据上removeLink和setFont。

dashboardscript