Difference between revisions of "ADF Applications"

From ADF Docs
Jump to: navigation, search
m (moved Create New App to Create New ADF App: Made title more concise)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
== Guide to Creating a New ADF Application ==
+
== Overview ==
The following steps are instructions for creating a new application in the ADF.
+
<strong>What is an ADF Application?</strong>
  
# A 'Starter App' is provided in the '/ADF/apps/' directory. See the [[Starter_Application|Starter Application]] wiki page for more details.
+
ADF Applications are essentially a combination of:
# Copy this 'Starter App' directory into the apps directory and rename the folder to the name of your application.
+
* Custom code (e.g. custom scripts, render handlers, datasheet modules etc...)
# Open the 'AppBeanConfig.cfm' file in your applications directory. See the [[App Bean Config|App Bean Config]] wiki page for more details.
+
* CommonSpot Components (e.g. Custom Elements, Custom Field Types, Display Templates etc...)
# Update the 'appBeanName' variable with the name for your application and the comment header at the top of the file with your application name.
+
* CFC Components
<source lang="java">
 
// App specific variables
 
appBeanName = "STARTER_APP";
 
</source>
 
# Save the updated 'AppBeanConfig.cfm' file.
 
# [[Reset_ADF|Reset the ADF]] for the server and site.  
 
# If no error messages appear, then your application is configured within the ADF.
 
  
== Related Guides ==
+
<strong>What can I do with an ADF Application?</strong>
* Change Components in App
+
 
* Application Site Config
+
You can pretty much do anything with an ADF Application.  You can:
* ADF Library Overrides
+
* use it to control settings for your custom coding projects
* Application Site Level Customization
+
* build interfaces to Custom Elements to make it easier to integrate with Custom data
 +
* construct and distribute entire applications that drive core content management functionality like Profiles, Facebook Integration or Sharpoint connectivity.
 +
 
 +
<strong>What makes up an ADF Application</strong>
 +
 
 +
ADF Applications can contain many different parts and can be simple or complex.  Depending on what you are trying to accomplish will determine what makes up your application.  There are however 2 things that each ADF Application must have (in order to be considered a true application)
 +
# An [[App Bean Config|appBeanConfig.cfm]]
 +
# An [[Site_Configuration_(ADF.cfc)|App.cfc]] located in your applications /components directory.
 +
 
 +
ADF Application's however can also have any of the following:
 +
 
 +
* [[Application Components]]
 +
* [[Custom Field Types]]
 +
* [[Application Configuration at the Site Level (XML)]]
 +
* [[Application Configuration at the Site Level (Element)]]
 +
* [[CCAPI]] calls
 +
* [[Custom Application ADF Library Overrides]]
 +
* [[General Chooser]](s)
 +
 
 +
== Guides ==
 +
* [[Building an ADF Application]]
 +
* [[Best Practices for ADF Applications]]
 +
* [[Distributing your ADF Application]]
 +
* [[Documenting your ADF Application]]
 +
* [[Configure SVN for your ADF Application]]
 +
* [[Maintaining your ADF Application]]
  
 
[[Category: How-to Guide]]
 
[[Category: How-to Guide]]

Latest revision as of 16:36, 21 April 2010

Overview

What is an ADF Application?

ADF Applications are essentially a combination of:

  • Custom code (e.g. custom scripts, render handlers, datasheet modules etc...)
  • CommonSpot Components (e.g. Custom Elements, Custom Field Types, Display Templates etc...)
  • CFC Components

What can I do with an ADF Application?

You can pretty much do anything with an ADF Application. You can:

  • use it to control settings for your custom coding projects
  • build interfaces to Custom Elements to make it easier to integrate with Custom data
  • construct and distribute entire applications that drive core content management functionality like Profiles, Facebook Integration or Sharpoint connectivity.

What makes up an ADF Application

ADF Applications can contain many different parts and can be simple or complex. Depending on what you are trying to accomplish will determine what makes up your application. There are however 2 things that each ADF Application must have (in order to be considered a true application)

  1. An appBeanConfig.cfm
  2. An App.cfc located in your applications /components directory.

ADF Application's however can also have any of the following:

Guides