UTIA Events and Definitions

2 UTIA Events and Definitions

The types of events in UTIA are Topology events and Performance or Fault events. The Topology events provide an event-driven architecture for creating, updating, and deleting Topology Vertices and Edges. The Topology events are listed as follows and are available as messages in the ora-uim-topology topic.

Table 2-1 Topology Events

Topology 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.
TopologyProfileCreate	This event supports the creation of Topology Profiles which represent an end-to-end trail of nodes and edges. For example, Service Topology is a Topology profile.
TopologyProfileDelete	This event supports the deletion of Topology Profiles.
TopologyProfileDelete	This event supports the deletion of Topology Profiles.
TopologyProfileUpdate	This event supports updates Topology Profiles.

TopologyEdgeCreate

The following table provides the TopologyEdgeCreate event details and the corresponding values:

Table 2-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	UTIA
URL	Provided during the deployment.
Schemas	Edge

Example Payload:

{
            "businessObjectClass": "PacketConnectivityDAO",
            "inventoryStatus": "INSTALLED",
            "name": "ELCN01PR.SR-1 / WSHN01DC.SR-1 / 40GigE / GE10 / 1",
            "referenceId": 1579678,
            "specName": "INNI Connectivity",
            "technology" : "Ethernet",
            "ratecode" : "10GigE",
            "fromNodeReferenceId" : "655350",
            "fromNodeBusinessObjectClass" : "LogicalDeviceDAO",
            "toNodeReferenceId" : "218472",
            "toNodeBusinessObjectClass" : "LogicalDeviceDAO",
            "edgeType" : "COMMUNICATES_WITH"
}

TopologyEdgeDelete

The following table provides the TopologyEdgeDelete event details and the corresponding values:

Table 2-3 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	UTIA
URL	Provided during the deployment.
Schemas	Edge

Example Payload (using Edge entityID):

{
            "entityId" : 1356
}

Example Payload (using businessObjectClass, referenceId and edgeType):

{
            "businessObjectClass": "PacketConnectivityDAO",
            "referenceId": 1579678,
            "edgeType" : "COMMUNICATES_WITH"
}

Example Payload (using fromNode, toNode and edgeType):

{
 "businessObjectClass": "TopologyOnly",
 "fromNode" : 1354,
 "toNode" : 1355,
 "edgeType" : "PARENT_DEVICE"
 }

TopologyEdgeUpdate

The following table provides the TopologyEdgeUpdate event details and the corresponding values:

Table 2-4 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	UTIA
URL	Provided during the deployment.
Schemas	Edge

Example Payload (Communication Edge):

{
            "entityId" : 1356,
            "businessObjectClass": "PacketConnectivityDAO",
            "inventoryStatus": "INSTALLED",
            "name": " ELCN01PR.SR-1 / WSHN01DC.SR-1 / 40GigE / GE10 / 1",
            "referenceId": 1579678,
            "specName": "INNI Connectivity",
            "technology" : "Ethernet",
            "ratecode" : "10GigE",
            "fromNode" : 4889,
            "fromNodeBusinessObjectClass" : "LogicalDeviceDAO",
            "toNode" : 6584,
            "toNodeBusinessObjectClass" : "LogicalDeviceDAO",
            "edgeType" : "COMMUNICATES_WITH"
}

Example Payload (Topological Edge with Edge Label = PARENT_DEVICE):

{
            "businessObjectClass": "TopologyOnly",
            "inventoryStatus": "INSTALLED",
            "name": "EquipmentShelfI-PhysicalDeviceI",
            "fromNodeReferenceId" : "675001",
            "fromNodeBusinessObjectClass" : "EquipmentDAO",
            "toNodeReferenceId" : "600001",
            "toNodeBusinessObjectClass" : "PhysicalDeviceDAO",
            "edgeType" : "PARENT_DEVICE",
            "properties" : {
                "propertyOne" : "newValueOne",
                "propertyTwo" : "newValueTwo"
            }
}

TopologyNodeCreate

The following table provides the TopologyNodeCreate event details and the corresponding values:

Table 2-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	UTIA
URL	Provided during the deployment.
Schemas	Vertex

Example Payload:

{
            "businessObjectClass": "LogicalDeviceDAO",
            "inventoryStatus": "INSTALLED",
            "name": "BDFR01TX.T-1.LD",
            "id" : "BDFR01TX.T-1",
            "referenceId": 3375004,
            "specName": "Cisco ASR 920 LD"
}

TopologyNodeDelete

The following table provides the TopologyNodeDelete event details and the corresponding values:

