OOI METADATA IMPLEMENTATION
Draft Version 1-01
Feb 10, 2014
Consortium for Ocean Leadership
1201 New York Ave NW, 4th Floor, Washington DC 20005
www.OceanLeadership.org
in Cooperation with
University of California, San Diego
University of Washington
Woods Hole Oceanographic Institution
Oregon State University
Scripps Institution of Oceanography
Rutgers University
Metadata Planning, Approach and Progress
Document Control Sheet
Version
Date
Creator
Description
0-00
24, Oct 2010
K. Stocks
0-01
0-02
0-03
25, Oct 2010
27, Oct 2011
23, January 2012
K. Stocks
S. Banahan
K. Stocks
0-04
6, March 2012
K. Stocks
0-05
14, March 2012
K. Stocks
0-06
0-07
17, March 2012
4, October 2012
B. Bergen
K. Stocks
1-00
07, February 2014
M. Meisinger
1-01
10, February 2014
M. Meisinger
First draft, incorporating comments from Bill
Bergen
Edits from John Orcutt.
Formatting.
Update to Appendix 3, replacement of
Appendix 4 on CTD metadata, to an
appendix on Data Product metadata.
Update of Table of Contents
Updated Appendices 3 and 4 to represent
current working version in confluence.
Removed Appendix 5 as overly abstract
Minor expansion of section 2 to describe the
variety of metadata. Added recognition that
additional metadata standards exist to
section 4.2. Added explanation for what
association are in App. 3
Minor edits for non ION reader clarity
Substantive update of content of sections
4.2 and 4.3 on adopted standards;
replacement of “ION” with Integrated
Observatory; revision of appendices to
include a full list of Resource Types and
Resource Attributes, removal of all previous
appendices and addition of new appendixes
on resource types, attributes and objects.
Minor wording improvements throughout.
Revised for OOINet Release 2 (version 2.1)
metadata model. Updated introductory
verbiage.
Updated page numbering
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 1 of 29
Metadata Planning, Approach and Progress
Table of Contents
1
Introduction..........................................................................................................3
2
Metadata Coverage in ION ....................................................................................3
3
Metadata Implementation ....................................................................................3
4
Metadata Standards .............................................................................................4
4.1
4.2
4.3
Rationale ..................................................................................................................4
Adopted Standards for Data Products ........................................................................4
Additional Metadata Specification .............................................................................5
Appendix 1
Resource Types..................................................................................... 6
Appendix 2
Abstract Resource Types ..................................................................... 10
Appendix 3
Common resource attributes ............................................................. 11
Appendix 4
Attributes (metadata elements) per resource type .............................. 12
Appendix 5
Metadata Objects and attributes ....................................................... 23
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 2 of 29
Metadata Planning, Approach and Progress
1
Introduction
1.1. Purpose of this Document
The purpose of this document is to describe the OOI approach to metadata, plan
for implementation, and its current progress for the OOINet software.
2
Metadata Coverage in ION
OOI recognizes the importance of metadata (additional information describing or
providing context for data) as critical to the use and appropriate curation of OOI
data. OOI will collect and maintain metadata within the OOINet system to
support end users of the data (science metadata) and to support the functioning
and maintenance of the Integrated Observatory system (infrastructure and
administration metadata). The science metadata will include metadata for both
discovery (searching and browsing data within OOINet) and use of the data by a
wide variety of audience types. Metadata can take multiple forms, and include
both human-readable and computer-parseable information about the data and
their collection. Metadata also include pointers to other data, such as auxiliary
documentation or coincident environmental observations that are important for
understanding the data.
All resources within OOINet have metadata. The term “resource” is defined in
the OOI definition reference module. To summarize: A resource is an element in
the system that provides capability. This includes data, annotations, derived data
products, user identities, instruments and executable algorithms. Those
metadata most relevant to OOINet science users are metadata for data products,
instruments and platforms, and data processes.
3
Metadata Implementation
The OOI Implementing Organization (IO) for Cyberinfrastructure (CI) is
introducing metadata capabilities in a phased approach. Only the metadata
required to support the functionality of each of the OOINet releases is provided
with each release. For example, OOINet Release 1 was focused on data
transport and use of external gridded fields as the data sets. Consequently, the
netCDF COARDS CF convention was supported for that release. Release 2
focuses on instrument command and control as well as the receipt and
processing of instrument data. The metadata fields required for these activities
got implemented during the Release 2 design and construction phase. With the
OOINet Release 3, all metadata capabilities for full OOINet operations will be
available.
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 3 of 29
Metadata Planning, Approach and Progress
4
Metadata Standards
4.1
Rationale
OOI adopts existing metadata standards when they meet project needs, in whole
or in part. Using existing standards, versus developing a local approach to
metadata documentation, has the benefits of:
 fostering interoperability with external projects;
 facilitating consistency of information collection, in comparison to adhoc metadata approaches; and
 meeting NSF data policy requirements.
4.2
Adopted Standards for Data Products
In OOINet Release 1, data product metadata was compliant with the Climate
Forecast (CF)1 convention of the Network Common Data Form (NetCDF)2, with
the Attribute Conventions for Dataset Discovery3 (ACDD). This is a widely
adopted set of standards in the Earth and atmospheric sciences (which extends
well beyond climate data).
In Release 2, a data model and set of metadata attributes was developed to
ensure that the information required to support a variety of metadata standards is
collected. In Release 3, the ability to export metadata in standard formats will be
implemented. Because the landscape of data integration changes through time,
as new versions of standards are created and new practices adopted by the user
community, the particular standards that will be supported in Release 3. At
present, the Integrated Observatory Data Model holds the information necessary
to support the following three standards:


