Page Comparison

...

Question metadata which has some differences from the QuML specs are:-

• responseDeclaration

• media

responseDeclaration

Currently, the response declaration responseDeclaration is stored in the below format but there are two properties that are maxScore is not allowed in it , which are: maxScore and  outcomesand   outcomes property is not allowed inside correctResponse

"responseDeclaration": {
       "response1": {
           "maxScore": 1, // maxScore is not allowed here
           "cardinality": "single",
           "type": "integer",
           "correctResponse": {
               "value": "0",
               "outcomes": {
                   "SCORE": 1
               } // outcome is not allowed here, only property ‘value’ is allowed
           },
           "mapping": []
       }
   }

...

Instead of keeping maxScore and outcomes in responseDeclaration we can store it maxScore in outcomeVariables outcomeDeclaration as below:

"outcomeVariables"outcomeDeclaration": {
    "maxScore": {
      "cardinality": "maxScore"single",
      "type": 1,"integer",
      "defaultValue": 3
    }
  },

We will not store outcomes.score inside correctResponse because maxScore and outcomes.score holds the same value.

For newly created single select MCQ question responseDecleration and outcomeVariables outcomeDeclaration will be stored in the below format for single select MCQ:

"responseDeclaration": {
    "response1": {
      "cardinality": "single",
      "type": "integer",
      "correctResponse": {
 
        "value": "0",2
      },
      "mapping": []
     } }, "outcomeVariables": {
  "maxScore": 1, }

For multi-select MCQ, responseDecleration and outcomeVariables will be in the below format:

"responseDeclaration": {     "response1value": {2,
          "cardinalityscore": "multiple",
 3
        }
      ]
"type": "integer",   }
  },
  "correctResponseoutcomeDeclaration": {
    "maxScore": {
      "valuecardinality": [0, 1],"single",
      "type": "integer",
    },  "defaultValue": 3
    }
"mapping}

For multi-select MCQ, responseDecleration and outcomeDeclaration will be in the below format:

"responseDeclaration": [{
       "response1": {
      "responsecardinality": 0"single",
      "type": "integer",
      "outcomescorrectResponse": {
        "value": [2,1]
      "score": 1},
      "mapping": [
       } {
          "value": }2,
          "score": 0.5
{        },
      "response": 1,    {
          "outcomesvalue": {1,
          "score": 0.5
    "score": 1   }
      ]
    }
  },
  "outcomeDeclaration": {
    "maxScore": }{
      "cardinality": "single",
]     }
}, "type": "outcomeVariables": {integer",
      "maxScoredefaultValue": 2, 1
    }
  },

...

With Migration

• We can do the data migration for the old questions and update the question with the above-mentioned format.

Without Data Migration

...

For the new question creation, We will store the maxScore inside the outcomeVariables property.

...

We will store the maxScore inside the outcomeDeclaration property for new question creation using v2 API.

• No Data Migration (Recommended)

  • We will do these changes as part of the v2 API and will give the data in the above format.

  • If a user edits the old question using v2 API, We will store the maxScore inside the outcomeVariables outcomeDeclaration and remove the maxScore from the responseDeclaration.

• Data Migration (Not Recommended)

  • We can do the data migration for the old questions and update the question metadata with the format mentioned above.

  • This solution is not recommended because, with the migration of old questions, the old mobile app will break.

Player Changes:

• The player will check if the question is having the outcomeVariables outcomeDeclaration in the metadata of the question and what’s the maxScore value present in it.

• if If the outcomeVariables outcomeDeclaration property is found then the player will use it as is it.

• If the question does not have the outcomeVariables outcomeDeclaration property in the metadata then the player will look for the maxScore property in the responseDeclartion.

media

Currently, Question metadata contains media in the below format:

...

Proposed Solution for media

Editor Changes:

• With migration

  • We can do the data migration for the old questions and update the question with the above-mentioned format.

• Without migrationUpdate QuML specs (Recommended)

  • If we can update the QuML spec then change will not be required in the editor and player.

• No Data Migration (Recommended)

  • If we are not updating the QuML specs then we have to do the following changes:

    • For the new question creation, we will store the media in a new format using v2 API.

    • If the user edits the old question using v2 API, we will check if the type is present in the media object, and convert it to mediaType while editing the question.

• No migration (Not Recommended)

  • We can do the data migration for the old questions and update the question with the above-mentioned format.

  • This solution is not recommended because, with the migration of old questions, the old mobile app will break.

Player Changes:

(Note: Following changes will not be required if we are updating the QuML specs as mentioned above).

• The player will first check if the question media have mediaType property if not it will check in type property.

...

QuestionSet metadata which has some differences from the QuML specs is:-

• timeLimits

timeLimits

Time limits are currently being stored in the question set metadata as below:

...

But as per the QuML schema, it timeLimits` should be stored in the below format:

...

Proposed Solution for timeLimits

We can set the limit timeLimits for the complete question set as:

timeLimits:
{
   questionset: {
           min: number,
           max: number,
           warn: number // update the QuML specs
           
   }
}

If we have a time limit for each of the questions we will store the time limit timeLimits to the question set metadata as:

...

timeLimits:
{
   questionset: {
           min: null,
           max: 240,
           warn: 60
           
   }
}

...

Note: The timer field in the question set editor is part of the common form which is taking maxTime and warningTime as input.

We can keep on using the same configuration for the field in the form configuration keeping maxTime and warningTime . And in the editor code we can handle maxTime with max and warningTime with warn.

• With Migration

  • we can do the data migration for the old questions and update the question with above mentioned format.

...

We will have to update the QuML spec so the warn time should be stored inside timeLimits

Editor Changes:

• No Data Migration (Recommended)

  • For the new question creation, we will store the timeLimits in a new format using v2 API.

  • If the user edits the old question using V2 API, we will check for the timeLimits if it's present in an the old format we will convert it to the new format on save.

• Data Migration (Not Recommended)

  • we can do the data migration for the old questions and update the question with the above-mentioned format.

Player Changes:

The player will first check if the question has timeLimits.questionset it will take the min and warn value from there, if timeLimits.questionset is undefined and timeLimits directly contains maxTime and warningTime it will take the value from there.

...