Versions Compared

Version Old Version 10 New Version Current
Changes made by

Rajeev Sathish

Devesh Mehta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

District Mapping (SC-1373)

Jira ID - 

Jira Legacy
serverSystem JIRA
serverId2207a759-5bc8-39c5-9cd2-aa9ccc1f65dd
keySC-1373

User location-DeviceLocation Telemetry - 

Will be triggered when the user clicks submits his location.

{

  "edata": {
    "type": "CLICK",
    "subtype": "device-profile-user-declared", 
    "id": "user-state-districtConfimation", 
    "pageid": "profile",
  }
}

Possible values of fields -

1.subtype

  • "device-profile-user-declared" - the suggestion is based on the device profile and the user has not changed suggested location.
  • "device-profile-user-declared-updated" - the suggestion is based on the device profile and the user has changed location.
  • "device-profile-ip-location" - the suggestion is based on the IP location and the user has not changed the suggested location.
  • "device-profile-ip-location-updated" - the suggestion is based on the IP location and the user has changed location.
  • "user-profile" - the suggestion is based on the user location and the user has not changed the suggested location.
  • "user-profile-updated" - the suggestion is based on the user location and the user has changed the suggested location.

2. pageid - which route the popup is loaded.
   example - "profile"

Impression Event -

Will be trigged when location popup is flashing up on the screen.

{
  context: {
    env: 'user-location',
    cdata: [{id: 'user:state:districtConfimation', type: 'Feature'},
      {id: 'SC-1373', type: 'Task'}
    ]
  },
  edata: {
    type: 'view',
    pageid: "profile",
    uri: "/profile", // route from which popup is visible to user.
  }
};

Telemetry log event - 

Will be triggered for API calls to update device or user location. For error and success, both cases these telemetries should be generated. 

{
  "edata": {
    "type": "update-location", // Required. Type of log (system, process, api_access, api_call, j
    "level": "ERROR", // Required. Level of the log. TRACE, DEBUG, INFO, WARN, ERROR, FA
    "message": "Updation of device profile failed", // Required. Log message
    "pageid": "profile", // Optional. Page where the log event has happened
  }
}

Possible values of fields -

1.level

  • "ERROR" :   When api fails.
  • "SUCCESS" : When API is success.

2.message 

  • "Updation of device profile failed"  
  • "Updation of device profile success"
  • "Updation of user profile success"
  • "Updation of user profile failed"

3. pageid - which route the popup is loaded.
   example - "profile"

Teacher-ID Verification (SC-1349)

Impression Event when the popup is visible

...

languagejs
titleImpression
collapsetrue

...

District Mapping (SC-1373)

Jira ID - 

Jira Legacy
serverSystem JIRA
serverId2207a759-5bc8-39c5-9cd2-aa9ccc1f65dd
keySC-1373

User location-DeviceLocation Telemetry - 

Will be triggered when the user clicks submits his location.

{

  "edata": {
    "type": "location-changed/location-unchanged",
    "subtype": "state_dist_changed/state_changed/dist_changed", 
    "id": "submit-clicked", 
    "pageid": "location-popup",
  }
}

Possible values of fields -

1.type

  • "location-changed" - if location is changed.
  • "location-unchanged" - if location is un changed.

Impression Event -

Will be trigged when location popup is flashing up on the screen.

{
  context: {
    env: 'user-location',
    cdata: [{id: 'user:state:districtConfimation', type: 'Feature'},
      {id: 'SC-1373', type: 'Task'}
    ]
  },
  edata: {
    type: 'view',
    pageid: "location-popup",
    uri: "/profile", // route from which popup is visible to user.
  }
};

Telemetry log event - 

Will be triggered for API calls to update device or user location. For error and success, both cases these telemetries should be generated. 

{
  "edata": {
    "type": "update-location", // Required. Type of log (system, process, api_access, api_call, j
    "level": "ERROR", // Required. Level of the log. TRACE, DEBUG, INFO, WARN, ERROR, FA
    "message": "Updation of device profile failed", // Required. Log message
    "pageid": "location-popup", // Optional. Page where the log event has happened
  }
}


Possible values of fields -

1.level

  • "ERROR" :   When api fails.
  • "SUCCESS" : When API is success.

Teacher-ID Verification (SC-1349)

Impression Event when the popup is visible

