# knowagelabs/knowage-server architecture

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

- Interactive diagram: https://gitdiagram.com/knowagelabs/knowage-server
- Repository: https://github.com/knowagelabs/knowage-server

## Overview

KNOWAGE is a broad business-intelligence and analytics suite. Its main user-to-result path is selecting and executing an analytical document: engine startup assembles user, template, dataset, and datasource context, then an engine produces a dashboard, query, or report result. The README also identifies KPI, data preparation, Python, dossier, and virtual-assistant capabilities. The sampled runtime files show context and service-proxy behavior, but not complete wiring for most product features; those branches are retained without asserting unverified calls.

Main entry points: [`knowageutils/src/main/java/it/eng/spagobi/utilities/engines/rest/AbstractEngineRestService.java`](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/utilities/engines/rest/AbstractEngineRestService.java) (Engine REST), [`knowageutils/src/main/java/it/eng/spagobi/utilities/engines/EngineStartServletIOManager.java`](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/utilities/engines/EngineStartServletIOManager.java) (Engine startup), [`knowage-core/src/main/java/it/eng/knowage/document/cockpit/CockpitDocument.java`](https://github.com/knowagelabs/knowage-server/blob/master/knowage-core/src/main/java/it/eng/knowage/document/cockpit/CockpitDocument.java) (Online dashboard), [`knowageqbeengine/src/main/java/it/eng/spagobi/engines/qbe/QbeEngineInstance.java`](https://github.com/knowagelabs/knowage-server/blob/master/knowageqbeengine/src/main/java/it/eng/spagobi/engines/qbe/QbeEngineInstance.java) (OLAP and QBE)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Execution runtime"]
  node_engine_start["Engine startup"]
  node_engine_rest["Engine REST"]
  node_profile["User profile<br/>[UserProfile.java]"]
  node_content_proxy["Content proxy"]
end

subgraph group_analysis["Analytics features"]
  node_cockpit["Online dashboard"]
  node_qbe["OLAP and QBE"]
  node_reporting["Reporting<br/>[BirtEngine.java]"]
  node_kpi["KPI analytics"]
  node_python["Python integration<br/>[PythonProxy.java]"]
  node_dossier["Dossier creation"]
  node_assistant["Virtual assistant"]
  node_result["Analysis result"]
end

subgraph group_platform["Platform services"]
  node_function_catalog["Function catalog"]
  node_api_files["Resource management<br/>[FilesResource.java]"]
  node_logs["Log management<br/>[LogsResource.java]"]
end

subgraph group_integration["Data integration"]
  node_dataset["Dataset model<br/>[IDataSet.java]"]
  node_datasource["Datasource model<br/>[IDataSource.java]"]
  node_data_prep["Data preparation<br/>[IDataSet.java]"]
  node_federation["Data federation<br/>[IDataSet.java]"]
end

node_user(("Analyst"))

node_user -.->|"starts analysis"| node_engine_start
node_engine_start -->|"sets profile"| node_profile
node_engine_start -->|"reads template"| node_content_proxy
node_engine_start -.->|"provides context"| node_engine_rest
node_engine_rest -->|"uses dataset"| node_dataset
node_engine_rest -->|"uses datasource"| node_datasource
node_engine_rest -->|"loads content"| node_content_proxy
node_engine_rest -.->|"executes analysis"| node_cockpit
node_engine_rest -.->|"executes analysis"| node_qbe
node_engine_rest -.->|"executes report"| node_reporting
node_cockpit -.->|"visualizes data"| node_result
node_qbe -.->|"returns analysis"| node_result
node_reporting -.->|"produces report"| node_result
node_user -.->|"uses KPI tools"| node_kpi
node_user -.->|"runs scripts"| node_python
node_user -.->|"creates dossier"| node_dossier
node_user -.->|"uses assistant"| node_assistant
node_user -.->|"prepares data"| node_data_prep
node_user -.->|"combines sources"| node_federation
node_user -.->|"manages functions"| node_function_catalog
node_user -.->|"manages resources"| node_api_files
node_user -.->|"accesses logs"| node_logs

click node_engine_start "https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/utilities/engines/EngineStartServletIOManager.java"
click node_engine_rest "https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/utilities/engines/rest/AbstractEngineRestService.java"
click node_profile "https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/commons/bo/UserProfile.java"
click node_content_proxy "https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/services/proxy/ContentServiceProxy.java"
click node_dataset "https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java"
click node_datasource "https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/tools/datasource/bo/IDataSource.java"
click node_cockpit "https://github.com/knowagelabs/knowage-server/blob/master/knowage-core/src/main/java/it/eng/knowage/document/cockpit/CockpitDocument.java"
click node_qbe "https://github.com/knowagelabs/knowage-server/blob/master/knowageqbeengine/src/main/java/it/eng/spagobi/engines/qbe/QbeEngineInstance.java"
click node_reporting "https://github.com/knowagelabs/knowage-server/blob/master/knowagebirtreportengine/src/main/java/it/eng/spagobi/engines/birt/BirtEngine.java"
click node_kpi "https://github.com/knowagelabs/knowage-server/blob/master/knowagekpiengine/src/main/java/it/eng/knowage/engine/kpi/KpiEngineInstance.java"
click node_python "https://github.com/knowagelabs/knowage-server/blob/master/knowage-core/src/main/java/it/eng/knowage/backendservices/rest/widgets/PythonProxy.java"
click node_dossier "https://github.com/knowagelabs/knowage-server/blob/master/knowage-core/src/main/java/it/eng/knowage/api/dossier/DossierExecutionResource.java"
click node_assistant "https://github.com/knowagelabs/knowage-server/blob/master/knowage-api/src/main/java/it/eng/knowage/resourcemanager/resource/EngGptDataResource.java"
click node_data_prep "https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java"
click node_federation "https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java"
click node_function_catalog "https://github.com/knowagelabs/knowage-server/blob/master/knowage-api/src/main/java/it/eng/knowage/knowageapi/resource/FunctionCatalogResource.java"
click node_api_files "https://github.com/knowagelabs/knowage-server/blob/master/knowage-api/src/main/java/it/eng/knowage/resourcemanager/resource/FilesResource.java"
click node_logs "https://github.com/knowagelabs/knowage-server/blob/master/knowage-api/src/main/java/it/eng/knowage/logmanager/resource/LogsResource.java"

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_engine_start,node_engine_rest,node_profile,node_content_proxy toneBlue
class node_cockpit,node_qbe,node_reporting,node_kpi,node_python,node_dossier,node_assistant,node_result toneAmber
class node_function_catalog,node_api_files,node_logs toneMint
class node_dataset,node_datasource,node_data_prep,node_federation toneRose
class node_user toneIndigo
```

## Components

### Execution runtime

- [Engine startup](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/utilities/engines/EngineStartServletIOManager.java): `knowageutils/src/main/java/it/eng/spagobi/utilities/engines/EngineStartServletIOManager.java`
- [Engine REST](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/utilities/engines/rest/AbstractEngineRestService.java): `knowageutils/src/main/java/it/eng/spagobi/utilities/engines/rest/AbstractEngineRestService.java`
- [User profile](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/commons/bo/UserProfile.java): `knowageutils/src/main/java/it/eng/spagobi/commons/bo/UserProfile.java`
- [Content proxy](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/services/proxy/ContentServiceProxy.java): `knowageutils/src/main/java/it/eng/spagobi/services/proxy/ContentServiceProxy.java`

### Analytics features

- [Online dashboard](https://github.com/knowagelabs/knowage-server/blob/master/knowage-core/src/main/java/it/eng/knowage/document/cockpit/CockpitDocument.java): `knowage-core/src/main/java/it/eng/knowage/document/cockpit/CockpitDocument.java`
- [OLAP and QBE](https://github.com/knowagelabs/knowage-server/blob/master/knowageqbeengine/src/main/java/it/eng/spagobi/engines/qbe/QbeEngineInstance.java): `knowageqbeengine/src/main/java/it/eng/spagobi/engines/qbe/QbeEngineInstance.java`
- [Reporting](https://github.com/knowagelabs/knowage-server/blob/master/knowagebirtreportengine/src/main/java/it/eng/spagobi/engines/birt/BirtEngine.java): `knowagebirtreportengine/src/main/java/it/eng/spagobi/engines/birt/BirtEngine.java`
- [KPI analytics](https://github.com/knowagelabs/knowage-server/blob/master/knowagekpiengine/src/main/java/it/eng/knowage/engine/kpi/KpiEngineInstance.java): `knowagekpiengine/src/main/java/it/eng/knowage/engine/kpi/KpiEngineInstance.java`
- [Python integration](https://github.com/knowagelabs/knowage-server/blob/master/knowage-core/src/main/java/it/eng/knowage/backendservices/rest/widgets/PythonProxy.java): `knowage-core/src/main/java/it/eng/knowage/backendservices/rest/widgets/PythonProxy.java`
- [Dossier creation](https://github.com/knowagelabs/knowage-server/blob/master/knowage-core/src/main/java/it/eng/knowage/api/dossier/DossierExecutionResource.java): `knowage-core/src/main/java/it/eng/knowage/api/dossier/DossierExecutionResource.java`
- [Virtual assistant](https://github.com/knowagelabs/knowage-server/blob/master/knowage-api/src/main/java/it/eng/knowage/resourcemanager/resource/EngGptDataResource.java): `knowage-api/src/main/java/it/eng/knowage/resourcemanager/resource/EngGptDataResource.java`
- **Analysis result**

### Platform services

- [Function catalog](https://github.com/knowagelabs/knowage-server/blob/master/knowage-api/src/main/java/it/eng/knowage/knowageapi/resource/FunctionCatalogResource.java): `knowage-api/src/main/java/it/eng/knowage/knowageapi/resource/FunctionCatalogResource.java`
- [Resource management](https://github.com/knowagelabs/knowage-server/blob/master/knowage-api/src/main/java/it/eng/knowage/resourcemanager/resource/FilesResource.java): `knowage-api/src/main/java/it/eng/knowage/resourcemanager/resource/FilesResource.java`
- [Log management](https://github.com/knowagelabs/knowage-server/blob/master/knowage-api/src/main/java/it/eng/knowage/logmanager/resource/LogsResource.java): `knowage-api/src/main/java/it/eng/knowage/logmanager/resource/LogsResource.java`

### Data integration

- [Dataset model](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java): `knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java`
- [Datasource model](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/tools/datasource/bo/IDataSource.java): `knowageutils/src/main/java/it/eng/spagobi/tools/datasource/bo/IDataSource.java`
- [Data preparation](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java): `knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java`
- [Data federation](https://github.com/knowagelabs/knowage-server/blob/master/knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java): `knowageutils/src/main/java/it/eng/spagobi/tools/dataset/bo/IDataSet.java`

### Other components

- **Analyst**

## Connections

- Analyst → Engine startup: starts analysis
- Engine startup → User profile: sets profile (evidence: `knowageutils/src/main/java/it/eng/spagobi/utilities/engines/EngineStartServletIOManager.java`)
- Engine startup → Content proxy: reads template (evidence: `knowageutils/src/main/java/it/eng/spagobi/utilities/engines/EngineStartServletIOManager.java`)
- Engine startup → Engine REST: provides context
- Engine REST → Dataset model: uses dataset (evidence: `knowageutils/src/main/java/it/eng/spagobi/utilities/engines/rest/AbstractEngineRestService.java`)
- Engine REST → Datasource model: uses datasource (evidence: `knowageutils/src/main/java/it/eng/spagobi/utilities/engines/rest/AbstractEngineRestService.java`)
- Engine REST → Content proxy: loads content (evidence: `knowageutils/src/main/java/it/eng/spagobi/utilities/engines/rest/AbstractEngineRestService.java`)
- Engine REST → Online dashboard: executes analysis
- Engine REST → OLAP and QBE: executes analysis
- Engine REST → Reporting: executes report
- Online dashboard → Analysis result: visualizes data
- OLAP and QBE → Analysis result: returns analysis
- Reporting → Analysis result: produces report
- Analyst → KPI analytics: uses KPI tools
- Analyst → Python integration: runs scripts
- Analyst → Dossier creation: creates dossier
- Analyst → Virtual assistant: uses assistant
- Analyst → Data preparation: prepares data
- Analyst → Data federation: combines sources
- Analyst → Function catalog: manages functions
- Analyst → Resource management: manages resources
- Analyst → Log management: accesses logs
