AND Ducts GIS-Import FeatureCollection
Type: object
Description
This schema defines a GeoJSON FeatureCollection for GIS files containing ducts which should be imported into Advanced Network Design projects. The name of the geojson file to be imported is mandatory ‘ducts.geojson’. Please note, the schema for trenches is separate and should be used accordingly.
Required Properties
type
features
Properties
The following properties are defined for this object:
type
Type:
string
Allowed Values
"FeatureCollection"
features
Type:
array
Items
Each item in this array must adhere to the following schema:
GeoJSON Feature:
features
Type:
object
Required Properties
type
properties
geometry
Properties
The following properties are defined for this object:
type
Type:
string
Allowed Values
"Feature"
id
Type:
string
Description
Specifies the ID of customers external system which will be stored within ‘RefId’ property of instaciated AND Object
Target: RefId of object
Default Value
The default value for this item is:
null
properties
Type:
object
Properties
The following properties are defined for this object:
identification
Type:
string
Description
The identification name will be used to do a logical, sequencial collect over several IDs which represent segments
Target: InstallationNumber of object
type
Description
Specifies the duct type, used exclusively for mapping purposes and will not be stored.
Component-mapping: true
Value-mapping: true
Target: not stored - used for mapping only
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
101
105
110
Default Value
The default value for this item is:
101
Type:
string
Allowed Values
"duct"
"duct_package"
"sub_duct"
Default Value
The default value for this item is:
"duct"
parent_id
Type:
string
Description
This duct is within that parent. If it’s null or missing and ‘parent_identification’ is null or missing then a trench is generated implicitly. If the parent-duct is inside this import-file then it refers to its ‘id’. For the case it is embedded into a trench it refers to the RefId of the already instanciated trench
Target: not stored - will be used for assignment to a parent duct or a trench
Default Value
The default value for this item is:
null
parent_type
Description
The type of the parent - parent_id plus parent_type must be an unique key
Target: not stored - will be used for assignment to a parent object
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1
2
101
105
110
Type:
string
Allowed Values
"trench"
"trench_air"
"duct"
"duct_package"
"sub_duct"
parent_identification
Type:
string
Description
This duct is embedded in that trench or duct with that ‘identification’ or ‘installation number’ when parent is a trench. If parent_id is valid then this will be ignored
Target: not stored - will be used for assignment to a parent object (trench or duct)
sub_ducts
Type:
integer
Description
generate this number of sub_ducts - property ‘type’ must be 105/'duct_package’
Component-mapping: true
Target: not stored - used for mapping only
subduct_identifier
Type:
string
Description
property ‘type’ must be 110/‘sub_duct’ / property ‘sub_ducts’ will be ignored - select the correct sub-duct of a duct-package - the rule tries to match the string first with the name of a subduct in mapped package-library-object; if the match fails then its checked if its a digit which then will be used as index in package; otherwise the next free sub-duct is taken
Target: not stored - will be used to select the correct subduct of a ductpackage
Examples
The following are example values for this schema:
-
"Blau"
-
"3"
-
deploy_direction
Description
The direction of the sub-duct deploy within the duct-package (enum); property ‘type’ must be 110/'sub_duct’
Target: not stored - used for generation only
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
0
1
2
Default Value
The default value for this item is:
0
Type:
string
Allowed Values
"auto"
"fromStart"
"fromEnd"
Default Value
The default value for this item is:
"auto"
count
Type:
integer
Description
create that number of parallel ducts (further IDs will be generated automatically then)
Target: not stored - used for object generation only
Default Value
The default value for this item is:
1
component_id
Description
Allows an explicit mapping to a library object via mapping setup
Component-mapping: true
Target: not stored - used for mapping only
This item must also validate against exactly one of the following schemas:
Type:
integer
Type:
string
owner
Type:
string
Description
The owner of that duct
Target: Is stored in DB. At begin of import all occuring owners (strings) will be collected and searched in DB by name. The existing ones mapped, the new ones added (with message)
status
Description
The status of the trenchline if it’s created implicitly (enum)
Value-mapping: true
Target: will be mapped into ObjAttribute::State from States.xml
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
50
100
200
300
400
420
440
450
480
500
600
700
800
900
Default Value
The default value for this item is:
50
Type:
string
Allowed Values
"n/a"
"inherit"
"Evaluation"
"Decision"
"Planning"
"Planned"
"Ordered"
"Booked"
"Interrupted"
"Building"
"Built"
"Operation"
"Standing Idle"
"Out of Order"
Default Value
The default value for this item is:
"n/a"
color
Type:
string
Description
Specifies the color of the trenchline if it’s created implicitly using RGB or RGBA format. Note that the alpha (transparency) channel is not considered and only RGB values are used for mapping to predefined system colors. Duct color itself comes from mapped library duct object.
Component-mapping: true
Value-mapping: true
Target: the rgb-value will be mapped to one of 127 fix colors of AND
Examples
The following are example values for this schema:
-
"rgba(0, 0, 255, 1.0)"
-
"rgb(0, 0, 255)"
-
layer
Type:
string
Description
The name of the layer where this trenchline will be placed on if it’s created implicitly
Component-mapping: true
Value-mapping: true
Target: will be mapped into ObjAttribute::Layer - no automatic adding of not found layers
system_id
Type:
string
Description
Filter to technical system - will be used to assign to projects/designs
Target: Triplet or DaaVar, if the assignment is configured in the metadata
data
Type:
object
Description
Customer defined additional information as json object
Target: Triplet or DaaVar, if the assignment is configured in the metadata - will internally be handled as string
width
Type:
number
Description
The width of the enclosing trench
Target: trench property if a trench is to be created implicitly
depth
Type:
number
Description
The depth of the enclosing trench
Target: trench property ‘Depth’ if a trench is to be created implicitly. Negative values mean a height
length
Type:
number
Description
The measured length of implicitly created trench - makes only sense in schematic drawings. Will not be stored if parent is a duct
Target: measured length of line-object
marking_band
Type:
string
Description
The desciption of a marking band if present of the enclosing trench
Target: trench property ‘Warning Tape’ if a trench is to be created implicitly
lease_cost
Type:
number
Description
Specifies lease costs or income per m
Target: duct property ‘Lease costs’
is_broken
Type:
boolean
Description
The duct is marked as broken/un-usable
Target: duct property ‘Defect’
is_reserved
Type:
boolean
Description
The duct is marked as reserved. Ot will be ignored when ‘is_reserved_for’ has a valid string - otherwise it generates ‘is reserverd’ in property 'is_reserved_for’
Target: duct property ‘Reserved for’
is_reserved_for
Type:
string
Description
The duct is marked as reserved for that customer/project
Target: duct property ‘Reserved for’
installation_year
Type:
string
Description
The installation year of the emclosing trench
Target: trench property if a trench is to be created implicitly
diameter
Type:
number
Description
Specifies the outer diameter - can be used for component mapping
Component-mapping: true
Target: Triplet or DaaVar, if the assignment is configured in the metadata
inner_diameter
Type:
number
Description
Specifies the inner diameter
Target: Triplet or DaaVar, if the assignment is configured in the metadata
surface
Description
Specifies the surface of the trench if implicitly created
Component-mapping: true
Value-mapping: true
Target: map to surface of SurfaceType.xml and store in trench if implicitly created
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1000
1001
1002
1003
1004
1005
Type:
string
Allowed Values
"unknown"
"unmetaled"
"tarred"
"concreted"
"paved"
"paved (sealed)"
layingtype
Description
Specifies the laying type of the trench if implicitly created
Component-mapping: true
Value-mapping: true
Target: map to layingtype of TrenchLayingType.xml and store in trench property ‘Laying Type’ if implicitly created
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1100
1101
1102
1103
1104
1105
1106
1107
Type:
string
Allowed Values
"unknown"
"buried"
"tray installation"
"arial"
"dry installation"
"within construction"
"Street crossing"
"Train route crossing"
trenching_method
Description
Specifies the trenching method of the trench if implicitly created
Component-mapping: true
Value-mapping: true
Target: map to trenching_method of ConstructionMethod.xml and store in trench property ‘Construction Principle’ if implicitly created
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1299
Type:
string
Allowed Values
"unknown"
"Conventional Excavation"
"Cable Ploughing"
"Micro Trenching"
"Mini Trenching"
"Macro Trenching"
"Hydraulic Rotary Water Drilling"
"Soil Displacement"
"With Sewer Trench"
"With Water Trench"
"Aerial Mounting"
"Other"
accuracy
Description
Specifies the accuracy of the trench if implicitly created
Component-mapping: true
Value-mapping: true
Target: map to accuracy of Accuracy.xml and store in trench if implicitly created
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1300
1301
1302
1303
Type:
string
Allowed Values
"unknown"
"planned"
"estimated"
"accurate"
permission
Description
Specifies the permission type of the trench if implicitly created
Value-mapping: true
Target: map to permission of Permit.xml and store in trench if implicitly created
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1400
1401
1402
1403
1404
Type:
string
Allowed Values
"neutral"
"not needed"
"pending"
"obtained"
"rejected"
duct_usage
Description
the duct-usage type
Component-mapping: true
Value-mapping: true
Target: Specifies map to duct-usage of DuctTradeType.xml and store in duct property 'Duct Trade Type
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1500
1501
1502
1503
1504
1505
1506
1507
1599
Type:
string
Allowed Values
"unknown"
"Communication"
"Electricity supply"
"District heating"
"Drinking water supply"
"Wastewater"
"Gas"
"Disused conduit"
"other"
material
Description
Specifies the duct material type - can be used for mapping a duct library component
Component-mapping: true
Target: Triplet or DaaVar, if the assignment is configured in the metadata
This item must also validate against exactly one of the following schemas:
Type:
integer
Examples
The following are example values for this schema:
-
1600
-
1601
-
1602
-
1603
-
1604
-
1605
-
1606
-
1607
-
1608
-
1609
-
1610
-
1699
-
Type:
string
Examples
The following are example values for this schema:
-
"unknown"
-
"PVC"
-
"PVC-U"
-
"PE"
-
"PE-HD"
-
"PP"
-
"PB"
-
"concrete"
-
"metal"
-
"lead"
-
"clay tiles"
-
"other"
-
rental_type
Description
Specifies the ducts rental type
Component-mapping: true
Value-mapping: true
Target: map to rental of RentalType.xml and store in duct
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1700
1701
1702
1799
Type:
string
Allowed Values
"neutral"
"rental income"
"lease costs"
"other"
owner_type
Description
Specifies the owner type of the duct
Value-mapping: true
Target: map to owner of OwnerType.xml and store in duct
This item must also validate against exactly one of the following schemas:
Type:
integer
Allowed Values
1900
1901
1902
1903
1904
Type:
string
Allowed Values
"neutral"
"own inventory"
"foreign inventory"
"communal inventory"
"partner inventory"
GeoJSON LineString:
geometry
Type:
object
Description
Defines the GeoJSON LineString geometry representing the entire duct layout. This geometry may be adjusted to align with connection points on associated objects.
Target: stored in the objects geometry - the line-geometry can be adjusted to pins of objects where they are connected to
Required Properties
type
coordinates
Properties
The following properties are defined for this object:
type
Type:
string
Allowed Values
"LineString"
coordinates
Type:
array
Minimum number of items:
2
Items
Each item in this array must adhere to the following schema:
coordinates
Type:
array
Minimum number of items:
2
Items
Each item in this array must adhere to the following schema:
coordinates
Type:
number