Skip to content

Commit f5c2de6

Browse files
authored
Merge pull request #231614 from brendansco/conversion-v2
Conversion v2
2 parents 73e96ec + d337400 commit f5c2de6

12 files changed

+425
-17
lines changed

articles/azure-maps/drawing-package-guide.md

Lines changed: 143 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@
22
title: Drawing package guide for Microsoft Azure Maps Creator
33
titleSuffix: Microsoft Azure Maps Creator
44
description: Learn how to prepare a drawing package for the Azure Maps Conversion service
5-
author: eriklindeman
6-
ms.author: eriklind
7-
ms.date: 01/31/2023
5+
author: brendansco
6+
ms.author: Brendanc
7+
ms.date: 03/21/2023
88
ms.topic: how-to
99
ms.service: azure-maps
1010
services: azure-maps
11+
zone_pivot_groups: drawing-package-version
1112
---
1213

1314
# Conversion drawing package guide
1415

16+
:::zone pivot="drawing-package-v1"
17+
1518
This guide shows you how to prepare your Drawing Package for the [Azure Maps Conversion service] using specific CAD commands to correctly prepare your DWG files and manifest file for the Conversion service.
1619

1720
To start with, make sure your Drawing Package is in .zip format, and contains the following files:
@@ -220,13 +223,149 @@ The following snippet shows the unit property object that is associated with the
220223

221224
You should now have all the DWG drawings prepared to meet Azure Maps Conversion service requirements. A manifest file has also been created to help describe the facility. All files will need to be zipped into a single archive file, with the `.zip` extension. It's important that the manifest file is named `manifest.json` and is placed in the root directory of the zipped package. All other files can be in any directory of the zipped package if the filename includes the relative path to the manifest. For an example of a drawing package, see the [sample drawing package].
222225

