更新产品文档

gitbook/dev/SUMMARY.md

@@ -14,5 +14,7 @@
     * 看板(第二期) 
 * [附录](appendix.md)
     * [前端框架结构](appendix.md#前端框架结构)
+___
+* [修订记录](updateLog.md)
 
 

gitbook/dev/updateLog.md

@@ -0,0 +1,4 @@
+# 修订记录
+| 文档版本号 	| 修订日期   	| 修订人 	| 修订描述                                                          	|
+|------------	|------------	|--------	|-------------------------------------------------------------------	|
+| V1.0       	| 2018/07/31 	| 肖春腾 	| 初稿；1)模板中思维导图部分意义不明; 2)数据库设计文档部分待贺骎伟更新 	|

gitbook/product/README.md

@@ -1,2 +1,14 @@
-# Introduction
+![Logo](asset/image/UAS_Logo.png)
 
+# BI商业智能平台 - 产品文档
+
+##### 编写人
+`肖春腾`
+##### 编写日期
+`2018/08/01`
+
+| 文档版本号 	| 文档编号 	| 文档密级  	| 项目编号 	| 归属部门/项目 	|
+|------------	|----------	|-----------	|----------	|---------------	|
+| V1.0       	|          	| 机密文件  	|          	|               	|
+
+##### 深圳市优软科技有限公司 版权所有 内部资料 注意保密

gitbook/product/SUMMARY.md

@@ -1,4 +1,16 @@
 # Summary
 
-* [Introduction](README.md)
-
+* [首页](README.md)
+* [简介](intro.md)
+* [用户角色描述](user-Role.md)
+* [产品概述](product-description.md)
+* 功能需求
+    * [数据连接](feature-demanded-dataConnect.md)
+    * [数据源](feature-demanded-dataSource.md)
+    * [图表](feature-demanded-chart.md)
+    * 报告与看板(第二期)
+* [其他需求](other-demand.md)
+* [风险分析](risk-analysis.md)
+* 相关文档
+___
+* [修订记录](updateLog.md)

gitbook/product/feature-demanded-chart.md

@@ -0,0 +1,51 @@
+# 功能需求
+## 图表（以及图表编辑器）
+### 用户场景
+确定好数据源之后根据数据源创建相应的图表
+### 功能描述
+按照需求将数据源所提供的数据进行可视化，可为报告与看板提供图表元素
+### 入口说明
+`创建图表：图表 => 创建图表 => 选择已存在的数据源`
+
+`从数据源快速创建图表: 数据源 =>  点击想要使用的数据源右边的齿轮弹出菜单 => 创建图表`
+
+`修改图表: 图表 => 点击需要修改的图表的卡片预览图部分`
+
+### 业务流程
+`选择可视化模式 =>`
+`填入相对应的图表设置项 =>`
+`选择样式设置标签配置样式（第二期） =>`
+`选择其他设置配置备注、所属组别、权限（第二期） =>`
+`在顶部点击标题或者标题旁的编辑按钮编辑标题 =>`
+`右上角可点击进行撤销和重做与预览（第二期） =>`
+`右上角可点击查看列（第二期与自定义列选项一起做） =>`
+`左上角可点击保存或返回图表界面（如果点击返回时尚未保存会提示是否保存） =>`
+`左下角有自动刷新开关，开启时每次改动配置都会触发刷新，关闭时会显示按钮点击手动刷新 =>`
+`点击图表上方漏斗可进行筛选（第一期未完成）`
+
+### 界面UI
+
+### 信息要素
+| 字段     	| 字段类型    	| 必填项 	| 字段说明                                           	|
+|----------	|-------------	|--------	|----------------------------------------------------	|
+| 图表名称 	| VARCHAR     	| 是     	| 默认为数据源名称（未命名）                         	|
+| 说明     	| VARCHAR     	| 否     	| 展示于图表卡片以简短说明                           	|
+| 创建人   	| VARCHAR     	| 否     	| 待用户系统建立后会自动填入                         	|
+| 创建时间 	| DATETIME    	| 否     	| 待用户系统建立后会自动填入                         	|
+| 图表设置 	| JSON String 	| 是     	| 设置图表的基础参数，不同的可视化模式可设置的项不同 	|
+| 样式设置 	| JSON String 	| 否     	| 设置显示图表的样式参数                             	|
+| 其他设置 	| JSON String 	| 否     	| 设置图表的其他参数                                 	|
+
+### 界面功能按钮及交互说明
+| 按钮 	| 按钮交互说明 	| 按钮功能说明                                                                                                 	| 按钮逻辑                                                                                                           	|
+|------	|--------------	|--------------------------------------------------------------------------------------------------------------	|--------------------------------------------------------------------------------------------------------------------	|
+|![分组管理器](asset/image/dataSource-Button1.png)      	| 分组管理器   	| 可展开分组管理器以进行分组管理                                                                               	| 点击展开，失焦时收起                                                                                               	|
+|![分组选择器](asset/image/dataSource-Button2.png)      	| 分组选择器   	| 可下拉展开一个层级菜单选择显示的分组                                                                         	| 点击展开，选择子项时标签变化为所选子项（如果是子节点会显示为面包屑形式）并收起，失焦时收起                         	|
+|![创建图表](asset/image/chart-button1.png)      	| 创建图表     	| 点击后会弹出选择数据源的窗口                                                                                 	| 点击后弹出Modal，单选数据源后点击下一步跳转入图表编辑器                                                            	|
+|![纵轴选择器](asset/image/chart-button2.png)       	| 纵轴选择器   	| 点击后展开纵轴选择器，选择数据列后可以选择统计方式；如果已选，可以直接点击显示统计方式的标签直接修改统计方式 	| 点击展开，选择数据列和统计方式后会显示为一个标签和列名，直接点击标签可以修改统计方式，失焦时收起                   	|
+|![刷新控件1](asset/image/chart-button3.png)![刷新控件2](asset/image/chart-button4.png)
+![刷新控件3](asset/image/chart-button5.png)         	| 刷新控件     	| 开启时每次更改图表设置都会刷新图表                                                                           	| 开启时每次更改图表设置都会尝试请求图表数据，然后刷新图表；关闭后则不会自动刷新，并且显示手动刷新按钮，点击后刷新。 	|
+|![筛选控件](asset/image/chart-button6.png)       	| 筛选控件     	| 点击后弹出筛选管理器                                                                                         	| 设置好筛选条件后每条筛选条件都会以标签的形式展示，并且可以手动点亮或点灭切换是否启用该筛选条件。                   	|
+|![预览按钮](asset/image/chart-button7.png)       	| 预览按钮     	| 点击后将在新窗口打开一个页面单独显示图表                                                                     	|                                                                                                                    	|
+
+### 补充说明

