CARIS HPD : S-57 Composer : Custom Product Example : Create Product Dictionary
 

Create Product Dictionary

The product dictionary is an XML file that defines available features and attributes. It is used in conjunction with the profile to form a product catalogue.

You should create a separate dictionary with its own file name then add specific features and attributes. You can use an existing dictionary and rename it or create a new dictionary.

The following guidelines should be followed:

The feature or attribute acronym must be unique. This applies not only to S-57 Composer, but worldwide. See the International Hydrographic Organization (IHO) Registry to view existing feature and attributes.

The feature or attribute acronym should be six characters long. This reduces compatibility issues with other software applications that can view the product file.

The ExternalID and ID attributes are currently not used, but it is recommended that you specify a unique ID for both to match the ID entered in the object lookup table.

The Name, Description, References and Remarks attributes are not mandatory and can consist of any text, though they are not of unlimited size.

The Type attribute is for administrative purposes only. It makes it easier to separate types of object classes but is not exported to the S-57 file.

The <ExpectedValues> and <ExpectedValue> tags are used only if the values are an enumerated or numbered list.

The example MIO contains two features as listed here:

Feature Acronym

Description

Type

crlref

Coral Reef

Point, line, area

mpaare

Marine Protected Area

Point, line, area

The example MIO contains the following attributes:

Attribute Acronym

Description

Type

density

Biologic cover density

List

bndcit

Boundary citation

String

catiuc

Category of IUCN protected area

List

catref

Category of reef

Enumeration

crlzne

Coral ecological zone

Enumeration

biocov

Ecosystem biological zone

List

geostr

Reef geomorphological structures

Enumeration

confcs

Conservation focus

List

consty

Constancy of protection

Enumeration

contct

Contact information

String

ecoscl

Ecological scale of protection

Enumeration

lglmnd

Legal mandate

String

levprt

Level of protection afforded to resources

Enumeration

manage

Management entity

String

perman

Permanence of protection

Enumeration

purpos

Purpose of marine management area

String

regcit

Regulations citation

String

websit

Websites

String

The attribute entries must correspond to the structure of the product dictionary. This is an example of an entry for a biocov attribute class:

<AttributeClass Acronym="biocov" ID="38" Type="LIST">

  <Name>Coral Ecosystem Biological Cover</Name>

  <Description></Description>

  <References>not specified;</References>

  <Remarks></Remarks>

  <DisplayFormat>XX</DisplayFormat>

  <ExpectedValues>

    <ExpectedValue Value="0" Description="-" />

    <ExpectedValue Value="1" Description="Live Coral" />

    <ExpectedValue Value="2" Description="Mollusk reef" />

    <ExpectedValue Value="3" Description="Annelid reef" />

    <ExpectedValue Value="6" Description="Seagrass" />

    <ExpectedValue Value="7" Description="Macroalgae" />

    <ExpectedValue Value="8" Description="Coralline Algae" />

    <ExpectedValue Value="9" Description="Turf Algae" />

    <ExpectedValue Value="10" Description="Uncolonized" />

    <ExpectedValue Value="11" Description="Unknown" />

    <ExpectedValue Value="12" Description="Unclassified" />

  </ExpectedValues>

</AttributeClass>

The feature entries must also correspond to the structure of the product dictionary. This is example of an feature class entry for the crlref feature.

<ObjectClass Acronym="crlref" ID="1" Type="GEOGRAPHIC">

  <Name>Coral Reef</Name>

  <Description>Definition: reef (general) - A mass of rock or coral

  which either reaches close to the sea surface or is exposed at

  low tide, posing a hazard to navigation. (IHO Dictionary, S-32,

  5th Edition)

  Coral reef - A reef, often of large extent, composed

  chiefly of coral and its derivatives. (IHO Dictionary, S-32,

  5th Edition)

  </Description>

  <References>not specified;</References>

  <Remarks>Remarks: </Remarks>

</ObjectClass>

When you are finished, save the file to C:\Program Files\CARIS\HPD\<version<\system\S57Config\system.