.png?version=1&modificationDate=1573544606587&cacheVersion=1&api=v2&height=400 "Sunbird Design > [Design] Programs on Sunbird portal > CollectionComponent (2).png")
This document describes the design for Programs to integrate with Sunbird Portal and also discusses the ability of Programs to support and launch multiple programs for various adopters.
Currently, Programs are used by a single adopter to run a specific activity within a defined scope which uses minimum configuration. It is currently used to create a specific set of content types. (Example: QuestionSet creation). By and large it is used for creation purpose.
Program portal should be able to support to launch multiple programs configured for various adopters. A program can have more than one activity. Each activity can take its own configuration. An admin of the program adopter should be able to define the scope, actions, tools etc based on the activity/purpose. Programs on the portal should be able to handle multiple active programs at a time.
Since each tool (comprises of multiple components and tools can share the same components between each other) is going to solve the purpose of each activity in a program, the program can have its configurations based on the input that each component in the tool is expecting.
Say for example, if the purpose of the program is to just see the coverage of textbooks, then the tool that is used in the program would expect a scope to be defined i.e: Board, Class, Medium, Subject, Framework. This can be the program configuration and nothing else would be required by the admin to see the coverage.
Let us take an example of a program whose purpose is to create content for different contentTypes such as PracticeSet, Explanation, Experiential, CuriositySet, etc for each chapter in a given textbook.
The workflow of the above mentioned program can be split into two parts
Creation:
In creation, a contributor with creator access visits the program and does the following actions
Review
The above listed actions can more or less be broken down into the following highlevel components.
Each component will take its own configuration and has a set of actions that the user can perform
For example:
CollectionType, Board, Class, Medium, Subject, Framework to list the textbook and it would have actions such as showFilters
Similarly, ChapterList component would expect CollectionId and List of content types as configuration and selectChapter, addResource, preview etc as actions.
.png?version=1&modificationDate=1573545196343&cacheVersion=1&api=v2&height=400 "Sunbird Design > [Design] Programs on Sunbird portal > chapterlist component (2).png")
If we put together all the component and its required configurations, actions and possible enhancements into a module/highlevel component the following would be the overall component hierarchy and configuration.
%20(1).jpg?version=1&modificationDate=1573533998659&cacheVersion=1&api=v2 "Sunbird Design > [Design] Programs on Sunbird portal > Flowchart-programs (2) (1).jpg")
With this basic set of configurations and actions a program can be created by an admin of a program.
{
"programId": "217bddc0-df59-11e9-8d82-2b7f2cdfa2fd",
"description": "Test Prep program",
"name": "Test Prep",
"slug": "sunbird",
"startDate": "2019-09-25T12:50:30.000Z",
"endDate": null,
"status": null,
"type": "private",
"roles": {
"value": [
"CONTRIBUTOR",
"REVIEWER",
"PUBLISHER"
]
},
"defaultRoles": [
"CONTRIBUTOR"
],
"onBoardingForm": {
"templateName": "onBoardingForm",
"action": "onboard",
"fields": [
{
"code": "school",
"dataType": "text",
"name": "School",
"label": "School",
"description": "School",
"inputType": "select",
"required": false,
"displayProperty": "Editable",
"visible": true,
"range": [
{
"identifier": "my_school",
"code": "my_school",
"name": "My School",
"description": "My School",
"index": 1,
"category": "school",
"status": "Live"
}
],
"index": 1
}
]
},
"header": {
"tabs": [
{
"index": 0,
"label": "Contribute Questions",
"onClick": {
"component": "collectionComponent"
},
"actionRoleMap": {
"show": {
"roles": [
"Contributor",
"Reviewer"
]
},
"drag": {
"roles": [
"Contributor",
"Reviewer"
]
}
}
},
{
"index": 1,
"label": "Issue Certificate",
"onClick": {
"component": "issueCertificateComponent"
},
"actionRoleMap": {
"show": {
"roles": [
"Reviewer"
]
}
}
},
{
"index": 2,
"label": "Dashboard",
"onClick": {
"component": "dashboardComponent"
},
"actionRoleMap": {
"show": {
"roles": [
"Admin"
]
}
}
}
]
},
"actions": {
"showFilters": {
"roles": [
"Contributor",
"Reviewer",
"Admin"
]
},
"addresource": {
"roles": [
"Contributor"
]
},
"preview": {
"roles": [
"Contributor",
"Reviewer"
]
},
"move": {
"roles": [
"Contributor"
]
},
"delete": {
"roles": [
"Contributor"
]
},
"selectChapter": {
"roles": [
"Contributor",
"Reviewer"
]
},
"showTotalContribution": {
"lable": "Total Contributoion",
"roles": [
"Contributor",
"Reviewer"
]
},
"showMyContribution": {
"lable": "My Contribution",
"roles": [
"Contributor"
]
},
"showRejected": {
"lable": "Rejected",
"roles": [
"Contributor"
]
},
"showUnderReview": {
"lable": "Under Review",
"roles": [
"Contributor"
]
},
"showtotalUnderReview": {
"lable": "Total under review",
"roles": [
"Reviewer"
]
},
"showAcceptedByMe": {
"lable": "Rejected by me",
"roles": [
"Reviewer"
]
},
"showRejectedByMe": {
"lable": "Accepted by me",
"roles": [
"Reviewer"
]
},
"savePracticeSet": {
"roles": [
"Contributor"
]
},
"previewPracticeSet": {
"roles": [
"Contributor",
"Reviewer"
]
},
"submitPracticeSet": {
"roles": [
"Contributor"
]
},
"deletePracticeSet": {
"roles": [
"Contributor"
]
},
"acceptPracticeSet": {
"roles": [
"Reviewer"
]
},
"rejectPracticeSet": {
"roles": [
"Reviewer"
]
},
"addQuestionPracticeSet": {
"roles": [
"Contributor"
]
},
"addSolutionPracticeSet": {
"roles": [
"Contributor"
]
},
"changeUploadFile": {
"roles": [
"Contributor"
]
},
"submitUpload": {
"roles": [
"Contributor"
]
},
"acceptUpload": {
"roles": [
"Reviewer"
]
},
"rejectUpload": {
"roles": [
"Reviewer"
]
},
"showPreview": {
"roles": [
"Contributor",
"Reviewer"
]
},
"showDashboard": {
"roles": [
"Admin"
]
},
"reportSelection": {
"label": "Select Report"
},
"reportContentTypeSelection": {
"label": "Select Content-Type"
},
"reportDownload": {
"label": "Download"
},
"reportRefresh": {
"label": "Refresh"
}
},
"config": {
"filters": {
"implicit": [
{
"code": "framework",
"defaultValue": "NCF",
"label": "Framework",
"visibility": false
},
{
"code": "board",
"defaultValue": "AP",
"label": "Board",
"visibility": false
},
{
"code": "medium",
"defaultValue": "English",
"label": "Medium",
"visibility": false
}
],
"explicit": [
{
"code": "class",
"range": [
"Class 6",
"Class 7",
"Class 8"
],
"label": "Class",
"multiselect": false,
"defaultValue": [
"Class 6"
],
"visibility": true
},
{
"code": "subject",
"range": [
"English",
"Maths"
],
"label": "Subject",
"multiselect": false,
"defaultValue": [
"English"
],
"visibility": true
}
]
},
"groupBy": {
"value": "Subject",
"defaultValue": "Class"
},
"contentTypes": {
"value": [
{
"name": "Explanation",
"contentType": "ExplanationResource",
"mimeType": [
"application/pdf"
],
"thumbnail": "",
"description": "description",
"marks": 5,
"resourceType": "",
"Audience": "",
"formConfiguration": [
{
"code": "LearningOutcome",
"range": [],
"label": "Learning Outcome",
"multiselect": true
},
{
"code": "bloomslevel",
"range": [],
"label": "Learning Level",
"multiselect": true
}
],
"filesConfig": {
"accepted": "pdf",
"size": "50"
}
},
{
"name": "Experimental",
"contentType": "ExperientialResource",
"mimeType": [
"video/mp4",
"video/webm",
"video/x-youtube"
],
"thumbnail": "",
"description": "description",
"marks": 5,
"resourceType": "",
"Audience": "",
"formConfiguration": [
{
"code": "LearningOutcome",
"range": [],
"label": "Learning Outcome",
"multiselect": true
},
{
"code": "bloomslevel",
"range": [],
"label": "Learning Level",
"multiselect": true
}
],
"filesConfig": {
"accepted": "mp4, webm, youtube",
"size": "50"
}
},
{
"name": "Practice Sets",
"contentType": "PracticeQuestionSet",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"questionCategories": [
"vsa",
"sa",
"la",
"mcq"
],
"thumbnail": "",
"description": "description",
"marks": 5,
"resourceType": "",
"Audience": "",
"formConfiguration": [
{
"code": "LearningOutcome",
"range": [],
"label": "Learning Outcome",
"multiselect": true
},
{
"code": "bloomslevel",
"range": [],
"label": "Learning Level",
"multiselect": true
}
]
},
{
"name": "Curiosity",
"contentType": "CuriosityQuestionSet",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"questionCategories": [
"curiosity"
],
"thumbnail": "",
"description": "description",
"marks": 5,
"resourceType": "",
"Audience": "",
"formConfiguration": [
{
"code": "LearningOutcome",
"range": [],
"label": "Learning Outcome",
"multiselect": true
},
{
"code": "bloomslevel",
"range": [],
"label": "Learning Level",
"multiselect": true
}
]
}
],
"defaultValue": [
{
"name": "Practice Sets",
"contentType": "PracticeQuestionSet",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"questionCategories": [
"vsa",
"sa",
"la",
"mcq"
],
"thumbnail": "",
"description": "description",
"marks": 2,
"resourceType": "",
"Audience": "",
"formConfiguration": [
{
"code": "LearningOutcome",
"range": [],
"label": "Learning Outcome",
"multiselect": false
},
{
"code": "bloomslevel",
"range": [],
"label": "Learning Level",
"multiselect": true
}
]
}
]
},
"textbookList": [],
"filesConfig": {
"accepted": "pdf, mp4, webm, youtube",
"size": "50"
},
"practiceSetConfig": {
"No of options": 4,
"solutionType": [
"Video",
"Text & image"
],
"questionCategory": [
"vsa",
"sa",
"ls",
"mcq",
"curiosity"
]
},
"formConfiguration": [
{
"code": "LearningOutcome",
"range": [],
"label": "Learning Outcome",
"multiselect": false
},
{
"code": "bloomslevel",
"range": [],
"label": "Learning Level",
"multiselect": true
}
]
}
} |