About the import of Fiber Optic Network design files in MapAll

This article highlights all the information relevant to the import of Fiber Optic Network design files into the Planning tool in MapAll.

Table of Contents

1. About the import of Fiber Optic Network design files in MapAll
2. MapAll plan
   1. GeoJSON specifications
   2. Shapefile specifications
   3. How to import a MapAll plan

1. External plan
   1. What is an integration?
      
      1. Most common External plan file types
   2. How to import an External plan (integration)

   3. Plan imported with errors

      1. Importing a DXF Virgin Media plan into MapAll

About the import of Fiber Optic Network design files in MapAll

MapAll enables Designers and Project Managers to design, view and edit new and existing Fiber Optic Network designs. Users can design their own plans from scratch using the various tools available in the Planning tool's toolbar or import either MapAll format files or External design files using an existing integration.

MapAll plan

A MapAll plan is defined as a group of files in the GeoJSON or Shapefile format, contained within a compressed folder (.zip), where each file corresponds to a specific layer (e.g. ducts, cables, boxes).

The data contained within these files or layers must be organised according to a predetermined data structure. This data structure is outlined in the MapAll GeoJSON specifications and MapAll Shapefile specifications.

GeoJSON specifications

Click here to download a .PDF file containing MapAll's GeoJSON specifications.

Shapefile Specifications

Click here to download a .PDF file containing MapAll's Shapefile Specifications.

How to import a MapAll plan

To import a MapAll plan, Project Managers should:

1. In the Planning tool, click the button labelled "Import a plan", located in the toolbar, between the buttons "Save to MapAll" and "Export to GeoJSON". This action will result in the display of a dialog titled "Import plan data" in the middle of the screen, with the "MapAll Plan" tab selected by default. 
   
2. Select a file to upload, by either:
   
   1. Browsing a local file, by clicking the button labelled "Browse" to browse a local file"
      
   2. Dragging and dropping a file, by clicking and holding a file from your local files and dropping it into the dotted field labelled "Drag and drop here or browse"
      
   Following the selection of a file for uploading, an indication will be displayed below the "Drag and drop or browse" field, which will present the file name, size, and an option to remove the file, represented by a bin icon (🗑).
3. With the correct file selected, click the button that is labelled "IMPORT PLAN" to initiate the import. A window titled "Processing plan details" will be displayed with the following message:
   "We are busy processing the plan details. This may take several minutes, depending on the plan size."
   
   After processing, one of the following scenarios will occur:
   
   1. If the plan has been successfully uploaded, a dialogue box entitled "Plan import successful" will appear with the following message: "The plan has been imported successfully. You can review and update the plan as required, before saving the plan to the MapAll system."
      

1. 1. If the plan fails to import, a dialogue box entitled "Plan import failed" will appear with the following message: "The plan has failed to import correctly."
      

External plan

An External plan is defined as any file of a Fibre Optic Network design or plan that has been created using software other than MapAll, such as AutoCAD or QGIS. In summary, every Fibre Optic Network design file that does not adhere to the data structure outlined in MapAll's Shapefile specifications or MapAll's GeoJSON specifications is considered to be an external plan.

It is imperative to note that a file-based integration is required to upload an external plan.

What is an integration?

An integration, or file-based integration, is a method of connecting different software systems by transferring data via structured files, providing a straightforward way to exchange information. In the context of MapAll, integration is defined as the connection between our integrator and your file system. It is done by property mapping and relies on a minimally conceived design to ensure that lines (e.g. lines: cables, ducts, etc) and points (e.g. points: poles, chambers, etc) meet and that all map elements are correctly positioned.

Most common External plan file types

The following is a list of the most common external plan file types:

1. .dxf
   (AutoCAD DXF (Drawing Interchange Format, or Drawing Exchange Format) is a CAD data file format developed by Autodesk for enabling data interoperability between AutoCAD on different platforms.)
2. Shapefiles
   (Shapefiles is a geospatial vector data format for geographic information system (GIS) software. It is developed and regulated by Esri as a mostly open specification for data interoperability among Esri and other GIS software products.)
3. GeoJSON
   (GeoJSON is an open standard format designed for representing simple geographical features, along with their non-spatial attributes. It is based on the JSON format.)

How to import an External plan (integration)

To import an External plan, Project Managers should:

1. In the Planning tool, click the button labelled "Import a plan", located in the toolbar, between the buttons "Save to MapAll" and "Export to GeoJSON". This action will result in the display of a dialog titled "Import plan data" in the middle of the screen, with the "MapAll Plan" tab selected by default. 
   
2. Click the circle to the left of "External plan" to view the External plan tab.
   
3. Select an integration by clicking on the "Select integration" field below the text "Select the integration applicable for the plan:". This will open a drop-down menu listing the integrations available in the system. Click on the appropriate option.
   
4. Select a file to upload, by either:
   
   1. Browsing a local file, by clicking the button labelled "Browse" to browse a local file"
      
   2. Dragging and dropping a file, by clicking and holding a file from your local files and dropping it into the dotted field labelled "Drag and drop here or browse"
      
   Following the selection of a file for uploading, an indication will be displayed below the "Drag and drop or browse" field, which will present the file name, size, and an option to remove the file, represented by a bin icon (🗑).
5. With the correct file selected, click the button that is labelled "IMPORT PLAN" to initiate the import. A window titled "Processing plan details" will be displayed with the following message:
   "We are busy processing the plan details. This may take several minutes, depending on the plan size."
   
   After processing, one of the following scenarios will occur:
   1. If the plan has been successfully uploaded, a dialogue box entitled "Plan import successful" will appear with the following message: "The plan has been imported successfully. You can review and update the plan as required, before saving the plan to the MapAll system."
   2. If the plan fails to import, a dialogue box entitled "Plan import failed" will appear with the following message: "The plan has failed to import correctly."
   3. In the event that the plan has been successfully imported with errors, a dialogue box entitled "Plan imported with errors" will appear with the following message: "The plan has been imported successfully with some errors. Not all features have been connected correctly. 
      

Plan imported with errors

In the event of a significant divergence in the positions of the elements, the integrator will attempt to resolve them automatically and correct the positions according to the established standards. However, if a substantial number of elements are incorrectly positioned on the map, the integrator will display an error and the plan will need to be revised.

As mentioned in "What is an integration?", the integration process is done by property mapping, which relies on a minimally conceived design to ensure that lines (e.g. lines: cables, ducts, etc.) and points (e.g. points: poles, chambers, etc.) meet and that all map elements are correctly positioned.

In such cases, depending on the number and type of issues identified, these can be rectified within the Planning tool following the import.

The issues are highlighted in two ways:

1. in the features panel under the "Issues" tab
   
2. on the map with a red highlighting around the asset with the issue.
   

However, in the majority of cases, such errors are indicative of design errors and may require fixing before the import.

Fixing issues in the Planning tool

Depending on the nature of the issue, the Planning tool may offer the user the option to fix it from the Issues tab within the Features panel.In order to do so, the user should:

1. Hover the mouse over the Issue icon (⚠), located to the left of the asset's name.
   (A balloon will then appear, displaying the type of issue, and, in some cases, an option to correct the issue automatically.)
   
2. The user should then click the button labelled "✔ Correct" to proceed with the fix.
   

Importing a DXF Virgin Media plan into MapAll

This video provides step-by-step instructions on how to import a Virgin Media DXF plan into MapAll and how to resolve common design issues that may be flagged after the import process is complete.