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(100) | Required | |
| telephoneNumber | decimal(10,0) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | |
|---|---|---|---|
| xml_type | xml_no_geom | Required |
Feature Type: ABRSubmissionMetadata
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| validateOnly | boolean | Required | |
| contactName | char(50) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | |
|---|---|---|---|
| xml_type | xml_no_geom | Required |
Feature Type: RoadTenure
- Feature is required. Submissions must contain at least one RoadTenure.
Comments:
A RoadTenure FME feature must be uniquely identified by its esf_road_tenure_id attribute since a submission may contain 1 or more RoadTenures.
A RoadTenure may have 1 or more RoadSections. A RoadSection FME feature will also have an esf_road_tenure_id attribute identifying its containing RoadTenure.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| forestFileId | char(10) | Required | |
| timberMark | char(6) | Optional | |
| cutBlockId | char(10) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type | xml_no_geom | Required | |
| esf_road_tenure_id | some unique id | Required | Uniquely identifies the RoadTenure within the submission. |
Feature Type: RoadSection
- Feature is required. A RoadTenure must have at least one RoadSection.
Comments:
Re-references its RoadTenure container through its required esf_road_tenure_id attribute.
A RoadSection FME feature additionally contains an esf_road_section_id attribute which must be unique within the submission.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| roadSectionId | char(10) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type | xml_line | Required | |
| esf_road_section_id | some unique id | Required | Uniquely identifies the RoadSection within the submission. |
| esf_road_tenure_id | some unique id | Required | Must match a RoadTenure’s esf_road_tenure_id attribute in the submission. |
| esf_spatial_metadata_id | some id | Optional | Reference to the spatial metadata. |
Feature Type: Bridge
- Feature is an optional Event
Comments:
The Bridge FME feature may be either a line or a non-geometrical feature. If the Bridge is a non-geometrical feature then its location.from and location.to attributes will be non-empty.
If the Bridge has line geometry, then its first coordinate will correspond to the start point of the event, and the second (and last) coordinate corresponds to the end point of the event.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| location.from | decimal(8,2) | Optional | |
| location.to | decimal(8,2) | Optional | |
| superStructureId | char(8) | Required | |
| siteId | char(8) | Required | |
| designLoadRating | decimal(10,0) | Required | |
| superStructureCode | char(10) | Required | |
| bridgeDeckCode | char(20) | Required | |
| substructureCode | char(14) | Required | |
| fishPresent | boolean | Required | |
| riparianClass | char(10) | Optional | |
| fieldKmMarker | char(15) | Optional | |
| streamName | char(30) | Optional | |
| currentLoadRating | decimal(10,0) | Optional | |
| designVehicleCode | char(10) | Optional | |
| nextInspectionDate | date | Optional | |
| bridgeDeckWidth | decimal(7,2) | Optional | |
| chronicMaintenance | boolean | Optional | |
| upstreamRisk | boolean | Optional | |
| inletRisk | boolean | Optional | |
| adequateSize | boolean | Optional | |
| historicWashout | boolean | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_line xml_no_geom |
Required | xml_type is xml_no_geom when the location of the event is provide through the location.from and location.to distance attributes. |
| esf_road_section_id | some unique id | Required |
Reference its containing RoadSection. Its value must match the RoadSection’s esf_road_section_id attribute. |
Feature Type: Culvert
- Feature is an optional Event
Comments:
The Culvert FME feature may be either a point or a non-geometrical feature. If the Culvert is a non-geometrical feature then its location.distance attribute will be non-empty.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| location.distance | decimal(8,2) | Optional | |
| siteStructureId | char(10) | Required | |
| diameterOrSpan | decimal(9,3) | Required | |
| engineeredStructure | boolean | Required | |
| materialCode | char(10) | Required | |
| designLoadRating | decimal(10,0) | Required | |
| fishPresent | boolean | Optional | |
| riparianClass | char(10) | Optional | |
| height | decimal(7,2) | Optional | |
| streamName | char(30) | Optional | |
| currentLoadRating | decimal(10,0) | Optional | |
| designVehicleCode | char(10) | Optional | |
| length | decimal(7,2) | Optional | |
| description | char(80) | Optional | |
| adequateSize | boolean | Optional | |
| inletRisk | boolean | Optional | |
| chronicMaintenance | boolean | Optional | |
| comments | char(4000) | Optional | |
| siteId | char(10) | Optional | |
| historicWashout | boolean | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_point xml_no_geom |
Required | xml_type is xml_no_geom when the location of the event is provide through the location.distance attribute. |
| esf_road_section_id | some unique id | Required | Reference its containing RoadSection. Its value must match the RoadSection’s esf_road_section_id attribute. |
Feature Type: LinearStructure
- Feature is an optional Event
Comments:
The LinearStructure FME feature may be either a line or a non-geometrical feature. If the LinearStructure is a non-geometrical feature then its location.from and location.to attributes will be non-empty.
If the LinearStructure has line geometry, then its first coordinate will correspond to the start point of the event, and the second (and last) coordinate corresponds to the end point of the event.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| location.from | decimal(8,2) | Optional | Represents the location of the event as a distance from the road’s PoC. It is not present if the Event has geometry. |
| location.to | decimal(8,2) | Optional | Represents the location of the event as a distance from the road’s PoC. It is not present if the Event has geometry. |
| linearFeatureTypeCode | char(20) | Required | |
| engineeredStructure | boolean | Required | |
| linearStructureClassCode | char(20) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_line xml_no_geom |
Required | xml_type is xml_no_geom when the location of the event is provide through the location.from and location.to distance attributes. |
| esf_road_section_id | some unique id | Optional | Reference its containing RoadSection. Its value must match the RoadSection’s esf_road_section_id attribute. |
Feature Type: OrganicMaterial
- Feature is an optional Event
Comments:
The OrganicMaterial FME feature may be either a line or a non-geometrical feature. If the OrganicMaterial is a non-geometrical feature then its location.from and location.to attributes will be non-empty.
If the OrganicMaterial has line geometry, then its first coordinate will correspond to the start point of the event, and the second (and last) coordinate corresponds to the end point of the event.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| location.from | decimal(8,2) | Optional | |
| location.to | decimal(8,2) | Optional | |
| roadFeatureTypeCode | char(20) | Required |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_line xml_no_geom |
Required | xml_type is xml_no_geom when the location of the event is provide through the location.from and location.to distance attributes. |
| esf_road_section_id | some unique id | Optional | Reference its containing RoadSection. Its value must match the RoadSection’s esf_road_section_id attribute. |
Feature Type: ConstructionDate
- Feature is an optional Event
Comments:
The ConstructionDate FME feature may be either a line or a non-geometrical feature. If the ConstructionDate is a non-geometrical feature then its location.from and location.to attributes will be non-empty.
If the ConstructionDate has line geometry, then its first coordinate will correspond to the start point of the event, and the second (and last) coordinate corresponds to the end point of the event.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| location.from | decimal(8,2) | Optional | |
| location.to | decimal(8,2) | Optional | |
| constructionTypeCode | char(10) | Required | |
| actualCompletionDate | date | Required | |
| plannedActivity | boolean | Optional | |
| seasonCode | char(10) | Optional | |
| outstandingObligation | boolean | Optional | |
| inspectionPlanned | boolean | Optional | |
| comments | char(4000) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_line xml_no_geom |
Required | xml_type is xml_no_geom when the location of the event is provide through the location.from and location.to distance attributes. |
| esf_road_section_id | some unique id | Required | Reference its containing RoadSection. Its value must match the RoadSection’s esf_road_section_id attribute. |
Feature Type: AccessControl
- Feature is an optional Event
Comments:
The AccessControl FME feature may be either a point or a non-geometrical feature. If the AccessControl is a non-geometrical feature then its location.distance attribute will be non-empty.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| location.distance | decimal(8,2) | Optional | |
| accessControlCode | char(20) | Required | |
| closureId | char(20) | Optional | |
| installDate | date | Optional | |
| rationaleCode | char(10) | Optional | |
| roadAccessMethodCode | char(10) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_point xml_no_geom |
Required | xml_type is xml_no_geom when the location of the event is provide through the location.distance attribute. |
| esf_road_section_id | some unique id | Required | Reference its containing RoadSection. Its value must match the RoadSection’s esf_road_section_id attribute. |
Feature Type: Deactivation
- Feature is an optional Event
Comments:
The Deactivation FME feature may be either a line or a non-geometrical feature. If the Deactivation is a non-geometrical feature then its location.from and location.to attributes will be non-empty.
If the Deactivation has line geometry, then its first coordinate will correspond to the start point of the event, and the second (and last) coordinate corresponds to the end point of the event.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| location.from | decimal(8,2) | Optional | |
| location.to | decimal(8,2) | Optional | |
| roadDeactivationLevelStatus | char(30) | Required | |
| actualCompletionDate | date | Required | |
| signageDate | date | Optional | |
| revegDate | date | Optional | |
| comments | char(4000) | Optional |
FME ESF Specific Attributes:
| Name | Type/Value | Optional/Required | Description |
|---|---|---|---|
| xml_type |
xml_line xml_no_geom |
Required | xml_type is xml_no_geom when the location of the event is provide through the location.from and location.to distance attributes. |
| esf_road_section_id | some unique id | Required | Reference its containing RoadSection. Its value must match the RoadSection’s esf_road_section_id attribute. |
Feature Type: SpatialMetaData
- Feature is required. Each Submission must have at least 1 RoadSection, and each RoadSection must have a related SpatialMetaData.
Comments:
The FME SpatialMetaData feature contains an esf_spatial_metadata attribute which uniquely identifies it within the submission.
Attributes:
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| dataSource | char(10) | Optional | |
| mostRecentSourceDate | date | Optional | |
| captureMethod | char(10) | Optional | |
| observationDate | date | Optional | |
| dataAccuracy | decimal(2,0) | Optional | |
| description | char(2000) | Optional | |
| ccsmCode | char(10) | Optional | |
| horizontalAccuracy | decimal(3,0) | Optional | |
| verticalAccuracy | decimal(3,0) | Optional | |
| horizontalDatum | char(10) | Optional | |
| verticalDatum | char(10) | Optional | |
| coordinateSystemCode | char(10) | 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. |