Installing JSonar Using the Installer

The self-extracting installer is designed to automatically copy and compile the Jsonar scripts and the HSC sets to the appropriate directory on your system, as well as to make entries in the Windows registry that are required in order to have the scripts run properly.  To use the self-extracting installer, simply click on the executable file and follow the prompts.

If you are installing JSonar using the executable installer, here are some tips just encase you get stuck:

  • If you are upgrading from a previous version of JSonar, be sure to uninstall the previous scripts for a trouble free installation and working of the Sonar program and the new version of the scripts.
  • Be sure that you are running the installer from an account with administrator priviliges; in Windows Vista and above, even if you are under an administrator account right-click the installer file and choose the „Run as Administrator“ option for best results.
  • For users of Windows Vista/2008 and higher, if you are having problems with the installation, such as the Control surface not installing, files not copying etc, try turning off „User Account Control“ (UAC), installing JSonar, and then after you are done with the configuration part, enable it again. Please see Windows help for assistance in turning off UAC.
  • If you have multiple versions of JAWS make certain that the installer is installing the scripts in to the correct folder. If you don't do this the scripts will still work, they'll just run under one of the other JAWS versions that you have installed in your system.
  • For HSC support in JSonar, be sure that you install HSC into the version of JAWS where JSonar is installed.
  • If you've obtained new and/or updated HSC sets, be sure to copy them (and replace if necessary) to the sonar8 folder. See the heading „Using JSonar With HotSpotClicker“ under the „Getting Started With JSonar“ section for more info.
  • Now that everything is installed, check out the „Configuring JSonar“ heading under the „Getting Started With JSonar“ section for additional setup instructions that you cannot afford to skip!!!

Installing JSonar Manually

This section describes the steps for manually installing JSonar. Please note that this method of installation is only recommended for those who are confident in their computer skills and for whatever reason really need to install JSonar this way. Do not attempt this installation if you do not know what you are doing, and even so, read through these steps before you get started. If for some reason the automatic installer isn't working for you, please contact the JSonar team or somebody on the JSonar list who can assist you with this type of installation, or read through this section until you understand and are confident with every step described below. For ease of use and better understanding, the manual installation process has been broken down into sections corresponding to individual tasks that you must perform.
Now for the steps:

Opening the Required Windows

  • After downloading the JSonar archive, unzip the contents of the file to a temporary folder. This should extract the following folders: 
  • doc: contains documentation in supported languages.
  • extras: contains the JSonar window layout provided by Phil Muir.
  • langs: contains the necessary scripts' files for the supported languages.
  • regkeys: contains registry keys files to enable accessibility mode for supported editions of Sonar8.
  • scripts: contains English version of the scripts and accompanying fi­les.
  • surface: contains the JSonar Control Surface DLL file.
  • Now that the folders have been extracted, open a second window with the JAWS User settings for your account. You can do this in one of the following ways: 
  • Go to the JAWS program group and choose „Explore JAWS,“ then select „Explore my Settings.“
  • Alternatively, go to the run prompt from the start menu or by pressing Windows+R, and depending on your OS, in the Open box type in 1 of the following: 
  • For Windows XP/2003 type: C:\Documents and Settings\User­Name\Applicati­on Data\Freedom Scientific\JAW­S\Version#\Set­tings\Language­Prefix
  • For Windows Vista/2008 or later type: C:\Users\User­Name\AppData\Ro­aming\Freedom Scientific\JAW­S\Version#\Set­tings\Language­Prefix
  • For both paths: replace c: with the letter of your system drive if it's different. UserName is your User Account, Version# refers to the version of JAWS on your system, and LanguagePrefix refers to the prefix for your JAWS language.
  • From now on we will refer to the window with the JAWS settings for your user account as the „JAWS settings folder,“ and the window with the JSonar extracted folders as the „JSonar folder.“

