Difference between revisions of "PT Poll Version 3.2 Install"

From ADF Docs
Jump to: navigation, search
(Site Level Customizations Review)
(PT Poll Version 3.2 Install Guide)
Line 3: Line 3:
 
  '''IMPORTANT''': v3.2 of this application requires '''ADF 2.7''' or greater and '''CommonSpot 11.0, 10.9.1 or 10.8.2''' or greater.
 
  '''IMPORTANT''': v3.2 of this application requires '''ADF 2.7''' or greater and '''CommonSpot 11.0, 10.9.1 or 10.8.2''' or greater.
  
== Overview ==
+
== Download ==
Follow the items below for upgrading the PT Poll app from v3.1 to v3.2.
+
# Download the PT Poll application from the 'the|commons' projects (http://community.paperthin.com/projects/pt_poll/).
 +
# Extract the zip file and place the directory in the "/ADF/Apps/pt_poll/" directory.
  
== ADF Application Code Review ==
+
== Site Configuration ==
This is only for reviewing the code that is in the "/ADF/apps/" directory, not at the site level.
+
* Make sure ADF 2.7 or greater is set up and running on the site. If the ADF is not set up, follow the instructions for ADF [[Installation]].
 +
* Open the site's 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more info]]) file in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add the following command under the comment section:
  
# Download the application from the Community project page.
+
  loadApp("ptPoll");
# Unzip the application zip folder.
 
# Analyze the updated app code compared to the current app code on your server. 
 
## Identify any customizations that you have made to the application code to make sure these are not overwritten by the app update. 
 
## 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.
 
# Once this is complete, then move your app customizations into the new app code package.  
 
  
== Application Code ==
+
* [[Reset ADF|Reset the ADF]] for the server and site.
# Renamed directory "/ADF/apps/pt_poll" to "/ADF/apps/pt_poll_v3_1".
 
# Renamed file "/ADF/apps/pt_poll_v3_1/appBeanConfig.cfm" to "/ADF/apps/pt_poll_v3_1/appBeanConfig.cfm.old".
 
# Move the PT Poll v3.2 app files into the "/ADF/apps/pt_poll/" directory.
 
  
== Site Level Customizations Review ==
+
== Element Import ==
This is only for reviewing the site-level customizations in the "/_cs_apps/pt_poll/" directory, not in the ADF directory.
+
* Import the following elements:
 +
** Poll-Question-Custom-Element.zip
 +
** Poll-Question-Gallery-Custom-Element.zip
 +
** Poll-Vote-Custom-Element.zip
  
# Analyze the updated app code compared to the app customization code on your server.
+
== Subsite Creation ==
## Identify any customizations that you have made to the application code to make sure these are updated with any functionality.
+
* Create a new subsite called polls under the webadmin subsite
## 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 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.
 
# Once completed, Reset the ADF.
 
  
 +
== Poll Manager ==
 +
# Create a new page:
 +
## Name: index
 +
## Title: Poll Manager
 +
# Insert a Custom Script module onto the page.
 +
# Edit the Custom Script module and enter the explicit path:
 +
## /apps/pt_poll/customcf/poll_dashboard.cfm
 +
# There will be a datasheet on the page click to define the datasheet
 +
## Select the Poll Question element
 +
## Add the ID, Title, Question, and Active flags
 +
# Click on "Edit Columns"
 +
## Edit the ID column
 +
### Change its name to: "Edit/Delete"
 +
### Change its renderhandler to: /ADF/extensions/datasheet-modules/datasheet-action-edit-delete.cfm
 +
# Click to edit Layout
 +
## Allow JavaScript data sorting: Unchecked
  
== Disabling the CCAPI ==
+
== Vote Manager ==
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!!
+
# Create a new page:
 +
## Name: vote manager
 +
## Title: Vote Manager
 +
# Insert a datasheet element into the page and define the datasheet.
 +
## Select the Poll Vote element
 +
## Add the UserID, QuestionID, Vote, Date
 +
# Click on "Edit Columns"
 +
## Add the action column for delete and select the "delete-form-data.cfm" module.
 +
