Purpose

The InPort XML Loader supports the full upload and update of any catalog item. This feature is primarily intended for end users who are already managing their own metadata in a different system, and have the technical means to produce a custom XML export.


Using the InPort XML Loader

To create a new catalog item from an InPort XML file, navigate to the catalog item that will be the parent of this new catalog item. Under the Item Actions menu, click on the link, "Upload InPort XML."

To update an existing catalog item from an InPort XML file, navigate to the catalog item you wish to update. Under the Item Actions menu, click on the link, "Update from InPort XML."

Note: You must have at least an Author role or higher, and be logged into InPort.


Batch InPort XML Loader

Multiple InPort XML files can be batch loaded together in one zip file. All normal restrictions apply -- you must have the appropriate role to modify the affected catalog items, and the catalog items must be in an editable workflow state (e.g. Draft for Authors and Publishers, Review/Revise for Publishers).

A link to the Batch InPort XML Loader is available in the right sidebar of the My InPort page. To batch load a set of InPort XML files, zip all desired files into a single .zip file and upload them. The zip file will be queued up and loaded into InPort, and a validation report with the results will be provided. To check on the status of your loaded file, visit the My InPort page.


Migrating from FGDC

If you have FGDC files that you would like to load into InPort, they can be transformed first into InPort XML, and then loaded into the XML Loader.

Please see the XSLT Transforms section on the Tools page for more information.


The InPort XML Format: Version 1.31

The format of InPort XML was designed to be simple and straightforward, conforming as much as possible to the same naming and ordering of sections and fields as they appear in InPort.

A single InPort XML file corresponds to a single catalog item. A batch load capability is also supported, which requires a zipped file of the XML files to upload - one XML file per catalog item.

An XML file containing all the currently supported fields, as well as brief instructions on each field, is available for download here. However, users should also consult the full documentation below for additional details, especially those who plan to update their metadata records with InPort XML imports on an ongoing basis.


Table of Contents


General Guidelines

Important: Files should be encoded in UTF-8. Other encodings work, but may produce unexpected character encoding issues on ingest.

The InPort XML format was designed for efficient item creation as well as item updating. Nearly all fields are optional (exceptions outlined below); generally if a field is omitted in the XML file, whatever existing value in InPort is preserved. In addition, field values can be explicitly deleted (nulled out) with an empty node.

For example, consider the following example snippet:

...
<data-set-information>
    <data-presentation-form>Document (digital)</data-presentation-form>
    <instrument></instrument>
</data-set-information>
...

This snippet would:

  • Set the value of the Data Presentation Form field to "Document (digital)".
  • Null out the existing value of the Instrument field.
  • Other Data Set Information fields such as Platform would be untouched since they are not included in the XML — they would retain whatever value they previously had.

Back to Table of Contents


inport-metadata

After the standard XML preamble, the body of the XML document must be enclosed with an <inport-metadata> node.

A version attribute should be included, with a value of "1.0".

Example:

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

Back to Table of Contents


Section: loader-options

Optional.

This is a special configuration section preceding other metadata sections, which allows the loader to specify configuration options for the load.

Example:

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

Back to Table of Contents


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 performed by the loader.

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>

Configuration Parameter: visibility

Optional.

Specifies whether an item should be published externally (public to all) or internally (visible only to logged-in users).

The value must be "External" or "Internal".

Note: If this field is not specified, the default value of "External" will be supplied.

Example:

<?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>

Configuration Parameter: approved-by

Optional.

Specifies another InPort user (via email address) as the person approving the item for publish.

This parameter is useful for loaders who have been authorized to publish catalog items, but are not the party who should be listed as approving the items.

The approver specified will be listed in the Catalog Item's workflow status history as the person responsible for the transition to the Approved state.

The email address must correspond to an existing user in InPort who has a Publisher or higher role for the Catalog Item.

Example:

<?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>

Section: item-identification

InPort Label: Item Identification
Required.

Example:

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

Back to Table of Contents


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 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.

Specifies the catalog item type of the record.

The value must be one of the following:

  • Data Set
  • Project
  • Entity
  • Document
  • Procedure

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. However, this field is still required on item updates as an additional safeguard to ensure the expected item is being updated.

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 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:

  • In Work
  • Planned
  • Complete

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: 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>

Section: keywords

InPort Label: Keywords
Optional.

Each Keyword should appear within its own <keyword> node under the enclosing <keywords> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <keywords>
        <keyword>
            ...
        </keyword>
        <keyword>
            ...
        </keyword>
    </keywords>
    ...
</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 Keywords should be deleted and completely replaced by the Keywords specified in the InPort XML file.

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

Example:

<keywords mode="replace">
    <keyword>
    ...
    </keyword>
    <keyword>
    ...
    </keyword>
</keywords>

Back to Table of Contents


Attribute: cc-id

This attribute is NOT allowed for 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

Example:

<keywords mode="replace">
    <keyword>
        <keyword-type>Theme</keyword-type>
        <thesaurus>My Keyword Thesaurus</thesaurus>
        <keyword>My Keyword</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.

Example:

<keywords mode="replace">
    <keyword>
        <keyword-type>Theme</keyword-type>
        <thesaurus>My Keyword Thesaurus</thesaurus>
        <keyword>My Keyword</keyword>
    </keyword>
</keywords>

Field: keyword

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

Specifies the keyword value.

Example:

<keywords mode="replace">
    <keyword>
        <keyword-type>Theme</keyword-type>
        <thesaurus>My Keyword Thesaurus</thesaurus>
        <keyword>My Keyword</keyword>
    </keyword>
</keywords>

Section: physical-location

InPort Label: Physical Location
Optional.

Section: physical-location

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <physical-location>
        ...
    </physical-location>
    ...
</inport-metadata>

Back to Table of Contents


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>

Section: data-set-information

InPort Label: Data Set Information
Optional.

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

Example:

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

Back to Table of Contents


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.

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:

<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.

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:

<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.

The value must be one of the following:

  • Published
  • Unpublished
  • Unknown

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.

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.

This field should only be provided if the Data Set Publication Status is "Published."

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: source-media-type

InPort Label: Source Media Type
Optional.

Specifies the source media type of the Data Set.

The value must be one of the following:

  • Audiocassette
  • CD-ROM
  • Cartridge Tape
  • Chart
  • Computer Program
  • Disc
  • Electronic Bulletin Board
  • Electronic Mail System
  • Electronically Logged
  • Filmstrip
  • Magnetic Tape
  • Microfiche
  • Microfilm
  • Online
  • Paper
  • Physical Model
  • Transparency
  • Videocassette
  • Videodisc
  • Videotape

Example:

<data-set-information>
    <data-set-scope-code>Data Set</data-set-scope-code>
    <source-media-type>CD-ROM</source-media-type>
</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>http://eadu.sample.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>

Section: document-information

InPort Label: Document Information
Optional.

This section is only applicable to Documents. It will be ignored if it is included for a catalog item of a different type.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <document-information>
        ...
    </document-information>
    ...
</inport-metadata>

Back to Table of Contents


Field: publication-date

InPort Label: Publication Date
Optional.

Specifies the publication date of the Document.

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:

<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>

Section: entity-information

InPort Label: Entity Information
Optional.

This section is only applicable to Entities. It will be ignored if it is included for a catalog item of a different type.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <entity-information>
        ...
    </entity-information>
    ...
</inport-metadata>

Back to Table of Contents


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>

Section: data-attributes

InPort Label: Data Attributes
Optional.

This section is only applicable to Entities. It will be ignored if it is included for a catalog item of a different type.

Each Data Attribute should appear within its own <data-attribute> node under the enclosing <data-attributes> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <data-attributes>
        <data-attribute>
            ...
        </data-attribute>
        <data-attribute>
            ...
        </data-attribute>
    </data-attributes>
    ...
</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 Data Attributes should be deleted and completely replaced by the Data Attributes specified in the InPort XML file.

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

Example:

<data-attributes mode="replace">
    <data-attribute>
    ...
    </data-attribute>
    <data-attribute>
    ...
    </data-attribute>
</data-attributes>

Back to Table of Contents


Attribute: cc-id

This attribute is NOT allowed for Data Attributes.


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

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: 20 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>

Section: procedure-information

InPort Label: Procedure Informatiion
Optional.

This section is only applicable to Procedures. It will be ignored if it is included for a catalog item of a different type.

Example:

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

Back to Table of Contents


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


Attribute: cc-id

This attribute is NOT allowed for Procedure Steps.


