Build Your First qBit
Learn how to create, package, and share a reusable qBit component for the qqq ecosystem.
What Are qBits?
qBits are reusable components that extend qqq applications. They come in three types:
Platform Extensions
Authentication, caching, notifications, file storage.
Application qBits
Business modules like OMS, WMS, CRM features.
Data qBits
Database connectors, API integrations.
What You'll Build
In this tutorial, you'll build a Customer Notes qBit that adds note-taking functionality to any qqq application with customer data:
- A
customerNotetable - Automatic linking to any customer table
- A process to add notes via API
- Full test coverage
Tutorial Steps
1. Create the qBit Project
Set up a qBit Maven project with the correct structure and manifest file.
2. Define the qBit Manifest
Configure metadata, dependencies, and configuration options in qbit.json.
3. Create the Note Table
Build the customerNote table with fields for content, type, and relationships.
4. Add the Process
Create the addCustomerNote process with input validation.
5. Wire Up the qBit
Implement the QBitInterface to register all metadata with a QInstance.
6. Test and Package
Write tests and build the qBit JAR for distribution.
Full Tutorial Available
The complete step-by-step tutorial with all code examples is available on our tutorials page.
View Full TutorialPublishing Your qBit
Ready to share your qBit with the community?
- Create a GitHub repository for your qBit
- Add documentation with usage examples
- Submit for review at the qBits portal
- Once approved, your qBit appears in the catalog