Difference between revisions of "PT Profile CCAPI Configuration"

From ADF Docs
Jump to: navigation, search
(Created page with '== Overview == The Profile Application uses the ADF CCAPI to populate profile records and create profile pages. This needs to be configured for the site and profile…')
 
(→‎Setup)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Overview ==
 
== Overview ==
−
The Profile Application uses the [[CS_CCAPI|ADF CCAPI]] to populate profile records and create profile pages.  This needs to be configured for the site and profile app.
+
The Profile Application uses the [[CCAPI|ADF CCAPI]] to populate profile records and create profile pages.  This needs to be configured for the site and profile app.
  
−
Follow the steps to setup the [[ADF_Library:CCAPI Config|CCAPI Config]] file for the site if this is not done.  Once this is completed, follow the steps below to setup the CCAPI config for the Profile App.  Make sure to update the ''wsVars'' section with the correct URL's and username/password.
+
Follow the steps to setup the [[CCAPI Config|CCAPI Config]] file for the site if this is not done.  Once this is completed, follow the steps below to setup the CCAPI config for the Profile App.  Make sure to update the ''wsVars'' section with the correct URL's and username/password.
 +
 
 +
'''Important:''' Make sure that the CommonSpot user account in the [[CCAPI_Config|CCAPI Configuration]] is a member of the Site Administrators group.
  
 
== Setup ==
 
== Setup ==
−
'''Recommended''' to create a 'webadmin' subsite for this Profile CCAPI page.
+
# Create a new page called 'ccapiProfile'.  Recommend creating this page in the ''/webadmin/profile/'' subsite.
−
 
 
−
# Create a new page called 'ccapiProfile'.   
 
 
# Add the 'Profile' element to the page.
 
# Add the 'Profile' element to the page.
 
# Select the 'Profile' element indicator and go to 'more...'.  Select 'Name' from the menu.
 
# Select the 'Profile' element indicator and go to 'more...'.  Select 'Name' from the menu.
Line 13: Line 13:
 
# Publish this page and put in read mode.
 
# Publish this page and put in read mode.
 
# Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:
 
# Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:
−
  <Profile>
+
<source lang="xml">
−
    <pageID>#####</pageID>
+
<Profile>
−
    <subsiteID>##</subsiteID>
+
  <pageID>#####</pageID>
−
    <elementType>custom</elementType>
+
  <subsiteID>##</subsiteID>
−
    <controlName>ccapiProfileElement</controlName>
+
  <elementType>custom</elementType>
−
  </Profile>
+
  <controlName>ccapiProfileElement</controlName>
 +
</Profile>
 +
</source>
 +
 
 
# To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiProfile' page that was just created.   
 
# To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiProfile' 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 page's source code and enter this numeric value into the <subsiteID> tag in the ccapi.xml config file:
−
  var jsSubSiteID = ##;
+
<source lang="java">
 +
var jsSubSiteID = ##;
 +
</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:
−
  var jsPageID = ####;
+
<source lang="java">
−
# The ADF needs to be reset for the server and site for these CCAPI updates to take effect. Enter the following URL parameter string to any page call within the site:
+
var jsPageID = ####;
−
  ?resetServerADF=1&resetSiteADF=1
+
</source>
−
'''Note: Resetting the ADF server might affect all sites implementing the ADF.'''  If an error occurs, this could cause sites to go down.  Needless to say, updates to the ADF Bean Configs and config files should be done in a controlled development environment (not on production servers!).
+
 
 +
[[Reset ADF|Reset the ADF]] for the server and site.
 +
 
 +
[[Category:Profile]]

Latest revision as of 18:19, 14 April 2010

Overview

The Profile Application uses the ADF CCAPI to populate profile records and create profile pages. This needs to be configured for the site and profile app.

Follow the steps to setup the CCAPI Config file for the site if this is not done. Once this is completed, follow the steps below to setup the CCAPI config for the Profile App. Make sure to update the wsVars section with the correct URL's and username/password.

Important: Make sure that the CommonSpot user account in the CCAPI Configuration is a member of the Site Administrators group.

Setup

  1. Create a new page called 'ccapiProfile'. Recommend creating this page in the /webadmin/profile/ subsite.
  2. Add the 'Profile' element to the page.
  3. Select the 'Profile' element indicator and go to 'more...'. Select 'Name' from the menu.
  4. In the Element Name field, enter the text 'ccapiProfileElement'.
  5. Publish this page and put in read mode.
  6. Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:
<Profile>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>ccapiProfileElement</controlName>
</Profile>
  1. To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapiProfile' page that was just created.
  2. Identify the following line in the page's source code and enter this numeric value into the <subsiteID> tag in the ccapi.xml config file:
var jsSubSiteID = ##;
  1. 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_Profile_CCAPI_Configuration&oldid=3486"