Search Help Show/Hide Menu
Home > Help >

InPort XML Loader Documentation for DMPs

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.

This help page focuses specifically on Data Management Plans (DMPs). For XML Loader documentation for other Catalog Item types, please see the main InPort XML Loader documentation page.

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, "Add Child Item From File".

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 Item From File". Please also consult the Catalog Item Replacement help page for more information on performing complete replacements of metadata records.

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.

The InPort XML Format for DMPs: Version 1.13

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

Example:

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

Back to Table of Contents

Section: loader-options

InPort Label: Loader Options
Optional.

Loader Options are currently not supported for DMPs.

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 user must have an Author or higher role on the Catalog Item to update it.

Example:

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

The example snippet would update Catalog Item ID 1234.

Field: catalog-item-type

InPort Label: Catalog Item Type
Required for item creation.

Specifies the Catalog Item Type of the record.

The value must be one of the following:

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

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

This documentation is intended for Data Management Plans. If you are using the Loader to create or update other Catalog Item Types, please refer to the main XML Loader Documentation page.

Example:

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

Field: parent-catalog-item-id

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

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

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

Example:

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

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

Section: general-information

InPort Label: General Information
Required.

Example:

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

Back to Table of Contents

Field: dmp-name

InPort Label: DMP Name
Required for DMP creation, optional for DMP updates.
Max Length: 4000 characters.

Human-readable name identifying this DMP.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <general-information>
        <dmp-name>My Data Management Plan</dmp-type>
        ...
    </general-information>
</inport-metadata>

Field: dmp-type

InPort Label: DMP Type
Optional.

The type of DMP this record represents.

The value must be one of the following:

  • Initial DMP
  • Updated DMP
  • Final DMP
  • Funding Proposal DMP (Grants/CAs)
  • Updated DMP (Grants/CAs)
  • Final DMP (Grants/CAs)
  • Program-level DMP
  • No Data DMP

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <general-information>
        <dmp-name>My Data Management Plan</dmp-type>
        <dmp-type>Initial DMP</dmp-type>
    </general-information>
</inport-metadata>

Field: description

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

A brief narrative summary. The description should clearly reference the specific subject and unique dimensions of this Data Management Plan, along with explicit consideration of major scientific concepts, keywords, and other descriptive terms to aid users in identifying, discovering, and understanding the DMP.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <general-information>
        <dmp-name>My Data Management Plan</dmp-type>
        <description>This is an example description.</description>
    </general-information>
</inport-metadata>

Field: purpose

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

Purpose or a summary of intentions with which the data was developed.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<inport-metadata version="1.0">
    ...
    <general-information>
        <dmp-name>My Data Management Plan</dmp-type>
        <purpose>This is an example purpose.</purpose>
    </general-information>
</inport-metadata>

Subsection: dmp-links

InPort Label: DMP Links
Optional.

Each DMP Link should appear within its own <dmp-link> node under the enclosing <dmp-links> node.

Example:

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

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

Example:

<dmp-links mode="replace">
    <dmp-link>
    ...
    </dmp-link>
    <dmp-link>
    ...
    </dmp-link>
</dmp-links>

Back to Table of Contents

Field: link-type

InPort Label: Link Type
Required.

The type of link - URL or InPort Catalog Item.

The value must be "URL" or "InPort Catalog Item".

Example:

<dmp-links>
    <dmp-link>
        <link-type>URL</link-type>
        <url>https://my.url/</url>
        <relationship>Program Level DMP</relationship>
    </dmp-link>
</dmp-links>

Field: catalog-item-id

InPort Label: Catalog Item ID
Required if the Link Type is InPort Catalog Item.

Specifies the Catalog Item ID of the linked DMP.

The value must be an integer, and it must correspond to an existing DMP in InPort.

Example:

<dmp-links>
    <dmp-link>
        <link-type>InPort Catalog Item</link-type>
        <catalog-item-id>1234</catalog-item-id>
        <relationship>Program Level DMP</relationship>
    </dmp-link>
</dmp-links>

Field: url

InPort Label: URL
Required if the Link Type is URL.
Max Length: 4000 characters.

Specifies the URL of the linked DMP.

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

Example:

<dmp-links>
    <dmp-link>
        <link-type>URL</link-type>
        <url>https://my.url/</url>
        <relationship>Program Level DMP</relationship>
    </dmp-link>
</dmp-links>

Field: relationship

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

A description of the content of the linked resource and its relationship to this DMP.

Example:

<dmp-links>
    <dmp-link>
        <link-type>InPort Catalog Item</link-type>
        <catalog-item-id>1234</catalog-item-id>
        <relationship>Program Level DMP</relationship>
    </dmp-link>
</dmp-links>

Section: program-information

InPort Label: Program Information
Required.

Example:

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

Back to Table of Contents

Subsection: implementing-program-information

InPort Label: Implementing Program Information
Optional.

Example:

<program-information>
    <implementing-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <additional-information>Additional information example.</additional-information>
    </implementing-program-information>
</program-information>

Back to Table of Contents

Subsection: programs

