Measure Manifests

Measure manifest files provide additional information about related template types within a specific measure. In many measures, each data gatherer has a specific evaluator and enrichment that must be used. Attempting to use the wrong templates together will result in failed evaluations. For example, consider a measure that has both "Parent" and "Teacher" rater type templates in each Janus stage. In this scenario, a Teacher evaluator cannot be used with a Parent data gatherer or enrichment. The Teacher template must be used across all life cycle stages to produce a successful result.

Use of the measure manifest is not required for a successful Janus integration, but it can provide value in setting up a successful metadata-driven solution for measure implementation, especially when used in conjunction with the JSON-based ScalesItems file. The ScalesItems JSON can be retrieved through the GET ScalesItems endpoint.

Note that not all measures have a measure manifest available. Please ensure the measure being implemented has a manifest file available by making a request to the GET Measure Manifest endpoint.

Template Objects

The measure manifest primarily consists of three arrays of objects - "dataGatherers", "evaluators", and "enrichments". Within each of the arrays, all available templates of that type are included as an object, with the exception of "enrichment transformer" type enrichments. This template object contains several pieces of data:

  1. templateID: The identifier for this template, which corresponds to the dataGathererID, evaluatorID, or enrichmentID, depending on the template type.
  2. availableDirectives: The directives required for this template.
  3. dataGatherers: The data gatherers that may be used alongside this template in a session.
  4. evaluators: The evaluators that may be used alongside this template in a session.
  5. enrichments: The enrichments that may be used alongside this template.
  6. events: The events that are available for this template.

By reviewing the "dataGatherer", "evaluator", and "enrichment" sub-objects, it can be determined which templates are available for use alongside the given template. Using the example described above, if we were to look at a "Parent Data Gatherer" as our template, we might see the following associated templates:

  1. dataGatherers: None, because two data gatherers cannot be directly related.
  2. evaluators: One object related to a Parent Evaluator.
  3. enrichments: One object related to a Parent Enrichment.

Associated Templates

Within an associated template sub-object, there are two pieces of information:

  1. templateID: The identifier for this related template, which corresponds to the dataGathererID, evaluatorID, or enrichmentID, depending on the template type.
  2. availableDirectives: The directives that are required for this template, within the context of also running the parent object. In some scenarios, the use of one template may enforce certain directives in another. A common example of this is in evaluators, which may have "Rater Type" or "Length" as a directive that is directly dependent on which data gatherer, and optionally enrichment, are being used alongside it.

Retrieving the Measure Manifest

A measure manifest is available by making a GET request to the Janus "manifest" endpoint. This will fetch the latest version of the manifest file. See the GET Measure Manifest endpoint for full schema and details.

Example Manifest Implementation

  • A portal implementing the Janus API is configured to request the latest manifest file using the "GET measure manifest" endpoint on a monthly basis, storing it to be used throughout the portal.
  • The portal is configured to call on the manifest to deliver the Janus API through a metadata-driven solution.
  • When a user opts to create a new assessment, the available data gatherer forms are populated by pulling the list from the manifest file.
  • After a data gatherer template is selected, the portal automatically populates the available evaluators and enrichments to choose from, based on the associated template sub-objects.
  • The available directives can also be populated by these sub-objects, preventing the user from making an invalid selection. By using the manifest file, the portal can set up new measures more easily while ensuring that all provided selections are valid for the measure.
Powered by