Communication Planner Upgrade

2410.0

2411.1 (November '24)

No configuration steps. 

Item 1: Update permissions to Standard objects

Because standard objects can’t be included in the permission scanner definitions, you must update some field permissions manually:

1. Navigate to Setup and search for Profiles.
2. Click the Profile or Permission Set for Communication Planner Admin users.

Note: You cannot manually revise a delivered profile (e.g., System Administrator) or permission set (e.g., TX Communication Planner (Admin)). If you have not already, you may have to consider cloning to add these additional updates.

3. Click Object Settings.
4. Select the Contact object and click Edit.
5. Assign Read and Edit access to the following fields:
   • TX_CommPlanner__Has_Alt_Email_Bounced__c
   • TX_CommPlanner__Has_Alt_Email_Bounced_Date__c
   • TX_CommPlanner__Has_Email_Bounced__c
   • TX_CommPlanner__Has_Email_Bounced_Date__c
6. Save your changes. 
7. Repeat for any Integration Users profiles.

Item 2: Update Page Layouts

1. Navigate to Setup and click Object Manager.
2. Select the Contact object, then Page Layouts. 
3. Select Edit next to the appropriate Layout option.
4. Select Fields and drag the new fields onto the page layout:
   • TX_CommPlanner__Has_Alt_Email_Bounced__c
   • TX_CommPlanner__Has_Alt_Email_Bounced_Date__c
   • TX_CommPlanner__Has_Email_Bounced__c
   • TX_CommPlanner__Has_Email_Bounced_Date__c
5. Save your changes.

Item 3: Schedule Jobs (optional)

Schedule Jobs are now available in General Settings. If you haven’t already scheduled these jobs, or wish to make a change, follow these steps:

1. Navigate to the Communication Planner tab.
2. Click Settings (gear icon).
3. Under the General heading, click Schedule Jobs.
4. Start, stop, or schedule each of the following jobs:
   1. Auto Deactivate Campaigns and Tracks
      • This job sets the Status for any Active Campaigns or Tracks to Inactive where the End Date is less than today.
   2. Campaign Sync Retry
      • This job will attempt to sync any Campaigns that do not have a Sync Status of “Success” or any Campaigns with Tracks that do not have a Sync Status of “Success.”
   3. Report Validator
      • This job will email all Org admins if any Tracks are found to have invalid or deleted Reports, which contain details of the Campaign, Track, and report. Reports will then need to be manually undeleted or edited to be valid reports for Communication Planner or the Tracks will need to be updated to select new valid Reports. 

Item 4: Resync Campaigns

A recent backend update has successfully addressed synchronization failures caused by missing SMS Twilio settings. To resolve any remaining synchronization failures, please refer to the article Resolving Sync Failures in Communication Planner.

Item 5: Your Upgrade is Complete

1. No further configuration is required.

Item 1: Verify Page Layouts

Ensure that the Contact Activity visualforce page [TX_ CommPlanner_Contact Activity] is added to your Page Layouts to view email and SMS activity from Comm Planner:

1. Navigate to Setup and select Object Manager.
2. Click the Contact/Student object.
3. Click Page Layouts.
4. Click the Page Layout you use for Students.
5. In the Page Layout Palette, choose Visualforce Pages.
6. Drag the Contact Activity Visualforce page onto the page.
7. Save your changes.

Item 2: Update Permissions to view Contact Activity (optional)

To enable users to view Communication Planner Contact activities, you must provide them with access to the Visualforce Page:

1. Navigate to Setup and search for Profiles.
2. Click the Profile for the user(s) that need to view Contact activities.
3. Click Visualforce Page Access.
4. Click Edit.
5. Locate the TX_ CommPlanner_Contact Activity in Available Visualforce Pages and click the arrow to move it to Enabled Visualforce Pages.
6. Save your changes.

Item 3: Your Upgrade is Complete

1. No further configuration is required. 

Item 1: Update Permissions

Option 1: for anyone who needs to use and manage SMS Inboxes, regenerate the Communication Planner (Standard) permission set to add the new fields added for SMS Inboxes. Note: if you have applied customized permissions to this permission set, you will want to use the manual steps below (Option 2).

1. Navigate to the Permission Scanner tab.
2. Select the Product/Feature = Communication Planner (Standard) and Version = the version you upgrade to (e.g., 2505.x).
3. If you want the process to run in the background, select the checkbox for Use @Future to generate Permission Set.
4. Click the Generate Permission Set button.
5. The updated permission sets will retain the currently assigned users. If needed, you can assign the Permission Sets to additional site users.
6. Repeat for the Admin permission definition:
7. Product/Feature = Communication Planner (Admin) and Version = the version you upgrade to (e.g. 2602.x).
8. Repeat for the Integration user:
9. Product/Feature = Communication Planner (Integration) and Version = the version you upgrade to (e.g. 2602.x).

Option 2: to manually implement these changes to customized permission sets for Standard Users:

1. Navigate to Setup and search for Profiles.
2. Click the Profile of the users who need to use the SMS Inbox.
3. Click Object Settings.
4. Select the SMS Inboxes object and click Edit.
5. Assign Read access to the SMS Inboxes and fields.
6. Save your changes. 
7. Repeat for the SMS Inbox Memberships object and SMS Inbox Phone Numbers object.

To manually implement these changes to customized permission sets for Admin Users: 

1. Navigate to Setup and search for Profiles.
2. Click the Profile of Communication Planner Admin users.
3. Click Object Settings.
4. Select the SMS Inboxes object and click Edit.
5. Assign Read access to the SMS Inboxes and fields.
6. Click Object Settings.
7. Select the SMS Inbox Memberships object and click Edit.
8. Assign Read and Edit access to the SMS Inbox Memberships and fields.
9. Select the SMS Inbox Phone Numbers object and click Edit.
10. Assign Read and Edit access to the SMS Inbox Phone Numbers and fields.

For users who should have access to SMS Inbox and messaging on the Contact page, the user needs to be a member of an inbox and have READ access to the following objects: 

1. Navigate to Setup and search for Profiles.
2. Click the Profile of users who need access to the SMS Inbox on the Contact page.
3. Click Object Settings.
4. Select the SMS Inboxes object and click Edit.
5. Assign Read access to the SMS Inboxes object [TX_CommPlanner__SMS_Inbox__c ] and fields.
6. Repeat for SMS Inbox Memberships [TX_CommPlanner__SMS_Inbox_Membership__c]
7. Repeat for SMS Inbox Phone Numbers [TX_CommPlanner__SMS_Inbox_Phone_Number__c]
8. Select Visualforce Page Access and click Edit.
9. Select TX_CommPlanner.Contact_SMS_Inbox from the Available Visualforce Pages list and add it to the Enabled Visualforce Pages list.
10. Save your changes.

Note: If you wish to have users access SMS Inbox but not manage campaigns in Communication Planner - clone the Communication Planner (Standard) permission set and remove Read access to Campaigns [TX_CommPlanner__Campaign__c] then assign the permission set to the user(s).

Item 2: Update Lightning or Page Layouts

Update the Contact record layout to include the Visualforce page: contact_sms_inbox.

To add the component to your Lightning Layout: 

1. Open a Contact record page.
2. Click the gear icon in the upper right and choose Edit page.
3. Find the Visualforce page in the left-hand menu and drag it into the layout.
4. The recommended height is 700 px.
5. Select Contact SMS Inbox.
6. Save & Activate.

To add the component to your Page Layout:

1. Navigate to Setup and search for Object Manager.
2. Select Contact > Page Layouts.
3. Select Edit next to the appropriate Contact Layout.
4. Select Fields and drag a new Section onto the layout.
5. Enter a Section Name, such as SMS Inbox.
6. Select 2-columns.
7. Select Visualforce Pages and drag the following onto the page layout:
   
   • contact_sms_inbox
   • The recommended height is 700 px.
8. Save your changes.

Item 3: Set up SMS Inboxes

You’ll need to create your SMS Inboxes within the Communication Planner:

1. Navigate to Communication Planner and click the Settings icon (gear).
2. Click SMS, then Inboxes.
3. Click + to create a new Inbox.
4. Enter a Name and select a Messaging Service.
5. In the Phone Numbers section, click + to add phone numbers. You can add multiple phone numbers.
6. Indicate if you want to Enable Email Notifications and, if enabled, select a Notification Timer.

Item 4: Your Upgrade is Complete

1. No further configuration is required. Proceed to the Events Upgrade.