Integration Steps
Use this page as the canonical checklist when bringing a new product under the Aventian platform. Each step links to a deeper document.
1. Register Product
Goal: Create a canonical product record so routing, roles, and tenant provisioning work.
Actions:
- Submit product metadata (name / key, base URL, logo, display name, brand color).
- Provide target environments (dev / qa / prod URLs).
- Confirm redirect / callback URLs for Auth0.
Output: New row in tbl_master_products + asset uploads.
Placeholder URL: (Replace with internal registration portal URL)
https://portal.aventian.internal/register-product
Deep Dive: Product Integration
2. Set Up Authentication
Goal: Users authenticate once (SSO) and access your product with Aventian-issued JWT + roles.
Actions:
- Obtain
domain,clientId,audiencefrom Aventian. - Add product origin + callback/logout URLs to Auth0 allowlists.
- Implement React Auth0 provider & secured routing.
- Call User Details API to fetch roles & permissions.
- Validate API requests with aventian verify API.
Deep Dive: Auth Overview · Auth Integration · API Auth
3. Understand Tenant Databases
Goal: Model schema & migrations to run inside per‑tenant silo DB (schema-per-product within team DB).
Actions:
- Design schema using naming conventions & isolation guidelines.
- Provide Flyway (or SQL) migration scripts.
- Ensure idempotent provisioning (repeatable migrations safe).
- Plan seed data (system roles, template privileges, etc.).
Deep Dive: Tenant Architecture Intro · Product Integration
4. Define Resources, Privileges & Roles
Goal: Express granular authorization model aligned with Aventian resource taxonomy.
Actions:
- List product resources (application / project / hybrid / system) and hierarchy.
- Derive privileges (atomic verbs) per resource.
- Propose built‑in roles + invisible system roles.
- (Optional) Provide template roles for team customization.
Deliverables: SQL inserts for tbl_master_resources, tbl_master_privileges, tbl_roles, associations.
Deep Dive: Product Integration · Metadata & Roles
6. Optional / Add-On Services
Choose what you need; you can add later.
| Service | When to Adopt | Link |
|---|---|---|
| Notification Service | Need cross-product or user-level notifications | Documentation |
| Management API | Need platform metadata, team/product associations | Documentation |
| React Component Library | Want consistent header / profile / layout widgets | Documentation |
Consolidated Checklist
Copy this into your tracking system and tick items as you proceed.
- Product registered
- Auth configured (login, tokens, verify API)
- Tenant DB migrations approved
- Resources & privileges inserted
- Built‑in & system roles (if any) created
- Template roles (if any) created
- Team context routing implemented
FAQ
Q: Can we skip defining template roles initially? Yes. Start with minimum built‑in roles; add templates later.
Q: How are new privileges rolled out? Add to master table, map to roles, run migration; communicate to dependent services.