Cisco Unified Application Environment Application Developer Getting Started Guide
Preface
Downloads: This chapterpdf (PDF - 130.0KB) The complete bookPDF (PDF - 2.93MB) | Feedback

Preface

Table Of Contents

Preface

Purpose

Audience

Organization

Related Documentation

Other Resources

Document Conventions

Obtaining Documentation and Submitting a Service Request

Cisco Product Security Overview


Preface


This preface describes the purpose, audience, organization, and conventions of this guide and provides information on how to obtain additional information.

This section includes these topics:

Purpose

Audience

Organization

Related Documentation

Other Resources

Document Conventions

Obtaining Documentation and Submitting a Service Request

Purpose

This guide describes the Cisco Unified Application Environment and how it fits into the broader Cisco Unified Communications family of products. It also provides step-by-step instructions for creating a simple telephony application to build developer familiarity with the tool sets.

Audience

This guide is intended for developers who are familiar with the Windows operating system, have a basic understanding of IP telephony, and who want to write telephony applications.

Organization

This guide is organized as follows:

Chapter 1, "Getting Started"

Introduces the Cisco Unified Application Environment and how it fits within the Cisco Unified Communications family of products.

Chapter 2, "Preparing Your Development Environment"

Lists the network requirements for creating a development and test environment.

Chapter 3, "Using the Cisco Unified Application Designer"

Describes the Cisco Unified Application Designer and provides instructions for common tasks you can perform with the tool.

Chapter 4, "Using Etch and the CUAE Command-line Tool"

Describes how to work with Etch tools to create containerless applications.

Chapter 5, "Building the MakeCall Application with the Cisco Unified Application Designer"

Guides you on how to create, build, deploy, and run a simple telephony application with the Cisco Unified Application Designer.

Chapter 6, "Building Etch-Based Applications"

Guides you on how to create, build, deploy, and run a simple telephony application with Etch tools and both Java and C#.

Chapter 7, "Running and Troubleshooting Cisco Unified Application Environment Applications"

Illustrates what happens in the Cisco Unified Application Environment as applications run and provides troubleshooting solutions to developer issues.


Related Documentation

There are two types of related documentation: product and developer. Table 1 provides links to related product documentation. Table 2 provides links to related developer documentation.

Table 1 Product Documentation 

Related Information
URL

Administration Guide for the Cisco Unified Application Environment, Release 2.5.1

http://cisco.com/en/US/products/ps7058/prod_maintenance_guides_list.html

Cisco Unified Application Environment Release Notes, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_release_notes_list.html

Cisco Unified Application Environment Installation Guide, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_installation_guides_list.html

Cisco Unified Application Environment Upgrade Guide, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_installation_guides_list.html

Cisco Unified Application Environment Hardware Compatibility Matrix, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/products_device_support_tables_list.html

Cisco Unified Application Environment Software Compatibility Matrix, Release 2.5.1

Open Source License Notices for the Cisco Unified Application Environment

http://www.cisco.com/en/US/docs/voice_ip_comm/cuae/openssl_license/cuae_ssllic.html


Table 2 Developer Documentation

Related Information
URL

API Reference Guide

http://developer.cisco.com/web/cuae/wikidocs?src=/wiki/display/CUAE/API+Reference

Timesaver The Developer Tools installer installs a local copy of the API Reference Guide. By default, it installs to C:\Program Files\Cisco Systems\Unified Application Environment\Documentation.

Example Applications

http://developer.cisco.com/web/cuae/wikidocs?src=/wiki/display/CUAE/Examples


Other Resources

The table below lists the additional resources available to developers who want to use the Cisco Unified Application Environment to create and run applications.

Resource Name
Resource Description
URL

Cisco Developer Community - Cisco Unified Application Environment home page

The Cisco Unified Application Environment home page. Contains links to all developer resources, including forums, blogs, the Cisco Unified Application Environment developer wiki and more.

http://developer.cisco.com/web/cuae/home

Cisco Unified Application Environment Wiki

Access and contribute to installation instructions, example applications, how-to articles, and more.

http://developer.cisco.com/web/cuae/wikidocs

Cisco Unified Application Environment Forums

View the latest posts and subscribe to the developer forum, the announcements forum, the beta forum, or the general interest forum.

http://developer.cisco.com/web/cuae/forums

Developer IRC Channel

Developer chat group. To participate, join the Cisco Unified Application Environment IRC channel, #cuae on Dalnet (irc.dal.net).


Document Conventions

This document uses the following conventions:

Convention
Description

boldface font

Commands and keywords are in boldface.

italic font

Arguments for which you supply values are in italics.

[   ]

Elements in square brackets are optional.

{ x | y | z }

Alternative keywords are grouped in braces and separated by vertical bars.

[ x | y | z ]

Optional alternative keywords are grouped in brackets and separated by vertical bars.

string

A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

screen font

Terminal sessions and information the system displays are in screen font.

boldface screen font

Information you must enter is in boldface screen font.

italic screen font

Arguments for which you supply values are in italic screen font.

^

The symbol ^ represents the key labeled Control—for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.

<   >

Nonprinting characters, such as passwords are in angle brackets.


Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.

Cisco Product Security Overview

This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.

A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html. If you require further assistance please contact us by sending email to export@cisco.com.