Table 2-6 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	UTIA
URL	Provided during the deployment.
Schemas	Vertex

Example Payload (using entityID):

{
            "entityId" : 1354
}

Example Payload (using businessObjectClass, referenceId):

{
            "businessObjectClass": "LogicalDeviceDAO",
            "referenceId": 999997
}

TopologyNodeUpdate

The following table provides the TopologyNodeUpdate event details and the corresponding values:

Table 2-7 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	UTIA
URL	Provided during the deployment.
Schemas	Vertex

Example Payload:

{
            "businessObjectClass": "LogicalDeviceDAO",
            "inventoryStatus": "INSTALLED",
            "name": "BDFR01TX.T-1.LD",
            "nodeCategory": "Access",
            "id" : "BDFR01TX.T-1",
            "referenceId": 3375004,
            "specName": "Cisco ASR 920 LD"
}

TopologyProfileCreate

The following table provides the TopologyProfileCreate event details and the corresponding values:

Table 2-8 TopologyProfileCreate

Event Details	Value
Summary	Receives messages for creating Topology Profiles.
Message Header (with examples)	eventType: “TopologyProfileCreate” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn”
Topic	ora-uim-topology
Producer	UIM, any External System, typically an Inventory System.
Consumer	UTIA
URL	Provided during the deployment.
Schemas	Profile, ProfileEdge, ProfileVertex

Example Payload:

{
  "entityId": 0,
  "entityVersion": 0,
  "businessObjectClass": "ServiceConfigurationVersionDAO",
  "id": "5100001:1",
  "name": "dev_service:dev_service - 1",
  "referenceId": 118500001,
  "zoomLevel": 0,
  "refresh": false,
  "profileVertices": [
    {
      "entityId": 0,
      "entityVersion": 0,
      "businessObjectClass": "LogicalDeviceDAO",
      "id": "5475001",
      "exclude": false,
      "device": 100155338,
      "name": "dev_device",
      "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
      "xPos": 0,
      "yPos": 0,
      "profile": 0,
      "createdDate": "2023-03-06T15:41:17.076Z",
      "lastModifiedDate": "2023-03-06T15:41:17.076Z"
    },
    {
      "entityId": 0,
      "entityVersion": 0,
      "businessObjectClass": "LogicalDeviceDAO",
      "id": "5475003",
      "exclude": false,
      "device": 100155343,
      "name": "dev_zdevice",
      "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
      "xPos": 0,
      "yPos": 0,
      "profile": 0,
      "createdDate": "2023-03-06T15:41:17.076Z",
      "lastModifiedDate": "2023-03-06T15:41:17.076Z"
    },
    {
      "entityId": 0,
      "entityVersion": 0,
      "businessObjectClass": "LogicalDeviceDAO",
      "id": "5475002",
      "exclude": false,
      "device": 100155341,
      "name": "dev_ydevice",
      "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
      "xPos": 0,
      "yPos": 0,
      "profile": 0,
      "createdDate": "2023-03-06T15:41:17.076Z",
      "lastModifiedDate": "2023-03-06T15:41:17.076Z"
    }
  ],
  "profileEdges": [
    {
      "entityId": 0,
      "entityVersion": 0,
      "businessObjectClass": "PacketConnectivityDAO",
      "id": "5250001",
      "communication": 100155339,
      "name": "YYY / ZZZ / 1GigE / GE1 / 23",
      "exclude": false,
      "profileNode": {
        "entityId": 0,
        "entityVersion": 0,
        "businessObjectClass": "LogicalDeviceDAO",
        "id": "5475002",
        "exclude": false,
        "device": 100155341,
        "name": "dev_ydevice",
        "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
        "xPos": 0,
        "yPos": 0,
        "profile": 0,
        "createdDate": "2023-03-06T15:41:17.076Z",
        "lastModifiedDate": "2023-03-06T15:41:17.076Z"
      },
      "toProfileNode": {
        "entityId": 0,
        "entityVersion": 0,
        "businessObjectClass": "LogicalDeviceDAO",
        "id": "5475003",
        "exclude": false,
        "device": 100155343,
        "name": "dev_zdevice",
        "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
        "xPos": 0,
        "yPos": 0,
        "profile": 0,
        "createdDate": "2023-03-06T15:41:17.076Z",
        "lastModifiedDate": "2023-03-06T15:41:17.076Z"
      },
      "profile": 0,
      "createdDate": "2023-03-06T15:41:17.161Z",
      "lastModifiedDate": "2023-03-06T15:41:17.161Z"
    }
  ],
  "createdDate": "2023-03-06T15:41:16.865Z",
  "lastModifiedDate": "2023-03-06T15:41:16.865Z"
}

