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-4305] Tích hợp SAP - Đồng bộ thông tin nhà thầu - Jira BPMKVH-4926 -Phân tích usecase và viết tài liệu US tích hợp SAP - đồng bộ thông tin nhà thầu | |||
1. Card (Mô tả tính năng)
Là admin nghiệp vụ, Tôi muốn đồng bộ thông tin danh mục nhà thầu, nhà cung cấp từ BPM về SAP
2. Confirmation/ Acceptance Criteria (Tiêu chí nghiệm thu)
- Tôi muốn đồng bộ thông tin nhà cung cấp/nhà thầu từ nền tảng BPM sang hệ thống SAP sau khi người dùng hoàn tất thao tác Tạo mới/Chỉnh sửa.
Với nhà cung cấp là Cá nhân call API:
Cấp (Level)
Key
Diễn giải bằng SAP
Độ dài
Loại dữ liệu
Giá trị minh họa
THAM_SO
PARTNER
Business Partner Number ( Tạo mới để trống, Update bắt buộc nhập )
10
CHAR
1000521
THAM_SO
BU_GROUP
Business Partner Grouping
4
CHAR
N009
ADDRESS
TITLE_MEDI
Form of address
4
CHAR
1
ADDRESS
NAME_FIRST
First name of business partner
40
CHAR
Ưng
ADDRESS
NAME_LAST
Last name of business partner
40
CHAR
Sỹ Cường
ADDRESS
BPEXT
Business Partner Number in External System
20
CHAR
4324093809238
ADDRESS
STREET
Street / House Number
60
CHAR
26 Hẻm 27 ngách 103
ADDRESS
STREET2
Street 2
40
CHAR
ngõ 1194 Đường Láng
ADDRESS
STREET3
Street 3
40
CHAR
Phường Láng Thượng
ADDRESS
CITY1
City
40
CHAR
Hà Nội
ADDRESS
CITY2
District
40
CHAR
Quận Cầu Giấy
ADDRESS
COUNTRY
Country Key
3
CHAR
VN
ADDRESS
LANGUCORR
Language Key
1
CHAR
EN
ADDRESS
TEL_NUMBER1
First Telephone No.
30
CHAR
977432874
ADDRESS
TEL_NUMBER2
Second Telephone No.
30
CHAR
934723442
ADDRESS
MOB_NUMBER1
First Mobile Phone No.
30
CHAR
347207340
ADDRESS
MOB_NUMBER2
Second Mobile Phone No.
30
CHAR
384023842
ADDRESS
MOB_NUMBER3
Third Mobile Phone No.
30
CHAR
998877669
ADDRESS
SMTP_ADDR
E-Mail Address
241
CHAR
ADDRESS
XDELE
Central Archiving Flag (Deletion)
1
CHAR
IDENTIFICATION
ID_TYPE
Identification Type
6
CHAR
CRM001
b. Với nhà cung cấp Tổ chức call API:
Cấp (Level)
Key
Diễn giải bằng SAP
Độ dài
Loại dữ liệu
Giá trị minh họa
THAM_SO
PARTNER
Business Partner Number
10
CHAR
1000521
THAM_SO
BU_GROUP
Business Partner Grouping
4
CHAR
N009
ADDRESS
TITLE_MEDI
Form of address
4
CHAR
1
ADDRESS
NAME_ORG1
Name 1
40
CHAR
FPT cormp
ADDRESS
NAME_ORG2
Name 2
40
CHAR
Công ty FPT
ADDRESS
BPEXT
Business Partner Number in External System
20
CHAR
4324093809238
ADDRESS
STREET
Street / House Number
60
CHAR
26 Hẻm 27 ngách 103
ADDRESS
STREET2
Street 2
40
CHAR
ngõ 1194 Đường Láng
ADDRESS
STREET3
Street 3
40
CHAR
Phường Láng Thượng
ADDRESS
CITY1
City
40
CHAR
Hà Nội
ADDRESS
CITY2
District
40
CHAR
Quận Cầu Giấy
ADDRESS
COUNTRY
Country Key
3
CHAR
VN
ADDRESS
LANGUCORR
Language Key
1
CHAR
EN
ADDRESS
TEL_NUMBER1
First Telephone No.
30
CHAR
977432874
ADDRESS
TEL_NUMBER2
Second Telephone No.
30
CHAR
934723442
ADDRESS
MOB_NUMBER1
First Mobile Phone No.
30
CHAR
347207340
ADDRESS
MOB_NUMBER2
Second Mobile Phone No.
30
CHAR
384023842
ADDRESS
MOB_NUMBER3
Third Mobile Phone No.
30
CHAR
998877669
ADDRESS
SMTP_ADDR
E-Mail Address
241
CHAR
ADDRESS
XDELE
Central Archiving Flag (Deletion)
1
CHAR
IDENTIFICATION
ID_TYPE
Identification Type
6
CHAR
CRM002
IDENTIFICATION
IDNUMBER
Identification Number
60
CHAR
4324093809238
- Tôi muốn lưu được thông tin mã nhà cung cấp, nhà thầu tương ứng của SAP trả về
- Tôi muốn đồng bộ thông tin nhà cung cấp, nhà thầu sang hệ thống SAP theo sự kiện khi có thông tin cập nhật tại danh mục nhà cung cấp, nhà thầu
- Tôi muốn quản lý được lịch sử đồng bộ danh mục
- Thời gian băt đầu
- Thời gian kết thúc
- Người đồng bộ
- MST/CCCD
- Mã NCC tại SAP
- 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ộ
- MST/CCCD
- Mã NCC tại SAP
- Trạng thái
- Mã lỗi
3. Conversation (Mô tả chi tiết)
3.1 UI/UX:
3.1.1. Màn hình Tích hợp SAP - Tab nhà cung cấp
3.1.2. Màn hình pop-up của màn hình Tích hợp SAP - Tab nhà cung cấp
3.1.3. Màn hình pop-up Đồng bộ thất bại
3.1.4. Màn hình kết quả lọc
3.1.4.1. Trường hợp 1: Có dữ liệu phù hợp
3.1.4.2. Trường hợp 2: Không có dữ liệu phù hợp
3.2 Luồng:
3.3. API Spec:
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 | |
| 9 | addition | false | Object | ||
(addition) taxCode | false | String | Mã số thuế | ||
(addition) sapCode | false | String | Mã sap trả về |
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ộ | |||
| 9 | (items) addition | false | Object | ||
(addition) taxCode | false | String | Mã số thuế | ||
(addition) sapCode | false | String | Mã sap trả về |
3.4. Mô tả những trường thông tin trên màn hình:
3.4.1. Màn hình Tích hợp SAP - Tab nhà cung cấp
Cách truy cập: Phân hệ Tích hợp hệ thống → Mục Tích hợp SAP → Tab Nhà cung cấp
| 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 | Tab Nhà cung cấp | Thẻ giao diện (Tab) | Không bắt buộc | - Hệ thống cho phép người dùng nhấn để lựa chọn tab.
| Thể hiện thông tin tích hợp dữ liệu nhà cung cấp từ BPM sang SAP. |
| 2 | STT | Số (Number) | Không bắt buộc | - Hệ thống tự động gán STT theo thời gian đồng bộ gần nhất: giao dịch đồng bộ gần nhận STT nhỏ hơn, giao dịch đồng bộ gần xa hơn nhận STT lớn hơn. | Thể hiện thứ tự các bản ghi. |
| 3 | Thời gian bắt đầu | Thời gian (date-time) | Không bắt buộc | - Hệ thống hiển thị thời điểm bắt đầu đồng bộ từ hệ thống BPM sang hệ thống SAP. - Thời điểm đồng bộ: Khi có phát sinh tạo mới hoặc chỉnh sửa thông tin tạiDanh mục NCC . - Định dạng: dd/mm/yyyy - hh:mm - Không cho phép người dùng thêm/sửa/xóa dữ liệu. | Thể hiện thời điểm hệ thống bắt đầu đồng bộ thông tin Nhà cung cấp từ hệ thống BPM sang hệ thống SAP. |
| 4 | Thời gian kết thúc | Thời gian (date-time) | Không bắt buộc | - Hệ thống hiển thị thời điểm kết thúc đồng bộ từ hệ thống BPM sang hệ thống SAP. - Thời điểm đồng bộ: Hệ thống nhận được phản hồi từ SAP về kết quả xử lý dữ liệu (thành công hoặc thất bại). - Định dạng: dd/mm/yyyy - hh:mm - Không cho phép người dùng thêm/sửa/xóa dữ liệu. | Thể hiện thời điểm hệ thống kết thúc đồng bộ thông tin Nhà cung cấp từ hệ thống BPM sang hệ thống SAP. |
| 5 | Mã số thuế/ CCCD | Văn bản (Text) | Không bắt buộc | - Hệ thống hiển thị Mã số thuế/ CCCD theo thông tin Nhà cung cấp tại thời điểm thực hiện đồng bộ. - Không cho phép người dùng thêm/sửa/xóa dữ liệu. | Thể hiện thông tin mã số thuế/CCCD của nhà cung cấp tại thời điểm đồng bộ dữ liệu từ hệ thống BPM sang hệ thống SAP. |
| 6 | Mã nhà cung cấp tại SAP | Văn bản (Text) | Không bắt buộc | - Hệ thống hiển thị mã nhà cung cấp từ hệ thống SAP khi đồng bộ dữ liệu giữa 2 nền tảng. - Không cho phép người dùng thêm/sửa/xóa dữ liệu. | Thể hiện nã NCC tại hệ thống SAP tại thời điểm đồng bộ dữ liệu từ BPM sang SAP. |
| 7 | Người đồng bộ | Văn bản (Text) | Không bắt buộc | - Hệ thống hiển thị tên người dùng hoàn tất thao tác Tạo mới/Chỉnh sửa thông tin nhà thầu tại Danh mục NCC . - Không cho phép người dùng thêm/sửa/xóa dữ liệu. | Thể hiện chủ thể thực hiện đồng bộ thông tin nhà cung cấp từ hệ thống BPM sang hệ thống SAP. |
| 8 | Trạng thái | Văn bản (Text) | Không bắt buộc | - Danh sách giá trị trạng thái đồng bộ gồm:
- Không cho phép người dùng thêm/sửa/xóa dữ liệu. | Thể hiển trạng thái đồng bộ thông tin nhà cung cấp từ hệ thống BPM sang hệ thống SAP. |
| 9 | Mã lỗi | Đường dẫn (Hyperlink) | Không bắt buộc | - Hệ thống hiển thị mã lỗi khi đồng bộ từ hệ thống BPM sang hệ thống SAP: 4667 - User Story - Cập nhật thông tin chung NCC phục vụ tích hợp SAP - Hệ thống cho phép người dùng nhấn vào mã lỗi để hiển thị pop-up cảnh báo “Đồng bộ thất bại” và xem chi tiết lỗi. - Pop-up cảnh báo “Đồng bộ thất bại” và xem chi tiết lỗi: tham chiếu mục:
| Thể hiện mã lỗi khi đồng bộ thông tin nhà cung cấp từ hệ thống BPM sang hệ thống SAP. |
| 10 | Nút Bộ lọc | Nút chức năng (Button) | Không bắt buộc | - Hệ thống hiển thị nút chức năng bộ lọc - Sau khi người dùng nhấn nút bộ lọc, hệ thống mở màn hình pop-up bộ lọc. - Pop-up Bộ lọc: tham chiếu mục 3.4.4. Màn hình pop-up Bộ Lọc | Thể hiện nút chức năng cho phép mở màn hình pop-up bộ lọc. |
3.4.2. Màn hình pop-up cảnh báo "Đồng bộ thất bại”
Cách truy cập: Phân hệ Tích hợp hệ thống → Mục Tích hợp SAP → Tab Nhà cung cấp > Đường dẫn Mô tả lỗi tại cột Mô tả lỗi
| 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ên mã lỗi | Văn bản (Text) | Không bắt buộc | Hệ thống hiển thị tên mã lỗi | Thể hiện tên mã lỗi |
| 2 | Mô tả lỗi | Văn bản (Text) | Không bắt buộc | Hệ thống hiển thị mô tả lỗi | Thể hiện mô tả lỗi |
| 3 | Nút Thoát | Nút chức năng (Button) | Không bắt buộc | - Hệ thống hiển thị nút chức năng thoát - Sau khi nhấn hệ thống cho phép thoát khỏi màn hình pop-up cảnh báo Đồng bộ thất bại | Thể hiện nút chức năng cho phép thoát khỏi màn hình pop-up cảnh báo Đồng bộ thất bại |
3.4.3. Danh sách mã lỗi
STT | Phân loại lỗi | Mã lỗi (HTTP/Code) | Status | Thông báo lỗi (Message) | Hệ thống phát sinh | Diễn giải & Hướng xử lý |
I | LỖI HỆ THỐNG | Liên quan đến kết nối và hạ tầng | ||||
1 | Kết nối | 401 | Unauthorized | SAP/BMP | Sai ApiToken hoặc User/Pass tích hợp. Cần kiểm tra lại thông tin xác thực. | |
2 | Kết nối | 403 | Forbidden | SAP/BMP | IP của PI/PO bị chặn bởi Firewall hoặc ACL trên Web Dispatcher. | |
3 | Kết nối | 404 | Not Found | SAP/BMP | Sai URL Endpoint của API trên SAP ROX. | |
4 | Hệ thống | 500 | Internal Server Error | SAP/BMP | Hệ thống đích bị treo hoặc gặp lỗi Runtime khi nhận Request. | |
5 | Hệ thống | 503 | Service Unavailable | SAP/BMP | SAP ROX đang bảo trì hoặc quá tải, Web Dispatcher không thể forward request. | |
II | LỖI NGHIỆP VỤ | Phát sinh từ Logic xử lý của SAP ROX (Trong MT_API_OUT) | ||||
8 | Dữ liệu | 200 | E | Chi tiết lỗi trả về | SAP | Xem chi tiết lỗi trả về |
9 | Dữ liệu | 200 | S | Message báo Tích hợp thành công, theo từng APIs | SAP | Trả thông báo thành công theo cấu trúc từng APIs |
3.4.4. Màn hình pop-up "Bộ lọc"
Cách truy cập: Phân hệ Tích hợp hệ thống → Mục Tích hợp SAP → Tab Nhà cung cấp > Nút Bộ lọ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 | Khoảng thời gian | Ngày tháng năm (date) | Không bắt buộc | - Hệ thống điều kiện lọc theo thời gian đồng bộ gồm 2 trường:
| Thể hiện điều kiện lọc về thời gian đồng bộ |
| 1.1 | Từ ngày | Ngày tháng năm (date) | Không bắt buộc | - Hệ thống cho phép người dùng chọn ngày từ lịch hệ thống. - Sau khi chọn giá trị ngày, hệ thống ghi nhận và hiển thị giá trị đã chọn trên màn hình. | Thể hiện mốc thời gian bắt đầu của khoảng lọc |
| 1.2 | Đến ngày | Ngày tháng năm (date) | Không bắt buộc | - Hệ thống cho phép người dùng chọn ngày từ lịch hệ thống. - Sau khi chọn giá trị ngày, hệ thống ghi nhận và hiển thị giá trị đã chọn trên màn hình. | Thể hiện mốc thời gian kết thúc của khoảng lọc |
| 2 | Người đồng bộ | Văn bản (Text) | Không bắt buộc | - Hệ thống cho phép người nhập có dấu hoặc không dấu hoặc dán (paste) dữ liệu vào ô nhập thông tin điều kiện lọc về tên người đồng bộ tại nền tảng SAP.
- Sau khi nhập giá trị tên người dùng tại nền tảng SAP, hành vi hệ thống như sau:
| Thể hiện trường cho phép nhập thông tin điều kiện lọc về chủ thể thực hiện đồng bộ thông tin nhà cung cấp từ hệ thống BPM sang hệ thống SAP. |
| 3 | Mã số thuế/CCCD | Văn bản (Text) | Không bắt buộc | - Hệ thống cho phép nhập thông tin điều kiện lọc về Mã số thuế/CCCD - Sau khi nhập giá trị Mã số thuế/CCCD, hệ thống ghi nhận và hiển thị giá trị đã nhập trên màn hình. | Thể hiện trường cho phép nhập thông tin điều kiện lọc về Mã số thuế/CCCD |
| 4 | Mã NCC tại SAP | Văn bản (Text) | Không bắt buộc | - Hệ thống cho phép nhập thông tin điều kiện lọc về Mã NCC tại nền tảng SAP. - Sau khi nhập giá trị Mã NCC tại nền tảng SAP, hệ thống ghi nhận và hiển thị giá trị đã nhập trên màn hình. | Thể hiện trường cho phép nhập thông tin điều kiện lọc về Mã NCC tại nền tảng SAP. |
| 5 | Trạng thái | Lựa chọn (Select) | Không bắt buộc | - Hệ thống hiển thị điều kiện lọc về trạng thái đồng bộ gồm:
- Sau khi chọn giá trị, hệ thống ghi nhận và hiển thị giá trị đã chọn trên màn hình. | Thể hiện điều kiện lọc về trạng thái đồng bộ |
| 6 | Mã lỗi | Văn bản (Text) | Không bắt buộc | - Hệ thống cho phép nhập thông tin điều kiện lọc về Mã lỗi. - Sau khi nhập giá trị Mã lỗi, hệ thống ghi nhận và hiển thị giá trị đã nhập trên màn hình. | Thể hiện trường cho phép nhập thông tin điều kiện lọc về mã lỗi khi đồng bộ từ hệ thống BPM sang hệ thống SAP. |
| 7 | 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. - Khi nhấn, màn hình pop-up "Bộ lọc" đóng lại. | Thể hiện nút X để hủy bỏ thao tác lọc. |
| 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 |
| 9 | Nút Đặt lại | Nút chức năng (Button) | Không bắt buộc | - Hệ thống cho phép người dùng nhấn để đặt lại tất cả tiêu chí lọc về trạng thái mặc định ban đầu. - Sau khi người dùng thao tác, hành vi hệ thống 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. |




