16. Managing and Deploying Applications : How You Can Generate Reports for Applications and Components : Document Applications and Components Using the DocumentApp Utility : Command Line Method of Documenting an Application
 
Share this page                  
Command Line Method of Documenting an Application
To generate a report on an application or component, start the DocumentApp utility by entering the following command at the command line:
w4gldev documentapp database application file
    [-uusername] [-ccomponent] [-vversion] [-s] [-a]
    [-T{yes|yes,min|yes,logonly|all|all,min|all,logonly|no}] [-A]
Note:  The following parameters and flags are available from the command line:
database
Specifies the name and location of the database in which the application resides
application
Specifies the name of the application to delete
file
Specifies the name of the file to which the information about the component or application is to be written
-uusername
Lets you use this command as if you were another user, username.
Notes:
You, not username, own all files created by OpenROAD.
This entry field can be used only if Execute in Background is enabled.
-ccomponent
Identifies a single component in the application to be documented
-vversion
Specifies the version of the application to document
-s
Prints a report containing only the 4GL source code for objects that have 4GL scripts, such as user class methods, procedures, and frames. For frames, the report also includes any field scripts.
-a
Requests a complete listing of the attributes for all fields in a frame.
Note:  Using this parameter can produce a very long report. If you do not use this parameter, the report contains information only about component and field names, data types, and scripts.
-T
Controls the display of the Trace window by entering one of the following values:
yes
Specifies that the Trace window appears but suppresses all informational system messages
yes,min
Specifies that the Trace window appears minimized as an icon, and all informational system messages are suppressed
yes,logonly
Specifies that the Trace window does not appear, but all messages are saved in a log file without informational system messages
all
Specifies that the Trace window does appear and all messages are written
all,min
Specifies that messages are written to the Trace window, which appears minimized as an icon
all,logonly
Specifies that the Trace window does not appear, but all messages are saved in a log file
no
Specifies that the Trace window does not appear, and no log file is created
-A
Appends the trace output of the current command to the end of the existing error log file.
Note:  The error log file, w4gl.log, is located in %II_SYSTEM%\ingres\files.