# aveva/connect-data-services-developer-docs architecture

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

- Interactive diagram: https://gitdiagram.com/aveva/connect-data-services-developer-docs
- Repository: https://github.com/aveva/connect-data-services-developer-docs

## Overview

This repository is CONNECT Data Services developer documentation, not the data-services runtime. Its primary user journey is to learn platform concepts in the developer guide, then consult the API reference while implementing a capability. The repository also contains DocFX template transformations for conceptual, managed-reference, REST, universal-reference, and table-of-contents pages. README-described platform features are represented as documented subject areas, not as implementation services. Template relationships are limited to calls and imports visible in the supplied excerpts; unsampled template and content internals are not inferred.

Main entry points: [`_exported_templates/default/RestApi.common.js`](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/RestApi.common.js) (REST model transform), [`_exported_templates/default/ManagedReference.common.js`](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/ManagedReference.common.js) (Managed reference model), [`_exported_templates/default/UniversalReference.common.js`](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/UniversalReference.common.js) (Universal reference model), [`_exported_templates/default/RestApi.html.primary.js`](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/RestApi.html.primary.js) (REST page transform)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_guides["Developer guide"]
  node_developer["Developer guide"]
  node_identitydev["Identity guidance"]
  node_sdsdev["SDS guidance"]
  node_dataviewdev["Data view guidance"]
  node_assetdev["Asset guidance"]
  node_omfdev["OMF guidance"]
end

subgraph group_reference["API reference"]
  node_apiref["API reference"]
  node_identityapi["Identity APIs"]
  node_sdsapi["SDS APIs"]
  node_dataviewapi["Data view APIs"]
  node_assetapi["Asset APIs"]
  node_omfapi["OMF ingress APIs"]
  node_eventapi["Event GraphQL APIs"]
  node_rulesapi["Rules APIs"]
  node_tenantapi["Tenant APIs"]
  node_communityapi["Community APIs"]
end

subgraph group_platform["Documented capabilities"]
  node_collection["Data collection"]
  node_context["Data context"]
  node_storage[("Time-series storage")]
  node_access["Data access"]
  node_delivery["REST delivery"]
end

subgraph group_templates["DocFX templates"]
  node_restprimary["REST page transform"]
  node_restcommon["REST model transform<br/>[RestApi.common.js]"]
  node_restextension["REST extension hooks"]
  node_managedprimary["Managed reference transform"]
  node_managedcommon["Managed reference model"]
  node_managedextension["Managed extension hooks"]
  node_universalprimary["Universal reference transform"]
  node_universalcommon["Universal reference model"]
  node_universalextension["Universal extension hooks"]
  node_conceptualextension["Conceptual hooks"]
  node_toctransform["TOC transform<br/>[toc.html.js]"]
  node_tocextension["TOC hooks<br/>[toc.extension.js]"]
end

node_externaldev(("Developer"))

node_externaldev -->|"starts with"| node_developer
node_developer -->|"then consults"| node_apiref
node_collection -->|"adds context"| node_context
node_context -->|"stores data"| node_storage
node_storage -->|"enables access"| node_access
node_access -->|"delivers via REST"| node_delivery
node_restprimary -->|"transforms with"| node_restcommon
node_restprimary -->|"calls hooks"| node_restextension
node_restcommon -->|"uses helpers"| node_restcommon
node_managedprimary -->|"transforms with"| node_managedcommon
node_managedprimary -->|"calls hooks"| node_managedextension
node_managedcommon -->|"uses helpers"| node_managedcommon
node_universalprimary -->|"transforms with"| node_universalcommon
node_universalprimary -->|"calls hooks"| node_universalextension
node_universalcommon -->|"uses helpers"| node_universalcommon
node_toctransform -->|"calls hooks"| node_tocextension