Code Block
languagejs
titleImpression
collapsetrue
{
      "eid": "IMPRESSION",
      "ets": 1575542490098,
      "ver": "3.0",
      "mid": "IMPRESSION:04a571d699d378b3db912ad9ab026820",
      "actor": {
        "id": "30ac4ca6-20b4-4e09-82cc-06758b6e624c",
        "type": "User"
      },
      "context": {
        "channel": "01285019302823526477",
        "pdata": {
          "id": "dev.sunbird.portal",
          "ver": "2.6.0",
          "pid": "sunbird-portal"
        },
        "env": "user-verification",
        "sid": "YieKCuJsgkgt0_hyc5i_GzGKeGlMeKrR",
        "did": "bfb7c01a5fd1fca853a6d22e64e38db3",
        "cdata": [
          {
            "id": "user:state:teacherId",
            "type": "Feature"
          },
          {
            "id": "SC-1349",
            "type": "Task"
          }
        ],
        "rollup": {
          "l1": "01285019302823526477"
        },
        "uid": "30ac4ca6-20b4-4e09-82cc-06758b6e624c"
      },
      "object": {
        
      },
      "tags": [
        "01285019302823526477"
      ],
      "edata": {
        "type": "view",
        "pageid": "user-verification-popup",
        "uri": "/learn"
      }
  }

Following Intrect Events for each button click

1.When User clicks on the NO button

Code Block
languagejs
titleIntrect event for NO button Click
collapsetrue
{ 
         "eid": "IMPRESSIONINTERACT",
         "ets":1575536161454,
  1575536639424,       "ver": "3.0",
         "mid": "IMPRESSIONINTERACT:295e3054a98a8004e38c58f6bb5174a6dbabb17de9891a20d9a70820fc7eaa10",
         "actor":{ 
   {         "id": "c79daa2830ac4ca6-423f20b4-422b4e09-b3bb82cc-e0b261f2c6e506758b6e624c",
            "type": "User"
      },   },
         "context":{ 
   {         "channel": "0128261234530222089301285019302823526477",
            "pdata":{ 
    {           "id": "stagingdev.dikshasunbird.portal",
               "ver": "2.6.0",
               "pid": "sunbird-portal"
            },
            "env": "user-verification",
            "sid": "uPbfJt7ZWfRPQCc8p31omxaVHM2ph_akuWvg13UT2jPih2SIU4IVs4VOOF9F62x2",
            "did": "4c5539d54424a290856c7006228e75511df8f400acfbd15c2e8baedb0b5e9928",
            "cdata": [
      			{
            ]			id: 'user:state:teacherId',
        "uid": "c79daa28-423f-422b-b3bb-e0b261f2c6e5"			type: 'Feature'
      			},
      "object": 			{
        			id: 'SC-1349',
     },   			type: 'Task'
  "tags": [   			}
     "01282612345302220893"
		],
     ],       "edatarollup": {
 
      "type": "view",         "pageidl1": "user-verification",01285019302823526477"
           "uri": "/resources", },
       }     }

Following Intrect Events for each button click

1.When User clicks on the NO button

