We use cookies on our website to ensure we provide you with the best experience on our website. By using our website, you agree to the use of cookies for analytics and personalized content.This website uses cookies. More Information
It seems like your browser didn't download the required fonts. Please revise your security settings and try again.

Barracuda PST Enterprise Script Support

  • Last updated on

This article refers to the Barracuda PST Enterprise version 5.1 or higher.

Use scripting to customize Barracuda PST Enterprise and the Barracuda PST Enterprise Client.

PST Enterprise Scripting

You can override the policies that are applied to PST files by writing a custom script located in the installation directory under the Scripts folder, by default C:\Program Files (x86)\Barracuda\PSTEnterprise\Scripts. Within the Scripts folder, locate the sample file PolicyOverrideScript_Sample.vbs. Use this file as a starting point for your own scripts. To enable scripting, rename the file to PolicyOverrideScript.vbs; the sample file is for information only and is not executed.

The script is called whenever a PST file is processed and allows you to control whether to apply an alternative policy to a PST file, ignore it, or use the originally defined policy. For example, you want to place certain PST files on legal hold and prevent them from being processed by PST Enterprise. The script is called with two parameters Machine and PstPath, and returns a string that indicates what you want to do with the current PST file.

Include business logic within the script and use the return value to control what you want to do with the current PST file. The valid return values are as follows:

  • Return the name of a Policy you’d like the PST Enterprise Client to use. This overrides the Policy configured within the PST Enterprise website.
  • Return "*" to indicate that no policy be applied to this PST file.
  • Return "=" to indicate that the default currently assigned policy be applied to the PST.

PST Enterprise Client Scripting

When PST files are discovered by the PST Enterprise Client, information about the PST is passed back up to the PST Enterprise server and stored within a SQL database. You can add additional information to the SQL database by using a script that is executed on the client machine.

A sample script AddPstDataScript_sample.vbs is located under the installation directory, by default C:\Program Files (x86)\Barracuda\PSTEnterprise\PSTEnterpriseClient\Scripts. You must rename this file to AddPstDataScript.vbs to enable scripting as the sample file is for information purposes only and is not used.

The script is automatically called whenever the PST Enterprise Client uploads information about the currently processed PST. The script is called with two parameters Machine and PstPath, which give you information about which PST and client machine the script is running against. Based on this information, you then return a string of custom data that you want to be associated with this PST file. This custom data is then stored within the SQL database.

Last updated on