This template is designed to guide integration architects and developers in documenting all required information for an interface. Each section includes a short explanation (tooltip) and example values to clarify usage.
Historical context and milestones.
| Status | InActive |
|---|---|
| Created | 2026-03-16 |
| Updated | 2025-05-01 |
What is this interface about? Who uses it and for what purpose?
This interface integrates the card transactions from the CMB china bank into SAP WP2 and SAP PF2
Example: Project Sunrise - Use Case: Customer Creation
Basic metadata and lifecycle of the interface.
|
Detailed list of systems and middleware used.
| Component Type | Name / Detail | Role / Description |
|---|---|---|
| Integration Flow |
| Executes logic |
| API Management | N/A | Secures and routes requests |
| Event System | N/A | Publishes asynchronous events |
| File Gateway | N/A | For batch file interfaces |
| Monitoring | CPI Logs | Monitoring tools |
| Alerting | SAP Cloud Alert Notification | Alerting tools |
Core interface behaviour and configuration.
| Attribute | Description | Example |
|---|---|---|
| Direction | Data flow orientation | Inbound, Outbound, Both - to be discussed with Owen |
| Versioning Strategy | How interface versioning is managed | URI, Header, SmartID |
Per-component security model.
| Component | Authentication | Transport Security | Authorization | Notes |
|---|---|---|---|---|
| SAP ECC | Client Certificate | TLS 1.2 | SAP Roles | Cloud Connector |
| CPI | OAuth2 | N/A | Internal Only | Managed by tenant |
| CMB China API | Basic | HTTPS | Token Scopes | Dedicated user |
Resilience and error management.
| Retry Logic | 3x every 30s |
|---|---|
| Dead Letter Queue | Not Applicable |
| Alerting | SAP Cloud Alert Notification |
| Error Logging | CPI Logs |
How is the interface observed and troubleshooted.
| Monitoring Tool | SAP Cloud ALM, Grafana, Elastic |
|---|---|
| Runbook Location | [Runbook PDF](#) |
| Dashboard URL | [Grafana Dashboard](#) |
Implementation assets.
| Artefact | Notes |
|---|---|
| Git Repository | |
| API Specification | Please refer to API Reference tab |
| Test Results |
Grouped interfaces or dependencies.