# Sunbird cQube

## Sunbird cQube

- [What is cQube & what does it solve](https://cqube.sunbird.org/know-about-cqube/architecture.md): Details out the technical architecture of cQube
- [Business case](https://cqube.sunbird.org/know-about-cqube/architecture/business-case.md)
- [cQube ed](https://cqube.sunbird.org/know-about-cqube/architecture/cqube-ed.md)
- [Design Principles](https://cqube.sunbird.org/know-about-cqube/architecture/design-principles.md)
- [cQube adoptions](https://cqube.sunbird.org/know-about-cqube/cqube-adoptions.md)
- [Discuss more about cQube](https://cqube.sunbird.org/know-about-cqube/discuss-more-about-cqube.md)
- [cQube on Gitpod](https://cqube.sunbird.org/try-cqube/architecture.md)
- [cQube Roadmap](https://cqube.sunbird.org/what-is-next-in-cqube/architecture.md)
- [Architecture](https://cqube.sunbird.org/techanical-overview/architecture.md): Details out the technical architecture of cQube
- [Design Principles](https://cqube.sunbird.org/techanical-overview/design-principles.md)
- [Key Components](https://cqube.sunbird.org/techanical-overview/key-components.md): This page outlines the key components of cQube
- [Details of microservices](https://cqube.sunbird.org/techanical-overview/details-of-microservices.md)
- [Suggested Team Structure](https://cqube.sunbird.org/get-started-on-cqube/getting-started.md): Shows you a list of things to help you get started with cQube V 5.0:
- [Hardware Requirements](https://cqube.sunbird.org/get-started-on-cqube/hardware-requirements.md): List of hardware requirements as pre-requisites for cQube V 5.0
- [Prerequisites Checklist](https://cqube.sunbird.org/get-started-on-cqube/prerequisites-checklist.md)
- [Checking pre existing ports](https://cqube.sunbird.org/get-started-on-cqube/checking-pre-existing-ports.md)
- [Instance Creation](https://cqube.sunbird.org/get-started-on-cqube/instance-creation.md)
- [Copying SSL Certificate](https://cqube.sunbird.org/get-started-on-cqube/copying-ssl-certificate.md): Below are the steps to copy SSL certificates from a local source to Ubuntu and from Windows to Ubuntu.
- [How can I install cQube?](https://cqube.sunbird.org/use-cqube/getting-started.md)
- [High level understanding of deployment](https://cqube.sunbird.org/use-cqube/getting-started/high-level-understanding-of-deployment.md)
- [Oracle Installation](https://cqube.sunbird.org/use-cqube/getting-started/oracle-installation.md)
- [AWS Installation](https://cqube.sunbird.org/use-cqube/getting-started/aws-installation.md)
- [SDC Installation](https://cqube.sunbird.org/use-cqube/getting-started/sdc-installation.md)
- [Azure  Installation](https://cqube.sunbird.org/use-cqube/getting-started/azure-installation.md)
- [How to prepare the data](https://cqube.sunbird.org/use-cqube/getting-started-1.md)
- [Schema](https://cqube.sunbird.org/use-cqube/getting-started-1/schema.md)
- [How to prepare schemas for  dimension files](https://cqube.sunbird.org/use-cqube/getting-started-1/how-to-prepare-schemas-for-dimension-files.md): Dimensions are the columns that describe events. The dimensions are those values which do not change frequently and remain constant. Example: State name
- [How to prepare schemas for event files](https://cqube.sunbird.org/use-cqube/getting-started-1/how-to-prepare-schemas-for-event-files.md)
- [Examples of dimension & event files](https://cqube.sunbird.org/use-cqube/getting-started-1/examples-of-dimension-and-event-files.md): This page gives an example of cQube Dimension & Event schema for better understanding
- [All cQube schemas used for VSK](https://cqube.sunbird.org/use-cqube/getting-started-1/all-cqube-schemas-used-for-vsk.md)
- [Ingesting the data](https://cqube.sunbird.org/use-cqube/ingesting-the-data.md)
- [High-level understanding of ingestion](https://cqube.sunbird.org/use-cqube/ingesting-the-data/high-level-understanding-of-ingestion.md)
- [Steps to ingest schema](https://cqube.sunbird.org/use-cqube/ingesting-the-data/steps-to-ingest-schema.md)
- [Steps to ingest data files](https://cqube.sunbird.org/use-cqube/ingesting-the-data/steps-to-ingest-data-files.md)
- [Upload the .csv data file for state specific programs using ingestion API](https://cqube.sunbird.org/use-cqube/ingesting-the-data/steps-to-ingest-data-files/upload-the-.csv-data-file-for-state-specific-programs-using-ingestion-api.md)
- [API to upload starter pack data files for NVSK programs](https://cqube.sunbird.org/use-cqube/ingesting-the-data/steps-to-ingest-data-files/api-to-upload-starter-pack-data-files-for-nvsk-programs.md): This focuses on ingestion of programs like UDISE, PGI, NISHTHA, DIKSHA, NAS, PM-POSHAN. The jwt token has to be passed in the API headers.
- [Get file status API](https://cqube.sunbird.org/use-cqube/ingesting-the-data/steps-to-ingest-data-files/get-file-status-api.md)
- [Scheduled API](https://cqube.sunbird.org/use-cqube/ingesting-the-data/steps-to-ingest-data-files/scheduled-api.md)
- [Error during ingestion](https://cqube.sunbird.org/use-cqube/ingesting-the-data/error-during-ingestion.md)
- [Error Monitoring](https://cqube.sunbird.org/use-cqube/ingesting-the-data/error-during-ingestion/error-monitoring.md)
- [Common errors in data files during ingestion](https://cqube.sunbird.org/use-cqube/ingesting-the-data/error-during-ingestion/common-errors-in-data-files-during-ingestion.md)
- [Processor group name](https://cqube.sunbird.org/use-cqube/ingesting-the-data/processor-group-name.md)
- [Adapter details](https://cqube.sunbird.org/use-cqube/adapter-details.md)
- [Postman details](https://cqube.sunbird.org/use-cqube/postman-details.md)
- [Processing of data](https://cqube.sunbird.org/use-cqube/processing-of-data.md)
- [Data Processing using CLI command](https://cqube.sunbird.org/use-cqube/processing-of-data/data-processing-using-cli-command.md)
- [API Details for Nifi-Rest](https://cqube.sunbird.org/use-cqube/processing-of-data/api-details-for-nifi-rest.md)
- [Nifi section](https://cqube.sunbird.org/use-cqube/processing-of-data/nifi-section.md)
- [Visualizing the data](https://cqube.sunbird.org/use-cqube/visualizing-the-data.md)
- [High level understanding of how visualizations work in cQube](https://cqube.sunbird.org/use-cqube/visualizing-the-data/high-level-understanding-of-how-visualizations-work-in-cqube.md)
- [Programs and reports out-of-the-box](https://cqube.sunbird.org/use-cqube/visualizing-the-data/programs-and-reports-out-of-the-box.md): Details out the indicators in each report and program available in cQube Ed V 5.0
- [Enhance /Customize cQube](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube.md)
- [Available customizations](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/manual-and-automated-testing.md): Describes how customizations on the login (UI) layer of cQube Ed can be made
- [Changing Dashboard Logos and Headers](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/manual-and-automated-testing/changing-dashboard-logos-and-headers.md)
- [Changing Program Name, Icon and Side Menu Sequence](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/manual-and-automated-testing/changing-program-name-icon-and-side-menu-sequence.md)
- [Adding a new KPI](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/manual-and-automated-testing/adding-a-new-kpi.md)
- [Adding a Map KPI into dashboard ms](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/manual-and-automated-testing/adding-a-map-kpi-into-dashboard-ms.md)
- [Table Drill Down Customization](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/manual-and-automated-testing/table-drill-down-customization.md)
- [Adding a Scatter Plot KPI into dashboard ms](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/manual-and-automated-testing/adding-a-scatter-plot-kpi-into-dashboard-ms.md)
- [Configure default date range across app/specific report](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/manual-and-automated-testing/configure-default-date-range-across-app-specific-report.md)
- [How to add a New Indicator](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/functional-testing.md): Note: These steps are for adding a new indicator to an existing program
- [How to add a new report in an existing program](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/test-for-one-step-installation.md): Note: These steps are for adding a new report to an existing program
- [How to add a  new program (end to end)](https://cqube.sunbird.org/use-cqube/visualizing-the-data/enhance-customize-cqube/test-for-ingestion.md): Note: These steps are for adding a new program
- [Additional Features](https://cqube.sunbird.org/use-cqube/additional-features.md)
- [Public/Private dashboards](https://cqube.sunbird.org/use-cqube/additional-features/public-private-dashboards.md)
- [Role based access control](https://cqube.sunbird.org/use-cqube/additional-features/role-based-access-control.md)
- [Saving geographical preferences](https://cqube.sunbird.org/use-cqube/additional-features/saving-geographical-preferences.md)
- [Admin Panel](https://cqube.sunbird.org/use-cqube/additional-features/admin-panel.md)
- [Data Debugger](https://cqube.sunbird.org/use-cqube/additional-features/admin-panel/data-debugger.md)
- [Schema Generator](https://cqube.sunbird.org/use-cqube/additional-features/admin-panel/schema-generator.md)
- [System Monitoring](https://cqube.sunbird.org/use-cqube/additional-features/admin-panel/system-monitoring.md)
- [Adding Users](https://cqube.sunbird.org/use-cqube/adding-users.md)
- [Adding  an individual user](https://cqube.sunbird.org/use-cqube/adding-users/adding-an-individual-user.md)
- [Adding bulk users](https://cqube.sunbird.org/use-cqube/adding-users/adding-bulk-users.md)
- [Infra health monitoring](https://cqube.sunbird.org/monitor-cqube/getting-started.md)
- [Usage monitoring](https://cqube.sunbird.org/monitor-cqube/usage-monitoring.md)
- [Testing approaches & activities](https://cqube.sunbird.org/qa-testing/ui-customisations.md)
- [Manual & Automated testing](https://cqube.sunbird.org/qa-testing/manual-and-automated-testing.md)
- [Functional Testing](https://cqube.sunbird.org/qa-testing/functional-testing.md)
- [Smoke Testing](https://cqube.sunbird.org/qa-testing/functional-testing/smoke-testing.md)
- [Functional tests](https://cqube.sunbird.org/qa-testing/functional-testing/functional-tests.md)
- [Regression Testing](https://cqube.sunbird.org/qa-testing/functional-testing/regression-testing.md)
- [System Testing](https://cqube.sunbird.org/qa-testing/functional-testing/system-testing.md)
- [Non Functional Testing](https://cqube.sunbird.org/qa-testing/non-functional-testing.md)
- [Performance Testing](https://cqube.sunbird.org/qa-testing/non-functional-testing/performance-testing.md)
- [Load Testing](https://cqube.sunbird.org/qa-testing/non-functional-testing/performance-testing/load-testing.md)
- [Volume Testing](https://cqube.sunbird.org/qa-testing/non-functional-testing/performance-testing/volume-testing.md)
- [Performance testing results](https://cqube.sunbird.org/qa-testing/non-functional-testing/performance-testing/performance-testing-results.md)
- [Test for One-Step Installation](https://cqube.sunbird.org/qa-testing/test-for-one-step-installation.md)
- [Test for Ingestion](https://cqube.sunbird.org/qa-testing/test-for-ingestion.md)
- [Test for nifi processing](https://cqube.sunbird.org/qa-testing/test-for-nifi-processing.md)
- [Test for UI Application](https://cqube.sunbird.org/qa-testing/test-for-ui-application.md)
- [Test for KPIs](https://cqube.sunbird.org/qa-testing/test-for-kpis.md)
- [State List](https://cqube.sunbird.org/deployment-process/state-list.md)
- [AWS Deployment](https://cqube.sunbird.org/deployment-process/aws-deployment.md)
- [SDC Deployment](https://cqube.sunbird.org/deployment-process/sdc-deployment.md)
- [Adapter Details During the Processing](https://cqube.sunbird.org/deployment-process/adapter-details-during-the-processing.md)
- [How can I upgrade cQube to the latest release](https://cqube.sunbird.org/upgrading-to-latest-version/ui-customisations.md)
- [Deployment & ingestion related issues & their solutions](https://cqube.sunbird.org/common-issues-and-their-solutions/ui-customisations.md)
- [Reporting a Bug](https://cqube.sunbird.org/standard-operating-procedure/reporting-a-bug.md): Describes the process of reporting a bug to the cQube Product Team
- [Protocol for issue reporting & resolution](https://cqube.sunbird.org/standard-operating-procedure/requesting-for-support.md): Describes the process of requesting for support from the cQube Product Team
- [Suggesting Enhancements](https://cqube.sunbird.org/standard-operating-procedure/suggesting-enhancements.md): Describes the process of suggesting enhancements for cQube to the cQube Product Team
- [Raising a PR](https://cqube.sunbird.org/standard-operating-procedure/raising-a-pr.md)
- [Running List](https://cqube.sunbird.org/frequently-asked-questions/reporting-a-bug.md)
- [Link to the training videos](https://cqube.sunbird.org/recording-of-trainings/reporting-a-bug.md)
- [Definitions](https://cqube.sunbird.org/key-terms-and-concepts/reporting-a-bug.md)
- [cQube - Release V 5.0.5](https://cqube.sunbird.org/release-notes/cqube-release-v-5.0.5.md)
- [cQube - Release V 5.0.3](https://cqube.sunbird.org/release-notes/cqube-release-v-5.0.3.md)
- [cQube - Release V 5.0.2](https://cqube.sunbird.org/release-notes/cqube-release-v-5.0.2.md)
- [cQube - Release V 5.0.1](https://cqube.sunbird.org/release-notes/cqube-release-v-5.0.1.md)
- [cQube - Release V 5.0](https://cqube.sunbird.org/release-notes/cqube-release-v-5.0.md)
- [cQube - Release V 4.1-beta](https://cqube.sunbird.org/release-notes/cqube-release-notes-v4.1-beta.md)
- [cQube - Release V 4.0-beta](https://cqube.sunbird.org/release-notes/cqube-release-notes-v4.0-beta.md)
- [cQube - Release V 4.0-alpha](https://cqube.sunbird.org/release-notes/cqube-release-notes-v4.0-alpha.md)
- [cQube - Release V 3.7](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-3.7.md)
- [cQube - Release V 3.6](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-3.6.md)
- [cQube - Release V 3.5](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-3.5.md)
- [cQube - Release V 3.4](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-3.4.md)
- [cQube - Release V 3.3](https://cqube.sunbird.org/release-notes/cqube-release-v-3.3.md)
- [cQube - Release V 3.2](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-3.2.md)
- [cQube - Release V 3.1](https://cqube.sunbird.org/release-notes/cqube-release-v-3.1.md): Release Version 3.1 - 21 September 2021
- [cQube - Release V 3](https://cqube.sunbird.org/release-notes/cqube-release-v-3.md): Release Version 3 - 21 July 2021
- [cQube - Release V 2](https://cqube.sunbird.org/release-notes/cqube-release-v-2.md): Release Version 2 - 11 June 2021
- [cQube - Release V 1.13 and V 1.13.1](https://cqube.sunbird.org/release-notes/cqube-release-v-1.13-and-v-1.13.1.md): Release Version 1.13 - 12 May 2021, Version 1.13.1 - 20 May 2021
- [cQube - Release V 1.12 and V 1.12.1](https://cqube.sunbird.org/release-notes/cqube-release-v-1.12-and-v-1.12.1.md): Release Version 1.12 - 31 March 2021, Version 1.12.1 - 22 April 2021
- [cQube - Release V 1.11](https://cqube.sunbird.org/release-notes/cqube-release-v-1.11.md): Release Version 1.11 - 03 March 2021
- [cQube - Release V 10 and V 10.1](https://cqube.sunbird.org/release-notes/cqube-release-v-10-and-v-10.1.md): Release Version 1.10 - 05 February 2021, Version 1.10.1 - 12 February 2021
- [cQube - Release V 1.9](https://cqube.sunbird.org/release-notes/cqube-release-v-1.9.md): Release version 1.9 - 13 January 2021
- [cQube - Release V 1.8 and V 1.8.1](https://cqube.sunbird.org/release-notes/cqube-release-v-1.8-and-v-1.8.1.md): Release Version 1.8 - 24 December 2020, Version 1.8.1 - 31 December 2020
- [cQube - Release Notes V 1.7](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-1.7.md): Release Version 1.7 - 08 December 2020
- [cQube - Release Notes V 1.6 and V 1.6.1](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-1.6.md): Release Version 1.6 - 06 November 2020, Version 1.6.1 - 13 November 2020
- [cQube - Release Notes V 1.5](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-1.5.md): Release Version 1.5, 16 October 2020
- [cQube - Release Notes V 1.4](https://cqube.sunbird.org/release-notes/cqube-release-notes-v-1.4.md): Release Version 1.4,  29 September 2020
- [cQube - Release Notes V 1.3](https://cqube.sunbird.org/release-notes/cqube-release-v1.3.md): Release Version 1.3, 11 September 2020
- [cQube - Release Notes V 1.2 and V 1.2.1](https://cqube.sunbird.org/release-notes/cqube-release-notes-v1.2-and-v1.2.1.md): Release Version 1.2 - 20 August 2020, Version 1.2.1 - 26 August 2020
- [cQube - Release Notes V 1.1](https://cqube.sunbird.org/release-notes/cqube-release-notes-v1.1.md): Release Version 1.1, 16 July 2020
- [cQube - Release Notes V 1.0](https://cqube.sunbird.org/release-notes/cqubeversion-1.0.md): Release Version 1.0,  June 2020
- [Sunbird cQube Overview](https://cqube.sunbird.org/cqube-v-4.1-beta/cqube-v-4.1-beta.md)
- [cQube Product Description](https://cqube.sunbird.org/cqube-v-4.1-beta/cqube-features.md)
- [Software Requirements](https://cqube.sunbird.org/cqube-v-4.1-beta/software-requirements.md)
- [Acronyms](https://cqube.sunbird.org/cqube-v-4.1-beta/acronyms.md)
- [cQube Software Architecture](https://cqube.sunbird.org/cqube-v-4.1-beta/cqube-software-architecture.md)
- [AWS - Network Architecture](https://cqube.sunbird.org/cqube-v-4.1-beta/network-architecture-diagram.md)
- [Hardware requirements](https://cqube.sunbird.org/cqube-v-4.1-beta/network-architecture-diagram/hardware-requirements.md)
- [Data Storage Locations](https://cqube.sunbird.org/cqube-v-4.1-beta/network-architecture-diagram/data-storage-locations.md)
- [Security Implementations](https://cqube.sunbird.org/cqube-v-4.1-beta/security-requirements.md)
- [Prerequisites for Installation process](https://cqube.sunbird.org/cqube-v-4.1-beta/prerequisites-for-installation-process.md)
- [New Use-Case Creation](https://cqube.sunbird.org/cqube-v-4.1-beta/use-case.md)
- [cQube Setup & configuration](https://cqube.sunbird.org/cqube-v-4.1-beta/cqube-installation.md)
- [Base Installation steps](https://cqube.sunbird.org/cqube-v-4.1-beta/base-installation-steps.md)
- [Base Upgradation steps](https://cqube.sunbird.org/cqube-v-4.1-beta/base-upgradation-steps.md)
- [Workflow Installation steps](https://cqube.sunbird.org/cqube-v-4.1-beta/workflow-installation-steps.md)
- [Workflow Upgradation steps](https://cqube.sunbird.org/cqube-v-4.1-beta/workflow-upgradation-steps.md)
- [Laptop/Desktop Installation](https://cqube.sunbird.org/cqube-v-4.1-beta/laptop-desktop-demo-installation.md)
- [Base Installation](https://cqube.sunbird.org/cqube-v-4.1-beta/laptop-desktop-demo-installation/base_installation.md)
- [Workflow Installation](https://cqube.sunbird.org/cqube-v-4.1-beta/laptop-desktop-demo-installation/workflow_installation.md)
- [Mock Data Processing](https://cqube.sunbird.org/cqube-v-4.1-beta/laptop-desktop-demo-installation/mock-data-processing.md)
- [Ad-hoc analysis](https://cqube.sunbird.org/cqube-v-4.1-beta/ad-hoc-analyst.md)
- [Workflow process](https://cqube.sunbird.org/cqube-v-4.1-beta/workflow-process.md)
- [Emission Process](https://cqube.sunbird.org/cqube-v-4.1-beta/emission-process-1.md)
- [cQube ER Diagrams](https://cqube.sunbird.org/cqube-v-4.1-beta/cqube-er-diagrams.md)
- [Data Validation after Ingestion](https://cqube.sunbird.org/cqube-v-4.1-beta/data-validation-after-ingestion.md)
- [User Authentication Process](https://cqube.sunbird.org/cqube-v-4.1-beta/authentication_process.md)
- [Admin Login Process](https://cqube.sunbird.org/cqube-v-4.1-beta/admin-login-process.md)
- [Admin Features](https://cqube.sunbird.org/cqube-v-4.1-beta/admin-features.md)
- [cQube Datasource Configuration](https://cqube.sunbird.org/cqube-v-4.1-beta/datasource_configuration.md)
- [cQube data replay process](https://cqube.sunbird.org/cqube-v-4.1-beta/cqube-data-replay-process.md)
- [S3 Partitioning](https://cqube.sunbird.org/cqube-v-4.1-beta/design-principles.md)
- [Reports](https://cqube.sunbird.org/cqube-v-4.1-beta/reports.md)
- [Troubleshooting Issues](https://cqube.sunbird.org/cqube-v-4.1-beta/troubleshooting-issues.md)
- [Data Processing-NIFI Issues](https://cqube.sunbird.org/cqube-v-4.1-beta/troubleshooting-issues/data-processing-nifi-issues.md)
- [Data Processing-PostgreSQL Issues](https://cqube.sunbird.org/cqube-v-4.1-beta/troubleshooting-issues/data-processing-postgresql-issues.md)
- [Data Emission Issues](https://cqube.sunbird.org/cqube-v-4.1-beta/troubleshooting-issues/data-emission-issues.md)
- [Angular & Node Issues](https://cqube.sunbird.org/cqube-v-4.1-beta/troubleshooting-issues/angular-and-node-issues.md)
- [FAQs](https://cqube.sunbird.org/cqube-v-4.1-beta/faqs.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://cqube.sunbird.org/know-about-cqube/architecture.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
