Submit a request
Submit a request

Configuring Academic Benchmarks standards integration

The Academic Benchmarks standards integration allows authors to do the following:
  • Align standards to Items,
  • Use the standards to filter out Items, or
  • Filter out Items by standards, when adding them to Activities.

Learnosity uses Tags internally, to store the globally unique identifiers (GUIDs) of the standards selected, for alignment to Items. For a more detailed understanding of how Learnosity uses Tags to store the standards alignment, please see this page.

Saving your AB Connect API credentials

Before using the Academic Benchmark standards integration, you'll need to save your AB Connect API credentials in Learnosity Console under the 'Partners Keys' section for your consumer (found under Configuration->Consumers->Partner Keys). The credentials are used to generate a signature in the back end, which is then used to call the AB Connect API through our internal proxy server to fetch the standards allowed under your licence. This way your credentials are kept secure, and neither the credentials or the generated signatures are exposed on the web client. 



Screenshot: Configuring your AB Connect API credentials in Learnosity Console


Once saved in Console, you now need to configure Author API to use the AB Connect API through Author API's initialization options.   

Configuring AB standards integration in Author API

The AB standards integration needs to be configured through the Author API's initialization options.

Sample configuration: 

"config": {
"global": {
"ab_standards": {
"enable": true,
"aligned_tag_type": 'lrn_ab_aligned',
"tag_standard_hierarchy": false,
"edit_standards": true,
"filter": true

Code example: Initialization options for AB standards integration.

If you are already aligning standards to Items in Learnosity (by storing the GUID for the standard as a Tag Name against a reserved Tag Type for your Items), you can provide the Tag Type value to the aligned_tag_type attribute. This will allow you to filter out Items based on your existing Tags defined for the standard. The Tag Type and associated Tag Names containing the GUIDs for the standards are hidden for your Authors, and they can now navigate through a standards browser to align standards to an Item or filter out Items based on standards.

The edit_standards attribute controls Authors' ability to align new standards to Items or remove standards aligned to Items.

The filter attribute controls if Authors can filter out Items based on aligned standards in the list view.

From v2021.2.LTS, the search option allows Authors to search for standards using their short code or dot notation. The Author API uses the prefix_enhanced attribute of the standards to fetch matching search results.  

The tag_standard_hierarchy attribute controls if Items would also be tagged with the ancestry information for the selected standards for alignment, right up to the Authority level. This ancestry information could be used to filter out Items using Data API to determine the Item coverage for a standard. For more information on how Learnosity uses Tags to store the standards alignment, see this page.

Using the AB standards integration in Author Site

In order to use the AB standards integration in Author Site, you need to be on the new version of Author Site (released in Q1, 2020). Please contact your Learnosity support agent to enable the new Author Site.

Was this article helpful?
1 out of 1 found this helpful

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