Webhook: Chuyển dữ liệu tự động từ Workflow sang Request : Base.vn

Webhook: Chuyển dữ liệu tự động từ Workflow sang Request in

Sửa đổi trên: Sat, 14 Tháng 9, 2024 tại 10:01 SA

Trong trường hợp: khi tạo, hoàn thành, đánh thất bại, chuyển tiếp một nhiệm vụ muốn dữ liệu được chuyển đổi tự động và tạo một đề xuất mới sang Request.

Lưu ý: Người được quyền tạo nhiệm vụ bên Workflow cần có quyền tạo đề xuất trong nhóm đề xuất bên Request

Để thiết lập Webhook giữa hai ứng dụng Workflow và Request, bạn thao tác theo các bước sau:

Bước 1: Thiết lập các trường dữ liệu tùy chỉnh trong Request:

Thiết lập các trường dữ liệu tùy chỉnh của Workflow và Request giống nhau về:
- Loại dữ liệu (type)

- Mã key của trường dữ liệu (input key)

- Trường dữ liệu bắt buộc (required) bên Request

Ví dụ: Khi chuyển dữ liệu từ Quy trình Bàn giao hợp đồng (Workflow) sang đề xuất Nhóm Bàn giao Hợp đồng (Request), Request có 3 trường thông tin “Bàn giao hợp đồng, Ký kết hợp đồng, Hóa đơn VAT” muốn lấy dữ liệu sang thì Workflow cần thiết lập các trường dữ liệu tương ứng và trùng mã key trên hệ thống.

Thiết lập các trường dữ liệu tùy chỉnh trên Request

Thiết lập các trường dữ liệu tùy chỉnh trên Workflow

Lưu ý:

Với trường dữ liệu dạng bảng và danh sách tùy chọn, các thông tin của hai trường tuỳ chỉnh này ở Workflow và Request cần được thiết lập giống nhau từng cột, hàng, thứ tự + số lượng các lựa chọn.
Kiểm tra lại tên trường dữ liệu, biến bắt buộc và input key của các trường dữ liệu của Workflow và Request phải trùng nhau thì mới có thể chuyển được dữ liệu tự động
Tránh chỉnh sửa input key nếu đã có dữ liệu, việc chỉnh sửa sẽ ảnh hưởng đến các dữ liệu đã được tạo ra và mẫu in. (Nếu inputkey không trùng nhau thì cài đặt transformer theo Bước 4)

Cách kiểm tra input key trong Workflow và Request:

Workflow

Request

Bước 2: Copy API tạo của nhóm đề xuất trên Request

Truy cập vào https://request.base.vn/, tại tuỳ chỉnh nhóm đề xuất >> Click vào icon "..." >> Quản lý webhooks

Copy đoạn “ API tạo” trong Request

Bước 3: Dán API tạo vào Quản lý Webhook của quy trình bên Workflow

Truy cập vào https://workflow.base.vn/, tại màn hình chính của quy trình >> Click vào icon "..." >> Quản lý webhooks của quy trình

Dán URL “API tạo” ở bước 2 vào một trong các mục bên dưới nếu muốn đề xuất được chuyển từ các trạng thái nhiệm vụ đó.

jobCreated: khi nhiệm vụ được tạo thì một đề xuất sẽ được tạo tự động.
jobDone: khi nhiệm vụ được chuyển sang giai đoạn Hoàn thành thì một đề xuất sẽ được tạo tự động.
jobFailed: khi nhiệm vụ được chuyển đến giai đoạn Thất bại thì một đề xuất sẽ được tạo tự động.
jobForwarded: mỗi khi nhiệm vụ được chuyển tiếp đến giai đoạn tiếp theo thì một đề xuất sẽ được tạo tự động.

Các thông tin của một đề xuất được tạo tự động:

Tên đề xuất: giữ nguyên theo tên nhiệm vụ.
Người đề xuất: giữ nguyên là người tạo nhiệm vụ.
Người theo dõi đề xuất giữ nguyên là người theo dõi của nhiệm vụ
File đính kèm đề xuất giữ nguyên là file đính kèm nhiệm vụ
Trường hợp tạo trường dữ liệu theo bước 1, hệ thống sẽ chuyển cả các trường dữ liệu đó.
Các thông tin khác trong đề xuất sẽ không chuyển tự động sang Request.

Nếu cần thiết lập thay đổi các thông tin này hay chuyển tự động sang các thông tin khác, bạn tham khảo bước 4.

Bước 4: Thiết lập Transformer

Có 2 cột dữ liệu trong Transformer

- Final key (bên trái): mã của biến/trường dữ liệu bên Request

Cú pháp:

- Nếu là biến hệ thống: {key}

- Nếu là trường tùy chỉnh: {custom_inputkey}

- Original key (bên phải): nội dung hoặc mã của biến/trường dữ liệu bên Workflow

Cú pháp:

- Nếu là biến hệ thống: {key}

- Nếu là trường tùy chỉnh: {custom_inputkey}

Lưu ý: Các biến transformer cần viết in thường, không viết in hoa thì dữ liệu mới được bắn tự động.

Có 3 nhóm thông tin có thể chuyển được với Transformer của Webhook:

Trường hợp 1: Nhóm liên quan đến thông tin cơ bản (name: tên đề xuất, content)

Chuyển tên nhiệm vụ của Workflow sang tên đề xuất của Request

- name: đại diện cho tên của đề xuất ở Request

- {name}: sử dụng tên của nhiệm vụ ở Workflow.

- [Chuyển từ Workflow]: phần nội dung muốn tạo tự động sau khi sinh ra một đề xuất mới trên Request. (có thể tùy chỉnh)

Tự động thêm mô tả đề xuất

- content là mô tả đề xuất ở Request

- Quản lý khách hàng: {name} sử dụng {name} là tên của nhiệm vụ trong Workflow.

Trường hợp 2: Nhóm liên quan đến những người liên quan (username, creator_username, followers)

Tự động chỉ định cụ thể người tạo đề xuất. Nếu không sử dụng transformer này thì mặc định người tạo nhiệm vụ là người tạo đề xuất.

- "creator_username" đại diện cho người tạo đề xuất ở Request

- "@minhdp" là username được chỉ định sẽ tạo đề xuất tự động.

Tự động thêm người theo dõi cho đề xuất

- followers" là danh sách người theo dõi đề xuất

- "@mi” là danh sách người theo dõi được thêm vào đề xuất

Trường hợp 3: Các trường dữ liệu tùy chỉnh (Customfields)

- Trường hợp Customfields ở Workflow và Request đã giống nhau như hướng dẫn bước 1 thì không cần sử dụng Transformer.

- Với những trường tùy chỉnh ở hai bên không trùng mã mà vẫn muốn dữ liệu được chuyển sang, cần tạo thêm transformer với cú pháp:

+ Final key (bên trái): custom_inputkey ở Request

+ Original key (bên phải): {custom_inputkey} ở Workflow

Ví dụ: Muốn lấy nội dung trong trường thông tin Số lượng thiết bị (inputkey là so_luong) trong Workflow thì sẽ điền {custom_so_luong}

Trường hợp 4: Thiết lập khi nhóm đề xuất bên Request có cài đặt yêu cầu duyệt từ quản lý trực tiếp

- direct_managers: đại diện cho các quản lý trực tiếp

- @mi: quản lý trực tiếp

Trường hợp muốn lựa chọn từ danh sách quản lý trực tiếp thì cần tạo thêm trường tùy chỉnh dạng lựa chọn hoặc dạng text Quản lý trực tiếp ở Workflow để chọn/nhập @username của quản lý trực tiếp.