Nuance. PowerMic Mobile. Installation and Administration Guide

Transcription

1 Nuance PowerMic Mobile Installation and Administration Guide

2 Table of contents Welcome to PowerMic Mobile 3 System requirements 4 Hardware and software requirements 4 Network requirements 4 System sizing 5 Nuance Management Center (NMC) 6 PowerMic Mobile licenses 6 The PowerMic Mobile Client user 7 The PowerMic Mobile Server organization 8 PowerMic Mobile Server 10 Installing the PowerMic Mobile Server 10 Configuring the PowerMic Mobile Server 10 Configuring a multiple-server system 11 Verifying the server status 12 PowerMic Mobile remote configuration 13 Remote configuration settings 13 PowerMic Mobile deployment 17 Enabling PowerMic Mobile in the speech recognition application 17 Installing the PowerMic Mobile app

3 Welcome to PowerMic Mobile PowerMic Mobile enables users to use their mobile device as a microphone for supported speech recognition applications. The PowerMic Mobile Server pairs PowerMic Mobile on the user's device with the speech recognition application on their PC. Speech and button controls are then streamed to the speech recognition application via the PowerMic Mobile Server. Components The following components make up the PowerMic Mobile solution: PowerMic Mobile Server Mediates pairing between the PowerMic Mobile app and the PowerMic Mobile Client. Once pairing is established, the PowerMic Mobile Server receives speech and button controls from the mobile app and delivers this data to the desktop application. The PowerMic Mobile Server does not initiate communication to the mobile app or the desktop application; it receives requests from both clients and responds to those requests. PowerMic Mobile The Android or ios app used as a microphone for supported speech recognition applications. The app pairs with the PowerMic Mobile Client via the PowerMic Mobile Server. Once pairing is established, the app sends speech and button controls to the PowerMic Mobile Server to be streamed to the PowerMic Mobile Client. PowerMic Mobile Client A client service embedded in the following Nuance applications: Dragon Medical One Dragon Medical Direct Dragon Case and Care The PowerMic Mobile Client connects to the PowerMic Mobile Server on behalf of the integrating application. The PowerMic Mobile Client pairs with the PowerMic Mobile app via the PowerMic Mobile Server. Once pairing is established, the PowerMic Mobile Client receives speech and button controls from the PowerMic Mobile Server. Procedure 1. Configure your organizations, users and groups in the Nuance Management Center (NMC). 2. Install the PowerMic Mobile Server and run the PowerMic Mobile Server configuration tool. 3. Run the PowerMic Mobile remote configuration tool. 4. Make sure PowerMic Mobile is enabled in your speech recognition application. 5. Send your users a zero-config URL to enable PMM on their devices

4 System requirements Hardware and software requirements Nuance Management Server (NMS) NMS 5.x It is strongly recommended to host NMS and the PowerMic Mobile Server on separate servers. Then if the PowerMic Mobile Server becomes unavailable, the speech recognition application can still be used without PowerMic Mobile functionality. Nuance Management Center (NMC) The following browsers are supported: Microsoft Internet Explorer Microsoft Edge Apple Safari Google Chrome PowerMic Mobile Server One of the following operating systems: Microsoft Windows Server 2012 R2 Microsoft Windows Server 2016.NET Framework 4.5 Microsoft IIS It is strongly recommended to configure the PowerMic Mobile Server to use secure communication. To use HTTPS, create a certificate for the PowerMic Mobile Server. The certificate must be signed by a trusted authority known to both the client and the server and must be bound to ports 443 and 8010 (configurable in IIS); for more information, see the Microsoft Developer Network, "Transport Security". PowerMic Mobile One of the following mobile operating systems: ios 8.0 or higher Android 4.3 or higher Device storage: 5 MB PowerMic Mobile does not retain audio data on the device. Once the audio data is uploaded to the PowerMic Mobile Server, it is deleted from the device. Network requirements Data upload bandwidth (single session): 14 kbps PowerMic Mobile requires approximately 10 kbps to stream audio. If a user records for 10 minutes a day for 22 days of the month, this will consume 16.5 megabytes of data per month (132 megabits per month)

