Dragon Medical Enterprise Network Edition vSync Best Practice Guide

Dragon Medical Enterprise Network Edition

Service Pack 2 and Hotfix 7

vSync Best Practice Guide

Contents

Reasons to upgrade to DMENE Service Pack 2 or Hotfix 7 5Benefits of upgrading to Service Pack 2 (Build 10.50.650.118 SP2) or Hotfix 7 5Supported upgrade paths for DMENE and DMENE components 5Upgrading Dragon to Service Pack 2 (Build 10.50.650.118 SP2) or Hotfix 7 6Verifying Service Pack 2 (Build 10.50.650.118 SP2) or Hotfix 7 are installed 6

Overview of vSync and Full Text Control 7Overview of vSync 7Overview of Full Text Control 7Availability of Full Text Control 8Applications with Basic Text Control support through vSync 8

Support for Dragon and vSync with Citrix clients and servers 9Support for Dragon with vSync and Citrix 9Support for Citrix Xenapp clients and Windows operating systems 11

Install vSync on a Citrix server 12Viewing Dragon set up log files to verify the vSync installation 13View the Dragon set-up log file from the Start Menu or Windows Explorer 13

Enabling vSync in the Nuance Management Console 14Recognizing a Full Text Control or vSync issue 15Recognizing a Full Text Control issue 15Recognizing a vSync issue 15Using log files to troubleshoot issues 15

What to do if someone reports a Full Text Control or vSync issue 17Checklist: Troubleshooting a Full Text Control or vSync issue 17

Restoring vSync support after updating a Citrix client 19Pre-requisites for installing the DMENE vSync Restoration Patch 19Steps for installing the DMENE vSync Restoration Patch on a workstation 20

Troubleshooting vSync on a workstation 21Verify the vSync plug-in is installed on the Citrix server 21Verify that the vddgncompatibility.dll is installed correctly 21Verify the vSync process on the workstation 22Verify the vSync registry entries on the workstation 22Verify Dragon users see a warning message about the vSync connection 22Verify Dragon users have disabled vSync for the current or all user sessions 23Verify Dragon users set Dragon to auto-disable vSync 23Verify the color of the Full Text Control indicator during dictation 26

Troubleshooting vSync on a Citrix server 28

Contents

4

Understand the vSync components that are on the Citrix Server 28Configure the MiniDragon watcher 28

View Dragon log files from the Nuance Management Console 30View the Dragon log file from the Nuance Management Console 30View the Dragon log file from the Start Menu or Windows Explorer 31What to look for in the dragon.log file when a user reports an issue with vSync 31

Viewing vSync log files for Dragon user activity with Citrix published appli-cations 32Important note about the size of vSync log files 32To enable vSync logging for all Dragon users that work with Citrix published appli-cations 32

Viewing notifications about vSync connectivity issues 33Obtaining the vSync timeout notification tool 33

Support for edit controls 34

Reasons to upgrade to DMENE ServicePack 2 or Hotfix 7

Benefits of upgrading to Service Pack 2 (Build10.50.650.118 SP2) or Hotfix 7Hotfix 7 includes many updates for Dragon users that use Dragon and vSync with applications

that are published from a Citrix server.

Dragon Medical Enterprise Network Edition (DMENE), Service Pack 2, is the newest version of

the product. Service Pack 2 includes many of the same vSync and Dragon updates from Hotfix 7.

You should upgrade to DMENE Service Pack 2 or Hotfix 7 as soon as possible.

Supported upgrade paths for DMENE and DMENEcomponentsThis section contains information about supported compatibility between different versions of

Dragon, vSync, and the Nuance Management Server (NMS). Use this information to plan your

next upgrade of DMENE.

The Dragon client in Service Pack 2 is compatible with the following versions of the NMS:

n RTM

n Service Pack 1

n Service Pack 2

The Dragon client in Service Pack 2 is compatible with the following versions of the vSync plug-

in on a Citrix server:

n RTM

n Service Pack 1

n Service Pack 2

For best results, you should upgrade the vSync plug-in to Service Pack 2 before you upgrade the

Dragon client to Service Pack 2.

The vSync plug-in in Service Pack 2 is compatible with the following versions of the Dragon

client:

n RTM

n Service Pack 1

n Service Pack 2

For best results, you should upgrade the Dragon client to Service Pack 2 as soon as possible.

The Nuance Management Server in Service Pack 2 is compatible with the following versions of

the Dragon client:

5

L-3422 DMENE vSync Best Practice Guide

6

n RTM

n Service Pack 1

n Service Pack 2

Upgrading Dragon to Service Pack 2 (Build10.50.650.118 SP2) or Hotfix 7To upgrade to the latest Dragon Medical Network Edition Client Version or to install Hotfix 7,

login to isupport.nuance.com and search for solution: “Solution 14274: What's New in Dragon

Medical Software and Can I download the current version?”

Verifying Service Pack 2 (Build 10.50.650.118 SP2)or Hotfix 7 are installed1. From the Dragon Bar menu, click Help.

2. Click About Dragon