# Click to edit Layout
 +
## Default Sorting: Date DESCENDING
 +
## Results Per Page: 50
  
# Find your CCAPI conduit page for the profile App. This page is generally called 'ccapiProfile' built from the 'Blank Layout Template''.
+
== Poll Question Gallery Manager ==
## The ccapi.cfm file may be located in the '/webadmin/profile/' subsite.
+
# Create a new page:
# Once you find the CCAPI Conduit page that has the 'Profile' element on it, disable this page.
+
## Name: index
# In the '/_cs_apps/config/ccapi.cfm' file for the site remove the <Profile> node from the <elements> section of the XML block.
+
## Title: Poll Question Gallery Manager
# Once completed, Reset the ADF.
+
# Insert a Custom Script module onto the page.  
 +
# Edit the Custom Script module and enter the explicit path:
 +
## /ADF/extensions/customcf/ceManagement/ceManagement.cfm
 +
## Add the Parameter:
 +
### elementName=Poll Question Gallery
 +
# There will be a datasheet on the page click to define the datasheet
 +
## Select the Poll Question Gallery element
 +
## Add the Poll Name and Poll Question ID fields.
 +
# Click on "Edit Columns"
 +
## Edit the Poll Question ID column
 +
### Change its name to: "Edit/Delete"
 +
### Change its renderhandler to: /ADF/extensions/datasheet-modules/datasheet-action-edit-delete.cfm
 +
## Move to the first row in the datasheet.
 +
# Click to edit Layout
 +
## Allow JavaScript data sorting: Unchecked
  
  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.
+
== CCAPI Configuration ==
 +
  IMPORTANT: The CCAPI configuration is no longer needed for ADF 2.7 and CommonSpot 11.0 or greater. Skip to the next section.
  
== Reset the ADF ==
+
With the release of CommonSpot 11 and ADF 2.7, this app now uses the new ceRecordAPI to save data to Custom Elements. Using the CCAPI with CommonSpot 11.0 is still available but using the ceRecordAPI instead is highly recommended.
[[Reset ADF|Reset the ADF]] for the server and site.
+
 
 +
Note: If you are using this app with CommonSpot 10.9.1 or 10.8.3, please continue with the following CCAPI Configuration steps:
 +
 
 +
'''ccapiPoll''' conduit page configuration
 +
# Navigate to your ccapiPoll.cfm page (or create one)
 +
# Add the Poll Vote Element to the page
 +
# Click on More under the Poll Vote Element and select name
 +
# enter the name: pollVote
 +
# Submit the page
 +
 
 +
XML Configuration
 +
# Open the _cs_apps/config/ccapi.cfm document
 +
# add the following:
 +
<pre>
 +
<pollVote>
 +
  <pageID>[ccapi.cfm page ID]</pageID>
 +
  <subsiteID>[subsite ID ccapi.cfm lies in]</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>pollVote</controlName>
 +
</pollVote>
 +
</pre>
 +
 
 +
== Installing the Left Pane ==
 +
The left pane allows you to see a quick breakdown of all the polls you have created. Also gives you a quick link to export the data.
 +
# Navigate to site administration
 +
# Click on Left Pane Settings
 +
# Click Add Panel
 +
## Name: Polls
 +
## Description: Polls LView
 +
## Panel URL: http://[insert your site url here]/ADF/apps/pt_poll/customcf/lview.cfm?subsiteURL=[insert your root subsite here]
 +
 
 +
 
 +
* [[Reset ADF|Reset the ADF]] for the server and site.
 +
 
 +
[[Category:Poll]]

Revision as of 16:01, 31 January 2025

Back to PT Poll

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

