Sunbird cQube
  • 📖KNOW ABOUT CQUBE
    • What is cQube & what does it solve
      • Business case
      • cQube ed
      • Design Principles
    • cQube adoptions
    • Discuss more about cQube
  • 👍TRY CQUBE
    • cQube on Gitpod
  • 🌅WHAT IS NEXT IN CQUBE
    • cQube Roadmap
  • 💻TECHANICAL OVERVIEW
    • Architecture
    • Design Principles
    • Key Components
    • Details of microservices
  • 👩‍💻Get started on cQube
    • Suggested Team Structure
    • Hardware Requirements
    • Prerequisites Checklist
    • Checking pre existing ports
    • Instance Creation
    • Copying SSL Certificate
  • 🛃USE CQUBE
    • How can I install cQube?
      • High level understanding of deployment
      • Oracle Installation
      • AWS Installation
      • SDC Installation
      • Azure Installation
    • How to prepare the data
      • Schema
      • How to prepare schemas for dimension files
      • How to prepare schemas for event files
      • Examples of dimension & event files
      • All cQube schemas used for VSK
    • Ingesting the data
      • High-level understanding of ingestion
      • Steps to ingest schema
      • Steps to ingest data files
        • Upload the .csv data file for state specific programs using ingestion API
        • API to upload starter pack data files for NVSK programs
        • Get file status API
        • Scheduled API
      • Error during ingestion
        • Error Monitoring
        • Common errors in data files during ingestion
      • Processor group name
    • Adapter details
    • Postman details
    • Processing of data
      • Data Processing using CLI command
      • API Details for Nifi-Rest
      • Nifi section
    • Visualizing the data
      • High level understanding of how visualizations work in cQube
      • Programs and reports out-of-the-box
      • Enhance /Customize cQube
        • Available customizations
          • Changing Dashboard Logos and Headers
          • Changing Program Name, Icon and Side Menu Sequence
          • Adding a new KPI
          • Adding a Map KPI into dashboard ms
          • Table Drill Down Customization
          • Adding a Scatter Plot KPI into dashboard ms
          • Configure default date range across app/specific report
        • How to add a New Indicator
        • How to add a new report in an existing program
        • How to add a new program (end to end)
    • Additional Features
      • Public/Private dashboards
      • Role based access control
      • Saving geographical preferences
      • Admin Panel
        • Data Debugger
        • Schema Generator
        • System Monitoring
    • Adding Users
      • Adding an individual user
      • Adding bulk users
  • 🖥️MONITOR cQUBE
    • Infra health monitoring
    • Usage monitoring
  • 🔎QA testing
    • Testing approaches & activities
    • Manual & Automated testing
    • Functional Testing
      • Smoke Testing
      • Functional tests
      • Regression Testing
      • System Testing
    • Non Functional Testing
      • Performance Testing
        • Load Testing
        • Volume Testing
        • Performance testing results
    • Test for One-Step Installation
    • Test for Ingestion
    • Test for nifi processing
    • Test for UI Application
    • Test for KPIs
  • ☀️DEPLOYMENT PROCESS
    • State List
    • AWS Deployment
    • SDC Deployment
    • Adapter Details During the Processing
  • 🈴UPGRADING TO LATEST VERSION
    • How can I upgrade cQube to the latest release
  • 🆘Common issues and their solutions
    • Deployment & ingestion related issues & their solutions
  • ⏱️Standard Operating Procedure
    • Reporting a Bug
    • Protocol for issue reporting & resolution
    • Suggesting Enhancements
    • Raising a PR
  • ❓Frequently Asked Questions
    • Running List
  • 🧑‍🏫🧑🏫 Recording of trainings
    • Link to the training videos
  • 🧠Key Terms & Concepts
    • Definitions
  • 🚀cQube Release Notes
    • cQube - Release V 5.0.5
    • cQube - Release V 5.0.3
    • cQube - Release V 5.0.2
    • cQube - Release V 5.0.1
    • cQube - Release V 5.0
    • cQube - Release V 4.1-beta
    • cQube - Release V 4.0-beta
    • cQube - Release V 4.0-alpha
    • cQube - Release V 3.7
    • cQube - Release V 3.6
    • cQube - Release V 3.5
    • cQube - Release V 3.4
    • cQube - Release V 3.3
    • cQube - Release V 3.2
    • cQube - Release V 3.1
    • cQube - Release V 3
    • cQube - Release V 2
    • cQube - Release V 1.13 and V 1.13.1
    • cQube - Release V 1.12 and V 1.12.1
    • cQube - Release V 1.11
    • cQube - Release V 10 and V 10.1
    • cQube - Release V 1.9
    • cQube - Release V 1.8 and V 1.8.1
    • cQube - Release Notes V 1.7
    • cQube - Release Notes V 1.6 and V 1.6.1
    • cQube - Release Notes V 1.5
    • cQube - Release Notes V 1.4
    • cQube - Release Notes V 1.3
    • cQube - Release Notes V 1.2 and V 1.2.1
    • cQube - Release Notes V 1.1
    • cQube - Release Notes V 1.0
  • 📂cQube V 4.1 - Beta
    • Sunbird cQube Overview
    • cQube Product Description
    • Listen to Experts (Youtube)
    • Software Requirements
    • Acronyms
    • cQube Software Architecture
    • AWS - Network Architecture
      • Hardware requirements
      • Data Storage Locations
    • Security Implementations
    • Prerequisites for Installation process
    • New Use-Case Creation
    • cQube Setup & configuration
    • Base Installation steps
    • Base Upgradation steps
    • Workflow Installation steps
    • Workflow Upgradation steps
    • Laptop/Desktop Installation
      • Base Installation
      • Workflow Installation
      • Mock Data Processing
    • Ad-hoc analysis
    • Workflow process
    • Emission Process
    • cQube ER Diagrams
    • Data Validation after Ingestion
    • User Authentication Process
    • Admin Login Process
    • Admin Features
    • cQube Datasource Configuration
    • cQube data replay process
    • S3 Partitioning
    • Reports
    • Troubleshooting Issues
      • Data Processing-NIFI Issues
      • Data Processing-PostgreSQL Issues
      • Data Emission Issues
      • Angular & Node Issues
    • FAQs
    • Discuss
    • Report
    • Source Code
