Administration Guide for the Cisco Unified Application Environment, Release 8.0
Managing Applications
Downloads: This chapterpdf (PDF - 173.0KB) The complete bookPDF (PDF - 4.59MB) | Feedback

Managing Applications

Table Of Contents

Managing Applications

Overview

Understanding Partitions

Understanding Scripts and Triggers

Application Configuration Example

Managing Applications

Viewing Applications

Installing an Application

Enabling or Disabling an Application

Uninstalling an Application

Viewing Application Details

Updating an Application

Managing Partitions

Adding a Partition

Deleting a Partition

Applying Partition Configurations

Enabling and Disabling Partition Configurations

Uninstalling Partition Configurations

Managing Triggers

Viewing Triggers

Viewing Trigger Details

Adding a Trigger Parameter

Deleting a Trigger Parameter

Updating a Trigger Parameter


Managing Applications


An application typically includes configuration items that are unique to your deployment and which you must configure after the application is installed.

Applications can be developed using Cisco Unified Application Designer or with your language of choice using Etch. See Cisco Unified Application Environment Developer Tools, page 1-3.

This chapter includes these topics:

Overview

Managing Applications

Managing Partitions

Managing Triggers

Overview

Application configuration occurs at the partition level. A partition is a configuration profile for an application. Applications can support multiple partitions, enabling you to create and execute multiple versions of the same application on a single Cisco Unified Application server.

This section includes these topics:

Understanding Partitions

Understanding Scripts and Triggers

Application Configuration Example

Understanding Partitions

Partitions are flexible and can be useful in a variety of situations. For example, if an application is intended to serve end users located on distinct Cisco Unified Communications Manager clusters, it is often desirable for all call control and media streams to terminate to the network and telephony resources contained within each cluster. At the same time, it may be desirable to have another configurable protocol on the application, such as LDAP, which makes reference to the same central location, regardless of the partition.

Each partition is associated with a call route group and media resource group. By defining unique call route groups and media resource groups, you can identify the partitions that use individual media engines. For each partition, you can also determine which Cisco Unified Communications Manager cluster is used for making calls by specifying a call route group that corresponds to the particular telephony protocol and group.

Understanding Scripts and Triggers

Each application is also associated with scripts, which are partitioned along with the application. Because multiple scripts can execute actions through the same protocol, you must specify the conditions, or trigger, under which a partitioned script should initiate action.

These are examples of trigger parameters for the following event types:

Metreos.CallControl.IncomingCall—Table 5-1

Table 5-1 Metreos.CallControl.IncomingCall 

Trigger Parameter
Description

To

Called party, or last redirected number if redirected

From

Number of the calling party

OriginalTo

Original called party, even if redirected

DisplayName

Textual display name associated with the calling part


Metreos.Providers.Http.GotRequest—Table 5-2

Table 5-2 Metreos.Providers.Http.GotRequest 

Trigger Parameter
Description

URI

Path portion of the requested URI. Must begin with a front slash (/).

Hostname

Host portion of the requested URI. Does not contain port information.

Host

Host portion of the requested URI. Might contain port information.

Port

Port portion of the requested URI

Body

Content of the request

Method

Request method—either GET or POST

Query

Query string portion of the requested URI

RemoteHost

IP address and port of the remote client

RemoteIPAddress

IP address of the remote client


Metreos.Providers.JTapi.JTapiIncomingCall—Table 5-3

Table 5-3 Metreos.Providers.JTapi.JTapiIncomingCall 

Trigger Parameter
Description

To

Called party, or last redirected number if redirected

From

Number of the calling party

OriginalTo

Original called party, even if redirected

DeviceName

Name of the device from which the call was initiated


Metreos.Providers.JTapi.JTapiCallInitiated—Table 5-4

Table 5-4 Metreos.Providers.JTapi.JTapiCallInitiated 

Trigger Parameter
Description

To

Called party

From

Number of the calling party

DeviceName

Name of the device from which the call was initiated


Metreos.Providers.TimerFacility.TimerFire—Table 5-5

Table 5-5 Metreos.Providers.TimerFacility.TimerFire

Trigger Parameter
Description

TimerUserData

Opaque token used to allow distinguishable events to be raised.

Note You must obtain this value from the person who developed the application which uses the TimerFire script.


Triggers can be defined in any of the following ways:

Single value—A trigger that activates when singe extension receives a call.

Value List —A trigger that activates when a call is received from more than one extension.

Single Regular Expression—A trigger that activates when a call is received on any of several extensions in a range.

Combined Method—A trigger that includes a single value trigger that activates when a single extension is called and a regular expression trigger that activates when a call is received from any of a range of extensions.


Note A regular expression is indicated by adding regex: before the expression. You cannot mix literal values and regular expressions in a list. Only a single regular expression can be used as a trigger parameter for a given partition. The syntax [0-9] in a regular expression is equivalent to the Cisco Unified Communications Manager X notation used in route patterns and CTI Route point line numbers.


Application Configuration Example

Assume that an application has one script and three partitions and activates on an IncomingCall trigger. The default partition has no triggering parameters and can act as a catch-all for events which do not match other partitions.

The application server determines the best match handler for a given event. Other partitions take effect if their trigger parameters are activated. For example, if Partition 2 specifies to=2000, then when a call comes in for extension 2000, partition 2 will activate. If no trigger matches, the default partition is active.

A partition is similar to a configuration template for a script and applies these rules:

The application developer sets the event that triggers a script. The event applies to all partitions and cannot be changed.

All installed script partitions across all applications are treated as equal.

If any two partitions have identical triggering criteria, either one may trigger; therefore, it is important that all partitions have unique triggering criteria.

The router will match the handler that best fits the events. For example, if partition A specifies to=2000 and partition B specifies to=2000 and from=1000, then a call from 1000 to 2000 triggers B.

Managing Applications

This section includes these topics:

Viewing Applications

Installing an Application

Enabling or Disabling an Application

Uninstalling an Application

Viewing Application Details

Updating an Application

Viewing Applications

To view a list of applications, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Applications. The List Applications page appears.

Table 5-6 describes the information that is provided for each application.

Table 5-6 List Applications  

Field
Description

Name

Application name

Description

Application description

Version

Application version

Status

Application status

Display Name

Application name



Installing an Application

To install an application, follow these steps:


Note Applications created using the Etch framework can be installed using the CUAE command-line tool. For more information see the Application Developer Getting Started Guide at this URL: http://www.cisco.com/en/US/docs/voice_ip_comm/cuae/2_5/english/developer/getting_started/guide/CUAE_Getting-Started_Book-Wrapper.html



Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Applications. The List Applications page appears.

Step 3 Under Install Application, click Browse...

Step 4 Highlight the file you want to upload, then click Open.

Step 5 Click Upload.


Note Applications are automatically enabled after they are installed. However, applications created with the Cisco Unified Application Designer are in Running status and Etch-based applications are in Stopped status after install. Etch-based applications enter Running status once executed.



Enabling or Disabling an Application

To enable or disable an application, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Applications. The List Applications page appears.

Step 3 Select the check box next to the application name.

To enable the application, click Enable.

To disable the application, click Disable.


Uninstalling an Application

To uninstall an application, follow these steps:


Note Applications created using the Etch framework can be uninstalled using the CUAE command-line interface. For more information see the Application Developer Getting Started Guide at this URL: http://www.cisco.com/en/US/docs/voice_ip_comm/cuae/2_5/english/developer/getting_started/guide/CUAE_Getting-Started_Book-Wrapper.html


Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Applications. The List Applications page appears.

Step 3 Select the check box next to the application name, then click Uninstall.


Viewing Application Details

To view the list of scripts, partitions, and partition configurations for an application, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Applications. The List Applications page appears.

Step 3 Click the application name. The Application Details page appears.

The scripts associated with the application are listed under Scripts

The default partition displays under Configurations. To view other partitions, select the partition name from the Partition Name list, and the configuration details for that partition are displayed.


Updating an Application

To update an application, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Applications. The List Application page appears.

Step 3 Click the application name. The Application Details page appears.

Step 4 Under Update Application, click Browse...

Step 5 Highlight the file you want to upload, then click Open.

Step 6 Click UploadFile.

Step 7 Click Done to return to the List Applications page.


Managing Partitions

This section includes the following procedures:

Adding a Partition

Deleting a Partition

Deleting a Partition

Applying Partition Configurations

Enabling and Disabling Partition Configurations

Uninstalling Partition Configurations

Adding a Partition

To add partition, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Applications. The List Application page appears.

