Difference between revisions of "PT Social Media"

From ADF Docs
Jump to: navigation, search
(Installation Guides)
(21 intermediate revisions by 2 users not shown)
Line 9: Line 9:
  
 
== Overview ==
 
== Overview ==
The Social Media application provides a tool to allow your organizations social media live data streams from your Facebook Pages, your Twitter accounts and targeted Twitter keyword searches, your YouTube Channels and your WordPress blog posts to be combined in various configurations to be displayed in one or in various strategic locations on your CommonSpot site.
+
The Social Media application provides a tool to allow your organizations social media live data streams from your Facebook Pages, your Instagram posts, your Twitter accounts and targeted Twitter keyword searches, your YouTube Channels and your WordPress blog posts to be combined in various configurations to be displayed in one or in various strategic locations on your CommonSpot site.
 +
* Any number of supported social media accounts can be setup in the app
 +
* Ready-made render handlers are provided to display your social media streams and can be updated to display your streams in any way you see fit
 +
* Posts can be moderated/filtered using either a blacklist or a whitelist
 +
* Social media feeds can be pulled on a regular basis and cached for display purposes to avoid exceeding API quota limits
  
 
== Requirements ==
 
== Requirements ==
Line 36: Line 40:
 
* '''Custom Elements:'''
 
* '''Custom Elements:'''
 
**[[SocialMedia Selector]] - Custom Element
 
**[[SocialMedia Selector]] - Custom Element
**[[Facebook Pages]] - Custom Element
+
**[[SocialMedia Filtering]] - Custom Element
 
**[[Twitter Accounts Keywords]] - Custom Element
 
**[[Twitter Accounts Keywords]] - Custom Element
 
**[[WordPress Blogs]] - Custom Element
 
**[[WordPress Blogs]] - Custom Element
**[[YouTube Channels]] - Custom Element
 
 
**[[ptSocialMedia Configuration]] - Custom Element
 
**[[ptSocialMedia Configuration]] - Custom Element
  
Line 73: Line 76:
  
 
== Installation Guides ==
 
== Installation Guides ==
'''Current Release:'''
+
'''Current ADF 2.5 Release Version:'''
 +
* v3.2:
 +
** [[PT_Social_Media_Version_3.2_Release_Notes|Version 3.2 Release Notes]]
 +
** [[PT_Social_Media_Version_3.2_Install|Version 3.2 Install Guide]]
 +
** [[PT_Social_Media_Version_3.2_Upgrade|Version 3.2 Upgrade Guide]] (from v3.1)
 +
 
 +
'''IMPORTANT''': The above versions of this application require '''ADF 2.5''' or greater and '''CommonSpot 10.5.2 or 10.6.1''' or greater.
 +
 
 +
'''Previous ADF 2.4.x Versions:'''
 +
* v3.1:
 +
** [[PT_Social_Media_Version_3.1_Release_Notes|Version 3.1 Release Notes]]
 +
** [[PT_Social_Media_Version_3.1_Install|Version 3.1 Install Guide]]
 +
** [[PT_Social_Media_Version_3.1_Upgrade|Version 3.1 Upgrade Guide]] (from v3.0)
 +
 
 +
* v3.0:
 +
** [[PT_Social_Media_Version_3.0_Release_Notes|Version 3.0 Release Notes]]
 +
** [[PT_Social_Media_Version_3.0_Install|Version 3.0 Install Guide]]
 +
** [[PT_Social_Media_Version_3.0_Upgrade|Version 3.0 Upgrade Guide]] (from v2.2)
 +
'''IMPORTANT''': The 'ADF 2.4.x Versions' of this application require '''ADF 2.0 to 2.4.x''' and '''CommonSpot 10 up to 10.5.1 or 10.6'''
 +
 
 +
'''Previous ADF 1.8 Version:'''
 
* v2.2:
 
* v2.2:
 
** [[PT_Social_Media_Version_2.2_Release_Notes|Version 2.2 Release Notes]]  
 
** [[PT_Social_Media_Version_2.2_Release_Notes|Version 2.2 Release Notes]]  
 
** [[PT_Social_Media_Version_2.2_Install|Version 2.2 Install Guide]]
 
** [[PT_Social_Media_Version_2.2_Install|Version 2.2 Install Guide]]
 
** [[PT_Social_Media_Version_2.2_Upgrade|Version 2.2 Upgrade Guide]] (from v2.1)
 
** [[PT_Social_Media_Version_2.2_Upgrade|Version 2.2 Upgrade Guide]] (from v2.1)
 +
'''IMPORTANT''': v2.x of this application requires '''ADF 1.6''' or greater. '''ADF 1.8.x''' is recommended.
  
'''Current Development Build:'''
 
* v2.3:
 
<!--
 
** [[PT_Social_Media_Version_2.3_Release_Notes|Version 2.3 Release Notes]]
 
** [[PT_Social_Media_Version_2.3_Install|Version 2.3 Install Guide]]
 
** [[PT_Social_Media_Version_2.3_Upgrade|Version 2.3 Upgrade Guide]] (from v2.2)
 
--->
 
  
'''Previous Versions:'''
+
'''Previous ADF 1.x Versions:'''
 
* v2.1:
 
