InPort XML Loader Documentation

Configuration Option: publish-on-load

Optional.

This option specifies that the catalog item being created or updated should also be published after it is loaded.

The Catalog Item will automatically be moved through all workflow state transitions necessary to reach Published status from its starting state, and all transitions will be logged as being executed by the Loader user.

Note: You must have at least a Publisher or higher role on the Catalog Item to use this option. The parent of the item must also already be Published.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <loader-options>
        <publish-on-load/>
    </loader-options>
    ...
</inport-metadata>

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <loader-options>
        <publish-on-load>
            <visibility>External</visibility>
        </publish-on-load>
    </loader-options>
    ...
</inport-metadata>

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <loader-options>
        <publish-on-load>
            <approved-by>
                john.doe@noaa.gov
            </approved-by>
        </publish-on-load>
    </loader-options>
    ...
</inport-metadata>

Configuration Option: replace-catalog-item

Optional.

This option specifies that the catalog item being updated should be completely replaced with the contents of the InPort XML file.

All metadata information -- with the exception of the Catalog Item ID and the Catalog Item history for the existing Catalog Item -- will be deleted.

In addition, if the Catalog Item is a Data Set with Child Entities, these Child Entities will be deleted and completely replaced with the Child Entities in the incoming XML file. Note that the Child Entity Catalog Item IDs will not be preserved; only the Data Set Catalog Item ID will be.

This option should only be used for Catalog Item updates, not creation. It is particularly recommended for InPort loader users who manage their metadata outside of InPort, and who want to update their metadata on InPort with a newer XML file.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <loader-options>
    <replace-catalog-item/>
    </loader-options>
    ...
</inport-metadata>

Field: catalog-item-id

InPort Label: Catalog Item ID
Required for item updates. Not applicable for item creation.

Specifies the Catalog Item ID of the catalog item to be updated. Should never be used for item creation.

The Loader user must have an Author or higher role on the Catalog Item to update it.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-id>1234</catalog-item-id>
        ...
    </item-identification>
</inport-metadata>

The example snippet would update Catalog Item ID 1234.

Field: catalog-item-type

InPort Label: Catalog Item Type
Required for item creation.

Specifies the Catalog Item Type of the record.

The value must be one of the following:

• Data Set
• Project
• Entity
• Document
• Procedure
• Publication

Note: This can only be used to set the Catalog Item Type for new items. The Catalog Item Type of an existing item cannot be changed. As such, it is not applicable for Catalog Item updates.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        ...
    </item-identification>
</inport-metadata>

Field: title

InPort Label: Title
Required for item creation, optional for item updates.
Max Length: 4000 characters.

Specifies the title of the Catalog Item.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        ...
    </item-identification>
</inport-metadata>

Field: short-name

InPort Label: Short Name
Optional.
Max Length: 160 characters.

Specifies the catalog item's short name.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <short-name>DS Short Name</short-name>
    </item-identification>
</inport-metadata>

Field: parent-catalog-item-id

InPort Label: Parent Catalog Item ID
Required for item creation. Not applicable for item updates.

Specifies the Catalog Item ID of the catalog item under which the new item should be created. Should never be used for item updates.

The Loader user must have an Author or higher role on the parent Catalog Item to create a child item.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <parent-catalog-item-id>1234</parent-catalog-item-id>
        ...
    </item-identification>
</inport-metadata>

The example snippet would create a new Catalog Item under Catalog Item ID 1234.

Field: status

InPort Label: Status
Optional.

Specifies the status of the Catalog Item.

The value must be one of the following:

• Planned
• In Work
• On Going
• Completed
• Superseded
• Obsolete
• Archive Only
• Withdrawn
• Legacy

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <status>In Work</status>
    </item-identification>
</inport-metadata>

Field: creation-date

InPort Label: Creation Date
Optional.

Specifies the creation date of the Catalog Item.

The value must be either a date specified in ISO 8601 extended format (YYYY-MM-DD, YYYY-MM, YYYY), or the value "Unknown". If a date is provided, it should use the appropriate granularity (Year, Month or Day). For example, if the date is significant only up to the month, use the YYYY-MM format.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <creation-date>2005-06</creation-date>
    </item-identification>
</inport-metadata>

Field: revision-date

InPort Label: Revision Date
Optional.

Specifies the revision date of the Catalog Item.

The value must be either a date specified in ISO 8601 extended format (YYYY-MM-DD, YYYY-MM, YYYY), or the value "Unknown". If a date is provided, it should use the appropriate granularity (Year, Month or Day). For example, if the date is significant only up to the month, use the YYYY-MM format.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <revision-date>2005-06</revision-date>
    </item-identification>
</inport-metadata>

Field: publication-date

InPort Label: Publication Date
Optional.

Specifies the publication date of the Catalog Item.

The value must be either a date specified in ISO 8601 extended format (YYYY-MM-DD, YYYY-MM, YYYY), or the value "Unknown". If a date is provided, it should use the appropriate granularity (Year, Month or Day). For example, if the date is significant only up to the month, use the YYYY-MM format.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <publication-date>2005-06</publication-date>
    </item-identification>
</inport-metadata>

Field: abstract

InPort Label: Abstract
Optional.
Max Length: 64000 characters.

Specifies the abstract of the Catalog Item.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <abstract>This is an example abstract.</title>
    </item-identification>
</inport-metadata>

Field: purpose

InPort Label: Purpose
Optional.
Max Length: 32767 characters.

Specifies the purpose of the Catalog Item.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <purpose>This is an example purpose.</purpose>
    </item-identification>
</inport-metadata>

Field: notes

InPort Label: Notes
Optional.
Max Length: 4000 characters.

Specifies notes for the Catalog Item.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <notes>These are example notes.</notes>
    </item-identification>
</inport-metadata>

Field: other-citation-details

InPort Label: Other Citation Details
Optional.
Max Length: 4000 characters.

Specifies other citation details for the Catalog Item.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <other-citation-details>This is an example of other citation details.</other-citation-details>
    </item-identification>
</inport-metadata>

Field: supplemental-information

InPort Label: Supplemental Information
Optional.
Max Length: 32767 characters.

Specifies supplemental information for the Catalog Item.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <supplemental-information>This is an example for supplemental information.</supplemental-information>
    </item-identification>
</inport-metadata>

Field: doi

InPort Label: DOI (Digital Object Identifier)
Optional.

Specifies the DOI for the Catalog Item.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <doi>doi:10.1594/PANGAEA.667386</doi>
    </item-identification>
</inport-metadata>

Field: doi-registration-authority

InPort Label: DOI Registration Authority
Optional.
Max Length: 1000 characters.

Specifies the DOI Registration Authority for the DOI.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <doi>doi:10.1594/PANGAEA.667386</doi>
        <doi-registration-authority>The registration authority</doi-registration-authority>
    </item-identification>
</inport-metadata>

Field: doi-issue-date

InPort Label: DOI Issue Date
Optional.

Specifies the DOI Issue Date for the DOI.

The value must be a date consisting of year, month, and day, specified in ISO 8601 extended format (YYYY-MM-DD).

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <item-identification>
        <catalog-item-type>Data Set</catalog-item-type>
        <title>My Data Set</title>
        <parent-catalog-item-id>1234</catalog-item-id>
        <doi>doi:10.1594/PANGAEA.667386</doi>
        <doi-issue-date>2001-02-03</doi-issue-date>
    </item-identification>
</inport-metadata>

Attribute: cc-id

This attribute is NOT allowed for Keywords.

Attribute: controlled

Optional.

Specifies whether the user's intended keyword is Controlled or Uncontrolled.

The value must be "Yes" or "No".

Note that while the optional controlled attribute can be used as a flag on the <keyword> tag, this attribute does not constrain the Loader to store a Keyword in a particular way; it only serves to signal the Loader user's intent. This may improve the Loader's analysis when user-supplied keywords can only be partially matched against Controlled Keywords in InPort. It may also help the Loader to provide more appropriate error messages if a problem is found.

We recommend using this flag when you know the controlled status of the Keyword and can emit this information in the XML; however, it is not required for the Loader to function properly.

Example:

<keywords>
    <keyword controlled="Yes">
        <keyword-type>Theme</keyword-type>
        <thesaurus>ISO 19115 Topic Category</thesaurus>
        <keyword>oceans</keyword>
    </keyword>
</keywords>

Field: keyword-type

InPort Label: Keyword Type
Required.

Specifies the type of Keyword.

The value must be one of the following:

• Theme
• Temporal
• Spatial
• Stratum
• Instrument
• Platform

Note: If the user-supplied keyword is a Controlled Keyword in InPort, the Keyword Type of the corresponding Controlled Keyword Thesauri in InPort will be retained, regardless of what <keyword-type> is supplied by the Loader user.

Example:

<keywords mode="replace">
    <keyword controlled="Yes">
        <keyword-type>Theme</keyword-type>
        <thesaurus>Global Change Master Directory (GCMD) Science Keywords</thesaurus>
        <keyword>EARTH SCIENCE > SPECTRAL/ENGINEERING > INFRARED WAVELENGTHS > INFRARED IMAGERY</keyword>
    </keyword>
</keywords>

Field: thesaurus

InPort Label: Thesaurus
Optional.
Max Length: 250 characters.

Specifies the thesaurus for the Keyword.

The value "None" is disallowed. If no thesaurus is provided, or if the thesaurus provided is "None", it will be set to a null value.

Note: When specifying thesauri for Controlled Keywords that InPort supports, please use the thesaurus name as cited within NOAA.

If a user supplies a thesaurus name which the Loader can determine to be a Controlled Keyword Thesaurus in InPort, the official thesaurus name in InPort will be used for the record.

Example:

<keywords mode="replace">
    <keyword controlled="Yes">
        <keyword-type>Theme</keyword-type>
        <thesaurus>Global Change Master Directory (GCMD) Science Keywords</thesaurus>
        <keyword>EARTH SCIENCE > SPECTRAL/ENGINEERING > INFRARED WAVELENGTHS > INFRARED IMAGERY</keyword>
    </keyword>
</keywords>

Field: keyword

InPort Label: Keyword
Required.
Max Length: 500 characters.

Specifies the keyword value.

Note: When specifying Controlled Keywords that InPort supports, please use the official keyword name.

If a user supplies a keyword which the Loader can determine to be a Controlled Keyword in InPort, the official keyword name in InPort will be used for the record.

Note: Keywords which contain reserved XML characters such as < must be properly escaped in the XML file. For example, "1 meters - < 10 meters" should be written as "1 meters - &lt; 10 meters".

Example:

<keywords mode="replace">
    <keyword controlled="Yes">
        <keyword-type>Theme</keyword-type>
        <thesaurus>Global Change Master Directory (GCMD) Science Keywords</thesaurus>
        <keyword>EARTH SCIENCE > SPECTRAL/ENGINEERING > INFRARED WAVELENGTHS > INFRARED IMAGERY</keyword>
    </keyword>
