Skip to content

Commit 8da6509

Browse files
committed
reflect NuixDiagnostics changes
1 parent 2c258af commit 8da6509

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.MD

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -217,9 +217,9 @@ Once a license has been obtained by [EngineWrapper] and a `Utilities` object has
217217

218218
## NuixDiagnostics
219219

220-
When there is a problem, it is helpful to capture a snapshot of the state of things for trouble shooting purposes. In the Nuix Workbench GUI we can generate a diagnostics file with the click of a button. When using the Java engine API we have to do a bit more work. The class [NuixDiagnostics] provides a method [saveDiagnostics](https://nuix.github.io/Nuix-Java-Engine-Baseline/com/nuix/javaenginesimple/NuixDiagnostics.html#saveDiagnostics-java.lang.String-) which can generate a Nuix diagnostics file for you. The method accepts as an argument the directory (as a String or [java.io.File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html)) to which the diagnostics zip will be saved. The generated zip file will automatically be given a time stamped name in the form `NuixEngineDiagnostics-yyyyMMddHHmmss.zip`, for example `NuixEngineDiagnostics-20200408113545.zip`.
220+
When there is a problem, it is helpful to capture a snapshot of the state of things for trouble shooting purposes. In the Nuix Workbench GUI we can generate a diagnostics file with the click of a button. When using the Java engine API we have to do a bit more work. The class [NuixDiagnostics] provides a method [saveDiagnosticsToDirectory](https://nuix.github.io/Nuix-Java-Engine-Baseline/com/nuix/javaenginesimple/NuixDiagnostics.html#saveDiagnosticsToDirectory-java.lang.String-) which can generate a Nuix diagnostics file for you. The method accepts as an argument the directory (as a String or [java.io.File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html)) to which the diagnostics zip will be saved. The generated zip file will automatically be given a time stamped name in the form `NuixEngineDiagnostics-yyyyMMddHHmmss.zip`, for example `NuixEngineDiagnostics-20200408113545.zip`.
221221

222-
In the example [NuixDiagnostics.saveDiagnostics][saveDiagnostics] is called when an exception bubbles all the way up to our main `try`/`catch`.
222+
In the example [saveDiagnosticsToDirectory](https://nuix.github.io/Nuix-Java-Engine-Baseline/com/nuix/javaenginesimple/NuixDiagnostics.html#saveDiagnosticsToDirectory-java.lang.String-) is called when an exception bubbles all the way up to our main `try`/`catch`.
223223

224224
```java
225225
public static void main(String[] args) throws Exception {
@@ -235,7 +235,7 @@ public static void main(String[] args) throws Exception {
235235
logger.error("Unhandled exception",e);
236236
// Lets dump a diagnostics file since something went wrong and having
237237
// this may be helpful for troubleshooting
238-
NuixDiagnostics.saveDiagnostics("C:\\EngineDiagnostics");
238+
NuixDiagnostics.saveDiagnosticsToDirectory("C:\\EngineDiagnostics");
239239
}
240240
}
241241
```

0 commit comments

Comments
 (0)