gitbook/product/feature-demanded-dataConnect.md

@@ -0,0 +1,35 @@
+# 功能需求
+## 数据连接
+### 用户场景
+系统管理员需要根据同一个数据库中多个不同的表分别创建数据源。
+### 功能描述
+在创建数据源时会引导用户选择一个已存在的数据连接而无需再次为同一个数据库/数据仓库手动填入重复的连接信息。
+### 入口说明
+`数据源 => 创建数据源 => 创建数据库型数据源 => 选择已存在的数据连接或点击加号新建连接`
+### 业务流程
+`点击加号新建数据连接 => 填入连接名、选择数据库类型、填入数据库地址、端口、数据库名(SID)、用户名、密码、说明（可选）=> 创建完成`
+
+### 界面UI
+![数据连接UI - 1](asset/image/dataConnect-ui1.png)
+![数据连接UI - 2](asset/image/dataConnect-ui2.png)
+![数据连接UI - 3](asset/image/dataConnect-ui3.png)
+
+### 信息要素
+| 字段          	| 字段类型 	| 必填项 	| 字段说明                                 	|
+|---------------	|----------	|--------	|------------------------------------------	|
+| 连接名        	| VARCHAR  	| 是     	| 数据连接名称                             	|
+| 数据库类型    	| VARCHAR  	| 是     	| 目前支持ORCL，计划支持MySQL，SQLSERVER   	|
+| 数据库地址    	| VARCHAR  	| 是     	| 所连接的数据库服务器地址，可为IP或域名   	|
+| 端口          	| INT      	| 是     	| 所连接的数据库服务器端口                 	|
+| 数据库名(SID) 	| VARCHAR  	| 是     	| 数据库实例名（SID）                      	|
+| 用户名        	| VARCHAR  	| 是     	| 数据连接所使用的用户名                   	|
+| 密码          	| VARCHAR  	| 是     	| 数据连接所使用的密码                     	|
+| 说明          	| VARCHAR  	| 否     	| 展示于数据连接选择界面下为该连接简单说明 	|
+
+### 界面功能按钮及交互说明
+- `测试`：以当前已填信息尝试连接目标数据库测试可用性
+- `清空`：清空已填字段
+- `取消`：放弃添加数据连接
+- `确定`：将当前已填信息保存为一个新的数据连接（保存前再次进行测试确保可用）
+
+### 补充说明

