Voice Application Specification. SBString

Transcription

1 Voice Application Specification Page 1 of 52 SBString Voice Application Specification SBString Thu, 10-Jan-2013

2 Voice Application Specification Page 2 of 52 SBString Revision History Revision number Change tes Revised by Date 1.0 Initial Selim Budakoğlu Supported method list added Selim Budakoğlu

3 Voice Application Specification Page 3 of 52 SBString Table of Contents 1. Call Flow Diagrams Call Flow Diagram Legend Application Call Flow Diagrams Page: main Page: split Page: charat Page: length Page: substring Page: indexof Page: lastindexof Page: touppercase Page: tolowercase Page: replace Page: replaceall Page: replacefirst Element Configurations Element Configurations in Page Page: main Page: split Page: charat Page: length Page: substring Page: indexof Page: lastindexof Page: touppercase Page: tolowercase Page: replace Page: replaceall Page: replacefirst Recording List Prompts Page: main Page: split Page: charat Page: length Page: substring Page: indexof Page: lastindexof Page: touppercase Page: tolowercase Page: replace Page: replaceall...51

4 Voice Application Specification Page 4 of 52 SBString Page: replacefirst...52

5 Voice Application Specification Page 5 of 52 SBString Introduction SBString custom element is written to have basic string functions on Cisco Unified Call Studio builder perspective. Currently the element supports the methods below; (1) split (2) charat (3) length (4) substring (5) indexof (6) lastindexof (7) touppercase (8) tolowercase (9) replace (10) replaceall (11) replacefirst To be able to use SBString in Cisco Unified Call Studio ; 1. Copy StringManager.class file under project path below; 2. Close then reopen the project. 3. A local element that is called SBString will be shown in Elements/Local Elements/UCCE EMEAR folder.

6 Voice Application Specification Page 6 of 52 SBString The application that is explained in this document is created to test and simulate SBString custom element.

7 Voice Application Specification Page 7 of 52 SBString 1. Call Flow Diagrams 1.1. Call Flow Diagram Legend Start of Call - The single main entry point into the voice application. Voice Element - A reusable, VoiceXML-producing dialog with a fixed or dynamically produced configuration. Action Element - Encapsulates business logic that performs tasks that are t the call-flow (i.e., has only one exit state). Web Service Element - An embedded web service interaction. Decision Element - Encapsulates business logic that makes decisions that are mapped to at least two exit states. Flag - System records the traversal of the call through this element. VoiceXML Insert - A special element that allows for the direct entry of VoiceXML markup. Hot Event - A global event that executes the developer-specified actions when it is caught. Hot Link - A globally accessible utterance and/or key press that immediately brings the caller to a specified part of the call-flow or throws an event. Application Transfer - Provides "virtual" transfers to other voice applications running on the same instance of Call Services. Element Group - Represents a consolidated group of elements. Page Entry - This represents an entry point into a particular page in the call flow workspace.

8 Voice Application Specification Page 8 of 52 SBString Page Connector - This element provides connectivity to other pages via the "Page Entry" element. Subdialog Start - This element is used as the entrance point to an application that is invoked as a subdialog. Subdialog Return - This element is used as the exit point to return control and data back to the calling application. Hang Up - This element is used to invoke a hang up and call end.

9 Voice Application Specification Page 9 of 52 SBString 1.2. Application Call Flow Diagrams Page: main

10 Voice Application Specification Page 10 of 52 SBString Page: split

11 Voice Application Specification Page 11 of 52 SBString Page: charat

12 Voice Application Specification Page 12 of 52 SBString Page: length

13 Voice Application Specification Page 13 of 52 SBString Page: substring

14 Voice Application Specification Page 14 of 52 SBString Page: indexof

15 Voice Application Specification Page 15 of 52 SBString Page: lastindexof

16 Voice Application Specification Page 16 of 52 SBString Page: touppercase

17 Voice Application Specification Page 17 of 52 SBString Page: tolowercase

18 Voice Application Specification Page 18 of 52 SBString Page: replace

19 Voice Application Specification Page 19 of 52 SBString Page: replaceall

20 Voice Application Specification Page 20 of 52 SBString Page: replacefirst

