FTA (Forest Tenures) Schema

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

 

FME ESF Specific Attributes

Name Type/Value Optional/Required  

xml_type

xml_no_geom

Required

 

Feature Type: FTASubmissionMetadata

  • 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

 

batchReferenceDate

char(10)

Required

 

FME ESF Specific Attributes

Name Type/Value Optional/Required  

xml_type

xml_no_geom

Required

 

Feature Type: Chart

  • Feature is optional (but required if ChartBlock(s) exist)

Comments

  • Chart and ChartBlock containment FME feature simulation: A Chart may contain one or more ChartBlock(s). A Chart will be represented by an FME feature having an esf_chart_id attribute that uniquely identifies it in the submission.
  • Each ChartBlock will also be represented by a separate FME feature having an esf_chart_id attribute whose value matches the value of the esf_chart_id of the containing Chart.

Attributes

Name Type Optional/Required Description

forestFileID

char(10)

Optional

 

fileType

char(2)

Required

 

applicationDescription

char(255)

Required

 

district

char(3)

Required

 

applicationPurpose

char(1)

Required

 

managementUnitType

char(1)

Optional

 

managementUnitID

char(4)

Optional

 

chartAreaID

char(3)

Required

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_no_geom

Required

 

esf_chart_id

some unique id

Required

Uniquely identifies the Chart within the submission.

Feature Type: ChartBlock

  • Feature is usually optional, but required if a Chart feature exists. (A Chart feature must contain at least one ChartBlock.)

Attributes

Name Type Optional/Required Description

chartBlockID

char(10)

Required

 

estimatedVolume

decimal(11,4)

Required

 

referenceName

char(120)

Optional

 

bCGSMapReference

char(15)

Optional

 

applicationPurpose

char(1)

Required

 

provincialForestConflictCode

char(3)

Required

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_area

Required

 

esf_chart_id

some id

Required

Identifies the Chart container.

esf_legal_description_id

some id

Required

Reference to the legal description.

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: HarvestApplicationWithCP

  • Feature is optional

Comments

  • Used for major tenures (A file types) where the harvesting authority is defined by a cutting permit It can occur multiple times in a single submissions.
  • HarvestApplicationWithCP and CutBlockWithCP containment FME feature simulation: A HarvestApplicationWithCP may contain one or more CutBlockWithCP (s).
  • A HarvestApplicationWithCP will be represented by an FME feature having an esf_harvest_application_id attribute that uniquely identifies it in the submission.
  • Each CutBlockWithCP will also be represented by a separate FME feature having an esf_harvest_application_id attribute whose value matches the value of the esf_harvest_application_id of the containing HarvestApplicationWithCP.

Attributes

Name Type Optional/Required Description

forestFileID

char(10)

Required

 

fileType

char(3)

Optional

 

applicationDescription

char(250)

Required

 

district

char(3)

Required

 

cascadeSplitCode

char(1)

Required

 

applicationPurpose

char(1)

Required

 

tenureTerm

decimal(4,0)

Optional

 

cuttingPermitID

char(3)

Required

 

cuttingPermitName

char(120)

Optional

 

bCGSMapReference

char(15)

Optional

 

provincialForestConflictCode

char(3)

Required

 

markingInstrumentCode

char(1)

Required

 

markingMethodCode

char(1)

Required

 

deciduousIndicator

boolean

Required

 

catastrophicIndicator

boolean

Required

 

cruiseBasedIndicator

boolean

Required

 

crownGrantedIndicator

boolean

Required

 

bCTSOffice

char(3)

Optional

 

salvageIndicator

boolean

Optional

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_area

xml_no_geom

Required

Represents the extent of the HarvestApplicationWithCP. It is a single or multiPolygon.

Geometry is optional since Rev. 7.

esf_harvest_application_id

some unique id

Required

Uniquely identifies the HarvestApplicationWithCP within the submission.

Each CutBlockWithCP contained in this HarvestApplicationWithCP will need to have an esf_harvest_application_id attribute referencing the value of this attribute.

esf_legal_description_id

some id

Required

Reference to the legal description.

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: CutBlockWithCP

  • Feature is optional

Comments

  • A HarvestApplicationWithCP may contain one or more CutBlock(s). Each FME CutBlock Feature will reference its containing Harvest Application with the esf_harvest_application_id attribute.

Attributes

