COS Vetro Integration
This article outlines the integration between COS Business Engine (COS BE) and Vetro FiberMap, focusing on how network operators can benefit from seamless data exchange between their OSS/BSS systems and network design platforms.
Key Integration Features
- Bi-directional Data Flow:
- Import Vetro Service Location addresses into COS BE as network Objects (automatically or manually)
- Push Object data (status, service info, etc.) from COS BE to Vetro.
-
- Automatic synchronization of Service Location information on both sides
- Periodic and Immediate Syncs:
- Hourly partial sync from Vetro to COS BE.
- Instantaneous updates (within 5 seconds) from COS BE to Vetro upon data change.
- Optional full daily sync.
- Visibility of fiber design:
- Visibility in COS BE of Service Location information, fiber paths, and network design.
- Visibility in COS BE of Service Location information, fiber paths, and network design.
- Direct Navigation:
- Clickable links from COS BE to Vetro to zoom into specific service locations and vice versa from Vetro to COS BE.
Supported Data and Attributes
COS BE stores and shares the following Vetro-related data:
COS BE Field | Description |
---|---|
Object Number / ID | Unique identifier of the Object in COS BE |
Object Group | Classification for grouping |
Object Status | Not deliverable / Approved survey / Pending signup / In deployment / Deliverable |
Object Reachable | Yes / No |
Service Status | Inactive / Active / Awaiting Activation / Paused |
Drop Installed | Yes / No |
COS-Vetro Link | Direct link to Object in BE Admin and Vetro |
Address Import Flag | Enables auto-import from Vetro |
Building Type & Full Address | Required for automatic object creation |
Metadata and Attributes |
Map any Object metadata field in COS BE |
User Roles and Access
-
Network Owners (Business Engine Administration Portal Access):
-
Can import Vetro data via CSV.
-
View Vetro data
-
-
-
Generate Circuit Reports (this function is deprecated in Vetro and is replaced by a Vetro fiber path widget in the COS BE Deploy portal).
-
Use clickable links to navigate to Service Locations in Vetro.
-
-
Installers/Technicians (Deployment Portal):
-
Access Vetro data during installations.
- View fiber path.
- Navigate to Service Location in Vetro.
-
Enabling the Integration
To enable and configure the COS BE - Vetro integration:
-
Enable COS Integration in Vetro:
- Ensure the correct modules for BSS/OSS integration exists in Vetro.
-
Create API Token:
- Generate API key via the integration panel and share with the COS BE team.
-
Configure Access:
- Select relevant Projects and Plans.
- Editing privileges required for data push features.
-
Specify Integration Settings:
-
Decide whether to enable:
-
Auto-import of addresses from Vetro
-
COS → Vetro data push
-
COS metadata mapping in Vetro
-
-
Auto-Import Conditions
Objects are automatically created in COS BE from Vetro if the following are true:
-
COS BE has a valid API key for access.
-
Address Import flag is set to Yes.
-
Status and Group Name are correctly set.
-
Address is complete (Street, City, State, Zip).
-
Building Type is specified.
Synchronization Logic
Type | Direction | Trigger |
---|---|---|
Partial Sync | Bi-directional | Hourly. Updates Objects and Service locations that have changed since last sync. |
Full Sync | Bi-directional | Scheduled daily or on-demand by COS support. Updates all Objects and Service locations that have changed. |
Immediate Sync | COS BE --> Vetro | On any Object attribute change in COS BE |
Note: Either External Service Location ID or External Identification must be populated in COS BE for the sync to work. These can be added manually or via CSV import.