🧒
Sunbird ED
new release -7.0.0 (Jun 2024)Askdot
latest
latest
  • Learn
    • Overview
    • Capabilities
      • Learning Apps
      • Asset Sourcing
      • Organised Collections
      • Discover Content - Digital & Phygital
      • User Engagement
      • Rich and diverse content
      • Versatile Question Bank
      • Observability
      • Launch Course
      • Verifiable Credentials
      • Multi-Channel Chatbot
      • Targeted Programs
      • Manage Learn
        • Overview
        • What is an entity?
        • What is a Program?
        • What is a Project?
        • What is Observation?
        • What is a Survey?
        • What is Observation as a task inside a Project?
      • Product and Developer's Guide
        • Learning apps
          • Workflows
            • Onboarding of Users
            • Discovery of Content
            • Play content
            • Track progress and Earn credentials
            • Interacting / Collaborating
        • Asset Sourcing
        • Organised Collections
        • Discover Content - Digital & Phygital
        • User Engagement
        • Rich and Diverse Content
        • Versatile Question Bank
        • Observability
        • Launch Courses
        • Verifiable Credentials
        • Multi-Channel Chatbot
        • Targeted Programs
        • Manage Learn
          • Overview
          • Component Diagram
          • ML Core Service
          • ML Project Service
          • ML Survey Service
          • ML Report Service
          • ML Analytics Service
    • Tech Overview
      • Design Principles
      • Technical Architecture Diagram
      • Tech Stack
    • Adopters
      • DIKSHA
    • Roadmap
      • Plan for 2025-2026
      • Releases and Dates
  • USE
    • Getting Started - Setup
      • Pre-requisites
      • Install
      • Functional Configurations
    • Developer Guide - Overview
      • Architecture - Component Diagram
      • System Requirements
        • Learning Apps
      • Install Locally
        • SunbirdED Mobile
        • SunbirdED Portal
      • Easy Installer
        • Adding Support for a New Cloud Provider
      • Configuration
        • SunbirdEd Portal
        • Sunbird Mobile
      • Portal
        • Component Diagram
        • I18N (Resource Bundles)
        • Branding Name and Logo Configuration Guide
      • Desktop
        • Component Diagram
      • Mobile
        • Component Diagram
        • sunbird-mobile-sdk
        • Sunbird-mobile-app plugins
        • Configurations to setup mobile app
        • I18N (Resource Bundles)
      • Form service
        • Component Diagram
        • Data model
        • API's
      • Manage Learn
        • ML Core Service
          • Overview
          • User Flow Diagram
          • Component Diagram
          • Data Model
          • Folder Structure
          • API's
          • Deployment Overview
          • Local Service Setup Guide
        • ML Project Service
          • Overview
          • User Flow Diagram
          • Component Diagram
          • Data Model
          • Folder Structure
          • API's
          • Deployment Overview
          • Local Service Setup Guide
        • ML Survey Service
          • Overview
          • User Flow Diagram
          • Component Diagram
          • Data Model
          • Folder Structure
          • API's
          • Deployment Overview
          • Local Service Setup Guide
        • ML Report Service
          • Overview
          • User Flow Diagram
          • Component Diagram
          • Data Model
          • Folder Structure
          • API's
          • Deployment Overview
          • Local Service Setup Guide
        • ML Analytics Service
          • Overview
          • Component Diagram
          • Data Model
          • Setup Guide
            • ENV Variables ( Config.ini)
          • Ingestions
          • Folder Structure
          • Report creation and Updation Scripts
          • Deployment Overview
      • UI (User interface)
        • Angular Material
          • Overview
          • Installation
          • Material Icons
          • Components Usage
          • Theming
          • Theme Setup
          • Customazion
            • Palette
            • Theme
            • Accessibility
            • Colors
            • Typography
            • Components
              • Buttons
              • CC Components
        • Component Style Guide Version 1
          • Accordion
          • Buttons
          • Cards
          • Forms
          • Grid & Layout
          • Labels
          • Modals
          • Pagination
          • Rating
          • Search Box
          • Select Box
          • Tables
          • Tabs
          • Toast messages
          • Tooltip
          • Typography
        • SB-Styles: A Comprehensive Design Resource
        • SB-Themes Repository: Unifying Design Across Platforms
          • Classical Theme in Sunbird-Ed portal
          • Joyful Theme in Sunbird-Ed portal:
      • Reference Apps
        • Independent Libraries
          • Common Consumption Components
          • SunbirdEd Forms
          • Sunbird Client Services
          • Sunbird Styles
          • Sunbird Themes
          • Sunbird Tag Manager
      • API's
      • CSP changes
      • Cloud-Store SDK Maven Deployment Guide
      • Other
        • Building Images
        • Minimal forms
        • Telemetry
          • Trackable Collection
        • Platform
        • Learning Apps
    • Learn More
      • Dependencies
      • Specifications
        • SOFIE
        • SOFIE Implementation
  • SB Ed Releases
    • Sunbird v7.6.0 (Latest)
    • Sunbird v7.5.1
    • Release - SB 7.5
    • SB Release - 7.0.0
      • Release notes
      • Updating Sunbird Releases
        • 6.0.1 to 7.0.0
      • Release Calendar 7.0.0
      • Demo of released items
  • Engage
    • Discuss
    • Contribute to Sunbird ED
    • Extend / Contribute to Sunbird
    • Issue tracker/ Create Issue
  • Misc
    • Templates
      • Upgrade Sunbird release document
      • Release Notes
    • Misc Pages
      • Portal - Manage Learn - Reports
      • App - Manage Learn - component diagram
        • Projects
        • Observation & Survey
        • Program
      • Portal - Manage Learn - component diagram
      • Mobile form configurations
      • Content Indexing Flow
      • What are multiple databases used for
      • Course completion, reports and certificate issue
      • How to access Flink UI
      • What are all the flink jobs for
      • How does data flow into Druid
      • Minimal build properties
      • Delete User Functionality
    • Archived
      • High Level Capabilities
      • Workflows
      • Where Sunbird ED helps you
      • ED - Mobile App (going to archive)
        • 4.10.3 to 5.0.0
        • 5.0.0 to 5.1.0
      • Setting up Sunbird ED
      • Developer Documentation
      • API Reference Documentation
      • Detailed Documentation
      • Source Code
      • Actors & Actions
      • Detailed Capabilities
      • Data
      • Terminology
      • 5.1.0-hotfix (OCI )
      • Getting started (v7)
        • Deployment Overview
        • Pre-requisites
        • Install
          • Provision Cloud Infrastructure
          • Setup Jenkins
          • Update Ansible Variables
          • Build, Provision and Deploy
          • Functional Configurations
