Transcript Presentation Title - download.scansoft.com

Enterprise Support Training
Dragon NaturallySpeaking 9 & PDF Converter Pro 5
June 12th 2008
Created by Loren Cole
1
Agenda
• Product Releases
– Enterprise vs. Retail
– Builds vs. Service Packs
• Installation
–
–
–
–
–
MSI Overview
Dragon NaturallySpeaking Specifics
PDF Converter Specifics
Active Directory
Systems Management Server (SMS)
• Citrix
–
–
–
–
Overview: Servers, Clients, Farms
Publishing Applications
Dragon NaturallySpeaking Specifics
PDF Converter Specifics
2
Agenda (2)
• User Access Rights
• Dragon NaturallySpeaking Specifics
–
–
–
–
–
–
Profiles: Layout, Upgrades, Local/Roaming, Corruption, Backups
NSAdmin
Sound Systems / Sources
Compatibility Modules / Non-Standard Windows
Speech Data / Deferred Correction
Logs
• PDF Converter Specifics
–
–
–
–
–
–
Adjusting Options
PDF Overview
Application Integration
Other Issues
API
DMS Server, Client, Integration
3
Enterprise vs. Retail
Builds vs. Service Packs
MSI Overview
Active Directory
Systems Management Server
4
Enterprise vs. Retail Builds
Retail Builds:
– Contain an activation component which requires the client to
communicate with the activation server for licensing.
– Activations are based on Serial Numbers. Each serial number can be
activated on a predefined number of systems.
– Special serial numbers can be used to turn off the activation component.
– Contain a pipeline mechanism for receiving messages and updates.
– Contain a registration mechanism for user registration.
Enterprise Builds:
– Do not contain activation, pipeline or registration.
– Have been fully tested for deployment and Citrix.
Builds vs. Updates:
– New builds are available for all minor version updates.
– Service packs are usually created for minor version updates, but may not
contain everything available in the full build.
5
Builds vs. Service Packs
Builds vs. Service Packs:
– New builds are available for all minor version updates.
– Service packs are usually created for minor version updates.
– Service packs contain the majority of fixes, but not all. New builds are
required to address installation issues and sometimes driver issues.
– Service packs are available for free to all users.
– New builds are sent to Enterprise customers with valid Upgrade
Maintenance contracts.
– Retail customers may purchase new builds from Customer Service.
6
Windows Installer Packages (MSI) Overview
Windows Installer Packages (MSI):
– Used for installing an application.
– Contains scripts, the order they are executed, conditions, dialog
definitions, text strings, files, etc.
– Contains properties used for altering the conditions
– Contain a Product Code unique to a product:
• HEX Format: {403EF592-953B-4794-BCEF-ECAB835C2095}
Windows Installer Transform File (MST):
– Contains MSI properties
– Used for passing large numbers of property adjustments to an MSI file at
the same time.
Windows Installer Patch File (MSP):
– Used for updated an existing installation.
7
Windows Installer – MSIEXEC (1)
Msiexec.exe
Windows Installer Process
Used for all installation operations
Parameters - Installation Type
/i – Install
/x – Uninstall
/p – Apply MSP to existing installation
/a – Create Administrative Installation Point
• Unpacks all files to a specified location.
• Reduces network traffic caused by decompression
Parameters – Adjustments
MSI File or Product Code
/q – Silent Installation
• b – shows progress and message dialogs
• n – suppresses all dialogs
• + – shows finish dialog
8
Windows Installer – MSIEXEC (2)
Parameters – Adjustments (cont’d)
TRANSFORMS – Used for passing MST files.
ALLUSERS – Changes availability to users
• 0 – Available for only user who installed
• 1 – Available for all users
/lv – Verbose Log – Follow by log path/filename
All MSI Properties can be altered by passing adjustments
Examples:
– msiexec.exe /i “<path>\Dragon NaturallySpeaking 9.msi”
SERIALNUMBER=“A209A-XXX-XXXX-XXXX-XX” ALLUSERS=1 /qb+ /lv
“C:\DNSInstall.log”
– msiexec.exe /i “<path>\PDF Professional 5.msi”
TRANSFORMS=“<path>\1033.mst”;<path>\admin.mst” ALLUSERS=1
/qn /lv “C:\PDFInstall.log”
– msiexec.exe /x {20ECF3EE-4F7B-40ED-98E7-8CA63FC69F14}
9
Viewing / Editing MSI Files
ORCA
– Part of the Windows SDK for Windows Installer Packages
– Available for download from many different web sites
– Allows viewing, editing and saving MSI file tables.
Note: It is very easy to destroy an installation package. Make sure to test
any MSI changes in a test environment before rolling out in production.
10
Dragon NaturallySpeaking Specifics (1)
Dragon NaturallySpeaking Settings:
– ADDLOCOL – Can be used to install specifics features; comma delimited
list. Use “ADDLOCAL=ALL” to install all components.
– ADVERTISE – The opposite of ADDLOCAL. Specify which features to
not install; comma delimited.
– SERIALNUMBER – Used to pass the serial number – use quotes.
– INSTALLDIR – Used to specify a different installation directory.
– DEFAULTSINI – Allows passing of a “NSOptions.ini” file to change the
default options of all user profiles.
– ROAMINGUSERINI/ROAMINGUSEROPTIONS – Used for changing
roaming user settings. See TN 5758 for details.
– SETDEFAULTS/SETADMINS – Will display the Options dialog and/or
Administrative Settings dialog during installation. Adjustments will impact
all users.
11
Dragon NaturallySpeaking Specifics (2)
Dragon NaturallySpeaking Settings (cont’d):
– DNS does not provide a tool for creating an MST settings file.
• We typically recommend the Microsoft Office Resource Kit for creating MST
files.
• Available as a free download from Microsoft’s website.
– Additional information can be found in the IT Administrators Help file. It is
only available from the Start menu after installing the application.
Prerequisite:
– ISScript1050.msi must be installed prior.
– Required by applications packaged with InstallShield Developer Studio
10.5.
– Provides the InstallShield Scripting Runtime needed to run the custom
installation scripts.
12
PDF Converter Specifics
PDF Converter Settings:
– Creating an administrative installation point will allow you to select all
installation options available.
– During the administrative installation, an “Admin.mst” file will be created.
– Admin.mst – contains all options selected including the serial number.
– Admin.mst can be passed to the installer using the TRANSFORMS
parameter.
– Additional information can be found in the documentation provided with
the installation files (CD or Download).
Prerequisite:
–
–
–
–
VCRedist must be installed prior.
Required by applications built with Visual C++ .NET 2005
Provides the Visual C++ 2005 Runtime required by the application.
Available for x86 (32-bit) and x64 (64-bit) installations:
• <CD>\Prerequisite
13
Active Directory
Active Directory:
– Is available as a free add-on to Microsoft Windows Server OS (2000,
2003, 2008).
– Testing has only been done on Windows 2000 and 2003, although there
should be no issue deploying through Windows 2008.
– Active Directory provides an easy way to manage a Domain, as well as
the computers and users within it.
– The main focus of deploying software is through Group Policy Object.
Group Policy Object (GPO):
– GPOs are used to alter the state of a computer or a users environment.
– GPOs can be used to alter appearance, permissions, deploy software
and run scripts.
– We only test and support deployment of software through Computer
defined GPOs.
– GPOs are applied using the Windows SYSTEM account.
14
Active Directory Interface
Interface:
– Provides a look at all users and computers that have been added to the
Domain.
– Organizational Units (OUs) are used to organize groups of users/computers.
– GPOs are applied to OUs.
15
Creating a GPO (1)
Group Policy Objects:
– Are added to the properties of an OU.
16
Creating a GPO (2)
Group Policy Objects (cont’d):
–
–
–
–
GPOs define Computer and User configuration adjustments.
GPO adjustments apply to all users/computers in the OU (and sub-OUs).
Computer policies occur before login; User policies occur during login.
Add a new package under software installation to deploy. When prompted,
select the “Advanced” option to change settings.
17
Creating a GPO (3)
Group Policy Objects (cont’d):
– The name and support information can be adjusted.
– It is possible to have the package automatically uninstalled from clients, if
the client is moved to another OU.
18
Creating a GPO (4)
Group Policy Objects (cont’d):
– Packages can be created for MSP files to upgrade an existing package.
– MST files can be added as Modifications to alter MSI packages.
– MST files are the only way to provide adjustments.
19
Systems Management Server (SMS)
Systems Management Server (SMS):
– Is a Microsoft management application.
• It can be used standalone or to extend the functionality of Active Directory.
• It provides a lot more functionality and adds reporting.
– We currently support SMS v2 and 2003 (v3). System Center
Configuration Manager 2007 (SMS v4) has not been tested.
– SMS setup consists of a Server, Database and a Client.
– Software deployments occur through the use of Packages and
Advertisements to Collections of computers or users.
Collections:
– Collections are similar to OUs in Active Directory.
– Client’s pass information to the server.
– Passed information can be used to customize collections (All Windows
XP Systems).
– Additional collections can be created to further organize computers
and/or users.
20
Packages (1)
Packages:
–
–
–
–
Are used to define any adjustment to a client system.
Define Access Accounts for accessing the package.
Define Distribution Points that hold the program.
Define Programs which will be run on the client system.
21
Packages (2)
Packages (cont’d):
– Details as well as the program icon can be set
– A source directory provides the location of the program files. Note that the
client must be able to access the UNC or Mapped Drive exactly as shown.
22
Packages (3)
Packages (cont’d):
– Adjustments to the shared folder can be made.
– The priority can be changed on updating the package on distribution points.
23
Package Program (1)
Package Program:
– Command line can be set for running the program.
– Can be run when a user is logged in, when no one is logged in or both.
– User rights and interaction can be set.
24
Package Program (3)
Package Program (cont’d):
– Can set another package to run first, as well as how many times to run it.
– Import the Product Code for easier management.
25
Advertisements (1)
Advertisements:
– All packages must be advertised to a client, unless they are run by
another package that is advertised.
– Advertisements can be used to allow a user the choice to run a program
or force a program to be run.
26
Advertisements (2)
Advertisements (cont’d):
– Specify the package, program and collection to advertise.
– Can set the advertisement start time, expire time and priority.
– Can set the advertisement as mandatory, forcing the program to run.
27
Advertisements (3)
Advertisements (cont’d):
– Specify whether the program runs from the distribution point or if the client
will download the source files and run them locally.
– Specify whether the client should check a remote distribution point.
28
Citrix MetaFrame Presentation Server 4.5
29
Citrix MetaFrame Presentation Server (1)
Citrix MetaFrame Presentation Server (MPS):
– Provides clients access to applications installed on a server.
– Applications are installed on a server and published to clients.
– Clients use software to connect to the server:
• ICA Client
• Web Client
– A Citrix Farm can be implemented, which makes use of several servers
that are managed as one to distribute the load.
– We currently support Citrix MPS 3, 4 and 4.5.
– We currently support Citrix ICA Client 8, 9, 10.
– The web client has not been tested.
– “Thick” clients refer to systems which function without a server.
– “Thin” clients refer to systems that require a server to be functional. Most
make use of embedded flash memory for boot tasks and runtime storage.
30
Citrix MetaFrame Presentation Server (2)
Citrix MetaFrame Presentation Server (MPS):
– Uses the main Presentation Server Console for administrating the
servers/farms.
– MPS 4.5 introduces a new Access Management Console for
administrating applications.
31
Citrix MetaFrame Presentation Server (3)
Citrix MetaFrame Presentation Server 4.5 (MPS 4.5):
– Access Management Console provides a better overview of the current
state of the server/farm.
32
Publishing Applications (1)
Publishing Applications:
– Setup through PSC (v3,4) and AMC (v4.5) – interface is similar.
– Can specify the name as well as quickly disable an application.
33
Publishing Applications (2)
Publishing Applications (cont’d):
– Select type for publishing (can only be changed on initial setup).
– Applications must be published as type: Application
34
Publishing Applications (3)
Publishing Applications (cont’d):
– Location of the EXE being published. Must be the same on all servers.
– Isolate will block the application from working with other applications.
35
Publishing Applications (4)
Publishing Applications (cont’d):
– Add all servers the application is available from.
36
Publishing Applications (5)
Publishing Applications (cont’d):
– Select all users or groups of users that can access the application.
37
Publishing Applications (6)
Publishing Applications (cont’d):
– Change the icon and automatically add the application to the client’s
desktop and/or start menu.
38
Publishing Applications (7)
Publishing Applications (cont’d):
– Enable audio between the server and client.
– Encrypt the data being sent between the client and server.
39
Publishing Applications (8)
Publishing Applications (cont’d):
– Adjust the resolution and color of the application sent to the client.
– Seamless window uses the client system’s display properties.
40
ICA Client (2)
ICA Client:
– The ICA Client needs to be installed on the client system.
– The Program Neighborhood can be modified to access the server.
– Any applications available to the user will be displayed on login.
41
ICA Client (2)
Application Set Settings:
– Adjust the communication method for
connecting to the server.
– Enable/Adjust the sound settings.
– Adjust the colors and window size of the
application being displayed on the client.
– Adjust the login settings for connecting the
client to the server.
42
Dragon NaturallySpeaking Specifics (1)
Dragon NaturallySpeaking Requirements:
– Has far greater requirements for a server and network than typical
applications.
– A server that can handle 200 instances of Microsoft Word, would only be
able to handle 6-10 DNS users.
– Network bandwidth requirement of 1.3 Mbps dedicated during dictation.
– Latency is another factor and can be quite high from remote points.
– http://www.nuance.com/naturallyspeaking/citrix
43
Dragon NaturallySpeaking Specifics (2)
Connection Setup:
– Legacy Audio must be turned on when publishing the application.
– Two policies must be enabled on the server for sound.
– Policies can be created on the server in the PSC.
44
Dragon NaturallySpeaking Specifics (3)
Connection Setup (cont’d):
– Microphone support must be enabled for Client Devices.
– The Client microphone must be enabled for audio input.
45
Dragon NaturallySpeaking Specifics (4)
Connection Setup (cont’d):
– Sound quality must be enabled for the client system.
– High sound quality must be allowed for the client system.
46
Dragon NaturallySpeaking Specifics (5)
Connection Setup (cont’d):
– High sound quality must be enabled on the Client system.
– A patch must be installed on the Client system.
Citrix Audio Patch (vddns):
– Provides Dragon the ability to adjust the sound settings on the Client
system.
– Required for proper communication between the sound system on the
Client and Dragon running on the server.
– Can be distributed through Citrix by publishing as Content. Must be run
on each Client individually.
– Must be the same version or higher than Dragon.
– Will only work with ICA Client 8 and 9 out of the box.
– TN 5761 contains the latest version that will work with ICA Client 10.
– Log file: C:\Program Files\Citrix\ICA Client\vddns.log
– Additional information can be found in the IT Administrators Help file. It is
only available from the Start menu after installing the application.
47
PDF Converter Specifics
PDF Converter Specifics:
– Standard application requirements.
– Does not require any special policies or client adjustments.
– Only the main application processes can be shared.
Printer Setup:
– Citrix can automatically add printers to a client system, making them
available to locally installed applications.
– If printers are installed on the Citrix server, they must be shared.
– The ScanSoft PDF Create virtual printer cannot be shared.
– The PDF Create printer will be available to applications running on the
Citrix server. It cannot be made available to applications running on the
Client systems.
48
User Access Rights
File Locations
Windows Registry
49
User Access Rights
User Access Rights:
– DNS and PDF fully support all standard Windows User Types.
– Restricted (Normal) Users are fully supported.
– Administrators may further lock down a user profile which can cause
problems with the software.
Read Access Rights:
– User Profile must have Read access to:
•
•
•
•
%ProgramFiles%
%SystemRoot%
%AllUsersProfile%
Hkey_Local_Machine – registry keys
– User Profile must have read/write access:
• %userprofile%
• Hkey_Current_User – registry keys
50
User Access Rights
Exceptions:
– Out of the box, Dragon must have read access rights to:
• %AllUsersProfile%
– By default Dragon writes all user profile information to the All Users
Profile Location:
• %AllUsersProfile%\Application Data\Nuance\NaturallySpeaking9\
– It is possible to change this to a location the user has full access too.
51
Dragon NaturallySpeaking Specifics
52
Dragon NaturallySpeaking Options (1)
Dragon NaturallySpeaking Options:
– Are written to INI files. A few references are written to the registry.
– Global application options are written to:
• %AllUsersProfile%\Application Data\Nuance\NaturallySpeaking9\
• Includes all Administrative Settings and can only be adjusted by a User with
Administrative Rights.
– Application settings that are user specific are written to:
• %UserProfile%\Application Data\Nuance\NaturallySpeaking9\
• Includes the Dragon.log and location of user profiles.
– User Profile settings are written to:
• The user profile directory.
• Includes adjustments to the Options dialog.
• Default :
– %AllUsersProfile%\Application Data\Nuance\NaturallySpeaking9\Users\
53
Dragon NaturallySpeaking Options (2)
Application INI:
– Nsapps.ini:
• Contains specific settings for connecting to applications.
• Can be used to adjust how Dragon connects to an application window.
– Nssystem.ini:
• Contains global application settings.
• Can be used to adjust how Dragon connects to unknown applications and
adjust runtime settings.
– Roaming.ini:
• Contains majority of Administrative Options.
• Can be used to adjust roaming user settings outside of the application.
User INI:
– Nsuser.ini:
• Contains settings specific to a given Windows User runtime options.
• Can be used to adjust the default location of the user’s user profiles.
54
Dragon NaturallySpeaking Options (2)
User Profile INI:
– Aco.ini / Acoustic.ini:
• Contains pointers to retained training and correction data.
• Used by the Acoustic Optimizer to adjust models.
– Audio.ini:
• Contains information about the sound systems.
• Updated by the Audio Setup Wizard.
– Options.ini:
• Contains all option adjustments.
– Topics.ini:
• Contains profile topic/vocabulary references.
55
Dragon NaturallySpeaking Profiles (1)
User Profiles:
– Root folder has the same name as the user.
– Contains all data pertaining to the user profile.
– Backup / Backup2:
• Copy of the current folder.
• Created after every 5 saves by default.
– Dataarchive:
• Contains archived training and correction data.
• Used by the acoustic optimizer to update the models.
– Current:
• Contains all current files pertaining to the profile.
56
Dragon NaturallySpeaking Profiles (2)
User Profiles (cont’d):
– Current:
• <name>_:
– Name of the attached topic/vocabulary.
– Contains the altered voc.
• <name>_container:
– Contains additional adjustments to the voc.
• voice:
– Contains the model and source information.
• voice_container:
– Contains training and correction data.
– Used by the acoustic optimizer to update the models.
• MyCmds.dat:
– Contains all custom commands.
– T folders:
• Temporary folders created during the use or backup of a profile.
• Will be merged during save or backup of the profile.
• Can be deleted when Dragon is closed.
57
Dragon NaturallySpeaking Profiles (2)
User Profiles (cont’d):
– Upgrades:
• Profiles can be upgraded from a lower version/edition to a higher
version/edition.
• Opening a profile in a higher version or edition will automatically upgrade the
profile.
• It is not possible to downgrade a user profile, version or edition.
– Roaming / Local:
•
•
•
•
Roaming Profiles can be used to access a profile from multiple locations.
A master profile is created on a network share.
A local cache is created on the local machine.
Adjustments are temporarily stored in the local cache and synchronized with
the master copy.
58
Dragon NaturallySpeaking Profiles (2)
User Profiles (cont’d):
– Corruption:
• Profiles can become corrupted very easily.
• Typically, corruption occurs during a save or update failure.
• When vocabularies or models go out of synch with the rest of the profile,
various SDAPI and Recognizer errors are displayed.
• Restoring the profile from a good backup is the only resolution.
– Backups:
• The Manage Users dialog provides the ability to restore a Local Profile from a
stored Backup.
• Restoration is the replacement of the Current folder with a Backup folder.
• Backups are not created for Roaming profiles. It is assumed that the network
store is being backed up by other means.
• Corruption of a local cache can make the user seem corrupt. Deleting the
local cache will allow Dragon to create a new cache from the Master profile.
59
NSAdmin Distribution Utility
NSAdmin:
– Command line utility for distributing commands, custom words and
vocabularies to individual systems.
– Must be run on each client system.
– Commands, custom word lists and adjusted vocabularies must be stored
in a location accessible by the client system.
– Can be scripted to install these file sets.
– Will copy command, word list and/or vocabulary files to the All Users
profile location.
– Dragon looks for these files when a user profile is opened or when
creating a new user and will automatically import them.
– Any added commands, words or vocabularies will be imported back into
the profile if they are deleted.
– NSAdmin will need to be used to update older files if changes are
required.
– See the IT Admin Guide for more information.
60
Sound Systems (1)
Sound Systems:
– Dragon relies heavily on the sound system.
– Any issue with the sound system will directly translate to poor recognition
and/or long recognition times.
Windows Setup:
– It is important that the sound system function properly outside of Dragon.
– Make sure that the sound system is properly installed with updated
drivers.
– Windows Sound Recorder (available from Accessories) can be used to
test recording outside of Dragon.
– Playback can show some problems with recording, but not all.
– Dragon will automatically adjust sound levels for recording. It will also
mute the microphone playback volume to avoid reverb through speakers.
61
Sound Systems (2)
Sources:
– Selecting the right source is as important as the sound system.
– Sources vary by sampling rate.
– USB and Sound Card sources use 22Khz models, while Array
microphones use 8Khz and Bluetooth/Recorder models use 4Khz.
– Adjusting the source can improve or reduce the recognition accuracy and
latency (time for recognition).
– When changing a sound system, it is important to add a source that
matches the system.
– When switching devices that use the same type of source, it is important
to re-run the Audio Setup Wizard to adjust levels.
62
Working with Applications (1)
Application Support:
– Have been created for all applications that Dragon supports.
– Generic modules have been created for Plain Text, Rich Text and HTML
edit controls.
– On installation, Dragon detects what supported applications are installed
on the system, then installs the appropriate module.
– Any installation or reinstall of a supported application after Dragon has
been installed will require a repair of Dragon.
Compatibility Modules:
– Provide application state information.
– Provide specialized commands, control over dialogs and menus, selectand-say correction and text formatting.
– Are loaded by the supported application as an add-in, which Dragon
connects to for support.
63
Working with Applications (2)
Compatibility Modules (cont’d):
– Checking registry keys can show proper setup and loading of the
compatibility module.
64
Working with Applications (3)
Compatibility Modules (cont’d):
– Microsoft Office applications may automatically disable an add-in if
problems were encountered.
– Add-ins can be re-enabled through “Help > About” within the Office app.
65
Working with Applications (4)
Non-Standard Windows:
– Applications that do not have a compatibility module.
– Generic modules have be adjusted for many text based applications.
– Non-standard implies that the current modules cannot identify the window
type and edit control.
Edit Controls:
–
–
–
–
Main edit controls are Plain Text, Rich Text and HTML.
Application windows make use of one of these controls for text input.
Many variations and combinations of edit controls can result in problems.
Dragon defaults to Rich Text for most unknown window types. This can
result in problems if the window doesn’t use a standard control.
66
Working with Applications (5)
Correcting Edit Controls:
– Dragon must be installed on the same system as the application for
proper detection and handling of text input.
– If Dragon or the Application are being accessed remotely, problems can
occur with text input.
– An adjustment can be made to force Plain Text for all unknown edit
controls.
• This can reduce text input problems.
• TN 4978 provides steps for the adjustment.
– It is possible to make adjustments to Dragon’s edit controls for a specific
window.
• Provides specific tailoring for an application’s needs.
• Won’t impact other non-standard applications being used with Dragon.
• TN 4247 provides steps for the adjustment.
67
Deferred Correction (1)
Deferred Correction:
– Allows reviewing of original speech data for document correction.
– DRA files contain all speech, indexed to the original text.
DRA File:
–
–
–
–
–
–
DRA files record speech in a linear fashion.
Corrections to text adds speech at the end and alters the index.
Large amounts of corrections can break the index, resulting in lost audio.
Corrections should be done in a linear fashion.
Multiple corrections to the same text should be avoided.
DRA files can be opened in DragonPad to retrieve any lost text.
68
Log Files (1)
Dragon.log
– Created for each user that runs Dragon.
• %appdata%\Nuance\NaturallySpeaking9\
– Contains details on every action performed by the application.
– Can be used to diagnose most product issues.
– Logged information:
• Timestamps
• Product, File and Application version information
• User Profile settings, sources, vocabularies, models, location, etc.
• Hardware information: processor, memory, sound system, etc.
• Compatibility Module connection for application handling
• Recognition problems
• Crash reports, exceptions and stack trace dumps
69
Log Files (2)
Dgnsetup.log
– Created for the user that installs Dragon.
• %temp%
– Contains details on the installation process.
– Is only created when installing through setup.exe; MSI installations will need to be
logged separately.
– Logged information:
• Timestamps
• Installation settings
• All installation scripts
• Any problems encountered during installation
Recognition History:
– Running log of recognized text and commands.
– Available from the “Words” menu.
– Useful for tracking down recognition and command errors.
70
Log Files (3)
Dgnuseability.log
– Created for each user that runs Dragon.
• %appdata%\Nuance\NaturallySpeaking9\
– Must be enabled in the options for the user profile.
• Options > Data > Advanced
– Contains details on every recognition made by the application.
– Can be used to diagnose text and command recognition problems.
– Will cause the application to run very slow.
– Only recommended for short tests to reproduce a problem.
71
PDF Converter Specifics
72
PDF Converter Options (1)
PDF Converter Options:
– Are written to INI files and Windows Registry keys.
– PDF Converter Assistant:
• HKEY_CURRENT_USER\Software\ScanSoft\PDF Converter 5.0
– Contains all settings related to the PDF Converter Assistant
– PDF Create Assistant:
• %APPDATA%\Zeon\DocuCom\PDFDirect
– Contains all settings for the PDF Create Assistant
– Includes Windows Context menu options
– DocuCom PDF and PDF Create Printer:
• Both use the same settings files – changes to one impact both.
• %APPDATA%\\Zeon\DocuCom\PDF Driver
73
PDF Converter Options (2)
PDF Converter Options (cont’d):
– PDF Converter Professional:
• Settings are broken up between several different locations.
• HKEY_CURRENT_USER\Software\Zeon\Docucom\PDF Gold\PDF Converter
Professional 5
– Contains the majority of PDF Converter Professional settings.
• HKEY_CURRENT_USER\Software\ScanSoft\Pdf Professional 5.0
– Contains settings for Update Service, PDF Optimizer and DMS integration
• %APPDATA%\Zeon\DocuCom\PDF Plus
– Contains settings for Links, Digital Signatures, 3D Object handling, Recent Files,
Text box font type/style and multimedia playback.
– Also includes all resources: Watermarks, Stamps, Search Index, etc.
74
PDF Converter Options (3)
PDF Converter Options (cont’d):
– Application Integration:
• HKEY_CURRENT_USER\Software\Zeon\Docucom\PDF Driver
– Contains layout for IE and MS Office toolbars
• HKEY_CURRENT_USER\Software\ScanSoft\PDF Create 5.0
– Contains settings for MS Outlook toolbar
• %APPDATA%\Zeon\DocuCom\PDFWord
– Contains settings for MS Word toolbar
75
PDF File Overview (1)
PDF File Overview:
– Similar to HTML and XML in tagging respects.
– Everything displayed exists within an object tag.
– Text objects:
• Contain plain text.
• Reference specific fonts through character mapping, including embedded
fonts.
– Multimedia objects, including images:
• Are embedded directly within the object tag.
• Tag contains information including image type, encoding/compression, color
depth, etc.
– Objects are layered.
– Object tags provide details on how to handle display of an object.
76
PDF File Overview (2)
PDF File Overview (cont’d):
– A look at PDF Objects:
77
PDF File Overview (3)
PDF File Overview (cont’d):
– Embedded Fonts:
• Can be referenced, embedded or subset embedded.
• Subset embedding only embeds characters that are used within the
document.
• Font licensing can prevent embedding and installation of embedded fonts.
• The entire font set file or a subset of the font set is stored within an object tag
within the PDF.
• Text objects reference the embedded font object for display.
• PDF Pro supports TrueType, OpenType and Type1 Fonts.
– Due to different encoding types, not all fonts will be handled properly.
78
PDF File Overview (4)
PDF File Overview (cont’d):
– Form Fields:
• Referenced through an Array Object.
• Each field is added to the array with all settings.
• Tab order follows Array order.
– Form Data:
• Stored within an FDF Object.
• FDF Object can be exported and imported into an identical empty form.
– Nuance PDF File Types:
• PDF Image: Refers to a PDF file where each page is made up of one or more
images of text/images.
• PDF Searchable: Refers to a PDF Image file that contains one or more text
objects, hidden behind the page image.
– Allows searching a PDF Image file while still maintaining the look of the original.
• PDF Normal: Refers to a PDF file with text and image objects.
79
PDF File Overview (4)
PDF File Overview (cont’d):
– XFA:
• Extensible Forms Architecture
• New XML Spec for PDF Format.
• New XFA Objects.
– PDF Converter does not support XFA Format.
– PDF Files with XFA Form Fields:
• Will display a message that XFA forms are not supported.
• It is possible to run FormTyper and remove XFA Objects and replace with
FDF Objects.
– PDF Files with all data embedded with XFA Objects:
• Has a separate object that is only displayed by applications that do not
support XFA.
• PDF file contains a single page with text stating to upgrade to Acrobat.
• Not possible to display the PDF in PDF Converter.
– XFA support is being worked on for a future release.
80
PDF File Overview (5)
PDF File Overview (cont’d):
– Security:
• Refers to encryption of the PDF file through use of a security mechanism.
• Password or Digital Signature or can be used for encryption.
• Encryption level can be set at 40 or 128-bit (password) or 128-bit for Digital
Signature.
– Password Security:
• Block opening the PDF.
• Block editing, printing, filling, copying data or commenting the PDF file.
– Digital Signature:
• Block opening the PDF.
• Can verify the PDF file has not been modified since it was last signed.
• Both require Digital Signature Public Key.
81
Application Integration (1)
MS Office Integration:
– Controlled through several COM Add-ins.
– PDF Converter:
• PDFCWordAddin.dll – Open PDF/XPS into DOC/DOCX file
– <INSTALL>
• OutlookAddin.dll – Open PDF attachments and archive email to PDF
– %PROGRAMFILES%\Common Files\ScanSoft Shared\PDF5\
– PDF Create:
• ZnWordAddIn.dll – Convert DOC/DOCX file to PDF
– <INSTALL>\PDF Driver\OfficeAddIn\
• ZnExcelAddIn.dll – Convert XLS/XLSX file to PDF
– <INSTALL>\PDF Driver\OfficeAddIn\
• ZnPPTAddIn.dll – Convert PPT/PPTX file to PDF
– <INSTALL>\PDF Driver\OfficeAddIn\
– COM Add-ins are registered to MS Office app to be loaded on startup.
82
Application Integration (2)
MS Office Integration:
– Referenced through MS Office app registry key – PDF Converter:
•
•
•
•
HKEY_CURRENT_USER\Software\Microsoft\Office\Word\Addins
HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins
HKEY_CURRENT_USER\Software\Microsoft\Office\PowerPoint\Addins
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins
– Referenced through MS Office app registry key – PDF Create:
• HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Word\Addins
• HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Excel\Addins
• HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\PowerPoint\Addins
– COM Add-In creates reference in Office Normal Template:
• %APPDATA%\Microsoft\Templates\
– Normal Template references PDF Converter Template:
• %APPDATA%\ScanSoft\PDF Converter 4.0\Templates\
– PDF Converter Template:
• Provides location of toolbar.
• Reference to Add-In calls for buttons.
83
Application Integration (3)
Internet Explorer Integration:
– Controlled through an ActiveX Control:
• IEPDFPlus.ocx – Embedded PDF viewer
– <Install>\Bin\
– Referenced through CLSID.
– Controlled through COM Add-ins:
• ZeonIEFavClient.dll – Convert Webpage to PDF
– <Install>\Bin\
– HKEY_CURRENT_USER\Software\Microsoft\Internet Explorer\MenuExtv\
• cnvres_eng.dll – Convert PDF/XPS from web link to text
– <install>
– HKEY_CURRENT_USER\Software\Microsoft\Internet Explorer\MenuExtv\
84
Application Integration (4)
Windows Explorer Integration:
– Controlled through COM Add-ins.
• ShellExt50.dll – Convert PDF/XPS to text through Context Menu
– <Install>
– HKEY_CLASSES_ROOT\*\shellex\ContextMenuHandlers
• DirectShellExt.dll – Convert file to PDF through Context Menu
– <install\bin
– HKEY_CLASSES_ROOT\*\shellex\ContextMenuHandlers
Word Perfect Integration:
• WPAddin.dll – Open PDF/XPS into WPD file
– <Install>
– HKEY_CURRENT_USER\Software\Corel\WordPerfect\10\Third Party
– 10 refers to the WordPerfect version – adjust for different versions.
85
Application Integration (5)
Removing Integration:
– All Integration can be disable through Custom Installation.
– Always recommend using Administrative Installation to create the
admin.mst transform file.
– All conversion of PDF/XPS to Text can be removed through PDF
Converter Assistant.
• Available through “File > Preferences”
• Removal can also be scripted – do not rely on DLL Register Server.
• See TN 5779 for more details.
– Removal of conversion to PDF is not available through UI
• DLL Register Server must be used.
• See TN 5986 for more details.
– Disabling of IE PDF Viewer is not available through UI
• DLL Register Server must be used.
• After removal, user will be prompted to Save or Open PDF in PDF Pro.
• See TN 5980 for more details.
86
General Issues (1)
Launching Problems:
– Crashes can occur when opening the application.
– Important to note whether it is application or file specific.
– Font Problems:
•
•
•
•
All installed fonts are loaded on launch.
A corrupt font can cause the application to crash.
No easy way to determine a bad font.
Can be located through Windows Process Monitor, although the logs huge.
– TTS Manager:
• The TTS Manager handles the Text to Speech functionality within the
application.
• The TTS Manager is available within our Capture SDK.
• Third Party applications that make use of the Capture SDK may cause
conflicts with the TTS Manager in PDF Converter Professional.
• See TN 5987 for more details.
87
General Issues (2)
Printing Problems:
– Problems can occur when printing from PDF Converter Professional to a
physical printer.
• Typically, this is a problem in the creation of the print stream.
• Updating Printer drivers may resolve the problem.
• May also be a problem with the specific PDF file.
– Invalid Argument error when printing a PDF file.
• Is caused by a Print dialog option storing an invalid value to the registry.
• Has been resolved by a patch - see TN 5983 for more details.
Opening PDF files from websites.
– Mishandling of the file type or location being passed from the site.
• Disabling the IEPDFPlus.ocx will allow the PDF to be opened in PDF Pro.
– Site is designed to use Acrobat.
• Some sites have been coded to use the Acrobat CLSID to open PDF files.
• Cannot be fixed without coding changes to the site.
• See TN 5933 for more information.
88
General Issues (3)
Display Problems:
– Text is not displayed properly:
• Mishandling of the embedded font, font reference or installed font.
• Requires fix to handle the font.
• Need to collect PDF file. Nice to have source file and font file.
– Image is not displayed properly:
• Mishandling of the embedded image file, either type or compression.
• Requires fix to handle the image.
• Need to collect the PDF file. Nice to have source file.
Crash Reports:
– If a crash occurs, a report is created.
– Helpful in diagnosing a problem, but not helpful exclusively.
– Written to:
• <install>\bin\
• <app><date>-<time>.htm
• <app><date>-<time>.dmp
89
API (1)
API:
– Provides methods for silently working with PDF files.
– Accessible only with the application installed.
– Accessed through:
• <install>\bin\PDFPlus.tlb
– Is relatively new - available since September 2007.
– Contains very basic functionality – more functionality added with each
release (minor and major).
– Current Documentation only provides Interfaces and Methods.
– Only available for PDF Creation and PDF Editing.
– PDF Conversion to text based files is not available. Conversion is only
available through the OmniPage API.
– Tested using C++ and C# through Visual Studio .NET 2005
– Documentation provided on request.
90
API (2)
API Functionality:
– PDF Professional Window (open, show, hide, close, minimize, maximize,
restore, hide/show tools)
– Get current app state information (current PDF, active tool, app language)
– Access PDF Files (open, save, close)
– Edit PDF Files (Delete/Move/Replace/Insert pages, Delete/Create Page
Thumbnails, Set/Clear Initial View, Set/Clear Metadata)
– Convert file to PDF
– Print pages (with dialog or silently)
– Pages (rotate, crop)
– Annotations (get/create annotations, highlight text)
– Adjust Annotations (title, date, color, contents)
– Page View (change page, zoom)
91
DMS Integration (1)
Interwoven WorkSite:
– Supports :
•
•
•
•
WorkSite Server 7.51 and 8.0, 8.2, 8.3
DeskSite Client 6.6 and 8.0, 8.2, 8.3
MailSite Client 8.0; FileSite Client 8.2
DeskSite Clients must be used with equal or higher server version.
– Server Setup:
• Server setup is crucial to proper functionality.
• PDF Converter Professional must be configured on the server for PDF files.
• If the application configured on the server is not located on the client,
DeskSite defaults to Windows File Type Association.
– Windows Association results in PDF Pro failure to recognize PDF files opened
directly from the DeskSite/FileSite Client.
– Check in will fail when closing the file and/or application.
92
DMS Integration (2)
Interwoven WorkSite (cont’d):
– A new type can be created for PDF Pro or Acrobat type can be used.
– Description can be set to anything.
93
DMS Integration (3)
Interwoven WorkSite (cont’d):
– PDF Pro application must be configured. Path must match client exactly.
– App is not integrated and DDE cannot be enabled.
94
DMS Integration (4)
Interwoven DeskSite/FileSite:
– Client Setup:
• COM Add-in must be installed into DeskSite for proper functionality.
• NuanceImanageAddon.dll – Open and PDF Creation Functionality
– <Install>\bin
– DLL register server can be used to add/remove integration.
• PDFProDMS.ini – Configure default PDF Type
– %ALLUSERSPROFILE%\Application Data\ScanSoft
– Configure when changing PDF Type on server from ACROBAT
– Example Contents:
[WorkSite]
PDFAPPID=“PDFPRO”
95
DMS Integration (5)
Interwoven DeskSite/FileSite (cont’d):
– DeskSite client provides access to files on the server.
– Check shows files that are currently checked out.
– Toolbar allows conversion of non-PDF files to PDF.
96
DMS Integration (6)
Interwoven DeskSite/FileSite (cont’d):
– Opening PDF Files through DeskSite/FileSite will download the file to the
local temp directory, check the file out and pass it to PDF Pro.
– Proper configuration will allow PDF Pro to know that the file came from
WorkSite.
– With proper configuration, when closing the file in PDF Pro or the PDF
Pro application, it will be checked back in.
97
DMS Integration (7)
Interwoven DeskSite/FileSite (cont’d):
– PDF Pro provides two different dialog types:
• Old style Profile dialogs
• New style Folder Centric dialogs.
– Adjustable through the WorkSite menu in PDF Pro (stored in Registry).
New
Old
98
DMS Integration (8)
Interwoven DeskSite/FileSite (cont’d):
– PDF Pro provides two different dialog types:
• Old style Profile dialogs
• New style Folder Centric dialogs.
– Adjustable through the WorkSite menu in PDF Pro (stored in Registry).
New
Old
99
DMS Integration (9)
Interwoven DeskSite/FileSite (cont’d):
– After opening a PDF file from DeskSite/FileSite, the file can be edited and
saved back to the server.
– Available save options:
• Replace Original – Update original with altered document
• New Version – Add a new version of the original document
• New Document – Add a new document
– PDF Pro must recognize the file as coming from WorkSite for this dialog
to be displayed.
100
DMS Integration (10)
Interwoven DeskSite/FileSite (cont’d):
– MailSite 8.0 and FileSite 8.2 provide WorkSite Server access through
Outlook.
– Client name was changed with the 8.2 release.
– Convert to PDF options are not available through Outlook.
– Open handling is the same as DeskSite.
101
DMS Integration (11)
Hummingbird DM Server:
– Supports :
• Hummingbird DM Server 5 (2004) and 6 (2005)
• Hummingbird DM Client 5 (2004) and 6 (2005)
• DM Clients must be the same version as the server.
– Server Setup:
• Server setup is crucial to proper functionality.
• PDF Converter Professional must be configured on the server for PDF files.
• If the application configured on the server is not located on the client, an error
appears stating invalid launch method.
– It will not be possible to open PDF files from the DM Client.
102
DMS Integration (12)
Hummingbird DM Server (cont’d):
– A new Application can be created for PDF Pro or a new launch method
can be added to Acrobat.
103
DMS Integration (13)
Hummingbird DM Server (cont’d):
– Location and Directory must match the client exactly.
– Do not use quotes to enclose paths, even if they contain spaces.
– Application is set with no integration.
104
DMS Integration (14)
Hummingbird DM Client:
– Client Setup:
• COM Add-in must be installed into DM Client for proper functionality.
• PDFProHBISImpl.dll – Open Functionality
– <Install>\bin
– DLL register server can be used to add/remove integration.
105
DMS Integration (15)
Hummingbird DM Client (cont’d):
– DM Client provides access to files on the server.
– Check shows files that are currently checked out.
106
DMS Integration (16)
Hummingbird DM Client (cont’d):
– Opening PDF Files through DM Client will download the file to the local
temp directory, check the file out and pass it to PDF Pro.
– Opening PDF Files from DM Server through PDF Pro checks the file out.
107
DMS Integration (17)
Hummingbird DM Client (cont’d):
– After opening a PDF file from DM Server, the file can be edited and saved
back to the server.
– Available save options:
• Replace Original – Update original with altered document
• New Version – Add a new version of the original document
• New Document – Add a new document.
108
Technical Support
• Knowledge Base:
– http://knowledgebase.nuance.com
• Level 3 Technical Support is available via the following channels.
• Hours:
– 8:30-5:30 (EDT), Monday-Friday (Excluding Nuance Holidays)
• Phone:
– Toll Free: (888) 857-6064
– Direct Number: (781) 565-5009
– Only available to Internal Contacts and Accounts with valid Technical
Support Contracts.
– Customers without a valid contract must contact retail support channel
and pay for support.
• http://support.nuance.com/ - Desktop Products
109