HF-MES-manual/en/system_settings/system_assistant.md

# 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.