InPort Label: Programs
Optional.

Field: program

InPort Label: Program
Optional.

The implementing program for this DMP.

The Program should already exist as a Program component in InPort. Please consult the list of Programs in InPort to view the currently available Programs and their Program.

Example:

<program-information>
    <implementing-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <additional-information>Additional information example.</additional-information>
    </implementing-program-information>
</program-information>

Field: additional-information

InPort Label: Additional Information
Optional.
Max Length: 1000 characters.

Additional information on the Implementing Program.

Example:

<program-information>
    <implementing-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <additional-information>Additional information example.</additional-information>
    </implementing-program-information>
</program-information>

Subsection: funding-program-information

InPort Label: Funding Program Information
Optional.

Example:

<program-information>
    <funding-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        ...
    </funding-program-information>
</program-information>

Back to Table of Contents

Subsection: programs

InPort Label: Programs
Optional.

Each Program should appear within its own <program> node under the enclosing <programs> node.

Example:

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

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

Example:

<programs mode="replace">
    <program>
    ...
    </program>
    <program>
    ...
    </program>
</programs>

Field: program

InPort Label: Program
Optional.

The Funding program for this DMP.

The Program should already exist as a Program component in InPort. Please consult the list of Programs in InPort to view the currently available Programs and their Program.

Example:

<program-information>
    <funding-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        ...
    </funding-program-information>
</program-information>

Field: additional-information

InPort Label: Additional Information
Optional.
Max Length: 1000 characters.

Additional information on the Funding Program.

Example:

<program-information>
    <funding-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <additional-information>Additional information example.</additional-information>
    </funding-program-information>
</program-information>

Field: funded-project

InPort Label: Funded Project
Optional.
Max Length: 150 characters.

The name of the project receiving funding.

Example:

<program-information>
    <funding-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <funded-project>Test Monitoring Program</funded-project>
        <funded-project-identifier>ABC-1234</funded-project-identifier>
    </funding-program-information>
</program-information>

Field: funded-project-identifier

InPort Label: Funded Project Identifier
Optional.
Max Length: 250 characters.

The unique identifier for the project receiving funding.

Example:

<program-information>
    <funding-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <funded-project>Test Monitoring Program</funded-project>
        <funded-project-identifier>ABC-1234</funded-project-identifier>
    </funding-program-information>
</program-information>

Field: funding-award-number

InPort Label: Funding Award Number
Optional.
Max Length: 250 characters.

The Grant or CI Funding Award Number associated with the funding (e.g. FAIN).

Example:

<program-information>
    <funding-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <funding-award-number>NA00NES1234567</funding-award-number>
    </funding-program-information>
</program-information>

Subsection: partner-program-information

InPort Label: Partner Program Information
Optional.

Example:

<program-information>
    <partner-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <additional-information>Additional information example.</additional-information>
    </partner-program-information>
</program-information>

Back to Table of Contents

Subsection: programs

InPort Label: Programs
Optional.

Each Program should appear within its own <program> node under the enclosing <programs> node.

Example:

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

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

Example:

<programs mode="replace">
    <program>
    ...
    </program>
    <program>
    ...
    </program>
</programs>

Field: program

InPort Label: Program
Optional.

Partner program for this DMP.

The Program should already exist as a Program component in InPort. Please consult the list of Programs in InPort to view the currently available Programs and their Program.

Example:

<program-information>
    <partner-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <additional-information>Additional information example.</additional-information>
    </partner-program-information>
</program-information>

Field: additional-information

InPort Label: Additional Information
Optional.
Max Length: 1000 characters.

Additional information on the Partner Program.

Example:

<program-information>
    <partner-program-information>
        <programs>
            <program>NWS > Office of Science & Technology Integration (STI)</link-type>
        </programs>
        <additional-information>Additional information example.</additional-information>
    </partner-program-information>
</program-information>

Section: coverage

InPort Label: Coverage
Optional.

Information on the temporal and geographic coverage of the data.

Example:

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

Back to Table of Contents

Subsection: temporal-coverage

InPort Label: The temporal coverage of the data.
Optional.

Example:

<coverage>
    <temporal-coverage>
        ...
    </temporal-coverage>
</coverage>

Back to Table of Contents

Field: collection-scope

InPort Label: Collection Scope
Optional.

The temporal scope of the collection.

The value must be one of the following:

  • One-time
  • Ongoing
  • Unknown

Example:

<coverage>
    <temporal-coverage>
        <collection-scope>One-time</collection-scope>
    </temporal-coverage>
</coverage>

Field: description

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

A description of the temporal coverage of the data.

Example:

<coverage>
    <temporal-coverage>
        <description>Temporal description example.</description>
    </temporal-coverage>
</coverage>

Field: start-date

InPort Label: Start Date
Optional.

The start date of the time period of the data.

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:

<coverage>
    <temporal-coverage>
        <start-date>2021-02-03</start-date>
    </temporal-coverage>
</coverage>

Field: end-date

InPort Label: End Date
Optional.

The end date of the time period of the data.

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 must be later than the Start Date.