</keywords>

<keywords>
    <keyword controlled="Yes">
        <keyword-type>Theme</keyword-type>
        <thesaurus>World Register of Marine Species</thesaurus>
        <keyword identifier="137094">Delphinus delphis</keyword>
    </keyword>
    <keyword controlled="Yes">
        <keyword-type>Theme</keyword-type>
        <thesaurus>Global Change Master Directory (GCMD) Science Keywords</thesaurus>
        <keyword identifier="de89c42c-206a-4573-a2af-edffe5ddd6bf">EARTH SCIENCE > HUMAN DIMENSIONS > ENVIRONMENTAL IMPACTS > BIOCHEMICAL RELEASE</keyword>
    </keyword>
</keywords>

Field: organization

InPort Label: Organization
Optional.

Specifies the organization name or organizational acronym of the Physical Location.

The value must match an existing InPort organization name or acronym, exactly as it appears in InPort.

Example:

<physical-location>
    <organization>Pacific Islands Fisheries Science Center</organization>
</physical-location>

Example:

<physical-location>
    <organization>PIFSC</organization>
</physical-location>

Field: city

InPort Label: City
Optional.
Max Length: 60 characters.

Specifies the city of the Physical Location

Example:

<physical-location>
    <city>Honolulu</city>
</physical-location>

Field: state-province

InPort Label: State / Province
Optional.

Specifies the state of the Physical Location.

Only standard two-letter acronyms for all states and territories in the US are recognized.

Example:

<physical-location>
    <state-province>HI</state-province>
</physical-location>

Field: country

InPort Label: Country
Optional.
Max Length: 30 characters.

Specifies the country of the Physical Location.

Example:

<physical-location>
    <country>USA</country>
</physical-location>

Field: location-description

InPort Label: Location Description
Optional.
Max Length: 4000 characters.

Specifies a description of the Physical Location.

Example:

<physical-location>
    <location-description>Sample location description</location-description>
</physical-location>

Field: data-set-scope-code

InPort Label: Data Set Scope Code
Required.

Specifies the scope of the Data Set.

The value must be one of the following:

• Data Set
• Series
• Non-Geographic Data Set
• Model
• Application

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
</data-set-information>

Field: data-set-type

InPort Label: Data Set Type
Optional.
Max Length: 50 characters.

Specifies the type of the Data Set.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <data-set-type>Database</data-set-type>
</data-set-information>

Field: maintenance-frequency

InPort Label: Maintenance Frequency
Optional.

Specifies the maintenance frequency of the Data Set.

The value must be one of the following:

• Continually
• Daily
• Twice a Week
• Weekly
• Every Other Week
• Monthly
• Quarterly
• Twice a Year
• Annually
• Every Other Year
• Unknown
• As Needed
• Irregular
• None Planned

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <maintenance-frequency>Annually</maintenance-frequency>
</data-set-information>

Field: maintenance-note

InPort Label: Maintenance Note
Optional.
Max Length: 4000 characters.

Specifies information regarding requirements for maintaining the resource.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <maintenance-note>Sample maintenance note</maintenance-note>
</data-set-information>

Field: data-set-creation-date

InPort Label: Data Set Creation Date
Optional.

Specifies the creation date of the Data Set.

Note: This field is deprecated.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <data-set-creation-date>2005-06</data-set-creation-date>
</data-set-information>

Field: data-set-revision-date

InPort Label: Data Set Revision Date
Optional.

Specifies the revision date of the Data Set.

Note: This field is deprecated.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <data-set-revision-date>2005-06</data-set-revision-date>
</data-set-information>

Field: data-set-publication-status

InPort Label: Data Set Publication Status
Optional.

Specifies the publication status of the Data Set.

Note: This field is deprecated.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <data-set-publication-status>Published</data-set-publication-status>
</data-set-information>

Field: publish-date

InPort Label: Publish Date
Optional.

Specifies the publish date of the Data Set.

Note: This field is deprecated.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <data-set-publication-status>Published</data-set-publication-status>
    <publish-date>2005-06</publish-date>
</data-set-information>

Field: data-presentation-form

InPort Label: Data Presentation Form
Optional.
Max Length: 100 characters.

Specifies the data presentation form of the Data Set.

The value should be one of the following if appropriate, but can also be entered as free text:

• Audio (digital)
• Audio (hardcopy)
• Diagram (digital)
• Diagram (hardcopy)
• Document (digital)
• Document (hardcopy)
• Image (digital)
• Image (hardcopy)
• Map (digital)
• Map (hardcopy)
• Model (digital)
• Model (hardcopy)
• Multimedia (digital)
• Multimedia (hardcopy)
• Profile (digital)
• Profile (hardcopy)
• Table (digital)
• Table (hardcopy)
• Video (digital)
• Video (hardcopy)

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <data-presentation-form>Map (digital)</data-presentation-form>
</data-set-information>

Field: entity-attribute-overview

InPort Label: Entity Attribute Overview
Optional.
Max Length: 4000 characters.

Specifies an overview of the entities and attributes for the Data Set.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <entity-attribute-overview>Sample entity attribute overview</entity-attribute-overview>
</data-set-information>

Field: entity-attribute-detail-citation

InPort Label: Entity Attribute Detail Citation
Optional.
Max Length: 500 characters.

Specifies a citation to detailed information about the entities and attributes for the Data Set.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <entity-attribute-detail-citation>Sample entity attribute detail citation</entity-attribute-detail-citation>
</data-set-information>

Field: entity-attribute-detail-url

InPort Label: Entity Attribute Detail URL
Optional.
Max Length: 240 characters.

Specifies an URL to detailed information about the entities and attributes for the Data Set.

The value must be a valid URL and must begin with http://, https://, or ftp://.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <entity-attribute-detail-url>
        https://my.url/
    </entity-attribute-detail-url>
</data-set-information>

Field: distribution-liability

InPort Label: Distribution Liability
Optional.
Max Length: 4000 characters.

Specifies distribution liability information for the Data Set.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <distribution-liability>Sample distribution liability</distribution-liability>
</data-set-information>

Field: data-set-credit

InPort Label: Data Set Credit
Optional.
Max Length: 4000 characters.

Specifies credits for the Data Set.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <data-set-credit>John Doe</data-set-credit>
</data-set-information>

Field: instrument

InPort Label: Instrument
Optional.
Max Length: 1000 characters.

Specifies the instrument used for data collection, if applicable.

Note: This field is deprecated.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <instrument>Multibeam Echosounder</instrument>
</data-set-information>

Field: platform

InPort Label: Platform
Optional.
Max Length: 1000 characters.

Specifies the platform used for data collection, if applicable.

Note: This field is deprecated.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <platform>Trawler</platform>
</data-set-information>

Field: physical-collection-fishing-gear

InPort Label: Physical Collection / Fishing Gear
Optional.
Max Length: 1000 characters.

Specifies the name of the physical collection or fishing gear used for data collection, if applicable.

Note: This field is deprecated.

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <physical-collection-fishing-gear>Midwater Trawl</physical-collection-fishing-gear>
</data-set-information>

Subsection: entity

InPort Label: Child Entity
Optional.

Each Child Entity should appear within its own <entity> node under the enclosing <entity-attribute-information> node.

Within each <entity> node, the InPort XML describing the child Entity can be nested. All other sections and fields applicable to Entities are eligible for inclusion, with the following exceptions:

• Do not include <catalog-item-id> or <parent-catalog-item-id> for Child Entities, as these are determined by the Loader automatically according to the parent-child relationship.
• The <catalog-item-type> field is unnecessary as the type is always Entity.
• The <loader-options> section is not supported for individual Child Entities. Any <loader-options> settings specified in the parent Data Set will be applied to all included Child Entities.

Example:

<entity-attribute-information>
    <entity>
        <item-identification>
            <title>Child Entity 1 Title</title>
            ...
        </item-identification>
        ...
    </entity>
    <entity>
        <item-identification>
            <title>Child Entity 2 Title</title>
            ...
        </item-identification>
        ...
    </entity>
    ...
</entity-attribute-information>

Back to Table of Contents

Field: publication-date

InPort Label: Publication Date
Optional.

Specifies the publication date of the Document.

Note: This field is deprecated.

Example:

<document-information>
    <publication-date>2005-06</publication-date>
</document-information>

Field: document-type

InPort Label: Document Type
Optional.
Max Length: 30 characters.

Specifies the type of Document.

Example:

<document-information>
    <document-type>Document Type</document-type>
</document-information>

Field: format

InPort Label: Format
Optional.

Specifies the format of the Document.

The value must be one of the following:

• Acrobat Portable Document Format
• Microsoft Excel
• Microsoft Powerpoint
• Microsoft Word
• Text
• Visio
• Word Perfect
• XML

Example:

<document-information>
    <format>Acrobat Portable Document Format</format>
</document-information>

Field: format-version

InPort Label: Format Version
Optional.
Max Length: 30 characters.

Specifies the format version of the Document.

Example:

<document-information>
    <format-version>8.1</format-version>
</document-information>

Field: document-status

InPort Label: Document Status
Optional.

Specifies the Document status.

The value must be one of the following:

• Draft
• Final
• In Review
• Planned
• Published

Example:

<document-information>
    <document-status>Final</document-status>
</document-information>

Field: entity-type

InPort Label: Entity Type
Optional.

Specifies the type of Entity.

The value must be one of the following:

• Data File
• Data Table
• Data View
• Form: Collection or Entry
• GIS File
• Report
• Spreadsheet
• XML Document
• Other

Example:

<entity-information>
    <entity-type>Data Table</entity-type>
</entity-information>

Field: active-version

InPort Label: Active Version?
Optional.

Specifies whether the Entity Information specified is for the active version.

The value must be "Yes" or "No".

Example:

<entity-information>
    <active-version>Yes</active-version>
</entity-information>

Field: alias

InPort Label: Alias
Optional.
Max Length: 50 characters.

Specifies the alias for the Entity.

Example:

<entity-information>
    <alias>the_alias</alias>
</entity-information>

Field: schema

InPort Label: Schema
Optional.
Max Length: 30 characters.

Specifies the schema for the Entity.

Example:

<entity-information>
    <schema>the_schema</schema>
</entity-information>

Field: description

InPort Label: Description
Optional.
Max Length: 4000 characters.

Specifies a description for the Entity.

Example:

<entity-information>
    <description>Sample description</description>
</entity-information>

Field: change-summary

InPort Label: Change Summary
Optional.
Max Length: 4000 characters.

Specifies the change summary for the Entity.

Example:

<entity-information>
    <change-summary>Sample change summary</change-summary>
</entity-information>

Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing Data Attribute to be referred to by its CC ID, so that its fields can be updated. The attribute can be used in combination with "add" or "replace" mode. (See notes on the mode attribute for data-attributes).

