Documentation for ColdBox 2.6.0 Configuration File

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema elementFormDefault="qualified">
...
</xs:schema>
top

Global Declarations

Element: BugEmail

Name BugEmail
Used by (from the same schema document) Element BugTracerReports
Type Locally-defined simple type
Nillable no
Abstract no
Documentation The email address to send reports.
Logical Diagram
XML Instance Representation
<BugEmail> xs:string (length >= 1) </BugEmail>
Diagram
Schema Component Representation
<xs:element name="BugEmail">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: BugTracerReports

Name BugTracerReports
Used by (from the same schema document) Element Config
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This sections is used to declare email addresses for Bug Reports
Logical Diagram
XML Instance Representation
<BugTracerReports>
<BugEmail> ... </BugEmail> [0..*]
</BugTracerReports>
Diagram
h-193439861
Schema Component Representation
<xs:element name="BugTracerReports">
<xs:complexType>
<xs:sequence>
<xs:element ref=" BugEmail " maxOccurs="unbounded" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: Cache

Name Cache
Used by (from the same schema document) Element Config
Type Locally-defined complex type
Nillable no
Abstract no
Documentation These are the application caching settings. It overrides the framework-wide settings.
Logical Diagram
XML Instance Representation
<Cache>
Start All [1]
<ObjectDefaultTimeout> xs:integer </ObjectDefaultTimeout> [1]

'The default object timeout in minutes'

<ObjectDefaultLastAccessTimeout> xs:integer </ObjectDefaultLastAccessTimeout> [1]

'The default object last access timeout in minutes'

<ReapFrequency> xs:integer </ReapFrequency> [1]

'The frequency in which the cache is reaped.'

<MaxObjects> xs:integer </MaxObjects> [1]

'The maximum number of objects to cache.'

<FreeMemoryPercentageThreshold> xs:integer </FreeMemoryPercentageThreshold> [1]

'The amount of free memory threshold needed to cache. If memory goes below this threshold, objects will no longer be cached.'

<UseLastAccessTimeouts> xs:boolean </UseLastAccessTimeouts> [0..1]

'Whether to reap using last access timeouts alongside default object timeouts'

<EvictionPolicy> xs:string (value comes from list: {'LFU'|'LRU'}) </EvictionPolicy> [0..1]

'The default eviction policy'

End All
</Cache>
Diagram
Schema Component Representation
<xs:element name="Cache">
<xs:complexType>
<xs:all>
<xs:element name="ObjectDefaultTimeout" type=" xs:integer " maxOccurs="1" minOccurs="1"/>
<xs:element name="ObjectDefaultLastAccessTimeout" type=" xs:integer " maxOccurs="1" minOccurs="1"/>
<xs:element name="ReapFrequency" type=" xs:integer " maxOccurs="1" minOccurs="1"/>
<xs:element name="MaxObjects" type=" xs:integer " maxOccurs="1" minOccurs="1" default="0"/>
<xs:element name="FreeMemoryPercentageThreshold" type=" xs:integer " maxOccurs="1" minOccurs="1" default="0"/>
<xs:element name="UseLastAccessTimeouts" type=" xs:boolean " maxOccurs="1" minOccurs="0" default="true"/>
<xs:element name="EvictionPolicy" maxOccurs="1" minOccurs="0" default="LFU">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="LFU"/>
<xs:enumeration value="LRU"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
top

Element: Config

Name Config
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This is the holder for the frameworks configurations.
Logical Diagram
h-1530114522 h-1008548359 h-2063121817 h-2005365664 h-22778335 h-780327406 h1912682223 h-275837914 h-573566623 h-1905187861 h-634317729 h1221367665 h2064686655
XML Instance Representation
<Config>
Start All [1]
<Settings> ... </Settings> [1]
<YourSettings> ... </YourSettings> [0..1]
<DebuggerSettings> ... </DebuggerSettings> [0..1]
<MailServerSettings> ... </MailServerSettings> [0..1]
<BugTracerReports> ... </BugTracerReports> [0..1]
<DevEnvironments> ... </DevEnvironments> [0..1]
<WebServices> ... </WebServices> [0..1]
<Layouts> ... </Layouts> [1]
<i18N> ... </i18N> [0..1]
<Datasources> ... </Datasources> [0..1]
<Cache> ... </Cache> [0..1]
<Interceptors> ... </Interceptors> [0..1]
<Conventions> ... </Conventions> [0..1]
End All
</Config>
Diagram
h-1530114522 h-1008548359 h-2063121817 h-2005365664 h-22778335 h-780327406 h1912682223 h-275837914 h-573566623 h-1905187861 h-634317729 h1221367665 h2064686655
Schema Component Representation
<xs:element name="Config">
<xs:complexType>
<xs:all>
<xs:element ref=" Settings " maxOccurs="1" minOccurs="1"/>
<xs:element ref=" YourSettings " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" DebuggerSettings " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" MailServerSettings " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" BugTracerReports " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" DevEnvironments " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" WebServices " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" Layouts " maxOccurs="1" minOccurs="1"/>
<xs:element ref=" i18N " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" Datasources " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" Cache " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" Interceptors " maxOccurs="1" minOccurs="0"/>
<xs:element ref=" Conventions " maxOccurs="1" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
top

