Skip to content

Commit 65674b0

Browse files
committed
edits
1 parent b3950f9 commit 65674b0

File tree

1 file changed

+42
-47
lines changed

1 file changed

+42
-47
lines changed

articles/migrate/appcat/java-preview.md

Lines changed: 42 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.date: 01/15/2025
1111
#customer intent: As a developer, I want to assess my Java application so that I can understand its readiness for migration to Azure.
1212
---
1313

14-
# Azure Migrate application and code assessment for Java version 7 (Preview)
14+
# Azure Migrate application and code assessment for Java version 7 (preview)
1515

1616
> [!NOTE]
1717
> This article is for the next generation of *Azure Migrate application and code assessment for Java*, version 7.x. This version is in preview. For the previous stable version, version 6.x, see [Azure Migrate application and code assessment for Java](./java.md).
@@ -60,9 +60,7 @@ When the tool assesses for Cloud Readiness and related Azure services, it can al
6060

6161
## Download and Install
6262

63-
To use the `appcat` CLI, you must download the package specific to your environment, and have the required dependencies in your environment.
64-
The `appcat` CLI runs on any environment such as Windows, Linux, or Mac, using Intel, Arm, or Apple Silicon hardware.
65-
For the JDK requirement, we recommend you use the [Microsoft Build of OpenJDK](/java/openjdk).
63+
To use the `appcat` CLI, you must download the package specific to your environment, and have the required dependencies in your environment. The `appcat` CLI runs on any environment such as Windows, Linux, or Mac, using Intel, Arm, or Apple Silicon hardware. For the JDK requirement, we recommend you use the [Microsoft Build of OpenJDK](/java/openjdk).
6664

6765
| OS | Architecture | Download Link | Other files |
6866
|---------|-----------------|----------------|--------------------------|
@@ -96,7 +94,7 @@ For the JDK requirement, we recommend you use the [Microsoft Build of OpenJDK](/
9694

9795
### Prerequisites
9896

99-
- [Download](/java/openjdk/download#openjdk-17) and [install Microsoft Build of OpenJDK 17](/java/openjdk/install). Ensure that the **JAVA_HOME** environment variable is set.
97+
- [Download](/java/openjdk/download#openjdk-17) and [install Microsoft Build of OpenJDK 17](/java/openjdk/install). Ensure that the `JAVA_HOME` environment variable is set.
10098
- [Download Apache Maven](https://maven.apache.org/download.cgi) and [install locally](https://maven.apache.org/install.html). Ensure that the Maven binary (`mvn`) is reachable through `PATH` environment variable.
10199

102100
### Installation
@@ -120,12 +118,12 @@ Extract the binary from the downloaded file. You should see the following folder
120118
└── readme.html
121119
```
122120

123-
### Running the tool
121+
### Run the tool
124122

125-
To run the `appcat` from any location in your terminal, extract the archive to your desired location, for example, `~/.appcat` on Linux/Mac or `%USERPROFILE%\.appcat` on Windows, then update the `PATH` environment variable to include the directory where you extracted the archive.
123+
To run `appcat` from any location in your terminal, extract the archive to your desired location - for example, **~/.appcat** on Linux/Mac or **%USERPROFILE%\.appcat** on Windows. Then, update the `PATH` environment variable to include the directory where you extracted the archive.
126124

127125
> [!NOTE]
128-
> When the `appcat` binary is called, it first looks for its dependencies in the executable folder specified in the `PATH` environment variable. If the dependencies aren't found, it falls back to the user's home directory - `~/.appcat` on Linux/Mac or `%USERPROFILE%\.appcat` on Windows.
126+
> When the `appcat` binary is called, it first looks for its dependencies in the executable folder specified in the `PATH` environment variable. If the dependencies aren't found, it falls back to the user's home directory - **~/.appcat** on Linux/Mac or **%USERPROFILE%\.appcat** on Windows.
129127
130128
## Usage
131129

@@ -137,7 +135,7 @@ AppCAT provides two subcommands for usage:
137135
- `transform`: Convert XML rules from previous versions (6 and older) to YAML format used by this version.
138136

139137
> [!NOTE]
140-
> For macOS users: If you encounter an error stating "Apple could not verify" when trying to run the app, you can resolve this error by using the following command:
138+
> For macOS users: If you encounter an error stating `Apple could not verify` when trying to run the app, you can resolve this error by using the following command:
141139
>
142140
> ```bash
143141
> xattr -d -r com.apple.quarantine /path/to/appcat_binary
@@ -151,9 +149,9 @@ AppCAT provides two subcommands for usage:
151149
152150
#### Analyze subcommand
153151
154-
The `analyze` subcommand allows you to run source code and binary analysis.
152+
The `analyze` subcommand enables you to run source code and binary analysis.
155153
156-
To analyze application source code, run the following command:
154+
To analyze application source code, use the following command:
157155
158156
# [Linux / macOS](#tab/linux)
159157
@@ -171,7 +169,7 @@ To analyze application source code, run the following command:
171169

172170
The `--input` flag must point to a source code directory or a binary file, and `--output` must point to a directory to store the analysis results.
173171

174-
For more information on the analyze flags, run the following command:
172+
For more information on the analyze flags, use the following command:
175173

176174
# [Linux / macOS](#tab/linux)
177175

@@ -187,7 +185,7 @@ For more information on the analyze flags, run the following command:
187185

188186
---
189187

190-
To check the available targets for AppCAT, run the following command:
188+
To check the available targets for AppCAT, use the following command:
191189

192190
# [Linux / macOS](#tab/linux)
193191

@@ -217,59 +215,56 @@ openjdk17
217215
openjdk21
218216
```
219217

220-
#### Analyzing Multiple Applications
218+
#### Analyzing multiple applications
221219

222-
AppCAT supports multiple applications analysis in per command execution.
223-
You can provide a comma-separated list of input paths for the `--input` flag to analyze multiple applications in a single command.
224-
The output directory and static report will include the combined analysis results for all applications.
220+
AppCAT supports multiple application analysis in per command execution. You can provide a comma-separated list of input paths for the `--input` flag to analyze multiple applications in a single command. The output directory and static report include the combined analysis results for all applications.
225221

226-
To analyze multiple applications, run the following command:
222+
To analyze multiple applications, use the following command:
227223

228224
# [Linux / macOS](#tab/linux)
229225

230226
```bash
231-
./appcat analyze --input=<path/to/source/A>,<path/to/source/B>,<path/to/source/C> --output=<path/to/output/ABC> --target=<targetname>
227+
./appcat analyze --input=<path-to-source-A>,<path-to-source-B>,<path-to-source-C> --output=<path-to-output-ABC> --target=<target-name>
232228
```
233229

234230
# [Windows](#tab/windows)
235231

236232
```cmd
237-
.\appcat.exe analyze --input=<path/to/source/A>,<path/to/source/B>,<path/to/source/C> --output=<path/to/output/ABC> --target=<targetname>
233+
.\appcat.exe analyze --input=<path-to-source-A>,<path-to-source-B>,<path-to-source-C> --output=<path-to-output-ABC> --target=<target-name>
238234
```
239235

240236
---
241237

242-
AppCAT also allows you to use `--bulk` option to incrementally add more application analysis to an existing output directory and static report.
243-
When using the `--bulk` option, you must use it consistently across all command executions that write to the same output.
238+
AppCAT also enables you to use `--bulk` option to incrementally add more application analysis to an existing output directory and static report. When you use the `--bulk` option, you must use it consistently across all command executions that write to the same output.
244239

245240
> [!NOTE]
246-
> When multiple input paths are provided, `--bulk` is enabled by default.
241+
> When you provide multiple input paths, `--bulk` is enabled by default.
247242
248-
To incrementally add more application analysis to an existing static report, run the following command:
243+
To incrementally add more application analysis to an existing static report, use the following command:
249244

250245
# [Linux / macOS](#tab/linux)
251246

252247
```bash
253-
./appcat analyze --input=<path/to/source/A>,<path/to/source/B>,<path/to/source/C> --output=<path/to/output/ABC> --target=<targetname>
254-
./appcat analyze --bulk --input=<path/to/source/D> --output=<path/to/output/ABC> --target=<targetname>
255-
./appcat analyze --bulk --input=<path/to/source/E> --output=<path/to/output/ABC> --target=<targetname>
248+
./appcat analyze --input=<path-to-source-A>,<path-to-source-B>,<path-to-source-C> --output=<path-to-output-ABC> --target=<target-name>
249+
./appcat analyze --bulk --input=<path-to-source-D> --output=<path-to-output-ABC> --target=<target-name>
250+
./appcat analyze --bulk --input=<path-to-source-E> --output=<path-to-output-ABC> --target=<target-name>
256251
```
257252

258253
# [Windows](#tab/windows)
259254

260255
```cmd
261-
.\appcat.exe analyze --input=<path/to/source/A>,<path/to/source/B>,<path/to/source/C> --output=<path/to/output/ABC> --target=<targetname>
262-
.\appcat.exe analyze --bulk --input=<path/to/source/D> --output=<path/to/output/ABC>
263-
.\appcat.exe analyze --bulk --input=<path/to/source/E> --output=<path/to/output/ABC>
256+
.\appcat.exe analyze --input=<path-to-source-A>,<path-to-source-B>,<path-to-source-C> --output=<path-to-output-ABC> --target=<target-name>
257+
.\appcat.exe analyze --bulk --input=<path-to-source-D> --output=<path-to-output-ABC>
258+
.\appcat.exe analyze --bulk --input=<path-to-source-E> --output=<path-to-output-ABC>
264259
```
265260

266261
---
267262

268-
#### Transform Subcommand
263+
#### Transform subcommand
269264

270-
The `transform` subcommand allows you to convert the previous `appcat` XML rules used in the 6.x version into the new YAML format used by this version 7.x.
265+
The `transform` subcommand enables you to convert the previous `appcat` XML rules used in the 6.x version into the new YAML format used by this version 7.x.
271266

272-
To transform rules, run the following command:
267+
To transform rules, use the following command:
273268

274269
# [Linux / macOS](#tab/linux)
275270

@@ -356,20 +351,20 @@ Then, for each file or class affected by the incident, you can jump into the sou
356351

357352
This release contains the following fixes and enhancements.
358353

359-
- The `--input` flag now accepts multiple values, allowing you to analyze multiple applications in a single command execution.
354+
- The `--input` flag now accepts multiple values, enabling you to analyze multiple applications in a single command execution.
360355
- The static report categorizes its issue list for better readability.
361-
- AppCAT can now be installed in directories other than the users home directory.
356+
- Users can now install AppCAT in directories other than the user's home directory.
362357
- Fixed an issue where running `analyze` with both `--bulk` and `--skip-static-report` failed to generate multiple output files.
363358
- Resolved a failure when analyzing with `--bulk` and `--rules` if no Java provider was launched.
364-
- Fixed an issue where analysis would fail if a specified package was not found when using the `--packages` flag.
365-
- The `--exclude-paths` flag has been deprecated. To exclude files or directories, use a `.appcat-ignore` file (supporting glob patterns) placed in the input directory or installation directory.
359+
- Fixed an issue where analysis would fail if a specified package wasn't found when using the `--packages` flag.
360+
- The `--exclude-paths` flag is deprecated. To exclude files or directories, use a **.appcat-ignore** file - supporting glob patterns - placed in the input directory or installation directory.
366361

367362
### 7.6.0.4
368363

369364
This release contains the following fixes and enhancements.
370365

371366
- Supports telemetry collection. Use the `--disable-telemetry` flag to disable telemetry.
372-
- Refactors the CLI command format to make it more clear.
367+
- Refactors the CLI command format to make it clearer.
373368
- Updates the `--source` flag, changing from `--source <source1> --source <source2> ...` to `--source <source1>,<source2>,...`
374369
- Updates the `--target` flag, changing from `--target <target1> --target <target2> ...` to ` --target <target1>,<target2>,...`
375370
- Updates the `--rules` flag, changing from `--rules <rule1> --rules <rule2> ...` to `--rules <rule1>,<rule2>,...`
@@ -402,8 +397,8 @@ This release contains the following fixes and enhancements.
402397
- `--analyze-known-libraries` flag: Now works on Windows.
403398
- Directory cleanup: Extra directories created during analysis on Windows are now automatically cleaned up.
404399
- `--json-output` flag: Now operational.
405-
- Rules parsing error: The error `unable to parse all the rules for ruleset` has been resolved.
406-
- Insights tab descriptions: Missing rule descriptions have been added.
400+
- Rules parsing error: The error `unable to parse all the rules for ruleset` is resolved.
401+
- Insights tab descriptions: Missing rule descriptions are now present.
407402
- Internet connection dependency: Analysis no longer fails without an internet connection.
408403
- `--context-lines` flag: Now behaves as expected when set to 0.
409404
- Removed Python requirement to run the tool.
@@ -458,7 +453,7 @@ Previously, a set of targets were enabled by default, making it difficult for ce
458453

459454
GA (Generally Available) release of Azure Migrate application and code assessment.
460455

461-
## Known Issues
456+
## Known issues
462457

463458
### 7.6.0.5
464459

@@ -483,7 +478,7 @@ GA (Generally Available) release of Azure Migrate application and code assessmen
483478
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant incidents created on Windows OS.
484479
- Error in Watcher Error channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
485480
- <kbd>Ctrl</kbd>+<kbd>C</kbd> fails to stop ongoing analysis. To work around, manually terminate the process by explicitly killing the process.
486-
- In binary analysis reports, the code snippet title shows an incorrect or non-existent file path.
481+
- In binary analysis reports, the code snippet title shows an incorrect or nonexistent file path.
487482

488483
### 7.6.0.2
489484

@@ -494,7 +489,7 @@ GA (Generally Available) release of Azure Migrate application and code assessmen
494489
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant incidents created on Windows OS.
495490
- Error in Watcher Error channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
496491
- <kbd>Ctrl</kbd>+<kbd>C</kbd> fails to stop ongoing analysis. To work around, manually terminate the process by explicitly killing the process.
497-
- In binary analysis reports, the code snippet title shows an incorrect or non-existent file path.
492+
- In binary analysis reports, the code snippet title shows an incorrect or nonexistent file path.
498493

499494
### 7.6.0.1
500495

@@ -505,7 +500,7 @@ GA (Generally Available) release of Azure Migrate application and code assessmen
505500
- Analyzing WAR files on Windows produces the following error: `Failed to Move Decompiled File`. An error occurs when analyzing WAR files on Windows, which is responsible for a few redundant incidents created on Windows OS.
506501
- Error in Watcher Error channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
507502
- <kbd>Ctrl</kbd>+<kbd>C</kbd> fails to stop ongoing analysis. To work around, manually terminate the process by explicitly killing the process.
508-
- In binary analysis reports, the code snippet title shows an incorrect or non-existent file path.
503+
- In binary analysis reports, the code snippet title shows an incorrect or nonexistent file path.
509504

510505
### 7.6.0.0
511506

@@ -527,14 +522,14 @@ GA (Generally Available) release of Azure Migrate application and code assessmen
527522
- Error in **Watcher Error** channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
528523
- This release requires an active internet connection for dependency analysis.
529524
- <kbd>Ctrl</kbd>+<kbd>C</kbd> fails to stop ongoing analysis. To work around, manually terminate the process by explicitly killing the process.
530-
- When the flag `--context-lines` is set to a number 0, it doesn't work as expected. This flag allows the user to limit how much of the source code should appear on the report. Setting to a value 0 might not work as expected.
525+
- When the flag `--context-lines` is set to a number 0, it doesn't work as expected. This flag enables the user to limit how much of the source code should appear on the report. Setting to a value 0 might not work as expected.
531526

532527
## License
533528

534529
Azure Migrate application and code assessment for Java is a free, open source-based tool.
535530

536531
## Data collection
537532

538-
AppCAT collects telemetry data by default. Microsoft aggregates collected data to identify patterns of usage to identify common issues and to improve the experience of AppCAT CLI. Microsoft AppCAT CLI doesn't collect any private or personal data. For example, the usage data helps identify issues such as commands with low success rate and helps prioritize our work.
533+
AppCAT collects telemetry data by default. Microsoft aggregates collected data to identify patterns of usage to identify common issues and to improve the experience of the AppCAT CLI. The Microsoft AppCAT CLI doesn't collect any private or personal data. For example, the usage data helps identify issues such as commands with low success rate. This information helps us prioritize our work.
539534

540-
While we appreciate the insights this data provides, we also understand that not everyone wants to send usage data. You can disable data collection with the `appcat analyze --disable-telemetry` command. You can also read our [privacy statement](https://www.microsoft.com/privacy/privacystatement) to learn more.
535+
While we appreciate the insights this data provides, we also understand that not everyone wants to send usage data. You can disable data collection by using the `appcat analyze --disable-telemetry` command. For more information, see our [privacy statement](https://www.microsoft.com/privacy/privacystatement).

0 commit comments

Comments
 (0)