Trường động (Custom fields)

Trường dữ liệu mở rộng, có thể tùy chỉnh trên Caresoft

Trên nền tảng CareSoft, có 3 đối tượng dữ liệu chính gồm: Phiếu ghi (tickets), Khách hàng (contacts) và Tổ chức (organizations)

Các đối tượng dữ liệu trên ngoài các trường thông tin cố định thì còn được cung cấp thêm 20 trường dữ liệu cho mỗi loại. CareSoft gọi nó là trường động, kèm với đối tượng dữ liệu đó, ví dụ: Trường động khách hàng, trường động phiếu ghi...

Các trường động có nhiều kiểu dữ liệu khác nhau, mục đích nhằm phân loại và khai thác dữ liệu sâu hơn.

Để tạo ra các trường động, admin của từng domain sẽ sử dụng giao diện CareSoft và vào từng Đối tượng thông tin để thực hiện cấu hình.

Ảnh minh họa danh sách và cấu hình trường động phiếu ghi trên giao diện CareSoft

Danh sách kiểu dữ liệu

Bảng kê dưới đây mô tả kiểu dữ liệu, ứng dụng và đối tượng áp dụng của chúng

STT	Tên kiểu	Đối tượng áp dụng	Ý nghĩa
1	TEXT	Phiếu ghiKhách hàngTổ chức	Ký tự
2	NUMERIC	Phiếu ghiKhách hàngTổ chức	Số
3	DATE	Phiếu ghiKhách hàngTổ chức	Ngày tháng Định dạng (YYYY/MM/DD)
4	SINGLE DROP-DOWN LIST	Phiếu ghiKhách hàngTổ chức	Chọn 1 giá trị
5	MULTIPLE DROP-DOWN LIST	Phiếu ghiKhách hàngTổ chức	Chọn nhiều giá trị
6	URL	Phiếu ghi	Liên kết
7	TEXTAREA	Phiếu ghi	Văn bản
8	STAGE	Phiếu ghi	Tiến trình (salefunnel)

Cấu trúc thông tin trường động

Thực hiện lấy cấu hình các trường động. Tùy theo kiểu dữ liệu của trường động, các trường thông tin trong đó cũng sẽ thay đổi theo

Đối tượng trường động điển hình

[{
            "custom_field_id": 6740,
            "custom_field_lable": "Phân loại",
            "type": "Single drop-down list",
            "values": [
                {
                    "id": 109398,
                    "lable": "Đơn mua",
                    "parent_value_id": -1
                },
                {
                    "id": 109399,
                    "lable": "Hỗ trợ khách hàng",
                    "parent_value_id": -1
                }
            ]
        },       
       {   "custom_field_id": 6103,
            "custom_field_lable": "Mã đơn hàng",
            "type": "Text"
        }]

Ý nghĩa các trường thông tin

Tên trường	Ý nghĩa	Ghi chú
custom_field_id (int)	ID của trường dữ liệu
custom_field_lable (string)	Tên trường
type (string)	Kiểu dữ liệu	(trong danh sách kiểu) Danh sách kiểu dữ liệu
values (array)	Giá trị lựa chọn. Đối với kiểu trường lựa chọn, chọn nhiều hay tiến trình. trường dữ liệu này chứa các giá trị định sẵn với ID riêng và nhãn cho từng lựa chọn.	Chỉ có với các kiểu dữ liệu: - SINGLE DROP-DOWN LIST - MULTIPLE DROP-DOWN LIST - STAGE

Chi tiết đối tượng Values của các trường dạng SINGLE DROP-DOWN LIST, MULTIPLE DROP-DOWN LIST, và STAGE

(click vào field để xem)

"": [
                {
                    "": 109398,
                    "": "Đơn mua",
                    "": -1
                },
                {
                    "id": 109399,
                    "lable": "Hỗ trợ khách hàng",
                    "parent_value_id": -1
                }
            ]

Cách thức khai thác thông tin

Để biết các đối tượng trên có những trường động nào. Lập trình viên sử dụng từng Api riêng lẻ dưới đây để thực hiện lấy về các thông tin đã cấu hình.

LƯU Ý: Trong quá trình vận hành Admin của domain có thể xóa, sửa tên, sửa kiểu dữ liệu hoặc thêm mới trường thông tin. Cần có cơ chế đồng bộ định kỳ hằng ngày để đảm bảo thông tin thông suốt

Trường động phiếu ghi

Danh sách trường động phiếu ghi

GET {{domain}}/api/v1/tickets/custom_fields

Headers

Name	Type	Description
***	String	Thông tin xác thực chung

200: OK

Kết quả điển hình

{
    "code": "ok",
    "custom_fields": [
        {
            "custom_field_id": 5164,
            "custom_field_lable": "Phân loại phiếu ghi( Không được đổi của Liên)",
            "type": "Single drop-down list",
            "values": [
                {
                    "id": 89496,
                    "lable": "Tiến trình Leads",
                    "parent_value_id": -1
                },
                {
                    "id": 89497,
                    "lable": "Tiến trình Deals",
                    "parent_value_id": -1
                },
                {
                    "id": 98211,
                    "lable": "Case Khiếu nại",
                    "parent_value_id": -1
                }
            ]
        },
        {
            "custom_field_id": 6068,
            "custom_field_lable": "Phân loại tương tác",
            "type": "Single drop-down list",
            "values": [
                {
                    "id": 106902,
                    "lable": "Spam",
                    "parent_value_id": -1
                },
                {
                    "id": 106903,
                    "lable": "Nội dung",
                    "parent_value_id": -1
                }
            ]
        },

401: Unauthorized

400: Bad Request

Trường động khách hàng

Danh sách trường động khách hàng

GET {{domain}}/api/v1/contacts/custom_fields

Headers

Name	Type	Description
****	String	Thông tin xác thực chung

200: OK Tương tự trường động phiếu ghi

Trường động tổ chức

Danh sách trường động tổ chức

GET {{domain}}/api/v1/organizations/custom_fields

Headers

Name	Type	Description
***	String	Thông tin xác thực chung

200: OK Tương tự trường động phiếu ghi

Khi lấy về thông tin trường động, cách tốt để tích hợp là làm 1 bảng dữ liệu mapping trường dữ liệu tương ứng từ CRM sang CareSoft

Ví dụ: 1 Bảng dữ liệu mapping với trường trạng thái đơn hàng từ CRM sang CareSoft tương ứng

crmField	crmValue	caresoftField	caresoftValue
orderStatus	New
orderStatus	Delivery	6740	109399
orderStatus	Payment	6740	109400

Khi tạo mới thông tin sang CareSoft, Object custom_fields sẽ được trình bày bằng cấu trúc sau

{
  "username" : "...", 
  "custom_fields" : [
    {
     "id": "{{custom_field_id: ID của trường động}}",
     "value": "{{Giá trị muốn truyền vào nếu trường động kiểu Date/Text/Number/Url/Textarea hoặc ID values của lựa chọn nếu là kiểu Single Select, State hoặc Multiple Select}}" 
     },
         .....
    ]
   }

DEMO: Ứng dụng, tạo mới phiếu ghi kèm thông tin trường động xem tại đây. Các đối tượng dữ liệu khác thực hiện tương tự