/
Vetro - en

Vetro - en

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

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

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

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:

  • System Settings: System settings including POP Levels, Box Levels, and Cable Levels, are imported.

    • For each layer concerning box, cable, and POP labels found in Vetro, a corresponding level is created in OZmap if one containing the same name does not already exist.

    • The imported levels in OZmap will be created following the already existing hierarchies in OZmap.

  • Fiber profiles: All fiber profiles from Vetro are fully imported into OZmap, even if identical profiles (name and specificities) already exist.

  • Box Templates: By default, all imported boxes from Vetro will receive an “Empty” template.

  • Tags: Tags named “house” and “office” will be created in OZmap to replace the client type classification used by Vetro.

 

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:

  • ODF Types: ODF types are imported during ODF importation, with the type name in OZmap defined by the number of ports the ODF has in Vetro.

    • For example, if a ODF has "12" ports in Vetro, a type named "12" will be created in OZmap.

  • POP Types: All POP types from Vetro are fully imported into OZmap, with the type name defined by the Layer name used in Vetro.

    • Includes mandatory importation of:

      • System Settings, as each Vetro Layer has an equivalent POP level in OZmap.

  • Splitter Types: Splitter types are imported during Splitter importation, with the type code in OZmap defined by the "placement" name and the number of ports in Vetro.

  • Pole Types: All pole types from Vetro are fully imported into OZmap, with the type name defined by the Layer name used in Vetro.

  • Box Types: All box types from Vetro are fully imported into OZmap, with the type name defined by the Layer name used in Vetro.

    • Includes mandatory importation of:

      • System Settings, as each Vetro Layer has an equivalent box level in OZmap.

  • Cable Types: Cable types are imported during cable importation, with the type code in OZmap defined by the "placement" name, the "label" name, and the "loose" and "fiber" quantities in Vetro.

    • Includes mandatory importation of:

      • Fiber Profiles, as each Vetro Layer has an equivalent cable level in OZmap.

 

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:

  • Projects: All selected projects from Vetro are imported into OZmap, replicating their characteristics in OZmap.

    • The importation only covers the project element information. All items within a Vetro project are imported separately through other element imports.

    • The OZmap project name will be the same as in Vetro.

    • The latitude and longitude of the OZmap project will be the same as in Vetro.

    • The coordinate area of the OZmap project will be the same as in Vetro.

  • Poles: All poles from Vetro are imported into OZmap from the pole layer, replicating their characteristics in OZmap.

    • Poles do not have a project in OZmap, but they do in Vetro. If the client requests the importation of selected projects only, only the poles from the selected project will be imported.

    • The OZmap pole name will be the Vetro pole ID. If there are multiple poles with the same name in Vetro, a number will be added after the pole name in OZmap to avoid duplicate name errors

    • The OZmap pole coordinates will be the same as in Vetro.

    • The OZmap pole observation will be the Vetro note.

    • Includes mandatory importation of:

      • Pole Types

  • Boxes: All boxes from Vetro are imported into OZmap from the box layer, replicating their characteristics in OZmap.

    • The OZmap box name will be defined by the ID or existing name in Vetro. If there are multiple boxes with the same name in Vetro, a number will be added after the box name in OZmap to avoid duplicate name errors.

    • The OZmap box type will be the same as in Vetro.

    • The OZmap box coordinates will be the same as in Vetro.

    • If the box is in “build” in Vetro, it will be created as implanted in OZmap. Otherwise, it will be created as Not implanted in OZmap.

    • The OZmap box observation will be the Vetro note.

    • Includes mandatory importation of:

      • Box Types

  • Vertical Buildings: All condominiums from Vetro are imported into OZmap from the customer layer, identified by the building type, replicating their characteristics in OZmap.

    • The OZmap condominium name will be defined by the ID or company name in Vetro. If there are multiple buildings with the same name in Vetro, a number will be added after the name in OZmap to avoid duplicate name errors.

    • The OZmap condominium coordinates will be the same as in Vetro.

    • If the condominium is in “build” in Vetro, it will be created as implanted in OZmap. Otherwise, it will be created as Not implanted in OZmap.

    • The OZmap condominium observation will be the Vetro note.

  • Properties and Clients: All properties and clients from Vetro are imported into OZmap from the customer layer, replicating their characteristics in OZmap.

    • The OZmap client code will be the Vetro ID. If there are multiple clients with the same code in Vetro, a number will be added after the code in OZmap to avoid duplicate code errors.

    • The OZmap client name will be the company name of the property in Vetro.

    • If the property is in “build” in Vetro, it will be created as Implanted in OZmap. Otherwise, it will be created as Not implanted in OZmap.

    • The OZmap property coordinates will be the same as in Vetro.

    • The OZmap property observation will be the Vetro note.

  • POPs: All POPs from Vetro are imported into OZmap from the pops layer, replicating their characteristics in OZmap.

    • The OZmap POP name will be defined by the ID or POP name in Vetro. If there are multiple POPs with the same name in Vetro, a number will be added after the name in OZmap to avoid duplicate name errors.

    • If the POP is in “build” in Vetro, it will be created as Implanted in OZmap. Otherwise, it will be created as Not implanted in OZmap.

    • The OZmap POP coordinates will be the same as in Vetro.

    • The OZmap POP observation will be the Vetro note.

    • Includes mandatory importation of:

      • POP Types

  • Cables: All cables from Vetro are imported into OZmap from the cable layer, replicating the characteristics in OZmap.

    • The name of the OZmap cable will be the ID if it exists, or the cable name in Vetro.

    • The points of the OZmap cable will be the same as in Vetro.

    • If the cable is in “build” in Vetro, it will be created as Implanted in OZmap. Otherwise, the cable will be created as Not Implanted in OZmap.

    • The ends of the OZmap cables will be the same as the ends in Vetro.

    • Includes mandatory importation of:

      • Cable Types

    • May depend on the importation of:

      • Boxes, Condominiums, POPs, and Properties.

  • Splitters: All splitters from Vetro are imported into OZmap from the splitter layer, replicating the characteristics in OZmap.

    • The name of the OZmap splitter will be the ID from Vetro.

    • The box of the OZmap splitter will be the same as in Vetro.

    • The observation of the OZmap splitter will be the note from Vetro.

    • If the splitter is in “build” in Vetro, it will be created as Implanted in OZmap. Otherwise, the splitter will be created as Not Implanted in OZmap.

    • By default, splitters will be created in OZmap with the attribute “Allow Client Connection” set to false.

    • Includes mandatory importation of:

      • Splitter Types

    • May depend on the importation of:

      • Boxes, Condominiums and POPs.

  • ODFs: All ODFs from Vetro are imported into OZmap from the DIO layer, replicating the characteristics in OZmap.

    • The name of the OZmap ODF will be the ID from Vetro.

    • The box or the POP of the OZmap ODF will be the same as in Vetro.

    • The note of the OZmap ODF will be the note from Vetro.

    • If the ODF is in “build” in Vetro, it will be created as Implanted in OZmap. Otherwise, the ODF will be created as Not Implanted in OZmap.

    • Includes mandatory importation of:

      • ODF Types

    • May depend on the importation of:

      • Boxes

  • Internal Box Connections: All internal box connections from Vetro are imported into OZmap.

    • Internal box connections refer to connections between elements within a box, such as connections between cables, between splitters and cables, and between splitters and splitters.

    • May depend on the importation of:

      • Cables and Splitters

  • Technical Reserves (SPAREs): All technical reserves from Vetro are imported into OZmap from the technical reserves layer, replicating the characteristics in OZmap.

    • May depend on the importation of:

      • Cables

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

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

Parameter

Description

Example

URL OZmap

The OZmap address that will receive the imported elements.

https://cliente1.ozmap.com.br

Vetro

Parameter

Description

Example

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

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.

-

 

Related content

Vetro - pt
Vetro - pt
More like this
Tomodat - pt
Tomodat - pt
Read with this
Vetro - es
Vetro - es
More like this
Integrator's Guide
Integrator's Guide
More like this
Codemaps
More like this