About {MavenNameTitle} arguments

The following is a detailed description of the available {ProductShortName} {MavenName} arguments.

Table 1. {ProductShortName} {MavenName} arguments

Argument	Description
analyzeKnownLibraries	Flag to analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code. Note This option may result in a longer execution time and a large number of migration issues being reported.
customLoggingPropertiesFile	An absolute path to a logging.properties file that contains a java.util.logging.LogManager logging configuration. If the specified path is invalid, or the option is not specified, then the logging reverts to using the logging.properties file included with the {MavenName}.
disableTattletale	Flag to disable generation of the Tattletale report. If both enableTattletale and disableTattletale are set to true, then disableTattletale will be ignored, and the Tattletale report will still be generated.
enableCompatibleFilesReport	Flag to enable generation of the Compatible Files report. Due to processing all files without found issues, this report may take a long time for large applications.
enableTattletale	Flag to enable generation of a Tattletale report for each application. This option is enabled by default when eap is in the included target. If both enableTattletale and disableTattletale are set to true, then disableTattletale will be ignored, and the Tattletale report will still be generated.
enableTransactionAnalysis	[Technology Preview] Flag to enable generation of a Transactions report that displays the call stack, which executes operations on relational database tables. The Enable Transaction Analysis feature supports Spring Data JPA and the traditional preparedStatement() method for SQL statement execution. It does not support ORM frameworks such as Hibernate. Note enableTransactionAnalysis is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
excludePackages	A list of packages to exclude from evaluation. For example, entering "com.mycompany.commonutilities" would exclude all classes whose package name begins with "com.mycompany.commonutilities".
excludeTags	A list of tags to exclude. When specified, rules with these tags will not be processed.
explodedApps	Flag to indicate that the provided input directory contains source files for a single application.
exportCSV	Flag to export the report data to a CSV file on your local file system. {ProductShortName} creates the file in the directory specified by the outputDirectory argument. The CSV file can be imported into a spreadsheet program for data manipulation and analysis.
includeTags	A list of tags to use. When specified, only rules with these tags will be processed.
inputDirectory	Specify the path to the directory containing the applications to be analyzed. This argument defaults to {project.basedir}/src/main/.
keepWorkDirs	Flag to instruct {ProductShortName} to not delete temporary working files, such as the graph database and unzipped archives. This is useful for debugging purposes.
legacyReports	Flag to instruct {ProductShortName} to generate the old format reports instead of the new format reports.
packages	A list of the packages to be evaluated by {ProductShortName}. This argument is required.
offlineMode	Flag to operate in offline mode, disabling network access features, such as scheme validation. Used to improve performance.
outputDirectory	Specify the path to the directory to output the report information generated by {ProductShortName}. This argument defaults to {project.build.directory}/windup-report.
overwrite	Flag to force delete the existing output directory specified by outputDirectory. Defaults to true. Warning Be careful not to specify a report output directory that contains important information!
sourceTechnologies	A list of one or more source technologies, servers, platforms, or frameworks to migrate from. This argument, in conjunction with the targetTechnologies argument, helps to determine which rulesets are used.
sourceMode	Flag to indicate that the application to be evaluated contains source files rather than compiled binaries. Defaults to true.
targetTechnologies	A list of one or more target technologies, servers, platforms, or frameworks to migrate to. This argument, in conjunction with the sourceTechnologies argument, helps to determine which rulesets are used.
userIgnorePath	Specify a location for {ProductShortName} to identify files that should be ignored.
userRulesDirectory	Specify a location for {ProductShortName} to look for custom {ProductShortName} rules. The value can be a directory containing ruleset files or a single ruleset file. The ruleset files must use the .windup.xml suffix.
windupHome	An optional argument that points to the root of an extracted {ProductShortName} {CLIName}. By referencing a local installation of the {CLIName}, the {MavenName} has direct access to all of the indexes, resulting in a performance increase.
windupVersion	Specify the version of {ProductShortName} to run. By default, this is the {MavenName}'s build version.

Specifying the input directory

A path to the file or directory containing one or more applications to be analyzed. This defaults to {project.basedir}/src/main/.

Usage

<inputDirectory>
    <INPUT_ARCHIVE_OR_DIRECTORY>
</inputDirectory>

Evaluating an input file

Depending on whether the input file type provided to the inputDirectory argument is a file or directory, it will be evaluated as follows depending on the additional arguments provided.

Directory

--explodedApp	--sourceMode	Neither Argument
The directory is evaluated as a single application.	The directory is evaluated as a single application.	Each subdirectory is evaluated as an application.

File

--explodedApp	--sourceMode	Neither Argument
Argument is ignored; the file is evaluated as a single application.	The file is evaluated as a compressed project.	The file is evaluated as a single application.

Specifying the output directory

Specify the path to the directory to output the report information generated by {ProductShortName}.

Usage

<outputDirectory>
    <OUTPUT_REPORT_DIRECTORY>
</outputDirectory>

• If omitted, the report will be generated in the {project.build.directory}/windup-report directory.

• If the output directory exists, it will be overwritten based on the value of the overwrite argument. This argument defaults to true, and causes {ProductShortName} to delete and recreate the directory.

Setting the source technology

A list of one or more source technologies, servers, platforms, or frameworks to migrate from. This argument, in conjunction with the targetTechnologies argument, helps to determine which rulesets are used.

Usage

<sourceTechnologies>
    <source>eap:6</source>
</sourceTechnologies>

The sourceTechnologies argument now provides version support, which follows the Maven version range syntax. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, <source>eap:5</source>.

Setting the target argument

A list of one or more target technologies, servers, platforms, or frameworks to migrate to. This argument, in conjunction with the sourceTechnologies argument, helps to determine which rulesets are used. This argument is required

Usage

<targetTechnologies>
  <target>eap:7</target>
</targetTechnologies>

The targetTechnologies argument now provides version support, which follows the Maven Version Range Specification. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, <target>eap:7</target>.

Warning

When migrating to JBoss EAP, be sure to specify the version in the target, for example, eap:6. Specifying only eap will run rulesets for all versions of JBoss EAP, including those not relevant to your migration path. See Supported migration paths in Introduction to the Migration Toolkit for Applications for the appropriate JBoss EAP version.

Selecting packages

A list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument.

Usage

<packages>
  <package>
    <PACKAGE_1>
  </package>
  <package>
    <PACKAGE_2>
  </package>
</packages>

• In most cases, you are interested only in evaluating custom application class packages and not standard Java EE or third party packages. The <PACKAGE_N> argument is a package prefix; all subpackages will be scanned. For example, to scan the packages com.mycustomapp and com.myotherapp, use the following snippet in your pom.xml.

  <packages>
    <package>com.mycustomapp</package>
    <package>com.myotherapp</package>
  </packages>

• While you can provide package names for standard Java EE third party software like org.apache, it is usually best not to include them as they should not impact the migration effort.