Difference between revisions of "PT Calendar Version 4.9 Upgrade"

Revision as of 14:54, 3 June 2025

Back to PT Calendar

IMPORTANT: v4.9 of this application requires ADF 2.7.0 or greater and CommonSpot 11.0.0, 10.9.1 or 10.8.3 or greater. 

Overview

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

Note: There is no 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 the SVN Repository.

ADF Application Code Review

This is only for reviewing the code 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 files 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.8".
2. Rename file "/ADF/apps/pt_calendar_v4.8/appBeanConfig.cfm" to "/ADF/apps/pt_calendar_v4.8/appBeanConfig.cfm.old".
3. Move the PT Calendar v4.9 files and folder structure 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 files 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 functions that have been customized and compare them with the new app functions 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.

Disabling the CCAPI for Custom Elements

IMPORTANT: For CommonSpot 11.x or above. If you are using this app with CommonSpot 10.9.1 or 10.8.3 or below, DO NOT disable the CCAPI for Custom Elements for this App!! 

1. Find your CCAPI conduit page for the Calendar App. This page is generally called 'ccapiCalendar' built from the 'Blank Layout Template.
   1. The ccapiCalendar.cfm page may be located in the '/webadmin/calendar/' subsite.
2. Once you find the CCAPI Conduit page that has the Calendar App elements on it, disable this page.
3. In the '/_cs_apps/config/ccapi.cfm' file for the site, remove the <CalendarEventDetails>, <CalendarEventDateTime>, <CalendarEventRecurrence>, <CalendarEventCategories>, and <CalendarOrganizations> nodes from the <elements> section of the XML block.
4. Once completed, reset the ADF.

Note: If other CE nodes are listed in the <elements> node, other ADF CCAPI functions may still use the <wsVars> configuration information, so do not remove this file.

Reset the ADF

Reset the ADF for the server and site.