21 Voice Application Specification Page 21 of 52 SBString 2. Element Configurations 2.1. Element Configurations in Page Page: main Menu - Voice Element Input Mode both Noinput Timeout 5s Digits Max NoInput Count 1 Digits Max NoMatch Count 1 Digits Confidence Level 0.40 Min Digits 1 Max Digits 2 Disable Hotlinks false Secure Logging false Maxnbest 1 VoiceXML Property Prompts Digits Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s yes SELECT METHOD (1) split (2) charat (3) length (4) substring (5) indexof (6) lastindexof (7) touppercase (8) tolowercase (9) replace (10) replaceall (11) replacefirst (AnyOther) EXIT

22 Voice Application Specification Page 22 of 52 SBString Language next Yes max_input Start Of Call Counter Equals Split Count CharAt value Length value Substring value IndexOf value LastIndexOf value ToUpperCase value ToLowerCase value Replace value ReplaceAll value ReplaceFirst value Menu max_match max_input Method Hang Up Menu Method - Decision Decision Editor <kwledge_base> <rule name="method" default_exit_state="undefined"> <exit_state name="split" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="1" /> </number> </exit_state> <exit_state name="charat" conjugate="and"> <number operator="equal">

23 Voice Application Specification Page 23 of 52 SBString <data> <element name="menu" variable="value" /> </data> <constant_number value="2" /> </number> </exit_state> <exit_state name="length" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="3" /> </number> </exit_state> <exit_state name="substring" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="4" /> </number> </exit_state> <exit_state name="indexof" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="5" /> </number> </exit_state> <exit_state name="lastindexof" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="6" /> </number> </exit_state> <exit_state name="touppercase" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="7" /> </number> </exit_state> <exit_state name="tolowercase" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="8" /> </number> </exit_state> <exit_state name="replace" conjugate="and"> <number operator="equal">

24 Voice Application Specification Page 24 of 52 SBString <data> <element name="menu" variable="value" /> </data> <constant_number value="9" /> </number> </exit_state> <exit_state name="replaceall" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="10" /> </number> </exit_state> <exit_state name="replacefirst" conjugate="and"> <number operator="equal"> <data> <element name="menu" variable="value" /> </data> <constant_number value="11" /> </number> </exit_state> </rule> </kwledge_base> Menu split charat length substring indexof lastindexof touppercase tolowercase replace replaceall replacefirst undefined SBString Split SBString CharAt SBString Length SBString Substring SBString IndexOf SBString LastIndexOf SBString ToUpperCase SBString ToLowerCase SBString Replace SBString ReplaceAll SBString ReplaceFirst Hang Up

25 Voice Application Specification Page 25 of 52 SBString Page: split Check Counter - Decision Decision Editor <kwledge_base> <rule name="check Counter" default_exit_state="5"> <exit_state name="1" conjugate="and"> <number operator="equal"> <data> <element name="counter" variable="count" /> </data> <constant_number value="1" /> </number> </exit_state> <exit_state name="2" conjugate="and"> <number operator="equal"> <data> <element name="counter" variable="count" /> </data> <constant_number value="2" /> </number> </exit_state> <exit_state name="3" conjugate="and"> <number operator="equal"> <data> <element name="counter" variable="count" /> </data> <constant_number value="3" /> </number> </exit_state> <exit_state name="4" conjugate="and"> <number operator="equal"> <data> <element name="counter" variable="count" /> </data> <constant_number value="4" /> </number> </exit_state> </rule> </kwledge_base> Counter 1 Token1 2 Token2 3 Token3 4 Token4

