User Guide & Documentation
System Overview System အကျဉ်းချုပ်
The BMR Platform is a membership management system built with Django. It handles the full lifecycle of a membership application — from initial registration through to an active member status.
Key capabilities:
- Dynamic role-based access control (RBAC)
- Configurable membership workflow (statuses, transitions, notifications)
- Integrated payment processing via HitPay QR
- Full audit trail for every status change
BMR Platform သည် Django ဖြင့် တည်ဆောက်ထားသော membership management system တစ်ခုဖြစ်သည်။ Membership application ၏ registration မှ active member အဖြစ် ရောက်ရှိသည်အထိ lifecycle တစ်ခုလုံးကို ကိုင်တွယ်သည်။
အဓိက လုပ်ဆောင်ချက်များ:
- Dynamic role-based access control (RBAC)
- ပြောင်းလဲနိုင်သော membership workflow (status, transition, notification)
- HitPay QR ဖြင့် ငွေပေးချေမှု ပေါင်းစပ်ထားခြင်း
- Status ပြောင်းလဲမှုတိုင်း audit trail မှတ်တမ်းတင်ခြင်း
/management/ — accessible only to non-member roles.
Management Portal URL: /management/ — member မဟုတ်သော role များသာ ဝင်ရောက်နိုင်သည်။
Roles & Permissions Role နှင့် Permission
Built-in Roles
Five system roles ship with the platform. They cannot be deleted but can have their permissions adjusted.
Built-in Role များ
Platform တွင် system role ၅ ခု ပါဝင်သည်။ ဤ role များကို ဖျက်၍မရသော်လည်း permission များကို ပြင်ဆင်နိုင်သည်။
| Role | Typical Use | အသုံးပြုမှု | Portal Access | Portal ဝင်ရောက်မှု |
|---|---|---|---|---|
admin |
Full system access, configure everything | System အပြည့်အဝ ထိန်းချုပ်မှု | Management + Admin Panel | |
management |
Review applications, manage members | Application စစ်ဆေးခြင်း၊ member စီမံခြင်း | Management Portal | |
finance |
Review and approve payments | Payment စစ်ဆေးခြင်းနှင့် အတည်ပြုခြင်း | Management Portal | |
staff |
View-only access to members and payments | Member/Payment ကြည့်ရှုခွင့်သာ | Management Portal | |
member |
Apply for membership, track own application | Membership လျှောက်ထားခြင်း | Member Dashboard only |
Assigning Permissions to Roles
- 1Go to Administration → Permissions in the sidebar.
- 2The Permission Matrix tab shows all permissions grouped by category, with a toggle slider per role.
- 3Toggle individual permissions, or use the category checkbox at the left to grant/revoke all permissions in a group at once.
- 4Changes take effect on the user's next request (no cache to clear).
Creating Custom Roles
Go to Administration → Permissions → Roles tab. Click New role, enter a label — a code (capital letters, numbers and underscores) is suggested for you.
Role များတွင် Permission သတ်မှတ်ခြင်း
- 1Sidebar မှ Administration → Permissions သို့ သွားပါ။
- 2Permission Matrix tab တွင် permission အားလုံးကို category အလိုက် ပြသပြီး role တစ်ခုချင်းစီအတွက် toggle slider ရှိသည်။
- 3Permission တစ်ခုချင်းစီ toggle လုပ်နိုင်သည်၊ သို့မဟုတ် category ၏ checkbox ကို နှိပ်ခြင်းဖြင့် category တစ်ခုလုံးကို တစ်ကြိမ်တည်း grant/revoke လုပ်နိုင်သည်။
- 4ပြောင်းလဲမှုများသည် user ၏ နောက်တစ်ကြိမ် request တွင် ချက်ချင်း အကျိုးသက်ရောက်သည်။
Custom Role ဖန်တီးခြင်း
Administration → Permissions → Roles tab သို့ သွားပါ။ New role ကို နှိပ်ပြီး code (capital letters၊ numbers၊ underscore) နှင့် display label ထည့်ပါ။
Review Member Applications Membership Application စစ်ဆေးခြင်း
Navigate to Members → Applications. Applications in Pending Review status require attention.
Actions Available
- Approve Info: Moves application to Pending Payment. The system locks in the calculated fee.
- Request Revision: Moves to Revise Application. A note field is required to explain what needs fixing.
- Reject: Moves to Rejected (terminal — no further changes).
member.review_application — ensure your role has this in the Permission Matrix.
Members → Applications သို့ သွားပါ။ Pending Review status ရှိသော application များကို စစ်ဆေးရန် လိုသည်။
ဆောင်ရွက်နိုင်သော Action များ
- Approve Info: Application ကို Pending Payment သို့ ပြောင်းသည်။ System မှ fee ကို lock in လုပ်သည်။
- Request Revision: Revise Application သို့ ပြောင်းသည်။ ဘာပြင်ရမည်ကို ရှင်းပြရန် note field လိုအပ်သည်။
- Reject: Rejected သို့ ပြောင်းသည် (terminal — နောက်ထပ် ပြောင်းလဲ၍မရ)။
member.review_application — Permission Matrix တွင် သင်၏ role မှာ ဤ permission ရှိမရှိ စစ်ဆေးပါ။
Review Payments Payment စစ်ဆေးခြင်း
Navigate to Membership → Payments. Applications showing Pending Payment Approval have submitted a payment receipt.
Actions Available
- Approve Payment: Moves application to Active. Member is now fully registered.
- Reject / Request Resubmission: Moves back to Pending Payment. Member must resubmit.
payment.approve — typically assigned to finance and admin roles.
Membership → Payments သို့ သွားပါ။ Pending Payment Approval ပြနေသော application များသည် payment receipt တင်ထားပြီးဖြစ်သည်။
ဆောင်ရွက်နိုင်သော Action များ
- Approve Payment: Application ကို Active သို့ ပြောင်းသည်။ Member အပြည့်အဝ registered ဖြစ်သွားသည်။
- Reject / Request Resubmission: Pending Payment သို့ ပြန်ပြောင်းသည်။ Member မှ ပြန်လည် submit လုပ်ရမည်။
payment.approve — ပုံမှန်အားဖြင့် finance နှင့် admin role တွင် ရှိသည်။
Workflow Setup Workflow Setup
Navigate to Administration → Workflow setup. This page has four tabs:
Statuses tab
Lists all statuses for the selected scope. Each status has an internal label (staff see this) and an external label (member sees this). You can add new statuses, change colors, and toggle visibility to members.
Transitions tab
Defines which status moves are legal and who can trigger them:
- From Status → To Status: leave From blank to allow from any status.
- Trigger: Member (applicant), Staff, System (automatic), or Payment Callback.
- Access: Link a Permission (strict), or list Role names (fallback).
Notifications tab
Attach email/in-app notification rules to a transition. Multiple rules per transition are supported.
Template variables available in subject/body: {applicant_name}, {reference_number}, {status_label}, {note}
Stages tab
Configures which staff roles are responsible for each review step. Used for dashboard routing and task queues. Changes take effect within 5 minutes.
Administration → Workflow setup သို့ သွားပါ။ ဤ page တွင် tab လေးခု ရှိသည်:
Statuses tab
ရွေးချယ်ထားသော scope ၏ status များအားလုံးကို ပြသည်။ Status တစ်ခုစီတွင် internal label (staff မြင်သည်) နှင့် external label (member မြင်သည်) ရှိသည်။ Status အသစ်ထည့်ခြင်း၊ color ပြောင်းခြင်း၊ member မြင်ရမရ toggle လုပ်ခြင်း ပြုနိုင်သည်။
Transitions tab
ဘယ် status ပြောင်းလဲမှု legal ဖြစ်သည်နှင့် ဘယ်သူ trigger လုပ်နိုင်သည်ကို သတ်မှတ်သည်:
- From → To: From ကို blank ထားပါက မည်သည့် status မှမဆို ပြောင်း၍ ရသည်။
- Trigger: Member၊ Staff၊ System (automatic)၊ Payment Callback
- Access: Permission (တင်းကျပ်) သို့မဟုတ် Role list (fallback)
Notifications tab
Transition တစ်ခုတွင် email/in-app notification rule များ ချိတ်ဆက်နိုင်သည်။ Transition တစ်ခုတွင် rule များစွာ ထည့်နိုင်သည်။
Subject/body တွင် သုံးနိုင်သော variable များ: {applicant_name}, {reference_number}, {status_label}, {note}
Stages tab
Review step တစ်ခုစီကို ဘယ် staff role တွေ တာဝန်ယူသည်ကို သတ်မှတ်သည်။ Dashboard routing နှင့် task queue များအတွက် အသုံးပြုသည်။ ပြောင်းလဲမှု ၅ မိနစ်အတွင်း အကျိုးသက်ရောက်သည်။
Permission Matrix Permission Matrix
Navigate to Administration → Permissions. The matrix shows every permission grouped by category, with an on/off switch per role.
- Green toggle = role has this permission
- Red toggle = role does not have this permission
- Category checkbox = grant or revoke all permissions in the group at once. Shows orange when partially assigned.
The Roles tab lets you create, rename, reorder, and delete custom roles. System roles cannot be deleted.
Administration → Permissions သို့ သွားပါ။ Matrix တွင် permission အားလုံးကို category အလိုက် ပြုစုပြီး role တစ်ခုစီအတွက် on/off switch ရှိသည်။
- Green toggle = role တွင် ဤ permission ရှိသည်
- Red toggle = role တွင် ဤ permission မရှိ
- Category checkbox = group တစ်ခုလုံးကို တစ်ကြိမ်တည်း grant/revoke လုပ်သည်။ တစ်ဝက်သာ assign ဖြစ်နေပါက orange ပြသည်။
Roles tab တွင် custom role များ ဖန်တီးခြင်း၊ အမည်ပြောင်းခြင်း၊ အစဉ်ပြောင်းခြင်းနှင့် ဖျက်ခြင်း ပြုနိုင်သည်။ System role များကို ဖျက်၍မရ။
Register & Login စာရင်းသွင်းခြင်းနှင့် Login
- 1Visit the platform homepage and click Create Account.
- 2Enter your email address and set a password, or click Sign in with Google to use your Google account.
- 3After logging in you will be taken to your Member Dashboard.
- 1Platform homepage သို့ ဝင်ပြီး Create Account ကို နှိပ်ပါ။
- 2Email address ထည့်ပြီး password သတ်မှတ်ပါ၊ သို့မဟုတ် Sign in with Google ကို နှိပ်ပါ။
- 3Login ဝင်ပြီးနောက် Member Dashboard သို့ ရောက်ရှိမည်။
Apply for Membership Membership လျှောက်ထားခြင်း
- 1Personal Details: Fill in your full name, date of birth, gender, citizenship, and contact details.
- 2Residential Status: Your membership type (Ordinary or Associate) is determined automatically based on your residential status. Singaporean Citizens and PRs qualify for Ordinary membership.
- 3Education & Work: Fill in your highest education level, institution, occupation, and employer.
- 4Review & Submit: Check all details and click Submit Application. You cannot edit after submission.
- 1ကိုယ်ရေးအချက်အလက်: နာမည်၊ မွေးသက္ကရာဇ်၊ ကျားမ၊ နိုင်ငံသား၊ ဆက်သွယ်ရေး အချက်အလက်များ ဖြည့်ပါ။
- 2နေထိုင်ခွင့် Status: Membership type (Ordinary / Associate) သည် နေထိုင်ခွင့် status ပေါ်မူတည်၍ အလိုအလျောက် သတ်မှတ်သည်။ Singapore နိုင်ငံသားနှင့် PR များ Ordinary membership ရပိုင်ခွင့်ရှိသည်။
- 3ပညာရေးနှင့် အလုပ်: ပညာအရည်အချင်း၊ ကျောင်း/တက္ကသိုလ်၊ အလုပ်အကိုင်နှင့် လုပ်ငန်းရှင် အချက်အလက်များ ဖြည့်ပါ။
- 4စစ်ဆေးပြီး Submit: အချက်အလက်များ စစ်ဆေးပြီး Submit Application နှိပ်ပါ။ Submit ပြီးနောက် ပြင်ဆင်၍မရ။
Understanding Your Application Status Application Status နားလည်ခြင်း
| Status | Status | What it means | အဓိပ္ပာယ် | Action needed? | လုပ်ဆောင်ရမည်? |
|---|---|---|---|---|---|
| Draft | Your application is saved but not yet submitted. | Application သိမ်းဆည်းထားသော်လည်း မတင်ပြသေး။ | Complete and submit the form. | Form ပြည့်စုံစေပြီး Submit လုပ်ပါ။ | |
| Pending Review | Staff are reviewing your application. | Staff မှ application စစ်ဆေးနေသည်။ | Wait for staff response. | Staff ၏ ပြန်ကြားချက် စောင့်ပါ။ | |
| Revise Application | Staff need corrections. Check the note from staff. | Staff မှ ပြင်ဆင်ရန် လိုအပ်သည်ဟု ဆုံးဖြတ်သည်။ Staff ၏ note ကြည့်ပါ။ | Make corrections and resubmit. | ပြင်ဆင်ပြီး ပြန်တင်ပါ။ | |
| Pending Payment | Application approved. Please submit your payment. | Application အတည်ပြုပြီ။ ငွေပေးချေမှု တင်သွင်းပါ။ | Submit payment. | Payment တင်ပါ။ | |
| Pending Payment Approval | Payment receipt received. Finance team is reviewing. | Payment receipt လက်ခံပြီ။ Finance team စစ်ဆေးနေသည်။ | Wait for approval. | အတည်ပြုချက် စောင့်ပါ။ | |
| Active | You are a registered member. | သင်သည် registered member ဖြစ်ပြီ။ | No action needed. | လုပ်ဆောင်ရန် မလိုအပ်ပါ။ | |
| Rejected | Application was declined. Contact the office for details. | Application ငြင်းဆိုခံရသည်။ အသေးစိတ်အတွက် ရုံးနှင့် ဆက်သွယ်ပါ။ | Contact office. | ရုံးနှင့် ဆက်သွယ်ပါ။ |
Submit Payment ငွေပေးချေခြင်း
- 1When your status shows Pending Payment, go to Dashboard → My Membership.
- 2The membership fee is shown. Click Pay Now to generate a HitPay QR code.
- 3Scan the QR code with your banking app and complete the payment.
- 4Your status will automatically update to Pending Payment Approval once the payment is confirmed by HitPay.
- 1Status တွင် Pending Payment ပြနေပါက Dashboard → My Membership သို့ သွားပါ။
- 2Membership fee ပမာဏ ပြသသည်။ Pay Now နှိပ်ပါ — HitPay QR code ထွက်ပေါ်လာမည်။
- 3Banking app ဖြင့် QR code scan ပြုလုပ်ပြီး ငွေပေးချေပါ။
- 4HitPay မှ payment အတည်ပြုပြီးနောက် status အလိုအလျောက် Pending Payment Approval သို့ ပြောင်းမည်။
Frequently Asked Questions မေးလေ့ရှိသော မေးခွန်းများ
Architecture Overview
Key Models
core.Permission
Every gated action. Convention: resource.action (e.g. member.approve, payment.view_reports). Seeded via seed_permissions management command.
core.Role + core.RolePermission
Dynamic roles stored in DB. RolePermission is the M2M join. User.has_role_permission(codename) checks this table with a per-request frozenset cache.
core.Status
Universal status store. Scoped by scope field (membership, payment, …). Each status has dual labels: internal_label (staff) and external_label (member).
core.WorkflowTransition + core.TransitionNotification
State machine engine. WorkflowTransition defines valid A→B moves. TransitionNotification attaches email/in-app rules to each transition.
members.MembershipApplication
status = ForeignKey(Status, limit_choices_to={'scope':'membership'}). Every status change must go through a valid WorkflowTransition. The save() method auto-sets draft status if none provided.
API Reference
Base URL: /api/v1/ — all endpoints require Authorization: Bearer <access_token>
Auth
| POST | /auth/login/ | Email/password login. Returns access, refresh, user object with permissions list. |
| POST | /auth/token/refresh/ | Refresh access token. |
| POST | /auth/logout/ | Blacklist refresh token. |
Statuses / Workflow
| GET | /statuses/?scope=membership | List statuses for a scope. |
| POST | /statuses/ | Create a status. |
| PATCH | /statuses/<id>/ | Update a status. |
| DELETE | /statuses/<id>/ | Delete non-system status. |
| GET | /transitions/?scope=membership | List transitions. |
| POST | /transitions/ | Create a transition. |
| GET | /notifications/?transition=<id> | List notification rules. |
| POST | /notifications/ | Create a notification rule. |
Permissions & Roles
| GET | /permissions/matrix/ | Full permission matrix (all roles × permissions). |
| POST | /permissions/toggle/ | Toggle single permission for a role. |
| POST | /permissions/batch-toggle/ | Grant/revoke all permissions in a category for a role. |
| GET | /roles/ | List all roles. |
| POST | /roles/ | Create a custom role. |
| PATCH | /roles/<name>/ | Update role label/order. |
| DELETE | /roles/<name>/ | Delete non-system role (if no users assigned). |
Permission System
Protecting a view
Checking in code
Adding a new permission
Workflow Engine
Triggering a transition in code
Adding a new scope (e.g. invoices)
Migrations
python manage.py migrate && python manage.py seed_permissions — this sets up all tables, system roles, and default permissions.