{"id":31798,"date":"2015-03-09T12:38:50","date_gmt":"2015-03-09T20:38:50","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/"},"modified":"2020-12-10T17:00:45","modified_gmt":"2020-12-11T00:00:45","slug":"clean-up-plugin-2","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/","title":{"rendered":"Clean Up Plugin"},"content":{"rendered":"

Available: <\/b>on-premises, cloud<\/span><\/p>\n

This page provides an overview of the Cleanup plugin in Ephesoft Transact. This information is intended for Transact Administrators.<\/span><\/p>\n

Overview<\/b><\/h2>\n

The Cleanup plugin is a default plugin in the Export module. This plugin removes all content associated with a batch instance after it has finished processing, including system files and UNC folder data.<\/span><\/p>\n

Specifically, this plugin uses the batch instance identifier (BI ID) to removes all contents from the following locations:<\/span><\/p>\n

    \n
  • BI folder in SharedFolders.<\/span>\n
      \n
    • [Ephesoft_Directory]\\<\/span><\/i>SharedFolders\\ephesoft-system-folder\\<\/span><BC ID><\/b>\\<\/span><BI ID><\/b><\/li>\n<\/ul>\n<\/li>\n
    • BI folder on the Local system (if enabled).<\/span>\n
        \n
      • <Local Folder Path><\/b>\\<\/span><BI ID><\/b><\/li>\n<\/ul>\n<\/li>\n
      • BI SER<\/span> file from the Local system (if enabled).<\/span>\n
          \n
        • <Local Folder Path><\/b>\\<\/span><BI ID><\/b>\\<\/span><BI ID>.ser<\/b><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n

          To prevent issues with workflow execution, the Cleanup plugin should be the final plugin in the workflow.<\/span><\/p>\n

          Note: <\/b>Once the Cleanup plugin runs, the batch will be set to the FINISHED state, and will be deleted from the server and can no longer be restarted.<\/span><\/p>\n

          Configuring the Cleanup Plugin<\/b><\/h2>\n

          This section provides information on how to configure the Cleanup plugin. This plugin only needs to be configured once per batch class.<\/span><\/p>\n

          To navigate to the plugin:<\/span><\/p>\n

            \n
          1. From the <\/span>Batch Class Management <\/b>page, select and open your batch class.<\/span><\/li>\n
          2. Go to <\/span>Modules <\/b>> <\/span>Export <\/b>> <\/span>CLEANUP.<\/b><\/li>\n
          3. Configure the <\/span>Delete System Folder Information <\/b>field according to your workflow needs.<\/span>\n
              \n
            1. \n
                \n
              1. TRUE: Deletes the BI folder and BI SER file from the Local system (default).<\/span><\/li>\n
              2. FALSE: Only deletes the BI folder in SharedFolders.<\/span><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<\/li>\n
              3. Click <\/span>Apply<\/b>.<\/span><\/li>\n<\/ol>\n

                Troubleshooting<\/b><\/h2>\n\n\n\n\n\n
                Error Message<\/b><\/span><\/td>\nPossible Root Cause<\/b><\/span><\/td>\n<\/tr>\n
                Unable to delete folder<\/span><\/td>\nFolder couldn’t be deleted due to one of the following reasons:<\/span><\/p>\n
                  \n
                • It is locked by another process<\/span><\/li>\n
                • It is open by another user<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
                Not enough permission to delete folder<\/span><\/td>\nSecurity exception occurred. The user or process doesn’t have rights to delete the folder.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

                Conclusion<\/b><\/h2>\n

                This completes an overview of the Cleanup plugin in Ephesoft Transact.<\/span><\/p>\n","protected":false},"featured_media":0,"parent":31772,"menu_order":12,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"\nClean Up Plugin | Ephesoft Docs<\/title>\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=\"Clean Up Plugin\" \/>\n<meta property=\"og:description\" content=\"Available: on-premises, cloud This page provides an overview of the Cleanup plugin in Ephesoft Transact. This information is intended for […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/\" \/>\n<meta property=\"og:site_name\" content=\"Ephesoft Docs\" \/>\n<meta property=\"article:modified_time\" content=\"2020-12-11T00:00:45+00:00\" \/>\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=\"2 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\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/\",\"url\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/\",\"name\":\"Clean Up Plugin | Ephesoft Docs\",\"isPartOf\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/#website\"},\"datePublished\":\"2015-03-09T20:38:50+00:00\",\"dateModified\":\"2020-12-11T00:00:45+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/#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\":\"Modules and Plugins\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Export Module\",\"item\":\"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"Clean Up Plugin\"}]},{\"@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":"Clean Up Plugin | Ephesoft Docs","robots":{"index":"noindex","follow":"follow"},"og_locale":"en_US","og_type":"article","og_title":"Clean Up Plugin","og_description":"Available: on-premises, cloud This page provides an overview of the Cleanup plugin in Ephesoft Transact. This information is intended for […]","og_url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/","og_site_name":"Ephesoft Docs","article_modified_time":"2020-12-11T00:00:45+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/","url":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/","name":"Clean Up Plugin | Ephesoft Docs","isPartOf":{"@id":"https:\/\/ephesoft.com\/docs\/#website"},"datePublished":"2015-03-09T20:38:50+00:00","dateModified":"2020-12-11T00:00:45+00:00","breadcrumb":{"@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/clean-up-plugin-2\/#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":"Modules and Plugins","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/"},{"@type":"ListItem","position":6,"name":"Export Module","item":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/"},{"@type":"ListItem","position":7,"name":"Clean Up Plugin"}]},{"@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\/31798"}],"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=31798"}],"version-history":[{"count":0,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31798\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31772"}],"next":[{"title":"CMIS Export Plugin","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/cmis-export-plugin-3\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31785"}],"prev":[{"title":"Copy Batch XML Plugin","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/copy-batch-xml-plugin-2\/","href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/docs\/31796"}],"wp:attachment":[{"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/media?parent=31798"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/ephesoft.com\/docs\/wp-json\/wp\/v2\/doc_tag?post=31798"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}