Sherlock Tutorial Getting Started

Transcription

1 Sherlock Tutorial Getting Started Background Sherlock is a Java-based application that allows users to analyze the reliability of circuit card assemblies based on their design files. Sherlock has been tested on Windows XP, Windows Vista and Windows 7 and is fully supported on those platforms. Sherlock may also work on other Windows versions. This lesson describes how to install Sherlock on any of the supported platforms. Required Packages Sherlock depends on the prior installation of the following software components in order to be installed properly and/or run properly: Windows.NET Framework 3.5 SP1 Java 1.6+ Runtime Environment Adobe Reader 8.x or 9.x (or any PDF viewer) For each required component, we provide a brief description of how to install them using the manufacturer's standard installation packages. Windows.NET Framework 3.5 SP1 This software component provides a rich library of Windows features that are used by many Windows and 3 rd party applications, including Sherlock. To determine if the framework is already installed on your system, open the Control Panel and select Add or Remove Programs. Scroll down the list of installed software and look for Microsoft.NET Framework 3.5 SP1. If found, the framework is currently installed. If not, go to the following web page: and follow the instructions for downloading and installing the framework of 10

2 Java Runtime Environment Sherlock uses the Java Runtime Environment (JRE) Version 1.6 Update 10 or higher to achieve portability and reliability. To determine if the proper JRE is installed on your system, open the Control Panel and select Java to display the Java Control Panel. (On Windows Vista, Java will not show up in the Control Panel unless you select the Classic View.) Alternately, Windows Vista and Windows 7 users can type java in the search bar on the Start Menu and the Java Control Panel should be the first result found. If the Java Control Panel is not found, then Java is probably not currently installed on your system. If the Java Control Panel exists, select the Java tab in that dialog and then press the View... button to display the Java Runtime Environment Settings dialog. Check for version 1.6 or higher and ensure that it is marked Enabled. If you need to install JRE 1.6 Update 10 or higher, then go to the following web page: and follow the instructions for downloading and installing the framework. Adobe Reader 8.x or 9.x Sherlock can use any 3 rd party PDF viewer to display release notes, tutorial lessons and analysis reports. When first executed, Sherlock automatically attempts to locate any Adobe Reader 8.x or 9.x executables already installed on the this system. If you use a different PDF viewer, Sherlock can be easily configured to reference that viewer instead. To determine if Adobe Reader 8.x or 9.x is installed on your system, open the Control Panel and select Add or Remove Programs. Scroll down the list of installed software and look for Adobe Reader 8.x or Adobe Reader 9.x. If found, the reader is currently installed. If not, go to the following web page: and follow the instructions for downloading and installing the framework of 10

3 Sherlock Installer Package The Sherlock Installer is distributed as a standard Microsoft Installer (MSI) file that can be used to install Sherlock on any supported Window platform. The Sherlock Installer may be downloaded from the following web page: by anyone with a valid Sherlock License file using the following process: 1. Enter the URL listed above into a standard web browser to access the Sherlock Download Server, as shown here: 2. Press the Browse button to locate the Sherlock license file on your local computer to be uploaded to the server. A valid license file is required in order to complete the download process. 3. Select the desired Sherlock Version from the given version list. The latest version is listed as the default and is recommended for most users. 4. If you'd like to review the Release Notes for the selected version before downloading it, press the View Release Notes button. At that point, your standard PDF viewer will be used to display the release notes associated with the selected version. 5. Press the Download Installer button to begin the download process. At that point, a standard browser dialog will appear allowing you to either save the file in the local file system. Select any convenient folder and download the MSI file of 10

4 Sherlock Installation The Sherlock Installer is distributed as a standard Microsoft Installer (MSI) file. After Sherlock is installed, the MSI file is no longer required by Sherlock and can be deleted if desired. You may also save the MSI file to be used at a later time to repair or uninstall Sherlock. To launch the installer, simply double-click the MSI file. At that point, the Sherlock Installer banner should appear. Press Next to display the Sherlock License Agreement. After reviewing the license agreement, select I Agree. Press Next to display the Select Installation Folder dialog of 10

5 It is generally best to install Sherlock in the default folder shown when the dialog is displayed, although you are free to select any folder if you would like to keep it in a different location. Press Next to display the Confirm Installation dialog. On 64-bit Windows platforms the default folder will usually be in the Program Files (x86) system folder because Sherlock is a 32- bit application. As a security precaution, Windows Vista and Windows 7 users and applications may not modify files stored in the Program Files or Program Files (x86) after they are installed. Sherlock does not need to modify any of the installed files during normal operations, so it is best to install Sherlock in the default location to maintain the highest levels of security on your system. If you are ready to proceed, then press Next to install Sherlock in the folder specified. A status bar will be displayed while installation is proceeding to show you the progress. Typically Sherlock is installed in just a minute or two of 10

