Files
FATrace/FATrace.WPLApp/Report/UserManual.md
2026-01-13 15:03:02 +08:00

337 lines
15 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# FATrace 用户说明书WPLApp
版本v1.0 适用模块FATrace.WPLApp桌面应用
![image-20260113113929437](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113113929437.png)
## 1. 简介
FATrace 是一套用于食品添加剂生产过程追溯与运行监控的桌面应用。WPLApp 负责生产端的日常使用,包括:
- 实时运行信息查看与统计总览Dashboard
- 历史报警查询History Alarm
- 原料使用查询(支持导出 Excel
- 原料入库查询(支持导出 Excel
- Excel 报表文件自动导入(工厂/OEM 多 Sheet 导入)
- 工厂/OEM 数据查询(按 Sheet 查询展示)
- 文件导入日志(查询每次导入、归档、行数统计与异常信息)
- 用户登录与状态显示
- PLC 通信状态指示与当前终端信息(底部状态栏)
本说明书面向一线操作员、现场工程、以及系统管理员,帮助快速上手并定位常见问题。
## 2. 安装与启动
- 安装:由管理员完成程序分发与安装(通常包含可执行文件与依赖项)。
- 运行:双击启动桌面应用,进入主界面。
![image-20260113113755346](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113113755346.png)
- 字体资源:应用内置图标字体,界面会自动加载,无需额外配置。
- 数据库:数据库连接等参数由管理员预配置。
如启动失败、页面空白或频繁报错,请联系系统管理员检查运行环境与数据库连接配置。
## 3. 登录与账号
- 打开左侧菜单“用户登录”进入登录页。
![image-20260113114128809](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113114128809.png)
- 输入“用户名”和“密码”,点击“登录”或直接按回车键。
- 登录成功后自动导航到 Dashboard底部状态栏将显示“当前用户已登录”。
注意:请妥善保管账号信息。若忘记密码,请联系管理员重置。
## 4. 主界面与导航
应用主界面由顶部、内容区域、底部状态栏组成。常用页面:
- Dashboard统计与实时信息
- 数据管理
- 原料使用查询
- 原料入库查询
- 文件导入日志
- 历史报警
- 系统
- 日志信息
- 用户登录
- 使用手册
- 工厂/OEM 数据查询
- 工厂:工厂-入库、工厂-领料、工厂-出入库、工厂-原料生产信息、工厂-成品出库
- OEMOEM-入库、OEM-出库、OEM-出入库、OEM-原料使用信息
通过左侧菜单切换页面。页面内容区支持自动刷新与数据联动,无需手动刷新按钮。
说明:当前版本左侧菜单中的“使用手册”入口暂未在程序内直接打开。请在安装目录中查看本文件:`Report/UserManual.md`
## 5. Dashboard统计与实时信息
![image-20260113114224114](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113114224114.png)
Dashboard 提供生产运行的概览信息,包括:
- 统计卡片按“日、月、年、累计”汇总原料使用重量RawProUse
- 实时运行信息:系统拦截并呈现关键运行日志与事件(如扫码、喷码、过程提示等)。
- PLC 连接状态:以指示灯颜色直观显示当前 PLC 通信状态。
- 预留区域:用于后续扩展显示(如更多曲线、指标或提示)。
刷新机制:当产生关键业务事件(例如扫码处理)时,系统自动发布事件触发 Dashboard 刷新,无需手动点击。
使用建议:
- 关注统计卡片的趋势变化,快速判断当日与周期产量情况。
- 实时信息区域用于排查当班异常,如出现错误或报警文字,可结合“历史报警”页进一步定位。
## 6. 历史报警History Alarm
![image-20260113114242263](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113114242263.png)
用于查询系统运行过程中记录的历史报警。功能特性:
- 支持按关键字、类别、时间范围进行过滤查询。
- 结果列表分页显示,便于快速定位。
- 报警内容来自系统在关键点输出的报警信息,出现后会自动写入数据库。
使用步骤:
1. 打开“历史报警”页。
2. 选择查询条件(时间范围、类别、关键字等)。
3. 点击查询,查看结果列表。
排查建议:
- 若报警持续出现,先检查 PLC 连接与设备状态,再根据报警文本采取现场处理措施。
- 如怀疑数据库未记录,关注是否出现数据库连接问题或权限异常。
## 7. 底部状态栏FootView
![image-20260113114257158](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113114257158.png)
底部状态栏持续显示系统运行关键信息:
- PLC 通信指示灯:绿色表示连接正常;红色表示断开或异常。
- PLC 终端信息:显示配置的 IP:Port便于对照设备。
- 当前用户与登录状态:显示当前登录用户及是否已登录。
当 PLC 状态改变时,这里会同步更新,便于第一时间发现通信问题。
## 8. 原料使用查询
![image-20260113114313626](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113114313626.png)
入口:左侧菜单 → 数据管理 → 原料使用查询。
功能说明:
- 支持按时间范围(称重时间 `WeightTime`)、原料编号/名称、批号、内袋二维码、外箱二维码、操作者、确认者进行查询。
- 支持分页浏览。
- 支持导出当前查询结果为 Excel.xlsx
操作步骤:
1. 打开“原料使用查询”页面。
2. 设置查询条件(可只填部分条件)。
3. 点击“查询”,在下方列表查看数据。
4. 如需导出点击“导出Excel”选择保存路径。
说明:
- 时间范围中“结束”若只选择日期(无时分秒),系统会自动按当天 23:59:59.999... 作为结束时间,避免漏数据。
## 9. 原料入库查询
![image-20260113114329697](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113114329697.png)
入口:左侧菜单 → 数据管理 → 原料入库查询。
功能说明:
- 支持按时间范围(创建时间 `CreateTime`)、原料编号/名称、批号进行查询。
- 支持按枚举筛选:原料来源(`RawSource`)、分拆状态(`RawSplitState`)。
- 支持分页浏览。
- 支持导出当前查询结果为 Excel.xlsx
操作步骤:
1. 打开“原料入库查询”页面。
2. 选择“原料来源/分拆状态”(可不选)。
3. 设置时间范围,点击“查询”。
4. 如需导出点击“导出Excel”选择保存路径。
## 10. Excel 报表文件自动导入(工厂/OEM
![image-20260113114357676](C:\Users\chong\AppData\Roaming\Typora\typora-user-images\image-20260113114357676.png)
本功能用于读取QR系统FTP每天生成的 Excel 文件(多 Sheet并将各 Sheet 数据分别存入数据库表,同时将文件移动到归档目录,便于对账与追溯。
### 10.1 文件放置与命名规则
- **文件类型**`.xlsx`
- **文件名**:建议按 `yyyyMMddHHmmss.xlsx`(文件名表示导出时间)
- **放置目录**:由配置项 `ExcelImportSourceDir` 指定
系统会在后台定时扫描源目录中的 `*.xlsx` 文件并执行导入(当前版本扫描周期约 1 小时,且程序启动后会立即执行一次检查)。
### 10.2 配置项说明App.config
配置文件位置:`FATrace.WPLApp/App.config`(部署后为程序同目录的配置文件)。
- `ExcelImportSourceDir`
- Excel 文件来源目录。
- 支持绝对路径与相对路径(相对路径将基于程序根目录解析)。
- `ExcelImportArchiveDir`
- Excel 文件归档目录。
- 导入完成后,程序会将源文件移动到该目录。
### 10.3 Sheet 与数据表映射
Excel 中各 Sheet 必须使用固定名称(中文 Sheet 名),系统按下列规则导入:
- 工厂-入库 → `FactoryInbound`
- 工厂-领料 → `FactoryMaterialWithdrawal`
- 工厂-出入库 → `FactoryInventoryTransaction`
- 工厂-原料生产信息 → `FactoryProductionRecord`
- 工厂-成品出库 → `FactoryOutbound`
- OEM-入库 → `OEMInbound`
- OEM-出库 → `OEMOutbound`
- OEM-出入库 → `OEMInventoryTransaction`
- OEM-原料使用信息 → `OEMRawUsageInfo`
注意:
- 导入时从每个 Sheet 的第 2 行开始读取(第 1 行为表头)。
- 如果整行为空会被跳过。
### 10.4 重复导入与归档规则
- **防重复**:当 `FileImportLog` 表中已存在相同文件名且状态为 `Success` 的记录时,该文件会被跳过,不会重复导入。
- **归档**:导入后移动到归档目录。若归档目录已存在同名文件,系统会自动在文件名后追加 `_HHmmss` 避免覆盖。
## 11. 文件导入日志
入口:左侧菜单 → 数据管理 → 文件导入日志。
用途:用于查看每次 Excel 文件导入的执行情况,便于定位导入失败原因与核对数据。
日志字段说明:
- **文件名**:导入的 Excel 文件名。
- **开始时间/结束时间**:导入流程的起止时间。
- **状态**`Success` / `Failed` / `Running`
- **源路径**:扫描到的原始文件路径。
- **归档路径**:导入后移动到归档目录的路径。
- **Sheet行数摘要**:各表导入行数统计,例如 `FactoryInbound=120;OEMInbound=35`
- **信息**:成功为 `OK`,失败时为异常信息。
查询建议:
- 导入失败优先用“关键字”搜索异常信息(例如路径、权限、格式错误)。
- 对账时可通过“文件名”定位某天的导入记录,并查看各 Sheet 导入行数是否符合预期。
## 12. 工厂/OEM 数据查询
入口:左侧菜单 → 工厂/OEM 数据查询。
说明:这些页面展示的是 Excel 导入后的数据(字符串字段为主),主要用于“展示、对账、追溯”。
### 12.1 工厂数据
- 工厂-入库
- 条件:产地、原料代码、原料名称、登录日期范围(基于 `LoginDateTime`)。
- 工厂-领料
- 条件:产地、原料代码、原料名称、登录日期范围(基于 `LoginDateTime`)。
- 工厂-出入库
- 条件:产地、原料代码、原料名称、入库时间日期范围(基于 `InTime`)。
- 工厂-原料生产信息
- 条件:原料编号、原料名称、批号、称重时间日期范围(基于 `WeightTime`)。
- 工厂-成品出库
- 条件:产地、原料代码、原料名称、批号、登录日期范围(基于 `LoginDateTime`)。
### 12.2 OEM 数据
- OEM-入库
- 条件:产地、原料代码、原料名称、批号、登录日期范围(基于 `LoginDateTime`)。
- OEM-出库
- 条件:产地、原料代码、原料名称、批号、登录日期范围(基于 `LoginDateTime`)。
- OEM-出入库
- 条件:产地、原料代码、原料名称、入库时间日期范围(基于 `InTime`)。
- OEM-原料使用信息
- 条件:内袋二维码、原料代码、原料名称、产地、原料使用时间日期范围(基于 `RawUseTime`)。
注意:以上页面的日期条件会对字符串时间字段做数据库端转换比较(例如 `TRY_CONVERT(datetime, LoginDateTime)`)。若 Excel 中日期格式不规范,可能导致该条数据无法被日期条件命中。
## 13. 常见操作流程
- 开机与登录:启动应用 → 进入“用户登录” → 登录成功 → 自动跳转至 Dashboard。
- 查询生产数据:进入“原料使用查询/原料入库查询” → 设置条件 → 查询 → 需要时导出 Excel。
- 导入外部 Excel`.xlsx` 文件放入 `ExcelImportSourceDir` 目录 → 等待系统后台导入 → 到“文件导入日志”确认状态为 `Success` → 如需对账,使用“工厂/OEM 数据查询”查看导入数据。
- 报警定位与复盘:在“历史报警”中按时间段和关键字查询,结合现场记录进行处理与复盘。
## 14. 常见问题与排查
- 无法登录:
- 确认用户名、密码输入正确;
- 若提示“用户不存在”,请联系管理员检查用户表;
- 若提示数据库错误,联系管理员检查数据库连接与网络。
- Dashboard 统计为空:
- 确认数据库中是否存在有效的原料使用数据;
- 等待系统产生新数据或触发刷新事件;
- 检查时间范围与系统时间是否正确。
- Excel 文件未导入(文件仍在源目录 / 工厂OEM页面无数据
- 检查 `ExcelImportSourceDir` 是否配置正确;
- 确认 Excel 文件扩展名为 `.xlsx`
- 检查文件是否被其他程序长期占用(建议导出后再投放目录);
- 打开“文件导入日志”,查看是否存在 `Failed` 记录以及失败原因;
- 确认 Excel 的 Sheet 名是否与系统要求一致(例如“工厂-入库”“OEM-原料使用信息”等)。
- 文件导入日志显示失败:
- 优先查看“信息”列中的异常原因;
- 常见原因包括目录权限不足、文件损坏、Sheet 缺失或名称不匹配。
- 工厂/OEM 查询页面按日期查不到数据:
- 该功能依赖将 Excel 中的时间字符串转换为数据库日期进行比较;
- 请确认 Excel 中对应时间列格式可被正常识别(建议 `yyyy-MM-dd HH:mm:ss` 或 Excel 标准日期格式)。
- PLC 指示红色:
- 检查 PLC 电源、网线、IP 配置;
- 确认与应用配置一致IP、端口
- 联系电气与系统工程师排查网络或驱动问题。
- 历史报警无记录:
- 近期是否确有报警触发;
- 检查数据库是否可写;
- 关注应用日志,必要时联系管理员。
## 15. 使用技巧
- 登录页支持“回车键”快捷登录。
- 关注底部状态栏的用户与 PLC 状态,能快速判断系统是否处于可用状态。
- 发生导入问题时优先查看“文件导入日志”,比直接看数据库更直观。
## 16. 安全与权限
- 账号仅限本人使用,请勿外借与分享。
- 退出离岗前可在“用户登录”页切换用户(如需要可联系管理员提供退出功能)。
- 如需更细粒度权限(基于岗位/等级),请与管理员沟通后续版本规划。
## 17. 版本与更新
- 本说明书适配当前应用版本的已上线功能。新增功能或 UI 调整将另行更新说明。
- 如需升级或安装补丁,请联系系统管理员统一安排。
## 18. 反馈与支持
- 使用中如遇到界面异常、统计不准、报警缺失、导入失败等问题:
- 记录问题发生时间、操作步骤、界面提示;
- 截图或拍照(含底部状态栏与异常信息);
- 提供导入的 Excel 文件名(必要时提供归档文件);
- 联系系统管理员或运维支持。
— 结束 —