5 System sizing The PowerMic Mobile Server does not perform computations and does not store audio data; performance is primarily constrained by memory speed and network latency. In a heavily used system, 50 concurrent sessions consume the following resources on the PowerMic Mobile Server: Bandwidth: 2.5 mbps (1.25 mbps up, 1.25 mbps down) RAM: 50 MB A server with a 4-core CPU and 16 GB of RAM can support 100 concurrent sessions with no performance degradation or noticeable latency. In our experience, the maximum number of concurrent sessions will be about 1/7 the total number of PowerMic Mobile users in the system. Most on-premise systems would be adequately provided by one PowerMic Mobile Server; however, it is strongly recommended to install a second PowerMic Mobile Server instance for redundancy. If the server hosting the PowerMic Mobile Server fails, all user sessions are immediately terminated. Once the second server instance is active, users will need to pair their speech recognition application with PowerMic Mobile to resume recording. For large sites expecting a lot of concurrent sessions, it might be necessary to run multiple instances of the PowerMic Mobile Server behind a load balancer. For more information, see: Configuring a multiple-server system

6 Nuance Management Center (NMC) Make sure NMC is fully set up for PowerMic Mobile before you install and configure the PowerMic Mobile Server and configure PowerMic Mobile. Remarks This guide assumes that you already have an NMC organization set up for your speech recognition application. For more information on configuring NMC for your speech recognition application, see the documentation delivered with the product. PowerMic Mobile will be licensed to your existing organization; your PowerMic Mobile users will belong to this organization. PowerMic Mobile requires two additional NMC user accounts: The PowerMic Mobile Client user and the PowerMic Mobile Server user. For the PowerMic Mobile Client user, you need to create a group in your existing organization. For the PowerMic Mobile Server user, you need to create a separate organization and create a group in that organization. Procedure To configure NMC, do the following: 1. In your existing NMC organization, import your PowerMic Mobile license. 2. Create a group for your PowerMic Mobile Client user. 3. Add the PowerMic Mobile Client user. 4. Create a new organization for your PowerMic Mobile Server user. 5. Add an organization token for your new organization. 6. Create a group for your PowerMic Mobile Server user. 7. Add the PowerMic Mobile Server user. PowerMic Mobile licenses Importing a license To import a PowerMic Mobile license, do the following: 1. Open the Licensing ribbon. 2. In the Administration group, click Import License Key. 3. Paste in your PowerMic Mobile license key. 4. Click Show Information and then click Import. 5. Log out of NMC and log in again to enable PowerMic Mobile-specific features. Verifying your licenses To verify your PowerMic Mobile licenses, do the following: - 6 -

7 1. Open the Licensing ribbon and click View Licenses. 2. Select your organization and click Search. The License Summary screen opens. 3. Check that the PowerMic Mobile license is listed. If this is an enterprise license the number of users is unlimited; the total number of licenses is always listed as 1. If this is an account-based license, check that the total number of licenses agrees with your contract specification. Verifying auto-provisioning By default, PowerMic Mobile licenses are automatically assigned to users. To check that this is enabled, do the following: 1. Open the Organizations ribbon and click Search. 2. Enter search criteria and click Search. 3. In the search results, right-click your organization and select Organization Details. 4. Open the Auto-provisioning tab and, in the left panel, click PowerMic Mobile. 5. Make sure the Enable auto-provisioning for this product check box is activated. The PowerMic Mobile Client user Creating a group for the PowerMic Mobile Client user 1. Open the Organizations ribbon and click Search. 2. Enter search criteria and click Search. 3. In the search results, right-click your organization and select Manage Organization. 4. On the Manage Organization screen, right-click the Default Site and select Add Group. The Add Group screen opens. 5. In the Create new group in organization drop-down list, select your organization. 6. In the Role drop-down list, select User. 7. In the Base new group on this existing group drop-down box, leave the default None. 8. Click OK. The Group Details screen opens. 9. Enter the Group name: PowerMic Mobile Client 10. Select Default Site from the Sites drop-down list. 11. Open the Grants tab. 12. Click Add. The Add Group Grant dialog box opens. 13. In the Object Type list, select Organization and in the Grants list, select View Organization. 14. Click Add. The Add Group Grant dialog box closes. 15. Repeat steps to add the following grants: Modify Organization, View All Sites, View All Groups. 16. Click Save

