This documentation covers the integration with the Sytex system. The integration is performed through API calls from the Integrator, utilizing the API provided by OZmap.
This documentation covers the integration with the Sytex system. The integration is performed through API calls from the Integrator, utilizing the API provided by OZmap.
The OZmap-Sytex integration is of the Passive-Direct type.
Sytex is a platform for managing technology deployment and maintenance activities, which streamlines the management of processes and fieldwork.
The integration with OZmap is based on a query performed once a day on the OZmap boxes to synchronize these boxes in Sytex.
Functionality | Description | Direction of the integration |
|---|---|---|
Box synchronization | Update and creation of OZmap boxes in Sytex | OZmap => Sytex |
Below are the functionalities described in the summary to help you understand how the synchronization flow works.
The box synchronization process occurs as follows:
Once a day, at 9 PM, a query is performed in OZmap to obtain information about all boxes that are not in the 'In project' deployment status.
After the query, a verification is performed in Sytex to determine which boxes need to be updated or created.
Sytex checks each box found in OZmap by name, verifying if a box with the same name exists in Sytex.
If it doesn't exist, the OZmap box is created in Sytex;
If it exists, the Sytex box is updated with the latest data from the OZmap box.
In Sytex, OZmap boxes are created as Network Elements (EdR), with their name, type, and coordinates filled in and updated with the data obtained from OZmap.
Additionally, in Sytex, each box represents a location point, where a technician who needs to perform a task in Sytex can assign a new activity to it, such as a deployment/maintenance form, for example.
Access data required for operations performed by the integrator are:
Learn more about how to configure this data by contacting Sytex support.
Parameter | Description | Example |
|---|---|---|
API URL | OZmap address, with the default port. | |
API Key | Token associated with the integration user's account registered in OZmap. The user must have access to the projects that the integration will work on (User's choice). Tutorial on how to generate a user/key. | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtb2R1bGUiOiJhcGkiLCJ1c2VyIjoiNWQ5ZjNmYjgyMDAxNDEwMDA2NDdmNzY4IiwiY3JlYXRpb25EYXRlIjoiMjAyMC0wOC0yNFQxNjoxMjoyMS43MTdaIiwiaWF0IjoxNTk6Mjg1NTQxfQ.S215vbHlBLtZSzxmORIc2sH1lEKi5VALKBqZB1VcFCE |
If the OZmap server is in an ON-Premises environment, it is necessary to allow the IP of the server where Sytex is located in 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
Question | Answer |
|---|---|
If a box is deleted in OZmap, will it be deleted in Sytex? | No, currently the integration only creates and updates OZmap boxes in Sytex. |