Files
yunrui_asset/docs/USER_GUIDE.md
T

938 lines
23 KiB
Markdown
Raw Normal View History

2026-06-23 10:40:10 +08:00
# 云睿资产系统 - 用户使用指南
## 目录
- [系统概述](#系统概述)
- [快速入门](#快速入门)
- [功能模块详解](#功能模块详解)
- [仪表盘](#仪表盘)
- [机房管理](#机房管理)
- [资产管理](#资产管理)
- [耗材管理](#耗材管理)
- [工单管理](#工单管理)
- [资产盘点](#资产盘点)
- [空闲设备管理](#空闲设备管理)
- [操作日志](#操作日志)
- [备份管理](#备份管理)
- [系统管理](#系统管理)
- [常见问题](#常见问题)
- [快捷操作参考](#快捷操作参考)
---
## 系统概述
### 系统简介
2026-06-23 10:40:10 +08:00
云睿资产系统是一款现代化的数据中心(IDC)设备管理平台,提供机房、机柜、设备的全生命周期管理,具备3D可视化展示功能。系统采用前后端分离架构,前端基于React + Ant Design构建,后端使用Node.js + Express开发。
### 核心功能
| 功能模块 | 主要功能 |
|---------|---------|
| **仪表盘** | 数据中心运行状态实时监控,关键指标可视化展示 |
| **机房管理** | 机房信息管理、机柜管理、3D可视化展示、机房平面图 |
| **资产管理** | 设备管理、端口管理、线缆管理、网络拓扑、字段配置 |
| **耗材管理** | 耗材库存管理、分类管理、操作日志、统计报表、批量导入 |
| **工单管理** | 故障报修、维护工单、工单分类、统计报表、工单评价 |
| **资产盘点** | 盘点计划、盘点任务、暂存设备管理 |
| **空闲设备** | 空闲设备管理、设备转入/激活 |
| **操作日志** | 操作日志审计、模块/类型筛选、操作统计 |
| **备份管理** | 数据库备份恢复、自动备份、远端备份 |
| **系统管理** | 用户管理、角色权限、系统设置 |
### 系统特点
- **全生命周期管理**:设备从采购、安装、运行、维护到报废的全流程跟踪
- **3D可视化**:三维机柜展示,直观呈现设备布局
- **灵活扩展**:支持自定义设备字段和工单字段
- **批量操作**:支持Excel/CSV批量导入导出设备
- **权限控制**:基于角色的访问控制(RBAC)
---
## 快速入门
### 首次登录
系统采用**首次注册自动成为管理员**的机制:
1. 打开浏览器,访问系统地址(如:`http://localhost:3000`
2. 在登录页面点击「注册账号」链接
3. 填写注册信息:
- 用户名(必填,用于登录)
- 密码(必填,建议8位以上)
- 邮箱(选填)
4. 点击「注册」按钮完成注册
5. 系统自动登录,第一个注册的用户自动获得管理员权限
> ⚠️ **安全提示**:首次登录后请立即修改密码,确保账号安全。
### 界面导航
系统采用左侧菜单导航结构:
```
├── 仪表盘 # 数据概览
├── 机房管理
│ ├── 机房管理 # 机房信息管理
│ ├── 机房平面图 # 机房平面图可视化
│ ├── 机柜管理 # 机柜信息管理
│ └── 3D机柜可视化 # 三维展示
├── 资产管理
│ ├── 设备管理 # 设备CRUD操作
│ ├── 空闲设备 # 空闲设备管理
│ ├── 字段管理 # 自定义字段配置
│ ├── 接线管理 # 线缆连接管理
│ ├── 网络拓扑 # 拓扑可视化
│ └── 端口管理 # 设备端口配置
├── 耗材管理
│ ├── 耗材统计 # 库存统计报表
│ ├── 耗材列表 # 耗材库存管理
│ ├── 分类管理 # 耗材分类配置
│ └── 操作日志 # 领用记录追踪
├── 工单管理
│ ├── 工单列表 # 工单处理
│ ├── 故障分类 # 故障类型配置
│ ├── 统计报表 # 工单统计分析
│ └── 字段管理 # 自定义字段
├── 资产盘点
│ ├── 盘点计划 # 盘点任务管理
│ └── 暂存设备 # 待确认设备
├── 备份管理
│ ├── 备份管理 # 数据库备份恢复
│ ├── 自动备份 # 定时备份配置
│ └── 远端备份 # 远程备份配置
├── 操作日志 # 操作审计日志
└── 系统管理
├── 用户管理 # 用户账号管理
└── 系统设置 # 系统参数配置
```
### 基本操作流程
```
1. 创建机房 → 2. 添加机柜 → 3. 录入设备 → 4. 配置端口/线缆 → 5. 日常维护
```
---
## 功能模块详解
### 仪表盘
仪表盘是系统的首页,提供数据中心整体运行状态的可视化展示。
#### 功能说明
| 区域 | 内容 |
|------|------|
| **统计卡片** | 机房数量、机柜数量、设备总数、运行中设备、维护中设备、已报废设备 |
| **设备状态分布** | 各状态设备占比图表 |
| **机柜容量概览** | 各机房机柜使用率 |
| **待处理工单** | 未完成工单列表 |
| **库存预警** | 低库存耗材提醒 |
#### 操作说明
- **刷新数据**:点击右上角「刷新」按钮获取最新数据
- **快速跳转**:点击统计卡片可跳转到对应管理页面
---
### 机房管理
#### 机房管理
机房管理用于维护数据中心的基础信息。
##### 新增机房
1. 进入「机房管理」页面
2. 点击「新增机房」按钮
3. 填写机房信息:
- **机房名称**(必填):如「北京一号机房」
- **机房位置**:详细地址
- **机房面积**:单位平方米
- **负责人**:机房管理员
- **联系电话**:紧急联系方式
- **备注**:其他说明
- **机房图片**:上传机房照片
4. 点击「确定」保存
##### 编辑机房
1. 在机房列表中找到目标机房
2. 点击操作列的「编辑」按钮
3. 修改需要更新的信息
4. 点击「确定」保存
##### 删除机房
> ⚠️ **注意**:删除机房前需确保该机房下没有机柜和设备。
1. 点击操作列的「删除」按钮
2. 确认删除操作
#### 机柜管理
机柜管理用于维护机柜信息和查看容量状态。
##### 新增机柜
1. 进入「机柜管理」页面
2. 点击「新增机柜」按钮
3. 填写机柜信息:
- **机柜名称**(必填):如「A01」
- **所属机房**(必填):选择已有机房
- **机柜高度**U数(如42U
- **机柜位置**:在机房中的位置
- **备注**:其他说明
4. 点击「确定」保存
##### 容量查看
机柜列表显示:
- **总U数**:机柜总容量
- **已用U数**:已安装设备占用
- **剩余U数**:可用空间
- **使用率**:可视化进度条
#### 3D机柜可视化
3D可视化提供直观的机柜设备布局展示。
##### 操作方式
| 操作 | 方法 |
|------|------|
| **旋转视角** | 鼠标左键拖拽 |
| **缩放视图** | 鼠标滚轮 |
| **平移视图** | 鼠标右键拖拽 |
| **查看设备** | 鼠标悬停显示设备信息 |
| **设备详情** | 点击设备弹出详情面板 |
##### 功能说明
- **机柜选择**:左侧列表选择要查看的机柜
- **设备状态**:不同颜色表示不同状态
- 🟢 绿色:运行中
- 🟡 黄色:维护中
- 🔴 红色:故障
- ⚪ 灰色:已停用
---
### 资产管理
#### 设备管理
设备管理是系统的核心功能,提供设备全生命周期管理。
##### 设备状态流转
```
采购中 → 待安装 → 运行中 ⇄ 维护中 → 已报废
```
| 状态 | 说明 |
|------|------|
| **采购中** | 设备已采购,尚未到货 |
| **待安装** | 设备到货,等待安装 |
| **运行中** | 设备正常运行 |
| **维护中** | 设备正在维护 |
| **已报废** | 设备已报废处理 |
##### 新增设备
1. 进入「设备管理」页面
2. 点击「新增设备」按钮
3. 填写设备信息:
- **基本信息**
- 设备名称(必填)
- 设备类型:服务器/网络设备/存储设备/其他
- 设备型号
- 序列号
- 品牌
- **位置信息**
- 所属机房
- 所属机柜
- 起始U位
- 占用U数
- **状态信息**
- 设备状态
- 购买日期
- 过保日期
- **自定义字段**:根据系统配置显示
4. 点击「确定」保存
##### 批量导入设备
1. 点击「导入」按钮
2. 下载导入模板(Excel/CSV格式)
3. 按模板格式填写设备信息
4. 选择填写好的文件上传
5. 系统自动解析并导入
> 💡 **提示**:导入前请确保机房和机柜信息已创建。
##### 设备导出
1. 选择需要导出的设备(可多选)
2. 点击「导出」按钮
3. 选择导出格式(Excel/CSV
4. 文件自动下载
##### 设备详情
点击设备名称或「详情」按钮,可查看:
- 设备完整信息
- 关联端口
- 网卡信息
- 操作历史
#### 端口管理
端口管理用于配置设备的网络端口信息。
##### 端口类型
| 类型 | 说明 |
|------|------|
| **网口** | 以太网接口(RJ45 |
| **光口** | 光纤接口(SFP/SFP+ |
| **管理口** | 带外管理接口 |
| **其他** | 其他类型接口 |
##### 配置端口
1. 进入「端口管理」页面
2. 选择设备
3. 点击「添加端口」
4. 填写端口信息:
- 端口名称(如 eth0、ens192
- 端口类型
- 端口速率(如 1Gbps、10Gbps
- IP地址
- MAC地址
- 关联网卡
- 状态
#### 接线管理
接线管理用于记录机柜间的线缆连接关系。
##### 新增线缆
1. 进入「接线管理」页面
2. 点击「新增线缆」
3. 填写线缆信息:
- **线缆名称**:如「A01-B01-光纤-01」
- **线缆类型**:光纤/网线/电源线
- **起始端**
- 源机房/机柜
- 源设备
- 源端口
- **终止端**
- 目标机房/机柜
- 目标设备
- 目标端口
- **线缆长度**:单位米
- **备注**
##### 线缆追踪
通过线缆列表可以:
- 查看线缆连接路径
- 追踪设备间连接关系
- 导出线缆清单
#### 字段管理
字段管理用于自定义设备属性,满足不同业务需求。
##### 字段类型
| 类型 | 说明 | 示例 |
|------|------|------|
| **文本** | 单行文本输入 | 资产编号 |
| **数字** | 数值输入 | 功率(W |
| **日期** | 日期选择 | 维保到期日 |
| **下拉选择** | 固定选项 | 设备等级 |
| **多行文本** | 长文本输入 | 备注说明 |
##### 添加字段
1. 进入「字段管理」页面
2. 点击「新增字段」
3. 配置字段属性:
- 字段名称
- 字段标识(英文,用于系统识别)
- 字段类型
- 是否必填
- 默认值
- 排序权重
4. 保存后,设备表单将自动显示该字段
---
### 耗材管理
#### 耗材统计
耗材统计页面提供库存数据的可视化分析。
##### 统计内容
- **库存总览**:总数量、总种类、预警数量
- **分类统计**:各分类耗材数量分布
- **库存预警**:低于安全库存的耗材列表
- **领用趋势**:近期耗材领用统计
#### 耗材列表
耗材列表用于管理耗材库存信息。
##### 新增耗材
1. 进入「耗材列表」页面
2. 点击「新增耗材」
3. 填写耗材信息:
- **耗材名称**(必填)
- **耗材分类**
- **规格型号**
- **计量单位**:个/条/盒等
- **当前库存**
- **安全库存**:低于此值触发预警
- **最大库存**
- **存放位置**
- **备注**
4. 保存
##### 库存操作
| 操作 | 说明 |
|------|------|
| **入库** | 增加库存数量 |
| **出库/领用** | 减少库存数量,记录领用人 |
| **盘点** | 更新实际库存数量 |
##### 入库操作
1. 点击耗材的「入库」按钮
2. 填写入库信息:
- 入库数量
- 入库类型(采购入库/归还入库)
- 备注
3. 确认入库
##### 出库操作
1. 点击耗材的「出库」按钮
2. 填写出库信息:
- 出库数量
- 领用人
- 用途
- 备注
3. 确认出库
#### 分类管理
分类管理用于维护耗材的分类体系。
##### 新增分类
1. 进入「分类管理」页面
2. 点击「新增分类」
3. 填写分类名称和描述
4. 保存
##### 分类示例
```
├── 网络耗材
│ ├── 网线
│ ├── 光纤
│ └── 跳线
├── 存储耗材
│ ├── 硬盘
│ └── 磁带
└── 通用耗材
├── 扎带
└── 标签
```
#### 操作日志
操作日志记录所有耗材的出入库操作历史。
##### 日志内容
- 操作时间
- 操作类型(入库/出库/盘点)
- 耗材名称
- 操作数量
- 操作人
- 领用人(出库时)
- 备注
##### 日志查询
- 按时间范围筛选
- 按耗材名称搜索
- 按操作类型筛选
---
### 工单管理
#### 工单列表
工单列表用于处理故障报修和维护工单。
##### 工单状态
```
待处理 → 处理中 → 已完成 → 已关闭
```
| 状态 | 说明 |
|------|------|
| **待处理** | 新建工单,等待分配 |
| **处理中** | 正在处理 |
| **已完成** | 问题已解决 |
| **已关闭** | 工单关闭 |
##### 工单优先级
| 优先级 | 说明 | 响应时间 |
|--------|------|----------|
| **紧急** | 严重影响业务 | 立即响应 |
| **高** | 重要问题 | 2小时内 |
| **中** | 一般问题 | 24小时内 |
| **低** | 优化建议 | 一周内 |
##### 创建工单
1. 进入「工单列表」页面
2. 点击「新建工单」
3. 填写工单信息:
- **工单标题**:简要描述问题
- **故障分类**:选择故障类型
- **优先级**:紧急/高/中/低
- **关联设备**:选择相关设备(可选)
- **问题描述**:详细说明问题
- **附件**:上传截图或日志
- **自定义字段**:根据系统配置填写
4. 提交工单
##### 处理工单
1. 点击工单进入详情页
2. 点击「接单」分配给自己
3. 更新工单状态为「处理中」
4. 记录处理过程:
- 点击「添加记录」
- 填写处理内容
- 更新工单状态
5. 问题解决后,点击「完成」
6. 填写解决方案
#### 故障分类
故障分类用于标准化故障类型,便于统计分析。
##### 新增分类
1. 进入「故障分类」页面
2. 点击「新增分类」
3. 填写分类名称和描述
4. 保存
##### 分类示例
```
├── 硬件故障
│ ├── 硬盘故障
│ ├── 电源故障
│ └── 风扇故障
├── 网络故障
│ ├── 网络中断
│ └── 配置错误
└── 系统故障
├── 系统崩溃
└── 服务异常
```
#### 统计报表
统计报表提供工单数据的分析视图。
##### 报表内容
- **工单数量趋势**:按时间统计工单数量
- **分类统计**:各类型工单占比
- **处理效率**:平均响应时间、解决时间
- **人员统计**:各处理人工单数量
#### 字段管理
工单字段管理用于自定义工单属性。
操作方式与设备字段管理相同,参见[字段管理](#字段管理)。
---
### 资产盘点
#### 盘点计划
盘点计划用于制定和管理资产盘点任务。
##### 创建盘点计划
1. 进入「盘点计划」页面
2. 点击「新建计划」
3. 填写计划信息:
- **计划名称**:如「2024年第一季度盘点」
- **盘点范围**
- 全部资产
- 指定机房
- 指定机柜
- **计划时间**:盘点开始和结束时间
- **负责人**:盘点负责人
- **参与人员**:选择盘点人员
- **备注**
4. 保存计划
##### 盘点任务状态
| 状态 | 说明 |
|------|------|
| **待执行** | 计划已创建,等待开始 |
| **执行中** | 盘点进行中 |
| **已完成** | 盘点结束 |
##### 执行盘点
1. 在盘点计划列表点击「执行」
2. 进入盘点执行页面
3. 逐个确认设备:
- 确认设备存在
- 核对设备信息
- 标记异常设备
4. 提交盘点结果
##### 盘点结果
- 正常设备数量
- 异常设备列表
- 盘点完成率
- 差异报告
#### 暂存设备
暂存设备用于管理盘点中发现的新设备或信息不完整的设备。
##### 功能说明
- 存放未在系统中登记的设备
- 记录设备基本信息
- 等待确认后转为正式设备
##### 操作流程
1. 盘点时发现新设备
2. 将设备添加到暂存区
3. 核实设备信息
4. 确认后转为正式设备
---
### 空闲设备管理
空闲设备管理用于管理当前未上架或暂时不使用的设备。
#### 功能说明
- 查看所有空闲设备列表
- 将运行中设备转入空闲状态
- 将空闲设备重新激活上架
#### 操作流程
1. 在设备管理页面,选择需要转入空闲的设备
2. 点击「转入空闲」按钮
3. 确认操作后,设备状态变为空闲
4. 在「空闲设备」页面查看所有空闲设备
5. 需要重新使用时,点击「激活」按钮将设备恢复
---
### 操作日志
操作日志用于审计系统中所有用户操作记录。
#### 功能说明
| 功能 | 说明 |
|------|------|
| **日志查询** | 按时间范围、操作模块、操作类型筛选 |
| **模块列表** | 查看系统所有操作模块 |
| **操作类型** | 查看所有操作类型(创建/更新/删除等) |
| **操作统计** | 按模块和类型维度统计操作次数 |
| **日志详情** | 查看单条操作的详细信息 |
#### 操作说明
1. 进入「操作日志」页面
2. 使用筛选条件缩小查询范围:
- **时间范围**:选择起止日期
- **操作模块**:选择设备/工单/耗材等模块
- **操作类型**:选择创建/更新/删除等类型
3. 点击日志条目查看详细信息
4. 可查看操作统计图表
---
### 备份管理
备份管理用于数据库的备份与恢复,保障数据安全。
#### 备份管理
##### 手动备份
1. 进入「备份管理」页面
2. 点击「创建备份」按钮
3. 系统自动创建数据库备份文件
4. 备份完成后显示在备份列表中
##### 备份恢复
1. 在备份列表中选择要恢复的备份文件
2. 点击「恢复」按钮
3. 确认恢复操作(此操作会覆盖当前数据)
4. 系统显示恢复进度,完成后自动重启服务
##### 备份文件管理
| 操作 | 说明 |
|------|------|
| **上传** | 上传外部备份文件 |
| **下载** | 下载备份文件到本地 |
| **删除** | 删除不需要的备份文件 |
| **验证** | 验证备份文件完整性 |
#### 自动备份
##### 配置自动备份
1. 进入「自动备份」设置页面
2. 开启自动备份开关
3. 配置备份计划:
- **Cron 表达式**:设置备份执行时间(如 `0 2 * * *` 表示每天凌晨2点)
- **保留数量**:设置保留的备份文件数量
4. 点击「测试 Cron」验证表达式是否正确
5. 保存配置
#### 远端备份
##### 配置远端备份
1. 进入「远端备份」设置页面
2. 点击「添加目标」
3. 选择备份协议:
- **FTP**:文件传输协议
- **SFTP**:安全文件传输协议
- **WebDAV**Web 分布式创作协议
- **SMB**:网络文件共享协议
4. 填写连接信息:
- 主机地址
- 端口号
- 用户名/密码
- 远程目录
5. 点击「测试连接」验证配置
6. 保存配置
---
### 系统管理
#### 用户管理
用户管理用于管理系统用户账号和权限。
##### 用户状态
| 状态 | 说明 |
|------|------|
| **正常** | 用户可正常登录 |
| **待审核** | 新注册用户,等待管理员审核 |
| **已禁用** | 账号被禁用,无法登录 |
##### 新增用户
1. 进入「用户管理」页面
2. 点击「新增用户」
3. 填写用户信息:
- 用户名(必填,唯一)
- 密码
- 邮箱
- 手机号
- 角色
- 状态
4. 保存
##### 用户审核
新注册用户默认为「待审核」状态:
1. 在用户列表筛选「待审核」用户
2. 点击「审核」按钮
3. 选择「通过」或「拒绝」
4. 通过后用户状态变为「正常」
##### 角色权限
系统采用RBAC权限模型:
| 角色 | 权限范围 |
|------|----------|
| **管理员** | 全部功能 |
| **运维人员** | 设备管理、工单处理 |
| **普通用户** | 查看权限 |
#### 系统设置
系统设置用于配置系统参数。
##### 可配置项
| 设置项 | 说明 |
|--------|------|
| **站点名称** | 系统显示名称 |
| **Logo** | 系统Logo图片 |
| **空闲超时** | 无操作自动退出时间 |
| **背景图片** | 登录页背景 |
##### 修改设置
1. 进入「系统设置」页面
2. 修改需要更新的配置
3. 点击「保存」
---
## 常见问题
### 登录相关
**Q: 忘记密码怎么办?**
A: 请联系管理员重置密码。管理员可在「用户管理」中为用户重置密码。
**Q: 账号被锁定怎么办?**
A: 多次密码错误会导致账号临时锁定,请等待30分钟后重试,或联系管理员解锁。
**Q: 为什么注册后无法登录?**
A: 新注册用户需要管理员审核后才能激活。请联系管理员进行审核。
### 设备管理
**Q: 如何批量修改设备信息?**
A: 目前支持批量导入更新。导出设备列表,修改后重新导入即可。
**Q: 设备删除后能恢复吗?**
A: 设备删除是软删除,数据仍保留在数据库中。如需恢复,请联系管理员。
**Q: 为什么导入失败?**
A: 请检查:
1. 文件格式是否正确(Excel/CSV)
2. 必填字段是否完整
3. 机房/机柜名称是否匹配
4. 数据格式是否符合要求
### 3D可视化
**Q: 3D页面加载很慢怎么办?**
A: 可能原因:
1. 设备数量较多,建议分机房查看
2. 浏览器性能限制,建议使用Chrome最新版
3. 网络带宽限制
**Q: 设备位置显示不正确?**
A: 请检查设备的起始U位和占用U数设置是否正确。
### 耗材管理
**Q: 库存预警如何设置?**
A: 在耗材编辑页面设置「安全库存」值,当库存低于此值时系统会自动预警。
**Q: 出库后可以撤销吗?**
A: 出库操作记录在日志中,如需撤销可执行入库操作,并在备注中说明原因。
### 工单管理
**Q: 如何分配工单?**
A: 工单创建后,处理人可以在工单详情页点击「接单」自行分配,或由管理员指定。
**Q: 工单关闭后还能重新打开吗?**
A: 已关闭的工单无法重新打开,如有新问题请新建工单。
---
## 快捷操作参考
### 键盘快捷键
| 快捷键 | 功能 |
|--------|------|
| `Ctrl + S` | 保存当前表单 |
| `Esc` | 关闭弹窗/抽屉 |
| `Enter` | 确认操作 |
### 表格操作
| 操作 | 方法 |
|------|------|
| **多选** | 勾选复选框 |
| **全选** | 勾选表头复选框 |
| **排序** | 点击列标题 |
| **筛选** | 使用列筛选器 |
| **分页** | 底部分页器 |
### 搜索技巧
- 支持模糊搜索
- 可组合多个条件筛选
- 时间范围选择器快速筛选
---
## 技术支持
如遇到问题,请通过以下方式获取帮助:
- **问题反馈**:提交 Issue 到代码仓库
- **功能建议**:提交 Issue 并标注 `feature-request`
**代码仓库:**
2026-06-23 10:40:10 +08:00
- 源码仓库: https://code.xinmi.cloud/yunruyunrui_asset
yunrui_asset
---
**文档版本**v2.0.0
**最后更新**2026年5月