Example:

<coverage>
    <temporal-coverage>
        <start-date>2021-02-03</start-date>
        <end-date>2022-02-03</end-date>
    </temporal-coverage>
</coverage>

Subsection: geographic-coverage

InPort Label: The geographic coverage of the data.
Optional.

Example:

<coverage>
    <geographic-coverage>
        ...
    </geographic-coverage>
</coverage>

Back to Table of Contents

Field: description

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

A description of the geographic coverage of the data.

Example:

<coverage>
    <geographic-coverage>
        <description>Geographic description example.</description>
    </geographic-coverage>
</coverage>

Field: west-bound

InPort Label: West Bound
Optional.

The west bound longitude in decimal degrees.

The value must be numeric, greater than or equal to -180, and less than 180.
Note that 180 degrees is not allowed for the west bound; please use -180 degrees for the antimeridian.
Up to 11 digits of precision are supported after the decimal point.

Example:

<coverage>
    <geographic-coverage>
        <west-bound>-10</west-bound>
        <east-bound>10</east-bound>
        <north-bound>10</north-bound>
        <south-bound>-10</south-bound>
    </geographic-coverage>
</coverage>

Field: east-bound

InPort Label: East Bound
Optional.

The east bound longitude in decimal degrees.

The value must be numeric, greater than -180, and less than or equal to 180.
Note that -180 degrees is not allowed for the east bound; please use 180 degrees for the antimeridian.
Up to 11 digits of precision are supported after the decimal point.

Example:

<coverage>
    <geographic-coverage>
        <west-bound>-10</west-bound>
        <east-bound>10</east-bound>
        <north-bound>10</north-bound>
        <south-bound>-10</south-bound>
    </geographic-coverage>
</coverage>

Field: north-bound

InPort Label: North Bound
Optional.

The north bound latitude in decimal degrees.

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

Example:

<coverage>
    <geographic-coverage>
        <west-bound>-10</west-bound>
        <east-bound>10</east-bound>
        <north-bound>10</north-bound>
        <south-bound>-10</south-bound>
    </geographic-coverage>
</coverage>

Field: south-bound

InPort Label: South Bound
Optional.

The south bound latitude in decimal degrees.

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

Example:

<coverage>
    <geographic-coverage>
        <west-bound>-10</west-bound>
        <east-bound>10</east-bound>
        <north-bound>10</north-bound>
        <south-bound>-10</south-bound>
    </geographic-coverage>
</coverage>

Section: data-acquisition

InPort Label: Data Acquisition
Optional.

Information on the acquisition plan and restricted designations.

Example:

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

Back to Table of Contents

Field: has-data-acquisition-plan

InPort Label: Has Data Acquisition Plan
Optional.

Indicates whether a data acquisition plan exists.

The value must be one of the following:

  • Yes
  • No
  • In Development

Example:

<data-acquisition>
    <has-data-acquisition-plan>Yes</has-data-acquisition-plan>
</data-acquisition>

Field: has-restricted-designations

InPort Label: Has Restricted Designations
Optional.

Indicates whether the data acquisition plan includes any restricted designations.

This field is not applicable if the Has Data Acquisition Plan field is set to "No".

The value must be one of the following:

  • Unrestricted
  • Restricted
  • In Development

Example:

<data-acquisition>
    <has-restricted-designations>Unrestricted</has-restricted-designations>
</data-acquisition>

Subsection: data-acquisition-plans

InPort Label: Data Acquisition Plans
Optional.

Link(s) to data acquisition plans.

Each Data Acquisition Plan should appear within its own <data-acquisition-plan> node under the enclosing <data-acquisition-plans> node.

Example:

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

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

Example:

<data-acquisition-plans mode="replace">
    <data-acquisition-plan>
    ...
    </data-acquisition-plan>
    <data-acquisition-plan>
    ...
    </data-acquisition-plan>
</data-acquisition-plans>

Back to Table of Contents

Field: url

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

Specifies the URL of the Data Acquisition Plan.

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

Example:

<data-acquisition>
    <data-acquisition-plans>
        <data-acquisition-plan>
            <url>https://my.url/</url>
            <relationship>Relationship example.</relationship>
        </data-acquisition-plan>
    </data-acquisition-plans>
</data-acquisition>

Field: relationship

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

A description of the linked Data Acquisition Plan and its relationship to this DMP.

Example:

<data-acquisition>
    <data-acquisition-plans>
        <data-acquisition-plan>
            <url>https://my.url/</url>
            <relationship>Relationship example.</relationship>
        </data-acquisition-plan>
    </data-acquisition-plans>
</data-acquisition>

Section: data-collection

InPort Label: Data Collection
Optional.

Information on the data to be collected, how it is to be collected, and the instruments, platforms, and systems of record used for collection.

Example:

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

Back to Table of Contents

Field: data-set-type

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

Type(s) of data, such as digital numeric data, imagery, photographs, video, audio, database, tabular data, etc.

Example:

<data-collection>
    <data-set-type>Imagery</data-set-type>
</data-collection>

