Backing up and restore Symantec Web Email Protection customization templates
search cancel

Backing up and restore Symantec Web Email Protection customization templates

book

Article ID: 178593

calendar_today

Updated On:

Products

Desktop Email Encryption Drive Encryption Endpoint Encryption File Share Encryption PGP Command Line PGP Key Management Server PGP Key Mgmt Client Access and CLI API PGP SDK Encryption Management Server Gateway Email Encryption PGP Encryption Suite

Issue/Introduction

 The PGP Encryption Server has the ability to use Web Email Protection Templates for a highly customized end-user experience when using secure email delivery.  This article will show you how to backup your Web Email Protection Templates.

Resolution

This article describes how to use the Encryption Server administrative interface to backup your existing Symantec Web Email Protection customization templates and how to restore them.

Symantec recommends backing up your Symantec Web Email Protection customization templates before you upgrade the PGP Encryption Server so that you can restore them if they become corrupted during the upgrade.

Generally the templates are not corrupted, but when there are different requirements for the customizations, such as when new functionality gets included for Web Email Protection, this also changes the template requirements.
This is why the templates should be redone on each version.  At the very least, test the upgrade before you do so, to ensure the templates are at least not breaking.
It is only supported to build new templates before each upgrade, so if you choose to not test your templates before the upgrade, support for these template issues are on a best-effort basis. 

To back up Symantec Web Email Protection customization templates

  1. Launch the PGP Encryption Server administrative interface.
  2. Navigate to the Services > Web Email Protection tab.
  3. In the Customization panel, click the download button next to the customization template that you want to back up.

    Note: You cannot download Simple Customization templates.
     
  4. Save the exported .zip file to a safe location.
  5. Repeat the process for any other customization templates that you want to back up.

Notes:

  • You can only backup Advanced Customization templates and Complete Customization templates.
  • The downloaded .zip file for an Advanced Customization template contains only the custom image files that are used in the template.
     

To restore backed up Complete Customization templates

Use the following procedure to restore Complete Customization templates.

Note: You must troubleshoot corrupted Advanced Customization templates manually. For information about troubleshooting customization templates, refer to the PGP Encryption Server Administrator's Guide.

  1. Launch the PGP Encryption Server administrative interface.
  2. Navigate to the Services > Web Email Protection tab.
  3. In the Customization panel, click Add Template…

    Note: You can restore only one customization template at a time. Repeat this procedure for each customization template that you want to restore.
     
  4. In the Web Email Protection Customization dialog box, click Continue to accept the terms of the Symantec Web Email Protection Customization Notice.
  5. On the Customization Option page, select Complete Customization and click Next. On the Download Customization page, click Next.
  6. In the Template Name section, enter the name of the customization template that you are restoring.
  7. In the General Text section, provide the following optional information:
     
    • Your Company Name, if you want it to appear on the Secure Messaging Settings screen.
    • A Login Title, which appears at the top of the login screen.
    • A Login Message, which is displayed to users on the login page.
       
  8. Click Next.
  9. On the Upload New Files page, click Browse.
  10. Navigate to and select the .zip file for the customization template that you want to restore.
  11. To begin uploading the file, click Next.
  12. When the upload is complete, click Close Window to close the Web Email Protection Customization dialog box.

The Web Email Protection tab reloads automatically, and the restored customization template appears in the list of templates.

 

Important Note: Whenever the PGP Encryption Server is upgraded to a newer version, the Web Email Protection templates must be redone. 
Doing this in a test environment is a good way to test this process to ensure the newly-created template will work in production. 
Restore only tested templates.  Even if you backed up your previous template, if it was created on an older version of the PGP Encryption Server, it may not work and may need to be redone.

For more information on how to configure templates, see the following article:

206882 - Customizing the PGP Encryption Server Web Email Protection template (Encryption Management Server)

Additional Information

Powered by Wolken Software