Online Resources

From NOAA Environmental Data Management Wiki

As the World Wide Web has developed into a ubiquitous information source, links to on-line information and services have become a critical element in all metadata records. As URLs have increased in complexity, it has become more important to provide supporting information along with the links. The ISO Standards use CI_OnlineResources to describe links. These include a rich set of attributes for describing on-line resources:

Structure

Online Resource
The structure of the CI_OnlineResource is shown here as Unified Modeling Language. The only required field is linkage, the URL for the resource. There are five optional elements, each of which can occur just once, that provide more information about the resource that the URL links to. The function, name, and description can provide information to the user about what will happen when they click the link (see wiki for choices for the CI_OnlineFunctionCode). The function and protocol can be used to classify the link in several ways and the applicationProfile can be used to provide information about applications that might be able to use the link automatically. See CodeLists for available function codes.

The name, description, and function attributes can be used to display helpful information along with the link. For example, the CI_OnlineResource shown below as XML can be displayed as:

More Information: NGDC Natural Hazards Image Database : NGDC maintains a collection of geologic hazards photographs, many of which are available as 35mm slide sets, as digital images on CD-ROM or on-line. Each slide set consists of 20 slides in color and/or black and white along with a separate booklet of captions.

XML

<gmd:CI_OnlineResource>
    <gmd:linkage>
        <gmd:URL>http://www.ngdc.noaa.gov/hazardimages/</gmd:URL>
    </gmd:linkage>
    <gmd:protocol>
        <gco:CharacterString>WWW:LINK-1.0-http--link</gco:CharacterString>
    </gmd:protocol>
    <gmd:applicationProfile>
        <gco:CharacterString>Web Browser</gco:CharacterString>
    </gmd:applicationProfile>
    <gmd:name>
        <gco:CharacterString>NGDC Natural Hazards Image Database</gco:CharacterString>
    </gmd:name>
    <gmd:description>
        <gco:CharacterString>NGDC maintains a collection of geologic hazards photographs,
            many of which are available as 35mm slide sets, as digital images
            on CD-ROM or on-line. Each slide set consists of 20 slides in color
            and/or black and white along with a separate booklet of
            captions.
        </gco:CharacterString>
    </gmd:description>
    <gmd:function>
        <gmd:CI_OnLineFunctionCode codeList="http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_OnLineFunctionCode"
        codeListValue="information">information</gmd:CI_OnLineFunctionCode>
    </gmd:function>
</gmd:CI_OnlineResource>

Usage

Where Are CI_OnlineResources?

Online Resource Locations
CI_OnlineResources can be connected to ISO metadata records in six places shown schematically in the Figure and in more detail below. The citation and browse graphic CI_OnlineResources were added in ISO 19115-1 (the revision of 19115). The addition of CI_OnlineResources directly into the CI_Citation class is very important. It allows direct citation of web resources which was not possible in 19115.
Usage Description and Xpath
WhereAreCI OnlineResources.Contact.png

The most common use of CI_OnlineResources in the ISO Standards is as part of a CI_ResponsibleParty object in CI_Citations. In the current standard, this is the only CI_OnlineResource associated with a CI_Citation, so it gives the location of web resources. it can also be the Home Page for the contact.

//gmd:CI_Citation/gmd:citedResponsibleParty /gmd:CI_ResponsibleParty/gmd:contactInfo/gmd:CI_Contact /gmd:onlineResource

WhereAreCI OnlineResources.Transfer.png

The CI_OnlineResource in the MD_DigitalTransferOptions is the location of digital resources distributed over the Web.

/gmi:MI_Metadata/gmd:distributionInfo/gmd:MD_Distribution/gmd:transferOptions/gmd:MD_DigitalTransferOptions/gmd:online
or
/gmi:MI_Metadata/gmd:distributionInfo/gmd:MD_Distribution/gmd:distributor/gmd:MD_Distributor/gmd:distributorTransferOptions/gmd:MD_DigitalTransferOptions/gmd:online

WhereAreCI OnlineResources.Service.png

The CI_OnlineResource in the SV_OperationMetadata is the URL for a service operation (e.g. GetCapabilities, GetMap).

/gmi:MI_Metadata/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:connectPoint/gmd:CI_OnlineResource

WhereAreCI OnlineResources.Extension.png

The CI_OnlineResource in the MD_MetadataExtensionInformation is the location of the description of extensions used in the metadata record.

/gmi:MI_Metadata/gmd:metadataExtensionInfo/gmd:MD_MetadataExtensionInformation/gmd:extensionOnlineResource

Notes

The CI_OnlineResource is one of the most simple objects included in the ISO Standards. At the same time, this simple object raises some interesting questions.

Required vs. Optional Elements

The elements in the CI_OnlineResource are relevant to the many conversations about metadata that start with a question about minimum requirements. The only required element, the linkage, carries the really critical information about the CI_OnlineResource, its location. By itself, however, this information can be difficult for a human to understand and use. This is particularly true in the common situation where many CI_OnlineResources are available for a given dataset. The name, description, and function elements provide critical additional information and allow resources to be presented to users in related groups. There are many situations in which optional fields make metadata easier for users to understand and use. Metadata with only required fields is typically difficult to use. Metadata creators should consider these applications when they make decisions about what to include in their metadata.

Community Guidance

The ISO Standards are broad and questions about how they should be used are common. Community understanding, practice and guidance play an important role in developing consistent usage. The CI_OnlineResource object, even though it is very simple, helps demonstrate this point. The protocol element is defined as “connection protocol to be used”. Examples might include http or ftp. The protocol is also included at the beginning of the URL, as in http://www.isoTC211.org. Should this URL be broken into two pieces: protocol = http and linkage = www.isoTC211.org? Should both fragments be combined in the linkage: http://www.iso.TC211.org? If they are combined, should protocol be left blank? All of these are reasonable questions and all three choices convey the same information content. Which is right?

As in the required vs. optional question discussed above, the correct answer involves usage. Including the protocol in the linkage element allows that element to be used without concatenating it together with the protocol element. The linkage can be used along with the name and description to easily form a nice package for users. At the same time, the protocol element can be used as a classifier for CI_OnlineResources to answer the question: “is this dataset available via ftp?”. So the correct answer is use both elements but don’t concatenate them together to create a link. Seems to make sense, but time, and practice, will tell.