8 17. On the Manage Organization screen, left panel (tree view), expand the site node to check that your new group is displayed. Adding the PowerMic Mobile Client user 1. Open the User Accounts ribbon and click Add. The User Account Details screen opens. 2. Open the Details tab and select your organization from the drop-down list. 3. Enter a first name and last name for the user; for example: PMM Client 4. Enter the user's login name: PMMReceiver01 5. Enter a password. Note: You will need to enter this login name and password in the PowerMic Mobile remote configuration tool when you configure PowerMic Mobile. 6. Open the Group Memberships tab. 7. In the Available Groups list, select PowerMic Mobile Client and click >. The group is moved to the Selected Groups list. 8. Click Save. The PowerMic Mobile Server organization Creating the PowerMic Mobile Server organization To create a separate organization for the PowerMic Mobile Server user, do the following: 1. Open the Organizations ribbon and click Add; the Create Organization screen opens. 2. Enter (arbitrary) search criteria and click Search. 3. Click I don't see the organization. Let's create one. The New Organization tab opens. 4. Enter the organization details and click Save. Adding an organization token 1. Open the Organizations ribbon and click Search. 2. Enter search criteria and click Search. 3. In the search results, right-click the PowerMic Mobile Server organization and select Organization Details. 4. On the Organization Tokens tab, click Add to generate a new organization token. Make a note of the organization token; you will need it when you configure the PowerMic Mobile Server. 5. Click Save. Creating a group for the PowerMic Mobile Server user 1. Open the Organizations ribbon and click Search. 2. Enter search criteria and click Search

9 3. In the search results, right-click the PowerMic Mobile Server organization and select Manage Organization. 4. On the Manage Organization screen, right-click the Default Site and select Add Group. The Add Group screen opens. 5. In the Create new group in organization drop-down list, select your PowerMic Mobile Server organization. 6. In the Role drop-down list, select User. 7. In the Base new group on this existing group drop-down box, leave the default None. 8. Click OK. The Group Details screen opens. 9. Enter the Group name: PMM Services 10. In the Sites drop-down list, select Default Site. 11. Open the Grants tab. 12. Click Add. The Add Group Grant dialog box opens. 13. In the Object Type list, select Organization and in the Grants list, select View Organization. 14. Click Add. The Add Group Grant dialog box closes. 15. Repeat steps to add the following grants: View All Sites, View All Groups. 16. Click Save. 17. On the Manage Organization screen, left panel (tree view), expand the site node to check that your new group is displayed. Adding the PowerMic Mobile Server user 1. Open the User Accounts ribbon and click Add. The User Account Details screen opens. 2. Open the Details tab and select your PowerMic Mobile Server organization from the drop-down list. 3. Enter a first name and last name for the user; for example: PMM Server 4. Enter the user's login name: PMMAuth_user 5. Open the Group Memberships tab. 6. In the Available Groups list, select PMM Services and click >. The group is moved to the Selected Groups list. 7. Click Save

10 PowerMic Mobile Server Installing the PowerMic Mobile Server 1. Unzip the PowerMic Mobile Server installation package. 2. Double-click ServerSetup.msi and follow the installation instructions. Once the PowerMic Mobile Server is installed, the PowerMic Mobile Server configuration tool starts automatically. 3. Configure the PowerMic Mobile Server via the configuration tool. The configuration tool generates a configuration file (Nuance.Healthcare.dMic.Hub.Service.exe.config) in the PowerMic Mobile Server installation folder. 4. For multiple PowerMic Mobile Server instances: update the configuration file to enable communication between servers. 5. Verify the server status. Remarks The PowerMic Mobile Server installation package installs the PowerMic Mobile Server configuration tool (PowermicConfig.exe) in C:\Program Files. To update the configuration of a PowerMic Mobile Server instance, run the PowerMic Mobile Server configuration tool on the server hosting that instance. nms.nuancehdp.com and pmm.nuancehdp.com addresses in the configuration file <client> element are replaced at run-time with the corresponding server addresses in your system; you do not need to change these settings. Configuring the PowerMic Mobile Server 1. Configure the NMS and Server sections as listed below. Note: These settings are not case-sensitive. 2. Select Run Server after applying changes and click Apply. 3. Click Exit to close the configuration tool. NMS These settings enable the PowerMic Mobile Server to communicate with NMS. Base Url The NMS IP address or domain name, without schema. Secure Mode If NMS is set up for secure communication (HTTPS), enter: True If NMS is not set up for secure communication (HTTP), enter: False Service Port The port used for communication with NMS

