CMDB Integration Definition Format… · 2017-02-08 · Technical Proposal CMDB Integration...

Technical Proposal

CMDB Integration Definition Format Petr Bohacek—V 0.8 March 2016 HPE Enterprise Maps

© Copyright 2016 Hewlett Packard Enterprise Development LP. Page 2

Abstract

Purpose of this document is to provide full information about XML configuration file used by HPE Enterprise Maps for integration with CMDB. Here you should be able to understand where to find the configuration for CMDB integration, what is and could be defined in this configuration and how to work with it.


Contents

1 Introduction ........................................................................................................ 4

1.1 About HPE Enterprise Maps .......................................................................................................................................................................... 4

1.2 About CMDB integration ................................................................................................................................................................................... 4

2 Prerequisites ...................................................................................................... 5

3 Working with CMDB mapping ............................................................................ 6

3.1 Where to see current CMDB mapping in HPE Enterprise Maps ................................................................................. 6

3.2 Where to change/manage the mapping used for CMDB integration .................................................................... 7

3.3 How to work with CMDB integration mapping file .................................................................................................................. 8

4 Concept of mapping file...................................................................................... 9

4.1 Entity Mapping ............................................................................................................................................................................................................ 9

4.1.1 Type section .................................................................................................................................................................................................. 9

4.1.2 External attributes ................................................................................................................................................................................ 10

4.1.3 External references ............................................................................................................................................................................. 10

4.1.4 Internal attributes ................................................................................................................................................................................. 10

4.1.5 Internal references ................................................................................................................................................................................ 11

5 Advanced cases ............................................................................................... 12

5.1 Multiple integrations with specific mappings ...............................................................................................................................12

5.2 Getting data from related entity ..............................................................................................................................................................13

5.3 Grouping of running_software artifacts ............................................................................................................................................13

6 FAQ .................................................................................................................. 14

6.1 Why there are id attributes on entityMapping elements? ............................................................................................. 14


1 Introduction

1.1 About HPE Enterprise Maps

HPE Enterprise Maps (HPE EM, EM) logically constructs enterprise architecture models aligned with projects, and enables you to capture and use information from various tools and across multiple locations. You can use EM tools to manage your architecture model and establish a solid baseline for making informed decisions about your IT assets and infrastructure. Investments can be planned more logically after detailed analysis, thus avoiding wastage of IT resources.

HPE Enterprise Maps is based on Archimate 2.1 and TOGAF standards which defines a full set of architecture elements.

HPE Enterprise Maps provides a web-based enterprise-ready repository application and collaborative environment.

1.2 About CMDB integration

To be able to analyze the costs, impacts, and dependencies of IT infrastructure on your business, you can integrate HPE EM with a configuration management database (CMDB). This allows the system to get information about servers and software running on it as well as enabling you to connect these objects to application and business architecture. This also enables you to control the lifecycle of these entities.

CMDB is a primary source of information about runtime systems. HPE EM can import and synchronize relevant data from CMDB configuration items (CIs). This gives the architect up-to-date data about the baseline architecture at the Technology layer and brings visibility on the as-is state. The enterprise architect can reuse the imported CMDB CIs and link them to the application architecture to provide traceability between the application and technology layer.

http://hp.com/go/em

http://hp.com/go/em

http://pubs.opengroup.org/architecture/archimate2-doc/toc.html

http://pubs.opengroup.org/architecture/togaf8-doc/arch/

http://hp.com/go/em


2 Prerequisites

HPE Enterprise Maps 3.10 running server integrated with CMDB or BSM server HP Universal Configuration Management Database (uCMDB) 9.05 or 10.20 or HP

Business Service Management (BSM) 9.13 or 9.24 HPE EM Workbench 3.00 HPE CMDB model browser/viewer HPE Enterprise Maps user account with Administrator role privileges


3 Working with CMDB mapping

3.1 Where to see current CMDB mapping in HPE Enterprise Maps

Current CMDB mapping can be found in Administration->Configuration->Integration section which shows the list of integrated systems (our demo data has some predefined servers so you can observe how it looks even without having the real system available). In the list of connected servers you can also get the information about mapping (see picture below).

Figure 1 Where to find integrations and mappings in HPE Enterprise Maps


3.2 Where to change/manage the mapping used for CMDB integration

Mapping can be managed in Administration->Configuration->Settings->System Properties. Property platform.sync.mapping.ucmdb contains the mapping file (see picture below). You can download the mapping XML and upload new version once you make all your updates.

Figure 2 Where to download/upload/change the mapping in HPE Enterprise Maps


3.3 How to work with CMDB integration mapping file

We recommend to download existing mapping file and open it using our Workbench tool 12. CMDB mapping file has predefined XML format defined by XML Schema and Workbench provides you syntax help during editing of the file.

Figure 3 CMDB mapping file in HPE EM Workbench