Code Block
languagejs
titleIntrect event for NO button Click
collapsetrue
{"uid":"30ac4ca6-20b4-4e09-82cc-06758b6e624c"
          "eid":"INTERACT"},
         "etsobject":1575536161454,{ 
         "ver":"3.0"},
         "midtags":"INTERACT:dbabb17de9891a20d9a70820fc7eaa10",[ 
            "actor":{01285019302823526477"
         ],
         "idedata":"30ac4ca6-20b4-4e09-82cc-06758b6e624c",{ 
            "typeid":"User"
    ext-user-verify-reject",
    },          "contexttype":{"click",
             "channelpageid":"01285019302823526477user-verification-popup",
         }
  "pdata":{ 
  }

2. When User clicks on the YES button

Code Block
languagejs
titleIntrect Event for the Yes button click
collapsetrue
{ 
           "ideid":"dev.sunbird.portalINTERACT",
         "ets":1575536161454,
         "ver":"2.63.0",
         "mid":"INTERACT:dbabb17de9891a20d9a70820fc7eaa10",
         "pidactor":"sunbird-portal"{ 
            }"id":"30ac4ca6-20b4-4e09-82cc-06758b6e624c",
            "envtype":"Course",
  User"
         },
         "sidcontext":"uWvg13UT2jPih2SIU4IVs4VOOF9F62x2",{ 
            "didchannel":"1df8f400acfbd15c2e8baedb0b5e992801285019302823526477",
            "cdatapdata":[{ 
               ],"id":"dev.sunbird.portal",
               "rollupver":{"2.6.0",
                "l1pid":"01285019302823526477sunbird-portal"
            },
            "uidenv":"30ac4ca6-20b4-4e09-82cc-06758b6e624c"
         },
  user-verification",
      "object":{        "sid":"uWvg13UT2jPih2SIU4IVs4VOOF9F62x2",
  },          "tagsdid":[ "1df8f400acfbd15c2e8baedb0b5e9928",
            "01285019302823526477cdata": [
      			{
 ],       			id: 'user:state:teacherId',
 "edata":{       			type: 'Feature'
     "id":"ext-user-verify-reject" 			},
      			{
     "type":"click",   			id: 'SC-1349',
        "pageid":"user-verification-popup"
			type: 'Task'
        }
  }

2. When User clicks on the YES button

Code Block
languagejs
titleIntrect Event for the Yes button click
{ 			}
     		],
   "eid":"INTERACT",          "etsrollup":1575536161454,
{ 
       "ver":"3.0",          "midl1":"INTERACT:dbabb17de9891a20d9a70820fc7eaa10",01285019302823526477"
           "actor":{ },
            "iduid":"30ac4ca6-20b4-4e09-82cc-06758b6e624c",
         },
         "typeobject":"User"{ 
         },
         "contexttags":{[ 
            "channel":"01285019302823526477",01285019302823526477"
         ],
         "pdataedata":{ 
               "id":"dev.sunbird.portalext-user-verify-confirm",
               "vertype":"2.6.0click",
               "pidpageid":"sunbirduser-verification-portalpopup"
         }
  },}

3. When User clicks on Submit Button after entring the teacher ID

Code Block
languagejs
titleSubmit Button intract event
collapsetrue
{ 
           "enveid":"CourseINTERACT",
  
         "sidets":"uWvg13UT2jPih2SIU4IVs4VOOF9F62x2"1575536161454,
            "didver":"1df8f400acfbd15c2e8baedb0b5e99283.0",

           "cdata":[ 
            ],
            "rollup":{ 
     mid":"INTERACT:dbabb17de9891a20d9a70820fc7eaa10",
         "l1actor":"01285019302823526477"{ 
            }"id":"30ac4ca6-20b4-4e09-82cc-06758b6e624c",
            "uidtype":"30ac4ca6-20b4-4e09-82cc-06758b6e624cUser"
         },
         "objectcontext":{ 
         },   "channel":"01285019302823526477",
            "tagspdata":[{ 
               "01285019302823526477"id":"dev.sunbird.portal",
         ],          "edata":{"ver":"2.6.0",
               "idpid":"ext-user-verify-confirm",sunbird-portal"
            "type":"click"},
            "pageidenv":"user-verification-popup",
         }   }

3. When User clicks on Submit Button after entring the teacher ID

Code Block
languagejs
titleSubmit Button intract event
collapsetrue

{"sid":"uWvg13UT2jPih2SIU4IVs4VOOF9F62x2",
            "eiddid":"INTERACT1df8f400acfbd15c2e8baedb0b5e9928",
            "ets":1575536161454,
  cdata": [
      			{
        			id: 'user:state:teacherId',
        			type: 'Feature'
      "ver":"3.0",
			},
      			{
        "mid":"INTERACT:dbabb17de9891a20d9a70820fc7eaa10"			id: 'SC-1349',
         "actor":{ 			type: 'Task'
      			}
     "id":"30ac4ca6-20b4-4e09-82cc-06758b6e624c"		],
            "typerollup":"User"{ 
               "l1":"01285019302823526477"
 },          "context":{ },
            "channeluid":"01285019302823526477",30ac4ca6-20b4-4e09-82cc-06758b6e624c"
         },
   "pdata":{      "object":{ 
         "id":"dev.sunbird.portal"},
         "tags":[ 
     "ver":"2.6.0",       "01285019302823526477"
        "pid":"sunbird-portal"
 ],
         "edata":{ 
},             "envid":"Courseext-user-verify-submit",
            "sidtype":"uWvg13UT2jPih2SIU4IVs4VOOF9F62x2click",
            "didpageid":"1df8f400acfbd15c2e8baedb0b5e9928user-verification-popup",
         }
  "cdata":[ 
            ],
            "rollup":}

4. When the teacher ID is wrong and a error Modal appears and user clicks on the OK button

