cc/td/doc/product/voice/sw_ap_to/rel_2_1
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Getting Started with the Cisco Application Editor

Getting Started with the Cisco Application Editor

This section provides the information you need to install and configure Cisco Application Editor and a brief introduction to the Cisco Application Editor user interface.

The following topics are described:

Installing the Cisco Application Editor on your Workstation

This section includes the following topics:

System Requirements

To use the Cisco Application Editor, you need to install Windows 95, Windows 98, Windows NT (Workstation or Server) or Windows 2000 (Server) with Service Pack 4 or later, and a web browser (supported versions).

Installing the Cisco Application Editor

The Cisco IP IVR software installation process places an installer for the Cisco Application Editor on the application server. You can use a web browser to download this installer and install the Cisco Application Editor on any computer that can access the Application Administration web pages.

Procedure


Step 1   Access the Application Administration web server pages by entering the following URL:

where servername is the IP address or, if available, Domain Name Service (DNS) name or of your Cisco IP IVR application server.

The system displays Figure 2-1.


Figure 2-1: Application Administration Main Menu


Step 2   In the Option column, click the Plug-Ins link.

Step 3   Click here for the Application Editor.

The system displays the Editor page

Step 4   Click directory access configuration file

The system displays the Save As... dialog.

Step 5   Click Save.

Once the download completes, move the ccndir.ini file to the appropriate directory, wfavvid (Program Files\wfavvid\ for Windows 95 or Windows 98;, \Winnt\system32\ccn\ for Windows NT). As part of the install process, this file is populated for you.

Next, you need to install the Cisco Application Editor.

Step 6   On the Download Workflow Editor window, click the installer link.

The system displays the Save As... dialog box.

Step 7   Click Save.

Step 8   Once the download completes, launch Application2.0Editor.exe.

Step 9   At the Welcome prompt, click Next.

Step 10   On the Choose Destination Location dialog box, click Next to accept the default option, C:\program Files\wfavvid.

Step 11   On the Select Components dialog box, accept the default (Application Editor)

If you are integrating your Cisco IP IVR with Cisco ICM, click the ICM Support radio button.

Step 12   On the Select Program Folder dialog, click Next to accept the default option, Applications 2.0.

Step 13   Click Next to start copying the files.

After copying, you see the ccdir.ini window.

Step 14   Either accept the default values or enter your own, then click OK

The pre-populated values reflect the LDAP directory configuration the Cisco IP IVR system to which you are connected. For more information on these settings, see the Cisco IP IVR Installation Guide.

Step 15   Your setup is now complete. Click Finish.


Application Editor Window

To start the Cisco Application Editor, use the following path:

Start > Programs > Application 2.0 > Application Editor

The system displays The Cisco Application Editor main window, as shown in Figure 2-2.


Figure 2-2: Cisco Application Editor Main Window


To display the contents of a folder in the Palette window, click the plus sign (+) to the left of the folder. To display a blank Design window, choose File > New.

This window provides the following features:

Drop-Down Menu Bar

The menu bar on the Cisco Application Editor main window provides the following options:

The following paragraphs describe the options available on each of these submenus.

File Options

The following table describes the options available on the File menu.


Table 2-1: File Menu options
Option Description

New

Creates a blank designer window and places a Start step on the new Designer window. This lets you start a new application.

Open

Displays a standard Open window that lets you browse to select and open an existing application (.aef) file. This lets you modify an existing application.

Close

Closes the current application.

Save

Saves the current application.

Save As

Opens a standard Save window that lets you enter a filename with an .aef extension, to save your current application.

Palette

Provides four options:

  • Load Jar—Loads Java .jar files that conform to the Cisco IP Application Editor interface specification.

  • Open Palette—Opens a palette of steps that you saved previously.

  • Save Palette—Saves the current palette of steps.

  • Save Palette As—Displays a Save window that lets you enter a name to save the current palette of steps

Print

Prints a list of the steps in the current application.

Properties

Provides two tabs:

  • General—Describes the type of file

  • Summary—Provides fields that let you enter descriptive information about the current application.

Edit Options

The following table describes the options on the Edit menu.


Table 2-2: File Menu options
Option Description

Undo

Reverses the last operation.

Redo

Repeats the last operation.

Cut

Places the currently selected step in the clipboard and removes it from the Designer window.

Copy

