Glossary

A Backend Service is an autonomous microservice application responsible for handling core business logic, data management, and system integrations.
It acts as the structural backend layer that processes data, manages persistence, and exposes capabilities through standardized interfaces such as REST or GraphQL APIs. A backend service can function fully independently or interoperate within a larger, distributed microservices architecture, communicating with other components to deliver comprehensive business capabilities.

Within a platform architecture like OneCX, a Backend Service fulfills exactly this classical role: it intercepts, validates, and processes requests sent from frontend applications (UI Apps) or adjacent services. To standardize development and accelerate time-to-market, specific blueprints and tools are utilized:

Scaffolding & Generation: The initial project structure, configurations, and boilerplate code are automatically scaffolded using the OneCX App/SVC Generator.

Technology Stack: It is built on top of modern, cloud-native frameworks—predominantly Quarkus—to guarantee high performance, fast startup times, and low memory consumption.

An entity (resource) is a representation of a real-world object or concept that is relevant to the application’s domain. It typically corresponds to a data model that defines the structure and properties of the entity, as well as the operations that can be performed on it.
The name is usually equal to <Feature> .
The entity/resource is used in various places, e.g. for search results, details view, create and update requests. As it is shared, be cautious while making changes to it. If the entity/resource differs for different use cases, you can define multiple entity/resources in the <Entity Schema> and adjust the endpoints accordingly.

An entity schema defines the structure of an entity/resource, including its properties and their types. It is used to ensure that the data for the entity is consistent and follows a defined format. The schema definition follows the OpenAPI specification. This is the basis for processing feature data, e.g., for searching, displaying, and modifying it.
At OneCX, we explicitly follow an API-first approach. In practice, this means that the OpenAPI Specification file is created first, in which entities and the paths for requests/responses are described. The OpenAPI file serves as the basis for the implementation of the backend services and the frontend components.