Field: data-volume

InPort Label: Data Volume
Optional.
Max Length: 250 characters.

The approximate total data volume.

Example:

<data-collection>
    <data-volume>200 GB</data-volume>
</data-collection>

Field: collection-method

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

The general type of collection method used.

Example:

<data-collection>
    <collection-method>Unmanned aerial system</collection-method>
</data-collection>

Field: collection-standards

InPort Label: Collection Standards
Optional.
Max Length: 1000 characters.

A description of collection standards used, if known.

Example:

<data-collection>
    <collection-standards>Collection standards example.</collection-standards>
</data-collection>

Field: non-noaa-observing-system

InPort Label: Non-NOAA Observing System
Optional.
Max Length: 150 characters.

Other Observing System(s) of Record associated with data collection, which are external to NOAA.

Example:

<data-collection>
    <non-noaa-observing-system>Satellite ABC</non-noaa-observing-system>
</data-collection>

Subsection: instruments

InPort Label: Instruments
Optional.

The instrument(s) used for data collection.

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

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

Example:

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

Back to Table of Contents

Field: identifier

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

Specifies the Instrument identifier.

The Identifier should already exist as a Instrument component in InPort. Please consult the list of Instruments in InPort to view the currently available Instruments and their 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.

The Docucomp UUID should already exist as a Instrument component in InPort. Please consult the list of Instruments in InPort to view the currently available Instruments and their Docucomp UUID.

Example:

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

Field: instrument-gear

InPort Label: Instrument or Gear
This field is required if specifying a new Instrument.

Specifies whether this refers to an instrument or gear.

Note: This field is only processed if a new Instrument is being added to InPort.

It is recommended to ensure that Instruments referenced in InPort XML files already exist in InPort before loading. Please consult the list of Instruments in InPort to view the currently available Instruments.

Instruments that cannot be matched to an existing Instrument in InPort will be automatically added to InPort.

Example:

<instruments>
    <instrument>
        <identifier>Instrument Name</identifier>
        <instrument-gear>Instrument</instrument-gear>
        <instrument-type>Instrument Type</instrument-type>
        <description>Instrument description example.</description>
    </instrument>
</instruments>

Field: instrument-type

InPort Label: Instrument Type
This field is required if specifying a new Instrument.
Max Length: 250 characters.

The type of Instrument.

Note: This field is only processed if a new Instrument is being added to InPort.

It is recommended to ensure that Instruments referenced in InPort XML files already exist in InPort before loading. Please consult the list of Instruments in InPort to view the currently available Instruments.

Instruments that cannot be matched to an existing Instrument in InPort will be automatically added to InPort.

Example:

<instruments>
    <instrument>
        <identifier>Instrument Name</identifier>
        <instrument-gear>Instrument</instrument-gear>
        <instrument-type>Instrument Type</instrument-type>
        <description>Instrument description example.</description>
    </instrument>
</instruments>

Field: description

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

A description of the Instrument.

Note: This field is only processed if a new Instrument is being added to InPort.

It is recommended to ensure that Instruments referenced in InPort XML files already exist in InPort before loading. Please consult the list of Instruments in InPort to view the currently available Instruments.

Instruments that cannot be matched to an existing Instrument in InPort will be automatically added to InPort.

Example:

<instruments>
    <instrument>
        <identifier>Instrument Name</identifier>
        <instrument-gear>Instrument</instrument-gear>
        <instrument-type>Instrument Type</instrument-type>
        <description>Instrument description example.</description>
    </instrument>
</instruments>

Subsection: platforms

InPort Label: Platforms
Optional.

The platform(s) used for data collection.

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

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

Example:

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

Back to Table of Contents

Field: identifier

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

Specifies the Platform identifier.

The Identifier should already exist as a Platform component in InPort. Please consult the list of Platforms in InPort to view the currently available Platforms and their Identifier.

Example:

<platforms>
    <platform>
        <identifier>Platform Name</identifier>
    </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.

The Docucomp UUID should already exist as a Platform component in InPort. Please consult the list of Platforms in InPort to view the currently available Platforms and their Docucomp UUID.

Example:

<platforms>
    <platform>
        <docucomp-uuid>1234ABCD5678</docucomp-uuid>
    </platform>
<platforms>

Field: description

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

A description of the Platform.

Note: This field is only processed if a new Platform is being added to InPort.

It is recommended to ensure that Platforms referenced in InPort XML files already exist in InPort before loading. Please consult the list of Platforms in InPort to view the currently available Platforms.

Platforms that cannot be matched to an existing Platform in InPort will be automatically added to InPort.

Example:

<platforms>
    <platform>
        <identifier>Platform Name</identifier>
        <description>Platform description example.</description>
    </platform>
<platforms>

Subsection: observing-systems

InPort Label: Observing Systems
Optional.

The NOAA Observing System(s) of Record associated with data collection.

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

Example:

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

Attribute: mode

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

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

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

Example:

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

Back to Table of Contents

Field: system-name

InPort Label: System Name
This field or System ID or Acronym is required for each Observing System.

Specifies the System Name of the Observing System.

The System Name should already exist as a Observing System component in InPort. Please consult the list of Observing Systems in InPort to view the currently available Observing Systems and their System Name.

Example:

<observing-systems>
    <observing-system>
        <system-name>Voluntary Observing Ship</system-name>
    </observing-system>
<observing-systems>

Field: system-id

InPort Label: System ID
This field or System Name or Acronym is required for each Observing System.

Specifies the System ID of the Observing System.

The System ID should already exist as a Observing System component in InPort. Please consult the list of Observing Systems in InPort to view the currently available Observing Systems and their System ID.

Example:

<observing-systems>
    <observing-system>
        <system-id>554</system-id>
    </observing-system>
<observing-systems>

Field: acronym

InPort Label: Acronym
This field or System Name or System ID is required for each Observing System.

Specifies the Acronym of the Observing System.

The Acronym should already exist as a Observing System component in InPort. Please consult the list of Observing Systems in InPort to view the currently available Observing Systems and their Acronym.

Note: Not all Observing System acronyms are unique. We recommend using the System Name or System ID to ensure uniqueness when possible.

Example:

<observing-systems>
    <observing-system>
        <acronym>VOS</acronym>
    </observing-system>
<observing-systems>

Section: contact-information

InPort Label: Contact Information
Required.

Example:

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

Back to Table of Contents

Subsection: point-of-contact

InPort Label: Point of Contact
Optional.

The primary Point of Contact for this Data Management Plan.

Example:

<contact-information>
    <point-of-contact>
        <contact-email>john.doe@noaa.gov</contact-email>
    </point-of-contact>
</contact-information>

Back to Table of Contents

Field: contact-email

InPort Label: Contact Email
Either orcid or contact-email or contact-name is required when specifying a Point of Contact.

Specifies the email address of the Point of Contact.

The Contact referenced must be a Person.

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

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

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

Example:

<contact-information>
    <point-of-contact>
        <contact-email>john.doe@noaa.gov</contact-email>
    </point-of-contact>
</contact-information>

Field: contact-name

InPort Label: Contact Name
Either orcid or contact-email or contact-name is required when specifying a Point of Contact.

Specifies the name of the Point of Contact.

The Contact referenced must be a Person.

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

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

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

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

Example:

<contact-information>
    <point-of-contact>
        <contact-name>Doe, Jane</contact-name>
    </point-of-contact>
</contact-information>

Field: orcid

InPort Label: ORCID
Either orcid or contact-email or contact-name is required when specifying a Point of Contact.

Specifies the ORCID of the Point of Contact.

The Contact referenced must be a Person.

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

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

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

Example:

<contact-information>
    <point-of-contact>
        <orcid>1234-5678-1234-5678</orcid>
    </point-of-contact>
</contact-information>

Field: affiliation

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

The Point of Contact's affiliation or facility.

Example:

<contact-information>
    <point-of-contact>
        <contact-email>john.doe@noaa.gov</contact-email>
        <affiliation>NMFS/OST</affiliation>
    </point-of-contact>
</contact-information>

Subsection: responsible-party

InPort Label: Responsible Party
Optional.

The Responsible Party for this Data Management Plan.

The contact information fields for Responsible Party are the same as those for Point of Contact. Please consult the Point of Contact section for details.

Example:

<contact-information>
    <responsible-party>
        <contact-email>john.doe@noaa.gov</contact-email>
    </responsible-party>
</contact-information>

Back to Table of Contents

Section: resources

InPort Label: Resources
Optional.

Information on resources related to management of the data.

Example:

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

Back to Table of Contents

Field: management-resources-available

InPort Label: Management Resources Available
Optional.

Assessment of availability of resources for data management of the data throughout its life cycle.

The value must be one of the following:

  • Yes
  • No
  • Unknown

Example:

<resources>
    <management-resources-available>Yes</management-resources-available>
</resources>

Field: dissemination-resources-available

InPort Label: Dissemination Resources Available
Optional.

Assessment of availability of resources for dissemination of the data.

The value must be one of the following:

  • Yes
  • No
  • Unknown

Example:

<resources>
    <dissemination-resources-available>Yes</dissemination-resources-available>
</resources>

Field: archive-resources-available

InPort Label: Archive Resources Available
Optional.

Assessment of availability of resources for archiving the data.

The value must be one of the following:

  • Yes
  • No
  • Unknown

Example:

<resources>
    <archive-resources-available>Yes</archive-resources-available>
</resources>

Field: project-budget-percentage

InPort Label: Project Budget Percentage
Optional.
Max Length: 50 characters.

Approximate percentage of the overall project budget allocated to data management.

Example:

<resources>
    <project-budget-percentage>10%</project-budget-percentage>
</resources>

Section: data-protection

InPort Label: Data Protection
Optional.

Information on how the data will be stored and protected before it is archived.

Example:

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

Back to Table of Contents

Field: archive-delay

InPort Label: Archive Delay
Optional.
Max Length: 250 characters.

Approximate length of time after data has been collected until it is submitted for archival.