11 If NMS is set up for secure communication (HTTPS), enter: 443 If NMS is not set up for secure communication (HTTP), enter: 80 Username The user name of the PowerMic Mobile Server user you configured in NMC: PMMAuth_user Server PowerMic Mobile Server settings. Log Directory The folder to store log files. Make sure that this location already exists; the tool will not create a folder. Default: %APPDATA%\Roaming\Nuance\Logs\PowerMicMobileServer Node Cookie Identifies a specific server if multiple PowerMic Mobile Server instances are installed. This setting is mandatory but not used for a single-server installation. Enter any string. Node Location Identifies a data center if multiple data centers are used. This setting is mandatory but not used for a single-server installation. Enter any string. Pairing Timeout The length of time PowerMic Mobile waits for pairing to be successful. Default: 3 seconds. Secure Mode If the PowerMic Mobile Server will be set up for secure communication (HTTPS), enter: True If the PowerMic Mobile Server will not be set up for secure communication (HTTP), enter: False Service Token The organization token you added for the PowerMic Mobile Server organization in NMC. Session Timeout The elapsed time of inactivity before the PowerMic Mobile Server will timeout from a client. Default: 23:59:59. Configuring a multiple-server system When more than one PowerMic Mobile Server is deployed, each server must be configured to be able to communicate with all servers in the system. You must manually add a section to the configuration file. 1. On the server hosting the PowerMic Mobile Server, stop the PowerMic Mobile Server service. 2. In the PowerMic Mobile Server installation folder, open Nuance.Healthcare.dMic.Hub.Service.exe.config in a text editor. If you do not have write access to this folder, copy the file to another location. 3. In the <Hub> element, add a RemoteHubs setting and list all of the other servers in the system: <RemoteHubs> <RemoteHub Name="server name" Uuid="CA9F95DB-67DB-4EF3-81CB-3DBE3A58237B" RestBaseUri="routable address (IP or name)"/> </RemoteHubs>

12 4. Repeat steps 1-3 for each server in the system. 5. Restart the PowerMic Mobile Server service on each server in the system. Note: You must do this on every server with PowerMic Mobile Server installed. The configuration file on each server will have a different list. Each UUID must be unique and can only contain hexadecimal digits (0-9, A-F). Example <!--Hub settings--> <Hub usessl="false" ServiceToken="organization token" ConsumerSessionTimeout="23:59:59" PairingTimeout="00:00:03" NodeCookie="node cookie specified in the configuration tool" NodeLocation="node location specified in the configuration tool"> <PairableProducts> <PairableProduct name="dmictooltray" uuid="135c3f4a-4c0e-41c1-b826-4af599f91d01"/> <PairableProducts> <RemoteHubs> <RemoteHub Name="uepmm-pvappa002" Uuid="CA9F95DB-67DB-4EF3-81CB-3DBE3A58237B" RestBaseUri="uepmm-pvappa002"/> </RemoteHubs> </Hub> Verifying the server status To check that the PowerMic Mobile Server is running, go to the following URL: http(s)://<your_powermic_mobile_server>/nuance.healthcare.dmic.status/v1/status If the server is running normally, the URL returns: Active (HTTP status code: 200 OK)

13 PowerMic Mobile remote configuration Configure the PowerMic Mobile app and the PowerMic Mobile Client via the PowerMic Mobile remote configuration tool. This tool can be run on any PC with a connection to NMS. These configuration settings are uploaded to NMS; the app and the speech recognition application retrieve these settings from NMS when they start. In addition, the PowerMic Mobile remote configuration tool generates a welcome kit letter (an HTML document containing licensing and deployment details): PowerMicMobile_fulfillment_template.html This contains a zero-config URL, which you will provide to your users when you deploy PowerMic Mobile. Note: Port 8010 is used to upload the configuration to NMS; make sure port 8010 is open and configure any firewall or proxy settings to allow communication via this port. If this is not possible from a remote PC, run the PowerMic Mobile remote configuration tool on the server hosting NMS. Using the PowerMic Mobile remote configuration tool 1. Unzip the PowerMic Mobile remote configuration tool package and double-click PowerMicConfig.msi. 2. Select View advanced configuration and configure the Client Service, Mobile, NMS, and Server sections as listed below. Note: Do not configure the Support Information section; this is only used in Nuance-hosted systems. 3. Click Apply Configuration; the configuration settings are uploaded to NMS and the welcome kit letter is generated. 4. Click Save or Exit. The status window indicates if the configuration has been uploaded successfully to NMS. Remote configuration settings Note: These settings are not case-sensitive. Client Service PowerMic Mobile Client settings. NMS Password The password of the PowerMic Mobile Client user you configured in NMC (PMMReceiver01). NMS Username The user name of the PowerMic Mobile Client user you configured in NMC: PMMReceiver01 Receiver Log Directory The folder to store log files. Default: C:\Users\Public\Documents\Nuance\Logs Tooltray Log Directory The folder to store log files from the PowerMic Mobile system tray process. Default: C:\Users\Public\Documents\Nuance\Logs

