Troubleshooting artifact collection
The troubleshooting artifact download allows you to download or upload the selected artifacts. This feature creates a zipped file containing all selected artifacts and makes it available for download or upload.
To access the Troubleshoot section, click the left arrow () on the bottom right of the Batch Instance Management screen.
Artifacts
Click Download to include the following artifacts in a zipped file.
-
-
Default Exported Batch Class
-
With Image Classification Sample
-
With Lucene Classification Sample
-
-
-
Lib
-
META-INF
-
Application Folder
-
-
Troubleshooting artifact collection
-
Application Logs
-
JavaAppServer Logs
-
Batch Class
There are three options for including the batch class:
- Default Exported Batch Class: The batch class excluding the Lucene and image classification sample folders.
- With Image Classification Sample: The batch class including the image classification sample folder.
- With Lucene Classification Sample: The batch class including the Lucene classification sample folder.
If you select all three options, a created batch class will include both Lucene and the image classification sample folder.
Application
There are three options for including artifacts related to the 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.
Logs
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 file.
Database Dump
Includes the database dump inside the .zip file.
UNC Folder
Includes the UNC folder of the selected batch instance's batch class inside the .zip file.
License Details
Includes a file containing the license details such as Max CPU count, License Expiry date, Number of cores used for OCRing, and the web service switch status.
Options for collecting artifacts
-
Download: Select this option to download the artifact .zip file to your machine.
-
Download to: Select this option to download the .zip file to a specific location. You can use this option to download the artifact .zip to a network path.
The following table describes the information required for downloading the artifacts to a network path.
Information |
Type of value |
Value options |
Description |
---|---|---|---|
User name |
String |
A valid username |
The FTP account on which the artifacts 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 |
Download batch artifacts
-
Click the left arrow () on the bottom right of the Batch Instance Management screen.
The Troubleshoot module opens.
-
Select the artifacts that you want to gather.
-
Select any relevant items from the Download, Download to, and Upload tabs and enter the required information.
-
A .zip file containing the select batch artifacts with the format <VersionNumber>_<BatchInstanceIdentifier>_troubleshoot_<mmddyyyy>_<CurrentTime> will be downloaded or uploaded (as specified in step 3).
-
If no batches are available, a .zip file with name <VersionNumber>_troubleshoot_<mmddyyyy>_<CurrentTime> will be uploaded or downloaded (as specified in step 3).
Troubleshooting
Enable batch instance logs
- Edit the dcma-batch.properties file located in <Ephesoft Transact Installation Folder>/Application/WEB-INF/classes/META-INF/dcma-batch/.
-
To enable batch instance logging, verify that batch.instance_logging is set to ON (default value).
-
Restart Transact as a service on each server.
Common error messages
Error message | Possible cause |
---|---|
Please select at least one option. | None of the artifact options are selected. |
Please enter a path beginning with \ | The Download to option expects a network path where the artifacts can be downloaded. Provide a valid path. |
The path provided does not exist. | The path entered on selected Download to does not exist. |
Could not connect to the FTP client. Please enter valid credentials. | The credentials entered for uploading the artifacts are incorrect. |