Download

  1. Download the PT Poll application from the 'the|commons' projects (http://community.paperthin.com/projects/pt_poll/).
  2. Extract the zip file and place the directory in the "/ADF/Apps/pt_poll/" directory.

Site Configuration

  • Make sure ADF 2.7 or greater is set up and running on the site. If the ADF is not set up, follow the instructions for ADF Installation.
  • Open the site's 'ADF.cfc' ( See Site Configuration (ADF.cfc) for more info) file in a text editor. Locate the Load the ADF Application into application space comment in the file. Add the following command under the comment section:
loadApp("ptPoll");

Element Import

  • Import the following elements:
    • Poll-Question-Custom-Element.zip
    • Poll-Question-Gallery-Custom-Element.zip
    • Poll-Vote-Custom-Element.zip

Subsite Creation

  • Create a new subsite called polls under the webadmin subsite

Poll Manager

  1. Create a new page:
    1. Name: index
    2. Title: Poll Manager
  2. Insert a Custom Script module onto the page.
  3. Edit the Custom Script module and enter the explicit path:
    1. /apps/pt_poll/customcf/poll_dashboard.cfm
  4. There will be a datasheet on the page click to define the datasheet
    1. Select the Poll Question element
    2. Add the ID, Title, Question, and Active flags
  5. Click on "Edit Columns"
    1. Edit the ID column
      1. Change its name to: "Edit/Delete"
      2. Change its renderhandler to: /ADF/extensions/datasheet-modules/datasheet-action-edit-delete.cfm
  6. Click to edit Layout
    1. Allow JavaScript data sorting: Unchecked

Vote Manager

  1. Create a new page:
    1. Name: vote manager
    2. Title: Vote Manager
  2. Insert a datasheet element into the page and define the datasheet.
    1. Select the Poll Vote element
    2. Add the UserID, QuestionID, Vote, Date
  3. Click on "Edit Columns"
    1. Add the action column for delete and select the "delete-form-data.cfm" module.
  4. Click to edit Layout
    1. Default Sorting: Date DESCENDING
    2. Results Per Page: 50

Poll Question Gallery Manager

  1. Create a new page:
    1. Name: index
    2. Title: Poll Question Gallery Manager
  2. Insert a Custom Script module onto the page.
  3. Edit the Custom Script module and enter the explicit path:
    1. /ADF/extensions/customcf/ceManagement/ceManagement.cfm
    2. Add the Parameter:
      1. elementName=Poll Question Gallery
  4. There will be a datasheet on the page click to define the datasheet
    1. Select the Poll Question Gallery element
    2. Add the Poll Name and Poll Question ID fields.
  5. Click on "Edit Columns"
    1. Edit the Poll Question ID column
      1. Change its name to: "Edit/Delete"
      2. Change its renderhandler to: /ADF/extensions/datasheet-modules/datasheet-action-edit-delete.cfm
    2. Move to the first row in the datasheet.
  6. Click to edit Layout
    1. Allow JavaScript data sorting: Unchecked

CCAPI Configuration

IMPORTANT: The CCAPI configuration is no longer needed for ADF 2.7 and CommonSpot 11.0 or greater. Skip to the next section.

With the release of CommonSpot 11 and ADF 2.7, this app now uses the new ceRecordAPI to save data to Custom Elements. Using the CCAPI with CommonSpot 11.0 is still available but using the ceRecordAPI instead is highly recommended.

Note: If you are using this app with CommonSpot 10.9.1 or 10.8.3, please continue with the following CCAPI Configuration steps:

ccapiPoll conduit page configuration

  1. Navigate to your ccapiPoll.cfm page (or create one)
  2. Add the Poll Vote Element to the page
  3. Click on More under the Poll Vote Element and select name
  4. enter the name: pollVote
  5. Submit the page

XML Configuration

  1. Open the _cs_apps/config/ccapi.cfm document
  2. add the following:
<pollVote>
  <pageID>[ccapi.cfm page ID]</pageID>
  <subsiteID>[subsite ID ccapi.cfm lies in]</subsiteID>
  <elementType>custom</elementType>
  <controlName>pollVote</controlName>
</pollVote>

Installing the Left Pane

The left pane allows you to see a quick breakdown of all the polls you have created. Also gives you a quick link to export the data.

  1. Navigate to site administration
  2. Click on Left Pane Settings
  3. Click Add Panel
    1. Name: Polls
    2. Description: Polls LView
    3. Panel URL: http://[insert your site url here]/ADF/apps/pt_poll/customcf/lview.cfm?subsiteURL=[insert your root subsite here]