226+
:::zone-end
227+
228+
:::zone pivot="drawing-package-v2"
229+
230+
This guide shows you how to prepare your Drawing Package for the Azure Maps [Conversion service v2]. A Drawing Package contains one or more DWG drawing files for a single facility and a manifest file describing the DWG files.
231+
232+
If you don't have your own package to reference along with this guide, you may download the [sample drawing package v2].
233+
234+
You may choose any CAD software to open and prepare your facility drawing files. However, this guide is created using Autodesk's AutoCAD® software. Any commands referenced in this guide are meant to be executed using Autodesk's AutoCAD® software.
235+
236+
> [!TIP]
237+
> For more information about drawing package requirements that aren't covered in this guide, see [Drawing Package Requirements].
238+
239+
## Glossary of terms
240+
241+
For easy reference, here are some terms and definitions that are important as you read this guide.
242+
243+
| Term | Definition |
244+
|:--------|:---------------------------------------------|
245+
| Layer | An AutoCAD DWG layer from the drawing file. |
246+
| Entity | An AutoCAD DWG entity from the drawing file. |
247+
| Level | An area of a building at a set elevation. For example, the floor of a building. |
248+
| Feature | An object that combines a geometry with more metadata information. |
249+
| Feature classes | A common blueprint for features. For example, a *unit* is a feature class, and an *office* is a feature. |
250+
251+
## Step 1: DWG file requirements
252+
253+
When preparing your facility drawing files for the Conversion service, make sure to follow these preliminary requirements and recommendations:
254+
255+
* Facility drawing files must be saved in DWG format, which is the native file format for Autodesk's AutoCAD® software.
256+
* The Conversion service works with the AutoCAD DWG file format. AC1032 is the internal format version for the DWG files, and it's a good idea to select AC1032 for the internal DWG file format version.
257+
* A DWG file can only contain a single floor. A floor of a facility must be provided in its own separate DWG file. So, if you have five floors in a facility, you must create five separate DWG files.
258+
259+
## Step 2: Prepare the DWG files
260+
261+
This part of the guide shows you how to use CAD commands to ensure that your DWG files meet the requirements of the Conversion service.
262+
263+
You may choose any CAD software to open and prepare your facility drawing files. However, this guide is created using Autodesk's AutoCAD® software. Any commands referenced in this guide are meant to be executed using Autodesk's AutoCAD® software.
264+
265+
### Bind External References
266+
267+
Each floor of a facility must be provided as one DWG file. If there are no external references, then nothing more needs to be done. However, if there are any external references, they must be bound to a single drawing. To bind an external reference, you may use the `XREF` command. After binding, each external reference drawing will be added as a block reference. If you need to make changes to any of these layers, remember to explode the block references by using the `XPLODE` command.
268+
269+
### Unit of measurement
270+
271+
The drawings can be created using any unit of measurement. However, all drawings must use the same unit of measurement. So, if one floor of the facility is using millimeters, then all other floors (drawings) must also be in millimeters. You can verify or modify the measurement unit by using the `UNITS` command and setting the “Insertion scale” value.
272+
273+
The following image shows the **Drawing Units** window within Autodesk's AutoCAD® software that you can use to verify the unit of measurement.
274+
275+
:::image type="content" source="./media/drawing-package-guide/units.png" alt-text="Screenshot of the drawing units window in Autodesk's AutoCAD® software.":::
276+
277+
### Alignment
278+
279+
Each floor of a facility is provided as an individual DWG file. As a result, it's possible that the floors don't align perfectly, as required by the Azure Maps Conversion service. To verify alignment, use a reference point such as an elevator or column that spans multiple floors. Use the `XATTACH` command to load all floor drawings, then the `MOVE` command with the reference points to realign any floors that require it.
280+
281+
### Layers
282+
283+
Ensure that each layer of a drawing contains entities of one feature class. If a layer contains entities for walls, then it shouldn't have other entities such as units or doors. However, a feature class can be composed of multiple layers. For example, you can have three layers in the drawing that contain wall entities.
284+
285+
For a better understanding of layers and feature classes, see [Drawing Package Requirements].
286+
287+
## Step 3: Prepare the manifest
288+
289+
The drawing package Manifest is a JSON file. The Manifest tells the Azure Maps Conversion service how to read the facility DWG files and metadata. Some examples of this information could be the specific information each DWG layer contains, or the geographical location of the facility.
290+
291+
To achieve a successful conversion, all “required” properties must be defined. A sample manifest file can be found inside the [sample drawing package v2]. This guide doesn't cover properties supported by the manifest. For more information about manifest properties, see [Manifest File Properties].
292+
293+
The manifest can be created manually in any text editor, or can be created using the Azure Maps Creator onboarding tool. This guide provides examples for each.
294+
295+
### The Azure Maps Creator onboarding tool
296+
297+
You can use the [Azure Maps Creator onboarding tool] to create new and edit existing [manifest files].
298+
299+
To process the DWG files, enter the geography of your Azure Maps Creator resource, the subscription key of your Azure Maps account and the path and filename of the DWG ZIP package, the select **Process**. This process can take several minutes to complete.
300+
301+
:::image type="content" source="./media/creator-indoor-maps/onboarding-tool/create-manifest.png" alt-text="Screenshot showing the create a new manifest screen of the Azure Maps Creator onboarding tool.":::
302+
303+
### Facility levels
304+
305+
The facility level specifies which DWG file to use for which level. A level must have a level name and ordinal that describes that vertical order of each level in the facility, along with a **Vertical Extent** describing the height of each level in meters.
306+
307+
The following example is taken from the [sample drawing package v2]. The facility has two levels: ground and level 2. The filename contains the full file name and path of the file relative to the manifest file within the drawing package.
308+
309+
:::image type="content" source="./media/creator-indoor-maps/onboarding-tool/facility-levels.png" alt-text="Screenshot showing the facility levels tab of the Azure Maps Creator onboarding tool.":::
310+
311+
### DWG layers
312+
313+
The `dwgLayers` object is used to specify the DWG layer names where feature classes can be found. To receive a properly converted facility, it's important to provide the correct layer names. For example, a DWG wall layer must be provided as a wall layer and not as a unit layer. The drawing can have other layers such as furniture or plumbing; but, the Azure Maps Conversion service ignores anything not specified in the manifest.
314+
Defining text properties enables you to associate text entities that fall inside the bounds of a feature. Once defined they can be used to style and display elements on your indoor map
315+
316+
:::image type="content" source="./media/creator-indoor-maps/onboarding-tool/dwg-layers.png" alt-text="Screenshot showing the create a new manifest screen of the onboarding tool.":::
317+
318+
> [!IMPORTANT]
319+
> Wayfinding support for `Drawing Package 2.0` will be supported in the near future. The following feature class should be defined (non-case sensitive) in order to use [wayfinding]. `Wall` will be treated as an obstruction for a given path request. `Stair` and `Elevator` will be treated as level connectors to navigate across floors:
320+
>
321+
> 1. Wall
322+
> 2. Stair
323+
> 3. Elevator
324+
325+
### georeference
326+
327+
Georeferencing is used to specify the exterior profile, location and rotation of the facility.
328+
329+
The [facility level] defines the exterior profile as it appears on the map and is selected from the list of DWG layers in the **Exterior** drop-down list.
330+
331+
The **Anchor Point Longitude** and **Anchor Point Latitude** specify the facility's location, the default value is zero (0).
332+
333+
The **Anchor Point Angle** is specified in degrees between true north and the drawing's vertical (Y) axis, the default value is zero (0).
334+
335+
:::image type="content" source="./media/creator-indoor-maps/onboarding-tool/georeference.png" alt-text="Screenshot showing the default settings in the georeference tab of the Azure Maps Creator onboarding tool. The default settings are zero for all anchor points including longitude, latitude and angle.":::
336+
337+
You position the facility's location by entering either an address or longitude and latitude values. You can also pan the map to make minor adjustments to the facility's location.
338+
339+
:::image type="content" source="./media/creator-indoor-maps/onboarding-tool/georeference-location-defined.png" alt-text="Screenshot showing the georeference tab of the Azure Maps Creator onboarding tool with values entered for the longitude and latitude anchor points.":::
340+
341+
### Review and download
342+
343+
When finished, select the **Review + Download** button to view the manifest. When you finished verifying that it's ready, select the **Download** button to save it locally so that you can include it in the drawing package to import into your Azure Maps Creator resource.
344+
345+
:::image type="content" source="./media/creator-indoor-maps/onboarding-tool/review-download.png" alt-text="Screenshot showing the manifest JSON.":::
346+
347+
## Step 4: Prepare the drawing package
348+
349+
You should now have all the DWG drawings prepared to meet Azure Maps Conversion service requirements. A manifest file has also been created to help describe the facility. All files need to be compressed into a single archive file, with the `.zip` extension. It's important that the manifest file is named `manifest.json` and is placed in the root directory of the drawing package. All other files can be in any directory of the drawing package if the filename includes the relative path to the manifest. For an example of a drawing package, see the [sample drawing package v2].
350+
351+
:::zone-end
352+
223353
## Next steps
224354

225355
> [!div class="nextstepaction"]
226356
> [Tutorial: Creating a Creator indoor map]
227357
358+
<!--------------------- Drawing Package v1 links--------------------------------------------------->
228359
[Azure Maps Conversion service]: /rest/api/maps/v2/conversion
229-
[sample drawing package]: https://github.com/Azure-Samples/am-creator-indoor-data-examples
360+
[sample drawing package]: https://github.com/Azure-Samples/am-creator-indoor-data-examples/tree/master/Drawing%20Package%201.0
230361
[Manifest File Properties]: drawing-requirements.md#manifest-file-requirements
231362
[Drawing Package Requirements]: drawing-requirements.md
232363
[Tutorial: Creating a Creator indoor map]: tutorial-creator-indoor-maps.md
364+
365+
<!--------------------- Drawing Package v2 links--------------------------------------------------->
366+
[Conversion service v2]: https://aka.ms/creator-conversion
367+
[sample drawing package v2]: https://github.com/Azure-Samples/am-creator-indoor-data-examples/tree/master/Drawing%20Package%202.0
368+
[Azure Maps Creator onboarding tool]: https://azure.github.io/azure-maps-creator-onboarding-tool
369+
[manifest files]: /azure/azure-maps/drawing-requirements#manifest-file-requirements
370+
[wayfinding]: creator-indoor-maps.md#wayfinding-preview
371+
[facility level]: drawing-requirements.md#facility-level

0 commit comments

Comments
 (0)