Introduction
This document describes requirements related to "Monitor Contribution Status" of Textbooks in a Program. This is one of the steps of "Programs driven Content sourcing". Following diagram depicts L1 and L2 flows of the overall program driven content sourcing flow.
https://miro.com/app/board/o9J_ky31DBw=/?moveToWidget=3074457347090026750
This is required to support this at scale for use in ETB
JTBD
- Jobs To Be Done: As a Program Admin, I want to monitor the status of content contribution to the textbooks in the scope of the Program
- User Personas: The logged-in users who have State Admin role, Report Viewer role, Book Creator role, Book Reviewer role can access this report.
- System or Environment: Works on for desktops with Chrome browser only.
Requirement Specifications
Two reports defined below will help tracking the progress of content contribution for a specific Program scope.
Key Points applicable to all reports:
- Reports will include the latest information about all the Textbooks in the current scope of the Program.
- Provide the ‘As On’ status with aggregated information on specific attributes.
- If a Textbook has a live and a draft/review version, Program will always include only the Draft/Review version. This can happen when a published textbook is revised and the revised version is still not published. The reports need to show only the Draft/Review version of that Textbook.
- All Reports detailed in following sections are extensions to the existing ETB Creation Reports that are showing up in portal dashboards page. All columns from existing ETB Creation Report should have the same functionality.
- Additional Columns are related to the number of contents categorized across the Content Types. These are the Content Types configured in the Program
- Each of the Report is downloaded as a CSV file with the given columns.
- This report should be updated on a real-time basis.
Reports Page
All the Reports and Graphs are accessed from "Reports" page of a Program. It is accessible by Program Admin, Textbook Creators and Textbook Reviewers.
Reports Page displays Graphs and following options: "Download Summary Report" and "Download Detailed Reports".
Clicking on "Download Summary Report", downloads Summary Report as CSV
Clicking on "Download Detailed Report", downloads Detailed Report as CSV
Wire-frames
Summary Report
Explanation Resource | Experiential Resource | Practice Question Set | Lesson Plan | Learning Outcome | Focus Spot | |||||||||||||||||||||||||
Text Book Id | Medium | Grade | Subject | Text Book Name | Textbook Status | Created On | Last Updated On | Total content linked | Total QR codes linked to content | Total QR Codes with no linked content | Total number of leaf nodes | Number of leaf nodes with no content | Live | Review | Draft | Live | Review | Draft | Live | Review | Draft | Live | Review | Draft | Live | Review | Draft | Live | Review | Draft |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
- The report will include all the Textbooks which are in the specific Program scope
- Each Row of this report will be one Textbook
- Textbooks are sorted by Medium, Grade, Subject, Textbook Name (in that order).
- Name of the downloaded CSV file is <<uniqueid>>_<<program name>>_Summary
Detailed Report
Explanation Resource | Experiential Resource | Practice Question Set | Lesson Plan | Learning Outcome | Focus Spot | |||||||||||||||||||||||||
Text Book Id | Medium | Grade | Subject | Textbook Name | Textbook Status | Type of Node | Level 1 Name | Level 2 Name | Level 3 Name | Level 4 Name | QR Code | Number of contents | Live | Review | Draft | Live | Review | Draft | Live | Review | Draft | Live | Review | Draft | Live | Review | Draft | Live | Review | Draft |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
- The report will include all the Textbooks which are in the specific Program scope
- Each Row of this report will be one Node in the Textbook. This will be same as in current detailed report of ETB Creation Status Report
- All the Textbooks are sorted by Medium, Grade, Subject, Textbook name, Textbook chapter index level (in that order).
- Name of the downloaded CSV file is <<uniqueid>>_<<program name>>_Report
Graphs
Following graphs are shown on the Reports page:
1.TextBook Creation Status - Pie Chart
2. TextBook Creation Status: Class-Wise
3. TextBook Creation Status: Subject-Wise
These graphs are exactly same as that displayed in ETB Creation Status Reports page on Dashboards page.
Localization Requirements
NA
Telemetry Requirements
Event Name | Description |
---|---|
Open Reports Page | This event is generated when a user opens Reports page in a Program. Apart from common set of data, Program Id should be captured in the event. |
Download Summary Report | This event is generated when a user clicks on "Download Summary Report" option in the Reports page. Apart from common set of data, Program Id should be captured in the event. |
Download Detailed Report | This event is generated when a user clicks on "Download Detailed Report" option in the Reports page. Apart from common set of data, Program Id should be captured in the event. |
Non-Functional Requirements
Performance / Responsiveness Requirements | Load/Volume Requirements | Security / Privacy Requirements |
---|---|---|
Report should work correctly for English and Non-English Textbook ToCs | The report should work for same number of textbooks and sizes as ETB Creation Reports in current dashboard | NA |
Impact on other Products/Solutions
ETB Creation Reports will continue as it is for all configured Tenants.
Impact on Existing Users/Data
NA
Key Metrics
Srl. No. | Metric | Purpose of Metric |
---|---|---|
Number of users downloading the Reports | Track the effectiveness of features through their usage. |
0 Comments