SAP Logo LeanIX is now part of SAP
Solved

Interface fact Sheet: Interface Category Types (API, Logical)

  • 19 February 2024
  • 5 replies
  • 229 views

Userlevel 1
Badge

 

I am interested in finding out if other users have added additional category types to gain more insights and value from this field. The current two types:  API and Logical are limited  and the type  Logical is very general and catch all types.  Thank you.

icon

Best answer by Mazen 19 February 2024, 15:56

View original

5 replies

Yes, we recently initiated an effort to better document interfaces and came to a similar conclusion.  We added SOAP, REST, sftp, messaging, and several other sub-categories in order to capture the additional detail.  

Userlevel 1
Badge

Thank you DL Hobson,  appreciate it, we are on the same page.

Userlevel 4
Badge

@Mazen we have not used the category for this purpose as there is a very specific purpose to create inter-relationships between Interface factsheets documented here https://docs-eam.leanix.net/docs/interface-modeling-guidelines#interface-fact-sheet-subtypes.

Instead we set up a new attribute of a filterable single-select list, with the many values the integration team requested.

 

Userlevel 3
Badge

Good find, @Justin Swift . We have found interfaces to be challenging to explain and laborious to apply.

In reading the v4 documentation, it sounds like Logical interfaces are what we need the most.

Business data flow using the Logical Interface subtype. If you focus on business-oriented data flow, you should model your connections using the Logical Interface. This approach involves linking Applications and Interfaces and provides a comprehensive view of how business processes interact with different Applications through Logical Interfaces

 

We want to model logical data flow, but also identify “efficient” versus “inefficient” methods. Especially calling out things like CSV file exports, log shipping, FTP, etc. I’ll think about adding an attribute of transfer method to the interface fact sheet.

Userlevel 4
Badge

@jalon zimmerman the standard Interface Factsheet needed a lot of extra fields so it could act as a catalogue for us. Some are mandatory, others are optional for setting the quality seal from draft to approved. Feel free to use the image in previous post for inspiration for those relevant to your business. It certainly helps analysis and technical risk management if you have some attributes of interest.

Reply