Communication Planner Upgrade

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

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.

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: Update Twilio Messaging Service(s)

After you set up your inboxes, you must configure the following setting in Twilio for each Messaging Service you use so that incoming responses are directed to the Communication Planner SMS Inbox.

Notes:

• If you use the same messaging service for both Communication Planner and TX SMS, updating the Twilio Webhook will direct incoming messages to Comm Planner and no longer send them to TX SMS.
• If you have a TargetX Managed Twilio account please reach out to support to complete this step

1. Log in to Twilio.
2. On the Develop tab in the left pane, choose Messaging > Services.
3. Use the Search by SID to locate the relevant messaging services.
4. Click the name of the Messaging Service.
5. Choose Integration on the left navigation panel.
6. Ensure the Send a webhook option is selected.
7. In the Request URL field, paste the following URL, replacing the ORG_ID_HERE with your 18-digit Organization ID:
   
   https://ws-prod-ag.targetxucp.com/webhook/api/v1/message-inbound?org_id=ORG_ID_HERE
   

Item 5: Your Upgrade is Complete

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

Item 1: Update Permissions

1. Navigate to Setup and search for Profiles.
2. Click the Profile of the users who need to view the Recipient Interactions.
3. Click Object Settings.
4. Select the Recipient Interactions object and click Edit.
5. Assign Read access to Recipient Interactions and fields.
6. Save your changes.

Item 2: Update Lightning or Page Layout

Update the Contact record layout to include the Related List - Recipient Interactions.

To add the related list to your object-level 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 Related Lists and drag Recipient Interactions onto the page layout.
5. Define the Properties as needed.
6. Save your changes.

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 Related Lists - Single in the left-hand menu and drag it into the layout.
4. Select Recipient Interactions.
5. Verify the fields you would like to see within the related list. 
6. Save and Activate.

Item 3: Update Time Zone field (optional)

If you have the Communication Planner package installed but have not activated sending through TargetX, a salesforce error message may be sent to the admin installing the package. If the error is sent to your admin, you need to update the values in the Time Zone field of the Track object manually: 

1. Navigate to Setup and select the Object Manager.
2. Locate the Track object.
3. Click Fields & Relationships and click the Timezone field.
4. Scroll to the Values section, and Edit the following:
   
   • Update the Alaska label:  Alaska Time (AST) to Alaska Time (AKT).
   • Update the Hawaii time zone API Name from America/Adak to Pacific/Honolulu.

Item 4: Your Upgrade is Complete

1. No further configuration is required. 

Item 1: Configure Track Membership for Parents

If you wish to record Track Membership for parents, you may do so. Complete these steps  to enable upsyncing of parent data:

1. Navigate to Setup and select Object Manager.
2. On the Track Member object: TX_CommPlanner__Track_Membership__c
3. Create a new field: lookup.
4. That field must have an API name of Relationship__c and looking up to the TargetX custom object: (Relationship (v1)) -  Target_SRMb__Family_Relationship__c 

Note: by default, this field is assigned the API name Relationship_V1__c. Rename the API name to Relationship__c to enable successful synchronization.
Save.

Track membership will be recorded and associated with the Relationship object.

• Sync occurs only if the RM/Base packages are installed; if they are not, Relationship V1 is not synced.
• Membership syncing applies only to “Parent” relationships when sending to Contacts + Parents or Parents only, where Parent is defined as Mother, Father, Legal Guardian, Parent, or Other.  

Item 2: Update Page Layouts for Track Membership and SMS Undelivered

Update the Contact record layout to include the Related List - Track Membership and the SMS Undelivered fields.

To add the related list and fields to your object-level 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 Related Lists and drag Track Membership onto the page layout.
5. Define the Properties as needed.
6. Select Fields and search for SMS Undelivered.
7. Drag the 3 new fields onto the page layout:
   
   • Comm Planner SMS Undelivered
   • Comm Planner SMS Undelivered Date
   • Comm Planner SMS Undelivered Reason
