ccxml elements - createccxml

CCXML 1.0 Development Guide

<createccxml> element

The <createccxml> element is used to spawn another thread of control, which begins execution with the document identified by this element. This thread of control provides independent execution and an entirely separate variable space for the CCXML documents that it executes. Such independent threads are associated with one or more event endpoints; such endpoints are the only things capable of sending events to these independent threads of execution.Note that the new thread of execution has an entirely separate address space and lifetime.

usage

<createccxml enctype="(ECMAScript Expression)" maxage="CDATA" maxstale="CDATA" method="(GET|POST)" namelist="STRING" next="(ECMAScript Expression)" sessionid="(ECMAScript Expression)" timeout="(ECMAScript Expression)">

attributes

enctype	Data Type: (ECMAScript Expression)	Default: application/x-www-form-urlencoded
	enctype specifies an ECMAScript string expression that denotes the media encoding type of the submitted document, (when the POST method is used). The only allowable value of this attribute is 'application/x-www-form-urlencoded', which specifies that the indicates that the variables in the namelist attribute must be url-encoded.
maxage	Data Type: CDATA	Default: Optional
	The maxage and maxstale attributes specify the maximum acceptable staleness, in seconds, of the resource in question. However, it is strongly advised not to rely on this attribute for cache-control; caching is always best controlled by the hosting server's response headers. If no headers are specified, then no cache control will be present, regardless of the value set for the maxage and maxstale attributes.
maxstale	Data Type: CDATA	Default: Optional
	The maxage and maxstale attributes specify the maximum acceptable staleness, in seconds, of the resource in question. However, it is strongly advised not to rely on this attribute for cache-control; caching is always best controlled by the hosting server's response headers. If no headers are specified, then no cache control will be present, regardless of the value set for the maxage and maxstale attributes.
method	Data Type: (GET\|POST)	Default: Optional (GET)
	The method attribute specifies the HTTP method to use when sending the request. If unspecified, then the value of ‘GET’, (default) is assumed, unless the submission of multipart/form-data is encountered, in which case the implied method will be ‘POST’.
namelist	Data Type: STRING	Default: none - attribute is optional
	The namelist attribute denotes the space-separated list of variable names to be sent along with the fetch. The variables will then be available as a variable/value pair in the resultant URI querystring that is sent to the server.
next	Data Type: (ECMAScript Expression)	Default: none - attribute is required
	This attribute simply indicates the URI of the XML document to be fetched.
sessionid	Data Type: (ECMAScript Expression)	Default: none - attribute is optional
	The sessionid attribute is an expression resolving to a platform-defined unique identifier that denotes the newly-instantiated thread of control.
timeout	Data Type: (ECMAScript Expression)	Default: Optional
	The timeout attribute specifies the amount of time to allow the fetch attempt to be made, specified by the next attribute value. If the new CCXML session is unable to fetch the initial document within the timeout interval denoted, then an error.fetch event will be thrown.

parents

none

children

none

code samples

<1.0 createccxml -next> sample

<?xml version="1.0" encoding="UTF-8"?>
<ccxml version="1.0" xmlns="http://www.w3.org/2002/09/ccxml">

<eventprocessor>
<transition event="ccxml.loaded">
<log expr="'***** CCXML.LOADED *****'"/>
<createccxml next="'CCXML_child.xml'"/>
</transition>

<transition event="error.createccxml" name="evt">
<log expr="'***** ERROR.CREATECCXML *****'"/>
</transition>

<transition event="ccxml.created" name="evt">
<log expr="'***** CHILD SESSION STARTED: ' + evt.sessionid"/>
<log expr="'***** CCXML.CREATED *****'"/>
<exit/>
</transition>

<transition event="ccxml.exit" name="evt">
<log expr="'***** CHILD SESSION HAS EXITED *****'"/>
<exit/>
</transition>
</eventprocessor>
</ccxml>

<CCXML_child.xml>

<?xml version="1.0" encoding="UTF-8"?>
<ccxml version="1.0" xmlns="http://www.w3.org/2002/09/ccxml">

<eventprocessor>
<transition event="ccxml.loaded" name="evt">
<log expr="'*** CCXML.LOADED:CHILD SESSION ***'"/>
</transition>

<transition event="ccxml.kill" name="evt">
<log expr="'*** CCXML.KILL:CHILD SESSION ***'"/>
</transition>

<transition event="connection.failed" name="evt">
<log expr="'*** CONNECTION.FAILED:CHILD SESSION ***'"/>
<exit/>
</transition>

<transition event="connection.disconnected" name="evt">
<log expr="'*** CONNECTION.DISCONNECTED:CHILD SESSION ***'"/>
<exit/>
</transition>

<transition event="connection.connected" name="evt">
<log expr="'*** CONNECTION.CONNECTED:CHILD SESSION ***'"/>
</transition>

<transition event="connection.alerting" name="evt">
<accept/>
<log expr="'*** CONNECTION.ALERTING:CHILD SESSION ***'"/>
</transition>
</eventprocessor>
</ccxml>

additional links

W3C Specification

ANNOTATIONS: EXISTING POSTS

0 posts - click the button below to add a note to this page