PT Profile CCAPI Configuration

From ADF Docs
Jump to: navigation, search

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.

Setup

Recommended to create a 'webadmin' subsite for this Profile CCAPI page.

  1. Create a new page called 'ccapiProfile'.
  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 source code and enter this numeric value into the <subsiteID> tag:
 var jsSubSiteID = ##;
  1. Identify the following line in the source code and enter this numeric value into the <pageID> tag:
 var jsPageID = ####;
  1. 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:
 ?resetServerADF=1&resetSiteADF=1

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!).