click node_developer "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide"
click node_identitydev "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/identity-dev"
click node_sdsdev "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/sequential-data-store-dev"
click node_dataviewdev "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/data-views-dev"
click node_assetdev "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/asset-dev"
click node_omfdev "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/omf-dev"
click node_apiref "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference"
click node_identityapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/identity"
click node_sdsapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/sequential-data-store"
click node_dataviewapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/data-views"
click node_assetapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/assets"
click node_omfapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/data-ingress/omf-ingress"
click node_eventapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/event-graphql-api"
click node_rulesapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/rules"
click node_tenantapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/tenant"
click node_communityapi "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/community"
click node_collection "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/omf-dev"
click node_context "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/asset-dev"
click node_storage "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/sequential-data-store-dev"
click node_access "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/data-views-dev"
click node_delivery "https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference"
click node_restprimary "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/RestApi.html.primary.js"
click node_restcommon "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/RestApi.common.js"
click node_restextension "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/RestApi.extension.js"
click node_managedprimary "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/ManagedReference.html.primary.js"
click node_managedcommon "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/ManagedReference.common.js"
click node_managedextension "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/ManagedReference.extension.js"
click node_universalprimary "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/UniversalReference.html.primary.js"
click node_universalcommon "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/UniversalReference.common.js"
click node_universalextension "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/UniversalReference.extension.js"
click node_conceptualextension "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/conceptual.extension.js"
click node_toctransform "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/toc.html.js"
click node_tocextension "https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/toc.extension.js"

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_developer,node_identitydev,node_sdsdev,node_dataviewdev,node_assetdev,node_omfdev toneBlue
class node_apiref,node_identityapi,node_sdsapi,node_dataviewapi,node_assetapi,node_omfapi,node_eventapi,node_rulesapi,node_tenantapi,node_communityapi toneAmber
class node_collection,node_context,node_storage,node_access,node_delivery toneMint
class node_restprimary,node_restcommon,node_restextension,node_managedprimary,node_managedcommon,node_managedextension,node_universalprimary,node_universalcommon,node_universalextension,node_conceptualextension,node_toctransform,node_tocextension toneRose
class node_externaldev toneIndigo
```

## Components

### Developer guide

- [Developer guide](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide): `content/developer-guide`
- [Identity guidance](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/identity-dev): `content/developer-guide/identity-dev`
- [SDS guidance](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/sequential-data-store-dev): `content/developer-guide/sequential-data-store-dev`
- [Data view guidance](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/data-views-dev): `content/developer-guide/data-views-dev`
- [Asset guidance](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/asset-dev): `content/developer-guide/asset-dev`
- [OMF guidance](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/omf-dev): `content/developer-guide/omf-dev`

### API reference

- [API reference](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference): `content/api-reference`
- [Identity APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/identity): `content/api-reference/identity`
- [SDS APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/sequential-data-store): `content/api-reference/sequential-data-store`
- [Data view APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/data-views): `content/api-reference/data-views`
- [Asset APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/assets): `content/api-reference/assets`
- [OMF ingress APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/data-ingress/omf-ingress): `content/api-reference/data-ingress/omf-ingress`
- [Event GraphQL APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/event-graphql-api): `content/api-reference/event-graphql-api`
- [Rules APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/rules): `content/api-reference/rules`
- [Tenant APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/tenant): `content/api-reference/tenant`
- [Community APIs](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference/community): `content/api-reference/community`

### Documented capabilities

- [Data collection](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/omf-dev): `content/developer-guide/omf-dev`
- [Data context](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/asset-dev): `content/developer-guide/asset-dev`
- [Time-series storage](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/sequential-data-store-dev): `content/developer-guide/sequential-data-store-dev`
- [Data access](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/developer-guide/data-views-dev): `content/developer-guide/data-views-dev`
- [REST delivery](https://github.com/aveva/connect-data-services-developer-docs/tree/main/content/api-reference): `content/api-reference`

### DocFX templates

- [REST page transform](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/RestApi.html.primary.js): `_exported_templates/default/RestApi.html.primary.js`
- [REST model transform](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/RestApi.common.js): `_exported_templates/default/RestApi.common.js`
- [REST extension hooks](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/RestApi.extension.js): `_exported_templates/default/RestApi.extension.js`
- [Managed reference transform](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/ManagedReference.html.primary.js): `_exported_templates/default/ManagedReference.html.primary.js`
- [Managed reference model](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/ManagedReference.common.js): `_exported_templates/default/ManagedReference.common.js`
- [Managed extension hooks](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/ManagedReference.extension.js): `_exported_templates/default/ManagedReference.extension.js`
- [Universal reference transform](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/UniversalReference.html.primary.js): `_exported_templates/default/UniversalReference.html.primary.js`
- [Universal reference model](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/UniversalReference.common.js): `_exported_templates/default/UniversalReference.common.js`
- [Universal extension hooks](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/UniversalReference.extension.js): `_exported_templates/default/UniversalReference.extension.js`
- [Conceptual hooks](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/conceptual.extension.js): `_exported_templates/default/conceptual.extension.js`
- [TOC transform](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/toc.html.js): `_exported_templates/default/toc.html.js`
- [TOC hooks](https://github.com/aveva/connect-data-services-developer-docs/blob/main/_exported_templates/default/toc.extension.js): `_exported_templates/default/toc.extension.js`

### Other components

- **Developer**

## Connections

- Developer → Developer guide: starts with (evidence: `README.md`)
- Developer guide → API reference: then consults (evidence: `README.md`)
- Data collection → Data context: adds context (evidence: `README.md`)
- Data context → Time-series storage: stores data (evidence: `README.md`)
- Time-series storage → Data access: enables access (evidence: `README.md`)
- Data access → REST delivery: delivers via REST (evidence: `README.md`)
- REST page transform → REST model transform: transforms with (evidence: `_exported_templates/default/RestApi.html.primary.js`)
- REST page transform → REST extension hooks: calls hooks (evidence: `_exported_templates/default/RestApi.html.primary.js`)
- REST model transform → REST model transform: uses helpers (evidence: `_exported_templates/default/RestApi.common.js`)
- Managed reference transform → Managed reference model: transforms with (evidence: `_exported_templates/default/ManagedReference.html.primary.js`)
- Managed reference transform → Managed extension hooks: calls hooks (evidence: `_exported_templates/default/ManagedReference.html.primary.js`)
- Managed reference model → Managed reference model: uses helpers (evidence: `_exported_templates/default/ManagedReference.common.js`)
- Universal reference transform → Universal reference model: transforms with (evidence: `_exported_templates/default/UniversalReference.html.primary.js`)
- Universal reference transform → Universal extension hooks: calls hooks (evidence: `_exported_templates/default/UniversalReference.html.primary.js`)
- Universal reference model → Universal reference model: uses helpers (evidence: `_exported_templates/default/UniversalReference.common.js`)
- TOC transform → TOC hooks: calls hooks (evidence: `_exported_templates/default/toc.html.js`)
