{"id":31722,"date":"2014-09-07T14:23:56","date_gmt":"2014-09-07T22:23:56","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/batch-instance-management-screen\/troubleshoot-artefact-collection\/"},"modified":"2022-02-28T12:47:01","modified_gmt":"2022-02-28T19:47:01","slug":"troubleshoot-artifact-collection","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/","title":{"rendered":"Troubleshooting Artifact Collection"},"content":{"rendered":"<h2>Overview<\/h2>\n<p>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.<\/p>\n<p>The <strong>Troubleshoot<\/strong> section can be accessed by pressing the left arrow ( \u25c4 ) on the bottom right of the <strong>Batch Instance Management<\/strong> screen.<\/p>\n<p><img decoding=\"async\" class=\"wp-image-43828\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-20.jpeg\" width=\"808\" height=\"317\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-20.jpeg 1200w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-20-300x118.jpeg 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-20-1024x401.jpeg 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-20-768x301.jpeg 768w\" sizes=\"(max-width: 808px) 100vw, 808px\" \/><\/p>\n<p><em>Figure 1: <strong>Batch Instance Management<\/strong> Screen\u00a0<\/em><\/p>\n<h2>Artifacts<\/h2>\n<p><img decoding=\"async\" class=\"wp-image-43829\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-21.jpeg\" width=\"805\" height=\"315\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-21.jpeg 1200w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-21-300x118.jpeg 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-21-1024x401.jpeg 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-21-768x301.jpeg 768w\" sizes=\"(max-width: 805px) 100vw, 805px\" \/><\/p>\n<p><em>Figure 2: <strong>Troubleshoot<\/strong> Module<\/em><\/p>\n<p><img decoding=\"async\" class=\"wp-image-43830\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-22.jpeg\" width=\"811\" height=\"318\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-22.jpeg 1200w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-22-300x118.jpeg 300w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-22-1024x402.jpeg 1024w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-22-768x301.jpeg 768w\" sizes=\"(max-width: 811px) 100vw, 811px\" \/><\/p>\n<p><em>Figure 3: Download Troubleshoot Artifacts<\/em><\/p>\n<p>The following artifacts will be included in a zipped file upon clicking <strong>Download<\/strong>:<\/p>\n<ul>\n<li>Batch Class\n<ul>\n<li>Default Exported Batch Class<\/li>\n<li>With Image Classification Sample<\/li>\n<li>With Lucene Classification Sample<\/li>\n<\/ul>\n<\/li>\n<li>Application\n<ul>\n<li>Lib<\/li>\n<li>META-INF<\/li>\n<li>Application Folder<\/li>\n<\/ul>\n<\/li>\n<li>Logs\n<ul>\n<li>Application Logs<\/li>\n<li>JavaAppServer Logs<\/li>\n<\/ul>\n<\/li>\n<li>Batch Instance Folder<\/li>\n<li>Database Dump<\/li>\n<li>UNC Folder<\/li>\n<li>License Details<\/li>\n<\/ul>\n<h3>Batch Class<\/h3>\n<p>There are three options for including the batch class:<\/p>\n<ol>\n<li><strong>Default Exported Batch Class<\/strong>: batch class excluding the Lucene and image classification sample folders.<\/li>\n<li><strong>With Image Classification Sample:<\/strong> batch class including the image classification sample folder.<\/li>\n<li><strong>With Lucene Classification Sample<\/strong>: batch class including the Lucene classification sample folder.<\/li>\n<\/ol>\n<p>If you select all three options it will create a batch class including both Lucene and the image classification sample folder.<\/p>\n<h3>Application<\/h3>\n<p>There are three options for including artifacts related to the Application Folder:<\/p>\n<ol>\n<li><strong>Lib<\/strong>: Include the lib folder only.<\/li>\n<li><strong>META\u2013INF<\/strong>: Include the META \u2013 INF only.<\/li>\n<li><strong>Application<\/strong>: Application folder without native including both lib and META \u2013 INF.<\/li>\n<\/ol>\n<h3>Logs<\/h3>\n<p>There are three types of logs available for download\/upload.<\/p>\n<ol>\n<li><strong>Application<\/strong>: Includes the application logs in the zip file<\/li>\n<li><strong>JavaAppServer<\/strong>: Includes the Application Server logs in the zip file.<\/li>\n<li><strong>Batch Instance<\/strong>: Includes the batch instance logs in the zip file.<\/li>\n<\/ol>\n<h3>Batch Instance Folder<\/h3>\n<p>Includes the whole batch instance folder inside the zip.<\/p>\n<h3>Database Dump<\/h3>\n<p>Includes the database dump inside the zip.<\/p>\n<h3>UNC Folder<\/h3>\n<p>Includes the UNC folder of the selected batch instance\u2019s batch class inside the zip.<\/p>\n<h3>License Details<\/h3>\n<p>Includes a file containing the license details like Max CPU count, License Expiry date, Number of cores used for OCRing, and web service switch status.<\/p>\n<h3>Options for Collecting Artifacts<\/h3>\n<ul>\n<li><strong>Download<\/strong>: Select this option for downloading the artifact zip on your machine.<\/li>\n<li><strong>Download to<\/strong>: Select this option for downloading the zip to a specific location. The artifact zip can be downloaded to a network path using this option.<\/li>\n<\/ul>\n<p>The below table describes the information required for downloading the artifacts on a network path:<\/p>\n<table>\n<tbody>\n<tr>\n<td><strong>Information<\/strong><\/td>\n<td><strong>Type of Value<\/strong><\/td>\n<td><strong>Value Options<\/strong><\/td>\n<td><strong>Description<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Username<\/td>\n<td>String<\/td>\n<td>A valid username<\/td>\n<td>The FTP account on which the artifacts are required to be uploaded<\/td>\n<\/tr>\n<tr>\n<td>Password<\/td>\n<td>String<\/td>\n<td>Corresponding password for the configured username<\/td>\n<td>Password for the configured FTP account<\/td>\n<\/tr>\n<tr>\n<td>Server URL<\/td>\n<td>String<\/td>\n<td>A valid FTP server URL<\/td>\n<td>The URL of the FTP server to which the configured user account belongs<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><img decoding=\"async\" class=\"wp-image-43831\" src=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-23.jpeg\" width=\"659\" height=\"246\" srcset=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-23.jpeg 629w, https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-23-300x112.jpeg 300w\" sizes=\"(max-width: 659px) 100vw, 659px\" \/><\/p>\n<p><em>Figure 4: <strong>Download To<\/strong> Path Option<\/em><\/p>\n<h3>Steps of execution\/working<\/h3>\n<ol>\n<li>Click the arrow ( \u25c4 ) at the bottom right of the <strong>Batch Instance Management<\/strong> screen to open the <strong>Troubleshoot<\/strong> module.<\/li>\n<li>Select the artifacts you need to gather.<\/li>\n<li>Select any relevant items from the <strong>Download<\/strong>, <strong>Download to<\/strong>, and <strong>Upload<\/strong> tabs and enter the necessary information.<\/li>\n<li>A zip containing the select batch\u2019s artifacts with the format\u00a0<strong>&lt;<em>VersionNumber<\/em>&gt;_&lt;<em>BatchInstanceIdentifier<\/em>&gt;_troubleshoot_&lt;<em>mmddyyyy<\/em>&gt;_&lt;<em>CurrentTime<\/em>&gt;<\/strong> will be downloaded or uploaded (as specified in Step 3).<\/li>\n<li>If there no batches were available, then a zip with name\u00a0<strong>&lt;<em>VersionNumber<\/em>&gt;_troubleshoot_&lt;<em>mmddyyyy<\/em>&gt;_&lt;<em>CurrentTime<\/em>&gt;\u00a0<\/strong>will be uploaded or downloaded (as specified in Step 3).<\/li>\n<\/ol>\n<p>&nbsp;<\/p>\n<h2>Troubleshooting<\/h2>\n<h3>How to Enable Batch Instance Logs<\/h3>\n<ol>\n<li>Edit the <strong>dcma-batch.properties<\/strong> file located in <strong>&lt;Ephesoft Installation Folder&gt;\/Application\/WEB-INF\/classes\/META-INF\/dcma-batch\/<\/strong><\/li>\n<li>Enable batch instance logging. Change <strong>batch.instance_logging=OFF<\/strong> to <strong>batch-instance_logging=ON.<\/strong><\/li>\n<li>Restart Ephesoft Transact as a service on each server.<\/li>\n<\/ol>\n<h3>Common Error Messages<\/h3>\n<table>\n<tbody>\n<tr>\n<td><strong>Error Message<\/strong><\/td>\n<td><strong>Possible Cause<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Please select at least one option.<\/td>\n<td>None of the artifact options are selected.<\/td>\n<\/tr>\n<tr>\n<td>Please enter a path beginning with \\<\/td>\n<td>The <strong>Download to<\/strong> option expects a network path where the artifacts can be downloaded. Provide a valid path.<\/td>\n<\/tr>\n<tr>\n<td>The path provided does not exist.<\/td>\n<td>The path entered on selected <strong>Download to <\/strong>does not exist.<\/td>\n<\/tr>\n<tr>\n<td>Could not connect to the FTP client. Please enter valid credentials.<\/td>\n<td>The credentials entered for uploading the artifacts are incorrect.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>&nbsp;<\/p>\n<p>&nbsp;<\/p>\n","protected":false},"featured_media":0,"parent":31710,"menu_order":9,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v19.0 (Yoast SEO v22.1) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Troubleshooting Artifact Collection | Ephesoft Docs<\/title>\n<meta name=\"description\" content=\"Troubleshooting artifact download allows the user 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.\" \/>\n<meta name=\"robots\" content=\"noindex, follow\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Troubleshooting Artifact Collection\" \/>\n<meta property=\"og:description\" content=\"Troubleshooting artifact download allows the user 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.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2022-02-28T19:47:01+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-20.jpeg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/\",\"name\":\"Troubleshooting Artifact Collection | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2014-09-07T22:23:56+00:00\",\"dateModified\":\"2022-02-28T19:47:01+00:00\",\"description\":\"Troubleshooting artifact download allows the user 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.\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/ephesoft.com\/docs\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transact\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Features and Functions\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Administrator Role and Features\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Batch Instance Management Screen\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Troubleshooting Artifact Collection\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\",\"url\":\"https:\/\/ephesoft.com\/docs\/\",\"name\":\"Ephesoft Docs\",\"description\":\"Intelligent Document Processing Made Easy\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/ephesoft.com\/docs\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Troubleshooting Artifact Collection | Ephesoft Docs","description":"Troubleshooting artifact download allows the user 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.","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Troubleshooting Artifact Collection","og_description":"Troubleshooting artifact download allows the user 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.","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/","og_site_name":"Ephesoft Docs","article_modified_time":"2022-02-28T19:47:01+00:00","og_image":[{"url":"https:\/\/ephesoft.com\/docs\/wp-content\/uploads\/2020\/02\/word-image-20.jpeg"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/","name":"Troubleshooting Artifact Collection | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2014-09-07T22:23:56+00:00","dateModified":"2022-02-28T19:47:01+00:00","description":"Troubleshooting artifact download allows the user 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.","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/troubleshoot-artifact-collection\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/ephesoft.com\/docs\/"},{"@type":"ListItem","position":2,"name":"Transact","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/"},{"@type":"ListItem","position":3,"name":"Features and Functions","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/"},{"@type":"ListItem","position":4,"name":"Administrator Role and Features","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/"},{"@type":"ListItem","position":5,"name":"Batch Instance Management Screen","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/"},{"@type":"ListItem","position":6,"name":"Troubleshooting Artifact Collection"}]},{"@type":"WebSite","@id":"https:\/\/ephesoft.com\/docs\/#website","url":"https:\/\/ephesoft.com\/docs\/","name":"Ephesoft Docs","description":"Intelligent Document Processing Made Easy","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/ephesoft.com\/docs\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"}]}},"comment_count":0,"_links":{"self":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31722"}],"collection":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/comments?post=31722"}],"version-history":[{"count":2,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31722\/revisions"}],"predecessor-version":[{"id":50414,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31722\/revisions\/50414"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31710"}],"next":[{"title":"Batch Instance Grid","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/batch-instance-grid-4050\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31712"}],"prev":[{"title":"Batch Instance Custom Columns","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/batch-instance-management-screen\/batch-instance-custom-columns\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31721"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31722"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31722"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}