Transact

  1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Modules and Plugins
  6. Export Module
  7. Clean Up Plugin

Clean Up Plugin

Available: on-premises, cloud

Overview

This plugin is used to delete system files and UNC folder data once all the processing on the batch is complete. This plugin also removes all the content associated with a particular batch instance. and associated batch content is also removed.

Steps of execution

    • This plug-in ideally works after the export phase of the application when all the processing on the batch has been done and desired results have been exported.
    • The plug-in takes the identifier of a batch instance and removes all the contents and it’s sub-files from the following paths:
      • <SHARED_FOLDER_PATH><BATCH_CLASS_UNC_FOLDER><BATCH_INSTANCE_FOLDER_NAME>: This folder is deleted always.
      • <LOCAL_FOLDER_PATH><BATCH_INSTANCE_IDENTIFIER>: This folder is deleted only if plugin configuration “Delete System Folder Information” is “TRUE”.
      • Also deletes “<BATCH_INSTANCE_IDENTIFIER>.ser” file from the <LOCAL_FOLDER_PATH> properties folder. This file is deleted only if plugin configuration “Delete System Folder Information” = TRUE.

Configuration

Configuration screenshot

Configurable Properties

Following are the list of configurable properties for the plugin:

Configurable propertyType of valueValue optionsDescription
Delete System Folder InformationList of values
  • TRUE(Default)
  • FALSE
Defines whether or not the “<Local folder><Batch instance>” folder and its contents are to be deleted or not.

Dependency

  • The plugin depends on “IMPORT BATCH FOLDER” as it considers a batch to be imported first before its associated files are cleaned up.
  • This plugin should ideally occur in the workflow only once and it is not mandatory that this plugin should keep it in last in export module. We can place it at any position.
  • The plugin assumes the extraction for the incoming batch has been done properly and just changes the results of provided batch.xml in a desired format.

Troubleshooting

Following are few common error messages seen due to malfunctioning of the plugin:

Error messagePossible root cause
Unable to delete FolderFolder could not be deleted. Due to one of the following reasons:

  • It is locked by some other process
  • It is opened by user on explorer
Not enough permission to delete folderSecurity exception occurred. The user/process/JVM does not have sufficient rights to delete the folder to be cleaned.

 

 

Articles

Was this article helpful to you? Yes No