V1 Templates in Ekstep

This document contains details about the older v1 templates available in ekstep. It provides information about how to

Create and upload templates.
Create questions(MCQ, FTB and MTF) in ekstep portal.
How to debug template issues.

Types of templates

MCQ
FTB
MTF

How to create questions using templates

Login to dev.ekstep.in or qa.ekstep.in
Click on Resources → Question Bank'
It will show you the list of available templates and the preview
To create a new question, Click on Add Question
And select a template and click start creating
1. For FTB,
  - Enter the question text, the question text may be the title for the question or may be the question itself.
  - Enter the answer text, the answer text can be single or multiple
  - It may have the additional Model field to be filled for some templates.
  - For some templates, the questions and answers can be generated randomly.
2. For MCQ,
  - Enter the question text, the question text may be the title for the question or may be the question itself.
  - Enter the answer text, the answer text can be single or multiple
  - It may have the additional Model field to be filled for some templates.
  - For some templates, the questions and answers can be generated randomly.
3. For MTF,
  - Enter the question text, the question text may be the title for the question or may be the question itself.
  - Enter the answer text, the answer text can be single or multiple
  - It may have the additional Model field to be filled for some templates.
  - For some templates, the questions and answers can be generated randomly.
Click on "save" and "save & create another"
The created question will be available in the question bank.

List of available v1 templates in QA and Production

Measuring Angles
Number Chart
Place Value In Numbers
MCQ - General
Comparing Angles
Horizontal Operations with Place Value Models
Vertical Operations with Place Value Models
Comparing Numbers
Place Value Bundles
Comparing Size
Counting Objects
Comparing Quantities
Place Value Models - Learn
Text Question, Text Options (Vertical)
Text + Image Question, Text or Image Options
Counting with Place Value Models - 1
Counting with Place Value Models - 2
Image Question, Image or Audio Option
Mcq long text
Sequencing
TEXT AND IMAGE MATCHING (HORIZONTAL)
Text and Image Matching (Vertical)
Reordering Letters & Numbers
Sorting Template
Reordering Words
Operations with images
Fill in the Blanks (with Image) - Word Answers
Vertical Operations
Division
Addition/Subtraction (with place value markers)
Addition/Subtraction
Multiplication (with parametrization)
Fill in the Blank - Number Answers
Multiplication
Sudoku
Multiple Blanks
Division
Vertical Operations
Fill in the Blank (sentence) - Number Answers
Custom Keyboard

How to debug templates in browser

