🧒
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
        • Velero Backup and Restore Guide
      • 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
  1. USE
  2. Developer Guide - Overview
  3. Manage Learn
  4. ML Analytics Service
  5. Setup Guide

ENV Variables ( Config.ini)

[ML_APP_NAME]

survey_app = {{ ml_analytics_survey_app_name }}

// survey application name\

integrated_app = {{ ml_analytics_integrated_app_name }}

// survey integrated application name\

integrated_portal = {{ ml_analytics_integrated_portal_name }}

// Domain Name

[API_HEADERS]

content_type = application/json

// type of API body has\

authorization = {{ ml_analytics_api_authorization_key }}

// authorization for API call\

internal_access_token = {{ ml_analytics_api_access_token }}

// Refresh token for API call\

authorization_access_token = {{ ml_analytics_authorization_access_token }}

// Access token for API call\

[MONGO]\

url = mongodb://{{ ml_analytics_mongodb_url }}

// MongoDB IP Address and URL\

database_name = {{ ml_analytics_mongo_db_name }}

// MongoDB Data Basese Name

# ------ Mongo Collections ------- #

observation_sub_collection = {{ ml_analytics_mongo_observation_submission_collection }}

// Collection name for observation submission in the database\

solutions_collection = {{ ml_analytics_mongo_solution_collection }}

// Collection name for solution in the database\

observations_collection = {{ ml_analytics_mongo_observation_collection }}

// Collection name for observation in the database\

entity_type_collection = {{ ml_analytics_mongo_entity_type_collection }}

// Collection name for entityTypes in the database\

questions_collection = {{ ml_analytics_mongo_question_collection }}

// Collection name for entityTypes in the database\

criteria_collection = {{ ml_analytics_mongo_criteria_collection }}

// Collection name for criteria in the database\

entities_collection = {{ ml_analytics_mongo_entities_collection }}

// Collection name for entities in the database\

programs_collection = {{ ml_analytics_mongo_program_collection }}

// Collection name for programs in the database\

user_roles_collection = {{ ml_analytics_mongo_userroles_collection }}

// Collection name for userRoles in the database\

criteria_questions_collection = {{ ml_analytics_mongo_criteria_questions_collection }}

// Collection name for criteriaQuestions in the database\

projects_collection = {{ ml_analytics_mongo_projects_collection }}

// Collection name for projects in the database\

survey_submissions_collection = {{ ml_analytics_mongo_survey_submissions_collection }}

// Collection name for surveySubmissions in the database

\

survey_collection = {{ ml_analytics_mongo_survey_collection }}

// Collection name for surveys in the database\

reports_log_collec = {{ ml_analytics_mongo_reports_log_collec }}

// Collection name for Reportsloger in the database\

[DRUID]

metadata_url = http://{{ ml_analytics_druid_url }}/druid/coordinator/v1/datasources/

// Druid coordinator URL \

batch_url = http://{{ ml_analytics_druid_url }}/druid/indexer/v1/task

// Druid indexer URL\

metadata_rollup_url = http://{{ ml_analytics_druid_rollup_url }}/druid/coordinator/v1/datasources/

// Druid rollup coordinator URL \

batch_rollup_url = http://{{ ml_analytics_druid_rollup_url }}/druid/indexer/v1/task

// Druid rollup indexer URL\

urlQuery = http://{{ ml_analytics_druid_query_url }}/druid/v2?pretty

// Druid Query URL\

observation_status_injestion_spec = {{ ml_analytics_druid_observation_status_injestion_spec }}

// Druid ingestion spec for observation status\

project_injestion_spec = {{ ml_analytics_druid_project_injestion_spec }}

// Druid ingestion spec for the project\

ml_distinctCnt_obs_status_spec = {{ ml_analytics_druid_distinctCnt_obs_injestion_spec }}

// Druid ingestion spec for distinct Count observation \

ml_distinctCnt_obs_domain_spec = {{ ml_analytics_druid_distinctCnt_obs_domain_injestion_spec }}

// Druid ingestion spec for distinct Count observation domain\

ml_distinctCnt_obs_domain_criteria_spec = {{ ml_analytics_druid_distinctCnt_obs_domain_criteria_injestion_spec }}

// Druid ingestion spec for distinct Count observation domain criteria\

ml_distinctCnt_projects_status_spec = {{ ml_analytics_druid_distinctCnt_projects_status_injestion_spec }}

// Druid ingestion spec for distinct Count project\

ml_distinctCnt_prglevel_projects_status_spec = {{ ml_analytics_druid_distinctCnt_prglevel_projects_status_injestion_spec }}

// Druid ingestion spec for distinct Count project program level\

observation_status_rollup_injestion_spec = {{ ml_analytics_druid_observation_status_rollup_injestion_spec }}

// Druid ingestion spec for observation status rollup \

project_rollup_injestion_spec = {{ ml_analytics_druid_project_rollup_injestion_spec }}