Name Type Optional/Required Description
cutBlockID char(10) Required  
applicationPurpose char(1) Required  
blockDescription char(120) Optional  
provincialForestConflictCode char(3) Required  
amendmentReason char(1) Optional  
plannedGrossArea decimal(11,4) Required  
plannedNetArea decimal(11,4) Required  
cruiseVolume decimal(13,2) Optional  
plannedHarvestDate char(10) Required  
managedByFile char(10) Optional  
managedByCuttingPermit char(3) Optional  
ownedByFile char(10) Optional  
ownedByCuttingPermit char(3) Optional  
ownedByBlock char(10) Optional  

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_area

xml_no_geom

Required

 

esf_harvest_application_id

some id

Required

Identifies the harvest application container.

esf_legal_description_id

some id

Required

Reference to the legal description.

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: HarvestApplicationNoCP

  • Feature is optional

Comments

  • Used for applications that don't have cutting permits. Some of these tenures have cut blocks; others do not.
  • For new applications, the file type is required.
  • HarvestApplicationNoCP and CutBlockNoCP containment FME feature simulation: A HarvestApplicationNoCP may contain one or more CutBlockNoCP(s).
  • A HarvestApplicationNoCP will be represented by an FME feature having an esf_harvest_application_id attribute that uniquely identifies it in the submission.
  • Each CutBlockNoCP will also be represented by a separate FME feature having an esf_harvest_application_id attribute whose value matches the value of the esf_harvest_application_id of the containing HarvestApplicationNoCP.

Attributes

Name Type Optional/Required Description

forestFileID

char(10)

Optional

 

fileType

char(3)

Optional

 

applicationDescription

char(255)

Required

 

district

char(3)

Required

 

cascadeSplitCode

char(1)

Required

 

managementUnitType

char(1)

Required

 

managementUnitID

char(4)

Required

 

applicationPurpose

char(1)

Required

 

tenureTerm

decimal(4,0)

Optional

 

bCGSMapReference

char(15)

Optional

 

referToFileNumber

char(10)

Optional

 

provincialForestConflictCode

char(3)

Required

 

blockID

char(10)

Optional

 

purposeCode

char(2)

Optional

 

bCTSOffice

char(3)

Optional

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_area

Required

Represents the extentOf the HarvestApplicationNoCP. It is a single or multiPolygon.

esf_harvest_application_id

some unique id

Required

Uniquely identifies the HarvestApplicationNoCP within the submission. Each CutBlockNoCP contained in this HarvestApplicationNoCP will need to have an esf_harvest_application_id attribute referencing the value of this attribute.

esf_legal_description_id

some id

Required

Reference to the legal description.

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: CutBlockNoCP

Comments

A HarvestApplicationNoCP may contain one or more CutBlock(s). Each FME CutBlock Feature will reference its containing Harvest Application with the esf_harvest_application_id attribute.

Attributes

Name Type Optional/Required Description

cutBlockID

char(10)

Required

 

applicationPurpose

char(1)

Required

 

blockDescription

char(120)

Optional

 

provincialForestConflictCode

char(3)

Required

 

amendmentReason

char(1)

Optional

 

plannedGrossArea

decimal(11,4)

Required

 

plannedNetArea

decimal(11,4)

Required

 

cruiseVolume

decimal(13,2)

Optional

 

plannedHarvestDate

char(10)

Required

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_area

Required

 

esf_harvest_application_id

some unique id

Required

Identifies the harvest application container.

esf_legal_description_id

some id

Required

Reference to the legal description.

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: RoadTenureApplication

  • Used to submit applications or amendments to road permits or FSRs

Attributes

Name Type Optional/Required Description

forestFileID

char(10)

Optional

 

fileType

char(3)

Optional

 

applicationDescription

char(255)

Required

 

district

char(3)

Required

 

cascadeSplitCode

char(1)

Required

 

managementUnitType

char(1)

Required

 

managementUnitID

char(4)

Required

 

applicationPurpose

char(1)

Required

 

deemedOwnerInd

boolean

Required

 

bCTSOffice

char(3)

Optional

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_no_geom

Required

 

esf_road_tenure_application_id

some id

Required

Uniquely identifies the RoadTenureApplication within the submission.

Feature Type: RoadSection

Attributes

Name Type Optional/Required Description

roadSectionID

char(10)

Required

 

roadName

char(20)

Optional

 

bCGSMapReference

