Understanding Item Level Metadata in Author API

Overview

There are several metadata fields available for Items in the Details section of Item Settings, which authors can use to provide more information about the Item or to collaborate with other authors while creating the Item. All text entered for the notes, source and description metadata fields is made searchable in the Author API, but will not be visible to the student at any stage.

 

Metadata fields

Notes

The Notes field can be used to provide notes to other Authors on the Item’s content when Items are being created and reviewed between multiple Authors.

The visibility of the Notes field can be controlled by the note initialization option in Author API and can be set by the setItemNotes public method when in the Item edit mode.

 

Source

The source field can be used by Authors to provide information on the source of the Items content.

The visibility of the source field can be controlled by the source initialization option in Author API and can be set by the setItemSource public method when in the Item edit mode.

 

Description

The description field can be used by Authors to provide a description for the Item.

The visibility of the description field can be controlled by the description initialization option in Author API and can be set by the setItemDescription public method when in the Item edit mode.

 

Acknowledgements

The acknowledgements field can be used by Authors to provide copyright acknowledgement for the Item content. Acknowledgements entered here can be configured to dynamically appear on the Activity Outro Item. This is particularly useful for adaptive Activities as you won't know which Items will appear in the Activity. 

The visibility of the acknowledgements field can be controlled by the acknowledgements initialization option in Author API.

 

Difficulty level

The difficulty level can be used to provide a difficulty level to your Item for internal reference, or when using adaptive assessments.

The visibility of the difficulty level can be controlled by the difficulty initialization option in Author API and can be set by the setItemDifficulty public method when in the Item edit mode.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.