3. The version number, as shown below, should be Version 10.50.650.118

Overview of vSync and Full TextControl

Overview of vSyncDragon Medical Enterprise Network Edition includes a feature called vSync that allows Dragon

users to use Full Text Control functionality with an application that is published from a Citrix

server.

vSync uses a connection with the Dragon client to tell Dragon about events in the Citrix server

window that corresponds to the generic window for the application on a client computer. This

allows Dragon users to utilize Full Text Control features with the published application.

To enable vSync for your Dragon user, you must perform the following tasks:

1. Install the vSync plug-in on the Citrix server

2. Enabling vSync in the Nuance Management Console

For details about support and system requirements for Dragon, Citrix, and vSync, see Support for

Dragon with vSync and Citrix.

Overview of vSync Mirroring

vSync mirroring of edit controls in Citrix published applications for information about cursor

movements, utterances, and window location and focus. The mirroring application accesses this

information by communicating through the Citrix Virtual Channel to a tracking application that

runs on the Citrix server. Applications published from a Citrix server appear as a Transparent

Windows Client on a client workstation.

vSync starts when a Dragon user accesses a published Citrix application.

Overview of Full Text ControlFull Text Control (formerly Select-And-Say) provides Dragon users with the full set of dictation,

editing, correction, menu, and dialog box features that are available in the Dragon client. The

commands that quote text from the screen (select <xyz>, correct <xyz>, insert after <xyz>…)

work thanks to Full Text Control. For more information about commands that are fully enabled by

Full Text Control, see the Dragon Help.

Full Text Control feature list

Full Text Control provides many capabilities and commands to Dragon users, including:

n Select and deselect text by voice and display the Correction menu (select <words>, select

<words> through <words>)

n Select from a list of alternative spellings and words (choose 1, etc.)

n Display the Spell dialog box (spell that)

n Play back dictation (play that back, play back paragraph, etc.)

7


8

n Capitalize selected text (cap that)

n Open the Correction menu. (correct <words>)

n Move the insertion point to a specific location (insert before <words>, insert after <words>)

n Overwrite the selected text with new dictation

If Full Text Control is not available, Dragon defaults to Basic Text Control which does not

include the capabilities mentioned in the Full Text Control features list.

Availability of Full Text ControlFor Full Text Control to be available to a Dragon user:

1. A Dragon user must use Dragon in applications with supported edit controls. See Support for

edit controls.

2. A Dragon user must use Dragon:

l with an application; and both Dragon and the application are installed and running on the

same client computer or both Dragon and the application are installed and running on the

same server. See Support for Dragon with vSync and Citrix.

l with Dragon installed and running on a client computer, an application published from a

Citrix server, and vSync enabled on both the Dragon client and the Citrix server.

In this configuration, vSync issues will occur if you:

l Install Dragon and then upgrade the XenApp client

l Install Dragon and then uninstall and reinstall the XenApp client

l Install the XenApp client after installing Dragon

If any of the above are true, perform one of the following actions:

l Run the patch installer – See Restore vSync after updating a Citrix client on a

workstation.

l From the Dragon installation DVD, run the Modify option to reinstall the

vSync for EHRs feature on the Dragon client and restore Full Text Control

functionality.

Applications with Basic Text Control supportthrough vSyncWhile vSync supports Full Text Control with certain applications published from Citrix, there are

some applications where only Basic Text Control support is available from the Dragon client. If

you use Dragon with these published applications over a vSync connection, features such as using

voice to correct text and move the cursor may not work as expected. The Dragon user may need

to use the DictationBox to make corrections and move the cursor.

The following is a non-exhaustive list of common applications where only Basic Dictation Control

is available over a Citrix connection. If you are using Dragon from a client computer and these

applications are published from a Citrix server, you can only use Basic Dictation Control with

these applications.

n Microsoft Word

n Microsoft Outlook (with Microsoft Word as the editor)

n Microsoft Excel

n Microsoft Internet Explorer

Notes:

n You can use Full Text Control with these applications if Dragon is on the Citrix server that the

applications publish from.

n Nuance will publish a Technical Note on this subject as soon as possible.

Support for Dragon and vSync withCitrix clients and servers

Support for Dragon with vSync and CitrixThis section lists the supported versions of the Citrix Xenapp client that you can use with the

Dragon client in Dragon Medical Enterprise Network Edition (DMENE). You can use this

information as you plan and set up your DMENE network.

In DMENE, vSync supports Full Text Control with certain applications published from Citrix.

The Citrix XenApp client session options must use "seamless" mode for publishing and

connecting to a published application.

Citrix XenApp client version 10

Citrix XenApp client type:

Web Client:

n Metaframe Presentation Server 4.5 on Windows Server 2003 32/64 bit

n XenApp 5 on Windows Server 2003 32/64 bit, Windows Server 2008 32 bit, and Windows

Server 2008 64 bit

Program Neighborhood:



Server 2008 64 bit

Program Neighborhood Agent



Server 2008 64 bit

9


10



Web Client:



Server 2008 64 bit

n XenApp 6 on Windows Server 2008 64 bit R2

