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.

StatusActive
Created2025-01-01
Updated2025-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

  • Value Mapping(s)
    • Package Name  
      • Value Mapping 1 Name
      • Value Mapping 2 Name
  • Integration Flow(s)
    • Package Name  
      • Integration Flow 1 Name
      • Integration Flow 2 Name
  • API Proxy(ies)
    • API Proxy 1 Name
LeanIX Fact Sheet(s)
Service Pool / Process / DomainHR 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 ProtocolProtocol used to transfer data, for example, REST, OData, etc.
Source Data Format

Format of data exchanged, for example, XML, JSON, CSV, etc.

Source Authentication mechanismAuthentication 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 ProtocolProtocol used to transfer data, for example, REST, OData, etc.
Target Data FormatFormat of data exchanged, for example, XML, JSON, CSV, etc.
Target Authentication mechanismAuthentication mechanism between source system and middleware, for example, OAuth 2.0 Client Credentials, OAuth 2.0 SAML Bearer Assertion Token, Basic Authentication, etc. 
SLAGo 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.

Integration Flow

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

Technical Components Involved

Detailed list of systems and middleware used.

Component TypeName / DetailRole / Description
Integration FlowCPI iflow-customer-sync-v1Executes logic
API ManagementSAP ISAM ProxySecures and routes requests
Event SystemSAP Event MeshPublishes asynchronous events
File GatewayB2B MFT AdapterFor batch file interfaces
MonitoringCloud ALM, GrafanaMonitoring tools

Integration Design

Core interface behaviour and configuration.

AttributeDescriptionExample
DirectionData flow orientationInbound, Outbound, Both - to be discussed with Owen
Versioning StrategyHow interface versioning is managedURI, Header, SmartID

Transformation

Link to Mapping Spreadsheet

Security & Access Control

Per-component security model.

ComponentAuthenticationTransport SecurityAuthorizationNotes
SAP S/4HANAClient CertificateTLS 1.2SAP RolesCloud Connector
CPIOAuth2N/AInternal OnlyManaged by tenant
SalesforceOAuth2HTTPSToken ScopesDedicated user

Error & Exception Handling

Resilience and error management.

Retry Logic3x every 30s, exponential backoff
Dead Letter QueueEnabled, Not Applicable
AlertingEmail, Cloud ALM, PagerDuty
Error LoggingCPI Logs, Splunk, Monitoring Platform

Monitoring & Runbook

How is the interface observed and troubleshooted.

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

Other Artefacts

Implementation assets.

ArtefactNotes
Git Repository
API SpecificationPlease refer to API Reference tab
Test Results

Step by Step Configuration

<Flow Name>

Start On Schedule (Timer Start)


Related Interfaces

Grouped interfaces or dependencies.