› Modules and plugins › Export module › Cleanup plugin

Cleanup plugin

This topic provides an overview of the Cleanup plugin in Transact.

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.

Specifically, this plugin uses the batch instance identifier (BI ID) to remove all contents from the following locations:

  • BI folder in SharedFolders.

    [Ephesoft_Directory]\ SharedFolders\ephesoft-system-folder\<BC ID>\<BI ID>

  • BI folder on the Local system (if enabled).

    <Local Folder Path> \<BI ID>

  • BI SER file from the Local system (if enabled).

    <Local Folder Path> \<BI ID>\<BI ID>.ser

To prevent issues with the workflow execution, the Cleanup plugin must be the final plugin in the workflow.

When the Cleanup plugin runs, the batch is set to the FINISHED state, and it is deleted from the server and can no longer be restarted.

Configure the Cleanup plugin

This topic provides the information on how to configure the Cleanup plugin. This plugin only needs to be configured once per batch class.

  1. From the Batch Class Management page, select and open your batch class.
  2. Go to Modules > Export > CLEANUP.
  3. Configure the Delete System Folder Information field according to your workflow needs.

    • TRUE: Deletes the BI folder and BI SER file from the Local system (default).

    • FALSE: Only deletes the BI folder in SharedFolders.

  4. Click Apply.

Troubleshooting

Error message

Possible root cause

Unable to delete folder

Folder cannot be deleted due to one of the following reasons:

  • It is locked by another process
  • It is open by another user

Not enough permission to delete folder

Security exception occurred. The user or process does not have rights to delete the folder.