Weblogic Authors: Yeshim Deniz, Elizabeth White, Michael Meiner, Michael Bushong, Avi Rosenthal

Related Topics: Weblogic

Weblogic: Article

Build Voice Presentation Layers For Delivering Applications To Phones

Build Voice Presentation Layers For Delivering Applications To Phones

BEA WebLogic Workshop 8.1 provides a wide range of tools for creating Web server applications. Components integrated using Workshop's extensible component model include Java controls, page flows, and source and design views that are available to any software vendor or Web application developer.

As the foundation of an integrated development environment, WebLogic Workshop offers the power to build new Web services that naturally inherit its Web design innovations. SandCherry's AppDev VXML is one example of extending BEA WebLogic Workshop 8.1 functionality to allow the creation of services that can be accessed by phone.

Interactive Voice Response (IVR) and speechbased services using touch-tone or speech recognition can now be consolidated with Web applications into a three-tiered application infrastructure, reducing solution costs and improving the user experience. These services have traditionally run on proprietary silos of hardware and software completely independent of Web-based applications and infrastructure. The silo approach drives up solution costs by duplicating data integration, business logic, and systems - not to mention the cost of user dissatisfaction caused by inconsistent experiences between different voice and Web systems. Developers can now simply add a new voice presentation layer to Web applications to extend their reach to any customer or employee with a phone while reusing existing business logic and back office resources (see Figure 1).


The SandCherry AppDev voice extension facilitates development of the voice presentation layer for controlling speech and media resources, which include automatic speech recognition (ASR), text-to- speech (TTS), and prerecorded prompts. By integrating the voice presentation layer development components into WebLogic Workshop 8.1, developers can reduce the time and cost of developing and maintaining a speech application by reusing the controls and models already created in the Workshop IDE for a Web application.