Note: The cc-id attribute value is only a reference. CC IDs are assigned automatically when records are created, and cannot be modified through the InPort XML Loader.

In most cases, it is easier and simpler to use replace mode, even though the same record may end up being deleted and then re-added. Nevertheless, the cc-id option is provided for greater flexibility in a range of upload scenarios.

Finding the CC ID:
To learn the CC ID of an existing Data Attribute, view the Catalog Item to which it belongs in InPort. The CC ID is displayed on the far right side of the header for each Data Attribute.

Example:

<data-attributes>
    <data-attribute cc-id="12345">
        ...
    </data-attribute>
    <data-attribute>
        ...
    </data-attribute>
    <data-attribute>
        ...
    </data-attribute>
</data-attributes>

The example snippet would remove all existing Data Attributes, except for the Data Attribute with CC ID 12345, which would be updated. In addition, two new Data Attributes would be added as specified.

Field: name

InPort Label: Name
Required.
Max Length: 160 characters.

Specifies the name of the Data Attribute.

All attribute names belonging to a single Entity must have a unique name.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
    </data-attribute>
</data-attributes>

Field: data-storage-type

InPort Label: Data Storage Type
Required.
Max Length: 106 characters.

Specifies the data storage type of the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
    </data-attribute>
</data-attributes>

Field: status

InPort Label: Status
Required.

Specifies the status of the Data Attribute.

The value must be one of the following:

• Active
• Inactive
• In Development
• In Review

Note: If this value is missing or invalid, the field is set to "Active" by default.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
    </data-attribute>
</data-attributes>

Field: seq-order

InPort Label: Sequence Number
Optional.

Specifies the sequence number for a Data Attribute.

The value must be a positive integer.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <seq-order>1</seq-order>
    </data-attribute>
</data-attributes>

Field: max-length

InPort Label: Max Length
Optional.

Specifies the maximum length of the data attribute.

The value must be a non-negative integer. Do not use this field for attributes with no explicit length.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <max-length>50</max-length>
    </data-attribute>
</data-attributes>

Field: min-length

InPort Label: Min Length
Optional.

Specifies the minimum length of the Data Attribute.

The value must be a non-negative integer.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <max-length>50</max-length>
        <min-length>1</max-length>
    </data-attribute>
</data-attributes>

Field: required

InPort Label: Required?
Optional.

Specifies whether or not the Data Attribute is required.

The value must be "Yes" or "No".
Note: If this field is not specified, the default value of "No" will be supplied.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <required>No</required>
    </data-attribute>
</data-attributes>

Field: primary-key

InPort Label: Primary Key
Optional.

Specifies whether the Data Attribute is a primary key.

The value must be "Yes" or "No".
Note: If this field is not specified, the default value of "No" will be supplied.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <primary-key>No</primary-key>
    </data-attribute>
</data-attributes>

Field: precision

InPort Label: Precision
Optional.

Specifies the precision of the data attribute.

The value must be a non-negative integer.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <precision>4</precision>
    </data-attribute>
</data-attributes>

Field: scale

InPort Label: Scale
Optional.

Specifies the scale of the Data Attribute.

The value must be a non-negative integer.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <scale>5</scale>
    </data-attribute>
</data-attributes>

Field: description

InPort Label: Description
Optional.
Max Length: 4000 characters.

Specifies the description of the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <description>Sample description</description>
    </data-attribute>
</data-attributes>

Field: units

InPort Label: Units
Optional.
Max Length: 60 characters.

Specifies the unit of measure of the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <units>meters</units>
    </data-attribute>
</data-attributes>

Field: case-restriction

InPort Label: Case Restriction
Optional.

Specifies the case restriction of the Data Attribute.

The value must be one of the following:

• Upper
• Lower
• Mixed

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <case-restriction>Mixed</case-restriction>
    </data-attribute>
</data-attributes>

Field: display-example

InPort Label: Display Example
Optional.
Max Length: 50 characters.

Specifies a display example for the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <display-example>Sample display example</display-example>
    </data-attribute>
</data-attributes>

Field: format-mask

InPort Label: Format Mask
Optional.
Max Length: 30 characters.

Specifies the format mask of the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <format-mask>DD-MON-RRRR</format-mask>
    </data-attribute>
</data-attributes>

Field: null-value

InPort Label: Null Value
Optional.
Max Length: 10 characters.

Specifies the null value of the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <null-value>NULL</null-value>
    </data-attribute>
</data-attributes>

Field: null-value-meaning

InPort Label: Null Value Meaning
Optional.
Max Length: 4000 characters.

Specifies the null value meaning for the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <null-value-meaning>Sample null value meaning</null-value-meaning>
    </data-attribute>
</data-attributes>

Field: allowed-values

InPort Label: Allowed Values
Optional.
Max Length: 4000 characters.

Specifies allowed values for the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <allowed-values>Sample allowed values</allowed-values>
    </data-attribute>
</data-attributes>

Field: default-value

InPort Label: Default Value
Optional.
Max Length: 2000 characters.

Specifies the default value for the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <default-value>Sample default value</default-value>
    </data-attribute>
</data-attributes>

Field: foreign-key-relations

InPort Label: Foreign Key Relations
Optional.
Max Length: 4000 characters.

Specifies the foreign key relations for the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <foreign-key-relations>Sample foreign key relations</foreign-key-relations>
    </data-attribute>
</data-attributes>

Field: derivation

InPort Label: Derivation
Optional.
Max Length: 4000 characters.

Specifies the derivation for the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <derivation>Sample derivation</derivation>
    </data-attribute>
</data-attributes>

Field: validation-rules

InPort Label: Validation Rules
Optional.
Max Length: 4000 characters.

Specifies the validation rules for the Data Attribute.

Example:

<data-attributes>
    <data-attribute>
        <name>ATTR_NAME</name>
        <data-storage-type>VARCHAR</data-storage-type>
        <status>Active</status>
        <validation-rules>Sample validation rules</validation-rules>
    </data-attribute>
</data-attributes>

Field: procedure-type

InPort Label: Procedure Type
Optional.
Max Length: 50 characters.

Specifies the type of the Procedure.

Example:

<procedure-information>
    <procedure-type>Procedure Type</procedure-type>
</procedure-information>

Subsection: procedure-steps

InPort Label: Procedure Steps
Optional.

Each Procedure Step should appear within its own <procedure-step> node under the enclosing <procedure-steps> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <procedure-steps>
        <procedure-step>
            ...
        </procedure-step>
        <procedure-step>
            ...
        </procedure-step>
    </procedure-steps>
    ...
</inport-metadata>

Attribute: mode

Optional; only applies to item updates. The value can be "replace" or "add". If no mode is specified, "replace" mode is used by default.

Replace mode (default) signifies that all existing Procedure Steps should be deleted and completely replaced by the Procedure Steps specified in the InPort XML file.

Add mode signifies that all existing Procedure Steps should be kept, and any Procedure Steps specified in the InPort XML file should be added as new Procedure Steps.

Example:

<procedure-steps mode="replace">
    <procedure-step>
    ...
    </procedure-step>
    <procedure-step>
    ...
    </procedure-step>
</procedure-steps>

Back to Table of Contents

<procedure-information>
    <procedure-steps>
        <procedure-step>
            <sequence-number>1</sequence-number>
            <label>PROC1</label>
            <step-name>Procedure Step 1</step-name>
        </procedure-step>
    </procedure-steps>
</procedure-information>

<procedure-information>
    <procedure-steps>
        <procedure-step>
            <sequence-number>1</sequence-number>
            <label>PROC1</label>
            <step-name>Procedure Step 1</step-name>
        </procedure-step>
    </procedure-steps>
</procedure-information>

<procedure-information>
    <procedure-steps>
        <procedure-step>
            <sequence-number>1</sequence-number>
            <label>PROC1</label>
            <step-name>Procedure Step 1</step-name>
        </procedure-step>
    </procedure-steps>
</procedure-information>

<procedure-information>
    <procedure-steps>
        <procedure-step>
            <sequence-number>1</sequence-number>
            <label>PROC1</label>
            <step-name>Procedure Step 1</step-name>
            <details>Sample details</details>
        </procedure-step>
    </procedure-steps>
</procedure-information>

<procedure-information>
    <procedure-steps>
        <procedure-step>
            <sequence-number>1</sequence-number>
            <label>PROC1</label>
            <step-name>Procedure Step 1</step-name>
            <purpose>Sample purpose</purpose>
        </procedure-step>
    </procedure-steps>
</procedure-information>

<procedure-information>
    <procedure-steps>
        <procedure-step>
            <sequence-number>1</sequence-number>
            <label>PROC1</label>
            <step-name>Procedure Step 1</step-name>
            <start-date>2016-01-01</start-date>
        </procedure-step>
    </procedure-steps>
</procedure-information>

<procedure-information>
    <procedure-steps>
        <procedure-step>
            <sequence-number>1</sequence-number>
            <label>PROC1</label>
            <step-name>Procedure Step 1</step-name>
            <start-date>2016-01-01</start-date>
            <end-date>2016-01-02</end-date>
        </procedure-step>
    </procedure-steps>
</procedure-information>

Field: project-type

InPort Label: Project Type
Optional.

Specifies the type of the Project.

The value must be one of the following:

• Activity
• Project
• Program
• Collection
• Data System
• Set of ...
• Task

Example:

<project-information>
    <project-type>Activity</project-type>
</project-information>

Field: is-mandated

InPort Label: Is Mandated
Optional.

Specifies whether the Project is mandated.

The value must be "Yes" or "No".

Example:

<project-information>
    <is-mandated>No</is-mandated>
</project-information>

Field: mandated-by

InPort Label: Mandated By
Optional.
Max Length: 100 characters.

Specifies what party the Project is mandated by.

Example:

<project-information>
    <mandated-by>NOAA</mandated-by>
</project-information>

Field: collection-type

InPort Label: Collection Type
Optional.

Specifies the collection type of the Project.

The value must be one of the following:

• Landings
• Logbook
• Observer
• Permit
• Socio-economic
• VMS

Example:

<project-information>
    <collection-type>Logbook</collection-type>
</project-information>

Field: collection-method

InPort Label: Collection Method
Optional.
Max Length: 50 characters.

Specifies the collection method of the Project.

Example:

<project-information>
    <collection-method>Sample collection method</collection-method>
</project-information>

Field: publication-type

InPort Label: Publication Type
Optional.

Specifies the Publication Type.

The value must be one of the following:

• Abstract
• Book
• External Presentation
• Journal
• Letter
• Popular Media
• Report
• Scientific Poster
• Section or Chapter
• Technical Memorandum
• Web Content
• Working Paper

Example:

<publication-information>
    <publication-type>Journal</publication-type>
</publication-information>

Field: technical-memo-date

InPort Label: Technical Memo Date
Optional.