Element: Conventions

Name Conventions
Used by (from the same schema document) Element Config
Type Locally-defined complex type
Nillable no
Abstract no
Documentation These are the custom conventions you can place for your current application.
Logical Diagram
XML Instance Representation
<Conventions>
Start All [1]
<handlersLocation> xs:string </handlersLocation> [0..1]

'The default location of your handlers'

<pluginsLocation> xs:string </pluginsLocation> [0..1]

'The default location of your plugins'

<layoutsLocation> xs:string </layoutsLocation> [0..1]

'The default location of your layouts.'

<viewsLocation> xs:string </viewsLocation> [0..1]

'The default location of your views.'

<eventAction> xs:string </eventAction> [0..1]

'The default event action if not specified.'

End All
</Conventions>
Diagram
Schema Component Representation
<xs:element name="Conventions">
<xs:complexType>
<xs:all>
<xs:element name="handlersLocation" type=" xs:string " maxOccurs="1" minOccurs="0"/>
<xs:element name="pluginsLocation" type=" xs:string " maxOccurs="1" minOccurs="0"/>
<xs:element name="layoutsLocation" type=" xs:string " maxOccurs="1" minOccurs="0"/>
<xs:element name="viewsLocation" type=" xs:string " maxOccurs="1" minOccurs="0"/>
<xs:element name="eventAction" type=" xs:string " maxOccurs="1" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
top

Element: Datasource

Name Datasource
Used by (from the same schema document) Element Datasources
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A datasource declaration.
Logical Diagram
XML Instance Representation
<Datasource
alias=" xs:string [1]

'The alias of the registered datasource, for use in your application.'

"
name=" xs:string [1]

'The name of the registered datasource.'

"
username=" xs:string [0..1]

'The username of the datasource.'

"
password=" xs:string [0..1]

'The password of the datasource.'

"
dbtype=" xs:string [0..1]

'The type of database this datasource connects to.'

"/>
Diagram
Schema Component Representation
<xs:element name="Datasource">
<xs:complexType>
<xs:attribute name="alias" type=" xs:string " use="required"/>
<xs:attribute name="name" type=" xs:string " use="required"/>
<xs:attribute name="username" type=" xs:string " use="optional" default=""/>
<xs:attribute name="password" type=" xs:string " use="optional" default=""/>
<xs:attribute name="dbtype" type=" xs:string " use="optional" default=""/>
</xs:complexType>
</xs:element>
top

Element: Datasources

Name Datasources
Used by (from the same schema document) Element Config
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Useful declarations of all the datasources used by this application.
Logical Diagram
h631278984
XML Instance Representation
<Datasources>
<Datasource> ... </Datasource> [0..*]
</Datasources>
Diagram
h631278984
Schema Component Representation
<xs:element name="Datasources">
<xs:complexType>
<xs:sequence>
<xs:element ref=" Datasource " maxOccurs="unbounded" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DebuggerSettings

Name DebuggerSettings
Used by (from the same schema document) Element Config
Type Locally-defined complex type
Nillable no
Abstract no
Documentation These are the settings to configure the coldbox debugger
Logical Diagram
h46220628 h-495574957 h-1542657819 h-142946288
XML Instance Representation
<DebuggerSettings>
Start All [1]
<PersistentRequestProfiler> xs:boolean </PersistentRequestProfiler> [0..1]

'Whether to activate or not the request profile persisten storage'

<maxPersistentRequestProfilers> xs:integer </maxPersistentRequestProfilers> [0..1]

'The maximum number of request profilers to keep in the stack.'