Field: sequence-number

InPort Label: Sequence Number
Required.

Specifies the sequence number for the Procedure Step.

The value must be a positive integer.

Example:

<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>

Field: label

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

Specifies a label for the Procedure Step.

Example:

<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>

Field: step-name

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

Specifies a step name for the Procedure Step.

Example:

<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>

Field: details

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

Specifies details for the Procedure Step.

Example:

<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>

Field: purpose

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

Specifies the purpose for the procedure step.

Example:

<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>

Field: start-date

InPort Label: Start Date
Optional.

Specifies the start date of the Procedure Step.

The value must be a date/time specified in ISO 8601 extended format (YYYY-MM-DDThh:mm:ss).

All date/times are interpreted as UTC.

Example:

<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>

Field: end-date

InPort Label: End Date
Optional.

Specifies the end date of the Procedure Step.

The value must be a date/time specified in ISO 8601 extended format (YYYY-MM-DDThh:mm:ss).

All date/times are interpreted as UTC.

Example:

<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>

Section: project-information

InPort Label: Project Information
Optional.

This section is only applicable to Projects. It will be ignored if it is included for a catalog item of a different type.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <project-information>
        ...
    </project-information>
    ...
</inport-metadata>

Back to Table of Contents


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>

Section: support-roles

InPort Label: Support Roles
Optional.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <support-roles>
        <support-role>
        ...
        </support-role>
        <support-role>
        ...
        </support-role>
    </support-roles>
    ...
</inport-metadata>

Each Support Role should appear within its own <support-role> node under the enclosing <support-roles> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <support-roles>
        <support-role>
            ...
        </support-role>
        <support-role>
            ...
        </support-role>
    </support-roles>
    ...
</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 Support Roles should be deleted and completely replaced by the Support Roles specified in the InPort XML file.

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

Example:

<support-roles mode="replace">
    <support-role>
    ...
    </support-role>
    <support-role>
    ...
    </support-role>
</support-roles>

Back to Table of Contents


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>
        <person-email>john.doe@noaa.gov</person-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>
        <person-email>john.doe@noaa.gov</person-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>
        <person-email>john.doe@noaa.gov</person-email>
    </support-role>
</support-roles>

Field: person-email

InPort Label: Person
Either person-email or organization (or both) is required for each support role.

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

The email address is used to identify the corresponding person in InPort; as such, the email address must be of an existing 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
Either person-email or organization (or both) is required for each support role.

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

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: contact-instructions

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

Specifies contact instructions for the person or organization 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>
        <person-email>john.doe@noaa.gov</person-email>
        <contact-instructions>Contact by email preferred. Phone hours 9am-5pm.</contact-instructions>
    </support-role>
</support-roles>

Section: extents

InPort Label: Extents
Optional.

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

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <extents>
        <extent>
            ...
        </extent>
        <extent>
            ...
        </extent>
    </extents>
    ...
</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 Extent Groups should be deleted and completely replaced by the Extent Groups specified in the InPort XML file.

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

Example:

<extents mode="replace">
    <extent>
    ...
    </extent>
    <extent>
    ...
    </extent>
</extents>

Back to Table of Contents


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


Field: time-frame-type

InPort Label: Time Frame Type
Required.

Specifies the type of the Time Frame.

The value must be one of the following:

  • Continuing
  • Discrete
  • Range

Example:

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

Field: start-date-time

InPort Label: Start Date/Time
Required.

Specifies the start date/time of the Time Frame.

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

A time zone component is optional. If no time zone is provided, UTC is assumed.

Example:

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

Field: end-date-time

InPort Label: End Date/Time
Required for Time Frames of type Range.

Specifies the end date/time of the Time Frame.

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

A time zone component is optional. If no time zone is provided, UTC is assumed.

Note: The End Date/Time must be later than the Start Date/Time.

Example:

<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>

Field: description

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

Specifies a description for the Time Frame.

Example:

<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>

Field: alternate-start-as-of-info

InPort Label: Alternate Start as of Info
Optional.
Max Length: 200 characters.

Specifies the activity that signaled the start of the Time Frame (e.g. trip number).

Example:

<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>

Field: alternate-end-as-of-info

InPort Label: Alternate End as of Info
Optional.
Max Length: 200 characters.

Specifies the activity that signaled the end of the Time Frame.

Example:

<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


Field: west-bound

InPort Label: West Bound
Optional, but required if any other bound is provided.

Specifies the west bound (longitude degrees) of the geographic area bounding box.

The value must be numeric, between -180 and 180.
Up to 11 digits of precision are supported after the decimal point.

Example:

<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>

Field: east-bound

InPort Label: East Bound
Optional, but required if any other bound is provided.

Specifies the east bound (longitude degrees) of the geographic area bounding box.

The value must be numeric, between -180 and 180.
Up to 11 digits of precision are supported after the decimal point.

Example:

<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>

Field: north-bound

InPort Label: North Bound
Optional, but required if any other bound is provided.

Specifies the north bound (latitude degrees) of the geographic area bounding box.

The value must be numeric, between -90 and 90.
Up to 11 digits of precision are supported after the decimal point.

Example:

<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>

Field: south-bound

InPort Label: South Bound
Optional, but required if any other bound is provided.

Specifies the south bound (latitude degrees) of the geographic area bounding box.

The value must be numeric, between -90 and 90.
Up to 11 digits of precision are supported after the decimal point.

Example:

<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>

Field: description

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

Specifies a description for the Geographic Area.

Field: description

Corresponds to the Description field for geographic areas in InPort.

Optional.

This field specifies a description for the geographic area.

Example:

<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


Field: min

InPort Label: Minimum Vertical Extent
Required.

Specifies the minimum value of the Vertical Extent.

The value must be numeric.
Up to 11 digits of precision are supported after the decimal point.

Example:

<vertical-extents>
    <vertical-extent>
        <min>-50</min>
        <max>-30</max>
        <coordinate-reference-system-url>http://crs.sample.url/</coordinate-reference-system-url>
    </vertical-extent>
</vertical-extents>

Field: max

InPort Label: Maximum Vertical Extent
Required.

Specifies the Maximum value of the Vertical Extent.

The value must be numeric.
Up to 11 digits of precision are supported after the decimal point.

Example:

<vertical-extents>
    <vertical-extent>
        <min>-50</min>
        <max>-30</max>
        <coordinate-reference-system-url>http://crs.sample.url/</coordinate-reference-system-url>
    </vertical-extent>
</vertical-extents>

Field: coordinate-reference-system-url

InPort Label: Coordinate Reference System URL
Required.
Max Length: 4000 characters.

Specifies a coordinate reference system URL for the Vertical Extent.

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

Example:

<vertical-extents>
    <vertical-extent>
        <min>-50</min>
        <max>-30</max>
        <coordinate-reference-system-url>http://crs.sample.url/</coordinate-reference-system-url>
    </vertical-extent>
</vertical-extents>

Section: spatial-information

InPort Label: Spatial Information
Optional.

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

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    <spatial-information>
        ...
    </spatial-information>
</inport-metadata>

Back to Table of Contents


Subsection: spatial-resolution

InPort Label: Spatial Resolution
Optional.

Example:

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

Back to Table of Contents


Field: angular-distance

InPort Label: Angular Distance
Optional.

Specifies the numeric value of the angular distance pertaining to the Spatial Resolution of the Data Set.

The value must be numeric.

Example:

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

Field: angular-distance-units

InPort Label: Angular Distance Units
This field should be provided if and only if a value is supplied for Angular Distance.

Specifies the unit of measure, of the angular distance pertaining to the Spatial Resolution of the Data Set.

The value must be one of the following:

  • Turn
  • Quadrant
  • Radian
  • Binary Degree
  • Degree
  • Grad
  • Minute of Arc
  • Second of Arc

Example:

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

Field: horizontal-distance

InPort Label: Horizontal Distance
Optional.

Specifies the numeric value of the horizontal distance pertaining to the Spatial Resolution of the Data Set.

The value must be numeric.

Example:

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

Field: horizontal-distance-units

InPort Label: Horizontal Distance Units
This field should be provided if and only if a value is supplied for Horizontal Distance.

Specifies the unit of measure, of the horizontal distance pertaining to the Spatial Resolution of the Data Set.

The value must be one of the following:

  • Centimeter
  • Meter
  • Kilometer
  • Inch
  • Foot
  • Yard
  • Mile
  • Nautical Mile

Example:

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

Field: vertical-distance

InPort Label: Vertical Distance
Optional.

Specifies the numeric value of the vertical distance pertaining to the Spatial Resolution of the Data Set.

The value must be numeric.

Example:

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

Field: vertical-distance-units

InPort Label: Vertical Distance Units
This field should be provided if and only if a value is supplied for Vertical Distance.

Specifies the unit of measure, of the vertical distance pertaining to the Spatial Resolution of the Data Set.

The value must be one of the following:

  • Centimeter
  • Meter
  • Kilometer
  • Inch
  • Foot
  • Yard
  • Mile
  • Nautical Mile

Example:

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

Field: equivalent-scale-denominator

InPort Label: Equivalent Scale Denominator
Optional.

Specifies the equivalent scale denominator pertaining to the Spatial Resolution of the Data Set.

The value must be a positive integer.

Example:

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

Field: level-of-detail-description

InPort Label: Level of Detail Description
Optional.
Max Length: 4000 characters.

Specifies a description of the level of detail pertaining to the Spatial Resolution of the Data Set.

Field: level-of-detail-description

Example:

<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


Subsection: representations-used

InPort Label: Representations Used
Optional.

If this subsection is provided, at least one of its child fields must exist.

Example:

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

Back to Table of Contents


Field: grid

InPort Label: Grid Representations Used
Optional.

Specifies whether or not Grid Spatial Representations are used.

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

Example:

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

Field: vector

InPort Label: Vector Representations Used
Optional.

Specifies whether or not Vector Spatial Representations are used.

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

Example:

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

Field: text-table

InPort Label: Text / Table Representations Used
Optional.

Specifies whether or not Text or Table Spatial Representations are used.

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

Example:

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

Field: tin

InPort Label: TIN Representations Used
Optional.

Specifies whether or not TIN Spatial Representations are used.

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

Example:

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

Field: stereo-model

InPort Label: Stereo Model Representations Used
Optional.

Specifies whether or not Stereo Model Spatial Representations are used.

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

Example:

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

Field: video

InPort Label: Video Representations Used
Optional.

Specifies whether or not Video Spatial Representations are used.

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

Example:

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

Subsection: grid-representations

InPort Label: Grid Representations
Optional.

Each Grid Representation should appear within its own <grid-representation> node under the enclosing <grid-representations> node.

Example:

<?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>

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 Grid Representations should be deleted and completely replaced by the Grid Representations specified in the InPort XML file.

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

Example:

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

Back to Table of Contents


Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing Grid Representation 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 grid-representations).

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 Grid Representation, 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 Grid Representation.

Example:

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

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


Field: dimension-count

InPort Label: Dimension Count
Required.

Specifies the number of dimensions for a grid representation.

The value must be a non-negative integer.

Example:

<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>

Field: cell-geometry

InPort Label: Cell Geometry
Required.

Specifies the cell geometry of the grid representation.

The value must be one of the following:

  • Point
  • Area
  • Voxel
  • Stratum

Example:

<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>

Field: transformation-parameters-available

InPort Label: Transformation Parameters Available
Required.

Specifies whether transformation parameters are available for the grid representation.

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

Example:

<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>

Subsection: axis-dimensions

InPort Label: Axis Dimensions
Required.

At least 1 Axis Dimension is required for each Grid Representation.

Each Axis Dimension should appear within its own <axis-dimension> node under the enclosing <axis-dimensions> node.

Example:

<?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>

Attribute: mode

Optional; only applies to item updates. Only "replace" mode is supported for Axis Dimensions. If no mode is specified, "replace" mode is used by default.

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

Example:

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

Back to Table of Contents


Attribute: cc-id

This attribute is NOT allowed for Axis Dimensions.


Field: dimension-type

InPort Label: Dimension Type
Required.

Specifies the type of the axis dimension.

The value must be one of the following:

  • Row
  • Column
  • Vertical
  • Track
  • Cross Track
  • Line
  • Sample
  • Time

Example:

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

Field: size

InPort Label: Size
Required.

Specifies the size of the axis dimension.

The value must be a non-negative integer.

Example:

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

Field: resolution-type

InPort Label: Resolution Type
Optional, but should only be provided if Resolution and Resolution Units are also provided.

Specifies the resolution type of the axis dimension.

The value must be one of the following:

  • Length
  • Distance
  • Angle
  • Scale
  • Measure

Example:

<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>

Field: resolution

InPort Label: Resolution
Optional, but requires Resolution Type and Resolution Units if provided.

Specifies the numeric value of the resolution pertaining to the axis dimension.

The value must be numeric.

Example:

<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>

Field: resolution-units

InPort Label: Resolution Units
Optional, but should only be provided if Resolution and Resolution Units are also provided.

Specifies the unit of measure, of the resolution pertaining to the axis dimension.

If the Resolution Type is Length or Distance...

The value must be one of the following:

  • Centimeter
  • Meter
  • Kilometer
  • Inch
  • Foot
  • Yard
  • Mile
  • Nautical Mile

If the Resolution Type is Angle...

The value must be one of the following:

  • Turn
  • Quadrant
  • Radian
  • Binary Degree
  • Degree
  • Grad
  • Minute of Arc
  • Second of Arc

If the Resolution Type is Scale or Measure...

The value must be one of the following:

  • Turn
  • Quadrant
  • Radian
  • Binary Degree
  • Degree
  • Grad
  • Minute of Arc
  • Second of Arc
  • Centimeter
  • Meter
  • Kilometer
  • Inch
  • Foot
  • Yard
  • Mile
  • Nautical Mile

Example:

<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>

Field: description

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

Specifies the description for the axis dimension.

Example:

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

Subsection: vector-representations

InPort Label: Vector Representations
Optional.

Each Vector Representation should appear within its own <vector-representation> node under the enclosing <vector-representations> node.

Example:

<?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>

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 Vector Representations should be deleted and completely replaced by the Vector Representations specified in the InPort XML file.

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

Example:

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

Back to Table of Contents


Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing Vector Representation 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 vector-representations).

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 Vector Representation, 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 Vector Representation.

Example:

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

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


Field: topology-level

InPort Label: Topology Level
Optional.

Specifies the topology level for a Vector Representation.

The value must be one of the following:

  • Geometry Only
  • Topology 1D
  • Planar Graph
  • Full Planar Graph
  • Surface Graph
  • Full Surface Graph
  • Topology 3D
  • Full Topology 3D
  • Abstract

Example:

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

Subsection: complex-object

InPort Label: Complex Object
Optional.

Specifies information pertaining to the use of Complex Objects for a Vector Representation.

Example:

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

Field: present

InPort Label: Present
Optional.

Specifies whether or not Complex Objects are present in the Vector Representation.

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

Example:

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

Field: count

InPort Label: Count
Optional.

Specifies the number of Complex Objects present in the Vector Representation.

The value must be a positive integer. If no Complex Objects are present, this node should NOT be included.

Example:

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

Subsection: composite-object

InPort Label: Composite Object
Optional.

Specifies information pertaining to the use of Composite Objects for a Vector Representation.

Example:

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

Field: present

InPort Label: Present
Optional.

Specifies whether or not Composite Objects are present in the Vector Representation.

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

Example:

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

Field: count

InPort Label: Count
Optional.

Specifies the number of Composite Objects present in the Vector Representation.

The value must be a positive integer. If no Composite Objects are present, this node should NOT be included.

Example:

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

Subsection: curve-object

InPort Label: Curve Object
Optional.

Specifies information pertaining to the use of Curve Objects for a Vector Representation.

Example:

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

Field: present

InPort Label: Present
Optional.

Specifies whether or not Curve Objects are present in the Vector Representation.

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

Example:

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

Field: count

InPort Label: Count
Optional.

Specifies the number of Curve Objects present in the Vector Representation.

The value must be a positive integer. If no Curve Objects are present, this node should NOT be included.

Example:

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

Subsection: point-object

InPort Label: Point Object
Optional.

Specifies information pertaining to the use of Point Objects for a Vector Representation.

Example:

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

Field: present

InPort Label: Present
Optional.

Specifies whether or not Point Objects are present in the Vector Representation.

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

Example:

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

Field: count

InPort Label: Count
Optional.

Specifies the number of Point Objects present in the Vector Representation.

The value must be a positive integer. If no Point Objects are present, this node should NOT be included.

Example:

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

Subsection: solid-object

InPort Label: Solid Object
Optional.

Specifies information pertaining to the use of Solid Objects for a Vector Representation.