Code Block
languagejs
titleOK click on error pop-up
collapsetrue
{
  "eid": "INTERACT",
  "ets": 1575536161454,
  "ver": "3.0",
  "mid": "INTERACT:dbabb17de9891a20d9a70820fc7eaa10",
  "actor": {
          "id": "30ac4ca6-20b4-4e09-82cc-06758b6e624c",
     "l1type": "01285019302823526477User"
  },
  "context": {
     }"channel": "01285019302823526477",
    "pdata": {
      "uidid":"30ac4ca6-20b4-4e09-82cc-06758b6e624c" "dev.sunbird.portal",
         },
"ver": "2.6.0",
        "objectpid":{ "sunbird-portal"
    },
    }"env": "user-verification",
     "sid": "uWvg13UT2jPih2SIU4IVs4VOOF9F62x2",
    "tagsdid":[ "1df8f400acfbd15c2e8baedb0b5e9928",
    "cdata": [
      "01285019302823526477"		{
         ]		id: 'user:state:teacherId',
         "edata":{ 		type: 'Feature'
      		},
     "id":"ext-user-verify-submit",
 		{
           "type":"click"		id: 'SC-1349',
            "pageid":"user-verification-popup"
		type: 'Task'
        		}
  }

4. When the teacher ID is wrong and a error Modal appears and user clicks on the OK button

Code Block
languagejs
titleOK click on error pop-up
{
  "eid": "INTERACT",
  "ets": 1575536161454,
  "ver": "3.0",
  "mid": "INTERACT:dbabb17de9891a20d9a70820fc7eaa10",
  "actor": {  ],
    "rollup": {
      "l1": "01285019302823526477"
    },
    "iduid": "30ac4ca6-20b4-4e09-82cc-06758b6e624c",
  },
  "typeobject": "User"{
    
  },
  "contexttags": {[
    "channel":01285019302823526477"
  ],
  "01285019302823526477edata",: {
    "pdataid": {
"ext-user-verify-fail",
     "idtype": "dev.sunbird.portalclick",

     "verpageid": "2.6.0",user-verification-popup"
      "pid": "sunbird-portal"
    },
    "env": "Course",
    "sid": "uWvg13UT2jPih2SIU4IVs4VOOF9F62x2",
    "did": "1df8f400acfbd15c2e8baedb0b5e9928",
    "cdata": [
      
    ],
    "rollup": {
      "l1": "01285019302823526477"
    },}
}

5. On success of the teacher verification the success pop-up is shown and when user clicks on the ok button of this popup

Code Block
languagejs
titleOk Button click on the success pop-up
collapsetrue
{
  "eid": "INTERACT",
  "ets": 1575536161454,
  "ver": "3.0",
  "mid": "INTERACT:dbabb17de9891a20d9a70820fc7eaa10",
  "actor": {
    "uidid": "30ac4ca6-20b4-4e09-82cc-06758b6e624c"
  },
  "object": {
  
    },
  "tagstype": [
    "01285019302823526477User"
  ]},
  "edatacontext": {
    "idchannel": "ext-user-verify-fail01285019302823526477",

   "type": "click",
    "pageidpdata": "user-verification-popup"{
  } }

5. On success of the teacher verification the success pop-up is shown and when user clicks on the ok button of this popup

Code Block
languagejs
titleOk Button click on the success pop-up
collapsetrue
{   "eidid": "INTERACTdev.sunbird.portal",
  "ets": 1575536161454,   "ver": "32.6.0",
      "midpid": "INTERACT:dbabb17de9891a20d9a70820fc7eaa10",sunbird-portal"
   "actor": { },
    "idenv": "30ac4ca6-20b4-4e09-82cc-06758b6e624cuser-verification",
    "typesid": "UseruWvg13UT2jPih2SIU4IVs4VOOF9F62x2",
  },   "contextdid": {"1df8f400acfbd15c2e8baedb0b5e9928",
    "channelcdata": "01285019302823526477",[
     "pdata": 	{
      "  	id": "dev.sunbird.portal"'user:state:teacherId',
      "ver": "2.6.0",  	type: 'Feature'
      "pid": "sunbird-portal"	},
     }, 	{
   "env": "Course",     "sid": "uWvg13UT2jPih2SIU4IVs4VOOF9F62x2"	id: 'SC-1349',
    "did": "1df8f400acfbd15c2e8baedb0b5e9928",     "cdata"	type: ['Task'
      	}
    ],
    "rollup": {
      "l1": "01285019302823526477"
    },
    "uid": "30ac4ca6-20b4-4e09-82cc-06758b6e624c"
  },
  "object": {
    
  },
  "tags": [
    "01285019302823526477"
  ],
  "edata": {
    "id": "ext-user-verify-success",
    "type": "click",
    "pageid": "user-verification-popup"
  }
}

...