Program Neighborhood:



Server 2008 64 bit



n XenApp 5 on Windows Server 2008 32 bit, and Windows Server 2008 64 bit




Web Client:



Server 2008 64 bit





Server 2008 64 bit


Support for Citrix Xenapp clients and Windowsoperating systems

CitrixXenAppclient

CitrixXenAppclient type

MetaframePresentationServer 4.5 XenApp 5 XenApp 6WindowsServer200332/64 bit

WindowsServer200832 bit

WindowsServer200864 bit

WindowsServer200864 bit R2

v10 Web Client Yes Yes Yes YesProgramNeighborhood

Yes Yes Yes Yes

ProgramNeighborhoodAgent

Yes Yes Yes Yes

v11 Web Client Yes Yes Yes Yes YesProgramNeighborhood

Yes Yes Yes Yes

ProgramNeighborhoodAgent

Yes Yes Yes Yes

v12 Web Client Yes Yes Yes Yes YesProgramNeighborhoodAgent

Yes Yes Yes Yes Yes

11


12

Install vSync on a Citrix serverThe vSync plug-in communicates with Dragon Medical Enterprise Network Edition 10.1 Client

in a Citrix environment. You install the vSync plug-in on a Citrix server to allow Dragon users to

use Full Text Control functionality with published applications that are on the server.

1. On the Citrix server that hosts the published applications, place the Dragon Medical Client 10.1

disc in to the DVD drive.

2. On the disc, perform one of the following actions:

l To install vSync on a 32-bit Citrix server, in the root directory of the DVD, find and

double-click the MiniTracker.exe file.

l To install vSync on a 64-bit Citrix server, in the root directory of the DVD, find and

double-click the MiniTracker_x64.exe file.

3. When the InstallShield Wizard appears, install the Visual C++ 9.0 runtime for Dragon by

clicking Install. You must install the C++ runtime before you install vSync.

4. On the Welcome screen, click Next.

5. On the Destination screen, to select a folder for the installation, click Change. Click Next to

install in the folder.

6. On the Ready to Install Program screen, click Install to start the installation process.

7. When the installation process is complete, on the 'InstallShield Wizard Completed' screen, click

Finish.

Viewing Dragon set up log files toverify the vSync installation

When you install the DMENEDragon client on a workstation, vSync is also installed if the

XenApp client is already installed. When vSync installs on the Dragon client, you can view the

dgnsetup.log file to verify that the vSync installation was successful. You can view the dragon set

up log file from the Start Menu or Windows Explorer.

If vSync did not or is not installed on the workstation, the dgnsetup.log file contains the

following text:

Script Info: <timeStamp>: Not-Installed or Not-SupportedFeature: vSync

View the Dragon set-up log file from the StartMenu or Windows ExplorerThere are several ways to locate the Dragon setup log file:

n In the Start Menu, select All Programs > Dragon Medical 10.1 > Show Setup Log

n In Windows Explorer, on Windows Server 2008, look here:

C:\Users\Administrator\AppData\Local\Temp\dgnsetup.log

n In Windows Explorer, on Windows XP, look here:

C:\Documents and Settings\<user_account_login>\LocalSettings\Temp\dgnsetup.log

13


14

Enabling vSync in the NuanceManagement Console

To enable vSync support for Dragon users, you must enable the vSync: Full Text Control option

in the Nuance Management Console (NMC).

After you enable the option, the vSync Full Text Control Support option starts when a Dragon

user opens an application published from a Citrix server where vSync is installed.

The vSync Full Text Control support starts communicating with vSync when the user logs into

the Dragon Medical Client 10.1, Dragon receives options data from the NMC that indicates the

vSync Full Text Control support option is enabled.

To enable vSync in the Nuance Management Console1. Launch the Nuance Management Console from an Internet browser.

2. Click Manage Organizations.

3. Click Site and select Organization Details.

4. Click the Dragon Settings tab and selectMiscellaneous.

5. Select vSync: Full Text Control.

Recognizing a Full Text Control orvSync issue

Recognizing a Full Text Control issueSymptoms that indicate Full Text Control is not working correctly include:

n A Dragon User complains that some commands are not working, especially the select <words>

command.

n Dragon User complains that Dragon does not capitalize the first word they dictate into a text

field.

n A Dragon User complains that Dragon is not always putting spaces between words.

n A Dragon User complains that Dragon is typing text slowly into the text field.

n A Dragon User complains of reduced accuracy in a certain text field. The user may actually

mean that Dragon is having trouble recognizing commands such as select <words>. You may

have to observe the user to verify that this is the case.

n The Full Text Control indicator is grey instead of green.

n The yellow message area of the DragonBar says “Dictating to a non-standard window” instead

of “Normal mode” after the user has dictated at least one phrase.

Recognizing a vSync issueIn addition to the above symptoms, symptoms that are specific to vSync include:

n Dragon displays a warning icon in the system tray area .

n A Dragon User reports seeing this message: "On <date> <time> a vSync connection issue was

detected – verify dictation. Click to dismiss."