<maxRCPanelQueryRows> xs:integer </maxRCPanelQueryRows> [0..1]

'The maximum number of records to dump on a query in the request collection panel.'

<TracerPanel
show=" xs:boolean [0..1]

'Whether to show or not this panel'

"
expanded=" xs:boolean [0..1]

'Whether this panel is expanded or not.'

"/> [0..1]

'The tracer panel info'

<InfoPanel
show=" xs:boolean [0..1]

'Whether to show or not this panel'

"
expanded=" xs:boolean [0..1]

'Whether this panel is expanded or not.'

"/> [0..1]

'The info panel info'

<CachePanel
show=" xs:boolean [0..1]

'Whether to show or not this panel'

"
expanded=" xs:boolean [0..1]

'Whether this panel is expanded or not.'

"/> [0..1]

'The cache panel info'

<RCPanel
show=" xs:boolean [0..1]

'Whether to show or not this panel'

"
expanded=" xs:boolean [0..1]

'Whether this panel is expanded or not.'

"/> [0..1]

'The request collection panel info'

End All
</DebuggerSettings>
Diagram
Schema Component Representation
<xs:element name="DebuggerSettings">
<xs:complexType>
<xs:all>
<xs:element name="PersistentRequestProfiler" type=" xs:boolean " maxOccurs="1" minOccurs="0" default="false"/>
<xs:element name="maxPersistentRequestProfilers" type=" xs:integer " maxOccurs="1" minOccurs="0"/>
<xs:element name="maxRCPanelQueryRows" type=" xs:integer " maxOccurs="1" minOccurs="0"/>
<xs:element name="TracerPanel" maxOccurs="1" minOccurs="0">
<xs:complexType>
<xs:attribute name="show" type=" xs:boolean " use="optional" default="true"/>
<xs:attribute name="expanded" type=" xs:boolean " use="optional" default="true"/>
</xs:complexType>
</xs:element>
<xs:element name="InfoPanel" maxOccurs="1" minOccurs="0">
<xs:complexType>
<xs:attribute name="show" type=" xs:boolean " use="optional" default="true"/>
<xs:attribute name="expanded" type=" xs:boolean " use="optional" default="true"/>
</xs:complexType>
</xs:element>
<xs:element name="CachePanel" maxOccurs="1" minOccurs="0">
<xs:complexType>
<xs:attribute name="show" type=" xs:boolean " use="optional" default="true"/>
<xs:attribute name="expanded" type=" xs:boolean " use="optional" default="false"/>
</xs:complexType>
</xs:element>
<xs:element name="RCPanel" maxOccurs="1" minOccurs="0">
<xs:complexType>
<xs:attribute name="show" type=" xs:boolean " use="optional" default="true"/>
<xs:attribute name="expanded" type=" xs:boolean " use="optional" default="false"/>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
top

Element: DefaultLayout

Name DefaultLayout
Used by (from the same schema document) Element Layouts
Type Locally-defined simple type
Nillable no
Abstract no
Documentation The mandatory default layout to use.
Logical Diagram
XML Instance Representation
<DefaultLayout> xs:string (length >= 1) </DefaultLayout>
Diagram
Schema Component Representation
<xs:element name="DefaultLayout">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: DefaultView

Name DefaultView
Used by (from the same schema document) Element Layouts
Type Locally-defined simple type
Nillable no
Abstract no
Documentation The optional default view to use if no view is set.
Logical Diagram
XML Instance Representation
<DefaultView> xs:string (length >= 1) </DefaultView>
Diagram
Schema Component Representation
<xs:element name="DefaultView">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
top

Element: DevEnvironments

Name DevEnvironments
Used by (from the same schema document) Element Config
Type Locally-defined complex type
Nillable no
Abstract no
Documentation You can define one or more development urls that the framework will decide wether its on development or production mode.
Logical Diagram
XML Instance Representation
<DevEnvironments>
<url> ... </url> [0..*]
</DevEnvironments>
Diagram
h674248108
Schema Component Representation
<xs:element name="DevEnvironments">
<xs:complexType>
<xs:sequence>
<xs:element ref=" url " maxOccurs="unbounded" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: Folder

Name Folder
Used by (from the same schema document) Element Layout
Type Locally-defined simple type
Nillable no
Abstract no
Documentation The name of the folder that will use the parent layout.
Logical Diagram
XML Instance Representation
<Folder> xs:string (length >= 1) </Folder>