Difference between revisions of "PT Poll Version 3.2 Install"
From ADF Docs
Gcronkright (talk | contribs) (→Site Level Customizations Review) |
Gcronkright (talk | contribs) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
Back to [[PT_Poll|PT Poll]] | Back to [[PT_Poll|PT Poll]] | ||
− | '''IMPORTANT''': v3.2 of this application requires '''ADF 2.7''' or greater and '''CommonSpot 11.0, 10.9.1 or 10.8. | + | '''IMPORTANT''': v3.2 of this application requires '''ADF 2.7''' or greater and '''CommonSpot 11.0, 10.9.1 or 10.8.3''' or greater. |
− | == | + | == Download == |
− | + | # 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. | ||
− | == | + | == 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' ([[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: | ||
− | + | loadApp("ptPoll"); | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | * [[Reset ADF|Reset the ADF]] for the server and site. | |
− | |||
− | |||
− | |||
− | == | + | == 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 == | ||
+ | # 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 | ||
− | == | + | == Vote Manager == |
− | + | # 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 | ||
− | # | + | == Poll Question Gallery Manager == |
− | ## | + | # Create a new page: |
− | # | + | ## Name: index |
− | # | + | ## Title: Poll Question Gallery Manager |
− | # | + | # 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 | ||
− | + | == CCAPI Configuration == | |
+ | |||
+ | IMPORTANT: The CCAPI configuration is no longer required for CommonSpot 11 and ADF 2.7 or greater. Please skip to the next section. | ||
− | == | + | With the release of CommonSpot 11.0 and ADF 2.7, this app now uses the ADF's ceRecordAPI wrapper functions for the CommonSpot Custom Data API to add or update Custom Elements data. |
− | [[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 or below, 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]] |
Latest revision as of 22:40, 6 February 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.3 or greater.
Contents
Download
- 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.
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");
- Reset the ADF for the server and site.
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
- 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
- Edit the ID column
- Click to edit Layout
- Allow JavaScript data sorting: Unchecked
Vote Manager
- 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
Poll Question Gallery Manager
- Create a new page:
- Name: index
- Title: Poll Question Gallery Manager
- 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.
- Edit the Poll Question ID column
- Click to edit Layout
- Allow JavaScript data sorting: Unchecked
CCAPI Configuration
IMPORTANT: The CCAPI configuration is no longer required for CommonSpot 11 and ADF 2.7 or greater. Please skip to the next section.
With the release of CommonSpot 11.0 and ADF 2.7, this app now uses the ADF's ceRecordAPI wrapper functions for the CommonSpot Custom Data API to add or update Custom Elements data.
Note: If you are using this app with CommonSpot 10.9.1 or 10.8.3 or below, 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:
<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.
- 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 the ADF for the server and site.