James/HF-MES-manual
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

英文版md

Browse Source
This commit is contained in:
hhl
2026-05-12 01:46:34 +08:00
parent b41d146d36
commit 1fc6406619
50 changed files with 12825 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
en/system_settings/menu_configuration.md Normal file
View File

@@ -0,0 +1,172 @@
# Menu Management
## 1. Function Overview
The Menu Management module is used to configure the system's menu structure, supporting menu configuration for both the backend management and PDA terminals. It enables menu CRUD operations, sorting, and permission association.
**Core Functions:**
- Menu Tree Structure Management: Supports creation, editing, and deletion of multi-level menus
- Menu Category Management: Distinguishes between admin (backend) and PDA module menus
- Menu Status Control: Supports enabling/disabling menu operations
- Menu Sorting: Supports drag-and-drop sorting to adjust menu display order
- Menu Permission Association: New menus are automatically associated with the super admin role
- Menu Navigation Property: Controls whether menus are displayed in the navigation bar
**Function Screenshot**:
![Menu Management Function Screenshot](/public/image_en/menu_configuration/图片：菜单管理功能截图.png)
## 2. Term Explanation
#### 2.1.1 Menu-related Terms
| Term | Definition | Description |
|------|------------|-------------|
| Top-level Menu | Menu node without parent menu | Serves as root node of menu tree |
| Sub-menu | Menu node with parent menu | Supports multi-level nesting |
| Module | System module to which menu belongs | admin (backend), pda (PDA terminal) |
| Navigation Property | Whether menu is displayed in navigation bar | Visible (1) or Hidden (0) |
| Link Type | Type of menu link | Module (0) or External Link (1) |
| Open Method | Link opening method | Current window (_self) or New window (_blank) |
## 3. Menu Management Operations
### 3.1 Menu Query
**Query Conditions:**
| Query Condition | Description |
|----------------|-------------|
| Module | Select backend (admin) or PDA module |
| Status | Filter enabled or disabled menus |
| Navigation Property | Filter visible or hidden menus |
| Menu Depth | Control expansion level of menu tree |
**Operation Steps:**
1. Go to [System Settings] → [Menu Management] → [Menu Configuration]
2. Select query conditions in the top query area
3. Click [Query] button to get menu list
4. Click [Reset] button to clear query conditions
**Function Screenshot**:
![Menu Management Query Function Screenshot](/public/image_en/menu_configuration/图片：菜单管理查询功能截图.png)
### 3.2 Add Menu
**Operation Steps:**
1. Go to [System Settings] → [Menu Management] → [Menu Configuration]
2. Click [Add Top-level Menu] button, or click [Add] button on existing menu to add sub-menu
3. Fill in menu form information
4. Click [OK] to complete addition
**Field Description:**
| Field | Description | Required |
|-------|-------------|----------|
| Parent Menu | Select parent menu; no selection means top-level menu | No |
| Name | Display name of menu | Yes |
| Alias | Alias identifier for menu; required for API-type menus | No |
| Icon | Menu icon, can be selected or customized | No |
| Sort | Sort order number; smaller value means higher priority | Yes |
| Navigation | Controls whether menu is displayed in navigation bar | Yes |
| Link Type | Module (0) or External Link (1) | Yes |
| Open Method | Current window or New window | Yes |
| URL | Menu link address | No |
| Parameters | Link parameters | No |
| Remarks | Remarks for menu | No |
**[Tip]** When adding a menu, the system automatically associates it with the super admin role.
**Function Screenshot**:
![Menu Management Add Function Screenshot](/public/image_en/menu_configuration/图片：菜单管理新增功能截图.png)
### 3.3 Edit Menu
**Operation Steps:**
1. Click the menu node to edit in the menu tree
2. Modify menu information in the right form
3. Click [Modify] button to save changes
**[Note]** Menu names cannot be duplicated within the same module.
**Function Screenshot**:
![Menu Management Edit Function Screenshot](/public/image_en/menu_configuration/图片：菜单管理编辑功能截图.png)
### 3.4 Delete Menu
**Operation Steps:**
1. Find the menu to delete in the menu tree
2. Click [Delete] button on the right side of the menu
3. Click [OK] in the confirmation dialog
**Function Screenshot**:
![Menu Management Delete Function Screenshot](/public/image_en/menu_configuration/图片：菜单管理删除功能截图.png)
**[Important]** If the menu or its child menus are being used by roles, deletion is not allowed.
### 3.5 Enable/Disable Menu
**Operation Steps:**
1. Find the menu to operate in the menu tree
2. Click [Disable] or [Enable] button on the right side of the menu
3. Click [OK] in the confirmation dialog
**[Note]** Status switching affects the menu and all its child menus.
**Function Screenshot**:
![Menu Management Delete Function Screenshot](/public/image_en/menu_configuration/图片：菜单管理删除功能截图.png)
### 3.6 Menu Sorting
**Operation Steps:**
1. Drag menu node to target position in the menu tree
2. System automatically saves sorting result
**Supported Drag Operations:**
- Drag to front or back of sibling menus
- Drag to other menus as sub-menu
**Function Screenshot**:
![Menu Management Sort Function Screenshot](/public/image_en/menu_configuration/图片：菜单管理排序功能截图.png)
## 7. Data Flow Diagram
```mermaid
flowchart TD
A[User Request] --> B{Is Super Admin?}
B -->|Yes| C[Query All Menus]
B -->|No| D[Query Role-associated Menus]
C --> E[Return Menu List]
D --> E
E --> F[Frontend Renders Tree Structure]
F --> G[User Operation]
G --> H{Operation Type}
H -->|Add| I[Validate Name Uniqueness]
H -->|Edit| J[Validate Name Uniqueness]
H -->|Delete| K[Check Role Usage]
H -->|Status Switch| L[Check Role Usage]
I --> M[Save Menu Data]
J --> M
K --> N{Is Being Used?}
L --> N
N -->|Yes| O[Show Error Message]
N -->|No| P[Execute Operation]
M --> Q[Associate Super Admin]
Q --> R[Return Result]
P --> R
O --> R
```
## 8. Notes
**[Important]** Before deleting or disabling a menu, ensure it is not used by any role; otherwise, the operation will fail.
**[Tip]** It is recommended to regularly organize the menu structure to maintain clarity and logic of the menu tree.
**[Note]** Smaller menu sort values appear first; default value is 50.

