VXML Servlet Node

Nodes and Palette Options > Detailed Node Descriptions > VXML Servlet Node

	VXML Servlet Node

Type

Application Item (basic) node

Purpose

Use this node to insert custom VoiceXML code into your project. The purpose of this node is to make it possible to write and employ custom VoiceXML code for operations that Dialog Designer does not natively handle.

Behavior

The framework for this node generates the VoiceXML header and footer (<vxml> and </vxml>) and the form header and footer (<form> and </form>). The custom code you place within the Java class for this node is inserted between the form header and footer.

After you place this node in a call flow, you must edit the Java class for the node. Because this node permits you to write and employ your own VoiceXML, Avaya is not responsible for the results. It is possible to write code that will prematurely exit the application, transfer a caller out of the system, and perform other actions that the parent application is then not aware of. Avaya recommends you to use this node with caution as this can cause your applications to hang, or display run-time errors.

To edit the Java class for the node:

Place a VXML Servlet node in the call flow.

Designate the next node for the VXML Servlet node to proceed to, when finished.

To save the project, in the Navigator view, select the project and then press Control+Shift+S.

Note:

Before editing the Java class, connect the VXML Servlet node to the next in the call flow and save the speech project. Dialog Designer does not allow editing of the Java class until steps 2 and 3 are completed.

After the project is finished building, right-click the VXML Servlet node and, from the pop-up context menu, select Edit VXMLservlet.java, where VXMLservlet is the name of your VXML servlet node.

In the Java class editor, add the method:

public void markupLanguageGeneration(PrintStream out, Submit submit, SCESession session) {

and add to this method your custom VoiceXML code.

Note:

The ability to integrate variables into and from this node is not easily supported. Avaya recommends that, if possible, you avoid using this node to pass variable values.

Properties

Name - Enter a name that reflects the central purpose of the node. Use naming conventions for Java components. See Naming Java Components.

Comments - Enter any comment you want to add as a reminder or description of the purpose or content of the node. You can leave this field blank.

Tip:

Dialog Designer uses the text you enter in this property field for the pop-up hint that appears when your mouse hovers over the node icon in the workspace. If you leave this blank, Dialog Designer uses the name of the node for the pop-up hint.

Location - (Read-only) Displays the location of the node graphic in the workspace.

Default Node Structure (Node Detail Editor Flow)

Next item - Indicates which node comes next in the call flow.