26 Voice Application Specification Page 26 of 52 SBString 5 Token5 - split(string regex,int limit) Splits this string around matches of the given regular expression. The array returned by this method contains each substring of this string that is terminated by ather substring that matches the given expression or is terminated by the end of the string. The substrings in the array are in the order in which they occur in this string. If the expression does t match any part of the input then the resulting array has just one element, namely this string. The limit parameter controls the number of times the pattern is applied and therefore affects the length of the resulting array. If the limit n is greater than zero then the pattern will be applied at most n - 1 times, the array's length will be greater than n, and the array's last entry will contain all input beyond the last matched delimiter. If n is n-positive then the pattern will be applied as many times as possible and the array can have any length. If n is zero then the pattern will be applied as many times as possible, the array can have any length, and trailing empty strings will be discarded. The string "boo:and:foo", for example, yields the following results with these parameters: Regex Limit Result : 2 { "boo", "and:foo" } : 5 { "boo", "and", "foo" } : -2 { "boo", "and", "foo" } o 5 { "b", "", ":and:f", "", "" } o -2 { "b", "", ":and:f", "", "" } o 0 { "b", "", ":and:f" } Parameters: regex - the delimiting regular expression limit - the result threshold, as described above Returns: the array of strings computed by splitting this string around matches of the given regular expression split(string regex) Splits this string around matches of the given regular expression. This method works as if by invoking the two-argument split method with the given expression and a limit argument of zero. Trailing empty strings are therefore t included in the resulting array. The string "boo:and:foo", for example, yields the following results with these expressions:

27 Voice Application Specification Page 27 of 52 SBString Regex Result : { "boo", "and", "foo" } o { "b", "", ":and:f" } Parameters: regex - the delimiting regular expression Returns: the array of strings computed by splitting this string around matches of the given regular expression Counter - Action Element Initial Count 0 Type increment Step Size 1 No Counter Equals Split Count Check Counter Counter Equals Split Count - Decision Decision Editor <kwledge_base> <rule name="counter Equals Split Count" default_exit_state="no"> <exit_state name="yes" conjugate="and"> <number operator="equal"> <data> <element name="counter" variable="count" /> </data> <data> <element name="sbstring Split" variable="value" /> </data> </number> </exit_state> </rule> </kwledge_base>

28 Voice Application Specification Page 28 of 52 SBString Token5 Token1 Token3 Token2 Split value Token4 Yes No Menu Counter SBString Split - Action Element String boo,and,foo Method split Regex, Limit 2 split Method Split value Split value - Voice Element

29 Voice Application Specification Page 29 of 52 SBString VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes Split Token Count :{.Element.SBString Split.value} SBString Split Counter Equals Split Count Token1 - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes TOKEN 1 : {.Session.Token1}

30 Voice Application Specification Page 30 of 52 SBString 1 Check Counter Counter Equals Split Count Token2 - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes TOKEN 2 : {.Session.Token2} 2 Check Counter Counter Equals Split Count Token3 - Voice Element

31 Voice Application Specification Page 31 of 52 SBString VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes TOKEN 3 : {.Session.Token3} 3 Check Counter Counter Equals Split Count Token4 - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes TOKEN 4 : {.Session.Token4}

32 Voice Application Specification Page 32 of 52 SBString 4 Check Counter Counter Equals Split Count Token5 - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes TOKEN 5 : {.Session.Token5} 5 Check Counter Counter Equals Split Count Page: charat CharAt value - Voice Element

33 Voice Application Specification Page 33 of 52 SBString VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes CharAt : {.Element.SBString CharAt.value} SBString CharAt Menu - charat(int index) Returns the char value at the specified index. An index ranges from 0 to length() - 1. The first char value of the sequence is at index 0, the next at index 1, and so on, as for array indexing. If the char value specified by the index is a surrogate, the surrogate value is returned. Parameters: index - the index of the char value. Returns: the char value at the specified index of this string. The first char value is at index 0. SBString CharAt - Action Element

34 Voice Application Specification Page 34 of 52 SBString String boo and foo Method charat Index 5 charat Method CharAt value Page: length - length() Returns the length of this string. The length is equal to the number of Unicode code units in the string. Returns: the length of the sequence of characters represented by this object. Length value - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS yes Length : {.Element.SBString Length.value}

35 Voice Application Specification Page 35 of 52 SBString s Language SBString Length Menu SBString Length - Action Element String Method boo and foo length length Method Length value Page: substring - substring(int beginindex) Returns a new string that is a substring of this string. The substring begins with the character at the specified index and extends to the end of this string.

