Document Applications and Components Using the DocumentApp Utility
The DocumentApp utility saves to a file a report about an application in a database or one of the application's components. The report lists all the properties of the application and the properties and scripts for all application components. The report combines information that otherwise is available only through the application scripts and the Property Inspector.
The easiest method of using the DocumentApp utility is from the Workbench Develop tab.
To use the DocumentApp utility
1. Select the application you want to document about in the Applications portlet of the Develop tab.
2. Click Project, Document.
The Document Application dialog appears.
3. Set parameters for the specified application.
4. Click Go.
Parameters for the DocumentApp Utility
The following parameters can be specified using the Document dialog:
Output File
Specifies the name of the file to which the information about the component or application is to be written. Click Browse to display a standard File Selection dialog.
4GL Source Only (-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.
All Attributes (-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.
Username (-u)
Lets you use this command as if you were another user, username.
• You, not username, own all files created by OpenROAD.
• This entry field can be used only if Execute in Background is enabled.
Log Path (-L)
Specifies the name of a log file. This entry field can be used only if Execute in Background is enabled and Trace Window is set to Yes. If the log path specified is not a full path, the file is created in the ingres\files directory.
Note: This parameter is only available when accessing this utility from the Project menu.
Trace Window (-T)
Lets you control display of the Trace window by entering one of the following values:
All
Specifies that the Trace window does appear
Yes
Specifies that the Trace window appears but suppresses informational messages output by the system
Yes (Minimized)
Specifies that the Trace window appears minimized as an icon
No
Specifies that the Trace window does not appear, and a log file is not created
Note: This entry field can be used only if Execute in Background is enabled.
Append to Log File (-A)
Appends the trace output of the current command to the end of the existing error log file. Otherwise, that log file is replaced. This entry field can be used only if Execute in Background is enabled.
Note: The error log file, w4gl.log, is located in %USERPROFILE%\AppData\Local\OpenROAD\Profiles\installation_ID. If the -L flag is passed, a new name and location can be provided for the OpenROAD log file.
Execute in Background
Begins a new process while you are using this utility.
If enabled, Execute in Background makes Username, Log Path, Trace Window, and Append to Log File available for use.
Note: This parameter is only available when accessing this utility from the Project menu.
Note: You can set defaults for this utility using the Set Tool Defaults dialog. see
Set Defaults.
Command Line Method of Documenting an Application (DocumentApp)
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 [-nowindows]
[-uusername] [-Lfilename] [-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 document
file
Specifies the name of the file to which the information about the component or application is to be written
-nowindows
Lets the application run without the window manager running. This option does not provide full batch mode execution, because some interaction with the application still may be required through the Trace window.
-uusername
Lets you use this command as if you were another user, username.
Note: You, not username, own all files created by OpenROAD.
-Lfilename
Specifies the name of a log file. If the log path specified is not a full path, the file is created in the %II_SYSTEM%\ingres\files directory.
-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.
An exit code of zero (0) means success; a non-zero exit code indicates an error.