LogoLogo
  • LEARN
    • Overview
    • Capabilities
      • Rich and Diverse Assets
      • Organised Collections
      • Asset Lifecycle Management
      • Powerful Discovery
      • Phygital Discovery
      • Observability
    • Technical Architecture
    • Product & Developer Guide
      • Content Service
        • Content APIs
          • Features
          • Architecture
          • Code Structure
          • Schemas
          • APIs
          • Jobs
            • Content publish
            • Asset enrichment
            • Audit event generator
            • Video stream generator
          • FAQs
            • Upload Content
        • Media APIs
          • Features
          • Architecture
          • Schemas
          • APIs
          • Jobs
            • Asset enrichment
            • Audit event generator
          • FAQs
        • Channel APIs
          • Architecture
          • Schema
          • APIs
          • Configuration
          • FAQs
        • License APIs
          • Architecture
          • Schema
          • APIs
          • Configuration
          • FAQs
        • Collection APIs
          • Features
          • Architecture
          • Schemas
          • APIs
          • Jobs
            • Content publish
            • Post publish processor
            • Audit event generator
          • FAQs
      • Search Service
        • Architecture
        • Code Structure
          • Configuration
        • APIs
        • Jobs
          • Search indexer
          • Audit history indexer
        • FAQs
      • Taxonomy Service (Taxonomy & Tagging)
        • Framework APIs
          • Architecture
          • Code Structure
            • Configuration
          • Schemas
          • APIs
          • Jobs
            • Audit event generator
          • FAQs
            • Create Framework
            • Add Content to Framework
        • Object Category APIs
          • Architecture
          • Code Structure
          • Schemas
          • APIs
          • Jobs
            • Audit event generator
          • Configuration
          • FAQs
      • DIAL Service
        • Architecture
        • APIs
        • Jobs
        • Configuration
        • FAQs
          • Link DIAL Code to a Book
      • Player
        • V1
          • Features
          • Architecture
          • Players
            • ECML Player - v1
              • Quiz
              • Create Content
            • Video Player v1
            • Epub Player - v1
            • PDF Player - v1
            • HTML-h5p Player - v1
          • Content import and preview folder creation
          • FAQs
        • V2
          • PDF Player
            • Features
            • Architecture
            • Configuration
            • FAQ's
          • Epub Player
            • Features
            • Architecture
            • Configuration
            • FAQ's
          • Video Player
            • Features
            • Architecture
            • Configuration
            • FAQ's
        • Telemetry Events
          • Offline Telemetry
          • Generate API keys
      • Editors
        • Architecture
        • Interactive Editor
          • Features
            • Content Editor
            • Adding Question Set
            • Concept Selector
            • Add Image
            • Add Video
            • Adding Math Function
            • Limited Publishing and Sharing
        • File Upload Editor
          • Features
          • FAQ's
            • Content Upload
        • Collection Editor - V1
        • Collection Editor - V2
          • Features
          • Architecture
          • APIs
          • FAQ's
        • How to contribute as a JS plugin
          • How do I think about a plugin?
          • Interactive Editor Plugin Guide
          • Using SDK to create and test the plugin
      • Other Knowlg Jobs
        • Configuration
        • FAQs
      • Other
        • Data Migration
        • Schema strucure
    • Product Roadmap
  • ENGAGE
    • Discuss
    • Contribute to SB Knowlg
  • USE
    • Overview
    • System requirements
    • Installation guide
      • Players
        • V1
          • How to setup
        • V2
          • Epub Player
          • Video Player
          • Pdf Player
      • Editors
        • Interactive Editor
        • File Upload Editor
        • Collection Editor - V1
        • Collection Editor - V2
        • Plugins
      • Services
        • Content Service
          • Configuration
        • Search Service
        • Taxonomy Service (Taxonomy & Tagging)
        • DIAL Service
        • Knowlg Jobs
    • Deployment
    • Release notes
      • Release - 6.2.0 (Ongoing)
      • Release - 6.1.0 (latest)
      • Release - 6.0.0
      • Release - 5.7.0
      • Release - 5.6.0
      • Release - 5.5.0
      • Release - 5.4.0
      • Release - 5.3.0
      • Release - 5.2.0
      • Release - 5.1.0
      • Release - 5.0.0
      • Release - 4.10.0
      • Release - 4.8.0
    • Breaking Changes
    • Deprecations
      • Release-5.2.0
      • Release-5.1.0
    • Release
    • USE
      • Infra Requirements
    • Additional Reading
      • Content Service Environment Variables
      • Import External Content
  • Archived
    • Powerful Discovery
      • Usecase
      • Sample data
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. LEARN
  2. Product & Developer Guide
  3. Editors
  4. Collection Editor - V2

FAQ's

PreviousAPIsNextHow to contribute as a JS plugin

Last updated 3 years ago

Was this helpful?

How to disable the "Add from Library" feature for a particular level/unit in the hierarchy?

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": {
          ....
        }
      }
    }
}
How to use collection editor with frameworks (Angular, React, Vue, etc.)?

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.

For angular, Please refer to the .md of the

How to enable an asset Drag&Drop?

The Drag&Drop features are enabled by default in the collection editor builds.

How to get an API key?

To be updated.....

How to configure a new metadata field and define its attributes in the collection editor?

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"
                        }
                    ]
                }
            ]
        }
    }
}
How to configure Section Level configurations?

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":[
                           
                        ]
                     }
                  ]
               }
            ]
         }
      }
   }
}
Is it possible to add review comment in the editor?
What is the "Publish checklist" in the editor?
{
    "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": {}
        }
    }
}

Yes, For more information please check the section of the editor.

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.

features
README
git repository