Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Include metadata element allows a reference to a prior metadata version.

Include Page
Include Element
Include Element

Include Page
Include Attributes
Include Attributes
A reference to a prior metadata version. This version must be present earlier in the same ODM file or in a previous file in the series. See the PriorFileOID attribute of the ODM element.

When a metadata element such as an ItemDef is re-defined in a MetaDataVersion that includes a previous MetaDataVersion, any metadata element of the same type and with the same OID in a preceding MetaDataVersion is completely replaced. This includes all attributes and child elements. It also means that all attributes and child elements not present in the new definition are effectively deleted from the previous version.

The href attribute allows to provide the location (as a URL) to the ODM where the to-be-included elements can be retrieved from, in the case that the combination of the referenced study and metadataversion is not present in the same file. The reference can be to a file, e.g. "file:///d:/MyStudies/MyStudy/PriorVersionODM.xml" or e.g. be an API call, like "https://www.MyCompany.com/MyStudies?StudyOID=MyStudy&MetaDataVersionOID=MV.001".

In the following example, question " I.003 " has been added to the ItemGroup " IG.001 " by adding an ItemRef element to the ItemGroupDef. The new version of the ItemGroupDef now contains only one of the Aliases, and the other Alias defined in MetaDataVersion " MDV.001 " has been removed. This same mechanism is used to remove ItemRefs from an ItemGroupDef, or to re-order reorder them.

Example
titleInclude

Include Page
Include Example
Include Example

...

Note: The StudyOID attribute allows an Include element to reference a metadata version in another study. Thus, it is possible for many studies to share a set of common metadata definitions. In fact, a study that contains nothing but metadata can serve as a metadata library.

...


Pagenav2