Difference between revisions of "PT Portlet CCAPI Configuration"

From ADF Docs
Jump to: navigation, search
(→‎Overview)
(→‎Setup)
Line 7: Line 7:
  
 
== Setup ==
 
== Setup ==
−
# Create a new page called 'ccapiPortlet'. Recommend creating this page in the ''/webadmin/portlet/'' subsite.  
+
# Create a new page called 'ccapiPortlet'. It is recommended to create this page in the ''/webadmin/portlet/'' subsite.  
−
# Add each of the following Forums elements to the page:
+
# Add each of the following Portlet App Elements to the page:
 
##PortletPodInstances
 
##PortletPodInstances
 
##PortletPodUserData
 
##PortletPodUserData
−
# Create a new page called 'ccapiPods'. Recommend creating this page in the ''/webadmin/portlet/'' subsite.  
+
# Create a new page called 'ccapiPods'. It is recommended to create this page in the ''/webadmin/portlet/'' subsite.
 +
# Add each of the following Pod Types to the page:
 
## Links
 
## Links
 
## RSS_Feeds
 
## RSS_Feeds
Line 17: Line 18:
 
## Weather
 
## Weather
 
## Custom_File
 
## Custom_File
−
# For each element that was added, click on the element indicator and go to 'more...'.  Select 'Name' from the menu.
+
# For each element that was added on both pages, 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:
 
# In the Element Name field, enter the appropriate name for each element:
 
## ccapiPortletPodInstance
 
## ccapiPortletPodInstance
Line 26: Line 27:
 
## ccapiPodTypeRSSFeed
 
## ccapiPodTypeRSSFeed
 
## ccapiPodTypeLinks
 
## ccapiPodTypeLinks
−
# Publish this page and view in read mode.
+
# Publish the pages and view in read mode.
−
# Edit the 'ccapi.cfm' file for the site and add the following xml blocks into the <elements> section:
+
# Edit the 'ccapi.cfm' (or ccapi.xml) file for the site and add the following xml blocks into the <elements> section:
−
## an example 'ccapi.cfm' file is in the '''pt_portlet > site-files > _cs_apps > config''' folder     
+
## an example 'ccapi.cfm' (or ccapi.xml) file is in the '''pt_portlet > site-files > _cs_apps > config''' folder     
  
 
<source lang="xml">
 
<source lang="xml">

Revision as of 00:41, 30 April 2010

Back to Build Templates/Pages

Overview

The Portlet Application uses the ADF CCAPI to populate portlet element records for pod instances, user pod data, pod configurations. The CCAPI needs to be configured for the site and portlet 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 Portlet application. Make sure to update the wsVars section with the correct URLs and username/password.

Setup

  1. Create a new page called 'ccapiPortlet'. It is recommended to create this page in the /webadmin/portlet/ subsite.
  2. Add each of the following Portlet App Elements to the page:
    1. PortletPodInstances
    2. PortletPodUserData
  3. Create a new page called 'ccapiPods'. It is recommended to create this page in the /webadmin/portlet/ subsite.
  4. Add each of the following Pod Types to the page:
    1. Links
    2. RSS_Feeds
    3. Simple_Content
    4. Weather
    5. Custom_File
  5. For each element that was added on both pages, click on the element indicator and go to 'more...'. Select 'Name' from the menu.
  6. In the Element Name field, enter the appropriate name for each element:
    1. ccapiPortletPodInstance
    2. ccapiPortletPodUserData
    3. ccapiPodTypeCustomFile
    4. ccapiPodTypeWeather
    5. ccapiPodTypeSimpleContent
    6. ccapiPodTypeRSSFeed
    7. ccapiPodTypeLinks
  7. Publish the pages and view in read mode.
  8. Edit the 'ccapi.cfm' (or ccapi.xml) file for the site and add the following xml blocks into the <elements> section:
    1. an example 'ccapi.cfm' (or ccapi.xml) file is in the pt_portlet > site-files > _cs_apps > config folder 
    <elements>
        <PortletPodInstance>
           <pageID>1567</pageID>
           <subsiteID>4</subsiteID>
           <elementType>custom</elementType>
           <controlName>ccapiPortletPodInstance</controlName>
       	</PortletPodInstance>
	<PortletPodUserData>
           <pageID>1567</pageID>
           <subsiteID>4</subsiteID>
           <elementType>custom</elementType>
           <controlName>ccapiPortletPodUserData</controlName>
       	</PortletPodUserData>
	<Custom_File>
           <pageID>1566</pageID>
           <subsiteID>4</subsiteID>
           <elementType>custom</elementType>
           <controlName>ccapiPodTypeCustomFile</controlName>
       	</Custom_File>
	<Weather>
           <pageID>1566</pageID>
           <subsiteID>4</subsiteID>
           <elementType>custom</elementType>
           <controlName>ccapiPodTypeWeather</controlName>
       	</Weather>
	<Simple_Content>
           <pageID>1566</pageID>
           <subsiteID>4</subsiteID>
           <elementType>custom</elementType>
           <controlName>ccapiPodTypeSimpleContent</controlName>
       	</Simple_Content>
	<RSS_Feed>
           <pageID>1566</pageID>
           <subsiteID>4</subsiteID>
           <elementType>custom</elementType>
           <controlName>ccapiPodTypeRSSFeed</controlName>
       	</RSS_Feed>
	<Links>
           <pageID>1566</pageID>
           <subsiteID>4</subsiteID>
           <elementType>custom</elementType>
           <controlName>ccapiPodTypeLinks</controlName>
       	</Links>
   </elements>

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_Portlet_CCAPI_Configuration&oldid=3741"