> For the complete documentation index, see [llms.txt](https://host2host.onibonje.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://host2host.onibonje.com/docs.md).

# Heirs H2H Platform — Documentation Index

Complete **architecture documentation** for the Group-Wide Host-to-Host Integration Platform.

**Status:** [Architecture Sign-Off](/docs/42-architecture-sign-off.md) — **48 documents — READY FOR IMPLEMENTATION**\
**Commercial proposal:** [49 Bid Proposal](/docs/49-bid-proposal.md) — **USD 2.0M floor / 24 months / Month 8 first delivery / success-based extensions**

***

## Quick Start by Role

| Role                  | Start here                                                                                                                                                                          |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Executive / business  | [01](/docs/01-architecture-overview.md) → [22](/docs/22-use-cases-and-solutions.md) → [44](/docs/44-program-cost-and-staffing.md) → [42](/docs/42-architecture-sign-off.md)         |
| Solution architect    | [01](/docs/01-architecture-overview.md) → [03](/docs/03-modular-jar-architecture.md) → [20](/docs/20-universal-library-extensibility.md)                                            |
| Integration developer | [03](/docs/03-modular-jar-architecture.md) → [43](/docs/43-core-banking-integration-api.md) → [08](/docs/08-camel-integration-patterns.md) → [29](/docs/29-canonical-data-model.md) |
| DevOps                | [19](/docs/19-cloud-agnostic-deployment.md) → [38](/docs/38-deployment-topology.md) → [33](/docs/33-devsecops-pipeline.md)                                                          |
| Security              | [09](/docs/09-security-and-compliance.md) → [16](/docs/16-security-library.md)                                                                                                      |
| Operations            | [34](/docs/34-operations-architecture.md) → [17](/docs/17-monitoring-and-logging.md)                                                                                                |

***

## Document Catalog

### A. Foundation (01–12)

| #  | Document                                                                   | Topics                     |
| -- | -------------------------------------------------------------------------- | -------------------------- |
| 01 | [Architecture Overview](/docs/01-architecture-overview.md)                 | RFP, layers, STP lifecycle |
| 02 | [Technology Stack](/docs/02-technology-stack.md)                           | Java, Camel, Kafka, K8s    |
| 03 | [Modular JAR Architecture](/docs/03-modular-jar-architecture.md)           | Wrapper JARs, BOM          |
| 04 | [Database-Driven Configuration](/docs/04-database-driven-configuration.md) | Config, publish            |
| 05 | [Low-Code Admin Platform](/docs/05-low-code-admin-platform.md)             | Admin UI modules           |
| 06 | [Personas and RBAC](/docs/06-personas-and-rbac.md)                         | Roles, Keycloak            |
| 07 | [Multi-Country Deployment](/docs/07-multi-country-deployment.md)           | Country packs, regions     |
| 08 | [Camel Integration Patterns](/docs/08-camel-integration-patterns.md)       | Routes, EIP                |
| 09 | [Security and Compliance](/docs/09-security-and-compliance.md)             | Policies, audit            |
| 10 | [Implementation Roadmap](/docs/10-implementation-roadmap.md)               | 5 phases                   |
| 11 | [Repository Structure](/docs/11-repository-structure.md)                   | Maven layout               |
| 12 | [Glossary](/docs/12-glossary.md)                                           | Terms                      |

### B. Design (13)

\| 13 | [Design Patterns](/docs/13-design-patterns.md) | 40 patterns |

### C. Platform Libraries (14–21)

\| 14 | [Extensibility Framework](/docs/14-extensibility-framework.md) | Scripts, jobs, EAV | | 15 | [File Management System](/docs/15-file-management-system.md) | SFTP, S3, signed URLs | | 16 | [Security Library](/docs/16-security-library.md) | PGP, Vault, HMAC | | 17 | [Monitoring and Logging](/docs/17-monitoring-and-logging.md) | OTel, SLA | | 18 | [Execution Context](/docs/18-execution-context.md) | H2hContext | | 19 | [Cloud-Agnostic Deployment](/docs/19-cloud-agnostic-deployment.md) | K8s, JAR, legacy WAR | | 20 | [Universal Library Extensibility](/docs/20-universal-library-extensibility.md) | CustomizationProfile | | 21 | [Event-Driven Runtime Extensibility](/docs/21-event-driven-runtime-extensibility.md) | DB-driven events, subscriptions | | 48 | [Utility & Notification Integrations](/docs/48-utility-notification-integrations.md) | Email, SMS, push, Slack SPI | | 46 | [Database-Driven Events](/docs/46-database-driven-events.md) | Event catalog, channels, partitioning |

### D. Domain Architecture (23–31)

\| 23 | [Finacle Integration](/docs/23-finacle-integration.md) | FCJ, FCUBS | | 43 | [Core Banking Integration API](/docs/43-core-banking-integration-api.md) | CBS interface, injection | | 24 | [Transformation and Messaging](/docs/24-transformation-and-messaging.md) | ISO 20022, MT940 | | 25 | [ACK/NACK Framework](/docs/25-ack-nack-framework.md) | Acknowledgements | | 26 | [Reconciliation](/docs/26-reconciliation.md) | Matching | | 27 | [Treasury Interfaces](/docs/27-treasury-interfaces.md) | FX, liquidity | | 28 | [MQ/JMS Adapter](/docs/28-mq-jms-adapter.md) | IBM MQ, Kafka | | 29 | [Canonical Data Model](/docs/29-canonical-data-model.md) | Internal models | | 30 | [Database Schema Reference](/docs/30-database-schema-reference.md) | All tables | | 31 | [Error Code Catalog](/docs/31-error-code-catalog.md) | VAL, FIN, FILE |

### E. Operations & API (32–41)

\| 32 | [Performance and Capacity](/docs/32-performance-and-capacity.md) | NFRs | | 33 | [DevSecOps Pipeline](/docs/33-devsecops-pipeline.md) | CI/CD | | 34 | [Operations Architecture](/docs/34-operations-architecture.md) | Runbooks, DR | | 35 | [Testing Strategy](/docs/35-testing-strategy.md) | Test pyramid | | 36 | [Admin API Reference](/docs/36-admin-api-reference.md) | REST catalog | | 37 | [Partner Portal](/docs/37-partner-portal.md) | Self-service | | 38 | [Deployment Topology](/docs/38-deployment-topology.md) | Monolith vs split | | 39 | [API Gateway Architecture](/docs/39-api-gateway-architecture.md) | HTTP, WebSocket, Kong | | 47 | [Gateway Entry Points](/docs/47-gateway-entrypoints.md) | SFTP, HTTP, WebSocket, MQ | | 48 | [Utility & Notification Integrations](/docs/48-utility-notification-integrations.md) | Email, SMS, push | | 40 | [Workflow Architecture](/docs/40-workflow-architecture.md) | Camunda, maker–checker | | 41 | [Training and Handover](/docs/41-training-and-handover.md) | RFP training |

### F. Validation & Sign-Off (22, 42, 44–48)

\| 22 | [Use Cases and Solutions](/docs/22-use-cases-and-solutions.md) | 22 scenarios | | 42 | [Architecture Sign-Off](/docs/42-architecture-sign-off.md) | **Complete gate** | | 44 | [Program Cost and Staffing](/docs/44-program-cost-and-staffing.md) | Budget, timeline, workforce | | 45 | [Database-Agnostic Persistence](/docs/45-database-agnostic-persistence.md) | PostgreSQL / Oracle / SQL Server | | 46 | [Database-Driven Events](/docs/46-database-driven-events.md) | Event catalog, channels, partitioning | | 47 | [Gateway Entry Points](/docs/47-gateway-entrypoints.md) | SFTP, HTTP, WebSocket, MQ | | 48 | [Utility & Notification Integrations](/docs/48-utility-notification-integrations.md) | Email, SMS, push, Slack |

### G. Commercial (49)

\| 49 | [Bid Proposal](/docs/49-bid-proposal.md) | **USD 2.0M floor · extension clause · Month 8 go-live** |

***

## Architecture Dependency Graph

```mermaid
flowchart TB
  subgraph foundation [01-12 Foundation]
    A01[01 Overview]
  end

  subgraph libraries [14-21 Libraries]
    L15[15 File]
    L16[16 Security]
    L20[20 Extensibility]
    L21[21 Events]
    L45[45 Persistence SPI]
    L46[46 DB Events]
    L48[48 Notifications]
  end

  subgraph domain [23-31 Domain]
    D23[23 Finacle]
    D43[43 CBS API]
    D29[29 Canonical]
    D30[30 Schema]
    D31[31 Errors]
  end

  subgraph ops [32-41 Ops]
    O38[38 Topology]
    O39[39 API Gateway]
    O47[47 Entry Points]
    O33[33 DevSecOps]
  end

  A01 --> libraries
  A01 --> domain
  D43 --> D23
  D29 --> D23
  D29 --> D24[24 Transform]
  D31 --> D25[25 ACK]
  L46 --> L21
  L45 --> D30
  libraries --> domain
  domain --> O38
  O47 --> O39
  O38 --> O33
  domain --> SIGN[42 Sign-Off]
  UC22[22 Use Cases] --> SIGN
  COST[44 Cost] --> SIGN
```

***

## Core Design Decisions

| Decision                      | Rationale                                                           |
| ----------------------------- | ------------------------------------------------------------------- |
| Apache Camel                  | Banking EIP, Finacle fit                                            |
| Composable JAR monolith       | STP, surgical JAR updates                                           |
| DB-driven config              | Low-code, no redeploy                                               |
| DB-driven events              | `event_def` + `event_channel_def`; no hardcoded topics              |
| Broker-delayed jobs           | No in-process cron; survives outages                                |
| Deployment-agnostic           | Same JARs on Kubernetes, standalone JVM, or legacy app server (WAR) |
| CBS base library              | `CoreBankingIntegration` + Finacle as one provider type             |
| DB-agnostic persistence       | PostgreSQL / Oracle / SQL Server via SPI                            |
| Kafka + runtime subscriptions | Event-driven extensions                                             |
| HTTP + WebSocket ingress      | Database-driven `channel_config`                                    |
| Utility notifications         | Email/SMS/push via `NotificationProvider` SPI + DB config           |
| CustomizationProfile          | Cross-library customization                                         |
| Vault + Keycloak              | Secrets and IAM                                                     |
| Cloud-agnostic K8s            | Any cloud or on-prem                                                |
| Deployment-agnostic           | K8s, standalone JAR, or legacy WAR — same JARs                      |

***

## Related

* [Project README](/readme.md)
* [Architecture Sign-Off](/docs/42-architecture-sign-off.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://host2host.onibonje.com/docs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
