Release 6.0.0 changes explained

Context

As part of release 6.0.0, inQuiry building block is releasing newer versions of it’s components; QuML Editor, QuML Player and Microservice.

Behaviour of the System post 6.0.0 release is explained below.

There are 2 major changes that is part of this release

  • Aligning inQuiry to latest QuML 1.1

  • Additional support for Multi Lingual

    • API is extended to support multiple languages and no changes to inQuiry editor / player

Component Versions vs QuML compatibility

Component

Component version (V1)

Component version (V2)

Component

Component version (V1)

Component version (V2)

QuML Editor

QuML 1.0

QuML 1.1

QuML Player

QuML 1.0

QuML 1.1

inQuiry Microservice (API)

QuML 1.0

QuML 1.1

QuML 1.0 for read only

  1. inQuiry Microservice provides a capability of reading the old Questions and QuestionSets that are in QuML 1.0.
  2. The Questions and QuestionSets in QuML 1.0 will be temporarily transformed to QuML 1.1 format by the read APIs

Support for V1 components will be deprecated in 6 months post the release of 6.0.0

Component Versions vs API Version compatibility

Component

API (V1)

API (V2)

Component

API (V1)

API (V2)

Editor (V1)

Allowed

Not permitted

Player (V1)

Allowed

Not permitted

Editor (V2)

Not permitted

Allowed

Player (V2)

Not permitted

Allowed

Behaviour of V2 Consumption APIs when requesting for Old or New Question / QuestionSet identifier

Scenario

QuestionSet Read

Question List

Scenario

QuestionSet Read

Question List

Old Question / QuestionSet identifier

Allowed

temporarily transformed to QuML 1.1

Allowed

temporarily transformed to QuML 1.1

New Question / QuestionSet identifier

Allowed

Allowed

Behaviour of V2 Create and Update APIs given the specific format of Question / QuestionSet

QuML version

QuestionSet Create

QuestionSet Update

Question Create

Question Update

Review

Publish

QuML version

QuestionSet Create

QuestionSet Update

Question Create

Question Update

Review

Publish

Questions / QuestionSets in QuML 1.0 format

Not permitted

Not permitted

Not permitted

Not permitted

Not permitted

Not permitted

Questions / QuestionSets in QuML 1.1 format

Allowed

Allowed

Allowed

Allowed

Allowed

Allowed

Changes for Making V2 QuML compliant

While the below table is a summary of changes, the details can be referenced from the below confluence pages

Attribute Name

Change summary

QuML 1.0 format

QuML 1.1 format

Attribute Name

Change summary

QuML 1.0 format

QuML 1.1 format

responseDeclaration

Changes are as follow,

  • maxScore

    • Now part of outcomeDeclaration

  • mapping

    • Is a JSON Object with keys as Value and Score

Multiple Choice Question

"responseDeclaration": { "response1": { "maxScore": 1, "cardinality": "single", "type": "integer", "correctResponse": { "value": "0", "outcomes": { "SCORE": 1 } }, "mapping": [ { "response": 0, "outcomes": { "score": 1 } } ] } }

Multi-select MCQ

"responseDeclaration": { "response1": { "maxScore": 1, "cardinality": "multiple", "type": "integer", "correctResponse": { "value": [1,0], "outcomes": { "SCORE": 1 } }, "mapping": [ { "response": 1, "outcomes": { "score": 0.5 } }, { "response": 0, "outcomes": { "score": 0.5 } } ] } }

Multiple Choice Question

"responseDeclaration": { "response1": { "cardinality": "single", "type": "integer", "correctResponse": { "value": 0 }, "mapping": [ { "value": 0, "score": 1 } ] } }, "outcomeDeclaration": { "maxScore": { "cardinality": "single", "type": "integer", "defaultValue": 1 } }

Multi-select MCQ

timeLimits

Changes are as follow,

maxScore

Changes are as follow,

  • maxScore

    • Now part of outcomeDeclaration

Question

QuestionSet

Question level

QuestionSet

answer

  1. There is adopter specific use case where the answer property is non-mandatory, like the Survey, Observation. Considering this case, the answer is non-mandatory in 6.0.0 release. This will need further enhancement to override answer property as mandatory or not at the QuestionSet level. Tentative time line for this change to affect is in release 6.2.0

Changes are as follow,

  • answer

    • is mandatory for all types of questions

    • answers will be concatenated together under an HTML element

    • supports multi-lingual

    • More details here

Subjective

Single Language:

Multi Language:

MCQ

Single Language:

Multi Language:

MMCQ

Single Language:

Multi Language:

interactions

Changes are as follows,

  • validation

    • Moved under response<1> attribute

solutions

Changes are as follows,

  • solutions

    • Change of type from array to object

    • supports multi-lingual

Image + Text

Video

Image + Text

Video

Multi Language

feedback

Changes are as follows,

  • feedback

    • mapping as part of outcomeDeclaration

    • supports multi-lingual

Multi Language

hints

Changes are as follows,

  • hints

    • mapping as part of outcomeDeclaration

    • supports multi-lingual

Multi Language

instructions

Changes are as follows,

  • instructions

    • Change of type from object to string

    • supports multi-lingual

Question

QuestionSet

Question

QuestionSet

Multi Lingual

showSolutions

Changes are as follows,

  • showSolutions

    • Change of type from string to boolean

showTimer

Changes are as follows,

  • showTimer

    • Change of type from string to boolean

showFeedback

Changes are as follows,

  • showFeedback

    • Change of type from string to boolean

showHints

Changes are as follows,

  • showHints

    • Change of type from string to boolean

bloomsLevel

Changes are as follows,

  • bloomsLevel

    • renamed to complexityLevel

    • Change of type from string to array

media

Changes are as follows,

  • media

    • this is a spec updation only and no changes in editor / player / api

No changes to the format

No changes to the format