The Types of Local Variables Available in the Cisco Unified CCX Editor

The following table describes the types of local variables available in the Cisco Unified CCX Editor.

Note

This table provide brief descriptions and examples of each of the built-in variable types available to Cisco Unified CCX. For complete details on using each variable, see Cisco Unified CCX Scripting and Development Series: Volume 3, Expression Language Referenceand the Cisco Unified Contact Center Express Scripting and Development Series: Volume 2, Editor Step Reference Guide.

Available Cisco Unified CCX Variable Types

Variable Name

Description

Byte

A Byte variable represents an integer value with a value range from -128 to +127.

Examples:

  • (byte)23

  • (byte)-45

Contact

A contact variable represents an internal contact created as a result of an external event, such as an incoming call, e-mail message or HTTP request. It can also represent an outbound contact, such as an outbound call or an outbound email. A variable of this type references the resources related to the contact and lets you indicate which contacts a step should act upon.

You cannot manually enter a contact as a variable value. Contact variables result only from the Create eMail step (from the eMail palette), the Place Call step (Call Contact palette), and/or the Get Trigger Info step (Contact palette).

Short

A Short variable represents an integer value with a value range of -32768 to +32767.

Examples:

  • (short)3456

  • (short)7239

User

A User variable represents a configured Cisco Unified CallManager User. A user variable can be returned by steps such as Name To User, Get User, or Select Resource step, and is used in other steps to extract information from the variable.

Session

A Session variable tracks contacts across the system. As the contact moves from one place to another, information can be tagged along and retrieved by a script. A Session variable can be thought of as a “shopping cart” in a web application.

You cannot manually give a Session variable a value. Session variables can only be returned from the Get Contact Info step (Contact palette) and/or the Get Session step (Session palette).

Prompt

A Prompt variable contains information about what to play to a caller when a call is passed to a Media step. It can reference audio files in the prompt repository or on disk, concatenation of multiple prompts, or more complicated types of prompts

Examples:

  • P[] or SP[]—An empty prompt. (No prompt gets played back.)

  • P[AA\AAWelcome.wav]—A user-defined prompt located in the User Prompts directory.

Grammar

The Grammar variable represents different options that can be selected by a caller using a Media input step (such as the Menu step). A grammar variable can represent grammars uploaded to the grammar repository or created using some of the existing steps.

Examples:

  • G[], SG[]—An empty grammar. (No value gets recognized.)

  • G[grammar.grxml]—A user-defined grammar located in the User Grammars directory.

Language

A Language variable is used to localize a particular resource in the system. It can be associated with a contact to customize what prompts and grammars should be retrieved from the repository when required.

Examples:

  • L[en_US]

  • L[fr_CA]

Currency

The Currency variable is used to identify a given currency, such as the American Dollar (USD), and is useful when creating generated currency prompts that need to be tailored based on a given currency.

Examples:

  • C[USD]

  • C[CAD]

Iterator

The Iterator variable corresponds to the Java java.util.Iterator class.

boolean

A Boolean variable can be either true or false, and is primarily used by the If step in the General palette of the Cisco Unified CCX Editor.

char

A Character variable consists of characters, such as the letters in an alphabet.

Examples:

  • ‘a’, ‘1’, ‘Z’

  • Any escape sequence: ‘\t’, ‘\r’, ‘\0’, ‘\n’, ‘\f’, ‘\\’, ‘\’

Document

A Document variable can be any type of document, such as a file, a URL, or a recording.

Examples:

  • FILE[C:\Documents\mydoc.txt]

  • URL[http://evbuweb/mydoc.asp?number=23]

  • TEXT[Some text to be stored in document]

float

A Float variable consists of decimal numbers.

Examples:

  • 3.14159

  • 2E-12

  • -100

int

An Integer variable consists of whole numbers, from -2147483648 to 2147483647, inclusive.

Examples:

  • 234556789

  • 0

  • -23

String

A String variable consists of a set of Unicode characters, from “\u0000” to “\uffff” inclusive.

Examples:

  • “Hello”, “C:\WINNT\win.ini”—Supports any escape characters or Unicode characters.

  • u“\”This is a quoted string\””, u“\tHello”, u“\u2222\u0065”, u“C:\\WINNT\\win.ini”—Supports he same escape sequences or Unicode characters described for the Character type.

Date

The Date variable contains date information.

Examples:

  • D[now]

  • D[12/13/52]

  • D[Dec 13, 1952]

Time

The Time variable contains time information.

Examples:

  • T[now]

  • T[3:39 AM]

  • T[11:59:58 PM EST]

BigDecimal

The BigDecimal variable consists of an arbitrary-precision integer along with a scale, where the scale is the number of digits to the right of the decimal point.

Examples (same as Float variable):

  • 3.14159 DB

  • 2E-12 DB

  • -100 DB

BigInteger

The BigInteger variable represents arbitrary-precision integers.

Examples (same as Integer variable):

  • 234556789 IB

  • 0 IB

  • -23 IB

double

The Double variable represents an expanded Float variable.

Examples:

  • 3.14159 D

  • 2E-12 D

  • -100 D

long

The Long variable is an expanded Integer variable.

Examples (same as Integer variable):

  • 234556789 L

  • 0 L

  • -23 L

CCCalendar

Calendar type variable.

Examples: new CCCalendar("1"), where 1 is the calendar ID that is configured in Unified CCX Administration.