TopologyProfileDelete

The following table provides the TopologyProfileDelete event details and the corresponding values:

Table 2-9 TopologyProfileDelete

Event Details	Value
Summary	Receives messages for deleting Topology Profiles.
Message Header (with examples)	eventType: “TopologyProfileDelete” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn”
Topic	ora-uim-topology
Producer	UIM, any External System, typically an Inventory System.
Consumer	UTIA
URL	Provided during the deployment.
Schemas	Profile, ProfileEdge, ProfileVertex

Example Payload:

{
        "entityId": 100155358
}

TopologyProfileUpdate

The following table provides the TopologyProfileUpdate event details and the corresponding values:

Table 2-10 TopologyProfileUpdate

Event Details	Value
Summary	Receives messages for updating Topology Profiles.
Message Header (with examples)	eventType: “TopologyProfileUpdate” sourceSystemId: “UIM” transactionId: “uim-topology-nnnnnn”
Topic	ora-uim-topology
Producer	UIM, any External System, typically an Inventory System.
Consumer	UTIA
URL	Provided during the deployment.
Schemas	Profile, ProfileEdge, ProfileVertex

Example Payload:

{
  "businessObjectClass": "ServiceConfigurationVersionDAO",
  "createdDate": "2023-03-06T15:55:47.892Z",
  "entityId": 100155358,
  "entityVersion": 0,
  "id": "5100001:3",
  "lastModifiedDate": "2023-03-06T15:55:47.892Z",
  "name": "dev_service:dev_service - 3",
  "profileEdges": [
    {
      "businessObjectClass": "PacketConnectivityDAO",
      "communication": 100155339,
      "createdDate": "2023-03-06T15:55:48.180Z",
      "entityId": 100155362,
      "entityVersion": 0,
      "exclude": false,
      "id": "5250001",
      "lastModifiedDate": "2023-03-06T15:55:48.180Z",
      "name": "YYY / ZZZ / 1GigE / GE1 / 23",
      "profile": 100155358,
      "profileNode": {
        "businessObjectClass": "LogicalDeviceDAO",
        "device": 100155341,
        "entityId": 100155350,
        "entityVersion": 1,
        "exclude": false,
        "id": "5475002",
        "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
        "location": 0,
        "name": "dev_ydevice",
        "nec": 0,
        "network": 0,
        "profile": 100155347,
        "xPos": 0,
        "yPos": 0
      },
      "toProfileNode": {
        "businessObjectClass": "LogicalDeviceDAO",
        "device": 100155343,
        "entityId": 100155349,
        "entityVersion": 1,
        "exclude": false,
        "id": "5475003",
        "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
        "location": 0,
        "name": "dev_zdevice",
        "nec": 0,
        "network": 0,
        "profile": 100155347,
        "xPos": 0,
        "yPos": 0
      }
    }
  ],
  "profileVertices": [
    {
      "businessObjectClass": "LogicalDeviceDAO",
      "createdDate": "2023-03-06T15:55:48.105Z",
      "device": 100155338,
      "entityId": 100155359,
      "entityVersion": 0,
      "exclude": false,
      "id": "5475001",
      "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
      "lastModifiedDate": "2023-03-06T15:55:48.105Z",
      "name": "dev_device",
      "profile": 100155358,
      "xPos": 0,
      "yPos": 0
    },
    {
      "businessObjectClass": "LogicalDeviceDAO",
      "createdDate": "2023-03-06T15:55:48.107Z",
      "device": 100155343,
      "entityId": 100155360,
      "entityVersion": 0,
      "exclude": false,
      "id": "5475003",
      "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
      "lastModifiedDate": "2023-03-06T15:55:48.107Z",
      "name": "dev_zdevice",
      "profile": 100155358,
      "xPos": 0,
      "yPos": 0
    },
    {
      "businessObjectClass": "LogicalDeviceDAO",
      "createdDate": "2023-03-06T15:55:48.108Z",
      "device": 100155341,
      "entityId": 100155361,
      "entityVersion": 0,
      "exclude": false,
      "id": "5475002",
      "imageName": "oracle.communications.platform.entity.impl.MediaDAO-1381575223.png",
      "lastModifiedDate": "2023-03-06T15:55:48.108Z",
      "name": "dev_ydevice",
      "profile": 100155358,
      "xPos": 0,
      "yPos": 0
    }
  ],
  "referenceId": 118500005,
  "refresh": false,
  "zoomLevel": 0,
  "status": "CANCELLED"
}