Copies the currently selected step to the clipboard. If the step has multiple outputs, all its outputs and, recursively, the steps within those outputs are included in the copy.

Paste

Pastes the steps on the clipboard.

Tools Options

This menu provides the Validate option. This option validates your application to ensure that the order of steps and the definition of the step properties conforms with the general syntax required by the application engine.

Debug Options

The Debug menu provides options that let you test your application on a local or remote Cisco IP Telephony application engine.

Table 2-3 describes the options on the Debug menu.


Table 2-3: Debug Menu options
Option Description

Start/Continue

Runs the current application in debug mode.

Break

Stops the application and allows you to view or change the current value of variables and step properties before resuming execution.

End

Ends the current application.

Step Over

Skips the currently executing step.

Insert/Remove Breakpoint

Inserts a breakpoint at the currently executing step that will cause the application to halt whenever it runs in debug mode. This does not affect the run time version of the application.

Enable/Disable Breakpoint

Toggles the selected break point on or off.

Clear All Breakpoints

Removes all breakpoints from the application.

Reactive Applications

Prompts for the name and time out of the event-triggered application to be debugged.

Settings Options

The following table describes the options on the Settings menu.


Table 2-4: Window Menu options
Option Description

ICM ECC Variable

Allow the administrator to manage Intelligent Contact Manager (ICM) expanded call variables to be used by ICM steps.

This option is only used for ICM.

Window Options

Table 2-5 describes the options on the Window menu.


Table 2-5: Window Menu options
Option Description

Cascade

When you have multiple applications open, this option overlaps each Designer window.

Tile Horizontally

When you have multiple applications open, this option reduces the length of each Designer window to fit the available space.

Tile Vertically

When you have multiple applications open, this option reduces the width of each Designer window to fit the available space.

Help Option

The following table describes the option on the Help menu.


Table 2-6: Help Menu option
Option Description

Help

Deploying Cisco IP IVR Applications in online format

About...

Information about your version of the Cisco Application Editor

Palette Pane

The Palette pane, partially expanded in Figure 2-3, shows the steps available for developing applications.


Figure 2-3: Cisco Application Editor Palette Pane


The steps are organized in folders, each of which contains a set of related steps. "General Step Reference" describes the steps provided in the General folder. "Cisco IP IVR Step Reference" describes the steps provided in the IVR folder. If you installed the ICM Voice Response Unit (VRU) interface component, you should see an ICM folder, described in "Implementing ICM VRU."

Toolbar

The toolbar provides icons for quickly selecting the same Cisco Application Editor options that are provided on the drop-down menu.

Design Pane

The design pane is where you assemble the steps in your application. To use the design pane, create a new application or open an existing application using the appropriate option from the File menu.


Note   To add a step to your application, drag the icon from the Palette pane and drop it on the step it will follow. The Start step, which is added automatically when you create a new application, provides the starting point to which you can add your first step.

To change the order of steps in the application, drag the icons from the old location to the new location. To delete a step, select the icon and press the Delete key. To display the properties sheet for a specific step, right-click the icon on the Design window, to display a pop-up menu, as in Figure 2-4.


Figure 2-4: Displaying the Customizer for a Step


When you select the Properties option, the system displays a customizer.

Each customizer is a dialog box that lets you modify the step properties, and provides at least three buttons:

In addition, customizers may have multiple tabs and additional buttons that allow you to display and modify various properties within a step.

Variable Pane

The Variable pane lets you create, modify, and view the local variables for your application. Local variables are the variables that you wish to make available for use by different steps within your application.

Once defined, the local variables can be used by any step in your application.


Note   You cannot make variables within an application available to other applications.

To declare a new variable, click the New Variable icon at the top of the Variable pane. The Edit Variable window appears, illustrated in Figure 2-5.


Figure 2-5: Edit Variable Window


The following table describes the fields on this dialog box.


Table 2-7: Edit Variable Properties
Property Description

Name

Name of the variable you want to declare

Type

Type of variable you want to declare

Java Type

Fully-qualified class name located using the CLASSPATH on your computer.

Note To use this field, you must choose
Java Type in the Type selection list.

Value

Value of the new variable

Assigning Data Types to Local Variables

You can create local variables with the following built-in data types:

After you declare your variables, they appear in the Variable window. You can use the modify or delete buttons on this window to make any necessary changes.

