How to document your SAP Cloud Integration Flows
Do you enjoy creating lengthy technical documentations after your Integration Flow has been completed?
The alternative is getting an automatically generated documentation based on your AS-IS integration artifact using WHINT Solutions.
In the article below we explain where to enter significant information which will be generated as PDF and stored periodically (e.g. daily) into SharePoint.
See the full article here on Integration Excellence.
- Maintain the Description to explain what integration requirement is solved here (high-level, who communicates to whom, what business process(es) is supported here.
- Add a high-level graphic to show the applications/systems/parties involved (e.g. with network zones), e.g. from draw.io.
- Use Custom Tags to assign your package to a domain/department/area to better structure your content.
- Add Sender and Receiver in the Metadata (to highlight the logical flow of the messages and the data).
- Add a short description in the Metadata, i.e. what specific business process is connected/supported, also an external interface ID can be added here.
- Add a longer description inside the iFlow explaining more in detail how the integration flow works (e.g. call API to 1. query, 2. list, 3. iterate over result, 4. confirm individual message). If available, also add the following information:
- Sender Interface, Receiver Interface (e.g. SAP IDoc/ServiceInterface, SalesForce API, etc.)
- How to trigger the interface (e.g. SAP program or event in S/4HANA)
- How to manage known errors (e.g. when wrong data is sent and the retry keeps failing)
- Change the names of the participants (Sender and Receiver) in the BPMN to improve readability (and monitoring as the names are used there).
Besides we also document other objects (not only SAP Integration Suite), here is the full list:
- SAP Cloud Integration: Integration Flow
- SAP Cloud Integration: Integration Package
- SAP Cloud Integration: Value Mapping
- SAP Cloud Integration: Message Mapping
- SAP API Management: API Proxies & Products
- SAP Process Orchestration: Configuration Scenario / Integration Flow / NWDS Folder
- Microsoft Azure Integration Services: Logic Apps
- Microsoft Azure Integration Services: API Management
- Microsoft Azure Integration Services: Service Bus
- Microsoft Azure Integration Services: Event Grid