Specifies the date of a Technical Memorandum.

Only applies when Publication Type is "Technical Memorandum".

The value must be a date consisting of year, month, and day, specified in ISO 8601 extended format (YYYY-MM-DD).

Example:

<publication-information>
    <publication-type>Technical Memorandum</publication-type>
    <technical-memo-date>2019-01-01</technical-memo-date>
</publication-information>

Field: technical-memo-number

InPort Label: Technical Memo Number
Optional.
Max Length: 250 characters.

Specifies the Technical Memorandum Number.

Only applies when Publication Type is "Technical Memorandum".

Example:

<publication-information>
    <publication-type>Technical Memorandum</publication-type>
    <technical-memo-number>1234</technical-memo-number>
</publication-information>

Field: professional-paper-series-number

InPort Label: Professional Paper Series Number
Optional.
Max Length: 250 characters.

Specifies the Professional Paper Series Number.

Example:

<publication-information>
    <professional-paper-series-number>1234</professional-paper-series-number>
</publication-information>

Field: series-name

InPort Label: Series Name
Optional.
Max Length: 500 characters.

Specifies the Series Name.

Example:

<publication-information>
    <series-name>Series Name</series-name>
</publication-information>

Field: series-issue

InPort Label: Series Issue
Optional.
Max Length: 150 characters.

Specifies the Series Issue.

Example:

<publication-information>
    <series-issue>1</series-issue>
</publication-information>

Field: series-page

InPort Label: Series Page
Optional.
Max Length: 50 characters.

Specifies the Series Page.

Example:

<publication-information>
    <series-page>123</series-page>
</publication-information>

Field: isbn

InPort Label: ISBN
Optional.
Max Length: 20 characters.

Specifies the ISBN of the Publication.

Example:

<publication-information>
    <isbn>123-4-56-789012-3</isbn>
</publication-information>

Field: issn

InPort Label: ISSN
Optional.
Max Length: 20 characters.

Specifies the ISSN of the Publication.

The ISSN must be in a valid format, NNNN-NNNC, where N is a digit, and C is a digit or the letter 'X'.

Example:

<publication-information>
    <issn>1234-5678</issn>
</publication-information>

Subsection: source-data-sets

InPort Label: Source Data Sets
Optional.

Specifies the Source Data Sets for the Publication.

Each Source Data Set should appear within its own <source-data-set> node under the enclosing <source-data-sets> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <source-data-sets>
        <source-data-set>
            ...
        </source-data-set>
        <source-data-set>
            ...
        </source-data-set>
    </source-data-sets>
    ...
</inport-metadata>

Attribute: mode

Optional; only applies to item updates. The value can be "replace" or "add". If no mode is specified, "replace" mode is used by default.

Replace mode (default) signifies that all existing Source Data Sets should be deleted and completely replaced by the Source Data Sets specified in the InPort XML file.

Add mode signifies that all existing Source Data Sets should be kept, and any Source Data Sets specified in the InPort XML file should be added as new Source Data Sets.

Example:

<source-data-sets mode="replace">
    <source-data-set>
    ...
    </source-data-set>
    <source-data-set>
    ...
    </source-data-set>
</source-data-sets>

Back to Table of Contents

<publication-information>
    <issn>1234-5678</issn>
    <source-data-sets>
        <source-data-set>
            <catalog-item-id>12345</catalog-item-id>
        </source-data-set>
    </source-data-sets>
</publication-information>

Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing Support Role to be referred to by its CC ID, so that its fields can be updated. The attribute can be used in combination with "add" or "replace" mode. (See notes on the mode attribute for support-roles).

Note: The cc-id attribute value is only a reference. CC IDs are assigned automatically when records are created, and cannot be modified through the InPort XML Loader.

In most cases, it is easier and simpler to use replace mode, even though the same record may end up being deleted and then re-added. Nevertheless, the cc-id option is provided for greater flexibility in a range of upload scenarios.

Finding the CC ID:
To learn the CC ID of an existing Support Role, view the Catalog Item to which it belongs in InPort. The CC ID is displayed on the far right side of the header for each Support Role.

Example:

<support-roles>
    <support-role cc-id="12345">
        ...
    </support-role>
    <support-role>
        ...
    </support-role>
    <support-role>
        ...
    </support-role>
</support-roles>

The example snippet would remove all existing Support Roles, except for the Support Role with CC ID 12345, which would be updated. In addition, two new Support Roles would be added as specified.

Field: support-role-type

InPort Label: Support Role Type
Required.

Specifies the support role type.

The value must be one of the following:

• Author
• Co-Author
• Collaborator
• Data Set Credit
• Data Steward
• Distributor
• Metadata Contact
• Originator
• Point of Contact
• Principal Investigator
• Process Contact
• Publisher

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-email>
            john.doe@noaa.gov
        </contact-email>
    </support-role>
</support-roles>

Field: from-date

InPort Label: From Date
Required.

Specifies the start date of the support role.

The value must be a date specified in ISO 8601 extended format (YYYY-MM-DD, YYYY-MM, YYYY). The date should use the appropriate granularity (Year, Month or Day). For example, if the date is significant only up to the month, use the YYYY-MM format.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-email>
            john.doe@noaa.gov
        </contact-email>
    </support-role>
</support-roles>

Field: to-date

InPort Label: To Date
Optional.

Specifies the end date of the support role.

Note that the absence of a To Date effectively indicates a support role which is effective up to the present.

The value must be a date specified in ISO 8601 extended format (YYYY-MM-DD, YYYY-MM, YYYY). The date should use the appropriate granularity (Year, Month or Day). For example, if the date is significant only up to the month, use the YYYY-MM format.

Note: The to-date value must be later than the from-date value.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <to-date>2015-12-31</to-date>
        <contact-type>Person</contact-type>
        <contact-email>
            john.doe@noaa.gov
        </contact-email>
    </support-role>
</support-roles>

Field: contact-type

InPort Label: Contact Type
Required.

Specifies the type of Contact filling the support role.

The value must be one of the following:

• Person
• Organization
• Position

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-email>
            john.doe@noaa.gov
        </contact-email>
    </support-role>
</support-roles>

Field: contact-email

InPort Label: Contact Email
Either contact-email or contact-name is required for each support role.

Specifies the email address of the Contact filling the support role.

It is recommended to ensure that Contacts referenced in InPort XML files already exist in InPort before loading. Please consult the list of Contacts in InPort to view the currently available Contacts names and their email addresses.

However, for Contacts with NOAA email addresses (ending in "noaa.gov"), the loader will attempt to add the Contact to InPort if it does not already exist for that Contact Type. In this situation, the Contact name <*-name> must also be provided.

Contacts with non-NOAA email address cannot be automatically inserted into InPort via the InPort XML Loader.

Note that the Contact's email address is only used for matching purposes — it is not possible to update a Contact's email address (or any other contact information) via the InPort XML Loader. Contact information can only be edited by Librarians within InPort.

Contacts can be matched by email address (<*-email>) or by name (<*-name>). However, due to the inherent ambiguity of names and potential for duplicates, it is preferable to identify Contacts by email address, rather than by name, whenever possible.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-email>
            john.doe@noaa.gov
        </contact-email>
    </support-role>
</support-roles>

Field: contact-name

InPort Label: Contact Name
Either contact-email or contact-name is required for each support role.

Specifies the person, organization or position filling the support role.

It is recommended to ensure that Contacts referenced in InPort XML files already exist in InPort before loading. Please consult the list of Contacts in InPort to view the currently available Contacts names and their email addresses.

However, for Contacts with NOAA email addresses (ending in "noaa.gov"), the loader will attempt to add the Contact to InPort if it does not already exist for that Contact Type. In this situation, the Contact name <*-name> must also be provided.

Contacts with non-NOAA email address cannot be automatically inserted into InPort via the InPort XML Loader.

Note that the Contact's email address is only used for matching purposes — it is not possible to update a Contact's email address (or any other contact information) via the InPort XML Loader. Contact information can only be edited by Librarians within InPort.

Contacts can be matched by email address (<*-email>) or by name (<*-name>). However, due to the inherent ambiguity of names and potential for duplicates, it is preferable to identify Contacts by email address, rather than by name, whenever possible.

Contact names are matched in slightly different ways depending on the type of Contact. For persons, the name should match the person name of the Contact record exactly as it appears in InPort, in the format [Last Name], [First Name] (e.g. "Doe, Jane"). If the person's middle name/initials are specified in InPort, the value for <contact-name> should reflect this in the format [Last Name], [First Name] [Middle Name/Initials] (e.g. "Doe, Jane H"), as it appears in InPort.

For organizations, the name must match the organization name of the Contact record exactly as it appears in InPort. Alternatively, if the Contact record is of a NOAA organization, and the NOAA Acronym field of the Contact record in InPort is populated, that acronym can also be used as a match for <noaa-acronym> (e.g. "PIFSC"), in lieu of providing the contact-name.

For positions the name must match the position name of the Contact record exactly as it appears in InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
    </support-role>
</support-roles>

Field: noaa-acronym

InPort Label: NOAA Acronym
Only applies to NOAA organizations.

Specifies the NOAA Acronym of the organization filling the support role.

Contact names are matched in slightly different ways depending on the type of Contact. For persons, the name should match the person name of the Contact record exactly as it appears in InPort, in the format [Last Name], [First Name] (e.g. "Doe, Jane"). If the person's middle name/initials are specified in InPort, the value for <contact-name> should reflect this in the format [Last Name], [First Name] [Middle Name/Initials] (e.g. "Doe, Jane H"), as it appears in InPort.

For organizations, the name must match the organization name of the Contact record exactly as it appears in InPort. Alternatively, if the Contact record is of a NOAA organization, and the NOAA Acronym field of the Contact record in InPort is populated, that acronym can also be used as a match for <noaa-acronym> (e.g. "PIFSC"), in lieu of providing the contact-name.

For positions the name must match the position name of the Contact record exactly as it appears in InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Organization</contact-type>
        <noaa-acronym>PIFSC</noaa-acronym>
    </support-role>
</support-roles>

Field: contact-instructions

InPort Label: Contact Instructions
Optional.
Max Length: 4000 characters.

Specifies contact instructions for the party filling the support role.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-email>
            john.doe@noaa.gov
        </contact-email>
        <contact-instructions>Contact by email preferred. Phone hours 9am-5pm.</contact-instructions>
    </support-role>
</support-roles>

Field: contact-address

InPort Label: Address
Optional.
Max Length: 100 characters.

Specifies the mailing address of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Address information must be complete. If any of the following fields are provided, all fields must be populated: <contact-address>, <contact-address-city>, <contact-address-state>, and <contact-address-zip>.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
    </support-role>
</support-roles>

Field: contact-address-city

InPort Label: City
Optional.
Max Length: 100 characters.

