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 | Nguyễn Đức Trung | ||
Vũ Thị Mơ | ||||
Tài khoản email/MS team | anhbn4 | trungnd3 | ||
movt2 | ||||
Chức danh | Business Analyst (BA) | Product Owner (P.O) | ||
Business (BA BIZ) | ||||
Ngày soạn thảo |
| |||
| ||||
Jira Link |
BPMKVH-4639
-
Getting issue details...
STATUS
| |||
1. Card (Mô tả tính năng)
Tôi muốn quản lý được các loại danh mục dùng chung để thực hiện quản lý các danh mục dùng chung trong hệ thống BPM
2. Confirmation/ Acceptance Criteria (Tiêu chí nghiệm thu)
- Tôi muốn xem được danh sách loại danh mục dùng chung bao gồm
- STT
- Mã loại danh mục
- Tên loại danh mục
- Trạng thái
- Tôi muốn tìm kiếm được thông tin loại danh mục dùng chung theo
- Mã -Tên loại danh mục
- Tôi muốn tạo mới được loại danh mục dùng chung bao gồm:
- Mã loại danh mục: Bắt buộc, Duy nhất
- Tên loại danh mục: Bắt buộc
- Trạng thái: Bắt buộc
- Tôi muốn sửa được thông tin loại danh mục dùng chung bao gồm:
- Tên loại danh mục
- Trạng thái
- Tôi muốn xem chi tiết được loại danh mục dùng chung bao gồm:
- Mã loại danh mục
- Tên loại danh mục
- Trạng thái
- Tôi muốn xóa được loại danh mục dùng chung trong trường hợp loại danh mục chưa được sử dụng trong danh mục dùng chung
- Tôi muốn hệ thống cảnh báo và chặn trong trường hợp mã loại danh mục trùng nhau
- Tôi muốn hệ thống cảnh báo và chặn trong trường hợp xóa hoặc chuyển trạng thái không hoạt động loại danh mục đang được sử dụng
- Tôi muốn tạo các loại danh mục dùng chung phục vụ cho tích hợp SAP tham chiếu theo US User Story- Các danh mục cố định BPM tự tạo để mapping vào SAP
3. Conversation (Mô tả chi tiết)
3.1. UI/UX:
3.1.1. Màn hình Loại danh mục dùng chung
3.1.2. Màn hình Thêm mới loại danh mục dùng chung
3.1.3. Màn hình Xem chi tiết loại danh mục dùng chung
3.1.4. Màn hình Chỉnh sửa loại danh mục dùng chung
3.1.5. Màn hình không có kết quả tìm kiếm
3.1.6. Thông báo (toast)
3.2 Luồng:
- Activity Diagram:
- Sequence Diagram:
- Flowchart:
3.3 API Spec: Loại danh mục
I. Danh sách loại danh mục
Method | GET | URL | /categoryType/list |
|---|
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Param
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | name | false | String | Tên loại danh mục | ||
| 2 | status | false | Integer | Trạng thái loại danh mục | Chưa định nghĩa trạng thái do k có mô tả cũng như figma nên tạm thời đang mặc định là (1: active, 0: inactive) | |
| 3 | limit | false | Integer | Giới hạn bản ghi trên 1 trang | ||
| 4 | page | false | Integer | Vị trí trang |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | id | Integer | Mã tự sinh của loại danh mục | ||
| 2 | code | String | Mã duy nhất của loại danh mục | ||
| 3 | name | String | Tên loại danh mục | ||
| 4 | status | Integer | Trạng thái loại danh mục | ||
| 5 | departmentId | Integer | Phòng ban khởi tạo |
II. Chi tiết loại danh mục
Method | GET | URL | /categoryType/get |
|---|
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Param
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | id | true | Integer | Mã tự sinh của loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | id | Integer | Mã tự sinh của loại danh mục | ||
| 2 | code | String | Mã duy nhất của loại danh mục | ||
| 3 | name | String | Tên loại danh mục | ||
| 4 | status | Integer | Trạng thái loại danh mục | ||
| 5 | departmentId | Integer | Phòng ban khởi tạo |
III. Thêm mới/chỉnh sửa loại danh mục
Method | POST | URL | /categoryType/update |
|---|
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Body
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | id | false | Integer | Mã tự sinh của loại danh mục | Truyền mã tự sinh > 0 thì sẽ cập nhật, còn không thì thêm mới | |
| 2 | code | true | String | Mã duy nhất của loại danh mục | ||
| 3 | name | true | String | Tên loại danh mục | ||
| 4 | status | true | Integer | Trạng thái loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | id | Integer | Mã tự sinh của loại danh mục | ||
| 2 | code | String | Mã duy nhất của loại danh mục | ||
| 3 | name | String | Tên loại danh mục | ||
| 4 | status | Integer | Trạng thái loại danh mục | ||
| 5 | departmentId | Integer | Phòng ban khởi tạo |
IV. Chỉnh sửa trạng thái loại danh mục
Method | POST | URL | /categoryType/update/status |
|---|
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Body
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | id | true | Integer | Mã tự sinh của loại danh mục | ||
| 2 | status | true | Integer | Trạng thái loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | id | Integer | Mã tự sinh của loại danh mục | ||
| 2 | code | String | Mã duy nhất của loại danh mục | ||
| 3 | name | String | Tên loại danh mục | ||
| 4 | status | Integer | Trạng thái loại danh mục | ||
| 5 | departmentId | Integer | Phòng ban khởi tạo |
V. Xóa loại danh mục
Method | DELETE | URL | /categoryType/delete |
|---|
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Param
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | id | true | Integer | Mã tự sinh của loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | result | Integer | Số bản ghi xóa thành công | Trả về 0 nếu xóa thất bại |
VI. Xóa nhiều loại danh mục
Method | DELETE | URL | /categoryType/deleteList |
|---|
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Param
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | lstId | true | List<Integer> | Danh sách mã tự sinh của loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | result | Integer | Số bản ghi xóa thành công | Trả về 0 nếu xóa thất bại |
3.4 Mô tả các trường dữ liệu trên màn hình:
Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) |
|---|---|---|---|---|
| id | Integer | true | ||
| code | String | true | <= 100 ký tự, mã loại danh mục không được phép trùng nhau | |
| name | String | true | <= 255 ký tự | |
| status | Integer | true | ||
| departmentId | Integer | false |
3.4.1. Màn hình Loại danh mục (Danh sách Loại danh mục)
Cách truy cập: Phân hệ Quản lý danh mục > mục Loại danh mục dùng chung
Phân quyền: Tất cả người dùng trên hệ thống
| 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/mã loại 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 "Loại 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ã loại danh mục dùng chung” và biểu tượng kính lúp ở phần đầu ô nhập. |
| 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 Loạ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 loại danh mục dùng" | Thể hiện nút chức năng thêm mới đơn 1 bản ghi loại danh mục dùng chung vào màn hình danh sách loại 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 loại 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 loại danh mục dùng chung. |
| 4 | STT | Số (Number) | Không bắt buộc | - Số thứ tự động sinh, bắt đầu từ 1, tăng dần
- Khi xóa bản ghi: STT không đánh lại (giữ nguyên để đảm bảo truy vết). - 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 loại danh mục dùng chung. |
| 5 | Mã 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). | Thể hiện mã định danh duy nhất của từng bản ghi trên màn hình danh sách loại danh mục dùng chung. |
| 6 | Tên loại 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 loại danh mục dùng chung: tham chiếu mục 3.4.3. Màn hình pop-up "Xem chi tiết loại danh mục dùng chung" | Thể hiện tên loại danh mục dùng chung ứng với bản ghi trên màn hình danh sách loại danh mục dùng chung. |
| 7 | Hoạt động | Công tắc (Toggle/Switch) | Không bắt buộc | 1. Ý nghĩa trạng thái - Trạng thái Bật (Active/On): Hệ thống ghi nhận trạng thái loại danh mục dùng chung là Hoạt động và được phép sử dụng trong hệ thống. - Trạng thái Tắt (Inactive/Off): Hệ thống ghi nhận trạng thái loại danh mục dùng chung là Không hoạt động và không được phép sử dụng trong hệ thống. 2. Phân quyền - Người dùng cuối (End-user): Không hiển thị tab Hoạt động đối với người dùng này và Không được phép thao tác trong tab Hoạt động. 3. Quy định ràng buộc dữ liệu - Trường hợp bản ghi đang được sử dụng trong hệ thống và người dùng thực hiện thay đổi trạng thái, hành vi hệ thống như sau:
| Thể hiện công tắc để thiết lập trạng thái hoạt động của từng bản ghi trên màn hình danh sách loại 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 loại danh mục dùng chung": tham chiếu mục 3.4.4. Màn hình pop up "Chỉnh sửa loại 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 loại 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 loại danh mục dùng chung đang ở trạng thái Không hoạt động (Inactive/Off). -Nếu chọn bản ghi không được xóa, hệ thống sẽ hiện thông báo (Toast):
| 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 loại danh mục dùng chung. |
3.4.2. Màn hình pop-up "Thêm mới loại danh mục dùng"
Cách truy cập: Phân hệ Quản lý danh mục > mục Loại danh mục dùng chung > Nhấn nút Thêm mới
Đối tượng sử dụng:
Admin: Có quyền truy cập và thao tác
End-user: Không cho phép thực hiện chức năng này
| 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 | Mã loại 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 hệ thống
| Thể hiện trường nhập văn bản để khai báo thông tin mã loại danh mục. |
| 2 | Tên loại danh mục | Văn bản (Text) | Bắt buộc | - Cho phép nhập tên loại danh mục < 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 loại danh mục. |
| 3 | Trạng thái hoạt động | Công tắc (Toggle/Switch) | Không bắt buộc | - Hiển thị giá trị mặc định: Bật (Active/On) - Khi nhập thông tin thêm mới, hệ thống cho phép người dùng nhấn để thay đổi trạng thái phép thay đổi trạng thái.
| Thể hiện công tắc để thiết lập trạng thái hoạt động của bản ghi loại danh mục dùng chung khi người dùng thực hiện thêm mới. |
| 4 | 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. |
| 5 | 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. |
| 6 | 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 bản ghi loại 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 thêm mới bản ghi loại danh mục dùng chung. |
3.4.3. Màn hình pop-up Xem chi tiết loại danh mục dùng chung
Cách truy cập: Phân hệ Quản lý danh mục > mục Loại danh mục dùng chung > Nhấn đúp vào Tên loại danh mục
Đối tượng sử dụng:
Admin: Có quyền truy cập và thao tác
End-user: Có quyền truy cập 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 | Mã loại 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 thông tin mã loại danh mục. |
| 2 | Tên loại 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 thông tin tên loại danh mục. |
| 3 | Trạng thái hoạt động | 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 trạng thái hoạt động của loại danh mục dùng chung. |
| 4 | 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. |
| 5 | 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 pop-up Chỉnh sửa loại danh mục dùng chung
Cách truy cập: Phân hệ Quản lý danh mục > mục Loại danh mục dùng chung > Nhấn đúp vào Tên loại danh mục
Đối tượng sử dụng:
Admin: Có quyền truy cập và thao tác
End-user: Không cho phép thực hiện chức năng này
| 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 | Mã loại 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 thông tin mã loại danh mục. |
| 2 | Tên loại 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 nhập văn bản < 255 ký tự - Sau khi nhập, hệ thống thực hiện:
| Thể hiện trường cho phép nhập văn bản để chỉnh sửa thông tin tên loại danh mục. |
| 3 | Trạng thái hoạt động | Công tắc (Toggle/Switch) | 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
- Trường hợp bản ghi đang được sử dụng trong hệ thống và người dùng thực hiện thay đổi trạng thái, hành vi hệ thống như sau:
| Thể hiện công tắc cho phép chỉnh sửa trạng thái hoạt động của bản ghi trên màn hình danh sách loại danh mục dùng chung. |
| 4 | 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. |
| 5 | 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. |
| 6 | 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 loại 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. |





