File structure¶

All JKUM-compatible files should have the extension .jkum. The contents of the file is based on the JSON-file standard and should in general follow all syntax regulations as described there. The .jkum file must validate according to this JKUM-standard, which is defined by a JSON Schema Definition file. The Standard is for the time being applying schema definition draft 7 (see JSON-schema), which covers most use cases to schema handling.

Any file created should adhere to the JSON-schemas as defined by JKUM.

The file should consist of two primary attributes: the head and the manholes. The structure should be similar to this:

{
  "head": {
    "epsg": 25832,
    "purpose": "Surveying"
  },
  "manholes": [...]
}

Properties¶

The .jkum-file has two properties at the top level: head and manholes. In the following, all related objects and properties are described.

Head¶

The head property consists of these possible properties:

Property Name	Type	Description
epsg	integer	The EPSG ID for the coordinate system which the coordinates this file system is represented.
purpose	string	The purpose for this file, which will affect which fields are considered required or not. One of the following values: `Surveying`, `Export`
date	string	An ISO 8601-formatted date string on the format YYYY-MM-DD.
author	string	The name or descriptive text about the author of the file.

Manholes¶

The manholes-property is an array consisting of Manhole.

Manhole¶

The properties for manholes are listed in this table.

Property Name	Type	Description
guid	GUID	A unique system-generated GUID for future reference and identification for the object.
sid	string	A unique ID commonly used in mapping systems. Enables a better human-readable ID for the object.
shape	string	The shape of the Manhole, one of: `Circular`, `Rectangular` or `Polygonal`.
elevationBottom	number	The altitude (elevation) for the bottom inside of the manhole in absolute elevation relative to zero.
elevationBanquet	number	The altitude (elevation) for any potential banquet, relative to zero. Skip this property if a banquet is not present.
topSolution	string	The solution applied for the top part of the manhole, one of: `Cone`, `Top plate`, `Cast removable`, `Cast not removable`, `Unknown`
material	string	The material of the manhole construction. Restricted by predefined values, one of: `Concrete`, `Bricks`, `Plastic`, `Rehabilitated`, `Other`
diameter	integer	The inner diameter of the manhole construction.
lids	array<Lid>	An array of Lid objects. Contains an array of Lids, since some manholes may have more than one Lid.
pipes	array<PipeConnection>	An array of PipeConnection objects.
images	array<ImageData>	An array of ImageData objects.

Depending on the shape of the manhole, the following properties are also required:

CircularRectangularPolygonal

Property Name	Type	Description
diameter	integer	The manhole inner diameter in millimeters.
isEccentric	bool	Wether the manhole is eccentric or centric.
rotation	integer	`Required if the manhole is eccentric.` The rotation pointing towards the center of the manhole lid. Relative to north, oriented clockwise from between 0 and 359 degrees.

Property Name	Type	Description
sizeX	integer	The manhole size in millimeters, along the X-axis according to its rotation.
sizeY	integer	The manhole size in millimeters, along the Y-axis according to its rotation.
rotation	integer	The y-axis relative to north, oriented clockwise from between 0 and 359 degrees.
center	Location	The center position of the manhole chamber.

Property Name	Type	Required	Description
circumference	array		A circumference-object consisting of the inner and outer boundary representing the Manhole constructions' shape.

Location¶

The location-attribute consists of the three properties east, north and elevation.

Property Name	Type	Description
east	float	A float representing the east coordinate within the EPSG-system as defined in the file `head`-property.
north	float	A float representing the north coordinate within the EPSG-system as defined in the file `head`-property.
elevation	float	A float representing the elevation of the coordinate within the EPSG-system as defined in the file `head`-property.

Circumference¶

Property Name	Type	Required	Description
innerVertices	array<Location>		An array of vertices within the EPSG-system as defined in the file `head`-property.
outerVertices	array<Location>		An array of vertices within the EPSG-system as defined in the file `head`-property.

Lid¶

Property Name	Type	Description
guid	GUID	A unique system-generated GUID for future reference and identification for the object.
position	Location	The position of the center point of the lid in the terrain.
diameter	integer	The manhole lid diameter in millimeters. Measured as lid size, not outer ring size.
ladder	string	If there is a ladder: `Yes`, otherwise `No`. Defaults to `Unspecified` in the absence of the property.
classification	string	Details of the lid type, one of: `Unspecified`, `D400`, `D700`

PipeConnection¶

When looking down into the manhole, pipe ends can be seen. Not knowing where the other end of the pipe is going or coming from, this file format instead focus on the relevant connector points that can be seen from inside the manhole.

Property Name	Type	Description
guid	GUID	A unique system-generated GUID for future reference and identification for the object.
sid	string	A unique ID commonly used in mapping systems. Enables a better human-readable ID for the object.
medium	string	The medium transported in the pipe. Must be one of the following: `Water`, `Sewer`, `Combination sewer`, `Storm water`, `Drain`
direction	string	The assumed flow direction of the pipe contents. Must be one of the following: `Ingoing`, `Outgoing`
material	string	The material of the pipe in the connection. Enum restricted to predefined values.
pressurized	boolean	If the pipe is a pressurized system.
measurementLocation	string	The location of where on the pipe the elevation was measured. One of: `topOutsidePipe`, `bottomInsidePipe`, `centerPipe`
elevation	float	The real-world elevation coordinate for the pipe connection.
clockPosition	integer	The location of the pipe as seen inside the manhole, oriented clockwise from between 0 and 359 degrees relative to north.
diameter	integer	The pipe diameter in millimeters.

ImageData¶

The images-items needs one of the following data contents:

Base64 and media typeImage URL to online source

Property Name	Type	Required	Description
base64String	string		A base 64 encoded string representing the image.
mediaType	string		A valid url to the location of the file, where it should be available for download.

Property Name	Type	Required	Description
imageUrl	string		A valid url to the location of the file, where it should be available for download.