PT Page Rating v2.4 Upgrade

Back to PT Page Rating

IMPORTANT: v2.4 of this application requires ADF 2.7.0 or greater and CommonSpot 11.0.0, 10.9.1 or 10.8.2 or greater.

Overview

This guide is to upgrade the PT Page Rating v2.4 from v2.3. If you are updating from a version earlier than v2.3, please follow the v2.3 Upgrade Guide before upgrading.

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_page_rating" to "/ADF/apps/pt_page_rating_v2.3".
2. Rename file "/ADF/apps/pt_page_rating_v2.3/appBeanConfig.cfm" to "/ADF/apps/pt_page_rating_v2.3/appBeanConfig.cfm.old".
3. Move the PT Page Rating v2.4 app code into the "/ADF/apps/pt_page_rating/" directory.
4. Reset the ADF

Site Level Customizations Review

This is only for reviewing the site-level customizations in the "/_cs_apps/pt_page_rating/" 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 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.

Disabling the CCAPI

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 this App!! 

1. Find your CCAPI conduit page for the Page Rating App. This page is generally called 'ccapi' or 'ccapiPageRating' built from the 'Blank Layout Template.
   1. The ccapi.cfm file may be located in the '/webadmin/profile/' subsite.
2. Once you find the CCAPI Conduit page that has the 'pt Page Rating' element on it, disable this page.
3. In the '/_cs_apps/config/ccapi.cfm' file for the site remove the <ptPageRating> node from the <elements> section of the XML block.
4. Once completed, Reset the ADF.

Note: If no 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.