Transcript
LFH7330
SPEECHEXECENTERPRISE
Technical Documentation Advanced Configuration For Certified MDC Partners and Support technicians
This page is intentionally left blank
2.
3.
System Reguirement .................................................................................. 5 2.1.
License Server ............................................................................................ 5
2.1.1. 2.1.2.
System requirements ................................................................................................ 5 Supported operating systems ................................................................................... 5
2.2.
Enterprise Manager .................................................................................... 6
2.2.1. 2.2.2.
System requirements ................................................................................................ 6 Supported operating systems ................................................................................... 6
2.3.
Dictate Modul.............................................................................................. 7
2.3.1. 2.3.2. 2.3.3.
System requirements ................................................................................................ 7 System requirements for Dragon Speech Recognition ............................................ 7 Supported operating systems ................................................................................... 7
2.4.
Transcribe Modul ........................................................................................ 8
2.4.1. 2.4.2.
System requirements ................................................................................................ 8 Supported operating system ..................................................................................... 8
2.5.
Workflow Manager ...................................................................................... 9
2.5.1. 2.5.2.
System requirements ................................................................................................ 9 Supported operating system ..................................................................................... 9
2.6.
Statistic Modul – BackEnd Server ............................................................. 10
2.6.1. 2.6.2.
System requirements .............................................................................................. 10 Supported operating system ................................................................................... 10
System Architecture ................................................................................. 11 3.1.
4.
5.
Installation Examples ................................................................................ 11
Installation process .................................................................................. 12 4.1.
License Server .......................................................................................... 12
4.1.1. 4.1.2.
Change the Port Number ........................................................................................ 14 Check the Installation.............................................................................................. 14
4.2.
Enterprise Manager .................................................................................. 16
4.2.1.
Change Root Folder path ....................................................................................... 19
4.3.
Dictate ...................................................................................................... 20
4.3.1.
Upgrading Enterprise Dictate .................................................................................. 23
4.4.
Transcribe................................................................................................. 24
4.4.1.
Upgrading Enterprise Transcribe ............................................................................ 27
4.5.
SEE Configuration for Webservices .......................................................... 28
4.5.1. 4.5.2. 4.5.3. 4.5.4. 4.5.5. 4.5.6. 4.5.7.
Install IIS Webservice ............................................................................................. 28 Configure IIS Webserver......................................................................................... 29 Assign web service to the application pool ............................................................. 30 Activate Windows Authentication for the service .................................................... 31 Test the web service ............................................................................................... 31 Connecting to the web service from SEE clients .................................................... 32 Setting application pool ........................................................................................... 33
4.6. 4.7.
Workflow Manager .................................................................................... 35 Statistics Module – BackEnd Server ......................................................... 37
4.7.1.
Create new Database ............................................................................................. 39
Configuration process .............................................................................. 40 5.1.
License Server .......................................................................................... 40
5.1.1. 5.1.2. 5.1.3. 5.1.4. 5.1.5.
Protect the Server Access ...................................................................................... 41 Deactivate the password protection ........................................................................ 42 Create License request ........................................................................................... 42 Import License file ................................................................................................... 43 Email notification – Health scanner ........................................................................ 45
5.2.
Enterprise Manager .................................................................................. 46
5.2.1. 5.2.2. 5.2.3.
Main window ........................................................................................................... 46 Backup system configuration .................................................................................. 47 Migration Wizard ..................................................................................................... 48
SpeechExec Enterprise 5.0 - Technical Documentation
Page 3
6.
5.3.
System Configuration Center .................................................................... 51
5.3.1. 5.3.2. 5.3.3. 5.3.4. 5.3.5. 5.3.6. 5.3.7. 5.3.8. 5.3.9.
Configuration files ................................................................................................... 51 Groups and users ................................................................................................... 53 Login settings .......................................................................................................... 59 User relationships ................................................................................................... 60 Dictation properties ................................................................................................. 60 System settings ....................................................................................................... 66 SpeechMagic settings ............................................................................................. 69 Mobile device assignments ..................................................................................... 70 How to edit mobile devices assignments ................................................................ 70
5.4.
SpeechExec Dictate ................................................................................. 73
5.4.1. 5.4.2. 5.4.3. 5.4.4. 5.4.5. 5.4.6. 5.4.7.
Menu structure – File .............................................................................................. 73 Menu structure – Edit .............................................................................................. 77 Menu structure – Folder .......................................................................................... 81 Menu structure – Speech recognition ..................................................................... 82 Menu structure – Setting ......................................................................................... 84 Menu structure – View ............................................................................................ 84 Menu structure – Help............................................................................................. 86
5.5.
SpeechExec Transcribe ............................................................................ 87
5.5.1. 5.5.2. 5.5.3. 5.5.4. 5.5.5. 5.5.6.
Menu structure – File .............................................................................................. 87 Menu structure – Edit .............................................................................................. 89 Menu structure – Folder .......................................................................................... 91 Menu structure – Speech recognition ..................................................................... 92 Menu structure – Settings ....................................................................................... 93 Menu structure – View ............................................................................................ 93
5.6.
Workflow Manager .................................................................................... 95
5.6.1. 5.6.2. 5.6.3.
Configuration ........................................................................................................... 97 Task ...................................................................................................................... 101 Logging ................................................................................................................. 108
5.7.
Statistics Module..................................................................................... 109
5.7.1. 5.7.2. 5.7.3. 5.7.4. 5.7.5. 5.7.6. 5.7.7.
Main Window ........................................................................................................ 110 Menu Bar .............................................................................................................. 110 Authors statistics ................................................................................................... 114 Transcriptionists statistics ..................................................................................... 117 Other statistics ...................................................................................................... 121 Dictations statistics ............................................................................................... 126 Dictation methods ................................................................................................. 127
Silent Setup ............................................................................................. 129 6.1.
Manager ................................................................................................. 129
6.1.1. 6.1.2. 6.1.3.
EXE Parameters ................................................................................................... 129 MSI Parameters .................................................................................................... 130 Examples .............................................................................................................. 130
6.2.
Dictate .................................................................................................... 130
6.2.1. 6.2.2. 6.2.3. 6.2.4.
EXE Parameters ................................................................................................... 130 MSI Parameters .................................................................................................... 131 Creating Setup transformations (MST) with Orca ................................................. 131 Example ................................................................................................................ 132
7.
Installation MSSQL Database................................................................. 133
8.
Silent Setup of the Microsoft .NET Framework .................................... 137 8.1.
9.
Silent Setup of .NET Framework 4.6 ....................................................... 137
Installation of Desktop Experience Feature on Windows Server ....... 137 9.1. 9.2.
Microsoft Windows Server 2012 ............................................................. 138 Microsoft Windows Server 2008 ............................................................. 143
SpeechExec Enterprise 5.0 - Technical Documentation
Page 4
1.
Introduction
2.
System Reguirement
2.1.
License Server
Warning: Do not rename the computer with the Enterprise License Server Service! This can make your license file invalid!
2.1.1. System requirements SpeechExec Enterprise License Server requires the following hardware specifications in order to function properly: The minimum requirement for your processor is: 1 GHz Intel® dual core or equivalent AMD processor or faster with 2 GB (32-bit) or 4 GB (64-bit) RAM. 100 MB for the Software installation. Microsoft .NET 4.61 Framework Full installation requires 4.5GB free disk space. For more information on the system requirements of Microsoft .NET Framework 4.6.1, please visit the following link: http://msdn.microsoft.com/en-us/library/5a4x27ek.aspx
2.1.2. Supported operating systems SpeechExec Enterprise License Server supports: Windows 7 (32-bit and 64-bit) Windows 8.1 (32-bit and 64-bit) Windows 10 (64-bit) Windows Server 2008 R2 (64-bit) Windows Server 2012 R2 Please don’t forget: For all the operating systems - it is recommended that you have installed the latest available service packs. SpeechExec Enterprise License Server also requires that you have Microsoft .NET 4.0 Framework installed. If it is not present on your system, it will be installed automatically during SpeechExec installation. For Microsoft .NET 4.0 Framework to be installed automatically, you must start the SpeechExec installation by launching the setup.exe. Depending on your PC, installing Microsoft .NET 4.0 Framework may take some time. Windows Terminal Server/Citrix session has to be run at least in Hi-Color (16-bit).
SpeechExec Enterprise 5.0 - Technical Documentation
Page 5
2.2.
Enterprise Manager
2.2.1. System requirements SpeechExec Enterprise Manager requires the following hardware specifications in order to function properly: The minimum requirement for your processor is: 1 GHz Intel® dual core or equivalent AMD processor or faster with 2 GB (32-bit) or 4 GB (64-bit) RAM. 100 MB hard disk space. Microsoft .NET 4.6.1 Framework requires an additional 4.5 GB of free disk space. For more information on the system requirements of Microsoft .NET Framework 4.X, please visit the following link: http://msdn.microsoft.com/en-us/library/5a4x27ek.aspx Crystal Reports requires 1.5 GB free disk space in 32-bit Windows (2 GB in 64-bit Windows). The minimum desktop screen resolution has to be 1024*768.
2.2.2. Supported operating systems SpeechExec Enterprise Manager supports: Windows 7 (32-bit and 64-bit) Windows 8.1 (32-bit and 64-bit) Windows 10 (64 bit) Windows Server 2008 R2 Windows Server 2012 R2 Please don’t forget: For all the operating systems - it is recommended that you have installed the latest available service packs. Under Windows Server 2008R2 and Server 2012 please install the Desktop experience feature to ensure trouble-free usage of SpeechExec. To install Desktop experience, open Server Manager from Administrative Tools and start the Add Features Wizard. In the Add Features Wizard select Desktop Experience and install it. When the installation is complete, then restart the computer. SpeechExec Enterprise Manager also requires that you have Microsoft .NET 4.6.1 Framework installed. If it is not present on your system, it will be installed automatically during installation. Windows Terminal Server/Citrix session has to be run at least in Hi-Color (16-bit).
SpeechExec Enterprise 5.0 - Technical Documentation
Page 6
2.3.
Dictate Modul
2.3.1. System requirements SpeechExec Enterprise Dictate requires the following hardware specifications in order to function properly: The minimum requirement for your processor is: 1 GHz Intel® dual core or equivalent AMD processor or faster with 2 GB (32-bit) or 4 GB (64-bit) RAM. 100 MB hard disk space. Microsoft .NET 4.6.1 Framework requires an additional 4.5 GB of free disk space. For more information on the system requirements of Microsoft .NET Framework 4.X, please visit the following link: http://msdn.microsoft.com/en-us/library/5a4x27ek.aspx Self-powered USB port for SpeechMike or Digital Pocket Memo device. Screen resolution: Minimum desktop screen resolution: 1024 x 768 px. Maximum desktop screen resolution: 3200 x 1800 px with a maximum display size of 150%.
2.3.2. System requirements for Dragon Speech Recognition The minimum requirement for your processor is: 2.2 GHz Intel® dual core or equivalent AMD processor or faster with 4 GB (32-bit) or 8 GB (64-bit) RAM. Free hard drive space – 4 GB is recommended.
2.3.3. Supported operating systems SpeechExec Enterprise Dictate supports: Windows 7 (32-bit and 64-bit) Windows 8.1 (32-bit and 64-bit) Windows 10 (64-bit) Windows Server 2008 R2. Windows Server 2012 R2. Please don’t forget: For all the operating systems - it is recommended that you have installed the latest available service packs and aktualisation. We recommended to open the Control Panel/System and Security and click on Check for updates. SpeechExec will not operate on Windows systems, which do not have Windows Media Player installed ("N" and "KN" Windows versions). In this case, Windows Media Player has to be installed manually before SpeechExec installation. For more information please visit the http://support2.microsoft.com/kb/2929699/en-us web page. Under Windows 7, to make roaming profile setting modifications or to change the Dragon NaturallySpeaking user profile setting from local to roaming and from roaming to local, administrator account is needed. Under Windows Server 2008R2 and Server 2012 R2 please install the Desktop experience feature to ensure troublefree usage of SpeechExec. To install Desktop experience, open Server Manager from Administrative Tools and start the Add Features Wizard. In the Add Features Wizard select Desktop Experience and install it. When the installation is completed, restart the computer. SpeechExec Enterprise 5.0 - Technical Documentation
Page 7
The Speech recognition features (online and offline) requires: Dragon Naturally Speaking Professional 12.5 or 13 (Dragon Professional, Dragon Legal or Dragon Medical) to be installed on the computer. Dragon Naturally Speaking 14 (Individual or Group editions) to be installed on the computer. Dragon Home, Daragon Premium and their predecessor products are not supported with SpeechExec. Windows Terminal Server/Citrix session has to be run at least in Hi-Color (16-bit).
2.4.
Transcribe Modul
2.4.1. System requirements SpeechExec Enterprise Transcribe requires the following hardware specifications in order to function properly: The minimum requirement for your processor is: 1 GHz Intel® dual core or equivalent AMD processor or faster. 2 GB (32-bit) or 4 GB (64-bit) RAM. 100 MB hard disk space. Microsoft .NET 4.6.1 Framework requires an additional 4.5 GB of free disk space. For more information on the system requirements of Microsoft .NET Framework 4.X, please visit the following link: http://msdn.microsoft.com/en-us/library/5a4x27ek.aspx
Screen resolution: Minimum desktop screen resolution: 1024 x 768 px. Maximum desktop screen resolution: 3200 x 1800 px with a maximum display size of 150%
2.4.2. Supported operating system SpeechExec Enterprise Manager supports: Windows 7 (32-bit and 64-bit) Windows 8.1 (32-bit and 64-bit) Windows 10 (64-bit) Windows Server 2008 R2 Windows Server 2012 R2. Please don’t forget: For all the operating systems - it is recommended that you have installed the latest available service packs. SpeechExec Transcribe will not operate on Windows systems, which do not have Windows Media Player installed ("N" and "KN" Windows versions). In this case, Windows Media Player has to be installed manually before SpeechExec installation. For more information please visit the http://support2.microsoft.com/kb/2929699/en-us web page. The Speech recognition features (online and offline) requires: Dragon Naturally Speaking Professional 12.5 or 13 (Dragon Professional, Dragon Legal or Dragon Medical) to be installed on the computer. Dragon Naturally Speaking 14 (Individual or Group editions) to be installed on the computer. Dragon Home, Daragon Premium and their predecessor products are not supported with SpeechExec. Under Windows Server 2008 R2 and Server 2012 R2 please install the Desktop experience feature to ensure troublefree usage of SpeechExec Transcribe.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 8
To install Desktop experience, open Server Manager from Administrative Tools and start the Add Features Wizard. In the Add Features Wizard select Desktop Experience and install it. Is the installation complete, and then restart the computer. SpeechExec Enterprise Transcribe also requires that you have Microsoft .NET 4.6.1 Framework installed. If it is not present on your system, it will be installed automatically during installation. Windows Terminal Server/Citrix session has to be run at least in Hi-Color (16-bit).
2.5.
Workflow Manager
2.5.1. System requirements SpeechExec Enterprise Workflow Manager requires the following hardware specifications in order to function properly: The minimum requirement for your processor is: 1 GHz Intel® dual core or equivalent AMD processor or faster with 2 GB (32-bit) or 4 GB (64-bit) RAM. 100 MB for the Software installation. Microsoft .NET 4.61 Framework Full installation requires 4.5GB free disk space. For more information on the system requirements of Microsoft .NET Framework 4.6.1, please visit the following link: http://msdn.microsoft.com/en-us/library/5a4x27ek.aspx
2.5.2. Supported operating system SpeechExec Enterprise Manager supports: Windows 7 (32-bit and 64-bit) Windows 8.1 (32-bit and 64-bit) Windows 10 (64-bit) Windows Server 2008 R2 (64-bit) Windows Server 2012 R2 It is recommended that you have the latest available Service Pack installed for your operating system. Under Windows Server 2008 R2 and Server 2012 R2 please install the Desktop experience feature to ensure troublefree usage of SpeechExec Enterprise Workflow Manager. To install Desktop experience, open Server Manager from Administrative Tools and start the Add Features Wizard. In the Add Features Wizard select Desktop Experience and install it. When the installation is complete, restart the computer. SpeechExec Enterprise Workflow Manager also requires that you have Microsoft .NET 4.6.1 Framework installed. If it is not present on your system, it will be installed automatically during installation. Windows Terminal Server/Citrix session has to be run at least in Hi-Color (16-bit).
SpeechExec Enterprise 5.0 - Technical Documentation
Page 9
2.6.
Statistic Modul – BackEnd Server
2.6.1. System requirements SpeechExec Enterprise BackEnd Server requires the following hardware specifications in order to function properly: The minimum requirement for your processor is: 1 GHz Intel dual core or equivalent AMD processor or faster with 2 GB (32-bit) or 4 GB (64-bit) RAM. 100 MB hard disk space. Microsoft .NET 4.6.1 Framework requires 4.5 GB free disk space. For more information on the system requirements of Microsoft .NET Framework 4.6.1, please visit the following link: http://msdn.microsoft.com/en-us/library/5a4x27ek.aspx The minimum desktop screen resolution has to be 1024*768. Windows Terminal Server/Citrix session has to be run at least in Hi-Color (16-bit).
2.6.2. Supported operating system SpeechExec Enterprise BackEnd server supports: Windows 7 (32-bit and 64-bit) Windows 8.1 (32-bit and 64-bit) Windows 10 (64-bit) Windows Server 2008 R2. Windows Server 2012 R2. Please don’t forget: For all the operating systems - it is recommended that you have installed the latest available service packs. SpeechExec Enterprise BackEnd server also requires that you have Microsoft .NET 4.6.1 Framework installed. If it is not present on your system, it will be installed automatically during installation. Note: For Microsoft .NET 4.6.1 Framework to be installed automatically, you must start the installation by launching setup.exe. Depending on your PC, installing Microsoft .NET 4.6.1 Framework may take some time. Windows Terminal Server/Citrix session has to be run at least in Hi-Color (16-bit).
SpeechExec Enterprise 5.0 - Technical Documentation
Page 10
3.
System Architecture
3.1.
Installation Examples
Concept 1 Simpy installation on SpeechExec Enterprise License Server, SpeechExec Enterprise Manager on one Server PC. SpeechExec Enterprise Dictate or Transcribe is installed on every PC or Notebook.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 11
4.
Installation process
This document describes the installation process of SpeechExec Enterprise Module.
4.1.
License Server
We recommend installing the Enterprise License Server on the Microsoft Windows Server 2008 R2 or Microsoft Windows Server 2012 R2 as for client operating systems the number of concurrent network connections is limited. Currently, the Enterprise modules are 32 bit applications and therefore run in 32 bit compatibility mode on supported 64 bit operating systems. Warning: Do not rename the computer with the Enterprise License Server Service! This can make your license file invalid! Click on the first option to install SpeechExec Enterprise License Server. Select the executable Autorun file.
Klick on 1 Install
Select the Installation Language and click on OK. The available language is Czech, Danisch, Dutch, English, Finnish, French, German, Norwegian, Spanish and Swedish.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 12
Click Install
Click Next
Select – I accept the terms in the license agreement and click Next [2]
Click Next
Click Install to begin the installation.
Click Finish
SpeechExec Enterprise 5.0 - Technical Documentation
Page 13
4.1.1. Change the Port Number Please note – the communication between License Server and SpeechExec Enterprise components runs via Port 13667. You can change this value in the registy in Windows Server 2008 R2 Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Philips Speech\SpeechExec\ EnterpriseLicenseServer
Computer\HKEY_USERS\S-1-5-21-2352806029-3641643645-500\Software\Philips Speech\SpeechExec\EnterpriseLicenseManagerStandalone
4.1.2. Check the Installation Open Task Manager by right clicking the taskbar, and then clicking Start Task Manager, alternative, you can also open Task Manager by pressing CTRL+SHIFT+ESC. Switch to Processes and look for PSP.SpeechExec.Enterprise.LicenseServer.exe (32 bit) process. Double click on this, and click with the right mouse button on SpeechExec Enterprise License Server Service, select Open Service
SpeechExec Enterprise 5.0 - Technical Documentation
Page 14
Switch to Services and check if the Status is Running. Click on Services
If the service is running, you can stop or restart the service
With doubleclick on it open the properties for more information.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 15
4.2.
Enterprise Manager
SpeechExec Enterprise Manager supports Windows 7 (32/64 bit), Windows 8.1 (32/64 bit), Windows 10 (only 64bit), Windows Server 2008 R2 (32/64 bit) and Windows Server 2012 R2. It is recommended that the latest available Service Pack is installed on the operating system. We recommend installing the Enterprise Manager on the Microsoft Windows Server 2008 R2 or Microsoft Windows Server 2012 R2 as for client operating systems the number of concurrent network connections is limited. This chapter describes the installation process of SpeechExec Enterprise Manager 5.0 on Windows Server 2012R2. Click 1 Install to run the installation wizard.
Select your preferred language from available: Czech, Dutch, English, French, German and Spanish. Click OK to select the language for installation
Click on Install
Click on Next
SpeechExec Enterprise 5.0 - Technical Documentation
Page 16
Accept the terms in the license agreement and click on Next. The Installer recognised, if the desktop experience feature is installed, click on Next
You can change the destination folder for the installation, we recommend you use the default setting, and click on Next. Create new SEE_Root Folder for the all configuration files created during the installation of the SpeechExec Enterprise Manager and all other end-user modules like SpeechExec Enterprise Dictate or SpeechExec Enterprise Transcribe.
Click Next
SpeechExec Enterprise 5.0 - Technical Documentation
Page 17
Make sure that the folder SEE_ROOT is accessible for everyone Search for the SEE_ROOT folder, click on this with the right mouse button select and click on Properties. Click on Advanced Sharing click on Permission check the permission for EVERYONE
Installation process can be started, using the preconfigured settings, click Install.
Click Finish to close the SpeechExec Enterprise Manager installer.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 18
4.2.1. Change Root Folder path Click on File, select Settings
click on Change system configuration path…
Select the SERVER, click on the available folder (seeroot) and click on Select Folder.
This path is saved in to registry key named Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Philips Speech\SpeechExec\ EnterpriseManager
SpeechExec Enterprise 5.0 - Technical Documentation
Page 19
4.3.
Dictate
SpeechExec Enterprise Dictate 5 supports Windows 7 (32/64 bit), Windows 8.1 (32-bit and 64-bit), Windows 10 (64bit), Windows Server 2008 R2 (32/64 bit) and Windows 2012 R2. It is recommended that the latest available Service Pack is installed on the operating system. Currently, the Enterprise modules – Dictation and Transcribe - are 32 bit applications and therefore run in 32 bit compatibility mode on supported 64 bit operating systems. Under Windows Server 2008 R2 and Windows Server 2012 R2, install the Desktop experience feature to ensure trouble-free usage of SpeechExec. To install Desktop experience, open Server Manager from Administrative Tools and start the Add Features Wizard.In the Add Features Wizard select Desktop Experience and install it. When the installation is complete, then restart the computer. SpeechExec Enterprise requires that you have Microsoft .NET 4.6.1 Framework installed. If it is not present on your system, it will be installed automatically during SpeechExec installation. Important: You need to have administrator rights in order to install the Software; otherwise an 'ikernel' error message is displayed at the beginning of the installation process. This chapter describes the installation process of SpeechExec Enterprise Dictate 5 on Windows Server 2012 R2 Open the 01_Enterprise_Foundation folder and double click on 04_Enterprise_Dictate. Double click on Autorun to start the installer.
Click Install
Select your preferred language from available: Czech, Dutch, English, French, German, and Spanish.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 20
Installshield is preparing the files for installation.
Accept the license agreement and click Next.
Select additional features and click on Next.
SpeechExec Enterprise 5.0 - Technical Documentation
Click Next
Desktop experience is installed, click on NEXT
Configure the central location of the system configuration folder.
Page 21
Click Install
Click Finish to exit the wizard. The installation procedure requires a reboot. Make sure that the same administrator user, who installed SpeechExec initially, also logs on after the reboot for the installation to be completed properly. If a different user tries to log on after the reboot, a dialog will be displayed which prompts for the administrator user to log on again.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 22
4.3.1. Upgrading Enterprise Dictate Upgrade is available only for version 4.6 and 4.6 SR1. During upgrading SpeechExec, all SpeechExec processes will be shut down. If you have any unsaved data, make sure you first save them, and then start upgrading. Otherwise, your unsaved data may be lost. Before upgrading SpeechExec it is recommended to backup your configuration files. For installations with a central configuration these are located on a central server. For local installations (CONFIGFILELOCATIONTYPE=Local) these configuration files can be found in: PSP.SpeechExec.SystemDefaultSettings.xml, which you find in the installation directory of SpeechExec, PSP.SpeechExec.DictationPropConfiguration.xml, which you find in the installation directory of SpeechExec, User configuration files, depending on your operating system they are located in Windows Vista / Windows 7 / Windows Server 2008 (R2): USERS_DIR\USERNAME\AppData\Roaming\Philips Speech\SpeechExec (for example “C:\Users\john\AppData\Roaming\Philips Speech\SpeechExec\ WindowsUser.xml”)
SpeechExec Enterprise 5.0 - Technical Documentation
Page 23
4.4.
Transcribe
SpeechExec Enterprise Transcribe 5.0 supports Windows 7 (32/64 bit), Windows 8.1 (32-bit and 64-bit), Windows 10 (64-bit), Windows Server 2008 R2 and Windows Server 2012 R2. It is recommended that the latest available Service Pack is installed on the operating system. Currently, the Enterprise modules are 32 bit applications and therefore run in 32 bit compatibility mode on supported 64 bit operating systems. Under Windows Server 2008 R2 and Server 2012 R2, install the Desktop experience feature to ensure trouble-free usage of SpeechExec. To install Desktop experience, open Server Manager from Administrative Tools and start the Add Features Wizard. In the Add Features Wizard select Desktop Experience and install it. When the installation is complete, then restart the computer. SpeechExec Enterprise requires that you have Microsoft .NET 4.6.1 Framework installed. If it is not present on your system, it will be installed automatically during SpeechExec installation. This chapter describes the installation process of SpeechExec Enterprise Transcribe 5.0 on Windows Server 2012 R2 Important: You need to have administrator rights in order to install the program, otherwise an 'ikernel' error message is displayed at the beginning of the installation process. This chapter describes the installation process of SpeechExec Enterprise Transcribe 5.0 on Windows Server 2012 R2 Open the 01_Enterprise_Foundation folder and double click on 05_Enterprise_Transcribe. Double click on Autorun to start the installer.
Click Install
SpeechExec Enterprise 5.0 - Technical Documentation
Page 24
Select your preferred language from available: Czech, Dutch, English, French, German and Spanish.
Installshield is preparing the files for installation.
Accept the license agreement and click Next.
SpeechExec Enterprise 5.0 - Technical Documentation
Click Next to start the installation process
Desktop experience is installed, click on NEXT
Page 25
Select additional features and click on Next.
Click Install
Configure the central location of the system configuration folder.
Installation process is running.
Click Finish to exit the wizard. The installation procedure requires a reboot. Make sure that the same administrator user, who installed SpeechExec initially, also logs on after the reboot for the installation to be completed properly. If a different user tries to log on after the reboot, a dialog will be displayed which prompts for the administrator user to log on again.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 26
4.4.1. Upgrading Enterprise Transcribe Upgrade is available only for version 4.6 and 4.6 SR1. During upgrading SpeechExec, all SpeechExec processes will be shut down. If you have any unsaved data, make sure you first save them, and then start upgrading. Otherwise, your unsaved data may be lost. Before upgrading SpeechExec it is recommended to backup your configuration files. For installations with a central configuration these are located on a central server. For local installations (CONFIGFILELOCATIONTYPE=Local) these configuration files can be found in: Windows 7 C:\Program Files (x86)\Philips Speech\SpeechExec Enterprise Transcribe\ PSP.SpeechExec.SystemDefaultSettings.xml, PSP.SpeechExec.DictationPropConfiguration.xml. User configuration files, depending on your operating system they are located in Windows Server 2008 (R2): USERS_DIR\USERNAME\AppData\Roaming\Philips Speech\SpeechExec for example C:\Users\peter\AppData\Roaming\Philips Speech\SpeechExec\peter.xml
SpeechExec Enterprise 5.0 - Technical Documentation
Page 27
4.5.
SEE Configuration for Webservices
SpeechExec Enterprise Configuration Web Service for IIS provides a REST interface to support group and user configuration for SpeechExec Enterprise Dictate and SpeechExec Enterprise Transcribe. This configuration management is done via a web service instead of directly accessing SEERoot that stores the Enterprise configuration. The solution also provides Windows NTLM authentication. This service does not affect other SpeechExec Enterprise products, such as SpeechExec Enterprise Manager. SpeechExec Enterprise Configuration Web Service for IIS has the following software requirements: Windows Server 2008 R2 (64-bit version) or later Internet Information Services (IIS) 7 or later, with the following features: o ASP.NET 4.x o Windows authentication Microsoft .NET Framework 4.6.1 Make sure that IIS is turned on before installing .NET Framework in order to have a properly installed ASP.NET Although the installer of SpeechExec Enterprise Configuration Web Service for IIS installs the web service into IIS, it is the task of the administrator to properly set up IIS.
4.5.1. Install IIS Webservice Double click on EnterpriseConfigWebServiceSetup.exe
Click on Next
SpeechExec Enterprise 5.0 - Technical Documentation
Click on Install
Page 28
Installation is running
Click Finish and close the installation.
4.5.2. Configure IIS Webserver To set up the web service to start automatically, do the following: Right click on Default Web Site and select Manage Web Site – Advanced settings
Set Start Automatically to True
SpeechExec Enterprise 5.0 - Technical Documentation
Page 29
4.5.3. Assign web service to the application pool In the Connections panel on the left, select the Sites - SEEConfigServiceForIIS web service. 2. Right-click on the web service, and click Manage Application > Advanced settings
In the Advanced Settings dialog select Application Pool and click on the Browse (…) button. In the Select Application Pool dialog select SEEConfigServiceAppPool and click OK
SpeechExec Enterprise 5.0 - Technical Documentation
Page 30
4.5.4. Activate Windows Authentication for the service To enable Windows Authentication, select the Sites and click on SEEConfigServiceForIIS web service and double click on Authentication.
In the Authentication panel select: Disable - for Anonymous Authentication Enable – for Windows Authentication
4.5.5. Test the web service The Enterprise Configuration web service provides a dedicated testing interface available via URL: URL_OF_WEB_SERVICE/test/testconfig. The test process validates the server’s configuration settings and returns a JSON array of validation steps. Each validation step consists StepID, StepResult and StepExplanation. Returned response codes can be the following: 401 (Inauthorized) – if the current user cannot be authenticated by the web server 566 – if any of the validation steps failed 200 (OK) – if all validation steps passed Validation steps: StepID 001_SEERootFoundInConfig 005_SEERootExists 010_SEERootWritable 015_SEERootStructureCorrect
Explanation SEERoot value must be found in the web.config The folder specified by the SEERoot value exists The service must be able to read from and write to SEERoot The structure of SEERoot is correct, it has all required subfolders and required config files
Please note that the response content is always returned in English language.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 31
Test the settings – open the URL http://localhost/SEEConfigServiceForIIS/test/testconfig
Now you see the example response result when the 1st step passed, but the 2nd step failed
How to solve this problem? If an appSettings node does not exist under the configuration node, it must be manually created. You must add the following settings to the appSettings node: The value field contains the UNC path of the remote SEERoot folder. before
afterwards
4.5.6. Connecting to the web service from SEE clients This is typically done during the installation of SEE clients, where the user can specify the URL of the Enterprise Configuration web service. When the user decides to use the Enterprise Configuration web service after installation, he/she needs to perform the following steps: - Open the Windows Registry Editor (regedit.exe) - Go to the node Computer\HKEY_LOCAL_MACHINE\Software\Philips Speech\SpeechExec\Enterprise
- Create a new String Value named SEE_ConfigServerURL and set its value to the URL of the Enterprise Configuration web service Important: Unlike in the case when not using configuration server, a default user configuration file is not created for a new (nonexisting) user. It must be created explicitly by the Administrator in Enterprise Manager.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 32
4.5.7. Setting application pool Application pools allow isolating one web application from another, even if they are running on the same server. This way, if there is an error in one app, it won't take down other applications. Additionally, applications pools allow specifying different levels of security (for example, file access security) for different apps. If a new application pool need be created, follow the configurations steps: Open the Internet Information Server (IIS) Manager Select Application Pools from the Connections panel on the left area. Right click on the Application Pools panel and select Add Application Pool.
Enter a name for your new application pool, such a SEEConfigServiceAppPool. In the .NET CLR version list, select .NET CLR Version v4.0.30319. Make sure that the Start application pool immediately checkbox is selected. Click OK to create and start the application pool.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 33
Change the user identity for the new application pool – on the Application Pools panel in IIS, right-click on the newly created SEEConfigServiceAppPool and select Advanced Settings. In the Advanced Settings dialog select Identity and click the Browse button
In the Application Pool Identity dialog, check Custom account and click SET
In the Set Credential dialog enter your user identity credentials and click on OK
SpeechExec Enterprise 5.0 - Technical Documentation
Page 34
4.6.
Workflow Manager
SpeechExec Enterprise Workflow Manager 5.0 supports Windows 7 (32/64 bit), Windows 8.1 (32-bit and 64-bit), Windows 10 (64-bit), Windows Server 2008 R2 (32/64 bit) and Windows Server 2012 R2. It is recommended that the latest available Service Pack is installed on the operating system. Currently, the Enterprise modules are 32 bit applications and therefore run in 32 bit compatibility mode on supported 64 bit operating systems. Under Windows Server 2008 R2 and Windows Server 2012 R2 install the Desktop experience feature to ensure trouble-free usage of SpeechExec. To install Desktop experience, open Server Manager from Administrative Tools and start the Add Features Wizard.In the Add Features Wizard select Desktop Experience and install it. When the installation is complete, then restart the computer. SpeechExec Enterprise Workflow Manager requires that you have Microsoft .NET 4.6.1 Framework installed. If it is not present on your system, it will be installed automatically during SpeechExec installation. This chapter describes the installation process of SpeechExec Enterprise Workflow Manager 5.0 on Windows 2012 R2 Important: You need to have administrator rights in order to install the program, otherwise an 'ikernel' error message is displayed at the beginning of the installation process. Click Install
Click Next
Click Next
SpeechExec Enterprise 5.0 - Technical Documentation
Desktop experiences are installed, click Next
Page 35
Choose, if needed, the destination folder and click Next. You can change the standard TCP or HTTP port or click Next
Specify which account should be used and click Next. Note: Please consider that the account, which runs the workflow manager service has to have access rights to the folders, which should be maintained by the Workflow Manager. If the folder structure is not located on the same server as the Workflow Manager, but somewhere in your network environment it is highly recommended to create a dedicated user account with the appropriate rights.
Click Install to begin the installation.
Click Finish to exit the wizard.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 36
4.7.
Statistics Module – BackEnd Server
SpeechExec Enterprise Statistic Module 5.0 supports Windows 7 (32/64 bit), Windows Server 2008 (32/64 bit), Windows Server 2008 R2 (32/64 bit) and Windows Server 2012. It is recommended that the latest available Service Pack is installed on the operating system. Currently, the Enterprise modules are 32 bit applications and therefore run in 32 bit compatibility mode on supported 64 bit operating systems. Under Windows Server 2008 (and R2), install the Desktop experience feature to ensure trouble-free usage of SpeechExec. To install Desktop experience, open Server Manager from Administrative Tools and start the Add Features Wizard.In the Add Features Wizard select Desktop Experience and install it. When the installation is complete, then restart the computer. SpeechExec Enterprise requires that you have Microsoft .NET 4.6.1 Framework installed. If it is not present on your system, it will be installed automatically during SpeechExec installation. Important: You need to have administrator rights in order to install the program, otherwise an 'ikernel' error message is displayed at the beginning of the installation process. Click Install
Select your preferred language from available: Czech, Danish, Dutch, English, Finnish, French, German, Norwegian, Spanish, and Swedish.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 37
Click Next
Choose the destination folder and click Next.
Accept the license agreement and click Next.
Click Install to begin the installation
If you connect the the BackEnd server immediately with the Database, click on Finish to start the configuration tool.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 38
4.7.1. Create new Database If you already had the statistics in use, select Upgrade existing database and the propriate server type and click Next, in other case click Create new database and click Next Depending on your Microsoft SQL server settings you have to enter the following information: Server name / Service name - the name of your database server (and service instance name, if applicable). Database name - the name of the database that you want to query. Windows Integrated Authentication - Select this option if you want to use your Windows user name and password.
User name / Password - enter the user name and password that you want to use for accessing the database. Click on Next
Click Finish to close the configuration tool.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 39
5.
Configuration process
5.1.
License Server
Run the Philips SpeechExec Enterprise License Manager
Connect to License Server, if you have installed the License Manager on the same PC as the License server, you can use the localhost server address, otherwise use the IP or PC-Name.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 40
Now you are connected with License Server
Server version License Server IP Address
5.1.1. Protect the Server Access You can protect access to the License Server with a password, click on Server, select Change password
Create new password and confirm this
SpeechExec Enterprise 5.0 - Technical Documentation
Page 41
5.1.2. Deactivate the password protection Fill the Old password and make the New password and Confirm password Fields empty.
5.1.3. Create License request Click on License and select Export license request file.
Accept the terms in the license and cklick Continue
SpeechExec Enterprise 5.0 - Technical Documentation
Page 42
Save the *.seereq File and send this to yours Key Account Manager or Speech Processing Partner.
5.1.4. Import License file Click on License and select Import license file.
Select the Folder with license file (with file extension *.seelic)
You can see all the installed and available licenses. In our example we have 30 Universal licenses for Dictation or Transcription, and also 2 licenses for other Modules.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 43
Click on License, select View license information and see the full information about your license.
License information
SpeechExec Enterprise 5.0 - Technical Documentation
Page 44
5.1.5. Email notification – Health scanner You can create a email notification for low license. SpeechExec Enterprise License Server will send an email notification to each recipient if the number of used licenses reaches the specified threshold. Each license type is monitored separately. Click on Email notifications, select Change email notifications.
Create SMTP connection to the SMTP Server. Create a recipients list and setup the threshold for notification. You can also activate notification for Workflow Manager and for Mobile Server.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 45
5.2.
Enterprise Manager
This chapter describes a best practice configuration of SpeechExec Enterprise Manager. Run the SpeechExec Enterprise Manager Put the IP Address for the Enterprise License Manager, the Password Field is empty. Standard connection
Connection with different License Server settings
5.2.1. Main window The main window of the SpeechExec Enterprise Manager application enables administrators to start Enterprise Manager Tools. The main window contains a menu bar [1], a menu of the applications of the Enterprise Manager [2] and on explanation area [3] for the application.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 46
The menu bar provides menu commands for settings configuration files, starting applications. SpeechExec Enterprise Manager provides the following menus in the Menu bar [1]: Settings – specify the path of the system configuration Backup system configuration – specify the path of the backup file. The files of the current system configuration can be saved in a .zip file for reference purposes or security reasons. Exit – close the SpeechExec Enterprise Manager window.
System Administration – start the System Administration License Administration – start the License Administration Dictation Statistic – start the Dictation Statistic. Workflow Manager – start the Workflow Manager
To use the Dictation Statistic module the application needs a StatisticsCAL license type from the Enterprise License Server specified during the startup.
5.2.2. Backup system configuration The files of the current system configuration can be saved in a .zip file for reference purposes or security reasons. Specify the path and name of the backup file using the Backup system configuration option in the File menu. All the necessary system configuration files with the current folder structure are backed up.
The Backup zip file contains four folders and files: DictationProperties PSP.SpeechExec.DictationPropConfiguration.xml Locks SE_EM.lock SystemConfiguration Contains folder UserToMobileDeviceAssignment with the related xml file, groups xml file, PSP.SpeechExec.SupportedAudioFormats.xml PSP.SpeechExec.SystemDefaultSettings.xml SpeechExecEnterprise.groups SpeechExecEnterpriseConfigurationRoot.settings userrelationships UserConfiguration UserName.xml
SpeechExec Enterprise 5.0 - Technical Documentation
Page 47
5.2.3. Migration Wizard Displays the Migration Wizard dialog, where you can import the necessary configuration files from an existing Enterprise Manager installation and upgrade the Enterprise Manager application. The Migration Wizard can import Enterprise Manager Configuration files from version 2.5 or 3.0 to version 4.x. Note: The migrated files will be copied into a root configuration folder, where they will be upgraded when necessary. You can also new folder for the configurations files migrated from previous installation. Click Next
Click on button to select root folder for the configuration
Select the folder to be used as the ROOT configuration folder
Click Next
Specify the path to the OLD group definition file – SpeechExecEnterprise.groups, dictation properties file – PSP.SpeechExec.DictationPropConfiguration.xml and audio formats file – PSP.SpeechExec.SupportedAudioFormats.xml and click Next
SpeechExec Enterprise 5.0 - Technical Documentation
Page 48
SpeechExec Enterprise 5.0 - Technical Documentation
Page 49
Select the folder that contain the OLD user configuration files. Click on button and search for the folder. Click on Analyze to shows those files that have been recognized as valid SpeechExec Enterprise user configuration files. Finaly – click on Next
SpeechExec Enterprise Migration Wizard collected all necessary information, click Start to run the migration process.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 50
5.3.
System Configuration Center
This SpeechExec Enterprise System Configuration Center allows the management of groups and users, the definition of dictation properties and login settings and the management of user relationships. Default settings can be defined for all users befor using one of the SpeechExec Modules like Dictate or Transcribe and also later if any system-wide default settings or user’s configuration settings need update.
You can define whether settings should be locked or user modification is allowed. If settings are locked, end users, who perhaps are unfamiliar with system parameters and business requirements, cannot change the settings. Also, some settings can be locked while others can be allowed for modification. This means that individual users can change some of the settings themselves.
5.3.1. Configuration files All configuration files are stored in a pre-defined directory structure, created during the installation of the Enterprise Manager and end-user modules. The central root folder containing the configuration files within the proper sub-folders is the following: DictationProperties This folder holds the dictation property configuration file (PSP.SpeechExec.DictationPropConfiguration.xml), which contains the dictation properties of the dictation files. Dictation properties can be modified or new properties added through Dictation properties in the System Administration tool. Note: Because using only one system-wide dictation property configuration file, multi-language property installation is not possible.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 51
SystemConfiguration This folder holds the following system configuration files: PSP.SpeechExec.SupportedAudioFormats.xml: stores the audio formats that SpeechExec officially supports when recording dictation files. PSP.SpeechExec.SystemDefaultSettings.xml: contains the settings of SpeechExec users modified or added in the System Administration tool. The PSP.SpeechExec.SystemDefaultSettings.xml file contains the settings of the users of the default group (Users without group). Users of other groups have separate system default settings files (the file name contains the group name). SpeechExecEnterprise.groups: contains the group settings and login settings made through Groups and Users in the System Administration tool. SpeechExecEnterpriseConfigurationRoot.settings: contains system-wide configurations that you can manage on the System settings and SpeechMagic settings pages. userrelationships: contains the settings for user relationships updated through User relationships in the System Administration tool.
UserConfiguration This folder holds the user configuration files (username.xml), which define how end users interact with SpeechExec. All SpeechExec users have individual user configuration files with individual settings, which can be modified in the System Administration tool. Note: Any configuration file stored outside of the root folder is not part of the system definition. The configuration files must not be edited manually. Use the System Configuration Center features for managing the required settings.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 52
5.3.2. Groups and users The list of groups shows the existing groups and the default group , which contains users that are not assigned to any other group. Under Groups, the following settings can be defined for groups: New group - create new groups. Copy group – copy existing groups. Rename group – modifythe name of the group with the rename group button. Delete group – select a group and click the button to delete the group. Group settings – select a group to edit the default properties of the group. With this application administrators can organize users of the system into groups so that the users of a group have common settings. On this page we describe step-by-step settings for groups and for the users of a group with the following possibilities: Groups Level
Users Level
5.3.2.1. User without groups For the first start please configure the group called Users without group. You can recognize that this is not configured during the first start of SpeechExec Enterprise Dictate or Transcribe. Open the System Configuration Center, select from the right menu area Groups and users, and click on , the click on Group settings
SpeechExec Enterprise 5.0 - Technical Documentation
Page 53
Select Author or Transcriptionist role for the user and click on Next. Click on the Enterprise menu point, select Licensing and add the host name or IP address for the computer with License server. Click on Next and finalise this with Finish.
Now, if you start the SpeechExec Enterprise Dictate the license is retrieved from License Server and Software started without problems.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 54
5.3.2.2. Create new groups Create a new group with the New group... button. When the Add new group dialog is displayed, enter the name of the group in the Group name field manually or click More groups from Active Directory... and select a group from the Active Directory. Here you can also specify the value of the %SE_CENTRAL_DICT_ROOT% system variable, however, it can also be left empty and added on the System variables page in Enterprise in the SpeechExec System Configuration Wizard. Note: A common default root path can also be defined for all newly created groups by specifying the %SE_CENTRAL_DICT_ROOT% system variable on the System settings page. When the Add new group dialog is displayed, enter the name of the group in the Group name field manually or click More groups from Active Directory … and select a group from the Active Directory. Here you can also specify the value of the %SE_CENTRAL_DICT_ROOT% system variable, hovewer; it can also be left empty and added on the System variables page in Enterprise in the SpeechExecExec System Configuration Wizard New group Available groups
Note: A common default root path can also be defined for all newly created groups by specifying the %SE_CENTRAL_DICT_ROOT% system variable on the System settings page. 5.3.2.3. Copy group Copy existing groups with the Copy group button. The group settings will be the same for the new group, but no users will be assigned to it. The default properties of the group can be changed if necessary with the System Configuration Wizard. Select one of available group [1] click on Copy group [2]
Create the new group name and click on OK
SpeechExec Enterprise 5.0 - Technical Documentation
New group is available
Page 55
5.3.2.4. Rename group Modify the name of the group with the Rename group button. When the Rename group dialog is displayed, modify the name of the group in the New group name field manually or click More groups from Active Directory... and select a group from the Active Directory. Note: The default group cannot be renamed. Select one of available group for rename this [1] and click on Rename group [2] Select groups Create new group name and click on OK
5.3.2.5. Delete group Select a group [1] and click the Delete group [2] button to delete the group. A prompt will confirm the deletion of the group. Note: The default group (Users without group) cannot be deleted.
5.3.2.6. Group settings Select a group [1] and click the Group settings… [2] Button to delete the group. A prompt will confirm the deletion of the group.
On this page, select the user role to be configured. Author – a user who uses SpeechExec Enterprise Dictate software to record dictation files Transcriptionist – a user who uses SpeechExec Enterprise Transcribe software to transcribe the dictation files.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 56
5.3.2.7. Create users You can assign users to a group either manually or from the Active Directory. To assign users to a group manually, choose Create user... In the New user name and role dialog, specify the name of the new user and the initial user role. Users can also be searched in the Active Directory.
To assign users to a group from the Active Directory, choose Create new users from AD groups... Select the role of the new users (Author, Transcriptionist or Both) and click OK. In the Create new users from AD groups dialog, choose the group in which the users are listed, then select the users from the list and click OK. An already existing user configuration can be used as a template for newly created users by clicking the desired user from the combo-box under Settings. Note: The option is selected by default. If the "real" user name is to be displayed instead of the login name, the Use displayed user name option should be activated. This option can be automatically activated by enabling the Use displayed user name(s) when creating new user(s) option on the System settings page. Note: When a new author is created, a Confidential folder and a My Transcriptionist folder is also created for the user along with the other folders. These folders together with the Finished dictations folder can be linked with the transcriptionist's pending dictations folder through the User relationships tool.
5.3.2.8. Copy users Copy existing users by selecting them [1] and clicking the Copy user [2] button. The user settings will be the same for the new user and can be changed if necessary with the User Configuration Wizard.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 57
5.3.2.9. Move users Move users to an existing group by selecting the users [1] and clicking the Move users [2]... button.
When the Move users dialog is displayed, select the group [1] where the selected users should be moved and click Move [2].
5.3.2.10. Delete users Delete users from a group by selecting the users [1] and clicking the Delete users [2]... button.
You are asked to confirm the deletion.
5.3.2.11. Edit users Select a user [1] and click the Edit user [2]... button to personalize the system-wide default settings for individual SpeechExec end users (authors and transcriptionists). The user configuration settings define how end users interact with SpeechExec.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 58
This Edit user… button opens the SpeechExec user Configuration Wizard.
5.3.3. Login settings The application enables defining the way users are identified when starting Enterprise Dictate and Enterprise Transcribe. Under Login settings, check the current login settings or define the settings for the login configuration of users by clicking on Edit login settings…
On this page, define the settings for the login configuration. Login type Here you can specify the type of the login to the Enterprise Dictate and Enterprise Transcribe applications. No login Allows starting the Enterprise Dictate and Enterprise Transcribe applications without logging in. Windows authentication (Active Directory) Allows login for the users of the Active Directory. SpeechExec authenticates users in the current Windows domain. LDAP authentication Allows login only for the users of a specified LDAP server by entering the name of the LDAP server. Under Advanced LDAP settings, you can also enter the LDAP connection string and test the LDAP authentication with the current settings. Note: If LDAP login authentication is used with Active Directory server, apply Ntlm as authentication type, otherwise, apply Basic.
Security level Here you can specify the security level of the user login. High security mode High security mode requires active connection to the authentication server. Standard security mode In standard security mode, users can log in without active connection to the authentication server if they have successfully logged in previously. Use this security mode when users do not always have access to the authentication server; for example, when working out of office.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 59
5.3.4. User relationships With this application, administrators can link transcriptionists to authors by linking the pending dictations folder of the transcriptionists to the folder where the finished dictation files are saved at the author.
Example: Author - Finished dictations folder: \\SERVER\A_FINISHED Transcriptionist - pending dictations folder: \\SERVER\A_FINISHED Note: This application can be used only in Simple operating mode. When transcriptionists are linked to authors, new pending dictation folders are created automatically on the transcriptionist side for each author. Name of the linked folder: Pending , Confidential (for example, Pending Author1, Confidential Author2). The settings of the linked transcriptionist folders are locked. These folders cannot be deleted and their path cannot be changed by the users in order to avoid broken links. To create relationships, or modify existing ones, click Edit relationships... on this page.
5.3.5. Dictation properties On this page, configure dictation properties for the system. Dictation properties provide various types of information about a dictation, for example, Dictation length, Author, Priority. Some dictation properties are filled in by the system and some require input by a user. SpeechExec is delivered with a set of default dictation properties. These properties are stored in the dictation properties configuration file stored in the central root folder of the system. Under Dictation properties, system-wide dictation properties can be edited and group-specific property values can be customized.
With this tool the following actions can be taken: Change the label (the displayed property name) of any dictation property. For example, Title can be changed to Case number. Define which properties are mandatory. The user who works on the dictation must fill in all properties defined as mandatory. Define which properties are editable by which user role. For example, you can make settings that enable the transcriptionists to add information in the Comments property.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 60
Add and delete additional custom dictation properties. For example, you can add a work type property. Note: You cannot delete any default properties delivered with SpeechExec. Modify the mapping of Digital Pocket Memo Keywords with SpeechExec dictation properties. For example, DPM Keyword 3 is associated by default with the SpeechExec dictation property Comment. You can modify this mapping so that DPM Keyword 3 is associated with a custom added dictation property Patient ID. Customize group-specific values for custom dictation properties. Users of a group can select from a set of values specific only to their group and not to the entire system. 5.3.5.1. Dictation property definitions All dictation properties in the configuration file are listed here (default and custom properties). The dictation properties are the following: Property name: the internal name of the property; it is read-only Display name: the field name that the users see in the Worklist module To edit the Display name click in the field and define a new name for the property. Type: the type of the property The following Types of property are available: BOOL - the user selects Yes or No DATE - the user enters a date DATETIME - the user enters a date and time DIRECTORY - browsing for a folder is possible ENUM - single selection from a menu is possible FILE - browsing for a file is possible FLOAT - numbers including decimal values INTEGER - numbers MULTIENUM - multiple selection from a menu is possible STRING - characters (words and numbers) Simple edit: can be selected if the property type is STRING Using STRING in simple edit is the old way, where users type the string property. By unchecking simple edit, you can add a string list to the property which shows up and users can decide to accept one of the pre-defined values or type a new one. Value range: depends on the Type of property that you have selected Each property has a system defined identifier which is read-only.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 61
Add - with this option you can create any property dictated by the business and user needs. Click the Add [1] button. A new line appears in the list with the Property name automatically assigned. Fill in all columns in the row.
When dictation files are downloaded from the Digital Pocket Memo to SpeechExec, properties which are set by configuring the Digital Pocket Memo can be associated with SpeechExec properties. For example, the content string of DPM Keyword 1 is by default associated with the SpeechExec property Author. Not all Digital Pocket Memo properties have to be mapped to SpeechExec properties. Note: It is possible to map two Digital Pocket Memo properties to the same SpeechExec property, however it is not advisable, as information might be overwritten.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 62
You can specify, by user role, which dictation properties are editable by the user and which are mandatory. The property field of editable properties can be edited by the user. To make a property editable by the author and/or transcriptionist set the Author edit and/or Transcr. edit columns to Yes. Mandatory properties for an author must be filled in when creating a dictation file. Mandatory properties for a transcriptionist must be filled in when opening a dictation file for transcription. To make a property mandatory for the author and/or transcriptionist set the Author input and/or Transcr. input columns to Yes.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 63
5.3.5.2. Group-specific property values On this page pre-defined values of dictation properties can be customized for each user group. Note: Special pre-defined values can only be specified for custom properties created with the Dictation Property Configuration Tool (Edit system-wide dictation properties... option) with STRING type and value range (not Simple edit). To customize the property values of a group: Select the necessary group [1] in the Group name combo-box. Customizing group-specific values can also be done from the Groups and users function, by right-clicking on the required group name and choosing Edit custom dictation properties from the drop-down menu. The customizable properties of the selected group are listed [2].
To add group-specific values to a custom property, select the required property under Customizable properties and click the Edit custom values [3]... button. In the Edit property values dialog, the property name with the selected group name is displayed. If system-wide values have been added with the Dictation Property Configuration Tool, those values are displayed as read-only under System-wide values. Click New to add group-specific values for the specified property of the specified group.
You can delete a value with the Delete button or clear all values with the Clear button. The order of the group-specific values can also be changed with the Move up and Move down buttons to get the desired order of values in the end-user modules. The values of a custom property can either be inserted into a text editor (for example, Notepad) by clicking Copy custom values or exported into a specified .txt file by clicking Export custom values. Click OK to save the changes on the custom values. In the Use custom values column define whether the end-user should use only group values (Use group values only), system values (Use system values only) or both values (Use group and system values). If no group values are specified, Use systems values only is set automatically. Click OK to save the changes on the customizable properties of the required group.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 64
System wide values
SpeechExec Enterprise 5.0 - Technical Documentation
Custom values – only for Office Vienna group
Page 65
5.3.6. System settings The System settings node provides you with the below adjustment possibilities centralized in one place:
Default group settings
Here you are enabled to set a common default root path for all newly created groups by specifying the %SE_CENTRAL_DICT_ROOT% system variable. By leaving this field empty, the value of the %SE_CENTRAL_DICT_ROOT% has to be defined manually for each and every new group either in the Add new group dialogs during group creation or on the System variables page in Enterprise in the System Configuration Wizard. Here you are also enabled to set a common SpeechExec Enterprise License server address and port number for all newly created groups. However, it can also be specified separately for each group on the Licensing page in Enterprise in the System Configuration Wizard. Save the new settings by clicking the Save license settings button. Note: These specifications have no influence on the settings of the already exisiting groups. Active Directory synchronization The Active Directory Synchronization feature can only operate if it is explicitly allowed by clicking the Allow Active Directory synchronization... button. Note: While it is running, the Enterprise Manager application will be locked and other users will not be able to change any settings.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 66
Activate field – Yes, I would like to allow Active Directory synchronization and click on OK
Active Directory Synchronization feature Click the Start button to manage group membership of users by synchronizing the groups and users of Active Directory to the groups and users of Enterprise Manager. During this action, some restrictions take effect and none of the following operations can be performed: creation, deletion and copying of groups and users modification of group names displacement of users to another group
SpeechExec Enterprise 5.0 - Technical Documentation
Page 67
Operating mode The operating mode is a constant system setting that covers all users who work within one system. The current operating mode is indicated in the bottom-left side panel of the System Configuration Center window. The Enterprise system can operate in simple or expert mode. Note: It is possible to switch from simple mode to expert mode, but reverting back to simple mode is not allowed. Simple operating mode When the Enterprise system is newly installed, it will operate in simple mode. When the system is upgraded or previous configuration files have been migrated, the system will operate in expert mode. In simple operating mode, authors and transcriptionists can be linked by the administrator under the User relationships option. Note: In simple operating mode, manual modification of the following folders is prohibited for individual users: Author role: Finished dictations, Confidential, My Transcriptionist Transcriptionist role: Pending dictations Expert operating mode In expert operating mode, no restrictions are made on modifying the folder paths of authors and transcriptionists; however, the Edit relationships option is not available. To switch to expert mode, click the Switch to Expert Mode button. Note: When changing the folder path of an author that is linked to a transcriptionist, also change the folder path of the linked transcriptionist folder. Otherwise, the transcriptionist will not receive the dictation files from the author. User name appearance Here you are able to decide on the appearance of new user names during their creation. Use displayed user name(s) when creating new user(s). Activate this option to display the "real" name of all newly created users. In the case of users with author role, it means the adjustment of the default profile name and the default author property name. In the case of users with transcriptionist role, it means the adjustment of the custom user name of the user who worked on the dictation file last. Note: Until the deactivation of this option, the Use displayed user name option will be automatically enabled in the New user name and role dialog of the User Configuration Wizard.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 68
5.3.7. SpeechMagic settings The SpeechMagic settings node provides the following options:
define the SpeechMagic servers that will be queried when a user in SpeechExec is searching for SpeechMagic user profiles
create SpeechExec users from SpeechMagic user profiles
Remote SMAPI The host name and port number of your SpeechMagic servers that are validated before synchronization. You can also enter the IP address of your servers in IPv4 format. Define each server in a new line. Defining a port number is optional. SpeechExec uses the default port if you do not define one. Data synchronization The host name and port number of your SpeechMagic servers that will be synchronized. You can also type the IP address of your servers in IPv4 format. Define each server in a new line. Click Save settings to save your changes in the server lists. Click Connect and synchronize to connect to your SpeechMagic servers and synchronize SpeechMagic ConTexts. A list will show you the result of your synchronization where you can see the available ConTexts and whether a server is unavailable for some reason. The newly synchronized ConTexts are available on the General Settings > Speech Recognition > Profile settings page in SpeechExec Enterprise. You can create SpeechExec users from SpeechMagic profiles. On the SpeechMagic settings page, click Create users from SpeechMagic. The Import SpeechMagic users wizard is displayed. Select a SpeechExec Group name where you want to add your new users. Click Next. A list of available SpeechMagic users is displayed. Select the SpeechMagic users that you want to import to SpeechExec. You select a user either by marking a checkbox in the Import column or by selecting multiple lines in the list and then clicking Mark all selected for importing. Click Start to import users. A confirmation message is displayed when users are created.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 69
5.3.8. Mobile device assignments If you have Philips SpeechExec Mobile Server installed, mobile device assignment in SpeechExec is essential for your administrator. Note: This page is only available for administrators with full rights. When you assign mobile devices to users, you essentially create a package of user details that you can synchronize with the Mobile Server. To synchronize user data, the administrator first enters user’s details in SpeechExec Enterprise, which generates an XML file that stores these data.
The administrator then logs in to the Philips SpeechExec Mobile Server and imports the user data, by specifying the path to the SpeechExec Enterprise central system configuration folder.
5.3.9. How to edit mobile devices assignments In the Assign authors to mobile devices window, you see the users of all groups. The author name and assigned mobile device are listed for each user. To edit mobile devices assignments, do the following: Select an author in the Assign authors to mobile devices window that you want to edit, – eg. Marcel. Click Edit mobile device assignments or double-click the name of an author. The details of authors are taken from the Active Directory, and the only detail you can change is the email address.
To add or modify a mobile device ID, click a row below Mobile device IDs and enter the identifier of the device. You can delete device assignments by selecting a mobile device ID and clicking Delete.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 70
Edit mobile device assignments The details of authors are taken from the Active Directory, and the only detail you can change is the email address. To add or modify a mobile device ID, click a row below Mobile device IDs and enter the identifier of the device. You can delete device assignments by selecting a mobile device ID and clicking Delete. Save your changes when you are done.
This will update the UserToMobileDeviceAssignment.xml file (located in the folder SEE_ROOT\SystemConfiguration\UserToMobileDeviceAssignment\) that Mobile Server reads.
Save your changes when you are done. XML file content:
SpeechExec Enterprise 5.0 - Technical Documentation
Page 71
The administrator logs in to the Philips SpeechExec Mobile Server and imports the user data, by specifying the path to the SpeechExec Enterprise central system configuration folder.
Click on User, select Import / Export and click on SpeechExec User Refresh. Log file is visible – for the user: Marcel we receive two devices ID 1234-ABCD-5678-EFGH and 8765HGFE-DCBA-4321
The system create automatically two account for the different Device ID
SpeechExec Enterprise 5.0 - Technical Documentation
Page 72
5.4.
SpeechExec Dictate
SpeechExec has been developed for the professional dictation and transcription business. It provides all the advantages of digital dictation combined with sophisticated file management capabilities.
5.4.1. Menu structure – File 5.4.1.1. New When a new dictation file is created in SpeechExec Pro Dictate, the following information is taken from pre-defined settings as described in General Settings: The file path, the file name prefix and the counter setting. For example: C:\Documents and Settings\User Name\My Documents\My Dictations\A_Suspended\MyLetter000.dss The sound file format. This can be .dss, .ds2 or .wav file . The file format of online speech-recognizable dictation files is .dra format, which is converted to .wav when sent for correction. The name for the special instruction file. This name is based on the dictation file name appended by 'i'. For example: MyLetter000i.dss You can create simple dictation files that will not be speech recognized, and dictation files that will be speech recognized. 5.4.1.2. New with speech recognition In the SpeechExec Pro Dictate window, click New with speech recognition on the toolbar, or go to the File menu and select New with speech recognition. With the New with speech recognition option, dictation files will be speech recognized online.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 73
5.4.1.3. New sequenced dictation file Creating sequenced dictation files is useful in case of long dictations, when the transcription of the files is urgently needed. The author can record the dictation in sequences, and send the sequenced files to the transcriptionist immediately when they are ready so that the transcriptionist can start transcribing the files as soon as possible. This way most part of the dictation may be transcribed before finishing the dictation itself. Limitation for sequenced files: Encryption of sequenced dictation files is not supported. Delivery of sequenced dictation files is not supported. Subfolder creation for sequenced dictation files is not supported. Automatic renaming of sequenced dictation files is not supported.
Define the audio format of the sequenced dictation file from the following options: DSS Standard Play or DSS Quality Play. All file parts will have the same file format, which can be converted later to some other format.
Specify the output folder of the new dictation files by selecting the desired folder in the Output folder combo-box. To save the files to one of the visible generic-type folders (for example, My Transcriptionist or Confidential), select the needed generic-type folder. Activate the Create a full length dictation file from the parts of the file option to merge the parts of the dictation file into one file after completing the recording. The sequences will not be deleted, the full length file will be created additionally. Note: If the size of the combined parts of the dictation file exceeds 50 MB, a warning message asks whether to perform the merge. Click No, to cancel the merge. Activate the Create sequences automatically option to automatically create a new sequence after a certain period of time. You can specify the length of the parts in minutes from 1 to 120 (default = 10 minutes). Click Start. SpeechExec checks whether the folder specified in the Output folder is valid and available for creating new files. If the check is successful, the Recorder window is displayed and recording starts. During the recording of sequenced dictation only the Finish and Save as draft buttons are available neither indexes nor spoken instructions can be created and the Recorder window cannot be operated in Compact mode; it is always displayed in Expanded mode
5.4.1.4. Continue An existing dictation file can be opened and work can continue in the file if the dictation file is not yet being transcribed. The dictation state is reverted to and the dictation properties are retrieved by the program. If a special instruction was recorded, the special instruction file is also loaded. 5.4.1.5. Playback Starts playback of the selected dictation file. If more than one file in your dictation list is selected, the first selected file is played back. Select the menu command again to stop playback.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 74
5.4.1.6. Play special instruction Starts playback of the special instruction associated with the dictation. If more than one file in your dictation list is selected, the first selected file is played back. Special instructions are saved in a separate file from the dictation file; playing back a special instruction does not open the dictation file. SpeechExec supports these types of instructions: Spoken instruction: Comments recorded by the author during dictation which are stored within the dictation sound file at the position in the sound file where the instruction was actually recorded. Examples for spoken instructions are 'insert a paragraph here' or 'correct spelling is Z E L A Z O W S K I'. Special instruction: Remarks recorded by the author usually at the start of a dictation with special information relating to the dictation. Special instructions are stored in a separate file from the dictation sound file. Every dictation sound file can have one special instruction sound file. Examples for special instructions are 'use the memo template for this dictation' or 'make a printout of the finished document and bring it to me for signing'. 5.4.1.7. Submit for email Sends the selected dictation via email. If email settings have been configured, these settings are used. If more than one dictation is selected, all are sent as email attachments. Note: Only one dictation can be sent per email. If you select more than one, the email sending dialog will appear for each dictation. The subject will be filled in automatically with the dictation file name. 5.4.1.8. Submit for FTP upload Uploads the selected dictation to the FTP location. If an FTP profile has been configured, this is used. 5.4.1.9. Send and receive Connects to the email system or the FTP server, checks for incoming emails or files, and sends the outgoing ones. 5.4.1.10. Import Displays the dialog for importing files created outside the SpeechExec Software. When importing dictation files, browse for the dictation files and define a target folder. Any additional files belonging to the dictation files will also be imported. Proceed as follows: Click Add new files to import... to select the files to be imported and click Open. The selected files are displayed in the Import dialog. You can play back the files and their special instructions before importing them.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 75
Click this button to play back the selected dictation file. Click the button again to stop playback. Click this button to play back the special instruction associated with the selected dictation file. Click the button again to stop playback. If required, define or modify the target import folder, or specify a new state for the imported dictation files by selecting the desired option from the Change the state of imported dictation files to combo-box. The following options are available: Transcription pending (default) Recording suspended Note: This setting does not affect the state of imported speechrecognizable dictation files. Speech-recognizable files will always be imported in their original state. Click Import to start the import process. You can add more files to your selection by clicking Add new files to import... again. If you activate the Delete files after importing option, the imported files are removed from their original location. When importing dictation files, any related files, such as instruction files or .xml files are imported automatically. 5.4.1.11. Synchronize Synchronizes the network folders with the contents of the Local Work folder. Dictation files which you have been working on locally are moved to folders on the network. When selecting this option, the Synchronization dialog is displayed, where you can define the destination folder for the files. 5.4.1.12. Start DPM download Starts download from the Digital Pocket Memo. A pop-up window appears, showing the list of files available for download. You can select the files you want to download from the Digital Pocket Memo to your PC. Note: This option is only available if the Digital Pocket Memo is connected to your PC. 5.4.1.13. Un-archive dictation Recovers dictation files from the Archive folder. The original directory is not known anymore; this way the target is always the Suspended folder. If the speech-recognized dictation file was a .dra file in the Archive folder, its state changes to , and recording can be continued in the file in SpeechExec Pro Dictate. If the speech-recognized dictation file was not a .dra file in the Archive folder, its state changes to , and only correction can be continued in the text. Recover a dictation file by following the instructions below:
SpeechExec Enterprise 5.0 - Technical Documentation
Page 76
Select a dictation file in the Archive folder or one of its subfolders (ARCH_yyyymmdd folders). You can recover only one file at a time, so if you want to recover more dictation files, you have to do it one by one. Check that the Suspended folder is available. If it is not available, an error message is displayed. From the File menu choose Un-archive dictation... The archived dictation file is moved to the Suspended folder. Work can continue on the file according to its state.
5.4.2. Menu structure – Edit
5.4.2.1. Delete Deletes the selected dictation; you must confirm your action. 5.4.2.2. Rename Enables you to change the file name of the selected dictation. 5.4.2.3. Cut Cuts the selected dictation from the current folder to paste it into another folder. 5.4.2.4. Copy Copies the selected dictation from the current folder to paste it into another folder.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 77
5.4.2.5. Paste Pastes the cut or copied dictation into the current folder. 5.4.2.6. Select All Selects all dictations in the current folder. 5.4.2.7. Convert Converts the selected dictation file to the configured audio format. If more than one file in your dictation list is selected, all files are converted. 5.4.2.8. Encrypt Encrypts the selected dictation. You must enter and confirm an encryption password. You can select more than one dictation (ctrl and shift keys). Note: The Encryption settings option in General Settings does not have to be activated to use this menu command.
5.4.2.9. Decrypt Decrypts the selected dictation. You must enter the password used to encrypt the dictation. 5.4.2.10. Split Dictation Enables you to split a selected dictation into several smaller overlapping parts with approximately equal lengths. Notes: This option is available if only one file is selected. The splitting process has no effect on the original dictation files. Dictation splitting is not supported for encrypted files. The following non-encrypted formats are supported: DSS, DS2, MP3. 5.4.2.11. Open attached document Opens the attached file of the selected dictation in the application in which the attachment was created. 5.4.2.12. Attach document Enables you to attach the selected file to the dictation. A copy of the selected file is saved in the SpeechExec user folder and renamed to the name of the dictation file. If the dictation already has a file attached, the user is asked to overwrite the existing file. A paper clip icon in the worklist indicates that a dictation has a file attached. Note: Files with the extension .xml, .sfd, .dir, .dll, .exe, .bat and .com cannot be attached. 5.4.2.13. Detach document Enables you to remove an attached file from the dictation. Specify the drive and directory in which to store the file. The attached file is moved to the specified location and removed from the dictation. SpeechExec Enterprise 5.0 - Technical Documentation
Page 78
5.4.2.14. Copy to Folder Enables you to copy the selected dictation to another folder. Select a folder in the displayed dialog and click OK. The dictation is now stored at both locations. 5.4.2.15. Move to Folder
Enables you to move the selected dictation to another folder. Select a folder in the displayed dialog and click OK. The dictation is now stored at the new location. 5.4.2.16. Change dictation State Displays the Change Dictation State dialog, where you can change the state of the selected dictation. Select a state in the displayed dialog and click OK. Note: If you modify the dictation state manually, the selected dictation will not be relocated to another folder. Whereas if you open a suspended dictation and click Finish in the Recorder window, then the dictation is moved to your Finished dictations folder and its state changes from to . You also have the possibility to choose whether the dictation position should be reset or not. You can select your choice at the bottom of the dialog. If you select this checkbox, the dictation position will jump back to the beginning of the dictation. If you leave this checkbox empty, you can continue the dictation from the same position. Notes: This option is also available in the menu General Settings/Worklist/File Operations. You should be aware that changing the dictation state does not initiate follow-up tasks like automatic emailing or conversion. 5.4.2.17. Dictation properties The Dictation Properties dialog lists all properties relating to the selected dictation on the following tabs: Dictation Tab, Document Tab, File Tab, Audio Tab. Properties can be defined when creating a dictation and, if necessary, edited at various stages of the workflow. Each property is displayed as a column in the Dictation list. Default properties can be defined in your user preferences. This ensures that many of the property fields are automatically filled in by SpeechExec when a new dictation is created. Note: Settings of a previous dictation file will be used automatically when a new dictation file is created. These settings will overwrite default property values if they are different. For example, the default Revision author name for dictations is 'John', but the last dictation was created with 'Mike'. The next dictation will use 'Mike' as Revision author, not 'John'. This is valid for the current session only. After restarting the application, the default property values will be used again when a dictation file is created. How dictation properties are edited depends on the type. Some properties can be selected from a menu or a calendar, or the information must be typed into the field. For information on the types of properties, see Types of Dictation Properties. The Copy button can be used to copy the dictation properties of the selected dictation to another program.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 79
Dictation
Document
File
Audio
Notification
Document name
File attributes
Format name
Attach file for notification
Document size
File size
Format tag
Email address for notification
Document date
File size (bytes)
Average bytes/sec
Author
Creation time
Bits/sample
Revision author
Last access time
Channels
Title
Last write time
Samples/sec
Keyword Comment Priority Label 1 (DPM) Label 2 (DPM) Barcode Worktype Typist Department Workstation Custom1 Custom2 Custom3 Custom4 Custom5 Instruction length Dictation length Created Last modified State Last user Encrypted EOL (DPM) Download date (DPM) Dictation identifier Speech recognizable dictation
SpeechExec Enterprise 5.0 - Technical Documentation
Page 80
Queued for speech recognition Queued for speech recognition by Recorded with
5.4.2.18. Delivery information Displays delivery information (like 'Sent to') of the selected dictation.
5.4.3. Menu structure – Folder
5.4.3.1. New subfolder Creates a folder one level below the selected folder. 5.4.3.2. Hide Hides the selected folder. The folder is not visible in the tree and is no longer available. Note: To make a hidden folder visible can be done only from the Folders page of General Settings.
5.4.3.3. Delete Deletes the selected folder after your confirmation. Note: You can delete any folder that you have created yourself. If this option is unavailable, the selected folder cannot be deleted. 5.4.3.4. Rename Enables you to change the name of the selected folder. 5.4.3.5. Folder properties Displays the Folder Properties dialog. Here you can view and edit the properties.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 81
5.4.4. Menu structure – Speech recognition
5.4.4.1. Recognition settings Displays the Recognition settings page of General Settings. Here you can enable speech recognition and define speech recognition settings.
5.4.4.2. Add to speech recognition queue Adds the selected dictation to the offline speech recognition queue.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 82
The queued dictations are visible in the Recognition and adaptation queue panel. This option is only available for Dragon NaturallySpeaking users. 5.4.4.3. Export to speech recognition application Exports the selected dictation to an external speech recognition engine. For this option, an external speech recognition engine must be installed. This option is only available for Dragon NaturallySpeaking users. 5.4.4.4. Start recognition queue Starts processing the dictation files in the offline speech recognition queue in the Recognition and adaptation queue panel. This option is only available for Dragon NaturallySpeaking users. 5.4.4.5. Stop recognition queue Stops the offline speech recognition processing of the dictation files in the Recognition and adaptation queue panel. This option is only available for Dragon NaturallySpeaking users. 5.4.4.6. Start adaptation Starts adaptation of the speech recognition profiles based on the corrected dictation files. The desired adaptation method must be selected in the pop-up window. This option is only available for Dragon NaturallySpeaking users. 5.4.4.7. Train user profile for online recognition Displays the Dragon NaturallySpeaking dialog for training the selected user profile. The desired user profile can be selected on the Recognition settings page in General Settings. This option is only available for Dragon NaturallySpeaking users. 5.4.4.8. SpeechMagic audio wizard Starts the audio wizard where you can set and test your preferred SpeechMagic recording and playback devices. This option is only available for SpeechMagic speech recognition. 5.4.4.9. Synchronize SpeechMagic profile now Synchronizes the settings of your selected SpeechMagic user profile, which is necessary to record a dictation with a SpeechMagic device. This option is only enabled if you have selected a user profile on the Recognition settings page of General Settings.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 83
5.4.5. Menu structure – Setting
5.4.5.1. General Settings Displays the General Settings dialog. Here you can make settings for your Worklist module, dictations, Digital Pocket Memo and Recorder module. 5.4.5.2. Sounds and audio device properties Displays the Audio device settings dialog. Here you can make sounds, audio and hardware settings. To display the corresponding Microsoft Windows dialog, click on Sounds and audio devices properties.
5.4.6. Menu structure – View
5.4.6.1. Toolbar Shows or hides the Toolbar. 5.4.6.2. Status bar Shows or hides the Status Bar. 5.4.6.3. Folders Shows or hides the dictation folders tree pane.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 84
5.4.6.4. DPM devices Shows or hides the DPM devices pane, which shows the status of the connected Digital Pocket Memo(s). 5.4.6.5. Filtering Shows or hides the Filtering panel. Here you can define filter conditions to display only items with specific properties. 5.4.6.6. Recognition and adaptation queue Shows or hides the Recognition and adaptation queue panel. This option is only available for Dragon NaturallySpeaking users. 5.4.6.7. Show Gridlines Shows or hides the gridlines between columns and rows in the dictation list. 5.4.6.8. Waiting list Shows or hides the Waiting list panel. 5.4.6.9. Reset view Resets the default layout of the main window. 5.4.6.10. Refresh Updates the information displayed in the dictation list for the currently open folder. 5.4.6.11. Filter on/off Applies the configured filter to the dictation list. Select the menu command again to return to the unfiltered dictation list. 5.4.6.12. Filters… Displays the Filters dialog. Here you can define filter conditions to display only items with specific properties. 5.4.6.13. Find… Displays the Find dialog. Here you can search for the property values of the files currently displayed in the dictation list. 5.4.6.14. Sort Opens a menu with all available column headings in your dictation list. Select a column to sort your dictation list by the column. 5.4.6.15. Choose Columns Opens a menu with all available column headings in your dictation list. Activate the corresponding checkbox to display a column, clear the checkbox to hide a column. For an explanation of the columns, see Dictation Tab in Dictation Properties.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 85
5.4.6.16. Minimize Minimizes the Worklist to a button on the Windows taskbar.
5.4.7. Menu structure – Help Displays system information, for example, the location of used configuration files and third party components used by the application.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 86
5.5.
SpeechExec Transcribe
5.5.1. Menu structure – File
5.5.1.1. Start transcription Opens the selected dictation. If more than one file in your Worklist is selected, the first selected file is opened. Depending on your personal settings or preconfigured settings, a word processor is also opened. 5.5.1.2. Playback Starts playback of the selected dictation file. If more than one file in your dictation list is selected, the first selected file is played back. Select the menu command again to stop playback. 5.5.1.3. Play special instruction Starts playback of the special instruction associated with the dictation. If more than one file in your dictation list is selected, the first selected file is played back. Special instructions are saved in a separate file from the dictation file; playing back a special instruction does not open the dictation file. 5.5.1.4. Submit for email Sends the selected dictation via email. If email settings have been configured, these settings are used. If more than one dictation is selected, all are sent as email attachments. Only one dictation file can be sent per email. If you select more than one, the email sending dialog will appear for each dictation file. The subject will be filled in automatically with the dictation file name. 5.5.1.5. Send and receive Connects to the email system or the FTP server, checks for incoming emails or files, and sends the outgoing ones. 5.5.1.6. Import Displays the dialog for importing files created outside SpeechExec.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 87
5.5.1.7. Synchronize Synchronizes the network folders with the contents of the Local Work folder. Dictation files which you have been working on locally are moved to folders on the network. When selecting this option, the Synchronization dialog is displayed, where you can define the destination folder for the files. 5.5.1.8. Start download from recorder Starts download from the recorder. A pop-up window appears, showing the list of files available for download. You can select the files that you want to download from the recorder to your PC. Note: This option is only available if the recorder is connected to your PC. 5.5.1.9. Un-archive dictation If you accidentally finish a transcription, and SpeechExec moves the dictation file to the Archive folder (if the corresponding setting is enabled) you can recover the dictation file from the Archive folder and move it to the Suspended folder. The original directory is not known anymore, this way the target is always the Suspended folder. If the speech-recognized dictation file was not a .dra file in the Archive folder, its state changes to , and only correction can be continued in the text. If the dictation file was a digital dictation file in the Archive folder, its state changes to , and transcription of the file can be continued in SpeechExec Pro Transcribe. Recover a dictation by following the instructions below: Select a dictation in the Archive folder or one of its subfolders (ARCH_yyyymmdd folders). You can recover only one dictation at a time, so if you want to recover more dictations, you have to do it one by one. Check that the Suspended folder is available. If it is not available, an error message is displayed. From the File menu choose Un-archive dictation... The archived dictation is moved to the Suspended folder. Work can continue on the file according to its state. 5.5.1.10. Exit Shuts down SpeechExec. Note: SpeechExec can now only be reopened from the Start menu.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 88
5.5.2. Menu structure – Edit
5.5.2.1. Delete Deletes the selected dictation; you must confirm your action. Whether this file is permanently deleted or moved to the Recycle Bin depends on your personal or preconfigured settings. 5.5.2.2. Rename Enables you to change the file name of the selected dictation. Note: Renaming, encrypting or converting a dictation file that is already sent for offline speech recognition is not recommended. The modified dictation file will be rejected from speech recognition. 5.5.2.3. Cut Cuts the selected dictation from the current folder to paste it into another folder. 5.5.2.4. Copy Copies the selected dictation from the current folder to paste it into another folder. 5.5.2.5. Paste Pastes the cut or copied dictation into the current folder. 5.5.2.6. Select All Selects all dictations in the folder that you are viewing.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 89
5.5.2.7. Convert Converts the selected dictation file to the configured audio format. If more than one file in your dictation list is selected, all files are converted. 5.5.2.8. Encrypt Encrypts the selected dictation. You must enter and confirm an encryption password. You can select more than one dictation (CTRL and SHIFT keys). Note: The Encryption settings option in General Settings does not have to be activated to use this menu command. 5.5.2.9. Decrypt Decrypts the selected dictation. You must enter the password used to encrypt the dictation. 5.5.2.10. Split dictation Enables you to split a selected dictation into several smaller overlapping parts with approximately equal lengths. Note: This option is available if only one file is selected. The splitting process has no effect on the original dictation files. Dictation splitting is not supported for encrypted files. The following non-encrypted formats are supported: DSS, DS2, and MP3.
5.5.2.11. Open attached document Opens the attached file of the selected dictation in the application in which the attachment was created. 5.5.2.12. Attach document Enables you to attach the selected file to the dictation. A copy of the selected file is saved in the SpeechExec user folder and renamed to the name of the dictation file. If the dictation already has a file attached, the user is asked to overwrite the existing file. A paper clip icon in the worklist indicates that a dictation has a file attached. Note: Files with the extension .xml, .sfd, .dir, .dll, .exe, .bat and .com cannot be attached. 5.5.2.13. Detach document Enables you to remove an attached file from the dictation. Specify the drive and directory in which to store the file. The attached file is moved to the specified location and removed from the dictation. 5.5.2.14. Copy to Folder Enables you to copy the selected dictation to another folder. Select a folder in the displayed dialog and click OK. The dictation is now stored at both locations. 5.5.2.15. Move to Folder Enables you to move the selected dictation to another folder. Select a folder in the displayed dialog and click OK. The dictation is now stored at the new location.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 90
5.5.2.16. Change dictation state Displays the Change Dictation State dialog, where you can change the state of the selected dictation. Select a state in the displayed dialog and click OK. The dictation is moved to the designated folder, for example if you change the state from to , the dictation is moved from your Suspended folder to your Finished dictations folder. You also have the possibility to choose whether the dictation position should be reset or not. You can select your choice at the bottom of the dialog. If you select this checkbox, the dictation position will jump back to the beginning of the dictation. If you leave this checkbox empty, you can continue the dictation from the same position. Note: This option is also available in the General Settings > Worklist > File Operations menu. You should be aware that changing the dictation state does not initiate follow-up tasks like automatic emailing or conversion. You can select more than one dictation (ctrl and shift keys) and change their state in one step. For example, if Digital Pocket Memo files, which were not finished with the EOL button but are ready for transcription, are downloaded, they have the dictation state . This means that you cannot open them until you change the dictation state to . 5.5.2.17. Dictation properties Displays the Dictation Properties dialog. Here you can view and edit the properties. 5.5.2.18. Take over dictation file 5.5.2.19. Delivery information Displays delivery information (like 'Sent to') of the selected dictation.
5.5.3. Menu structure – Folder
5.5.3.1. Hide Hides the selected folder. The folder is not visible in the tree and is no longer available. Note: To make a hidden folder visible can be done only from the Folders page of General Settings. 5.5.3.2. Delete Deletes the selected folder after your confirmation. Note:
SpeechExec Enterprise 5.0 - Technical Documentation
Page 91
You can delete any folder that you have created yourself. If this option is unavailable, the selected folder cannot be deleted. 5.5.3.3. Rename Enables you to change the name of the selected folder. 5.5.3.4. Folder properties Displays the Folder Properties dialog. Here you can view and edit the properties.
5.5.4. Menu structure – Speech recognition
5.5.4.1. Recognition settings Displays the Profile settings page of General Settings. Here you can enable speech recognition and define speech recognition settings. 5.5.4.2. Add to speech recognition queue Adds the selected dictation to the internal offline speech recognition queue. The queued dictations are visible in the Recognition and adaptation queue panel. This option is only available for Dragon NaturallySpeaking users. 5.5.4.3. Export to speech recognition application Exports the selected dictation to a speech recognition engine. For this option, a speech recognition engine must be installed. 5.5.4.4. Start recognition queue Starts processing the dictation files in the offline speech recognition queue in the Recognition and adaptation queue panel. This option is only available for Dragon NaturallySpeaking users. 5.5.4.5. Stop recognition queue Stops the offline speech recognition processing of the dictation files in the Recognition and adaptation queue panel. This option is only available for Dragon NaturallySpeaking users. 5.5.4.6. Start adaptation Starts adaptation of the speech recognition profiles based on the corrected dictation files. The desired adaptation method must be selected in the pop-up window. This option is only available for Dragon NaturallySpeaking users.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 92
5.5.5. Menu structure – Settings
5.5.5.1. General settings Displays the General Settings dialog. Here you can make settings for your Worklist module, dictations, Digital Pocket Memo and Recorder module. 5.5.5.2. Sounds and audio devices properties Displays the Audio device settings dialog. Here you can make sounds, audio and hardware settings. To display the corresponding Microsoft Windows dialog, click on Sounds and audio devices properties.
5.5.6. Menu structure – View
5.5.6.1. Display carousel Opens the carousel window where dictation files are displayed as dictation cards. Each card contains information about the name of the dictation file, its related properties, its state and a button. Note: The button is disabled if the selected dictation file is locked. A photo of the author can also be displayed on the card by defining its path on the Visibility page in General Settings. The color of a dictation card always reflects the current properties of a dictation file. By default, both the header and the body of the dictation card is blue. In case of dictation files with high priority status, the header of a card is red. The body of a dictation card is green in case of dictation files queued for speech recognition and grey if a file is locked. The currently selected dictation file in the middle of the carousel can be opened by either clicking on the button or pressing ENTER. Filtering or sorting in the Worklist influences the appearance of the dictation files in the carousel, too. Note: Neither filtering nor sorting can be changed in the carousel.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 93
5.5.6.2. Toolbar Shows or hides the Toolbar. 5.5.6.3. Status bar Shows or hides the Status Bar. 5.5.6.4. Folders Shows or hides the dictation folders tree pane. 5.5.6.5. Recorders Displays or hides the Recorders pane, which shows the status of the last connected recorder device. For example, if you connect a DPM first and subsequently a SpeechAir device, then only the status of the SpeechAir device is displayed. 5.5.6.6. Filtering Shows or hides the Filtering panel. Here you can define filter conditions to display only items with specific properties. 5.5.6.7. Recognition and adaptation queue Shows or hides the Recognition and adaptation queue panel. This option is only available for Dragon NaturallySpeaking users. 5.5.6.8. Show gridlines Shows or hides the gridlines between columns and rows in the dictation list. 5.5.6.9. Reset view Resets the default layout of the main window. 5.5.6.10. Refresh Updates the information displayed in the dictation list for the currently open folder. 5.5.6.11. Filter On/Off Applies the configured filter to the dictation list. Select the menu command again to return to the unfiltered dictation list. 5.5.6.12. Filters Displays the Filters dialog. Here you can define filter conditions to display only items with specific properties. 5.5.6.13. Find Displays the Find dialog. Here you can search for the property values of the files currently displayed in the dictation list.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 94
5.5.6.14. Sort Opens a menu with all available column headings in your dictation list. Select a column to sort your dictation list by the column. 5.5.6.15. Choose Columns Opens a menu with all available column headings in your dictation list. Activate the corresponding checkbox to display a column, clear the checkbox to hide a column. 5.5.6.16. Minimize Minimizes the Worklist to a button on the Windows taskbar. Note: This option is not available in a Windows Terminal server and Citrix environment.
5.6.
Workflow Manager
SpeechExec Enterprise Workflow Manager can manage the routing process of the dictations automatically, based on a predefined schedule and criteria. The application processes and routes dictations independently from the recorder (Digital Pocket Memo or SpeechMike). SpeechExec Enterprise Workflow Manager is a client-server application. The Workflow Manager server is implemented as a Windows service and it can be connected to more Workflow Manager Clients from different PCs at the same time. The application infrastructure ensures that if any changes have been made by one of the connected users, the changes have to be applied for the other users as well. Start the SpeechExec Enterprise Manager, select Advanced Administration Tools and click on Workflow Manager
Give the server address of the Workflow Manager service and click OK. The port number is given by default 49256 for TCP or 80 for HTTP.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 95
The Workflow Manager server can be accessed by the clients through TCP and HTTP protocols. HTTP protocol can be used when a user connects to the service from outside of the company domain, which is protected by firewalls. The ports through which the Workflow Manager service accepts connections can be defined through the following ways: Change port values in Registry Pass startup parameters for the Workflow Manager service Registry keys The TCP and HTTP ports used by the Workflow Manager service are stored in the Windows Registry, under HKLM\Software\Philips Speech\WorkflowManager\Service path: WorkflowServerHttpPort for HTTP connections (default value: 80) WorkflowServerTcpPort for TCP connections (default value: 49256) Tasks: This option allows you to manage the tasks of the application.
Configuration: This option allows you to configure the application.
Logging: This option allows you to configure the log settings of the application.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 96
5.6.1. Configuration This is the main window for configuration
Enter the name of the License Server (IP or Name) and click Apply.
After that select the local path [1] to your dictation property configuration file PSP.SpeechExec.DictationPropConfiguration.xml and click Apply.
If you are successful you receive rhe following message – click OK.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 97
Enable email sending by tasks and configure the SMTP server. Note: If this option is disabled, the Workflow Manager service will not complete the tasks with email sending action. For sending email warnings through the Workflow Manager service, only SMTP connection is supported. Establishing the SMTP connection, communication with the SMTP server, and sending email warnings to users is handled by the Workflow Manager server and not the client. Click Configure
SMTP settings dialog Server: enter the name of the server. This can also be the IP address. Sender's address: enter your email address. Port number: enter the port number which identifies the SMTP service. Some services or processes have conventionally assigned permanent port numbers. Click the Default button to select this number automatically. Use SMTP authentication Activate this option if the SMTP server registers legitimate sender addresses for outgoing mail. Secure connection Select the protocol, through which to create connection to the server. By default this option is set to Off and the SMTP server uses normal TCP/IP connection. To set a different secure connection, select the desired option from the Secure connection combo-box. If the setting is changed to any of the available SSL settings, the SMTP port number changes to the commonly used SSL-enabled SMTP port number 465. For the TLS connection please use port 587. Test - click this button to verify that the information entered on this page is correct.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 98
System notifications dialog The application will send an email notification to each recipients if license request fails or task execution stops for any reason. Note: The email notifications will be sent with the settings defined on the SMTP settings dialog.
The Recipient list textbox accepts syntactically valid email addresses, each address in a new line. When clicking OK, the administrator is warned if a syntactically incorrect email address is present in the list. Note: If this feature is not supported by the Workflow Manager service, this tab is disabled.
This is an example notification created by the SpeechExec Enterpeise Workflow Manager.
Default date and time property formatting - specify the default date and time format property of the destination folder where the dictation files are copied or moved. The destination folder must be defined when creating or editing a copy or move task. These properties can be added to the path of the destination folder one by one from the Add variable to path list in the Destination folder path editor window where the available variables are listed.
The default date and time format are the short date and short time format retrieved from the server, however, these values can be changed by clicking the Configure button, when the Default date and time formatting dialog is displayed. Default date and time formatting format used for the date of the Date and DateTime type properties The field displays the date format used currently. You can make changes or define a new format manually in the field. Notes: The date format must not be empty. The following characters can only be used for defining the date properties: y, M, d, space, dot (.), hyphen (-), and underscore (_). Format used for the time of the DateTime type properties The field displays the time format used currently. You can make changes or define a new format manually in the field. Notes: The time format cannot be empty. The following characters can only be used for defining the time properties: H, m, s, space, dot (.), hyphen (-), and underscore (_). Separator between date and time
SpeechExec Enterprise 5.0 - Technical Documentation
Page 99
Separators are punctuation marks that separate the date and time. The following separators are allowed: , space, hyphen (-) and underscore (_). Example The field displays the value of the date and time formats defined above. You can also add predefined placeholders from the list by double-clicking or right-clicking one or by selecting a preferred placeholder and clicking the Add selected button below the list. Click OK to save the defined default formats. Click Cancel to discard the changes you have made.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 100
5.6.2. Task In this chapter we will create example tasks. Based on several schedules and rule criteria, dictations and corresponding files are moved, copied, or deleted from the system. Click on Task [1] or select the +[2] Button
The Task editor window is displayed, which allows the configuration of the schedule, source folders, criteria and action of a task, as well as the enabling/disabling of a task and entering a comment. For the new task, make the following configurations: Edit schedule... option, in the Schedule editor window you can specify the time when the task should run.
The source folders are the directories, the dictations of which are routed by the tasks. In the Criteria editor window you can specify the conditions of the tasks for the dictations. The dictations that meet the criteria set here are processed while the task is running. In the Action you can specify the action of processing the dictations. Miscellanous properties - you can add a comment to the task.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 101
5.6.2.1. Schedule With the Edit schedule… option, in the Schedule editor window you can specify the time when the task should run.
Frequency - specify the frequency of running the tasks by choosing one of the following options: Daily - the task runs daily or every “x” days. Weekly - the task runs weekly or every “x” weeks on the given days. Daily frequency - specify the exact time when the task should start running. Occurs once at - the task starts running at the exact time that you set (for example, 09:08:42). Occurs every - the task runs every “x” hours or minutes that you set from the starting time until the ending time (for example, every 1 hours, starting from 00:00:00 until 23:59:59). Note: tasks, whose daily frequency is set to a specific time (Occurs once at: option) can be executed later, even if it is delayed to another day, which is not enabled for the specified task. Tasks, whose daily frequency is set to a time range (Occurs every option) can only be executed if the current time is between the starting and ending time. Duration - specify the start date from which the settings should be applied. The end date can be chosen as follows: End date - Specify a date when the settings expire. No end date - the validity of the settings will not expire.
5.6.2.2. Source folder The source folders are the directories, the dictations of which are routed by the tasks. You can add a new folder with this option either by typing the full path of the folder or by browsing for the folder with the Add button. To enable processing dictations in the subfolders, check in the Include subfolders option. Delete - you can delete the selected folders from the source folders list.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 102
5.6.2.3. Criteria With the Edit… option, in the Criteria editor window you can specify the conditions of the tasks for the dictations. The dictations that meet the criteria set here are processed while the task is running.
To define custom criteria click on New
Select the Property name column and the Operator comparison algorithm, and type the specific information you are looking for into the Value column. Example Property name - select: File name Operator - select: = Value - type: pri To create more conditions in this criteria, repeat this step. You can use also logical operator AND, OR.
Available property name File name Media type Has special instruction Dictation length (seconds) Instruction length Dictation length Created Last modified State Last user Encrypted Notification Attach file to notification Email address for notification Author Revision author Title Keyword Comment Priority EOL (DPM)
Label1 (DPM) Label2 (DPM) Barcode Download date (DPM) Work type Typist Dictation identifier Department Workstation Custom1 Custom2 Custom3 Custom4 Custom5 Document name Speech recognizable dictation Queued for speechrecognition Queued for speech recognition by Recorded with Vocabulary extension performed Readonly simple edit strings
SpeechExec Enterprise 5.0 - Technical Documentation
Operator = <> Contains Not Contains Starts with Not Starts with
Page 103
5.6.2.4. Action Here you can specify the action of processing the dictations
You can select following options: None Copy dictations from source folder(s) to destination folder – this action needs a destination folder specified in the Destination folder field. To keep the directory hierarchy of the folders and subfolders also in the destination folder, check in the Maintain directory hierarchy during copy/move option. Delete dictations from source folder(s) – this action does not need any additional specification. Deleting a dictation´s files is permanent, Recycle Bin is not used. Move dictations from source folder(s) to destination folder – this action needs a destination folder specified in the Destination folder field. To keep the directory hierarchy of the folders and subfolders also in the destination folder, check in the Maintain directory hierarchy during copy/move option. Maintain cache in source folder(s) – this action creates or maintains a cache file that contains information about the dictations in the source folder. The cache file helps other SpeechExec applications (for example, Enterprise Dictate and Enterprise Transcribe) to process the directory faster. No criteria are needed for this action. Send email warning on a set of dictation files – this action sends email warnings to users based on the defined criteria. This action requires the email settings and SMTP server to be configured.
5.6.2.5. Miscellaneous properties You can add a comment to the task.
Task enabled (only affects non-running tasks) You can enable the selected task by checking in this option. If a task is already running, disabling it will take into effect only after it stops. Now you can see all the tasks and tasks details
SpeechExec Enterprise 5.0 - Technical Documentation
Page 104
5.6.2.6. Setup examples In this chapter we will create some example tasks. Based on several schedules and rule criteria, dictations and corresponding files are moved, copied, or deleted from the system. 5.6.2.7. Maintain Cache One of the features of the Workflow Manager is that it can create a centralized cache of dictation files. Each subfolder will contain a separate cache file of the dictations found in that folder. Networking caching can make the client applications open faster when launched. It is sufficient enough to perform the Network caching task once a day and usually at a time when the system will be idle. We have designed our system to have all the client accessible dictation files within the CENTRAL_DICTATION workflow folder. We will cache beginning from that folder and traverse through all the subfolders. 1.
Click the + button to start the task wizard.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 105
2.
Click the Edit schedule… button.
3.
Choose the settings as shown below and click OK.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 106
4.
Click Add…, checkmark the box in the Include subfolders? Column and click the browse button … to set the source folders.
5. Browse to the CENTRAL_DICTATION folder and click Select Folder
6.
Now select Action type: Maintain cache in source folder(s), set a comment for the task.
check Task enabled (only affects non-running tasks) and click OK.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 107
The new task has been created. Run the task(s) by clicking the Start button.
5.6.3. Logging Here you can specify the place of the log files.
You can enable logging to files by checking Create log files option. If this option is active, you have to specify a folder [1] (in UNC path format) where the log files are generated.
Save the settings with the Apply button.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 108
5.7.
Statistics Module
The SpeechExec Dictation Statistics application collects statistical data on the activities of the authors and transcriptionists. In addition, queries can be run on the dictations to view all details and create reports that are related to these dictations. The screenshots are taken from a Windows Server 2012 operating system. The user interface elements (for example, dialogs, button names and so on) may be slightly different in other operating systems. To start the program, run SpeechExec Enterprise Manager first, and click the SpeechExec Dictation Statistics icon.
When starting the application, specify the BackEnd server name and port, to which SpeechExec Dictation Statistics must connect. With the Test button you can test whether the connection to the server is successful. To confirm the settings, click OK. Note: SpeechExec Dictation Statistics needs successful connection to the BackEnd server in order to function. BackEnd server name - Enter the hostname or the IP address of the selected BackEnd server. BackEnd server port - Enter the port of the selected BackEnd server (the default port is 49255).
SpeechExec Enterprise 5.0 - Technical Documentation
Page 109
5.7.1. Main Window The main window of the Dictation Statistics tool provides an overview on the query result and the filtering conditions defined prior to running the query.
5.7.2. Menu Bar From the menu bar of SpeechExec Dictation Statistics you can select the queries to run, configure the database to be queried and delete dictation files from the database.
5.7.2.1. Statistics In this menu, you can adjust the configuration of the application, reach the toolbar items and exit the SpeechExec Dictation Statistics. Refresh results - executes the selected statistics based on the given filtering information. You can also execute the selected statistics with the F5 shortcut key. Note: In Delete statistics, this option is called Execute, and clicking it will delete all of the dictation information older than the specified date. Export results to file - saves the statistics result in .xls (Microsoft Excel sheet) format. View chart - presents the selected statistics information in column chart and pie chart. Note: This option works only if the selected statistics supports chart display. The chart display contains the following options: Export chart - with this option, you can save the chart display in the following formats: .rpt, .pdf, .xls, .doc, .rtf. Print chart - with this option, you can print the chart display. Zoom - with this option, you can change the size of the page. Column chart - with this option, you can check the statistics information displayed in column chart. Pie chart - with this option, you can check the statistics information displayed in pie chart. Visible properties - presents the properties to be displayed under Statistics result list elements. You can select which properties to be displayed by checking in the checkboxes of the elements. SpeechExec Enterprise 5.0 - Technical Documentation
Page 110
Note: This option works only with the following statistics: Dictation summary Transcription summary The list of non-transcribed dictations with corresponding information Delay Job statistics Configuration - with this option, you can specify the BackEnd server name and port (the default port is 49255), to which SpeechExec Dictation Statistics must connect. With the Test button you can test whether the connection to the server is successful. To confirm the settings, click OK. Note: SpeechExec Dictation Statistics needs successful connection to the BackEnd server in order to function. Exit - with this option, you can exit the application and return to SpeechExec Enterprise Manager. 5.7.2.2. Filters From the Filters menu, you can filter your search results according to several pre-defined filtering conditions.
5.7.2.3. Author From the Author menu, you can run queries that are associated with the author role.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 111
5.7.2.4. Transcription From the Transcription menu, you can start queries that are associated with the transcriptionist role.
5.7.2.5. Other From the Other menu, you can run queries that produce dictation information that cannot clearly be associated with authors or transcriptionists.
5.7.2.6. Dictations The only query in the Dictations menu displays the most detailed information on the individual dictation files.
5.7.2.7. Dictation methods From the Dictation methods menu, you can run queries that produce dictation information related to the dictations methods.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 112
5.7.2.8. View From the View menu, you can toggle the visibility of the Saved reports panel by clicking the Show/hide saved reports menu item. From the View menu, you can also specify how to display the Time value format. You can choose from one of the following options: day.hour:minutes:second (D.HH:mm:ss) day:hour:minutes:second (D:HH:mm:ss)
SpeechExec Enterprise 5.0 - Technical Documentation
Page 113
5.7.3. Authors statistics This chapter describes the dictation statistics queries that are available for analyzing the work of authors. The available queries are described in the following sections: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10.
Dictation summary Number of dictation days Total amount of dictations within a given period Total amount of dictating time within a given period Average dictation length Total online time per author Dictation factor Average number of dictations per day Average dictation time and online time per day Average online time per dictation
The following chapters describe in detail the functions 5.7.3.1. Dictation summary This query summarizes several kinds of statistics. The summary also calculates an average and total for certain statistics, displayed at the bottom of the result list. Statistics result list elements: Avg/total - the average and total that is calculated for the individual statistics (displayed at the bottom of the list). Avg dict length - the average length of dictations in seconds. Avg dict time per day - the average time (in hours) per day when authors recorded dictations. Avg dict online time per day - the average time (in hours) per day when authors actively used the Recorder/Player. Avg num of dict per day - the average number of dictations per those days when authors created recordings. Avg online time per dict - the average time (in minutes) per dictation when authors actively used the Recorder/Player within the specified time interval. Dict factor - The time of the dictation process of authors. Num of dict days - The number of days when authors recorded dictations. Total amount of dict - The number of dictations within the specified time interval. Total amount of dict time - The total dictation hours within the specified time interval. Total dict online time - The total time when authors actively used the Recorder/Player. User name - The name of the selected author(s). Calculation method: An additional Average/Total column is added to show the Average and Total values for certain columns in the bottom two rows. Average values are calculated for all columns except User name. Total values are calculated only for the following columns: - Number of dictation days - Total amount of dictations - Total amount of dictating time - Total dictation online time The average value for the column Average number of dictations per day is not calculated as an average of the peruser column values, but as an average of the total source data set. 5.7.3.2. Number of dictation days By querying the number of dictation days, you can calculate those days when the authors were recording dictations. Settings begin and ends periods is mandatory for this query. Statistics result list elements User name - The name of the selected author(s). Days - The number of days when the individual authors recorded dictations.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 114
Calculation method: Only those days are calculated, which are assigned with any dictation action’s EndTime. That is, when the individual authors were actually recording dictations. 5.7.3.3. The total amount of dictations within a given period This query displays the number of dictations within the selected time interval. Setting the begin and end periods is mandatory for this query. Statistics result list elements User name - the name of the selected author(s). Amount - the number of dictations within a specified time interval. 5.7.3.4. The total amount of dictating time within a given period This query shows the dictating hours and the time that an author spent online during a specified interval. Online in this case means that the author actively used the Recorder/Player. This statistic includes only dictations that were finished within the specified time interval. Statistics result list elements User name - the name of the selected author(s). Dictation time - the total dictation hours within the specified time interval. Online time - the total time that an author spent on using the Recorder/Player. 5.7.3.5. Average dictation length This query calculates the average length of dictations for every author. If two or more authors begin dictating at the same time (that is, their dictations have the same ID) and record dictations of the same length, this query will include only the dictation of which Computer property is the first in alphabetical order. Therefore, if, for example, Author A on Computer 6 and Author B on Computer 2 begin dictating simultaneously and record the same length of dictation, only the dictation of Author B will be included in the query since the name of this computer is first in alphabetical order. Statistics result list elements User name - the name of the selected author(s). Avg dictation length - The average length of dictations within the specified time interval.
Calculation method: Calculates the average dictation length of dictations. Only the most recently changed DetailedDictation records are included (EndTime value = the maximum EndTime values recorded for a given dictation ID). If there are two or more records for the same dictation and same EndTime, then only that one is used which has the maximum ComputerName (in alphabetical order). 5.7.3.6. Total online time per author This query summarizes the period during which the individual authors used the Recorder/Player. This statistic includes only dictations that were finished within the specified interval. Statistics result list elements User name - The name of the selected author(s). Online time - The total time period during which an author uses the Recorder/Player.
Calculation method: Summarizes the OnlineTime fields. Only those DetailedDictation records are used of which EndTime value is in the specified time interval.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 115
5.7.3.7. Dictation factor The dictation factor statistics provides information on how long the process of dictation takes for individual authors. This is counted by dividing the sum of online time with the total dictation length within the specified time interval. This statistic includes only dictations that are finished within the specified interval. If there are two or more recordings with the same dictation ID and ending at the same time, then only that dictation will be included in this query of which Computer property is the first in alphabetical order. For instance, if Author A on Computer 6 and Author B on Computer 2 begin dictating simultaneously and record the same length of dictation, then only the dictation of Author B will be included in the query since the name of this computer is first in alphabetical order. Statistics result list elements User name - the name of the selected author(s). Factor - the sum of online time divided by the total dictation length.
Calculation method: The sum of online time is divided by the sum of dictation length. Only the most recently changed DetailedDictation records are included (EndTime value = the maximum EndTime values recorded for a given dictation ID). If there are 2 or more records for the same dictation (dictation ID) and same EndTime, then only that one which has the maximum ComputerName (in alphabetical order) is used. 5.7.3.8. Average number of dictations per day This query displays the average number of dictations per those days when the author created recordings. This statistic includes even dictations that are only started but not yet finished. Statistics result list elements User name - the name of the selected author(s). Average - the average number of dictations that the author created per day.
Calculation method: This statistics includes all dictations regardless of being finished or not. Calculates those dictations of which EndTime is in the specified interval and divides this number with the number of days when the user created dictations (which is also determined based on the EndTime field). 5.7.3.9. Average dictation time and online time per day This query summarizes two time per day averages when individual authors recorded dictations average of durations when the authors used the Recorder/Player. Statistics result list elements User name - the name of the selected author(s). Average dictation time – the average time – in hours – per day that the author spent on recording dictations Average online time – the average time – in hours – per day when the author actively used the Recorder/Player.
Calculation method: Average dictation time: summarized EndTime - BeginTime divided by the number of those days when the user had dictations. Online time per day: summarized OnlineTime divided by the number of those days when the user had dictations.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 116
5.7.3.10. Average online time per dictation This query displays the average time per dictation during which an author was using the Recorder/Player within the specified time interval. Statistics result list elements User name - the name of the selected author(s). Average - the average time (in minutes) when the author actively used the Recorder/Player.
Calculation method: Summarized Online Time in the specified interval divided by the summarized number of dictations of the user in the same interval.
5.7.4. Transcriptionists statistics This chapter describes the dictation statistics queries that are available for analyzing the work of transcriptionists. The available queries are described in the following sections: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10.
Transcription summary The number of transcription days within a given period The number of transcribed dictations within a given period Total dictation length of transcribed dictations Average time before a dictation has been transcribed Total online time per transcriptionist Transcription factor Average number of transcribed dictations per day Average dictation time and online time per day Average transcription online time per dictation
The following chapters describe in detail the functions 5.7.4.1. Transcription summary This query summarizes several kinds of statistics. The summary also calculates an average and total for certain statistics, displayed at the bottom of the result list. Visible properties Here you can select the properties to be displayed under Statistics result list elements by checking in the checkboxes of the elements. Statistics result list elements Avg/total - the average and total that is calculated for the individual statistics (displayed at the bottom of the list). Avg trans dict time per day - the average time (in hours) per day that transcriptionists spent on transcribing dictations. Avg trans online time per day - the average time (in hours) per day when transcriptionists actively used SpeechExec Player. Avg num of trans dict per day - the average number of dictations per day that the transcriptionists finished transcribing. Avg trans online time per dict - the average time (in minutes) per dictation when transcriptionists actively used SpeechExec Player. Num of trans dict - the number of transcribed dictations within the specified time interval. Num of trans days - the number of days when transcriptionists transcribed dictations. Total dict length - the total transcribed dictation hours within the specified time interval. Trans total online time - the total time that transcriptionists spent on using the SpeechExec Player. Trans factor - the time of the transcription process of transcriptionists. User name - the name of the selected transcriptionist(s).
SpeechExec Enterprise 5.0 - Technical Documentation
Page 117
Calculation method: An additional Average/Total column is added to show the Average and Total values for all columns in the bottom two rows. Average values are calculated for all columns except User name. Total values are calculated only for the following columns: Number of transcribed dictations Number of transcription days Total dictation length (of transcribed dictations) Total transcription online time The average value for the column Average number of transcribed dictations per day is not calculated as an average of the per-user column values, but as an average of the total source data set. As an example, see the following table:
Users may expect that the average value of all data is the same as the average of the per-user averages: (1.6+2.375+2)/3=1.991667 – but this is wrong. Enterprise Statistic calculates it as 35/11=3.1818
SpeechExec Enterprise 5.0 - Technical Documentation
Page 118
Screenshot for reference. Please note that the result value is displayed as 3.182 due to rounding.
5.7.4.2. The number of transcription days within a given period By querying the number of transcription days, you can calculate those days when the transcriptionists were transcribing dictations. Setting the begin and end periods is mandatory for this query. Statistics result list elements User name - the name of the selected transcriptionist(s). Days - the number of days when the transcriptionist transcribed dictations. Calculation method: Only those days are calculated which are assigned with any dictation action’s EndTime. Only dictations with state Transcription Finished are taken into account. 5.7.4.3. The number of transcribed dictations within a given period This query displays the number of transcribed dictations within the selected time interval. Setting the begin and end periods is mandatory for this query. Statistics result list elements User name - the name of the selected transcriptionist(s). Amount - the number of transcribed dictations within the specified time interval. Calculation method: Calculates the number of dictations of which EndTime is in the specified time interval. Only dictations with state Transcription Finished are taken into account. 5.7.4.4. Total dictation length of transcribed dictations This query displays the length of transcribed dictations. This statistic includes only dictations that are in Transcription finished state. If there are two dictations with the same dictation ID and length, then only that dictation will be included in this query of which Computer property is the first in alphabetical order. Therefore, if, for example, Transcriptionist A on Computer 6 and Transcriptionist B on Computer 2 begin dictating simultaneously and record the same length of dictation then only the dictation that Transcriptionist B was working on will be included in the query since the name of this computer is first in alphabetical order. Statistics result list elements User name - the name of the selected transcriptionist(s). Total dictation length - the total dictation hours within the specified time interval. Calculation method: Summarizes dictation length of dictations. Only the most recently changed DetailedDictation records are included (EndTime value = the maximum EndTime values recorded for a given dictation ID). If there are more than one user actions for the same dictation with the same EndTime, then only that one is used which has the maximum ComputerName (in alphabetical order). Only those records are collected whose state is Transcription Finished.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 119
5.7.4.5. Average time before a dictation has been transcribed This query displays the average time that passed before a dictation was finally transcribed. This statistic includes only the dictations in Transcription finished state. The dictations that have been recorded again after the last transcription are left out from the query. Statistics result list elements User name - the name of the selected transcriptionist(s). Avg hours - the average time that passed before dictations were transcribed. Calculation method: Collects dictations with maximum EndTime which have been transcribed (state is Transcription Finished), and then subtracts the EndTime of the same dictation of which state is Recording Finished and has maximum EndTime. 5.7.4.6. Total online time per transcriptionist This query summarizes the period during which individual transcriptionists used SpeechExec Player. This statistic includes only dictations that were transcribed within the specified interval. Statistics result list elements User name - The name of the selected transcriptionist(s). Online time hours - The total time during which an author uses the Recorder/Player. Calculation method: Summarizes the OnlineTime fields. Only those DetailedDictation records are included of which EndTime value is in the specified time interval. 5.7.4.7. Transcription factor The transcription factor statistics provides information on how long the process of transcription takes for individual transcriptionists. This is counted by dividing the sum of online time with the total dictation length within the specified time interval. This statistic includes only dictations that are transcribed within the specified interval and are in Transcription finished state. If there are two or more dictations with the same dictation ID and ending at the same time, then only that dictation will be included in this query of which Computer property is the first in alphabetical order. For instance, if Transcriptionist A on Computer 6 and Transcriptionist B on Computer 2 begin dictating simultaneously and record the same length of dictation then only the dictation of Transcriptionist B will be included in the query since the name of this computer is first in alphabetical order. Statistics result list elements User name - the name of the selected transcriptionist(s). Factor - the sum of online time divided by the total dictation length. Calculation method: Calculates the sum online time and divides it by the sum of dictation length. Only the most recently changed DetailedDictation records are included (EndTime value = the maximum EndTime values recorded for a given dictation ID). If there are 2 or more records for the same dictation (dictation ID) and same EndTime, then only that one which has the maximum ComputerName (in alphabetical order) is used. State has to be Transcription Finished. 5.7.4.8. Average number of transcribed dictations per day This query displays the average number of dictations per those days when the transcriptionist finished a transcription. This statistic includes only dictations that are in Transcription finished state. Statistics result list elements User name - the name of the selected transcriptionist(s). Average - the average number of dictations per day that the transcriptionist finished transcribing.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 120
Calculation method: Calculates those dictations of which EndTime is in the specified interval and divides this number with the number of days when the user created dictations (which is also determined based on the EndTime field). Only dictations with state Transcription Finished are taken into account. 5.7.4.9. Average dictation time and online time per day This query summarizes two separate 'average time per day' counters: the average time that transcriptionists spent on transcribing dictations and the average time when the transcriptionists used SpeechExec Player. Only those dictations are included in this statistics that are in Transcription finished state. Statistics Result list elements User name - the name of the selected transcriptionist(s). Avg dictation time - the average time (in hours) per day the transcriptionist spent on transcribing dictations. Avg online time - the average time (in hours) per day when the transcriptionist actively used SpeechExec Player. Calculation method: Average dictation time: summarized EndTime - BeginTime divided by the number of those days when the user had dictations with state Transcription Finished. Online time per day: summarized OnlineTime divided by the number of those days when the user had dictations with state Transcription Finished. 5.7.4.10. Average transcription online time per dictation This query displays the average time per dictation during which a transcriptionist was using SpeechExec Player within the specified time interval. This statistic includes only dictations that are in Transcription finished state. Statistics result list elements User name - the name of the selected transcriptionist(s). Average - the average time (in minutes) per dictation the transcriptionist actively used SpeechExec Player. Calculation method: Summarizes Online Time in the specified interval divided by the summarized number of dictations of the user in the same interval. Only dictations with state Transcription Finished are taken into account.
5.7.5. Other statistics This chapter describes the statistics queries that are available for analyzing the dictations from various perspectives. The available queries are described in the following sections:
Dictation busy hours Transcription busy hours The number of dictations and transcriptions for every day of a given period The number of dictations and transcriptions for every month of a given period
SpeechExec Enterprise 5.0 - Technical Documentation
Page 121
Dictation place Transcription place The average time before the dictation is transcribed within a given period The number of transcribed and non transcribed dictations per work type Total dictation length per work type The list of non-transcribed dictations with corresponding dictation information The number of dictations, dictation length and online time per both authors and transcriptionists Delay Total length and count of non-transcribed dictations
The following chapters describe in detail the functions. 5.7.5.1. Dictation busy hours This query displays the number of recorded dictations for every hour of the selected day. Statistics result list elements Hour - the hours of the selected day. Activity - the number of recorded dictations in each hour of the selected day. Calculation method: Count of dictation records for every hour when EndTime of the dictation user action is in the current hour. Only users with role 0 (Author) are taken into account. 5.7.5.2. Transcription busy hours This query displays the number of finished transcriptions for every hour of the selected day. Statistics result list elements Hour - the hours of the selected day. Activity - the number of transcribed dictations in each hour of the selected day. Calculation method: Calculates the number of dictation records for every hour when EndTime of the dictation user action is in the current hour. Only users with role 1 (Transcriptionist) are taken into account. 5.7.5.3. The number of dictations and transcriptions for every day of a given period This query displays the number of finished dictations and finished transcriptions for every day of the specified time interval. Statistics result list elements Dictation number - the number of finished dictations on a given day. Transcription number - the number of transcribed dictations on a given day. Day of a period - the day of the selected time interval in mm/dd/yyyy format. Calculation method: Calculates the number of finished dictations and the number of finished transcriptions for every day of the specified time interval. Those dictations whose EndTime field is out of the specified interval will not be included. 5.7.5.4. The number of dictations and transcriptions for every month of a given period This query displays the number of finished dictations and finished transcriptions for every month of the specified time interval. Statistics result list elements Dictation number - the number of finished dictations in a given month.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 122
Transcription number - the number of transcribed dictations in a given month. Month of a period - the month of the selected time interval in yyyy/mm format.
Calculation method: Calculates the number of finished dictations and the number of finished transcriptions for every month of the specified time interval. Those dictations, whose EndTime field is out of the specified interval, will not be included. 5.7.5.5. Dictation place This query displays the number of finished dictations on every Computer that was created in the specified time interval. Statistics result list elements Computer - the name of the computer where the dictation was created. Dictation number - the number of finished dictations in the selected time interval. Calculation method: Calculates the number of dictations of which role is 0 (Author), grouped by Computer. 5.7.5.6. Transcription place This query displays the number of transcriptions on every Computer that was finished in the specified time interval. Statistics result list elements Computer - the name of the computer where the transcription was done. Dictation number - the number of finished transcriptions in the selected time interval. Calculation method: Calculates the number of dictations of which role is 1 (Transcriptionist), grouped by Computer. 5.7.5.7. The average time before the dictation is transcribed within a given period. Calculation method: The average number of days between Transcription Pending state and Transcription Finish state of dictations. Only those dictations will be included which has Transcription Pending state record and Transcription Finish state record in the specified time interval. 5.7.5.8. The number of transcribed and non-transcribed dictations per work type This query displays the number of dictations grouped by work type and whether they are finished (state is Transcription finished) or not (state is not Transcription finished). Statistics result list elements Work type - the name of the work type that contains the transcribed dictations. Transcribed - this field categorizes dictations for each work type on the basis of whether the dictations were transcribed or not. Non-transcribed - the number of transcribed and non-transcribed dictations that for each work type. Calculation method: Calculates the number of dictations grouped by Work type and whether they are finished (state is Transcription Finished) or not (state is not Transcription Finished). 5.7.5.9. Total dictation length per work type This query summarizes the length of finished dictations for each work type. If there are two or more transcriptions for the same dictation, the statistic includes only the dictation of which Computer property is first in alphabetical order. Statistics result list elements
SpeechExec Enterprise 5.0 - Technical Documentation
Page 123
Work type - the name of the work type that contains the dictations. Total dictation length - the total length of dictations for each work type.
Calculation method: Sums up the length of dictations. Only the most recently changed DetailedDictation records are included (i.e. EndTime value = the maximum of EndTime values recorded for a given dictation ID). If there were more than one typing sessions for the same dictation (dictation ID) and same EndTime, then only that one is used which has the maximum ComputerName (in alphabetical order). Result set is grouped by Category. 5.7.5.10. The list of non-transcribed dictations with corresponding dictation information This query provides detailed information on finished dictations that are not yet in Transcription finished state. If there are two or more dictations with the same ID, only that dictation will be included in the query of which Computer property is first in alphabetical order. If a dictation was transcribed once and it is reopened for dictation, it will not be included in the result of the query. Visible properties Here you can select the properties to be displayed under Statistics result list elements by checking in the checkboxes of the elements. Statistics result list elements Author name - the name of the author of the dictation. Begin time - the time of starting the last action on the dictation. The last action is visible in the State field. Computer - the name of the computer where the dictation was last processed. Custom 1-5 - the custom properties information, if they were filled in. Department - the name of the department where the dictation was processed. Dictation ID - the unique identifier of the dictation. Dictation length - the length of the dictation. End time - the time of completing the last action on the dictation. File name - the name of the dictation file on the user's computer. Online time - the total time that the user spent on actively using the Recorder/Player while managing the dictation. Priority - the priority of the dictation. Role - this field shows if the dictation is associated with an author or a transcriptionist. State - the last state of the dictation within the specified time interval. Transcriptionist name - the name of the transcriptionist who transcribes the dictation. Work type - the work type of the dictation. Calculation method: Information about those DetailedDictation records, which: Have maximum EndTime (If there are 2 or more records for the same dictation ID with the same EndTime, then only that one is used which has the maximum ComputerName (in alphabetical order)), and There aren’t any other DetailedDictation records with the same dictation ID where the dictation state is Transcription Finished. If a dictation was transcribed one time (there is a record with Transcription Finished state), and is “reopened” again for dictation, it won’t be included in the result set. Only dictations with Role 0 (Author) are retrieved. 5.7.5.11. The number of dictations, dictation length and online time per department for both authors and transcriptionists This query provides information (grouped by department and role) on the number of dictations, dictation length and the time spent on actively using the Recorder/Player. Statistics Result list elements Department - the name of the department where the dictation was processed. Role - this field shows if the dictation is associated with an author or a transcriptionist. SpeechExec Enterprise 5.0 - Technical Documentation
Page 124
Number of dictations - the number of dictations per department and role. Dictation length - the total length of dictations. Online time - the total time that the authors or transcriptionists spent on using the Recorder/Player while processing the dictations.
Calculation method: This is a summary of the following 6 previously described queries: - Total amount of dictations within a given period - Total amount of dictating time within a given period - Total online time per author - The number of transcribed dictations within a given period - Total dictation length of transcribed dictations - Total online time per transcriptionist
5.7.5.12. Delay This query lists dictations, whose transcription has not been finished yet, that is, their state has not yet changed to Transcription finished. Visible properties Here you can select the properties to be displayed under Statistics result list elements by checking in the checkboxes of the elements. Statistics result list elements Author name - the name of the author of the dictation. Begin time - the time of starting the last action on the dictation. The last action is visible in the State field. Computer - the name of the computer where the dictation was last processed. Custom 1-5 - the custom properties information, if they were filled in. Delay - the period of time that has elapsed from the time that the state of the dictation became Transcription pending until the actual time. Department - the name of the department where the dictation was processed. Dictation ID - the unique identifier of the dictation. Dictation length - displays the length of the dictation. End time - the time of completing the last action on the dictation. File name - the name of the dictation file on the user's computer. Online time - the total time that the user spent on actively using the Recorder/Player while managing the dictation. Priority - the priority of the dictation. Role - this field shows if the dictation is associated with an author or a transcriptionist. State - the last state of the dictation within the specified time interval. Transcriptionist - the name of the transcriptionist who transcribes the dictation. Work type - the work type of the dictation. Calculation method: Information about those DetailedDictation records, which: - have a maximum EndTime value (If there are 2 or more records for the same dictation ID with the same EndTime, then only that one is used which has the maximum ComputerName (in alphabetical order)), and - There aren’t any other DetailedDictation records with the same dictation ID where dictation state equals Transcription Finished but there is at least one DetailedDictation record with the same dictation ID where dictation state equals Transcription Pending. The query returns an additional Delay column which contains the period of time that has elapsed from the time that the state of the dictation became Transcription Pending until the actual time.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 125
5.7.5.13. Total length and count of non-transcribed dictations This query provides detailed information on dictations that are not yet in Transcription finished or Correction finished state. Statistics result list elements - User name - The name of the author of the dictation. - Transcriptionist name - The name of the transcriptionist who transcribes the dictation. - Number of dictations - The number of dictations that are not transcribed or corrected in the selected time interval. - Dictation length - The length of the dictation.
5.7.6. Dictations statistics This chapter describes the dictation statistics query with which you can run a comprehensive analysis on several dictations at one time and the Delete statistics function with which dictation information can be deleted. The available functions are described in the following sections: Job statistics Delete statistics 5.7.6.1. Job statistics This query provides information on dictations that the users are working on. By double-clicking a dictation, you can see the details of the modifications that users performed. Visible properties Here you can select the properties to be displayed under Statistics result list elements by checking in the checkboxes of the elements. Statistics result list elements Author name - the name of the author of the dictation file. Comment - the comment of the user related to the dictation file. Computer - the name of the computer where the dictation file was last changed. Creation - the time of creating the dictation file. Custom 1-5 - the custom properties information, if they were filled in. Delay from creation (days) - the elapsed time since the creation of the dictation file. Delay from download (DPM) (days) - the elapsed time since the download of the dictation file from the Digital Pocket Memo device. Delay from last modification (days) - the elapsed time since the last modification of the dictation file. Department - the name of the department where the dictation file was modified. Dictation ID - the unique identifier of the dictation file. Dictation length - the length of the dictation file. Download date and time (DPM) - the date and time when the dictation file was downloaded from the Digital Pocket Memo. Download date (DPM) - the date when the dictation file was downloaded from the Digital Pocket Memo. Download time (DPM) - the time when the dictation file was downloaded from the Digital Pocket Memo. Download month name (DPM) - the name of the month when the dictation file was downloaded from the Digital Pocket Memo. Download day of week (DPM) - the day of the week when the dictation file was downloaded from the Digital Pocket Memo. File name - the path and name of the dictation file. Last modify - the time when the last changes were made on the dictation file. Last role - the role of the user who last modified the dictation file. Last user - the name of the last user who modified the dictation file. Online time - displays the total time that the user spent on actively using the Recorder/Player while managing the dictation file. Priority - the priority of the dictation file. State - the last state of the dictation file within the specified time interval. Transcriptionist - the name of the transcriptionist who transcribes the dictation file. SpeechExec Enterprise 5.0 - Technical Documentation
Page 126
Worked time in seconds - this filed shows the time in seconds that the user spent on working with the dictation file. Work type - the work type of the dictation file.
After double-clicking a dictation, the following additional list elements are displayed: Begin time - the time of starting the last action on the dictation file. The last action is visible in the State field. End time - the time of completing the last action on the dictation file. Role - the role of the user who last modified the dictation file. Calculation method of various values: Delay from creation: days of CurrentDate - CreationDate Delay from download (DPM): days of CurrentDate - DpmDownloadDate Delay from last modification: days of CurrentDate – LastModificationDate Total lifecycle: days of LastModificationDate – CreationDate Worked time in seconds: sum of all (BeginTime - EndTime) By double-clicking a row, the details of all user modifications are displayed. These details include BeginTime, EndTime and OnlineTime values. 5.7.6.2. Delete statistics Here you can delete all statistics that are older than the specified date. To delete dictations, select a date from the calendar and click the Execute button.
5.7.7. Dictation methods This section describes the statistics queries that are available for analyzing the efficiency of transcriptionists. To calculate efficiency, SpeechExec measures turnaround time (TAT), which is the time spent on finishing the full workflow of a dictation from the time of creation, until the transcription is finished. SpeechExec provides the following dictation methods: Digital dictation and transcription In this method, the author creates a dictation and a separate typist transcribes the dictation. Dragon SR with self-correction The author of the dictation uses the Dragon recognition engine to transcribe the dictation. Subsequently, the author corrects the transcription in the Correction window. Dragon SR with typist correction The author of the dictation uses the Dragon recognition engine to transcribe the dictation. Subsequently, a separate typist corrects the transcription.
5.7.7.1. Average turnaround time per dictation method This query displays the turnaround time of finished dictations that were created in the specified time interval. Statistics result list elements Dictation method – the name of the dictation method that was used to create the dictation and its transcription. The following dictation methods are available: o Digital dictation and transcription o Dragon SR with self-correction o Dragon SR with typist correction Avg turnaround time – the average time to finish the complete workflow of creating and transcribing a dictation Avg dictation length – the average length of dictations in the specified time interval. Calculation method: Calculates the average of the most recent EndTime with state Transcription Finished and the first BeginTime with state not Transcription Finished. Possible values of Dictation method: - Digital dictation and transcription SpeechExec Enterprise 5.0 - Technical Documentation
Page 127
- Dragon SR with self-correction - Dragon SR with typist correction 5.7.7.2. Typist efficiency per dictation method This query displays a selected transcriptionist's efficiency per dictation method in the specified time interval. Statistics result list elements Dictation method - The name of the dictation method that was used to create the dictation and its transcription. The following dictation methods are available: Digital dictation and transcription Dragon SR with self-correction Dragon SR with typist correction Typist efficiency (%) - The efficiency of the typist calculated as the maximum dictation length in seconds divided by the total time when the typist worked in seconds. Avg dictation length - The average length of dictations in the specified time interval.
Calculation method: The average DictationLength divided by the average OnlineTime of the Typist (multiplied by 100 to get a percentage value). The value of OnlineTime is calculated based on the Dictation method in the following way: Digital dictation and transcription: only dictations with role 1 (Transcriptionist) are taken into account Dragon SR with self-correction: dictations with role 0 (Author) and state Transcription Finished are omitted from calculation Dragon SR with typist correction: only dictations with state Transcription Finished and Correction Suspended are taken into account 5.7.7.3. Typist statistics per department This query displays the statistics of typists for each department in the specified time interval. Statistics result list elements: Department - The department of the author who created the dictation. Speech recognition only - The number of dictations, which have already been transcribed by a speech recognition engine but have not been corrected. Speech recognition with correction - The number of dictations that a speech recognition engine has already recognized and a typist has corrected the transcription. Digital dictation and transcription - The number of dictations that a typist has already transcribed. Calculation method: Summarizes the number of dictations per dictation method for the specified Department. Only dictations with state Transcription Finished are taken into account. 5.7.7.4. Typist statistics per author This query displays the statistics of typists for each author in the specified time interval. Statistics result list elements: Author name - The name of the author who created the dictation. Speech recognition only - The number of dictations, which have already been transcribed by a speech recognition engine but have not been corrected. Speech recognition with correction - The number of dictations that a speech recognition engine has already recognized and a typist has corrected the transcription. Digital dictation and transcription - The number of dictations that a typist has already transcribed. Calculation method: Summarizes the number of dictations per dictation method for the specified Author name. Only dictations with state Transcription Finished are taken into account.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 128
5.7.7.5. Typist statistics per work type This query displays the statistics of typists for each work type in the specified time interval. Statistics result list elements: Work type - The work type of the transcribed dictation. Speech recognition only - The number of dictations, which have already been transcribed by a speech recognition engine but have not been corrected. Speech recognition with correction - The number of dictations that a speech recognition engine has already recognized and a typist has corrected the transcription. Digital dictation and transcription - The number of dictations that a typist has already transcribed. Calculation method: Summarizes the number of dictations per dictation method for the specified Work type. Only dictations with state Transcription Finished are taken into account
6.
Silent Setup
6.1.
Manager
The command line installation offers the following options: Interactive Setup setup.exe [EXE parameters] /V"" Silent Setup setup.exe /S [EXE parameters] /V"" Logged Setup setup.exe /V"/L*v c:\setuplog.txt" Note: Installation using MSI packages is not supported!
6.1.1. EXE Parameters These parameters are passed directly to the Setup.EXE: /x: Uninstall mode /Lxxxx: Setup language (xxxx is the language ID, for example, the command to specify German is: Setup.exe /L1031 Western Installation Package Language
ID
Parameter
English
1033
/L1033
German
1031
/L1031
French
1036
/L1036
Czech
1029
/L1029
Dutch
1043
/L1043
Spanish
1034
/L1034
Language
ID
Parameter
Swedish
1053
/L1053
Nordic Installation Package
SpeechExec Enterprise 5.0 - Technical Documentation
Page 129
Finnish
1035
/L1035
Danish
1030
/L1030
Norwegian
1044
/L1044
6.1.2. MSI Parameters Use the /qn switch to suppress the user interface of the Windows Installer (see Example). Parameter Name
Possible Values
SEEROOTPATH
Description Path (preferably via a network drive or UNC path specification) of the common, consolidated SEERoot folder, that now contains all necessary configuration information. Example: \\SEEServer\SEERoot\SEE_Confi guration
6.1.3. Examples S:\AdminInstall\setup.exe /S /L1033 /V"/qn SEEROOTPATH=\\SEEServer\SEERoot\SEE_Configuration"
6.2.
Dictate
The command line installation offers the following options: Interactive Setup setup.exe [EXE parameters] /V"" Silent Setup setup.exe /S [EXE parameters] /V"" Logged Setup setup.exe /V"/L*v c:\setuplog.txt" Note: Installation using MSI packages is described in a separate document.
6.2.1. EXE Parameters These parameters are passed directly to the Setup.EXE: /x: Uninstall mode /Lxxxx: Setup language (xxxx is the language ID, for example, the command to specify German is: Setup.exe /L1031 Western Installation Package Language
ID
Parameter
English
1033
/L1033
SpeechExec Enterprise 5.0 - Technical Documentation
Page 130
German
1031
/L1031
French
1036
/L1036
Czech
1029
/L1029
Dutch
1043
/L1043
Spanish
1034
/L1034
Language
ID
Parameter
Swedish
1053
/L1053
Finnish
1035
/L1035
Danish
1030
/L1030
Norwegian
1044
/L1044
Nordic Installation Package
6.2.2. MSI Parameters Use the /qn switch to suppress the user interface of the Windows Installer (see Examples). Feature Parameters (the first one is the default) Parameter Name
Possible Values
CREATESHORTCUTINQL
YES | NO
CREATESHORTCUTINDESKTOP
YES | NO
Configuration Parameters (the first one is the default) Parameter Name
Possible Values
SEEROOTPATH
Description Path (preferably via a network drive or UNC path specification) of the common, consolidated SEERoot folder, that now contains all necessary configuration information. Example: \\SEEServer\SEERoot\SEE_Confi guration
SKIPWMFDIST
NO | YES
Skip installation of Windows Media Format redistributable.
DEVICECONFIGTOOL
YES | NO
Install Philips Device Configuration Tool.
6.2.3. Creating Setup transformations (MST) with Orca 1. Start Orca. (Orca is part of Microsoft SDK) 2. Go to File – Open and open the MSI file in setup disc (in Tools/Setup Configuration). 3. Select Tables – Property on the left side of the main window. 4. Click Transform – New Transform to begin plain MST creating process.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 131
By editing the property values on the right, you can specify and create unique MST files with predefined setup settings. If using this method, SpeechExec will be installed with your predefined settings. If a setting is not available in the Property table, create it by selecting Tables – Add row… and enter the new parameter and its value.
5.
When finished setting the property values, click Transform – Generate Transform… to generate the MST file.
6.2.4. Example S:\AdminInstall\setup.exe /S /L1033 /V"/qn SEEROOTPATH=\\SEEServer\SEERoot\SEE_Configuration"
SpeechExec Enterprise 5.0 - Technical Documentation
Page 132
7.
Installation MSSQL Database
This chapter describe how to install a new SQL Server 2014 Express standalone version. Latest version of SQL Server 2014 can be downloaded from here (http://bit.ly/mssql2k14)
Double-click on SQLEXPR_x86_ENU to start the installer.
It will extract all install files to directory where executable is present, you can change that also.
files
After extraction of the files, click on New SQL Server stand-alone installation… from the window.
You should and must accept the license terms and click on Next
SpeechExec Enterprise 5.0 - Technical Documentation
Page 133
You can activate the update check option ond click on Next.
Update is running, latest software is downloaded
SpeechExec Enterprise 5.0 - Technical Documentation
Page 134
Select the features that needs to be installed. It also displays disk space requirements, make sure you have enough disk space before installation.
On the Instance Configuration page, select a default or named instance for your installation. SQL Server supports multiple installations on the same computer, each installation receives the name of "instance". The default instance gets the name of the computer, but the named instances, receive the name of the computer plus the name provided by the user on this setup page. To access a default instance once it is installed, using SQL Server Management Studio or any other program, you just need provide the computer name. To access a named instance, you will need to provide the name of the instance in the format of computername\nameoftheinstance.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 135
On this screen you need to provide the service accounts that SQL Server services will use. As you can notice, SQL Server setup provides virtual accounts by default, they are auto-managed, they can access the network on a domain environment by using the credentials of the computer account. However, I still recommend to create a local user or use a domain user account to start SQLServer services.
On the Database Engine Configuration page (see above), choose the authentication mode to use for your SQL Server installation. If you select Mixed Mode, Setup creates an sa (system administrator) account. Enter and confirm the password for the sa login when you choose Mixed Mode Authentication and click on Next.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 136
On the "Complete" page you can view the Setup summary log by clicking the blue link provided on the bootom this page. To exit the SQL Server Installation Wizard, click Close.
8.
Silent Setup of the Microsoft .NET Framework
If you install a SpeechExec application on a computer that doesn't have the Microsoft .NET Framework installed, the setup may reboot the PC even if the setup started in the silent mode. Microsoft strongly recommends to restart the PC after installing .NET Framework 4.6 and hotfixes, that's why the SpeechExec setup initiates a reboot. You can prevent this by installing the .NET Framework before the SpeechExec setup is started. The necessary files are located on the installation CD, in the folder \04_Speech_recognition_service\02_Installation\ISSetupPrerequisites\{DD31C237-BFF4-499A-8B6CF6AA9FCBDCE9}\NDP461-KB3102436-x86-x64-AllOS-ENU.exe URL: https://msdn.microsoft.com/de-de/library/ee942965(v=vs.110).aspx
8.1.
Silent Setup of .NET Framework 4.6
The following command launches a silent installation of .NET Framework 4.6: {sharedPath}NDP461-KB3102436-x86-x64-AllOS-ENU.exe /q /norestart
9.
Installation of Desktop Experience Feature on Windows Server
The Desktop Experience feature enables you to install a variety of Windows 7 features on your server running Windows Server 2008 or Server 2012. If you use Windows Server 2008 or Windows Server 2012 as your primary operating system, you might want to have some of these Windows 7 features available for your daily use.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 137
9.1.
Microsoft Windows Server 2012
NOTE: The Server might need to be restarted after the installation completes. The Desktop Experience feature allows you to install a variety of components and features that are provided in the Windows 7 operating system onto a computer that is running the Windows Server 2012 operating system. Select the 2nd option – Add roles and features
Click on Next
SpeechExec Enterprise 5.0 - Technical Documentation
Page 138
Select the first option [1] – Role-based or feature-based installation and click Next [2]
Click Next
SpeechExec Enterprise 5.0 - Technical Documentation
Page 139
On the Features Menu [1] select the – User Interfaces and Infrastructure (installed)[2] and activate Desktop Experience [3] and click finally click on Next [4]
SpeechExec Enterprise 5.0 - Technical Documentation
Page 140
Required components will be installed – click Add Features
Finally click on Install
SpeechExec Enterprise 5.0 - Technical Documentation
Page 141
Installation is ready, click Close and restart your server.
After Restart please check the Installation – go to Server Manager, open Local Server, scroll down to Roles and Features and you see the installed Desktop Experience Feature.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 142
9.2.
Microsoft Windows Server 2008
NOTE: The Server might need to be restarted after the installation completes. The Desktop Experience feature allows you to install a variety of components and features that are provided in the Windows 7 operating system onto a computer that is running the Windows Server 2008 R2 operating system. Open Server Manager: click Start, point to Administrative Tools, and click Server Manager. In the Features Summary section, click Add Features.
Select the Desktop Experience check box, and then click Next.
Click on Add Required Features
SpeechExec Enterprise 5.0 - Technical Documentation
Page 143
Required components will be installed.
Click Close
Finally click on Yes
SpeechExec Enterprise 5.0 - Technical Documentation
Page 144
After Restart please check the Installation
Now you can install SpeechExec Enterprise Software.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 145
SpeechExec Enterprise 5.0 - Technical Documentation
Page 146
Discover the comprehensive range of professional dictation products from Philips http://www.philips.com/dictation February 2017 Doc. No: PRI-1236/20170228 Philips and the Philips Shield Emblem are registered trademarks of Koninklijke Philips N.V. and are used by Speech Processing Solutions GmbH under license from Koninklijke Philips N.V. Dragon NaturallySpeaking is a trademark of Nuance, Inc. and is used here under license All other trademarks are the property of their respective owners. Errors and omissions excepted.
Speech Processing Solutions GmbH reserves the right to change programs or the documentation from time to time without informing the user © 2014-2017 by Speech Processing Solutions GmbH. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior written permission of Company Name.
SpeechExec Enterprise 5.0 - Technical Documentation
Page 147