6 When the installation is complete the Installation Complete dialog will be displayed. Press Close to exit the installation program. You may now delete the MSI file if you desire. Standard Folder Locations Sherlock uses two standard folder locations for its files: Sherlock Installation Folder Sherlock User Data Folder Sherlock Installation Folder The Sherlock Installation Folder contains all of the common files needed to run Sherlock on any system. Usually the Sherlock Installation Folder is located at: c:\program Files\DfR Solutions\Sherlock on 32-bit Windows platforms c:\program Files (x86)\dfr Solutions\Sherlock on 64-bit Windows platforms although users may change this location at installation time. Except for possible changes to the SetJava.cmd script file as indicated above to set the Java location, no files in the Sherlock Installation Folder need to be changed after installation. Sherlock User Data Folder The Sherlock User Data Folder is created in the following location for each user (e.g., USERID) on the system that executes Sherlock: c:\documents and Settings\USERID\Application Data\Sherlock on Windows XP c:\users\userid\appdata\roaming\sherlock on Windows Vista / 7 The Sherlock User Data Folder contains all log, property, design, result and report files associated with one or more projects created by a given user. These folders are only visible in Windows Explorer if the option to display hidden files is set. Alternately, you can type the full path into Windows Explorer of 10

7 Initial Testing and Configuration You can perform the following simple tests to confirm that Sherlock is installed properly and that all required software components are configured properly. Java Installation To determine if Java can be successfully used to launch Sherlock simply double-click the Sherlock icon added to your Desktop during the installation process. At that point, the Sherlock Console window should be displayed showing key file system properties, including the Data path (indicating where all user-specific files are stored) and the Java path (indicating where the JRE is located). If Java is installed in the standard location, the Sherlock Main Window will be displayed properly and you can proceed to the next test. If Java is not installed in the standard location, then an error message will be displayed in the Sherlock Console window such as: In this case, you'll need to edit the SetJava.cmd script located in the Sherlock Installation Folder to indicate where the Java executable is located. When specifying the location, be sure to include the full path to the java.exe executable, not just the Java folder. On Windows Vista and Windows 7 normal users are not allowed to edit files in the Program Files folder. Therefore, in order to make the necessary modifications you must execute Notepad or your favorite text editor using the Run as Administrator menu option, then open the SetJava.cmd script file and edit it. That will allow you (as Administrator) to save the revised version of 10

8 Sherlock License Configuration When the Sherlock Main Window is initially launched an error dialog will appear indicating that no Sherlock License file exists. When OK is pressed, the License Settings dialog will be displayed, indicating that a license file needs to be imported in order for Sherlock to run properly. The License Settings dialog will also show the Host ID associated with the current system. The Host ID is used to uniquely identify your system. The Host ID is required in order to generate a Sherlock Host License (a license file associated with a specific host platform) and is optionally included in Sherlock Floating Licenses in case of network problems. Cut-and-paste the Host ID shown into an message, send it to your Customer Support Representative and they will send you a valid Sherlock License File. When you receive a valid Sherlock License File, press the Import button in the License Settings dialog, locate the license file on your file system using the file chooser dialog and press Select License File to import the new license file. If the license file is valid, the Sherlock Main Window will change to show all Sherlock menu options. If not, a Sherlock License Error will be displayed and you'll have to repeat the license import process of 10

9 PDF Viewer Configuration By default, Sherlock automatically checks for the existence of Adobe Reader 8.x or Adobe Reader 9.x to be used as the PDF viewer when displaying the Sherlock Release Notes or an analysis report. To determine if the PDF Viewer is properly configured, select Help >> Release Notes from the Sherlock Menu. If the Sherlock Release Notes are displayed properly in a separate window, then everything is configured properly. If not, select Settings >> Report Settings from the Sherlock Menu to display the Report Settings dialog. Use the Browse button to search your system for the executable to be used as the PDF viewer. After finding the desired executable, press Select File to return to the Report Settings dialog and then press Save to save the new settings. Select Help >> Release Notes from the Sherlock Menu to re-test the PDF viewer settings. Software Upgrades Sherlock provides an automatic update feature that can be used to remind you when a new Sherlock version is available for download. By default, the upgrade feature is configured to check for new Sherlock versions in the background at the start of every session (we describe below how to change that setting.) If one or more software upgrades are available, a dialog will appear shortly after Sherlock is started that lists the upgrades, with the most recent upgrade on top. If you'd like to upgrade to the latest version, simply press the Download Software button to start the upgrade process. Sherlock will automatically download the necessary installer from the Sherlock Upgrade Server to a directory of your choosing. After the installer has been downloaded, you'll need to exit Sherlock and launch the installer by double-clicking the MSI file in the specified download directory. You may also view the release notes for any version listed by selecting the version from the list and pressing the View Release Notes button of 10

10 You can change the Software Upgrade reminder setting at any time by selecting Settings >> Upgrade Software from the Sherlock menu bar and choosing the desired reminder period. When done, press the Save button to update the settings only or press the Save & Check button to save the settings and check with the designated server for available upgrades. Un-installing Sherlock To un-install Sherlock, select Programs >> Sherlock >> Uninstall Sherlock from the Start Menu and follow the instructions. Alternatively, open the Control Panel >> Add or Remove Programs dialog, search for Sherlock and press the Remove button. During the un-install process, all files stored in the Sherlock Installation Folder will be deleted, but all files in the Sherlock User Data Folder will be kept. This allows users to re-install Sherlock at a later time without losing all their previous work or results. If you don't want any files remaining after Sherlock is un-installed you'll need to manually remove the Sherlock User Data Folder for each user that executed Sherlock on the system of 10