Copying the Scripts

  • Now that both windows are open, go to the JSonar Folder.
  • Open the „scripts“ folder and press CTRL+A to select all the files, then press CTRL+C to copy the files.
  • Now switch to the JAWS settings folder and press CTRL+V to paste the files to this location. You might be asked if you want to merge the sounds folder since 1 already exists, answer „Yes.“ If you had older versions of the scripts in this location you will be asked if you want to replace those files, answer „Yes“ or „Yes to All.“
  • After the copying is complete, switch back to the JSonar folder and go up 1 level to the main folder which contains the rest of the JSonar folders.

Installing Other JSonar Supported Languages

If you want to use JSonar in another language other than English, do the following. However, if you will be using the English copy, skip to the next section.

  • Navigate to the „langs“ folder, and then to the folder named after the language you'd like to use.
  • Once in that folder, press CTRL+A to select all those files, then CTRL+C to copy.
  • Now switch to the JAWS Settings window and press CTRL+V to paste those files into this folder. Answer „Yes“ or „Yes to All“ when asked if you'd like to replace files.
  • Now switch back to the JSonar folder and go up 2 levels to the main JSonar folder.

Installing the Accessibility Mode Registry Keys

In the JSonar folder, navigate to the „regkeys“ folder and select (press enter on) the file that matches your edition of Sonar; for example, if you are using Sonar8 Producer Edition, the file you want to open is „Sonar Producer 8.0 accessibility mode.reg.“ When the registry prompt appears, answer „Yes“ and then „OK.“ Once this is done go up 1 level to the main JSonar folder.

Registering the JSonar Control Surface Plug-in DLL

  • Back in the main JSonar folder, navigate to the „surface“ folder, highlight the „JSonar.dll“ file and press CTRL+C to copy it to the clipboard.
  • Switch back to the JAWS settings window, and press CTRL+V to paste this file into this folder.
  • Do 1 of the following things to register the JSonar.dll file:

Registering the Plug-in From the Run Prompt

  • Open the Run dialog by going to Start, Run, or press Windows+R.
  • Depending on your OS, type 1 of the following commands at the Open prompt: 
  • For Windows XP/2003 type:

C:\Windows\Sys­tem32\RegSVR32­.exe „C:\Documents and Settings\User­Name\Applicati­on Data\Freedom Scientific\JAW­S\Version#\Set­tings\Language­Prefix\JSonar­.dll“

  • For Windows Vista/2008 or higher type:

C:\Windows\Sys­tem32\RegSVR32­.exe „C:\Users\User­Name\AppData\Ro­aming\Freedom Scientific\JAW­S\Version#\Set­tings\Language­Prefix\JSonar­.dll“

  • For both paths: replace c: with the letter of your system drive if it's different. UserName is your User Account, Version# refers to the version of JAWS on your system, and LanguagePrefix refers to the prefix for your JAWS language. Be sure to include the path to the JSonar.dll file in quotes as it's written, or else it will not work.
  • You should get a RegSVR32 dialog informing you that „DllRegisterServer in JSonar.dll succeeded.“ If you didn't see this dialog or nothing happened, check over the steps and make sure you have performed them according to the instructions and that you've filled in all the variables such as UserName, Version# etc. If this method didn't work for you, you might also want to try using the registration method below. If you did get the success dialog, congratulations! Answer „OK“ to dismiss it and move on to the next section.

Registering the Plug-in Using Notepad

  • In the JAWS settings window, go to File, New, Text File. Name the file whatever you want, just change the extension to .bat instead of txt. If using Windows Vista/2008 or later, be sure to go to the end of the file and manually change the extension, as it does not get highlighted with the rest of the file name. Press enter and when Windows asks about changing file extensions, answer „yes.“
  • Right-click the file (applications key), and choose „Edit.“ The file should open in Notepad; if it does, type in or copy and paste the following, exactly as written but without the quotes: 

