Updating TargetX for Enhanced Domains

Payment Connectors

Listed below are the Payment connectors that need to be updated manually to work with Enhanced Domains. The list outlines the name of the URL field that should be updated and includes notes about what to update on the vendor side, if applicable. 

Email Templates 

You need to run a process to scan existing Email Templates to identify all occurrences where old URLs are used for both Salesforce Classic Email Templates and TX Email Templates that have URLs. Suppose you've coded entire email templates or sections and have included HTML-encoded characters in the domain portions of your URLs. In that case, you must double-check the URLs manually, following the Salesforce guidelines for URL format changes. See TargetX Enhanced Domains for TargetX Tools video [10:05, 20:10]

If you do NOT have the Email package, go to Email Template update for Institutions that do NOT use the TargetX Email package.

If you wish to run the scan/update in a sandbox, you must update all Contact emails to INVALID addresses and then update the Email Deliverability Settings in your sandbox:

1. Navigate to Setup and search for Deliverability.
2. Set the Access Level to All email
3. Save your changes.

For additional information, see Testing emails in a sandbox instance.

Notes:

• We have successfully tested the audit/update tool with approximately 10,000 Salesforce URLs in Email Templates.
• A System Administrator must run these audits and updates as they need access to all the objects impacted.
• This process could take several hours to run. You can check the job status by navigating to Setup and searching for Apex Jobs.
• This tool can be run in "audit" mode regardless of whether Enhanced Domains is enabled. You can run the audit scan before enabling Enhanced Domains. You can only Perform Updates if Enhanced Domains is enabled.

1. Navigate to Email Preferences.
2. Locate the Enhanced Domains: Email Template URL Update section.
3. You should first audit the Email Templates to review which URLs will be updated:
   1. Verify the Email Address to Notify and click Scan Email Template URLs.
4.  The email address specified will receive CSV files with details on URLs that will be updated. 
   1. TXEmailBuilderTemplate: This file shows what URLs are affected in your XBuilder templates. Rows in the file with Location = "Configuration" can be filtered out; they represent other places XBuilder URLs are stored in your org and are only relevant if there are errors when you perform the updates.
   2. SalesforceEmailTemplate: This is relevant ONLY for email templates built within Classic Email Templates. For example, templates created for Salesforce workflow alerts.
   3. LegacyEmailContentBlock: This is relevant for conditional content blocks built in the legacy email builder.
   4. The Status will be listed as Found.
   5. If nothing is found for an update, the email will read, "Your Email Templates do not contain any URLs that need conversion for Enhanced Domains."
5. Review the list and, if correct, proceed to perform the updates:
   1. Verify the Email Address to Notify, check the Field Perform Updates checkbox, and click Scan Email Template URLs.
   2. If the checkbox to Perform Updates is disabled, you have not enabled Enhanced Domains.
6. The email address specified will receive an email with a CSV file of any/all Email Template URLs that were updated.
   1. The Status will be listed as Updated.
   2. If nothing is found for an update, the email will read, "Your Email Templates do not contain any URLs that need conversion for Enhanced Domains."
7. The Batch Size will default to 200. Changing the Batch Size should only be done in cases where the URL Scanner will not run with default settings.

Note: If the process encounters an error, the email report will list a Status of Error, and the Message column will provide details on the error.

Base/Communities 

During the August ’22 Base install, a script runs to update Community Theme Related Site records to the Enhanced Domain format; for any record with a URL in the old format, the system will clone the record and use the Enhanced Domains URL format. The updated record will be named <Site Name> (Enhanced Domain):

• A new record will only be created if the existing record uses the old URL format AND there is no record for that site in the Enhanced Domain format.
• You can check the job status by navigating to Setup and searching for Apex Jobs (Apex Class = baseSettingsController).
• If an error occurs, a record will be created in TargetX Logs.
• You can re-run the job by navigating to Base Custom Settings. Under the Enhanced Domains: Community Theme Sites Update section, click Update Community Theme Sites:

Note: A System Administrator must run these updates as they need access to all the objects impacted.

Portals 

If you have Portals, you must run a process to audit existing Portals, identify all occurrences where old format URLs are used, and then run the process to update the URLs. You must first install the latest Base package.

Notes:

• These audits and updates must be run by a System Administrator as they need access to all the objects impacted.
• This tool can be run in "audit" mode regardless of whether Enhanced Domains is enabled. You can run the audit scan before enabling Enhanced Domains. You can only Perform Updates if Enhanced Domains is enabled.

1. Navigate to Base Custom Settings.
2. Locate the Enhanced Domains: Portal URL Update section.
3. You should first audit the Portals to review which URLs will be updated:
   1. Verify the Email Address to Notify and click Scan Portal for URL.
4. The specified email will receive an email with a CSV file of any/all Portal URLs that will be updated. 
   1. The Status will be listed as Found.
   2. If nothing is found for an update, the email will read, "Your Student Portals do not contain any URLs that need conversion for Enhanced Domains."
5. Review the list and, if correct, proceed to perform the updates:
   1. Verify the Email Address to Notify, check the box Perform Updates checkbox and then click Scan Portal for URL.
   2. If the checkbox to Perform Updates is disabled, you have not enabled Enhanced Domains.
6. The email address specified will receive an email with a CSV file of any/all Portal URLs that were updated.
   1. The Status will be listed as Updated.
   2. If nothing is found for an update, the email will read, "Your Portals do not contain any URLs that need conversion for Enhanced Domains."
7. The Batch Size will default to 5. Changing the Batch Size should only be done in cases where the URL Scanner will not run with default settings.

Note: If the process encounters an error, the email report will list a Status of  Error and the Message column will provide details on the error.

Events 

