Difference between revisions of "PT Comments v2.4 Upgrade"

Latest revision as of 17:34, 3 March 2020

Back to PT Comments

IMPORTANT: v2.4 of this application requires ADF 2.5 or greater and CommonSpot 10.5.2 or 10.6.1 or greater.

Overview

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

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_comments" to "/ADF/apps/pt_comments_v2.3".
2. Rename file "/ADF/apps/pt_comments_v2.3/appBeanConfig.cfm" to "/ADF/apps/pt_comments_v2.3/appBeanConfig.cfm.old".
3. Move the PT Comments v2.4 and into the "/ADF/apps/pt_comments/" directory.
4. Reset the ADF

Comments Custom Element

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

Due to a new incompatibility with the ADF's getCEData function and with the BuildView function, "formid" and "userid" are no longer valid field Names in the custom elements. Use these steps to update the two fields in the Comments Global Custom element:

1. Copy the following updater file to your site and place it in your 'customcf' directiry:
   1. '/ADF/apps/pt_comments/site-files/customcf/CommentsAppUpdater.cfm'
2. View the PT Comments App Update menu page by going to the URL:
   1. http://{your-site}/customcf/CommentsAppUpdater.cfm
3. The following updater script with be displayed with [PREVIEW] and [RUN] options
   1. schema-update-for-2.3
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 and displays the message:
   1. The field "formid" in the Comments element was updated!
   2. The field "userid" in the Comments element was updated!
   3. Go to the CommonSpot Site Admin.
   4. Go to the "Elements" menu item under "Elements & Forms".
   5. From the list of elements in the "Manage Elements" dialog find the "Comments" custom element.
   6. Select the "Field Definitions" menu option for the Comments element under the pencil icon.
   7. When the "Custom Element Field Definitions" dialog appears click on the pencil icon to edit either updated field
   8. Without making any other changes hit the "save" option to save the field.
   9. The fields list should then reflect the changes.
9. Close the "Manage Elements" windows.

Your Fields should now be updated!

IMPORTANT: Using CommonSpot reserved words as field names in Custom Element is not recommended!
(eg. subsiteid, pageid, formid)

Site Level Customizations Review

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