Example:

<data-protection>
    <archive-delay>3 months</archive-delay>
</data-protection>

Field: data-storage-location

InPort Label: Data Storage Location
Optional.
Max Length: 250 characters.

Location where data will be stored prior to archival.

Example:

<data-protection>
    <data-storage-location>PIFSC AWS</data-storage-location>
</data-protection>

Field: data-protection-plan

InPort Label: Data Protection Plan
Optional.
Max Length: 250 characters.

Description of plans for data protection, including discussion of data backups, disaster recovery and contingency planning, and off-site data storage relevant to the data collection.

Example:

<data-protection>
    <data-protection-plan>Data protection plan example.</data-protection-plan>
</data-protection>

Section: data-lineage

InPort Label: Data Lineage and Quality
Optional.

Information on the lineage and quality of the data.

Example:

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

Back to Table of Contents

Field: lineage-statement

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

Statement on the lineage of the data, including information such as the data's provenance/sources, as well as steps, methods and tools used in processing the data.

Example:

<data-lineage>
    <lineage-statement>Lineage statement example.</lineage-statement>
</data-lineage>

Field: quality-control-procedures

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

Description of procedures used to ensure data quality.

Example:

<data-lineage>
    <quality-control-procedures>Quality control procedures example.</quality-control-procedures>
</data-lineage>

Subsection: related-lineage-links

InPort Label: Related Lineage Links
Optional.

Each Related Lineage Link should appear within its own <related-lineage-link> node under the enclosing <related-lineage-links> node.

Example:

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

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

Example:

<related-lineage-links mode="replace">
    <related-lineage-link>
    ...
    </related-lineage-link>
    <related-lineage-link>
    ...
    </related-lineage-link>
</related-lineage-links>

Back to Table of Contents

Field: link-type

InPort Label: Link Type
Required.

The type of link - URL or InPort Catalog Item.

The value must be "URL" or "InPort Catalog Item".

Example:

<data-lineage>
    <related-lineage-links>
        <related-lineage-link>
            <link-type>URL</link-type>
            <url>https://my.url/</url>
            <relationship>Related Lineage Statement</relationship>
        </related-lineage-link>
    </related-lineage-links>
</data-lineage>

Field: catalog-item-id

InPort Label: Catalog Item ID
Required if the Link Type is InPort Catalog Item.

Specifies the Catalog Item ID of the linked lineage information.

The value must be an integer, and it must correspond to an existing Data Set in InPort.

Example:

<data-lineage>
    <related-lineage-links>
        <related-lineage-link>
            <link-type>InPort Catalog Item</link-type>
            <catalog-item-id>1234</catalog-item-id>
            <relationship>Related Lineage Statement</relationship>
        </related-lineage-link>
    </related-lineage-links>
</data-lineage>

Field: url

InPort Label: URL
Required if the Link Type is URL.
Max Length: 4000 characters.

Specifies the URL of the linked lineage information.

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

Example:

<data-lineage>
    <related-lineage-links>
        <related-lineage-link>
            <link-type>URL</link-type>
            <url>https://my.url/</url>
            <relationship>Related Lineage Statement</relationship>
        </related-lineage-link>
    </related-lineage-links>
</data-lineage>

Field: relationship

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

A description of the content of the linked lineage information and its relationship to this DMP.

Example:

<data-lineage>
    <related-lineage-links>
        <related-lineage-link>
            <link-type>InPort Catalog Item</link-type>
            <catalog-item-id>1234</catalog-item-id>
            <relationship>Related Lineage Statement</relationship>
        </related-lineage-link>
    </related-lineage-links>
</data-lineage>

Section: data-documentation

InPort Label: Data Documentation
Optional.

Information on how the data will be documented.

Example:

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

Back to Table of Contents

Field: metadata-process

InPort Label: Metadata Process
Optional.
Max Length: 4000 characters.

Description of the process used for producing and maintaining the data.

Example:

<data-documentation>
    <metadata-process>Metadata process example.</metadata-process>
</data-documentation>

Field: metadata-assistance-required

InPort Label: Metadata Assistance Required
Optional.

Assessment of the need for additional assistance for metadata creation and maintenance.

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

Example:

<data-documentation>
    <metadata-assistance-required>No</metadata-assistance-required>
</data-documentation>

Section: data-access

InPort Label: Data Access and Data Sharing
Optional.

Information on how the data will be made available, and any access restrictions to the data.

Example:

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

Back to Table of Contents

Field: restriction-status

InPort Label: Restriction Status
Optional.

Indication of any restrictions on the data to the public.

The value must be one of the following:

  • Unrestricted
  • Partially Restricted
  • Fully Restricted

Example:

<data-access>
    <restriction-status>Unrestricted</restriction-status>
</data-access>

Field: restriction-explanation

InPort Label: Restriction Explanation
Optional.
Max Length: 4000 characters.

Explanation of any restrictions on the data, including how access is limited as well as the justification for the restriction.

This field is only applicable if the Restriction Status field is set to Restricted or Partially Restricted.

Example:

<data-access>
    <restriction-status>Restricted</restriction-status>
    <restriction-explanation>Restriction Explanation example.</restriction-explanation>
</data-access>

Field: data-for-publication

InPort Label: Data For Publication
Optional.

Indication of whether the data is associated with a new publication.

This field is only applicable if the Restriction Status field is set to Unrestricted or Partially Restricted.

The value must be one of the following:

  • Yes
  • No
  • To Be Determined

Example:

<data-access>
    <data-for-publication>No</data-for-publication>
</data-access>

Field: data-license

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

The intended data license.

This field is only applicable if the Restriction Status field is set to Unrestricted or Partially Restricted.

Example:

<data-access>
    <data-license>CC0-1.0</data-license>
</data-access>

Field: data-access-providers

InPort Label: Data Access Providers
Optional.
Max Length: 500 characters.

The party or parties providing access to the data.

This field is only applicable if the Restriction Status field is set to Unrestricted or Partially Restricted.

Example:

<data-access>
    <data-access-providers>Data Access Provider example.</data-access-provider>
</data-access>

Subsection: data-access-methods

InPort Label: Data Access Methods
Optional.

The method(s) by which data will be accessed.

Each Data Access Method should appear within its own <data-access-method> node under the enclosing <data-access-methods> node.

Example:

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

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

Example:

<data-access-methods mode="replace">
    <data-access-method>
    ...
    </data-access-method>
    <data-access-method>
    ...
    </data-access-method>
</data-access-methods>

Back to Table of Contents

Field: data-access-method

InPort Label: Data Access Method
Optional.

The location where data will be archived long-term.

The value must be one of the following:

  • NCEI
  • Web Service
  • API
  • FTP Bulk Download
  • HTTP Bulk Download
  • Website, Web Page, or Portal
  • Asynchronous Ordering Service
  • To Be Determined
  • Unable to Provide Access

Example:

<data-access>
    <data-access-methods>
        <data-access-method>Web Service</data-access-method>
        <data-access-method>To Be Determined</data-access-method>
    </data-access-methods>
    <no-access-explanation>No Access explanation.</no-access-explanation>
</data-access>

Field: no-access-explanation

InPort Label: No Access Explanation
Optional.
Max Length: 1000 characters.

Explanation of why data access cannot be provided, or is to be determined at this time.

This field is only applicable if one or more Data Access Methods is set to "To Be Determined" or "Unable to Provide Access".

Example:

<data-access>
    <data-access-methods>
        <data-access-method>Web Service</data-access-method>
        <data-access-method>To Be Determined</data-access-method>
    </data-access-methods>
    <no-access-explanation>No Access explanation.</no-access-explanation>
</data-access>

Field: cloud-access

InPort Label: Cloud Access
Optional.

Indication of whether the data will be accessible via a cloud provider.

The value must be one of the following:

  • Yes
  • No
  • To Be Determined

Example:

<data-access>
    <cloud-access>Yes</cloud-access>
</data-access>

Field: access-level-of-service

InPort Label: Access Level of Service
Optional.

The intended level of service for data access.

The value must be one of the following:

  • Basic Access
  • Long Term Preservation and Basic Access
  • Enhanced Access and Basic Quality Assurance
  • Scientific Improvements
  • Derived Products
  • Authoritative Records
  • National Services and International Leadership

Example:

<data-access>
    <access-level-of-service>Basic Access</access-level-of-service>
</data-access>

Subsection: dissemination-plans

InPort Label: Dissemination Plans
Optional.

The intended schedule for data dissemination.

Each Dissemination Plan should appear within its own <dissemination-plan> node under the enclosing <dissemination-plans> node.

Example:

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

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

Example:

<dissemination-plans mode="replace">
    <dissemination-plan>
    ...
    </dissemination-plan>
    <dissemination-plan>
    ...
    </dissemination-plan>
</dissemination-plans>

Back to Table of Contents

Field: dissemination-plan

InPort Label: Dissemination Plan
Optional.

The intended plan for data dissemination.

The value must be one of the following:

  • No Delay
  • At Publication
  • 2 Years After Collection
  • 2 Years After Project End Date
  • To Be Determined
  • Unable to Provide Access
  • Limited Access Only
  • No Access Intended

Example:

<data-access>
    <dissemination-plans>
        <dissemination-plan>At Publication</dissemination-plan>
        <dissemination-plan>Limited Access</dissemination-plan>
    </dissemination-plans>
    <dissemination-date>2020-01-02</dissemination-date>
</data-access>

Field: dissemination-date

InPort Label: Dissemination Date
Optional.

The date when data will be made accessible.

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

Example:

<data-access>
    <dissemination-plans>
        <dissemination-plan>At Publication</dissemination-plan>
        <dissemination-plan>Limited Access</dissemination-plan>
    </dissemination-plans>
    <dissemination-date>2020-01-02</dissemination-date>
</data-access>

Subsection: data-dois

InPort Label: Data DOIs
Optional.

Link(s) to DOIs for the data.

Each Data DOI should appear within its own <data-doi-link> node under the enclosing <data-dois> node.

