Skip to content

Commit 97b6e74

Browse files
Merge pull request #107866 from stevemunk/drawing-conversion-error-codes
Drawing conversion error codes
2 parents d222906 + 8b2c2b9 commit 97b6e74

File tree

1 file changed

+39
-30
lines changed

1 file changed

+39
-30
lines changed

articles/azure-maps/drawing-conversion-error-codes.md

Lines changed: 39 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,31 @@ services: azure-maps
1212

1313
# Drawing conversion errors and warnings
1414

15-
The [Azure Maps Conversion service](/rest/api/maps/v2/conversion) lets you convert uploaded drawing packages into map data. Drawing packages must adhere to the [Drawing package requirements](drawing-requirements.md). If one or more requirements aren't met, then the Conversion service will return errors or warnings. This article lists the conversion error and warning codes, with recommendations on how to resolve them. It also provides some examples of drawings that can cause the Conversion service to return these codes.
15+
The Azure Maps [Conversion service] lets you convert uploaded drawing packages into map data. Drawing packages must adhere to the [Drawing package requirements]. If one or more requirements aren't met, then the Conversion service returns errors or warnings. This article lists the conversion error and warning codes, with recommendations on how to resolve them. It also provides some examples of drawings that can cause the Conversion service to return these codes.
1616

17-
The Conversion service will succeed if there are any conversion warnings. However, it's recommended that you review and resolve all warnings. A warning means part of the conversion was ignored or automatically fixed. Failing to resolve the warnings could result in errors in latter processes.
17+
The Conversion service succeeds if there are any conversion warnings. However, it's recommended that you review and resolve all warnings. A warning means part of the conversion was ignored or automatically fixed. Failing to resolve the warnings could result in errors in latter processes.
1818

1919
## General Warnings
2020

2121
### **geometryWarning**
2222

2323
#### *Description for geometryWarning*
2424

25-
A **geometryWarning** occurs when the drawing contains an invalid entity. An invalid entity is an entity that doesn't conform to geometric constraints. Examples of an invalid entity are a self-intersecting polygon or a non-closed PolyLine in a layer that only supports closed geometry.
25+
A **geometryWarning** occurs when the drawing contains an invalid entity. An invalid entity is an entity that doesn't conform to geometric constraints. Examples of an invalid entity are a self-intersecting polygon or an open PolyLine in a layer that only supports closed geometry.
2626

2727
The Conversion service is unable to create a map feature from an invalid entity and instead ignores it.
2828

2929
#### *Examples for geometryWarning*
3030

31-
* The two images below show examples of self-intersecting polygons.
31+
* The following two images show examples of self-intersecting polygons.
3232

3333
![Example of a self-intersecting polygon, example one.](./media/drawing-conversion-error-codes/geometry-warning-1.png)
3434

3535
![Example of a self-intersecting polygon, example two.](./media/drawing-conversion-error-codes/geometry-warning-2.png)
3636

37-
* Below is an image that shows a non-closed PolyLine. Assume that the layer only supports closed geometry.
37+
* The following image shows an open PolyLine. Assume that the layer only supports closed geometry.
3838

39-
![Example of a non-closed PolyLine](./media/drawing-conversion-error-codes/geometry-warning-3.png)
39+
![Example of an open PolyLine](./media/drawing-conversion-error-codes/geometry-warning-3.png)
4040

4141
#### *How to fix geometryWarning*
4242

@@ -46,13 +46,13 @@ Inspect the **geometryWarning** for each entity to verify that it follows geomet
4646

4747
#### *Description for unexpectedGeometryInLayer*
4848

49-
An **unexpectedGeometryInLayer** warning occurs when the drawing contains geometry that is incompatible with the expected geometry type for a given layer. When the Conversion service returns an **unexpectedGeometryInLayer** warning, it will ignore that geometry.
49+
An **unexpectedGeometryInLayer** warning occurs when the drawing contains geometry that is incompatible with the expected geometry type for a given layer. When the Conversion service returns an **unexpectedGeometryInLayer** warning, it ignores that geometry.
5050

5151
#### *Example for unexpectedGeometryInLayer*
5252

53-
The image below shows a non-closed PolyLine. Assume that the layer only supports closed geometry.
53+
The following image shows an open PolyLine. Assume that the layer only supports closed geometry.
5454

55-
![Example of a non-closed PolyLine](./media/drawing-conversion-error-codes/geometry-warning-3.png)
55+
![Example of an open PolyLine](./media/drawing-conversion-error-codes/geometry-warning-3.png)
5656

5757
#### *How to fix unexpectedGeometryInLayer*
5858

