Name (Label)

Type

Req'd

Single Setting Value

Substitution Allowed

Default

Notes

Call Peripheral Variables 1 – 10

(callvar1 – callvar10)

string

No

true

true

None

Call Peripheral Variables passed by the Studio script to the ICM Server. Each of these settings can be a maximum length of 210 characters. The ICM Server returns a name-value pair for up to 10 Call Peripheral Variables in a result. Any value that is placed in callvar<n> from a Call Studio script is returned unchanged, if the ICM Script does not change it.

Call Peripheral Variables Return 1 – 10

(callvarReturn1 – callvarReturn10)

string

No

true

true

None

Call Peripheral Variables created upon the return of the ICM Label request, regardless of whether or not these variables are filled by the ICM Script. The reason we need two sets of these variables is to keep reporting the To ICM Call Peripheral Variables separate from what is returned from the ICM.

FromExtVXML0 - 3

(External VXML 0 – External VXML 3)

string array

No

true

true

None

Expanded Call Context (ECC) variables passed by the Studio script to the ICM Server. Each variable is a string of name-value pairs, separated by semicolons, for up to 4 external VXML variables. Each of these settings can be a maximum length of 210 characters.

ToExtVXML0 - 4

(External VXML 0 – External VXML 4)

string array

No

true

true

None

Expanded Call Context (ECC) variables received from the ICM script. The ICM Server returns a string of name-value pairs, separated by semicolons, for up to 5 external VXML variables.

Timeout

integer

Yes

true

true

3000 (ms)

The number of milliseconds the transfer request waits for a response from the ICM Server before timing out. Note: This value can only be increased or decreased by increments of 500 ms.

caller_input

(Caller Input)

string

No

true

true

None

This setting can be a maximum length of 210 characters. The value of this setting will be sent from VXML Server to ICM at runtime. Should a response from ICM be needed, the Call Peripheral Variables or ToExtVXML settings should be used.

Name

Type

Notes

result

string

ICM Label returned from an ICM server.

callvar<n>

string

Call Peripheral Variables that the Studio scripts passes to the ICM Server. Valid Call Peripheral Variables are callvar1 – callvar10.

callvarReturn<n>

string

Call Peripheral Variables that the ICM script returns to the VXML Server. Valid Call Peripheral Variables are callvarReturn1 – callvarReturn10.

For example, if an ICM script contains call peripheral variable 3 with the string value "CompanyName=Cisco Systems, Inc", you can access the value of CompanyName that is returned by the ICM script by using:

Data.Element.ReqICMLabelElement.callvarReturn3.

The returned value is Cisco Systems, Inc.

Name

Type

Notes

name

string

Value for a name-value pair contained in a ToExtVXML variable returned in the ICM label. You must know which name-value pairs are set in the ICM script to retrieve the correct value from the Call Studio script.

For example, if an ICM script contains a user.microapp.ToExtVXML0 variable with the string value CustomerName=Mantle, specify Data.Session.CustomerName. If the same ICM script contains a user.microapp.ToExtVXML0 variable with the string value BusinessType=Manufacturing, you can access the customer business type returned by the ICM script by using Data.Session.BusinessType.

Name

Notes

done

The element is run successfully and the value is retrieved.

error

The element failed to retrieve the value.

Studio Element Folder Name

Class Name

Cisco

com.cisco.cvp.vxml.custelem.ReqICMLabel

Name (Label)

Notes

Event Type

You can select Java Exception as event handler type.