OLT Cloud - en

Open

'

Type of Integration

The OZmap-OLT Cloud integration is a Passive-Direct type, developed by the OLT Cloud team.

Description

OLT Cloud is a provisioning and monitoring system focused on managing PONs, Boxes, OLTs, and ONUs, either individually or shared.

The integration is responsible for synchronizing the Boxes between the systems, managing the creation and cancellation of Clients in OZmap based on OLT Cloud data, and updating client ports.

Functionality Summary

Functionalities

Below, the functionalities listed in the summary will be described to help you understand how the synchronization flow works.

Box Synchronization

The synchronization of boxes in OLT Cloud aims to keep the information of boxes and their ports always up to date, based on the data obtained from OZmap. The process allows configuring which types of OZmap boxes should be synchronized and from which projects should be extracted. The boxes are linked to OLT Cloud through their respective IDs in OZmap, and this information is stored in a specific field of the box table in OLT Cloud called “ex_id.”

The frequency of this synchronization is determined by the OLT Cloud team and depends on the number of boxes the client has. It can occur every hour if the client has a small number of boxes in their database or only twice a day (at 5 AM and 5 PM) if the client has a large number of boxes.

The synchronization process works as follows:

1. The client configures the synchronization of OZmap boxes for their database in OLT Cloud, defining in OLT Cloud which types of OZmap boxes should be imported and from which projects.

2. The synchronized OZmap boxes will contain information in OLT Cloud such as: number of ports, name, implementation status, and coordinates.

3. A routine is executed periodically (at the time interval determined by the OLT Cloud team, as previously explained) and performs the following functions:

   • It creates and deletes boxes in OLT Cloud if they have been added or removed in OZmap.

   • It updates the box data in OLT Cloud if any changes have been made in OZmap, such as name, coordinates, or the number of ports.

Client Creation

The creation of clients in OZmap is triggered when a client is linked to a box in OLT Cloud. During this process, the integration checks if the client is already registered in OZmap. The identification may vary depending on the specifics of the ERP integrated with OLT Cloud, but generally follows this flow:

1. Initial check: The properties linked to the corresponding box are retrieved from OZmap. Then, it is verified if any of these properties have a customer code that matches the contract ID of a client in OLT Cloud. This contract ID is the same as the one originated from the ERP.

2. Alternative search via PPPoE: If the client is not found by the contract ID, an attempt is made to identify them through the "user_PPPoE" field, using the value linked to the "onu" field associated with the client in the system.

3. Search by Serial Number: If the client is still not found, the integration attempts to identify them by the Serial Number linked to an ONU in OZmap.

4. Client Creation: If the client is not identified by any of the above methods, they are created in OZmap. The client is then associated with the corresponding Box and port, with the status "implanted". Additionally, the ONU data is recorded in the system, along with a note indicating that the creation was performed via OLT Cloud.

Client Port Update

By default, client port updates in OLT Cloud are carried out based on OZmap data. Thus, if a client's port is changed in OZmap, this information is automatically replicated in OLT Cloud. The integration searches for the client in OZmap using different identification criteria, depending on how the link was established: by the OZmap code associated with the contract ID in OLT Cloud, by the PPPoE username, or by the Serial Number. Once the client is located, the integration updates their port in OLT Cloud with the information from OZmap.

However, if the "Save data to OZmap" setting is enabled in OLT Cloud, the update becomes bilateral. In this case, port changes made in OLT Cloud will also be replicated in OZmap, ensuring that the information remains synchronized across both systems.

Client Cancellation

Client cancellation occurs when the client is unlinked from a Box in OLT Cloud. In this case, the integration identifies the client in OZmap using different criteria, depending on how the link was established: by the OZmap code associated with the contract ID in OLT Cloud, by the PPPoE username, or by the Serial Number. Once the client is located, they are disconnected from the Box in OZmap, while their property remains registered in the system. It is important to note that even after cancellation in OZmap, the client will continue to exist in OLT Cloud.

Access Data

The access details required for operations performed by the integrator are:

Learn more about how to configure this data by contacting OLT Cloud support.

OZmap

IP Allowlist

If the OZmap server is in an ON-Premises environment, it is necessary to allow the IP of the server where OLT Cloud is located through the firewalls to access ports 80 and 9994 in the OZmap environment.

If your server is hosted by OZmap, these ports will already be open for the integrator

Questionnaire