// Druid ingestion spec for project status rollup\

ml_survey_rollup_spec = {{ml_analytics_druid_survey_rollup_injestion_spec}}

// Druid ingestion spec for survey status rollup\

survey_status_injestion_spec = {{ ml_analytics_druid_survey_status_injestion_spec }}

// Druid ingestion spec for Survey \

observation_query_spec = {{ ml_analytics_druid_observation_query_spec }}

// Druid query spec for observation\

observation_injestion_spec = {{ml_analytics_druid_observation_batch_ingestion_spec}}

// Druid spec for observation \

survey_query_spec = {{ml_analytics_druid_survey_query_spec}}

// Druid query spec for survey\

survey_injestion_spec = {{ml_analytics_druid_survey_batch_ingestion_spec}}

// Druid spec for survey

intervals = {{ml_analytics_druid_interval_list}}

// Druid interval variables \

[KAFKA]

url = {{ ml_analytics_kafka_url }}

// Kafka IP address \

observation_raw_topic = {{ ml_analytics_kafka_observation_topic_name }}

// Kafka observation raw topic name\

observation_druid_topic = {{ ml_analytics_kafka_observation_druid_topic_name }}

// Kafka observation druid topic name

observation_evidence_druid_topic = {{ ml_analytics_kafka_observation_evidence_topic_name }}

// Kafka observation evidence topic name\

survey_evidence_druid_topic = {{ ml_analytics_kafka_survey_evidence_topic_name }}

// Kafka survey evidence topic name\

survey_raw_topic = {{ ml_analytics_kafka_survey_topic_name }}

// Kafka survey raw topic name\

survey_druid_topic = {{ ml_analytics_kafka_survey_druid_topic_name }}

// Kafka survey druid topic name\

[LOGS]

observation_streaming_success_error = {{ ml_analytics_observation_log_folder_path }}/

// file path for loggers for observation streaming\

observation_streaming_evidence_success_error = {{ ml_analytics_observation_log_folder_path }}/evidence/

// file path for loggers for observation evidence\

observation_status_success_error = {{ ml_analytics_observation_log_folder_path }}/status/

// file path for loggers for observation status\

project_success_error = {{ ml_analytics_project_log_folder_path }}/

// file path for loggers for project\

survey_evidence_streaming_success_error = {{ ml_analytics_survey_log_folder_path }}/evidence/

// file path for loggers for survey evidence\

survey_streaming_success_error = {{ ml_analytics_survey_log_folder_path }}/

// file path for loggers for survey streaming\

survey_status_success_error = {{ ml_analytics_survey_log_folder_path }}/status/

// file path for loggers for survey status \

[ORACLE]

endpoint_url = {{ ml_ORACLE_endpoint_url }}

// ORACLE endpoint url\

access_key = {{ ml_ORACLE_access_key }}

// ORACLE access key\

secret_access_key = {{ ml_ORACLE_secret_access_key }}

// ORACLE secret access key\

region_name = {{ ml_ORACLE_region_name }}

// ORACLE region name

bucket_name = {{ ml_ORACLE_bucket_name }}

// ORACLE bucket name \

[GCP]

secret_data = {{ ml_GCP_secret_json_file }}

// GCP secret json file path

bucket_name = {{ ml_GCP_bucket_name }}

// GCP bucket name \

[AWS]

service_name = {{ ml_AWS_service_name }}

// AWS service name\

access_key = {{ ml_AWS_access_key }}

// AWS access key

secret_access_key = {{ ml_AWS_secret_access_key }}

// AWS secret access key

region_name = {{ ml_AWS_region_name }}

// AWS region name

bucket_name = {{ ml_AWS_bucket_name }}

// AWS bucket name \

[AZURE]

account_name = {{ ml_analytics_azure_account_name }}

// Azure account name\

sas_token = {{ ml_analytics_azure_sas_token }}

// Azure sas token\

container_name = {{ ml_analytics_azure_container_name }}

// Azure container name \

account_key = {{ ml_analytics_azure_account_key }}

// Azure account key \

[OUTPUT_DIR]

project = {{ ml_analytics_project_output_dir }}

// file path for project\

observation_status = {{ ml_analytics_observation_status_output_dir }}

// file path for observation status\

observation_distinctCount_status = {{ ml_analytics_obs_distinctCnt_output_dir }}

// file path for observation distinct Count status\

observation_distinctCount_domain = {{ ml_analytics_obs_distinctCnt_domain_output_dir }}

// file path for observation distinct Count domain\

observation_distinctCount_domain_criteria = {{ ml_analytics_obs_distinctCnt_domain_criteria_output_dir }}

// file path for observation distinct Count domain criteria\

projects_distinctCount = {{ ml_analytics_projects_distinctCnt_output_dir }}

// file path for project distinct Count \

projects_distinctCount_prgmlevel = {{ ml_analytics_projects_distinctCnt_prglevel_output_dir }}

// file path for project distinct Count program level\

