Moviri Integrator for TrueSight Capacity Optimization - ServiceNow

“Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” is an additional component of the BMC TrueSight Capacity Optimization product. It allows to extract data from ServiceNow CMDB. The integration supports the extraction of both configuration metrics (based on ServiceNow fields) and relationships (based on ServiceNow topology).

The documentation is targeted at BMC TrueSight Capacity Optimization administrators, in charge of configuring and monitoring the integration between BMC TrueSight Capacity Optimization and ServiceNow CMDB.

Importing tags to create service pools is supported only when you apply Service Pack 1 (11.5.01) of TrueSight Capacity Optimization 11.5. 


Requirements

Supported Versions of Data Source Software

  • ServiceNow CMDB
  • Table API version v.2

Supported Versions of BMC TrueSight Capacity Optimization

  • BMC TrueSight Capacity Optimization v.11
  • BMC TrueSight Capacity Optimization v.11.3.01
  • BMC TrueSight Capacity Optimization v.11.5

Installation

Downloading the Additional Package

“Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” is available as additional component, distributed via BMC electronic distribution site (EPD).

Installing the Additional Package

To install the “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” as additional package, please refer to the official BMC documentation (“Performing system maintenance tasks”).

Data Source Checks and Configuration

Configuration Pre-requisites

The “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” requirements are the following:

  • A valid JSON file configuration, accessible by the ETL Engine running the “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow”. Please refer to "JSON File Configuration Format" section for more information about the JSON configuration file
  • Connectivity between BMC TrueSight Capacity Optimization ETL Engine server and ServiceNow API (proxy connectivity is supported)
  • Valid credentials (username/password) to access ServiceNow Table API. The account needs the following privileges:
    • web_service_adminrest_api_explorer, or admin ServiceNow role
    • Access to the ServiceNow tables listed in the ETL configuration. In addition, the accounts must have access to the following tables
      • cmdb_rel_ci
      • instance

Please refer to the official ServiceNow documentation to properly configure the account and privileges.

To verify if the listed requirements, please execute the following command from the ETL Engine Server:

curl https://<servicenow-fqdn>/api/now/v2/table/instance -u <username>

The result of the command should have the following format:

{"result":[{"database_user":"","war_version":"","database_url":"","instance_name":"Source Instance","database_name":"","production":"true","validation_error":"","instance_url":"","sys_mod_count":"0","database_tablespace":"","source":"true","sys_updated_on":"2012-04-05 23:36:24","sys_tags":"","admin_password":"","database_password":"","database_type":"","sys_id":"f1fff5dc371120004f6a80f7bcbe5dca","instance_id":"source_instance","sys_updated_by":"admin","cluster_node":"","sys_created_on":"2012-04-05 23:36:24","sys_created_by":"admin","admin_user":"","primary":"true"}]}

Connector Configuration Attributes

Property Name

Value Type

Required

Default

Description

ServiceNow – Connection Parameters

ServiceNow API URL

String

Yes

 

ServiceNow API URL, with the format http(s)://<servicenow>:<port>

ServiceNow API username

String

Yes

 

User used to access ServiceNow API

ServiceNow API password

String

Yes

 

Password for the user used to access ServiceNow API

Use HTTP Proxy?

String

Yes

No

Select ‘yes’ if an HTTP proxy is required to connect to ServiceNow API

Proxy Host

String

 

 

Proxy FQDN or IP Address

Proxy Port

String

 

 

Proxy server port

Proxy Username

String

 

 

Proxy server username

Proxy Password

String

 

 

Proxy server password

ServiceNow – Extraction

JSON file configuration full path

String

 

 

Absolute path to the JSON configuration file accessible by the ETL engine

 

The following image shows a Run Configuration example for the “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow”.

JSON File Configuration Format

File Structure

The “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” requires as input a JSON file following the JSON schema described in the following file (ServiceNow_JSON_Schema.json).

The following table contains the description for each field (use “dot notation” to traverse element in the JSON schema):

Property

Description

Example