Powered by GitBook
On this page
  • Overview
  • Release Highlights
  • Release Features
  • Backward Compatibility
  • Deprecations from previous release (V 4.1 - beta)
  • Available Documentations for V 5.0
  • Known Issues
  • Scale Testing Results
  • Upcoming Release Features

Was this helpful?

Edit on GitHub
  1. cQube Release Notes

cQube - Release V 5.0

Document Release Version

Project
Release Date
Release Version

cQube

27 Mar 2023

V 5.0

Overview

As part of cQube V 5.0, a cQube adopter can install V 5.0 or upgrade from V 4.1 Beta to V 5.0 seamlessly, ingest spec-compliant data for 9 out-of-the-box programs & leverage RBAC-enabled visualisation layer of cQube for all programs. cQube adopter can also add a new program or indicator easily and connect cQube datasets to external visualisation tools (like Metabase, Tableau etc.)

Release Highlights

  1. 📊 Pre-Packaged Programs: 20+ out-of-the-box education programs, out of which 9 are live as part of this version with an additional ability for the cQube adopter to add new programs within 2 days

  2. 👥 Decentralised Observability: Visualisations for all out-of-the-box programs tailored to user role and jurisdictions. For example, a state officer will look at state and district-level data for all districts in the state. A district officer selects their district and looks at data for their districts and all the blocks in the district

  3. 🧑‍💻 Quick and Smooth Set Up: Seamless installation of cQube V 5.0 and upgradation from V 4.1 - beta to V 5.0 in less than 30 minutes

  4. 🔁 Direct Linkage for Data Updates: Automatic updation of daily-level data by direct linkage of the state data sources with cQube

  5. 📈 Usage Tracking Mechanism: Track usage of dashboards for each program via telemetry

