This is the proposed engineering implementation to integrate the Question Set Editor inside the Sourcing solution Project Creation workflow, based on this requirements document. (Confluence Document) and these mockups. (Google Slides)
Proposed Implementation
1. Sourcing
- Create Program
We will use the sunbird-collection-editor to create question sets as target objects.
We will add an
enableQuestionCreation
attribute to the editor configurationWe will implement changes to be able to emit question set metadata on exiting the question set creation page
2. Contribution
- Question Creation
We will use the sunbird-collection-editor to create new questions inside question sets.
We will add a new object type to editor configuration:
Question
We will implement requisite changes:
Editor: Accepting a question ID to initialise the editor
Header: Adding Send for review, Publish, Reject etc. buttons
Question: Only saving question and not updating the collection hierarchy on save etc.
- Add from Library
We will create a new add-from-library Angular library to add questions from library to question sets.
Scope:
- In release-4.4.0
1. We will add three new attributes to the question KP schema on the creation portal: collectionIds
and projectIds
and channelIds
2. For a question added to multiple collections (and/or projects, channels), we will populate this attribute with an array of their identifier
s
3. We will use these values to detect whether a question has been added from library or not
- In release-4.3.0
We will invoke this library from the portal for an existing question set.
The question set and unit identifiers will be passed to the library, which will use the existing library and player components
On returning/saving, the library will emit the question identifiers that have been added
The portal will then make an update hierarchy call for the given section
Caveat: We will only add questions to the section that was passed to the library to begin with.
We will use the following components of the existing collection editor:
Library: We will need to enable the existing library components for objects of type
Question
Quml Player: We will need to support previewing QuML questions in the library component etc.
- In future releases, we will integrate this library with mvc-library
and sunbird-collection-editor
In the creation-portal, we will have to enable changes to invoke the sunbird-collection-editor
and handle events emitted by it.
Only for projects with target objects of type
QuestionSet
, we will implement opening the new library on "Add from Library" being clicked - for the rest, the existingmvc-library
component will continue to be used.
3. Question Set Publish
We will use the sunbird-collection-editor to publish question sets.
We will have to use a combination of the
enableQuestionCreation
attribute andsessionContext
variables to display/hide the "Publish" option
We will make changes to the knowledge-platform to modify the publish pipeline for question sets.
We will have to modify this logic to be able to publish question sets only with "Approved" questions, and not re-create questions when the question set is re-published.
We will add
acceptedContributions
andrejectedContributions
attributes in creation-portal question-set schema.If sourcing reviewer approves the question, we will add its identifier to
acceptedContributions
array and if question is rejected it will be added torejectedContributions
array.We are using autoCreatorV2 flink job to copy contents from sourcing to consumption. Here we will add a check condition to validate if
acceptedContributions
attribute exists or not in question-set metadata.
- If attribute exist, we follow the new flow, in which we will remove the rejected questions from
question-set hierarchy and save only with approved questions to consumption.
- If attribute does not exist, we will use the existing flow and save all questions in question-set to
consumption irrespective of questions approval and rejection.
DB Changes: Program Table
column_name | datatype | postgresql command |
---|---|---|
targetcollectionprimarycategories | jsonb |
|
DB Changes: Configuration Table
INSERT INTO "public"."configuration" ("key", "value", "status") VALUES ('programTargetObjectMap', '[ { "identifier":"obj-cat:content-playlist_collection_all", "name":"Content Playlist", "targetObjectType":"Collection", "associatedAssetTypes":["Content"], "contentAdditionMode":["Search"] }, { "identifier":"obj-cat:demo-practice-question-set_questionset_all", "name":"Demo Practice Question `Set", "targetObjectType":"QuestionSet", "associatedAssetTypes":["Question","QuestionSet"], "contentAdditionMode":["New"] }, { "identifier":"obj-cat:digital-textbook_collection_all", "name":"Digital Textbook", "targetObjectType":"Collection", "associatedAssetTypes":["Content"], "contentAdditionMode":["Search"] }, { "identifier":"obj-cat:professional-development-course_collection_all", "name":"Course", "targetObjectType":"Collection", "associatedAssetTypes":["Content"], "contentAdditionMode":["Search"] }, { "identifier":"obj-cat:question-paper_collection_all", "name":"Question paper", "targetObjectType":"Collection", "associatedAssetTypes":["Content"], "contentAdditionMode":["Search"] } ]', 'active');`
0 Comments