Difference between revisions of "ADF Installation"

From ADF Docs
Jump to: navigation, search
Line 1: Line 1:
 
== ADF Installation ==
 
== ADF Installation ==
 
The following steps outline the files to configure for your server.
 
The following steps outline the files to configure for your server.
 +
# Download the ADF (two options)
 +
#* Latest zip archive (http://cfusion6.paperthin.com/projects/ADF/)
 +
#* SVN (http://community.paperthin.com/svn/adf/)
 +
# 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.
 +
# Create a ColdFusion Mapping ( /ADF ) to the ADF directory
 +
# 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. 
 +
  
# Download the ADF
 
## The URL to the ADF file respository is: http://consulting.paperthin.com/svn/adf/
 
# 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.
 
# Set up the [[ColdFusion and Web Mappings|ColdFusion and Web Mappings]].
 
# The ADF has been set up for the server.  Next, 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.  See the [[Site Configuration|Site Configuration]] wiki page for more details.
 
 
# 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 not, then copy the ''custom-application.cfm'' to your sites root (ColdFusion restart is required).
+
#* 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 copy the contents of the starter ''custom-application.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).
 
# [[Reset ADF|Reset the ADF]] for the Server and Site.
 
# [[Reset ADF|Reset the ADF]] for the Server and Site.
  
 
== Related Guides ==
 
== Related Guides ==
 +
* [[Site Configuration|Site Configuration]]
 
* [[Create_New_App|Create New ADF Application]]
 
* [[Create_New_App|Create New ADF Application]]
 
* [[Add_New_Library_Component|Add New Component to Library]]
 
* [[Add_New_Library_Component|Add New Component to Library]]

Revision as of 02:45, 18 February 2010

ADF Installation

The following steps outline the files to configure for your server.

  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 copy the contents of the starter custom-application.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.

Related Guides