140
en/system_settings/system_assistant.md Normal file
View File

@@ -0,0 +1,140 @@
# System Assistant
## 1. Function Overview
The System Assistant module provides query functions for system operation logs and interface logs, helping administrators track system operation records and interaction logs of device docking processes.
**Core Functions:**
- Operation Log Query: Records user's system operation behavior, supports query by user, IP, time, etc.
- Interface Log Query: Records interface interaction logs with device docking, supports query by IP, interface name, etc.
**Function Screenshot**:
![System Assistant Function Screenshot](/public/image_en/system_assistant/图片：系统助手功能截图.png)
## 2. Term Explanation
#### 2.1.1 Log-related Terms
| Term | Definition | Description |
|------|------------|-------------|
| Operation Log | User's operation records in the system | Including login, CRUD operations, etc. |
| Interface Log | Interaction records between system and external devices/systems | Including device docking, data transmission, etc. |
| Tray ID | Unique identifier for device tray | Used for device docking tracking |
| Batch ID | Unique identifier for production batch | Used for production process tracking |
| Battery Barcode | Unique identifier for battery barcode | Used for production process tracking |
| Process Code | Unique identifier for process code | Used for production process tracking |
| Interface Status Code | Return status of interface call | 0 means success, 4001/4002 means failure |
## 3. Operation Log
### 3.1 Operation Log Query
**Query Conditions:**
| Query Condition | Description |
|----------------|-------------|
| User | Filter operation records by user ID |
| IP Address | Filter by operation IP address |
| Route Name | Filter by accessed route name |
| Tray ID | Filter related operations by tray ID |
| Batch ID | Filter related operations by batch ID |
| Time Range | Filter by operation time range, default is last week |
**Operation Steps:**
1. Go to [System Settings] → [System Assistant] → [Operation Log]
2. Set query conditions in the top query area
3. Click [Query] button to get operation log list
**Function Screenshot**:
![Operation Log Query Screenshot](/public/image_en/system_assistant/图片：操作日志查询截图.png)
![Operation Log Table Screenshot](/public/image_en/system_assistant/图片：操作日志表格截图.png)
### 3.2 Operation Log Field Description
| Field | Description |
|-------|-------------|
| ID | Unique identifier for log |
| Username | User who performed the operation |
| Request Path | Accessed URL path |
| Controller Method | Executed controller and method |
| IP Address | Operation source IP |
| Status | Operation status |
| Request Parameters | Incoming parameters |
| Execution Result | Returned result |
| Operation Type | Type of operation |
| Operation Name | Chinese name of operation |
| Tray ID | Associated tray ID |
| Batch ID | Associated batch ID |
| Operation Time | Operation occurrence time |
### 3.3 Log Record Content
The system automatically records the following types of operations:
- User login/logout
- Data addition, editing, deletion
- Status changes
- Permission configuration
- System settings modification
## 4. Interface Log
### 4.1 Interface Log Query
**Query Conditions:**
| Query Condition | Description |
|----------------|-------------|
| Device Unit | Filter by device unit name |
| IP Address | Filter by client IP address |
| Process Code | Filter by process code |
| Tray ID | Filter by tray ID |
| Battery ID | Filter by battery ID |
| Time Range | Filter by interaction time range, default is last week |
| Status | Filter successful or failed interface calls |
| Source Category | Filter interfaces from ERP/SPC sources |
**Operation Steps:**
1. Go to [System Settings] → [System Assistant] → [Interface Log]
2. Set query conditions in the top query area
3. Click [Query] button to get interface log list
**Function Screenshot**:
![Interface Log Query Screenshot](/public/image_en/system_assistant/图片：接口日志查询截图.png)
### 4.2 Interface Log Field Description
| Field | Description |
|-------|-------------|
| ID | Unique identifier for log |
| Device Unit | Device unit name |
| Client IP | Device IP that called the interface |
| Data1 | Usually stores process code |
| Data2 | Usually stores tray ID |
| Data3 | Usually stores battery ID |
| Creation Time | Log record time |
| Interface Time | Interface call time |
| Status | Interface call status (0 success, 4001/4002 failure) |
| Category | Interface category (erp/spc, etc.) |
| Type | Interface type |
| Request Parameters | Interface incoming parameters |
| Return Result | Interface return result |
| Data4 | Extension field 1 |
| Data5 | Extension field 2 |
### 4.3 View Interface Details
**Operation Steps:**
1. Click the view response button in the interface log list
2. View detailed information of interface call, including request parameters, return results, status code, etc.
**Function Screenshot**:
![Interface Details Screenshot](/public/image_en/system_assistant/图片：接口详情截图.png)
## 5. Notes
**[Note]** The purpose of data fields (data1-data5) in interface logs varies according to interface types. The specific meaning needs to be understood in combination with business scenarios.

