Technical Documentation

Overview

This documentation serves as a detailed technical reference for developers and engineers working with the Provisioning Portal. It includes setup instructions, system architecture, workflow definitions, integration points, and best practices for maintenance and troubleshooting.

Documentation Structure

Installation & Deployment – Detailed instructions for setting up and running the Provisioning Portal.
- Getting the Installation Files
- System Requirements
- Flowable Database Setup
- Environment Configuration
- XML-Based Service Configuration
- Deployment via Docker
- Provision Portal Deployment (API + UI) – Docker Compose deployment of both backend API and UI.
- Run & Verify
QA Deployment – Detailed QA deployment process for the Provisioning Portal, covering build creation, testing, and release.
Architecture Overview – High-level component interaction and data flow.
- Component Diagrams
- Interaction with Flowable and TR069 NBI
Project Structure – Codebase organization and module purposes.
Flowable Workflows – BPMN processes, customizations, and execution.
Database – Basic database information.
Testing – Unit, integration tests and how to run them.
API & Integration – REST endpoints and integration patterns.