# axonivy-market/portal architecture

> Architecture diagram of the GitHub repository axonivy-market/portal, 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/axonivy-market/portal
- Repository: https://github.com/axonivy-market/portal

## Overview

Axon Ivy Portal is the end-user portal for the Axon Ivy platform. One visible workflow is global search: an authenticated user submits a process, task, or case query to the REST resource, which delegates to the search service and returns a response. The repository tree also identifies dashboard filtering, workflow case data, document handling, chat, statistics, and portal configuration as meaningful capabilities. Source excerpts are selective, so links for unsampled features are omitted rather than inferred; dashed links indicate the documented user entry point whose UI wiring was not shown.

Main entry points: [`AxonIvyPortal/portal/src/com/axonivy/portal/rest/GlobalSearchRestService.java`](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/rest/GlobalSearchRestService.java) (Global search API), [`AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatService.java`](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatService.java) (Case chat), [`AxonIvyPortal/portal/src/com/axonivy/portal/service/GlobalSearchService.java`](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/service/GlobalSearchService.java) (Global search), [`AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/CaseDocumentService.java`](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/CaseDocumentService.java) (Case documents)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_search["Search"]
  node_global_search_api["Global search API"]
  node_global_search["Global search"]
  node_search_payload["Search request<br/>[SearchPayload.java]"]
  node_search_response["Search response"]
end

subgraph group_workflow["Workflow data"]
  node_process_service["Process lookup"]
  node_case_service["Case queries<br/>[CaseService.java]"]
  node_case_search_criteria["Case search criteria"]
  node_case_result["Case results"]
end

subgraph group_portal["Portal features"]
  node_dashboard_filter["Dashboard filters"]
  node_column_model["Dashboard columns<br/>[ColumnModel.java]"]
  node_filter_operator["Filter operators"]
  node_chat["Case chat<br/>[ChatService.java]"]
  node_chat_messages["Chat messages"]
  node_cluster_chat["Chat cluster events"]
  node_statistics["Statistics API"]
  node_document_service["Case documents"]
end

subgraph group_shared["Shared components"]
  node_security_service["Security lookup"]
  node_user_dto["User data<br/>[UserDTO.java]"]
  node_security_member_dto["Security member data"]
  node_global_variables["Portal settings"]
end

node_user(("Portal user"))
node_ivy_case_store[("Axon Ivy case store")]

node_user -.->|"submits query"| node_global_search_api
node_global_search_api -->|"accepts payload"| node_search_payload
node_global_search_api -->|"delegates search"| node_global_search
node_global_search_api -->|"returns response"| node_search_response
node_global_search -->|"uses process lookup"| node_process_service
node_chat -->|"loads messages"| node_chat_messages
node_chat -->|"sends events"| node_cluster_chat
node_document_service -->|"reads and writes"| node_ivy_case_store
node_security_service -->|"maps users"| node_user_dto

click node_global_search_api "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/rest/GlobalSearchRestService.java"
click node_global_search "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/service/GlobalSearchService.java"
click node_search_payload "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/payload/SearchPayload.java"
click node_search_response "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/response/GlobalSearchResponse.java"
click node_process_service "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/impl/ProcessService.java"
click node_case_service "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/service/impl/CaseService.java"
click node_case_search_criteria "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/searchcriteria/CaseSearchCriteria.java"
click node_case_result "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/dto/IvyCaseResultDTO.java"
click node_dashboard_filter "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/dto/dashboard/filter/DashboardFilter.java"
click node_column_model "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/dto/dashboard/ColumnModel.java"
click node_filter_operator "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/enums/dashboard/filter/FilterOperator.java"
click node_chat "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatService.java"
click node_chat_messages "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatMessageManager.java"
click node_cluster_chat "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ClusterChatEventSender.java"
click node_statistics "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/rest/StatisticRestService.java"
click node_document_service "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/CaseDocumentService.java"
click node_security_service "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/ivydata/service/impl/SecurityService.java"
click node_user_dto "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/dto/UserDTO.java"
click node_security_member_dto "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/dto/SecurityMemberDTO.java"
click node_global_variables "https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/enums/GlobalVariable.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_global_search_api,node_global_search,node_search_payload,node_search_response,node_user toneBlue
class node_process_service,node_case_service,node_case_search_criteria,node_case_result,node_ivy_case_store toneAmber
class node_dashboard_filter,node_column_model,node_filter_operator,node_chat,node_chat_messages,node_cluster_chat,node_statistics,node_document_service toneMint
class node_security_service,node_user_dto,node_security_member_dto,node_global_variables toneRose
```

## Components

### Search

- [Global search API](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/rest/GlobalSearchRestService.java): `AxonIvyPortal/portal/src/com/axonivy/portal/rest/GlobalSearchRestService.java`
- [Global search](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/service/GlobalSearchService.java): `AxonIvyPortal/portal/src/com/axonivy/portal/service/GlobalSearchService.java`
- [Search request](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/payload/SearchPayload.java): `AxonIvyPortal/portal/src/com/axonivy/portal/payload/SearchPayload.java`
- [Search response](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/response/GlobalSearchResponse.java): `AxonIvyPortal/portal/src/com/axonivy/portal/response/GlobalSearchResponse.java`

### Workflow data

- [Process lookup](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/impl/ProcessService.java): `AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/impl/ProcessService.java`
- [Case queries](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/service/impl/CaseService.java): `AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/service/impl/CaseService.java`
- [Case search criteria](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/searchcriteria/CaseSearchCriteria.java): `AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/searchcriteria/CaseSearchCriteria.java`
- [Case results](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/dto/IvyCaseResultDTO.java): `AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/ivydata/dto/IvyCaseResultDTO.java`

### Portal features

- [Dashboard filters](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/dto/dashboard/filter/DashboardFilter.java): `AxonIvyPortal/portal/src/com/axonivy/portal/dto/dashboard/filter/DashboardFilter.java`
- [Dashboard columns](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/dto/dashboard/ColumnModel.java): `AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/dto/dashboard/ColumnModel.java`
- [Filter operators](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/enums/dashboard/filter/FilterOperator.java): `AxonIvyPortal/portal/src/com/axonivy/portal/enums/dashboard/filter/FilterOperator.java`
- [Case chat](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatService.java): `AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatService.java`
- [Chat messages](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatMessageManager.java): `AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatMessageManager.java`
- [Chat cluster events](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ClusterChatEventSender.java): `AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ClusterChatEventSender.java`
- [Statistics API](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/com/axonivy/portal/rest/StatisticRestService.java): `AxonIvyPortal/portal/src/com/axonivy/portal/rest/StatisticRestService.java`
- [Case documents](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/CaseDocumentService.java): `AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/CaseDocumentService.java`

### Shared components

- [Security lookup](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/ivydata/service/impl/SecurityService.java): `AxonIvyPortal/portal-components/src/com/axonivy/portal/components/ivydata/service/impl/SecurityService.java`
- [User data](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/dto/UserDTO.java): `AxonIvyPortal/portal-components/src/com/axonivy/portal/components/dto/UserDTO.java`
- [Security member data](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal-components/src/com/axonivy/portal/components/dto/SecurityMemberDTO.java): `AxonIvyPortal/portal-components/src/com/axonivy/portal/components/dto/SecurityMemberDTO.java`
- [Portal settings](https://github.com/axonivy-market/portal/blob/master/AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/enums/GlobalVariable.java): `AxonIvyPortal/portal/src/ch/ivy/addon/portalkit/enums/GlobalVariable.java`

### Other components

- **Portal user**
- **Axon Ivy case store**

## Connections

- Portal user → Global search API: submits query
- Global search API → Search request: accepts payload (evidence: `AxonIvyPortal/portal/src/com/axonivy/portal/rest/GlobalSearchRestService.java`)
- Global search API → Global search: delegates search (evidence: `AxonIvyPortal/portal/src/com/axonivy/portal/rest/GlobalSearchRestService.java`)
- Global search API → Search response: returns response (evidence: `AxonIvyPortal/portal/src/com/axonivy/portal/rest/GlobalSearchRestService.java`)
- Global search → Process lookup: uses process lookup (evidence: `AxonIvyPortal/portal/src/com/axonivy/portal/service/GlobalSearchService.java`)
- Case chat → Chat messages: loads messages (evidence: `AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatService.java`)
- Case chat → Chat cluster events: sends events (evidence: `AxonIvyPortal/portal/src/ch/ivy/addon/portal/chat/ChatService.java`)
- Case documents → Axon Ivy case store: reads and writes (evidence: `AxonIvyPortal/portal-components/src/com/axonivy/portal/components/service/CaseDocumentService.java`)
- Security lookup → User data: maps users (evidence: `AxonIvyPortal/portal-components/src/com/axonivy/portal/components/ivydata/service/impl/SecurityService.java`)
