Collection and extended metadata XML schema (Bathymetry Solution)
Collection and extended metadata XML schemas are almost identical. However, by using the Collection feature of ArcGIS for Maritime:Bathymetry, you have the ability to manage groups of bathymetric surfaces with common metadata attributes. The examples below show the root element, which is the highest-level node within the XML file for both the BisCollectionExtMetadataDef.xml (collection metadata) and the BisDatasetExtMetadataDef.xml (extended metadata) files.
While the information in this topic is useful to understanding your BIS metadata configuration, manual modification of the XML schema files is only recommended for advanced users of the BIS who are familiar with editing XML schemas. For most use cases, comprehensive editing functionality is provided by the Collection Metadata Configuration Editor or the Extended Metadata Configuration Editor dialog box accessible through the Manage BIS Settings dialog box.
Collection metadata
<BisExtXmlMetadataDefinition metadataType="BisCollectionExt" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<BisExtXmlMetadataDefinitionFields>
Extended metadata
<BisExtXmlMetadataDefinition metadataType="BisDatasetExt" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<BisExtXmlMetadataDefinitionFields>
The only difference between these two root elements is the metadataType attribute value: the Extended metadata type is BisDatasetExt, while the Collection metadata type is BisCollectionExt. If you need to modify the metadata XML files, you must not alter the metadataType values since these values determine the metadata field display for the applicable dialog box or window.
Modifying your XML schema outside of the Collection Metadata Configuration Editor or Extended Metadata Configuration Editor can introduce errors, which can corrupt your BIS and temporarily invalidate much of your metadata. For this reason, it is highly recommended that you make a back-up copy of your metadata and always use an XML editing application that has built-in validation checks whenever modifying the schema directly.
Outside of the root element, the collection and extended XML schemas are the same.
The example below shows a breakdown of the element hierarchy in both the collection and extended metadata XML configuration files.
<BisExtXmlMetadataDefinition metadataType="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<BisExtXmlMetadataDefinitionFields>
<BisExtXmlMetadataDefinitionField xmlNodeName=”” title=”” dataType=”” required=”” searchable=”” displayed=””>
<xmlDataRestriction restrictionType="">
</xmlDataRestriction>
</BisExtXmlMetadataDefinitionField>
</BisExtXmlMetadataDefinitionFields>
</BisExtXmlMetadataDefinition>
The following table summarizes the elements:
Element | Description |
---|---|
BisExtXmlMetadataDefinition | Root element that defines the type of metadata (collection or extended) using the metadata attribute, along with the generic namespaces for the XML schema and definition URLs. |
BisExtXmlMetadataDefinitionFields | Single parent element for the BisExtMetadataDefinitionField that stores all of the metadata field definition information. Any custom field added to the display must be stored within this element. |
BisExtXmlMetadataDefinitionField | All of the field definitions are stored within this element as attributes. If you add a new field, you will need to construct this element within the BisExtMetadataDefinitionFields parent element and include all of the attributes defined in the schema. |
xmlNodeName | A unique field identifier within the XML configuration file that should follow standard XML attribute naming conventions (no spaces, special characters, and so on). |
title | The field title that will be displayed within BIS dialog boxes and windows. |
dataType | The field’s data type. |
required | A Boolean value that determines whether or not the field is mandatory and must be populated on the dialog box or window. |
searchable | A Boolean value that determines whether or not the field will show up in the Manage Collections dialog box and the Explore Bathymetry and Compose Surface windows as a field against which you can filter or create a rule. |
displayed | A Boolean value that controls whether or not the field will be displayed in any of the dialog boxes or windows that show the metadata fields. If the required attribute is mandatory (set to true), the displayed attribute must be true as well. |
xmlDataRestriction | A single child element of the BisExtXmlMetadataDefinitionField that applies the restrictions to the data type defined in the dataType attribute on the BisExtXmlMetadataDefinitionField. This element implements the restrictionType attribute. |
restrictionType | Defines the data restriction based on the field's data type. The following is a list of each restriction type:
|