1. Metadata Reference
DDF extracts basic metadata from the resources ingested. Many file types contain additional file format-specific metadata attributes. A neutral Catalog Taxonomy enables transformation of metadata to other formats. See also a list of all formats supported for ingest.
1.1. Common Metadata Attributes
DDF supports a wide variety of file types and data types for ingest. The DDF’s internal Input Transformers extract the necessary data into a generalized format. DDF supports ingest of many datatypes and commonly used file formats, such as Microsoft office products: Word documents, Excel spreadsheets, and PowerPoint presentations as well as .pdf files, GeoJson and others. See complete list. Many of these file types support additional file format-specific attributes from which additional metadata can be extracted.
|
Note
|
These attributes will be available in all the specified file formats; however, values will only be present if present in the original document/resource. |
These attributes are supported by any file type ingested into DDF:
-
metadata
-
id
-
modified (date)
-
title (filename)
-
metadata content type (mime type)
-
effective (date)
-
created (date)
These 'media' file types have support for additional attributes to be available when ingested into DDF:
-
Video Types
-
WMV
-
AVI
-
MP4
-
MOV
-
h.264 MPEG2
-
-
Image Types
-
JPEG-2000
-
-
Document Types
-
.DOC, .DOCX, .DOTX, .DOCM
-
.PPT, .PPTX
-
.XLS, .XLSX
-
.PDF
-
These are the attributes common to any of the media file types which support additional attributes:
-
media.format-version -
media.format -
media.bit-rate -
media.bits-per-sample -
media.compression -
media.encoding -
media.frame-center -
media.frame-rate -
media.height-pixels -
media.number-of-bands -
media.scanning-mode -
media.type -
media.duration -
media.page-count -
datatype -
description -
contact.point-of-contact-name -
contact.contributor-name -
contact.creator-name -
contact.publisher-name -
contact.point-of-contact-phone -
topic.keyword
1.2. File Format-specific Attributes
Many file formats support additional metadata attributes that DDF is able to extract and make discoverable.
1.2.2. All File Formats Supported
Using the various input transformers, DDF supports ingest of the following MIME types. While ingest is possible for these files, metadata will be limited unless otherwise noted.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1.3. Catalog Taxonomy Definitions
To facilitate data sharing while maximizing the usefulness of metadata, the attributes on resources are normalized into a common taxonomy that maps to attributes in the desired output format.
|
Note
|
The taxonomy is presented here for reference only. |
1.3.1. Core Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
A name for the resource. Dublin Core elements-title |
String |
< 1024 characters |
||
ID of the source where the Metacard is cataloged. While this cannot be moved or renamed for legacy reasons, it should be treated as non-mappable, since this field is overwritten by the system when federated results are retrieved. |
String |
< 1024 characters |
||
metadata-content-type [deprecated] see Media Attributes |
Content type of the resource. |
String |
< 1024 characters |
|
metadata-content-type-version [deprecated] see Media Attributes |
Version of the metadata content type of the resource. |
String |
< 1024 characters |
|
metadata-target-namespace [deprecated] see Media Attributes |
Target namespace of the metadata. |
String |
< 1024 characters |
|
Additional XML metadata describing the resource. |
XML |
A valid XML string per RFC 4825 (must be well-formed but not necessarily schema-compliant). |
||
The primary geospatial location of the resource. |
Geometry |
Valid Well Known Text (WKT) per http://www.opengeospatial.org/standards/wkt-crs |
POINT(150 30) |
|
The expiration date of the resource. |
Date |
|||
The |
Date |
|
||
point-of-contact [deprecated] |
The name of the point of contact for the resource. This is set internally to the user’s subject and should be considered read-only to other DDF components. |
String |
< 1024 characters |
|
Catalog-specific location of the resource for the metacard. This URI is used for internal catalog requests. |
String |
Valid URI per RFC 2396 |
||
URL location of the resource for the metacard. This attributes provides a client-resolvable URL to the download location of the resource. Clients should use this URL for download requests. |
String |
Valid URL per RFC 2396 |
||
Size in bytes of resource. |
String |
Although this type cannot be changed for legacy reasons, its value should always be a parsable whole number. |
||
The thumbnail for the resource in JPEG format. |
Base 64 encoded binary string per RFC 4648 |
⇐ 128 KB |
||
An account of the resource. Dublin Core elements-description |
String |
|||
Checksum value for the primary resource for the metacard. |
String |
< 1024 characters |
||
Algorithm used to calculate the checksum on the primary resource of the metacard. |
String |
< 1024 characters |
||
The creation date of the resource Dublin Core terms-created |
Date |
|||
The modification date of the resource Dublin Core terms-modified |
Date |
|||
The language(s) of the resource. Dublin Core language |
List of Strings |
Alpha-3 language code(s) per ISO_639-2 |
||
Catalog-specific Location(s) for accessing the resources derived from another source (for example, an overlay of a larger image). This URI is used for internal catalog requests. |
List of Strings |
Valid URI per RFC 2396 |
||
Download URL(s) for accessing the resources derived from another source (for example, an overlay of a larger image). Clients should use this URL for download requests. |
List of Strings |
Valid URL(s) per RFC 2396 |
||
The generic type(s) of the resource including the Dublin Core terms-type |
List of Strings |
|
1.3.2. Associations Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
ID of one or more metacards derived from this metacard. |
List of Strings |
A valid metacard ID (conventionally, a type 4 random UUID with hyphens removed). |
70809f17782c42b8ba15747b86b50ebf |
|
ID of one or more metacards related to this metacard. |
List of Strings |
A valid metacard ID (conventionally, a type 4 random UUID with hyphens removed). |
70809f17782c42b8ba15747b86b50ebf |
|
One or more URI’s identifying external associated resources. |
List of Strings |
A valid URI. |
https://infocorp.org/wikia/reference |
1.3.3. Contact Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
The name(s) of this metacard’s creator(s). |
List of Strings |
< 1024 characters per entry |
|
|
The physical address(es) of this metacard’s creator(s). |
List of Strings |
< 1024 characters per entry |
|
|
The email address(es) of this metacard’s creator(s). |
List of Strings |
A valid email address per RFC 5322. |
|
|
The phone number(s) of this metacard’s creator(s). |
List of Strings |
< 1024 characters per entry |
|
|
The name(s) of this metacard’s publisher(s). |
List of Strings |
< 1024 characters per entry |
|
|
The physical address(es) of this metacard’s publisher(s). |
List of Strings |
< 1024 characters per entry |
|
|
The email address(es) of this metacard’s publisher(s). |
List of Strings |
A valid email address per RFC 5322. |
|
|
The phone number(s) of this metacard’s publisher(s). |
List of Strings |
< 1024 characters per entry |
|
|
The name of the contributor(s) to this metacard. |
List of Strings |
< 1024 characters per entry |
|
|
The physical address(es) of the contributor(s) to this metacard. |
List of Strings |
< 1024 characters per entry |
|
|
The email address(es) of the contributor(s) to this metacard. |
List of Strings |
A valid email address per RFC 5322. |
|
|
The phone number(s) of the contributor(s) to this metacard. |
List of Strings |
< 1024 characters per entry |
|
|
The name(s) of the point(s) of contact for this metacard. |
List of Strings |
< 1024 characters per entry |
|
|
The physical address(es) of a point(s) of contact for this metacard. |
List of Strings |
< 1024 characters per entry |
|
|
The email address(es) of the point(s) of contact for this metacard. |
List of Strings |
A valid email address per RFC 5322. |
|
|
The phone number(s) of the point(s) of contact for this metacard. |
List of Strings |
< 1024 characters per entry |
1.3.4. DateTime Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
Start time(s) for the resource. |
List of Dates |
|
|
|
End time(s) for the resource. |
List of Dates |
|
|
|
A descriptive name for the corresponding temporal attributes. See datetime.start and datetime.end. |
List of Strings |
< 1024 characters per entry |
|
1.3.5. History Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
Internal attribute identifier for which metacard this version is representing |
String |
A valid metacard ID (conventionally, a type 4 random UUID with hyphens removed). |
70809f17782c42b8ba15747b86b50ebf |
|
Internal attribute identifying the editor of a history metacard. |
String |
A valid email address per RFC 5322 |
|
|
Internal attribute for the versioned date of a metacard version. |
Date |
|
|
|
Internal attribute for the action associated with a history metacard. |
String |
One of |
|
|
Internal attribute for the tags that were on the original metacard. |
String |
|
|
|
Internal attribute for the metacard type of the original metacard. |
String |
|
|
|
Internal attribute for the serialized metacard type of the original metacard. |
Binary |
|
|
|
Internal attribute for the original resource uri. |
URI |
1.3.6. Location Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
Altitude of the resource in meters. |
List of Doubles |
> 0 |
|
|
One or more country codes associated with the resource. |
List of Strings |
ISO_3166-1 alpha-3 codes |
|
|
Coordinate reference system code of the resource. |
List of Strings |
< 1024 characters per entry |
EPSG:4326 |
|
Coordinate reference system name of the resource. |
List of Strings |
< 1024 characters per entry |
WGS 84 |
1.3.7. Media Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
The file format, physical medium, or dimensions of the
resource. Dublin Core elements-format |
String |
< 1024 characters |
txt, docx, xml - typically the extension or a more complete name for such, note that this is not the mime type |
|
The file format version of the resource. Note that the syntax can vary widely from format to format. |
String |
< 1024 characters |
POSIX, 2016, 1.0 |
|
The bit rate of the media, in bits per second. |
Double |
|||
The frame rate of the video, in frames per second. |
Double |
|||
The center of the video frame. |
Geometry |
Valid Well Known Text (WKT) |
||
The height of the media resource in pixels. |
Integer |
|||
The width of the media resource in pixels. |
Integer |
|||
The type of compression this media uses. EXIF |
String |
One of the values defined for EXIF Compression tag. |
||
The number of bits per image component. |
Integer |
|||
A two-part identifier for file formats and format content. |
String |
A valid mime-type per https://www.ietf.org/rfc/rfc2046.txt |
application/json |
|
The encoding format of the media. |
List of Strings |
< 1024 characters per entry |
MPEG-2, RGB |
|
The number of spectral bands in the media. |
Integer |
The significance of this number is instrumentation-specific, but there are eight commonly recognized bands. https://en.wikipedia.org/wiki/Multispectral_image |
||
Indicate if progressive or interlaced scans are being applied. |
String |
PROGRESSIVE, INTERLACED |
1.3.8. Metacard Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
The creation date of the metacard. |
Date |
|||
The modified date of the metacard. |
Date |
|||
The email address of the metacard owner. |
String |
A valid email address per RFC 5322 |
||
Collections of data that go together, used for filtering. query results. NOTE: these are system tags. For descriptive tags, Topic Attributes. |
List of Strings |
< 1024 characters per entry |
1.3.9. Security Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
Attribute name for storing groups to enforce access controls upon that will enable a user to read and write a metacard. |
List of Strings |
< 1024 characters per entry |
||
Attribute name for storing the email addresses of users to enforce access controls upon that will enable the ability to read and write a metacard. |
List of Strings |
A valid email address per RFC 5322. |
|
|
Attribute name for storing the email addresses of users to enforce access controls upon that can read, but not explicitly write to a metacard. |
List of Strings |
A valid email address per RFC 5322. |
|
|
Attribute name for storing groups to enforce access controls upon that will enable a user to read, but not necessarily write to a metacard. |
List of Strings |
< 1024 characters per entry |
||
Attribute name for explicitly stating who has the permissions to modify the access control values of a metacard. These values include changing the security.access-groups, security.access-individuals and the security.access-administrators values. |
List of Strings |
A valid email address per RFC 5322. |
1.3.10. Topic Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
A category code from a given vocabulary. |
List of Strings |
A valid entry from the corresponding controlled vocabulary. |
||
One or more keywords describing the subject matter of the metacard or resource. |
List of Strings |
< 1024 characters per entry |
||
An identifier of a controlled vocabulary from which the topic category is derived. |
List of Strings |
Valid URI per RFC 2396. |
1.3.11. Validation Attributes
| Term | Definition | Datatype | Constraints | Example Value |
|---|---|---|---|---|
Textual description of validation warnings on the resource. |
List of Strings |
< 1024 characters per entry |
||
Textual description of validation errors on the resource. |
List of Strings |
< 1024 characters per entry |