@@ -66,13 +66,13 @@ The **unsupportedFeatureRepresentation** warning occurs when the drawing contain
6666

6767
#### *Example for unsupportedFeatureRepresentation*
6868

69-
The image below shows an unsupported entity type as a multi-line text object on a label layer.
69+
The following image shows an unsupported entity type as a multi-line text object on a label layer.
7070

7171
![Example of a multi-line text object on label layer](./media/drawing-conversion-error-codes/multi-line.png)
7272

7373
#### *How to fix unsupportedFeatureRepresentation*
7474

75-
Ensure that your DWG files contain only the supported entity types. Supported types are listed under the [Drawing files requirements](drawing-requirements.md#drawing-package-requirements) section in the drawing package requirements article.
75+
Ensure that your DWG files contain only the supported entity types. Supported types are listed under the [Drawing files requirements] section in the drawing package requirements article.
7676

7777
### **automaticRepairPerformed**
7878

@@ -86,13 +86,13 @@ The **automaticRepairPerformed** warning occurs when the Conversion service auto
8686

8787
![Example of a self-intersecting polygon repaired](./media/drawing-conversion-error-codes/automatic-repair-1.png)
8888

89-
* The image below shows how the Conversion service snapped the first and last vertex of a non-closed PolyLine to create a closed PolyLine, where the first and last vertex were less than 1 mm apart.
89+
* The following image shows the Conversion service snapping the first and last vertex of an open PolyLine to create a closed PolyLine, where the first and last vertex were less than 1 mm apart.
9090

9191
![Example of a snapped PolyLine](./media/drawing-conversion-error-codes/automatic-repair-2.png)
9292

93-
* The image below shows how, in a layer that supports only closed PolyLines, the Conversion service repaired multiple non-closed PolyLines. To avoid discarding the non-closed PolyLines, the service combined them into a single closed PolyLine.
93+
* The following image shows how, in a layer that supports only closed PolyLines, the Conversion service repaired multiple open PolyLines. To avoid discarding the open PolyLines, the service combined them into a single closed PolyLine.
9494

95-
![Example of non-closed Polylines combined into a single closed PolyLine](./media/drawing-conversion-error-codes/automatic-repair-3.png)
95+
![Example of open Polylines combined into a single closed PolyLine](./media/drawing-conversion-error-codes/automatic-repair-3.png)
9696

9797
#### *How to fix automaticRepairPerformed*
9898

@@ -115,7 +115,7 @@ The **redundantAttribution** warning occurs when the manifest contains redundant
115115

116116
#### *Examples for redundantAttribution*
117117

118-
* The JSON snippet below contains two or more `unitProperties` objects with the same `name`.
118+
* The following JSON example contains two or more `unitProperties` objects with the same `name`.
119119

120120
```json
121121
"unitProperties": [
@@ -134,7 +134,7 @@ The **redundantAttribution** warning occurs when the manifest contains redundant
134134
]
135135
```
136136

137-
* In the JSON snippet below, two or more `zoneProperties` objects have the same `name`.
137+
* In the following JSON snippet, two or more `zoneProperties` objects have the same `name`.
138138

139139
```json
140140
"zoneProperties": [
@@ -182,7 +182,7 @@ The **wallOutsideLevel** warning occurs when the drawing contains a Wall geometr
182182

183183
#### *Example for wallOutsideLevel*
184184

185-
* The image below shows an interior wall, in red, outside the yellow level boundary.
185+
* The following image shows an interior wall, in red, outside the yellow level boundary.
186186

187187
![Example of interior wall outside the level boundary](./media/drawing-conversion-error-codes/wall-outside-level.png)
188188

@@ -300,7 +300,7 @@ To fix a **labelWarning**, ensure that:
300300

301301
An **invalidArchiveFormat** error occurs when the drawing package is in an invalid archive format such as GZIP or 7-Zip. Only the ZIP archive format is supported.
302302

303-
An **invalidArchiveFormat** error will also occur if the ZIP archive is empty.
303+
An **invalidArchiveFormat** error also occurs if the ZIP archive is empty.
304304

305305
#### *How to fix invalidArchiveFormat*
306306

@@ -355,7 +355,7 @@ To fix a **dwgError**, inspect your _manifest.json_ file confirm that:
355355

356356
An **invalidJsonFormat** error occurs when the _manifest.json_ file can't be read.
357357

358-
The _manifest.json_file can't be read because of JSON formatting or syntax errors. To learn more about how JSON format and syntax, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://tools.ietf.org/html/rfc7159)
358+
The _manifest.json_file can't be read because of JSON formatting or syntax errors. To learn more about how JSON format and syntax, see [The JavaScript Object Notation (JSON) Data Interchange Format].
359359

360360
#### *How to fix invalidJsonFormat*
361361

@@ -369,7 +369,7 @@ A **missingRequiredField** error occurs when the _manifest.json_ file is missing
369369

370370
#### *How to fix missingRequiredField*
371371

372-
To fix a **missingRequiredField** error, verify that the manifest contains all required properties. For a full list of required manifest object, see the [manifest section in the Drawing package requirements](drawing-requirements.md#manifest-file-requirements)
372+
To fix a **missingRequiredField** error, verify that the manifest contains all required properties. For a full list of required manifest object, see the [manifest section in the Drawing package requirements].
373373

374374
### **missingManifest**
375375

@@ -395,7 +395,7 @@ The **conflict** error occurs when the _manifest.json_ file contains conflicting
395395

396396
#### *Example scenario for conflict*
397397

398-
The Conversion service will return a **conflict** error when more than one level is defined with the same level ordinal. The following JSON snippet shows two levels defined with the same ordinal.
398+
The Conversion service returns a **conflict** error when more than one level is defined with the same level ordinal. The following JSON snippet shows two levels defined with the same ordinal.
399399

400400
```JSON
401401
"buildingLevels":
@@ -432,7 +432,7 @@ The **invalidGeoreference** error occurs because of one or more of the following
432432

433433
#### *Example scenario for invalidGeoreference*
434434

435-
In the JSON snippet below, the latitude is above the upper limit.
435+
In the following JSON snippet, the latitude is above the upper limit.
436436

437437
```json
438438
"georeference"
@@ -447,12 +447,12 @@ In the JSON snippet below, the latitude is above the upper limit.
447447

448448
To fix an **invalidGeoreference** error, verify that the georeferenced values are within range.
449449

450-
>[!IMPORTANT]
451-
>In GeoJSON, the coordinates order is longitude and latitude. If you don't use the correct order, you may accidentally refer a latitude or longitude value that is out of range.
450+
> [!IMPORTANT]
451+
> In GeoJSON, the coordinates order is longitude and latitude. If you don't use the correct order, you may accidentally refer a latitude or longitude value that is out of range.
452452
453453
## Wall errors
454454

455-
### **wallError**
455+
### **wallError**s
456456

457457
#### *Description for wallError*
458458

@@ -483,7 +483,7 @@ The **verticalPenetrationError** occurs because of one or more of the following
483483

484484
#### *Example scenario for verticalPenetrationError*
485485

486-
The image below shows a vertical penetration area with no overlapping vertical penetration areas on levels above or below it.
486+
The following image shows a vertical penetration area with no overlapping vertical penetration areas on levels above or below it.
487487

488488
![Example of a vertical penetration 1](./media/drawing-conversion-error-codes/vrt-2.png)
489489

@@ -493,15 +493,24 @@ The following image shows a vertical penetration area that overlaps more than on
493493

494494
#### How to fix verticalPenetrationError
495495

496-
To fix a **verticalPenetrationError** error, read about how to use a vertical penetration feature in the [Drawing package requirements](drawing-requirements.md) article.
496+
To fix a **verticalPenetrationError** error, read about how to use a vertical penetration feature in the [Drawing package requirements] article.
497497

498498
## Next steps
499499

500500
> [!div class="nextstepaction"]
501-
> [How to use Azure Maps Drawing error visualizer](drawing-error-visualizer.md)
501+
> [How to use Azure Maps Drawing error visualizer]
502502
503503
> [!div class="nextstepaction"]
504-
> [Drawing Package Guide](drawing-package-guide.md)
504+
> [Drawing Package Guide]
505505
506506
> [!div class="nextstepaction"]
507-
> [Creator for indoor mapping](creator-indoor-maps.md)
507+
> [Creator for indoor mapping]
508+
509+
[Conversion service]: /rest/api/maps/v2/conversion
510+
[Drawing package requirements]: drawing-requirements.md
511+
[Drawing files requirements]: drawing-requirements.md#drawing-package-requirements
512+
[The JavaScript Object Notation (JSON) Data Interchange Format]: https://tools.ietf.org/html/rfc7159
513+
[manifest section in the Drawing package requirements]: drawing-requirements.md#manifest-file-requirements
514+
[How to use Azure Maps Drawing error visualizer]: drawing-error-visualizer.md
515+
[Drawing Package Guide]: drawing-package-guide.md
516+
[Creator for indoor mapping]: creator-indoor-maps.md

0 commit comments

Comments
 (0)