# moqui/moqui-framework architecture

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

- Interactive diagram: https://gitdiagram.com/moqui/moqui-framework
- Repository: https://github.com/moqui/moqui-framework

## Overview

Moqui Framework is a runtime framework for executing application services and managing shared execution context, entities, screens, and integrations. A typical invocation enters through the service API, resolves and validates a service definition, then runs it with thread-scoped context and access to framework facilities. Entity querying and persistence, screen rendering, ETL, and remote calls are distinct capabilities rather than a single assumed pipeline. The graph follows documented interfaces and indexed source references; several subsystem links are omitted where sampled excerpts do not establish the runtime caller.

Main entry points: [`framework/src/main/java/org/moqui/service/ServiceFacade.java`](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/service/ServiceFacade.java) (Service facade), [`framework/src/main/java/org/moqui/entity/EntityFacade.java`](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/entity/EntityFacade.java) (Entity facade), [`framework/src/main/java/org/moqui/context/ExecutionContext.java`](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/context/ExecutionContext.java) (Execution context API), [`framework/src/main/groovy/org/moqui/impl/service/ServiceCallImpl.java`](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/service/ServiceCallImpl.java) (Service call)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_execution["Execution context"]
  node_ecapi["Execution context API"]
  node_context["Execution context"]
  node_contextstack["Context stack<br/>[ContextStack.java]"]
  node_artifact["Artifact execution"]
end

subgraph group_services["Service runtime"]
  node_serviceapi["Service API<br/>[ServiceCall.java]"]
  node_servicefacade["Service facade<br/>[ServiceFacade.java]"]
  node_servicecall["Service call"]
  node_sync["Synchronous dispatch"]
  node_definition["Service definition"]
  node_runner["Service runners"]
end

subgraph group_data["Data and ETL"]
  node_entityapi["Entity facade<br/>[EntityFacade.java]"]
  node_entityquery["Entity queries"]
  node_entityvalue["Entity values<br/>[EntityValue.java]"]
  node_entitylist["Entity results<br/>[EntityList.java]"]
  node_etl["Simple ETL<br/>[SimpleEtl.java]"]
end

subgraph group_interfaces["Screens and integrations"]
  node_screenapi["Screen facade<br/>[ScreenFacade.java]"]
  node_screenrender["Screen rendering"]
  node_resource["Resource access"]
  node_rest["REST client<br/>[RestClient.java]"]
end

node_caller(("Application caller"))
node_remote(("Remote services"))

node_caller -->|"invokes"| node_serviceapi
node_serviceapi -->|"obtains caller"| node_servicefacade
node_servicefacade -.->|"creates call"| node_servicecall
node_servicecall -->|"resolves"| node_definition
node_servicecall -.->|"dispatches"| node_sync
node_sync -->|"uses definition"| node_definition
node_sync -->|"uses context"| node_context
node_definition -.->|"selects runner"| node_runner
node_ecapi -.->|"implemented by"| node_context
node_context -->|"owns stack"| node_contextstack
node_ecapi -->|"exposes"| node_entityapi
node_ecapi -->|"exposes"| node_screenapi
node_entityquery -.->|"builds queries for"| node_entityapi
node_entityapi -.->|"returns values"| node_entityvalue
node_entityapi -.->|"returns results"| node_entitylist
node_screenapi -.->|"renders screens"| node_screenrender
node_servicefacade -->|"provides client"| node_rest
node_servicefacade -->|"calls JSON RPC"| node_remote
node_rest -->|"sends requests"| node_remote

