2020 Email Editor: Filter Template Folders

This document contains instructions on how to set up filtering folders within the BH4SF Email Editor.

Prerequisites

  • The email provider is set up.
  • To have the necessary permissions to administer email template folders and email page types, make sure your admin user has the Message Channels Admin permission set assigned.
  • To have the necessary permissions to use the BH4SF Email Editor with the ability to filter template folders, make sure your users have the Email Editor User permission set assigned.
  • Update page layouts as necessary by completing the following steps:

    1. Go to Setup > Object Manager.

    2. Open the Email Page Type object, then open Page Layouts.

    3. Open Email Page Type Layout.

      1. Drag and drop the Email Page Type Name, Page Type, Email Type, and Email Template Folders fields into the information section.

      2. Click Save to overwrite the layout changes.
    4. If leveraging Campaigns for email sending, open the Campaign Template Mapping object, then open Page Layouts.

      1. Open Campaign Template Mapping Layout.

      2. Drag and drop the following fields into the information section: Available Languages, Campaign Unique Name, Email Template Folders, Email Editor Template Name, Email Editor Template Label, Email Template Unique Name, and Use Personalization Strings.
      3. Click Save to overwrite the layout changes.
  • Verify Email Page Types:
    1. Go to App Launcher > Email Page Types.
    2. Confirm the following email page types exist:
      • ATSv2 - Internal Interview (API Name: InternalInterview)
      • ATSv2 - Send Email (API Name: SendEmail)
      • ATSv2 - SendOut Schedule (API Name: SendOutSchedule)
      • ATSv2 - Submit With Email (API Name: SubmitWithEmail)
      • CV Manager - Share CV (API Name: ShareCV)
      • Call List - Candidate Marketing (API Name: MarketingCallList)
      • Call List - Standard (API Name: StandardCallList)
      • Job Lead Email (API Name: JobLeadEmail)
      • Long List (API Name: LongList)
      • Registration Interview (API Name: RegistrationInterview)
      • Rejection Email (API Name: Rejection)
      • TextKernel Sam Email (API Name: TextKernelSamEmail)
      • Unrejection Email (API Name: Unrejection)

      If some of the default email page types are missing, run the following Apex script in the Developer Console:

      TR1.Utility.createDefaultEmailPageTypes();

      After refreshing the list of email page types, the missing records for the main OOTB email page types should appear.

Set Up Filtering Template Folders

Customize the Folder List

The Email Template Folders fields on Email Page Type and Campaign Template Mapping refer to the same global picklist value set called Email Template Folders. To manage its picklist values and add new folder options according to business needs:

  1. Go to Setup > Picklist Value Sets.
  2. Find and open Email Template Folders.
  3. Add new values as needed.

Important:

  • For AWS/Salesforce/SFMC (BH4SF preview based on Salesforce Classic Email Templates), the added picklist value for the new folder must equal the API Name of the Salesforce Folder where the Classic Email Templates are stored.
  • To avoid breaking filtering of the OOTB default email page types, do not edit these OOTB picklist values:
    • My Personal Email Templates
    • Unfiled Public Email Templates
    • Closing Report Email Templates
    • Job Manager Templates
    • Talent Rover Email Templates.

Specify Email Folders for Email Templates

For AWS/Salesforce/SFMC (BH4SF preview based on Salesforce Classic Email Templates)

The folder filtering relies on Salesforce Email Folders. Complete these steps:

  1. Go to Setup > Email > Classic Email Templates.
  2. Click New Folder if new folder options should be created.
  3. Modify existing email templates by specifying the Folder field.

For SFMC Message Preview

  1. Go to App Launcher > Campaign Templates Mapping.
  2. Click on any record representing an email template that needs to be configured.
  3. Edit the Email Template Folders field and select the folders under which the current email template should appear. Typically, a template exists within only one folder.
  4. Click Save to save the Campaign Template Mapping record.

Make sure that Campaign Template Mapping records corresponding to the affected email templates exist and are linked to the desired folders.

How the folder filtering is applied within the BH4SF Email Editor (for SFMC email provider):

Enable Folder Filtering Per Email Page Type

To enable the filtering template folders per email page types:

  1. Go to App Launcher > Email Page Types.
  2. Click on any record that needs to be configured.
  3. Edit the Email Template Folders field and select the folders under which email templates related to the current email page type should appear.
  4. Click Save to save the email page type record.

If everything is configured correctly, the BH4SF Email Editor will display within the Template selector only those email templates that are part of the defined template folders specified for the configured email page type.

If the Email Template Folders field on the Email Page Type record is empty, folder filtering is disabled within the BH4SF Email Editor for this email page type.

Use Custom Email Page Types

If the BH4SF Email Editor is used outside of the BH4SF package (e.g., via the exposed component), you can pass any standard or custom email page type name through an attribute by setting the value of the emailPageType attribute. Examples include:

  • TR1:eML_Email LWC component
  • TR1:GlobalEmailEditor Visualforce component
  • GlobalEmailEditor Lightning component available for app pages

In this case, the BH4SF Email Editor will apply folder filtering based on settings defined at the passed Email Page Type record. To create a custom email page type with custom folder filtering:

  1. Go to Setup > Object Manager > Email Page Type (API Name: TR1__Email_Page_Type__c).
    1. Click Fields & Relationships.
    2. Open the Page Type field.
    3. Add a new picklist value and click Save.
  2. Go to App Launcher > Email Page Types.
    1. Click New.
    2. Enter the Email Page Type Name.
    3. Select the Page Type (the new value added in the previous step).
    4. Select folders on the Email Template Folders field.
    5. Optionally, populate the Email Type field if the record should be linked to a specific email type.
    6. Click Save.
  3. Optional, for SFMC email provider only.
    1. Go to App Launcher > Campaign Templates Mapping.
    2. Create a new or update an existing record's Email Template Folders field with one of the same folders specified on the new custom Email Page Type record in Step 2.
  4. When instantiating the TR1:eML_Email LWC component, pass the value of the newly added Page Type (API name of new picklist value added in Step 1) to the emailPageType attribute.