element <bot:action>
Namespace:
http://www.zionsoftware.com/jbuddy/bot
Type:
embedded complexType
Content:
complex, 9 attributes, 1 element
Defined:
globally in bot.xsd
Used:
at 1 location
XML Representation Summary
<bot:action
   
 htmlTidy
 = 
("yes" | "no" | "auto")
   
 httpCompression
 = 
("gzip" | "deflate" | "auto" | "none")
   
 httpMethod
 = 
("get" | "post" | "head" | "options" | "put" | "delete" | "trace")
   
 httpUserAgent
 = 
string
   
 path
 = 
string
   
 resultType
 = 
("string" | "html" | "xhtml" | "file" | "xml" | "none")
   
 timeout
 = 
string
   
 transform
 = 
string
   
 type
 = 
("url" | "java" | "system")
   
>
   
Content: 
bot:description?
</bot:action>
May contain elements (1):
bot:description (type bot:richContent)
May be included in elements (4):
bot:eventHandler (type bot:eventHandler),
bot:eventHandler (type bot:globalEventHandler),
bot:target,
bot:target (type bot:globalTarget)
Known Usage Locations
Annotation
An external process carried out by the bot engine.
Attribute Detail
htmlTidy
Sets the HTML Tidy mode to use. HTML Tidy is used with actions to convert HTML documents into valid XML documents. This is required if an HTML document is to be transformed with XSLT, as most HTML documents are not valid XML.
Type:
bot:htmlTidyMode
Use:
optional
Defined:
locally, within this element
httpCompression
Sets the requested HTTP compression type to use. Compression is used with HTTP to increase performance and lower bandwidth usage by compressing content.

This is valid only for url actions using HTTP.

Type:
bot:httpCompression
Use:
optional
Defined:
locally, within this element
httpMethod
Sets the HTTP/1.1 request method to use.

This is valid only for url actions using HTTP.

Type:
bot:httpMethod
Use:
optional
Defined:
locally, within this element
httpUserAgent
Sets the HTTP User-Agent value to use. This is important for web sites that serve content depending on browser version information contained in the value.

This is valid only for url actions using HTTP.

Type:
string
Use:
optional
Defined:
locally, within this element
path
Sets this action's path.

If type is:

  • url, this must be a relative or fully-qualified URL. If relative, it must point to a local resource, such as a file or resource within the Java Runtime Environment's current classpath. If fully-qualified, the URL protocol must refer to a networking protocol supported by the Java Runtime Environment being used. Most runtime environments support at least file, ftp, jar, http, and https protocols.
  • java, this must be a fully-qualified class name which refers to a BotActionTask implementation. An instance of that class is instantiated and executed.
  • system, this must be a path to a system command or executable.

This value can contain content variables.

Type:
string
Use:
required
Defined:
locally, within this element
resultType
Sets this action's result type. The engine sends different result content to the user depending on an action's result type.

If a result type is not specified, the default behavior depends on the action's type:

  • For url actions using HTTP, a result type is used that best matches the HTTP Content-Type.

    Content-Type Result Type
    text/html html
    text/plain string
    application/xhtml+xml xhtml
    text/xhtml xhtml
    text/xml xml

    text/* content types not listed above are returned as string results. All other content types are returned as file results.

  • For java actions, the returned value is converted to a string and sent to the user. For more information, consult the javadocs included with the framework (especially the com.zion.jbuddy.bots.BotActionTask class).
  • For system actions, results are returned as a string.
Type:
bot:actionResultType
Use:
optional
Defined:
locally, within this element
timeout
Sets this action's timeout value.

If an action takes longer than its specified timeout to finish executing, the associated process or thread is canceled, and an error message is sent to the user. If a timeout is not specified (timeout <= 0), an action is allowed to take any amount of time to complete.

The default value is 0.

Type:
bot:timeValue
Use:
optional
Defined:
locally, within this element
transform
Sets this action's XSLT path. The value must be a relative or fully-qualified URL to an XSL transform file.

This action's results will be transformed using the rules specified in the XSLT. HTML content can also be transformed; it will be first converted to an XML document using HTML Tidy so it can be processed. This can be especially useful to dynamically extract content from HTML-based web sites.

Type:
string
Use:
optional
Defined:
locally, within this element
type
Sets this action's type.
Type:
bot:actionType
Use:
required
Defined:
locally, within this element
Content Element Detail
bot:description
Sets this action's description.

If resultType is file, this description is set on the <file> that is sent to the user. This property isn't currently used for anything else.

Type:
bot:richContent, mixed 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