Click here for non-normative background/supplementary documentation from this group.
Metadata is commonly referred to as data about data and includes information such as author, grade level, or keywords relating to a learning object, as examples.
Metadata can be used to structure and contain any of this kind of information in a consistent manner.
In the context of SIF, SIF_Metadata
provides a consistent structure to appropriate SIF objects for the purpose of cataloging and object discovery,
as well as other metadata functions and purposes. One recurring use case within the SIF data model is the requirement for some form of temporal constraints and tagging
on objects (see TimeElement
). Other metadata elements are based on needs brought to the Data Model Task Force.
IMPORTANT NOTE ON PERSISTENCE
This data is not designed to be permanent. It is designed to frame an object instance and could dissolve as soon as it leaves the SIF framework for the application space. A data warehouse could be used to store metadata for later tracking.
IMPORTANT NOTE ON USAGE
Any usage of metadata is optional unless made a requirement within individual SIF objects, or if a SIF or local profile or zone installation mandates it. SIF_Metadata allows for the usage of metadata in agents and applications that choose to support it.
This element is designed to operate much like SIF_ExtendedElements. It is an approved common element that is part of any data object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SIF_Metadata | A commonly defined container for metadata elements defined within SIF. | |||
TimeElements | O | List | ||
TimeElements/TimeElement | OR | TimeElement | ||
LifeCycle | O | LifeCycle | ||
RightsElements | O | List | ||
RightsElements/RightsElement | OR | RightsElement | ||
EducationFilter | O | EducationFilter |
A common metadata element designed to contain time data, both self-defined and by type.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
TimeElement | A common metadata element designed to contain time data, both self-defined and by type. | |||
Type | M | This element is designed to contain the time period attached to an object. Very long periods (school year, quarter, etc.) and very small periods (second, millisecond, etc.) can be defined. This element provides a scoping description of the time metadata enclosed. Because the educational environment varies so greatly we are including here a suggested but not prescriptive list of values. Although there may be unique needs for values not covered here—and we may have missed a major one—a best practice would be to utilize the examples here to enhance interoperability. Examples | xs:normalizedString | |
Code | M |
This element provides a place for the application to send structured data (code values, unique identifier, timestamps).
This code value can, depending upon the use case agreement between agents, be used to qualify the data in the Value element.
Examples | xs:token | |
Name | M |
Contains a human-readable description of the value in Value .
Examples | xs:normalizedString | |
Value | M | Contains the human-readable value. Examples | xs:normalizedString | |
StartDateTime | O | xs:dateTime | ||
EndDateTime | O | xs:dateTime | ||
SpanGaps | O | A container element for holding multiple possible span gaps. | List | |
SpanGaps/SpanGap | OR |
This structure duplicates much of the structure of TimeElement and is designed to represent a gap in the parent time period
defined by StartDateTime and EndDateTime above.
| ||
SpanGaps/SpanGap/Type | M | xs:normalizedString | ||
SpanGaps/SpanGap/Code | M | xs:token | ||
SpanGaps/SpanGap/Name | M | xs:normalizedString | ||
SpanGaps/SpanGap/Value | M | xs:normalizedString | ||
SpanGaps/SpanGap/StartDateTime | O | xs:dateTime | ||
SpanGaps/SpanGap/EndDateTime | O | xs:dateTime | ||
IsCurrent | M |
This element allows for the system to tag an object as being explicitly current.
Although the baseline assumption in SIF is that objects are always current (default value is typically true ),
there are use cases when that is not the case.
| xs:boolean |
This common metadata element describes the life cycle of the object it represents, based on the IEEE LOM LifeCycle element [LOM].
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LifeCycle | This common metadata element describes the life cycle of the object it represents, based on the IEEE LOM LifeCycle element [LOM]. | |||
Created | O |
When the object was created by whom. This is a more persistent creation date than
the date/time in the object's SIF_Header .
Depending on the use case being implemented, this value could contain the date the data in the object first entered the zone or was actually created.
| ||
Created/DateTime | M | xs:dateTime | ||
Created/Creators | O | List | ||
Created/Creators/Creator | MR | |||
Created/Creators/Creator/ Name | M | Human-readable name of the data's creator. If the object contains system-generated data, the name should identify the creating service or application. | xs:normalizedString | |
Created/Creators/Creator/ ID | M | Unique identifier of the creator. An email address or URI could be used here. | xs:normalizedString | |
ModificationHistory | O |
An ordered set of Modified elements describing which system modified the data, when
the modification took place, and a brief description of the modification.
| List | |
ModificationHistory/Modified | OR | A single modification event. | ||
ModificationHistory/Modified/ By | M | Identifier of the system or person that modified the data. | xs:normalizedString | |
ModificationHistory/Modified/ DateTime | M | The date/time the modification occurred. | xs:dateTime | |
ModificationHistory/Modified/ Description | O | Human readable description of the data modifications. | xs:string | |
TimeElements | O | List | ||
TimeElements/TimeElement | OR | TimeElement |
A common metadata element designed to carry any intellectual property or copyright information, based on the IEEE LOM Rights element [LOM].
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
RightsElement | A common metadata element designed to carry any intellectual property or copyright information, based on the IEEE LOM Rights element [LOM]. | |||
Cost | O | xs:boolean | ||
FeesForUse | O | A container for fees for use of the content in the object. | List | |
FeesForUse/FeeForUse | OR | Description of one fee structure applying to the use of this resource. | ||
FeesForUse/FeeForUse/UseType | M | A description of the fee structure for this resource. Some resources may be licensed differently depending upon their context. For example, a content provider might charge one fee structure for resources used in the classroom and a separate fee for those resources available to parents from home. | xs:string | |
FeesForUse/FeeForUse/MeteringType | M | xs:token | ||
FeesForUse/FeeForUse/MeteringURL | O | xs:anyURI | ||
FeesForUse/FeeForUse/PerUseCharge | O | MonetaryAmountType | ||
CopyrightStatement | O | xs:string | ||
TermsOfUse | O | xs:string |
Based on feedback from publishers, instructional management and system integrator vendors,
EducationFilter
was developed to provide the ability to tag objects with metadata that allows for categorization,
sorting, and filtering, to empower teaching and learning SIF usage. There exist two main business cases:
The use cases for EducationFilter
require a contract and choreography to be understood between both sides of
the transaction as is the case with all SIF_Metadata
.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
EducationFilter | ||||
MediaTypes | O | Allows an object or query to be tagged with MIME types. | List | |
MediaTypes/MediaType | MR | xs:token | ||
GradeLevels | O | Applicable grade levels as defined by SIF. | GradeLevels | |
SubjectAreas | O | This allows subject areas to be associated with an object or query.
Although there could be overlap with LearningStandardItems , it is anticipated
there will be use cases where LearningStandardItem objects may not exist or may not be available, and data may need to be tagged with high-level subject areas. | List | |
SubjectAreas/SubjectArea | MR | SubjectArea | ||
InterestLevels | O | InterestLevels is designed to represent the grade level for which the content is created. For example a tenth grader is at a third grade level in Algebra. You would want to present the content at a third grade level, but in a tenth grade context or interest level. | List | |
InterestLevels/InterestLevel | MR | GradeLevel | ||
LearningStandardItems | O | Allows any SIF object to be correlated to learning standards. | List | |
LearningStandardItems/LearningStandardItemRefId | MR | IdRefType |