[[Dashboard|<< Back to Dashboard]]

{|align="right"
| __TOC__
|}

[[Category:setup]]

= CFBuilder ColdBox Platform Utilities =

This extension helps you when building ColdBox Platform applications using [http://www.adobe.com/products/coldfusion-builder.html Adobe ColdFusion Builder].  It will help you get started with application skeletons, to configuring URL rewriting, security and so much more.

== Download ==
You can download the latest ColdBox extension from our extras download section: http://www.coldbox.org/download/extras or the forgebox entry: http://coldbox.org/forgebox/view/ColdBox-Platform-Utilities

== Auto Update ==
Right click on any project or folder and click on the '''Check For Extensions Updates...''' context menu.  This will contact [http://www.coldbox.org/forgebox ForgeBox] and verify the latest release of this extension.

<div align="center">
<img src="/imagelibrary/CPU_autoupdate.png" style="border: 1px outset #eaeaea">
</div>

== Installation ==

* Go to the ColdFusion Builder/Eclipse preferences dialog and click on the ''ColdFusion'' link to expand it.
* Now click on the ''Extensions'' in the left side panel.
* On the right panel click on the button ''Install...'' and search for the zip file that you downloaded.
* Follow the wizard and voila!

You can now right click on a project root, and some other trigger folders to get some of the following context menus:

<div align="center">
<img src="/imagelibrary/CPU_context1.png" style="border: 1px outset #eaeaea">
<img src="/imagelibrary/CPU_context2.png" style="border: 1px outset #eaeaea">
</div>

== Videos ==

=== v2.6 Release ===
<div>
<iframe src="http://player.vimeo.com/video/23833418?title=0&byline=0&portrait=0&color=80ceff" width="580" height="326" frameborder="0" />
</div>

=== v2.5 Release ===
<div>
<iframe src="http://player.vimeo.com/video/20302117" width="601" height="338" frameborder="0" />
</div>

== Project-Wide Features ==
The following features are available when right clicking on any folder or project root:

* '''Application generation''' : Choose from several different application templates.
* '''Generate handlers''' : Can generate handlers, actions, views and even integration tests.
* '''Generate plugins'''
* '''Generate model objects'''
* '''Generate interceptors'''
* '''Generate ColdBox Modules'''
* '''Install from ForgeBox'''

<div align="center">
<img src="/imagelibrary/CPU_handlerwizard.png" style="border: 1px outset #eaeaea">
</div>

== Project Only Features ==
The following features are available when right clicking on a project root:

* '''Configure URL rewrite engine''': The available rewrite engines are ''mod_rewrite'' and ''ISAPI Rewrite''

== Config Folder Features ==
The following features are available when right clicking on the application's ''config'' folder:

* '''Setup the Deploy interceptor''' : Creates a deploy tag, ANT script and configures the Deploy interceptor
* '''Setup the Security interceptor''' : Generation of a rules access file, validator object and Security interceptor
* '''Setup the Environment interceptor''' : Generates an environments settings file and configures the Environment control interceptor
* '''Setup Transfer ORM''': This will configure the application to use the Transfer loader interceptor and generate some basic transfer files
* '''Setup Reactor ORM''': This will configure the application to use the Reactor loader interceptor and generate some basic reactor files

== Modules Only Features ==

* The ability to generate new ColdBox modules when right clicking on a ''modules'' folder.

You can also tweak the module template skeleton by looking and updating in the following location:
<pre>
{ExtensionInstallation}/templates/modules
</pre>


<div align="center">
<img src="/imagelibrary/CPU_modulewizard.png" style="border: 1px outset #eaeaea">
</div>

== Creating Custom Application Templates ==
You can easily create your own application templates and have the plugin use them for application generation.  All you have to do is follow these nice steps:

# Create your application template and zip it up
# Create a folder under the following directory inside of the expanded extension: ''{extensionfolder}/skeletons/'' with the name of your skeleton. Example: ''CF9SimpleApp''
# Copy the zip file under this directory with any name you like. Example: ''CF9SimpleApp.zip''

That is it! The extension will now pick up your new application template.


<div align="center">
<img src="/imagelibrary/CPU_appwizard.png" style="border: 1px outset #eaeaea">
</div>


== Customizing Generation Templates ==
You can customize all the generation templates by looking in the ''{extensionfolder}/templates'' folder.  Here you will find all the templates used for generating content.