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.

Lifecycle & Changes

Historical context and milestones.

Status	Active
Created	2025-01-01
Updated	2025-05-01 – linked to O2C

Integration Description

What is this interface about? Who uses it and for what purpose?

Summary

Example: This integration synchronises customer master data from SAP S/4HANA to Salesforce in real-time.

Use Case Reference

Example: Project Sunrise - Use Case: Customer Creation

Overview

Basic metadata and lifecycle of the interface.

Smart ID/Legacy IDs	APP-S4-SF-CUSTOMER-V1 Format: <Domain>-<Source>-<Target>-<Object>-<Version> SCPIINT12 Former tracking codes or CMDB references.
Artefact(s)	Implementation assets Integration Flow(s) Brazil Nota Fiscal Eletrônica Upload Nota Fiscal Eletronica Invoices to SAP ECC
LeanIX Fact Sheet(s)	Linked LeanIX Interface Fact Sheet For example, MyID to SAP SuccessFactors Employee Central
Service Pool / Process / Domain	HR Data `PRC-S4-SF-O2C-V1 Link to a higher-level process if applicable.`
Integration Style	List of Applicable Integration Styles For example,
Data Volume	Expected volume of records High - 1,000,000 per day Low - 1,000 per day Median - 100,000 per day
Frequency	How often data is exchanged, for example, Real-time, Daily, Batch Daily 08:30 PM CET
Source System	Name(s) of provider system(s) in LeanIX Interface Fact Sheet, for example, MyId
Source Protocol	Protocol used to transfer data, for example, REST, OData, etc.
Source Data Format	Format of data exchanged, for example, XML, JSON, CSV, etc.
Source Authentication mechanism	Authentication mechanism between source system and middleware, for example, OAuth 2.0 Client Credentials, OAuth 2.0 SAML Bearer Assertion Token, Basic Authentication, etc.
Target System	Name(s) of consumer system(s) in LeanIX Interface Fact Sheet, for example, SAP SuccessFactors Employee Central
Target Protocol	Protocol used to transfer data, for example, REST, OData, etc.
Target Data Format	Format of data exchanged, for example, XML, JSON, CSV, etc.
Target Authentication mechanism	Authentication mechanism between source system and middleware, for example, OAuth 2.0 Client Credentials, OAuth 2.0 SAML Bearer Assertion Token, Basic Authentication, etc.
SLA	Go to Source and Target Application in LeanIX and look at Business Criticality and Functional Fit section
Version	Increment for significant logic changes, for example, V1

Functional Requirements & Rules

Business rules and conditions.

Mandatory field SalesOrg must be present
Convert CustomerCategory to AccountType
Enrich RegionCode from mapping table

Integration Flow

List down steps involved in the Interface Flow
For example, first step is receive a webhook from 11VMS
Get Activity Report Details from 11 VMS
Update SAP SRM using Function Module

Technical Components Involved

Detailed list of systems and middleware used.

Component Type	Name / Detail	Role / Description
Integration Flow	`CPI iflow-customer-sync-v1`	Executes logic
API Management	`SAP ISAM Proxy`	Secures and routes requests
Event System	`SAP Event Mesh`	Publishes asynchronous events
File Gateway	`B2B MFT Adapter`	For batch file interfaces
Monitoring	`Cloud ALM, Grafana`	Monitoring tools

Integration Design

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`

Transformation

Link to Mapping Spreadsheet

Security & Access Control

Per-component security model.

Component	Authentication	Transport Security	Authorization	Notes
SAP S/4HANA	`Client Certificate`	`TLS 1.2`	`SAP Roles`	Cloud Connector
CPI	`OAuth2`	`N/A`	`Internal Only`	Managed by tenant
Salesforce	`OAuth2`	`HTTPS`	`Token Scopes`	Dedicated user

Error & Exception Handling

Resilience and error management.

Retry Logic	3x every 30s, exponential backoff
Dead Letter Queue	Enabled, Not Applicable
Alerting	Email, Cloud ALM, PagerDuty
Error Logging	CPI Logs, Splunk, Monitoring Platform

Monitoring & Runbook

How is the interface observed and troubleshooted.

Monitoring Tool	SAP Cloud ALM, Grafana, Elastic
Runbook Location	[Runbook PDF](#)
Dashboard URL	[Grafana Dashboard](#)

Other Artefacts

Implementation assets.

Artefact	Notes
Git Repository
API Specification	Please refer to API Reference tab
Test Results