FAQ's
There is a configuration to disable/enable the "Add from Library" feature at any level/unit in the hierarchy.
Let's say you want to disable this feature for level1 and enable it for level2 then pass an empty object value to level1 as below:
hierarchy.level1.children{
"objectCategoryDefinition": {
"objectMetadata": {
"config": {
"sourcingSettings": {
"collection": {
"maxDepth": 2,
"objectType": "Collection",
"primaryCategory": "Digital Textbook",
"isRoot": true,
"iconClass": "fa fa-book",
"children": {},
"hierarchy": {
"level1": {
"name": "Textbook Unit",
"type": "Unit",
"mimeType": "application/vnd.ekstep.content-collection",
"contentType": "TextBookUnit",
"primaryCategory": "Textbook Unit",
"iconClass": "fa fa-folder-o",
"children": {}
},
"level2": {
"name": "Section",
"type": "Unit",
"mimeType": "application/vnd.ekstep.content-collection",
"contentType": "TextBookUnit",
"primaryCategory": "Textbook Unit",
"iconClass": "fa fa-folder-o",
"children": {
Content: [
'Explanation Content',
'Learning Resource',
'eTextbook',
'Teacher Resource',
'Course Assessment'
]
}
}
}
}
}
},
"schema": {
....
}
},
"forms": {
....
}
}
}
}
The current implementation supports using the editor with Angular framework. However, adopters can create custom integrations to work with other frameworks such as React, Vue etc.
The config for new fields has to be added in the object category definition. This can be done at the system level or at the individual channel level.
Suppose you want to add a name field in the metadata field, it can be added as:
"objectCategoryDefinition": {
"identifier": "obj-cat:digital-textbook_collection_all",
"objectMetadata": {
"config": {
...
...
},
...
...
},
...
"name": "Digital Textbook",
"forms": {
"create": {
...
...
"properties": [
{
"code": "name",
"dataType": "text",
"description": "Name of the collection",
"editable": true,
"inputType": "text",
"label": "Name",
"name": "Name",
"placeholder": "Enter name of the collection",
"renderingHints": {
"class": "sb-g-col-lg-1 required"
},
"required": true,
"visible": true,
"validations": [
{
"type": "maxLength",
"value": "120",
"message": "Input is Exceeded"
},
{
"type": "required",
"message": "Name is required"
}
]
}
]
}
}
}
Attributes/collection behavior can be modified based on the unit level as well. It can be updated in the object category definition of the collection under the unit metadata form. Under unit metadata, the attributes or the behavior can be defined. Each field has a code and it can be updated with the collection configuration.
Here's the sample configuration for the Digital textbook:
{
"objectCategoryDefinition":{
"identifier":"obj-cat:digital-textbook_collection_all",
"objectMetadata":{
"config":{
...
},
"schema":{
...
}
},
"name":"Digital Textbook",
"forms":{
"unitMetadata":{
"templateName":"",
"required":[
],
"properties":[
{
"name":"First Section",
"fields":[
{
"code":"name",
"dataType":"text",
"description":"Name of the content",
"editable":true,
"inputType":"text",
"label":"Title",
"name":"Title",
"placeholder":"Title",
"renderingHints":{
"class":"sb-g-col-lg-1 required"
},
"required":true,
"visible":true,
"validations":[
{
"type":"maxLength",
"value":"120",
"message":"Input is Exceeded"
},
{
"type":"required",
"message":"Title is required"
}
]
},
{
"code":"description",
"dataType":"text",
"description":"Description of the content",
"editable":true,
"inputType":"textarea",
"label":"Description",
"name":"Description",
"placeholder":"Description",
"renderingHints":{
"class":"sb-g-col-lg-1"
},
"required":false,
"visible":true,
"validations":[
{
"type":"maxLength",
"value":"256",
"message":"Input is Exceeded"
}
]
},
{
"code":"keywords",
"visible":true,
"editable":true,
"dataType":"list",
"name":"Keywords",
"renderingHints":{
"class":"sb-g-col-lg-1"
},
"description":"Keywords for the content",
"inputType":"keywords",
"label":"Keywords",
"placeholder":"Input the keyword and PRESS enter",
"required":false,
"validations":[
]
},
{
"code":"topic",
"visible":true,
"depends":[
],
"editable":true,
"dataType":"list",
"renderingHints":{
},
"name":"Topic",
"description":"Choose a Topics",
"index":11,
"inputType":"topicselector",
"label":"Topics",
"placeholder":"Choose Topics",
"required":false,
"validations":[
]
}
]
}
]
}
}
}
}
When the reviewer tries to publish the collection, a dialog with the list of items in the checklist is shown. The reviewer has to check all the items before the collection can be published.
In case there is no checklist configured, a standard confirmation dialog is shown.
The checklist is currently configured at a tenant level. It can be updated in the object category definition of the collection under the publish checklist form.
{
"objectCategoryDefinition": {
"identifier": "obj-cat:digital-textbook_collection_all",
"objectMetadata": {
"config": {
...
},
"schema": {
...
}
},
"name": "Digital Textbook",
"forms": {
"publishchecklist": {
"templateName": "",
"required": [],
"properties": [
{
"name": "Appropriateness",
"renderingHints": {
"class": "d-grid-inline-3 display-sectionName"
},
"fields": [
{
"code": "appropriatenessOne",
"name": "No Hate speech, Abuse, Violence, Profanity",
"label": "No Hate speech, Abuse, Violence, Profanity",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "appropriatenessTwo",
"name": "No Sexual content, Nudity or Vulgarity",
"label": "No Sexual content, Nudity or Vulgarity",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "appropriatenessThree",
"name": "No Discrimination or Defamation",
"label": "No Discrimination or Defamation",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "appropriatenessFour",
"name": "Is suitable for children",
"label": "Is suitable for children",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
}
]
},
{
"name": "Content details",
"renderingHints": {
"class": "d-grid-inline-3 display-sectionName"
},
"fields": [
{
"code": "contentdetailsOne",
"name": "Appropriate Title, Description",
"label": "Appropriate Title, Description",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "contentdetailsTwo",
"name": "Correct Board, Grade, Subject, Medium",
"label": "Correct Board, Grade, Subject, Medium",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "contentdetailsThree",
"name": "Appropriate tags such as Resource Type, Concepts",
"label": "Appropriate tags such as Resource Type, Concepts",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "contentdetailsFour",
"name": "Relevant Keywords",
"label": "Relevant Keywords",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
}
]
},
{
"name": "Usability",
"renderingHints": {
"class": "d-grid-inline-3 display-sectionName"
},
"fields": [
{
"code": "usabilityOne",
"name": "Content plays correctly",
"label": "Content plays correctly",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "usabilityTwo",
"name": "Can see the content clearly on Desktop and App",
"label": "Can see the content clearly on Desktop and App",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "usabilityThree",
"name": "Audio (if any) is clear and easy to understand",
"label": "Audio (if any) is clear and easy to understand",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "usabilityFour",
"name": "No Spelling mistakes in the text",
"label": "No Spelling mistakes in the text",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
},
{
"code": "usabilityFive",
"name": "Language is simple to understand",
"label": "Language is simple to understand",
"dataType": "boolean",
"inputType": "checkbox",
"editable": true,
"required": false,
"visible": true,
"validations": [
{
"type": "required",
"message": ""
}
],
"renderingHints": {
"class": "sb-g-col-lg-1"
}
}
]
}
]
},
"review": {},
"update": {}
}
}
}
Last modified 1yr ago