Specifies the city of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Address information must be complete. If any of the following fields are provided, all fields must be populated: <contact-address>, <contact-address-city>, <contact-address-state>, and <contact-address-zip>.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
    </support-role>
</support-roles>

Field: contact-address-state

InPort Label: State
Optional.
Max Length: 2 characters.

Specifies the state of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Address information must be complete. If any of the following fields are provided, all fields must be populated: <contact-address>, <contact-address-city>, <contact-address-state>, and <contact-address-zip>.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
    </support-role>
</support-roles>

Field: contact-address-zip

InPort Label: Zip Code
Optional.
Max Length: 12 characters.

Specifies the zip code of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Address information must be complete. If any of the following fields are provided, all fields must be populated: <contact-address>, <contact-address-city>, <contact-address-state>, and <contact-address-zip>.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
    </support-role>
</support-roles>

Field: contact-address-country

InPort Label: Country
Optional.
Max Length: 50 characters.

Specifies the country of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Address information must be complete. If any of the following fields are provided, all fields must be populated: <contact-address>, <contact-address-city>, <contact-address-state>, and <contact-address-zip>.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
        <contact-address-country>USA</contact-address-country>
    </support-role>
</support-roles>

Field: contact-phone-number

InPort Label: Phone Number
Optional.
Max Length: 50 characters.

Specifies the phone number of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
        <contact-phone-number>(123) 456-7890</contact-phone-number>
    </support-role>
</support-roles>

Field: contact-mobile-number

InPort Label: Mobile Number
Optional.
Max Length: 50 characters.

Specifies the mobile number of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
        <contact-mobile-number>(123) 456-7890</contact-mobile-number>
    </support-role>
</support-roles>

Field: contact-fax-number

InPort Label: Fax Number
Optional.
Max Length: 50 characters.

Specifies the fax number of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
        <contact-fax-number>(123) 456-7890</contact-fax-number>
    </support-role>
</support-roles>

Field: contact-url

InPort Label: URL
Optional.
Max Length: 250 characters.

Specifies the URL for the contact.

Optional, but required if any other URL field is populated.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
        <contact-url>https://my.url/</contact-url>
    </support-role>
</support-roles>

Field: contact-url-name

InPort Label: URL Name
Optional.
Max Length: 250 characters.

Specifies the name for the contact's URL.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
        <contact-url>https://my.url/</contact-url>
        <contact-url-name>My URL</contact-url-name>
    </support-role>
</support-roles>

Field: contact-url-description

InPort Label: URL Description
Optional.
Max Length: 1000 characters.

Specifies the description for the contact's URL.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
        <contact-url>https://my.url/</contact-url>
        <contact-url-description>My URL description</contact-url-description>
    </support-role>
</support-roles>

Field: contact-url-function

InPort Label: URL Function
Optional.

Specifies the function for the contact's URL.

The value must be "Online Resource" or "Browse Graphic".

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
        <contact-url>https://my.url/</contact-url>
        <contact-url-function>Online Resource</contact-url-function>
    </support-role>
</support-roles>

Field: contact-business-hours

InPort Label: Business Hours
Optional.
Max Length: 250 characters.

Specifies the business hours of the contact.

This field is only processed for new NOAA contacts. When a NOAA contact (identified by a NOAA email address) is found in an InPort XML file, and does not already exist in InPort, that contact and all related contact information fields are automatically loaded into InPort.

This is the only situation in which this field will be processed. Note also that the contact-name is also required for the NOAA contact to be added to InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Person</contact-type>
        <contact-name>Doe, John</contact-name>
        <contact-email>example@noaa.gov</contact-email>
        <contact-address>123 NOAA Way</contact-address>
        <contact-address-city>Silver Spring</contact-address-city>
        <contact-address-state>MD</contact-address-state>
        <contact-address-zip>12345</contact-address-zip>
          <contact-business-hours>9am - 5pm Eastern</contact-business-hours>
    </support-role>
</support-roles>

Field: person-email

InPort Label: Person
Optional.

Specifies the email address of the person who is filling the support role.

Note: This field is deprecated.

While this field has been deprecated, for a temporary transitional period it will continue to be supported. However, it will be matching against Contact records (of type Person), not Person records.

This field should not be used in combination with <contact-name> or <contact-email>.

The email address is used to identify the corresponding Person Contact in InPort; as such, the email address must be of an existing Contact of type Person in InPort. The value is used only for identification/matching purposes — it is not possible to update a person's email address (or any other contact information) via the InPort XML Loader. Contact information can only be edited by Librarians within InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <person-email>
            john.doe@noaa.gov
        </person-email>
    </support-role>
</support-roles>

Field: organization

InPort Label: Organization
Optional.

Specifies the organization which is filling the support role, or the organization that the person who fills the support role belongs to.

Note: This field is deprecated.

While this field has been deprecated, for a temporary transitional period it will continue to be supported. However, it will be matching against Contact records (of type Organization), not Organization records.

This field should not be used in combination with <contact-name> or <contact-email>.

The organization can be identified by name or acronym, exactly as it appears in InPort. The value is used only for identification/matching purposes — it is not possible to update a organization's name or acronym (or any other contact information) via the InPort XML Loader. Contact information can only be edited by Librarians within InPort.

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <organization>Pacific Islands Fisheries Science Center</organization>
    </support-role>
</support-roles>

Example:

<support-roles>
    <support-role>
        <support-role-type>Point of Contact</support-role-type>
        <from-date>2015-01-01</from-date>
        <organization>PIFSC</organization>
    </support-role>
</support-roles>

Field: currentness-reference

InPort Label: Currentness Reference
Optional.

Specifies the currentness reference of the Catalog Item across all extents.

The value should be "Ground Condition" or "Publication Date" if appropriate. If the appropriate value is not one of these possibilities, enter the value as free text.

Example:

<extents>
    <currentness-reference>Ground Condition</currentness-reference>
    <extent>
    ...
    </extent>
</extents>

Attribute: cc-id

This attribute is NOT allowed for Extent Groups.

Field: description

InPort Label: Description
Optional.
Max Length: 4000 characters.

Specifies a description for the extent group.

Example:

<extents>
    <extent>
        <description>Sample extent group description.</description>
    </extent>
</extents>

Subsection: time-frames

InPort Label: Time Frames
Optional.

Each Time Frame should appear within its own <time-frame> node under the enclosing <time-frames> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <extents>
        <extent>
            <time-frames>
                <time-frame>
                    ...
                </time-frame>
                <time-frame>
                    ...
                </time-frame>
            </time-frames>
        </extent>
    </extents>
    ...
</inport-metadata>

Attribute: mode

This attribute is NOT allowed for Time Frames.

Back to Table of Contents

<time-frames>
    <time-frame>
        <time-frame-type>Discrete</time-frame>
        <start-date-time>2015-01-01</start-date-time>
    </time-frame>
</time-frames>

<time-frames>
    <time-frame>
        <time-frame-type>Discrete</time-frame>
        <start-date-time>2015-01-01</start-date-time>
    </time-frame>
</time-frames>

<time-frames>
    <time-frame>
        <time-frame-type>Range</time-frame>
        <start-date-time>2015-01-01</start-date-time>
        <end-date-time>2015-01-01T15:30</end-date-time>
    </time-frame>
</time-frames>

<time-frames>
    <time-frame>
        <time-frame-type>Discrete</time-frame>
        <start-date-time>2015-01-01</start-date-time>
        <description>Sample description text.</description>
    </time-frame>
</time-frames>

<time-frames>
    <time-frame>
        <time-frame-type>Discrete</time-frame>
        <start-date-time>2015-01-01</start-date-time>
        <alternate-start-as-of-info>Sample alternate start as of info text.</alternate-start-as-of-info>
    </time-frame>
</time-frames>

<time-frames>
    <time-frame>
        <time-frame-type>Range</time-frame>
        <start-date-time>2015-01-01</start-date-time>
        <end-date-time>2015-01-01T15:30</end-date-time>
        <alternate-end-as-of-info>Sample alternate end as of info text.</alternate-end-as-of-info>
    </time-frame>
</time-frames>

Subsection: geographic-areas

InPort Label: Geographic Areas
Optional.

Each Geographic Area requires a full set of bounds or a description, or both.

Each Geographic Area should appear within its own <geographic-area> node under the enclosing <geographic-areas> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <extents>
        <extent>
            <geographic-areas>
                <geographic-area>
                    ...
                </geographic-area>
                <geographic-area>
                    ...
                </geographic-area>
            </geographic-areas>
        </extent>
    </extents>
    ...
</inport-metadata>

Attribute: mode

This attribute is NOT allowed for Geographic Areas.

Back to Table of Contents

<geographic-areas>
    <geographic-area>
        <west-bound>-10</west-bound>
        <east-bound>10</east-bound>
        <north-bound>10</north-bound>
        <south-bound>-10</south-bound>
    </geographic-area>
</geographic-areas>

<geographic-areas>
    <geographic-area>
        <west-bound>-10</west-bound>
        <east-bound>10</east-bound>
        <north-bound>10</north-bound>
        <south-bound>-10</south-bound>
    </geographic-area>
</geographic-areas>

<geographic-areas>
    <geographic-area>
        <west-bound>-10</west-bound>
        <east-bound>10</east-bound>
        <north-bound>10</north-bound>
        <south-bound>-10</south-bound>
    </geographic-area>
</geographic-areas>

<geographic-areas>
    <geographic-area>
        <west-bound>-10</west-bound>
        <east-bound>10</east-bound>
        <north-bound>10</north-bound>
        <south-bound>-10</south-bound>
    </geographic-area>
</geographic-areas>

<geographic-areas>
    <geographic-area>
        <description>Sample geographic description text.</description>
    </geographic-area>
</geographic-areas>

Subsection: vertical-extents

InPort Label: Vertical Extents
Optional.

Each Vertical Extent should appear within its own <vertical-extent> node under the enclosing <vertical-extents> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <extents>
        <extent>
            <vertical-extents>
                <vertical-extent>
                    ...
                </vertical-extent>
                <vertical-extent>
                    ...
                </vertical-extent>
            </vertical-extents>
        </extent>
    </extents>
    ...
</inport-metadata>

Attribute: mode

This attribute is NOT allowed for Vertical Extents.

Back to Table of Contents

<vertical-extents>
    <vertical-extent>
        <coordinate-reference-system>
            <epsg-code>2004</epsg-code>
        </coordinate-reference-system>
        <min>-50</min>
        <max>-30</max>
    </vertical-extent>
</vertical-extents>

<vertical-extents>
    <vertical-extent>
        <coordinate-reference-system>
            <epsg-code>2004</epsg-code>
        </coordinate-reference-system>
        <min>-50</min>
        <max>-30</max>
    </vertical-extent>
</vertical-extents>

<vertical-extents>
    <vertical-extent>
        <coordinate-reference-system>
            <epsg-code>2004</epsg-code>
        </coordinate-reference-system>
        <min>-50</min>
        <max>-30</max>
    </vertical-extent>
