The ESF reader returns features with the same schema for each type of XML format.
The following tables explain which XML elements are mapped to which feature attributes.
Feature Type: ESFSubmissionMetadata
- Feature is required
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| emailAddress | char(64) | Required | |
| telephoneNumber | decimal(10,0) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | |
|---|---|---|---|
| xml_type | xml_no_geom | Required |
Feature Type: RESULTSSubmissionMetadata
- Feature is required
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| districtCode | char(3) | Required | |
| clientCode | char(8) | Required | |
| clientLocationCode | char(2) | Required | |
| licenseeContact | char(50) | Required | |
| telephoneNumber | decimal(10,0) | Required | |
| emailAddress | char(64) | Required | |
| batchReferenceDate | char(10) | Required | |
| validationIndicator | boolean | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | |
|---|---|---|---|
| xml_type | xml_no_geom | Required |
Feature Type: Opening
- Feature is optional
- An Opening indicates the administrative boundary of an area of land on which silviculture activities are planned and completed
-
A submission may contain multiple openings. An Opening contains several items
Comments:
An Opening FME feature must be uniquely identified through its esf_opening_id attribute since a submission may contain zero or more Openings.
All containing items should refer to their container Opening through their esf_opening_id attribute. The possible containing items are (these are all ESF RESULTS FME feature types) :
OpeningNumberKey, TimberMarkKey, TenureKey and OpeningID (these are classified as Opening Key’s in the ESF RESULTS documentation but we will treat them as separate FME features), Disturbance, SivilcultureActivity, ForestCoverPolygon, and MilestoneDeclaration.
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type | xml_no_geom | Required | |
| esf_opening_id | some unique id | Required | Uniquely identifies the Opening within the submission. |
Feature Type: OpeningNumberKey
- Feature is optional
Comments:
Re-references its Opening container through its required esf_opening_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| mapsheetGrid | decimal(3,0) | Required | |
| mapsheetLetter | char(1) | Required | |
| mapsheetSquare | char(3) | Required | |
| mapsheetQuad | decimal(1,0) | Required | |
| mapsheetSubQuad | decimal(1,0) | Required | |
| openingNumber | char(4) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type | xml_no_geom | Required | |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
Feature Type: TimberMarkKey
- Feature is optional
Comments:
Re-references its Opening container through its required esf_opening_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| timberMark | char(6) | Required | |
| cutblock | char(10) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type | xml_no_geom | Required | |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
Feature Type: TenureKey
- Feature is optional
Comments:
Re-references its Opening container through its required esf_opening_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| licenceNumber | char(10) | Required | |
| cuttingPermitID | char(3) | Required | |
| cutblock | char(10) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
Feature Type: OpeningID
- Feature is optional
Comments:
Re-references its Opening container through its required esf_opening_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| openingID | decimal(10) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
Feature Type: OpeningDefinition
- Feature is optional
-
Required the first time an Opening is submitted, but may also be included as an update of previously submitted data. The Opening Definition provides information that defines the Opening itself. It includes spatial information, simple attributes, Tenures and Stocking Standards
Comments:
The OpeningDefinition has an esf_opening_id attribute which references its corresponding opening.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| previousStandType | char(3) | Optional | |
| previousSpecies1Code | char(4) | Optional | |
| previousSpecies2Code | char(4) | Optional | |
| previousAgeClassCode | char(1) | Optional | |
| previousHeightClassCode | char(1) | Optional | |
| previousStockClassCode | char(1) | Optional | |
| previousSiteIndex | decimal(2,0) | Optional | |
| previousSiteIndexSource | char(1) | Optional | |
| openingGrossArea | decimal(6,1) | Optional | |
| maximumAllowablePermanentAccessPercentage | decimal(3,1) | Optional | |
| sitePlanExemption | char(1) | Optional | |
| openingCategoryCode | char(7) | Optional | |
| openingLocationName | char(30) | Optional | |
| licenseeID | char(30) | Optional | |
| actionCode | char(1) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_area xml_no_geom |
Required | |
| esf_opening_definition_id | some id | Required | Must be unique across OpeningDefinitions in the submission. |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
| esf_spatial_metadata_id | some id | Optional | Reference to the spatial metadata. |
Feature Type: Tenure
- Feature is optional
Comments:
A Tenure contains a TenureKey but we don’t want to introduce an extra link for this containment.
Instead, we’ll let the FME Tenure feature type carry directly the attributes of the TenureKey, these attributes are: licenceNumber, cuttingPermitID, and cutblock (the TenureKey in a Tenure is required so we’ll make these attributes required).
Attributes:
The following are the attributes that are supposed to belong to the TenureKey, but we’ll represent them directly in our Tenure.
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| licenceNumber | char(10) | Required | |
| cuttingPermitID | char(3) | Required | |
| cutblock | char(10) | Required |
Tenure Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| primeLicenceIndicator | boolean | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_opening_definition_id | some id | Required | Must match an OpeningDefinition’s esf_opening_definition_id attribute in the submission. |
Feature Type: Standards
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| standardsUnitID | char(1) | Required | |
| netArea | decimal(6,1) | Optional | |
| bgcZone | char(4) | Optional | |
| bgcSubzone | char(3) | Optional | |
| bgcVariant | char(1) | Optional | |
| bgcPhase | char(1) | Optional | |
| bgcSiteSeries | char(2) | Optional | |
| bgcSiteType | char(2) | Optional | |
| maximumAllowableSoilDisturbancePercentage | decimal(3,1) | Optional | |
| standardsRegimeID | decimal(10,0) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_area xml_no_geom |
Required | |
| esf_opening_definition_id | some id | Required | Must match an OpeningDefinition’s esf_opening_definition_id attribute in the submission. |
| esf_spatial_metadata_id | some id | Optional | Reference to the spatial metadata. |
Feature Type: Disturbance
- Feature is optional
-
A Disturbance stores planned and actual information about a disturbance activity - it is a type of Opening Item
Comments:
A Disturbance contains an optional TenureKey but we don’t want to introduce an extra link for this containment. Instead, we’ll let the FME Disturbance feature type carry directly the attributes of the TenureKey, these attributes are: licenceNumber, cuttingPermitID, and cutblock
(The TenureKey is optional so we’ll make these attributes optional).
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| disturbanceCode | char(1) | Required | |
| silviculturalSystem | char(5) | Optional | |
| silviculturalVariant | char(3) | Optional | |
| silviculturalCutPhase | char(5) | Optional | |
| silviculturalCutPhase | char(10) | Required | |
| disturbanceCompleteDate | char(10) | Optional | |
| grossArea | decimal(6,1) | Optional | |
| harvestCompleteOnCutBlock | boolean | Optional | |
| licenseeID | char(30) | Optional | |
| actionCode | char(1) | Required |
The following attributes are from the optional tenureKey. If any of these tenureKey attributes are specified then all of them must be specified.
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| licenceNumber | char(10) | Optional | |
| cuttingPermitID | char(3) | Optional | |
| cutblock | char(10) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_area xml_no_geom |
Required | |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
| esf_spatial_metadata_id | some id | Optional | Reference to the spatial metadata. |
Feature Type: SilviculturalActivity
- Feature is optional
Comments:
A SilviculturalActivity contains 0 or more PlantingStocks. The PlantingStocks will be represented by a separate FME feature type, PlantingStock. These FME PlantingStock features will reference back their containing SilviculturalActivity feature through their esf_silvicultural_activity_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| activityBase | char(2) | Required | |
| activityTechnique | char(5) | Optional | |
| activityMethod | char(3) | Optional | |
| objective1 | char(3) | Optional | |
| objective2 | char(3) | Optional | |
| objective3 | char(3) | Optional | |
| fundingSource | char(3) | Optional | |
| fundingProject | char(10) | Optional | |
| actualDateIndicator | boolean | Optional | |
| activityDate | char(10) | Optional | |
| netAreaTreated | decimal(6,1) | Optional | |
| licenseeID | char(30) | Optional | |
| actionCode | char(1) | Required |
The PlantingStock attributes will be linked back to this feature through their esf_silvicultural_activity_id.
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_area xml_no_geom |
Required | |
| esf_silvicultural_activity_id | some id | Required | Must be unique across SilviculturalActivity(s) in the submission. |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
| esf_spatial_metadata_id | some id | Optional | Reference to the spatial metadata. |
Feature Type: PlantingStock
- This FME feature references a FME SilviculturalActivity feature. It is contained in the SilviculturalActivity feature
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| seedlot-Veglot | char(5) | Required | |
| species | char(4) | Required | |
| numberPlanted | decimal(7,0) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_silvicultural_activity_id | some id | Required | Must match a SilviculturalActivity’s esf_silvicultural_activity_id attribute in the submission. |
Feature Type: ForestCoverPolygon
- Feature is optional
Comments:
FME ForestCoverPolygon, Layer, TreeSpecies, and DamageAgent containment representation: The ForestCoverPolygon feature will contain an esf_forest_cover_polygon_id attribute that uniquely identifies it in the submission.
A ForestCoverPolygon may contain 0 or more Layers. Each Layer feature will refer to its corresponding container through its esf_forest_cover_polygon_id attribute. Additionally, each Layer feature will carry an esf_layer_id attribute since a Layer may have a list of TreeSpecies and/or a list of DamageAgent(s). Each TreeSpecies and DamageAgent will be represented by separate FME features,mainly, TreeSpecies and DamageAgent, respectively. Each FME TreeSpecies and DamageAgent will refer to their corresponding (container) through their esf_layer_id attribute.
A ForestCoverPolygon may contain 0 or more NonMappableComponents. Each NonMappableComponent feature will refer to its corresponding ForestCoverPolygon container through its esf_forest_cover_polygon_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| standardsUnitID | char(1) | Optional | |
| licenseeID | char(30) | Optional | |
| area | decimal(6,1) | Optional | |
| referenceYear | char(4) | Optional | |
| reserveTypeCode | char(1) | Optional | |
| reserveObjectiveCode | char(3) | Optional | |
| siteIndex | decimal(2,0) | Optional | |
| siteIndexSource | char(1) | Optional | |
| treeCoverPattern | char(1) | Optional | |
| re-entryYear | char(4) | Optional | |
| stockingStatus | char(3) | Optional | |
| stockingType | char(3) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_area xml_no_geom |
Required | |
| esf_forest_cover_polygon_id | some id | Required | Must be unique across ForestCoverPolygon(s) in the submission. |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
| esf_spatial_metadata_id | some id | Optional | Reference to the spatial metadata. |
Feature Type: Layer
- Feature is optional. It must reference back a ForestCoverPolygon through its esf_forest_cover_polygon_id attribute
Comments:
TreeSpecies and DamageAgent features will reference back their “containing” Layer features through their esf_layer_id attribute.
A Layer feature references its “containing” ForestCoverPolygon feature through its esf_forest_cover_polygon_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| layerCode | char(2) | Required | |
| crownClosure | decimal(3,0) | Optional | |
| totalStems | decimal(6,0) | Optional | |
| totalWellSpaced | decimal(6,0) | Optional | |
| wellSpaced | decimal(6,0) | Optional | |
| freeGrowing | decimal(6,0) | Optional | |
| basalArea | decimal(3,0) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_layer_id | some id | Required | Must be unique across Layer(s) in the submission. |
| esf_forest_cover_polygon_id | some id | Required | Must match a ForestCoverPolygon’s esf_forest_cover_poylgon_id attribute in the submission. |
Feature Type: TreeSpecies
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| speciesCode | char(4) | Required | |
| speciesPercent | decimal(3,0) | Optional | |
| averageAge | decimal(3,0) | Optional | |
| averageHeight | decimal(3,1) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_layer_id | some id | Required | Must match a Layer’s esf_layer_id attribute in the submission. |
Feature Type: DamageAgent
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| damageAgentCode | char(3) | Required | |
| incidencePercent | decimal(3,0) | Optional | |
| incidenceArea | decimal(6,1) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_layer_id | some id | Required | Must match a Layer’s esf_layer_id attribute in the submission. |
Feature Type: NonMappableComponent
- Feature is optional. It must reference back a ForestCoverPolygon through its esf_forest_cover_polygon_id attribute.
Comments:
A NonMappableComponent feature references its “containing” ForestCoverPolygon feature through its esf_forest_cover_polygon_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| nmcID | char(3) | Required | |
| stockingStatus | char(3) | Required | |
| stockingType | char(3) | Optional | |
| nmcArea | decimal(6,1) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_forest_cover_polygon_id | some id | Required | Must match a ForestCoverPolygon’s esf_forest_cover_poylgon_id attribute in the submission. |
Feature Type: MilestoneDeclaration
- Feature is optional
Comments:
References its Opening container through its required esf_opening_id attribute.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| standardsUnitID | char(1) | Required | |
| milestoneType | char(2) | Required | |
| declarationDate | char(10) | Required | |
| comment | char(2000) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_opening_id | some id | Required | Must match an Opening’s esf_opening_id attribute in the submission. |
Feature Type: SpatialMetaData
Comments:
A search through the actual XML Schema files reveals that the components that allow for spatial metadata are (listed in the form of FME ESF feature types): OpeningDefinition, Disturbance, StockingStandard, SilvicultureActivity, and the ForestCoverPolygon.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| dataSourceCode | char(15) | Optional | |
| captureMethodCode | char(29) | Optional | |
| observationDate | char(10) | Optional | |
| dataQualityComment | char(2000) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_no_geom |
Required | |
| esf_spatial_metadata_id | some id | Required | The id must be unique across the SpatialMetadatas across a submission. |