8. Save your changes.
9. Repeat for the Relationship (v1) object.

To add the component and fields 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 Related Lists - Single in the left-hand menu and drag it into the layout.
4. Select Track Membership.
5. Verify the fields you would like to see within the related list. 
6. Click the Fields tab and search for SMS Undelivered.
7. Drag the 3 new fields onto the page layout:
   
   • Comm Planner SMS Undelivered
   • Comm Planner SMS Undelivered Date
   • Comm Planner SMS Undelivered Reason
8. Save and Activate.
9. Repeat for the Relationship (v1) lightning layout.

Item 3: Update Permissions for Track Membership

The Track Membership feature requires the following updated permissions:

Option 1: Regenerate the Communication Planner permission sets

1. Navigate to the Permission Scanner tab.
2. Select the Product/Feature = Communication Planner (Admin) and Version = the version you are upgrading to (e.g. 2609.x).
3. Select the checkbox for Use @Future to generate the Permission Set if you want to have the process run in the background.
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 users.
6. Repeat for the following Product/Features:
   
   • Communication Planner (Standard)
   • Communication Planner (Integration)

Option 2: Manually implement permission changes to customize Profiles or Permission Sets

Integration user 

1. Navigate to Setup and search for Profiles.
2. Click the Profile or Permission Set for your Integration User.

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

3. Click Object Settings.
4. Select the Track Members object and click Edit.
5. Assign Read and Edit access to the following fields:
   
   • Campaign Name [TX_CommPlanner__Campaign_Name__c]
   • Contact [TX_CommPlanner__Contact__c]
   • Created By [CreatedById]
   • First Delivered Date [TX_CommPlanner__Delivered_Date__c]
   • Integration ID [TX_CommPlanner__Track_Integration__c]
   • Last Modified By [LastModifiedById]
   • Lead [TX_CommPlanner__Lead__c]
   • TargetX_SRMb__Family_Relationship__c [Relationship__c] (the Lookup field you created in Item 1)
   • Track [TX_CommPlanner__Track__c]
   • Track Member Name [Name]
   • Track Name [TX_CommPlanner__Track_Name__c]
   • Track Type [TX_CommPlanner__Track_Type__c]
6. Save your changes. 

Admin User

1. The delivered Admin Permission set (TX_Communication_Planner_Admin) has create/read/edit/delete access to the Track Members object [TX_CommPlanner__Track_Membership__c] and all fields (added upon install).

Standard User

1. Navigate to Setup and search for Profiles.
2. Click the Profile or Permission Set for your Standard Users.

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

3. Click Object Settings.
4. Select the Track Member object and click Edit.
5. Assign Read access to the following fields:
   
   • Campaign Name [TX_CommPlanner__Campaign_Name__c]
   • Contact [TX_CommPlanner__Contact__c]
   • Created By [CreatedById]
   • First Delivered Date [TX_CommPlanner__Delivered_Date__c]
   • Integration ID [TX_CommPlanner__Track_Integration__c]
   • Last Modified By [LastModifiedById]
   • Lead [TX_CommPlanner__Lead__c]
   • TargetX_SRMb__Family_Relationship__c [Relationship__c] (the Lookup field you created in Item 1)
   • Track [TX_CommPlanner__Track__c]
   • Track Member Name [Name]
   • Track Name [TX_CommPlanner__Track_Name__c]
   • Track Type [TX_CommPlanner__Track_Type__c]
6. Save your changes. 

Item 4: Update Permissions for Unknown Inbound Messages

Users who need to create contacts from unknown inbound messages will need access to create new Contacts.

1. Navigate to Setup and search for Profiles.
2. Click the Profile or Permission Set for Users that should be able to create contacts from unknown inbound messages.
3. Click Object Settings.
4. Select the Contact object and click Edit.
5. Assign Edit access to the Contact object.
6. Save your changes.
   

Item 5: Your Upgrade is Complete

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