</vertical-extents>

<vertical-extents>
    <vertical-extent>
        <coordinate-reference-system>
            <epsg-code>2004</epsg-code>
        </coordinate-reference-system>
        <min>-50</min>
        <max>-30</max>
    </vertical-extent>
</vertical-extents>

Subsection: spatial-resolution

InPort Label: Spatial Resolution
Optional.

Example:

<spatial-information>
    <spatial-resolution>
        ...
    </spatial-resolution>
</spatial-information>

Back to Table of Contents

<spatial-information>
    <spatial-resolution>
        <angular-distance>1.5</angular-distance>
        <angular-distance-units>Degree</angular-distance-units>
    </spatial-resolution>
</spatial-information>

<spatial-information>
    <spatial-resolution>
        <angular-distance>1.5</angular-distance>
        <angular-distance-units>Degree</angular-distance-units>
    </spatial-resolution>
</spatial-information>

<spatial-information>
    <spatial-resolution>
        <horizontal-distance>10</horizontal-distance>
        <horizontal-distance-units>Meter</horizontal-distance-units>
    </spatial-resolution>
</spatial-information>

<spatial-information>
    <spatial-resolution>
        <horizontal-distance>10</horizontal-distance>
        <horizontal-distance-units>Meter</horizontal-distance-units>
    </spatial-resolution>
</spatial-information>

<spatial-information>
    <spatial-resolution>
        <vertical-distance>10</vertical-distance>
        <vertical-distance-units>Meter</vertical-distance-units>
    </spatial-resolution>
</spatial-information>

<spatial-information>
    <spatial-resolution>
        <vertical-distance>10</vertical-distance>
        <vertical-distance-units>Meter</vertical-distance-units>
    </spatial-resolution>
</spatial-information>

<spatial-information>
    <spatial-resolution>
        <equivalent-scale-denominator>100</equivalent-scale-denominator>
    </spatial-resolution>
</spatial-information>

<spatial-information>
    <spatial-resolution>
        <level-of-detail-description>Sample description</level-of-detail-description>
    </spatial-resolution>
</spatial-information>

Subsection: spatial-representation

InPort Label: Spatial Representation
Optional.

Example:

<spatial-information>
    <spatial-representation>
        ...
    </spatial-representation>
</spatial-information>

Back to Table of Contents

<spatial-information>
    <spatial-representation>
        <representations-used>
            ...
        </representations-used>
    </spatial-representation>
</spatial-information>

<spatial-information>
    <spatial-representation>
        <representations-used>
            <grid>Yes</grid>
        </representations-used>
    </spatial-representation>
</spatial-information>

<spatial-information>
    <spatial-representation>
        <representations-used>
            <vector>Yes</vector>
        </representations-used>
    </spatial-representation>
</spatial-information>

<spatial-information>
    <spatial-representation>
        <representations-used>
            <text-table>Yes</text-table>
        </representations-used>
    </spatial-representation>
</spatial-information>

<spatial-information>
    <spatial-representation>
        <representations-used>
            <tin>Yes</tin>
        </representations-used>
    </spatial-representation>
</spatial-information>

<spatial-information>
    <spatial-representation>
        <representations-used>
            <stereo-model>Yes</stereo-model>
        </representations-used>
    </spatial-representation>
</spatial-information>

<spatial-information>
    <spatial-representation>
        <representations-used>
            <video>Yes</video>
        </representations-used>
    </spatial-representation>
</spatial-information>

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <grid-representations>
        <grid-representation>
            ...
        </grid-representation>
        <grid-representation>
            ...
        </grid-representation>
    </grid-representations>
    ...
</inport-metadata>

<grid-representations mode="replace">
    <grid-representation>
    ...
    </grid-representation>
    <grid-representation>
    ...
    </grid-representation>
</grid-representations>

<grid-representations>
    <grid-representation cc-id="12345">
        ...
    </grid-representation>
    <grid-representation>
        ...
    </grid-representation>
    <grid-representation>
        ...
    </grid-representation>
</grid-representations>

<grid-representation>
    <dimension-count>1</dimension-count>
    <cell-geometry>Point</cell-geometry>
    <transformation-parameters-available>No</transformation-parameters-available>
    <axis-dimensions>
        <axis-dimension>
            ...
        </axis-dimension>
    </axis-dimensions>
</grid-representation>

<grid-representation>
    <dimension-count>1</dimension-count>
    <cell-geometry>Point</cell-geometry>
    <transformation-parameters-available>No</transformation-parameters-available>
    <axis-dimensions>
        <axis-dimension>
            ...
        </axis-dimension>
    </axis-dimensions>
</grid-representation>

<grid-representation>
    <dimension-count>1</dimension-count>
    <cell-geometry>Point</cell-geometry>
    <transformation-parameters-available>No</transformation-parameters-available>
    <axis-dimensions>
        <axis-dimension>
            ...
        </axis-dimension>
    </axis-dimensions>
</grid-representation>

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <axis-dimensions>
        <axis-dimension>
            ...
        </axis-dimension>
        <axis-dimension>
            ...
        </axis-dimension>
    </axis-dimensions>
    ...
</inport-metadata>

<axis-dimensions mode="replace">
    <axis-dimension>
    ...
    </axis-dimension>
    <axis-dimension>
    ...
    </axis-dimension>
</axis-dimensions>

<axis-dimension>
    <dimension-type>Row</dimension-type>
    <size>4</size>
</axis-dimension>

<axis-dimension>
    <dimension-type>Row</dimension-type>
    <size>4</size>
</axis-dimension>

<axis-dimension>
    <dimension-type>Row</dimension-type>
    <size>4</size>
    <resolution-type>
        Distance
    </resolution-type>
    <resolution>
        1.5
    </resolution>
    <resolution-units>Meter</resolution-units>
</axis-dimension>

<axis-dimension>
    <dimension-type>Row</dimension-type>
    <size>4</size>
    <resolution-type>Distance</resolution-type>
    <resolution>1.5</resolution>
    <resolution-units>Meter</resolution-units>
</axis-dimension>

<axis-dimension>
    <dimension-type>Row</dimension-type>
    <size>4</size>
    <resolution-type>Distance</resolution-type>
    <resolution>1.5</resolution>
    <resolution-units>Meter</resolution-units>
</axis-dimension>

<axis-dimension>
    <dimension-type>Row</dimension-type>
    <size>4</size>
    <description>Sample description.</description>
</axis-dimension>

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <vector-representations>
        <vector-representation>
            ...
        </vector-representation>
        <vector-representation>
            ...
        </vector-representation>
    </vector-representations>
    ...
</inport-metadata>

<vector-representations mode="replace">
    <vector-representation>
    ...
    </vector-representation>
    <vector-representation>
    ...
    </vector-representation>
</vector-representations>

<vector-representations>
    <vector-representation cc-id="12345">
        ...
    </vector-representation>
    <vector-representation>
        ...
    </vector-representation>
    <vector-representation>
        ...
    </vector-representation>
</vector-representations>

<vector-representation>
    <topology-level>Planar Graph</topology-level>
</vector-representation>

<vector-representation>
    <complex-object>
        ...
    </complex-object>
</vector-representation>

<vector-representation>
    <complex-object>
        <present>No</present>
    </complex-object>
</vector-representation>

<vector-representation>
    <complex-object>
        <present>Yes</present>
        <count>3</count>
    </complex-object>
</vector-representation>

<vector-representation>
    <composite-object>
        ...
    </composite-object>
</vector-representation>

<vector-representation>
    <composite-object>
        <present>No</present>
    </composite-object>
</vector-representation>

<vector-representation>
    <composite-object>
        <present>Yes</present>
        <count>3</count>
    </composite-object>
</vector-representation>

<vector-representation>
    <curve-object>
        ...
    </curve-object>
</vector-representation>

<vector-representation>
    <curve-object>
        <present>No</present>
    </curve-object>
</vector-representation>

<vector-representation>
    <curve-object>
        <present>Yes</present>
        <count>3</count>
    </curve-object>
</vector-representation>

<vector-representation>
    <point-object>
        ...
    </point-object>
</vector-representation>

<vector-representation>
    <point-object>
        <present>No</present>
    </point-object>
</vector-representation>

<vector-representation>
    <point-object>
        <present>Yes</present>
        <count>3</count>
    </point-object>
</vector-representation>

<vector-representation>
    <solid-object>
        ...
    </solid-object>
</vector-representation>

<vector-representation>
    <solid-object>
        <present>No</present>
    </solid-object>
</vector-representation>

<vector-representation>
    <solid-object>
        <present>Yes</present>
        <count>3</count>
    </solid-object>
</vector-representation>

<vector-representation>
    <surface-object>
        ...
    </surface-object>
</vector-representation>

<vector-representation>
    <surface-object>
        <present>No</present>
    </surface-object>
</vector-representation>

<vector-representation>
    <surface-object>
        <present>Yes</present>
        <count>3</count>
    </surface-object>
</vector-representation>

Subsection: reference-systems

InPort Label: Reference Systems
Optional.

Each Reference System should appear within its own <reference-system> node under the enclosing <reference-systems> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <reference-systems>
        <reference-system>
            ...
        </reference-system>
        <reference-system>
            ...
        </reference-system>
    </reference-systems>
    ...
</inport-metadata>

Attribute: mode

Optional; only applies to item updates. The value can be "replace" or "add". If no mode is specified, "replace" mode is used by default.

Replace mode (default) signifies that all existing Reference Systems should be deleted and completely replaced by the Reference Systems specified in the InPort XML file.

Add mode signifies that all existing Reference Systems should be kept, and any Reference Systems specified in the InPort XML file should be added as new Reference Systems.

Example:

<reference-systems mode="replace">
    <reference-system>
    ...
    </reference-system>
    <reference-system>
    ...
    </reference-system>
</reference-systems>

