Difference between revisions of "Navigation CCAPI Setup"

Latest revision as of 19:13, 8 September 2010

Important: The Content Creation API (CCAPI) must be configured for your site. The CCAPI Configuration wiki page has instructions for configuration.

Create CCAPI page

• Create a new page called 'ccapi' (if it doesn't already exist).
• Add the 'Nav Element' custom element to the page.
• Select the 'Nav Element' element indicator and go to 'more...'. Select 'Name' from the menu.
• In the Element Name field, enter the text 'navElement'.
• Publish this page and put in read mode.

Edit ccapi.xml

• Edit the 'ccapi.xml' file for the site and add the following xml block into the <elements> section:

<navigation>
  <pageID>#####</pageID>
  <subsiteID>##</subsiteID>
  <elementType>custom</elementType>
  <controlName>navElement</controlName>
</navigation>

• To populate the <pageID> and <subsiteID> tags, view the source code for the 'ccapi' page that was just created.
• Identify the following line in the cs page source:

var jsSubSiteID = ##;

and enter this numeric value into the <subsiteID> tag:

• Identify the following line in the cs page source:

var jsPageID = ####;

and enter this numeric value into the <pageID> tag:

Reset ADF

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