Bỏ qua, đến nội dung

@digiforce-nc/plugin-workflow-custom-action-trigger

Plugin đăng ký trigger kích hoạt workflow từ custom action button, mở rộng plugin-workflow. Tương tự action-trigger nhưng dành cho các nút được tạo qua cơ chế customize:triggerWorkflows, cho phép gắn workflow vào bất kỳ action tùy chỉnh nào.

Plugin này làm gì?

Custom Action Trigger cho phép developer đăng ký các nút action riêng (không phải nút mặc định của hệ thống) và gắn chúng với workflow. Khi user nhấn nút custom, hệ thống thu thập context tùy chỉnh rồi kích hoạt workflow.

So với Action Trigger tiêu chuẩn:

  • Action Trigger: Nút hệ thống, bind 1:1 với workflow, context là record
  • Custom Action Trigger: Nút tùy chỉnh qua customize:triggerWorkflows, hỗ trợ context mở rộng, có thể bind nhiều workflow

Cấu hình

Tham sốKiểuMô tả
collectionstringCollection gắn với trigger
appendsstring[]Các relation cần eager-load kèm bản ghi
triggerActionstringTên custom action kích hoạt trigger
contextobjectDữ liệu bổ sung truyền vào workflow
bindWorkflowsstring[]Danh sách workflow key được bind

Input / Output

HướngDữ liệuMô tả
InputdataBản ghi hiện tại hoặc dữ liệu custom từ action
InputuserThông tin người dùng thực hiện action
InputparamsTham số bổ sung từ custom action
OutputresultKết quả trả về từ workflow
OutputstatusTrạng thái: resolved / rejected

Tính năng chính

#Tính năngChi tiết
1Custom actionĐăng ký nút action tùy chỉnh ngoài các nút hệ thống
2customize:triggerWorkflowsSử dụng cơ chế customize để bind workflow vào action
3Context linh hoạtTruyền dữ liệu tùy chỉnh (không chỉ record) vào workflow
4Nhiều workflowMột custom action có thể kích hoạt nhiều workflow cùng lúc
5Đồng bộ/bất đồng bộHỗ trợ cả hai chế độ thực thi

Trường hợp sử dụng

#Kịch bảnMô tả
1Bulk actionNút "Duyệt hàng loạt" trên table, trigger workflow cho nhiều bản ghi
2Action ngoài CRUDNút "Tính lại giá" không thuộc CRUD, gọi workflow xử lý logic
3Action có form inputNút mở dialog nhập lý do, truyền lý do vào workflow
4Integration buttonNút "Đồng bộ Shopee" gọi workflow tích hợp bên ngoài
5Multi-step wizardNút khởi tạo quy trình nhiều bước với context tùy chỉnh

Lưu ý quan trọng

  • Plugin này phụ thuộc vào plugin-workflow-action-trigger - cần cài cả hai
  • Custom action phải được đăng ký trước khi bind workflow
  • Khi bind nhiều workflow cho một action, các workflow chạy song song
  • Context tùy chỉnh cần được validate ở phía client trước khi gửi
  • Sử dụng triggerAction để phân biệt giữa các custom action khác nhau

Dependencies

PackageVai trò
@digiforce-nc/plugin-workflowWorkflow engine (peer)
@digiforce-nc/plugin-workflow-action-triggerAction trigger base (peer)
@digiforce-nc/serverServer framework (peer)
@digiforce-nc/clientClient framework (peer)
@digiforce-nc/databaseDatabase ORM (peer)

Mục lục chi tiết