Skip to main content

Return to TX Community

Liaison

Communication Planner Upgrade

The Communication Planner is currently unavailable for UK & EU clients but will be available soon!

Step 1 - Record the Current Package Version 

​Prior to upgrading, you will need to find and record your currently installed version:

  1. Navigate to Setup > Installed Packages
  2. Search for TX_CommPlanner
  3. Record your current version number

Note: ​if your current version is 2505.0 you are on the most recent package and should proceed to the Events Upgrade.

Step 2 - Install the Upgraded Package  

This is your "ending version" (i.e., the version you want to upgrade to). You can select any version that's higher than your current package version. Packages are cumulative, meaning the upgraded package you select includes all features from previous packages. For example, if you're upgrading from Package A to Package D, that package includes all features from Packages B and C. 

  1. Navigate to TargetX Recruitment Suite: Admin Group or TargetX Retention Suite: Admin Group to select and obtain the upgraded package. 
  2. Choose "Install for Admins Only.
    • Remember to update the appropriate Profiles and Permission Sets if additional security is required.

Step 3 - Complete Additional Configurations  

After installing the upgraded package (i.e., the ending version), you must complete additional configuration steps to ensure all functionality is available. Use the following chart to complete the additional configurations. Identify your starting package and your ending package, then complete all configurations steps in between. For example, if your starting version is xxxx.1 and you're upgrading to xxxx.4, you'll need to complete all configuration steps for xxxx.2, xxxx.3, and xxxx.4.

Starting Version

This is the version you currently have installed, as Identified in Step 1.

Ending Version

This is the upgrade you are installing, as selected in Step 2.  

Configuration Steps by Release

These are the steps you need to complete, from the starting version to the ending version. For example, if your starting version is 2205.0 (May '22) and you're upgrading to 2208.6 (August '22), you'll need to complete the configuration steps for 2206.3 (June '22), 2207.0 (July '22), and 2208.6 (August '22)

2410.0

2411.1 (November '24)

No configuration steps. 

2411.1 2412.0 (December '24) No configuration steps. 
2412.0 2502.0 (February '25) No configuration steps. Proceed to the Events Upgrade.
2502.0 2505.0 (May '25)

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.

  1. Click Object Settings.
  2. Select the Contact object and click Edit.
  3. 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
  4. Save your changes. 
  5. Repeat for any Integration Users profiles.

Item 2: 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 3: Resync Campaigns

A recent backend update has resolved Sync failures due to missing SMS Twilio settings:

If you were affected by Sync failures

If you were affected by Sync failures due to missing SMS Twilio settings (UCP-1918), follow these steps:

If you do have Twilio settings saved in Settings > SMS > Twilio Settings, no other steps are needed.

If you do not have Twilio settings saved in Settings > SMS > Twilio Settings:
1. Make active campaigns inactive and save your changes. Activate the campaign and save your campaign.

OR

Enable the Campaign Sync Retry job

If you are on the May package (2505) -> Navigate to Settings in TX Communication Planner -> General Settings -> 

If you are on an earlier package than May 

  1. Navigate to Setup and search for Scheduled Jobs.
  2. Click Schedule Apex.
  3. Provide the following job details:
    • Name = TargetX Communication Planner - Campaign Sync Retry
    • APEX Class = SyncRetryBatch
    • Select a schedule using Schedule Builder or provide a valid Cron Expression.
  4. Save your changes.

If you were impacted by Track Start Dates not being respected (CL-2415), no further action is needed. However, when a drip track is reactivated, all recipients will resume the scheduled sends from the next step in the sequence. If you'd prefer that all recipients start the track from the beginning, we recommend cloning the track.

Item 4: Your Upgrade is Complete

  1. No further configuration is required. You may proceed to the Events Upgrade.
     

 

  • Was this article helpful?