Example:

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

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

Example:

<data-dois mode="replace">
    <data-doi-link>
    ...
    </data-doi-link>
    <data-doi-link>
    ...
    </data-doi-link>
</data-dois>

Back to Table of Contents

Field: url

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

Specifies the URL of the Data DOI.

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

Example:

<data-access>
    <data-dois>
        <data-doi-link>
            <url>https://my.url/</url>
            <relationship>Relationship example.</relationship>
        </data-doi-link>
    </data-dois>
</data-access>

Field: relationship

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

A description of the linked Data DOI and its relationship to this DMP.

Example:

<data-access>
    <data-dois>
        <data-doi-link>
            <url>https://my.url/</url>
            <relationship>Relationship example.</relationship>
        </data-doi-link>
    </data-dois>
</data-access>

Section: long-term-preservation

InPort Label: Long-Term Preservation
Optional.

Information on archival (long-term preservation) of the data.

Example:

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

Back to Table of Contents

Subsection: archive-locations

InPort Label: Archive Locations
Optional.

The location(s) where data will be archived long-term.

Each Archive Location should appear within its own <archive-location> node under the enclosing <archive-locations> node.

Example:

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

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

Example:

<archive-locations mode="replace">
    <archive-location>
    ...
    </archive-location>
    <archive-location>
    ...
    </archive-location>
</archive-locations>

Back to Table of Contents

Field: archive-location

InPort Label: Archive Location
Optional.

The location where data will be archived long-term.

The value must be one of the following:

  • NCEI
  • Other Approved Federal Archive
  • NARA
  • To Be Determined
  • Unable to Archive
  • No Archiving Intended

Example:

<long-term-preservation>
    <archive-locations>
        <archive-location>Other Approved Federal Archive</archive-location>
        <archive-location>To Be Determined</archive-location>
    </archive-locations>
</long-term-preservation>

Field: other-archive

InPort Label: Other Approved Federal Archive
Optional.
Max Length: 250 characters.

The name of the federally approved archive, if not NCEI.

This field is only applicable if an Archive Location is specified as "Other Approved Federal Archive".

Example:

<long-term-preservation>
    <archive-locations>
        <archive-location>Other Approved Federal Archive</archive-location>
    </archive-locations>
    <other-archive>Zenodo</other-archive>
    <other-archive-explanation>Other Archive explanation.</other-archive-explanation>
</long-term-preservation>

Field: other-archive-explanation

InPort Label: Other Archive Explanation
Optional.
Max Length: 1000 characters.

Explanation of why the data will not be archived at NCEI (e.g. data out-of-scope for NCEI, appraisal failed, preferred community of practice, cost considerations, technical considerations, etc.).

This field is only applicable if an Archive Location is specified other than "NCEI".

Example:

<long-term-preservation>
    <archive-locations>
        <archive-location>Other Approved Federal Archive</archive-location>
    </archive-locations>
    <other-archive>Zenodo</other-archive>
    <other-archive-explanation>Other Archive explanation.</other-archive-explanation>
</long-term-preservation>

Field: no-archive-explanation

InPort Label: No Archive Explanation
Optional.
Max Length: 1000 characters.

Explanation of why archival is not possible, not intended, or still to be determined.

This field is only applicable when one or more of the Archive Locations is "To Be Determined", "Unable to Archive" or "No Archiving Intended".

Example:

<long-term-preservation>
    <archive-locations>
        <archive-location>Unable to Archive</archive-location>
    </archive-locations>
    <no-archive-explanation>No Archive explanation.</no-archive-explanation>
</long-term-preservation>

Section: comments

InPort Label: Additional Comments or Questions
Optional.

Additional comments or questions on the DMP for the ACDO.

Example:

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

Back to Table of Contents

Field: comment

InPort Label: Additional Comments or Questions
Optional.
Max Length: 4000 characters.

Additional comments or questions for the ACDO.

Example:

<comments>
    <comment>Example comment.</comment>
</comments>

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.

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-last-review-date

InPort Label: Metadata Last Review Date
Optional.

Specifies the last 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).

The date for this field cannot be set in the future.

Example:

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

Field: metadata-review-frequency

InPort Label: Metadata Review Frequency
Required.

Specifies the frequency in years that the Catalog Item is reviewed.

The value must be one of the following:

  • 1 Year
  • 2 Years
  • 3 Years

Example:

<catalog-details>
    <metadata-review-frequency>1 Year</metadata-review-frequency>
</catalog-details>

Subsection: tags

InPort Label: Tags
Optional.

Each Tag should appear within its own <tag> node under the enclosing <tags> node.

Example:

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

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

Example:

<tags mode="replace">
    <tag>
    ...
    </tag>
    <tag>
    ...
    </tag>
</tags>

Back to Table of Contents

Attribute: cc-id

This attribute is NOT allowed for Tags.

Field: tag

InPort Label: Tag
Required.

Specifies the tag.

Example:

<tags>
  <tag>My Tag 1</tag>
  <tag>My Tag 2</tag>
</tags>