Difference between revisions of "ADF Installation"

From ADF Docs
Jump to: navigation, search
(Get the code and configure CF/Web)
(Set up the ADF to work with a site)
Line 16: Line 16:
 
# Copy the ''ADF.cfc'' and ''ajaxProxy.cfm'' into the sites ''/_cs_apps/'' directory.
 
# Copy the ''ADF.cfc'' and ''ajaxProxy.cfm'' into the sites ''/_cs_apps/'' directory.
 
# Identify if your site is currently using a ''custom-application.cfm'' file.   
 
# Identify if your site is currently using a ''custom-application.cfm'' file.   
#* If your site is running a ''custom-application.cfm'' file, then copy the contents of the starter ''custom-application.cfm'' into the top of your sites ''custom-application.cfm''.
+
#* If your site is running a ''custom-application.cfm'' file, then add a cfinclude tag with the template path of ''/ADF/core/load_site_adf.cfm'' into the top of your sites ''custom-application.cfm''.
 
#* If not, then copy the ''custom-application.cfm'' to your sites root (ColdFusion restart is required).
 
#* If not, then copy the ''custom-application.cfm'' to your sites root (ColdFusion restart is required).
 
# [[Reset ADF|Reset the ADF]] for the Server and Site.
 
# [[Reset ADF|Reset the ADF]] for the Server and Site.

Revision as of 12:24, 24 March 2010

Get the code and configure CF/Web

The following steps outline how to download the ADF and configure CommonSpot and your sites to use the ADF

  1. Download the ADF (two options)
  2. Copy the ADF directory to your server at the same level as the CommonSpot directory. The name of the folder is "ADF" and must be all capital letters. The ADF should not be created within a CommonSpot site directory.
  3. Create a ColdFusion Mapping ( /ADF ) to the ADF directory
  4. Create a Website Mapping ( /ADF ) to the ADF directory
Note: At this point the ADF has been set up for the server.

Set up the ADF to work with a site

Starter Files are located in the /ADF/core/site-sample directory. This contains a starter 'custom-application.cfm', 'ADF.cfc', and 'ajaxProxy.cfm'. These files contain the basic initialization code for the ADF configuration into a site.


  1. Copy the ADF.cfc and ajaxProxy.cfm into the sites /_cs_apps/ directory.
  2. Identify if your site is currently using a custom-application.cfm file.
    • If your site is running a custom-application.cfm file, then add a cfinclude tag with the template path of /ADF/core/load_site_adf.cfm into the top of your sites custom-application.cfm.
    • If not, then copy the custom-application.cfm to your sites root (ColdFusion restart is required).
  3. Reset the ADF for the Server and Site.
  4. You are good!
Note: you will need to repeat the steps in "Set up the ADF" for each site utilizing the ADF

Related Guides