106
en/system_settings/system_monitoring.md Normal file
View File

@@ -0,0 +1,106 @@
# System Monitoring
## 1. Function Overview
The System Monitoring module is used to configure and manage system monitoring parameters, enabling real-time monitoring of server resources and alarm settings.
**Core Functions:**
- Monitoring Configuration Management: Create, edit, delete monitoring configurations
- Resource Alarm Settings: Configure alarm thresholds for CPU, disk, and memory
- Monitoring Refresh Settings: Configure refresh intervals for monitoring data
- Monitoring List Query: Support filtering by name and ID
**Function Screenshot**:
![Monitoring Configuration Screenshot](/public/image_en/system_monitoring/图片：监控配置截图.png)
## 2. Term Explanation
#### 2.1.1 Monitoring-related Terms
| Term | Definition | Description |
|------|------------|-------------|
| Monitoring ID | Unique identifier for monitoring configuration | Used to distinguish different monitoring targets |
| Refresh Interval | Time interval for updating monitoring data | Usually in seconds |
| CPU Alarm Threshold | Alarm threshold for CPU usage | Triggers alarm when exceeded |
| Disk Alarm Threshold | Alarm threshold for disk usage | Triggers alarm when exceeded |
| Memory Alarm Threshold | Alarm threshold for memory usage | Triggers alarm when exceeded |
## 3. Monitoring Settings Management
### 3.1 Monitoring Configuration Query
**Query Conditions:**
| Query Condition | Description |
|----------------|-------------|
| Name | Fuzzy query by monitoring name |
| ID | Fuzzy query by monitoring ID |
**Operation Steps:**
1. Go to [System Settings] → [System Monitoring] → [Monitoring Settings]
2. Set query conditions in the top query area
3. Click [Query] button to get monitoring configuration list
**Function Screenshot**:
![Monitoring Configuration Query Screenshot](/public/image_en/system_monitoring/图片：监控配置查询截图.png)
### 3.2 Add Monitoring Configuration
**Operation Steps:**
1. Click [Add] button
2. Fill in monitoring configuration information
3. Click [OK] to complete addition
**Field Description:**
| Field | Description | Required |
|-------|-------------|----------|
| Monitoring ID | Unique identification code for monitoring | Yes |
| Monitoring Name | Chinese name for monitoring | Yes |
| IP Address | IP address of monitored server | Yes |
| Port | Monitoring service port | Yes |
| Refresh Interval | Data refresh interval (seconds) | Yes |
| CPU Alarm Threshold | CPU usage alarm threshold (%) | Yes |
| Disk Alarm Threshold | Disk usage alarm threshold (%) | Yes |
| Memory Alarm Threshold | Memory usage alarm threshold (%) | Yes |
| Version | Monitoring service version number | No |
**[Tip]** Monitoring ID and monitoring name cannot be duplicated.
**Function Screenshot**:
![Add Monitoring Configuration Screenshot](/public/image_en/system_monitoring/图片：新增监控配置截图.png)
### 3.3 Edit Monitoring Configuration
**Operation Steps:**
1. Click the configuration to edit in the monitoring list
2. Modify configuration information
3. Click [OK] to save changes
**Function Screenshot**:
![Edit Monitoring Configuration Screenshot](/public/image_en/system_monitoring/图片：编辑监控配置截图.png)
### 3.4 Delete Monitoring Configuration
**Operation Steps:**
1. Select the configuration to delete in the monitoring list
2. Click [Delete] button
3. Click [OK] in the confirmation dialog
**[Tip]** Supports batch deletion of multiple monitoring configurations.
**Function Screenshot**:
![Delete Monitoring Configuration Screenshot](/public/image_en/system_monitoring/图片：删除监控配置截图.png)
## 6. Notes
**[Tip]** It is recommended to set alarm thresholds within a reasonable range to avoid overly frequent alarm notifications.
**[Note]** Deleted monitoring configurations cannot be recovered. Please proceed with caution.
**[Important]** Ensure the configured IP address and port are accessible; otherwise, monitoring data cannot be obtained.

