Picture: Login window for SAP system.
Once the user enters the login information and hit Ok than it is possible to move to the execution panel. To switch to the execution panel it is only necessary to access the menu "Panel selection" and select "Execution panel."
In the "Execution panel" it is possible to type the name of the remote functions calls in the text field. There should be one function name per line. The lines that begin with the "#" sign are skipped and can be used to put comments. The content of this text area is saved automatically without the need of the user intervention. To start the functions documentation it is only necessary to click in the "Document functions" button.
The application is going indicate the documentation progress by a progress bar. In case of any exception the application will show the details on a window.
Picture: Indication of the documentation progress. |
When the progress bar reaches the end then a small window will appear indicating that the documentation process has completed. At this time, all the remote functions are documented in a specific directory.
Picture: Indication that the documentation process has been finished with success.. |
The directory that the application creates to put the documentations of the remote function calls has the format of a date and time. That is: it starts with the year, followed by the month, day, hour, minute and second. Each text file corresponds to a function and the name of each file is exactly the name of the function following by the extension ".txt".
Picture: Directory created by the application with the functions description. |
The content of each file corresponds to the format of the function. It contains the input parameters, the output fields and the tables and structures included in the function.
Picture: Example of a function documentation. |
|