element <bot:bot>

Namespace:	http://www.zionsoftware.com/jbuddy/bot
Type:	embedded complexType
Content:	complex, 9 attributes, 5 elements
Defined:	globally in bot.xsd
Used:	never

XML Representation Summary

<bot:bot

logLevel

integer

string

positiveInteger

string

xs:anyURI

xs:ID

(xs:language | "")

("default" | "preserve")

Content:

bot:property*, bot:client*, (bot:target*, bot:menu*, bot:eventHandler*)*

</bot:bot>

May contain elements (5):

bot:client (type bot:client),

bot:eventHandler (type bot:globalEventHandler),

bot:menu (type bot:globalMenu),

bot:property (type bot:property),

bot:target (type bot:globalTarget)

Annotation

A bot's logic and content, interpreted by a bot engine.

This is the top-level element in a Bot Definition.

Attribute Detail

logLevel

Sets the engine's log level.

Type:	bot:logLevel
Use:	optional
Defined:	locally, within this element

menuHistorySize

Sets the user menu history size.

If a user visits a menu that would cause the associated menu history to grow larger than this size, the oldest menu is removed from the history.

If menuHistorySize < 0, the history may contain an infinite number of menus (not recommended).

The default value is 10.

Type:	integer
Use:	optional
Defined:	locally, within this element

resourceBundle

Sets the path to the engine's resource bundle.

The engine normally loads string constants from its built-in resource bundle. The constants can be overridden here. To see the available constants, consult the Bots.properties file included with the framework.

Type:	string
Use:	optional
Defined:	locally, within this element

threadPoolSize

Sets the size of the internal thread pool the bot engine uses to process requests.

The default value is 5.

Type:	positiveInteger
Use:	optional
Defined:	locally, within this element

userTimeout

Sets the amount of time, in milliseconds, before idle user sessions are timed-out.

If no input is sent by a user for longer than this amount of time, the user's session is considered inactive and is removed from the engine. Further input from the user would then create a new session.

If userTimeout < 1, user sessions will never time out (not recommended).

The default value is 15m (15 minutes).

Type:	bot:timeValue
Use:	optional
Defined:	locally, within this element

xml:base

Type:	xs:anyURI
Use:	optional
Defined:	by reference, within xml:specialAttrs attributeGroup

xml:id

Type:	xs:ID
Use:	optional
Defined:	by reference, within xml:specialAttrs attributeGroup

xml:lang

Type:	embedded
Use:	optional
Defined:	by reference, within xml:specialAttrs attributeGroup

xml:space

Type:	embedded
Use:	optional
Defined:	by reference, within xml:specialAttrs attributeGroup

Content Element Detail

bot:client

Creates a client gateway.

Type:	bot:client, complex content
Defined:	locally, within this element

bot:eventHandler

Creates an event handler.

Type:	bot:globalEventHandler, complex content
Defined:	locally, within this element

bot:menu

Creates a menu.

Type:	bot:globalMenu, complex content
Defined:	locally, within this element

bot:property

Sets a system property.

Type:	bot:property, empty content
Defined:	locally, within this element

bot:target

Creates a target.

Type:	bot:globalTarget, complex content
Defined:	locally, within this element

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.0

DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else!

Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task!

Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com