click node_ecapi "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/context/ExecutionContext.java"
click node_context "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/context/ExecutionContextImpl.java"
click node_contextstack "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/util/ContextStack.java"
click node_artifact "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/context/ArtifactExecutionInfo.java"
click node_serviceapi "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/service/ServiceCall.java"
click node_servicefacade "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/service/ServiceFacade.java"
click node_servicecall "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/service/ServiceCallImpl.java"
click node_sync "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/service/ServiceCallSyncImpl.java"
click node_definition "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/service/ServiceDefinition.java"
click node_runner "https://github.com/moqui/moqui-framework/tree/master/framework/src/main/groovy/org/moqui/impl/service/runner"
click node_entityapi "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/entity/EntityFacade.java"
click node_entityquery "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/entity/EntityQueryBuilder.java"
click node_entityvalue "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/entity/EntityValue.java"
click node_entitylist "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/entity/EntityList.java"
click node_etl "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/etl/SimpleEtl.java"
click node_screenapi "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/screen/ScreenFacade.java"
click node_screenrender "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/screen/ScreenWidgetRender.java"
click node_resource "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/context/ResourceFacade.java"
click node_rest "https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/util/RestClient.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_ecapi,node_context,node_contextstack,node_artifact toneBlue
class node_serviceapi,node_servicefacade,node_servicecall,node_sync,node_definition,node_runner toneAmber
class node_entityapi,node_entityquery,node_entityvalue,node_entitylist,node_etl toneMint
class node_screenapi,node_screenrender,node_resource,node_rest toneRose
class node_caller,node_remote toneIndigo
```

## Components

### Execution context

- [Execution context API](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/context/ExecutionContext.java): `framework/src/main/java/org/moqui/context/ExecutionContext.java`
- [Execution context](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/context/ExecutionContextImpl.java): `framework/src/main/groovy/org/moqui/impl/context/ExecutionContextImpl.java`
- [Context stack](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/util/ContextStack.java): `framework/src/main/java/org/moqui/util/ContextStack.java`
- [Artifact execution](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/context/ArtifactExecutionInfo.java): `framework/src/main/java/org/moqui/context/ArtifactExecutionInfo.java`

### Service runtime

- [Service API](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/service/ServiceCall.java): `framework/src/main/java/org/moqui/service/ServiceCall.java`
- [Service facade](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/service/ServiceFacade.java): `framework/src/main/java/org/moqui/service/ServiceFacade.java`
- [Service call](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/service/ServiceCallImpl.java): `framework/src/main/groovy/org/moqui/impl/service/ServiceCallImpl.java`
- [Synchronous dispatch](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/service/ServiceCallSyncImpl.java): `framework/src/main/groovy/org/moqui/impl/service/ServiceCallSyncImpl.java`
- [Service definition](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/service/ServiceDefinition.java): `framework/src/main/groovy/org/moqui/impl/service/ServiceDefinition.java`
- [Service runners](https://github.com/moqui/moqui-framework/tree/master/framework/src/main/groovy/org/moqui/impl/service/runner): `framework/src/main/groovy/org/moqui/impl/service/runner`

### Data and ETL

- [Entity facade](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/entity/EntityFacade.java): `framework/src/main/java/org/moqui/entity/EntityFacade.java`
- [Entity queries](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/entity/EntityQueryBuilder.java): `framework/src/main/groovy/org/moqui/impl/entity/EntityQueryBuilder.java`
- [Entity values](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/entity/EntityValue.java): `framework/src/main/java/org/moqui/entity/EntityValue.java`
- [Entity results](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/entity/EntityList.java): `framework/src/main/java/org/moqui/entity/EntityList.java`
- [Simple ETL](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/etl/SimpleEtl.java): `framework/src/main/java/org/moqui/etl/SimpleEtl.java`

### Screens and integrations

- [Screen facade](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/screen/ScreenFacade.java): `framework/src/main/java/org/moqui/screen/ScreenFacade.java`
- [Screen rendering](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/groovy/org/moqui/impl/screen/ScreenWidgetRender.java): `framework/src/main/groovy/org/moqui/impl/screen/ScreenWidgetRender.java`
- [Resource access](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/context/ResourceFacade.java): `framework/src/main/java/org/moqui/context/ResourceFacade.java`
- [REST client](https://github.com/moqui/moqui-framework/blob/master/framework/src/main/java/org/moqui/util/RestClient.java): `framework/src/main/java/org/moqui/util/RestClient.java`

### Other components

- **Application caller**
- **Remote services**

## Connections

- Application caller → Service API: invokes
- Service API → Service facade: obtains caller (evidence: `framework/src/main/java/org/moqui/service/ServiceFacade.java`)
- Service facade → Service call: creates call
- Service call → Service definition: resolves (evidence: `framework/src/main/groovy/org/moqui/impl/service/ServiceCallImpl.java`)
- Service call → Synchronous dispatch: dispatches (evidence: `framework/src/main/groovy/org/moqui/impl/service/ServiceCallSyncImpl.java`)
- Synchronous dispatch → Service definition: uses definition (evidence: `framework/src/main/groovy/org/moqui/impl/service/ServiceCallSyncImpl.java`)
- Synchronous dispatch → Execution context: uses context (evidence: `framework/src/main/groovy/org/moqui/impl/service/ServiceCallSyncImpl.java`)
- Service definition → Service runners: selects runner (evidence: `framework/src/main/groovy/org/moqui/impl/service/runner/ScriptServiceRunner.java`)
- Execution context API → Execution context: implemented by (evidence: `framework/src/main/groovy/org/moqui/impl/context/ExecutionContextImpl.java`)
- Execution context → Context stack: owns stack (evidence: `framework/src/main/groovy/org/moqui/impl/context/ExecutionContextImpl.java`)
- Execution context API → Entity facade: exposes (evidence: `framework/src/main/java/org/moqui/context/ExecutionContext.java`)
- Execution context API → Screen facade: exposes (evidence: `framework/src/main/java/org/moqui/context/ExecutionContext.java`)
- Entity queries → Entity facade: builds queries for
- Entity facade → Entity values: returns values (evidence: `framework/src/main/java/org/moqui/entity/EntityFacade.java`)
- Entity facade → Entity results: returns results
- Screen facade → Screen rendering: renders screens
- Service facade → REST client: provides client (evidence: `framework/src/main/java/org/moqui/service/ServiceFacade.java`)
- Service facade → Remote services: calls JSON RPC (evidence: `framework/src/main/java/org/moqui/service/ServiceFacade.java`)
- REST client → Remote services: sends requests (evidence: `framework/src/main/java/org/moqui/util/RestClient.java`)