Example:

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

Field: present

InPort Label: Present
Optional.

Specifies whether or not Solid Objects are present in the Vector Representation.

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

Example:

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

Field: count

InPort Label: Count
Optional.

Specifies the number of Solid Objects present in the Vector Representation.

The value must be a positive integer. If no Solid Objects are present, this node should NOT be included.

Example:

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

Subsection: surface-object

InPort Label: Surface Object
Optional.

Specifies information pertaining to the use of Surface Objects for a Vector Representation.

Example:

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

Field: present

InPort Label: Present
Optional.

Specifies whether or not Surface Objects are present in the Vector Representation.

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

Example:

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

Field: count

InPort Label: Count
Optional.

Specifies the number of Surface Objects present in the Vector Representation.

The value must be a positive integer. If no Surface Objects are present, this node should NOT be included.

Example:

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


Section: access-information

InPort Label: Access Information
Optional.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <access-information>
        ...
    </access-information>
    ...
</inport-metadata>

Back to Table of Contents


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>
    <security-class>Restricted</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>
    <security-class>Restricted</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>
    <security-class>Restricted</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>
    <security-class>Restricted</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>
    <security-class>Restricted</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>
    <security-class>Restricted</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>
    <security-class>Restricted</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>
    <security-class>Restricted</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>
    <security-class>Restricted</security-class>
    <metadata-use-constraints>Sample metadata use constraints.</metadata-use-constraints>
</access-information>

Section: distribution-information

InPort Label: Distribution Information
Optional.

Each Distribution should appear within its own <distribution> node under the enclosing <distribution-information> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <distribution-information>
        <distribution>
            ...
        </distribution>
        <distribution>
            ...
        </distribution>
    </distribution-information>
    ...
</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 Distributions should be deleted and completely replaced by the Distributions specified in the InPort XML file.

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

Example:

<distribution-information mode="replace">
    <distribution>
    ...
    </distribution>
    <distribution>
    ...
    </distribution>
</distribution-information>

Back to Table of Contents


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>http://sample.download.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>http://sample.download.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)
  • person-email: The Distributor's Email Address (if a person)
  • organization: The Organization Name or Acronym, as it appears in InPort (if an organization)

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>
        <person-email>john.doe@noaa.gov</person-email>
        <organization>PIFSC</organization>
    </support-role>
</support-roles>
...
<distribution-information>
    <distribution>
        <download-url>http://www.download.url/</download-url>
        <distributor>
            <from-date>2005-01-01</from-date>
            <person-email>john.doe@noaa.gov</person-email>
            <organization>PIFSC</organization>
        </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>http://www.download.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: 50 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.

Example:

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

Field: fgdc-content-type

InPort Label: FGDC Content Type
Optional.

Specifies the FGDC content type of the Distribution.

The value must be one of the following:

  • Applications
  • Clearinghouses
  • Downloadable Data
  • Geographic Activities
  • Geographic Services
  • Live Data and Maps
  • Map Files
  • Offline Data
  • Other Documents
  • Static Map Images

Example:

<distribution>
    <fgdc-content-type>Live Data and Maps</fgdc-content-type>
</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
  • Zip
  • GZIP
  • Z
  • TAR
  • GTAR
  • Unknown
  • no compression applied

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>

Section: urls

InPort Label: URLs
Optional.

This section is not allowed for Entities. It will be ignored if it is included for a disallowed item type.

Each URL should appear within its own <url> node under the enclosing <urls> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <urls>
        <url>
            ...
        </url>
        <url>
            ...
        </url>
    </urls>
    ...
</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 URLs should be deleted and completely replaced by the URLs specified in the InPort XML file.

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

Example:

<urls mode="replace">
    <url>
    ...
    </url>
    <url>
    ...
    </url>
</urls>

Back to Table of Contents


Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing URL 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 urls).

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 URL, 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 URL.

Example:

<urls>
    <url cc-id="12345">
        ...
    </url>
    <url>
        ...
    </url>
    <url>
        ...
    </url>
</urls>

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


Field: url

InPort Label: URL
Required for each URL specified.
Max Length: 4000 characters.

Specifies an URL associated with the Catalog Item.

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

Example:

<urls>
    <url>
        <url>https://inport.nmfs.noaa.gov/inport</url>
    </url>
</urls>

Field: name

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

Specifies the name for the URL.

Example:

<urls>
    <url>
        <url>https://inport.nmfs.noaa.gov/inport</url>
        <name>InPort<name>
    </url>
</urls>

Field: url-type

InPort Label: URL Type
Optional.

Specifies the URL type.

The value must be one of the following:

  • Online Resource
  • Browse Graphic
  • Other

Example:

<urls>
    <url>
        <url>https://inport.nmfs.noaa.gov/inport</url>
        <url-type>Other<url-type>
    </url>
</urls>

Field: file-resource-format

InPort Label: File Resource Format
Optional.
Max Length: 30 characters.

Specifies the file resource format for the URL.

Example:

<urls>
    <url>
        <url>https://inport.nmfs.noaa.gov/inport</url>
        <file-resource-format>PDF<file-resource-format>
    </url>
</urls>

Field: description

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

Specifies a description for the URL.

Example:

<urls>
    <url>
        <url>https://inport.nmfs.noaa.gov/inport</url>
        <description>InPort metadata repository for NOAA data assets.<description>
    </url>
</urls>

Section: activity-logs

InPort Label: activity-log
Optional.

Each Activity Log should appear within its own <activity-log> node under the enclosing <activity-logs> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <activity-logs>
        <activity-log>
            ...
        </activity-log>
        <activity-log>
            ...
        </activity-log>
    </activity-logs>
    ...
</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 Activity Logs should be deleted and completely replaced by the Activity Logs specified in the InPort XML file.

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

Example:

<activity-logs mode="replace">
    <activity-log>
    ...
    </activity-log>
    <activity-log>
    ...
    </activity-log>
</activity-logs>

Back to Table of Contents


Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing Activity Log 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 activity-logs).

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 Activity Log, 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 Activity Log.

Example:

<activity-logs>
    <activity-log cc-id="12345">
        ...
    </activity-log>
    <activity-log>
        ...
    </activity-log>
    <activity-log>
        ...
    </activity-log>
</activity-logs>

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


Field: activity-date-time

InPort Label: Activity Date/Time
Required.

Specifies the date/time of the Activity.

The value must be a date or date/time specified in ISO 8601 extended format (YYYY-MM-DDThh:mm:ss.fffZ). The date/time should use the appropriate granularity (Year, Month, Day, Hour, Minute, Second, or Fractional 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:

<activity-log>
    <activity-date-time>2001-01-01</activity-date-time>
</activity-log>

Field: activity-type

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

Specifies the type of Activity.

Example:

<activity-log>
    <activity-date-time>2001-01-01</activity-date-time>
    <activity-type>Sample activity type.</activity-type>
</activity-log>

Field: responsible-party-email

InPort Label: Responsible Party
Optional.

Specifies the email address for the responsible party associated with the activity.

The email address is used to identify the corresponding person in InPort; as such, the email address must be of an existing 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:

<activity-log>
    <activity-date-time>2001-01-01</activity-date-time>
    <responsible-party-email>john.doe@noaa.gov</responsible-party-email>
</activity-log>

Field: description

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

Specifies a description of the Activity.

Example:

<activity-log>
    <activity-date-time>2001-01-01</activity-date-time>
    <description>Sample description.</description>
</activity-log>

Section: issues

InPort Label: Issues
Optional.

Each Issue should appear within its own <issue> node under the enclosing <issues> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <issues>
        <issue>
            ...
        </issue>
        <issue>
            ...
        </issue>
    </issues>
    ...
</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 Issues should be deleted and completely replaced by the Issues specified in the InPort XML file.

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

Example:

<issues mode="replace">
    <issue>
    ...
    </issue>
    <issue>
    ...
    </issue>
</issues>

Back to Table of Contents


Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing Issue 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 issues).

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 Issue, 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 Issue.

Example:

<issues>
    <issue cc-id="12345">
        ...
    </issue>
    <issue>
        ...
    </issue>
    <issue>
        ...
    </issue>
</issues>

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


Field: issue-date

InPort Label: Issue Date
Optional.

Specifies the date of the Issue.

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:

<issues>
    <issue>
        <issue-date>2001-01-01</issue-date>
        <issue>Sample issue</issue>
    </issue>
</issues>

Field: author-email

InPort Label: Author
Optional.