@C:\Windows\Sys­tem32\Regsvr32­.exe JSonar.dll

  • Close Notepad and answer „Yes“ or „Save“ to the prompt about saving file changes.
  • Now that you are back in the JAWS settings folder, press enter on the file we just created and edited with Notepad. You should get a RegSVR32 dialog informing you that „DllRegisterServer in JSonar.dll succeeded.“ If you didn't see this dialog or nothing happened, check over the steps and make sure you have performed them according to the instructions . If you manually typed the commands, make sure that they were typed as shown above. However, if you did get the success dialog, great! Answer „OK“ to dismiss it and move on to the next section.
  • If you successfully registered the JSonar Control Surface plug-in as described above, you may delete or leave the file we created and edited with Notepad; you cannot however move or touch the JSonar.dll file. If you do, the scripts will stop working and you will have to reregister the file.

Compiling the Scripts

Now that the scripts are copied, the registry keys installed and the JSonar Control Surface DLL registered, the last step that remains is to compile the scripts! To do this, perform the following steps:

  • Open the JAWS Script manager from the JAWS window (Utilities, Script Manager) or by pressing JAWSKey+0 on the numbers row.
  • Once the Script Manager opens, press CTRL+F4 to close whatever file might have opened by default.
  • Press CTRL+O to open the „Open File“ Dialog, and shift tab back to the list of files and folders. If using Windows Vista or later, it might be necessary for you to press enter on the „Browse Folders“ button. By default the dialog is set to open files in the current user's settings folder; this should be the folder to where we copied the scripts earlier. If this isn't the case, which you can verify by shift tabbing to the list of folders and files and checking for any of the jss files listed below, use this same file/folder list to navigate to your user settings folder. This list view works much like Windows Explorer, meaning that you can use Backspace to back up 1 level/folder and enter to open a folder/file.
  • Once you are in the file/folder list view, you must open the following files, press CTRL+S to resave/compile them, and press CTRL+F4 to close them and move on to the next file. For each time you press CTRL+S to compile, you will know that it worked because the Script Manager will notify you saying „Compile Complete.“ At this time you press CTRL+F4 to close the file, open the next and compile it. Do this until you've compiled all the following files: 
  • sonarstd.jss
  • sonarpdr.jss
  • sonarle.jss
  • sonarhs.jss
  • And sonar8.jss
  • After you've compiled all of these files, close the Script Manager, your Scripts are now compiled and ready to use! But before you go, read the next sections for some final notes and comments.

Final Notes and Comments

Congratulations! You now have successfully installed the JSonar scripts! Before you get started, go over these notes and comments to make sure you finish everything right and perform some next crucial steps…

  • We recommend that you copy the doc folder from the JSonar folder to a permanent location such as your Documents folder. Remember that in this folder you have all the JSonar documentation such as: this readme file, JSonar8 Keystroke Guide, the License agreement and more…
  • In the extras folder, the JSonar cakewalk window layout is stored. If you'd like to use this window layout (recommended for better accessibility in large projects), copy this file to Sonar's Sample Content folder, or wherever you told Sonar to look for window layouts. By default this is set to be the Sample Content folder found in your documents folder, cakewalk, sonar8, sample content. Once you configure JSonar, go to View, Layouts and load the JSonar window layout; be sure to uncheck the load project specific layouts box.
  • After you copy the folder and file mentioned above, or if you don't want to do so, you can feel free to delete all the JSonar folders that we extracted earlier. We do recommend that you keep a copy of the zip archive as a backup of the original scripts, and just in case you ever need to reinstall…
  • The last step is to now install and configure HotSpotClicker and the HSC sets for access to Cakewalk Sonar's built-in plug-ins and many others. See the heading „Using JSonar With HotSpotClicker“ under the „Getting Started With JSonar“ section for more info/instructions.
  • Finally, go to the heading „Configuring JSonar“ under the „Getting Started With JSonar“ section to learn how to properly configure JSonar. Please DO NOT skip this part of the installation process, as it is of extreme importance!