# skylinecommunications/dataminer-docs architecture

> Architecture diagram of the GitHub repository skylinecommunications/dataminer-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/skylinecommunications/dataminer-docs
- Repository: https://github.com/skylinecommunications/dataminer-docs

## Overview

This repository is the open-source documentation project for DataMiner, not the DataMiner runtime itself. The tree includes documentation-site search assets and a broad set of DataMiner API source files that appear to support reference documentation. The README establishes the documentation purpose, but the supplied excerpts do not show how site content is built or how search produces results. The diagram therefore shows the documented product surface and its major API areas, without inferring runtime calls or a search pipeline.

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_site["Documentation site"]
  node_docs["DataMiner documentation"]
  node_search["Site search<br/>[search.js]"]
  node_site_main["Site script<br/>[main.js]"]
end

subgraph group_automation["Automation APIs"]
  node_engine["Automation engine<br/>[Engine.cs]"]
  node_engine_contract["Engine interface<br/>[IEngine.cs]"]
  node_elements["Element controls<br/>[Element.cs]"]
  node_script_dummy["Script dummy<br/>[ScriptDummy.cs]"]
  node_profile_adapter["Automation profiles"]
end

subgraph group_managers["Manager APIs"]
  node_profile_helper["Profile manager"]
  node_profile_models["Profile models"]
  node_jobs["Jobs manager"]
  node_manager_base["Manager store base"]
  node_service_profiles["Service profiles"]
  node_service_profile_types["Service profile types"]
  node_ticket_errors["Ticketing errors"]
end

subgraph group_net["DataMiner APIs"]
  node_connection["DMS connection<br/>[IDMS.cs]"]
  node_analytics_messages["Analytics messages"]
  node_rad_messages["RAD messages"]
  node_protocol_api["Protocol helpers<br/>[SLProtocolExt.cs]"]
  node_logger_api["Logging API<br/>[ILogger.cs]"]
  node_storage_types["Storage types<br/>[CustomDataType.cs]"]
end

node_reader(("Documentation reader"))

node_reader -->|"consults"| node_docs