Step 3 Click the application name. The application details page appears.

Step 4 Under Partitions, click Add Partition. The Create Partitions page appears.

Step 5 Enter the values as described in Table 5-7.

Table 5-7 Add Partition 

Field
Description

Partition Details

Partition Name

Partition name

Descriptions

Partition description


Step 6 Click Add. The partition is added and you return to the application details page.

Step 7 Under Configurations, enter the values as described in Table 5-8.


Note Configuration values are inherited from the default partition, and all unchanged configurations in the new partition remain linked to configurations in the default partition. These configuration values are updated in the new partition to match any changes made to them in the default partition.


Table 5-8 Configuration Details 

Field
Description

Preferred Codec

Preferred media resource codec.

CallRoute GroupId

Call route group ID (used only when making outbound calls).

The protocol of the inbound call is determined by the configuration of the Cisco Unified Communications Manager. Specifically, its configuration determines which protocol is used when routing the call to the Cisco Unified Application Server device appearance.

Locale

Locale for this partition.

Note The supported locales listed can be different across applications. The list is dependent on which locales the application's developer has designated as supported.

EarlyMedia

Reserve media ports (for reduced set up time)

Enabled

Enabled when selected.

Media Resource Group

Cisco Unified Media Engine group closest to the IP endpoints using this application.


Step 8 Click Done to return to the List Applications page.


Deleting a Partition

To delete a partition, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Applications. The List Application page appears.

Step 3 Click the application name. The application details page appears.

Step 4 Under Partitions, select the partition you want to delete from the Partition Name list, then click Delete Partition.

Step 5 Click Done to return to the List Applications page.


Applying Partition Configurations

To apply a partition configuration, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Click Applications > List Applications. The List Application page appears.

Step 3 Click the application name. The Application Details page appears.

Step 4 Under Partitions, select the partition from the Partition Name list.

Step 5 Under Configurations, click Apply.

Step 6 Click Done to return to the List Applications page.


Enabling and Disabling Partition Configurations

To enable or disable a partition configuration, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Click Applications > List Applications. The List Application page appears.

Step 3 Click the application name. The Application Details page appears.

Step 4 Under Partitions, select the partition from the Partition Name list.

Step 5 Under Configurations

Click Enable to enable the partition configuration.

Click Disable to disable the partition configuration.

Step 6 Click Done to return to the List Applications page.


Uninstalling Partition Configurations

To uninstall a partition configuration, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Click Applications > List Applications. The List Application page appears.

Step 3 Click the application name. The Application Details page appears.

Step 4 Under Partitions, select the partition from the Partition Name list.

Step 5 Under Configurations, click Uninstall.

Step 6 Click Done to return to the List Applications page.


Managing Triggers

This section includes the following procedures:

Viewing Triggers

Viewing Trigger Details

Adding a Trigger Parameter

Deleting a Trigger Parameter

Viewing Triggers

To view the applications being triggered on a particular event type, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Triggers. The List Triggers page appears.

Step 3 Table 5-9 describes the information that is provided for each trigger.

Table 5-9 List Triggers  

Field
Description

Event Type

Trigger event type

App Name

Associated application name

Partition Name

Associated partition

Script Name

Associated script name



Viewing Trigger Details

To view trigger details, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Triggers. The List Triggers page appears.

Step 3 Click the application name. The Trigger Details page appears.


Adding a Trigger Parameter

To add a trigger parameter, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Triggers. The List Triggers page appears.

Step 3 Click the application name. The Trigger Details page appears.

Step 4 Enter the trigger name and value in the blank spaces provided.

Step 5 Click Add Parameter. The name and value are added to the table.

Step 6 Click Done to return to the List Triggers page.


Deleting a Trigger Parameter

To delete a trigger parameter, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Triggers. The List Triggers page appears.

Step 3 Click the application name. The Trigger Details page appears.

Step 4 Select the parameter you want to delete, then click Delete Parameter.

Step 5 Click Done to return to the List Triggers page.


Updating a Trigger Parameter

To update a trigger parameter, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment Administration.

Step 2 Choose Applications > List Triggers. The List Triggers page appears.

Step 3 Click the application name. The Trigger Details page appears.

Step 4 Change the value.

Step 5 Click Update Parameter.

Step 6 Click Done to return to the List Triggers page.