Table of Contents

DataMiner Extension Modules (DxMs)

A DataMiner Extension Module (DxM) is a service that can be installed, upgraded, and uninstalled without the need to reboot the DataMiner Agent. These modules will expand the core DataMiner software with additional features and capabilities. In most cases, DxMs will be backwards-compatible with all supported core DataMiner versions. However, this may not be possible in some cases, and then a minimum core DataMiner version will be indicated.

Some DxMs are considered core modules created using the DxM technology. These are known as "DcMs" (DataMiner Core Modules). DcMs are treated differently from DxMs during upgrades. While DxMs are only updated if they have already been installed, DcMs will always be installed or updated with an upgrade.

DxMs depend on a minimum version of the core software. This is indicated in the Admin app. When you install updates, the latest compatible update will be automatically selected.

Packs

For ease of installation, DxMs may be packaged together in a pack, such as the Cloud Pack. These packs allow users to install several DxMs at once.

Available DcMs

APIGateway

The APIGateway module is the endpoint for the gRPC communication with a DataMiner Agent.

From DataMiner 10.4.0/10.4.2 onwards, DataMiner modules can register with APIGateway. All modules registered with APIGateway are displayed under https://[Your DMA]/APIGateway/api/version, showing the following properties:

  • Name
  • Version
  • Endpoint on which they can be accessed via APIGateway (proxy modules only)

ArtifactDeployer

The ArtifactDeployer module is responsible for allowing users to deploy different DataMiner artifacts towards their system. An example of a feature that uses this module is the deployment of connectors from within the Catalog.

This DxM is included in DataMiner upgrade packages from DataMiner 10.3.7/10.4.0 onwards.

CoreGateway

The CoreGateway module is responsible for translating requests from other modules into requests towards the DataMiner System. This ensures backwards compatibility with different DataMiner versions.

This DxM is included in DataMiner upgrade packages from DataMiner 10.3.7/10.4.0 onwards.

FieldControl

The FieldControl module is responsible for handling incoming requests from dataminer.services. For example, such a request could come from the DataMiner Teams Bot when a user asks it to retrieve the alarms from the system.

This DxM is included in DataMiner upgrade packages from DataMiner 10.3.7/10.4.0 onwards.

Orchestrator

The Orchestrator module is responsible for management and upgrades of DxMs through the Admin app.

This DxM is included in DataMiner upgrade packages from DataMiner 10.3.7/10.4.0 onwards.

StorageModule

The StorageModule DcM is responsible for the storage of element configuration data.

SupportAssistant

The SupportAssistant module is responsible for features allowing Skyline Communications to provide better and faster support.

This DxM is included in DataMiner upgrade packages from DataMiner 10.3.7/10.4.0 onwards.

From version 1.3.1 of the DataMiner SupportAssistant module onwards, this DxM also takes care of offloading reports and notifications generated by SLWatchDog to dataminer.services to improve the maintenance and support experience.

UserDefinableApiEndpoint

The UserDefinableApiEndpoint module is responsible for handling API triggers for DataMiner User-Defined APIs. See DataMiner UserDefinableApiEndpoint DxM.

Available DxMs

CloudGateway

The CloudGateway module is responsible for connecting a DataMiner System to dataminer.services. It manages the identity towards dataminer.services and ensures a secure connection.

CloudFeed

The CloudFeed module is responsible for offloading data towards dataminer.services. This setting can be controlled in the Admin app. Among the data that is offloaded are SPI events and alarm events.

DataAggregator

See Data Aggregator.

ModelHost

The ModelHost module is responsible for allowing users to retrieve parameter relationship data on DataMiner Agents that are connected to dataminer.services and have been configured to offload alarm and change point events to the cloud.

The ModelHost DxM is not included in the Cloud Pack and must be deployed separately.

CommunicationGateway

The CommunicationGateway module makes it possible for connectors or scripts running in the DataMiner environment to communicate with devices that require a gRPC connection.

At present, we support the gNMI service, but more services and RPC connections may be added.

This DxM exists in tandem with service-specific middleware that facilitates the NATS communication to the DxM. However, not all middleware require the CommunicationGateway to establish a connection with the device. The DxM is primarily used to bridge the gap between different .NET versions. This is because gRPC requires .NET 5 or higher for full functionality, while SLScripting still runs on .NET 4.6.2.

Tip

See also: OpenConfig Middleware

Propose changes