Clone the content-player(https://github.com/project-sunbird/sunbird-content-player) repo of sunbird.
Inside content-player → player → public → fixture-stories, Add your template folder containing (index.ecml, assets etc)
Inside content-player → player → app-data → fixture-content-list.json, Add the below object structure to the json object result → contnet

{
"identifier": "template-name",
"mimeType": "application/vnd.ekstep.ecml-archive",
"localData": {
"questionnaire": null,
"appIcon": "fixture-stories/template_folder_name/logo.png",
"subject": "literacy_v2",
"description": "epub - Beyond Good and Evil",
"name": "Custom Eval",
"downloadUrl": "",
"checksum": null,
"loadingMessage": "Without requirements or design, programming is the art of adding bugs to an empty text file. ...",
"concepts": [{
"identifier": "LO1",
"name": "Receptive Vocabulary",
"objectType": "Concept"
}],
"identifier": "org.ekstep.customeval",
"grayScaleAppIcon": null,
"pkgVersion": 1
},
"isAvailable": true,
"path": "fixture-stories/custom_eval"
},

In the browser, click on the template logo you added for the template, the player will show the template, If the ECML is valid.
Inside content-player → player, Open command prompt and type "node app.js" and press enter.
In the browser type "localhost:3000".

How to create templates

Create a folder with the template name. The template folder structure should contain
- assets
  - images.png
- widgets
  - css
    - index.css
  - js
    - index.js
- items
  - assessment.json
- index.ecml

Assets folder contains images required for the template
Widgets folder contains additional js and css required for the template
Items folder contains assessment.json file which is used by the template
index.ecml contains the ECML for the template. The basic structure of the template is
- <theme id="theme" startStage="splash" ver="0.2">
  <manifest>
  <media id="id" src="image.png" type="image"/>
  </manifest>
  <stage id="baseStage" preload="true">
  <image asset="image"/>
  </stage>
  <controller id="assessment" name="assessment" type="items"/>
  <template id="tempalate_name">
  </template>
  <stage h="100" id="splash" iterate="assessment" var="item" w="100" x="0" y="0" preload="true">
  <param name="next" value="stage1"/>
  <g h="88" w="76" x="12" y="0">
  <embed template="item" var-item="item"/>
  </g>
  </stage>
  <stage h="100" id="stage1" w="100" x="0" y="0" preload="true">
  <param name="next" value="stage2"/>
  <param name="previous" value="splash"/>
  <image assest="image">
  </stage>
  <stage h="100" id="stage2" w="100" x="0" y="0" preload="true">
  <param name="previous" value="stage1"/>
  <image assest="image">
  </stage>
  </theme>
Tags used in ECML
- theme - Which is the entry point of the ecml. It should specify the id as theme and the stage which is to be rendered first.
- manifest - it contains the media tags of medias(images, audio), js and css files used inside the template
- media - it is used to include the medias(images, audio), js and css files used inside the template
- stage - this tag specifies each screen inside the renderer. One can add multiple stages. The start stage should be "splash" and should be included in the theme tag. If you want to include the json add attribute iterate and var = item
- embed - Embed tag is used to embed the template inside the stage
- param - name attribute of param can be next, previous to specify the navigation to the next and previous stages.
- controller - this tag is used to include the json file inside the items folder. specify the json file name as id and name attribute.
- template - contains unique id for the template and the tag contains various tags which specify the UI for the template.
assessment.json
- For MCQ
  - {
    "identifier": "template_name",
    "title": "template_name",
    "total_items": 1,
    "shuffle": false,
    "max_score": 1,
    "subject": "LIT",
    "item_sets": [{
    "id": "set_1",
    "count": 1
    }],
    "items": {
    "set_1": [{
    "identifier": "protractor.que1",
    "qid": "protractor.que1",
    "type": "MCQ",
    "template_id": "template_name",
    "template": "template_name",
    "title": "Question text here",
    "question_audio": "",
    "question": "Question_title",
    "model" : {
    "angleRange":"0-180" // for example, and it can be anything depands on the model
    },
    "question_image": "angle_img",
    "options": [{
    "value": {
    "type": "mixed",
    "text": "120",
    "audio": "",
    "image": "",
    "asset": ""
    }
    }, {
    "value": {
    "type": "mixed",
    "text": "180",
    "audio": "",
    "image": "",
    "asset": ""
    }
    },{
    "value": {
    "type": "mixed",
    "text": "75",
    "audio": "",
    "image": "",
    "asset": ""
    },
    "answer": true
    }]
    }
    }
- For FTB
  - {
    "identifier": "template_name",
    "title": "template_name",
    "total_items": 1,
    "shuffle": false,
    "max_score": 1,
    "subject": "LIT",
    "item_sets": [{
    "id": "set_1",
    "count": 1
    }],
    "items": {
    "set_1": [{
    "identifier": "protractor.que1",
    "qid": "protractor.que1",
    "type": "MCQ",
    "template_id": "template_name",
    "template": "template_name",
    "title": "Question text here",
    "question_audio": "",
    "question": "Question_title",
    "model: {
    "keys": "A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z"
    },
    "answer": {
    "ans1": {
    "value": "जजज",
    "score": 1
    }
    }
    }
    }
- For MTF
  - {
    "identifier": "template_name",
    "title": "template_name",
    "total_items": 1,
    "shuffle": false,
    "max_score": 1,
    "subject": "LIT",
    "item_sets": [{
    "id": "set_1",
    "count": 1
    }],
    "items": {
    "set_1": [{
    "identifier": "protractor.que1",
    "qid": "protractor.que1",
    "type": "MCQ",
    "template_id": "template_name",
    "template": "template_name",
    "title": "Question text here",
    "question_audio": "",
    "question": "Question_title",
    "model" : {
    "angleRange":"0-180" // for example, and it can be anything depands on the model
    },
    "question_image": "angle_img",
    "lhs_options": [{
    "value": { "type": "mixed", "audio": "", "image": "home", "text": "" },
    "index": 0
    }, {
    "value": { "type": "mixed", "audio": "", "image": "home", "text": "" },
    "index": 1
    }, {
    "value": { "type": "mixed", "audio": "", "image": "", "text": "3" },
    "index": 2
    }, {
    "value": { "type": "mixed", "audio": "", "image": "", "text": "4" },
    "index": 3
    }, {
    "value": { "type": "mixed", "audio": "", "image": "", "text": "5" },
    "index": 4
    }, {
    "value": { "type": "mixed", "audio": "", "image": "", "text": "6" },
    "index": 5
    }],
    "rhs_options": [{
    "value": { "type": "mixed", "audio": "", "image": "home", "text": "" },
    "answer": 0
    }, {
    "value": { "type": "mixed", "audio": "", "image": "", "text": "the" },
    "answer": 1
    }, {
    "value": { "type": "mixed", "audio": "", "image": "home", "text": "" },
    "answer": 2
    } ,{
    "value": { "type": "mixed", "audio": "", "image": "", "text": "the" },
    "answer": 3
    }, {
    "value": { "type": "mixed", "audio": "", "image": "", "text": "school" },
    "answer": 4
    }, {
    "value": { "type": "mixed", "audio": "", "image": "", "text": "team." },
    "answer": 5
    }],
    }
    }

Steps to upload templates in Ekstep portal

Go inside the template folder and create a zip of the template folder.
Login to dev.ekstep.in or qa.ekstep.in
Click on "Create new lesson" button
Select "Upload a file".
Fill all the required fields
Select the Content Type as "template"
Select the Template Type as "MCQ" or "FTB" or "MTF"
Enter the template name as same as template id in the ECML.
Upload the .zip file of the template.
Then save the template and send for review.
Once it is reviewed and published by other user your template will appear in the question bank.

Steps to create the lesson by adding the questions

Login to dev.ekstep.in or qa.ekstep.in
Click on "Create new lesson" button
Select "Create new lesson".
Fill all the required fields
Click on launch editor
Click on "Add question set" plugin from the core plugins bar
Select any questions from the list or apply filter (or) search to select the required question
Provide question title, Total marks and how many number of questions to be displayed, and the toggle button to show immediate feedback and the shuffle questions
Then click on "add Question set" will add the question set to the stage.
Then click on "preview to start the assessment.
Click on dowload icon to download it to the mobile and an email will be send to the email id.
Click on the button to play the lesson inside your Genie app

Other details about templates

https://docs.google.com/spreadsheets/d/1fQ8ekSVjHG-QHTCffMa7K56WWIAXyGKnAWRSX7VgpdQ/edit?usp=sharing

https://docs.google.com/spreadsheets/d/1LvqQzHfhi4eNDl4LtBUJCqCfYBF71NwHYHO2Ko1B45k/edit#gid=1994775373

ECML Reference

https://github.com/ekstep/Common-Design/wiki/ECML-Home

https://github.com/ekstep/Common-Design/wiki/Item-Templates-V1.

Sunbird Design

V1 Templates in Ekstep

Related articles