Difference between revisions of "PT Social Media Version 3.4 Upgrade"

From ADF Docs
Jump to: navigation, search
(→‎Custom Element Updates)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
Back to [[PT_Social_Media|PT Social Media]]
 
Back to [[PT_Social_Media|PT Social Media]]
  
−
  '''IMPORTANT:''' v3.4 of this application requires '''ADF 2.6.3''' or greater (and '''10.9.0''', '''10.8.2''', '''10.7.3''' or greater)
+
  '''IMPORTANT''': v3.4 of this application requires '''ADF 2.7''' or greater and '''CommonSpot 11.0, 10.9.1 or 10.8.3''' or greater.
  
 
== Overview ==
 
== Overview ==
Line 21: Line 21:
 
# Once completed, Reset the ADF.
 
# Once completed, Reset the ADF.
  
−
== Custom Element Updates ==
+
== Disabling the CCAPI for Custom Elements ==
−
=== Update the SocialMedia Filtering Custom Element ===
+
  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!!
−
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:
 
−
# Copy the following updater file to your site and place it in your 'customcf' directory:
 
−
## '/ADF/apps/pt_social_media/site-files/customcf/SocialMediaAppUpdater.cfm'
 
−
# View the PT Social Media App Update menu page by going to the URL:
 
−
## http://{your-site}/customcf/SocialMediaAppUpdater.cfm
 
−
# The following updater-script will be displayed with [PREVIEW] and [RUN] options
 
−
## schema-update-for-3.4
 
−
# First, click on the '''[PREVIEW]''' option
 
−
# If the message reads "No Fields need to be updated at this time!" you are done!
 
−
# If the message displays the "Old Field" and the "New Field" update info, go back to the updater menu.
 
−
# Once back at the updater menu, click the '''[RUN]''' option.
 
−
# When the script has finished running it should display the messages:
 
−
## The field "youtubeIncludeList" in the SocialMedia Filtering element was updated!
 
−
## The field "youtubeExcludeList" in the SocialMedia Filtering element was updated!
 
−
## The field "wordpressIncludeList" in the SocialMedia Filtering element was updated!
 
−
## The field "wordpressExcludeList" in the SocialMedia Filtering element was updated!
 
−
# Now go to the CommonSpot Site Admin.
 
−
# Go to the "Elements" menu item under "Elements & Forms".
 
−
## From the list of elements in the "Manage Elements" dialog find the "SocialMedia Filtering" custom element.
 
−
## Select the "Field Definitions" menu option for the "SocialMedia Filtering" element under the pencil icon.
 
−
## When the "Custom Element Field Definitions" dialog click on the pencil icon to edit one of the updated fields
 
−
## Without making any other changes hit the "save" option to save the field.
 
−
## The field should then reflect the changes.
 
−
# Close the "Manage Elements" windows.
 
  
−
Your Fields should now be updated!
+
# Find your CCAPI conduit page for the Social Media App. This page is generally called 'ccapi' or 'ccapiSocialMedia' and generally is built from the 'Blank Layout Template'.
 +
## The ccapiSocialMedia.cfm page may be located in the '/webadmin/socialmedia/' subsite.
 +
# Once you find the CCAPI Conduit page with the Social Media App elements on it, disable this page.
 +
# In the '/_cs_apps/config/ccapi.cfm' file for the site remove any of the Social Media element nodes (eg. <SocialMediaFiltering>) from the <elements> section of the XML block.
 +
# 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 ==

Latest revision as of 22:38, 6 February 2025

Back to PT Social Media 

IMPORTANT: v3.4 of this application requires ADF 2.7 or greater and CommonSpot 11.0, 10.9.1 or 10.8.3 or greater.

Overview

The following guide is for upgrading from v3.3 to v3.4. If you are updating from a version earlier than v3.3, please complete the v1.0 - v3.4 Upgrade Guides in order.

Application Code

  1. Rename directory "/ADF/apps/pt_socialmedia/" to "/ADF/apps/pt_socialmedia_v3_3/".
  2. Rename file "/ADF/apps/pt_socialmedia_v3_3/appBeanConfig.cfm" to "/ADF/apps/pt_socialmedia_v3_3/appBeanConfig.cfm.old".
  3. Download the PT Social Media v3.4 and copy the extracted files into the "/ADF/apps/pt_socialmedia/" directory.
  4. Reset the ADF

Site Level Customizations Review

This is only for reviewing the site-level customizations in the "/_cs_apps/pt_socialmedia/" 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 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 Social Media App. This page is generally called 'ccapi' or 'ccapiSocialMedia' and generally is built from the 'Blank Layout Template'.
    1. The ccapiSocialMedia.cfm page may be located in the '/webadmin/socialmedia/' subsite.
  2. Once you find the CCAPI Conduit page with the Social Media App elements on it, disable this page.
  3. In the '/_cs_apps/config/ccapi.cfm' file for the site remove any of the Social Media element nodes (eg. <SocialMediaFiltering>) 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.

Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=PT_Social_Media_Version_3.4_Upgrade&oldid=8389"