Using log files to troubleshoot issuesYou can enable and view many different log files to troubleshoot issues that may be related to

vSync or Full Text Control. You can also email the log files to Nuance Technical Support to help

us trouble shoot the issue.

You can view the following log files to help trouble shoot issues with vSync:

n Dragon log file on the Dragon workstation: To troubleshoot possible vSync connectivity issues,

view the dragon.log file. See Viewing Dragon log files to troubleshoot vSync connectivity

issues.

n Dragon set up log file on the Dragon workstation: To verify that vSync was successfully

installed on a Dragon workstation, view the dgnsetup.log file. See Viewing Dragon set up log

files to verify the vSync installation.

15


16

n vSync log files on a Citrix server: To view data about the activities of Dragon users that dictate

into applications published from a Citrix server, view vSync log files. You must enable vSync

logging – it is disabled by default. See Viewing vSync log files for Dragon user activity with

Citrix published applications.

What to do if someone reports a FullText Control or vSync issue

Checklist: Troubleshooting a Full Text Control orvSync issueIf a vSync issue is reported, you can perform the following actions:

Action DetailsView online resources for DMENE To obtain technical support information, visit

http://isupport.nuance.comVerify that you or another administrator hasinstalled, upgraded, or re-installed the XenAppclient after installing Dragon.

Perform the following action if the answer to any ofthese items is Yes:From the Dragon installation DVD, run the Modifyoption to reinstall the vSync for EHRs feature on theDragon client and restore Full Text Control func-tionality.

Verify the Dragon client and vSync configuration Full Text Control with published applications is onlyavailable in certain configurations of Dragon andvSync.See Availability of Full Text Control.

Verify that the Dragon user is dictating into pub-lished applications that have Full Text Control sup-port through vSync

vSync does not support Full Text Control with certainpublished applications.See Applications with only Basic Text Control throughvSync.

Verify that the Dragon client and vSync areupdated to DMENE Service Pack 2 or Hotfix 7

See Benefits of upgrading to Service Pack 2 (Build10.50.650.118 SP2) or Hotfix 7.

Verify that Sync warningmessages are displayingto the Dragon user

Dragon displays a warning icon when there is a com-munication issue between vSync and the Dragonclient.See Verify Dragon users see a warningmessageabout the vSync connection.

Verify that certain vSync options are enabled inDragon

Users can manually disable vSync for the current ses-sion, all of their sessions, and set Dragon to auto-dis-able vSync. See the following topics:Verify Dragon users have disabled vSync for the cur-rent or all user sessions

Verify Dragon users set Dragon to auto-disable vSync

Verify the color of the Full Text Indicator in Dragon The DragonBar includes a Full Text Control indicatorthat indicates if Full Text Control or Basic Text Controlis available to the user.See Verify the color of the Full Text Control indicatorduring dictation.

Verify the vSync plug-in is installed on the Citrixserver that hosts the published application

The vSync plug-in must be installed on the server theDragon is connecting to.See Install vSync on a Citrix server.

17

http://isupport.nuance.com/


18

Action DetailsVerify that vSync is enabled on the Dragon work-station

See Enabling vSync in the Nuance Management Con-sole.

Verify that the Citrix ICA Client and Dragon wereinstalled properly and in the correct order.

See the DMENE 10 1 Dragon in a Citrix EnvironmentAdministrator Guide.pdf in http://i-support.nuance.com by searching for solution:14111 "Dragon Medical Enterprise.

Verify the current and active vSync processes See Verify the vSync processes on the workstation.Verify the vSync registry settings See Verify the vSync registry entries on the work-

station..Verify how often the vSync plug-in looks for theDragon custom virtual channel

See Configure the MiniDragon watcher.

View the Dragon set up log file and the Dragon logfile for information

See the following topics:Viewing Dragon log files to troubleshoot vSync con-nectivity issues

Viewing Dragon set up log files to verify the vSyncinstallation

Enable vSync logging You can set vSync to create log files that contain dataabout errors, warnings, or all activities for all vSyncusers on the server.See Viewing vSync log files for Dragon user activitywith Citrix published applications.

Enable notifications for vSync issues You can configure the NMS to send a notification ifthe vSync connection experiences a time out.See Viewing notifications about vSync connectivityissues.

Restore vSync after an upgrade of the Citrix ICAClient

Updating or reinstalling a Citrix ICA client deletes theDragon vSync components; disabling vSync support.See Restoring vSync support after updating a Citrixclient.

Ensure the Dragon user is dictating into a sup-ported edit control

Dragon users can use Full Text Control in specific editcontrols in applications (local or published).See Support for edit controls.

Verify that the System Requirements are met See Support for Dragon and vSync with Citrix clientsand servers.




Restoring vSync support afterupdating a Citrix client

Dragon uses vSync support to provide Dragon users with Full Text Control when they work with

applications published from a Citrix server. An administrator updates or reinstalls one or more

Citrix ICA clients on a workstation with Dragon.

Updating or reinstalling a Citrix ICA client deletes the Dragon vSync components; disabling

vSync support.

The vSync Restoration Patch provides a quick and simple way to reinstall vSync support after