Release Features

  1. A deployer can install V 5.0 or upgrade from V 4.1 - Beta (VSK Starter Pack) to V 5.0 seamlessly within 30 minutes - Installation Details | Upgradation Details

  2. A deployer is able to ingest state data for 9 out-of-the-box programs in cQube schema via APIs through adapters at a set frequency - Available Programs | cQube Schema | Adapter Creation | Ingestion Details

  3. A deployer can monitor ingestion by viewing the number of rows ingested and rectifying any errors - Monitoring Ingestion | Rectifying Errors

  4. A deployer is able to schedule the processing of ingested data within cQube - Installation Details

  5. A deployer can add a new program / report / indicator in cQube by configuring ingestion, processing and visualisation

  6. A deployer / admin can connect the cQube datasets to any external visualisation tool (eg: Metabase, Tableau etc.)

  7. A deployer can modify the UI of the cQube dashboards through configurations - UI Customisations

  8. A user can select the role (State Officer, District Officer, Block Officer, Cluster Officer, School Principal, Class Teacher) & jurisdiction (District, Block, Cluster, School, Class) for which they want to view data / charts on the cQube dashboard for all out-of-the-box programs

  9. A user can apply relevant filters to data available for all programs

  10. A user can see a summary dashboard with important data points from all programs

  11. A user can see when the data was last updated for all programs on the cQube dashboard

  12. A user can download data for a specific chart / report into a CSV

  13. An admin can monitor and track usage of dashboards regularly (Unique users, Page-wise total views, Day & week-wise views etc.)

Backward Compatibility

For the users who upgrade to cQube V 5.0, their existing data for the 6 programs in the VSK Starter Pack will automatically become compliant to V 5.0 and they will be able to see the same programs with state data in V 5.0.

The existing users of the VSK Starter Pack can continue updating the data for the 6 national programs (NAS, UDISE, PGI, DIKSHA, NISHTHA and PM-POSHAN) in the same ZIP format of the file using the new API in the same manner.

In case the existing users of VSK Starter Pack also wish to see the state programs that come out-of-the-box in cQube V5.0 (Student Attendance, Teacher Attendance & Review Meetings), they will need to ingest the state data in the manner explained here.

Deprecations from previous release (V 4.1 - beta)

Some features have been deprecated from the previous release (V 4.1 - beta) but will be available in the future versions of cQube as mentioned here:

  1. Admin Console: A UI-based admin console will not be available in cQube V 5.0 but most of the functionalities of the admin console have been enabled via APIs as explained below:

    1. Monitoring of ingestion and processing: The deployer can see the number of ingested rows in cQube V 5.0 along with the errors in the ingested file using the file status API as explained here.

    2. Managing retention and deletion of ingested data: This feature will be available in V 5.0.2, planned to be released at the end of April'23.

    3. Scheduling the processing of ingested data: This can be done using the schedule API in V 5.0 as explained here.

Available Documentations for V 5.0

  1. Step-wise Installation Process

  2. cQube Schemas

  3. Step-wise Adapter Creation Process

  4. Step-wise Ingestion Process

  5. Available programs, reports and indicators

  6. UI Customisations

Known Issues

To be published soon!

Scale Testing Results

To be published soon!

Upcoming Release Features

PreviouscQube - Release V 5.0.1NextcQube - Release V 4.1-beta

Last updated 2 years ago

Was this helpful?

cQube users on VSK Starter Pack (V 4.1 Beta) with 6 out-of-the-box programs like NAS, UDISE, PGI, DIKSHA, NISHTHA and PM-POSHAN can upgrade to V 5.0 within 30 minutes using these steps. The hardware and software requirements for are same (actually - lesser) as .

cQube users on any other version, who wish to upgrade to cQube V 5.0, please reach out to the cQube Product Team .

Login Page: A login page is not present in cQube V 5.0. The aggregated data (there is no PII data in cQube) can be accessed by all officers in the state according to the role that they select. The login functionality will be available in V 5.0.1, planned to be released by mid-April'23. The ticket for this functionality can be tracked .

The list of features for the upcoming releases can be accessed from this . Any comments for suggestions are welcome in the attached document.

🚀
V 5.0
V 4.1 Beta
here
here
Getting Started
link