char(15)

Optional

 

applicationPurpose

char(1)

Required

 

provincialForestConflictCode

char(3)

Required

 

withinALRIND

boolean

Required

 

amendmentStartStation

decimal(11,4)

Optional

 

amendmentEndStation

decimal(11,4)

Optional

 

amendmentType

char(3)

Optional

 

roadState

char(1)

Optional

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_line

Required

 

esf_road_tenure_application_id

some id

Required

References the containing RoadTenureApplication.

esf_legal_description_id

some id

Required

Reference to the legal description.

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: RangeTenureApplication

Comments

A HarvestApplicationNoCP may contain one or more CutBlock(s). Each FME CutBlock Feature will reference its containing Harvest Application with the esf_harvest_application_id attribute.

Attributes

Name Type Optional/Required Description

forestFileID

char(10)

Optional

 

fileType

char(3)

Required

 

applicationDescription

char(255)

Required

 

district

char(3)

Required

 

applicationPurpose

char(1)

Required

 

authorizedHarvestableForage

decimal(5,0)

Required

 

issueDate

char(10)

Required

 

tenureTerm

decimal(4,0)

Optional

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_no_geom

Required

 

esf_range_tenure_application_id

some id

Required

Uniquely identifies the RoadTenureApplication within the submission.

Feature Type: RangeMapBlock

Comments

These are contained by the RangeTenureApplication features.

Attributes

Name Type Optional/Required Description

tenureBlock

char(10)

Required

 

hayCuttingAreaNumber

char(4)

Optional

 

referenceName

char(120)

Optional

 

bCGSMapReference

char(15)

Optional

 

applicationPurpose

char(1)

Required

 

provincialForestConflictCode

char(3)

Required

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_area

Required

 

esf_range_tenure_application_id

some id

Required

References the containing RangeTenureApplication.

esf_legal_description_id

some id

Required

Reference to the legal description.

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: TimberLicence

Comments

The Timber Licence boundary identifies the outer boundary of a Timber Licence.

Attributes

Name Type Optional/Required Description

forestFileID

char(10)

Required

 

applicationDescription

char(255)

Required

 

district

char(3)

Required

 

applicationPurpose

char(1)

Required

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_no_geom

Required

 

esf_timber_license_id

some id

Required

Uniquely Identifies the TimberLicence within the submission.

Feature Type: TimberLicenceMapBlock

Comments

These are contained by the TimberLicence features.

Attributes

Name Type Optional/Required Description

mapBlockID

char(10)

Required

 

referenceName

char(120)

Optional

 

bCGSMapReference

char(15)

Optional

 

applicationPurpose

char(1)

Required

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_area

Required

 

esf_timber_licence_id

some id

Required

References the containing TimberLicence.

esf_legal_description_id

some id

Required

Reference to the legal description.

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: TimberLicenceElimination

Comments

Licensees must annually submit the areas they have harvested or eliminated from a Timber Licence.

Attributes

Name Type Optional/Required Description

forestFileID

char(10)

Required

 

timberLicenceBlockID

char(10)

Required

 

applicationDescription

char(255)

Required

 

district

char(3)

Required

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_area

Required

 

esf_spatial_metadata_id

some id

Optional

Reference to the spatial metadata.

Feature Type: LegalDescription

  • Feature is required in HarvestApplicationWithCP, HarvestApplicationWithNoCP, ChartBlock, CutBlock, RoadSection, and MapBlock.

Attributes

Name Type Optional/Required Description

pointOfCommencement

char(2000)

Required

 

pointOfTermination{}

char(2000)

Optional

 

FME ESF Specific Attributes

Name Type/Value Optional/Required Description

xml_type

xml_no_geom

Required

 

esf_legal_description_id

some id

Required

Because many different esf features (across containers) have a reference to a unique LegalDescription, the esf_legal_description_id must be unique across a single submission.

Feature Type: SpatialMetaData

  • Feature is optional. From the ESF-FTA Submission Guide: “Some geometry content allows for the capture of spatial metadata as well. Metadata is information about the geometry data itself, for example how it was captured."

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): ChartBlock, CutBlockWithCP, CutBlockNoCP, RoadSection, RangeMapBlock, TimberLicenceMapBlock, and the TimberLicenceElimination.
  • HarvestApplicationWithCP and HarvestApplicationNoCP allow the optional spatial metadata explicitly.

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.