Technical document Template for SAP PI interface developement

[Former Member]

Hi guys,

After finishing developing of the interfaces, I need to document it as a technical document which should incldue Data types, Message Types, etc. Is there any technical document template I can use as a reference.

Blue

[former_member186851 · Accepted solution]

you can add sections as per below

Section I: Initial Information Requirements    

General Information    

Involved Systems, Message Communication and Interfaces    

Involved Systems    

Message Communication    

Interfaces

Section II: Technical Development Concept    

General Information    

Overall Process Description    

Enterprise Service Repository Objects    

Data Types    

Message Types    

External Definition    

Imported Archive    

Imported Objects    

Service Interfaces    

Java Archive    

Message Mappings    

Function Library    

Operation Mappings    

Integration Process    

Integration Scenario    

BPM Processing Details    

Container Variables    

Integration Directory    

Sender Configuration    

Receiver Configuration    

Receiver Determination    

Interface Determination    

Sender Agreement    

Receiver Agreement    

Direct Connections    

Integrated Configurations (AAE)    

File Archiving Mechanism    

Security & Authorization Configurations    

IDoc Port Configurations (for IDoc Inbound/Outbound scenarios)    

COMMON Services    

PI PatTERNS IDENTIFIED    

Section III: Operational Support    

Monitoring    

Other Configurations    

Error Handling within PI    

Test Cycle u2013 Unit Test    

Transport Number(s)    

Cutover Activities    

Contacts to Solution Owner    

Outstanding Issues

[Former Member · Accepted solution]

Hi Raghuraman,

Thanks you for the information. It really helps.

Blue

[former_member186851 · Accepted solution]

Welcome.Let me know if you need further inputs.

[apu_das2]

This message was moderated.

[nitindeshpande]

Hello,

It actually depends on what you want to be included in the TD. Below is the one of the format of the TD you can follow -

TABLE OF CONTENTS

1. 1.     Purpose.
2. 2.     Overview..
3. 2.1.      Functional Overview
4. 2.2.      Technical Overview
5. 2.3.      Integration Scenarios
6. 2.4.      Assumptions
7. 2.5.      Transaction Volume
8. 2.6.      Frequency and Timing
9. 3.     System Landscape Configuration
10. 3.1.      Products (Software Components)
11. 3.2.      Technical Systems
12. 3.3.      SWCV’s and Products Mapping to Technical systems
13. 4.     Interface Objects Definition
14. 4.1.      Data Types
15. 4.2.      Message Types
16. 4.3.      External Definition
17. 4.4.      Message Interfaces
18. 5.     Mapping Program Development
19. 5.1.      Message Mapping
20. 5.2.      Interface Mapping
21. 6.     Integration Processes
22. 6.1.      ccBPM Design
23. 7.     Communication Channels
24. 8.     Logical Routing Rules
25. 8.1.      Receiver Determinations
26. 8.2.      Interface Determinations
27. 9.     Collaboration Agreements
28. 9.1.      Sender Agreement
29. 9.2.      Receiver Agreement
30. 9.3.      Alerts
31. 10.       SAP R/3 Configurations
32. 10.1.        IDoc Configurations
33. 10.2.        RFC Configurations
34. 11.       Appendix
35. 11.1.        Terms, Abbreviations, Definitions

Regards,

Nitin

[Former Member]

Hi Nitin, it is really a very comprehensive list of the template. I will bookmark it for sure.

Blue