My webMethods Server 10.11 | My webMethods Server Webhelp | Diagnosing My webMethods Server | Using My webMethods Server Command Line Tools | envcapture
 
envcapture
Description
Creates an environment-specific report of the My webMethods Server environment that you can view or save. If you want review the server's environment later on, you can create a current report and compare it to a previous report.
You would typically run the envcapture command before and after environment changes such as updates, upgrades, configuration changes, or component deployments to the server environment. For on-premises installations, the system runs envcapture automatically to capture server environment information after you install or upgrade My webMethods Server.
The envcapture command captures the following information:
*Log files.
*Configuration files.
*Applied fixes.
*Installation folder structure, size, time stamps, and file system permissions for the current operating system user account.
*Local operating system and Java virtual machine (JVM) information.
*Internet connectivity and configuration settings, and the connectivity to My webMethods Server database information.
*Connectivity information from the database connection configuration file, mws.db.xml.
The envcapture command uses the standard System.getProperties() and System.getenv() methods to obtain the system specific information. When you execute the envcapture command without specifying the -s| --server option, it captures information about the default My webMethods Server instance. All information is saved in an envcapture.zip file.
The envcapture command-line tool is located in the following directory:
Software AG_directory /MWS/tools/diagnostics/bin.
Syntax
*On Windows: envcapture.bat rootDir [options]
*For UNIX: ./envcapture rootDir [options]
Options
[{–d | --mws-db-xml} path_to_db_configuration_file]
[{–a | --action} {all | filesystem | network | env | java | db | logs}]
[{-f | --from-date} {yyyy.MM.dd | HH:mm:ss | nd | nH}]
[{-t | --to-date} {yyyy.MM.dd | HH:mm:ss | nd | nH}]
[{-s | --server} server_instance]
[{–o | --output} directory_path/name]
The following table lists the arguments and options of the envcapture command-line tool:
Argument or Option
Description
rootDir
Required. Specifies the directory path of the My webMethods Server instance.
{-d | --mws-db-xml}
Specifies the directory path to the mws.db.xml configuration file for the installed database; provide the fully qualified path name as the argument.
{-a | --action}
Specifies the information to capture. The valid arguments are as follows:
*all queries and captures all of the environment information; all is the default value.
*filesystem queries and captures information about the file system structure.
*network queries and captures information about the network and Internet connection.
*env queries and captures information about the environment variables.
*java queries and captures information about the Java system properties.
*db queries and captures information about the installed database.
*logs queries and captures logging information.
{-f | --from-date}
Specifies the start date to use for capturing logging information using the year.month.day or hour.minute.second date format as follows: yyyy.MM.dd or HH:mm:ss . You can also specify an interval as a number of days (d) or hours (h), for example enter 2 days as 2d, or 3 hours as 3h. This captures information from the logs that occurred within the specified time period (for example, collect the logs that have been modified in the last 3 hours).
{-t | --to-date}
Specifies the end date to use when capturing logging information, using the same date format is the same as the from date option. You can also input a time interval using hours and days using, for example, 2d or 3h. This captures information from the logs that occurred prior to the specified date or interval (for example, collect the logs that have been modified up until 3 hours ago).
{-s | --server}
Runs the envcapture command to capture information about another server instance available on the local system. If you do not specify a server instance, the tool performs environment capture on the default My webMethods Server instance.
{-o | --output}
Stores the result of the environment capture in an alternative location. By default, the command creates the result files in the same directory in which you started it.
{-h | --help}
Displays command help text about the command, the available options and arguments, and default values.
Usage Notes
*If your Internet connection uses proxy settings, as a prerequisite you must configure the corresponding proxy host and port for your My webMethods Server in the Windows server.properties.bat file which is located in the Software AG_directory /MWS/server/server_name/bin directory. When working on UNIX-based operating systems, update the server.properties.sh file. The envcapture command verifies the settings and the Internet access of the server.
*The envcapture command produces the result using the log4j mechanism. For more information, see Log4j.
*To use the envcapture output to compare before and after server environment changes, see envdiff.
Examples
*Windows:
envcapture.bat C:\softwareag\MWS\ –d C:\DB\mws.db.xml –a all
-s myServer –o C:\softwareag\MWS\tools\diagnostics\bin\output\
*UNIX:
./envcapture /opt/softwareag/MWS/ –d /opt/DB/mws.db.xml –a all
-s myServer –o /opt/softwareag/MWS/tools/diagnostics/bin/output/