PT Social Media Version 3.4 Upgrade - Revision history

Gcronkright at 22:38, 6 February 2025

2025-02-06T22:38:08Z

Gcronkright: PT Social Media 3.4 Upgrade Guide

2025-01-31T19:59:32Z

PT Social Media 3.4 Upgrade Guide

Gcronkright: /* Custom Element Updates */

2025-01-10T20:15:22Z

‎Custom Element Updates

Gcronkright: /* Update the SocialMedia Filtering Custom Element */

2024-10-10T20:52:21Z

‎Update the SocialMedia Filtering Custom Element

Gcronkright: Created page with "Back to 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 gr..."

2024-10-10T20:40:38Z

Created page with "Back to 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 gr..."

New page

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)

== 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 ==
# Rename directory "/ADF/apps/pt_socialmedia/" to "/ADF/apps/pt_socialmedia_v3_3/".
# Rename file "/ADF/apps/pt_socialmedia_v3_3/appBeanConfig.cfm" to "/ADF/apps/pt_socialmedia_v3_3/appBeanConfig.cfm.old".
# Download the PT Social Media v3.4 and copy the extracted files into the "/ADF/apps/pt_socialmedia/" directory.
# 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.

# Analyze the updated app code compared to the app customization code on your server.
## Identify any customizations that you have made to the application code to make sure these are updated with any functionality.
## 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.
## 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.
# Once completed, Reset the ADF.

== Update the SocialMedia Filtering Custom Element ==
If you have not done so previously, you will need to add the following new fields to the '''SocialMedia Filtering''' Global Custom Element:
#a YouTube Include List field
##Type: Large Text Area
##Field Name: youtubeIncludedList
##Field Label: youtubeIncludedList
##Description: <nowiki>YouTube posts that are selected to be displayed.</nowiki>
##Required: No
#a YouTube Exclude List field
##Type: Large Text Area
##Field Name: youtubeExcludedList
##Field Label: youtubeExcludedList
##Description: <nowiki>YouTube posts that are selected to be hidden.</nowiki>
##Required: No
#a WordPress Include List field
##Type: Large Text Area
##Field Name: wordpressIncludedList
##Field Label: wordpressIncludedList
##Description: <nowiki>WordPress posts that are selected to be displayed.</nowiki>
##Required: No
#a WordPress Exclude List field
##Type: Large Text Area
##Field Name: wordpressExcludedList
##Field Label: wordpressExcludedList
##Description: <nowiki>WordPress posts that are selected to be hidden.</nowiki>
##Required: No
''Note: Even if you do not intend to use the above services, it is a good idea to add these fields to avoid any general App errors''

== Reset the ADF ==
[[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Social Media]]

@@ Line 1: / Line 1: @@
 Back to [[PT_Social_Media|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.2''' 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 ==

@@ Line 1: / Line 1: @@
 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.2''' or greater.
 == Overview ==
@@ Line 21: / Line 21: @@
 # 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!!
-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'.
 == Reset the ADF ==

@@ Line 30: / Line 30: @@
 # View the PT Social Media App Update menu page by going to the URL:
 ## http://{your-site}/customcf/SocialMediaAppUpdater.cfm
-# The following updater-script with be displayed with [PREVIEW] and [RUN] options
+# The following updater-script will be displayed with [PREVIEW] and [RUN] options
 ## schema-update-for-3.4
 # First, click on the '''[PREVIEW]''' option

@@ Line 21: / Line 21: @@
 # Once completed, Reset the ADF.
-== Update the SocialMedia Filtering Custom Element ==
+== Custom Element Updates ==
-If you have not done so previously, you will need to add the following new fields to the '''SocialMedia Filtering''' Global Custom Element:
+=== Update the SocialMedia Filtering Custom Element ===
-#a YouTube Include List field
+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.
-##Type: Large Text Area
+ IMPORTANT: It is a good idea to backup your CommonSpot Site Database before running the '''SocialMediaAppUpdater''' script
-##Field Name:  youtubeIncludedList
+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:
-##Field Label:  youtubeIncludedList
+# Copy the following updater file to your site and place it in your 'customcf' directory:
-##Description: <nowiki>YouTube posts that are selected to be displayed.</nowiki>
+## '/ADF/apps/pt_social_media/site-files/customcf/SocialMediaAppUpdater.cfm'
-##Required: No
+# View the PT Social Media App Update menu page by going to the URL:
-#a YouTube Exclude List field
+## http://{your-site}/customcf/SocialMediaAppUpdater.cfm
-##Type: Large Text Area
+# The following updater-script with be displayed with [PREVIEW] and [RUN] options
-##Field Name:  youtubeExcludedList
+## schema-update-for-3.4
-##Field Label:  youtubeExcludedList
+# First, click on the '''[PREVIEW]''' option
-##Description: <nowiki>YouTube posts that are selected to be hidden.</nowiki>
+# If the message reads "No Fields need to be updated at this time!" you are done!
-##Required: No
+# If the message displays the "Old Field" and the "New Field" update info, go back to the updater menu.
-#a WordPress Include List field
+# Once back at the updater menu, click the '''[RUN]''' option.
-##Type: Large Text Area
+# When the script has finished running it should display the messages:
-##Field Name:  wordpressIncludedList
+## The field "youtubeIncludeList" in the SocialMedia Filtering element was updated!
-##Field Label:  wordpressIncludedList
+## The field "youtubeExcludeList" in the SocialMedia Filtering element was updated!
-##Description: <nowiki>WordPress posts that are selected to be displayed.</nowiki>
+## The field "wordpressIncludeList" in the SocialMedia Filtering element was updated!
-##Required: No
+## The field "wordpressExcludeList" in the SocialMedia Filtering element was updated!
-#a WordPress Exclude List field
+# Now go to the CommonSpot Site Admin.
-##Type: Large Text Area
+# Go to the "Elements" menu item under "Elements & Forms".
-##Field Name:  wordpressExcludedList
+## From the list of elements in the "Manage Elements" dialog find the "SocialMedia Filtering" custom element.
-##Field Label:  wordpressExcludedList
+## Select the "Field Definitions" menu option for the "SocialMedia Filtering" element under the pencil icon.
-##Description: <nowiki>WordPress posts that are selected to be hidden.</nowiki>
+## When the "Custom Element Field Definitions" dialog click on the pencil icon to edit one of the updated fields
-##Required: No
+## Without making any other changes hit the "save" option to save the field.
- ''Note: Even if you do not intend to use the above services, it is a good idea to add these fields to avoid any general App errors''
+## The field should then reflect the changes.
 == Reset the ADF ==