DeogratiasNiyitanga/Rwanda-Administrative-Location-Plugin

# Rwanda Administrative Location Selector — Joget DX 8 Plugin A custom form element that lets users select Rwanda administrative locations in a cascading hierarchy: **Province → District → Sector → Cell → Village**. Each level is stored in its own database column and is fully configurable. --- ## Table of Contents 1. What it Does 2. Installation 3. Adding the Element to a Form 4. Configuration Reference - Basic Settings - Interaction Mode - Stop Selection At - Kinyarwanda Names - Validation (Required Fields) - Sub-level DB Column IDs 5. Database Columns 6. Using Location Data in List Builder & Filters 7. Validation Behaviour 8. For Developers — Modifying the Plugin - Project Structure - Key Files - Build - Updating the Location Data - How the Plugin Works Internally --- ## What it Does - Renders cascading dropdown menus (Province through Village) inside a Joget form. - Each level is only populated after the parent level is selected. - Saves each level to a **separate DB column** so data can be filtered, reported on, and displayed individually. - Supports optional **Kinyarwanda province display names** (the stored value matches the display language). - Validates required levels with per-field messages and inline error display. - Works in both **standard** (all dropdowns visible) and **stepped** (one level revealed at a time) interaction modes. - Compatible with Joget **List Builder** and **filter palettes** — all sub-level columns appear as searchable fields. --- ## Installation 1. Build the JAR (or obtain the pre-built one): ``` target/Rwanda-Administrative-Locations-1.0.0.jar ``` 2. In Joget DX 8, go to **Admin Panel → Manage Plugins → Upload Plugin**. 3. Upload the JAR file and click **Upload**. 4. The plugin appears in the Form Builder palette under **Custom Fields → Rwanda Administrative Location Selector**. --- ## Adding the Element to a Form 1. Open your app in the Joget App Center. 2. Navigate to **Design → Forms** and open (or create) a form …