Documentation
Batches
Batches defines named operational learner groups such as enrichment batches, club batches, coaching batches, or program-linked delivery batches within an institution. This page documents purpose, navigation, screens, fields, actions, valuesets, lookups, validations, date handling, and examples using the locked AkshaEDU header-only standard.
Purpose
Batches is used to define named operational groups such as enrichment batches, club batches, coaching batches, remedial batches, or other focused learner groups that may run under an institution, campus, program, course, or shift.
This feature belongs to AkshaEDU Setup > Academic Setup and follows the standard Education header-only pattern with list page, create/edit page, summary panel, date fields, controlled status, and lookup-driven academic dependencies.
Business Purpose
Use Batches when an institution needs an additional operational grouping beyond the basic class and section structure. A batch can represent an Olympiad prep group, robotics club, coaching batch, enrichment stream, practical batch, or similar focused learner cohort.
Batches can optionally be linked with campus, program, course, shift, and batch type so institutions can model both academic and non-academic delivery groups without overloading the class structure.
- Creates named learner groups used for focused delivery, enrichment, coaching, or club activities.
- Supports optional linkage to campus, program, course, and shift.
- Stores batch mode, batch type, capacity, and operating date range.
- Acts as a dependency for learner grouping, scheduling, attendance, and targeted operational planning where batch-level tracking is needed.
Screen Overview
Available screens
| Screen | Purpose | Notes |
|---|---|---|
| List Page | Displays batch records with search, export, pagination, and row actions. | Visible columns include Batch Code, Batch Name, Institution, Campus, Program, Course, and Batch Type. |
| Create / Edit Page | Allows users to create or update a single batch record. | Uses the standard Education ResponsiveContainer + ContextPanel layout with Save, Close, and action menu support. |
| Summary Panel | Shows a quick summary of the current record on the right side. | Displays Institution, Campus, Program, Course, Batch Type, Shift, Batch Mode, Capacity, and Status. |
Screenshots
Batches is best explained using three visuals shown one below another so the operational grouping fields, date range, and summary behavior remain readable.
List view showing search, export, visible columns, create/delete actions, pagination, and batch examples such as Olympiad Prep and Robotics Club.
Blank create screen showing Institution, Batch Code, Batch Name, Campus, Course, Shift, End Date, Batch Mode, Program, Batch Type, Capacity, Start Date, Status, and the summary panel.
Filled example showing Olympiad Prep linked to Horizon Public School Warangal, HPS Warangal Main Campus, Secondary School Programme, Enrichment Batch, Regular Day Shift, batch mode AFTER_SCHOOL, capacity 45, and an operating end date.
Functional Behavior
- Supports create, update, list, search, export, and list-level delete actions in the UI.
- Save commits the record and returns to the list page.
- Apply saves and stays on the same page when supported through the page action menu.
- Close returns to the list page without continuing edits.
- Batch Code is typically editable on create and locked in edit mode, aligned with the Education code-field pattern.
- Institution should generally be selected first so dependent lookups such as Campus, Program, Course, Shift, and Batch Type can be filtered correctly.
- Start Date and End Date together define the operating window of the batch when date tracking is used.
Batch header fields
| UI Label | Technical Field | Type | Mandatory | Value Set / LOV | Description | Rules / Notes | Example |
|---|---|---|---|---|---|---|---|
| Institution | institution_id | Autocomplete / LOV | Yes | Institution LOV | Institution that owns the batch record. | Required parent lookup. | Horizon Public School Warangal |
| Batch Code | batch_code | Text | Yes | None | Unique identifying code for the batch. | Required. Typically locked in edit mode as per Education code-field pattern. | HPS_WARANG_OLYMPIAD |
| Batch Name | batch_name | Text | Yes | None | Business name of the batch. | Required. | Olympiad Prep |
| Campus | campus_id | Autocomplete / LOV | No | Campus LOV | Optional campus under which the batch is managed. | Usually filtered by institution selection. | HPS Warangal Main Campus |
| Course | course_id | Autocomplete / LOV | No | Course LOV | Optional course associated with the batch. | Useful where the batch is tied to a specific curriculum or course. | |
| Shift | shift_id | Autocomplete / LOV | No | Shift LOV | Optional shift assigned to the batch. | Useful for day, after-school, evening, or similar operating models. | Regular Day Shift |
| End Date | end_date | Date | No | None | Optional end date of the batch. | Should normally be later than Start Date when both dates are entered. | 20-03-2026 |
| Batch Mode | batch_mode | Dropdown | No / implementation dependent | Controlled batch-mode value set | Operational mode in which the batch runs. | Shown as a dropdown in the UI. Example visible in the summary is AFTER_SCHOOL. | AFTER_SCHOOL |
| Program | program_id | Autocomplete / LOV | No | Program LOV | Optional program to which the batch belongs. | Usually filtered by institution or campus context. | Secondary School Programme |
| Batch Type | batch_type_id | Autocomplete / LOV | No | Batch Type LOV | Optional classification of the batch. | Lookup field visible with search icon in the UI. | Enrichment Batch |
| Capacity | capacity | Number | No | None | Planned learner capacity of the batch. | Used for operational planning and allocation. | 45 |
| Start Date | start_date | Date | No | None | Optional start date of the batch. | Use with End Date when date-bounded delivery is needed. | 10-07-2025 |
| Status | status | Dropdown | Yes | EDU_STATUS | Current business status of the batch. | Controlled valueset field. | ACTIVE |
Page actions
| Action | Purpose | Available On | Validation | Outcome |
|---|---|---|---|---|
| Create | Opens create mode for a new batch record. | List page | None before opening. | User can enter a new batch. |
| Save | Saves the current batch and returns to the list page. | Create / Edit page | Mandatory fields must pass validation. | Batch is created or updated. |
| Apply | Saves the current batch and remains on the same page when supported. | Create / Edit page action menu | Same validation as Save. | Batch is saved without leaving the page. |
| Close | Closes the page and returns to the list. | Create / Edit page | None. | User returns to the list page. |
| Export | Exports list data. | List page | Depends on current list contents. | Export output is produced. |
| Delete | Delete action exists in the list UI. | List page | Depends on dependency rules and implementation behavior. | Selected records may be removed where allowed. |
| Search | Filters visible list rows. | List page | None. | Matching rows remain visible. |
Controlled values
| Field | Value Set Code | Allowed Values / Examples | Notes |
|---|---|---|---|
| Status | EDU_STATUS | ACTIVE, INACTIVE | Used on the batch header and summary display. |
| Batch Mode | Controlled batch-mode value set | Example visible in the UI: AFTER_SCHOOL; other approved values may represent regular, weekend, enrichment, or institution-specific operating modes. | Use the implementation-approved batch-mode valueset rather than free text. |
| Operational grouping controls | Institution-specific batch configuration | Values depend on the institution's academic and co-curricular model. | Keep public documentation at a business level and avoid exposing internal configuration mechanics. |
Reference data and lookups
| Field | Source | Usage |
|---|---|---|
| Institution | Institutions | Used to select the parent institution for the batch. |
| Campus | Campuses | Used where batches are campus specific. |
| Program | Programs | Used to associate the batch with a program or larger academic offering. |
| Course | Courses | Used where the batch is linked to a particular course or curriculum stream. |
| Shift | Shifts | Used when the batch operates in a specific shift. |
| Batch Type | Batch Types | Used to classify the batch such as enrichment, club, remedial, or similar grouping. |
Status values
| Status | Meaning | Notes |
|---|---|---|
| ACTIVE | Batch is available for normal academic or operational use. | Visible as the active state in the screenshots. |
| INACTIVE | Batch exists but is not available for normal operational use. | Useful for retired or historical learner groups. |
- Institution, Batch Code, and Batch Name are treated as core mandatory fields.
- Campus, Program, Course, Shift, and Batch Type are lookup-driven fields and may be optional depending on the institution model.
- Batch Mode should be selected from a controlled value list rather than entered as free text.
- Capacity should be numeric and aligned with the institution's operational planning rules.
- Batch Code should remain unique within the applicable institution or campus scope defined by the implementation.
- If Start Date and End Date are both entered, End Date should be later than Start Date.
- Institution should generally be selected before dependent lookups such as Campus, Program, Course, Shift, and Batch Type.
- Batches should be created before learner allocation, focused scheduling, attendance capture, or batch-level operational reporting depends on them.
Public operational notes
| Item | Value |
|---|---|
| Feature Type | Header Only |
| Primary Scope | Institution-level batch master with optional campus, program, course, shift, and batch-type alignment |
| Primary Dependencies | Institution, optional Campus, optional Program, optional Course, optional Shift, optional Batch Type |
| Used Before | Learner grouping, enrichment scheduling, attendance, targeted communication, and batch-level reporting |
| Public Documentation Note | This public page explains user-facing behavior only and does not expose internal implementation details. |
Example Record
Sample batch
| Field | Example Value |
|---|---|
| Batch Code | HPS_WARANG_OLYMPIAD |
| Batch Name | Olympiad Prep |
| Institution | Horizon Public School Warangal |
| Campus | HPS Warangal Main Campus |
| Program | Secondary School Programme |
| Course | |
| Batch Type | Enrichment Batch |
| Shift | Regular Day Shift |
| Batch Mode | AFTER_SCHOOL |
| Capacity | 45 |
| Start Date | 10-07-2025 |
| End Date | 20-03-2026 |
| Status | ACTIVE |