Page Comparison

...

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

• responseDeclaration

• media

responseDeclaration

Currently, the responseDeclaration is stored in the below format but maxScore is not allowed in it and   outcomes property is not allowed inside correctResponse

...

We will store the maxScore inside the outcomeVariables 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.

  • The old player mobile app will not be supported to play questions created using the v2 API.

  • If a user edits the old question using v2 API, We will store maxScore inside the outcomeVariables 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.

...

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

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

• If the question does not have the outcomeVariables 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:

...

Editor Changes:

• Update 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:

...

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

• 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 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.

...