Thuật ngữ
Các từ dùng trong tài liệu và giao diện của DX-OS. Mỗi từ được giải thích trong một hoặc hai dòng, kèm tài liệu để đọc kỹ hơn.
1. Sản phẩm và kiến trúc
| Thuật ngữ | Nghĩa | Xem thêm |
|---|---|---|
| DX-OS | Lõi dynamic nguồn mở cho hệ thống hồ sơ có quy trình: khai báo nghiệp vụ trong một tệp mô hình, lõi dựng phần còn lại | README.md |
| Lõi, Tầng 1 | Phần chạy ngầm, không có giao diện, chỉ có API: định danh, cổng API, dữ liệu, quy trình, lịch sử, sự kiện | Kiến trúc |
| Ứng dụng, Tầng 2 | Giao diện web, bảng điều khiển, portal, màn hình giám sát và lệnh dxos, dựng từ dữ liệu của lõi và gọi lõi qua cổng API | Kiến trúc |
| Mô hình, Tầng 3 | Các tệp mô tả nghiệp vụ; thêm một nghiệp vụ mới là thêm một tệp, không viết mã | Viết tệp mô hình |
| H-P-D-I | Bốn không gian của đề thi: H môi trường số chung, P rào chắn và luồng tự động, D một nguồn sự thật, I trí tuệ nhân tạo | README.md |
| Headless | Không có giao diện: lõi chỉ phục vụ API cho ứng dụng tầng trên | Kiến trúc |
| Cổng API, APISIX | Cổng duy nhất mở ra ngoài: kiểm token ở biên, giới hạn tốc độ, định tuyến đến web, API, Keycloak và giám sát | Kiến trúc |
dx-engine | Dịch vụ lõi chạy được: phần điều khiển, API chung và Flowable nhúng | Kiến trúc |
dx-model | Module đọc và kiểm tra tệp mô hình, báo lỗi theo dòng và cột; không phụ thuộc Spring | Kiến trúc |
dx-core | Thư viện dùng chung của backend: bảo mật, audit, lưu trữ, quét tệp, client Keycloak | Kiến trúc |
dx-monitor | Dịch vụ giám sát chạy riêng, không phụ thuộc các module còn lại | Giám sát và nhật ký |
| Bảng điều khiển | Trang /console của người triển khai (ADMIN): thư viện mẫu, soạn mô hình, xem kế hoạch, áp dụng, người dùng, ứng dụng ngoài, danh mục dữ liệu | TESTING.md |
| Portal | Trang /portal/ liệt kê các địa chỉ và trạng thái dịch vụ | README.md |
| Chế độ chỉ lõi | dxos start --core chỉ chạy Tầng 1, không có ứng dụng web, portal và giám sát | Cài đặt và vận hành |
| Điểm mở rộng | Chỗ để người dùng viết thêm dịch vụ, bên nhận webhook, giao diện riêng hay route riêng ở ngoài lõi | Điểm mở rộng |
2. Tệp mô hình
| Thuật ngữ | Nghĩa | Xem thêm |
|---|---|---|
| Tệp mô hình | Một tệp YAML khai báo thực thể, trường, vai, quyền và quy trình của một nghiệp vụ | Viết tệp mô hình |
Định dạng (format) | Số phiên bản của cú pháp tệp mô hình; lõi tự nâng tệp cũ trong bộ nhớ, và dxos model upgrade ghi ra tệp mới | Viết tệp mô hình |
| Thực thể | Một loại bản ghi của nghiệp vụ, như hồ sơ hay thiết bị; mỗi thực thể thành một bảng dữ liệu | Viết tệp mô hình |
| Trường | Một cột của thực thể, có kiểu (text, number, date, choice, reference, file...) và các ràng buộc | Viết tệp mô hình |
| Vai | Nhóm quyền của một người dùng trong một mô hình; vai của mô hình nằm ở client dxos-m-<mô hình> trong Keycloak | Kiến trúc |
ADMIN | Vai của nền tảng, không thuộc mô hình nào: dùng bảng điều khiển và quản trị người dùng | Cài đặt và vận hành |
| Đơn vị | Cơ cấu tổ chức, là một nhóm Keycloak dùng chung cho mọi mô hình; chỉ quyết định phạm vi dòng, không quyết định quyền làm gì | Viết tệp mô hình |
| Quyền theo dòng | Mức một vai được chạm tới bản ghi: all mọi dòng, read mọi dòng chỉ đọc, own dòng mình tạo, unit dòng của đơn vị mình, assigned dòng giao cho mình | Viết tệp mô hình |
| Mẫu có sẵn | Mô hình mẫu chọn được ngay ở bảng điều khiển, nằm ở backend/dx-engine/src/main/resources/templates/ | Viết tệp mô hình |
| Mã hồ sơ | Trường type: code cho mỗi hồ sơ một mã ngắn không trùng, như HS-2026-00007, để đọc, in và tra | Viết tệp mô hình |
required_when | Khóa làm một trường chỉ bắt buộc khi một trường khác có giá trị nhất định | Viết tệp mô hình |
Khối ui | Phần của tệp mô hình chọn biểu tượng, nhóm menu, cột, nhóm biểu mẫu và lời gợi ý | Viết tệp mô hình |
| Tài liệu in | Khóa documents khai báo mẫu giấy xác nhận, phiếu hay biên bản; mỗi hồ sơ thành một tệp PDF | Viết tệp mô hình |
3. Quy trình
| Thuật ngữ | Nghĩa | Xem thêm |
|---|---|---|
| Họ mẫu | Khung quy trình viết sẵn: approval (chuỗi duyệt), work_item (công việc cần xử lý), reservation (chiếm dụng tài nguyên theo khung giờ) | Viết tệp mô hình |
| Trạng thái | Chỗ một hồ sơ đang đứng trong quy trình; chỉ quy trình đổi được cột trạng thái | Viết tệp mô hình |
| Hành động | Một bước chuyển trạng thái do một vai thực hiện, có thể cần lý do, trường bắt buộc hoặc điều kiện when | Viết tệp mô hình |
| Trạng thái cuối | Trạng thái đóng hồ sơ: sau đó hồ sơ bị đóng băng và ghi ai quyết định, lúc nào | Viết tệp mô hình |
| Hộp việc | Danh sách việc đang chờ của một người; tự làm mới khi hồ sơ đổi | TESTING.md |
| Hạn xử lý | Thời gian một hồ sơ được xử lý (deadline); quá hạn thì ghi vào lịch sử và nhắc | Viết tệp mô hình |
| Leo thang | Các mức báo tiếp cho vai khác khi hồ sơ quá hạn lâu; chỉ thông báo, không đổi trạng thái hay người giữ hồ sơ | Viết tệp mô hình |
| Hành động hoàn tất | Thao tác chạy sau khi hồ sơ đến một trạng thái cuối, như thêm người vào nhóm Keycloak; chạy sau giao dịch và thử lại nếu lỗi | Viết tệp mô hình |
check | Khóa của một hành động cho một dịch vụ riêng quyết định trước khi trạng thái đổi; bị từ chối thì trả 403 | Viết tệp mô hình |
| Rút lại | Người nộp lấy lại hồ sơ ở các trạng thái khai trong withdraw | Viết tệp mô hình |
| Quy tắc bất biến | Các quy tắc nằm trong lõi mà mô hình không tắt được: chỉ quy trình đổi trạng thái, người tạo không tự duyệt, mỗi bước để lại lịch sử | dynamic-core/README.md |
| Flowable | Động cơ quy trình nhúng trong dx-engine; BPMN do lõi sinh từ tệp mô hình | Kiến trúc |
4. Đổi mô hình khi hệ thống đang chạy
| Thuật ngữ | Nghĩa | Xem thêm |
|---|---|---|
Kế hoạch (plan) | Kết quả xem trước một lần đổi: những gì sẽ đổi, mức rủi ro và dòng đang vi phạm; chưa đổi gì | Kiến trúc |
Áp dụng (apply) | Đưa hệ thống về đúng tệp mô hình, từng bước một và ghi lại từng bước | Kiến trúc |
SAFE, MIGRATION, LOSS | Ba mức rủi ro của kế hoạch: áp dụng được ngay; cần chuyển dữ liệu (dòng vi phạm thì dừng); mất dữ liệu nên cần xác nhận riêng | Kiến trúc |
| Áp dụng dở | Một bước lỗi làm lần áp dụng dừng; mô hình bị giữ cho tới khi quản trị viên chọn tiếp tục (resume) hoặc hủy bỏ (abandon) | Kiến trúc |
Sửa chữa (repair) | Áp dụng lại tệp không đổi để dựng lại thứ bị mất ở bảng hay Keycloak, không tăng phiên bản | Kiến trúc |
Quay lui (rollback) | Áp lại nội dung phiên bản trước, ghi thành một phiên bản mới | Kiến trúc |
renamed_from | Khai báo tên cũ của một trường để đổi tên mà giữ nguyên dữ liệu | Viết tệp mô hình |
pgschema | Công cụ nguồn mở so bảng với tệp mô hình và đổi bảng cho khớp; lõi lo đổi tên và chặn mất dữ liệu | Kiến trúc |
| GitOps | dxos gitops kéo hạ tầng và tệp mô hình từ git theo chu kỳ, rồi báo lệch, chờ duyệt hoặc tự áp dụng | Cài đặt và vận hành |
dxos lint | Kiểm tệp mô hình bằng đúng bộ đọc của backend, không cần hệ thống đang chạy | Viết tệp mô hình |
5. Dữ liệu và sự kiện
| Thuật ngữ | Nghĩa | Xem thêm |
|---|---|---|
| Lịch sử chống sửa | Các dòng lịch sử của hồ sơ nối thành một chuỗi hash; sửa, xóa hay chèn một dòng thì dxos history verify chỉ ra dòng đầu tiên bị đổi | Tích hợp với hệ thống ngoài |
| Điểm neo | Mỗi giờ lõi ghi mốc của chuỗi hash vào kho đối tượng, ngoài PostgreSQL, để so lại khi kiểm | Kiến trúc |
| Outbox | Bảng trong PostgreSQL giữ các sự kiện chờ gửi, để gửi lại khi bên nhận lỗi | Tích hợp với hệ thống ngoài |
| Webhook | Thông báo mỗi thay đổi của hồ sơ tới một địa chỉ web hoặc kênh chat, có chữ ký để bên nhận kiểm tra | Điểm mở rộng |
Idempotency-Key | Header cho yêu cầu tạo hồ sơ hay hành động: gửi lại cùng khóa và cùng nội dung chỉ làm một lần | Điểm mở rộng |
| Hồ dữ liệu | Kho Parquet trong SeaweedFS chứa hồ sơ đã đóng và lịch sử của chúng, kèm manifest và hash; đọc bằng DuckDB | Kiến trúc |
| Danh mục dữ liệu | Trang cho biết dữ liệu của mỗi mô hình nằm ở đâu, ai được xem, đi vào và đi ra đâu, và chất lượng ra sao | Kiến trúc |
| Phả hệ | Với mỗi trường: nơi giá trị đi vào, các quy tắc đọc nó và nơi nó đi ra | Kiến trúc |
report_ro | Vai PostgreSQL chỉ đọc cho công cụ báo cáo; thấy mọi dòng, không áp quyền theo dòng | Kết nối công cụ báo cáo |
| OpenAPI theo mô hình | Tài liệu API sinh ngay lúc gọi từ mô hình đang chạy, nên luôn khớp tệp mô hình | API |
6. Đăng nhập, vận hành và giấy phép
| Thuật ngữ | Nghĩa | Xem thêm |
|---|---|---|
Keycloak, realm dxos | Dịch vụ đăng nhập một lần; giữ tài khoản, mật khẩu và vai | Kiến trúc |
| Client | Một ứng dụng đăng ký với Keycloak: dxos-web cho web, dxos-cli cho lệnh, dxos-m-<mô hình> giữ vai của mô hình, dxos-app-<tên> cho ứng dụng ngoài | Kiến trúc |
| Token máy | Token một ứng dụng ngoài lấy bằng mã bí mật của nó; tài khoản dịch vụ giữ đúng một vai của một mô hình | Điểm mở rộng |
| OIDC, PKCE | Cách giao diện ở tên miền khác đăng nhập người dùng, không giữ mã bí mật trong trình duyệt | Điểm mở rộng |
Tự phục hồi (reconcile) | dxos reconcile đưa stack về đúng khai báo, tạo lại container bị xóa hay lệch; chạy mỗi phút bằng systemd timer | Cài đặt và vận hành |
| ClamAV | Dịch vụ quét mã độc tệp tải lên; tệp chưa quét được thì bị từ chối | Cài đặt và vận hành |
| SPDX, REUSE | Hai dòng SPDX-FileCopyrightText và SPDX-License-Identifier ở đầu mỗi tệp mã và REUSE.toml cho tệp không chèn được; reuse lint kiểm cả cây | CONTRIBUTING.md |
| SBOM | Danh mục thành phần (CycloneDX) của backend, web và trang docs, ở sbom/ | sbom/README.md |
| OSI | Tổ chức công nhận giấy phép nguồn mở; mọi thành phần của DX-OS dùng giấy phép được OSI công nhận | DEPENDENCIES.txt |