Powered by GitBook
On this page
  • Step 1:
  • Step 2:
  • Step 3
  • Step 4:
  1. USE
  2. Developer Guide - Overview
  3. Other
  4. Telemetry

Trackable Collection

"Course" is a type of Trackable collection in Sunbird. A trackable Collection is one in which a User's progress can be measured. A course (Trackable Collection) will have the following attributes associated with it.

  • Course Unit(collection os resources grouped together)

  • Resources

  • Collection

  • Batches

    • Batches will have a Start Date of the batch

    • Batches can have a End Date of the batch

    • Batches can have a Enrolment End date

    • Batches can have mentors to the batch

    • Batches can have Certificates for a batch

    • Batches can have a discussion

This Page will try to explain and understand the user flow and telemetry that will be created for a user journey

Step 1:

A user tries to search a course with the course name or ID or QRCODE an Impression event will be triggerd\

{
      "eid": "IMPRESSION",
      "ets": 1672903979125,
      "ver": "3.0",
      "mid": "IMPRESSION:9233e99da2ae1364c4050561a6b97b6f",
      "actor": {
        "id": "88e71f0a-c9b3-4449-b076-e468027e360e",
        "type": "User"
      },
      "context": {
        "channel": "0126796199493140480",
        "pdata": {
          "id": "{<environment in which the telemetry was generated>}",
          "ver": "5.1.0",
          "pid": "sunbird-portal"
        },
        "env": "library",
        "sid": "jEczuH3QGIAyaxgCwNswZEQOB_rkSB5f",
        "did": "560884cd9da0e8e61c084559ca2a7b1b",
        "cdata": [
          {
            "id": "jEczuH3QGIAyaxgCwNswZEQOB_rkSB5f",
            "type": "UserSession"
          },
          {
            "id": "Desktop",
            "type": "Device"
          },
          {
            "id": "joy",
            "type": "Theme"
          }
        ],
        "rollup": {
          "l1": "0126796199493140480"
        },
        "uid": "88e71f0a-c9b3-4449-b076-e468027e360e"
      },
      "object": {},
      "tags": [
        "0126796199493140480"
      ],
      "edata": {
        "type": "view",
        "pageid": "library-search",
        "uri": "/search/Library/1?key={<Search workd from the user>}&selectedTab=all",
        "subtype": "pageexit",
        "duration": 0.026,
        "visits": []
      }
    }

Step 2:

Once Searched a Course name and got the response user clicks on the course card the following Interact telemetry event will be generated