36 Voice Application Specification Page 36 of 52 SBString Examples: "unhappy".substring(2) returns "happy" "Harbison".substring(3) returns "bison" "emptiness".substring(9) returns "" (an empty string) Parameters: beginindex - the beginning index, inclusive. Returns: the specified substring. substring(int beginindex,int endindex) Returns a new string that is a substring of this string. The substring begins at the specified beginindex and extends to the character at index endindex - 1. Thus the length of the substring is endindex-beginindex. Examples: "hamburger".substring(4, 8) returns "urge" "smiles".substring(1, 5) returns "mile" Parameters: beginindex - the beginning index, inclusive. endindex - the ending index, exclusive. Returns: the specified substring. SBString Substring - Action Element String hamburger Method substring BeginIndex 4 EndIndex 8 substring Method Substring value

37 Voice Application Specification Page 37 of 52 SBString Substring value - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes Substring : {.Element.SBString Substring.value} SBString Substring Menu Page: indexof - indexof(string str) Returns the index within this string of the first occurrence of the specified substring. Parameters: str - any string. Returns: if the string argument occurs as a substring within this object, then the index of the first character of the first such substring is returned; if it does t occur as a substring, -1 is returned. indexof(string str,int fromindex)

38 Voice Application Specification Page 38 of 52 SBString Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.if such value exists, then -1 is returned. Parameters: str - the substring for which to search. fromindex - the index from which to start the search. Returns: the index within this string of the first occurrence of the specified substring, starting at the specified index. IndexOf value - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes IndexOf : {.Element.SBString IndexOf.value} SBString IndexOf Menu SBString IndexOf - Action Element

39 Voice Application Specification Page 39 of 52 SBString String ucce emear Method indexof Str e FromIndex 5 indexof Method IndexOf value Page: lastindexof - lastindexof(string str) Returns the index within this string of the rightmost occurrence of the specified substring. The rightmost empty string "" is considered to occur at the index value this.length(). Parameters: str - the substring to search for. Returns: if the string argument occurs one or more times as a substring within this object, then the index of the first character of the last such substring is returned. If it does t occur as a substring, -1 is returned. lastindexof(string str,int fromindex) Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the specified index.if such value exists, then -1 is returned. Parameters: str - the substring to search for. fromindex - the index to start the search from. Returns: the index within this string of the last occurrence of the specified substring. LastIndexOf value - Voice Element

40 Voice Application Specification Page 40 of 52 SBString VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes LastIndexOf : {.Element.SBString LastIndexOf.value} SBString LastIndexOf Menu SBString LastIndexOf - Action Element String ucce emear Method lastindexof Str cc FromIndex 7 lastindexof Method

41 Voice Application Specification Page 41 of 52 SBString LastIndexOf value Page: touppercase - touppercase() Converts all of the characters in this String to upper case using the rules of the default locale. Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "title".touppercase() in a Turkish locale returns "T?TLE", where '?' is the LATIN CAPITAL LETTER I WITH DOT ABOVE character. To obtain correct results for locale insensitive strings, use touppercase(locale.english). Returns: the String, converted to uppercase. SBString ToUpperCase - Action Element String Method ucce emear touppercase touppercase Method ToUpperCase value

42 Voice Application Specification Page 42 of 52 SBString ToUpperCase value - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes ToUpperCase : {.Element.SBString ToUpperCase.value} SBString ToUpperCase Menu Page: tolowercase - String tolowercase() Converts all of the characters in this String to lower case using the rules of the default locale. Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "TITLE".toLowerCase() in a Turkish locale returns "t?tle", where '?' is the LATIN SMALL LETTER DOTLESS I character. To obtain correct results for locale insensitive strings, use tolowercase(locale.english). Returns:

43 Voice Application Specification Page 43 of 52 SBString the String, converted to lowercase. SBString ToLowerCase - Action Element String Method UCCE EMEAR tolowercase tolowercase Method ToLowerCase value ToLowerCase value - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes ToLowerCase : {.Element.SBString ToLowerCase.value}

44 Voice Application Specification Page 44 of 52 SBString SBString ToLowerCase Menu Page: replace - replace(string target,string replacement) Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence. The replacement proceeds from the beginning of the string to the end, for example, replacing "aa" with "b" in the string "aaa" will result in "ba" rather than "ab". Parameters: target - The sequence of char values to be replaced replacement - The replacement sequence of char values Returns: The resulting string Replace value - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes Replace : {.Element.SBString Replace.value}

