Reserved Settings Guide

Introduction

This guide will show you which settings are reserved for framework operation. The way you can override settings is via the yoursettings element in the configuration file or if you dynamically set a setting using the setSetting() method. I won't go into much detail of what each setting is, just know that it is used internally as a reserved setting.

Reserved Settings

AppMapping The application's mapping
AppName The name of the application
ApplicationPath The physical application path
ApplicationStartHandler The application start handler
BugEmails The bug emails list
CacheSettings The cache structure
ColdboxLogsLocation The physical path of the log file
ConfigAutoReload Flag to reload application every time (dev)
ConfigTimeStamp The timestamp of the loaded configuration file
CustomErrorTemplate The relative or mapping path of the error template
Datasources The datasources structure
DebugMode The default debug mode
DebugPassword The debug mode password
DefaultEvent The default event
DefaultLayout The default layout
DefaultLocale The default locale
DefaultResourceBundle The physical path of the default resource bundle
DefaultView The default view
DevEnvironments The development environments structure
EnableBugReports Flag to enable/disable bug reports
EnableColdboxLogging Flag to enable coldbox logging
EnableColdfusionLogging Flag to enable coldfusion logging
EnableDumpVar Enable the dumpvar url action
Environment The environment you are on (Development|Production)
EventName The name of the event action variable
ExceptionHandler The exception handler
HandlerCaching Flag to use or not handler caching
HandlerIndexAutoReload Flag for reloading the handler's index.
HandlersInvocationPath The base handler invocation path
HandlersPath The physical handler path
htmlBaseURL Set by the ses interceptor
IOCDefinitionFile The relative or mapping path of IoC configuration file or object
IOCFramework The IoC Framework
IOCObjectCaching Flag to activate IoC caching
LocaleStorage The locale storage scope
MailPassword The mail server password
MailPort The mail port
MailServer The mail server
MailUsername The mail username
MessageboxStyleOverride The override flag for the messagebox
MyPluginsInvocationPath The plugins base invocation path
MyPluginsLocation The external plugins invocation path
MyPluginsPath The physical path of the plugins
OwnerEmail The owner email address
RBundles The structure that holds resource bundles
ReinitPassword The framework reinit password
RequestEndHandler The request end handler
RequestStartHandler The request start handler
sesBaseURL Set by the ses interceptor
UDFLibraryFile The relative or absolute UDF library to mix-in
ViewLayouts The view layouts structure combination
WebServices The declared webservices structure
onInvalidEvent The invalid event to execute
using_i18N Flag to determine if i18N is being used

Conclusion

Please try not to override these settings unless you know what you are doing. They are there to define your application.


Copyright 2006 ColdBox Framework by Luis Majano