If you use Events, you must run a process to audit your Events for old format URLs and then run the process to update the URLs to the Enhanced Domain format. You must first install the TargetX Events package version 2208.4. This process will only scan records where the Event End Date Time exceeds the current date/time.

Notes:

• A System Administrator must run these audits and updates as they need access to all the objects impacted.
• This tool can be run in “audit” mode regardless of whether Enhanced Domains is enabled. You can run the audit scan before enabling Enhanced Domains. You can only Perform Updates if Enhanced Domains is enabled.

1. Navigate to Events Custom Settings.
2. Locate the Enhanced Domains: Org Event URL Update section.
3. You should first audit Events to review which URLs will be updated:
   1. Verify the Email Address to Notify and click Scan Org Event for URL.
4. The specified email will receive an email with a CSV file of any/all Portal URLs that will be updated. 
   1. The Status will be listed as Found.
   2. If nothing is found for an update, the email will read, “Your Events do not contain any URLs that need conversion for Enhanced Domains.”
5. Review the list and, if correct, proceed to perform the updates:
   1. Verify the Email Address to Notify, check the Field Perform Updates checkbox, and click Scan Portal for URL.
   2. If the checkbox to Perform Updates is disabled, you have not enabled Enhanced Domains.

Note: If the process encounters an error, the email report will list a Status of Error, and the Message column will provide details on the error.

Community Theme Custom CSS 

If you have Custom CSS on your Community Theme records, you must update any URLs manually.

1. Navigate to the Community Themes tab.
2. Select Edit on the Theme you need to review.
3. In the Custom CSS field, scan the code for any URLs. 
4. You can refer to the Salesforce Help and Training article My Domain URL Format Changes When You Enable Enhanced Domains for guidance on formatting URLs.
5. In the Applicant Dashboard Events URL field, review the code for the Events site and update to the new Enhanced Domain format.
6. Save your changes.
7. Repeat for all your Community Theme CSS records.

TX Forms records

If you use TX Forms, you will need to manually review and update the links used for the images and redirect link in each form. See TargetX Enhanced Domains for TargetX Tools video[27:08]

1. Navigate to the TargetX Builder tab. 
2. Select the TX Forms tile. 
3. Click the three dots on the right, and then click Edit for the first form you choose to review. 
4. Review the values in the Logo URL and Poster URL fields for static resource or file image URLs. 
5. Review the value in the Redirect URL for any Salesforce URL values (e.g. redirect to an event, community, etc.) 
6. You can refer to the Salesforce Help and Training article My Domain URL Format Changes When You Enable Enhanced Domains for guidance on formatting URLs. 
7. Save your changes. 
8. Repeat for all your TX Form records. 

Engage Room records

If you use Engage, you must manually review and update the site URL and poster URL fields. See TargetX Enhanced Domains for TargetX Tools video [28:56]

1. Navigate to the TargetX Builder tab. 
2. Navigate to the Engage tab to view the Advisor Center. 
3. Click the arrow to enter the first room you choose to review. 
4. Click the gear in the top right corner to enter the Room Settings. 
5. Update the SITE URL field as follows: https://XXX.my.salesforce-sites.com/engage, updating the XXX with your custom domain. 

Example: https://myschool.my.salesforce-sites.com/engage 

1. Review the POSTER URL field for static resource or file image URL. 
2. You can refer to the Salesforce Help and Training article My Domain URL Format Changes When You Enable Enhanced Domains for guidance on formatting URLs. 
3. Click Update to save your changes. 
4. Repeat for all your Engage Room records. 

DecisionLetter visualforce 

If you use Decision Letters, you should validate your Decision Letter and update any URLs that may be included in your letter.

1. Navigate to Setup and search for Visualforce Pages.
2. Click your Decision Letter Visualforce page.
3. Review the page for any URLs and update to the new Enhanced Domain format as needed.

Group Assignment Remote Sites 

For Group Assignments to be updated or migrated correctly, you will need to update the SandboxVF and ProdVF Remote Sites:

1. Navigate to Setup and search for Remote Site Settings.
2. Click Edit for the Remote Site Name = GAS_SandboxVF
3. Update the Remote Site URL as follows, replacing the xxxx with your Target Org's my domain:https://xxxx--targetx-base.vf.force.com
4. Click Edit for the Remote Site Name = GAS_ProdVF
5. Update the Remote Site URL as follows, replacing the xxxx with your Target Org's my domain:https://xxxx--targetx-base.vf.force.com
6. Save your changes. 

Retention Remote Sites 

If you have the Retention package, you’ll need to update your Remote Site Settings:

1. Navigate to Setup and search for Remote Site Settings.
2. Click Edit for the Remote Site Name = MDAPI.
3. Update the Remote Site URL: https://XXX--tgtx-retention.vf.force.com, updating theXXXwith your custom domain.

Example: https://myschool--tgtx-retention.vf.force.com

5. Check the Active checkbox.
6. Save your changes.

Form Assembly 

You must update the notification redirect for your Form Assembly event forms, or your forms will break. For information on setting the redirect for Event Registration in Form Assembly, see Setting the Redirect for Event Registration In Form Assembly.

ReCaptcha

If you are using reCAPTCHA, you must add your new Domains to the CAPTCHA setup. See TargetX Enhanced Domains for TargetX Tools video [13:26]:

Surveys

If you are using Surveys, you must update the formula field on the Survey Response object:

1. Navigate to Setup and select Object Manager.  Select the Survey Response object.
2. Under Custom Fields & Relationships, locate the Survey Summary Report field.
3. Edit the Formula to replace your custom domain in place of XXXX:

HYPERLINK('https://XXXX.my.salesforce.com/apex/surveyResponsesSummary?id=<<Survey Id>>','<<Enter Name for Link>>')