Difference between revisions of "PT Calendar Version 4.2 Upgrade"

From ADF Docs
Jump to: navigation, search
(Created page with "Back to PT Calendar IMPORTANT: v4.1 of this application requires '''ADF 2.0''' or greater ('''ADF 2.3.1''' or greater is recommended) == Overview == This g...")
 
Line 1: Line 1:
 
Back to [[PT_Calendar|PT Calendar]]
 
Back to [[PT_Calendar|PT Calendar]]
  
  IMPORTANT: v4.1 of this application requires '''ADF 2.0''' or greater ('''ADF 2.3.1''' or greater is recommended)  
+
  IMPORTANT: v4.2 of this application requires '''ADF 2.0''' or greater ('''ADF 2.4.x''' is recommended)  
  
 
== Overview ==
 
== Overview ==
This guide is to upgrade the PT Calendar v4.1 from v4.0.  If you are updating from a version earlier than v4.0, please follow the [[PT_Calendar_Version_4.0_Upgrade|Version 4.0 Upgrade Guide]] before upgrading to v4.1.
+
This guide is to upgrade the PT Calendar v4.2 from v4.1.  If you are updating from a version earlier than v4.1, please follow the [[PT_Calendar_Version_4.1_Upgrade|Version 4.1 Upgrade Guide]] before upgrading to v4.2.
  
  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.  
+
  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.
 
  From Calendar 2.x or earlier you will need to treat the Calendar App as a new install.
  
<!--
 
== Custom Element Updates ==
 
 
=== PTCalendar Configuration ===
 
Update the following field in the '''Rendering and Display''' tab of the ptCalendar Configuration element:
 
#add an additional Tool Tip theme '''VALUE''' (to allow qTips2 to use the Apps selected jQueryUI Theme)
 
##Field Name:  Calendar_App_ToolTip_Theme
 
##Type: Selection List
 
##Properties:
 
###Option List Source: Value List
 
###Option List: cream,dark,green,light,red,blue''',UI'''
 
###Default Value: <nowiki>cream</nowiki>
 
 
Add the following fields in the '''Rendering and Display''' tab of the ptCalendar Configuration element:
 
#a Past Events Rollup on the Month List selection list field
 
##Type: Selection List
 
##Field Name:  collapseCurrentMonthsPastEvents
 
##Field Label:  Roll Up Current Month's Past Events
 
##Description: <nowiki>Only applicable for the Month List View</nowiki>
 
##Required: No
 
##Properties:
 
###Option List Source: Value List
 
###Option List: Yes,No
 
###Multiple: No
 
###Select Option: No
 
###Size: 1
 
###Default Value: <nowiki>Yes</nowiki>
 
#an Organizations Sort Field selection list field
 
##Type: Selection List
 
##Field Name:  sortFieldOrganizations
 
##Field Label:  Organizations Sort Field
 
##Description: <nowiki></nowiki>
 
##Required: No
 
##Properties:
 
###Option List Source: Value List
 
###Option List: Name,Ordinal
 
###Multiple: No
 
###Select Option: No
 
###Size: 1
 
###Default Value: <nowiki>Name</nowiki>
 
#a Categories Sort Field selection list field
 
##Type: Selection List
 
##Field Name:  sortFieldCategories
 
##Field Label: Categories Sort Field
 
##Description: <nowiki></nowiki>
 
##Required: No
 
##Properties:
 
###Option List Source: Value List
 
###Option List: Name,Ordinal
 
###Multiple: No
 
###Select Option: No
 
###Size: 1
 
###Default Value: <nowiki>Name</nowiki>
 
Add the following fields in the '''Performance and Debugging''' tab of the ptCalendar Configuration element:
 
#an Enable Event Cache for Events Management checkbox field
 
##Type: Checkbox
 
##Field Name:  enableEventCacheForManagement
 
##Field Label:  Enable Event Cache for Events Management
 
##Description: <nowiki></nowiki>
 
##Required: No
 
##Properties:
 
###Value: 1
 
###Checked by default: False
 
-->
 
  
 
== ADF Application Code Review ==
 
== ADF Application Code Review ==
Line 85: Line 21:
  
 
== Application Code ==
 
== Application Code ==
# Rename directory "/ADF/apps/pt_calendar" to "/ADF/apps/pt_calendar_v4.0".
+
# Rename directory "/ADF/apps/pt_calendar" to "/ADF/apps/pt_calendar_v4.1".
# Rename file "/ADF/apps/pt_calendar_v4.0/appBeanConfig.cfm" to "/ADF/apps/pt_calendar_v4.0/appBeanConfig.cfm.old".
+
# Rename file "/ADF/apps/pt_calendar_v4.1/appBeanConfig.cfm" to "/ADF/apps/pt_calendar_v4.1/appBeanConfig.cfm.old".
# Move the PT Calendar v4.1 and into the "/ADF/apps/pt_calendar/" directory.
+
# Move the PT Calendar v4.2 and into the "/ADF/apps/pt_calendar/" directory.
 
# Reset the ADF
 
# Reset the ADF
 
== Setup the Calendar Events Cache Dashboard ==
 
To view or reset the Calendar Events Cache you will want to setup the 'Calendar Events Cache Dashboard' utility page.
 
 
#Create a new page called 'Calendar Events Cache Dashboard' from the Base Plus One (or a Web Admin template) and in the ''/webadmin/calendar/configuration'' subsite.
 
#In the main content container of the page, add a Custom Script element.
 
#From the Custom Script element interface, click the "Edit" icon.
 
#Enter the following text into the Explicit Module path:
 
#* /ADF/apps/pt_calendar/customcf/manage_events_cache_dashboard.cfm
 
#Click Save
 
# Publish this page.
 
  
 
== Site Level Customizations Review ==
 
== Site Level Customizations Review ==

Revision as of 18:57, 1 October 2019

Back to PT Calendar

IMPORTANT: v4.2 of this application requires ADF 2.0 or greater (ADF 2.4.x is recommended) 

Overview

This guide is to upgrade the PT Calendar v4.2 from v4.1. If you are updating from a version earlier than v4.1, please follow the Version 4.1 Upgrade Guide before upgrading to v4.2.

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.


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.1".
  2. Rename file "/ADF/apps/pt_calendar_v4.1/appBeanConfig.cfm" to "/ADF/apps/pt_calendar_v4.1/appBeanConfig.cfm.old".
  3. Move the PT Calendar v4.2 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.

Reset the ADF

Reset the ADF for the server and site.