Difference between revisions of "CCAPI Config"

Revision as of 16:29, 22 November 2009

Overview

The CCAPI uses the Core Config object to handle all of its site specific configuration. Essentially the CCAPI needs to know what the URL for the site is and other info like username/password.

Steps

To allow each site to have its own configuration for the CCAPI you can:

1. Locate the directory in your site '/_cs_apps/config/'. If this directory does not exist, then create it.
2. Place a file in this directory called "ccapi.xml".
3. Place the following XML content into this file

<?xml version="1.0" encoding="utf-8"?>
<settings>
  <logging>
       <enabled>1</enabled>
   </logging>
   <elements>
       <UniqueElementName>
           <pageID>30622</pageID>
           <subsiteID>1</subsiteID>
           <elementType>custom</elementType>
           <controlName>posts</controlName>
       </UniqueElementName>
   </elements>
   <wsVars>
       <webserviceURL>http://cfusion/commonspot/webservice/cs_service.cfc?wsdl</webserviceURL>
       <csuserid>csUserName</csuserid>
       <cspassword>csPassword</cspassword>
       <site>Demo</site>
       <siteURL>http://cfusion/demo</siteURL>
       <subsiteID>1</subsiteID>
       <cssites>commonspot-sites</cssites>
   </wsVars>
</settings>

XML Components

There are three major components to the CCAPI XML Config file:

1. <logging> this tag contains the flag to enable logging.
   
   
2. <elements> this contains the Custom Elements and Textblock elements that you would like to use. Be sure to see CCAPI Content page for more about how to add/edit data for Textblocks and Custom Elements.
   
   
3. <templates> this is a work in progress and may not remain as a goal of the CCAPI.
   
   
4. <wsVars> this node contains the Web Services information for your site.