Table of Contents
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 >
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 the bug tracing reports configuration.
XML Instance Representation
<BugTracerReports
enabled="
xs :boolean
[0..1]
'Use to turn on bugtracer reports.'
" >
<MailFrom> ... </MailFrom>
[0..1]
'The from email address to send from.'
<CustomEmailBugReport> ... </CustomEmailBugReport>
[0..1]
'The location of the custom bug report to use.'
<BugEmail>
xs :string (length >= 1) </BugEmail>
[0..*]
'The email address to send reports.'
</BugTracerReports>
Schema Component Representation
<
xs:element
name ="
BugTracerReports ">
<
xs:complexType >
<
xs:sequence >
<xs:element
name ="MailFrom " maxOccurs ="1 " minOccurs ="0 "/>
<xs:element
name ="CustomEmailBugReport " maxOccurs ="1 " minOccurs ="0 "/>
<
xs:element
name ="
BugEmail "
maxOccurs ="
unbounded "
minOccurs ="
0 ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:minLength
value ="1 "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:element >
</
xs:sequence >
<
xs:attribute
name ="
enabled "
type ="
xs :boolean
"
default ="
false "
use ="
optional "/>
</
xs:complexType >
</
xs:element >
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.
XML Instance Representation
<Cache>
Start All
[1]
<ObjectDefaultTimeout>
xs :integer </ObjectDefaultTimeout>
[0..1]
'The default object timeout in minutes'
<ObjectDefaultLastAccessTimeout>
xs :integer </ObjectDefaultLastAccessTimeout>
[0..1]
'The default object last access timeout in minutes'
<ReapFrequency>
xs :integer </ReapFrequency>
[0..1]
'The frequency in which the cache is reaped.'
<MaxObjects>
xs :integer </MaxObjects>
[0..1]
'The maximum number of objects to cache.'
<FreeMemoryPercentageThreshold>
xs :integer </FreeMemoryPercentageThreshold>
[0..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'|'FIFO'}) </EvictionPolicy>
[0..1]
'The eviction policy to use in the caching engine'
<EvictCount>
xs :integer </EvictCount>
[0..1]
'The evict count to use when evicting objects, the default is 1.'
End All
</Cache>
Schema Component Representation
<
xs:element
name ="
Cache ">
<
xs:complexType >
<
xs:all >
<
xs:element
name ="
ObjectDefaultTimeout "
type ="
xs :integer
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
60 "/>
<
xs:element
name ="
ObjectDefaultLastAccessTimeout "
type ="
xs :integer
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
15 "/>
<
xs:element
name ="
ReapFrequency "
type ="
xs :integer
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
1 "/>
<
xs:element
name ="
MaxObjects "
type ="
xs :integer
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
100 "/>
<
xs:element
name ="
FreeMemoryPercentageThreshold "
type ="
xs :integer
"
maxOccurs ="
1 "
minOccurs ="
0 "
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:enumeration
value ="FIFO "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:element >
<
xs:element
name ="
EvictCount "
type ="
xs :integer
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
1 "/>
</
xs:all >
</
xs:complexType >
</
xs:element >
Name
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
This is the holder for the frameworks configurations.
XML Instance Representation
<Config>
Start All
[1]
End All
</Config>
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 ="
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:element
ref ="
LogBox
"
maxOccurs ="
1 "
minOccurs ="
0 "/>
<
xs:element
ref ="
IOC
"
maxOccurs ="
1 "
minOccurs ="
0 "/>
<
xs:element
ref ="
Models
"
maxOccurs ="
1 "
minOccurs ="
0 "/>
</
xs:all >
</
xs:complexType >
</
xs:element >
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.
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.'
<modelsLocation>
xs :string </modelsLocation>
[0..1]
'The default location of your models.'
End All
</Conventions>
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:element
name ="
modelsLocation "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "/>
</
xs:all >
</
xs:complexType >
</
xs:element >
Name
Datasource
Used by (from the same schema document)
Element
Datasources
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
A datasource declaration.
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.'
" />
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 >
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.
XML Instance Representation
<Datasources>
</Datasources>
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 >
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
XML Instance Representation
<DebuggerSettings>
Start All
[1]
<EnableDumpVar>
xs :boolean </EnableDumpVar>
[0..1]
'Whether to activate the dumpVar URL action or not.'
<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>
Schema Component Representation
<
xs:element
name ="
DebuggerSettings ">
<
xs:complexType >
<
xs:all >
<
xs:element
name ="
EnableDumpVar "
type ="
xs :boolean
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
false "/>
<
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 >
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.
XML Instance Representation
<DefaultLayout>
xs :string (length >= 1) </DefaultLayout>
Schema Component Representation
<
xs:element
name ="
DefaultLayout ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:minLength
value ="1 "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:element >
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.
XML Instance Representation
<DefaultView>
xs :string (length >= 1) </DefaultView>
Schema Component Representation
<
xs:element
name ="
DefaultView ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:minLength
value ="1 "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:element >
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.
XML Instance Representation
<Folder>
xs :string (length >= 1) </Folder>
Schema Component Representation
<
xs:element
name ="
Folder ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:minLength
value ="1 "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:element >
Element: i18N
Name
i18N
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
Internationalization Section.
XML Instance Representation
<i18N>
Start All
[1]
<DefaultResourceBundle>
xs :string </DefaultResourceBundle>
[0..1]
'The path to the resource bundle to load.'
<DefaultLocale>
xs :string </DefaultLocale>
[0..1]
'The default locale in the standard Java locale names'
<LocaleStorage>
xs :string (value comes from list: {'client'|'session'|'cookie'}) </LocaleStorage>
[0..1]
'The storage scope of the locale setting. Preferred is session.'
<UnknownTranslation>
xs :string </UnknownTranslation>
[0..1]
'The key to use when a translation is not found. default is _UNKNOWNTRANSLATION_'
End All
</i18N>
Schema Component Representation
<
xs:element
name ="
i18N ">
<
xs:complexType >
<
xs:all >
<
xs:element
name ="
DefaultResourceBundle "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "
default =""/>
<
xs:element
name ="
DefaultLocale "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "/>
<
xs:element
name ="
LocaleStorage "
maxOccurs ="
1 "
minOccurs ="
0 ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="client "/>
<xs:enumeration
value ="session "/>
<xs:enumeration
value ="cookie "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:element >
<
xs:element
name ="
UnknownTranslation "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "
default =""/>
</
xs:all >
</
xs:complexType >
</
xs:element >
Name
Interceptors
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
These are the coldbox interceptor declarations
XML Instance Representation
<Interceptors
throwOnInvalidStates="
xs :boolean
[0..1]
'Flag that determines if the interceptor service throws an error when an invalid state is announced.'
" >
<CustomInterceptionPoints>
xs :string </CustomInterceptionPoints>
[0..1]
'A comma delimmited list of custom interception points to declare an use.'
<Interceptor
class="
xs :string
[1]
'The instantiation class of the interceptor.'
"
name="
xs :string
[0..1]
'The unique name to use for this interceptor. If not set, we will use the interceptor\'s cfc name.'
" >
[0..*]
'An interceptor declaration.'
<Property
name="
xs :string
[1]
'The name of the property'
" >
[0..*]
'A property of the interceptor, can be simple or complex via ColdBox complex properties'
xs :string
</Property>
</Interceptor>
</Interceptors>
Schema Component Representation
<
xs:element
name ="
Interceptors ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
name ="
CustomInterceptionPoints "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "
default =""/>
<
xs:element
name ="
Interceptor "
minOccurs ="
0 "
maxOccurs ="
unbounded ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
name ="
Property "
maxOccurs ="
unbounded "
minOccurs ="
0 ">
<
xs:complexType >
<
xs:simpleContent >
<
xs:extension
base ="
xs :string
">
<
xs:attribute
name ="
name "
type ="
xs :string
"
use ="
required "/>
</
xs:extension >
</
xs:simpleContent >
</
xs:complexType >
</
xs:element >
</
xs:sequence >
<
xs:attribute
name ="
class "
type ="
xs :string
"
use ="
required "/>
<
xs:attribute
name ="
name "
type ="
xs :string
"
use ="
optional "/>
</
xs:complexType >
</
xs:element >
</
xs:sequence >
<
xs:attribute
name ="
throwOnInvalidStates "
type ="
xs :boolean
"
use ="
optional "
default ="
true "/>
</
xs:complexType >
</
xs:element >
Element: IOC
Name
IOC
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
These are the IOC settings for ColdBox.
XML Instance Representation
<IOC>
Start All
[1]
<Framework
type="
xs :string (value comes from list: {'coldspring'|'lightwire'})
[1]
'The IOC framework type: coldspring or lightwire.'
"
objectCaching="
xs :boolean
[0..1]
'The use object caching or not by the IOC plugin'
"
reload="
xs :boolean
[0..1]
'Reload the IOC framework on each request for development purposes'
" >
[0..1]
'The IOC frammework to declare. The text contents is the definition file.'
xs :string
</Framework>
<ParentFactory
type="
xs :string (value comes from list: {'coldspring'|'lightwire'})
[1]
'The IOC framework type: coldspring or lightwire.'
" >
[0..1]
'The parent IOC frammework to add to the ioc framework. The text contents is the definition file.'
xs :string
</ParentFactory>
End All
</IOC>
Schema Component Representation
<
xs:element
name ="
IOC ">
<
xs:complexType >
<
xs:all >
<
xs:element
name ="
Framework "
maxOccurs ="
1 "
minOccurs ="
0 ">
<
xs:complexType >
<
xs:simpleContent >
<
xs:extension
base ="
xs :string
">
<
xs:attribute
name ="
type "
use ="
required ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="coldspring "/>
<xs:enumeration
value ="lightwire "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:attribute >
<
xs:attribute
name ="
objectCaching "
type ="
xs :boolean
"
use ="
optional "
default ="
false "/>
<
xs:attribute
name ="
reload "
type ="
xs :boolean
"
use ="
optional "
default ="
false "/>
</
xs:extension >
</
xs:simpleContent >
</
xs:complexType >
</
xs:element >
<
xs:element
name ="
ParentFactory "
maxOccurs ="
1 "
minOccurs ="
0 ">
<
xs:complexType >
<
xs:simpleContent >
<
xs:extension
base ="
xs :string
">
<
xs:attribute
name ="
type "
use ="
required ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="coldspring "/>
<xs:enumeration
value ="lightwire "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:attribute >
</
xs:extension >
</
xs:simpleContent >
</
xs:complexType >
</
xs:element >
</
xs:all >
</
xs:complexType >
</
xs:element >
Name
Layout
Used by (from the same schema document)
Element
Layouts
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
A layout declaration to be used for the children views declared.
XML Instance Representation
<Layout
file="
xs :string
[1]
'The filename of the layout template.'
"
name="
xs :string
[1]
'A reference name to the layout.'
" >
Start Choice
[1..*]
End Choice
</Layout>
Schema Component Representation
<
xs:element
name ="
Layout ">
<
xs:complexType >
<
xs:choice
maxOccurs ="
unbounded ">
<
xs:element
ref ="
View
"
maxOccurs ="
unbounded "
minOccurs ="
0 "/>
<
xs:element
ref ="
Folder
"
maxOccurs ="
unbounded "
minOccurs ="
0 "/>
</
xs:choice >
<
xs:attribute
name ="
file "
type ="
xs :string
"
use ="
required "/>
<
xs:attribute
name ="
name "
type ="
xs :string
"
use ="
required "/>
</
xs:complexType >
</
xs:element >
Name
Layouts
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
Template layout definitions.
Schema Component Representation
<
xs:element
name ="
Layouts ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
ref ="
DefaultView
"
minOccurs ="
0 "
maxOccurs ="
1 "/>
<
xs:element
ref ="
Layout
"
maxOccurs ="
unbounded "
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:complexType >
</
xs:element >
Name
LogBox
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
This is how you configure the ColdBox Logging Library: LogBox
XML Instance Representation
<LogBox>
<Appender
name="
xs :ID
[1]
'The name of the registered appender.'
"
class="
xs :string
[1]
'The instantiation class of the appender.'
"
layout="
xs :string
[0..1]
'A custom layout class to use with this appender.'
" >
[1..*]
'An Appender declaration.'
<Property
name="
xs :string
[1]
'The name of the property'
" >
[0..*]
'A property of the appender, can be simple or complex via ColdBox complex properties'
xs :string
</Property>
</Appender>
<Root
levelMin="
xs :string (value comes from list: {'OFF'|'FATAL'|'ERROR'|'WARN'|'INFO'|'DEBUG'})
[0..1]
'The minimum logging level for this root logger.'
"
levelMax="
xs :string (value comes from list: {'OFF'|'FATAL'|'ERROR'|'WARN'|'INFO'|'DEBUG'})
[1]
'The maximum logging level for this root logger.'
"
appenders="
xs :string
[0..1]
'*=all appender or optional configuration of appenders, else use Appender-ref'
" >
[1]
'The root logger definition.'
<Appender-ref
ref="
xs :IDREF
[1]
'The appender reference name'
" >
[0..*]
'An appender reference for the root logger'
xs :string
</Appender-ref>
</Root>
<Category
name="
xs :string
[1]
'The name of the category to configure.'
"
levelMin="
xs :string (value comes from list: {'OFF'|'FATAL'|'ERROR'|'WARN'|'INFO'|'DEBUG'})
[0..1]
'The minimum logging level for this root logger.'
"
levelMax="
xs :string (value comes from list: {'OFF'|'FATAL'|'ERROR'|'WARN'|'INFO'|'DEBUG'})
[0..1]
'The maximum logging level for this root logger.'
"
appenders="
xs :string
[0..1]
'*=all appender or optional configuration of appenders, else use Appender-ref'
" >
[0..*]
'A category definition.'
<Appender-ref
ref="
xs :IDREF
[1]
'The appender reference name'
" >
[0..*]
'An appender reference for thi category'
xs :string
</Appender-ref>
</Category>
</LogBox>
Schema Component Representation
<
xs:element
name ="
LogBox ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
name ="
Appender "
minOccurs ="
1 "
maxOccurs ="
unbounded ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
name ="
Property "
maxOccurs ="
unbounded "
minOccurs ="
0 ">
<
xs:complexType >
<
xs:simpleContent >
<
xs:extension
base ="
xs :string
">
<
xs:attribute
name ="
name "
type ="
xs :string
"
use ="
required "/>
</
xs:extension >
</
xs:simpleContent >
</
xs:complexType >
</
xs:element >
</
xs:sequence >
<
xs:attribute
name ="
name "
type ="
xs :ID
"
use ="
required "/>
<
xs:attribute
name ="
class "
type ="
xs :string
"
use ="
required "/>
<
xs:attribute
name ="
layout "
type ="
xs :string
"
use ="
optional "
default =""/>
</
xs:complexType >
</
xs:element >
<
xs:element
name ="
Root "
minOccurs ="
1 "
maxOccurs ="
1 ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
name ="
Appender-ref "
maxOccurs ="
unbounded "
minOccurs ="
0 ">
<
xs:complexType >
<
xs:simpleContent >
<
xs:extension
base ="
xs :string
">
<
xs:attribute
name ="
ref "
type ="
xs :IDREF
"
use ="
required "/>
</
xs:extension >
</
xs:simpleContent >
</
xs:complexType >
</
xs:element >
</
xs:sequence >
<
xs:attribute
name ="
levelMin "
use ="
optional ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="OFF "/>
<xs:enumeration
value ="FATAL "/>
<xs:enumeration
value ="ERROR "/>
<xs:enumeration
value ="WARN "/>
<xs:enumeration
value ="INFO "/>
<xs:enumeration
value ="DEBUG "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:attribute >
<
xs:attribute
name ="
levelMax "
use ="
required ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="OFF "/>
<xs:enumeration
value ="FATAL "/>
<xs:enumeration
value ="ERROR "/>
<xs:enumeration
value ="WARN "/>
<xs:enumeration
value ="INFO "/>
<xs:enumeration
value ="DEBUG "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:attribute >
<
xs:attribute
name ="
appenders "
type ="
xs :string
"
use ="
optional "/>
</
xs:complexType >
</
xs:element >
<
xs:element
name ="
Category "
minOccurs ="
0 "
maxOccurs ="
unbounded ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
name ="
Appender-ref "
maxOccurs ="
unbounded "
minOccurs ="
0 ">
<
xs:complexType >
<
xs:simpleContent >
<
xs:extension
base ="
xs :string
">
<
xs:attribute
name ="
ref "
type ="
xs :IDREF
"
use ="
required "/>
</
xs:extension >
</
xs:simpleContent >
</
xs:complexType >
</
xs:element >
</
xs:sequence >
<
xs:attribute
name ="
name "
type ="
xs :string
"
use ="
required "/>
<
xs:attribute
name ="
levelMin "
use ="
optional ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="OFF "/>
<xs:enumeration
value ="FATAL "/>
<xs:enumeration
value ="ERROR "/>
<xs:enumeration
value ="WARN "/>
<xs:enumeration
value ="INFO "/>
<xs:enumeration
value ="DEBUG "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:attribute >
<
xs:attribute
name ="
levelMax "
use ="
optional ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="OFF "/>
<xs:enumeration
value ="FATAL "/>
<xs:enumeration
value ="ERROR "/>
<xs:enumeration
value ="WARN "/>
<xs:enumeration
value ="INFO "/>
<xs:enumeration
value ="DEBUG "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:attribute >
<
xs:attribute
name ="
appenders "
type ="
xs :string
"
use ="
optional "/>
</
xs:complexType >
</
xs:element >
</
xs:sequence >
</
xs:complexType >
</
xs:element >
Name
MailServerSettings
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
These are global mail settings
XML Instance Representation
<MailServerSettings>
<MailServer> ... </MailServer>
[0..1]
'The ip or address of the mail server to declare'
<MailPort> ... </MailPort>
[0..1]
'The port of the mail server. Default is 25'
<MailUsername> ... </MailUsername>
[0..1]
'The username of the mail server, if used.'
<MailPassword> ... </MailPassword>
[0..1]
'The password of the mail server, if used.'
</MailServerSettings>
Schema Component Representation
<
xs:element
name ="
MailServerSettings ">
<
xs:complexType >
<
xs:sequence >
<xs:element
name ="MailServer " maxOccurs ="1 " minOccurs ="0 "/>
<xs:element
name ="MailPort " maxOccurs ="1 " minOccurs ="0 " default ="25 "/>
<xs:element
name ="MailUsername " maxOccurs ="1 " minOccurs ="0 "/>
<xs:element
name ="MailPassword " maxOccurs ="1 " minOccurs ="0 "/>
</
xs:sequence >
</
xs:complexType >
</
xs:element >
Name
Models
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
These are the model integration settings for ColdBox.
XML Instance Representation
<Models>
Start All
[1]
<ExternalLocation>
xs :string </ExternalLocation>
[0..1]
'The external locations for model objects (comma-delimitted).'
<ObjectCaching>
xs :boolean </ObjectCaching>
[0..1]
'Activates persistence for model objects, use false in development mode only.'
<DefinitionFile>
xs :string </DefinitionFile>
[0..1]
'The file containting the model integration mappings and defnitions.'
<SetterInjection>
xs :boolean </SetterInjection>
[0..1]
'To activate setter injection on model objects or not'
<DICompleteUDF>
xs :string </DICompleteUDF>
[0..1]
'The method name to use for post processing of a model object when created and configured'
<StopRecursion>
xs :string </StopRecursion>
[0..1]
'The class paths (comma-delimmitted) that the coldbox bean factory will stop recursion on when searching for dependencies.'
<ParentFactory
type="
xs :string (value comes from list: {'coldspring'|'lightwire'})
[1]
'The IOC framework type: coldspring or lightwire.'
" >
[0..1]
'The parent IOC frammework to add to the model integration features of ColdBox. The text contents is the definition file.'
xs :string
</ParentFactory>
End All
</Models>
Schema Component Representation
<
xs:element
name ="
Models ">
<
xs:complexType >
<
xs:all >
<
xs:element
name ="
ExternalLocation "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "
default =""/>
<
xs:element
name ="
ObjectCaching "
type ="
xs :boolean
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
false "/>
<
xs:element
name ="
DefinitionFile "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
config/ModelMappings.cfm "/>
<
xs:element
name ="
SetterInjection "
type ="
xs :boolean
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
false "/>
<
xs:element
name ="
DICompleteUDF "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "
default ="
onDIComplete "/>
<
xs:element
name ="
StopRecursion "
type ="
xs :string
"
maxOccurs ="
1 "
minOccurs ="
0 "
default =""/>
<
xs:element
name ="
ParentFactory "
maxOccurs ="
1 "
minOccurs ="
0 ">
<
xs:complexType >
<
xs:simpleContent >
<
xs:extension
base ="
xs :string
">
<
xs:attribute
name ="
type "
use ="
required ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="coldspring "/>
<xs:enumeration
value ="lightwire "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:attribute >
</
xs:extension >
</
xs:simpleContent >
</
xs:complexType >
</
xs:element >
</
xs:all >
</
xs:complexType >
</
xs:element >
Name
Settings
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
These are global framework settings. All of them need to be defined in order for the framework to start.
XML Instance Representation
<Settings>
<Setting
name="
xs :string (value comes from list: {'AppMapping'|'AppName'|'ApplicationStartHandler'|'CustomErrorTemplate'|'ConfigAutoReload'|'ColdBoxExtensionsLocation'|'DebugMode'|'DebugPassword'|'DefaultEvent'|'EventName'|'ExceptionHandler'|'EventCaching'|'FlashURLPersistScope'|'HandlersIndexAutoReload'|'HandlersExternalLocation'|'HandlerCaching'|'LayoutsExternalLocation'|'MessageboxStyleOverride'|'MissingTemplateHandler'|'PluginsExternalLocation'|'onInvalidEvent'|'ProxyReturnCollection'|'RequestEndHandler'|'RequestStartHandler'|'RequestContextDecorator'|'ReinitPassword'|'SessionStartHandler'|'SessionEndHandler'|'UDFLibraryFile'|'ViewsExternalLocation'})
[1]
'The name of the framework\'s settings.'
"
value="
xs :string
[1]
'The value of the setting.'
" />
[1..*]
</Settings>
Schema Component Representation
<
xs:element
name ="
Settings ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
name ="
Setting "
maxOccurs ="
unbounded ">
<
xs:complexType >
<
xs:attribute
name ="
name "
use ="
required ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:enumeration
value ="AppMapping "/>
<xs:enumeration
value ="AppName "/>
<xs:enumeration
value ="ApplicationStartHandler "/>
<xs:enumeration
value ="CustomErrorTemplate "/>
<xs:enumeration
value ="ConfigAutoReload "/>
<xs:enumeration
value ="ColdBoxExtensionsLocation "/>
<xs:enumeration
value ="DebugMode "/>
<xs:enumeration
value ="DebugPassword "/>
<xs:enumeration
value ="DefaultEvent "/>
<xs:enumeration
value ="EventName "/>
<xs:enumeration
value ="ExceptionHandler "/>
<xs:enumeration
value ="EventCaching "/>
<xs:enumeration
value ="FlashURLPersistScope "/>
<xs:enumeration
value ="HandlersIndexAutoReload "/>
<xs:enumeration
value ="HandlersExternalLocation "/>
<xs:enumeration
value ="HandlerCaching "/>
<xs:enumeration
value ="LayoutsExternalLocation "/>
<xs:enumeration
value ="MessageboxStyleOverride "/>
<xs:enumeration
value ="MissingTemplateHandler "/>
<xs:enumeration
value ="PluginsExternalLocation "/>
<xs:enumeration
value ="onInvalidEvent "/>
<xs:enumeration
value ="ProxyReturnCollection "/>
<xs:enumeration
value ="RequestEndHandler "/>
<xs:enumeration
value ="RequestStartHandler "/>
<xs:enumeration
value ="RequestContextDecorator "/>
<xs:enumeration
value ="ReinitPassword "/>
<xs:enumeration
value ="SessionStartHandler "/>
<xs:enumeration
value ="SessionEndHandler "/>
<xs:enumeration
value ="UDFLibraryFile "/>
<xs:enumeration
value ="ViewsExternalLocation "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:attribute >
<
xs:attribute
name ="
value "
type ="
xs :string
"
use ="
required "/>
</
xs:complexType >
</
xs:element >
</
xs:sequence >
</
xs:complexType >
</
xs:element >
Element: View
Name
View
Used by (from the same schema document)
Element
Layout
Type
Locally-defined simple type
Nillable
no
Abstract
no
Documentation
The name of the view that will use the parent layout. This is the same name of the file without .cfm
XML Instance Representation
<View>
xs :string (length >= 1) </View>
Schema Component Representation
<
xs:element
name ="
View ">
<
xs:simpleType >
<
xs:restriction
base ="
xs :string
">
<xs:minLength
value ="1 "/>
</
xs:restriction >
</
xs:simpleType >
</
xs:element >
Name
WebService
Used by (from the same schema document)
Element
WebServices
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
A webservice declaration.
XML Instance Representation
<WebService
URL="
xs :anyURI
[1]
'The WSDL URL for this web service.'
"
name="
xs :string
[1]
'The web service reference name. This is the name the framework uses to retrieve the WSDL.'
" />
Schema Component Representation
<
xs:element
name ="
WebService ">
<
xs:complexType >
<
xs:attribute
name ="
URL "
type ="
xs :anyURI
"
use ="
required "/>
<
xs:attribute
name ="
name "
type ="
xs :string
"
use ="
required "/>
</
xs:complexType >
</
xs:element >
Name
WebServices
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
Useful declarations of all web services used in the application.
XML Instance Representation
<WebServices>
</WebServices>
Schema Component Representation
<
xs:element
name ="
WebServices ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
ref ="
WebService
"
maxOccurs ="
unbounded "
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:complexType >
</
xs:element >
Name
YourSettings
Used by (from the same schema document)
Element
Config
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
These are your own application settings.
XML Instance Representation
<YourSettings>
<Setting
name="
xs :string
[1]
'The name of the setting'
"
value="
xs :string
[0..1]
'The value of the setting. If not used, use the content of the element as the value.'
" >
[0..*]
'A custom setting for your application. The value can be simple or complex using JSON notation.'
xs :string
</Setting>
</YourSettings>
Schema Component Representation
<
xs:element
name ="
YourSettings ">
<
xs:complexType >
<
xs:sequence >
<
xs:element
name ="
Setting "
maxOccurs ="
unbounded "
minOccurs ="
0 ">
<
xs:complexType >
<
xs:simpleContent >
<
xs:extension
base ="
xs :string
">
<
xs:attribute
name ="
name "
type ="
xs :string
"
use ="
required "/>
<
xs:attribute
name ="
value "
type ="
xs :string
"
use ="
optional "
default =""/>
</
xs:extension >
</
xs:simpleContent >
</
xs:complexType >
</
xs:element >
</
xs:sequence >
</
xs:complexType >
</
xs:element >
Complex Type:
Schema Component Type
AusAddress
Schema Component Name
Super-types:
Address < AusAddress (by extension)
Sub-types:
QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
The table above displays the properties of this schema component.
XML Instance Representation
<...
country="Australia "
>
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice
[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]
?
</...>
The XML Instance Representation table above shows the schema component's content as an XML instance.
The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
Model group information are shown in gray, e.g. Start Choice ... End Choice.
For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold .
If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
Otherwise, the type of the element/attribute is displayed.
If the element/attribute's type is in the schema, a link is provided to it.
For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
Schema Component Representation
<complexType
name ="AusAddress ">
<complexContent >
<extension
base ="
Address
">
<sequence >
<element
name ="state " type ="
AusStates
"/>
<element
name ="postcode ">
<simpleType >
<restriction
base ="
string
">
<pattern
value ="[1-9][0-9]{3} "/>
</restriction >
</simpleType >
</element >
</sequence >
<attribute
name ="country " type ="
string
" fixed ="Australia "/>
</extension >
</complexContent >
</complexType >
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
Abstract
(Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.
All Model Group
Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all .
Choice Model Group
Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice .
Collapse Whitespace Policy
Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.
Disallowed Substitutions
(Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods , e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.
Key Constraint
Like Uniqueness Constraint , but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions .
Key Reference Constraint
Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint . See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions .
Model Group
Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups .
Nillable
(Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil , from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.
Notation
A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations .
Preserve Whitespace Policy
Preserve whitespaces exactly as they appear in instances.
Prohibited Derivations
(Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.
Prohibited Substitutions
(Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.
Replace Whitespace Policy
Replace tab, line feed, and carriage return characters with space character (Unicode character 32).
Sequence Model Group
Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence .
Substitution Group
Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.
Substitution Group Exclusions
(Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.
Target Namespace
The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.
Uniqueness Constraint
Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions .
