CARIS HPD : CARIS® Batch : S-100 Processes : Edit S-100 Exchange Set : Metadata files
 

Metadata files

The metadata file used by the --file-to-add option is a user-defined XML file. The format of the metadata attributes must be in the format for the discovery metadata in the S-100 exchange catalogue.

The format is fully described in the S-101 ENC Product Specification 1.1.0 document (June 2020). For further information on dataset metadata, see clause 12.

If the dataset/support file is part of an existing S-100 exchange set, the metadata node can be copied from the exchange catalogue (CATALOG.XML) and the required namespaces can be added to the root node or created manually, perhaps from a sample file.

Sample dataset metadata

If the new file is a dataset file, the metadata must be in the format defined by S100_DatasetDiscoveryMetadata.

This sample file shows selected metadata. You do not need to include entries that do not apply.

<?xml version="1.0" encoding="UTF-8"?>

<XC:S100_DatasetDiscoveryMetadata xmlns:XC="http://www.iho.int/s100/xc/5.0" xmlns:mmi="http://standards.iso.org/iso/19115/-3/mmi/1.0" xmlns:mcc="http://standards.iso.org/iso/19115/-3/mcc/1.0" xmlns:cit="http://standards.iso.org/iso/19115/-3/cit/2.0" xmlns:gco="http://standards.iso.org/iso/19115/-3/gco/1.0" xmlns:gex="http://standards.iso.org/iso/19115/-3/gex/1.0" xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:lan="http://standards.iso.org/iso/19115/-3/lan/1.0" xmlns:mco="http://standards.iso.org/iso/19115/-3/mco/1.0" xmlns:mri="http://standards.iso.org/iso/19115/-3/mri/1.0">

  <XC:description>

   <gco:CharacterString>test desc</gco:CharacterString>

  </XC:description>

  <XC:datasetID>urn:mrn:iho:ca</XC:datasetID>

  <XC:compressionFlag>true</XC:compressionFlag>

  <XC:dataProtection>false</XC:dataProtection>

  <XC:protectionScheme>S100p15</XC:protectionScheme>

  <XC:copyright>true</XC:copyright>

  <XC:classification gco:isoType="mco:MD_ClassificationCode">

   <mco:MD_ClassificationCode codeList="http://standards.iso.org/iso/19115/resources/Codelists/cat/codelists.xml#MD_ClassificationCode" codeListValue="secret">secret</mco:MD_ClassificationCode>

  </XC:classification>

  <XC:purpose>newDataset</XC:purpose>

  <XC:notForNavigation>true</XC:notForNavigation>

  <XC:specificUsage>

   <mri:MD_Usage>

    <mri:specificUsage>

     <gco:CharacterString>Transit</gco:CharacterString>

    </mri:specificUsage>

   </mri:MD_Usage>

  </XC:specificUsage>

  <XC:editionNumber>1</XC:editionNumber>

  <XC:updateNumber>0</XC:updateNumber>

  <XC:updateApplicationDate>2022-08-16</XC:updateApplicationDate>

  <XC:issueDate>2022-08-16</XC:issueDate>

  <XC:issueTime>08:00:00</XC:issueTime>

  <XC:temporalExtent>

   <XC:timeInstantBegin>2022-07-11T00:00:00Z</XC:timeInstantBegin>

   <XC:timeInstantEnd>2022-08-11T00:00:00Z</XC:timeInstantEnd>

  </XC:temporalExtent>

  <XC:productSpecification>

   <XC:name>S-101</XC:name>

   <XC:version>010100</XC:version>

   <XC:date>2022-07-12</XC:date>

   <XC:productIdentifier>S-101</XC:productIdentifier>

   <XC:number>101</XC:number>

   <XC:compliancyCategory>category4</XC:compliancyCategory>

  </XC:productSpecification>

  <XC:producingAgency>

   <cit:CI_Responsibility>

    <cit:role>

     <cit:CI_RoleCode codeList="http://standards.iso.org/iso/19115/resources/Codelists/cat/codelists.xml#CI_RoleCode" codeListValue="author">author</cit:CI_RoleCode>

    </cit:role>

    <cit:extent>

     <gex:EX_Extent>

      <gex:description>

       <gco:CharacterString>test extent</gco:CharacterString>

      </gex:description>

     </gex:EX_Extent>

    </cit:extent>

    <cit:party>

     <cit:CI_Organisation>

      <cit:name>

       <gco:CharacterString>caris</gco:CharacterString>

      </cit:name>

      <cit:contactInfo>

       <cit:CI_Contact>

        <cit:phone>

         <cit:CI_Telephone>

          <cit:number>

           <gco:CharacterString>506-111-2222</gco:CharacterString>

          </cit:number>

          <cit:numberType>

           <cit:CI_TelephoneTypeCode codeList="http://standards.iso.org/iso/19115/resources/Codelist/cat/codelists.xml#CI_TelephoneTypeCode" codeListValue="fax">fax</cit:CI_TelephoneTypeCode>

          </cit:numberType>

         </cit:CI_Telephone>

        </cit:phone>

        <cit:address>

         <cit:CI_Address>

          <cit:deliveryPoint>

           <gco:CharacterString>11 First St</gco:CharacterString>

          </cit:deliveryPoint>

          <cit:city>

           <gco:CharacterString>Toronto</gco:CharacterString>

          </cit:city>

          <cit:administrativeArea>

           <gco:CharacterString>ON</gco:CharacterString>

          </cit:administrativeArea>

          <cit:postalCode>

           <gco:CharacterString>A1A 1A1</gco:CharacterString>

          </cit:postalCode>

          <cit:country>

           <gco:CharacterString>Canada</gco:CharacterString>

          </cit:country>

          <cit:electronicMailAddress>

           <gco:CharacterString>email@caris.com</gco:CharacterString>

          </cit:electronicMailAddress>

         </cit:CI_Address>

        </cit:address>

        <cit:onlineResource>

         <cit:CI_OnlineResource>

          <cit:linkage>

           <gco:CharacterString>test link</gco:CharacterString>

          </cit:linkage>

          <cit:protocol>

           <gco:CharacterString>test protocol</gco:CharacterString>

          </cit:protocol>

          <cit:applicationProfile>

           <gco:CharacterString>test profile</gco:CharacterString>

          </cit:applicationProfile>

          <cit:name>

           <gco:CharacterString>test name</gco:CharacterString>

          </cit:name>

          <cit:description>

           <gco:CharacterString>test desc</gco:CharacterString>

          </cit:description>

          <cit:function>

           <cit:CI_OnLineFunctionCode codeList="http://standards.iso.org/iso/19115/resources/Codelist/cat/codelists.xml#CI_DateTypeCode" codeListValue="browsing">browsing</cit:CI_OnLineFunctionCode>

          </cit:function>

          <cit:protocolRequest>

           <gco:CharacterString>browsing</gco:CharacterString>

          </cit:protocolRequest>

         </cit:CI_OnlineResource>

        </cit:onlineResource>

        <cit:hoursOfService>

         <gco:CharacterString>9-5</gco:CharacterString>

        </cit:hoursOfService>

        <cit:contactInstructions>

         <gco:CharacterString>test contact inst</gco:CharacterString>

        </cit:contactInstructions>

        <cit:contactType>

         <gco:CharacterString>test type</gco:CharacterString>

        </cit:contactType>

       </cit:CI_Contact>

      </cit:contactInfo>

      <cit:logo>

       <mcc:MD_BrowseGraphic>

        <mcc:fileName>

         <gco:CharacterString>logo name</gco:CharacterString>

        </mcc:fileName>

        <mcc:fileDescription>

         <gco:CharacterString>desc</gco:CharacterString>

        </mcc:fileDescription>

        <mcc:fileType>

         <gco:CharacterString>type</gco:CharacterString>

        </mcc:fileType>

       </mcc:MD_BrowseGraphic>

      </cit:logo>

     </cit:CI_Organisation>

    </cit:party>

   </cit:CI_Responsibility>

  </XC:producingAgency>

  <XC:producerCode>1C</XC:producerCode>

  <XC:encodingFormat>ISO/IEC 8211</XC:encodingFormat>

  <XC:dataCoverage>

   <XC:boundingPolygon gco:isoType="gex:EX_BoundingPolygon">

    <gex:polygon>

     <gml:LineString gml:id="DC1_1011C00ALL" srsName="urn:ogc:def:crs:EPSG::4326">

      <gml:posList> 22.0000000 22.0000000 33.0000000 22.0000000 33.0000000 44.0000000 22.0000000 44.0000000 22.0000000 22.0000000</gml:posList>

     </gml:LineString>

    </gex:polygon>

   </XC:boundingPolygon>

   <XC:optimumDisplayScale>5050</XC:optimumDisplayScale>

   <XC:maximumDisplayScale>100</XC:maximumDisplayScale>

   <XC:minimumDisplayScale>10000</XC:minimumDisplayScale>

  </XC:dataCoverage>

  <XC:comment>

   <gco:CharacterString>test</gco:CharacterString>

  </XC:comment>

  <XC:defaultLocale>

   <lan:PT_Locale>

    <lan:language>

     <lan:LanguageCode codeList="http://www.iho.int/S100/4.0.0/resources/Codelists/cat/codelists.xml#S100_MD_LanguageCode" codeListValue="eng">eng</lan:LanguageCode>

    </lan:language>

    <lan:characterEncoding>

     <lan:MD_CharacterSetCode codeList="http://www.iho.int/S100/4.0.0/resources/Codelists/cat/codelists.xml#S100_MD_CharacterSetCode" codeListValue="utf-8">utf-8</lan:MD_CharacterSetCode>

    </lan:characterEncoding>

   </lan:PT_Locale>

  </XC:defaultLocale>

  <XC:otherLocale>

   <lan:PT_Locale>

    <lan:language>

     <lan:LanguageCode codeList="http://www.iho.int/S100/4.0.0/resources/Codelists/cat/codelists.xml#S100_MD_LanguageCode" codeListValue="fre">fre</lan:LanguageCode>

    </lan:language>

    <lan:characterEncoding>

     <lan:MD_CharacterSetCode codeList="http://www.iho.int/S100/4.0.0/resources/Codelists/cat/codelists.xml#S100_MD_CharacterSetCode" codeListValue="utf-8">utf-8</lan:MD_CharacterSetCode>

    </lan:characterEncoding>

   </lan:PT_Locale>

  </XC:otherLocale>

  <XC:metadataPointOfContact>

   <cit:CI_Responsibility>

    <cit:role>

     <cit:CI_RoleCode codeList="http://standards.iso.org/iso/19115/resources/Codelists/cat/codelists.xml#CI_RoleCode" codeListValue="custodian">custodian</cit:CI_RoleCode>

    </cit:role>

    <cit:extent>

     <gex:EX_Extent>

      <gex:description>

       <gco:CharacterString>test ext</gco:CharacterString>

      </gex:description>

     </gex:EX_Extent>

    </cit:extent>

    <cit:party>

     <cit:CI_Organisation>

      <cit:name>

       <gco:CharacterString>caris</gco:CharacterString>

      </cit:name>

     </cit:CI_Organisation>

    </cit:party>

   </cit:CI_Responsibility>

  </XC:metadataPointOfContact>

  <XC:metadataDateStamp>2022-08-16</XC:metadataDateStamp>

  <XC:replacedData>true</XC:replacedData>

  <XC:navigationPurpose>overview</XC:navigationPurpose>

  <XC:resourceMaintenance>

   <mmi:MD_MaintenanceInformation>

    <mmi:maintenanceAndUpdateFrequency>

     <mmi:MD_MaintenanceFrequencyCode codeList="" codeListValue="asNeeded">asNeeded</mmi:MD_MaintenanceFrequencyCode>

    </mmi:maintenanceAndUpdateFrequency>

    <mmi:maintenanceDate>

     <cit:CI_Date>

      <cit:date>

       <gco:DateTime>2022-07-11T00:00:00Z</gco:DateTime>

      </cit:date>

      <cit:dateType>

       <cit:CI_DateTypeCode codeList="http://standards.iso.org/iso/19115/resources/Codelist/cat/codelists.xml#CI_DateTypeCode" codeListValue="nextUpdate">nextUpdate</cit:CI_DateTypeCode>

      </cit:dateType>

     </cit:CI_Date>

    </mmi:maintenanceDate>

    <mmi:userDefinedMaintenanceFrequency>

     <gco:TM_PeriodDuration>PT06H</gco:TM_PeriodDuration>

    </mmi:userDefinedMaintenanceFrequency>

   </mmi:MD_MaintenanceInformation>

  </XC:resourceMaintenance>

</XC:S100_DatasetDiscoveryMetadata>

Sample support file metadata

If the new file is a support file, the metadata is expected to be in the format defined by S100_SupportFileDiscoveryMetadata.

This is an example of a metadata file for a support file.

<?xml version="1.0" encoding="UTF-8"?>

<XC:S100_SupportFileDiscoveryMetadata xmlns:XC="http://www.iho.int/s100/xc/5.0" xmlns:gco="http://standards.iso.org/iso/19115/-3/gco/1.0" xmlns:lan="http://standards.iso.org/iso/19115/-3/lan/1.0">

  <XC:revisionStatus>new</XC:revisionStatus>

  <XC:editionNumber>1</XC:editionNumber>

  <XC:issueDate>2022-08-23</XC:issueDate>

  <XC:compressionFlag>false</XC:compressionFlag>

  <XC:resourcePurpose>dataset</XC:resourcePurpose>

</XC:S100_SupportFileDiscoveryMetadata>