235 lines
7.2 KiB
Markdown
235 lines
7.2 KiB
Markdown
# 数据管理平台用户手册
|
||
|
||
## 项目概述
|
||
|
||
数据管理平台是一个综合性的数据管理系统，主要用于发动机型号数据录入、参数配置管理、审批流程控制、基准报告生成等功能。该平台基于Spring Boot框架开发，集成了Activiti工作流引擎，支持数据录入、维护、审批等完整的业务流程。
|
||
|
||
## 功能架构
|
||
|
||
### 1. 数据录入与引擎模型管理
|
||
- **发动机型号管理**：支持发动机型号的录入、编辑、删除等操作
|
||
- **Excel导入功能**：支持通过Excel批量导入发动机型号数据
|
||
- **型号字段管理**：包括产品型号、产品编号、板块、平台、系列、细分市场、项目名称、项目编号、品牌、排放等信息
|
||
|
||
### 2. 参数与模板配置
|
||
- **参数管理**：管理发动机相关的各类参数信息
|
||
- **模板配置**：配置数据录入模板，支持参数模板的增删改查
|
||
- **参数详情管理**：管理具体参数的详细信息和版本控制
|
||
|
||
### 3. 审批流程控制
|
||
- **Activiti工作流**：基于Activiti引擎实现的审批流程
|
||
- **参数审批**：支持参数修改的审批流程
|
||
- **报告审批**：支持基准报告的审批流程
|
||
- **审批节点配置**：可配置多级审批节点
|
||
- **审批记录**：记录完整的审批过程和结果
|
||
|
||
### 4. 基准报告生成
|
||
- **报告管理**：支持对标报告的创建、编辑、上传
|
||
- **报告审批流程**：集成审批流程的报告管理
|
||
- **文件上传**：支持报告附件上传功能
|
||
|
||
### 5. 待办任务处理
|
||
- **待办中心**：集中管理用户需要处理的审批任务
|
||
- **已办任务**：查看已完成的任务记录
|
||
- **发起任务**：查看用户发起的审批流程
|
||
|
||
### 6. 部门人员管理
|
||
- **部门管理**：管理部门信息和层级关系
|
||
- **人员管理**：管理各部门人员信息
|
||
- **责任人员配置**：配置各部门的责任人
|
||
|
||
## 主要模块说明
|
||
|
||
### 1. 数据录入模块
|
||
- 路径：`/custom/dataEntry`
|
||
- 支持模板筛选、列表显示、添加模板、导入模板、查看、下载、版本管理、修改等功能
|
||
|
||
### 2. 引擎型号管理模块
|
||
- 路径：`/custom/dataEntryEngineModel`
|
||
- 支持发动机型号的Excel导入功能
|
||
- 管理发动机型号的基本信息
|
||
|
||
### 3. 参数管理模块
|
||
- 路径：`/custom/parameter`
|
||
- 管理发动机相关的参数配置
|
||
|
||
### 4. 审批流程模块
|
||
- 路径：`/custom/activitiProcess`
|
||
- 处理参数和报告的审批流程
|
||
|
||
### 5. 基准报告模块
|
||
- 路径：`/custom/benchmark`
|
||
- 管理对标报告的创建、审批、查看等
|
||
|
||
### 6. 待办任务模块
|
||
- 路径：`/custom/todoTask`
|
||
- 管理用户的待办、已办、发起任务
|
||
|
||
## 技术架构
|
||
|
||
### 后端技术栈
|
||
- **Spring Boot 2.2.7.RELEASE**：核心框架
|
||
- **Maven**：项目构建工具
|
||
- **Java 1.8**：开发语言
|
||
- **Lombok**：简化代码
|
||
- **Hutool**：工具库
|
||
- **MongoDB**：数据查询
|
||
- **Activiti**：工作流引擎
|
||
- **Groovy**：编译器集成
|
||
|
||
### 数据库
|
||
- 使用MySQL作为主要数据存储
|
||
- 支持多数据源配置
|
||
- 通过MpaasQuery进行数据访问
|
||
|
||
### 接口规范
|
||
- RESTful API设计
|
||
- 统一的响应格式
|
||
- 基于Response的返回结果封装
|
||
|
||
## 安装部署
|
||
|
||
### 环境要求
|
||
- JDK 1.8
|
||
- Maven 3.5+
|
||
- MySQL 5.7+
|
||
- Redis（可选）
|
||
|
||
### 部置步骤
|
||
|
||
1. **克隆项目**
|
||
```bash
|
||
git clone <项目地址>
|
||
```
|
||
|
||
2. **配置数据库**
|
||
- 修改 [application.properties](file:///D:/JavaProjects/data-management-platform/src/main/resources/application.properties) 文件中的数据库连接信息
|
||
- 执行 [sql.sql](file:///D:/JavaProjects/data-management-platform/src/main/resources/sql.sql) 初始化数据库表结构
|
||
|
||
3. **Maven构建**
|
||
```bash
|
||
# 使用single profile构建可执行jar
|
||
mvn clean package -Psingle
|
||
|
||
# 或使用lib profile构建库模式
|
||
mvn clean package -Plib
|
||
```
|
||
|
||
4. **启动项目**
|
||
```bash
|
||
java -jar target/data-management-platform.jar
|
||
```
|
||
|
||
## 使用指南
|
||
|
||
### 1. 发动机型号管理
|
||
|
||
#### 添加发动机型号
|
||
1. 访问数据录入模块
|
||
2. 可通过Excel导入或手动添加发动机型号
|
||
3. 填写型号信息包括：产品型号、产品编号、板块、平台、系列等
|
||
4. 提交后系统会自动为该型号绑定所有参数模板
|
||
|
||
#### Excel导入
|
||
- 支持批量导入发动机型号数据
|
||
- 需按照指定的Excel模板格式填写数据
|
||
- 上传后系统会自动验证数据格式和重复性
|
||
|
||
### 2. 参数管理
|
||
|
||
#### 参数维护
|
||
1. 选择具体的发动机型号
|
||
2. 查看该型号绑定的参数列表
|
||
3. 可编辑参数值、版本信息等
|
||
4. 修改后需要提交审批
|
||
|
||
### 3. 审批流程
|
||
|
||
#### 发起审批
|
||
1. 在参数编辑完成后，点击发起审批
|
||
2. 系统会生成审批修改说明
|
||
3. 选择审批流程和审批人
|
||
4. 提交审批请求
|
||
|
||
#### 处理审批任务
|
||
1. 在待办任务中查看需要处理的审批
|
||
2. 查看审批详情和修改内容
|
||
3. 选择通过、拒绝或转交操作
|
||
4. 填写审批意见
|
||
|
||
### 4. 基准报告管理
|
||
|
||
#### 创建报告
|
||
1. 进入基准报告模块
|
||
2. 填写报告基本信息
|
||
3. 上传报告文件
|
||
4. 保存为草稿或提交审批
|
||
|
||
#### 报告审批
|
||
1. 选择需要审批的报告
|
||
2. 按照预设流程进行审批
|
||
3. 查看审批进度和历史记录
|
||
|
||
## API接口
|
||
|
||
### 数据录入相关
|
||
- `GET /custom/dataEntry/getTemplateByCondition` - 模板条件查询
|
||
- `GET /custom/dataEntry/getParameterByCondition` - 参数条件查询
|
||
- `POST /custom/dataEntryEngineModel/excelImport` - Excel导入发动机型号
|
||
|
||
### 审批流程相关
|
||
- `POST /custom/activitiProcess/initiateApproval` - 发起参数审批
|
||
- `POST /custom/activitiProcess/handleApproval` - 处理审批
|
||
- `GET /custom/activitiProcess/getApprovalProcess` - 获取审批流程
|
||
|
||
### 报告管理相关
|
||
- `POST /custom/benchmark/uploadFile` - 上传文件
|
||
- `POST /custom/benchmark/insertReport` - 创建报告
|
||
- `POST /custom/benchmark/updateReport` - 更新报告
|
||
- `GET /custom/benchmark/getReportDetail` - 获取报告详情
|
||
|
||
### 任务管理相关
|
||
- `GET /custom/todoTask/getTodoTaskList` - 获取待办任务列表
|
||
- `GET /custom/todoTask/getCompletedTaskList` - 获取已办任务列表
|
||
- `GET /custom/todoTask/getInitiatedTaskList` - 获取发起任务列表
|
||
|
||
## 系统配置
|
||
|
||
### 配置文件
|
||
- [application.properties](file:///D:/JavaProjects/data-management-platform/src/main/resources/application.properties) - 主配置文件
|
||
- [application-s.properties](file:///D:/JavaProjects/data-management-platform/src/main/resources/application-s.properties) - 服务配置文件
|
||
|
||
### 多数据源配置
|
||
系统支持配置多个数据源，通过 `mpaas.datasource` 配置项进行设置。
|
||
|
||
## 常见问题
|
||
|
||
### 1. Excel导入失败
|
||
- 检查文件格式是否为.xlsx或.xls
|
||
- 确认Excel模板格式是否正确
|
||
- 验证数据是否符合字段要求
|
||
|
||
### 2. 审批流程异常
|
||
- 确认审批人配置是否正确
|
||
- 检查工作流配置是否完整
|
||
- 查看系统日志获取详细错误信息
|
||
|
||
### 3. 数据库连接问题
|
||
- 检查数据库连接参数
|
||
- 确认数据库服务是否正常运行
|
||
- 验证数据库用户权限
|
||
|
||
## 维护说明
|
||
|
||
### 日志管理
|
||
- 系统日志文件默认位于 `log/xdap-app.log`
|
||
- 支持日志级别配置和日志轮转
|
||
|
||
### 数据备份
|
||
- 定期备份数据库
|
||
- 保留重要配置文件的备份
|
||
- 建立数据恢复机制
|
||
|
||
## 版权声明
|
||
|
||
本项目为数据管理平台系统，所有权利保留。 |