Press "Enter" to skip to content

Quality Checks for SAP CPI with WHINT Interface Documentation

0

WHINT Interface Documentation creates PDF documents of your Cloud Integration Content to automate the technical documentation and help you to search for used artifacts and elements inside SAP CPI Integration Flows & OData Services.

Inspired by an open source contribution of Morten Wittbrock, the official SAP design guidelines and some of our own experiences, we have embedded the following checks into our documentation solution:

AreaQuality Check
DocumentationiFlow Description is missing
DocumentationReadability of integration processes: max. number of elements (configurable)
SecurityUnencrypted Receiver Channel with Basic Authentication
SecurityRefuse specific HTTP Headers (configurable)
Security Use CSRF Protection for HTTP/OData Sender Channels with POST/PATCH
ConsistencyEnsure ProcessDirect receiver channel has a
matching sender channel
ConsistencyClean up request headers
Mapping GuidelinesAllow/refuse Script Languages: Groovy/JavaScript (configurable)
Mapping GuidelinesAllow/refuse Operation/Message Mappings (configurable)
Mapping GuidelinesAllow/refuse XSLT Mappings (configurable)
Mapping GuidelinesAllow/refuse XSLT versions 1.0/2.0/3.0 (configurable)
Mapping GuidelinesRefuse Java Archives (configurable)
Runtime/PerformanceApply rate limit for Incoming Calls (> 1 MB)
Runtime/PerformanceMessage Body is stored in MPL
Runtime/PerformanceCheck if HTTP session reuse is applied
Runtime/PerformanceCheck if Chunking is enabled
Transport ManagementHave parameters been externalized?
Error HandlingNo Exception Subprocess is used
Error HandlingMessages can be lost: Apply a Retry Pattern

A quality check document typically looks like this:

Quality Checks

Benefits:

  • The Quality Checks help you to implement best practices and recommendations your integration flows and protect you against common design mistakes.
  • It is also a useful instrument to validate the quality delivered by your implementation partners.
  • Overall, it helps you to increase the quality and so the robustness of your cloud interfaces.
Print Friendly, PDF & Email