Notifikasi
- Code: ACC-NTF
- Module: Account
- Type: System Record
1. Overview
Notifikasi memberi tahu pengguna tentang kejadian yang relevan, misalnya PO yang perlu diajukan atau data yang berubah. Notifikasi sampai lewat tiga kanal: kotak masuk berisi daftar terbaru dan riwayat yang bisa dicari, toast yang muncul seketika saat aplikasi terbuka dan tersambung, dan notifikasi perangkat yang tetap muncul meski aplikasi tertutup bila pengguna menyalakannya. Setiap notifikasi mengarah ke data terkait, sehingga pengguna bisa langsung membukanya dengan satu klik.
Hasil yang diharapkan: pengguna tidak melewatkan pekerjaan yang menunggu mereka, dan bisa langsung menuju data terkait.
2. Problem
Tanpa pemberitahuan otomatis, pengguna harus membuka setiap modul satu per satu untuk tahu ada tugas atau perubahan yang menunggu. Akibatnya:
- Tugas yang menunggu seseorang, misalnya PO yang harus diajukan PIC, tidak diketahui tanpa membuka setiap modul.
- Pengguna yang tidak sedang membuka aplikasi melewatkan kejadian penting.
- Notifikasi tanpa tautan memaksa pengguna mencari data secara manual.
3. Goals & Non-goals
3.1 Goals
- Pengguna tahu ada pekerjaan yang menunggu tanpa membuka setiap modul satu per satu.
- Kejadian penting tetap sampai meski pengguna sedang tidak membuka aplikasi.
- Notifikasi bisa langsung ditindaklanjuti ke data yang bersangkutan.
- Pengguna bisa memilih menerima notifikasi perangkat atau tidak, sedangkan toast otomatis selama aplikasi terhubung.
3.2 Non-goals
- Pengaturan notifikasi per jenis kejadian.
- Notifikasi lewat email atau WhatsApp.
- Menghapus notifikasi yang sudah diterima.
- Membuat notifikasi secara manual dari dalam aplikasi.
4. Business Rules
Aturan bisnis adalah kumpulan ketentuan dan batasan yang berlaku untuk Notifikasi di seluruh aplikasi, pada semua layar dan aksi yang melibatkannya, siapa pun yang melakukannya. Aturan ini menjadi sumber kebenaran tunggal: bila bagian lain di PRD ini tampak berbeda, aturan di sinilah yang berlaku.
- BR-01 Pengguna hanya menerima dan melihat notifikasi miliknya sendiri. Akun tidak aktif atau yang emailnya belum terverifikasi mengikuti pembatasan di Autentikasi.
- BR-02 Setiap notifikasi punya judul, isi, dan tautan tujuan (opsional) berupa alamat halaman di dalam aplikasi yang sudah jadi. Aplikasi hanya mengarahkan pengguna ke tautan itu saat notifikasi dibuka, tanpa daftar pemetaan sendiri. Halaman tujuannya ditentukan dan ditulis di PRD fitur yang memicu notifikasi (section Notifications). Tombol Lihat Detail hanya tersedia bila notifikasi punya tautan. 🚧 Belum: FE + BE
- BR-03 Notifikasi selalu tersimpan di kotak masuk, dan tetap tampil di perangkat walau isinya tidak lengkap. Membuka notifikasi dari kotak masuk atau toast menandainya sudah dibaca, sedangkan membuka dari notifikasi perangkat tidak menandainya.
- BR-04 Ada tiga kanal. Kotak masuk selalu aktif. Notifikasi dalam aplikasi (toast) tidak punya pengaturan: aktif otomatis bila aplikasi berhasil tersambung ke koneksi realtime saat dimuat, dan tidak aktif bila gagal. Notifikasi perangkat aktif bila pengguna menyalakan toggle Notifikasi dan mengizinkannya; pengaturan ini tersimpan per perangkat, bukan per akun. 🚧 Belum: FE
- BR-05 Izin notifikasi perangkat hanya diminta saat pengguna sendiri menyalakan toggle Notifikasi, tidak pernah otomatis.
- BR-06 Satu pengguna bisa punya notifikasi perangkat di banyak perangkat. Notifikasi di sebuah perangkat dihapus saat pengguna logout, perangkatnya dicabut atau login-nya kedaluwarsa, kata sandi diatur ulang atau diganti, atau email login yang diganti diverifikasi.
- BR-07 Selama izin notifikasi browser masih diberikan, aplikasi mendaftarkan ulang notifikasi perangkat setiap kali dibuka, sehingga pengguna tidak perlu menyalakannya lagi setelah terhapus (BR-06).
- BR-08 Setiap kali aplikasi dimuat atau dimuat ulang, aplikasi mencoba tersambung ke koneksi realtime. Bila berhasil, toast aktif; bila gagal, toast tidak aktif tanpa pemberitahuan ke pengguna, dan kotak masuk serta notifikasi perangkat tetap berfungsi. 🚧 Belum: FE
5. Flow
5.1 Main Flowchart
- Notifikasi Dibuat — Kejadian yang relevan bagi pengguna, misalnya PO yang perlu diajukan, memunculkan satu notifikasi yang ditujukan kepadanya (BR-01).
- Tersimpan di Kotak Masuk — Notifikasi selalu tersimpan di kotak masuk, sehingga tetap bisa dibaca meski kanal lain tidak aktif (BR-03).
- Toast Muncul — Bila aplikasi berhasil tersambung ke koneksi realtime dan pengguna sedang membuka aplikasi, notifikasi muncul seketika sebagai toast tanpa memuat ulang halaman (BR-04, BR-08). 🚧 Belum: FE
- Notifikasi Perangkat Muncul — Bila toggle Notifikasi menyala, notifikasi muncul di perangkat meski aplikasi tertutup (BR-04).
- Pilih Cara Membuka — Pengguna membuka notifikasi lewat lonceng atau halaman Notifikasi, atau langsung dari toast atau notifikasi perangkat.
- Baca Detail Notifikasi — Pengguna membaca judul, waktu, dan isi notifikasi di dialog. Tombol Lihat Detail membawa pengguna ke halaman tujuan (BR-02, BR-03).
- Halaman Tujuan — Pengguna langsung sampai di data yang bersangkutan tanpa mencarinya (BR-02).
- Atur Notifikasi — Dari pengaturan di header, pengguna menyalakan atau mematikan toggle Notifikasi untuk perangkat ini. Toast tidak punya pengaturan (BR-04). 🚧 Belum: FE
- Izinkan atau Cabut Izin — Pengguna menyalakan notifikasi dengan memberi izin browser, atau mematikannya untuk menghapus notifikasi di perangkat ini (BR-05, BR-06).
5.2 Status Lifecycle
| Status | Keterangan | Selanjutnya |
|---|---|---|
| Belum Dibaca | Notifikasi belum dibuka dan ditandai menonjol di daftar | Dibaca |
| Dibaca | Notifikasi sudah dibuka dan tidak lagi dihitung sebagai belum dibaca | — |
5.3 Channel Delivery
Informasi tambahan untuk tim Frontend dan Backend. Notifikasi yang sama dikirim ke semua kanal sekaligus; berikut perbedaan cara kerja kedua kanal di luar kotak masuk:
| App Toast Notification | Browser Push Notification | |
|---|---|---|
| WebSocket | Ya | Tidak |
| Cara kerja | Browser membuka koneksi WebSocket yang tetap hidup selama aplikasi terbuka. Server mendorong notifikasi lewat koneksi itu, lalu toast muncul seketika. | Server mengirim ke layanan push milik browser (Chrome, Firefox, Safari, masing-masing punya sendiri). Layanan itu meneruskannya ke perangkat, jadi tetap sampai walau aplikasi tertutup. |
Teknologi backend (retail-api) | Laravel Reverb (server WebSocket), channel broadcast Laravel, channel privat tenant.users.{userId} | laravel-notification-channels/webpush, protokol Web Push dengan kunci VAPID, langganan disimpan di tabel push_subscriptions |
Teknologi frontend (retail-app) | laravel-echo + pusher-js (Reverb memakai protokol Pusher), toast memakai sonner | Service Worker (public/sw.js), Push API (PushManager), dan Notification API untuk izin |
| Pengaturan di pengguna | Tidak ada toggle; aktif otomatis bila koneksi WebSocket berhasil saat aplikasi dimuat (BR-04, BR-08) | Toggle Notifikasi; aktif bila pengguna memberi izin browser (BR-04, BR-05) 🚧 Belum: FE |
| Otorisasi | Endpoint /api/broadcasting/auth | Langganan didaftarkan lewat /api/auth/notifications/subscriptions |
| Bila tidak tersampaikan | Toast tidak muncul saat koneksi terputus; notifikasi tetap ada di kotak masuk | Notifikasi dibuang layanan push bila perangkat tidak terjangkau lebih dari 1 jam; tetap ada di kotak masuk |
Kotak masuk tidak memakai keduanya: notifikasi disimpan di database lalu dibaca lewat API biasa, sehingga selalu tersedia (BR-03).
6. Document Structure
6.1 General
| Field | Tipe | Wajib | Default | Aturan |
|---|---|---|---|---|
| Judul | Teks | — | Disusun dari kejadiannya | Baris pertama notifikasi |
| Isi | Teks | — | Disusun dari kejadiannya | Keterangan notifikasi |
| Waktu Dibuat | Tanggal & Waktu | — | Saat notifikasi dibuat | Ditampilkan relatif, misalnya “5 menit lalu” |
| Waktu Dibaca | Tanggal & Waktu | — | Kosong | Terisi saat notifikasi dibuka (BR-03) |
| Tujuan | Teks | — | Ditentukan dari kejadiannya | Alamat halaman di dalam aplikasi, misalnya /account/linked-devices; kosong bila tidak ada halaman terkait (BR-02) 🚧 Belum: FE + BE |
6.2 Device Notification
| Field | Tipe | Wajib | Default | Aturan |
|---|---|---|---|---|
| Perangkat | Ref. Perangkat | — | Diambil dari login saat notifikasi perangkat dinyalakan | Mengikat notifikasi ke Perangkat Terhubung (BR-06) |
| Data Berlangganan | Teks | Ya | Diberikan browser saat diizinkan | Data teknis dari browser untuk mengirim notifikasi; tidak ditampilkan ke pengguna |
7. UI Structure
Bagian ini mendefinisikan cara Notifikasi ditampilkan dan dioperasikan: lonceng, halaman, dialog detail, dan pengaturan notifikasi. Bagian ini hanya mengatur tampilan dan interaksi; aturan isi dan nilainya tetap mengikuti Document Structure.
7.1 Lonceng
| Bagian | Contoh Nilai | Komponen |
|---|---|---|
| Badge Jumlah | 12, atau 99+ | Badge |
| Tab | Semua, Belum Dibaca | Tabs |
| Daftar | 10 notifikasi terbaru | List Item, dengan ikon modul, judul, dan waktu relatif |
| Tautan Lihat Semua | — | Link ke halaman Notifikasi |
Aksi: Lihat Semua.
7.2 Halaman Notifikasi
| Field | Kontrol | Perilaku |
|---|---|---|
| Tab | Toggle Semua/Belum Dibaca (di header, berupa ikon) | Tetap tersimpan saat halaman dimuat ulang |
| Pencarian | Text Input | Tetap tersimpan saat halaman dimuat ulang; mencari di judul dan isi |
| Daftar | List Item, dimuat bertahap | Tombol Muat Lebih Banyak |
Aksi: Tandai Semua Dibaca, di baris yang sama dengan pencarian.
7.3 Dialog Detail
| Field | Komponen |
|---|---|
| Judul | Text |
| Isi | Text 🚧 Belum: FE |
| Waktu | Text, relatif |
| Aksi Lihat Detail | Button, hanya tampil bila notifikasi punya tautan tujuan (BR-02) |
Aksi: Lihat Detail, Tutup.
7.4 Pengaturan Notifikasi
Tersedia di pengaturan header.
| Field | Kontrol | Perilaku |
|---|---|---|
| Notifikasi | Toggle | Mengatur notifikasi perangkat (push) di perangkat ini; mencerminkan ada atau tidaknya notifikasi perangkat; nonaktif dengan keterangan bila tidak didukung atau izin ditolak (BR-04, BR-05) 🚧 Belum: FE |
Aksi: nyalakan atau matikan toggle. Toast tidak punya toggle (BR-04).
8. User Stories
US-01 - Lonceng notifikasi
Sebagai pengguna, saya ingin melihat notifikasi terbaru dari header, agar cepat tahu ada yang baru.
| ID | Kriteria penerimaan |
|---|---|
| AC-01.1 | Lonceng menampilkan badge jumlah belum dibaca; lebih dari 99 ditampilkan “99+”. |
| AC-01.2 | Popover menampilkan 10 notifikasi terbaru dengan tab Semua dan Belum Dibaca. |
| AC-01.3 | Tautan Lihat Semua membuka halaman Notifikasi; klik item menutup popover dan membuka dialog detail. |
| AC-01.4 | Keadaan kosong: “Belum ada notifikasi” atau “Tidak ada notifikasi yang belum dibaca”. |
| AC-01.5 | Notifikasi muncul bila ada kejadian yang ditujukan ke pengguna (BR-01). Perlu dikonfirmasi: saat ini belum ada modul bisnis yang mengirim notifikasi; satu-satunya pengirim adalah notifikasi percobaan yang hanya ada di lingkungan non-produksi. |
US-02 - Halaman notifikasi
Sebagai pengguna, saya ingin melihat semua notifikasi saya, agar bisa menemukan notifikasi lama.
| ID | Kriteria penerimaan |
|---|---|
| AC-02.1 | Tab Semua dan Belum Dibaca serta kata kunci pencarian tetap tersimpan saat halaman dimuat ulang; pencarian mencocokkan judul dan isi. |
| AC-02.2 | Daftar dimuat bertahap 15 per muatan dengan tombol Muat Lebih Banyak. |
| AC-02.3 | Tombol Tandai Semua Dibaca menandai semua notifikasi pengguna dan memperbarui daftar serta badge (BR-03). |
| AC-02.4 | Notifikasi belum dibaca dibedakan secara visual, dan ikon mengikuti modul (inventory, purchase, settings, atau lonceng bila tidak dikenal). |
US-03 - Detail dan navigasi
Sebagai pengguna, saya ingin membaca notifikasi lengkap dan membuka data terkait.
| ID | Kriteria penerimaan |
|---|---|
| AC-03.1 | Klik item menandainya sudah dibaca bila belum, lalu membuka dialog detail berisi judul, waktu relatif, dan isi (BR-03). |
| AC-03.2 | Tombol Lihat Detail hanya tampil bila notifikasi punya tautan tujuan (BR-02). |
| AC-03.3 | Lihat Detail menutup dialog dan membuka halaman tujuan (BR-02). |
| AC-03.4 | Notifikasi tanpa tautan tujuan — tidak ada tombol Lihat Detail (BR-02). |
| AC-03.5 | Pengguna tidak punya akses ke data tujuan — halaman tujuan membawa pengguna ke halaman tanpa akses. |
| AC-03.6 | Tautan dibuat otomatis dari data notifikasi dan harus berupa alamat halaman yang benar-benar ada di aplikasi (BR-02). Perlu dikonfirmasi: pengiriman uji coba menghasilkan /inventory/product/{id}, sedangkan halaman detail produk saat ini /inventory/products/{id}/detail; aturan pembentukan tautan perlu disamakan dengan rute aplikasi. 🚧 Belum: FE + BE |
US-04 - Notifikasi dalam aplikasi
Sebagai pengguna, saya ingin notifikasi muncul langsung saat aplikasi terbuka.
| ID | Kriteria penerimaan |
|---|---|
| AC-04.1 | Setiap aplikasi dimuat atau dimuat ulang, aplikasi mencoba tersambung ke koneksi realtime; toast tidak punya toggle atau pengaturan (BR-04, BR-08). 🚧 Belum: FE |
| AC-04.2 | Koneksi berhasil — notifikasi baru menampilkan toast yang bisa diklik, dan memperbarui badge serta daftar (BR-04). |
| AC-04.3 | Klik toast menandai notifikasi sudah dibaca dan membuka halaman tujuan (BR-03). |
| AC-04.4 | Koneksi gagal — toast tidak tampil dan tidak ada pemberitahuan ke pengguna; kotak masuk dan notifikasi perangkat tetap berfungsi (BR-03, BR-08). |
US-05 - Notifikasi perangkat
Sebagai pengguna, saya ingin menerima notifikasi walau aplikasi tertutup.
| ID | Kriteria penerimaan |
|---|---|
| AC-05.1 | Toggle Notifikasi mencerminkan ada atau tidaknya notifikasi perangkat di perangkat ini. |
| AC-05.2 | Menyalakan toggle meminta izin perangkat hanya saat pengguna mengkliknya, lalu mendaftarkan notifikasi perangkat (BR-05). |
| AC-05.3 | Mematikan toggle menghapus notifikasi perangkat di perangkat tersebut (BR-06). |
| AC-05.4 | Toggle nonaktif dengan keterangan bila perangkat atau browser tidak mendukung, atau izin ditolak. |
| AC-05.5 | Notifikasi perangkat tetap tampil walau isinya rusak, dengan judul pengganti (BR-03). |
| AC-05.6 | Klik notifikasi perangkat saat aplikasi tertutup — aplikasi terbuka langsung di halaman tujuan, atau di beranda bila notifikasi tidak punya tautan; notifikasi tidak ditandai sudah dibaca (BR-03). |
| AC-05.7 | Klik notifikasi perangkat saat aplikasi terbuka — aplikasi ditampilkan dan membuka halaman tujuan; notifikasi tidak ditandai sudah dibaca (BR-03). |
| AC-05.8 | Pengguna logout di perangkat yang notifikasinya aktif — notifikasi di perangkat itu dihapus, sehingga tidak muncul untuk akun lain (BR-06). |
| AC-05.9 | Notifikasi perangkat terhapus, misalnya setelah kata sandi diganti, tetapi izin browser masih diberikan — saat aplikasi dibuka berikutnya, notifikasi didaftarkan lagi tanpa pengguna menyalakan toggle (BR-07). |
9. User Scenarios
| Role | Scenario |
|---|---|
| Pengguna | Mendapat toast saat notifikasi masuk, mengkliknya, lalu langsung membuka halaman data terkait |
| Pengguna | Menerima notifikasi di ponsel saat aplikasi tertutup |
| Pengguna | Membuka lonceng, melihat 10 notifikasi terbaru, lalu membuka halaman Notifikasi untuk menandai semuanya sudah dibaca |
| Pengguna | Mencari notifikasi lama di halaman Notifikasi dengan filter Belum Dibaca |
| Pengguna | Mematikan toggle Notifikasi di perangkat bersama agar tidak muncul di sana |
| Pengguna | Membuka aplikasi saat koneksi realtime gagal; toast tidak muncul, tetapi notifikasi tetap terbaca di kotak masuk |
10. Permissions & Actions
Fitur ini tidak memiliki permission; semua pengguna yang login hanya mengakses notifikasi miliknya sendiri.
11. Notifications
Notifikasi adalah mesin pengiriman, bukan pemicu. Kejadian yang memicu notifikasi dicatat di section Notifications pada PRD fitur masing-masing.
12. Dependencies
PRD terkait
- Authentication — login dari perangkat baru mengirim notifikasi ke pemilik akun (BR-16 di sana); logout, pengaturan ulang atau penggantian kata sandi, dan verifikasi email login yang diganti menghapus notifikasi perangkat (BR-06). Akun tidak aktif atau belum terverifikasi mengikuti pembatasan di sana (BR-01).
- Linked Devices — notifikasi perangkat terikat ke perangkat yang login, dan dihapus saat perangkat dicabut (BR-06).
- Purchase Order, Goods Receipt, dan modul lain — calon sumber kejadian notifikasi; saat ini belum ada yang mengirim.
Efek ke modul lain
- Fitur yang memicu notifikasi menuliskan halaman tujuannya di section Notifications pada PRD-nya sendiri; PRD ini tidak menyimpan daftar tujuan.