{
      "eid": "INTERACT",
      "ets": 1672903979118,
      "ver": "3.0",
      "mid": "INTERACT:595a19d6ceebc0c6cd5b7fb4f156c4f7",
      "actor": {
        "id": "88e71f0a-c9b3-4449-b076-e468027e360e",
        "type": "User"
      },
      "context": {
        "channel": "0126796199493140480",
        "pdata": {
          "id": "{<environment in which the telemetry was generated>}",
          "ver": "5.1.0",
          "pid": "sunbird-portal"
        },
        "env": "library",
        "sid": "jEczuH3QGIAyaxgCwNswZEQOB_rkSB5f",
        "did": "560884cd9da0e8e61c084559ca2a7b1b",
        "cdata": [
          {
            "id": "jEczuH3QGIAyaxgCwNswZEQOB_rkSB5f",
            "type": "UserSession"
          },
          {
            "id": "Desktop",
            "type": "Device"
          },
          {
            "id": "joy",
            "type": "Theme"
          }
        ],
        "rollup": {
          "l1": "0126796199493140480"
        },
        "uid": "88e71f0a-c9b3-4449-b076-e468027e360e"
      },
      "object": {
        "id": "do_2136796955344240641444",
        "type": "Course",
        "ver": "3",
        "rollup": {}
      },
      "tags": [
        "0126796199493140480"
      ],
      "edata": {
        "id": "content-card",
        "type": "click",
        "pageid": "home-search"
      }
    }

Step 3

Once the user clicks on the course card and lands into the course TOC page there will be a impression event will be generated as following

{
      "eid": "IMPRESSION",
      "ets": 1672903979343,
      "ver": "3.0",
      "mid": "IMPRESSION:07834e60105c059ca0210984472c2727",
      "actor": {
        "id": "88e71f0a-c9b3-4449-b076-e468027e360e",
        "type": "User"
      },
      "context": {
        "channel": "0126796199493140480",
        "pdata": {
          "id": "{<environment in which the telemetry was generated>}",
          "ver": "5.1.0",
          "pid": "sunbird-portal"
        },
        "env": "Course",
        "sid": "jEczuH3QGIAyaxgCwNswZEQOB_rkSB5f",
        "did": "560884cd9da0e8e61c084559ca2a7b1b",
        "cdata": [
          {
            "id": "jEczuH3QGIAyaxgCwNswZEQOB_rkSB5f",
            "type": "UserSession"
          },
          {
            "id": "Desktop",
            "type": "Device"
          },
          {
            "id": "joy",
            "type": "Theme"
          }
        ],
        "rollup": {
          "l1": "0126796199493140480"
        },
        "uid": "88e71f0a-c9b3-4449-b076-e468027e360e"
      },
      "object": {
        "id": "do_2136796955344240641444",
        "type": "Course",
        "ver": "1.0",
        "rollup": {
          "l1": "do_2136796955344240641444"
        }
      },
      "tags": [
        "0126796199493140480"
      ],
      "edata": {
        "type": "view",
        "pageid": "course-details",
        "uri": "/learn/course/{<ID of the course>}"
      }
    }

Step 4:

User needs to join a batch of a course to take one so once user clicks on the join batch button an interact event is generated as follows

{
      "eid": "INTERACT",
      "ets": 1672904391516,
      "ver": "3.0",
      "mid": "INTERACT:9fb8085f1a8122c18cfc96ec81115575",
      "actor": {
        "id": "88e71f0a-c9b3-4449-b076-e468027e360e",
        "type": "User"
      },
      "context": {
        "channel": "0126796199493140480",
        "pdata": {
          "id": "{<environment in which the telemetry was generated>}",
          "ver": "5.1.0",
          "pid": "sunbird-portal"
        },
        "env": "Course",
        "sid": "jEczuH3QGIAyaxgCwNswZEQOB_rkSB5f",
        "did": "560884cd9da0e8e61c084559ca2a7b1b",
        "cdata": [
          {
            "id": "jEczuH3QGIAyaxgCwNswZEQOB_rkSB5f",
            "type": "UserSession"
          },
          {
            "id": "Desktop",
            "type": "Device"
          },
          {
            "id": "joy",
            "type": "Theme"
          }
        ],
        "rollup": {
          "l1": "0126796199493140480"
        },
        "uid": "88e71f0a-c9b3-4449-b076-e468027e360e"
      },
      "object": {
        "id": "{<ID of the course>}",
        "type": "Course",
        "ver": "3",
        "rollup": {
          "l1": "{<ID of the course>}"
        }
      },
      "tags": [
        "0126796199493140480"
      ],
      "edata": {
        "id": "join-course",
        "type": "click",
        "pageid": "course-consumption"
      }
    }