SayIt Advanced Diagnostics
  • 6 Minutes to read
  • Dark
    Light

SayIt Advanced Diagnostics

  • Dark
    Light

Where do I find the diagnostics or expanded help menu in SayIt/AgentAssist?

The Diagnostics or expanded Help menu provides additional options to help a user or administrator diagnose or correct issues with a user's SayIt client. 

  • Log in to the voice client. 
  • Press the Ctrl key while you click the SayIt Help icon (?). An expanded Help menu displays diagnostic options. 
On Mac, use Command key while you click the SayIt Help icon (?)

sayit-extended-help-menu

Select the information to display:

  • Log Viewer... Opens the client log file. 
  • Click the Upload button to send a copy of the user log file to the server and open the Log Upload window which includes a path to a Zip file of the user’s log.
  • Copy the file path (manually) and send to Support.
  • Click OK to close the Log Upload window.
  • See Also: Collect Logs for Users
  • System Info... Displays a drop-down list of choices. Use the File and Edit menus to save or change the properties information. 
  • Properties - Displays a combination of the voice client server and audio configurations, and optional settings that are selected. 
  • Java Properties - Displays information about the Java settings that the application is using. 
  • Diagnostics... Opens a Diagnostics panel that allows real-time diagnostics while a user is logged in. 
  • Audio Diagnostics - When this check box is selected, the Write Audio to Disk starts to write a raw streaming audio debug file, which continuously records until the check box is cleared. A new debug audio file is automatically generated each time the check box is selected. Since this generates a raw audio file, it cannot be played using a normal media player. The debug audio files are deleted when the voice client exits. 
The Audio Diagnostics option is not available for Popup shortcuts only users. 
  • Logging - Change the logging level of a running instance of the voice client using the drop-down menu. Change this from WARN (the default) to TRACE will update the logging level so that all activity (rather than just WARN and ERROR messages) will appear in a temporary log file. The setting remains until the user closes the voice client. For troubleshooting, have the user repeat the problem BEFORE closing the voice client, and then go to Log Viewer (see above), and send the Zip file path to Support. Once the voice client is closed and re-launched, the setting goes back to WARN and the temporary log file will be deleted. See Also: Collect Logs for Users
  • Miscellaneous - Use the Deregister Key Hook button if the dictation hotkey or shortcut hotkeys stop working. This button will re-register the "key listener" that allows the voice client to detect a hotkey button press.
    This area is also where you can enable or disable new features that are being alpha tested. Put a checkmark in the box beside the feature to enable it. In some cases, this will start an automatic download of files needed for the feature. Options may include:

Browser v2

Unchecking this box will disable (turn off) "client will automatically switch to using our standard configuration of HTML Shortcuts. Putting a checkmark in this box will start an automatic download of files needed for the feature.

WebSockets

Unchecking this box will disable (turn off) "Fast Dictation" for the client. Fast Dictation is a WebSocket connection to the dictation server instead of HTTP. client will automatically switch to using an HTTP connection for all dictations. 

  • Bandwidth Test... Opens a dialog that begins a real-time speed test of the user’s network connection. 
  • This test emulates uploading files to the server, streaming data to the server, and downloading a file from the server to emulate streaming audio, returning transcripts, and downloading shortcuts, etc. The minimum streaming data results should be a minimum of 64 kilobytes/second or higher, with the ideal speed being 100 kilobytes/second or above.  A message on the bandwidth test results will indicate if your bandwidth speeds are good enough, or too slow.

SayIt_BandwidthTest_Results

The results from this bandwidth test will not be the same as results run from a website such as speedtest.net because the SayIt test actually downloads and uploads a file. Moreover, the http request for the SayIt test is processed through Java.
  • The user can run this test when transcripts do not seem to return quickly. If there is a network concern, ideally this should be run at different times during the day to compare results.
  • An Administrator can also turn on client logging to collect the results of the voice client user running this test. 
  • Java Control Panel... Opens the Java Control Panel menu. 
  • To enable debugging, click the Advanced tab, click to expand the Debugging option. Select Enable tracing and/or Enable logging, then click Apply and OK to exit.
  • To display logging in a separate window, click the Advanced tab, click to expand the Java console options, select Show console, click Apply, then click OK to exit. 
  • See Also: Turn on Maximum Logging for SayIt
  • See Also: How Do I Clear Java Cache?
  • AU3 Info... Opens the workflow automation shortcut window information tool. 
  • AU3 Editor... Opens the workflow automation shortcut editing tool. 
  • Clear Resource Cache...This option deletes files that are temporarily stored to allows fast access to data (such as files needed to run HTML Automation shortcuts or Fast Shortcuts). If SayIt has a problem with these types of shortcuts, try using this option to delete the files and then exit SayIt. The files are downloaded again when you restart SayIt.
    • For sayit.exe this deletes files needed to run HTML Automation shortcuts or Fast Shortcuts located in
      C:\Users\<userprofile>\AppData\Roaming\nVoq\sayitresources
    • For sayit.jnlp on Windows this option deletes the files needed to run HTML Automation shortcuts or Fast Shortcuts located in C:\Users\<userprofile>\AppData\Local\Temp\sayitresources
    • For sayit.jnlp on Mac this option deletes the files needed to run Fast Shortcuts, located in in [user home]/Library/Application Support/com.nvoq.sayit (HTML Automation files do not run on Mac.)
  • About... Displays the version of the voice client that you are running. 

Where do I find voice client logs?

Step 1: Upload to the server

  • Press the Ctrl key and click the Help icon (?).
  • Select Log Viewer.

sayit_logViewer

  • To save the logs, click the Upload button. The dialog displays the name of the zip file that contains the logs and the URL location of where the file was saved.

sayit_logUpload

  • Click OK.

Step 2: Locate on the user’s local computer

The voice client logs to the nvoq-sayit*.log file in the user's Temp directory.

The location of the log file is defined by the Java System property java.io.tmpdir.

  • In the voice client window, press Ctrl and click the Help icon (?). 
  • Select System Info. 
  • From the drop-down box at the top of the System Information menu, select Java Properties. 
  • Scroll down to the java.io.tmpdir parameter.
  • In Windows, the default temp directory is typically: %Temp%
  • On a Mac, the default temp directory is typically: $TMPDIR

The log file is not deleted when the voice client exits, but subsequent launches will attempt to overwrite the file.  

How do I clear Java cache?

In general, you should not have to clear the Java cache, including for upgrades. But in some cases, clearing the Java cache may be useful if you are having trouble launching the voice client or experiencing other unusual problems. 

Clearing the Java cache will uninstall all applications that use Java Web Start. 

Step 1. Access the Java Control Panel

Instructions for accessing the Java Control Panel from SayIt are below. If you CANNOT log in to the SayIt voice client, you can access the Java Control Panel from Windows or Mac. See Accessing the Java Control Panel

From SayIt:
  • With the SayIt window in focus, press the Ctrl key while you click the Help icon (?) with your mouse.

SayItHelpIcon

  • An expanded Help menu displays diagnostic options. From that menu, select Java Control Panel

Step 2. Clear Java Cache from the Java Control Panel

  • Exit all your browser windows and Java Web Start applications before deleting the cache directory.
  • On the General tab of the Java Control Panel, click the Settings button.
  • Click the Delete Files... button. 
  • Select all check boxes and click OK.
  • Click OK to exit all of the open dialogs. 

Step 3. Launch SayIt Again

  • Re-launch the voice client.

Turn On Java & Voice Client Logging

Whether a user is having issues prior to getting logged in to the voice client or having issues while logged in, it can be helpful to turn on "maximum" logging to gather information about their system and voice client application.