Documentation- HTML Editor in XI
As part of huge XI implementation project, handling hundreds of interfaces, it is very difficult to keep track of attributes of all the objects like Data Type/Message Type/Message Interfaces/Mappings etc. Let me define attributes now. The attributes are nothing but, Name of the Object, Descriptions about the object, Author of the object, Date Created, Reason for the Object, Revision history etc.
It is very important that there should be proper documentation for each object. Otherwise if any changes needs to be done in future and it is very tedious task for the people who are not developed the objects. Whenever any changes are done it should be documented properly with providing Date changed, Reason for the change, Descriptions about the changes etc. So like change history of ABAP programs/or any Java Programs are maintained, we can maintain this developer log for each object.
Here is step-by-step procedure to achieve the same
Go to View from Menu->Documentation
Here enter the description , details, date,modification log etc
This can be done in object level or namespace level or software component level.
Real-time Best Practices where it is prefer to use
Describe Integration Scenario with Source and Target System details with brief- i.e functionality.
Describe different namespaces used and purpose
Name of the Imported Objects and the purpose
Mapping functionality and Logic i.e. pseudo code
User defined functions and purpose
Validations if any
Enhancement/modification log and the reason.
If we use Java Mapping, many places we will not put .java file in the imported archive for security or other reasons. So it is better to explain the entire logic/pseudo code to understand the implementation.
3. Integration Process:
If the scenario contains very complex business process, then it is required if it is explained in the documentation. It can be good if flowchart kind of description is given here.
4. In the Integration Directory
It is good practice to describe the flow of the message processing by describing sequence of XI pipeline steps.
If the documentation describes all the sequence of steps executed in the multiple receivers/complex scenarios, it can be very easy to handle the interfaces for any successor consultant.
This feature may be useful in any of the future XI implementation project.