The International Standards Organization (ISO) 19115 Geographic
Information Metadata standard4. The Federal Geographic Data
Committee is in the process of adopting a profile of ISO 19115 as the
federal standard. By complying with ISO 19115, OOI will be prepared to
meet the metadata requirements for submitting data to the National Data
Centers, as required under NSF Division of Ocean Sciences Samples and
Data Policy5.
The Open Geospatial Consortium (OGC) Catalog Service Implementation
Specification (CSW)6. Supporting the metadata needed by CSW lays the
groundwork for the Integrated Observatory data to be discovered and
http://cf-pcmdi.llnl.gov/
http://www.unidata.ucar.edu/software/netcdf/
3 http://www.unidata.ucar.edu/software/netcdfjava/formats/DataDiscoveryAttConvention.html
4 http://www.iso.org/iso/catalogue_detail.htm?csnumber=26020
5 http://www.nsf.gov/pubs/2011/nsf11060/nsf11060.pdf
6 http://www.opengeospatial.org/standards/cat
1
2
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 4 of 29
Metadata Planning, Approach and Progress

retrieved through this community-adopted catalog service mechanism, in
addition to through the Integrated Observatory user interfaces.
The NetCDF CF and ACDD standards.
In Release 3, the ability to export metadata in standard formats will be
implemented. OOI recognizes that a wide variety of additional, applicable
metadata standards exist, including others produced by ISO and OGC.
Decisions to support additional particular standards will balance the benefits,
such as increased interoperability or meeting user demand, against the
resources needed.
4.3
Additional Metadata Specification
While generic standards provide for interoperability among heterogeneous data
sets, they are not able to capture the detailed characteristics of specific data
types, nor can they fully support the needs of instrument operators. To meet
user needs, OOI is defining additional metadata attributes to better describe
resources within OOINet. A list of user relevant resource types for which OOI is
developing metadata attributes is presented in Appendix 1. The partitioning into
resource types and the attributes for user relevant resources are driven by
experience in previous ocean observatories such as MBARI's Monterey Ocean
Observing System (MOOS), as well as by interviews with OOI and community
scientists and technologists and related programs, such as the US Integrated
Ocean Observing System (IOOS) and NEPTUNE Canada. OOINet manages
additional resources for its internal operation. These resource types and their
attributes are not described in this document. Similarly, user relevant resource
types may have additional attributes relevant only to OOINet operations. These
attributes are not further described in this document. Appendix 2 lists a number
of abstract resource types that group several related resource types.
Metadata specifications for all resources within OOINet have been developed. A
list of metadata attributes, common to all resource types, is supplied in Appendix
3. A list of metadata attributes by resource type, current as of the last update of
this metadata document, is supplied in Appendix 4. System-only resources
having no end-user exposure are not included in this list. Appendix 5 shows
Objects in the system, and their attributes. Objects are used to define sets of
related attributes, and allow the re-use of attributes sets by multiple resource
types. Not all of the resource and object attributes will be displayed to end users
or used in metadata reports; some serve internal tracking functions.
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 5 of 29
Metadata Planning, Approach and Progress
Appendix 1: List of all concepts (called Resource Types) in OOINet about which metadata are captured. Those marked as
“System” are used for the internal operation of the system, but will have no exposure to an end user. Those marked as
“User” have some level of impact on the user interfaces, though their purpose may be primarily to support system operation.
Every resource type shows the abstract type it extends, if any. Abstract types are listed in Appendix 2.
Resource Type
Extending Resource Type
Visibility
Description
ActorIdentity
InformationResource
System
A known identity for a user, resource or system element.
Attachment
InformationResource
User
Represents separate information attached to a resource, such as a PDF or image file.
CapabilityContainer
TaskableResource
System
Represents a capability container that is part of the system with the ability to host
processes.
Commitment
InformationResource
System
Represents a standing obligation of one participant to another participant.
Commitments can be tracked and violations against commitments can be sanctioned.
DataProcess
TaskableResource
System
Represents a computational process that derives information from less refined
information on a continuous streaming basis or on-demand, including the generation of
derived science data products..
DataProcessDefinition
InformationResource
System
Defines a type of data transform computational process.
DataProducer
InformationResource
System
Represents provenance information within data flows for a data source such as a
device, data process, external data source. Captures input and parent relationships.
DataProduct
InformationResource
User
Represents a uniquely identified presentation of a defined collection of information.
The presentation consists of a particular subset of the collection. A DataProduct may
have a real-time stream and may have persisted historic data.
Dataset
InformationResource
System
Represents a possibly open-ended coverage of science data that may be persistent.
Deployment
FrameOfReference
User
Describes an assignment of a device to a specific observatory site for a period of time.
The device may be an assembly of devices, such as a platform composed of
components and instruments.
EventType
InformationResource
System
Describes a unique type of event
ExchangePoint
InformationResource
System
Represents a message router within an Exchange Space. Message routing may occur
based on topic, headers or content.
ExchangeSpace
InformationResource
System
Represents a namespace of Exchange participants, operated within one domain of
authority. May be distributed across multiple Exchange Brokers.
ExternalDataProvider
InformationResource
System
Represents an external institutional entity that provides and owns data.
ExternalDataset
InformationResource
System
Describes a dataset provided by an external collaborator or organization.
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 6 of 29
Metadata Planning, Approach and Progress
Resource Type
Extending Resource Type
Visibility
Description
ExternalDatasetAgent
DeviceAgent
User
Describes a type of external dataset agent
ExternalDatasetAgentInstance
AgentInstance
User
Describes an instance of external dataset agent
ExternalDatasetModel
InformationResource
System
Describes a type of external dataset
InstrumentAgent
DeviceAgent
User
Defines an agent/driver combination compatible with a specific instrument model.
InstrumentAgentInstance
AgentInstance
User
Describes parameters for an instance of an instrument agent for a specific device.
InstrumentDevice
Device
User
Represents a physical package with a manufacturer, model, and serial number,
containing one to many sensors that communicate through a single onboard data
interface.
InstrumentModel
DeviceModel
User
Specifies a distinguished type of instruments, derived from the manufacturer's model
number, based on common attributes.
InstrumentSite
DeviceSite
User
Represents a reference designator within an observatory, designated for the
deployment of functionally equivalent instrument devices, with geospatial and temporal
bounds.
Negotiation
InformationResource
User
Describes an interaction between multiple system participants with the intent of
negotiating a mutual contract with commitments for each participant.
NotificationRequest
InformationResource
User
Describes a standing request for notifications by type and delivery modality for one
user.
ObjectType
InformationResource
System
Specifies a type of ION object.
Observatory
Site
User
Represents a reference designator that designates a top-level observatory, with
geospatial and temporal bounds. This Observatory Site can have Subsites, Platform
and Instrument Sites.
Org
TaskableResource
User
Represents a domain of authority that provides the context within which policy applies
to registered member individuals and resources. Also known as facility.
ParameterContext
InformationResource
System
Defines a named variable of a stream, dataset or data product. This can be an
independent, measured value, a variable describing the geospatial-temporal domain, a
calibration coefficient or a derived, computed value or QC flag.
ParameterDictionary
InformationResource
System
Represents a collection of parameter contexts, e.g. for use to describe a stream,
dataset or data product.
ParameterFunction
InformationResource
System
Represents a calculation used to compute a derived parameter, e.g. for an L1 product
or QC flag, that can be executed within a coverage.
PlatformAgent
DeviceAgent
User
Describes a type of platform agent
PlatformAgentInstance
AgentInstance
User
Describes parameters for a platform agent instance
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 7 of 29
Metadata Planning, Approach and Progress
Resource Type
Extending Resource Type
Visibility
Description
PlatformDevice
Device
User
Represents a physical package with a manufacturer, model, and serial number,
providing physical mounting locations for one to many instruments. Platforms are also
the primary units of deployment of marine infrastructure.
PlatformModel
DeviceModel
User
Specifies a distinguished type of platform, derived from the manufacturer's model
number and on common attributes.
PlatformSite
DeviceSite
User
Represents a reference designator within an observatory, designated for the
deployment of functionally equivalent platform devices, with geospatial and temporal
bounds.
Policy
InformationResource
System
Specifies a set of rules applicable when interacting with designated OOI system
resources.
Process
TaskableResource
System
Represents an executing computational entity in the system, executed by an
Execution Engine. An instance of a process definition, of type service, agent or
transformation process.
ProcessDefinition
ExecutableResource
System
Specifies a type of executable process of class service, agent or transformation
process. References the executable or source code.
ResourceType
InformationResource
System
Defines a type of system known resource.
Service
TaskableResource
System
Represents an instance of a service definition, available for use within the OOI
Integrated Observatory Network.
ServiceDefinition
ExecutableResource
System
Represents a type of service, available for instantiation within the OOI Integrated
Observatory Network.
Stream
InformationResource
System
Represents an identified, unbounded sequence of data granules (messages)
published with a unique topic.
StreamDefinition
InformationResource
System
Describes the format, structure, and characteristics of a stream and its granules (data
records).
Subscription
InformationResource
System
Represents a standing request to receive information from streaming sources.
Typically, represents a pubsub queue receiving science data granules from a data
stream.
Subsite
Site
User
Represents a reference designator that designates a hierarchical substructure within
an observatory, with geospatial and temporal bounds. Subsites mostly represent
distinct geospatial areas within an Observatory.
UserCredentials
InformationResource
System
Represents one set of user credentials from an external identity provider for a user,
defining an external user identity.
UserInfo
InformationResource
User
Represents a human user registered with the system, with their contact information,
preferences and other profile data.
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 8 of 29
Metadata Planning, Approach and Progress
Resource Type
Extending Resource Type
Visibility
Description
UserRole
InformationResource
User
Defines a named set of responsibilities and authorities that a user may fulfill within one
Org when interacting with resources.
View
InformationResource
System
Specifies a standing, parameterizable query for resources. Describes order and
additional filters to be applied when view is evaluated.
Workflow
InformationResource
System
Represents a composite process producing a derived data product, by orchestrating
data process instances.
WorkflowDefinition
InformationResource
System
Specifies a composite process definition for orchestrating a sequence of
transformations, for instance as needed to produce a visualization pipeline for an input
data product stream.
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 9 of 29
Metadata Planning, Approach and Progress
Appendix 2: List of abstract Resource Types in OOINet. These are concept definitions that can be extended into one of the
Appendix 1 listed resource types. They serve to indicate commonality between resource types and to enable the system to
treat all derived types in the same way.
Resource Type
Extending Resource Type
Visibility
Description
AgentDefinition
InformationResource
User
Describes a type of agent. Abstract base type.
AgentInstance
InformationResource
User
Device
TaskableResource
System
DeviceAgent
AgentDefinition
System
DeviceModel
InformationResource
System
DeviceSite
Site
System
ExecutableResource
InformationResource
System
FrameOfReference
InformationResource
System
Index
InformationResource
System
InformationResource
Resource
System
Describes a running or scheduled agent representing a single resource. Abstract base
type.
Describes a physical device with a serial number, such as sensor, instrument and
platform. Abstract base type.
Describes a running or scheduled agent representing a single device. Abstract base
type.
Represents a grouping of devices by common characteristics, e.g. a vendor's make
and model. Abstract base type.
Represents a reference designator within an observatory for one platform or
instrument. Can have one current primary device and has many device assignments
of the same model over time. Abstract base type.
Describes a computational entity that can be instantiated into a taskable resource.
Abstract base type.
Describes a range or extent over the dimensions that it represents. The frame of
reference can include dimensions of geodetic (earth-based) space, time, or other
cardinal or ordinal axes, and can be specified in absolute terms or relative to another
frame of reference.
Represents information about an index (search path) in the system and how to access
it.
Describes a resource that exists as an electronic artifact, such as science data,
attachments, actor identities. Abstract base type.
Represents an entity known to the system that provides capability and has an identity
and a life cycle. Resources can be associated with other resources. Abstract base
type and type root.
Represents a reference designator within an observatory, with geospatial and
temporal bounds. Abstract base type.
Describes a resource that can be controlled and monitored, such as a physical device
or a computational process. Abstract base type.
Resource
System
Site
FrameOfReference
System
TaskableResource
Resource
System
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 10 of 29
Metadata Planning, Approach and Progress
Appendix 3: Common resource attributes, available for all resource types. These attributes are available but use is
dependent on the resource type.
Attribute
Description
_id
Unique identifier
availability
Resource availability state
description
A more verbose description of the resource
lcstate
Resource life cycle state
name
Human readable long name of the resource, e.g. for display in resource lists
ts_created
Timestamp when resource object was created (str in millis in UNIX epoch)
ts_updated
Timestamp when resource object was last updated (str in millis in UNIX epoch)
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 11 of 29
Metadata Planning, Approach and Progress
Appendix 4: Attributes (metadata elements) for each Resource Type. System-only Resource Types are not shown. Not all
attributes will be shown on user interfaces or in metadata reports; some have internal functions. This table omits some purely
internal attributes and the common resource attributes shown in Appendix 3.
Resource Type
Attribute Name
Description
attachment_size
Size of the attachment content, in bytes
content_type
type of attachment (PDF document, PNG image, etc); expressed as standard
MIME types
context
Provides additional attributes depending on the type of attachment.
created_by
The identity of the creator of the document. For documents imported from external
sources, this is not the same as the creator of this resource.
keywords
Keywords indicating the type of attachment (e.g. user manual, log)
modified_by
The identity of someone who has modified of the document. For documents
imported from external sources, this modification may have happened outside of
the system
acknowledgement
A place to acknowledge various types of support provided by the project that
produced the data
citation_description
Describes how this data product is used and can be used. This is in addition to any
system record of acquired commitments (if existing) to the data product and
events generated when accessing the data product.
comment
Miscellaneous information not already captured in attributes
contacts
All entities that serves as a contact point for this data product as a list of
ContactInformation objects.
descriptors
A list of keyword/authority pairs with optional urls as list of Term objects.
doors_l2_requirement_num
The OOI DOOR L2 Science Requirement number(s). Comma-separated list when
multiple values are present.
doors_l2_requirement_text
The OOI DOOR L2 Science Requirement text.
dps_dcn
The OOI document control number (DCN) for this data product's Data Processing
Specification. Comma-separated list when multiple values are present.
exclusive_rights_end_date
For temporary data holds, the date on which the hold will expire.
exclusive_rights_notes
Further information about the exclusive rights hold, such as a justification for a
Attachment
DataProduct
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 12 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
permanent hold
exclusive_rights_status
Indicates whether the dataset is under proprietary hold or whether it is public.
Codelist: unrestricted, temporary_hold, permanent_hold
external_archives
Holds information on where and when the data product was submitted to an
external archive. A list of objects of type ExternalArchive.
flow_diagram_dcn
The OOI document control number (DCN) for this data product's processing flow
diagram. Comma-separated list when multiple values are present.
geospatial_bounds
Specifies both limits of the resource's latitude, longitude, and optionally vertical
position, with respect to a geospatial CRS.
geospatial_coordinate_reference_system
The geospatial coordinate reference system, expressed as a URI (ideally a URL);
incorporates both coordinate system and datum; may be geodetic/horizontal,
vertical, or both.
ioos_category
Selection from IOOS controlled vocabulary for parameters.
ISO_spatial_representation_type
Optional for ISO 19115 (=> MD_DataIdentification.spatialRepresentationType.
DUPLICATE with iso_spatial_representation_type.
iso_spatial_representation_type
From ISO:method used to spatially represent geographic information. Codelist:
vector, grid, textTable, tin, stereoModel, video
iso_topic_category
One or more of the topic categories from ISO 19115
license_uri
Links to a description of the permissions and restrictions for access to and
distribution of OOI data.
lineage_description
Describes user entered changes to this data product over time. This is in addition
to the event history of life cycle state changes, resource changes and other events.
naming_authority_id
Indicates the authority that is issuing the IDs, so that people with the product can
know how/where to look up the ID. It will indicate the OOI identity in some way
(may indicate each Org as they issue their own resource IDs)
nominal_datetime
A nominal representation of the temporal span of when the observations within the
data product were actually made. For instruments that are not real-time, this will
not be the same as the earliest and latest ingestion of data.
ooi_product_name
The OOI core data product descriptive name provided in section 2.2.1 of the DPS,
and also in the column "Data Product Name" in the Data Product Catalog that is
part of the Instrument Application in SAF
ooi_short_name
The product short name provided in the Data Product Specification, often a 7
character code, e.g. "PRESWAT"
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 13 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
processing_level_code
OOI data processing level. Codelist: L0, L1, L2 or N/A
provenance_description
Describes the provenance of this data product with respect to input data products
and data sources. This is in addition to the associations of this data product to
other resources and any computed provenance information.
qc_cmbnflg
Whether the Combine QC Flags (CMBNFLG) QC is run on this data product.
Codelist: applicable, not applicable, TBD
qc_condcmp
Whether the Conductivity Compressibility Compensation (CONDCMP) QC is run
on this data product. Codelist: applicable, not applicable, TBD
qc_glblrng
Whether the Global Range Test (GLBLRNG) QC is run on this data product.
Codelist: applicable, not applicable, TBD
qc_gradtst
Whether the Gradient Test (GRADTST) QC is run on this data product. Codelist:
applicable, not applicable, TBD
qc_interp1
Whether the 1-D Interpolation (INTERP1) QC routine is run on this data product.
Codelist: applicable, not applicable, TBD
qc_loclrng
Whether the Local Range Test (LOCLRNG) QC is run on this data product.
Codelist: applicable, not applicable, TBD
qc_modulus
Whether the Modulus (MODULUS) QC is run on this data product. Codelist:
applicable, not applicable, TBD
qc_polyval
Whether the Evaluate Polynomial (POLYVAL) QC is run on this data product.
Codelist: applicable, not applicable, TBD
qc_solarel
Whether the Solar Elevation (SOLAREL) QC is run on this data product. Codelist:
applicable, not applicable, TBD
qc_spketest
Whether the Spike Test (SPKETST) QC is run on this data product. Codelist:
applicable, not applicable, TBD
qc_stuckvl
Whether the Stuck Value Test (STUCKVL) QC is run on this data product. Codelist:
applicable, not applicable, TBD
qc_trndtst
Whether the Trend Test (TRNDTST) QC is run on this data product. Codelist:
applicable, not applicable, TBD
quality_control_level
The quality control level of the data product. Codelist: a = no QC, b = automated
QC, c = human QC, N/A = no QC for this data product
reference_urls
List of URLs with information about the data product
regime
Whether the data product is from the Air-Sea Interface, Surface Water, Water
Column, Benthic Boundary Layer and/or Seafloor/Crust. Codelist: Air-Sea
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 14 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
Interface, Surface Water, Water Column, Benthic Boundary Layer, Seafloor/Crust
synonyms
Synonyms to facilitate searching as a list of strings.
auxiliary_identifier
An additional identification code used by the operators
auxiliary_name
An additional identification name used by the operators
constraint_list
Applicable constraints as a list of GeospatialBounds, GeospatialPoint,
TemporalBounds, etc objects
context
Additional attributes specific to this deployment type
coordinate_reference_system
Defines the as geospatial coordinate reference system as
GeospatialCoordinateReferenceSystem object
port_assignments
A mapping of device id to PlatformPort object, containing port reference
designators as values
type
Defines the specific type of deployment. Codelist: RemotePlatform, CabledNode,
CabledInstrument, Cruise, MobileAsset
agent_default_config
The default settings for this agent (pubrate, etc)
commissioned
Commissioning status for this agent type as CommissionedStatusType value
stream_configurations
List of StreamConfiguration objects for which this agent/driver can produce
granules on
alerts
Configures alert detectors for the device represented by this agent instance.
driver_config
Specific config for the agent driver, such as connection ports
agent_default_config
The default settings for this agent (pubrate, etc)
commissioned
Commissioning status for this agent type as CommissionedStatusType value
stream_configurations
List of StreamConfiguration objects for which this agent/driver can produce
granules on
alerts
Configures alert detectors for the device represented by this agent instance.
driver_config
Specific config for the agent driver, such as connection ports
Deployment
ExternalDatasetAgent
ExternalDatasetAgentInstance
InstrumentAgent
InstrumentAgentInstance
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 15 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
port_agent_config
Contains configuration for accessing the instrument specific port agent
startup_config
Contains configuration for the instrument agent and agent driver start
commissioned
Commissioning status as CommissionedStatusType value
contacts
Contacts for this device as list of ContactInformation objects.
controllable
Whether the device can be sent a control message
custom_attributes
Additional attribute values applicable for the device's model as key-value pairs.
The attribute names must align with the DeviceModel:custom_attributes:name field
for this type of device.
firmware_version
Identifier of hard-coded operating system in unit
hardware_version
Version of the hardware
last_calibration_datetime
The date of the last instrument calibration, expressed in ISO format.
message_controllable
Indicates that this resource can be controlled by messages sent to it
monitorable
Indicates that this resource has a communication port for real-time monitoring
reference_urls
References to pages about that individual device (e.g. configuration diagram)
serial_number
Unique identifier of device provided by manufacturer
uuid
The UUID provided by the manufacturer
baud_rate_default
Default rate at which bits are sent over RS232 interface
class_alternate_name
Alternate name of instrument class (from SAF)
class_description
Description for instrument class (from SAF)
class_id
Code for instrument class (from SAF)
class_name
Name of instrument class (from SAF)
clock_max_drift
Manufacturer's specifications of clock drift rate
clock_notes
Notes on real-time clock
configuration
Instrument series variant (from SAF)
custom_attributes
Additional attributes permissible or required for this specific model. Each entry in
the list is a CustomAttribute object (see above). A device of this model should then
store these attribute values in the corresponding custom_attributes of the device
instance.
InstrumentDevice
InstrumentModel
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 16 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
electrical_notes
Any notes about electrical attributes or characteristics
family_id
The family of instrument (from SAF). Codelist: CAM, CO2, CTD, DO2, FDC, FLO,
HYD, IES, MET, MSP, NIT, NUT, OBS, OPT, PRS, RAS, SFL, VEL, WAV, ZPL
family_name
Name of instrument family (from SAF)
has_clock
Indicates whether the device has an internal clock or not
height
The height of the instrument device in meters, typically from bottom to top as
mounted or resting
hotel_current
Amount of current drawn by the instrument on standby
inline_management
Can you manage the instrument while it is operating
instrument_classes_supported
A list of instrument classes this instrument model can support
instrument_family
DEPRECATE, REMOVE - the family of instrument
integrated_inductive_modem_available
Is there an inductive modem in the unit?
internal_battery
Is there an internal battery?
internal_data_storage
Can system store data internally?
length
The length of the instrument device in meters, generally along the longest
(alternatively, the facing) side-to-side dimension
manufacturer
The name of the manufacturer
manufacturer_url
The primary URL of the manufacturer
mixed_sampling_mode
Polled vs ...
ooi_make_model
Model makemodel code (from SAF)
operational_depth_maximum
Maximum depth for correct functioning (meters)
parameter_characteristics_reports
List of ParameterCharacteristicsReport objects
power_source
Required power source is external or internal
power_supply_voltage_maximum
Maximum voltage supported by internal power supply
power_supply_voltage_minimum
Minimum voltage supported by internal power supply
primary_interface
The principal interface by which the instrument communicates (typically via its
platform) with OOI as PrimaryInterface value.
reference_urls
Location(s) where additional information about this model can be obtained
required_on_time
Time system must be on before sampling.
series_id
Code for instrument series (from SAF)
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 17 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
series_name
Name of instrument series (from SAF)
subseries_id
Code for instrument subseries (from SAF)
subseries_name
Name of instrument subseries (from SAF)
survival_depth_maximum
Maximum depth beyond which instrument may be damaged (meters)
voltage
Nominal voltage at which unit operates, in Volts
wattage
Nominal wattage consumed by instrument, in Watts
weight
Weight of instrument in air, as configured for operation, in kg
width
The width of the instrument device in meters, from side to side (orthogonal to
length measurement)
alt_resource_type
For UI distinction purposes, a more fine granular resource type
constraint_list
Applicable constraints as a list of GeospatialBounds, GeospatialPoint,
TemporalBounds, etc objects
coordinate_reference_system
Defines the as geospatial coordinate reference system as
GeospatialCoordinateReferenceSystem object
environment
The environment of the site. Used to differentiate marine deployments from, e.g.
"bucket" tests
local_name
Unique part of name that can be composed with next higher level name
planned_uplink_port
Describes the nominal port of the parent or network uplink device
reference_designator
OOI reference designator
negotiation_status
Current status of negotiation as NegotiationStatusEnum value.
negotiation_type
Specific variant of negotiation as NegotiationTypeEnum value
proposals
A list of service agreement proposals (SAP) describing the sequent steps of the
negotiation. The last SAP in the list is considered the most recent one.
reason
Describes a reason for a status (optional)
event_subtype
Event filter by event subtype
event_type
Event filter by event type
origin
Event filter by origin
InstrumentSite
Negotiation
NotificationRequest
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 18 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
origin_type
Event filter by origin type
temporal_bounds
The start and end time of this subscription
type
Indicates the notification type as NotificationType value
constraint_list
Applicable constraints as a list of GeospatialBounds, GeospatialPoint,
TemporalBounds, etc objects
coordinate_reference_system
Defines the as geospatial coordinate reference system as
GeospatialCoordinateReferenceSystem object
environment
The environment of the site. Used to differentiate marine deployments from, e.g.
"bucket" tests
local_name
Unique part of name that can be composed with next higher level name
reference_designator
OOI reference designator
spatial_area_name
The larger geospatial area (aka OI array/site) used to group sites
url
URL to an external homepage about the observatory
contacts
A list of ContactInformation entities that serves as a contact point
institution
Identifies the institution that operates the Org/Facility
message_controllable
Indicates that this resource can be controlled by messages sent to it
monitorable
Indicates that this resource has a communication port for real-time monitoring
org_governance_name
A permanent human readable identifier for the Org.
org_type
Specializes the type of Org as OrgTypeEnum value
url
A URL for the Org
agent_default_config
The default settings for this agent (pubrate, etc)
commissioned
Commissioning status for this agent type as CommissionedStatusType value
stream_configurations
List of StreamConfiguration objects for which this agent/driver can produce
granules on
alerts
Configures alert detectors for the device represented by this agent instance.
driver_config
Specific config for the agent driver, such as connection ports
Observatory
Org
PlatformAgent
PlatformAgentInstance
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 19 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
commissioned
Commissioning status as CommissionedStatusType value
contacts
Contacts for this device as list of ContactInformation objects.
controllable
Whether the device can be sent a control message
custom_attributes
Additional attribute values applicable for the device's model as key-value pairs.
The attribute names must align with the DeviceModel:custom_attributes:name field
for this type of device.
message_controllable
Indicates that this resource can be controlled by messages sent to it
monitorable
Indicates that this resource has a communication port for real-time monitoring
platform_monitor_attributes
Describes this platform's monitors as a list of PlatformMonitorAttributes objects
ports
Describes this platform's ports as a list of PlatformPort objects
reference_urls
References to pages about that individual device (e.g. configuration diagram)
serial_number
Unique identifier of device provided by manufacturer
uuid
The UUID provided by the manufacturer
ci_onboard
Whether ION software is run on platform resources
custom_attributes
Additional attributes permissible or required for this specific model. Each entry in
the list is a CustomAttribute object (see above). A device of this model should then
store these attribute values in the corresponding custom_attributes of the device
instance.
has_clock
Indicates whether the device has an internal clock or not
height
The height of the instrument device in meters, typically from bottom to top as
mounted or resting
length
The length of the instrument device in meters, generally along the longest
(alternatively, the facing) side-to-side dimension
manufacturer
The name of the manufacturer
manufacturer_url
The primary URL of the manufacturer
parameter_characteristics_reports
List of ParameterCharacteristicsReport objects
platform_family
The family of platform, with term from the OOI Node Type list. Codelist: Mediumpower Junction Box, Interface Box HD Camera, Float Junction Box, Low-power
Junction Box, Winch Junction Box, Profiler Junction Box, Multi-Function Node,
Fixed Instruments, Surface Buoy Surface-Piercing Profiler, Wire-Following Profiler,
PlatformDevice
PlatformModel
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 20 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
Mid-Water Platform, AUV, Gliders, Benthic Package Deep Profiler
platform_type
Broad categorization of the platform into major functional category. Codelist: AUV,
Glider, Mooring, Profiler, Cable Node, ...
reference_urls
Location(s) where additional information about this model can be obtained
shore_networked
Whether the platform is typically connected to the terrestrial network (boolean).
Codelist: Always Fast, Always Slow, Intermittent, Never
voltage
Nominal voltage at which unit operates, in Volts
wattage
Nominal wattage consumed by instrument, in Watts
weight
Weight of instrument in air, as configured for operation, in kg
width
The width of the instrument device in meters, from side to side (orthogonal to
length measurement)
alt_resource_type
For UI distinction purposes, a more fine granular resource type
constraint_list
Applicable constraints as a list of GeospatialBounds, GeospatialPoint,
TemporalBounds, etc objects
coordinate_reference_system
Defines the as geospatial coordinate reference system as
GeospatialCoordinateReferenceSystem object
environment
The environment of the site. Used to differentiate marine deployments from, e.g.
"bucket" tests
local_name
Unique part of name that can be composed with next higher level name
planned_uplink_port
Describes the nominal port of the parent or network uplink device
reference_designator
OOI reference designator
constraint_list
Applicable constraints as a list of GeospatialBounds, GeospatialPoint,
TemporalBounds, etc objects
coordinate_reference_system
Defines the as geospatial coordinate reference system as
GeospatialCoordinateReferenceSystem object
environment
The environment of the site. Used to differentiate marine deployments from, e.g.
"bucket" tests
local_name
Unique part of name that can be composed with next higher level name
reference_designator
OOI reference designator
PlatformSite
Subsite
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 21 of 29
Metadata Planning, Approach and Progress
Resource Type
Attribute Name
Description
contact
Describes user attributes as ContactInformation object
variables
A list of key-value arguments for the user; can be used to specify user
configuration information such as UI preferences
governance_name
A permanent valid human readable identifier for the role
org_governance_name
The permanent Org name this role pertains to
UserInfo
UserRole
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 22 of 29
Metadata Planning, Approach and Progress
Appendix 5: User-facing Object Types and their metadata attributes. Objects are re-usable sets of attributes that are used
to connect related attributes, or to create attribute sets that can be used by more than one Resource Type.
Object Type Name
Attribute Name
Description
code_meaning
Description of the meaning of the code value description of the meaning of the code value
code_value
The code value being described
administrative_area
Any placenames that are less specific than country and more specific than city, e.g. state or
province.
city
The city part of the address
country
The country part of the address.
email
Primary email for the contact
individual_name_family
The family, aka last, name
individual_names_given
The given, i.e. first and optionally middle, name(s)
organization_name
The name of the organization. Can be used in place of an individually-named contact when
appropriate.
phones
A list of phone contacts as a lists of Phone object list of phone objects
position_name
The position or role of the contact. For example, it may be preferable to name "OOI Data
Curator" as a contact instead of giving an individual's name, since the individual may change
through time the position or role of the contact
postal_code
The postal code, i.e. zip code
roles
The list of roles this contact has, e.g. owner, custodian, PointOfcontact
street_address
The street address portion of the mailing address
url
URL for the contact
variables
A list holding the extra information about user so that specific variables do not need to be held,
CabledInstrumentDeploym
entContext
CabledNodeDeploymentCo
ntext
CodeReport
ContactInformation
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 23 of 29
Metadata Planning, Approach and Progress
Object Type Name
Attribute Name
Description
e.g. IM, alternate phone, second address, facebook, etc. Every entry in this list has a name and
a value.
default
Default value for the attribute
description
Description for the attribute
name
Name of the attribute
type
Type of the attribute. Codelist: str, int, float, bool, list, dict
units
Units applied to the attribute value (if applicable)
connection_port
Unique identification of the port to which the device is attached
device_id
The id of the device to which this position applies relative to the parent device (usually an
instrument on a platform)
offset_x
Offset location of the mounted device along the X axis of the mounting platform, with more
positive offsets indicating the device is further along the positive direction of that axis and
indicating the device is at the origin of the axis (see
https://confluence.oceanobservatories.org/display/CIDev/Coordinate+Systems+and+Coordinate
+Transformations#CoordinateSystemsandCoordinateTransformations-MountingPosition)
offset_y
Offset location of the mounted device along the Y axis of the mounting platform, with more
positive offsets indicating the device is further along the positive direction of that axis and
indicating the device is at the origin of the axis
offset_z
Offset location of the mounted device along the Z axis of the mounting platform, with more
positive offsets indicating the device is further along the positive direction of that axis and
indicating the device is at the origin of the axis
reference_designator
OOI code for the position of an instrument location on a platform. Ex: GA01SUMO-FI003-03CTDMO0999
rotation_x
Indicates which way a device is pointing relative to its platform; specifies the rotation around the
X axis in degrees clockwise; assumes device is pointing out Z axis (see
https://confluence.oceanobservatories.org/display/CIDev/Coordinate+Systems+and+Coordinate
+Transformations#CoordinateSystemsandCoordinateTransformations-MountingOrientation)
rotation_y
Indicates which way a device is pointing relative to its platform; specifies the rotation around the
Y axis in degrees clockwise; assumes device is pointing out Z axis
CruiseDeploymentContext
CustomAttribute
DeviceMountingPosition
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 24 of 29
Metadata Planning, Approach and Progress
Object Type Name
Attribute Name
Description
rotation_z
Indicates which way a device is pointing relative to its platform; specifies the rotation around the
Z axis in degrees clockwise; assumes device is pointing out Z axis
phone_number
The phone number. phone number is assumed US if no '+' prefix exists to specify a country
code
phone_type
The type of phone number
archive_contact
The contact information for the archive POC.
archive_name
Name of an external repository where the data product has been submitted
archive_url
The URL of the data product within an external repository.
id_in_archive
The Unique ID of the resource in an external repository
submission_datetime
The last datetime this data product was submitted to an external repository (timestamp, no
constraints, stored).
geospatial_latitude_limit_north
Specifies one or both limits, for any or all of an entity's latitude, longitude, and vertical position,
with respect to a geospatial CRS
geospatial_latitude_limit_south
Specifies the southernmost latitude
geospatial_longitude_limit_east
Specifies the easternmost longitude (if the value is smaller than the minimum longitude, the
bounds fall on either side of the 18th meridian, and the enclosed area includes that meridian)
geospatial_longitude_limit_west
Specifies the westernmost longitude (if the value is larger than the maximum longitude, the
bounds fall on either side of the 180th meridian, and the enclosed area includes that meridian)
geospatial_vertical_max
Specifies the (numerically) maximum vertical position; if the vertical/z axis positive
(geospatial_vertical_positive) is down, the maximum value will be closer to earth center than the
minimum value
geospatial_vertical_min
Specifies the (numerically) minimum vertical position; if the vertical/z axis positive
(geospatial_vertical_positive) is down, the minimum value will be further away from earth center
than the maximum value
geospatial_geodetic_crs
The geospatial coordinate reference system, expressed as a URI (ideally a URL); incorporates
both coordinate system and datum; may be geodetic horizonal, vertical, or both
ExtendedPhone
ExternalArchive
GeospatialBounds
GeospatialCoordinateRefer
enceSystem
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 25 of 29
Metadata Planning, Approach and Progress
Object Type Name
Attribute Name
Description
geospatial_latitude_units
Specifies the units of measure for latitude
geospatial_longitude_units
Specifies the units of measure for longitude
geospatial_vertical_crs
The vertical coordinate reference system, expressed as a URI (ideally a URL); incorporates both
coordinate system and datum
geospatial_vertical_positive
Specifies the direction meant by more positive vertical location values; up indicates more
positive values are further from earth's center.
geospatial_vertical_units
The units of measure for the vertical location; overrides the geospatial_vertical_crs, if those units
are different
geospatial_horizontal_accuracy
The accuracy of the lat/lon info, expressed in the same units as the lat/lon fields
geospatial_latitude
Specifies the latitude, longitude, and/or vertical location of an entity, with respect to a geospatial
CRS
geospatial_longitude
Specifies the longitude
geospatial_vertical_accuracy
The accuracy of the vertical value, expressed in the same units
geospatial_vertical_location
Specifies a vertical position (relative to the datum, along the axis direction specified by
geospatial_vertical_positive)
email
Primary email for the institution
name
Name of the institution
phone
Primary phone for the institution
website
Website URL for the institution
axis
For CF compliance, holds X, Y, Z or T for vars holding lat, lon, depth and time info
cdm_data_type
The THREDDS data type
code_reports
Provide the meaning of flags, or other code lists that need description
custom_attributes
Holds additional attributes, especially those provided by external providers that are difficult to
characterize in advance
description
A human-readable description of the parameter
GeospatialPoint
Institution
MobileAssetDeploymentCo
ntext
Parameter
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 26 of 29
Metadata Planning, Approach and Progress
Object Type Name
Attribute Name
Description
fill_value
A value used to represent missing or undefined data
ion_name
The name given in the Data Product Specification
ioos_category
Selection from IOOS controlled vocabulary for parameters
long_name
A longer descriptive name
ooi_short_name
The 7 character code (now being expanded to >7 characters) used by OL to identify core data
producs, e.g. TEMPWAT)
reference_urls
List of URLs with information about the data parameter
standard_name
From CF standard names
units
Units of measure (from UDUNITS)
applicable_range_max
If the value is only valid within a particular range, this gives the maximum. Must be in same units
as the value.
applicable_range_min
If the value is only valid within a particular range, this gives the minimum. Must be in same units
as the value.
characteristic_name
Name of the characteristic being reported on. Common ones include accuracy, precision, and
drift
comments
Any additional important information about the characteristic
parameter_name
The ParameterDictionary name for the parameter being described.
source
Indicates the category of the source of the value, such as manufacturer, literature, etc
units
The units associated with the value of the characteristic
value
The value of the characteristic
aggregate_type
Defines the actual aggregate status category for this monitor as AggregateStatusType value
id
Monitor identifier
monitor_rate
Monitor rate in seconds
name
Monitor mane
units
Monitor units
ParameterCharacteristicsR
eport
PlatformMonitorAttributes
PlatformPort
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 27 of 29
Metadata Planning, Approach and Progress
Object Type Name
Attribute Name
Description
ip_address
IP address of port as needed for cabled platforms
port_type
The type of port as PortTypeEnum value
reference_designator
The OOI reference designator
device_mounting_positions
A list of DeviceMountingPosition objects
parameter_dictionary_name
the name of the parameter dictionary that defines the contents of the stream
stream_attributes
Additional attributes for the stream (for extension purposes)
stream_name
the tag that the driver uses to reference this stream
stream_type
Type of stream configuration
RemotePlatformDeployme
ntContext
StreamConfiguration
StreamRoute
credentials
exchange_point
routing_key
TemporalBounds
end_datetime
The end of the timespan (string with number of seconds since epoch)
name
Allows the kind of datetime to be specified, in cases where more than one TemporalBounds is
used. For example to differentiate the planned vs actual deployment datetimes.
start_datetime
The start of the timespan (string with number of seconds since epoch)
term_url
A URL defining a term
term_value
The name of the keyword applied to a resource
vocabulary_name
The name of the vocabulary or guideline from which the keyword was drawn, if applicable
vocabulary_url
A URL to the source of a controlled vocabulary
Term
Hardcopies are uncontrolled. Verify version prior to use.
Version 1-00
Page 28 of 29