Retention Upgrade

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 2412.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).
2308.0	2310.0 (October '23)	No configuration steps.
2310.0	2311.0 (November '23)	Item 1: Update Permissions Permission sets for Student Success Center (Advisor/Standard) and Student Success Center (Admin) should be regenerated to use the new Action Item Notes field: Navigate to the Permission Scanner tab. Select the Product/Feature = Student Success Center (Advisor/Standard) and Version = the version you are upgrading to. Select the checkbox for Use @Future to generate Permission Set if you want to have the process run in the background. Click Generate Permission Set. Repeat for Product/Feature = Student Success Center (Admin) Note: The Student Success Center tab is not included within the Permission Scanner permissions. If you choose to regenerate the permission sets listed above please update this tab's visibility within the permission sets once they have been regenerated. Item 2: Update Page Layouts When the Retention package is installed, a script runs automatically to copy information from the Details field to the new Action Item Notes field. You must update the Action Item Page Layout to include the new Action Item Notes field instead of the Details field in the Student Success Center Details field: Navigate to Setup and select Object Manager. Locate. the Action Item object and select Page Layouts. Select Edit next to the Action Item Layout. Select the Fields group from the page layout palette and drag the Action Item Notes field onto your layout. Remove the Details field. Save your changes. Repeat for any additional Page Layouts that include the Action Item Notes field. Item 3: Update Email Templates You must update any email template referencing the Details field in the Student Success Center to point to the new Action Item Notes field. Item 4: Upgrade Complete No further configuration is required.
2311.0	2312.0 (December '23)	No configuration steps.
2312.0	2402.1 (February '24)	No configuration steps.
2402.1	2405.0 (May '24)	No configuration steps.
2405.0	2405.1 (May '24)	Note: a new Retention package was made available on 5/28/24 due to a defect in the original May '24 package. No configuration steps.
2405.1	2410.1 (October '24)	No configuration steps.
2410.1	2411.0 (November '24)	No configuration steps.
2411.0	2412.0 (December '24)	No configuration steps. You may proceed to the HEDA Toolkit Upgrade.