New Payments Dashboard
Developer Documentation for Payments Dashboard
Introduction
This document serves as a comprehensive guide for developers tasked with creating the new payments dashboard for the CampX platform. The dashboard is designed to provide a detailed overview of financial transactions within the educational institution, with a focus on user-friendly interfaces and data accuracy. Its primary goal is to offer administrators and financial departments a centralized, intuitive, and detailed view of all payment-related activities.
Navigating to the Feature
To begin development, ensure you are working within the CampX environment. The payments dashboard will be accessible through the main CampX portal, under the Bird's Eye view dashboards. It should be prominently featured for easy access by users with the necessary permissions.
Viewing and Using the Feature
Payments Overview Cards
- Purpose: To display a summary of payments for a selected academic year.
- Components:
- Selection for Academic Year at the top of the dashboard.
- Cards displaying Total Payments, Total Received (with number and percentage), Total Due (with number and percentage), Concession Offered, and Scholarship Amount.
Monthly Payment Trends
- Purpose: To show payment trends over months.
- Features:
- Filters for degree and program to refine data.
- Graphical representation of monthly payment trends.
Fee Group Wise Payments Due Table
- Purpose: To provide detailed insights into payments due by fee category.
- Structure:
- A table format showing payments due for each batch/year in the selected academic year.
- Categories like Academic, Hostel, etc., will be included.
Student Summary Table
- Purpose: To offer a snapshot of student payment status.
- Details:
- Columns for Total Payments, Paid, Partially Paid, and Not Paid.
- Segregation between Regular and Scholarship students.
Department Wise Payments
- Purpose: To visualize payment data across departments.
- Visualization:
- A bar graph showing payments in numbers and percentages.
- Differentiation between regular and scholarship payments.
Adding or Modifying Elements
While developing the dashboard, ensure the following:
- Scalability to add or remove payment categories.
- Flexibility in the data representation (graphs, tables).
- User-friendly interface for modifying filters or settings.
Purpose and Integration
This dashboard is a key component in the broader CampX ecosystem, integrating with other modules like admissions, student profiles, and academic management. It enhances the financial management capabilities of the platform, ensuring efficient and transparent handling of payment processes.
User-Friendly Language
Maintain clear, concise, and technical language appropriate for a developer audience. Ensure all instructions are straightforward, avoiding ambiguity to facilitate smooth development and implementation.
This documentation should serve as a foundational guide for developers, emphasizing clarity, functionality, and integration within the CampX framework.