Avaya SAB User Manual
Avaya SAB User Manual

Avaya SAB User Manual

Avaya sab speech application builder: user guide

Advertisement

Quick Links

Avaya Speech Applications Builder
Configurator User Guide
May 15, 2004

Advertisement

Table of Contents
loading

Summary of Contents for Avaya SAB

  • Page 1 Avaya Speech Applications Builder Configurator User Guide May 15, 2004...
  • Page 2 While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors. Changes and corrections to the information in this document may be incorporated in future releases.
  • Page 3 Web site: http://www.avaya.com/support All Avaya switch products are compliant with Part 68 of the FCC rules, but many have been registered with the FCC before the SDoC process was available. A list of all Avaya registered products may be found at: http://www.part68.org/...
  • Page 4 Order: Avaya support Avaya provides a telephone number for you to use to report problems or to ask questions about your contact center. The support telephone number is1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Web site: http://www.avaya.com...
  • Page 5: Table Of Contents

    Debugging facilities Version control Starting SAB... 16 Logging in Entering the License Key Changing your password Exiting SAB The SAB GUI... 19 The Menu bar The Tool bar Context menus The Browser The Dialog Modeler window The Dialogs tree ... 33...
  • Page 6 Finding a stored dialog Copying a dialog flow Renaming a dialog flow Migrating a dialog flow Saving a dialog flow Importing a dialog flow from file The Prompts tree... 82 Adding a new recorded prompt Searching for a prompt Viewing a recorded prompt Editing a prompt Exporting and importing prompt files Persona...
  • Page 7: About This Document

    Starting SAB, see page 16, describes how to start up the SAB Configurator. • The SAB GUI, see page 19, provides a description of the SAB GUI, its workspaces, menus • and buttons The Dialogs tree, see page 33, provides a description of the Dialogs resource, including how •...
  • Page 8: System Requirements

    System requirements The minimum system requirements for running Speech Applications Builder are as follows: Hardware requirements Minimum speed required for platform Minimum memory required for platform Software requirements Speech Applications Builder Operating System Speech Applications Builder has been verified to run under Windows 2000. However, it should also be capable of running under any operating system that supports Java™...
  • Page 9: Introduction To Speech Applications Builder

    The main dialog flow may contain one or more sub-dialog flows (and a sub-dialog flow may have sub flows of its own). SAB dialog flows are built using pre-defined SAB components, and are created as a type of flow diagram, drawn using the SAB GUI. For a description of the SAB GUI, see page 19.
  • Page 10: The Structure Of A Dialog Flow

    Figure 1. The different step icons (left to right): dialog, process, rule and Begin Dialog step When you create a new dialog flow (see page 34), SAB automatically creates a Begin Dialog step and an End Dialog step.
  • Page 11 • Process steps Process steps handle data. Figure 2 shows a process step that accesses a database to retrieve the customer record associated with a particular loan number. Other SAB processes include: addition, subtraction, multiplication, division, total, exponentiation • check lookup table •...
  • Page 12 SAB rules are boolean. They include less than, more than, equal to • text handling rules • list handling rules • looping • More complex boolean rules can be built using multiple rule components. For example If id = 10 AND name = "Jones”...
  • Page 13: Prompts

    Figure 4. The construction of a typical confirmation prompt When the dialog flow is run, SAB sends the text of the prompt to the Text-To-Speech (TTS) synthesizer, which synthesizes a speech equivalent of the text and returns it to SAB to be played out to the caller.
  • Page 14: The Sab Database

    When the SAB Configurator is updated, both the Configurator and the SAB database are uninstalled. It is therefore essential to export all dialog flows to file (see page 77) before uninstalling SAB. The dialog flows can be re-imported after the Configurator has been upgraded.
  • Page 15 SAB is both a development environment and a runtime environment, and provides a formal • mechanism for migrating a dialog from the development phase (the tool environment) to the deployment phase (the production environment) and then to the decommissioned phase (the decommission environment).
  • Page 16: Starting Sab

    Start > Programs > Avaya Speech Applications Builder Logging in If this is the first time you have opened the Configurator, SAB will ask you to enter a License Key (see page 17). Otherwise, SAB displays the User Authentication dialog box, which asks you to enter a UserID and Password.
  • Page 17: Entering The License Key

    Entering the License Key If this is the first time you have opened the Configurator, SAB asks you to enter a License Key. To enter the License Key: Enter or copy it into the dialog box. Click OK. Changing your password To change your password: Open the SAB Configurator.
  • Page 18: Exiting Sab

    Exiting SAB To exit SAB, select File > Exit. If you have made unsaved changes to a dialog flow, SAB will ask you if you want to save the dialog flow. Figure 8. Save warning message Speech Applications Builder Configurator User Guide • May 15, 2004 • page 18 of 116...
  • Page 19: The Sab Gui

    The SAB GUI This chapter provides a brief description of the SAB Graphical User Interface (GUI). The features discussed here are described in more detail at the appropriate places in the remainder of the manual. The SAB GUI consists of a Menu bar and Tool bar, running along the top, which display both generic and context- •...
  • Page 20: The Menu Bar

    Used to import an SAB file stored outside the SAB database. See page 79. Used to save an SAB dialog flow file to a location outside the SAB database. See page 77. Saves the currently selected dialog flow in the SAB database.
  • Page 21: The Tool Bar

    Add Prompt Import Wave Zip Create Wave Extract The Tool bar The Toolbar, which runs along the top of the SAB Configurator, provides short cuts to some of the options available from the Menu bar. Generic buttons Add Organization Add ...
  • Page 22 The Dialog flow is saved to the SAB database. Check out a Dialog Model Opens an editable version of the dialog flow and locks out other users. Since SAB is a multi-user environment, checking in and checking out ensures that only one user can work on a dialog at any time.
  • Page 23: Context Menus

    Prompt buttons The following buttons are provided when the Prompts resource is in use. The selection of buttons displayed is relevant to the task being performed. Add (create) a prompt Import a zipped prompt directory. See page 89. Export a zipped prompt directory. See page 89. Delete Context menus Many of the options provided on the Menu bar and Tool bar are also presented on pop-up Context...
  • Page 24: The Browser

    The Components Workbench is used to import new components and manage existing • components. See page 92. Administration is used to manage SAB. See page 93. • In some respects, the tree displayed in the Browser acts like a typical directory structure. For example, all Dialog flow files are displayed beneath the Dialogs node.
  • Page 25 If you click on a dialog flow icon, (for example, Main Dialog in the Figure above, which is, in effect, a leaf node), SAB displays the Dialog Model Version Index, shown in the Figure below, which lists all the versions of the dialog flow available, and you can open the version you require by clicking on the entry.
  • Page 26 • have been taken out of deployment (and related prompts). Click Search. SAB displays a list of all matching entities in the Dialog Modeler window. Click Show Details to display further details. Click on the entity name to open it in the Dialog Modeler window.
  • Page 27 Thumbnail and zoom facilities When a dialog flow is open in the Dialog Modeler window, the Browser also provides a thumbnail view of the entire dialog flow, outlining the area that is also displayed in the Dialog • Modeler window with a red border Figure 15.
  • Page 28 a “zoomed” view of the dialog flow, which can be scrolled by moving the cursor around the • Dialog Modeler window. Figure 16. The Browser “zoomed” view Speech Applications Builder Configurator User Guide • May 15, 2004 • page 28 of 116...
  • Page 29: The Dialog Modeler Window

    The Dialog Modeler window The Dialog Modeler window (on the right of the Configurator) is a workspace where you can build new dialogs and view or amend existing dialogs. It allows you to build, test, analyze and deploy dialog flows. Figure 17.
  • Page 30 • default minimum confidence (see Glossary, page 114) • no input timeout - defines the length of silence that must elapse before SAB • classifies the response as no input maximum errors allowed - defines the maximum number of times SAB attempts •...
  • Page 31 Arrange steps and connections Check repository for updated components If any newer versions are available, SAB gives you the opportunity to update the dialog. Add component Opens the Select Component dialog box, which allows you to select a component and then “paste”...
  • Page 32 Multiple dialog flow windows Multiple dialog flow windows may be opened in the Dialog Modeler and can be selected from the list displayed under the Windows option in the Menu bar • from the drop-down list accessed from the blue title bar at the top of the Dialog Modeler •...
  • Page 33: The Dialogs Tree

    The Dialogs tree Interactions between an automated system and a caller are called dialogs. The software that performs a dialog is called a dialog flow (or a dialog model or, sometimes, a process). A dialog flow may contain one or more sub-dialog flows (and a sub-dialog flow may have sub flows of its own).
  • Page 34: Classification

    Classification The Classification feature is used to build the file directory structure by grouping and nesting dialog flows; for example, the Figure below shows a dialog flow “Main Dialog” that has been classified under “Direct Debit”, which has itself been classified under “Banking”. Figure 21.
  • Page 35 3. Enter a dialog flow Name. 4. Click Finish. SAB allocates a default version number of 1.0 to a new dialog and automatically adds it to the Tool Environment, where it can be edited. Figure 22. Add New Dialog 1...
  • Page 36 It lists the Dialog Model name in the Dialogs tree, and opens a read only version of the new dialog flow, complete with Begin Dialog and End Dialog steps, in the Dialog Modeler window. Figure 23. The Dialog Modeler window (at right hand side) Speech Applications Builder Configurator User Guide •...
  • Page 37: Checking In And Out

    Checking in and out SAB is a multi-user development environment. To prevent more than one developer simultaneously editing a dialog flow, SAB does not allow you to edit a dialog flow until you have checked it out. Figure 24. The read-only warning message While a dialog flow is checked out, no other developer can edit it (though he or she may open another read only version).
  • Page 38: Building A Dialog Flow

    Checking in To check in a dialog flow: 1. Click on the Check in button on the Tool bar. SAB asks if you want to save the dialog flow before you check it in. 2. Click Yes to save or No to check in without saving.
  • Page 39 Visibility of variables As you build a dialog flow, SAB automatically makes available to the current component all the variables defined in all the previous components in the path. For this reason, the most efficient way to draw a dialog is to add a component, connect it to the previous component, then edit its details.
  • Page 40 • Figure 29. The Select Component dialog box, showing the Add button (center) SAB displays the Select Categories dialog box. Figure 30. The Select Categories dialog box, showing a selection of valid categories Speech Applications Builder Configurator User Guide • May 15, 2004 • page 40 of 116...
  • Page 41 7. Click on the canvas of the Dialog Modeler window. SAB pastes the component onto the canvas. You can reposition it by clicking on it (in the case of a dialog component, click on its title box) dragging it to a new position, and dropping it.
  • Page 42 Figure 32. A connection between two dialog steps Setting up or editing a dialog step To set up or edit a dialog step, double-click on the title box of the component. SAB displays the Edit Step dialog box. Figure 33. The Edit Step dialog box of the Question component, used to edit dialog steps...
  • Page 43 Each dialog step must be configured to perform the specific task required by the dialog flow. The majority of dialog steps handle an interaction with the caller and typically perform the following tasks: Play out an initial prompt; for example, Please select one of the following options: Red, Blue or •...
  • Page 44 The question to ask field. Note that the step must be linked to previous steps before SAB can populate the Folder Data field if you want to specify an existing .wav file, stored in the SAB database, click on the Prompts •...
  • Page 45 A prompt can be built up from several of these elements; for example: Figure 35. Defining a prompt Dynamic information is formatted (for example, as a date or an amount of money) using variable handlers. Figure 36. A variable token Speech Applications Builder Configurator User Guide •...
  • Page 46 Select the appropriate folder (this will narrow the search and speed up retrieval of the prompt file at runtime). c. Check either of the following: Match whole phrase only – if SAB cannot find the appropriate file it will leave a “blank” in the • prompt Allow mixed TTS/prompts –...
  • Page 47 Voice Properties To set the “Voice Properties” (the recognition parameters for this recognition), click Show Details. SAB displays the Voice Properties dialog box. Figure 38. The Voice Properties dialog box Speech Applications Builder Configurator User Guide • May 15, 2004 • page 47 of 116...
  • Page 48 SAB allows you to configure the following recognition parameters: Parameter Description Timeout The Timeout parameter sets the length of silence that must elapse before the recognizer returns a value of No Input. Barge-in The Barge-in parameter specifies the barge-in setting to be used on this recognition.
  • Page 49 Parameter Description Confidence Level Confidence is a floating point value that indicates the perceived accuracy of the recognition result. The Confidence Level parameter sets the accuracy threshold: a recognition result with a confidence value above the threshold is considered successful; a recognition result with a confidence value below the threshold is considered a no-match.
  • Page 50 Parameter Description Fetch Audio The Fetch Audio parameter specifies the location of the audio clip to be played to cover the delay while waiting for a document to be fetched. The fetching of the audio clip is governed by the values of Audio Fetch Hint and Fetch Timeout. The playing of the audio clip is governed by the values of Fetch Audio Delay and Fetch Audio Minimum.
  • Page 51 Confirmation If the caller’s answer requires confirmation select the Confirmation tab and do the following: define the confirmation prompt as described in the previous step. A confirmation prompt • typically has the following format: Variable dragged and dropped from a list of previously defined variables Typed Did you <caller_data>...
  • Page 52 if you want the step to confirm the data it has captured only if the recognition result has a • confidence value below a certain threshold, leave the Explicit confirmation box unchecked and set the slider controls to the thresholds you require Figure 41.
  • Page 53 To set either of these functions, click the appropriate Show Details button. Figure 42. Setting up confirmation handling 3 SAB opens a dialog box; for example, the Confirmation No Match dialog box is shown in the Figure below. Define the prompt wording.
  • Page 54 Note that confirmation is not usually required when the main prompt is a yes-no question, but is often necessary if the caller has provided accurate data, such as a postcode or an amount of money. Speech recognition Components that are designed to recognize a standard item of data, such as a date, a time or a weight, have built-in grammars that will recognize any valid response.
  • Page 55 For example, for the Question Dialog Step you must define a set of valid caller responses, with synonyms (alternative words) if appropriate, and SAB uses these to generate a recognition grammar. These recognitions are typically configured on the Choices and Results page.
  • Page 56 4. To (optionally) enter a synonym, click the Alternatives : Add button. SAB displays the first page of the Attach Values wizard. 5. Click Next. SAB displays the second page. 6. Enter the synonym in the Substitute Word field. Click Finish. SAB re-displays the Add Value dialog box, with the alternative word shown in the Alternatives field.
  • Page 57 Figure 49. The Add Value dialog box, showing a valid response SAB displays the option in the Valid Answers field of the Edit Step dialog box. Figure 50. The Edit Step dialog box of the Question component, showing a valid response defined To define another valid response, repeat from Step 1 above.
  • Page 58 4. Specify how the recognition results are handled by defining the Slot Names as follows: a) Click on Add Value. SAB displays the Add Value dialog box. b) Enter the first Slot Name associated with the grammar rule.
  • Page 59 No Input If the caller remains silent, the dialog step plays the prompt that has been defined on the No Input page. For an explanation of prompt levels, see page 53. Figure 53. The No Input page, showing a typical No Input prompt. No Match If the caller says something that does not match any of the choices defined on the Choices and Results page, the dialog step plays the prompt that has been defined on the No Match page.
  • Page 60 Misrecognition If the caller disconfirms the recognition result, the dialog step plays the prompt that has been defined on the Misrecognition page. For an explanation of prompt levels, see page 53. Figure 55. The Misrecognition page, showing a typical Misrecognition prompt. Settings The Settings page is used to configure the general behavior of the dialog step.
  • Page 61 To set up a process component: 1. Double click on the process step icon. SAB displays the Edit Step dialog box. 2. The majority of Process components are configured via a single page, called Default. The data that must be entered is component-specific.
  • Page 62 1. Select the Trigger Modeler window. 2. Select the type of trigger you want to create (see list above). 3. Check Create. SAB opens a dialog window. 4. Build the alternative dialog flow. If the trigger being defined is an Exception trigger, ensure that the dialog flow contains an ExceptionFlowControlStep (see below).
  • Page 63 Step trigger To set up a step trigger: 1. Open the Edit Step dialog box. 2. Select the Edit Step trigger page. 3. Create the trigger as described above. ExceptionFlowControlStep An exception trigger dialog flow must always contain at least one ExceptionFlowControlStep, which must be in a path that will be executed whenever the trigger dialog flow is run.
  • Page 64 FALSE result. 2. Double click on the decision point on the TRUE path. SAB opens the Rule Editor dialog box. 3. Enter a brief description. This will be displayed next to the rule in the Dialog Modeler window.
  • Page 65 5. Select the component you require, using the search facility (see page 39). Figure 59. The Select Component dialog box 6. Click Use. SAB displays the undefined rule in the Rule Editor dialog box. Figure 60. The undefined rule Speech Applications Builder Configurator User Guide • May 15, 2004 • page 65 of 116...
  • Page 66 7. Double click on the rule icon (“less than or equals to” in the Figure above). SAB displays the Edit Rule dialog box. 8. The data you will need to enter is rule-specific. As you build a dialog flow, SAB automatically makes available to the current component all the variables defined in all the previous components in the path.
  • Page 67 • If the step is valid, SAB displays the result in a pop-up message: If the step is invalid, SAB displays a pop-up error message, which lists the errors it has detected and provides links to the Java stack trace.
  • Page 68: Sub-Dialogs

    To define an input variable: 1. With the sub-dialog flow open in the Dialog Modeler window, click on the Required Data tab. SAB displays the Required Data window. 2. Click Add. Voice Runner displays the Add Data Type wizard.
  • Page 69 5. Click on the canvas of the Dialog Modeler window. SAB pastes the dialog flow onto the canvas as a single component. You can reposition it by clicking on its title box, dragging it to a new position, and dropping it.
  • Page 70 To assign the input variables: 1. Double click the Sub-Dialog step. SAB displays the Step Editor, which lists, in the Sub-Process input column of the Input tab, the input variables that you have already specified in the Required Data window.
  • Page 71 6. Click Add Assignment. SAB lists the output variables you have already defined in the Output Data window. 7. Select the variable you require and click Next. 8. Select Add value to folder (add variable) or Replace value in folder (overwrite variable). Click Next.
  • Page 72: Deleting A Dialog Flow

    (not the version number) and select Dialog Model > Deletes the Selected Dialog Model Version SAB asks you to confirm that you want to delete the dialog flow. Click Yes. The dialog flow is deleted. Deleting components and connections A component must be physically connected to another component to see its variables.
  • Page 73: Finding A Stored Dialog

    Deleting rules If you use the method described in the previous section to delete a rule, SAB will also delete the connection it lies on. To delete a rule: 1. Double click on the rule. Voice Runner opens the Rule Editor dialog box.
  • Page 74: Copying A Dialog Flow

    Figure 70. The Copy Dialog Model dialog box 3. By default, SAB assigns the name “Copy of...” to the new dialog; this may be changed. If more than one version of the dialog is available, select the version number you require.
  • Page 75: Renaming A Dialog Flow

    4. Select the version number you want to copy. Click Next. 5. Click Finish. The new dialog flow is created in the tool environment. SAB displays it in the Dialogs tree and automatically opens an editable version in the Dialog Modeler window.
  • Page 76: Migrating A Dialog Flow

    1. Open the dialog flow. 2. Check the dialog flow out (see page 37). 3. Click on the Migrate button. SAB will ask you to confirm that you want to migrate the dialog flow. 4. Click Yes. 5. SAB will check if the dialog flow is valid.
  • Page 77: Saving A Dialog Flow

    Saving a dialog flow By default, dialog flows are saved in the SAB database. However, they can also be exported to an external file (see page 77). Saving a dialog flow to the SAB database To save an open dialog flow: Do one of the following: •...
  • Page 78 SAB displays the Export Dialog Model dialog box, which lists all the dialogs available. Figure 73. Export Dialog Model dialog box 1 3. Check the Dialog flows you want to export. 4. Click Next. SAB lists the available models of the dialog flows you have selected.
  • Page 79: Importing A Dialog Flow From File

    2. Browse to the location of the .vra file, select it and click Open. If the .vra file contains out of date components, SAB displays a warning and may ask you to resolve any step conflicts that arise (see page on page 80).
  • Page 80 4. Click Finish. Problems with importing If the .vra file contains out of date components, SAB displays the following warning. Figure 77. Out of date components warning Speech Applications Builder Configurator User Guide • May 15, 2004 • page 80 of 116...
  • Page 81 SAB displays a table of missing component versions and their possible replacements. 6. Click Finish. Step conflict If a component cannot automatically be upgraded to a new equivalent, SAB displays Step Conflict information. To resolve the step conflict: 1. Either select the appropriate new component from the drop down list or select Leave unconnected to delete the path.
  • Page 82: The Prompts Tree

    Right click on the Prompts tree to display the pop-up Prompts context menu and select Add • Prompt SAB displays the first Add New Prompt dialog box. Figure 80. Add New Prompt 1 Speech Applications Builder Configurator User Guide • May 15, 2004 • page 82 of 116...
  • Page 83 2. (Optionally) enter a classification path name (see page 34 for an explanation of classification). 3. Enter a prompt name. 4. Click Next. Figure 81. Add New Prompt 2 5. Specify the source of the new prompt - an existing file or a new recording. 6.
  • Page 84 2. Click Next. Save the prompt (see page 86). Recording a new prompt If you have opted to record a new prompt, SAB displays the recording tool shown below. Figure 83. Add New Prompt 3: recording tool Speech Applications Builder Configurator User Guide • May 15, 2004 • page 84 of 116...
  • Page 85 The following options are provided by the Prompt editor. Load Prompt from File Record Prompt Play Prompt Pause Prompt Stop Prompt Save Prompt to File Remove selected audio Remove all but selected audio Clear To record a prompt: 1. Connect a headset and microphone to the sound card on your computer. 2.
  • Page 86 To save the prompt, when you have either selected the correct .wav file or are satisfied with the recording: 1. Click Next. SAB displays the final dialog box: 2. Enter the exact text of the prompt you have recorded into the top field. This text will be used under the following circumstances: it is played out using TTS if the .wav file is not available (to prevent the dialog coming to a...
  • Page 87: Searching For A Prompt

    Searching for a prompt SAB provides a search engine that can be used to search for the prompt you require. To search: 1. Click on the Prompts tree. Voice Runner displays its Prompt Search engine in the Dialog Modeler window.
  • Page 88: Editing A Prompt

    2. Click the Scissors button to delete the selected area. Alternatively, you can delete everything but the selected area by clicking on the Curly brackets button. 3. When you select another resource, SAB asks whether you want to save your changes. 4. Click Yes.
  • Page 89: Exporting And Importing Prompt Files

    Saving a prompt to file To save a prompt to file: 1. Open the prompt .wav file 2. Click on the Disk icon. SAB displays a Save dialog box. 3. Browse to the file location and enter the appropriate filename. 4. Click Save.
  • Page 90: Persona

    Persona What is persona? A persona is the “personality” one person assigns to another person (real or virtual) based on how he or she looks or sounds, or seems to behave. In the case of an automated telephone service, persona is created by details such as the voice type –...
  • Page 91 1. Record the prompts using the appropriate voice artist and prompt wording. 2. Create the prompts by specifying an existing file (see page 84). 3. Assign the appropriate persona type (see page 86). SAB then stores the prompt in the SAB database with the appropriate persona label.
  • Page 92: The Component Workbench

    The Component Workbench The Component Workbench is used to import new SAB components. The components are supplied as a .jar file. Importing components To import new components: 1. Expand the Component Workbench (by clicking on the + sign) in the Browser window.
  • Page 93: The Administration Resource

    Figure 90. Dialog deployment war wizard 1 4. All SAB applications have a top level flow - the flow that will be run first when a caller interacts with an application. Select the top level flow. 5. Click Next.
  • Page 94 Figure 91. Dialog deployment war wizard 2 6. Either check the version number you want to deploy or check AutoUpdate. 7. Click Next. Figure 92. Dialog deployment war wizard 3 8. Check the environment you want the war file to run in: Tool - under construction •...
  • Page 95 .war suffix. This means that the default value of /servlet/MainDialogFlow will typically make SAB available at http://Machine:Port/sab/servlet/MainDialog if the SAB WAR is called sab.war and Machine and Port are the address and port on which the servlet container is listening for HTTP requests. Accept default...
  • Page 96 These parameters are initialized to whatever values are currently in the ccp.properties file, which correspond to the values the SAB Configurator is using to access the repository database. The values will typically not need to change if the runtime is to use the same database as the Configurator, however it may be necessary to change the address of the database server to a format which resolves correctly from the machine where the runtime is to be deployed.
  • Page 97 Language When creating a prompt (see page 86) you are asked to specify its language and SAB labels the prompt file accordingly. This feature allows you to create a single application in multiple languages. Some languages have multiple variants or 'locales' (for example, US English, UK English) which are pronounced differently.
  • Page 98 5. Click OK. Persona When creating a prompt (see page 86) you are asked to specify a persona and SAB labels the prompt file accordingly. This feature allows you to create a single application that uses multiple personae. Persona is discussed in detail earlier.
  • Page 99 1. Open the Persona tool (see above). 2. Select the persona name. 3. Click on the Edit button. SAB displays the Input dialog box (with an empty field). Figure 98. Input dialog box (used to edit Persona) 4. Enter the corrected persona name.
  • Page 100: Debugging A Dialog

    2. Check out the dialog flow. 3. Select the Dialog Analysis tab. SAB splits the right-hand window into two areas, then displays the entire dialog flow in the upper window and lists the individual dialog paths in the lower window.
  • Page 101 A textual Short Description of the path. • 5. To trace a particular path on the process diagram, select the path in the list and SAB will highlight it on the diagram, in yellow (see the Figure on page 100).
  • Page 102: Run/Debug

    1. Open the dialog flow. 2. Check out the dialog flow. 3. Select the Run/Debug tab. SAB displays the Run/Debug window. Figure 101. The Run/Debug window 1 Speech Applications Builder Configurator User Guide • May 15, 2004 • page 102 of 116...
  • Page 103 Address Remote Server Port number of the remote server Port Local Server Address or name of the machine on which the SAB Configurator is running Address Local Server Port Port number of the local server Render Style Select the style in which VoiceXML is presented from the drop-down list...
  • Page 104 Fit the whole dialog to screen Refresh dialog flow to reflect any changes introduced by Debugging Setup. 6. Click the Servlet Information tab to view technical details of the interaction between the SAB dialog flow and the VoiceXML browser. Speech Applications Builder Configurator User Guide • May 15, 2004 • page 104 of 116...
  • Page 105: System Preferences

    System Preferences Certain features of SAB can be configured by selecting File > System Preferences to display the Edit System Preferences dialog box, which contains three pages: Dialog Modeler - which is used to configure visual aspects of the Dialog Modeler window, see •...
  • Page 106 Show Step Names Enables/disables display of step names Show Decision Labels Enables/disables the display of rule names Modify Long Step If step names are being displayed, offers a choice of the following methods Names of displaying long names: • Display whole name •...
  • Page 107: General Preferences

    Confirm Delete Enables/disables request for confirmation before an a dialog model or Prompt is deleted. Note that SAB does not ask for confirmation before deleting a component step or connection, even if Confirm Delete is enabled. Query Save on Close Enables/disables Save query message before closing an unsaved dialog flow.
  • Page 108: Appendix A: Component List

    Appendix A: Component List The following components are supplied with the SAB Configurator. For more information about a specific component, see the SAB Components Guide. Component type Core Dialog Handler Name Basic BlockingSayDialogStep CallReceiveDialogStep CallRedirectDialogStep DynamicAnswerDialogStep DynamicGrammarQuestionDialogStep DynamicMenuDialogStep DynamicSayDialogStep DynamicSelectFromListDialogStep...
  • Page 109 Component type Core Process (continued) Name Basic FixedFormatEmailStep JDBCLookupStep LookupTableProcessStep ModifyMenuChoicesStep PropertiesFileNumericLookupTableStep Control EndProcess ExceptionFlowControlStep InsertNewVariables InterruptStep PromptLanguage PromptPersona ReRunLastDialogStep ReturnFromInterruptStep SetNumberVariable SetTextVariable StartProcess TerminateProcess Math AdditionStep TotalStep DivisionStep ExponentiationStep MathAbsoluteValue MultiplicationStep RoundNumber SubtractionStep Speech Applications Builder Configurator User Guide • May 15, 2004 • page 109 of 116...
  • Page 110 Component type Core Process (continued) (continued) Rule Process Name Reporting ReportCallActtivityStep ReportCallEndStep ReportCallInformationStep String CapitalizeAllWords MakeVariableUppercase Math BooleanRule DiffGreaterThanVariableRule EqualsVariableRule GreaterThanRule LessThanRule LoopRule RandomVariable RangeRule String ContainsTextVariableRule EndsWithVariableRule StartsWithVariableRule TextDoesntExistRule TextExistsRule TextSubtext Basic GetCorrelationIDProcessStep GetLastFourDigitsProcessStep NumberRangeMappingProcessStep Message ICMDeliveredEventStep ICMNewCallMessageStep ICMSendRegisterVariableMessageStep Speech Applications Builder Configurator User Guide •...
  • Page 111 Component type Process (continued) (continued) Intermediate Dialog Name Message ICMSendRouteRequestMessageStep (continued) SendDeliveredEvent SendEventReport SendNewCall SendRegisterVariables SendRequestInstruction SendRouteEndEvent SendRouteRequestEvent SendRunScriptResult Variable GenerateECCVariableProcessStep GetSingleECCVariableProcessStep InitialiseECCValuesListProcessStep SetSingleECCVariableProcessStep Basic LetterSequenceDialogStep NumberDialogStep NumberSequenceDialogStep PhoneNumberDialogStep WeightDialogStep List SelectFromListDialogStep Money MoneyDialogStep Date DateDialogStep MonthAndYearDialogStep MonthAndYearWithTooEarlyAndTooLateResponses MonthDialogStep TimeDialogStep Speech Applications Builder Configurator User Guide •...
  • Page 112 Component type Intermediate Dialog (continued) (continued) Handler Process Rule Name Date WeekDayDialogStep (continued) YearDialogStep Money MoneyHandler Date DateHandler List Merge/ReplaceStep Technical DumpFolderToLog SessionBeanClient WriteToFileStep Time GetSystemTimeMillisProcessStep SystemDateAndTime List ItemExistsRule Speech Applications Builder Configurator User Guide • May 15, 2004 • page 112 of 116...
  • Page 113: Appendix B: Data Types

    Appendix B: Data types XSD Type Description xsd:boolean Represents boolean values (true or false). xsd:decimal A generic number data type with variable-precision, 64-bit, floating-point number. xsd:double A variable-precision, 64-bit, floating-point number. xsd:user_defined User Defined Data Type xsd:long An integer data type with a range of -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807.
  • Page 114: Glossary

    SAB is a multi-user development environment. To prevent more than one check out developer simultaneously editing a dialog flow, SAB automatically opens it in a read-only version. The developer cannot edit the dialog flow until he or she checks it out. Whilst a dialog flow is checked out, no other developer can edit it (though he or she may open another read only version).
  • Page 115 “conversation”. Rule A component that performs boolean logic on an input. SAB database All components, dialog flows, and prompts are stored in a database called the SAB database. Step An instance of a component. Tools The environment (state) in which a dialog flow can be edited.
  • Page 116 Text-To-Speech synthesizer. Synthesizes a speech equivalent of text and returns it to SAB to be played out to the caller. Synthesized speech is particularly useful during the development of an application, but for a deployed system many service providers prefer to use a recorded voice.

This manual is also suitable for:

Speech applications builder configurator

Table of Contents