PT Profile CCAPI Configuration - Revision history

Mcarroll: /* Setup */

2010-04-14T18:19:25Z

‎Setup

Mcarroll at 18:16, 14 April 2010

2010-04-14T18:16:55Z

Mcarroll: /* Setup */

2010-03-26T19:29:09Z

‎Setup

Mcarroll: /* Setup */

2010-03-26T19:28:01Z

‎Setup

Mcarroll: /* Setup */

2010-03-26T19:27:19Z

‎Setup

Mcarroll: moved PT Profile CCAPI Setup to PT Profile CCAPI Configuration

2010-03-26T19:25:45Z

moved PT Profile CCAPI Setup to PT Profile CCAPI Configuration

Renee.mckechnie at 01:48, 24 December 2009

2009-12-24T01:48:23Z

Renee.mckechnie at 17:20, 22 November 2009

2009-11-22T17:20:32Z

Renee.mckechnie: 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…'

2009-11-22T17:19:37Z

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…'

New page

== 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.

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.

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

# Create a new page called 'ccapiProfile'.
# Add the 'Profile' element to the page.
# Select the 'Profile' element indicator and go to 'more...'. Select 'Name' from the menu.
# In the Element Name field, enter the text 'ccapiProfileElement'.
# 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:
<Profile>
<pageID>#####</pageID>
<subsiteID>##</subsiteID>
<elementType>custom</elementType>
<controlName>ccapiProfileElement</controlName>
</Profile>
# 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:
var jsSubSiteID = ##;
# Identify the following line in the source code and enter this numeric value into the <pageID> tag:
var jsPageID = ####;
# 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!).

← Older revision		Revision as of 18:16, 14 April 2010
Line 3:		Line 3:

	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.		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 ==

← Older revision		Revision as of 01:48, 24 December 2009
Line 27:		Line 27:
	?resetServerADF=1&resetSiteADF=1		?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!).		'''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!).
		+
		+	[[Category:Profile]]

@@ Line 23: / Line 23: @@
 # 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:
 <source lang="java">
 var jsSubSiteID = ##;

@@ Line 22: / Line 22: @@
 # 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:
-  var jsSubSiteID = ##;
+<source lang="java">
 # 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!).
 [[Category:Profile]]

@@ Line 5: / Line 5: @@
 == 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.
 # Add the 'Profile' element to the page.
 # 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.
 # 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>
 # 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:

← Older revision	Revision as of 19:25, 26 March 2010
(No difference)

@@ Line 1: / Line 1: @@
 == 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.
 == Setup ==