* v2.1:
 
** [[PT_Social_Media_Version_2.1_Release_Notes|Version 2.1 Release Notes]]  
 
** [[PT_Social_Media_Version_2.1_Release_Notes|Version 2.1 Release Notes]]  
Line 98: Line 115:
 
** [[PT_Social_Media_Version_2.0_Upgrade|Version 2.0 Upgrade Guide]] (from v1.2)
 
** [[PT_Social_Media_Version_2.0_Upgrade|Version 2.0 Upgrade Guide]] (from v1.2)
  
  IMPORTANT: v2.x of this application requires '''ADF 1.6''' or greater
+
  '''IMPORTANT''': v2.x of this application requires '''ADF 1.6''' or greater
  
 
* v1.2:
 
* v1.2:
Line 113: Line 130:
 
** [[PT_Social_Media_Version_1.0_Install|Version 1.0 Install Guide]]
 
** [[PT_Social_Media_Version_1.0_Install|Version 1.0 Install Guide]]
  
  IMPORTANT: v1.x of this application requires '''ADF 1.5''' or greater
+
  '''IMPORTANT''': v1.x of this application requires '''ADF 1.5''' or greater
 +
 
 +
<!--
 +
'''Current Development Build:'''
 +
* v2.3:
 +
** [[PT_Social_Media_Version_2.3_Release_Notes|Version 2.3 Release Notes]]
 +
** [[PT_Social_Media_Version_2.3_Install|Version 2.3 Install Guide]]
 +
** [[PT_Social_Media_Version_2.3_Upgrade|Version 2.3 Upgrade Guide]] (from v2.2)
 +
-->
  
 
== Getting Started Guide ==
 
== Getting Started Guide ==
Line 121: Line 146:
 
The social media application provides the following features:
 
The social media application provides the following features:
 
* [[PT_Social_Media_Facebook|Facebook Pages Data Stream]]
 
* [[PT_Social_Media_Facebook|Facebook Pages Data Stream]]
 +
* [[PT_Social_Media_Instagram|Instagram Posts Data Stream]]
 
* [[PT_Social_Media_Twitter|Twitter Accounts and Keywords Data Stream]]
 
* [[PT_Social_Media_Twitter|Twitter Accounts and Keywords Data Stream]]
 
* [[PT_Social_Media_YouTube|YouTube Channels Data Stream]]
 
* [[PT_Social_Media_YouTube|YouTube Channels Data Stream]]

Revision as of 04:55, 5 March 2020

About the Social Media App

The Social Media application is built using the Application Development Framework (ADF).


Overview

The Social Media application provides a tool to allow your organizations social media live data streams from your Facebook Pages, your Instagram posts, your Twitter accounts and targeted Twitter keyword searches, your YouTube Channels and your WordPress blog posts to be combined in various configurations to be displayed in one or in various strategic locations on your CommonSpot site.

  • Any number of supported social media accounts can be setup in the app
  • Ready-made render handlers are provided to display your social media streams and can be updated to display your streams in any way you see fit
  • Posts can be moderated/filtered using either a blacklist or a whitelist
  • Social media feeds can be pulled on a regular basis and cached for display purposes to avoid exceeding API quota limits

Requirements

ADF Library components that are required for the Calendar application:

  • CEData_1_1
  • CSData_1_1
  • Data_1_1
  • Date_1_1
  • Forms_1_1
  • UI_1_0
  • Scripts_1_1
  • JSON
  • CCAPI

App v1.2 and higher also requires:

  • CSContent_1_0
  • Scheduler_1_0
  • Utils_1_1

The ADF 1.5.x must be configured correctly for your site. The Site Configuration (ADF.cfc) wiki page has instructions for configuration.

Contents

The Social Media application contains the following:

  • Custom Coding - various components and scripts.
  • Custom Fields:
    • Video Size Calculator Field

Note: Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates.

Pre-installation Considerations

The Application Development Framework (ADF) must be setup and configured on the server for the site that will be implementing the Social Media application. For detailed instructions follow the ADF Overview wiki page for Site Configurations.

This installation guide assumes that you have no Custom Elements and/or Metadata Forms with the names above. Before the install, remove any Custom Elements/Metadata Forms with the names listed in the "Contents" section above. (If you do not remove existing elements with these names, you may have difficulties during the installation.)


Installation Guides

Current ADF 2.5 Release Version:

IMPORTANT: The above versions of this application require ADF 2.5 or greater and CommonSpot 10.5.2 or 10.6.1 or greater.

Previous ADF 2.4.x Versions:

IMPORTANT: The 'ADF 2.4.x Versions' of this application require ADF 2.0 to 2.4.x and CommonSpot 10 up to 10.5.1 or 10.6

Previous ADF 1.8 Version:

IMPORTANT: v2.x of this application requires ADF 1.6 or greater. ADF 1.8.x is recommended.


Previous ADF 1.x Versions:

IMPORTANT: v2.x of this application requires ADF 1.6 or greater
IMPORTANT: v1.x of this application requires ADF 1.5 or greater


Getting Started Guide

Features

The social media application provides the following features:

Known Issues/Bugs

Found a bug, view the PT Social Media Issues page. Your issue not on the list? Then post it so the issue can be addressed.