updating or re-installing a Citrix ICA client. After updating or reinstalling a Citrix ICA client on a

workstation, run the patch on the workstation or push the patch install to the workstation.

In DMENE Service Pack 3, only use the vSync Restoration Patch to repair damaged vSync client

components or to install the vSync client components for the first time.

To upgrade vSync client components. use the the patch installer. Do not use the vSync

Restoration Patch to upgrade these components.

Note: You must upgrade vSync on your Citrix servers before you upgrade vSync on Dragon client

computers.

The patch can be run on a 32-bit or 64-bit workstation where all, some, or none of the vSync

components are installed. The patch installer can also be run in 'silent' mode.

When you run the patch installer, it successfully patches and re-registers the relevant dll and

component files. The installer also displays messages about installation success or errors.

You can run or push the vSync Restoration Patch using any version of the DMENEDragon client

Service Pack 1 (Build 10.50.650.033) or higher. If you do not have Service Pack 1, you must

install it before you can install the patch.

Pre-requisites for installing the DMENE vSyncRestoration PatchEnsure the following items are met before you run the patch. Otherwise, the patch installation

will fail and log error messages to the DgnSetup log file.

n The Dragon client must be installed on the workstation

n Dragon must not be running on the workstation

n A Citrix ICA client must be installed on the workstation

n Citrix ICA Client Engine process (wfica32.exe) must not be running on the workstation

You can install the patch even if the vSync components in the patch are the same version as the

vSync components currently installed on the workstation.

19


20

Steps for installing the DMENE vSync RestorationPatch on a workstationPerform the following steps after updating or reinstalling a Citrix ICA client on a workstation.

1. Ensure all the installation pre-requisites are met. See Pre-requisites for installing the DMENE

vSync Restoration Patch for details.

2. On the DVD, in the VsyncRestorationPatch folder, find and run the vSyncRestorer.exe file on

the Dragon client workstation. Alternately, you can push the patch install to the workstation.

DMENE vSync Restoration Patch Logging

When you run the vSync Restoration Patch, it logs success and error messages to the DgnSetup

log. It also logs the version numbers of the currently installed Citrix support components and the

components in the patch.

Troubleshooting vSync on aworkstation

Verify the vSync plug-in is installed on the CitrixserverYou must install the vSync plug-in (minitracker.exe) on the Citrix servers that host the published

applications that Dragon users work with. See Install vSync on a Citrix server.

Verify that the vddgncompatibility.dll is installedcorrectlyThe vddgncompatibility.dll runs on the computer where the Citrix ICA client is installed. The

vddgncompatibility.dll: starts when the Citrix channel opens to access an application.

The vddgncompatibility.dll is overwritten if you install or upgrade a Citrix ICA Client after you

install Dragon. If this occurs, you will need to fix the vddgncompatibility.dll in the Citrix

directory. The location of the Citrix directory depends on the Operating system on the Citrix

server machine:

n C:\Program Files (x86)\Citrix\ICA Client\

n C:\ProgramFiles\Citrix\ICA Client\

To verify the correct order to install the required workstation components, see the DMENE 10 1

Dragon in a Citrix Environment Administrator Guide.pdf (available in iSupport by searching for

solution: 14111 "Dragon Medical Enterprise Network Edition User's Guides").

To fix the vddgncompatibility.dll, perform one of the following actions:

n Redo the installation process in the correct order

n Use the new vSync patch available on iSupport. The version of the patch you use depends on

the Hotfix level currently installed in your environment. See Restoring vSync support after

updating a Citrix client.

For more information, on iSupport, search for solution 14274: "What's new in Dragon Medical

Software and can I Download the Current Version?"

21


22

Verify the vSync process on the workstationYou can view the vSync process that runs on the workstation when the Citrix Virtual Channel

starts. In the Task Manager, verify the citrixwindowmgr.exe: process is running.

Verify the vSync registry entries on theworkstationWhen the vSync processes register with the Citrix Virtual Channel, you should see the following

registry keys in the Windows Registry:

[HMLM\SOF-TWARE\Ci-trix\ICAClient\Engine\Configuration\Advanced\Modules\DNSMED]"DriverName"="Unsupported”

"DriverNameWin16"="Unsupported"

"DriverNameWin32"="vddgncompatibility.dll"

[HKLM\SOFTWARE\Citrix\ICAClient\Engine\Configuration\Advanced\Modules\ICA 3.0]

"VirtualDriverEx"="DNSMED"

Verify Dragon users see a warning message aboutthe vSync connectionWhen a user dictates into an application published from Citrix, network issues may cause vSync

connection between Dragon and the Citrix server to slow down. This may negatively impact

dictation performance.

Dragon displays the following graphic in the system tray area if the connection speed between

itself and the Citrix server slows down:

The graphic appears when the connection first times out. The graphic then appears when the

connection times out for 4 out of 20 utterances.

If a user places the mouse over the message, the following message appears:

"On <date> <time> a vSync connection issue was detected – verify dictation. Click to dismiss."