1 HPE EM Workbench can be found https://hpln.hp.com/group/enterprise-maps 2 Create new extension project so you can also observe HPE EM SDM model

https://hpln.hp.com/group/enterprise-maps


4 Concept of mapping file

Mapping file contains the header defined in entityMappings element and multiple mappings for each artifact/configuration item defined in entityMapping elements.

4.1 Entity Mapping

Every entityMapping element is split into two part defined by internal and external elements.

First you need to define which configuration item and its attributes and relations defined in CMDB you want to load to EM. This is done in external section. You define Type of configuration item inside type element, attributes you want to read from CMDB using multiple attribute elements and finally relations using reference elements.

Then you move to internal section of the entityMapping and define how the data from CMDB will be mapped to HPE EM artifact. Every internal element starts with type definition which is similar to external section.

4.1.1 Type section

Type section is similar for external and internal. You have to define what kind of configuration item/artifact will be used for reading/storing the data. Type element contains property element with two attributes:

name – specifies the type of the configuration item or artifact3 TBD rewrite value – contains the name of the configuration item type or artifact type4

Figure 4 Type section example

3 Contains Type for CMDB and sdmName for HPE Enterprise Maps 4 Here you specify the values from CMDB or HPE Enterprise Maps SDM model


4.1.2 External attributes

In this section you have to create definitions of all attributes you want to use further in internal section (means you want to store them in EM).

Attributes has to have name which matches the name of the attribute in definition of configuration item in CMDB and several classifiers used for specific cases. Most common are:

sync - Attibutes carry a synchronization value and may not be stored with the entity. virt - Attribute is computed value for the entity.

4.1.3 External references

You have to create definitions of all references you want to use further in internal section (means you want to store them in EM).

References has to have name which matches the name of the relation in definition of configuration item in CMDB and its direction which could be out, in, or inout.

4.1.4 Internal attributes

Attributes in internal section use mapping elements in order to reference the attribute values defined in the external section.

Figure 5 Example of internal mapping

Attribute element contains name attribute which needs to match the attribute name in the SDM model. Then in the mapping section you reference the attributes loaded in external section. Mapping element can contain overwrite attribute which specifies how to behave when the data already exists in HPE EM. If overwrite is not specified or is set to false then in case the data already exists in HPE EM value of such attribute is not updated.

TBD – virt classifier at internal attributes


4.1.5 Internal references

Reference elements in internal section defines mapping of relationships. In this section you references the relations from external section as you can see in the example below.

Figure 6 Example of reference in internal section

Reference contains name attribute which must contain name of the relation defined in SDM model.


5 Advanced cases

5.1 Multiple integrations with specific mappings

In case you have multiple integrations of the same kind (e.g. multiple CMDB integrations) and you want to have specific mapping for every such integration you have to create specific mapping files you want to use (one mapping file can be shared for the same kind of integrations). Such mapping file must be stored in scope of Top-Level domain and must follow prefix of the default mapping file for specific integration. So for example in case of CMDB integration if you want to have multiple mapping files then each mapping file must start with platform.sync.mapping.ucmdb. prefix and any other text can follow. You can observe this situation at Sparx EA integrations where we provide multiple mappings out of the box.


Later on during the definition of the integration server in EM you can select from the mapping file and specify the one you want to use. The name of the mapping file is specified in the header of the mapping file.



5.2 Getting data from related entity

Figure 9 Example of getting data from related entity

Used in external section in case you need to get data from related entity in CMDB. Add element ucmdb:related in namespace ucmdb defined xmlns:ucmdb="urn:com.hp.systinet.sync.mapping:extension:ucmdb:1.0" with attributes:

name - property name of other entity otherEntityType - type of other entity type - direction of the relation to other entity (out, in) relation - type of the relation in CMDB

5.3 Grouping of running_software artifacts

HPE Enterprise Maps introduces grouping capability in 2.00 release. It allows you to shrink the number of artifacts created in HPE EM when there is lot of similar configuration items in CMDB. This is related to running software CI which is usually limited set of software used across all servers5. In default mapping we do grouping of running_software CIs into System Software artifacts based on the name and version. Artifacts with the same name are created just once.

TBD – how is it done

5 For example operating system is limited set of software used in the company spread across all servers


6 FAQ

6.1 Why there are id attributes on entityMapping elements?

It’s a good practice which improves human readability of CMDB mapping file TBD – check the answer is correct


Version No. Version date Created by Affected section and description of change

0.7 Sep 2015 Petr Bohacek Initial Baseline

0.8 Mar 2016 Petr Bohacek Rebranding to HPE. 4.1.2, 4.1.3 Update - more semantics about external section and dependencies there. 5.1 Multiple integrations with different mappings


Date post:	13-Apr-2020
Category:	Documents
Upload:	others
View:	11 times
Download:	3 times

CMDB Integration Definition Format… · 2017-02-08 · Technical Proposal CMDB Integration...

Documents