Cisco Unity Express 1.1.1 Script Editor Guide
Contact Step Descriptions

Table Of Contents

Contact Step Descriptions

Accept

Get Contact Info

Set Contact Info

Terminate


Contact Step Descriptions


The steps in the Contact palette of the Cisco Unity Express Script Editor provide designers with a way to control contacts.

A contact represents a specific interaction with a customer. For Cisco Unity Express, the contact type is a telephone call.

The Contact palette contains the following steps:

Accept

Get Contact Info

Set Contact Info

Terminate

Figure 58 shows the steps in the Contact palette as they appear in the Palette pane of the Cisco Unity Express Script Editor.

Figure 58 Contact Palette Steps

Accept

Use the Accept step to accept a particular contact.

After the Start step, the Accept step is normally the first step in a Cisco Unity Express script, triggered by an incoming contact.

The caller hears ringing until the script reaches this step.

Figure 59 shows the customizer window for the Accept step.

Figure 59 Accept Customizer Window

Table 19 describes the field of the Accept customizer window.

Table 19 Accept Customizer Window Field

Field
Description

Contact

Contact variable.

Default is Triggering Contact, unless another contact is defined.


To configure the Accept step, click the Contact drop-down arrow to choose a contact and click OK.

The Accept customizer window closes. The name of the Contact variable appears next to the Accept step icon in the Design pane of the Cisco Unity Express Script Editor.

Get Contact Info

Use the Get Contact Info step to extract information from a particular type of object and store it in script variables so that this contact information is available to subsequent steps in the script.

Figure 60 shows the customizer window for the Get Contact Info step.

Figure 60 Get Contact Info Customizer Window

Table 20 describes the fields of the Get Contact Info customizer window.

Table 20 Get Contact Info Customizer Window Fields

Field
Description

Contact

Contact variable for which you want to get information.

Default is Triggering Contact, unless another contact is defined.

Attribute/Variable

Attributes and variables of contact information types.


Table 21 describes the information that the Get Contact Info step makes available to other steps in the script.

Table 21 Get Contact Info Attributes

Attribute
Description

Type

String representing the type of contact. For Cisco Unity Express, the type is a call.

Language

This option is for future use.

ASR Supported

This option is for future use.

Is Active

Boolean value indicating whether the call is still active.

Is Aborting

Boolean value indicating whether the call is being aborted.

Session Handled

Boolean value indicating whether the contact was previously marked as handled.

Identifer

Integer value containing the contact identifier assigned by the system guaranteed to be unique among all contacts.

Implementation ID

String value containing the implementation-specific identifier for the contact. This value is unique for a given contact type. For a Cisco JTAPI call contact, this value is equivalent to the global call identifier obtained by the Cisco CallManager software.

Sequence Number

Integer value containing the sequence number of the contact assigned by the system if the contact is associated with a session. The value is -1 if the contact is not associated with a session. For every new contact associated with a session, the system increments the value by one.

Session

Session object associated with the contact. Null if none is found.


Follow these steps to get contact information:


Step 1 From the Contact drop-down menu, choose the Contact variable for which you want to get information.

Step 2 In the Attribute/Variable list box, select the desired attribute and click Set.

The Get Contact Type dialog box appears, as shown in Figure 61.

Figure 61 Get Contact Type Dialog Box

Step 3 From the Select Variable drop-down menu, choose the desired variable and click OK.

The Get Contact Type dialog box closes. The name of the selected variable appears in the Variable column next to the selected attribute in the Get Contact Info customizer window.

Step 4 Click OK.

The Get Contact Info customizer window closes. The name of the selected Contact variable appears next to the Get Contact Info step icon in the Design pane of the Cisco Unity Express Script Editor.


Set Contact Info

Use the Set Contact Info step to modify the context information associated with a contact.

The Set Contact Info step often follows a Redirect step in the script to mark the contact as Handled.

A contact can be marked Handled only while it is active. Once a contact becomes inactive (for example, after a successful transfer), the script has a maximum of 5 seconds to mark the contact as Handled; otherwise the mark will have no effect in reporting.


Note You cannot mark a contact as unhandled. Once a contact is reported as Handled, it will always be reported with that status.


Figure 62 shows the customizer window for the Set Contact Info step.

Figure 62 Set Contact Info Customizer Window

Table 22 describes the fields of the Set Contact Info customizer window.

Table 22 Set Contact Info Customizer Window Fields

Field
Description

Contact

Contact variable for which you want to set information.

Default is Triggering Contact, unless another contact is defined.

Attribute/Value

Attributes and values of contact information types.


Table 23 describes the attribute information provided in the customizer window of the Set Contact Info step.

Table 23 Set Contact Info Attributes

Attribute
Description

Language

This option is for future use.

Handled

Final result of contact; this is important for reporting purposes.

Session

This option is for future use.


Follow these steps to modify the context information associated with a contact:


Step 1 From the Contact drop-down menu, choose the Contact variable for which you want to set information.

Step 2 In the Attribute/Variable list box, select Handled and click Set.

An X appears in the Value column next to the Handled attribute.

Step 3 Click OK.

The Set Contact Info customizer window closes,. The name of the selected Contact variable appears next to the Set Contact Info step icon in the Design pane of the Cisco Unity Express Script Editor.


Terminate

Use the Terminate step to disconnect the call.

Figure 63 shows the customizer window for the Terminate step.

Figure 63 Terminate Customizer Window

Table 24 describes the field of the Terminate customizer window.

Table 24 Terminate Customizer Window Field

Field
Description

Contact

Contact variable that you want terminated.

Default is Triggering Contact, unless another contact is defined.


To terminate a contact, click the Contact drop-down arrow to choose the contact that you want to terminate and click OK.

The Terminate customizer window closes. The name of the selected Contact variable appears next to the Terminate step icon in the Design pane of the Cisco Unity Express Script Editor.