Welcome to the WFM Archive documentation. This comprehensive guide covers everything from getting started to advanced deployment scenarios.
WFM Archive is a robust document management and archiving system built on the CUBA Platform. It provides enterprise-grade document storage, workflow management, and seamless integration with external systems including Keycloak, MongoDB, Amazon S3, and IBM i-Series.
- Prerequisites - System requirements and dependencies
- Installation - Step-by-step installation guide
- Configuration - Environment configuration
- Quick Start - Get up and running quickly
🏗️ Architecture
- System Overview - High-level architecture
- Modules - CUBA Platform module structure
- Data Flow - How data moves through the system
- Entity Model - Database schema and relationships
- Integrations - External system connections
- REST Endpoints - Complete API reference
- Authentication - Keycloak authentication setup
- Examples - Practical API usage examples
- Error Codes - Error handling guide
⚙️ Services
- Archive Service - Document archiving operations
- MongoDB Service - Document storage
- S3 Service - File storage integration
- Keycloak Service - User management
- Workflow Service - Business process automation
- Integration Services - External systems
👨💻 Development
- Setup - Development environment setup
- Project Structure - Code organization
- Coding Standards - Best practices
- Testing - Test strategy and execution
- Debugging - Troubleshooting tips
- Contributing - How to contribute
- Build Process - Gradle build commands
- Docker - Container deployment
- Production - Production deployment guide
- CI/CD - Automated deployment pipelines
- Troubleshooting - Common issues
- Monitoring - System monitoring and logging
- Backup & Restore - Data protection
- Performance - Performance optimization
- Maintenance - Routine maintenance tasks
- Configuration Reference - All configuration options
- Database Schema - Complete schema documentation
- Gradle Tasks - Available build tasks
- Glossary - Terms and definitions
| Component | Technology | Version |
|---|---|---|
| Framework | CUBA Platform | 7.2.19 |
| Language | Java / Groovy | 11 / 2.5.14 |
| Frontend | Vaadin | 8.14.3 |
| Build Tool | Gradle | 5.6.4 |
| Primary Database | Microsoft SQL Server | - |
| Document Store | MongoDB | 4.10+ |
| File Storage | Amazon S3 | - |
| Workflow Engine | Flowable | 6.5.0 |
| Authentication | Keycloak | - |
| Message Queue | Apache Camel | 2.25.0 |
- Document Management: Comprehensive document archiving with metadata and versioning
- Workflow Automation: Business process automation using Flowable BPMN
- Multi-tenant Support: Organization-based data isolation
- External Integrations: Seamless integration with enterprise systems
- Advanced Search: Full-text search across documents and metadata
- Role-Based Access: Fine-grained permission control
- REST API: Complete RESTful API for external system integration
- Audit Trail: Comprehensive logging and audit capabilities
- Issues: Report bugs or request features on GitHub Issues
- Contact: Reach out to the development team
- Support: Check the Troubleshooting Guide
[Your License Information]
Last updated: September 2025