Squidhead

Configuration Reference

config['application']
These configurations all refer to settings for the application Squidhead will create.
config['application']['appname']
The name of the application you are creating
config['application']['CFCpathCFCStyle']
The CFC path of the CFC's that will be created for te application.
config['application']['cssPath']
The path to the css file that will style the created application.
config['application']['imagePath']
The path to the image file that will be the logo for the created application.
config['application']['steps']
An ordered array of the steps that squidhead will perform.
config['application']['url']
The url for the new application.
config['cfc']
These are CFC paths for squidhead CFC's which perform specialized functions.
config['cfc']['cfc']
The CFC path of the CFC that builds cfc code.
config['cfc']['cfstoredproc']
The CFC path of the CFC that builds cfstoredproc calls.
config['cfc']['cfUnitPath']
The CFC style path to the CFunit framework on your system. Defaults to CFUnit default.
config['cfc']['constants']
The CFC path of the CFC that holds certain database constants.
config['cfc']['customtag']
The CFC path of the CFC that builds customtags.
config['cfc']['database']
The CFC path of the CFC that inspects and presents the database structure.
config['cfc']['fk']
The CFC style path to the foreignkey cfc.
config['cfc']['function']
The CFC path of the CFC that builds cffunction code.
config['cfc']['functionHelper']
The CFC style path to the functionhelper cfc.
config['cfc']['help']
The CFC style path to the help cfc.
config['cfc']['sqlstoredproc']
The CFC path of the CFC that builds SQL storedprocedure calls in an active/delete table.
config['cfc']['sqlstoredprocactive']
The CFC path of the CFC that builds SQL storedprocedure calls in an active/deactivate table.
config['cfc']['table']
The CFC style path to the table cfc.
config['db']
These configurations all refer to settings for the database on which the create application will be built.
config['db']['datasource']
The ColdFusion datasource to use.
config['db']['password']
The database password to use.
config['db']['type']
The Type of DBMS to use. [Currently only MSSQL is valid]
config['db']['username']
The database username to use.
config['defaults']
These are default values used for certain data types.
config['defaults']['binary']
Default for BINARY
config['defaults']['boolean']
Default for booleans.
config['defaults']['CF_SQL_BIGINT']
Default for CF_SQL_BIGINT
config['defaults']['CF_SQL_BINARY']
Default for CF_SQL_BINARY
config['defaults']['CF_SQL_BIT']
Default for CF_SQL_BIT
config['defaults']['CF_SQL_BLOB']
Default for blobs
config['defaults']['CF_SQL_CHAR']
Default for CF_SQL_CHAR
config['defaults']['CF_SQL_CLOB']
Default for CLOBS
config['defaults']['CF_SQL_DECIMAL']
Default for CF_SQL_DECIMAL
config['defaults']['CF_SQL_FLOAT']
Default for CF_SQL_FlOAT
config['defaults']['CF_SQL_IDSTAMP']
Default for CF_SQL_IDSTAMP
config['defaults']['CF_SQL_INTEGER']
Default for CF_SQL_INTEGER
config['defaults']['CF_SQL_LONGVARBINARY']
Default for CF_SQL_LONGVARBINARY
config['defaults']['CF_SQL_LONGVARCHAR']
Default for CF_SQL_LONGVARCHAR
config['defaults']['CF_SQL_NUMERIC']
Default for CF_SQL_NUMERIC
config['defaults']['CF_SQL_REAL']
Default for CF_SQL_REAL
config['defaults']['CF_SQL_TIMESTAMP']
Default for CF_SQL_TIMESTAMP
config['defaults']['CF_SQL_TINYINT']
Default for CF_SQL_TINYINT
config['defaults']['CF_SQL_VARCHAR']
Default for CF_SQL_VARCHAR
config['defaults']['date']
Default for dates
config['defaults']['numeric']
Default for numeric.
config['defaults']['string']
Default for string.
config['fileLocations']
A collection of paths where Squidhead will create certain files.
config['fileLocations']['business']
The path in which to store all of the business files.(These aren't overwritten by Squidhead)
config['fileLocations']['businessdynamic']
Path where squidhead will store dynamically generated business objects.
config['fileLocations']['cfc']
The top level path of all of the CFC's cretaed by Squidhead.
config['fileLocations']['cfml']
The path in which to store all of the CFML form handling logic.
config['fileLocations']['config']
Path where squidhead will store dynamically generated config files currently only for ColdSpring.
config['fileLocations']['css']
The directory for CSS in the application that we are building.
config['fileLocations']['customtags']
The path in which to store all of the static customtag files.(These aren't overwritten by Squidhead)
config['fileLocations']['customtagsdynamic']
The path in which to store all of the dynamic customtag files.(These are overwritten by Squidhead)
config['fileLocations']['dao']
The path in which to store all of the static dao files.(These aren't overwritten by Squidhead)
config['fileLocations']['docs']
A location for storing documents produced by the buildDocumentation step.
config['fileLocations']['dynamicdao']
The path in which to store all of the dynamic dao files.(These are overwritten by Squidhead)
config['fileLocations']['dynamicgateway']
The path in which to store all of the dynamic gateway files.(These are overwritten by Squidhead)
config['fileLocations']['gateway']
The path in which to store all of the static gateway files.(These aren't overwritten by Squidhead)
config['fileLocations']['images']
A location for storing images that Squidhead generates.
config['fileLocations']['logs']
A log directory for various purposes for the application.
config['fileLocations']['output']
The top level path of your application.
config['fileLocations']['sql']
The path in which to store all output SQL code, if you are not autocreating the stored procedures, or are using the disk cache..
config['fileLocations']['temp']
A location for storing temporary files produced by image manipulation.
config['fileLocations']['test']
The root directory for CFUnit Tests to go in.
config['fileLocations']['testbusiness']
The directory for user created CFUnit Tests related to business objects
config['fileLocations']['testdao']
The directory for user created CFUnit Tests related to dao's
config['fileLocations']['testdynamicdao']
The directory for dynamically created CFUnit Tests related to dao's
config['fileLocations']['testdynamicgateway']
The directory for dynamically created CFUnit Tests related to gateways.
config['fileLocations']['testgateway']
The directory for user created CFUnit Tests related to gateways.
config['fileLocations']['testinterface']
The directory for dynamically created CFUnit Tests related to user interfaces.
config['fileLocations']['webroot']
The webroot of your server.
config['notify']
Settings for use in the notify step.
config['notify']['from']
A setting for just the notify step. It's the address from which send notification emails.
config['notify']['to']
A setting for just the notify step. It's the address to which send notification emails.
config['reservedwords']
These are words and strings that when you use in the database, will have a specific effect on the way Squidhead works with it.
config['reservedwords']['active']
Bit fields with this name will cause Squidhead to write delete and list functions that treat deleted records as deactivated (active = false). A good choice if you have a lot of foreign key's in your database.
config['reservedwords']['createdBy']
Any field with this name will only be accessible on Insert operations.
config['reservedwords']['createdOn']
A datetime field with this reserved word will be automatically set by the code Squidhead creates, and only on insert operations.
config['reservedwords']['excludedTablePrefix']
Tables that start with this string will be ignore by Squidhead.
config['reservedwords']['password']
Text fields with this name will appear as ********* in read and list ui's and as a password input in the edit ui.
config['reservedwords']['updatedBy']
No restrictions.
config['reservedwords']['updatedOn']
A date field with this reserved word will be automatically set by the code Squidhead creates.
config['settings']
These are general settings that determines how Squidhead runs.
config['settings']['applicationTemplate']
The UI template to use. Currently there are only two default or simple. In the future there may be more. Alternately, you can create your own templates, and they won't be overwrittne by updating.
config['settings']['dboprocs']
The verbs used in procedures that will be placed in DBO CFC's.
config['settings']['defaultFunctionAccess']
Default access to give to the functions created in your cfc's.
config['settings']['excludedTableList']
A comma separated list of excluded tables.
config['settings']['generateSQLScript']
Whether or not to create SQL scripts for creating the procedures instead of writing them directly to the database.
config['settings']['generateStoredProcedureFiles']
Whether or not to have Squidhead create SQL files for adding adding and dropping every stored procedure individually.
config['settings']['ignoreXMLCache']
Setting instructs Squidhead to ignore the XMLCache when inspecting the database. Will speed up process at cost of not overiding values from the XMLCache.
config['ui']
Various settings that deal with using ColdFusion 8 UI components
config['ui']['DateField']
Whether or not to use the cfinput type=datefield option for datetime columns.
config['ui']['ImageListWidth']
The width to resize images to in the list view.
config['ui']['ImageReadWidth']
The width to resize images to in the read view.
config['ui']['Images']
Whether or not to use cfimage to deal with images in the application.
config['ui']['logoBuild']
Whether or not to build a Web 2.0 logo. By default this is yes in Windows, no in Mac. The Mac had issues with Cfimage, and since it was such a little plus, I just deactivated it.
config['ui']['LogoFont']
The default font to use with the Web 2.0 logo. Defaults to Arial on Windows, Helvetica on Mac (IF the issues with logoBuild get fixed.)
config['ui']['RichTextAreas']
Whether or not to use the cftextarea richtext option for text columns.
config['ui']['RichTextAreasSkin']
Which skin to use with the richtext option.
config['ui']['RichTextAreasToolbar']
Which toolbar to use with the richtext option.