Difference between revisions of "PT Calendar Version 4.8 Upgrade"

Revision as of 20:10, 10 January 2025

Back to PT Calendar

IMPORTANT: v4.8 of this application requires ADF 2.7 or greater and CommonSpot 10.8.3 or 10.9.1 or 11.0 or greater. 

Overview

This guide is to upgrade the PT Calendar v4.7 from v4.8. If you are updating from a version earlier than v4.7, please complete the v3.0 - v4.7 Upgrade Guides in order.

Note: There is not an upgrade path from Calendar 2 or earlier to Calendar 4.x. You can only upgrade Calendar v3.x to Calendar v4.x. From Calendar 2.x or earlier you will need to treat the Calendar App as a new install.

Download

Download the Calendar Application from the Community Site Project or from the SVN Repository.

ADF Application Code Review

This is only for reviewing the code that is in the "/ADF/apps/" directory, not at the site level.

1. Download the application from the Community project page.
2. Unzip the application zip folder.
3. Analyze the updated app code compared to the current app code on your server.
   1. Identify any customizations that you have made to the application code to make sure these are not overwritten by the app update.
   2. A great tool to use is Beyond Compare to compare the new and current file to identify the exact lines of code that have been changed.
4. Once this is complete, then move your app customizations into the new app code package.

Application Code

1. Rename directory "/ADF/apps/pt_calendar" to "/ADF/apps/pt_calendar_v4.7".
2. Rename file "/ADF/apps/pt_calendar_v4.7/appBeanConfig.cfm" to "/ADF/apps/pt_calendar_v4.7/appBeanConfig.cfm.old".
3. Move the PT Calendar v4.8 and into the "/ADF/apps/pt_calendar/" directory.
4. Reset the ADF

Site Level Customizations Review

This is only for reviewing the site-level customizations in the "/_cs_apps/pt_calendar/" directory, not in the ADF directory.

1. Analyze the updated app code compared to the app customization code on your server.
   1. Identify any customizations that you have made to the application code to make sure these are updated with any functionality.
   2. Again, Beyond Compare is a good tool to compare the new and current file to identify the exact lines of code that have been changed.
   3. This is important for components that have customized functions to the site level "/_cs_apps/". The best practice is to identify the function that have been customized and compare with the new app function to identify any updates. A good help is to check the function comment header to see if any updates have been made.
2. Once completed, Reset the ADF.

Custom Element Updates

Update the SocialMedia Filtering Custom Element

Due to the misnamed youtubeExcludedList, youtubeExcludedList, wordpressIncludedList and wordpressExcludedList fields in the SocialMedia Filtering Custom Element you will need to run the Social Media App Updater Custom Script.

IMPORTANT: It is a good idea to backup your CommonSpot Site Database before running the SocialMediaAppUpdater script

Use these steps to update the youtubeIncludeList, youtubeExcludeList, wordpressIncludeList and wordpressExcludeList fields to be updated to the correct youtubeIncludedList, youtubeExcludedList, wordpressIncludedList and wordpressExcludedList names and labels:

1. Copy the following updater file to your site and place it in your 'customcf' directory:
   1. '/ADF/apps/pt_social_media/site-files/customcf/SocialMediaAppUpdater.cfm'
2. View the PT Social Media App Update menu page by going to the URL:
   1. http://{your-site}/customcf/SocialMediaAppUpdater.cfm
3. The following updater-script with be displayed with [PREVIEW] and [RUN] options
   1. schema-update-for-3.4
4. First, click on the [PREVIEW] option
5. If the message reads "No Fields need to be updated at this time!" you are done!
6. If the message displays the "Old Field" and the "New Field" update info, go back to the updater menu.
7. Once back at the updater menu, click the [RUN] option.
8. When the script has finished running it should display the messages:
   1. The field "youtubeIncludeList" in the SocialMedia Filtering element was updated!
   2. The field "youtubeExcludeList" in the SocialMedia Filtering element was updated!
   3. The field "wordpressIncludeList" in the SocialMedia Filtering element was updated!
   4. The field "wordpressExcludeList" in the SocialMedia Filtering element was updated!
9. Now go to the CommonSpot Site Admin.
10. Go to the "Elements" menu item under "Elements & Forms".
    1. From the list of elements in the "Manage Elements" dialog find the "SocialMedia Filtering" custom element.
    2. Select the "Field Definitions" menu option for the "SocialMedia Filtering" element under the pencil icon.
    3. When the "Custom Element Field Definitions" dialog click on the pencil icon to edit one of the updated fields
    4. Without making any other changes hit the "save" option to save the field.
    5. The field should then reflect the changes.
11. Close the "Manage Elements" windows.

Your Fields should now be updated!

Reset the ADF

Reset the ADF for the server and site.