click node_search "https://github.com/skylinecommunications/dataminer-docs/blob/main/templates/skyline/public/search.js"
click node_site_main "https://github.com/skylinecommunications/dataminer-docs/blob/main/templates/skyline/public/main.js"
click node_engine "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/Engine.cs"
click node_engine_contract "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/IEngine.cs"
click node_elements "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/Element.cs"
click node_script_dummy "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/ScriptDummy.cs"
click node_profile_adapter "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/SLProfileManager.cs"
click node_profile_helper "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/ProfileManager/ProfileManagerHelper.cs"
click node_profile_models "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/ProfileManager/Objects/ProfileDefinition.cs"
click node_jobs "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/Jobs/JobManagerHelper.cs"
click node_manager_base "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/ManagerStore/BaseManagerHelper.cs"
click node_service_profiles "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/ServiceProfiles/Helpers/ServiceProfileDefinitionCrudHelperComponent.cs"
click node_service_profile_types "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/ServiceProfiles/ServiceProfileDefinitions/ServiceProfileDefinition.cs"
click node_ticket_errors "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/TicketingManager/TicketingManagerError.cs"
click node_connection "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/Interop.SLDms/IDMS.cs"
click node_analytics_messages "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLAnalyticsTypes/Communication/GetAnalyticsMessage.cs"
click node_rad_messages "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLAnalyticsTypes/Rad/GetRADDataMessage.cs"
click node_protocol_api "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/ProtocolName.ProtocolVersion.QAction.Helper/SLProtocolExt.cs"
click node_logger_api "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLLoggerUtil/ILogger.cs"
click node_storage_types "https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/Skyline.DataMiner.Storage.Types/CustomDataType.cs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_docs,node_search,node_site_main toneBlue
class node_engine,node_engine_contract,node_elements,node_script_dummy,node_profile_adapter toneAmber
class node_profile_helper,node_profile_models,node_jobs,node_manager_base,node_service_profiles,node_service_profile_types,node_ticket_errors toneMint
class node_connection,node_analytics_messages,node_rad_messages,node_protocol_api,node_logger_api,node_storage_types toneRose
class node_reader toneIndigo
```

## Components

### Documentation site

- **DataMiner documentation**
- [Site search](https://github.com/skylinecommunications/dataminer-docs/blob/main/templates/skyline/public/search.js): `templates/skyline/public/search.js`
- [Site script](https://github.com/skylinecommunications/dataminer-docs/blob/main/templates/skyline/public/main.js): `templates/skyline/public/main.js`

### Automation APIs

- [Automation engine](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/Engine.cs): `src/DataMiner/SLManagedAutomation/Engine.cs`
- [Engine interface](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/IEngine.cs): `src/DataMiner/SLManagedAutomation/IEngine.cs`
- [Element controls](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/Element.cs): `src/DataMiner/SLManagedAutomation/Element.cs`
- [Script dummy](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/ScriptDummy.cs): `src/DataMiner/SLManagedAutomation/ScriptDummy.cs`
- [Automation profiles](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLManagedAutomation/SLProfileManager.cs): `src/DataMiner/SLManagedAutomation/SLProfileManager.cs`

### Manager APIs

- [Profile manager](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/ProfileManager/ProfileManagerHelper.cs): `src/DataMiner/SLNetTypes/Apps/ProfileManager/ProfileManagerHelper.cs`
- [Profile models](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/ProfileManager/Objects/ProfileDefinition.cs): `src/DataMiner/SLNetTypes/Apps/ProfileManager/Objects/ProfileDefinition.cs`
- [Jobs manager](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/Jobs/JobManagerHelper.cs): `src/DataMiner/SLNetTypes/Apps/Jobs/JobManagerHelper.cs`
- [Manager store base](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/ManagerStore/BaseManagerHelper.cs): `src/DataMiner/SLNetTypes/Apps/ManagerStore/BaseManagerHelper.cs`
- [Service profiles](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/ServiceProfiles/Helpers/ServiceProfileDefinitionCrudHelperComponent.cs): `src/DataMiner/SLNetTypes/Apps/ServiceProfiles/Helpers/ServiceProfileDefinitionCrudHelperComponent.cs`
- [Service profile types](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/ServiceProfiles/ServiceProfileDefinitions/ServiceProfileDefinition.cs): `src/DataMiner/SLNetTypes/ServiceProfiles/ServiceProfileDefinitions/ServiceProfileDefinition.cs`
- [Ticketing errors](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLNetTypes/Apps/TicketingManager/TicketingManagerError.cs): `src/DataMiner/SLNetTypes/Apps/TicketingManager/TicketingManagerError.cs`

### DataMiner APIs

- [DMS connection](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/Interop.SLDms/IDMS.cs): `src/DataMiner/Interop.SLDms/IDMS.cs`
- [Analytics messages](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLAnalyticsTypes/Communication/GetAnalyticsMessage.cs): `src/DataMiner/SLAnalyticsTypes/Communication/GetAnalyticsMessage.cs`
- [RAD messages](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLAnalyticsTypes/Rad/GetRADDataMessage.cs): `src/DataMiner/SLAnalyticsTypes/Rad/GetRADDataMessage.cs`
- [Protocol helpers](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/ProtocolName.ProtocolVersion.QAction.Helper/SLProtocolExt.cs): `src/DataMiner/ProtocolName.ProtocolVersion.QAction.Helper/SLProtocolExt.cs`
- [Logging API](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/SLLoggerUtil/ILogger.cs): `src/DataMiner/SLLoggerUtil/ILogger.cs`
- [Storage types](https://github.com/skylinecommunications/dataminer-docs/blob/main/src/DataMiner/Skyline.DataMiner.Storage.Types/CustomDataType.cs): `src/DataMiner/Skyline.DataMiner.Storage.Types/CustomDataType.cs`

### Other components

- **Documentation reader**

## Connections

- Documentation reader → DataMiner documentation: consults (evidence: `README.md`)
