Difference between revisions of "PT Forums CCAPI Configuration"

From ADF Docs
Jump to: navigation, search
(Created page with '== Overview == The Forum Application uses the ADF CCAPI to populate profile records and create categories, topics, threads and message posts. The CCAPI needs to be con…')
 
 
(16 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
Back to [[PT Forums Build Templates Pages|Build Templates/Pages]]
 +
 
== Overview ==
 
== Overview ==
−
The Forum Application uses the [[CCAPI|ADF CCAPI]] to populate profile records and create categories, topics, threads and message posts.  The CCAPI needs to be configured for the site and forums application.
+
The Forums Application uses the [[CCAPI|ADF CCAPI]] to populate forum element records for user settings, categories, topics, threads and messages.  The CCAPI needs to be configured for the site and forums application.
  
 
First, follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.  Once that configuration is complete, follow the steps below to set up the CCAPI config for the Photo Gallery application.  Make sure to update the ''wsVars'' section with the correct URLs and username/password.
 
First, follow the steps to set up the [[CCAPI Config|CCAPI Config]] file for the site.  Once that configuration is complete, follow the steps below to set up the CCAPI config for the Photo Gallery application.  Make sure to update the ''wsVars'' section with the correct URLs and username/password.
  
 
== Setup ==
 
== Setup ==
−
# Create a new page called 'ccapiPhoto'. Recommend creating this page in the ''/webadmin/photogallery/'' subsite.  
+
# Create a new page called 'ccapiForums'. Recommend creating this page in the ''/webadmin/forums/'' subsite.  
−
# Add the 'Photo' element to the page.
+
# Add each of the following Forums elements to the page:
−
# Select the 'Photo' element indicator and go to 'more...'.  Select 'Name' from the menu.
+
## Forum Categories
−
# In the Element Name field, enter the text 'ccapiPhotoElement'.
+
## Forum Topics
 +
## Forum Threads
 +
## Forum Messages
 +
## Forum User Settings
 +
## Forum Subscriptions
 +
 
 +
# For each element that was added, click on the element indicator and go to 'more...'.  Select 'Name' from the menu.
 +
# In the Element Name field, enter the appropriate name for each element:
 +
## ccapiForumCategories
 +
## ccapiForumTopics
 +
## ccapiForumThreads
 +
## ccapiForumTopicsMessages
 +
## ccapiForumUserSettings
 +
## ccapiForumSubscriptions
 +
 
 
# Publish this page and view in read mode.
 
# Publish this page and view in read mode.
−
# Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:
+
# Edit the 'ccapi.cfm' file for the site and add the following xml blocks into the <elements> section:
 +
## an example 'ccapi.cfm' file is in the '''pt_forum > site-files > _cs_apps > config''' folder   
 +
 
 
<source lang="xml">
 
<source lang="xml">
−
<Photo>
+
<ForumCategories>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>ccapiForumCategories</controlName>
 +
</ForumCategories>
 +
<ForumTopics>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>ccapiForumTopics</controlName>
 +
</ForumTopics>
 +
<ForumThreads>
 
   <pageID>#####</pageID>
 
   <pageID>#####</pageID>
 
   <subsiteID>##</subsiteID>
 
   <subsiteID>##</subsiteID>
 
   <elementType>custom</elementType>
 
   <elementType>custom</elementType>
−
   <controlName>ccapiPhotoElement</controlName>
+
   <controlName>ccapiForumThreads</controlName>
−
</Photo>
+
</ForumThreads>
 +
<ForumMessages>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>ccapiForumTopicsMessages</controlName>
 +
</ForumMessages>
 +
<ForumUserSettings>
 +
  <pageID>#####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>ccapiForumUserSettings</controlName>
 +
</ForumUserSettings>
 +
<ForumSubscriptions>
 +
  <pageID>####</pageID>
 +
  <subsiteID>##</subsiteID>
 +
  <elementType>custom</elementType>
 +
  <controlName>ccapiForumSubscriptions</controlName>
 +
</ForumSubscriptions>
 
</source>
 
</source>
  
−
To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiPhoto' page that was just created.  
+
To populate the <pageID> and <subsiteID> tags, view the 'source' code for the 'ccapiForums' page that was just created.  
 
   
 
   
 
Identify the following line in the source code and enter this numeric value into the <subsiteID> tag:
 
Identify the following line in the source code and enter this numeric value into the <subsiteID> tag:
 
<source lang="java">
 
<source lang="java">
−
var jsSubSiteID = ##;
+
    var jsSubSiteID = ##;
 
</source>
 
</source>
  
 
Identify the following line in the source code and enter this numeric value into the <pageID> tag:
 
Identify the following line in the source code and enter this numeric value into the <pageID> tag:
 
<source lang="java">
 
<source lang="java">
−
var jsPageID = ####;
+
    var jsPageID = ####;
 
</source>
 
</source>
  
 
[[Reset ADF|Reset the ADF]] for the server and site.
 
[[Reset ADF|Reset the ADF]] for the server and site.
  
−
[[Category:Photo Gallery]]
+
[[Category:Forums]]

Latest revision as of 17:54, 15 September 2010

Back to Build Templates/Pages

Overview

The Forums Application uses the ADF CCAPI to populate forum element records for user settings, categories, topics, threads and messages. The CCAPI needs to be configured for the site and forums application.

First, follow the steps to set up the CCAPI Config file for the site. Once that configuration is complete, follow the steps below to set up the CCAPI config for the Photo Gallery application. Make sure to update the wsVars section with the correct URLs and username/password.

Setup

  1. Create a new page called 'ccapiForums'. Recommend creating this page in the /webadmin/forums/ subsite.
  2. Add each of the following Forums elements to the page:
    1. Forum Categories
    2. Forum Topics
    3. Forum Threads
    4. Forum Messages
    5. Forum User Settings
    6. Forum Subscriptions
  1. For each element that was added, click on the element indicator and go to 'more...'. Select 'Name' from the menu.
  2. In the Element Name field, enter the appropriate name for each element:
    1. ccapiForumCategories
    2. ccapiForumTopics
    3. ccapiForumThreads
    4. ccapiForumTopicsMessages
    5. ccapiForumUserSettings
    6. ccapiForumSubscriptions
  1. Publish this page and view in read mode.
  2. Edit the 'ccapi.cfm' file for the site and add the following xml blocks into the <elements> section:
    1. an example 'ccapi.cfm' file is in the pt_forum > site-files > _cs_apps > config folder 
<ForumCategories>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiForumCategories</controlName>
</ForumCategories>
<ForumTopics>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiForumTopics</controlName>
</ForumTopics>
<ForumThreads>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiForumThreads</controlName>
</ForumThreads>
<ForumMessages>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiForumTopicsMessages</controlName>
</ForumMessages>
<ForumUserSettings>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiForumUserSettings</controlName>
</ForumUserSettings>
<ForumSubscriptions>
  <pageID>####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiForumSubscriptions</controlName>
</ForumSubscriptions>

To populate the <pageID> and <subsiteID> tags, view the 'source' code for the 'ccapiForums' page that was just created.

Identify the following line in the source code and enter this numeric value into the <subsiteID> tag: 

     var jsSubSiteID = ##;

Identify the following line in the source code and enter this numeric value into the <pageID> tag: 

     var jsPageID = ####;

Reset the ADF for the server and site.

Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=PT_Forums_CCAPI_Configuration&oldid=4154"