Nghiệp vụ | IT | |||
Người lập | Người duyệt | Người lập | Người duyệt | |
Họ và tên | Bùi Nguyệt Anh | Vũ Thị Mơ | ||
Vũ Thị Mơ | ||||
Tài khoản email/MS team | anhbn4 | movt2 | ||
movt2 | ||||
Chức danh | Business Analyst (BA) | Product Owner (P.O) | ||
Business (BA BIZ) | ||||
Ngày soạn thảo |
| |||
| ||||
Jira Link | ||||
Là admin quản lý, tôi muốn quản lý được các danh mục dùng chung của hệ thống BPM
3.1 UIUX:
3.2 Luồng:
3.3 API Spec: danh mục dùng chung
I. Danh sách danh mục dùng chung
1. Headers
2. Param
3. Response / Incoming Data Specification
Mô tả
|
3.4 Mô tả các trường dữ liệu trên màn hình:
3.4.1. Màn hình Loại danh mục (Danh sách Danh mục dùng chung)
Cách truy cập: Phân hệ Quản lý danh mục > mục Danh mục dùng chung
Đối tượng sử dụng: Admin, End-user: Có quyền truy cập, xem và thao tác
| STT | Trường thông tin/ Nút chức năng | Kiểu dữ liệu | Điều kiện | Quy định | Mô tả |
|---|---|---|---|---|---|
| 1 | Ô tìm kiếm | Văn bản (Text) | Không bắt buộc | - Cho phép người dùng nhập từ khóa liên quan đến "Tên hoặc mã danh mục dùng chung". - Hệ thống thực hiện tìm kiếm và cập nhật màn hình "Danh sách danh mục dùng chung" khi người dùng nhấn Enter hoặc biểu tượng kính lúp sau khi hoàn thành nhập từ khóa. - Hành vi hệ thống khi Thể hiện kết quả:
| Thể hiện ô tìm kiếm với gợi ý mặc định (placeholder) “Tìm theo tên hoặc mã danh mục dùng chung |
| 2 | Nút Thêm mới | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để mở ra màn hình pop-up "Thêm mới danh mục dùng chung": tham chiếu mục 3.4.2. Màn hình pop-up Thêm mới danh mục dùng | Thể hiện nút chức năng thêm mới đơn 1 bản ghi danh mục dùng chung vào màn hình danh sách danh mục dùng chung. |
| 3 | Hộp chọn (Check box) | Boolean (True/False) | Không bắt buộc | - Cho phép người dùng tích chọn một/nhiều/tất cả bản ghi danh mục dùng chung để phục vụ cho chức năng xóa nhiều bản ghi ở trạng thái Không hoạt động (Inactive/Off). - Khi nhấn hệ thống hiển thị thông báo (toast):
| Thể hiện trường lựa chọn (select) phục vụ cho chức năng xóa nhiều bản ghi trên màn hình danh sách danh mục dùng chung. |
| 4 | STT | Văn bản (Text) | Không bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện thứ tự các bản ghi trên màn hình danh sách danh mục dùng chung |
| 5 | Loại danh mục | Văn bản (Text) | Không bắt buộc | - Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). - Nguồn dữ liệu: 4639- Quản lý danh mục dùng chung - Phần Loại danh mục | Thể hiện tên danh mục dùng chung |
| 6 | Mã danh mục | Văn bản (Text) | Không bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện mã định danh duy nhất của từng bản ghi danh mục trên màn hình danh sách danh mục dùng chung. |
| 7 | Tên danh mục | Đường dẫn (Hyperlink) | Không bắt buộc | Cho phép người dùng nhấn vào bản ghi để hệ thống mở màn hình Xem chi tiết danh mục dùng chung: tham chiếu mục 3.4.3. Màn hình pop-up Xem chi tiết danh mục | Thể hiện tên danh mục dùng chung ứng với bản ghi trên màn hình danh sách danh mục dùng chung. |
| 8 | Giá trị | Công tắc (Toggle/Switch) | Không bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện giá trị thuộc của từng danh mục trên màn hình danh sách danh mục dùng chung. |
| 8 | Nút Chỉnh sửa | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để mở ra màn hình pop up "Chỉnh sửa danh mục dùng chung": tham chiếu mục 3.4.4. Màn hình pop up Chỉnh sửa danh mục dùng chung | Thể hiện nút chức năng chỉnh sửa thông tin từng bản ghi trên màn hình danh sách danh mục dùng chung. |
| 9 | Nút Xóa | Nút chức năng (Button) | Không bắt buộc | - Cho phép người dùng thao tác đối với CHỈ những bản ghi danh mục dùng chung đang ở trạng thái không sử dụng -Nếu chọn đơn bản ghi không được xóa, hệ thống sẽ hiện thông báo (Toast):
-Nếu chọn nhiều bản ghi không được xóa, hệ thống sẽ vô hiệu hóa nút xóa nhiều -Nếu chọn bản ghi được xóa, hệ thống sẽ hiển thị màn hình pop-up Xác nhận xóa | Thể hiện nút chức năng xóa đơn 1 bản ghi trên màn hình danh sách danh mục dùng chung. |
| 10 | Nút Lọc | Nút chức năng (Button) | Không bắt buộc | - Cho phép người dùng nhấn để mở màn hình pop-up bộ lọc - Màn hình pop-up bộ lọc: 3.4.5. Màn hình pop-up bộ lọc | Thể hiện nút chức năng mở màn hình pop-up bộ lọc |
3.4.2. Màn hình Thêm mới danh mục dùng chung
Cách truy cập: Phân hệ Quản lý danh mục > mục Danh mục dùng chung > Nhấn đúp vào nút Thêm mới
Đối tượng sử dụng: Admin, End-use: Có quyền truy cập, xem và thao tác
| STT | Trường thông tin/ Nút chức năng | Kiểu dữ liệu | Điều kiện | Quy định | Mô tả |
|---|---|---|---|---|---|
| 1 | Loại danh mục | Lựa chọn (select) | Bắt buộc | - Cho phép người dùng nhấn để chọn loại danh mục dùng chung ở trạng thái hoạt động - Nguồn dữ liệu: 4639- Quản lý danh mục dùng chung - Phần Loại danh mục | Thể hiện trường cho phép chọn thông tin loại danh mục ứng với từng bản ghi danh mục dùng chung |
| 2 | Mã danh mục | Văn bản (Text) | Bắt buộc | - Cho phép nhập kí tự ≤ 100 ký tự, không trùng với mã đã tồn tại trong cùng một danh mục
| Thể hiện trường nhập văn bản để khai báo thông tin mã danh mục ứng với từng bản ghi danh mục dùng chung |
| 3 | Tên danh mục | Văn bản (Text) | Bắt buộc | - Cho phép nhập tên danh mục dùng chung < 255 ký tự - Sau khi nhập, hệ thống thực hiện:
| Thể hiện trường nhập văn bản để khai báo thông tin tên danh mục ứng với từng bản ghi danh mục dùng chung |
| 4 | Giá trị | Văn bản (Text) | Không bắt buộc | - Cho phép nhập giá trị ứng với danh mục - Sau khi nhập, hệ thống thực hiện: Tự động loại bỏ khoảng trắng ở đầu và cuối (trim) | Thể hiện trường nhập văn bản để khai báo thông tin giá trị ứng với từng bản ghi danh mục dùng chung |
| 5 | Nút X | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để hủy bỏ thao tác thêm mới và đóng giao diện hiện tại mà không lưu thông tin. | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
| 6 | Nút Hủy | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để hủy bỏ thao tác thêm mới và đóng giao diện hiện tại mà không lưu thông tin. | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
3.4.3. Màn hình Xem chi tiết danh mục dùng chung
Cách truy cập: Phân hệ Quản lý danh mục > mục Danh mục dùng chung > Nhấn đúp vào tên danh mục dùng chung
Đối tượng sử dụng:Admin, End-user: Có quyền truy cập, và xem
| STT | Trường thông tin/ Nút chức năng | Kiểu dữ liệu | Điều kiện | Quy định | Mô tả |
|---|---|---|---|---|---|
| 1 | Loại danh mục | Lựa chọn (select) | Bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện trường thông tin loại danh mục ứng với từng bản ghi danh mục dùng chung |
| 2 | Mã danh mục | Văn bản (Text) | Bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện trường thông tin về mã danh mục ứng với từng bản ghi danh mục dùng chung |
| 3 | Tên danh mục | Văn bản (Text) | Bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện trường nhập văn bản để khai báo thông tin tên ứng với từng bản ghi danh mục dùng chung |
| 4 | Giá trị | Văn bản (Text) | Không bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện trường nhập văn bản để khai báo thông tin giá trị ứng với từng danh mục dùng chung |
| 5 | Nút X | Nút chức năng (Button) | Không bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
| 6 | Nút Hủy | Nút chức năng (Button) | Không bắt buộc | Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa). | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
3.4.4. Màn hình Chỉnh sửa danh mục dùng chung
Cách truy cập: Phân hệ Quản lý danh mục > mục Danh mục dùng chung > Nhấn vào nút chỉnh sửa
Đối tượng sử dụng: Admin: Có quyền truy cập, xem và thao tác
| STT | Trường thông tin/ Nút chức năng | Kiểu dữ liệu | Điều kiện | Quy định | Mô tả |
|---|---|---|---|---|---|
| 1 | Loại danh mục | Lựa chọn (select) | Bắt buộc | - Hệ thống hiển thị sẵn giá trị đã khai báo trước đó tại trường
- Cho phép người dùng nhấn để chọn loại danh mục dùng chung ở trạng thái hoạt động - Nguồn dữ liệu: 4639- Quản lý danh mục dùng chung - Phần Loại danh mục - Sau khi nhập, hệ thống thực hiện hiển thị giá trị đã chọn trên màn hình chỉnh sửa | Thể hiện trường thông tin cho phép chọn để chỉnh sửa thông tin loại danh mục ứng với từng bản ghi danh mục dùng chung |
| 2 | Mã danh mục | Văn bản (Text) | Bắt buộc | - Hệ thống hiển thị sẵn giá trị đã khai báo trước đó tại trường
- Cho phép nhập kí tự ≤ 100 ký tự, không trùng với mã đã tồn tại trong cùng một danh mục
| Thể hiện trường thông tin cho phép chỉnh sửa mã danh mục ứng với từng bản ghi danh mục dùng chung |
| 3 | Tên danh mục | Văn bản (Text) | Bắt buộc | - Hệ thống hiển thị sẵn giá trị đã khai báo trước đó tại trường
- Cho phép nhập tên loại danh mục dùng chung < 255 ký tự - Sau khi nhập, hệ thống thực hiện:
| Thể hiện trường thông tin cho phép chỉnh sửa mã ứng với từng bản ghi danh mục dùng chung |
| 4 | Giá trị | Văn bản (Text) | Không bắt buộc | - Hệ thống hiển thị sẵn giá trị đã khai báo trước đó tại trường
- Sau khi nhập, hệ thống thực hiện: Tự động loại bỏ khoảng trắng ở đầu và cuối (trim) | Thể hiện trường thông tin cho phép chỉnh sửa giá trị ứng với từng danh mục dùng chung |
| 5 | Nút X | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để hủy bỏ thao tác chỉnh sửa và đóng giao diện hiện tại mà không lưu thông tin. | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
| 6 | Nút Nút Hủy | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để hủy bỏ thao tác chỉnh sửa và đóng giao diện hiện tại mà không lưu thông tin. | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
| 7 | Nút Áp dụng | Nút chức năng (Button) | Không bắt buộc | - Cho phép nhấn để áp dụng và lưu thông tin chỉnh sửa bản ghi danh mục dùng chung. - Khi nhấn hệ thống tiến hành xác nhận dữ liệu khi chỉnh sửa như sau:
| Thể hiện nút áp dụng để lưu thông tin chỉnh sửa bản ghi loại danh mục dùng chung. |
3.4.5. Màn hình pop-up Bộ lọc
Cách truy cập: Phân hệ Quản lý danh mục > mục Danh mục dùng chung > Nhấn đúp vào nút Lọc
Đối tượng sử dụng: Admin: Có quyền truy cập, xem và thao tác
| STT | Trường thông tin/ Nút chức năng | Kiểu dữ liệu | Điều kiện | Quy định | Mô tả |
|---|---|---|---|---|---|
| 1 | Loại mục | Lựa chọn (select) | Không bắt buộc | - Cho phép người dùng nhấn để chọn loại danh mục dùng chung - Nguồn dữ liệu: 4639- Quản lý danh mục dùng chung - Phần Loại danh mục - Sau khi nhập, hệ thống thực hiện hiển thị giá trị đã chọn trên màn hình chỉnh sửa | Thể hiện trường thông tin cho phép chọn để thao tác lọc thông tin loại danh mục ứng với từng bản ghi danh mục dùng chung |
| 2 | Giá trị | Văn bản (Text) | Không bắt buộc | - Cho phép nhập giá trị theo khoảng để thực hiện lọc - Xem chi tiết mục 2.1 và mục 2.2 | Thể hiện nhóm cho phép nhập giá trị lọc theo khoảng |
| 2.1 | Từ | Văn bản (Text) | Không bắt buộc | - Cho phép nhập giá trị bắt đầu thực hiện lọc - Sau khi nhập, hệ thống thực hiện: Tự động loại bỏ khoảng trắng ở đầu và cuối (trim) | Thể hiện trường thông tin cho phép nhập giá trị bắt đầu lọc thông tin loại danh mục ứng với từng bản ghi danh mục dùng chung |
| 2.2 | Đến | Văn bản (Text) | Không bắt buộc | - Cho phép nhập giá trị kết thúc thực hiện lọc - Sau khi nhập, hệ thống thực hiện: Tự động loại bỏ khoảng trắng ở đầu và cuối (trim) | Thể hiện trường thông tin cho phép nhập giá trị kết thúc lọc thông tin loại danh mục ứng với từng bản ghi danh mục dùng chung |
| 3 | Nút X | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để hủy bỏ thao tác lọc và đóng giao diện hiện tại mà không lưu thông tin. | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
| 4 | Nút Hủy | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để hủy bỏ thao tác lọc và đóng giao diện hiện tại mà không lưu thông tin. | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
| 5 | Nút Áp dụng | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để áp dụng tiêu chí lọc và đóng giao diện hiện tại mà không lưu thông tin. | Thể hiện nút chức năng cho phép hủy bỏ thao tác mà không lưu dữ liệu. |
| 6 | Nút Đặt lại | Nút chức năng (Button) | Không bắt buộc | Cho phép người dùng nhấn để tất cả trường nhập liệu/ được chọn trên pop-up sẽ trở về trạng thái mặc định (giá trị ban đầu hoặc trống). | Thể hiện nút chức năng cho phép tất tất cả trường nhập liệu/ được chọn trên pop-up sẽ trở về trạng thái mặc định (giá trị ban đầu hoặc trống). |