286
en/system_settings/user_management.md Normal file
View File

@@ -0,0 +1,286 @@
# User Management
## 1. Function Overview
The User Management module is used to manage system user accounts and role permissions, enabling user CRUD operations, role assignment, password management, and permission configuration.
**Core Functions:**
- User Account Management: Create, edit, delete user accounts
- User Status Control: Enable/disable user accounts
- Role Management: Create, edit, delete roles (user groups)
- Permission Assignment: Assign menu and API permissions to roles
- Password Management: Change password, reset password
**Function Screenshot**:
![User Management Function Screenshot](/public/image_en/user_management/图片：用户管理功能截图.png)
## 2. Term Explanation
#### 2.1.1 User Management Terms
| Term | Definition | Description |
|------|------------|-------------|
| User Group/Role | Permission group to which user belongs | Users with the same role have the same permissions |
| Pass ID | User's identification number | Used for access control and other scenarios |
| Super Admin | System's highest permission role | Default has all menu permissions |
## 3. Role Management
### 3.1 Role List Query
**Query Conditions:**
| Query Condition | Description |
|----------------|-------------|
| Status | Filter enabled or disabled roles |
**Operation Steps:**
1. Go to [System Settings] → [User Management] → [Role]
2. Select status condition in the top query area
3. Click [Query] button to get role list
**Function Screenshot**:
![Role Management Query Function Screenshot](/public/image_en/user_management/图片：角色管理查询功能截图.png)
### 3.2 Add Role
**Operation Steps:**
1. Click [Add Role] button
2. Fill in role name and description
3. Set role status
4. Click [OK] to complete addition
**Field Description:**
| Field | Description | Required |
|-------|-------------|----------|
| Name | Role name, such as "Admin", "Regular User" | Yes |
| Description | Detailed description of role | No |
| Status | Enabled or disabled | Yes |
**[Tip]** Role names cannot be duplicated.
**Function Screenshot**:
![Role Management Add Function Screenshot](/public/image_en/user_management/图片：角色管理新增功能截图.png)
### 3.3 Edit Role
**Operation Steps:**
1. Click the role to edit in the role list
2. Modify role information
3. Click [OK] to save changes
**Function Screenshot**:
![Role Management Edit Function Screenshot](/public/image_en/user_management/图片：角色管理编辑功能截图.png)
### 3.4 Delete Role
**Operation Steps:**
1. Find the role to delete in the role list
2. Click [Delete] button
3. Click [OK] in the confirmation dialog
**[Important]** If there are users under the role, the role cannot be deleted.
**Function Screenshot**:
![Role Management Delete Function Screenshot](/public/image_en/user_management/图片：角色管理删除功能截图.png)
### 3.5 Permission Assignment
**Operation Steps:**
1. Click [Permission Configuration] button in the role list
2. Select menus and APIs to assign in the permission configuration page
3. Click [OK] to save permission configuration
**[Tip]** Permission configuration will overwrite all existing permissions of the role.
**Function Screenshot**:
![Role Management Permission Assignment Function Screenshot](/public/image_en/user_management/图片：角色管理权限分配功能截图.png)
## 4. User Management
### 4.1 User List Query
**Query Conditions:**
| Query Condition | Description |
|----------------|-------------|
| Account | Fuzzy query by username |
| Name | Fuzzy query by nickname |
| User Group | Filter by role |
| Status | Filter enabled or disabled users |
**Function Screenshot**:
![User Management Query Function Screenshot](/public/image_en/user_management/图片：用户管理查询功能截图.png)
### 4.2 Add User
**Operation Steps:**
1. Click [Add User] button
2. Fill in user information
3. Set user group and status
4. Click [OK] to complete addition
**Field Description:**
| Field | Description | Required |
|-------|-------------|----------|
| Account | User login account | Yes |
| Name | User nickname or real name | Yes |
| Pass ID | User's identification number | No |
| Password | User login password | Yes |
| Confirm Password | Enter password again for confirmation | Yes |
| User Group | Select role to which user belongs | Yes |
| Status | Enabled or disabled | Yes |
**[Note]** The two password entries must be identical. Deleted or disabled user groups cannot be selected.
**Function Screenshot**:
![User Management Add Function Screenshot](/public/image_en/user_management/图片：用户管理新增功能截图.png)
### 4.3 Edit User
**Operation Steps:**
1. Click the user to edit in the user list
2. Modify user information
3. Click [OK] to save changes
**[Note]** You cannot disable your own account.
**Function Screenshot**:
![User Management Edit Function Screenshot](/public/image_en/user_management/图片：用户管理编辑功能截图.png)
### 4.4 Delete User
**Operation Steps:**
1. Find the user to delete in the user list
2. Click [Delete] button
3. Click [OK] in the confirmation dialog
**[Important]** You cannot delete your own account.
**Function Screenshot**:
![User Management Delete Function Screenshot](/public/image_en/user_management/图片：用户管理删除功能截图.png)
### 4.5 Batch Operations
**Supported Batch Operations:**
- Batch Delete: Select multiple users and click [Batch Delete]
- Batch Enable/Disable: Select multiple users and click [Batch Enable] or [Batch Disable]
**Function Screenshot**:
![User Management Batch Operation Function Screenshot](/public/image_en/user_management/图片：用户管理批量操作功能截图.png)
### 4.6 Password Management
#### Change Password
**Operation Steps:**
1. Move mouse to username in the top right corner, click [Change Password] button in the dropdown
2. Enter old password and new password
3. Click [OK] to complete change
**Function Screenshot**:
![User Management Change Password Function Screenshot](/public/image_en/user_management/图片：用户管理修改密码功能截图.png)
#### Reset Password
**Operation Steps:**
1. Click [Reset Password] button in the user list
2. Click [OK] in the confirmation dialog
3. Password will be reset to default password "123456"
**Function Screenshot**:
![User Management Reset Password Function Screenshot](/public/image_en/user_management/图片：用户管理重置密码功能截图.png)
### 4.7 User Data Import/Export
#### Import User Data
**Operation Steps:**
1. Click [Download Import Template] to get the import template file
2. Fill in user data according to template format
3. Upload the filled Excel file
4. Click [Import] to complete batch import
**Import Template Fields:**
| Field | Description | Required |
|-------|-------------|----------|
| Account | User login account | Yes |
| Name | User nickname | Yes |
| Pass ID | User identification number | No |
| Password | User password | Yes |
| Status | Enabled or disabled | Yes |
| User Group | Role name to which user belongs | Yes |
**Function Screenshot**:
![User Management Import Function Screenshot](/public/image_en/user_management/图片：用户管理导入功能截图.png)
![Excel Template](/public/image_en/user_management/图片：EXCEL模板.png)
#### Export User Data
**Operation Steps:**
1. Set query conditions to filter users to export
2. Click [Export] button
3. System generates export task in background
4. Get export file in download management
**Function Screenshot**:
![User Management Export Function Screenshot](/public/image_en/user_management/图片：用户管理导出功能截图.png)
## 5. Operation Logic Flowchart
```mermaid
flowchart TD
A[User Management] --> B[Add User]
A --> C[Edit User]
A --> D[Delete User]
A --> E[Change Password]
B --> F{Validate Username Uniqueness}
F -->|Exists| G[Show Error]
F -->|Not Exists| H{Validate Password Consistency}
H -->|Inconsistent| I[Show Error]
H -->|Consistent| J{Validate Role Validity}
J -->|Invalid| K[Show Error]
J -->|Valid| L[Save User Data]
C --> M{Validate Username Uniqueness}
M -->|Duplicate| N[Show Error]
M -->|Unique| O{Disable Self?}
O -->|Yes| P[Show Error]
O -->|No| Q[Update User Data]
D --> R{Delete Self?}
R -->|Yes| S[Show Error]
R -->|No| T[Delete User and Reorder]
E --> U{Validate Password Consistency}
U -->|Inconsistent| V[Show Error]
U -->|Consistent| W{Same as Old Password?}
W -->|Same| X[Show Error]
W -->|Different| Y[Update Password]
```
## 6. Notes
**[Important]** Users cannot delete or disable their own accounts.
**[Note]** Before deleting or disabling a role, ensure there are no associated users under the role.
**[Tip]** When importing user data, if the username already exists, that row of data will be skipped.