1. Home
  2. EIDR Data Fields
  3. Compilation
  4. Data Fields – Compilation

Data Fields – Compilation

A Compilation is a grouping of individual items. Generally, each item in a Compilation is included in its entirety, and exists separately within the Compilation. Examples include themed distribution packages, media bundles, franchises, and the contents of a DVD or Blu-ray disc. Note that while the elements of a Compilation can be sequenced, their order is not considered significant when identifying a Compilation. A Compilation may include another Compilation (for example a boxed set Compilation that contains individual disc Compilations).

The Referent Type of a Compilation must be a Compilation. The Structural Type of a Compilation can be Abstraction, Performance, or Digital, and must match the Structural Type of the included Entries, excluding other Compilations. The Approximate Length should be equal to the cumulative durations of the included Entries (for Performance and Digital Compilations) or zero (for Abstract Compilations or when the complete inventory of included Entries is not known). Credits will not apply unless they are common across all of the included Entries.

NOTE: Compilation only allows child records that are Manifestations. Edits and Clips are not allowed.

The Extra Object Metadata for a Compilation is contained within CompilationInfo:

Field NameTypeCardinalityExplanatory Notes
md:Entrymd:CompObjEntry-type <xs:element maxOccurs=”unbounded” minOccurs=”0″ name=”Entry” type=”md:CompObjEntry-type”/>0-∞ OptionalThe components of the Compilation, creating an inventory list of the included Entries.   Entry is a complex type where all data are recorded in child elements.   NOTE: A Compilation should, but does not have to include Entries. If there are no Entries, then the CompilationClass @hasOtherInclusions attribute must be set to true.
 /md:DisplayNameUnicode 128 character string: e.g.,  Duck Dodgers in the 24½th Century   <xs:element minOccurs=”0″ name=”DisplayName”>0-1 OptionalThe name of the Compilation component as it is known within the context of the Compilation.
 /md:EntryNumberA complex number[1] up to 8 characters long, but typically a simple non-negative integer: e.g., 1   <xs:element minOccurs=”0″ name=”EntryNumber” type=”md:string-Compilation-EntryNumber”/>0-1 OptionalIndicates the position of this entry within the Compilation. The format matches that of an EIDR Episode Distribution Number.
 /md:EntryClassEnumeration: Episode, Installment, Part, Season, Supplemental   <xs:element minOccurs=”0″ name=”EntryClass” type=”md:string-Compilation-EntryClass”/>0-1 OptionalDescribes the association between the Entry elements.

See “EntryClass Details” below.
 /md:ContentIDEIDR Content ID: e.g., 10.5240/4DDF-A111-8543-E67B-58F6-2 <xs:element name=”ContentID” type=”md:ContentID-type”/>1 RequiredThe EIDR Content ID of the Compilation Entry item.   NOTE: All included Entries (excluding other Compilations) must have the same Structural Type as the Compilation itself.
md:CompilationClassEnumeration: Blu-ray, Digital Cinema, Distribution Bundle, DVD, EST, Franchise, Home Entertainment, Syndication, Series, Season, Volume, Other   <xs:element name=”CompilationClass” type=”md:CompObjClass-type”/>1 RequiredThe general type of the Compilation.   See “CompilationClass Details” below  
 @hasOtherInclusionsBoolean: e.g., true   <xs:attribute name=”hasOtherInclusions” type=”xs:boolean” use=”optional”/>0-1 Conditionally RequiredIndicates if the list of Entry elements is exhaustive for the Compilation. If this is known to be true, set hasOtherInclusions to false. If it is known not to be true, set it to true. If the state is unknown, skip this entry.

Here is sample XML for the Extra Object Metadata for a Compilation (the preceding Base Object Data is not shown):