project_rollup = {{ ml_analytics_project_rollup_output_dir }}

// file path for project rollup \

observation_status_rollup = {{ ml_analytics_observation_status_rollup_output_dir }}

// file path for observation status rollup\

survey_rollup = {{ ml_analytics_survey_rollup_output_dir }}

// file path for survey rollup\

survey_status = {{ ml_analytics_survey_status_output_dir }}

// file path for survey status\

observation_sub_ids = {{ ml_analytics_observation_submission_id_filepath }}

// file path for observation submission ID\

observation_druid_data = {{ ml_analytics_observation_batchupdate_output_dir }}

// file path for observation batch update for druid

survey_sub_ids = {{ml_analytics_survey_submission_id_filepath}}

// file path for survey submission ID

survey_druid_data = {{ml_analytics_survey_batchupdate_output_dir}}

// file path for survey druid data

program_text_file = {{ml_analytics_project_program}}

// file path for project program ID \

[VAM]

druid_query_url = {{ ml_druid_query_data }}

// Druid query URL

program_dashboard_data = {{ ml_program_dashboard_data }}

// Program Dash board data \

[COMMON]

cloud_module_path = {{ ml_analytics_cloud_package_path }}

// File path for cloud class

observation_blob_path = {{ ml_analytics_observation_azure_blob_path }}

// File path for observation in cloud\

projects_blob_path = {{ ml_analytics_project_azure_blob_path }}

// File path for project in cloud \

observation_distinctCount_blob_path = {{ ml_analytics_obs_distinctCnt_azure_blob_path }}

// File path for observation distinct Count in cloud\

observation_distinctCount_domain_blob_path = {{ ml_analytics_obs_distinctCnt_domain_azure_blob_path }}

// File path for observation distinct Count domain in cloud\

observation_distinctCount_domain_criteria_blob_path = {{ ml_analytics_obs_distinctCnt_domain_criteria_azure_blob_path }}

// File path for observation distinct Count domain criteria in cloud\

projects_distinctCnt_blob_path = {{ ml_analytics_projects_distinctCnt_azure_blob_path }}

// File path for project distinct Count in cloud\

projects_distinctCnt_prgmlevel_blob_path = {{ ml_analytics_projects_distinctCnt_prglevel_azure_blob_path }}

// File path for project program level distinct Count in cloud\

projects_rollup_blob_path = {{ ml_analytics_project_rollup_azure_blob_path }}

// File path for project rollup in cloud \

observation_rollup_blob_path = {{ ml_analytics_observation_rollup_azure_blob_path }}

// File path for observation rollup in cloud \

survey_rollup_blob_path = {{ ml_analytics_survey_rollup_azure_blob_path }}

// File path for survey rollup in cloud \

survey_blob_path = {{ ml_analytics_survey_azure_blob_path }}

// File path for survey in cloud \

projects_program_csv = {{ ml_analytics_program_dashboard_azure_blob_path }}

// File path for project program ID in cloud

observation_batch_ingestion_data_del = {{ ml_analytics_observation_batchupdate_azure_blob_path }}

// File path for observation batch data delete in cloud\

survey_batch_ingestion_data_del = {{ml_analytics_survey_batchupdate_azure_blob_path}}

// File path for survey batch data delete in cloud

cname_url = {{ ml_analytics_cname_url }}

// Cname URL

nvsk_imp_projects_data_local_path = {{ ml_analytics_nvsk_imp_projects_data_local_path }}

// File path for NVSK in local

nvsk_imp_projects_data_blob_path = {{ ml_analytics_nvsk_imp_projects_data_blob_path }}

// File path for NVSK in cloud

nvsk_imp_projects_state_data_local_path = {{ ml_analytics_nvsk_imp_projects_state_data_local_path }}

// File path for NVsK state level data in local

nvsk_imp_projects_state_data_blob_path = {{ ml_analytics_nvsk_imp_projects_state_data_blob_path }}

// File path for NVSK state level data in cloud\

[API_CREDENTIALS]

client_id = {{ ml_analytics_client_id }}

// Client ID for Reports Portal HawkEye API's\

client_secret = {{ ml_analytics_client_secret }}

// Client secret ID for Reports Portal HawkEye API's\

grant_type = {{ ml_analytics_grant_type }}

// Grant type for Reports Portal HawkEye API's

username = {{ ml_analytics_username }}

// User Name for Reports Portal HawkEye API's

password = {{ ml_analytics_password }}

// Password Reports Portal HawkEye API's\

[REPORTS_FILEPATH]

script_path = {{ ml_analytics_script_path }}

// File path for report creation \

[JSON_VARIABLE]

createdBy = {{ ml_analytics_createdBy }}

// report creator user ID

container = {{ ml_analytics_reports_container }}

// container name for HawkEye reports

store = {{ ml_analytics_reports_sore }}

// store name for HawkEye reports

key = {{ ml_analytics_reports_key }}

// key for HawkEye reports

\

\