This message indicates that the vSync connection between the Dragon workstation and the Citrix

server experienced issues. The issues do not impact the overall network and vSync is still enabled.

Verify Dragon users have disabled vSync for thecurrent or all user sessionsVerify Dragon users have disabled vSync for the current user session

On sites that support the vSync feature, Dragon users can disable vSync just for their current user

session by pressing Ctrl+F9. If they perform this action, they cannot use Full Text Control with

applications published from a Citrix server unless they re-enable it by pressing Ctrl+ F9 again.

Verify Dragon users have disabled vSync across all of their usersessions

On sites that support the vSync feature, Dragon users can enable or disable the vSync feature

across all of their user sessions. A Dragon user may wish to disable vSync if they are experiencing

network latency and connectivity issues with vSync.

Users can set the Enable vSync Full Text Support option in the Options >Miscellaneous tab

or use the hot key combination Ctrl+Shift+F9 to enable or disable vSync. This feature applies to

individual workstations. If a user moves from one workstation to another workstation, the setting

is not applied to the new workstation.

If a user performs the above actions, they cannot use Full Text Control with applications

published from a Citrix server. This option persists for all of their user sessions until the setting is

reversed.

Notes:

n Once users turn vSync on or off, the setting persists across all future user sessions.

n Users can turn vSync off without having to restart Dragon or reload a user profile. After a user

turns vSync off, they must log out and log back into Dragon before they can turn vSync on

n This feature applies to individual workstations. If a user moves from one workstation to another

workstation, the setting is not applied on the new workstation.

Verify Dragon users set Dragon to auto-disablevSyncOn sites that support the vSync feature, Dragon users can enable the Automatically switch to

Basic Dictation Control option to have Dragon automatically switch them to basic dictation

mode if the connection between Dragon and vSync fails. The option is located in the Options >

Miscellaneous tab in Dragon.

If users enable this option, they cannot use Full Text Control with a Citrix published application

for the current Dragon session. Before they can enable vSync, they must close and re-start

Dragon.

Notes:

23


24

n Once users turn vSync on or off, the setting persists across all future user sessions.

n Users can turn vSync off without having to restart Dragon or reload a user profile. After a user

turns vSync off, they must log out and back into Dragon before they can turn vSync on.

n This feature applies to individual workstations. If a user moves from one workstation to

another, the setting is not applied to the new workstation.

n We recommend that users do not enable the Automatically switch to Basic Dictation Control

option unless the Dragon user is having network latency or connection issue with vSync.

If this option is enabled and a user is disconnected from vSync, the user loses Full Text Support

for the rest of the current user session. Please consult with the Dragon Support Team before you

enable this feature.

Furthermore, users can use Hotkey combinations to enable or disable these settings:

25


26

Verify the color of the Full Text Control indicatorduring dictationA Dragon user can determine if Full Text Control support is available in the current application

they are working with. In the Dragon client, the DragonBar includes a Full Text Control indicator.

n The indicator turns green when Full Text Control is available.

n The indicator turns grey when only Basic Text Control is available.

If a Dragon user reports an issue that is impacting Full Text Control availability or may be related

to vSync, ask the user about the color and behavior of the Full Text Control indicator when the

user experienced the issue.

Full Text Control colors and behavior during dictation

When a Dragon user uses Dragon with an application published from a Citrix server, the Full Text

Control indicator exhibits the following behavior:

n When the Dragon user first turns on the microphone, the Full Text Control indicator is gray

until the Dragon user starts dictation.

n When the Dragon user begins dictation, the Full Text Control indicator turns green if they have

Full Text Control and vSync is functioning

n If a Dragon user is dictating into a non-standard window (a window in which Full Text Control

is not supported) and changes the focus to a standard window or loses vSync connectivity, the

Full Text Control indicator remains gray.

If vSync stops working, Dragon users may experience issues responding to correction commands

and may notice inconsistencies when they use certain commands, including capitalization,

formatting, select <xyz>, correct <xyz>, and insert after <xyz>…) commands. For more

information about commands that are fully enabled by Full Text Control, see the Dragon Help.

27


28

Troubleshooting vSync on a Citrixserver

Understand the vSync components that are on theCitrix ServerA vSync installation on a Citrix server includes several components.

The vSync plug-in (MiniTracker) installs on the Citrix XenApp server and sends UI information

to a UI Mirror that allows the Dragon Medical client to integrate with a published Citrix

application. vSync acts as a “proxy” between the Citrix Server and the Dragon Medical client.

The installation files for the vSync plug-in are:

n MiniTracker.exe – for 32 bit Operating systems

n MiniTracker_x64.exe – for 64 bit Operating systems

Both installers are on the Dragon Medical Network Edition Client media disk.

MiniDragon is an executable that is installed on the Citrix Server and starts when a Dragon user

access a published Citrix application.

Minidragon.exe and a process called Minidragonwatcher.exe alternate until either the Dragon

Citrix Virtual Channel closes or Minidragon can open the custom virtual channel. Minidragon.exe

can use approximately 10 MB of memory per user session.

A process called dgnuiasvr_x64.exe allows minidragon to provide Full Text Control support with