14 Mobile PowerMic Mobile app settings. Additional Feedback s addresses used by the Send Feedback feature. The app uses the default client on the device; no additional configuration needs to be specified. Audio Buffer Size: Do not change this setting. The size of the audio buffer used by the app to send audio to the PowerMic Mobile Server. Default: 0.4 Audio Session Mode: Do not change this setting unless the user has audio issues. The recording mode. ios Default Audio Session Behavior: 0 Voice Chat: 1 Android Default Audio Source: 0 Microphone Audio Source: 1 Voice Communication: 2 Voice Recognition: 3 Default: 1; this is the optimal recording mode on ios and Android. Audio Transmission Timeout: Do not change this setting. The length of time, in seconds, the app will continue to buffer audio during a network outage. Default: 0.5. To avoid significant recognition delay following network outage, do not change this setting. Autopairing To enable the app to pair automatically with the PowerMic Mobile Client, enter: True To disable automatic pairing (the user must always pair manually using the 6-character pairing ID), enter: False Default: True. It is highly recommended not to change this setting; the automatic pairing algorithm is optimized to provide seamless connection with the PowerMic Mobile Client. Custom Button Layout: Do not change this setting. Used to select from a list of available button layouts. Default: 6-button layout; do not change this. Custom Message The message on the app when the configuration is downloaded from NMS. Default: Welcome to PowerMic Mobile. Enable button taps while recording To enable all buttons on the app while the user is recording, enter: True To enable only the record button (to stop recording), enter: False Default: True. Favorites: Obsolete - do not change this setting. A list to manage workstations when list mode (deprecated) is enabled. Default: False. Idle Time Disable Duration Screen locking disabled, during inactivity, while paired. This can extend the device timeout, which might violate the organization s policy. Default: None; do not change this value without written approval from the customer

15 Maximum Feedback Logs The number of log files sent via the Send Feedback feature. Default: 4. NMS Authentication Type How the app authenticates with NMS. To enable authentication using the user name and the organization token stored on the device (the user does not need to enter a password), enter: Token To enable authentication using the user's password in addition to the user name and organization token, enter: NMS Credentials Default: Token. Remember Username To enable the app to start with the last-used user name displayed on the login screen, enter: True To clear the user name each time the user logs out of the app, enter: False Tooltray Pairing Mode: Do not change this setting. Here you decide if the app supports manual pairing using the pairing ID displayed in the speech recognition application. Default: True. TooltrayId Recall Minutes The length of time, in minutes, the app retains the pairing ID after unpairing. Only applies when Tooltray Pairing Mode is set to True. Default: 0. NMS These settings enable PowerMic Mobile and the PowerMic Mobile Client to communicate with NMS. Base Url The NMS IP address or domain name, without schema. Discovery Port: Obsolete - do not change this setting. Legacy port used by the app to retrieve the NMS status. Legacy Service Port (REST): Obsolete - do not change this setting. Legacy port used for NMS 4.x REST communication. Organization Guid The partner GUID of the NMC organization. Organization Token The organization token of the NMC organization. Secure Mode If NMS is set up for secure communication (HTTPS), enter: https If NMS is not set up for secure communication (HTTP), enter: http Service Port (REST) Port used for NMS 5+ REST communication. If NMS is set up for secure communication (HTTPS), enter: 443 If NMS is not set up for secure communication (HTTP), enter: 80 Service Port (SOAP): Obsolete - do not change this setting. Port used in SOAP communication for NMS 4.x authentication. Session Timeout The elapsed time between calls to NMS for session renewal. Default: 23:00:

16 Server These settings enable PowerMic Mobile and the PowerMic Mobile Client to communicate with the PowerMic Mobile Server. Base Url The PowerMic Mobile Server IP address or domain name, without schema. Port If the PowerMic Mobile Server is set up for secure communication (HTTPS), enter: 443 If the PowerMic Mobile Server is not set up for secure communication (HTTP), enter: 80 Schema If the PowerMic Mobile Server is set up for secure communication (HTTPS), enter: https If the PowerMic Mobile Server is not set up for secure communication (HTTP), enter: http

17 PowerMic Mobile deployment Enabling PowerMic Mobile in the speech recognition application PowerMic Mobile can be enabled/disabled in the configuration file for the following applications: Dragon Medical One Dragon Medical Direct Dragon Case and Care 1. Go to the application's installation folder. 2. Open SoD.exe.config in a text editor. 3. In the SoD.Settings element, EnablePowerMicMobile setting, set the value to True: <setting name="enablepowermicmobile" serializeas="string"> <value>true</value> </setting> Installing the PowerMic Mobile app 1. Your users install PowerMic Mobile via the Apple App Store or Google Play. 2. Send each user the zero-config URL provided in the welcome letter (output from the PowerMic Mobile remote configuration tool). 3. The user opens the zero-config URL on their device. The URL parameters provide the app with the information needed to connect to NMS and download the configuration settings