Difference between revisions of "Overview"
From ADF Docs
(→Overview) |
|||
| Line 6: | Line 6: | ||
The ADF is a series of components and methodology to build apps within CommonSpot. | The ADF is a series of components and methodology to build apps within CommonSpot. | ||
| − | View the [[ | + | View the [[Licenses|License]] wiki page for licensing details. |
== Architecture == | == Architecture == | ||
The ADF is built on the LightWire object factory framework. The object factory is configured and saved in server scope. | The ADF is built on the LightWire object factory framework. The object factory is configured and saved in server scope. | ||
The directory structure is as follows: | The directory structure is as follows: | ||
| − | * [[ | + | * [[Apps|Apps]] - Location of the custom applications to be used throughout the server. |
| − | * [[ | + | * [[Core|Core]] - Configuration components that build and control the ADF. |
| − | * [[ | + | * [[Extensions|Extensions]] - Directory of custom scripts, custom field types, datasheet modules, render handlers, etc, that is used in development of custom applications. |
| − | * [[ | + | * [[Lib|Lib]] - Library of components. |
| − | * [[ | + | * [[ThirdParty|ThirdParty]] - Third party software that is used in the ADF. |
== Security == | == Security == | ||
| − | [[ | + | [[Security|Security]] |
== ADF Library == | == ADF Library == | ||
| Line 24: | Line 24: | ||
== Install Steps/Requirements == | == Install Steps/Requirements == | ||
| − | [[ | + | [[Installation|Installation Steps]] for the ADF on your server. |
* ColdFusion 8 | * ColdFusion 8 | ||
| Line 30: | Line 30: | ||
* CommonSpot 5.0.3 (Hot Fix 11) or above | * CommonSpot 5.0.3 (Hot Fix 11) or above | ||
| − | [[ | + | [[Naming Conventions|Naming Conventions]] |
== Custom Applications == | == Custom Applications == | ||
| − | * [[ | + | * [[Custom Application Configuration|Custom Application Configuration]] |
| − | * [[ | + | * [[Custom Application ADF Library Overrides|Custom Application ADF Library Overrides]] |
| − | * [[ | + | * [[Custom Application Site Level Configuration|Custom Application Site Level Configuration]] |
| − | * [[ | + | * [[Custom Application Site Level Customization|Custom Application Site Level Customization]] |
== Starter Application == | == Starter Application == | ||
| − | A [[ | + | A [[Starter Application|Starter Application]] can be used as a base to developing a new application. |
== Auto CFC Documentation == | == Auto CFC Documentation == | ||
| Line 51: | Line 51: | ||
== Known Issues/Bugs == | == Known Issues/Bugs == | ||
| − | * [[ | + | * [[Known_Issues|Known Issues]] |
Revision as of 02:58, 22 November 2009
Contents
Overview
The Application Development Framework (ADF) provides a common library of building blocks for CommonSpot custom applications. The ADF is located at the server level and is accessible in all sites on the server.
Visit the Term Glossary to understand the terminology used with the lightwire object factory.
The ADF is a series of components and methodology to build apps within CommonSpot.
View the License wiki page for licensing details.
Architecture
The ADF is built on the LightWire object factory framework. The object factory is configured and saved in server scope. The directory structure is as follows:
- Apps - Location of the custom applications to be used throughout the server.
- Core - Configuration components that build and control the ADF.
- Extensions - Directory of custom scripts, custom field types, datasheet modules, render handlers, etc, that is used in development of custom applications.
- Lib - Library of components.
- ThirdParty - Third party software that is used in the ADF.
Security
ADF Library
Library provided within the ADF.
Install Steps/Requirements
Installation Steps for the ADF on your server.
- ColdFusion 8
- Windows/Unix
- CommonSpot 5.0.3 (Hot Fix 11) or above
Custom Applications
- Custom Application Configuration
- Custom Application ADF Library Overrides
- Custom Application Site Level Configuration
- Custom Application Site Level Customization
Starter Application
A Starter Application can be used as a base to developing a new application.
Auto CFC Documentation
The documentation for the ADF library components is automated to view the metadata for the component files. This provides a self documenting process for the ADF library components.
To make this documentation process comprehensive, the component needs to be documented with the following:
- Component hints
- Function hints
- Argument hints
- Properties
