feat: 增加报表系统说明文档

报表系统集成/报表系统集成使用文档.md

+
+
+# 报表系统集成使用文档
+
+## 一、 报表管理
+
+进入**mcs系统**中报表管理页面, 可对**报表分类**、**报表设计**、**报表参数** 等数据操作管理， 左侧页面显示报表分类信息，右侧显示报表数据。
+
+![image-20210426142755655](./image/01进入报表管理页面.png)
+
+### 1.1 报表分类
+
+#### 1.1.1 新建报表分类
+
+鼠标移动到左侧分类树上对应的节点， 节点右边则会显示 **+** 号图标，点击图标可弹出分类的对话框，设置分类信息后点击保存可进行新增操作。
+
+![image-20210426143124708](./image/02移动到分类树上.png)![image-20210426143604254](./image/03填写报表分类信息.png)
+
+#### 1.1.2 编辑报表分类
+
+鼠标移动到左侧分类树上对应的节点， 节点右边则会显示 **编辑** 图标，点击图标可弹出分类的对话框，设置分类信息后点击保存可进行编辑操作。
+
+ ![image-20210426144310010](./image/04报表分类点击修改图标.png)
+
+#### 1.1.3 删除报表分类
+
+ 鼠标移动到左侧分类树上对应的节点， 节点右边则会显示  **删除**  图标， 点击删除图标后会出现删除确认提示，点击确定则会进行删除操作。
+
+![image-20210426144448187](./image/05报表分类点击删除图标.png)
+
+
+
+ ![image-20210426144549135](./image/06删除分类确认.png)
+
+### 1.2 报表
+
+#### 1.2.1 新增报表
+
+ 点击新增按钮，可进行报表新增操作。
+ ![image-20210426145531840](./image/07点击新增报表.png)
+
+填写报表名称、设置分类、 排序值(推荐填写大于0的数字来进行排序)
+
+![image-20210426145919354](./image/08选择报表分类.png)
+
+ 设置报表信息后点击 **保存** 按钮![image-20210426150043206](./image/09设置报表信息新增报表.png)
+
+新增成功后查看报表列表信息![image-20210426150232042](./image/10查看当前新增的报表信息.png)
+
+#### 1.2.2 删除报表
+
+找到需要删除的列表行，点击 **删除** 图标
+
+![image-20210427103730689](./image/11点击删除报表.png)
+
+点击确定删除报表
+
+![image-20210427103902833](./image/12点击删除确定删除报表.png)
+
+
+
+### 1.3 报表设计
+
+#### 1.3.1 进入报表设计
+
+在报表列表上面点击对应报表行上的 **设计** 按钮， 进入到报表设计页面
+
+![image-20210426155757400](./image/13点击进入报表设计页面.png)
+
+
+
+![image-20210426160250020](./image/14报表设计大概说明.png)
+
+#### 1.3.2 选择数据源
+
+在右侧属性面板，点击切换到数据源，在点击**添加内置数据源连接**图标
+
+![image-20210427104802878](./image/15点击添加数据源.png)
+
+选择对应的数据源
+
+![image-20210427105219664](./image/16点击选择数据源.png)
+
+
+
+#### 1.3.3 添加数据集
+
+点击添加数据集
+
+![image-20210427110244195](./image/17点击添加数据集.png)
+
+SQL数据集配置
+
+左侧数据表双击可选中对应表， 然后SQL表达式中默认会生成`select * from 表名` 语句，可编写表达式。
+
+![image-20210427113802574](./image/18SQL数据集配置.png)
+
+点击预览可查看表数据
+
+![image-20210427113919357](./image/19点击预览数据.png)
+
+数据列表
+
+ 
+
+![image-20210427114124774](./image/20查看数据集信息.png)
+
+#### 1.3.4 设置单元格属性
+
+点击单元格，设置文本内容
+
+![image-20210427142238310](./image/21点击单元格设置文本内容.png)
+
+点击单元格，为单元格设置 数据集 类型。
+
+![image-20210427142424687](./image/22为单元格设置数据集类型.png)
+
+单元格属性设置数据集
+
+![image-20210427142549137](./image/23单元格选择数据集.png)
+
+
+
+![image-20210427142714513](./image/24单元格选择属性.png)
+
+![image-20210427142833125](./image/25选择聚合方式.png)
+
+再设置`手机号` 单元格、`mobile` 数据集属性。
+
+![image-20210427143155877](./image/26报表设计添加手机号列.png)
+
+#### 1.3.5 预览报表
+
+点击报表设计菜单左上角 **预览** 图标, 可预览当前设计的报表
+
+![image-20210427143442029](./image/27报表设计预览.png)
+
+![image-20210427143520156](./image/28报表设计预览数据页面.png)
+
+#### 1.3.6 保存报表
+
+点击菜单左上角**保存** 图标，可保存当前设计。
+
+![image-20210427143811209](./image/29点击保存报表设计.png)
+
+
+
+
+
+### 1.4 报表参数管理
+
+用于配置预览页面显示的报表过滤控件， 如下图所示, 需要设置报表参数和报表设计中SQL配置语句才能进行搜索过滤数据。
+
+ **图1.4.1**![image-20210427145249170](./image/34报表参数控件显示说明.png)
+
+#### 1.4.1 进入报表参数页面
+
+![image-20210427144723233](./image/30进入报表参数页面.png)
+
+![image-20210427144808900](./image/31报表参数列表页面.png)
+
+
+
+#### 1.4.2 报表参数说明
+
+![image-20210427144916793](./image/32点击新增.png)
+
+![image-20210427144943553](./image/33报表参数新增参数.png)
+
+- 报表参数说明
+  - 参数名： 用于搜索过滤的参数名称。
+  - 显示名称： 控件显示的名称，如上图**1.4.1**  `密码`。
+  - 参数控件： 目前支持控件`输入框` 、`隐藏表单域`、`日期`、`下拉框`、`下拉框(多选)。`
+  - 绑定数据源: 目前支持`系统内置`、`手动输入`、`SQL语句。`
+  - 默认值: 在某些绑定数据源情况下会有默认的选项值。
+  - 数据格式: 目前仅支持对 `日期` 控件来设置格式。
+  - 必填: 用于校验过滤条件是否必须要填写，才能进行刷新查看报表数据。
+  - 排序: 用于控件显示的顺序
+
+#### 1.4.3 新增报表参数(报表控件)
+
+添加报表参数(用户名), 设置默认值为 `当前用户名称`
+
+![image-20210427150220626](./image/35添加报表参数-用户名.png)
+
+添加报表参数(用户账号), 绑定控件为 `输入框`![image-20210427150405664](./image/36添加报表参数-用户账号.png)
+
+![image-20210427150759489](./image/37查看报表参数列表.png)
+
+
+
+### 1.5 报表预览
+
+#### 1.5.1 进入报表预览页面
+
+报表管理点击**预览**图标进入预览页面
+
+![image-20210427150929173](./image/38报表管理点击预览.png)
+
+仅设置报表参数，未在报表设计中配置SQL查询语句，报表参数是无法进行刷新过滤数据。
+
+![image-20210427151024439](./image/39查看预览页面.png)
+
+
+
+#### 1.5.2 报表设计过滤条件
+
+当前用户已设置过滤条件，但未在报表设计中配置SQL过滤。需要为报表设计属性过滤条件才能进行过滤刷新。重新进入对应报表设计页面。
+
+打开报表设计页面，进入编辑数据集界面
+
+![image-20210427151320272](./image/40编辑数据集.png)
+
+为数据集添加参数
+
+![image-20210427151409898](./image/41点击添加参数.png)
+
+
+
+设置参数名称`userAccount` 数据类型`String` 
+
+
+
+![image-20210427151502792](./image/42设置参数用户账号.png)
+
+
+
+设置参数名称`userName` 数据类型`String`  也可以设置默认值
+
+![image-20210427151643526](./image/43添加参数默认值.png)
+
+设置SQL表达式， 报表说明请查看 [ureport报表教程](https://www.w3cschool.cn/ureport/ureport-jaod2h8k.html)
+
+为sql设置了精确查询 `userAccount`  和 模糊匹配 `userName`语句
+
+```sql
+${
+	"select * from ldp_mcs_user_info u where 1=1 " +
+      (emptyparam("userAccount") == false ? 
+        "and u.user_account= :userAccount " : "")
+	+ "and u.user_name like  CONCAT(\'%\',:userName,\'%\')"
+}
+```
+
+![image-20210427151827163](./image/44设置SQL表达式.png)
+
+设计完成后需要点击保存
+
+#### 1.5.3 预览报表
+
+进入对应报表的预览页面，初始化会按照报表参数设置的默认值来进行显示列表数据
+
+![image-20210427153157574](./image/45预览过滤报表页面.png)
+
+预览报表页面清空`用户名` 刷新报表列表，会按照`sql数据集配置`中的默认值进行过滤(`userName` 默认值为`admin`)。
+
+![image-20210427153226660](./image/46预览报表页面清空默认值.png)
+
+###  1.6 带参数报表实例
+
+#### 1.6.1 隐藏表单域报表
+
+新建隐藏表单域报表, 在设置隐藏表单域参数
+
+![image-20210427154707876](./image/47隐藏表单域报表参数.png)
+
+进入报表设计页面
+
+设计数据集
+
+![image-20210427155049848](./image/48报表设计-隐藏表单域数据集.png)
+
+![image-20210427154857016](./image/49隐藏表单域报表设计.png)
+
+![image-20210427155213355](./image/49报表设计-隐藏表单域单元格user_account.png)
+
+保存报表设计， 查看预览。
+
+隐藏表单域的控件不会在预览界面中显示，但是会传递默认值进行刷新过滤列表。
+
+![image-20210427155342766](./image/50报表预览-隐藏表单域.png)
+
+
+
+#### 1.6.2 日期报表
+
+新建日期报表
+
+![image-20210427155718473](./image/51新建报表-日期.png)
+
+
+
+新增报表参数
+
+![image-20210427155915717](./image/52日期报表新增参数.png)
+
+![image-20210427160004490](./image/53日期报表参数列表.png)
+
+进入日期报表设计，设置SQL数据集
+
+![image-20210427160149786](./image/54报表设计-日期报表设置数据集.png)
+
+![image-20210427160258125](./image/55报表设计-日期报表单元格(用户).png)
+
+![image-20210427160337048](./image/56报表设计-日期报表单元格(账号).png)
+
+![image-20210427160415968](./image/57报表设计-日期报表单元格(创建日期).png)
+
+点击保存设计。
+
+进入报表预览页面，按照日期报表参数所设置的默认值(`当前日期`)进行过滤报表数据
+
+![image-20210427160519068](./image/58报表预览-日期默认列表.png)
+
+清空控件默认值后，在进行刷新操作时候，会按照报表设计中 `createDate`设置的默认值来进行过滤列表数据
+
+![image-20210427160635507](./image/59报表预览-日期默认sql查询.png)
+
+#### 1.6.3 下拉框报表
+
+新建下拉框报表
+
+![image-20210427162846000](./image/60新建下拉框报表.png)
+
+进入报表参数页面
+
+![image-20210427173358599](./image/61进入报表参数-下拉框.png)
+
+点击新增报表参数
+
+`下拉框`控件数据来源目前仅适用于 绑定数据源`SQL语句`， 默认值可选`数据集第一条`
+
+![image-20210427173346105](./image/62新增报表参数下拉框.png)
+
+ 设置SQL语句，
+
+sql说明： 第一列数据作为name, 第二列数据为value, 表示为查询的数据第一列作为`下拉框的` 显示内容， 第二列为值
+
+![image-20210427173705488](./image/63报表参数设置SQL语句.png)
+
+点击预览，可以查看sql配置查询的数据
+
+![image-20210427174153083](./image/64点击预览查看列表数据.png)
+
+
+
+![image-20210427175105686](./image/65报表参数sql预览数据列表.png)
+
+保存SQL配置
+
+![image-20210427175223822](./image/66报表参数sql配置保存.png)
+
+参数列表
+
+![image-20210427175350729](./image/67报表参数列表-下拉框.png)
+
+进入报表设计页面， 设置SQL数据集
+
+![image-20210427175622064](./image/68报表设计-SQL数据集.png)
+
+![image-20210427175743223](./image/69报表设计-下拉框用户账号.png)
+
+
+
+![image-20210427175836624](./image/70报表设计-下拉框用户名.png)
+
+
+
+
+
+![image-20210427180010034](./image/71报表设计-下拉框保存.png)
+
+
+
+进入`测试-下拉框`报表预览界面
+
+会自动获取`sql配置查询`的列表数据作为 `下拉框的选项`，且会自动设置默认值来进行查询过滤列表数据
+
+![image-20210427180113199](./image/72报表预览-测试下拉框.png)
+
+![image-20210427180159146](./image/73报表预览-测试下拉框情况.png)
+
+
+
+
+
+## 二、报表菜单
+
+### 2.1 新建报表菜单
+
+进入`应用菜单维护` 或者`管理菜单维护` 页面
+
+![image-20210427180409753](./image/74进入菜单维护页面.png)
+
+在对应菜单上面点击新建按钮
+
+![image-20210427180521040](./image/75菜单点击新建.png)
+
+
+
+新建菜单，选择页面类型 `报表-ureport`
+
+![image-20210427180632129](./image/76菜单维护修改页面类型.png)
+
+
+
+点击报表名称
+
+![image-20210427180751190](./image/77菜单维护-点击报表名称.png)
+
+选择对应报表，点击确认
+
+![image-20210427180855055](./image/78菜单维护-选择对应报表.png)
+
+点击保存
+
+![image-20210427180938720](./image/79菜单维护-保存.png)
+
+
+
+### 2.2 设置报表权限
+
+
+
+![image-20210427181342722](./image/80设置报表菜单权限.png)
+
+登录应用系统，查看应用菜单报表页面
+
+![image-20210428095039396](./image/81查看应用报表页面.png)
+