Specifies the email address for the author of the Issue.

The email address is used to identify the corresponding person in InPort; as such, the email address must be of an existing 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:

<issues>
    <issue>
        <author-email>john.doe@noaa.gov</author-email>
        <issue>Sample issue</issue>
    </issue>
</issues>

Field: issue

InPort Label: Issue
Required.
Max Length: 4000 characters.

Specifies an Issue associated with the Catalog Item.

Example:

<issues>
    <issue>
        <issue>Sample issue</issue>
    </issue>
</issues>

Section: technical-environment

InPort Label: Technical Environment
Optional.

This section is applicable to all item types EXCEPT Entities and Documents. It will be ignored if it is included for either of these types.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <technical-environment>
        ...
    </technical-environment>
    ...
</inport-metadata>

Back to Table of Contents


Field: description

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

Specifies a description of the Technical Environment for the item.

Example:

<technical-environment>
    <description>Sample technical environment description</description>
</technical-environment>

Section: data-quality

InPort Label: Data Quality
Optional.

This section is not allowed for Entities. It will be ignored if it is included for a disallowed item type.

Example:

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

Back to Table of Contents


Field: representativeness

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

Specifies the representativeness for the Catalog Item.

Example:

<data-quality>
    <representativeness>Sample representativeness.</representativeness>
</data-quality>

Field: accuracy

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

Specifies the accuracy for the Catalog Item.

Example:

<data-quality>
    <accuracy>Sample accuracy.</accuracy>
</data-quality>

Field: analytical-accuracy

InPort Label: Analytical Accuracy
Optional.
Max Length: 4000 characters.

Specifies the analytical accuracy for the Catalog Item.

Example:

<data-quality>
    <analytical-accuracy>Sample analytical accuracy.</analytical-accuracy>
</data-quality>

Field: horizontal-positional-accuracy

InPort Label: Horizontal Positional Accuracy
Optional.
Max Length: 4000 characters.

Specifies the horizontal positional accuracy for the Catalog Item.

Example:

<data-quality>
    <horizontal-positional-accuracy>Sample horizontal positional accuracy.</horizontal-positional-accuracy>
</data-quality>

Field: vertical-positional-accuracy

InPort Label: Vertical Positional Accuracy
Optional.
Max Length: 4000 characters.

Specifies the vertical positional accuracy for the Catalog Item.

Example:

<data-quality>
    <vertical-positional-accuracy>Sample vertical positional accuracy.</vertical-positional-accuracy>
</data-quality>

Field: quantitation-limits

InPort Label: Quantitation Limits
Optional.
Max Length: 4000 characters.

Specifies the quantitation limits for the Catalog Item.

Example:

<data-quality>
    <quantitation-limits>Sample quantitation limits.</quantitation-limits>;
</data-quality>

Field: bias

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

Specifies the bias for the Catalog Item.

Example:

<data-quality>
    <bias>Sample bias.</bias>
</data-quality>

Field: comparability

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

Specifies the comparability for the Catalog Item.

Example:

<data-quality>
    <comparability>Sample comparability.</comparability>
</data-quality>

Field: completeness-measure

InPort Label: Completeness Measure
Optional.
Max Length: 4000 characters.

Specifies the completeness measure for the Catalog Item.

Example:

<data-quality>
    <completeness-measure>Sample completeness measure.</completeness-measure>
</data-quality>

Field: precision

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

Specifies the precision for the Catalog Item.

Example:

<data-quality>
    <precision>Sample precision.</precision>
</data-quality>

Field: analytical-precision

InPort Label: Analytical Precision
Optional.
Max Length: 4000 characters.

Specifies the analytical precision for the Catalog Item.

Example:

<data-quality>
    <analytical-precision>Sample analytical precision.</analytical-precision>
</data-quality>

Field: field-precision

InPort Label: Field Precision
Optional.
Max Length: 4000 characters.

Specifies the field precision for the Catalog Item.

Example:

<data-quality>
    <field-precision>Sample field precision.</field-precision>
</data-quality>

Field: sensitivity

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

Specifies the sensitivity for the Catalog Item.

Example:

<data-quality>
    <sensitivity>Sample sensitivity.</sensitivity>
</data-quality>

Field: detection-limit

InPort Label: Detection Limit
Optional.
Max Length: 4000 characters.

Specifies the detection limit for the Catalog Item.

Example:

<data-quality>
    <detection-limit>Sample detection limit.</detection-limit>
</data-quality>

Field: completeness-report

InPort Label: Completeness Report
Optional.
Max Length: 32767 characters.

Specifies the completeness report for the Catalog Item.

Example:

<data-quality>
    <completeness-report>Sample completeness report.</completeness-report>
</data-quality>

Field: conceptual-consistency

InPort Label: Conceptual Consistency
Optional.
Max Length: 4000 characters.

Specifies the conceptual consistency for the Catalog Item.

Example:

<data-quality>
    <conceptual-consistency>Sample conceptual consistency.</conceptual-consistency>
</data-quality>

Field: quality-control-procedures

InPort Label: Quality Control Procedures
Optional.
Max Length: 4000 characters.

Specifies the quality control procedures for the Catalog Item.

Example:

<data-quality>
    <quality-control-procedures>Sample quality control procedures.</quality-control-procedures>
</data-quality>

Section: acronyms

InPort Label: Acronyms
Optional.

Section: acronyms

This section is only applicable to Projects. It will be ignored if it is included for a catalog item of a different type.

Each Acronym should appear within its own <acronym> node under the enclosing <acronyms> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <acronyms>
        <acronym>
            ...
        </acronym>
        <acronym>
            ...
        </acronym>
    </acronyms>
    ...
</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 Acronyms should be deleted and completely replaced by the Acronyms specified in the InPort XML file.

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

Example:

<acronyms mode="replace">
    <acronym>
    ...
    </acronym>
    <acronym>
    ...
    </acronym>
</acronyms>

Back to Table of Contents


Attribute: cc-id

This attribute is NOT allowed for Acronyms.


Field: acronym

InPort Label: Acronym
Required.
Max Length: 30 characters.

Specifies the acronym.

Example:

<acronyms>
    <acronym>
        <acronym>PIFSC</acronym>
        <meaning>Pacific Islands Fisheries Science Center</meaning>
    </acronym>
</acronyms>

Field: meaning

InPort Label: Meaning
Required.
Max Length: 240 characters.

Specifies the acronym meaning.

Example:

Example:

<acronyms>
    <acronym>
        <acronym>PIFSC</acronym>
        <meaning>Pacific Islands Fisheries Science Center</meaning>
    </acronym>
</acronyms>

Section: glossary

InPort Label: Glossary
Optional.

This section is only applicable to Projects. It will be ignored if it is included for a catalog item of a different type.

Each Glossary entry should appear within its own <glossary-entry> node under the enclosing <glossary> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <glossary>
        <glossary-entry>
            ...
        </glossary-entry>
        <glossary-entry>
            ...
        </glossary-entry>
    </glossary>
    ...
</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 Glossary entries should be deleted and completely replaced by the Glossary entries specified in the InPort XML file.

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

Example:

<glossary mode="replace">
    <glossary-entry>
    ...
    </glossary-entry>
    <glossary-entry>
    ...
    </glossary-entry>
</glossary>

Back to Table of Contents


Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing Glossary entry 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 glossary).

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 Glossary entry, 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 Glossary entry.

Example:

<glossary>
    <glossary-entry cc-id="12345">
        ...
    </glossary-entry>
    <glossary-entry>
        ...
    </glossary-entry>
    <glossary-entry>
        ...
    </glossary-entry>
</glossary>

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


Field: term

InPort Label: Term
Required.
Max Length: 50 characters.

Specifies the Glossary entry term.

Example:

<glossary>
    <glossary-entry>
        <term>Sample term</term>
        <definition>Sample definition</definition>
    </glossary-entry>
</glossary>

Field: authority

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

Specifies the authority for the Glossary entry.

Example:

<glossary>
    <glossary-entry>
        <term>Sample term</term>
        <authority>Sample authority</authority>
        <definition>Sample definition</definition>
    </glossary-entry>
</glossary>

Field: definition

InPort Label: Definition
Required.
Max Length: 4000 characters.

Specifies the definition for the Glossary entry.

Example:

<glossary>
    <glossary-entry>
        <term>Sample term</term>
        <definition>Sample definition</definition>
    </glossary-entry>
</glossary>

Section: data-management

InPort Label: Data Management
Optional.

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