Back to Table of Contents

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Latitude and Longitude</horizontal-encoding-method>
        <latitude-resolution>0.001</latitude-resolution>
        <longitude-resolution>0.001</longitude-resolution>
        <horizontal-units>Degrees</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Latitude and Longitude</horizontal-encoding-method>
        <latitude-resolution>0.001</latitude-resolution>
        <longitude-resolution>0.001</longitude-resolution>
        <horizontal-units>Degrees</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Latitude and Longitude</horizontal-encoding-method>
        <latitude-resolution>0.001</latitude-resolution>
        <longitude-resolution>0.001</longitude-resolution>
        <horizontal-units>Degrees</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Latitude and Longitude</horizontal-encoding-method>
        <latitude-resolution>0.001</latitude-resolution>
        <longitude-resolution>0.001</longitude-resolution>
        <horizontal-units>Degrees</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Coordinate Pair</horizontal-encoding-method>
        <coordinate-x-resolution>0.001</coordinate-x-resolution>
        <coordinate-y-resolution>0.001</coordinate-y-resolution>
        <horizontal-units>Meters</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Coordinate Pair</horizontal-encoding-method>
        <coordinate-x-resolution>0.001</coordinate-x-resolution>
        <coordinate-y-resolution>0.001</coordinate-y-resolution>
        <horizontal-units>Meters</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Row and Column</horizontal-encoding-method>
        <row-resolution>0.001</row-resolution>
        <column-resolution>0.001</column-resolution>
        <horizontal-units>Meters</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Row and Column</horizontal-encoding-method>
        <row-resolution>0.001</row-resolution>
        <column-resolution>0.001</column-resolution>
        <horizontal-units>Meters</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Latitude and Longitude</horizontal-encoding-method>
        <latitude-resolution>0.001</latitude-resolution>
        <longitude-resolution>0.001</longitude-resolution>
        <horizontal-units>Degrees</horizontal-units>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Distance and Bearing</horizontal-encoding-method>
        <distance-resolution>0.001</distance-resolution>
        <distance-units>Meters</distance-units>
        <bearing-resolution>0.001</bearing-resolution>
        <bearing-units>Degrees</bearing-units>
        <reference-direction>North</reference-direction>
        <reference-meridian>Grid</reference-meridian>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Distance and Bearing</horizontal-encoding-method>
        <distance-resolution>0.001</distance-resolution>
        <distance-units>Meters</distance-units>
        <bearing-resolution>0.001</bearing-resolution>
        <bearing-units>Degrees</bearing-units>
        <reference-direction>North</reference-direction>
        <reference-meridian>Grid</reference-meridian>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Distance and Bearing</horizontal-encoding-method>
        <distance-resolution>0.001</distance-resolution>
        <distance-units>Meters</distance-units>
        <bearing-resolution>0.001</bearing-resolution>
        <bearing-units>Degrees</bearing-units>
        <reference-direction>North</reference-direction>
        <reference-meridian>Grid</reference-meridian>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Distance and Bearing</horizontal-encoding-method>
        <distance-resolution>0.001</distance-resolution>
        <distance-units>Meters</distance-units>
        <bearing-resolution>0.001</bearing-resolution>
        <bearing-units>Degrees</bearing-units>
        <reference-direction>North</reference-direction>
        <reference-meridian>Grid</reference-meridian>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Distance and Bearing</horizontal-encoding-method>
        <distance-resolution>0.001</distance-resolution>
        <distance-units>Meters</distance-units>
        <bearing-resolution>0.001</bearing-resolution>
        <bearing-units>Degrees</bearing-units>
        <reference-direction>North</reference-direction>
        <reference-meridian>Grid</reference-meridian>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <horizontal-resolution>
        <horizontal-encoding-method>Distance and Bearing</horizontal-encoding-method>
        <distance-resolution>0.001</distance-resolution>
        <distance-units>Meters</distance-units>
        <bearing-resolution>0.001</bearing-resolution>
        <bearing-units>Degrees</bearing-units>
        <reference-direction>North</reference-direction>
        <reference-meridian>Grid</reference-meridian>
    </horizontal-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <vertical-resolution>
        <vertical-encoding-method>Explicit Coordinate</vertical-encoding-method>
        <vertical-resolution>0.001</vertical-resolution>
        <vertical-units>Degrees</vertical-units>
    </vertical-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <vertical-resolution>
        <vertical-encoding-method>Explicit Coordinate</vertical-encoding-method>
        <vertical-resolution>0.001</vertical-resolution>
        <vertical-units>Degrees</vertical-units>
    </vertical-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <vertical-resolution>
        <vertical-encoding-method>Explicit Coordinate</vertical-encoding-method>
        <vertical-resolution>0.001</vertical-resolution>
        <vertical-units>Degrees</vertical-units>
    </vertical-resolution>
</reference-system>

<reference-system>
    <coordinate-reference-system>
        <epsg-code>2004</epsg-code>
    </coordinate-reference-system>
    <vertical-resolution>
        <vertical-encoding-method>Explicit Coordinate</vertical-encoding-method>
        <vertical-resolution>0.001</vertical-resolution>
        <vertical-units>Degrees</vertical-units>
    </vertical-resolution>
</reference-system>

Field: data-license-type

InPort Label: Data License Type
Optional.

Specifies the type of data license.

This section is only applicable to Data Sets. It will be ignored if it is included for a different Catalog Item type.

The value must be "Standard" or "Custom".

Use "Standard" if the standard NOAA Data License is being used. Note that in this situation, data-license, data-license-url, and data-license-statement should not be provided.

Use "Custom" to specify a different data license.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
</access-information>

Field: data-license

InPort Label: Data License
Optional.
Max Length: 100 characters.

Specifies the data license.

This section is only applicable to Data Sets. It will be ignored if it is included for a different Catalog Item type.

Example:

<access-information>
    <data-license-type>Custom</data-license-type>
    <data-license>CC-BY</data-license>
    <data-license-url>https://creativecommons.org/licenses/by/4.0/</data-license-url>
    <data-license-statement>Sample Data License statement</data-license-statement>
    <security-class>Unclassified</security-class>
</access-information>

Field: data-license-url

InPort Label: Data License URL
Optional.
Max Length: 4000 characters.

Specifies the URL for the data license.

This section is only applicable to Data Sets. It will be ignored if it is included for a different Catalog Item type.

The value must be a valid URL and must begin with http://, https://, or ftp://.

Example:

<access-information>
    <data-license-type>Custom</data-license-type>
    <data-license>CC-BY</data-license>
    <data-license-url>https://creativecommons.org/licenses/by/4.0/</data-license-url>
    <data-license-statement>Sample Data License statement</data-license-statement>
    <security-class>Unclassified</security-class>
</access-information>

Field: data-license-statement

InPort Label: Data License Statement
Optional.
Max Length: 4000 characters.

Specifies a statement for the data license.

This section is only applicable to Data Sets. It will be ignored if it is included for a different Catalog Item type.

Example:

<access-information>
    <data-license-type>Custom</data-license-type>
    <data-license>CC-BY</data-license>
    <data-license-url>https://creativecommons.org/licenses/by/4.0/</data-license-url>
    <data-license-statement>Sample Data License statement</data-license-statement>
    <security-class>Unclassified</security-class>
</access-information>

Field: security-class

InPort Label: Security Class
Required.

Specifies the security classification of the item.

Important: If this field is not present for this section, no other fields in the section will be processed.

The value must be one of the following:

• Top Secret
• Secret
• Confidential
• Restricted
• Sensitive
• Unclassified

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
</access-information>

Field: security-classification-system

InPort Label: Security Classification System
Optional.
Max Length: 4000 characters.

Specifies the security classification system used in reference to the security classification for the item.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
    <security-classification-system>Sample security classification</security-classification-system>
</access-information>

Field: security-handling-description

InPort Label: Security Handling Description
Optional.
Max Length: 4000 characters.

Specifies the security handling description for the item.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
    <security-handling-description>Sample security handling description.</security-handling-description>
</access-information>

Field: data-access-policy

InPort Label: Data Access Policy
Optional.
Max Length: 4000 characters.

Specifies the data access policy for the item.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
    <data-access-policy>Sample data access policy.</data-access-policy>
</access-information>

Field: data-access-procedure

InPort Label: Data Access Procedure
Optional.
Max Length: 4000 characters.

Specifies the data access procedure for the item.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
    <data-access-procedure>Sample data access procedure.</data-access-procedure>
</access-information>

Field: data-access-constraints

InPort Label: Data Access Constraints
Optional.
Max Length: 32767 characters.

Specifies the data access constraints for the item.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
    <data-access-constraints>Sample data access constraints.</data-access-constraints>
</access-information>

Field: data-use-constraints

InPort Label: Data Use Constraints
Optional.
Max Length: 32767 characters.

Specifies the data use constraints for the item.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
    <data-use-constraints>Sample data use constraints.</data-use-constraints>
</access-information>

Field: metadata-access-constraints

InPort Label: Metadata Access Constraints
Optional.
Max Length: 32767 characters.

Specifies the metadata access constraints for the item.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
    <metadata-access-constraints>Sample metadata access constraints.</metadata-access-constraints>
</access-information>

Field: metadata-use-constraints

InPort Label: Metadata Use Constraints
Optional.
Max Length: 32767 characters.

Specifies the metadata use constraints for the item.

Example:

<access-information>
    <data-license-type>Standard</data-license-type>
    <security-class>Unclassified</security-class>
    <metadata-use-constraints>Sample metadata use constraints.</metadata-use-constraints>
</access-information>

Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing Distribution to be referred to by its CC ID, so that its fields can be updated. The attribute can be used in combination with "add" or "replace" mode. (See notes on the mode attribute for distribution-information).

Note: The cc-id attribute value is only a reference. CC IDs are assigned automatically when records are created, and cannot be modified through the InPort XML Loader.

In most cases, it is easier and simpler to use replace mode, even though the same record may end up being deleted and then re-added. Nevertheless, the cc-id option is provided for greater flexibility in a range of upload scenarios.

Finding the CC ID:
To learn the CC ID of an existing Distribution, view the Catalog Item to which it belongs in InPort. The CC ID is displayed on the far right side of the header for each Distribution.

Example:

<distribution-information>
    <distribution cc-id="12345">
        ...
    </distribution>
    <distribution>
        ...
    </distribution>
    <distribution>
        ...
    </distribution>
</distribution-information>

The example snippet would remove all existing Distributions, except for the Distribution with CC ID 12345, which would be updated. In addition, two new Distributions would be added as specified.

Field: start-date

InPort Label: Start Date
Optional, but required if end-date is provided.

Specifies the start date of the Distribution.

The value must be a date specified in ISO 8601 extended format (YYYY-MM-DD, YYYY-MM, YYYY). The date should use the appropriate granularity (Year, Month or Day). For example, if the date is significant only up to the month, use the YYYY-MM format.

Example:

<distribution>
    <start-date>2015-01</start-date>
    <download-url>
        https://my.url/
    </download-url>
</distribution>

Field: end-date

InPort Label: End Date
Optional.

Specifies the end date of the Distribution.

Note that the absence of an End Date, when Start Date exists, effectively indicates a Distribution which is effective up to the present.

The value must be a date specified in ISO 8601 extended format (YYYY-MM-DD, YYYY-MM, YYYY). The date should use the appropriate granularity (Year, Month or Day). For example, if the date is significant only up to the month, use the YYYY-MM format.

Note: The end-date value must be later than the start-date value.

Example:

<distribution>
    <start-date>2015-01-01</start-date>
    <end-date>2015-12-31</end-date>
</distribution>

Field: download-url

InPort Label: Download URL
Optional.
Max Length: 4000 characters.

Specifies a download URL for the Distribution.

The value must be a valid URL and must begin with http://, https://, or ftp://.

