Managing CCXML applications

Use the Vision Console to specify the following properties for individual CCXML applications, if the routing provided by the gateway call routing table does not provide the required flexibility:

The Vision Console adds this information to the CCXML application definition file (ccxmlappcfg.xml).

To specify properties for an application, you must first add the application to the Vision Console. Adding CCXML applications to the Vision Console does not disable gateway routing table functionality. The Video Gateway first tries to match calls to custom CCXML applications. Calls that do not match a custom CCXML application are then handled by the gateway routing table.

This topic describes how to:

It also describes the pattern matching syntax used to match the dialed numbers of inbound calls and to define outbound routes.

Adding a CCXML application definition

To add a CCXML application to the Vision Console, follow these steps:

Step

Action

1

Access the Vision Console, as described in Accessing the Vision Console.

2

Click CCXML applications on the Provisioning menu.

The CCXML application configuration page appears. By default, there is one CCXML application called gateway.ccxml defined for the Video Gateway. This application is defined as a gateway application.

A gateway application accesses the gateway routing table for route definitions, while a custom application defines routes based on the application definition. For more information about call routing, see Overview of creating routes.

Note: Do not remove or modify the default entry (for gateway.ccxml).

3

To add a CCXML application as a gateway application, click New at the bottom of the Gateway section, and enter the following information:

Field

Description

Number range

Number range associated with the CCXML application specified by the Initial URI value. The number range can be a combination of numbers, alphabetic characters, and wildcards.

The gateway checks if the dialed number of an incoming call matches this. If it finds a match, the corresponding CCXML application is executed.

If the dialed number matches the number range of multiple applications, the call is matched to the most specific number range.

For more information, see CCXML application definition pattern matching syntax.

Initial URI

Initial URI to use for an incoming all, based on the number range of the dialed number.

For information about creating call routes for gateway applications, see Understanding the gateway routing table.

4

To add a CCXML application as a custom application, click New at the bottom of the Custom section, and enter the following information:

Field

Description

Number range

Number range associated with the CCXML application specified by the Initial URI value. The number range can be a combination of numbers, alphabetic characters, and wildcards.

The gateway checks if the dialed number of an incoming call matches this. If it finds a match, the corresponding CCXML application is executed.

If the dialed number matches the number range of multiple applications, the call is matched to the most specific number range.

For more information, see CCXML application definition pattern matching syntax.

Initial URI

Initial URI to use for an incoming all, based on the number range of the dialed number.

Dialog servers

List of dialog servers for the application. Separate each dialog server with a comma.

Outbound routes

List of outbound routes for the calls that the CCXML application creates. Separate each route with a comma.

PSTN routes

For a PSTN route, the syntax is:

route-Route_Number[Priority]

where:

  • Route_Number identifies a PSTN route, as defined in the telecom conf file.

  • Priority specifies the priority level for load balancing over the telecom routes.

If Route_Number is set to 0, the route is chosen automatically according to the associated incoming call.

SIP routes

For a SIP route, the syntax is:

IP_Address:Port[Priority]

where:

  • IP_Address:Port is the IP address and port of a SIP route.

  • Priority the priority level for load balancing over SIP routes.

For both PSTN and SIP routes, Priority is optional, and its value is relative from 0 (default) to any required level. The highest priority is expressed by the lowest value (typically 0). Load balancing is performed between routes with the same priority and starts by routes defined with the highest priority.

Note: If you have outbound PSTN routes defined in the CCXML application, the Video Gateway processes those routes before it processes the routes defined here.

For information about creating call routes for custom CCXML applications, see Fine tuning gateway routing.

5

Click Apply.

The Vision Console adds the new definition to the top of the definition list in the associated section (Custom or Gateway).

Removing a CCXML application definition

To remove a CCXML application from the Vision Console, follow these steps:

Step

Action

1

Access the Vision Console, as described in Accessing the Vision Console.

2

Click CCXML applications in the Provisioning menu.

The CCXML application configuration page is displayed.

3

Locate the row that contains the application you want to remove, and click Remove.

A confirmation message appears.

4

Click OK to remove the application.

Modifying a CCXML application definition

To modify a CCXML application definition, follow these steps:

Step

Action

1

Access the Vision Console, as described in Accessing the Vision Console.

2

Click CCXML applications in the Provisioning menu.

The CCXML Application Configuration page is displayed.

3

Click Edit.

The Edit CCXML application page appears.

4

Modify the application as appropriate. For a description of the entry fields, see Adding a CCXML application definition to the Vision Console.

5

Click Apply to save the changes.

CCXML application definition pattern matching syntax

The following table describes the syntax used to specify patterns for matching the dialed number (DNIS) for inbound calls. This is based on standard regular expression syntax.

Symbol

Description

. (period)

Wildcard that matches any single digit or character. For example, 123.... matches any dialed string beginning with 123, plus exactly four additional digits.

[ ]

Range of digits. A consecutive range is indicated with a hyphen (-); for example, [5-7]. A non-consecutive range is indicated with a comma (,); for example, [5,8]. Hyphens and commas can be used in combination; for example, [5-7,9].

Note: Only single-digit ranges are supported. For example, [98-102] is invalid.

( )

A pattern; for example, 408(555). Used in conjunction with the symbol ?, *, or +.

?

Preceding digit occurred zero or one time.

* or %

Preceding digit occurred zero or more times.

+

Preceding digit occurred one or more times.

The following table provides examples of destination patterns and how they are interpreted:

Pattern

Translation

408555.+

408555, followed by one or more wildcard digits. Indicates the string must contain at least 7 digits starting with 408555.

408555.*

408555, followed by zero or more wildcard digits. Indicates the string must contain at least 408555.

408555+

40855, followed by 5 repeated one or more times.

408555*

40855, followed by 5 repeated zero or more times. Any explicitly matching digit before * (asterisk) is not stripped off.

408555?

40855, followed by 5 repeated zero or one time. Any explicitly matching digit before ? (question mark) is not stripped off.

40855[5-7].+

40855, followed by 5, 6, or 7, plus any digit repeated one or more times.

40855[5-7].*

40855, followed by 5, 6, or 7, plus any digit repeated zero or more times.

40855[5-7]+1234

40855, followed by 5, 6, or 7 repeated one or more times, followed by 1234.

408(555)+1234

408, followed by 555, which may repeat one or more times, followed by 1234.