Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Create schema file An xsd schema file must be created to define the new schema. These are generally placed in a folder named gisSchemas in the root directory of the defining plugin. The xsd file must define the fields of the new schema. See the maeviz-bridgeDamage_1.0.xsd in the ncsa.maeviz plugin for an example. As in the example, the field names must be prefixed with "maeviz." Also, the main part of the field name (after the maeviz prefix) must be 10 characters or less. The primitive type of the field (double, string, etc) must also be correctly specified.
  2. Add Schema extension point The extension point ncsa.gis.gisSchemas must be extended to define the schema.

    field

    description

    id

    The id of the schema

    name

    A friendly name for the schema

    version

    A version identifier for the schema.

    type

    A short type name for the schema

    description

    A user-friendly description of the schema

    file

    The schema file defined in the previous step

    format

    The format of the schema. Predefined formats include: shapefile,fragility,mapping, raster, and table. If other formats are desired, they must be defined, which is outside the scope of this document

    requiredFields

    The list of fields that are required as a minimum for this schema. These will be prompted to map to during ingestion

    mapLayer

    For shapefiles, the suggested smart layering position in the map. Should be between 1 and 100, where lower numbers appear above lower numbers. A mapLayer of -1 indicates that the dataset should be invisible by default

    category

    A category name for the schema. Categories determine what subfolders the schemas appear in the repository view.

  3. Add field metadata An xml file should be created to define field-specific metadata for the schema. These files should be placed in a folder named gisMetadata that sits parallel to the gisSchemas folder. Files in here should have the same name as their corresponding schema xsd file, except with xsd renamed to xml. Each field should be defined using a column-metadata element with the following attributes:

    attribute

    description

    required?

    column-id

    The id to match the column id from the xsd file. Should not include the maeviz. prefix.

    Y

    friendly-name

    A friendly name for the field