Using Other Java Classes

To build more advanced applications, you can use java class variables that are not explicitly supported.

Use the Variable pane to declare a variable using the Java classes in your computer's CLASSPATH.

To do this, perform the following steps.

Procedure


Step 1   Select the Java Type from the Type selection list in the Edit Variable window

Step 2   Type a fully-qualified class name in the Java Class field, for example, 'java.sql.Timestamp.'

The system locates and loads the class from the directories identified by the system CLASSPATH.


Once you successfully declare a variable for a class, you can create instances of the class using the Create Java Object step, and execute methods of the class using the Execute Java Method step.

Importing Customized Steps

You can add steps to the Palette for use in your applications. To add steps to the Palette, perform the following steps.

Procedure


Step 1   Choose File > Palette > Load Jar.

Step 2   Type the URL or path to your .jar files in the window that appears next and click OK.

If you don't know the complete path, click Browse, navigate to the directory that contains your .jar file and click Open.



Note   Imported .jar files must contain steps and conform to the Cisco IP IVR specification.

Related Topics

ICM Expanded Call Variable Window

In addition to local variables, you can define expanded call variables for use with the Cisco Intelligent Contact Manager (ICM).You can define these variables in the Edit ICM Expanded Call Variable window.

Choose Settings > ICM ECC Variable.

To define an expanded call variable, perform the following steps.

Procedure


Step 1   Click the Add New Variable button on the toolbar.

Step 2   Enter the expanded call variable name as defined in the Cisco ICM configuration.

Step 3   Select the type of expanded call variable (scalar or array).

Step 4   Provide a description of the variable and click OK.


Using the Expression Editor

You can write an application to perform calculations on data collected from the caller or other resources. These calculations can greatly increase the effectiveness and ease-of-use of your applications. To do this, you can create formulas called "expressions," and assign them to the steps in your application

For instance, you might want to advise customers calling from a certain area code of a change in services specific to their region. To do this, you would create an expression comparing the ANI data to the area code of the region in question, and only playing the service change announcement if there is a match.

You can enter an expression in the Expression field of any step, or click Expression Editor on a customizer to display the Expression Editor window, as shown in Figure 2-6.


Figure 2-6: Expression Editor


After you type an expression into this window and click OK, the Expression Editor validates the expression syntax. The following operators are allowed (they are listed in order of execution priority):

    1. Multiplication (*), Division (/)

    2. Addition (+), Subtraction (-)

    3. Less Than (<), Greater Than (>), Less Than or Equal (<=), Greater Than or Equal (>=)

    4. Equal to (==), Not Equal to (!=)

    5. And (&&)

    6. Or (||)

    7. Concatenation (+)

Table 2-8 shows the operations allowed on different variable types used as the left or right operands of an expression.


Table 2-8: Permitted Operations for Variables in Left and Right Operands

With string on right With integer on right With float on right With Boolean on right
String on left

+ Concatenate
< Less Than
> Greater Than
<= Less Than or Equal
>= Greater Than or Equal
== Equal to
!= Not Equal to

Not Allowed

Not Allowed

Not Allowed

Integer on left

Not Allowed

* Multiplication
/ Division
+ Addition
- Subtraction
< Less Than
> Greater Than
<= Less Than or Equal
>= Greater Than or Equal
== Equal to
!= Not Equal to

* Multiplication
/ Division
+ Addition
- Subtraction
< Less Than
> Greater Than
<= Less Than or Equal
>= Greater Than or Equal
== Equal to
!= Not Equal to

Not Allowed

With string on right With integer on right With float on right With Boolean on right
Float on left

Not Allowed

* Multiplication
/ Division
+ Addition
- Subtraction
< Less Than
> Greater Than
<= Less Than or Equal
>= Greater Than or Equal
== Equal to
!= Not Equal to

* Multiplication
/ Division
+ Addition
- Subtraction
< Less Than
> Greater Than
<= Less Than or Equal
>= Greater Than or Equal
== Equal to
!= Not Equal to

Not Allowed

Boolean
on left

Not Allowed

Not Allowed

Not Allowed

&& And
|| Or
== Equal to
!= Not Equal to


hometocprevnextglossaryfeedbacksearchhelp
Posted: Fri May 18 17:01:13 PDT 2001
All contents are Copyright © 1992--2001 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.