note

This document presents the main information on data importation between Vetro and OZmap and provides a pre-importation form as well.

This document presents the main information on data importation between Vetro and OZmap and provides a pre-importation form as well.

Description

The importation between Vetro and OZmap is conducted via API calls; we execute API calls to import elements into OZmap.

This documentation only addresses an initial import model. Import using different formats or adding more elements may be requested, subject to evaluation by the responsible team.

Once the importation is completed, reports are sent to the client containing all imported elements, and the reasons for any errors during importation, for elements that weren't imported.

Functionalities Summary

Import Settings and Customization

Functionality

Description

System Settings Import

Import POP levels, Boxes, and Cables.

Needed for importing POP types, box types, and cable types.

Tags Import

Import tags to differentiate between clients and buildings.

Tags are used to distinguish a client from a building imported from Vetro.

Fiber Profiles Import

Import all fiber profiles from Vetro.

Needed for importing cable types.

Types Import

Functionality

Description

Box Types Import

Import all box types from Vetro’s Box Layer.

Needed for box importation.

Pole Types Import

Import all pole types from Vetro’s Pole Layer.

Needed for pole importation.

Elements Import

Functionality

Description

Project Import

Import all or selected projects from Vetro.

The project will be imported as an empty project, without any elements and with the same area settings as in Vetro.

Pole Import

Import all or selected poles from Vetro projects.

Box Import

Import all or selected boxes from Vetro projects.

Vertical Buildings Import

Import all or selected vertical buildings from Vetro projects.

Properties and Clients Import

Import all or selected properties and clients from Vetro projects.

POP Import

Import all or selected POPs from Vetro projects.

Cables Import

Import all or selected cables from Vetro projects.

Splitter Import

Import all or selected splitters from Vetro projects.

ODFs Import

Import all or selected ODFs from Vetro projects.

Technical Reserves (Spares) Import

Import all or selected technical reserves from Vetro projects.

Boxes Internal Connections Import

Import all or selected internal connections in boxes from Vetro projects.

Functionalities

As follows, we’ll describe the functionalities of the import service between Vetro and OZmap, allowing a better understanding of the importation flow.

Settings and Customization Imports

Settings and customization imports from Vetro are performed to ensure that the data utilizing them (Cable and Box Types, Properties, Clients, Poles, etc.) can be created with identical customizations in OZmap. The imports occur as follows:

IMPORTANT: Even if the client selects specific projects for importation from Vetro to OZmap, ALL items described in this section will be imported to OZmap, regardless of their usage in the selected projects.

Types Import

Type imports from Vetro are performed to enable data that utilizes them (Cables, Boxes, Splitters, Poles, etc.) to be created in OZmap. The imports occur as follows:

IMPORTANT: Even if the client selects specific projects for importation from Vetro to OZmap, ALL items described in this section will be imported to OZmap, regardless of their usage in the selected projects.

Elements Import

Element imports from Vetro aim to replicate documentation elements, either fully or partially. Element imports from Vetro occur as follows:

CAPTION:

“Includes mandatory importation of” - These are other elements that will also need to be imported along with the element selected by the client in the form.

“May depend on the importation of” - These are other elements that, if not imported, may prevent the creation of the elements in question. For example: When importing boxes, if a box is located on a pole in Vetro and that pole has not been previously imported into OZmap for some reason, the box cannot be created in OZmap either.

Standard Settings

Elements

Parameter

Description

Default

Projects to be imported

Use a list of projects to be imported into OZmap.

Disabled.

By default, all projects from Vetro will be imported.

Access Data

Vetro Import Form

Access data needed to fetch information via API from the Vetro and OZmap systems. (These data must be provided in the initial form).

OZmap

Parameter

Description

Example

URL OZmap

The OZmap address that will receive the imported elements.

https://cliente1.ozmap.com.br

Vetro

Parameter

Description

Example

URL Vetro

The Vetro address that will be used to query the elements.

https://vetro.io/v2

Vetro User

The user responsible for accessing the interface and API calls for Vetro.

user@vetro.com

Vetro User Password

The password for the Vetro user;

gXv3tr0

Common Doubts

Question

Answer

Functionality

Are any of the OZmap import service functionalities optional?

No. Currently, in the current version, all the elements described are imported.

All.

Is it possible to import only poles from specific Vetro projects?

Yes, the poles in Vetro are separated by projects. Thus, if the importation of a single project is requested, only the poles from that project will be imported.

Pole Importation

Is it possible to import only specific types of elements from Vetro?

No, currently all types of selected elements will be imported into OZmap, regardless of whether they are used or not.

-

Is it possible to translate types from Vetro to use existing types in OZmap?

No, currently it is not possible to translate element types, only to import the original types from Vetro into OZmap.

-