Example:

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

Back to Table of Contents


Field: resources-identified

InPort Label: Have Resources for Management of these Data Been Identified?
Optional.

Specifies whether data management resources have been identified for the Data Set.

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

Example:

<data-management>
    <resources-identified>Yes</resources-identified>
</data-management>

Field: resources-budget-percentage

InPort Label: Approximate Percentage of Budget for these Data Devoted to Data Management
Optional.
Max Length: 1000 characters.

Specifies the approximate percentage of budget which been devoted to data management of the Data Set.

The value can be expressed as a percentage. Enter "Unknown" if the value is currently unknown.

Note: On item creation only, when any field under the Data Management section is populated, the value for this field will be set to "Unknown" by default if a value is not provided.

Example:

<data-management>
    <resources-budget-percentage>10%</resources-budget-percentage>
</data-management>

Field: data-access-directive-compliant

InPort Label: Do these Data Comply with the Data Access Directive?
Optional.

Specifies whether or not this Data Set complies with the Data Access Directive.

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

Note: On item creation only, when any field under the Data Management section is populated, the value for this field will be set to "No" by default if a value is not provided.

Example:

<data-management>
    <data-access-directive-compliant>Yes</data-access-directive-compliant>
</data-management>

Field: data-access-directive-waiver

InPort Label: Is Access to the Data Limited Based on an Approved Waiver?
Optional.

Specifies whether or not data access is limited based on an approved waiver.

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

Note: If the question is not applicable to the Data Set, the value should be set to "No".

Example:

<data-management>
    <data-access-directive-waiver>No</data-access-directive-waiver>
</data-management>

Field: hosting-service-needed

InPort Label: If Distributor (Data Hosting Service) is Needed, Indicate
Optional.
Max Length: 1000 characters.

Specifies whether a distributor / data hosting service is needed for the Data Set.

Example:

<data-management>
    <hosting-service-needed>Not needed</hosting-service-needed>
</data-management>

Field: delay-collection-dissemination

InPort Label: Approximate Delay Between Data Collection and Dissemination
Optional.
Max Length: 1000 characters.

Specifies the approximate delay between data collection and dissemination for the Data Set.

Example:

<data-management>
    <delay-collection-dissemination>10 days</delay-collection-dissemination>
</data-management>

Field: delay-collection-dissemination-explanation

InPort Label: If Delay is Longer than Latency of Automated Processing, Indicate Under What Authority Data Access is Delayed
Optional.
Max Length: 32767 characters.

Provides an explanation for the delay between data collection and dissemination, if any.

Example:

<data-management>
    <delay-collection-dissemination-explanation>Sample explanation.</delay-collection-dissemination-explanation>
</data-management>

Field: archive-location

InPort Label: Actual or Planned Long-Term Data Archive Location
Optional.

Specifies the data archive location for the Data Set.

The value must be one of the following:

  • NCEI-MD
  • NCEI-CO
  • NCEI-NC
  • NCEI-MS
  • World Data Center (WDC) Facility
  • Other
  • To Be Determined
  • Unable to Archive
  • No Archiving Intended

Example:

<data-management>
    <archive-location>NCEI-MD</archive-location>
</data-management>

Field: archive-location-explanation-other

InPort Label: If World Data Center or Other, Specify
Optional.
Max Length: 1000 characters.

Specifies the data archive location, if World Data Center or Other, for the Data Set.

Note: This field is only necessary if the value for archive-location is "World Data Center (WDC) Facility" or "Other".

Example:

<data-management>
    <archive-location>Other</archive-location>
    <archive-location-explanation-other>WPacFIN</archive-location-explanation-other>
</data-management>

Field: archive-location-explanation-none

InPort Label: If To Be Determined, Unable to Archive, or No Archiving Intended, Explain
Optional.
Max Length: 32767 characters.

Provides an explanation when the data archive location has been specified as To Be Determined, Unable to Archive, or No Archiving Intended.

Example:

<data-management>
    <archive-location>To Be Determined</archive-location>
    <archive-location-explanation-none>Sample explanation.</archive-location-explanation-none>
</data-management>

Field: delay-collection-archive

InPort Label: Approximate Delay Between Data Collection and Archiving
Optional.
Max Length: 1000 characters.

Specifies the approximate delay between data collection and archiving.

Example:

<data-management>
    <delay-collection-archive>21 days</delay-collection-archive>
</data-management>

Field: data-protection-plan

InPort Label: How Will the Data be Protected from Accidental or Malicious Modification or Deletion Prior to Receipt by the Archive?
Optional.
Max Length: 32767 characters.

Specifies the data protection plan for the Data Set.

Example:

<data-management>
    <data-protection-plan>Sample data protection plan.</data-protection-plan>
</data-management>

Section: lineage

InPort Label: Lineage
Optional.

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

Example:

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

Back to Table of Contents


Field: lineage-statement

InPort Label: Lineage Statement
Optional.
Max Length: 4000 characters.

Specifies the lineage statement for the Data Set.

Example:

<lineage>
    <lineage-statement>Sample lineage statement.</lineage-statement>
</lineage>

Subsection: lineage-sources

InPort Label: Lineage Sources
Optional.

Each Lineage Source should appear within its own <lineage-source> node under the enclosing <lineage-sources> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <lineage-sources>
        <lineage-source>
            ...
        </lineage-source>
        <lineage-source>
            ...
        </lineage-source>
    </lineage-sources>
    ...
</inport-metadata>

Attribute: mode

Optional; only applies to item updates. Only "replace" mode is supported for Lineage Sources. If no mode is specified, "replace" mode is used by default.

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

Example:

<lineage-sources mode="replace">
    <lineage-source>
    ...
    </lineage-source>
    <lineage-source>
    ...
    </lineage-source>
</lineage-sources>

Back to Table of Contents


Field: citation-title

InPort Label: Citation Title
Required for each lineage source.
Max Length: 1000 characters.

Specifies the title of the citation for the Lineage Source.

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
    </lineage-source>
</lineage-sources>

Field: originator-publisher-type

InPort Label: Originator/Publisher Type
Optional.

Specifies the type of Originator/Publisher for the Lineage Source.

The value must be one of the following:

  • InPort Person
  • InPort Organization
  • Non-InPort Person/Organization

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <originator-publisher-type>InPort Organization</originator-publisher-type>
        <originator-publisher>PIFSC</originator-publisher>
    </lineage-source>
</lineage-sources>

Field: originator-publisher

InPort Label: Originator/Publisher
Optional.
Max Length: 500 characters.

Specifies the Originator/Publisher for the Lineage Source.

