Giao diện
@digiforce-nc/plugin-workflow-response-message
Plugin đăng ký node trả message response về client trong workflow, mở rộng plugin-workflow. Khi trigger từ action button, node này cho phép gửi thông báo (success/error/info) trực tiếp về giao diện người dùng.
Plugin này làm gì?
Node Response Message gửi một message trở lại giao diện người dùng đã kích hoạt workflow. Phù hợp khi workflow được trigger từ action button và cần thông báo kết quả cho user biết. Message hiển thị dưới dạng toast notification hoặc dialog.
Node này chỉ có ý nghĩa khi workflow được kích hoạt bởi Action Trigger hoặc Custom Action Trigger (trigger đồng bộ). Với các trigger bất đồng bộ (Webhook async, Schedule), message không có nơi hiển thị.
Cấu hình
| Tham số | Kiểu | Mô tả |
|---|---|---|
type | string | Loại message: success, error, warning, info |
message | string | Nội dung thông báo (hỗ trợ template biến workflow) |
title | string | Tiêu đề thông báo (tùy chọn) |
duration | number | Thời gian hiển thị (ms), 0 = không tự ẩn |
Input / Output
| Hướng | Dữ liệu | Mô tả |
|---|---|---|
| Input | context | Biến workflow để render template message |
| Input | type | Loại thông báo (quyết định màu sắc và icon) |
| Output | delivered | true nếu message gửi thành công về client |
Tính năng chính
| # | Tính năng | Chi tiết |
|---|---|---|
| 1 | Nhiều loại message | success (xanh), error (đỏ), warning (vàng), info (xanh dương) |
| 2 | Template message | Nội dung chứa biến từ workflow context |
| 3 | Toast / Dialog | Hiển thị dạng toast notification hoặc dialog |
| 4 | Tự động ẩn | Cấu hình thời gian hiển thị |
| 5 | Kết hợp action trigger | Hoạt động với action-trigger và custom-action-trigger |
Trường hợp sử dụng
| # | Kịch bản | Mô tả |
|---|---|---|
| 1 | Xác nhận thành công | Hiển thị "Đơn hàng #123 đã được tạo thành công" |
| 2 | Thông báo lỗi | Hiển thị "Không đủ tồn kho cho sản phẩm X" |
| 3 | Cảnh báo | Hiển thị "Đơn hàng vượt hạn mức, cần phê duyệt thêm" |
| 4 | Thông tin | Hiển thị "Email xác nhận đã được gửi đến khách hàng" |
Các loại message
| Type | Màu sắc | Icon | Khi nào dùng |
|---|---|---|---|
success | Xanh lá | Checkmark | Thao tác thành công |
error | Đỏ | X | Thao tác thất bại |
warning | Vàng cam | Cảnh báo | Thành công nhưng có lưu ý |
info | Xanh dương | Info | Thông tin bổ sung |
Lưu ý quan trọng
- Chỉ hoạt động với trigger đồng bộ (Action Trigger, Custom Action Trigger)
- Workflow phải kết thúc trong thời gian timeout của HTTP request (thường 30 giây)
- Nếu workflow có Delay node trước Response Message, message sẽ không gửi được
- Một workflow có thể có nhiều Response Message node (ví dụ: trong các nhánh condition khác nhau)
- Message quá dài sẽ bị cắt ở giao diện - giữ ngắn gọn, dưới 200 ký tự
Dependencies
| Package | Vai trò |
|---|---|
@digiforce-nc/plugin-workflow | Workflow engine (peer) |
@digiforce-nc/plugin-workflow-action-trigger | Action trigger (peer) |
@digiforce-nc/server | Server framework (peer) |
@digiforce-nc/client | Client - render message UI (peer) |