Initialization Option Items API

intro_item

Specifies an Item that will be initially rendered before the learner starts the assessment.

You would want to specify this option so that you can show essential information to the learner before the assessment begins.

Examples

// Enable and specify an intro Item to use
var initializationOptions = {
    "config": {
        "navigation": {
            "intro_item": "my_item_reference_1"
        }
    }
};

// Enable and specify an intro Item when using multiple Item banks
var initializationOptions = {
    "config": {
        "navigation": {
            "intro_item": {
                "reference": "my_item_reference_2",
                "organisation_id": 123,
                "item_pool_id": "my_item_pool_id_1",
                "id": "intro_item"
            }
        }
    }
};

Values

Request object key config.navigation.intro_item

Default: false

This option can be initialized as one of the following types: boolean string object.

  • Type boolean

    When set to false, this option is ignored and a default message will be displayed since an Item has not been specified.

    To specify an intro Item, use either a string or object type.

  • Type string
    The Item reference to retrieve.
  • Type object
    An ItemObject can be used in place of an Item reference. See ItemObject definition for more information.

Caveats

The show_intro initialization option must be set to true for the intro page to be displayed. The default value for show_intro is true.

Related articles

Was this article helpful?