Usage Manual

This page describes how the connector can be used and configured.

Prerequisites

The connector needs:

• network access from the CMDBuild server to the Dynatrace environment, through the URL configured in the Endpoint attribute of the instance (HTTPS requests to the /api/v2/entities and /api/v2/settings/objects paths);
• a Dynatrace API token, configured in the Token attribute of the instance. The token is sent in the Authorization header of every request, using the Api-Token scheme.

The token must have the following permissions:

entities.read
settings.read

Connector dependencies

The connector requires the installation of the Connector utils plugin version 2.0.6 or higher and CMDBuild version 4.2.0 or higher.

Configuration

Plugin configuration

The standard connector plugin configuration can be found here.

The connector has no additional configurations.

Instance configuration

Config	Default	Description	Notes
Code*		Unique code of the instance.	Used to identify the instance in the executions of the connector.
Active*		Whether the instance is read during the synchronization.	Only active instances are read.
Endpoint*		Base URL of the Dynatrace environment.	The paths of the Dynatrace API (for example /api/v2/entities) are appended to this value. The validation of the HTTPS certificate is relaxed.
Token*		API token used to authenticate to Dynatrace.	Password attribute. See the permissions required in Prerequisites.
From	now-1d	Start of the time frame in which the entities must have been observed.	Sent as the from parameter of the entities requests, so it accepts the values supported by the Dynatrace API (for example now-1d, now-7d). It is not applied to management zones and detection rules. If blank, now-1d is used.
Page size	100	Number of records requested per page.	Minimum value is 1 and maximum value is 4000. If blank, 100 is used.

Records that are no longer returned by Dynatrace for an instance are removed from CMDBuild at the end of the import. Choose the From value accordingly: entities not observed in the selected time frame are not read.

Entities preview

100%

Management Zone is related to all the other records: its line connects to the dashed container, which groups those records.

The diagram provides a high-level overview of the entities extracted by the connector and the relationships between them.

The diagram uses the following conventions:

• Orange containers represent CMDBuild superclasses. The entities contained within them belong to the corresponding superclass.

• Dashed orange containers group all the entities that are related to an entity outside the container. A line or an arrow connected to the container represents a relationship with each of the entities inside it.

• Blue boxes represent record types extracted by the connector. Each box is labeled using the format {Source Object Name} ({_type}), combining the object name used by the source service with the internal record type produced by the connector.

• Arrows represent one-to-many relationships between entities managed by the connector. The arrow points to the "many" side of the relationship, as indicated by its label (1 : N).

• Lines without arrow tips represent many-to-many relationships between entities managed by the connector, as indicated by their label (N : N).

Below is a list of all the entities retrieved by the connector.

Settings

• Management Zone (managementzone)

Entities

• Application (application)
• Service (service)
• Process Group (processgroup)
• Process Group Instance (processgroupinstance)
• Host (host)
• Kubernetes Cluster (kubernetescluster)
• Kubernetes Node (kubernetesnode)
• Kubernetes Service (kubernetesservice)
• Cloud Application (cloudapplication)
• Cloud Application Instance (cloudapplicationinstance)
• Cloud Application Namespace (cloudapplicationnamespace)

Relations

• Application - Service (appservicerelation)
• Service - Cloud Application (servicecloudapprelation)
• Service - Host (servicehostrelation)
• Service - Process Group Instance (serviceprocessgroupinstancerelation)
• Process Group - Cloud Application (processgroupcloudapprelation)
• Process Group - Cloud Application Instance (processgroupcloudappinstancerelation)
• Process Group - Host (processgrouphostrelation)
• Process Group Instance - Process Group Instance (processgroupinstanceprocessgroupinstancerelation)
• Host - Host (hosthostrelation)
• Kubernetes Cluster - Service (kubernetesclusterservicerelation)
• Kubernetes Service - Cloud Application (kubernetesservicecloudapprelation)
• Kubernetes Service - Cloud Application Instance (kubernetesservicecloudappinstancerelation)
• Cloud Application - Cloud Application (cloudappcloudapprelation)
• Cloud Application Namespace - Process Group (cloudappnamespaceprocessgrouprelation)
• Cloud Application Namespace - Service (cloudappnamespaceservicerelation)
• Entity - Management Zone (entitymanagementzonerelation)
• Generic relation between two entities (relation)

Additional Information

Synchronization to Application Classes

The standard connector imports and maintains data within the CMDBuild standard classes and relationships, providing a consistent representation of the data.

As a separate and optional customization activity, organizations may define additional synchronization processes to populate application-specific classes from the imported infrastructure data. Through custom mappings and enrichment rules, connector resources can be associated with organization-specific business objects, services, assets, or other application entities.

This approach supports customer-specific business models, enrichment processes, and classification rules while preserving the standard infrastructure representation provided by the connector.

Known Limitations

• The connector operates in read-only mode.
• Large environments may require increased execution time.
• No real-time synchronization: data is updated only during scheduled runs.
• The plugin is distributed under a Premium license model. Its usage is tied to an active support and maintenance agreement, which is subject to expiration and must be renewed to remain valid.

Deployment Guidelines

Deployment of the connector includes the creation of standard CMDBuild classes and relationships corresponding to supported connector resource types. These structures provide the foundation for storing and organizing synchronized infrastructure information. The deployment process also includes configuration elements required for data visualization and the establishment of scheduled synchronization activities.

Following deployment, it is recommended to validate the configuration by executing an initial synchronization and reviewing the imported data.

Scheduling frequency should be selected according to the scale of the environment, expected rate of infrastructure change, and operational reporting requirements.