You can avoid mapping all characteristics to ATA if you have a large set of characteristics. Determine which characteristics are helpful for developing the proper answers to your topology questions.

For example, if you want to query all Router specifications:

1. Identify all characteristics and specification names that identify a Router.
2. Map those values to the PG_DEVICE.NODECATEGGORY column.
3. Run a query 'Node Category' = 'Router' to display the topology for all your routers.

Another example is Vendor. If you identify your <vendor1> devices by specification name or by characteristics, map them to the PG_VENDOR Vertex. Once this is setup, you can query all your <vendor1> Devices or combine it with the previous examples and query all your vendor Routers. See ATA Model Documentation for the full set of columns and vertices that are available.

Characteristics that are mapped as Properties are displayed when you select Properties on the Resource Drawer from the ATA canvas. If you have a large set of characteristics that are mapped to Properties, an alternate flow is recommended. If you use More Info from Resource Drawer and visualize the characteristics from the Resource Summary page, you see all attributes without impacting the performance.

To map the dynamic data from UIM, the following definitions are required:

• vertex: A node in the Topology Model, examples are Vendor, Domain, Technology, Network Type, Device, Location
• property: A column on every vertex and edge in the Topology model.
  • It supports JSON allowing for unlimited additional attributes.
  • Property is the name of the key used to store the value retrieved from the UIM attribute.
• properties: Is an array defining how individual attributes of an entity are to be stored in Topology schema.
• columnName: An existing column on a physical table in the Topology Model used to store the attribute.
• name: Maps to different entity classes and entity specification classes. For example: “LogicalDeviceDAO”, “EquipmentSpecificationDAO”, “PlaceSpecificationDAO”, “PropertyLocationDAO” and so on.

The following POST operation creates a logical device, you can see the relationships and properties with which the dynamic properties are supported.

POST: http://localhost:8080/vertex

Body:

{"entityId":<entityID>,"entityVersion":<entityVersion>,"businessObjectClass":"LogicalDeviceDAO","id":"<ID>","name":"<name>","specName":"<specificationName>","latitude":0.0,"longitude":0.0,"inventoryStatus":"INSTALLED","referenceId":<referenceID>,"relationships":{"vendor":"<vendor>"},"properties":{"deviceIdentifier":"<deviceIdentifier>"}}

The POST operation tells the topology:

• Map LogicalDevice.deviceIdentifier to the property deviceIdentifer.
• Map LogicalDeviceSpecification.vendorName to the vertex = vendor
• This is based on the UIM ClassName, it works with any Class or specification that is topology-enabled.

You can add a role to the Logical Device from the list of roles that are configured in the TopologyRoleMapping.json file.

You can see that GET that the Logical Device tracks the deviceIdentifier in the properties column using:

GET: http://localhost:8080/vertex/typeid/1/referenceid/<refID>

{"businessObjectClass":"LogicalDeviceDAO","entityId":<entityID>,"entityVersion":<entityVersion>,"id":"<versionID>","inventoryStatus":"INSTALLED","latitude":0.0,"longitude":0.0,"name":"<name>","properties":{"deviceIdentifier":"<deviceID>"},"referenceId":<referenceID>,"specName":"<specificationName>"}

PUT: http://localhost:8080/vertex

{"businessObjectClass":"LogicalDeviceDAO","entityId":<entityID>,"entityVersion":3,"id":"<ID>","inventoryStatus":"INSTALLED","latitude":0.0,"longitude":0.0,"name":"<name>","properties":{"deviceIdentifier":"<ID>","transmission":"Optical_Transmission"},"referenceId":<refernceID>,"specName":"<specificationName>"}

In the body:

• The role “Optical_Transmission” is mapped to the property field with name = “transmission”.
• The role was given a name = “transmission” which was provided by the UIM admin.
• Add, update and delete are supported. This works for Equipment and Physical Device (any topology-enabled entity that supports roles).
• Roles can be mapped to properties, vertices or columns.

The rules to perform this are:

• The Vertex must exist: The mapping can be performed to multiple vertices and can have multiple values.
• Property: There can be multiple properties. The UIM integrator is responsible for not having similar or misspelled values.
• ColumnName: A column can only have 1 value. The user is currently responsible for assuring this value is unique. It can be overlaid. This should be used for a queried attributes where an index is needed.
• The possible values of "columnName" are the following:
  • PG_DEVICE - [ NODECATEGORY, MACADDRESS, IPV4, IPV4SUBNET, IPV6, IPV6SUBNET, ZONEID, DEVICEIDENTIFIER, NETWORKSTATUS, NODETYPE]
  • PG_LOCATION - [DISTRICT, PROVINCE, OPERATOR, CITY, STATE, POSTALCODE, COUNTRY, AREA, CIRCLE]
  • PG_COMMICATION - [FROMNODEDATA, TONODEDATA, RATECODE, TECHNOLOGY]
  • PG_NETWORK - [CATEGORY, SUBCATEGORY, TOPOLOGYTYPE, SUBTYPE]

The supported UIM classes are:

LogicalDeviceDAO, GeographicPlaceDAO, PhysicalDeviceDAO, NetworkDAO, NetworkEdgeDAO, EquipmentDAO, GeographicSiteDAO, PropertyLocationDAO

The last configuration is TopologySpecificationMapping.json.

• The related vertices field automatically adds a relationship edge between any instance of the specification to the vertex with the provided name and value.
• A characteristic does not need to be added and set on the specification to be tracked in topology.
• This allows our current RI cartridges to be used without any modifications.
• The characteristics column works the same as roles.
• It automatically adds a relationship to a vertex, sets properties or sets a column value.
• Any current characteristics can be used. No changes are needed.

PUT: http://localhost:8080/vertex

{"entityId":<entityID>,"entityVersion":<entityVersion>,"businessObjectTypeId":1,"businessObjectClass":"LogicalDeviceDAO","id":"<ID>","name":"<name>","specName":"router","latitude":<latitude>,"longitude":<longitude>,"inventoryStatus":"INSTALLED","isTopLevelNode":true,"nodeAvailable":true,"placeNode":false,"referenceId":<referenceID>,"createdUser":"test","lastModifiedUser":"test","relationships":{"vendor":"<vendor>","domain":"Ethernet"},"properties":{"deviceIdentifier":"<deviceID>"}}

By default, parties associated with the impacted entities are not considered as the impacted customers. Based on your requirement, you can track the impacted customers using the configuration file. By specifying these mappings, you can control which customers are included in the impact analysis results when specific entities are impacted by network events or changes.

To achieve this filtering, provide the configuration in a JSON file. The location of this file is as follows:

• File location in UIM CNTK: $UIM_CNTK/charts/uim/config/siaMappings/partyRoleMappings.json

  File location in a standalone installation: <DOMAIN_HOME>/UIM/config/siaMappings/partyRoleMappings.json

After making any changes to partyRoleMappings.json, restart UIM to make the mappings effective.

{
  "EntityTypeDAO": [
    {
      "entitySpecification": "SpecificationName",
      "parties": [
        {
          "partySpecification": "PartySpecName",
          "roles": ["Role1", "Role2", ...]
        }
      ]
    }
  ]
}

"ServiceDAO": [
  {
    "entitySpecification": "FibreBroadband",
    "parties": [
      {
        "partySpecification": "Individual",
        "roles": ["Customer"]
      }
    ]
  }
]

"LogicalDeviceDAO": [
  {
    "entitySpecification": "Ciena 6500",
    "parties": [
      {
        "partySpecification": "Individual",
        "roles": ["Customer", "ServiceOwner", "TechnicalContact"]
      }
    ]
  }
]

"EquipmentDAO": [
  {
    "entitySpecification": "Ciena 6500-2 Chassis",
    "parties": [
      {
        "partySpecification": "Individual",
        "roles": ["Customer"]
      },
      {
        "partySpecification": "Business",
        "roles": ["EnterpriseCustomer", "ManagedServiceClient"]
      }
    ]
  }
]

"ServiceDAO": [
  {
    "entitySpecification": "GPONService",
    "parties": [
      {
        "partySpecification": "Individual",
        "roles": ["Customer", "Subscriber"]
      },
      {
        "partySpecification": "Business",
        "roles": ["EnterpriseCustomer"]
      }
    ]
  }
]

// Original mapping
"PipeDAO": [
  {
    "entitySpecification": "DWDM_Optical_Fiber",
    "parties": [
      {
        "partySpecification": "Individual",
        "roles": ["Customer"]
      }
    ]
  }
]
 
// Updated mapping with new role
"PipeDAO": [
  {
    "entitySpecification": "DWDM_Optical_Fiber",
    "parties": [
      {
        "partySpecification": "Individual",
        "roles": ["Customer", "ServiceUser"]
      }
    ]
  }
]