3         Desktop for Web Elements

The main work area of Desktop for Web is called the main Desktop window. This chapter provides an overview of its screen elements.

Its two major elements Object Browser and Dialog Designer are described in more detail in the following chapters (Chapter 4 – Object Browser and Chapter 5 – Dialog Designer).

For more information on the object editors, the other important area of Desktop for Web for developing phone applications, refer to Chapter 6 – Object Editors.

For more information on how to develop applications with Desktop for Web see Chapter 7 Basic Commands and the Design Guide.

Desktop Modes

You can either enter the main Desktop window in project mode (obligatory for users with Designer role or in Control Center mode (obligatory for users with any controller role).

To open the main Desktop window in project mode do the following:

1.        Log into Desktop for Web. For details see Chapter 1 – Getting Started with Desktop for Web.

2.        In the Open Project window either open a project version of any project, or create a new project. For details see Chapter 2 – Working with Projects.

The main Desktop window will open up in project mode displaying the Project Home Page for the current project in the right-hand pane.

In project mode you have access to all project-relevant folders and menus. Administrators in addition have access to all configuration-relevant folders and menus here.

Example of the main Desktop window in project mode:


 

To open the main Desktop window in Control Center mode do the following:

1.        Log into Desktop for Web. For details see Chapter 1 – Getting Started with Desktop for Web.

2.        In the Open Project window, click Control Center. The main Desktop window will open up in Control Center mode displaying the Control Center Home Page in the right-hand pane.

Controllers get straight to the main Desktop window in Control Center mode upon login.

In Control Center mode access is restricted to all configuration-relevant folders and menus.

Example of the main Desktop window in Control Center mode:


 

For more information on user roles and their individual privileges see Chapter 2 – User Management – Basic Topics in the Administration Guide.

Elements Overview

The main Desktop window contains the following main elements that are explained in more detail in their respective paragraphs:


Element

Description

Menu bar

Contains the File, New, Tools, View, and Help menus.

Toolbar

Contains shortcut buttons to frequently used commands or objects available in Desktop for Web.

Status bar

Displays the most recent information about the current project and the VoiceObjects environment.

Left-hand pane

Provides the Object Browser.

Right-hand pane

Main working area of Desktop for Web. The following worksheets are displayed here: Project Home Page, Control Center Home Page, Dialog Designer, Control Center, Desktop Logging, and Desktop Sessions.

Object Browser

The Object Browser contains folders and subfolders that are filled with the respective objects available for that type in the current project.

Project Home Page

Displays the project properties of the current project and allows direct access to Help.

Control Center Home Page

Contains buttons to create new configuration objects.

Dialog Designer

Displays dialog flows for selected objects of the current project.

Control Center

Enables the administration of servers and services. The Control Center is described in detail in the Deployment Guide.
To access the Control Center you need the appropriate rights (administrator or controller).

Desktop Logging

Displays a list of all Desktop log files with options for viewing and downloading them.

Desktop Sessions

Displays the currently active Desktop sessions. For details see Monitoring Desktop Sessions in Chapter 2 – User Management – Basis Topics in the Administration Guide.

 

The main Desktop window can be moved and resized customarily with the left mouse button.

Apart from the main Desktop window, the most frequently used working area within Desktop for Web are the object editors that always open up when creating or editing any object. Object editors are explained in more detail in Chapter 6 – Object Editors.

Menu Bar

The menu bar of Desktop for Web allows access to the File, New, Tools, View and Help menus. All options are explained in detail below.


File menu

The File menu contains commands associated with projects and project versions.



The File menu commands have the following functions:


Command

Function

New Project

Opens up the New Project window where a new project can be created. For details see Create a Project in Chapter 2 – Working with Projects.

Open Project

Opens up the Open Project window where an existing project and a corresponding project version may be selected out of a project list. For details see Open a Project and a Project Version in Chapter 2 – Working with Projects.

Configure Project

Opens up the Project editor to view additional information on the current project or to modify its properties.

Publish Project Version

Allows creating a project version of the current project. For details see Publish a Project Version Chapter 2 – Working with Projects.

Open Project Version

Opens up the Open Project Version window where a project version of the current project may be selected out of a project version list.

Export Project Version

Opens up the Export window in order to export an entire project version. For details see Export a Project Version in Chapter 2 – Working with Projects.

Configure Project Version

Opens up the Project Version editor to view or modify the properties of the current project version. Also in the Project Version editor, you can link project libraries into your project. For details on linking project libraries see Link a Library into a Project in Chapter 2 – Working with Projects.

Enter Reviewer Annotation

Opens up the Reviewer Annotation window to enter an annotation for the project version. For details on entering reviewer annotations see Enter a Reviewer Annotation Chapter 2 – Working with Projects.

Exit

Exits Desktop for Web. You need to clearly log out this way (instead of just closing the browser window) to return the Desktop seat license. For more information on Desktop seat licenses see Chapter 4 – Managing Licenses in the Administration Guide.

 

i8Note: Depending on your user role and/or the Desktop mode you are in not all of the commands explained above may be accessible. For detailed information on user roles and their privileges see Chapter 2 – User Management – Basic Topics in the Administration Guide.

New menu

The New menu contains a list of all object types. The objects are grouped into the categories Components, OSDM, Resources, Logic, Actions, Layers and Business Tasks divided by a small bar.

If you click an object type the corresponding object editor will open up allowing creating a new object.

For details on the use and function of all objects see the Object Reference.


i8Note: This menu is not accessible in Control Center mode.


Tools menu

The Tools menu contains commands for various additional actions.



The Tools menu commands have the following functions:


Command

Function

Import Object from File

Opens up the Import – File window to import objects from files into the current project. For details see Import objects from a file in Chapter 7 – Basic Commands.

Import Object from Browser Clipboard

Opens up the Import – Browser Clipboard window to import objects from the browser clipboard into the current project. For details see Import objects from the browser clipboard in Chapter 7 – Basic Commands.

Audio File Registration

Opens up the Audio File Registration window to bulk register audio files. For details see Audio File Registration in Chapter 6 – Handling External Resources in the Design Guide.

Search Objects

Opens up the Search editor to enter search criteria to find specific objects. For details see Search Objects in Chapter 7 – Basic Commands.

Search Unused Objects

Lists all objects that are not referenced by other objects. For details see Search Unused Objects in Chapter 7 – Basic Commands.

Change Password

Allows changing your current password.

Configure New Server

Opens up the Server editor to configure a new Server object. For details see Configuring a Server in Chapter 2 – Server and Services in the Deployment Guide.

Configure New Service

Opens up the Service editor to configure a new service. For details see Configuring a Service in Chapter 2 – Server and Services in the Deployment Guide.

Configure New User

Opens up the User editor to specify a new user. For details see Configuring a New User in
Chapter 2 – User Management – Basis Topics in the Administration Guide.

Configure Licenses

Opens up the License editor to view or modify the current licenses or to specify new licenses. For details see Chapter 4 – Managing Licenses in the Administration Guide.

VoiceObjects Analyzer

Opens up VoiceObjects Analyzer, the web-enabled reporting and analysis component of VoiceObjects. For details see the Analyzer Guide.

Project Documentation

Opens up the Project Documentation window to specify various options and create the corresponding project documentation as a PDF document. For details see Create Project Documentation in Chapter 7 – Basic Commands.

Storyboard Export

Opens up the Storyboard Export window to specify various options and create the corresponding storyboard as a Microsoft Excel file. For details see Create Storyboard Export in Chapter 7 – Basic Commands.

Launch Storyboard Manager

Launches the Storyboard Manager for Design and Migration. For details on how to use this tool see the Storyboard Manager Guide.

Voxeo Prophecy Hosting

Opens up Voxeo´s Evolution Developer Portal where you can register for Voxeo´s free developer hosting service.

 

i8Note: Depending on your user role and/or the Desktop mode you are in, not all of the commands explained above may be accessible. For detailed information on user roles and their privileges see Chapter 2 – User Management – Basic Topics in the Administration Guide.

View menu

The View menu contains the following commands:



The View menu commands have the following functions:


Command

Function

Refresh

Refreshes the Object Browser and the active worksheet in the right-hand pane.

Project Home Page

Brings the Project Home Page to the front.

Desktop Logging

Displays a list of all Desktop log files with options for viewing and downloading them.

Desktop Sessions

Displays the currently active Desktop sessions. For details see Monitoring Desktop Sessions in Chapter 2 – User Management – Basis Topics in the Administration Guide.

 

i8Note: Depending on your user role and/or the Desktop mode you are in, not all of the commands explained above may be accessible. For detailed information on user roles and their privileges see Chapter 2 – User Management – Basic Topics in the Administration Guide.

Help menu

The Help menu contains the following commands:



The Help menu commands have the following functions:


Command

Function

VoiceObjects Help

Opens up the VoiceObjects Online Help in a new browser window on your Windows desktop.

VoiceObjects Tutorial

Opens up the VoiceObjects Online Tutorial in a new browser window on your Windows desktop.

VoiceObjects Documentation

Provides access to the VoiceObjects documentation in PDF format.

Readme

Opens up the Readme information provided for the current VoiceObjects installation in a new browser window on your Windows desktop.

VoiceObjects Home Page

Opens up the VoiceObjects Home Page in a new browser window on your Windows desktop.

VoiceObjects Technical Support

Opens up the VoiceObjects Technical Support page in a new browser window on your Windows desktop.

VoiceObjects Developer Portal

Opens up the VoiceObjects Developer Portal page in a new browser window on your Windows desktop.

About VoiceObjects

Opens up the Start screen displaying information about the currently installed VoiceObjects version.

Toolbar

The toolbar contains icons for general Desktop for Web commands, for all object types belonging to the Components category, and for OSDMs.



i8Note: In Control Center mode only the Refresh function is accessible.

If you point to an icon a tooltip will be displayed providing the name of the command.


Button

Command

Function

Refresh

Refreshes the Object Browser and the active worksheet in the right-hand pane.

Display Options

Opens the Display Options window where you can specify display options for the Dialog Designer. For details on display options see Display of Dialog Flows in Chapter 7 – Basic Commands.

Collapse Subtrees

Collapses the object selected in the current dialog flow - including all its subtrees.

Expand Subtrees

Expands the object selected in the current dialog flow - including all its subtrees.

Search objects

Opens the Search editor to search for objects according to a specific selection. For details refer to Search Objects in Chapter 7 – Basic Commands.

 

< object icons>

Opens up the object editor for the selected object type in order to create a new object.

Status Bar

The status bar at the bottom of the main Desktop window displays the most recent information about a project and the current VoiceObjects environment.


 

The following information is displayed here:

Left field: the user name currently logged into Desktop for Web and the name of the machine running it.

Middle field: displays the project name and project version name.

Right field: displays the product name, product version, and build number.

Right-Hand Pane

The right-hand pane is the main working area of Desktop for Web. Depending on your user role and/or the Desktop mode you are in, you can open different kind of worksheets here: the Project Home Page, the Control Center Home Page, the Dialog Designer, the Control Center, Desktop Logging, and Desktop Sessions.

The title of the active worksheet is shown at the top and tabs for all open worksheets at the bottom.


Open a worksheet

The different kinds of worksheets are opened as follows:

·          The Project Home Page is the initial page if you enter the main Desktop window in Project mode. To bring it to the front, select the View menu and click Project Home Page or click the Project Home Page tab.

·          The Control Center Home Page is the initial page if you enter the main Desktop window in Control Center mode. To bring it to the front, click the Control Center Home Page tab.

·          To open the Dialog Designer, right-click the selected object in the Object Browser or in another Dialog Designer and click Display Dialog. If you click Display and Validate Dialog you will get additional information on the dialog flow. You can open up several Dialog Designer worksheets.

·          To open the Control Center, right-click the selected Server object in the Object Browser and click Control Center. You can open up one Control Center worksheet for each Server object available.

·          To view the Desktop Logging, select the View menu and click Desktop Logging.

·          To view the Desktop Sessions, select the View menu and click Desktop Sessions.

The new worksheet will be added and displayed as the active worksheet.

Switch between worksheets

Click the tab of a worksheet to bring it to the front.

Remove worksheets

To remove a worksheet, do the following:

·          Right-click the tab of the worksheet you want to remove and click Remove Worksheet.

To remove a Dialog Designer worksheet you can also right-click any white space within the Dialog Designer and from the context menu select Remove Worksheet.

Scroll tabs

If you have more worksheet tabs than are displayable at the bottom of the right-hand pane you may use the scroll buttons on the left of the tab list for scrolling.


Button

Command

Function

First worksheet

Scrolls to the first tab in the row.

Previous worksheet

Scrolls one tab to the left.

Next worksheet

Scrolls one tab to the right.

Last worksheet

Scrolls to the last tab in the row.

Project Home Page

The Project Home Page is the initial worksheet in the right-hand pane when entering the main Desktop window in Project mode. It displays the name, a short description and the creation date of the current project and project version.


 

In addition, the Project Home Page provides the following buttons:


Button

Function

Opens up the Project editor to display additional information on a project or to change the project properties.

Opens up the Project Version editor to display additional information on a project version or to change the project version properties.

Opens up the VoiceObjects Online Help.

Opens up the VoiceObjects Tutorial.

Control Center Home Page

The Control Center Home Page is the initial worksheet in the right-hand pane if you enter the main Desktop window in Control Center mode. It displays buttons to directly access the configuration object editors (see below).


 

In addition, the Control Center Home Page provides the following buttons:


Button

Function

New Server – Opens up the Server editor to configure a new Server object. For detailed information see Configuring a Server in Chapter 2 – Configuring Servers and Services in the Deployment Guide.

New Service – Opens up the Service editor to configure a new Service object. For detailed information see Configuring a Service in Chapter 2 – Configuring Servers and Services in the Deployment Guide.

New User – Opens up the User editor to configure a new user. For detailed information see Chapter 2 – User Management – Basic Topics in the Administration Guide.

Licenses – Opens up the License editor to manage licenses. For detailed information see Chapter 4 – Managing Licenses in the Administration Guide.

Desktop Logging

The Desktop Logging sheet displays a list of all Desktop log files with options for viewing (up to a maximum size of 1 MB) and downloading these files.



To view a log file in a new window, click on its name. To download a log file, click the Download button to the right of its name.

Both viewing and downloading are only possible if the log file is not empty.