OneCX Local Environment
onecx-local-env is the local development environment for OneCX. It is based on Docker/Docker Compose, and enables developers to quickly run a local instance for development and testing purposes.
onecx-local-env can either be used as a standalone tool, or integrated into custom development environments via Git submodules. Custom development environments can interact with onecx-local-env via provided lifecycle-scripts and extend its functionality by wrapping the provided Docker Compose and script files with custom implementations.
Get and Run OneCX
| Setting up |
Details on how to get and install OneCX locally |
| Run OneCX |
How to start and access OneCX |
Scripts for more Ease
Since OneCX runs in a Docker Compose environment, most settings can be managed directly through Docker and Docker Compose. However, for a more convenient approach and taking into account specific OneCX features, various shell scripts are available.
| Each script has the -h flag to explain how to use. |
The following table gives an overview of the available scripts in onecx-local-env root directory.
Start the local environment including import of inital neccessary data |
|
Stop the local environment |
|
Import data into the local environment |
|
Integrate local running microfrontends directly into OneCX |
|
List local images with state and version |
|
Update local images to the latest available versions |
|
List all running containers with details and filter options |
|
Create or update Java Truststore with custom certificates |
Additional Utilities
In addition to the OneCX Core products, further services will be launched.
The IAM service used by OneCX |
|
Postgres |
Storing the data. Each OneCX backend service has its own separate database. Access can be gained using pgAdmin. |
Manage the Postgres databases. |
|
Proxy service for routing requests between services within the Docker network and from/to outside. |
OneCX Applications
The OneCX Platform is a modular system which provides a lot of standard services:
Core Applications
| Application | Description |
|---|---|
Handles user authentication, authorization, and identity management within the OneCX platform. |
|
Used by some applications |
|
Declared and used in applications. |
|
Application data (components, slots etc.) |
|
The main user interface framework for OneCX applications. |
|
Represents a customer or organizational unit using OneCX |
|
Customizing the look and feel of OneCX for a tenant |
|
Managing user-specific settings and preferences |
|
Customizing the working areas for users |
Feature Applications
| Application | Description |
|---|---|
Manages announcements and notifications within the OneCX platform. |
|
Bookmarks for quick access to frequently used items |
|
Manages data synchronization and integration between different OneCX services and external systems. |
|
Managing documents in a user-friendly and efficient manner |
|
Provide users easy access to help resources and support within the portal |
|
Provide various services |
|
Provide special functionality for testing service |
|
Customizing the start page for users |