0% found this document useful (0 votes)
13 views2 pages

Feature Addition

The document outlines the addition of an Entity History Tracking feature for the Hindustan Olympiad website, aimed at providing an audit trail for changes made to key entities like schools and students. It details the necessary backend and frontend changes, including API modifications and UI enhancements, along with the benefits of increased transparency and accountability. The implementation is estimated to cost ₹30,000 and will take approximately 3–5 days to complete.

Uploaded by

Vaibhav Khating
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
13 views2 pages

Feature Addition

The document outlines the addition of an Entity History Tracking feature for the Hindustan Olympiad website, aimed at providing an audit trail for changes made to key entities like schools and students. It details the necessary backend and frontend changes, including API modifications and UI enhancements, along with the benefits of increased transparency and accountability. The implementation is estimated to cost ₹30,000 and will take approximately 3–5 days to complete.

Uploaded by

Vaibhav Khating
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

Feature Addition: Entity History Tracking for Hindustan

Olympiad website
As part of the ongoing development for the Hindustan Olympiad dashboard, a new requirement has
been introduced: Entity History Tracking. This feature aims to provide a detailed audit trail for key
entities such as schools and students — capturing who made changes, what was changed, and when
those changes occurred.

Implementation Plan

1. Backend/API Changes

To support this feature:

• All existing API calls that update or confirm entities (e.g., editSchool, confirmPayment,
updateStudent, etc.) will be modified to log history data.

• Each relevant API will now:


o Identify the user performing the action.
o Capture the timestamp of the action.
o Log what type of action was performed (e.g., "Edited School Name", "Confirmed
Payment").
o Save the previous and new values (where applicable).

This data will be stored in a new entity_history collection/table with the following structure:

"entityType": "school" | "student",

"entityId": "123",

"action": "Edited School Name",

"performedBy": "admin@example.com",

"timestamp": "2025-07-03T18:00:00Z",

"details": {

"previous": { "schoolName": "ABC Public" },

"updated": { "schoolName": "ABC Public Sr. Sec." }

2. Frontend/UI Changes

• On the School List and Student List pages, an eye or clock icon will be added beside each
row.

• Clicking this icon will open a modal that shows a detailed chronological history of changes
for that entity.
3. Benefits

• Enhanced transparency and accountability for data changes.

• Quick access for admins to track activities.

• Helpful for debugging or manual verification.

Costing

For implementing this complete Entity History feature, including backend logging, API modifications,
frontend modal integration, and UI enhancements the total cost will be ₹30,000.

Timeline
This feature will take approximately 3–5 days to implement.

You might also like