NIEM XML follows a regular, well-defined syntax. Snippets can be used to quickly and consistently fill in the basic syntax, leaving users to fill in the blank or partially-filled in fields.
{:toc}
- TOC
{:.note}
Snippets may include some commonly-used default values but these may be modified as necessary. Change default values if needed as the snippet is used, or edit the snippet template itself to fill in better default values for your particular requirements.
The following snippets provide template for various kinds of NIEM properties.
| Label | Description | Example pattern | Info |
|---|---|---|---|
| niem-elt | NIEM element | ag:AgricultureProductionPlan | Info |
| niem-elt-abstract | NIEM abstract element | st:RoadwayGradeAbstract | Info |
| niem-elt-augPoint | NIEM augmentation point element (abstract) | ip:SectorAugmentationPoint | Info |
| niem-elt-substitution | NIEM substitutable element | st:RoadwayGradeCode | Info |
| niem-attribute | NIEM attribute | mo:codespaceID | Info |
The following snippets provide templates for various kinds of NIEM types.
| Label | Description | Example pattern | Info |
|---|---|---|---|
| niem-type-object | NIEM object type (has sub-properties) |
ip:SectorType | Info |
| niem-type-csc | NIEM complex type with simple content (has a value and attributes) |
st:MedianCategoryCodeType | Info |
| niem-type-simple | NIEM simple type (has a value) |
mo:MGRSCoordinateStringSimpleType | Info |
| niem-type-enum | NIEM simple type with enumerations (has a value from a given set of codes) | st:MedianCategoryCodeSimpleType | Info |
| niem-type-list | NIEM simple list type (has a space-separated list of values) |
nc:IntegerListSimpleType | Info |
| niem-type-union | NIEM simple union type (combines codes from multiple types) |
biom:FrictionRidgePositionCodeSimpleType | Info |
| niem-type-adapter | NIEM adapter type (wraps an element from an external standard) |
mo:WGS84EllipseType | Info |
The following snippets provide templates for two or more related NIEM components that are often built at the same time.
| Label | Description | Example pattern | Info |
|---|---|---|---|
| niem-assn-2 |
NIEM association type NIEM association element |
mo:AircraftTargetAssociationType mo:AircraftAssignedTargetAssociation |
Info |
| niem-assn-3 |
NIEM association type NIEM association element NIEM association augmentation point |
mo:AircraftTargetAssociationType mo:AircraftAssignedTargetAssociation mo:AircraftTargetAssociationAugmentationPoint |
Info |
| niem-aug-2 |
NIEM augmentation type NIEM augmentation element |
it:PersonAugmentationType it:PersonAugmentation |
Info |
| niem-code-2 |
NIEM code simple type NIEM code CSC type |
st:MedianCategoryCodeSimpleType st:MedianCategoryCodeType |
Info |
| niem-code-3 |
NIEM code simple type NIEM code CSC type NIEM code element |
st:MedianCategoryCodeSimpleType st:MedianCategoryCodeType st:MedianCategoryCode |
Info |
| niem-code-4 |
NIEM code simple type NIEM code CSC type NIEM abstract element NIEM substitutable code element |
mo:SignalDirectionCodeSimpleType mo:SignalDirectionCodeType mo:SignalDirectionAbstract mo:SignalDirectionCode |
Info |
| niem-metadata-2 |
NIEM metadata type NIEM metadata element |
cui:DocumentMarkingMetadataType cui:DocumentMarkingMetadata |
Info |
The following snippets can be used to initialize a NIEM XML schema and includes a general template for the schema header, definition, local terminology section, and import statements.
| Label | Description | Example pattern | Info |
|---|---|---|---|
| niem-schema-4-ref | NIEM 4.0-style reference schema template (for a release schema) | Schema header for the NIEM 4.0 Intelligence domain schema | Info |
| niem-schema-4-ext | NIEM 4.0-style extension schema template (for an IEPD schema) | Info | |
| niem-schema-5-ref | NIEM 5.0-style reference schema template (for a release schema) | Schema header for the NIEM 5.0 Intelligence domain schema | Info |
| niem-schema-5-ext | NIEM 5.0-style extension schema template (for an IEPD schema) | Info |
The following snippets provide additional NIEM templates.
| Label | Description | Example pattern | Info |
|---|---|---|---|
| niem-enum | NIEM enumeration | Code "APPROVED" | Info |
| niem-import | NIEM import statement for a conformant namespace | Import NIEM Core | Info |
| niem-import-external | NIEM import statement for an external standard |
Import GML
(not a NIEM-conformant namespace) |
Info |
| niem-term-literal | NIEM local terminology described by a literal string | Local term "UTM" with literal | Info |
| niem-term-def | NIEM local terminology described by a definition | Local term "Waypoint" with definition | Info |