Update Documentation

This commit is contained in:
2026-05-31 10:29:44 +07:00
parent 17a9c69379
commit eebb9c9fe9
6 changed files with 208 additions and 12 deletions
@@ -2,7 +2,11 @@
Dokumen ini ditujukan untuk developer frontend (Vue.js + three.js + ThatOpen) yang akan mengintegrasikan aplikasi dengan backend Odoo 19 Product Engineering.
Dokumen ini adalah panduan rekomendasi implementasi.
Dokumen dapat direview dan direvisi mengikuti perubahan implementasi backend.
Lihat juga indeks dokumentasi utama di [README.md](README.md).
Untuk istilah dan konvensi endpoint, lihat [TERMINOLOGY_AND_CONVENTIONS.md](TERMINOLOGY_AND_CONVENTIONS.md).
## 1) Prinsip Integrasi
@@ -20,11 +24,28 @@ Urutan umum:
1. Login session
2. List atau create dokumen IFC
3. Parse IFC
4. Submit approval sesuai alur bisnis
5. Tambah atau tampilkan activity per dokumen
6. Generate BoM saat dibutuhkan
7. Minta signed temp URL
8. Load IFC file ke viewer menggunakan URL temp
4. Tambah atau tampilkan activity per dokumen
5. Submit approval sesuai alur bisnis (production -> provisioning)
6. Generate Estimated BoM
7. Jalankan inventory/check
8. Jika shortage, jalankan create-draft-purchase atau create-product
9. Create Permanent BoM (jika availability terpenuhi)
10. Create MO from Permanent BoM
11. Jalankan check-all-availability
12. Confirm all MOs jika all_available bernilai true
13. Opsional: gunakan run-pipeline untuk eksekusi otomatis
14. Opsional: gunakan pipeline-dry-run untuk preview tanpa mutasi data
15. Minta signed temp URL dan load IFC file ke viewer
Catatan:
- Urutan di atas adalah urutan rekomendasi yang selaras dengan backend saat ini.
- Untuk UI cepat, frontend dapat memanfaatkan endpoint run-pipeline atau pipeline-dry-run.
## 2.1) State Model Singkat
- Parse state: draft -> parsed | failed
- Approval state: draft -> in_validation -> waiting_production -> waiting_provisioning -> approved (dapat rejected pada tahap validasi/approval)
## 3) Format Request JSON-RPC
@@ -153,8 +174,8 @@ Saran UI:
### 5.6 Manufacturing Order
- /api/ifc/documents/mo/create-if-available
- /api/ifc/documents/mo/create-from-permanent-bom
- /api/ifc/documents/mo/create-from-permanent-bom (recommended)
- /api/ifc/documents/mo/create-if-available (compatibility alias)
- /api/ifc/documents/mo/check-all-availability
- /api/ifc/documents/mo/confirm-all-if-available
- /api/ifc/documents/mo/run-pipeline
@@ -163,6 +184,7 @@ Saran UI:
Saran UI:
- Aktifkan tombol Create MO hanya jika permanent BoM sudah ada dan availability terpenuhi.
- Untuk integrasi baru, gunakan endpoint create-from-permanent-bom sebagai jalur utama.
- Setelah ada beberapa MO, tampilkan summary kebutuhan produk dari check-all-availability.
- Aktifkan tombol Confirm All MOs hanya jika all_available = true pada summary all MOs.
- Untuk mode otomatis, gunakan run-pipeline dengan auto_confirm=true.
@@ -250,6 +272,10 @@ Checklist tahap awal:
- Activity add/list tampil di UI per dokumen.
- Approval flow berjalan sesuai role.
- BoM generate/get tampil di panel BOM.
- Inventory check dan draft purchase/create product flow berjalan.
- Alur permanent BoM dan create MO from permanent BoM berjalan.
- check-all-availability dan confirm-all-if-available berjalan sesuai rule all_available.
- run-pipeline dan pipeline-dry-run tervalidasi dari UI.
- Viewer berhasil load file dari signed temp URL.
Checklist UAT: