How to Generate a Diagnostic Report of FileCatalyst Products via Command line
Posted by Jeyram Sachchithananthan, Last modified by Aly Essa on 21 May 2021 11:29 AM

Overview
The diagnostic Report collects logs, reports, Java virtual machine heap and configurations of your FileCatalyst application, which is useful to FileCatalyst engineers for analysis and troubleshooting. The information is assembled into a zip archive under the diagnostics subfolder of your application's installation directory, from where it can be forwarded to the FileCatalyst support team if desired.


Note:
The diagnostics archive can take a few minutes to generate, depending on how busy the product is with other operations. The collected logs are filtered based on time and size to keep the resulting diagnostics zip file small. It is expected to see a temporary file appear in the diagnostics folder during this process. When the archive is completed, it will appear in the diagnostics folder with a filename similar to "FileCatalyst<product>_<YYYY-MM-DD-HH-MM-SS>_diagnostics.zip "


Environment
FileCatalyst Server v3.7.3 Build 18 and Higher
FileCatalyst HotFolder v3.7.3 Build 18 and Higher
FileCatalyst TransferAgent v3.7.3 Build 18 and Higher
FileCatalyst Central v3.7.3 Build 18 and Higher

Resolution
Note: These commands must be executed with a choice of a Command-Line Tool when the involved FileCatalyst application is up and running as either service or standalone instance.   

  1. Navigate to the install directory of FileCatalyst Applications. This may vary depending on the Operating systems, Your installation path and how the application is executed (either as a service or standalone).
  2. Run the provided commands to get the diagnostics report generated:


FileCatalyst Server

Windows : 

  1. cd <path to>\FileCatalyst Server\
  2. "jre\bin\java.exe" -jar FileCatalystServer.jar -diagnostic

Diagnostic file location:<path to>\FileCatalyst Server\diagnostics

EG:
Server-Windows


Linux: 

  1. cd  /opt/utechsoft/server/
  2. sudo ./jre/bin/java -jar FileCatalystServer.jar -diagnostic

Diagnostic file location:/opt/utechsoft/server/diagnostics

EG:
Server-Linux


FileCatalyst Central

Windows:

  1. cd <path to>\FileCatalyst Central\
  2.  "jre\bin\java.exe" -jar FileCatalystCentralWC.jar -diagnostic

Diagnostic file location:<path to>\FileCatalyst Central\diagnostics

EG:
Central-Windows

Linux:

  1. cd /opt/utechsoft/central/
  2.  sudo ./jre/bin/java -jar FileCatalystCentralWC.jar -diagnostic

Diagnostic file location:/opt/central/server/diagnostics

EG:
Central-Linux


FileCatalyst HotFolder

Windows:

  1. cd <path to>\FileCatalyst HotFolder\
  2.  "jre\bin\java.exe" -jar FileCatalystHotFolder.jar -diagnostic

Diagnostic file location:<path to>\FileCatalyst HotFolder\diagnostics

EG:
HF-Windows


Linux: 

  1. cd /opt/utechsoft/hotfolder/
  2. sudo ./jre/bin/java -jar FileCatalystHotFolder.jar -diagnostic

Diagnostic file location:/opt/hotfolder/server/diagnostics

EG:
HF-Linux

macOS:

  1. cd /Applications/FileCatalystHotFolder.app/Contents/MacOS
  2. ./FileCatalystHotFolder -diagnostic

Diagnostic file location:
HotFolder running as standalone: Users/<username>/Library/Application\ Support/FileCatalyst/TransferAgent/diagnostics/
HotFolder running as a service: /Library/Application\ Support/FileCatalyst/TransferAgent/diagnostics/

EG:
HF-Mac


FileCatalyst TransferAgent

Windows:

  1. cd <path to>\FileCatalyst TransferAgent\
  2. "jre\bin\java.exe" -jar FileCatalystTransferAgent.jar -diagnostic

EG:
TA-Windows

Linux:

  1. cd /opt/utechsoft/transferagent/
  2. sudo ./jre/bin/java -jar FileCatalystTransferAgent.jar -diagnostic

EG:
TA-Linux

macOS: 

  1. cd /Applications/FileCatalystTransferAgent.app/Contents/MacOS/
  2. ./FileCatalystTransferAgent -diagnostic

EG:
TA-Mac


Diagnostic file location:
TransferAgent running as standalone: Users/<username>/Library/Application\ Support/FileCatalyst/TransferAgent/diagnostics
TransferAgent running as a Service: /Library/Application\ Support/FileCatalyst/TransferAgent/diagnostics




Comments (0)