Customizing the PGP Server Web Email Protection template (Encryption Management Server)
search cancel

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

book

Article ID: 206882

calendar_today

Updated On:

Products

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

Issue/Introduction

The PGP Server (Symantec Encryption Management Server) allows administrators to create custom Web Email Protection Templates. There are three types of customization:

1. Simple

  • This is the most basic form of customization and is easy to do and does not require any specialized html skill. 
  • This allows you to change the default logo and the introductory text on the home page as well as the color scheme.
  • After upgrading PGP Server to a new release, Simple templates are almost certain to work the way they did previously.
  • The limitation with the Simple Template is that your logo is almost certain to clash with the default background. For example:



    The cause of the result above is that the default design uses a logo with a black background:



2. Advanced

  • This is slightly more challenging to implement but is not difficult.
  • It allows you to modify the content (but not the file name) of any of the image files.
  • You can also change the footer, header and CSS (Cascading Style Sheet).
  • After an upgrade, Advanced templates are highly likely but not guaranteed to work the way they did previously.

3. Complete

  • This option can require advanced HTML skills, depending what you are seeking to achieve.
  • It allows you to modify the HTML files themselves and, therefore, add additional image files or change the names of the default image files.
  • It even allows you to add additional languages by creating new *.properties files with the relevant translation text.
    You should always assume that a Complete template will not work the way it did previously after an upgrade.
    This is because there are so many files that are involved and if even only one of the default files was changed by the upgrade, it could cause changes to the appearance or functionality of the custom template.
  • You should therefore always import your Complete template into a test environment that is already running the new release to check that it still works as expected before updating the production PGP Server to the new version.
  • You can then export the template from the test environment and import it to the production environment after the production environment has been upgraded.
  • Because of this additional effort, Complete customization should only be used when absolutely necessary.

Environment

Symantec Encryption Management Server 10.5 and above.

Resolution

If you choose to use a Simple template, ensure that the logo image that you upload has a black background or that the image that you do choose will look acceptable to your business.


If you do not wish to change the background of your corporate logo, you can use an Advanced template.

To use an Advanced template, do the following from the administration console:

  1. Go to Services / Web Email Protection.
  2. Click the Add Template button to open the Web Email Protection Customization page.
  3. Click Continue.
  4. Select Advanced Customization.
  5. Click Next.
  6. Click the Download button to download a zip file called WebMessengerImages.zip containing all the Web Email Protection image files.
  7. Enter a name for the template. This name will be seen only under Services / Web Email Protection.
  8. If you wish to change the Company Name, Login Title or Login Message you can do so at this stage. Otherwise, click Next.
  9. If you wish to change the Header HTML, Left Side HTML, Footer HTML or CSS you can do so.

    By changing the CSS file and, optionally, the Header file, you can remove references to the background images from the header section. See article 238575  for details on how to do this. Otherwise, click Next.

  10. You are prompted to upload a new zip file containing your customized Web Email Protection image files. Since you do not have a new zip file, click Next.
  11. Click the Close button to close the Web Email Protection Customization window.

If you unzip WebMessengerImages.zip you will find that the image files are all in the folder WebMessengerImages\images.

The files that you need to change in order to use a logo that does not have a black background are:

  1. header_bg_left.gif - this is the black background shown behind the logo image.
  2. header_bg_right.gif - this is the blue background shown behind the Symantec logo.
  3. header_logo.gif - this is the default logo shown on the left.
  4. header_pgp_logo.gif - this is the Symantec logo shown on the right.

The file 1611156879723__WebMessengerImages.zip is attached to this article. It contains the above file names but all of them are plain white. If you replace the original files with the ones in the attached zip file and then add your logo to header_logo.gif, you can remove the header background and Symantec logo. Alternatively, you can achieve the same result without changing image files by following the steps in article 238575. You will see a result like this:

 

If you keep the original header_pgp_logo.gif file you will see a result like this:

 

To update an existing Advanced template with new images, do the following:

  1. Ensure all the images (not just the ones you are replacing) are in the folder WebMessengerImages\images.
  2. Zip the WebMessengerImages folder and its subfolders to WebMessengerImages.zip.
  3. From the administration console, go to Services / Web Email Protection.
  4. Click on the name of the template you wish to modify. Note that you cannot modify the active template. You will first need to make another template active.
  5. If you wish to change the Company Name, Login Title or Login Message you can do so at this stage. Otherwise, click Next.
  6. If you wish to change the Header HTML, Left Side HTML, Footer HTML or CSS you can do so. Otherwise, click Next.
  7. On the Upload New Files page, click the Choose File button and upload the WebMessengerImages.zip file.
  8. After the zip file has been processed and validated, click the Close Window button.
  9. Wait for the new template to be replicated to other cluster members. This may take up to 20 minutes.
  10. Make the new template active by clicking on its Active radio button.
  11. Wait for the active template to be replicated to other cluster members. This may take up to 20 minutes.



If you wish to do a Complete Customization, special care should be taken as this requires HTML skills.
The option looks like this:

When working with the templates, keep in mind that there are html parameters that **must not** be left out or modified.  What can typically be modified is the text that shows up for External Users.  This may require modifying multiple files.  For each upgrade, this may need to be done again because new html code may be included in the default customization files.  

Not every upgrade will require making a completely new template, but if you do not do this for each version, you do so at your own risk as new elements can be added.  Symantec Encryption Support always recommends testing the templates thoroughly in a UAT environment prior to actually applying these new templates into production.  

When uploading the customized template, also make note that there is only basic validation of the file/folder structure, and no integrity checks are done on the files themselves.  This means that if you are missing html code from one of the files, but the filename itself is still there, the validation will succeed and the templates will be uploaded, but you may find the template does not work properly.  Templates are expected to be supported by each deployment, and Symantec Encryption Support will review these templates only on a best-effort basis. 

Additional Information

153269 - Symantec Encryption Management Server Web Email Protection Troubleshooting

A Feature Request has been opened with our Product Management Team to be able to customize the templates entirely via the UI.
Symantec Enterprise Division is committed to product quality and satisfied customers. Technical Support filed a Feature Request to add the functionality listed above. This Feature Request is currently being considered by Symantec Enterprise Division to be addressed in a forthcoming version of the product.    

If you would like to have this capability, please reach out to our Symantec Encryption Support team and reference the below IDs to be added:

ISFR-2053
ISFR-2054

There is no guaranteed date for this request from the Encryption Product Management team, or the Encryption Engineering team at this time. Please be sure to refer back to this article periodically as any changes to the status of the request will be reflected here. You can also submit a new ticket to Symantec Enterprise Support to receive a direct update from our team or to have your organization added to the list of companies that desire this Feature Request.

Attachments

1611156879723__WebMessengerImages.zip get_app
Powered by Wolken Software