Difference between revisions of "CCAPI Config"

Revision as of 22:58, 20 December 2009

Overview

The CCAPI uses the Core Config object to handle its site specific configuration. The CCAPI simply needs the URL for the site and other key information like username and password.

Steps

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

1. Locate the '/_cs_apps/config/' directory in your site. If this directory does not exist, create it.
2. Place a file in this directory called "ccapi.xml".
3. Place the following XML content into the ccapi.xml 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 in the CCAPI XML Config file:

1. <logging> This tag contains the flag to enable logging.
   
   
2. <elements> This tag contains the Custom Elements and Textblock elements that you would like to use. Be sure to see CCAPI Content page for additional information about how to add/edit data within Textblocks and Custom Elements.
   
   
3. <templates> This tag 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.