4 SmartSearch Consumer Events and Definitions
This chapter provides information on SmartSearch consumer events and definitions
The events in SmartSearch provide an event-driven architecture for creating, updating, and deleting Topology Vertices and Edges. These are listed as follows and are available as messages in the ora-uim-topology topic.
Table 4-1 SmartSearch Events
| SmartSearch Event | Definition |
|---|---|
|
TopologyEdgeCreate |
This event supports the creation of all types of Topology Edges except Profile Edges. |
|
TopologyEdgeDelete |
This event supports the deletion of all types of Topology Edges except Profile Edges. |
|
TopologyEdgeUpdate |
This event supports updates of all types of Topology Edge except Profile Edges. |
|
TopologyNodeCreate |
This event supports the creation of all types of Topology Vertices except Profile Vertices. |
|
TopologyNodeDelete |
This event supports the deletion of all types of Topology Vertices except Profile Vertices. |
|
TopologyNodeUpdate |
This event supports updates of all types of Topology Vertices except Profile Vertices. |
TopologyEdgeCreate
The following table provides the TopologyEdgeCreate event details and the corresponding values:
Table 4-2 TopologyEdgeCreate
| Event Details | Value |
|---|---|
|
Summary |
Receives messages for creating Topology Edges. |
|
Message Header (with examples) |
eventType: “TopologyEdgeCreate” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn” |
|
Topic |
ora-uim-topology |
|
Producer |
UIM, any External System, typically an Inventory System. |
|
Consumer |
SmartSearch |
|
URL |
Provided during the deployment. |
|
Schemas |
Edge |
Example Payload:
{
"entityId": 0,
"entityVersion": 0,
"businessObjectClass": "PipeDAO",
"technology": "WDM",
"id": "P67336P3",
"name": "PLANO / DALLAS / 7675",
"edgeType": "COMMUNICATES_WITH",
"fromNode": 2997853,
"fromNodeBusinessObjectClass": "LogicalDeviceDAO",
"fromNodeData": "oracle.communications.platform.entity.impl.PipeTerminationPointDAO-135000054",
"isPipeInterfaceTerminated": true,
"toNode": 2997849,
"toNodeBusinessObjectClass": "LogicalDeviceDAO",
"toNodeData": "oracle.communications.platform.entity.impl.PipeTerminationPointDAO-135000056",
"referenceId": 135000053,
"inventoryStatus": "INSTALLED",
"createdDate": "2024-11-15T08:25:42.456Z",
"createdUser": "inv",
"lastModifiedDate": "2024-11-15T08:25:42.456Z",
"properties": {
"SmartSearchProperties.aTerminationPoint": "8475001",
"SmartSearchProperties.zLocation": "[{\"id\":\"8250005\",\"name\":\"DALLASTEST1034\"}]",
"SmartSearchProperties.zTerminationPoint": "8475002",
"SmartSearchProperties.zTerminationDevice": "[{\"id\":\"L4801024\",\"name\":\"DALLASTEST1034.P01.LD\",\"businessObjectType\":\"LogicalDeviceDAO\"}]",
"SmartSearchProperties.isNameOverridden": "false",
"SmartSearchProperties.aLocation": "[{\"id\":\"8250002\",\"name\":\"PLANOTEST1034\"}]",
"SmartSearchProperties.aTerminationDevice": "[{\"id\":\"L4726027\",\"name\":\"PLANOTEST1034.P01.LD\",\"businessObjectType\":\"LogicalDeviceDAO\"}, {\"id\":\"5325003\",\"name\":\"PLANOTEST1034.P01.EQP\",\"businessObjectType\":\"EquipmentDAO\"}]"
},
"maxBandwidth": 0,
"totalCapacity": 0,
"availableCapacity": false,
"isChannelized": false,
"capacities": [],
"specName": "CWDM_Optical_Fiber",
"fromNodeReferenceId": "133500015",
"toNodeReferenceId": "133500016",
"trailPaths": 0
}TopologyEdgeUpdate
The following table provides the TopologyEdgeUpdate event details and the corresponding values:
Table 4-3 TopologyEdgeUpdate
| Event Details | Value |
|---|---|
|
Summary |
Receives messages for updating Topology Edges. |
|
Message Header (with examples) |
eventType: “TopologyEdgeUpdate” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn” |
|
Topic |
ora-uim-topology |
|
Producer |
UIM, any External System, typically an Inventory System. |
|
Consumer |
SmartSearch |
|
URL |
Provided during the deployment. |
|
Schemas |
Edge |
Example Payload:
{
"entityId": 2997901,
"entityVersion": 1,
"businessObjectClass": "PipeDAO",
"technology": "WDM",
"id": "P67336P3",
"name": "PLANO / DALLAS / 7675",
"edgeType": "COMMUNICATES_WITH",
"isPipeInterfaceTerminated": true,
"referenceId": 135000053,
"inventoryStatus": "INSTALLED",
"createdDate": "2024-11-15T02:55:42.000Z",
"createdUser": "inv",
"lastModifiedDate": "2024-11-15T02:55:42.000Z",
"lastModifiedUser": "inv",
"properties": {
"SmartSearchProperties.zLocation": "[]",
"SmartSearchProperties.zTerminationDevice": "[]",
"SmartSearchProperties.aLocation": "[{\"id\":\"8250002\",\"name\":\"PLANOTEST1034\"}]",
"SmartSearchProperties.aTerminationDevice": "[{\"id\":\"L4726027\",\"name\":\"PLANOTEST1034.P01.LD\",\"businessObjectType\":\"LogicalDeviceDAO\"}, {\"id\":\"5325003\",\"name\":\"PLANOTEST1034.P01.EQP\",\"businessObjectType\":\"EquipmentDAO\"}]"
},
"maxBandwidth": 0,
"totalCapacity": 0,
"availableCapacity": false,
"isChannelized": false,
"capacities": [],
"specName": "CWDM_Optical_Fiber",
"trailPaths": 0
}TopologyEdgeDelete
The following table provides the TopologyEdgeDelete event details and the corresponding values:
Table 4-4 TopologyEdgeDelete
| Event Details | Value |
|---|---|
|
Summary |
Receives messages for deleting Topology Edges. |
|
Message Header (with examples) |
eventType: “TopologyEdgeDelete” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn” |
|
Topic |
ora-uim-topology |
|
Producer |
UIM, any External System, typically an Inventory System. |
|
Consumer |
SmartSearch |
|
URL |
Provided during the deployment. |
|
Schemas |
Edge |
Example Payload:
{
"entityVersion": 0,
"businessObjectClass": "PipeDAO",
"edgeType": "COMMUNICATES_WITH",
"referenceId": 135000053
}TopologyNodeCreate
The following table provides the TopologyNodeCreate event details and the corresponding values:
Table 4-5 TopologyNodeCreate
| Event Details | Value |
|---|---|
|
Summary |
Receives messages for creating Topology Nodes and Vertices. |
|
Message Header (with examples) |
eventType: “TopologyNodeCreate” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn” |
|
Topic |
ora-uim-topology |
|
Producer |
UIM, any External System, typically an Inventory System. |
|
Consumer |
SmartSearch |
|
URL |
Provided during the deployment. |
|
Schemas |
Vertex |
Example Payload:
{
"entityId": 0,
"entityVersion": 0,
"businessObjectClass": "LogicalDeviceDAO",
"id": "L4726024",
"name": "PLANO.LD",
"specName": "Ciena 6500",
"inventoryStatus": "INSTALLED",
"deviceIdentifier": "PLANO.LD",
"referenceId": 133500012,
"relationships": {
"vendor": "Ciena",
"locationReference": "18000003"
},
"properties": {
"SmartSearchProperties.locationId": "750002",
"SmartSearchProperties.isNameOverridden": "false"
},
"createdDate": "2024-11-15T08:14:24.482Z",
"createdUser": "inv",
"lastModifiedDate": "2024-11-15T08:14:24.482Z"
}TopologyNodeUpdate
The following table provides the TopologyNodeUpdate event details and the corresponding values:
Table 4-6 TopologyNodeUpdate
| Event Details | Value |
|---|---|
|
Summary |
Receives messages for updating Topology Nodes and Vertices. |
|
Message Header (with examples) |
eventType: “TopologyNodeUpdate” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn” |
|
Topic |
ora-uim-topology |
|
Producer |
UIM, any External System, typically an Inventory System. |
|
Consumer |
SmartSearch |
|
URL |
Provided during the deployment. |
|
Schemas |
Vertex |
Example Payload:
{
"entityId": 0,
"entityVersion": 0,
"businessObjectClass": "LogicalDeviceDAO",
"id": "L4726024",
"name": "PLANO.P01.LD",
"specName": "Ciena 6500",
"inventoryStatus": "INSTALLED",
"deviceIdentifier": "PLANO.LD",
"referenceId": 133500012,
"relationships": {
"childDeviceReference": "",
"vendor": "Ciena",
"locationReference": "18000003",
"necReference": "",
"parentDeviceReference": ""
},
"properties": {
"SmartSearchProperties.locationId": "750002",
"SmartSearchProperties.isNameOverridden": "false"
},
"createdDate": "2024-11-15T08:16:19.359Z",
"lastModifiedDate": "2024-11-15T08:16:19.359Z",
"lastModifiedUser": "inv"
}TopologyNodeDelete
The following table provides the TopologyNodeDelete event details and the corresponding values:
Table 4-7 TopologyNodeDelete
| Event Details | Value |
|---|---|
|
Summary |
Receives messages for deleting Topology Nodes or Vertices. |
|
Message Header (with examples) |
eventType: “TopologyNodeDelete” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn” |
|
Topic |
ora-uim-topology |
|
Producer |
UIM, any External System, typically an Inventory System. |
|
Consumer |
SmartSearch |
|
URL |
Provided during the deployment. |
|
Schemas |
Vertex |
Example Payload:
{
"entityVersion": 0,
"businessObjectClass": "LogicalDeviceDAO",
"referenceId": 133500012
}