<ExtraObjectMetadata>
  <CompilationInfo>
    <md:Entry>
      <md:DisplayName>Alien Director's cut</md:DisplayName>
      <md:EntryNumber>1</md:EntryNumber>
      <md:ContentID>10.5240/8172-952F-E129-3FAF-1387-9</md:ContentID>
    </md:Entry>
    <md:Entry>
      <md:DisplayName>Alien 3 Extended</md:DisplayName>
      <md:EntryNumber>2</md:EntryNumber>
      <md:ContentID>10.5240/13DE-7053-272A-3879-824B-Z</md:ContentID>
    </md:Entry>
    <md:Entry>
      <md:DisplayName>Alien Resurrection original</md:DisplayName>
      <md:EntryNumber>3</md:EntryNumber>
      <md:ContentID>10.5240/3FB2-9C6E-FAA0-DDF2-EC98-W</md:ContentID>
    </md:Entry>
    <md:Entry>
      <md:DisplayName>Aliens Extended</md:DisplayName>
      <md:EntryNumber>4</md:EntryNumber>
      <md:ContentID>10.5240/12C1-89F2-7811-BE87-2FF4-J</md:ContentID>
    </md:Entry>
    <md:CompilationClass>Home Entertainment</md:CompilationClass>
  </CompilationInfo>
</ExtraObjectMetadata>

EntryClass Details

ValueExplanatory Notes
 EpisodeThe Entry is an Episode of a Series, with the Compilation Class = Series or Season. Used with episodic distribution bundles.
InstalmentThe Entry is part of a sequential but non-episodic set of items, such as a successful film and its prequels/sequels, a franchise, etc.
PartThe Entry is one part of a multi-part program.
SeasonThe Entry is a Season of a Series, with the Compilation Class = Series. Used with episodic distribution bundles.
SupplementalThe Entry is a piece of supporting (supplemental) content for the primary work(s). The referenced EIDR ID may be a Supplemental record (trailer, deleted scenes, etc.) or could be some other work that is being used in a supplemental capacity in this context (an episode of a series, a short, etc.).

1.1.1     CompilationClass Details

ValueExplanatory Notes
Blu-rayThe Compilation includes the contents of a Blu-ray disc (packaged media). Structural Type is Performance; Entries are Edits.
Digital CinemaThe Compilation includes the contents of a Digital Cinema DCM (Digital Cinema Master) or DCP (Digital Cinema Package). Structural Type is Performance or Digital; Entries are Edits or Manifestations.
Distribution BundleThe Compilation includes the contents of an otherwise unspecified media distribution bundle. Structural Type is Performance or Digital; Entries are Edits or Manifestations.
DVDThe Compilation includes the contents of a DVD disc (packaged media). Structural Type is Performance; Entries are Edits.
ESTThe Compilation includes the contents of an Electronic Sell-Through bundle. Structural Type is Performance; Entries are Edits.
FranchiseThe Compilation includes the related items of a franchise, the œuvre of an actor or director, etc. Structural Type is Abstraction; Entries are Abstraction records.
Home EntertainmentThe Compilation includes the contents of an otherwise unspecified home entertainment distribution bundle, often some form of packaged media. Structural Type is Performance; Entries are Edits.
SyndicationThe Compilation includes entries in a syndication bundle. Structural Type is Performance; Entries are Edits.
SeriesThe Compilation is an episodic distribution bundle, representing an entire Series. Structural Type is Performance; Entries include Season Compilations and Episode Edits.
SeasonThe Compilation is an episodic distribution bundle, representing an entire Season. Structural Type is Performance; Entries are Episode Edits.
VolumeThe Compilation is one of several that, when taken together, cover a particular topic (Episodes of a Series, Movies within a Franchise, etc.), often distinguished with “Volume 1”, “Volume 2”, etc. in their name. Unlike a Franchise, a Volume is a distribution bundle so it its Structural Type is Performance; Entries include Edits.
OtherThe Compilation includes items that are not otherwise defined. Structural Type is Performance or Digital; Entries are Edits or Manifestations.

[1] The XML regular expression that controls Compilation Entry Numbers is “0|[1-9][0-9a-zA-Z]*([:/\-.,][0-9a-zA-Z]+)?”.

Updated on April 10, 2021

Was this article helpful?