Getting started

About DataMiner connectors

A DataMiner connector (also referred to as a "driver" or "protocol") is an XML file containing all the information a DataMiner Agent needs to be able to communicate with a data source: instructions on how to poll the data source and display all relevant data on the user interface (i.e., DataMiner Cube element cards), default port settings, alarm thresholds, parameter labels, etc. The language used to define a protocol is referred to as the DataMiner Protocol Markup Language (DPML).

A DataMiner protocol can be uploaded to a DataMiner Agent, so that elements can be created that will run the protocol.

 flowchart LR
     subgraph DMA["DataMiner Agent"]
         EA["Element A\nRuns protocol X, v1.0.0.1"]
         EB["Element B\nRuns protocol X, v1.0.0.1"]
         EC["Element C\nRuns protocol Y, v1.0.0.2"]
     end
 
     DSA["Data source A"]
     DSB["Data source B"]
     DSC["Data source C"]
 
     EA <--> DSA
     EB <--> DSB
     EC <--> DSC
 
     style DMA fill:#00517d,color:#ffffff,stroke:#00517d
     style EA fill:#f2f6f8,color:#000000,stroke:#cccccc
     style EB fill:#f2f6f8,color:#000000,stroke:#cccccc
     style EC fill:#f2f6f8,color:#000000,stroke:#cccccc
     style DSA fill:#f2f6f8,color:#000000,stroke:#cccccc
     style DSB fill:#f2f6f8,color:#000000,stroke:#cccccc
     style DSC fill:#f2f6f8,color:#000000,stroke:#cccccc

Get to know the basics

Overview of the available connector metadata: Metadata
For more information about logic-related components such as parameters, actions, triggers, and so on, see Logic.
For an overview of the different UI components that can be used in a DataMiner protocol, see UI components.
For an overview of the different connection types that are supported in DataMiner, see Connections.
To find out more on how to implement alarming and trending support in a protocol, see Monitoring.
To test your knowledge of DataMiner protocols or find the answers to particular questions, see Questions & Answers.
Best practices

Note

As mentioned above, a protocol is an XML file. However, where possible, this guide makes abstraction of the way something is defined in DPML by providing a conceptual description. To learn more about this markup language, see DataMiner Protocol Markup Language.

Discover data source integrations

Discover the full list of available features

Using DataMiner connectors in a DataMiner System

When you have created or updated a DataMiner protocol, it first needs to be uploaded to a DataMiner Agent, which will then automatically copy it to each of its peers in the DataMiner System it belongs to. You can then start creating elements that will use that protocol.

For more information on how to upload a protocol, refer to Adding a protocol or protocol version to your DataMiner System.
For more information on how to create an element, refer to Adding elements.

Table of Contents