JSON Configuration File

configVersion

Version of the JSON file configuration

“1.0”

links

Array of “link” element, defining nodes and relationships

 

standaloneEntities

Array of “node” elements, identifying the list of entities that are not visited by any relationship. These nodes will appear under the domain configured in the ETL

 

Link Element

links.tscoRelType

Type of TSCO relationship

“contains”

links.nodes

Array of “node” elements identifying the levels that should be imported. The array must include a “root” and a “leaf” node

 

links.relationships

Array of “relationship” elements, identifying the connections that should be imported. It must include at least one element

 

Node Element

node.type

The type of the node. This property accepts three possible values:

  • “root”: the node in the hierarchy that will be directly assigned to the target workspace domain in TSCO
  • “leaf”: the deepest node in the hierarchy
  • “inter”: intermediate node linking leaf node to root node

“root”

node.snowFilter

ServiceNow query that can be used to filter the type of node to be extracted from ServiceNow API

“parent.classification=Production^name=srv001”

node.snowClassName

ServiceNow class name that identifies the entity. It must be a valid ServiceNow table

“cmdb_ci_server”

node.tscoLookupField

ServiceNow field (available in the snowClassName table) that will used as simple lookup value.

“name”

node.tscoNodeName

ServiceNow field (available in the snowClassName table) that will used as entity name

“name”

node.tscoTypeName

A valid TSCO entity type name

“gen”

node.tscoCatName

A valid TSCO entity category (“APP”, “SYS”, “WKLD”)

“SYS”

node.metrics

Array of “metric” elements, identifying configuration metrics to be imported

 

Metric Element

metric.snowMetric

ServiceNow field (available in the snowClassName table) whose value will be imported in TSCO. Use “dot notation” to traverse fields represented as ServiceNow link

“ram”

“manufacturer.name”

metric.tscoMetric

A valid TSCO metric used to map the ServiceNow Field

“TOTAL_REAL_MEM”

“HW_VENDOR”

metric.scaleFactor

The scale factor to convert the ServiceNow field to the proper metric unit

1024

Relationship Element

relationship.snowRelType

ServiceNow relationship class type

“Depends On::Used by”

relationship.snowRelParType

ServiceNow class name that identifies the parent entity of the relationship. It must be a valid ServiceNow table

“cmdb_ci_service”

relationship.snowRelChildType

ServiceNow class name that identifies the child entity of the relationship. It must be a valid ServiceNow table

“cmdb_ci_server”

relationship.snowFilter

ServiceNow query that can be used to filter the list of relationships to be extracted from ServiceNow API

“parent.classification=Production^name=srv001”

 

Please refer to ServiceNow Administrator to create a proper JSON configuration file specific for your organization. ServiceNow provides useful tool to find all the required information to create the JSON configuration file, in particular:

  • ServiceNow REST API Explorer
  • (within the context of a Server or Business Service) Dependency View

As example, you can refer to the following ServiceNow topology:

Please notice that this topology contains both Linux Servers (class “cmdb_ci_linux_server”, linked via Web Server, class “class_ci_web_server”) and Windows Servers (class “cmdb_ci_win_server”).

This topology can be represented by the following JSON configuration file (ServiceNow_Configuration_Example.json).

Considering the JSON configuration file described above, the “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” will create the following hierarchy in the TSCO workspace:

Integration Results

Hierarchy

The hierarchy imported by the “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” depends on specific ServiceNow implementation to be integrated and the relationships configured in the JSON configuration file.

Metrics and Entity Type

The list of metric and Entity Types imported by the “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” depends on specific ServiceNow implementation to be integrated and the relationships configured in the JSON configuration file.

Lookup Consideration

The “Moviri Integrator for TrueSight Capacity Optimization – ServiceNow” supports only simple lookup. For each node in the hierarchy, the lookup value can be configured using the property “tscoLookupField”. Please refer to the official BMC documentation for more information regarding TSCO lookup.

Was this page helpful? Yes No Submitting... Thank you

Comments