The value should correspond to the Originator/Publisher Type specified in originator-publisher-type.

  • If the type is an InPort Person, enter the email address of person in InPort. (Do not enter the person's name).
  • If the type is an InPort Organization, enter the organization's name or acronym, exactly as it appears in InPort.
  • If the type is a Non-InPort Person/Organization, enter the person or organization name.

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <originator-publisher-type>InPort Person</originator-publisher-type>
        <originator-publisher>jane.doe@noaa.gov</originator-publisher>
    </lineage-source>
</lineage-sources>

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <originator-publisher-type>InPort Organization</originator-publisher-type>
        <originator-publisher>PIFSC</originator-publisher>
    </lineage-source>
</lineage-sources>

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <originator-publisher-type>Non-InPort Person/Organization</originator-publisher-type>
        <originator-publisher>George Washington</originator-publisher>
    </lineage-source>
</lineage-sources>

Field: publish-date

InPort Label: Publish Date
Optional.

Specifies the publish date of the Lineage Source.

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

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <publish-date>2015-01-20</publish-date>
    </lineage-source>
</lineage-sources>

Field: extent-type

InPort Label: Extent Type
Optional.

Specifies the type of the extent for a Lineage Source.

The value must be one of the following:

  • Continuing
  • Discrete
  • Range

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <extent-type>Continuing</extent-type>
        <extent-start-date-time>2015-01-03</extent-start-date-time>
    </lineage-source>
</lineage-sources>

Field: extent-start-date-time

InPort Label: Extent Start Date/Time
Optional.

Specifies the start date/time of the extent for a Lineage Source.

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:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <extent-type>Continuing</extent-type>
        <extent-start-date-time>2015-01-03T09:30</extent-start-date-time>
    </lineage-source>
</lineage-sources>

Field: extent-end-date-time

InPort Label: Extent End Date/Time
Optional.

Specifies the end date/time of the extent for a Lineage Source.

The end date/time must not be before the start date/time.

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:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <extent-type>Range</extent-type>
        <extent-start-date-time>2015-01-03T09:30</extent-start-date-time>
        <extent-end-date-time>2015-01-03T10:30</extent-end-date-time>
    </lineage-source>
</lineage-sources>

Field: scale-denominator

InPort Label: Scale Denominator
Optional.

Specifies the scale denominator for a Lineage Source.

The value must be a positive integer.

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <scale-denominator>100</scale-denominator>
    </lineage-source>
</lineage-sources>

Field: citation-url

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

Specifies an URL to the Lineage Source citation.

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

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <citation-url>http://lineage-source.citation.url/</citation-url>
    </lineage-source>
</lineage-sources>

Field: citation-url-name

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

Specifies the name of the URL to the Lineage Source citation.

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <citation-url>http://lineage-source.citation.url/</citation-url>
        <citation-url-name>The Lineage Source Citation</citation-url-name>
    </lineage-source>
</lineage-sources>

Field: citation-url-description

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

Specifies the description of the URL to the Lineage Source citation.

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <citation-url>http://lineage-source.citation.url/</citation-url>
        <citation-url-description>The description of the Lineage Source Citation.</citation-url-description>
    </lineage-source>
</lineage-sources>

Field: source-contribution

InPort Label: Source Contribution
Optional.
Max Length: 2000 characters.

Specifies the source contribution for the Lineage Source.

Example:

<lineage-sources>
    <lineage-source>
        <citation-title>Sample Citation Title</citation-title>
        <source-contribution>Sample Source Contribution</source-contribution>
    </lineage-source>
</lineage-sources>

Subsection: lineage-process-steps

InPort Label: Lineage Process Steps
Optional.

Each Lineage Process Step should appear within its own <lineage-process-step> node under the enclosing <lineage-process-steps> node.

Example:

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

Attribute: mode

Optional; only applies to item updates. Only "replace" mode is supported for Lineage Process Steps. If no mode is specified, "replace" mode is used by default.

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

Example:

<lineage-process-steps mode="replace">
    <lineage-process-step>
    ...
    </lineage-process-step>
    <lineage-process-step>
    ...
    </lineage-process-step>
</lineage-process-steps>

Back to Table of Contents


Field: sequence-number

InPort Label: Sequence Number
Required.

Specifies the sequence number for the lineage process step.

The value must be a positive integer.

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
    </lineage-process-step>
</lineage-process-steps>

Field: description

InPort Label: Description
Required.

Specifies the description for the Lineage Process Step.

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
    </lineage-process-step>
</lineage-process-steps>

Field: process-date-time

InPort Label: Process Date/Time
Optional.

Specifies the process date/time for the Lineage Process Step.

The value must be a date/time specified in ISO 8601 extended format (YYYY-MM-DDThh:mm:ss).

All date/times are interpreted as UTC.

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
        <process-date-time>2015-01-19T12:00:00</process-date-time>
    </lineage-process-step>
</lineage-process-steps>

Field: process-contact-type

InPort Label: Process Contact Type
Optional.

Specifies the type of Process Contact Type for the Lineage Process Step.

The value must be one of the following:

  • InPort Person
  • InPort Organization
  • Non-InPort Person/Organization

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
        <process-contact-type>InPort Organization</process-contact-type>
        <process-contact>PIFSC</process-contact>
    </lineage-process-step>
</lineage-process-steps>

Field: process-contact

InPort Label: Process Contact
Optional.
Max Length: 500 characters.

Specifies the Process Contact for the lineage process step.

The value should correspond to the Process Contact specified in process-contact.

  • If the type is an InPort Person, enter the email address of person in InPort. (Do not enter the person's name).
  • If the type is an InPort Organization, enter the organization's name or acronym, exactly as it appears in InPort.
  • If the type is a Non-InPort Person/Organization, enter the person or organization name.

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
        <process-contact-type>InPort Person</process-contact-type>
        <process-contact>jane.doe@noaa.gov</process-contact>
    </lineage-process-step>
</lineage-process-steps>

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
        <process-contact-type>InPort Organization</process-contact-type>
        <process-contact>PIFSC</process-contact>
    </lineage-process-step>
</lineage-process-steps>

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
        <process-contact-type>Non-InPort Person/Organization</process-contact-type>
        <process-contact>George Washington</process-contact>
    </lineage-process-step>
</lineage-process-steps>

Field: process-contact-phone

InPort Label: Process Contact Phone
Optional.
Max Length: 50 characters.

Specifies the Process Contact's phone number, when it is a Non-InPort Person/Organization.

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
        <process-contact-type>Non-InPort Person/Organization</process-contact-type>
        <process-contact>George Washington</process-contact>
        <process-contact-phone>123-456-7890</process-contact-phone>
    </lineage-process-step>
</lineage-process-steps>

Field: process-contact-email

InPort Label: Process Contact Email
Optional.
Max Length: 200 characters.

Specifies the Process Contact's email address, when it is a Non-InPort Person/Organization.

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
        <process-contact-type>Non-InPort Person/Organization</process-contact-type>
        <process-contact>George Washington</process-contact>
        <process-contact-email>george.washington@usa.gov</process-contact-email>
    </lineage-process-step>
</lineage-process-steps>

Field: source-citation

InPort Label: Source Citation
Optional.

Specifies the Lineage Source for the Process Step.

The value must match an existing or newly added Lineage Process Step Citation Title exactly.

Example:

<lineage-process-steps>
    <lineage-process-step>
        <sequence-number>1</sequence-number>
        <description>Sample Description</description>
        <source-citation>Sample Citation Title</source-citation>
    </lineage-process-step>
</lineage-process-steps>

Section: acquisition-information

InPort Label: Acquisition Information
Optional.

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

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <acquisition-information>
        ...
    </acquisition-information>
    ...
</inport-metadata>

Back to Table of Contents


Field: instrument-unavailable-reason

InPort Label: Instrument Unavailable Reason
Optional.

Specifies the reason Instrument information is unavailable.

Thie field should only be specified if no Instruments will be documented for the record.

The value must be one of the following:

  • Not Applicable
  • Unknown
  • Withheld

Example:

<acquisition-information>
    <instrument-unavailable-reason>Not Applicable</instrument-unavailable-reason>
</acquisition-information>

Subsection: instruments

InPort Label: Instruments
Optional.

Each Instrument should appear within its own <instrument> node under the enclosing <instruments> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <instruments>
        <instrument>
            ...
        </instrument>
        <instrument>
            ...
        </instrument>
    </instruments>
    ...
</inport-metadata>

Attribute: mode

Optional; only applies to item updates. Only "replace" mode is supported for Instruments. If no mode is specified, "replace" mode is used by default.

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

Example:

<instruments mode="replace">
    <instrument>
    ...
    </instrument>
    <instrument>
    ...
    </instrument>
</instruments>

Back to Table of Contents


Attribute: cc-id

This attribute is NOT allowed for Instruments.


Field: identifier

InPort Label: Identifier
This field or Docucomp UUID is required for each Instrument.
Max Length: 250 characters.

Specifies the Instrument identifier.

Example:

<instruments>
    <instrument>
        <identifier>Instrument Name</identifier>
    </instrument>
</instruments>

Field: docucomp-uuid

InPort Label: Docucomp UUID
This field or Identifier is required for each Instrument.
Max Length: 100 characters.

Specifies the Docucomp UUID of the Instrument.

Example:

<instruments>
    <instrument>
        <docucomp-uuid>1234ABC567DE89F0A123BCDE4FA5678B</docucomp-uuid>
    </instrument>
</instruments>

Field: platform-unavailable-reason

InPort Label: Platform Unavailable Reason
Optional.

Specifies the reason Platform information is unavailable.

Thie field should only be specified if no Platforms will be documented for the record.

The value must be one of the following:

  • Not Applicable
  • Unknown
  • Withheld

Example:

<acquisition-information>
    <platform-unavailable-reason>Not Applicable</platform-unavailable-reason>
</acquisition-information>

Subsection: platforms

InPort Label: Platforms
Optional.

Each Platform should appear within its own <platform> node under the enclosing <platforms> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <platforms>
        <platform>
            ...
        </platform>
        <platform>
            ...
        </platform>
    </platforms>
    ...
</inport-metadata>

Attribute: mode

Optional; only applies to item updates. Only "replace" mode is supported for Platforms. If no mode is specified, "replace" mode is used by default.

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

Example:

<platforms mode="replace">
    <platform>
    ...
    </platform>
    <platform>
    ...
    </platform>
</platforms>

Back to Table of Contents


Attribute: cc-id

This attribute is NOT allowed for Platforms.


Field: identifier

InPort Label: Identifier
This field or Docucomp UUID is required for each Platform.
Max Length: 250 characters.

Specifies the Platform identifier.

Example:

<platforms>
    <platform>
        <identifier>Platform Name</identifier>
        <mounted-instruments>
            <instrument>
                <identifier>Instrument Name</identifier>
            </instrument>
        </mounted-instruments>
    </platform>
<platforms>

Field: docucomp-uuid

InPort Label: Docucomp UUID
This field or Identifier is required for each Platform.
Max Length: 100 characters.

Specifies the Docucomp UUID of the Platform.

Example:

<platforms>
    <platform>
        <docucomp-uuid>1234ABC567DE89F0A123BCDE4FA5678B</docucomp-uuid>
        <mounted-instruments>
            <instrument>
                <identifier>Instrument Name</identifier>
            </instrument>
        </mounted-instruments>
    </platform>
<platforms>

Subsection: mounted-instruments

InPort Label: Mounted Instruments
Required. Each Platform must specify one or more Mounted Instruments.

Specifies the Instruments mounted on the Platform.

Each Mounted Instrument should appear within its own <instrument> node under the enclosing <mounted-instruments> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <mounted-instruments>
        <instrument>
            ...
        </instrument>
        <instrument>
            ...
        </instrument>
    </mounted-instruments>
    ...
</inport-metadata>

Attribute: mode

This attribute is NOT allowed for Mounted Instruments.

Back to Table of Contents


Attribute: cc-id

This attribute is NOT allowed for Mounted Instruments.


Field: identifier

InPort Label: Identifier
This field or Docucomp UUID is required for each Mounted Instrument.
Max Length: 250 characters.

Specifies the identifier of the Mounted Instrument.

The Identifier must correspond to one of the Instruments declared in the Instruments subsection.

Example:

<instruments>
    <instrument>
        <identifier>Instrument Name</identifier>
    </instrument>
</instruments>
<platforms>
    <platform>
        <identifier>Platform Name</identifier>
        <mounted-instruments>
            <instrument>
                <identifier>Instrument Name</identifier>
            </instrument>
        </mounted-instruments>
    </platform>
<platforms>

Field: docucomp-uuid

InPort Label: Docucomp UUID
This field or Identifier is required for each Mounted Instrument.
Max Length: 100 characters.

Specifies the Docucomp UUID of the Mounted Instrument.

The Docucomp UUID must correspond to one of the Instruments declared in the Instruments subsection.

Example:

<instruments>
    <instrument>
        <docucomp-uuid>1234ABC567DE89F0A123BCDE4FA5678B</docucomp-uuid>
    </instrument>
</instruments>
<platforms>
    <platform>
        <identifier>Platform Name</identifier>
        <mounted-instruments>
            <instrument>
                <docucomp-uuid>1234ABC567DE89F0A123BCDE4FA5678B</docucomp-uuid>
            </instrument>
        </mounted-instruments>
    </platform>
<platforms>

Section: faqs

InPort Label: FAQs
Optional.

Each FAQ should appear within its own <faq> node under the enclosing <faqs> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <faqs>
        <faq>
            ...
        </faq>
        <faq>
            ...
        </faq>
    </faqs>
    ...
</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 FAQs should be deleted and completely replaced by the FAQs specified in the InPort XML file.

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

Example:

<faqs mode="replace">
    <faq>
    ...
    </faq>
    <faq>
    ...
    </faq>
</faqs>

Back to Table of Contents


Attribute: cc-id

Optional. Only applicable to item updates.

This attribute allows an already existing FAQ 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 faqs).

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 FAQ, 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 FAQ.

Example:

<faqs>
    <faq cc-id="12345">
        ...
    </faq>
    <faq>
        ...
    </faq>
    <faq>
        ...
    </faq>
</faqs>

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


Field: date

InPort Label: Date
Required.

Specifies the FAQ date.

The value must be a date/time specified in ISO 8601 extended format (YYYY-MM-DDThh:mm:ss).

All date/times are interpreted as UTC.

Example:

<faqs>
    <faq>
        <date>2016-01-01</date>
        <author-email>john.doe@noaa.gov</author-email>
        <question>Sample question</question>
        <answer>Sample answer</answer>
    </faq>
</faqs>

Field: author-email

InPort Label: Author
Required.

Specifies the email of the FAQ author.

The email address is used to identify the corresponding person in InPort; as such, the email address must be of an existing 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:

<faqs>
    <faq>
        <date>2016-01-01</date>
        <author-email>john.doe@noaa.gov</author-email>
        <question>Sample question</question>
        <answer>Sample answer</answer>
    </faq>
</faqs>

Field: question

InPort Label: Question
Required.
Max Length: 4000 characters.

Specifies the FAQ question.

Example:

<faqs>
    <faq>
        <date>2016-01-01</date>
        <author-email>john.doe@noaa.gov</author-email>
        <question>Sample question</question>
        <answer>Sample answer</answer>
    </faq>
</faqs>

Field: answer

InPort Label: Answer
Required.
Max Length: 4000 characters.

Specifies the FAQ answer.

Example:

<faqs>
    <faq>
        <date>2016-01-01</date>
        <author-email>john.doe@noaa.gov</author-email>
        <question>Sample question</question>
        <answer>Sample answer</answer>
    </faq>
</faqs>

Section: related-items

InPort Label: Related Items
Optional.

Each Related Item should appear within its own <related-item> node under the enclosing <related-items> node.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <related-items>
        <related-item>
            ...
        </related-item>
        <related-item>
            ...
        </related-item>
    </related-items>
    ...
</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 Related Items should be deleted and completely replaced by the Related Items specified in the InPort XML file.

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

Example:

<related-items mode="replace">
    <related-item>
    ...
    </related-item>
    <related-item>
    ...
    </related-item>
</related-items>

Back to Table of Contents


Attribute: cc-id

This attribute is NOT allowed for Related Items.


Field: catalog-item-id

InPort Label: Catalog Item ID
Required.

Specifies the Catalog Item ID of the Related Item.

The value must be an integer, and it must correspond to an existing Catalog Item in InPort. The Linking Share Level setting of the Catalog Item must also allow the relationship.

Example:

<related-items>
    <related-item>
        <catalog-item-id>1234</catalog-item-id>
        <relationship-type>Cross-Reference</relationship-type>
    </related-item>
</related-items>

Field: relationship-type

InPort Label: Relationship Type
Required.

Specifies the type of relationship of the Related Item.

The value must be one of the following:

  • Cross Reference
  • Larger Work Citation
  • Part of a Seamless Database
  • Stereo Mate
  • Revision Of
  • Series

Example:

<related-items>
    <related-item>
        <catalog-item-id>1234</catalog-item-id>
        <relationship-type>Cross-Reference</relationship-type>
    </related-item>
</related-items>

Field: notes

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

Specifies notes on the Related Item relationship.

Example:

<related-items>
    <related-item>
        <catalog-item-id>1234</catalog-item-id>
        <relationship-type>Cross-Reference</relationship-type>
        <notes>Sample notes</notes>
    </related-item>
</related-items>

Section: catalog-details

InPort Label: Catalog Details
Optional.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <catalog-details>
        ...
    </catalog-details>
    ...
</inport-metadata>

Back to Table of Contents


Field: is-do-not-publish

InPort Label: Do Not Publish
Optional.

Specifies whether or not the item is flagged to prevent publishing.

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

Example:

<catalog-details>
    <is-do-not-publish>Yes</is-do-not-publish>
</catalog-details>

Field: metadata-next-review-date

InPort Label: Metadata Next Review Date
Optional.

Specifies the next metadata review date for the Catalog Item.

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

Example:

<catalog-details>
    <metadata-next-review-date>2020-01-15</metadata-next-review-date>
</catalog-details>

Field: linking-share-level

InPort Label: Linking Share Level
Optional.

Specifies the allowed scope of related item linking to this Catalog Item.

The value must be one of the following:

  • Across the InPort Catalog
  • Within this Item's Library
  • Within this Item's Project

Note: If this field is not specified, the default value of "Across the InPort Catalog" will be supplied.

Example:

<catalog-details>
    <linking-share-level>Across the InPort Catalog</linking-share-level>
</catalog-details>