Example:

<distribution>
    <download-url>
        https://my.url/
    </download-url>
</distribution>

Field: distributor

InPort Label: Distributor
Optional.

Specifies the Distributor for the corresponding Distribution.

The distributor supplied is only a reference to a Distributor for the Catalog Item. Distributors should be created as Support Roles, with a type of Distributor; they are not created within the Distribution Information section. To associate a Distributor to a Distribution, the Distributor must already exist in InPort, or be added in the same InPort XML file.

The Distributor is referenced by providing:

• from-date: The Distributor From Date (if any)
• to-date: The Distributor To Date (if any)
• contact-type: The Contact Type of the Distributor
• contact-email: The Distributor's Email Address (must exist as a Contact in InPort)
• contact-name: The Distributor's Name (use only if email address is unavailable)

The values for these fields must match EXACTLY to the values for the Distributor being referred to; otherwise they will not be considered a valid reference, and an association will not be created. In addition, each field should only provided if the Distributor being referenced has a value for them; otherwise the field should be omitted.

Note: The Contact Instructions field does not need to match, and should never be included in the Distributor reference.

Example:

<support-roles>
    <support-role>
        <support-role-type>Distributor</support-role-type>
        <from-date>2015-01-01</from-date>
        <contact-type>Organization</contact-type>
        <contact-name>Pacific Islands Fisheries Science Center</contact-name>
    </support-role>
</support-roles>
...
<distribution-information>
    <distribution>
        <download-url>
            https://my.url/
        </download-url>
        <distributor>
            <from-date>2005-01-01</from-date>
            <contact-type>Organization</contact-type>
            <contact-name>Pacific Islands Fisheries Science Center</contact-name>
        </distributor>
    </distribution>
</distribution-information>

Removing a Reference to a Distributor

When updating an existing record, a reference from a Distribution to a Distributor can be deleted by providing an empty distributor node:

Example:

<distribution>
    <download-url>
        https://my.url/
    </download-url>
    <distributor></distributor>
</distribution>

Note that the example above will delete the association of the distribution to the distributor, but it will NOT delete the distributor. Removal of distributors should be handled within the Support Roles section.

Field: file-name

InPort Label: File Name
Optional.
Max Length: 100 characters.

Specifies the file name of the Distribution.

Example:

<distribution>
    <file-name>data.xls</file-name>
</distribution>

Field: description

InPort Label: Description
Optional.
Max Length: 4000 characters.

Specifies a description of the Distribution.

Example:

<distribution>
    <description>Sample description.</description>
</distribution>

Field: file-date-time

InPort Label: File Date/Time
Optional.

Specifies the file date/timestamp of the Distribution.

The value must be a date or date/time specified in ISO 8601 extended format (YYYY-MM-DDThh:mm:ss). The date/time should use the appropriate granularity (Year, Month, Day, Hour, Minute or Second). For example, if the date is significant only up to the minute, use the YYYY-MM-DDThh:mm format.

All date/times are interpreted as UTC.

Example:

<distribution>
    <file-date-time>2015-01-13</file-date-time>
</distribution>

Field: file-type

InPort Label: File Type
Optional.
Max Length: 200 characters.

Specifies the file type of the Distribution.

Note: This field is deprecated.

Use <distribution-format> instead.

Example:

<distribution>
    <file-type>Microsoft Excel</file-type>
</distribution>

Field: distribution-format

InPort Label: Distribution Format
Optional.

Specifies the format of the Distribution.

The value must be one of the following:

• Not Applicable
• ACCDB - Microsoft Access Database
• ALL - Kongsberg ALL Format
• AVI - Audio Video Interleave
• BSB - BSB Nautical Chart Format
• CSV - Comma Separated Values (Text)
• Darwin Core Archive
• DOC - Microsoft Word
• E00 - ESRI ArcInfo Interchange
• EPS - Encapsulated PostScript
• ERDDAP Data Service
• ESRI ARC/INFO GRID
• ESRI File Geodatabase
• ESRI Personal Geodatabase
• ESRI REST Service
• FLT - ESRI GridFloat
• GeoTIFF
• GSF - Generic Sensor Format
• IMG - ERDAS Imagine
• JPEG
• KML/KMZ - Keyhole Markup Language
• LAS/LAZ - LASer
• MDB - Microsoft Access Database
• MP4
• NC - NetCDF
• OData - Open Data Protocol
• ORDS - Oracle REST Data Services
• PDF - Adobe Portable Document Format
• PIX - PCI Geomatics PCIDSK Format
• PNG - Portable Network Graphics Format
• PPT - Microsoft PowerPoint Format
• RAW - Kongsberg Simrad RAW Format
• RINEX - Receiver INdependent EXchange Format
• Shapefile
• SID-MrSID/Multiresolution Seamless Image DB
• Text (Structured)
• Text (Tab Delimited)
• Text (Unstructured)
• TIFF
• TMS - Tile Map Service
• Web Service (Other)
• WMS - Web Map Service
• XLS - Microsoft Excel
• XML (Structured Text)
• XYZ - ASCII Gridded Data

Example:

<distribution>
    <distribution-format>GeoTIFF</distributionFormat>
</distribution>

Field: file-size

InPort Label: File Size
Optional.
Max Length: 30 characters.

Specifies the file size of the Distribution.

Example:

<distribution>
    <file-size>58K</file-size>
</distribution>

Field: application-version

InPort Label: Application Version
Optional.
Max Length: 100 characters.

Specifies the application version of the Distribution.

Example:

<distribution>
    <application-version>Microsoft Excel 1.0</application-version>
</distribution>

Field: compression

InPort Label: Compression
Optional.

Specifies the compression of the Distribution.

The value must be one of the following:

• Uncompressed
• GTAR
• GZ / GZIP
• LAZ
• RAR
• TAR
• Unknown
• Z
• Zip

Example:

<distribution>
    <compression>Zip</compression>
</distribution>

Field: review-status

InPort Label: Review Status
Optional.

Specifies the review status of the Distribution.

The value must be one of the following:

• Not Chked
• Chked MD
• Chked Viruses
• Chked Inapp Content
• Chked Viruses Inapp Content

Example:

<distribution>
    <review-status>Chked Viruses Inapp Content</review-status>
</distribution>

Attribute: cc-id

This attribute is NOT allowed for Archives.

Field: location-name

InPort Label: Location Name
Either location-name, location-email or location-noaa-acronym is required for each archive.

Specifies the organization where the archive is located.

Only Contacts of type Organization are allowed.

It is recommended to ensure that Contacts referenced in InPort XML files already exist in InPort before loading. Please consult the list of Contacts in InPort to view the currently available Contacts names and their email addresses.

However, for Contacts with NOAA email addresses (ending in "noaa.gov"), the loader will attempt to add the Contact to InPort if it does not already exist for that Contact Type. In this situation, the Contact name <*-name> must also be provided.

Contacts with non-NOAA email address cannot be automatically inserted into InPort via the InPort XML Loader.

Note that the Contact's email address is only used for matching purposes — it is not possible to update a Contact's email address (or any other contact information) via the InPort XML Loader. Contact information can only be edited by Librarians within InPort.

Contacts can be matched by email address (<*-email>) or by name (<*-name>). However, due to the inherent ambiguity of names and potential for duplicates, it is preferable to identify Contacts by email address, rather than by name, whenever possible.

Example:

<archive>
    <location-name>National Centers for Environmental Information</location-name>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
</archive>

Field: location-email

InPort Label: Location Email
location-name, location-email or location-noaa-acronym is required for each archive.

Specifies the email address of the organization where the archive is located.

Only Contacts of type Organization are allowed.

It is recommended to ensure that Contacts referenced in InPort XML files already exist in InPort before loading. Please consult the list of Contacts in InPort to view the currently available Contacts names and their email addresses.

However, for Contacts with NOAA email addresses (ending in "noaa.gov"), the loader will attempt to add the Contact to InPort if it does not already exist for that Contact Type. In this situation, the Contact name <*-name> must also be provided.

Contacts with non-NOAA email address cannot be automatically inserted into InPort via the InPort XML Loader.

Note that the Contact's email address is only used for matching purposes — it is not possible to update a Contact's email address (or any other contact information) via the InPort XML Loader. Contact information can only be edited by Librarians within InPort.

Contacts can be matched by email address (<*-email>) or by name (<*-name>). However, due to the inherent ambiguity of names and potential for duplicates, it is preferable to identify Contacts by email address, rather than by name, whenever possible.

Example:

<archive>
    <location-email>ncei.info@noaa.gov</location-email>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
</archive>

Field: location-noaa-acronym

InPort Label: Location NOAA Acronym
Only applies to NOAA organizations.

Specifies the NOAA Acronym of the organization where the archive is located.

Only Contacts of type Organization are allowed.

Example:

<archive>
    <location-noaa-acronym>NCEI</location-noaa-acronym>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
</archive>

Field: file-identifier

InPort Label: File Identifier
Required.
Max Length: 50 characters.

Specifies the file identifier for the archive.

Example:

<archive>
    <location-name>National Centers for Environmental Information</location-name>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
</archive>

Field: file-name

InPort Label: File Name
Required.
Max Length: 50 characters.

Specifies the human-readable name of the archive.

Example:

<archive>
    <location-name>National Centers for Environmental Information</location-name>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
</archive>

Field: url

InPort Label: URL
Optional.
Max Length: 4000 characters.

Specifies the URL for the archive.

The value must be a valid URL and must begin with http://, https://, or ftp://.

Example:

<archive>
    <location-name>National Centers for Environmental Information</location-name>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
    <url>
        https://my.url/
    </url>
</archive>

Field: description

InPort Label: Description
Optional.
Max Length: 4000 characters.

Specifies a description of the archive.

Example:

<archive>
    <location-name>National Centers for Environmental Information</location-name>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
    <description>Sample description.</description>
</archive>

Field: doi

InPort Label: DOI
Optional.
Max Length: 250 characters.

Specifies the DOI for the Catalog Item.

Example:

<archive>
    <location-name>National Centers for Environmental Information</location-name>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
    <doi>doi:12.3456/sample.123456</doi>
</archive>

Field: archive-date

InPort Label: Archive Date
Optional.

Specifies the date the accession number was granted.

The value must be a date consisting of year, month, and day, specified in ISO 8601 extended format (YYYY-MM-DD).

Example:

<archive>
    <location-name>National Centers for Environmental Information</location-name>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
    <archive-date>2001-02-03</archive-date>
</archive>

Field: archive-update-frequency

InPort Label: Archive Update Frequency
Optional.

Specifies the update frequency of the archive.

Example:

<archive>
    <location-name>National Centers for Environmental Information</location-name>
    <file-identifier>ID9999</file-identifier>
    <file-name>example-filename.zip</file-name>
    <archive-update-frequency>Annually</archive-update-frequency>
</archive>