45 Voice Application Specification Page 45 of 52 SBString SBString Replace Menu SBString Replace - Action Element String Method Replacement Target ucce emear replace r TT replace Method Replace value Page: replaceall - replaceall(string regex,string replacement) Replaces each substring of this string that matches the given regular expression with the given replacement. Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string.

46 Voice Application Specification Page 46 of 52 SBString Parameters: regex - the regular expression to which this string is to be matched replacement - the string to be substituted for each match Returns: The resulting String ReplaceAll value - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI TTS s Language yes ReplaceAll : {.Element.SBString ReplaceAll.value} SBString ReplaceAll Menu SBString ReplaceAll - Action Element String Method Regex ucce emear replaceall e

47 Voice Application Specification Page 47 of 52 SBString Replacement RR replaceall Method ReplaceAll value Page: replacefirst - replacefirst(string regex,string replacement) Replaces the first substring of this string that matches the given regular expression with the given replacement. Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string. Parameters: regex - the regular expression to which this string is to be matched replacement - the string to be substituted for the first match Returns: The resulting String ReplaceFirst value - Voice Element VoiceXML Property Prompts Initial () - audio item 1 Audio File/TTS Use Audio Path URI yes

48 Voice Application Specification Page 48 of 52 SBString TTS s Language ReplaceFirst : {.Element.SBString ReplaceFirst.value} SBString ReplaceFirst Menu SBString ReplaceFirst - Action Element String Method Regex Replacement ucce emear replacefirst c RR replacefirst Method ReplaceFirst value

49 Voice Application Specification Page 49 of 52 SBString 3. Recording List 3.1. Prompts Page: main Element Menu Audio Group (Language) Digits Initial () File Name Transcript Language s SELECT METHOD (1) split (2) charat (3) length (4) substring (5) indexof (6) lastindexof (7) touppercase (8) tolowercase (9) replace (10) replaceall (11) replacefirst (AnyOther) EXIT

50 Voice Application Specification Page 50 of 52 SBString Page: split Element Split value Token1 Token2 Token3 Token4 Token5 Audio Group (Language) Initial () File Name Transcript Language s Split Token Count :{.Element.SBString Split.value} Initial () TOKEN 1 : {.Session.Token1} Initial () TOKEN 2 : {.Session.Token2} Initial () TOKEN 3 : {.Session.Token3} Initial () TOKEN 4 : {.Session.Token4} Initial () TOKEN 5 : {.Session.Token5} Page: charat Element CharAt value Audio Group (Language) Initial () File Name Transcript Language s CharAt : {.Element.SBString CharAt.value} Page: length Element Length value Audio Group (Language) Initial () File Name Transcript Language s Length : {.Element.SBString Length.value} Page: substring Element Substring value Audio Group (Language) File Name Transcript Language s Initial () Substring : {.Element.SBString Substring.value} Page: indexof

51 Voice Application Specification Page 51 of 52 SBString Element IndexOf value Audio Group (Language) Initial () File Name Transcript Language s IndexOf : {.Element.SBString IndexOf.value} Page: lastindexof Element LastIndexOf value Audio Group (Language) File Name Transcript Language s Initial () LastIndexOf : {.Element.SBString LastIndexOf.value} Page: touppercase Element ToUpperCase value Audio Group (Language) File Name Transcript Language s Initial () ToUpperCase : {.Element.SBString ToUpperCase.value} Page: tolowercase Element ToLowerCase value Audio Group (Language) File Name Transcript Language s Initial () ToLowerCase : {.Element.SBString ToLowerCase.value} Page: replace Element Replace value Audio Group (Language) Initial () File Name Transcript Language s Replace : {.Element.SBString Replace.value} Page: replaceall

52 Voice Application Specification Page 52 of 52 SBString Element ReplaceAll value Audio Group (Language) File Name Transcript Language s Initial () ReplaceAll : {.Element.SBString ReplaceAll.value} Page: replacefirst Element ReplaceFirst value Audio Group (Language) File Name Transcript Language s Initial () ReplaceFirst : {.Element.SBString ReplaceFirst.value}