Retention Upgrade

Last updated
Save as PDF

Step 1 - Record Your Current Package Version

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

Navigate to Setup > Installed Packages
Search for TgtX_Retention
Note the version number

NOTE: If your current version is 2511.0 you are on the most recent package and should proceed to the HEDA Toolkit Upgrade.

Step 2 - Check for a Custom Object tab

Navigate to Setup and search for Tabs.
Check to see if you have a Custom Object tab for Academic Periods.
- If you do NOT have the tab, proceed with the install.
- If you DO have the tab, Delete the tab by selecting the Del link.
- If you DO have the tab but do NOT have the option to Delete it, proceed to the next step.
Check if you have a Custom Object tab for Success Team Members.
- If you do NOT have the tab, proceed with the install.
- If you DO have the tab, Delete the tab by selecting the Del link.
- If you DO have the tab but do NOT have the option to Delete it, proceed to the next step.

Step 3 - 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.
Navigate to TargetX Retention Suite: Admin Group to select and obtain the upgraded package.
Choose "Install for Admins Only."
- Remember to update the appropriate Profiles and Permission Sets if additional security is required.
Choose "Install for Admins Only." Please update the appropriate Profiles and Permission Sets if additional security is required.

Step 4 - 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.1	2411.0 (November '24)	No configuration steps.
2411.0	2412.0 (December '24)	No configuration steps.
2412.0	2502.0 (February '25)	No configuration steps.
2502.0	2505.0 (May '25)	No configuration steps.
2505.0	2511.0 (November '25)	Item 1: Update Student Success Center (Advisor/Standard) Permissions for Student Success Center Users who create or edit Advising records need Read and Edit rights to the new Open Advising Items field on the Advising object. Option 1: Regenerate the Student Success Center (Advisor/Standard) permission set Navigate to the Permission Scanner tab. Select the Product/Feature = Student Success Center (Advisor/Standard) and Version = the version you are upgrading to (e.g. 2511.x). Select the checkbox for Use @Future to generate Permission Set if you want to have the process run in the background. Click the Generate Permission Set button. The updated permission sets will retain the currently assigned users. If needed, you can assign the Permission Sets to additional users. Option 2: Manually implement these changes to customized Profiles or Permission Sets Navigate to Setup and search for Profiles. Click the Profile for your Advisors. Click Object Settings. Select the Advising object and click Edit. Assign Read and Edit access to the Open Advising Items field. Save your changes. Item 2: Update Student Success Center (Admin) Permissions for Student Success Center Users who create or edit Advising records need Read and Edit rights to the new Open Advising Items field on the Advising object. Option 1: Regenerate the Student Success Center (Admin) permission set Navigate to the Permission Scanner tab. Select the Product/Feature = Student Success Center (Admin) and Version = the version you are upgrading to (e.g. 2511.x). Select the checkbox for Use @Future to generate Permission Set if you want to have the process run in the background. Click the Generate Permission Set button. The updated permission sets will retain the currently assigned users. If needed, you can assign the Permission Sets to additional users. Option 2: Manually implement these changes to customized Profiles or Permission Sets Navigate to Setup and search for Profiles. Click the Profile for your Administrators. Click Object Settings. Select the Advising object and click Edit. Assign Read and Edit access to the Open Advising Items field. Save your changes. Item3: Run Open Advising Item Batch Runner (optional) A new batch job is available to update the count of Open Advising Items on Advising records. If your Advisors have more than 50 open issues for their students, you should run this process to ensure they can view the records in the Student Success Center: Navigate to Retention Settings. Locate the new section, Open Advising Item Batch Runner. Click Run Open Advising Count Batch. You can check the job status in Apex Jobs for the Apex Class named CountOpenSubAdvisingBatch. Item 4: Upgrade Complete No further configuration is required. You may proceed to the HEDA Toolkit Upgrade.