gitbook/product/feature-demanded-dataSource.md

@@ -0,0 +1,54 @@
+# 功能需求
+## 数据源
+### 用户场景
+1. 系统管理员将业务数据库/数据仓库中的数据接入BI平台
+2. 其他用户自行上传CSV/XLSX文件作为数据源（第二期）
+
+### 功能描述
+作为数据来源为图表提供数据以及其他相关信息以供自定义图表
+### 入口说明
+- `新建数据源：数据源 => 创建数据源`
+- `修改数据源：	数据源 =>  点击需要修改的数据源右边的齿轮弹出菜单 => 属性设置`
+
+### 业务流程
+- `选择数据库或者文件（第二期）=> `
+- `选择一个已存在的数据连接或者新建一个数据连接（见数据连接部分）=>`
+- `填入数据对象（SQL语句或者表名），点击获取列数据 =>`
+- `按照需求为各列设置启用、列名、备注（会尝试获取注释字段）、分析类型（会尝试初步自动判断分析类型）、允许分组/分段（为按照分析类型判断是否可用）、别名 =>`
+- `填入权限配置（第二期）`
+
+
+
+### 界面UI
+![数据源UI - 1](asset/image/dataSource-ui1.png)
+![数据源UI - 2](asset/image/dataSource-ui2.png)
+![数据源UI - 3](asset/image/dataSource-ui3.png)
+![数据源UI - 4](asset/image/dataSource-ui4.png)
+![数据源UI - 5](asset/image/dataSource-ui5.png)
+
+### 信息要素
+| 字段     	| 字段类型 	| 必填项 	| 字段说明                                                	|
+|----------	|----------	|--------	|---------------------------------------------------------	|
+| 名称     	| VARCHAR  	| 是     	|                                                         	|
+| 说明     	|          	| 否     	|                                                         	|
+| 创建人   	| VARCHAR  	| 否     	| 待用户系统建立后会自动填入                              	|
+| 创建时间 	| DATETIME 	|        	| 待用户系统建立后会自动填入                              	|
+| 数据对象 	| String   	|        	| 连接上数据库后具体连接的数据对象，可为表明或一段SQL语句 	|
+
+### 界面功能按钮及交互说明
+| 按钮 	| 按钮交互说明       	| 按钮功能说明                                                                                     	| 按钮逻辑                                                                                                 	|
+|------	|--------------------	|--------------------------------------------------------------------------------------------------	|----------------------------------------------------------------------------------------------------------	|
+|![分组管理器](asset/image/dataSource-Button1.png)      	| 分组管理器         	| 可展开分组管理器以进行分组管理                                                                   	| 点击展开，失焦时收起                                                                                     	|
+|![分组选择器](asset/image/dataSource-Button2.png)      	| 分组选择器         	| 可下拉展开一个层级菜单选择显示的分组                                                             	| 点击展开，选择子项时标签变化为所选子项（如果是子节点会显示为面包屑形式）并收起，失焦时收起               	|
+|![添加数据源](asset/image/dataSource-Button3.png)      	| 添加数据源         	| 可下拉展开一个普通菜单，显示可添加的数据源类型，目前包括数据库和文件选项                         	| 点击展开，选择子项时跳转，失焦时收起                                                                     	|
+|![数据源操作](asset/image/dataSource-Button4.png)      	| 数据源操作         	| 可下拉展开一个层级菜单，可进行快速创建图表、属性设置、预览数据，分组、删除数据源                 	| 点击展开，选择分组层级菜单时和分组选择器功能一样，选择其他子项跳转相应页面，失焦时收起                   	|
+|![获取列数据](asset/image/dataSource-Button5.png)      	| 获取列数据         	| 点击后会获取数据对象的列信息                                                                     	| 以已填入的数据连接信息和数据对象信息尝试向目标数据库请求该数据对象的列信息                               	|
+|![启用开关](asset/image/dataSource-Button6.png)      	| 启用开关           	| 点击设定是否启用该数据列                                                                         	| 如果设为不启用，则图表在解析列信息时会忽略该列                                                           	|
+|![列备注](asset/image/dataSource-Button7.png)      	| 列备注             	| 可修改该列备注                                                                                   	| 列备注默认获取数据对象中对应列的注释，在选择数据列时可以简短说明该数据列意义                             	|
+|![分析类型](asset/image/dataSource-Button8.png)      	| 分析类型           	| 可选择该数据列的分析类型；取决于其数据类型，可能可选的选项有时间、索引、标量、类别、序值、字符串 	| 分析类型默认获取数据对象中对应列的数据类型然后解析判断为一个默认的分析类型，如果判断不正确可以手动修改。 	|
+|![允许分组与允许分段](asset/image/dataSource-Button9.png)      	| 允许分组与允许分段 	| 可选择该数据列是否允许分组或分段；取决于其分析类型，可能可用或不可用                             	| 允许分组/分段默认根据其分析类型解析出其是否理论上可用于分组或分段，如果判断不正确可手动修改              	|
+|![别名](asset/image/dataSource-Button10.png)      	| 别名               	| 可修改该列别名                                                                                   	| 别名用于图表中代表各数据列，默认获取相应的备注列信息，如果过长只会尝试截取头部，也可以另行修改           	|
+|![保存修改](asset/image/dataSource-Button11.png)      	| 保存修改           	| 点击保存修改                                                                                     	| 向服务器提交表单保存修改                                                                                 	|
+
+
+### 补充说明

