Nghiệp vụ | IT | |||
|---|---|---|---|---|
Người lập | Người duyệt | Người lập | Người duyệt | |
Tên, Chức danh | ||||
Ngày ký | ||||
Jira Link | [BPMKVH-4304] Tích hợp SAP - Đồng bộ thông tin dự án - Jira | |||
1. Card (Mô tả tính năng)
Là admin nghiệp vụ, Tôi muốn đồng bộ được thông tin dự án từ SAP về BPM
2. Confirmation/ Acceptance Criteria (Tiêu chí nghiệm thu)
- Tôi muốn đồng bộ được thông tin dự án khi Tạo mới/Chỉnh sửa của các dự án đầu tư xây dựng cơ bản tại SAP về BPM
- Mã loại dự án ( Danh mục)
- Mã dự án
- Tên dự án
- Tỉnh thành phố
- Phường Xã
- Địa chỉ
- Chủ đầu tư ( Danh mục chủ đầu tư)
- Quy mô dự án (Diện tích)
- Trạng thái
- Tôi muốn khi đồng bộ thông tin dự án:
- Nếu mã dự án đã tồn tại → Update thông tin dự án thay đổi theo mã dự án
- Mã dự án chưa tồn tại → Insert thông tin dự án
- Tôi muốn cấu hình được tần suất cập nhật theo thời gian
- Tôi muốn chủ động cập nhật thủ công được thông tin khi có nhu cầu
- Tôi muốn quản lý được lịch sử đồng bộ danh mục dự án
- Thời gian băt đầu
- Thời gian kết thúc
- Người đồng bộ
- Trạng thái
- Mã lỗi
- Mô tả lỗi
- Tôi muốn lọc được thông tin lịch sử đồng bộ theo
- Ngày: Từ- Đến
- Người đồng bộ
- Trạng thái
- Mã lỗi
- US này chưa bao gồm API Spec do SAP cung cấp
- Phân quyền: Với những người có quyền xem danh mục thì sẽ có quyền full liên quan đến danh mục bao gồm cả Cấu hình và Đồng bộ ngay
| TT | Tên trường | Mô tả | SAP field | Loại dữ liệu | Độ dài | Bắt buộc | Ghi chú |
| 1 | Mã loại dự án | Danh mục cố định A: Star (Thấp tầng) B: Khu công nghiệp C: Cao tầng F: Sojo W: Dự án CNTT | Mã loại dự án | CHAR | 5 | SAP: Danh mục Loại dự án: Mã ,Tên, Chỉ XDCB, ít thay đổi BPM: Danh mục có Mã, tên, Trạng thái và chia nhỏ theo Hạ tầng, Giao thông,... | |
| 2 | Mã dự án | project definition | CHAR | 24 | Bắt buộc | Key so sánh khi insert, update | |
| 3 | Tên dự án | description | CHAR | 40 | Bắt buộc | ||
| 4 | Tỉnh thành phố | Tỉnh thành phố | CHAR | 50 | |||
| 5 | Phường Xã | Phường Xã | CHAR | 50 | |||
| 6 | Địa chỉ | Địa chỉ | Bắt buộc | ||||
| 8 | Mã chủ đầu tư | Danh mục BPM đồng bộ theo SAP | Mã Chủ đầu tư | CHAR | 4 | Danh mục chủ đầu tư: Mã chủ đầu tư, Mã số thuế, Tên, Địa chỉ, BPM thêm mới theo đúng mã của SAP | |
| 9 | Quy mô dự án ( Diện tích) | Quy mô dự án | QUAN | 13 | |||
| 10 | Trạng thái | REL1 :Chuẩn bị triển khai REL2 : Đang triển khai REL3: Dự án hoàn thành REL4: Dự án hủy | Trạng thái | CHAR | 4 |
3. Conversation (Mô tả chi tiết)
3.1 UIUX:
3.1.1. Màn hình danh sách tích hợp thông tin dự án (SAP)
3.1.2. Màn hình pop-up "Bộ lọc"
3.1.3. Nút cấu hình tích hợp danh mục dự án
3.1.3.1 Màn hình chọn tần suất tích hợp hàng ngày
3.1.3.1 Màn hình chọn tần suất tích hợp tùy chọn- khi có lựa chọn
3.1.3.2 Màn hình chọn tần suất tích hợp tùy chọn- khi không có lựa chọn
3.1.4. Pop-up xác nhận đồng bộ ngay
3.1.5. Pop-up cảnh báo Khi người dùng nhấn nút "đồng bộ dữ liệu" cùng lúc với hệ thống đồng bộ tự động
3.1.6. Pop-up chi tiết mã lỗi
3.2 Luồng:
3.3 API Spec: <gắn link tài liệu mô tả API vào đây>
Method | POST | URL | /integration/partnerSyncLog/list |
|---|---|---|---|
Description | API Lấy thông tin lịch sử đông bộ | ||
Note | API mới | ||
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request body
STT | Field | Required | Data Type / Length | Description | Note |
|---|---|---|---|---|---|
| 1 | errorCode | false | String | mã lỗi | |
| 2 | page | false | Integer | Trang dữ liệu (phân trang) | |
| 3 | limit | false | Integer | Số bản ghi mỗi trang | |
| 4 | startTime | false | String | Thời gian đồng bộ ("2026-02-26") | |
| 5 | endTime | false | String | Thời gian đồng bộ ("2026-02-26") | |
| 6 | syncBy | false | Integer | Người đồng bộ | |
| 7 | type | false | String | loại (PROJECT: dự án...) | |
| 8 | status | false | Integer | trạng thái |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note |
|---|---|---|---|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại | |
| 2 | message | String | ||
| result | List<Object> | |||
| (result) page | Integer | trang bao nhiêu | ||
| (result) total | Integer | số lượng bản ghi | ||
| (result) items | List<Object> | danh sách bản ghi | ||
| (items) id | Integer | id | ||
| (items) endTime | String | thời gian kết thúc đòng bộ | ||
| (items) errorCode | String | mã lỗi | ||
| (items) String | String | chi tiết lỗi | ||
| (items) startTime | String | Thời gian bắt đầu đồng bộ | ||
| (items) status | Integer | trang thái | ||
| (items) syncBy | String | người đồng bộ |
Method | POST | URL | /integration/partner/scheduleConfig |
|---|---|---|---|
Description | API cập nhật/ thêm mới cấu hình đồng bộ | ||
Note | API mới | ||
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request body
STT | Field | Required | Data Type / Length | Description | Note |
|---|---|---|---|---|---|
| 1 | code | false | String | mã cấu hình (PROJECT: dự án...) | |
| 2 | id | false | Integer | id | |
| 3 | dayOfWeek | false | Integer | ngày trong tuần | |
| 4 | hour | false | String | giờ | |
| 5 | minute | false | Integer | phút | |
| 6 | type | false | Integer | loại (day: hằng ngày, week: tùy chọn) |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note |
|---|---|---|---|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại | |
| 2 | message | String |
Method | POST | URL | /integration/partner/sync |
|---|---|---|---|
Description | API button đông bộ ngay | ||
Note | API mới | ||
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request body
STT | Field | Required | Data Type / Length | Description | Note |
|---|---|---|---|---|---|
| 1 | type | false | String | loại (PROJECT: dự án...) |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note |
|---|---|---|---|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại | |
| 2 | message | String |
Method | POST | URL | integration/partner/scheduleConfig/get |
|---|---|---|---|
Description | API lấy thông tin cấu hình đồng bộ | ||
Note | API mới | ||
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request body
STT | Field | Required | Data Type / Length | Description | Note |
|---|---|---|---|---|---|
| 1 | code | false | String | loại (PROJECT: dự án...) |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note |
|---|---|---|---|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại | |
| 2 | message | String | ||
| result | Object | thông tin chi tiết cấu hình | ||
| (result) code | Integer | mã cấu hình | ||
| (result) cronExpression | Integer | |||
| (result) dayOfWeek | List<Object> | ngày trong tuần | ||
| (result) id | Integer | id | ||
| (result) hour | String | giờ | ||
| (result) minute | String | phút | ||
| (result) status | String | trang thái | ||
| (result) timezoneOffset | String | |||
| (result) type | Integer | loại |
Method | POST | URL | /application/projectRealty/sync |
|---|---|---|---|
Description | API nhận dữ liệu từ SAP | ||
Note | API mới | ||
1. Headers
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|---|---|---|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request body
STT | Field | Required | Data Type / Length | Description | Note |
|---|---|---|---|---|---|
| 1 | List<Object> | true | danh sách chủ đầu tư | ||
| address | String | địa chỉ | |||
| bukrs | String | mã chủ đầu tư SAP | |||
| pstype | String | mã SAP loại dự án | |||
| pspid | String | Mã dự án | |||
| post1 | String | tên dự án | |||
| diettich | String | quy mô dự án | |||
| stats | String | Trạng thái |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note |
|---|---|---|---|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại | |
| 2 | message | String |
Tài liệu SAP gửi: ROX_S4HANA_2026_PM_DacTaAPI_Tich-hop-BPM_v0.2 (2).docx
3.4 Mô tả các trường dữ liệu trên màn hình:
3.4.1. Màn hình danh sách tích hợp thông tin dự án (SAP)
Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) | |
|---|---|---|---|---|---|
| 1 | STT | Số (Number) | Không bắt buộc |
| Thể hiện thứ tự các bản ghi lịch sử đồng bộ màn hình "Tích hợp thông tin dự án" |
| 2 | Thời gian bắt đầu | Thời gian (date-time) | Không bắt buộc |
| Thể hiện thời gian bắt đầu đồng bộ thông tin dự án |
| 3 | Thời gian kết thúc | Thời gian (date-time) | Không bắt buộc |
| Thể hiện thời gian kết thúc đồng bộ thông tin dự án |
| 4 | Người đồng bộ | Văn bản (Text) | Không bắt buộc |
| Thể hiện thông tin người đồng bộ dự án |
| 5 | Trạng thái | Văn bản (Text) | Không bắt buộc |
+ Thành công: khi cập nhật thông tin thành công + Thất bại: khi cập nhật thông tin xảy ra lỗi TH1: Hệ thống lỗi theo quy định mã lỗi của SAP TH2: Trong trường hợp người dùng đang thực hiện đồng bộ thủ công, sau đó hệ thống kích hoạt đồng bộ tự động (thao tác đồng bộ thủ công diễn ra trước), hệ thống không cho phép hai tiến trình đồng bộ chạy đồng thời. Hành vi hệ thống:
+ Đang thực hiện: khi hệ thống đang thực hiện cập nhật thông tin | Thể hiển trạng thái đồng bộ thông tin dự án |
| 6 | Mã lỗi | Văn bản (Text) | Không bắt buộc |
| Thể hiện mã lỗi hệ thống trả về khi đồng bộ thất bại |
| 7 | Nút lọc | Nút chức năng (Button) | Không bắt buộc |
| Thể hiện nút chức năng bộ lọc |
| 8 | Nút cấu hình | Nút chức năng (Button) | Không bắt buộc |
| Mở màn hình cấu hình tích hợp/cấu hình lịch đồng bộ |
| 9 | Nút đồng bộ ngay | Nút chức năng (Button) | Không bắt buộc |
| Thể hiện đồng bộ dữ liệu ngay lập tức theo thời gian hiện tại |
3.4.2. Màn hình pop-up "Bộ lọc"
Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) | |
|---|---|---|---|---|---|
| 1 | Tiêu đề bộ lọc | Nhãn hiệu (Label) | Thể hiển thị tiêu đề popup “Bộ lọc” | ||
| 2 | Khoảng thời gian | Ngày tháng năm (date) | Không bắt buộc |
| Thể hiện thời gian lọc từ ngày đến ngày |
| 3 | Người đồng bộ | Lựa chọn (Droplist) | Không bắt buộc | Hệ thống lấy ra từ list danh sách
| Thể hiện người thực hiện đồng bộ thông tin dự án |
| 4 | Trạng thái | Lựa chọn (Droplist) | Không bắt buộc |
+ Thành công + Thất bại + Đang thực hiện + Tất cả (Khi người dùng không chọn sẽ để mặc định) | Thể hiện trạng thái đồng bộ dự án |
| 5 | Mã lỗi | Hyperlink | Không bắt buộc |
| Thể hiện thông tin mã lỗi khi đồng bộ thông tin |
| 6 | Nút "X" | Nút chức năng (Button) | Không bắt buộc |
| Thể hiện nút "X" để hủy bỏ thao tác lọc. |
| 7 | Nút "Đặt lại" | Nút chức năng (Button) | Không bắt buộc |
-Hành vi hệ thống khi người dùng nhấn nút "Đặt lại" như sau:
| Thể hiện nút đặt lại tất cả tiêu chí lọc về trạng thái mặc định ban đầu. |
| 8 | 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 những tiêu chí lọc đã chọn. - Hành vi hiển thị kết quả hệ thống khi người dùng nhấn nút "Áp dụng" như sau:
| Thể hiện nút áp dụng tiêu chí lọc được chọn |
3.4.3. Nút cấu hình tích hợp danh mục dự án
Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) | |
|---|---|---|---|---|---|
| 1 | Tiêu đề màn hình | Nhãn hiệu (Label) | Không bắt buộc | Hiển thị tiêu đề " Tích hợp thông tin danh mục dự án (SAP)" | |
| 2 | Nút đóng (X) | Nút chức năng (Button) | Không bắt buộc |
| Đóng màn hình cấu hình, không lưu thay đổi |
| 3 | Tần suất | Nhãn hiệu (Label) | Không bắt buộc |
| Thể hiện tần suất người dùng chọn đồng bộ dữ liệu dự án |
| 4 | Hàng ngày | Nút chọn (Radio Option) | Không bắt buộc |
| Thể hiện thời gian đồng bộ dữ liệu dự án được chọn trong ngày |
| 5 | Tự chọn | Nút chọn (Radio Option) | Không bắt buộc |
| Thể hiện thời gian đồng bộ dữ liệu dự án các ngày được chọn trong tuần |
| 6 | Nút Hủy | Nút chức năng (Button) | Không bắt buộc |
| Thể hiện để hủy bỏ thao tác cấu hình. |
| 7 | 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 cài đặt cấu hình đã thiết lập - Khi nhấn nút, hành vi hệ thống như sau: Hành vi 1: Pop-up "Cài đặt hiển thị" sẽ đóng lại Hành vi 2: Hệ thống tải lại hoặc cập nhật ngay lập tức màn hình "Tích hợp danh mục dự án" để áp dụng cấu hình mới đã thiết lập. | Thể hiện nút áp dụng cấu hình được chọn |
3.4.4. Pop-up xác nhận đồng bộ ngay
Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) | |
|---|---|---|---|---|---|
| 1 | Tiêu đề màn hình | Nhãn hiệu (Label) | Không bắt buộc | Hiển thị tiêu đề " Xác nhận đồng bộ dữ liệu" | |
| 2 | Văn bản thông báo | Nút chức năng (Button) | Không bắt buộc |
| - Thể hiện văn bản thông báo - Nội dung văn bản thông báo: "Bạn có chắc chắn muốn đồng bộ dữ liệu dự án (SAP)" |
| 3 | Nút "Tôi chắc chắn" | Nút chức năng (Button) | Không bắt buộc |
| Cho phép người dùng nhấn để thực hiện đồng bộ thông tin dự án theo cấu hình hiện tại |
| 4 | Nút Hủy | Nút chức năng (Button) | Không bắt buộc |
| Thể hiện để hủy bỏ thao tác đồng bộ ngay. |
3.4.5. Pop-up cảnh báo Khi người dùng nhấn nút "đồng bộ dữ liệu" cùng lúc với hệ thống đồng bộ tự động
Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) | |
|---|---|---|---|---|---|
| 1 | Tiêu đề màn hình | Nhãn hiệu (Label) | Không bắt buộc | Hiển thị tiêu đề " Cảnh báo" | |
| 2 | Văn bản thông báo | Nút chức năng (Button) | Không bắt buộc |
| - Thể hiện văn bản cảnh báo: "Không thể thực hiện đồng bộ" - Nội dung văn bản thông báo:"Hệ thống đang thực hiện đồng bộ. |
| 3 | Nút "Thoát | Nút chức năng (Button) | Không bắt buộc |
| Thể hiện nút "Thoát" để đóng màn hình pop up cảnh báo |
3.4.6. Pop-up chi tiết mã lỗi
Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) | |
|---|---|---|---|---|---|
| 1 | Tiêu đề màn hình | Nhãn hiệu (Label) | Không bắt buộc | Hiển thị tiêu đề "Đồng bộ thất bại" | |
| 2 | Văn bản thông báo | Nút chức năng (Button) | Không bắt buộc |
| - Thể hiện văn bản thông báo - Nội dung văn bản thông báo: "Mã lỗi. Mô tả chi tiết lỗi" |
| 3 | Nút "Thoát | Nút chức năng (Button) | Không bắt buộc |
| Thể hiện nút "Thoát" để đóng màn hình pop up cảnh báo |





1 Comment
Vũ Thị Mơ
Mai Kiều Mi