64-bit applications, for example, the 64-bit version of Notepad). The dgnuiasvr_x64.exe process

can use approximately 20 MB of memory per user session.

Configure the MiniDragon watcherYou can configure the MiniDragon Watcher process by setting the EHRForceLogOff registry

value. With vSync installed on a Citrix Server, when a user starts a published application on the

server, vSync starts. If vSync cannot find the Dragon custom virtual channel, Minidragon.exe and

Mindragonwatcher.exe take turns starting each other. The number of times this occurs is based on

registry settings. By default, after attempting to start Minidragonwatcher two times,

Minidragon.exe turns off and does not try to restart Minidragonwatcher.exe a third time.

When you install Minidragon.exe (vSync) on the Citrix Server, the registry key HKEY_LOCAL_

MACHINE\Software\Nuance EHRForceLogOff (REG_DWORD) is set to 3.

You can set the registry key to a value between 0 and 99:

n EHRForceLogOff=0 – The feature is turned off. Minidragon and Minidragonwatcher take turns

starting each other until Minidragon can find and open the Dragon Citrix Virtual Channel.

n EHRForceLogOff=1 – Minidragon exits after a single unsuccessful attempt to open the Dragon

Citrix Virtual Channel.

n EHRForceLogOff=1/99 – Minidragon exits after the defined number of attempts to open the

Dragon Citrix Virtual Channel.

29


30

View Dragon log files from theNuance Management Console

You can view the dragon.log file to obtain troubleshooting information for vSync connectivity

issues. You can view the dragon.log file from the NMC, the Start menu, or in Windows Explorer.

To help you diagnose specific problems, the Dragon Medical client creates a file named

Dragon.log for each healthcare Dragon user. You can view this file in the NMC Console. In this

file Dragon Medical records all of its actions that occur during each user dictation session. If you

contact Nuance Technical Support, you may be asked to supply this file.

The Dragon log file is not uploaded to the NMS server if there is a communication issue between

Dragon and the server. The Dragon log file can also be found on the Dragon client workstation.

To place the Dragon Medical Client place the log files in a location where they are accessible for

viewing on the NMC Console, you must enable the option Copy Dragon log to network on the

Site > Dragon Settings tab.

View the Dragon log file from the NuanceManagement Console

1. On the User Accounts screen, search for the Dragon user whose log files you want to view.

To refresh the data on the User Accounts screen, press Refresh at the bottom right of the

screen.

1. Select the Dragon user in the list and click the Dragon Client Logs icon on the ribbon.

2. The Dragon Client Logs tab opens and displays a list of log files.

3. Double click on the log file you want to view.

The log file opens and displays user activity information.

View the Dragon log file from the Start Menu orWindows ExplorerThere are several ways to locate the Dragon log file:

n In the Start Menu, select All Programs > Dragon Medical 10.1 > Show Dragon Log. For

this to work, you must be logged in to Windows under the Dragon user’s account.

n In Windows Explorer, on Windows Vista, Windows 7, or Windows Server 2008, look here:

C:\Users\Administrator\AppData\Roaming\Nuance\NaturallySpeaking10\Dragon.log

n In Windows Explorer, on Windows XP, look here:

C:\Documents and Settings\<user_account_login>\ApplicationData\Nuance\ NaturallySpeaking10\Dragon.log

What to look for in the dragon.log file when a userreports an issue with vSyncThe following information was placed into a dragon.log file during a 2,000 millisecond Citrix

timeout:

n CtxWinMgr: PrepTarget - Local window is different. Asking for server window info.

n CtxWinMgr: GetServerWindowInfo - Asking server to send window info for local window

0x002c0340.

n vddgncompatibility<7496>: DriverPoll - 11 order received

n Speech starting to edit control 0x002c0340 0x002c0340 "Transparent Windows Client" key ""

n CtxWinMgr: GetServerWindowInfo - Window info request failed (result, elapsed time, timeout)

= (258, 2015,2000)

n CtxWinMgr: PrepTarget - Failed to retrieve server window info

n CtxWinMgr: EnableGlobalDictation - Dictation into window 0x002c0340 will be handled by

global dictation.

If you see the following text in a dragon.log file, it means that vSync is disabled.

[NAS] Info: vSync module is disabled.

31


32

Viewing vSync log files for Dragonuser activity with Citrix publishedapplications

After you install vSync on a Citrix server, you can set vSync to create log files that contain data

about errors, warnings, or all activities for all vSync users on the server. Once you enable logging,

vSync produces a minitracker.log file for every vSync session. By default, vSync logging is not

enabled. vSync creates logs files in the following directory on a Citrix server:

C:\Documents and Settings\<username>\ApplicationData\Nuance\NaturallySpeaking10

Important note about the size of vSync log filesOnly enable vSync logging if you need to provide log files to Nuance Technical Support for

troubleshooting. Each log file uses up disk space on the Citrix server.

If you enable vSync logging, vSync can create many, very large log files. The logs files can use up

a lot of disk space on the Citrix server and increase memory usage on the server.