Integration Overview
Any voice application requires three components to work: the voice user interface design and flow, written in VoiceXML (VXML); grammars that identify what spoken input the application will recognize, written in Grammar XML (GRXML); and audio prompts and announcements played to the user that are captured as wave or other types of audio formats. Adding a voice application development environment under WebLogic Workshop required integration with five major Workshop components to provide a seamless development experience between Web and voice Web projects. Extending these components consists of integrating previously stand-alone applications and creating new applications that dock and run within the Workshop workspace. The five components extended by AppDev VXML and the tools that use them are:

  • Web Project: Voice Web Project
  • Document: Audio, Grammar XML (GRXML), and VoiceXML (VXML) document types
  • Tag Library: VoiceXML and GRXML tags for voice documents
  • Action: Voice-related menu and toolbar and launching external applications
  • Frame: Application frames that can be docked within WebLogic Workshop

    The functionality added to WebLogic Workshop offers both development and testing tools, since one of the primary objectives in building the development environment was to create a complete stand alone development and test environment for speech applications. Using the Workshop-based approach, developers no longer require an expensive and complex speech hardware platform to develop and test voice applications.

    Voice Application Development Tools
    Voice applications require several different components that must be combined to deliver the three basic functions required for a voice interaction with a user: controlling the application flow, processing voice input from a user, and outputting prerecorded (or synthesized) information to a user. The development tools added represent the combination of the Web view presented by Workshop and the voice application view required by the speech and media components used to deliver the voice application. The development tools added include:

  • Voice Web Project: Project to maintain voice-related documents and functionality. A Voice Web Project inherits the Web project functionality of a WebLogic Workshop Web Project.
  • VXML Document: Document containing a VXML page depicting the flow of a voice application. A VXML document inherits JSP document functionality from the WebLogic Workshop JSP Document.
  • GRXML document: Document containing a GRXML page, which lists the valid text (grammars) representing the spoken words the application will recognize. A GRXML document inherits JSP document functionality in the same manner as a VXML document.
  • Audio Document: Document containing wave audio data of a prompt or announcement to play to a caller. The prompt is generally played before trying to recognize a caller's response. This is a completely new document type that extends Workshop's base Document class.
  • Tree Design View: Creates a tree-oriented view of a VXML or GRXML page. The tree gives the developer an easy-to-manage and readable view of the voice documents just as Workshop does for Web documents.
  • Voice Menu and Toolbar: Menu and toolbar containing voice application tools. SandCherry added the Log Viewer, Validator, SoftPhone, and Test Voice Application tools that are available from the voice menu and toolbar. These options were incorporated by extending the WebLogic Workshop Action class.
  • Validator: Uses a third-party parser to validate a VXML or GRXML page being hosted by the WebLogic Web Server. Integrating this component required extending the WebLogic Workshop Frame class.

    Together, these tools allow a developer to add tags from VXML and GRXML tag libraries, create wave files to be played within a voice application, and validate the scripts of the application before testing.

    Voice Web Project
    The Voice Web Project is a new project type created to hold both voice and Webrelated documents. The project extends WebLogic Workshop's Web Project, and by doing so inherits Web project functionality. Java Controls (JCX), Java Page Flows (JPF), and any other legal Web document may be added to a voice project. Once a new application has been created, the "Voice Web Project" can be found under the "Voice Interface" category. This project type was created to accommodate the integration of VXML, GRXML, and audio documents for a Voice User Interface (VUI) into the Workshop model while providing sufficient separation due to the unique nature of speech applications to avoid unnecessarily complicating existing Web projects in Workshop.

    The Documents
    There are three new voice document types that exist only within a Voice Project - VXML, GRXML, and audio documents. Once the project has been created, a developer can create these voice documents just like any other Workshop document (see Figure 2).


    Voice Extensible Markup Language (VoiceXML or VXML), defined by the W3C standards body, is the leading speech application language today. The description of VXML contained in the standard is:

    "VoiceXML is designed for creating audio dialogs that feature synthesized speech, digitized audio, recognition of spoken and DTMF key input, recording of spoken input, telephony, and mixed initiative conversations. Its major goal is to bring the advantages of Web-based development and content delivery to interactive voice response [IVR] applications."

    The SandCherry team identified several overriding goals that guided the WebLogic Workshop extensions to support VXML files:
    1.  WebLogic Workshop must understand VXML 2.0 in order to provide familiar IDE development aids such as property editing and code completion.
    2.  HTML and VXML document types must be different within Workshop.
    3.  Each VXML file must be processed as a JavaServer Page (JSP) to harness the power of the BEA WebLogic platform.

    Since SandCherry's AppDev's VXML was developed in parallel with the WebLogic Workshop integration, fundamental design choices such as using JSPs for the VXML pages within AppDev allowed the development team to easily integrate with Workshop's JSP Document Class and inherit the capabilities provided by WebLogic Workshop. Creating a custom JSP tag library for VXML made it possible to integrate into Workshop's JSP designer and reuse many of its features to help developers write VXML. Because some functionality must be enabled when an AppDev document is open, but disabled when a standard Workshop document is open, a new document type was required. Creating the new document type was accomplished within the WebLogic Workshop extensibility framework by extending the base Document class to create a new "voice document" type for both VXML and GRXML file types.

    GRXML is another W3C standard used for defining grammars within voice applications. As stated in the specification:

    "Grammars [are] for use in speech recognition so that developers can specify the words and patterns of words to be listened for by a speech recognizer. The syntax of the grammar format is presented in an XML Form."

    GRXML documents were added to WebLogic Workshop in the same way as VXML documents, with the "voice document" type mapped to the file extension "grxml". A unique tag library was created for GRXML based on W3C's "Speech Recognition Grammar Specification" (SRGS 1.0).

    Audio documents present two unique challenges within the WebLogic Workshop framework since an audio document is simply a wave file used within a voice application. First, audio files include wave recordings, not text, yet must still reside in the Workshop project so that the application can use them. The second challenge is that presenting an application developer with a GUI-based source or design view of a wave file isn't very useful. An audio recording tool must be embedded into the Workshop document editor to address these challenges.

    BEA WebLogic Workshop offers a clean and easy solution to these challenges by giving the tool developer the flexibility to extend the base Document class, remove the source view, and embed a once standalone tool into the Workshop workspace. Using this method, an audio recording and playback tool was integrated into the Workshop environment so that when an audio document is opened, the audio tool is launched in what is normally the source view window. This tool records audio files for use during development and testing of the voice application.

    Tree Design View
    A Tree Design view was created for VXML and GRXML documents to take the place of the original Design View. Since both VXML and GRXML documents inherit JSP functionality, the original Design view was not useful for creating voice applications. Using a tree to display and develop a voice application provides a clear hierarchical view of the script. Under this view, a developer may also close and open nodes to shrink and expand sections of the application to focus on particular portions of the document. WebLogic Workshop provides the flexibility to disable the original view and create a new one that can be displayed as a tab in the source editor (see Figure 3).


    With all of the functionality it provides, the Tree Design view is a very powerful tool for creating a voice application. First, it provides integral error checking of the tags. Second, it makes it easy to cut, paste, copy, and move large sections of a document. Finally, it provides an easy-to-read view of the entire voice document.

    The error checking built into the Tree Design view offers users a familiar environment to build voice files incorporating many of the features found in the normal WebLogic Workshop design view: nodes containing errors are color coded in a similar fashion; right-clicking on elements (tree nodes) within the view displays a menu that includes the legal actions for that node; and users can drag-and-drop any tag for any node. Additional intelligence is provided on insertion to ensure that tags are valid within the VXML specification to help avoid basic errors. The Tree Design view uses the underlying Workshop compiler service to provide diagnosis for each of the nodes (see Figure 4).


    Voice Menu and Toolbar
    The Voice Menu and Toolbar are simple controls that allow a user to start voice tools, including Test Voice Application, Log Viewer, Validator, and SoftPhone.

    Adding these tools to the menu options is easily accomplished by extending the Workshop Action class with several lines of XML that specify the location of the tool, the icon, and the Java code to run when the option is selected. A snippet of script for adding the Validator menu option is shown in Listing 1.

    In this example, the "action class" is the Java code to launch the Validator, Validator.gif is the icon to display, and "location priority" specifies where to display the tool within the toolbar and menu. Adding actions within WebLogic Workshop is simple, yet powerful, since these actions integrate seamlessly and inherit the Workshop look and feel (see Figure 5).


    The Validator tool verifies VXML and GRXML documents by pulling both types of files from a WebLogic Server and running them through a "validating parser" (Apache Xerces) in AppDev VXML using the W3C Schema appropriate for the current document. The parser downloads the active file in the same way that a VXML browser downloads applications from the Web server during service deployment. The content being validated is displayed in a window, along with a list of any errors found in the document.

    The Validator, which is written in Java, uses a Swing panel that plugs neatly into Workshop's Frame extensions. These extensions allow the Validator to provide a consistent UI experience for the developer by inheriting Workshop's look, feel, and functionality.

    Test Voice Tools
    Testing a voice application offers a new set of challenges not originally envisioned within the Workshop environment. Where a Web application can be easily displayed in a window, a voice application requires a phone-based interaction with a speech platform controlling a number of different media components. SandCherry has preintegrated a variety of components using its software-based speech platform and added a software-based phone emulator to provide a complete test environment for voice applications. Four tools are used when testing a voice project within an application.

  • Test Voice Application: This component starts the voice platform and component processes necessary for testing a voice application.
  • SoftPhone: A software-based phone emulator that allows a developer to call a voice application for testing. The Workshop Action class is used to start the SoftPhone application, which is an external component to WebLogic Workshop.
  • Log Viewer: A developer may view the logs of all the different voice resources while the application is running or after the application has completed. The Log Viewer uses the Workshop Frames class to allow the log viewer to dock within Workshop and inherit the appropriate look-and-feel.
  • AppTuner: A software-based speech platform for a laptop or PC that controls the speech recognition, prompt playing, and text-to-speech media components required for application testing.

    Test Voice Application
    Test Voice Application simplifies the test process by allowing the developer to launch multiple components needed to test an application using a single button. Using the WebLogic Workshop Action class, this button starts the WebLogic Server to host the application, the Log Viewer to view speech resource logs, and the SoftPhone for calling the application. When launched, the SoftPhone is automatically populated to run the current VXML document.

    The SoftPhone, like the audio document, is also a stand-alone program. Again, extending the Action class from the Voice Menu made it easy to start the SoftPhone without requiring any changes to the SoftPhone application. Other WebLogic Workshop extensions allowed SandCherry to retrieve current document information used to auto-populate the phone and specify which VXML document to run (see Figure 6).


    Log Viewer
    The Log Viewer provides access to important information regarding the status of the speech resources used to run a voice application. For example, as an application is processing speech recognition, the log viewer can be used to verify that the recognition engine is matching speech grammars correctly.

    The Log Viewer is launched from the Voice Menu or toolbar via WebLogic Workshop's Action class (see Voice Menu and Toolbar), seamlessly integrating into Workshop by using the Frame class. By default, the window has the appropriate look-and-feel of other WebLogic Workshop components and can dock into multiple locations (see Figure 7).


    AppTuner, the underlying speech platform for testing voice applications, is a complex system with a number of integrated components. The AppTuner Console is a separate GUI program for starting and managing speech resource components, giving the application developer an easy to read view of the running speech resources (see Figure 8).


    Originally, the console was going to be the only portion of the AppDev suite requiring start-up outside of the WebLogic Workshop window - unfortunate since all other voice development tools were embedded neatly within the Workshop framework. A simple solution exists within Workshop, however, that requires no code at all to add this to the Workshop environment.

    WebLogic Workshop provides a tool for starting an executable from the Tools menu. Following the steps below made the stand-alone AppTuner Console an integrated tool within Workshop.
    1.  From the Tools menu, select IDE Properties.
    2.  In the left-hand pane of the IDE Properties Window, click on the Tools folder.
    3.  Select the New Tool button at the top of the right-hand pane.
    4.  In the Tool Name text box, enter "AppTuner Console".
    5.  In the Directory text box, enter the full path to the AppTunerConsole.exe
    6.  Click OK.

    The console is now available from the External Tools menu option within Workshop.

    Integrating SandCherry's AppDev VXML into BEA WebLogic Workshop 8.1 provides a number of unique challenges due to the inherent differences between voice applications and Web applications. Incorporating a new project and file types for voice applications, dealing with files that contained only recorded audio, and incorporating external applications into Workshop were only a few of the potential roadblocks to offering a complete voice development environment seamlessly integrated into Workshop. Surprisingly, this effort was far easier than expected, despite moments that prompted head-scratching and calls to the BEA WebLogic Workshop team.

    In the end, however, the extensibility components built into WebLogic Workshop 8.1 provided solutions for almost every challenge faced during integration. Extensible Project, Document, Frame, and Action classes offered tremendous flexibility for incorporating new capabilities into the WebLogic Workshop framework. In addition to supporting internal enhancements, Workshop's extensibility support provided different ways to incorporate external applications and even allow applications unrelated to the Web application server or its components to appear fully integrated. Developers can now build and test Web and voice applications seamlessly using BEA WebLogic Workshop 8.1 and SandCherry's AppDev VXML.

  • More Stories By Eric Assouad

    Eric Assouad is a senior software engineer for SandCherry with nearly a decade of experience developing both ERP and telecommunications object oriented software. He has held key architect, developer, and software team lead roles for creating innovative telecom products such as Web-based voice conferencing.

    More Stories By Al Haddock

    Al Haddock is a senior software engineer with SandCherry and has over 15 years’ experience developing software for the defense, bioinformatics, and telecom industries. Drawing on over a decade of object-oriented programming experience, he has also taught courses in both introductory and advanced Java.

    More Stories By Michael Clark

    Michael Clark is a software engineer for SandCherry experienced in developing speech and multimodal (data+voice) applications using VoiceXML and Speech Application Language Tags (SALT), with a focus on combining Web and network technologies. 

    Comments (0)

    Share your thoughts on this story.

    Add your comment
    You must be signed in to add a comment. Sign-in | Register

    In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.

    @ThingsExpo Stories
    SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
    SYS-CON Events announced today that TidalScale, a leading provider of systems and services, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. TidalScale has been involved in shaping the computing landscape. They've designed, developed and deployed some of the most important and successful systems and services in the history of the computing industry - internet, Ethernet, operating s...
    SYS-CON Events announced today that IBM has been named “Diamond Sponsor” of SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California.
    Join IBM November 1 at 21st Cloud Expo at the Santa Clara Convention Center in Santa Clara, CA, and learn how IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Cognitive analysis impacts today’s systems with unparalleled ability that were previously available only to manned, back-end operations. Thanks to cloud processing, IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Imagine a robot vacuum that becomes your personal assistant tha...
    SYS-CON Events announced today that TidalScale will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. TidalScale is the leading provider of Software-Defined Servers that bring flexibility to modern data centers by right-sizing servers on the fly to fit any data set or workload. TidalScale’s award-winning inverse hypervisor technology combines multiple commodity servers (including their ass...
    As hybrid cloud becomes the de-facto standard mode of operation for most enterprises, new challenges arise on how to efficiently and economically share data across environments. In his session at 21st Cloud Expo, Dr. Allon Cohen, VP of Product at Elastifile, will explore new techniques and best practices that help enterprise IT benefit from the advantages of hybrid cloud environments by enabling data availability for both legacy enterprise and cloud-native mission critical applications. By rev...
    Infoblox delivers Actionable Network Intelligence to enterprise, government, and service provider customers around the world. They are the industry leader in DNS, DHCP, and IP address management, the category known as DDI. We empower thousands of organizations to control and secure their networks from the core-enabling them to increase efficiency and visibility, improve customer service, and meet compliance requirements.
    With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend 21st Cloud Expo October 31 - November 2, 2017, at the Santa Clara Convention Center, CA, and June 12-14, 2018, at the Javits Center in New York City, NY, and learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.
    SYS-CON Events announced today that N3N will exhibit at SYS-CON's @ThingsExpo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. N3N’s solutions increase the effectiveness of operations and control centers, increase the value of IoT investments, and facilitate real-time operational decision making. N3N enables operations teams with a four dimensional digital “big board” that consolidates real-time live video feeds alongside IoT sensor data a...
    Amazon is pursuing new markets and disrupting industries at an incredible pace. Almost every industry seems to be in its crosshairs. Companies and industries that once thought they were safe are now worried about being “Amazoned.”. The new watch word should be “Be afraid. Be very afraid.” In his session 21st Cloud Expo, Chris Kocher, a co-founder of Grey Heron, will address questions such as: What new areas is Amazon disrupting? How are they doing this? Where are they likely to go? What are th...
    In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, will lead you through the exciting evolution of the cloud. He'll look at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering ...
    Digital transformation is changing the face of business. The IDC predicts that enterprises will commit to a massive new scale of digital transformation, to stake out leadership positions in the "digital transformation economy." Accordingly, attendees at the upcoming Cloud Expo | @ThingsExpo at the Santa Clara Convention Center in Santa Clara, CA, Oct 31-Nov 2, will find fresh new content in a new track called Enterprise Cloud & Digital Transformation.
    Most technology leaders, contemporary and from the hardware era, are reshaping their businesses to do software. They hope to capture value from emerging technologies such as IoT, SDN, and AI. Ultimately, irrespective of the vertical, it is about deriving value from independent software applications participating in an ecosystem as one comprehensive solution. In his session at @ThingsExpo, Kausik Sridhar, founder and CTO of Pulzze Systems, will discuss how given the magnitude of today's applicati...
    SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp emp...
    Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
    As popularity of the smart home is growing and continues to go mainstream, technological factors play a greater role. The IoT protocol houses the interoperability battery consumption, security, and configuration of a smart home device, and it can be difficult for companies to choose the right kind for their product. For both DIY and professionally installed smart homes, developers need to consider each of these elements for their product to be successful in the market and current smart homes.
    SYS-CON Events announced today that Avere Systems, a leading provider of enterprise storage for the hybrid cloud, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Avere delivers a more modern architectural approach to storage that doesn't require the overprovisioning of storage capacity to achieve performance, overspending on expensive storage media for inactive data or the overbui...
    Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
    SYS-CON Events announced today that Avere Systems, a leading provider of hybrid cloud enablement solutions, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Avere Systems was created by file systems experts determined to reinvent storage by changing the way enterprises thought about and bought storage resources. With decades of experience behind the company’s founders, Avere got its ...
    High-velocity engineering teams are applying not only continuous delivery processes, but also lessons in experimentation from established leaders like Amazon, Netflix, and Facebook. These companies have made experimentation a foundation for their release processes, allowing them to try out major feature releases and redesigns within smaller groups before making them broadly available. In his session at 21st Cloud Expo, Brian Lucas, Senior Staff Engineer at Optimizely, will discuss how by using...