Chuyển tới nội dung chính

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ĩaXem thêm
DX-OSLõ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ạiREADME.md
Lõi, Tầng 1Phầ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ệnKiến trúc
Ứng dụng, Tầng 2Giao 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 APIKiến trúc
Mô hình, Tầng 3Cá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-IBố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ạoREADME.md
HeadlessKhông có giao diện: lõi chỉ phục vụ API cho ứng dụng tầng trênKiến trúc
Cổng API, APISIXCổ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átKiến trúc
dx-engineDịch vụ lõi chạy được: phần điều khiển, API chung và Flowable nhúngKiến trúc
dx-modelModule đọ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 SpringKiến trúc
dx-coreThư viện dùng chung của backend: bảo mật, audit, lưu trữ, quét tệp, client KeycloakKiến trúc
dx-monitorDịch vụ giám sát chạy riêng, không phụ thuộc các module còn lạiGiám sát và nhật ký
Bảng điều khiểnTrang /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ệuTESTING.md
PortalTrang /portal/ liệt kê các địa chỉ và trạng thái dịch vụREADME.md
Chế độ chỉ lõidxos start --core chỉ chạy Tầng 1, không có ứng dụng web, portal và giám sátCài đặt và vận hành
Điểm mở rộngChỗ để 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ĩaXem thêm
Tệp mô hìnhMộ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ớiViế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ệuViết tệp mô hình
TrườngMột cột của thực thể, có kiểu (text, number, date, choice, reference, file...) và các ràng buộcViết tệp mô hình
VaiNhó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 KeycloakKiến trúc
ADMINVai 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ùngCà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òngMứ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ìnhViết tệp mô hình
Mẫu có sẵnMô 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à traViết tệp mô hình
required_whenKhóa làm một trường chỉ bắt buộc khi một trường khác có giá trị nhất địnhViết tệp mô hình
Khối uiPhầ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 inKhó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 PDFViết tệp mô hình

3. Quy trình​

Thuật ngữNghĩaXem thêm
Họ mẫuKhung 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áiChỗ một hồ sơ đang đứng trong quy trình; chỉ quy trình đổi được cột trạng tháiViết tệp mô hình
Hành độngMộ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 whenViết tệp mô hình
Trạng thái cuốiTrạng thái đóng hồ sơ: sau đó hồ sơ bị đóng băng và ghi ai quyết định, lúc nàoViết tệp mô hình
Hộp việcDanh sách việc đang chờ của một người; tự làm mới khi hồ sơ đổiTESTING.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ắcViết tệp mô hình
Leo thangCá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ấtThao 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ỗiViết tệp mô hình
checkKhó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ả 403Viết tệp mô hình
Rút lạiNgười nộp lấy lại hồ sơ ở các trạng thái khai trong withdrawViết tệp mô hình
Quy tắc bất biếnCá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ìnhKiến trúc

4. Đổi mô hình khi hệ thống đang chạy​

Thuật ngữNghĩaXem 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ướcKiến trúc
SAFE, MIGRATION, LOSSBa 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êngKiế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ảnKiế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ớiKiến trúc
renamed_fromKhai báo tên cũ của một trường để đổi tên mà giữ nguyên dữ liệuViết tệp mô hình
pgschemaCô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ệuKiến trúc
GitOpsdxos 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ụngCài đặt và vận hành
dxos lintKiểm tệp mô hình bằng đúng bộ đọc của backend, không cần hệ thống đang chạyViết tệp mô hình

5. Dữ liệu và sự kiện​

Thuật ngữNghĩaXem thêm
Lịch sử chống sửaCá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ị đổiTích hợp với hệ thống ngoài
Điểm neoMỗ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ểmKiến trúc
OutboxBảng trong PostgreSQL giữ các sự kiện chờ gửi, để gửi lại khi bên nhận lỗiTích hợp với hệ thống ngoài
WebhookThô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-KeyHeader 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ệuKho Parquet trong SeaweedFS chứa hồ sơ đã đóng và lịch sử của chúng, kèm manifest và hash; đọc bằng DuckDBKiến trúc
Danh mục dữ liệuTrang 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 saoKiế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 raKiến trúc
report_roVai PostgreSQL chỉ đọc cho công cụ báo cáo; thấy mọi dòng, không áp quyền theo dòngKết nối công cụ báo cáo
OpenAPI theo mô hìnhTà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ìnhAPI

6. Đăng nhập, vận hành và giấy phép​

Thuật ngữNghĩaXem thêm
Keycloak, realm dxosDịch vụ đăng nhập một lần; giữ tài khoản, mật khẩu và vaiKiến trúc
ClientMộ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àiKiến trúc
Token máyToken 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, PKCECá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 timerCài đặt và vận hành
ClamAVDịch vụ quét mã độc tệp tải lên; tệp chưa quét được thì bị từ chốiCài đặt và vận hành
SPDX, REUSEHai 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âyCONTRIBUTING.md
SBOMDanh mục thành phần (CycloneDX) của backend, web và trang docs, ở sbom/sbom/README.md
OSITổ 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ậnDEPENDENCIES.txt