Troubleshoot Artefact Collection


Troubleshooting artefact download allows the user to download or upload the selected artefacts. This feature creates a zipped file containing all the artefacts selected by the user and makes it available for download or upload (as specified by user).

The Troubleshoot button is on the Batch Instance Management module on the extreme bottom right adjacent to the scroll bars.







It provides the following artefacts to be included in the output zipped file:

  • Batch Class
    • Default Exported Batch Class
    • With Image Classification Sample
    • With Lucene Classification Sample
  • Application
    • Lib
    • META – INF
    • Application
  • Logs
    • Application
    • JavaAppServer
    • Batch Instance
  • Batch Instance Folder
  • Database Dump
  • UNC Folder
  • License Detail

Batch Class

There are three options for including the batch class:

Default Exported Batch Class – Batch class excluding the lucene and image classification sample folders.

With Image Classification Sample – Batch class including the image classification sample folder.

With Lucene Classification Sample – Batch class including the lucene classification sample folder.

If the user selects all the three options, then Batch Class including both lucene and image classification sample folder is created.


There are three options for including artefacts related to Application Folder:

Lib – Include the lib folder only.

META – INF – Include the META – INF only.

Application – Application folder without native including both lib and META – INF.


There are three types of logs available for download/upload.

Application – Includes the application logs in the zip file

JavaAppServer – Includes the Application Server logs in the zip file.

Batch Instance – Includes the batch instance logs in the zip file.

Batch Instance Folder

Includes the whole batch instance folder inside the zip.

Database Dump

Includes the database dump inside the zip.

UNC Folder

Includes the UNC folder of the selected batch instance’s batch class inside the zip.

License Details

Includes a file containing the license details like Max CPU count, License Expire date, Number of cores used for OCRing and web service switch status.

Options for collecting artefacts

Download – Select this option for downloading the artefact zip on your machine.

Download to – Select this option for downloading the zip at a particular location. The artefact zip can be downloaded to a network path using this option.

Following is the information required for downloading the artefacts on a particular path:


[table caption=”” width=”800″ colwidth=”20|100|50″ colalign=”left|left|center|left|right”]
Information,Type of value,Value options,Description
Username,String,A valid username,The FTP account on which the artefacts are required to be uploaded.
Password,String,Corresponding password for the configured username,Password for the configured FTP account.
Server URL,String,A valid FTP server URL,The URL of the FTP server to which the configured user account belongs.


Steps of execution/working

  • Click the Troubleshoot button.
  • Select the artefacts you need to gather.
  • Select any one of from Download, Download to, Upload and enter necessary information.
  • A zip with name{BatchInstanceIdentifier}_troubleshoot_{mmddyyyy}_{CurrentTime} containing the select batch’s artefacts will be downloaded or uploaded as specified by the user.
  • If there were no batches then a zip with name{mmddyyyy}_{CurrentTime} will be uploaded or downloaded as specified by the user.



Following are few common error messages received while using the Troubleshoot Artefact Collection feature


[table caption=”” width=”800″ colwidth=”20|100|50″ colalign=”left|left|center|left|right”]
S. No.,Error message,Possible root cause
1,Please select at least one option.,If none of the artefact options is selected.
2,Please enter a path beginning with \\.,Download to option expects a network path where the artefacts can be downloaded.
3,The path provided does not exist.,The path entered on selecting DownloadTo does not exist.
4,Could not connect to the FTP client. Please enter valid credentials.,The credentials entered for uploading the artefacts are not valid.