gitbook/product/intro.md

@@ -0,0 +1,4 @@
+# 简介
+此文档为BI（商业智能）平台的产品文档，用于全面介绍BI商业智能平台以及汇总产品设计的原则与思路
+##	目的
+##	范围

gitbook/product/other-demand.md

@@ -0,0 +1,4 @@
+# 其他产品需求
+## 性能需求
+## 监控需求
+## 兼容性需求

gitbook/product/product-description.md

@@ -0,0 +1,28 @@
+# 产品概述
+## 目标
+1. 系统管理员可以通过配置将业务数据库/数据仓库接入BI系统提供给所有用户使用。
+2. 所有用户都可以自行上传CSV/XLSX文件作为自用数据源
+3. 普通用户和数据分析师可以使用BI系统提供的数据可视化工具制作自定义图表，还可以将多个自定义图表组合成自定义报告/看板
+4. 数据分析师还可以将制作好的图表/报告/看板/推送给普通用户用于分享信息。
+5. 用户可以将报告/看板导出为PDF用于其他场景。
+
+## 总体流程
+![新增数据源](asset/image/workflow1.png)
+![新增图表](asset/image/workflow2.png)
+
+## 功能摘要
+| 功能模块                   	| 主要功能点                                    	| 优先级 	|
+|----------------------------	|-----------------------------------------------	|--------	|
+| 数据源                     	| 为图表提供数据                                	| 高     	|
+| 数据连接                   	| 作为快速创建数据源的工具                      	| 高     	|
+| 图表                       	| 将数据可视化，为报告提供图表元素              	| 高     	|
+| 图表编辑器                 	| 用于配置图表                                  	| 高     	|
+| 报告与看板（第二期）       	| 整合图表元素、添加基础元素形成完整的报告/看板 	| 中     	|
+| 报告与看板编辑器（第二期） 	| 用于配置报告与看板                            	| 中     	|
+
+
+## 名词解释
+1. 报告与看板在系统源代码中都命名为dashboard，其中type字段会标注为”Dynamic” （看板：动态dashboard）或”Static”（报告：静态dashboard）。其功能区别在于
+ - 看板具有自动刷新功能，更多用于屏幕上的展示； 
+ - 报告需要参照纸张规格设计，更多用于打印或导出为PDF的分享。
+

gitbook/product/risk-analysis.md

@@ -0,0 +1,7 @@
+# 风险分析
+
+## 风险
+- 可能性
+- 严重性
+- 应对策略
+- 可应对性

gitbook/product/updateLog.md

@@ -0,0 +1,4 @@
+# 修订记录
+| 文档版本号 	| 修订日期   	| 修订人 	| 修订描述                                                          	|
+|------------	|------------	|--------	|-------------------------------------------------------------------	|
+| V1.0       	| 2018/08/01 	| 肖春腾 	| 初稿完成，用于帮助启动测试环节 	|

gitbook/product/user-Role.md

@@ -0,0 +1,6 @@
+# 用户角色描述
+| 用户角色   	| 用户描述                                          	|
+|------------	|---------------------------------------------------	|
+| 普通用户   	| 所有BI平台的普通用户                              	|
+| 系统管理员 	| BI平台的系统管理员                                	|
+| 数据分析师 	| 使用BI平台进行数据分析和制作报告/看板的数据分析师 	|