SUMMARY.md

Table of contents

LEARN

• Overview
• Functional Capabilities
• Technical Architecture
• Product & Developer Guide
  • USER & ORG SERVICE
    • Features/Core capabilities
    • Architecture
      • Code Flow
    • Data Models
      • Cassandra
        • Data Dictionary
          • User
          • Organisation
          • System Settings
          • Role
          • Bulk Upload Process
          • Tenant Preference
          • Cassandra Migration Version
          • User Consent
          • Email Template
          • OTP
          • Page Management (LMS Service)
          • Location
          • User Notes
          • Deprecated
      • Elastic Search
      • Redis
    • APIs
      • User Management
      • Organisation Management
      • Location Management
      • Consent Management
      • OTP Services
      • Tenant Configurations
      • Bulk Upload
      • System Settings
      • API Management Service
      • Data Sync
      • Notification APIs
    • Flink Jobs
      • User Cache Updater
    • Reports
      • Standard Exhaust
        • State Admin Geo report
        • State Admin Report
      • Other Jobs
        • User Cache Indexer Job
    • Logs, Telemetry Events
    • Configuration
      • Functional Configurations
      • System Settings
      • Email Configuration
      • SMS Configuration
      • OTP based SMS Configuration
    • Roles
      • System Roles
      • User Roles
      • RBAC
    • Dependencies
    • Keycloak on Sunbird
    • How to Guide
      • Create Organization
      • Create User
      • Add new user type & location
    • Single Sign-on with Sunbird
    • Caching and Denormalising User Metadata
      • ETLUserCacheUpdaterJob
      • UserCacheUpdaterFlinkJob
    • Unit Tests and Code Coverage
    • FAQs
  • LMS(BATCH) SERVICE
    • Features/Core Capabilities
    • Architecture
      • Code Flow
    • Data Models
      • Cassandra
        • Data Dictionary
      • ElasticSearch
      • Redis
    • APIs
    • Flink Jobs
      • Merge User Courses
      • Relation Cache Updater
      • Activity Aggregate Updater
      • Assessment Aggregator
      • Enrolment Reconciliation
      • Collection Certificate Pre-Processor
      • Collection Certificate Generator
    • Reports
      • On-Demand Exhaust
        • Response Exhaust
        • User Info Exhaust
        • Progress Exhaust
      • Other Jobs
        • Collection Summary Job
        • Course Batch Status Updater Job
        • Cassandra Migrator Job
        • Score Metric Migration Job
        • Assessment Score Correction Job
        • Collection Reconciliation Job
        • Course Enrollment Job
        • Course Consumption Job
    • Logs, Telemetry Events
    • Configuration
      • System Configuration
      • Functional Configuration
    • Dependencies
    • Certificate Registry and Credentialing using Sunbird-RC
    • Certificate Flow
      • Certificates Creation and Configuration
  • GROUPS
    • Features/Core Capabilities
    • Architecture
      • Code Flow
    • Data Models
      • Cassandra
        • Data Dictionary
      • Redis
    • APIs
    • Logs, Telemetry Events
      • UI Telemetry Events
      • Service Telemetry Events
    • Configuration
      • Functional Configurations
    • Design References
    • Dependencies
    • Unit Tests and Code Coverage
  • NOTIFICATION SERVICE
    • Features/Core Capabilities
    • Architecture
      • Code Flow
    • Data Models
      • Data Dictionary
    • APIs
    • Flink Jobs
    • Logs, Telemetry Events
    • Configuration
      • Functional Configurations
    • Dependencies
    • Unit Tests and Code Coverage
  • DISCUSSION FORUM
    • Features/Core capabilities
    • Architecture
      • Code Flow
    • APIs
      • Category APIs
      • User APIs
      • Post APIs
      • Topic APIs
      • Forum APIs
    • Context Schema
    • Configurations
      • Nodebb Admin panel settings
      • Discussion MW & Nodebb System Config
    • Telemetry Events
    • Dependencies
  • DATA PIPELINE (Flink Jobs)
    • Program User Info
      • Component Diagram
      • Data Model
      • Folder Structure
  • DATA PRODUCTS
    • Program Exhaust
      • Component Diagram
      • Folder Structure
• Dependencies
• Product Roadmap
• Tech References
• FAQs
• Telemetry Processing
• Data Dictionary
  • Sample Data

Engage

• Discuss
• Contribute to Sunbird Lern

USE

• Overview
• Developer Installation
  • USER & ORG SERVICE
    • System Requirements
    • Tech Stack
    • Installation Guide
    • Keycloak Local setup
    • Additional Installation Dependencies:
    • Source Code
    • Installation Configuration
  • LMS(BATCH) SERVICE
    • System Requirements
    • Tech Stack
    • Installation Guide
    • Source Code
  • GROUPS
    • System Requirements
    • Tech Stack
    • Installation Guide
    • Source Code
    • Installation Configuration
  • NOTIFICATION SERVICE
    • System Requirements
    • Tech Stack
    • Installation Guide
    • Source Code
    • Installation Configuration
  • DISCUSSION FORUM
    • System Requirements
    • Tech Stack
    • Installation Guide
      • Nodebb setup
      • Discussion Middleware Setup
      • Discussion Middleware
      • Discussion forum integration with any application
      • Discussion-UI setup along with demo application.
      • Sunbird-lern portal for DF
    • Source Code
  • DATA PIPELINE (Flink Jobs)
  • DATA PRODUCTS
    • System Requirements
    • Tech Stack
    • Installation Dependencies
    • Local installation of data-products
    • Server setup Guide
    • Installation Configuration
    • Data-product creation guide
    • Troubleshooting a data-product
• Dependency setup
• Release Notes
  • Release V 5.4.0 (Ongoing)
  • Release V 5.3.0
  • Release V 5.2.0
  • Release V 5.1.0
  • Release V 5.0.1
  • Release V 5.0.0
  • Release V 4.10.0
  • Release V 4.9.0
  • Release V 4.8.0
  • Release V 4.7.0
• Deprecation
  • Release-5.4.0
• Server Installation
• Jenkins Jobs
• Release Calendar
• Raise an Issue
• Contribute to Sunbird Lern