Note: vSync log file settings are set when vSync starts.

Follow these guidelines for vSync logging:

n Only enable vSync logging to track and troubleshoot specific issues

n Enable vSync logging during a time when network usage is at a minimum.

n When you no longer require the log files, quickly disable the logging feature.

To enable vSync logging for all Dragon users thatwork with Citrix published applicationsIn the Windows registry, perform one of the following actions.

Action StepsDisable vSync logging for all users Set the HKLM\Software\Nuance\LogLevel (DWORD)

key to 0.Enable vSync logging of errors for all users Set the HKLM\Software\Nuance\LogLevel (DWORD)

key to 1.Enable vSync logging of errors andwarnings for allusers

Set the HKLM\Software\Nuance\LogLevel (DWORD)key to 2.

Enable vSync logging of all data for all users Set the HKLM\Software\Nuance\LogLevel (DWORD)key to 3.

Viewing notifications about vSyncconnectivity issues

When vSync starts, it keeps track of application windows that open and close.

vSync does not take any action on any window until a dictation occurs.

When a dictation occurs, vSync attempts to communicate with the Citrix server. vSync may

timeout if it is unable to communicate with the server.

If that occurs, Dragon users will be unable to use Full Text Control functionality with an

application published from a Citrix server.

You can now receive a notification when a Dragon client cannot establish a vSync connection to a

Citrix server. You can use a vSync timeout notification tool, a stand-alone command line tool, to

receive notifications when network issues cause vSync to time out.

The notifications contain information about the number of users in a site that experienced vSync

timeouts and the names of the users.

The vSync timeout notification tool searches the Dragon log in the Master Profile Directory for a

special log statement that the Dragon client Citrix components generate when a certain number of

attempts to communicate with the Citrix server time out.

The tool generates notifications (as a WMI event) about the network issues. You can write an

MOF script to detect the event and perform an action when the event occurs. An example action

could be to send an email or SMS message to an inbox, or to write an event to the NT Event Log.

The generated WMI notifications contain information about the number of users that experienced

vSync timeouts and a list of the users that experienced vSync timeouts.

You can use the Windows Task Scheduler to configure the vSync timeout notification tool to run

according to a schedule and to receive periodic notifications of vSync timeouts.

Administrators should schedule the tool to run once a day.

Obtaining the vSync timeout notification toolYou can obtain the vSync timeout notification tool from Nuance through an ftp site. Contact

Nuance Technical Support for details.

You will receive a zip file that contains the vsync_notifier.exe, a readme.txt file and a sample

MOF script called ‘vsync_event_consumer_example.mof’. The Readme.txt file and the sample

contain information about the event properties that an MOF script must use to detect and react to

vSync timeouts.

The Readme.txt file contains prerequisites and requirements for the vSync timeout notification

Tool and also contains instructions for installing, un-installing, and using the tool.

33


34

Support for edit controlsDragon Medical Enterprise Network Edition includes support for a wide variety of edit controls.

You can use either Basic Text Control or Full Text Control with an edit control. To use Full Text

Control with an application published from a Citrix server, the vSync feature must be enabled.

You can use Full Text Control (formerly Select-And-Say) with the following edit controls:

Edit Control DescriptionDMENE Dragonsupport

Dragon withvSync support

Edit (NotePad) A Microsoft edit control Yes YesEmrTerClass A Ter edit control from GE Yes YesEpicTer78Class An Epic edit control Yes YesExcel A Microsoft edit control for Excel Yes NoINKTEXTBOX A Microsoft edit control Yes YesINKEDIT A Microsoft edit control Yes YesMeditor 2.6 and higher A Meditech edit control Yes YesRichEdit20A A Microsoft rich edit control Yes YesRichEdit20W AMicrosoft rich edit control Yes YesRichEdit50W (Word Pad) A Microsoft rich edit control Yes YesRichEdit20WPT A Microsoft Outlook edit control Yes YesRichTextWndClass A Microsoft RichTextBox edit con-

trolYes Yes

TEdit An edit control from Borland Inter-national

Yes Yes

ThunderRT5TextBox A Visual Basic edit control Yes YesThunderRT6TextBox A Visual Basic edit control Yes YesTMemo An edit control from Borland Inter-

nationalYes Yes

TRichEdit An edit control from Borland Inter-national

Yes Yes

Ter13 Class A TE edit control from Sub Sys-tems, Inc.

Yes Yes


Yes Yes


Yes Yes


Yes Yes


Yes Yes


Yes Yes

TX10 / Txedit10 A TX text control from Text ControlGmbH

Yes Yes

Edit Control DescriptionDMENE Dragonsupport

Dragon withvSync support

TX11 / TXedit11 A TX text control from Text ControlGmbH

Yes Yes


Yes Yes

TX13 /TXedit13 A TX text control from Text ControlGmbH

Yes Yes


Yes Yes


Yes Yes


Yes Yes

Windows edit A Microsoft Windows edit control Yes YesWindows rich edit A Microsoft Windows rich edit con-

trolYes Yes

Word A Microsoft Word edit control Yes No

35