You are on page 1of 38

Sciemetric Instruments Inc.

InspeXion® System
Shell User Guide
InspeXion

InspeXion System Shell User Guide


InspeXion System Shell User Guide
Issue 3, October 2008
Describes v7.0

All information and specifications contained in this document are subject to change without notice and do not
represent a commitment on behalf of Sciemetric Instruments Inc., Canada. No part of this document may be
transmitted, reproduced, or used in any form or by any means, mechanical or electronic, including
photocopying, without the expressed written permission of Sciemetric Instruments Inc., Canada.

© Sciemetric Instruments Inc. All Rights Reserved.


Printed in Canada.

InspeXion®, Sigmeter®, QualityWorX®, and the Sciemetric logo are registered trademarks of Sciemetric
Instruments Inc. All rights reserved. Other product names in this document may be trademarks or registered
trademarks of their respective companies and are the sole property of their respective owners.

Sciemetric Instruments Inc.


360 Terry Fox Drive,
Ottawa, Ontario, Canada, K2K 2P5
Phone: 1.613.254.7054 or 1.877.581.0112 (Service) Fax:1.613.254.5313
Email: support@sciemetric.com (Service) inquiries@sciemetric.com (Sales)
Web: www.sciemetric.com
Engineering Workstation

Table of Contents

System Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Launching the Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Shell View Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Toolbar Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Mini Toolbar View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Normal Toolbar View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Floating Toolbar View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Application Quick Load & Launch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Automatic Application Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Performing a Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Backing Up the System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Archiving History Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Extracting Rejected Part History Files. . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Performing an Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Installing a System Backup File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Removing Local Backups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Installing an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Creating a New Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Clearing Component Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Installing a New Version of the Run-Time Software . . . . . . . . . . . . . . . . . . 23
Upgrading to a New Version or Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Modify Installation Options, Repair or Remove Run-Time . . . . . . . . . . . . . . . . . 23
Reverting to a Previous Version or Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Submitting Part History Files (.SPH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Restoring Factory Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Editing the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Running the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Launching the System Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Shutting Down the System or Exit. . . . . . . . . . . . . . . . . . . . . . . . . . 28
Restart on RunTime Critical Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4

Sciemetric Instruments Inc.


System Shell

The System Shell is an application that supports and manages the test
system. The application allows you to perform the following actions
from the Menu Bar (see Figure 2-2):
• Performing a Backup
• Backing Up the System
• Archiving History Data
• Extracting Rejected Part History Files
• Performing an Install
• Installing a System Backup File
• Installing an Application
• Creating a New Application (if the IDE is installed and licensed
on the system)
• Clearing Component Files
• Installing a New Version of the Run-Time Software
• Submitting Part History Files (.SPH)
• Restoring Factory Settings
• Editing the Application (if the IDE is installed and licensed on the
system)
• Running the Application
• Launching the System Setup to configure parameters, such as
passwords, history depth, and test system settings
• Shutting Down the System or Exit

The System Shell is used by embedded Sciemetric Test Systems as the


system shell, but it can also be used on other computers for a quick,
intuitive launching bar for the InspeXion suite of tools. The behavior
when it is functioning as an embedded system shell is sometimes
different, and the differences are noted in the descriptions of the
relevant dialogs.

Sciemetric Instruments Inc.


6 Launching the Shell

There are many places where the software behaves differently


depending on the system on which it is installed:
Managed by Explorer Shell - a system running normal Windows or an
older System 300/298 running an XPe SP1 image.
Managed by System Shell - a system running the System Shell as the
OS shell. This is the case on all SigPODs and System 300 and 298
running an XPe SP2 image and InspeXion V6.30 or greater.

Launching the Shell


On embedded Sciemetric Test Systems, the System Shell is launched as
the main system interface on startup of the system. In this case the
system is Managed by System Shell.
Otherwise, the System Shell can be launched by using the Windows
Start Bar:
Start -> All Programs -> Sciemetric -> InspeXion -> System Shell
The System Setup utility also provides the ability to set the System Shell
to launch on start-up of Windows:
System node -> Windows Logon
When launched, the System Shell will be restored to present the view
mode that was shown the last time it was shutdown.

Shell View Modes


When running on a system that is Managed by System Shell, the
interface is either the Normal Toolbar (see Figure 2-2) fixed on the
botton of the screen or the Application Quick Load & Launch (see
Figure 2-4) shown on top of the system wallpaper.
When running on as system that is Managed by Explorer Shell, the
interface is either the Quick Load and Launch (see Figure 2-4) or one of
three floating toolbars:
• Mini (see Figure 2-1)
• Normal (see Figure 2-2)
• Floating I (see Figure 2-3)

Toolbar Views
All toolbar views provide a group of shortcut keys to the same
following functions:

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 7
System Shell

Table 2-1: Toolbar Buttons

Button Action

Launches dialog to perform Backup operations (see “Performing


a Backup”)

Launches a dialog to perform Install operations (see


“Performing an Install”)

Launches the InspeXion IDE to edit the currently installed


Applications (see “Editing the Application”)

Launches the InspeXion RunTime to run the currently installed


Application (see “Running the Application”)

Launches the InspeXion System Setup utility to configure the


system (see “Launching the System Setup”)

Exits the SystShutting Down the System or Exitem Shell/


Shutdown the system (see “Shutting Down the System or Exit”)

Switches the current View Mode between the available views.


When the Shell is restarted it will resume with the View that was
showing when it was closed.

Sciemetric Instruments Inc.


8 Shell View Modes

Most button functions can also be activated by pressing the associated


function key on the keyboard.
This Help system can be accessed from the System Shell by pressing the
F1 Help key.

Mini Toolbar View


The Mini Toolbar view provides a compact toolbar. Due to the lack of
space, the Application Name is only shown on the Windows Taskbar
button for the System Shell.
Figure 2-1: Mini System Shell Toolbar

Toolbar Buttons

View Mode Button

InspeXion Version

Normal Toolbar View


The Normal Toolbar view has large buttons and text to make
navigation easy. This is the only toolbar view that is available on
systems Managed by System Shell. The Application name and version
as well as the InspeXion version are displayed below the toolbar
buttons.
Figure 2-2: Normal System Shell Toolbar

View Mode Button Application Title (Version) Toolbar Buttons InspeXion Version

Floating Toolbar View


The Floating Toolbar view is a stylized InspeXion “I” and waveform
with the embedded buttons.

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 9
System Shell

Figure 2-3: Floating I System Shell Toolbar

InspeXion Version

Toolbar Buttons

View Mode Button

Application Title
(Version)

Application Quick Load & Launch


The Application Quick Load and Launch view provides a quick
method to install and run any of the applications that have been
installed on the system that are valid to run with the current version of
the run-time. This includes:
• The currently installed active application (i.e. the one that will run
when the Run button is clicked) - shown in green.
• Internal backups - shown in magenta, these are the applications
that are included in backup files on the local system.
• Pre-installed Standard Applications - shown in cyan, these are the
applications that are pre-installed as part of InspeXion.
The buttons show:
• the Application icon (if configured)
• the Application description (if configured) or the file name of the
Application
• the Application version (in square brackets)
Clicking on any of the available buttons will automatically:

Sciemetric Instruments Inc.


10 Automatic Application Startup

1. if not the currently installed application, install the SBK file with
the following options:
– All Clear First options selected
– All Install options selected
2. launch the Application.

Figure 2-4: System Shell Quick Load and Launch

View Mode Button Installed Applications InspeXion Version Exit/Shutdown

Automatic Application Startup


If a valid application is installed and the system is configured to auto-
start (System Setup->Application->Start-up), a countdown starts in the
application title (the Windows Start-Bar text for the Mini System Shell
Toolbar). If no shell button is pressed before the countdown completes,
the application automatically runs.
If the application auto-start delay is set to zero (0), the System Shell is
not displayed on initial startup and the application launches
immediately.

Performing a Backup
The Backup option allows you perform three actions:

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 11
System Shell

• Backing up all or portions of the system to a System Backup file


(SBK) for archiving settings or transferring to another system (see
Backing Up the System).
• Archiving all or portions of the local History buffer as Single Part
History files (SPH) (see Archiving History Data).
• Extracting Rejected History files for manual repair (see Extracting
Rejected Part History Files).

To perform a backup function


1. Click the Back Up button (see Figure 2-5) or the F2 function key.
The Backup dialog opens (see Figure 2-12).
2. Select the backup type from the Type radio buttons.
Figure 2-5: Backup Button in System Shell Toolbar

Backing Up the System


The Backup option backs up selected portions of the system into a
single, compressed file. The file can be used to restore the configuration
of the system at a later time, or transfer the configuration to a different
system.
Note: The Backup does not collect all pertinent files if the application
uses non-system directories to store data or if the system uses third
party software that has configuration and/or data files. See
documentation for the specific application.
Table 2-2: Backup Components

Component Description

Application The currently installed application file.

Calibration Any locally stored sensor/effector calibration files.

Configuration Any configuration files stored to the configuration system directory.

Application Data Any data that the application has stored to the application data system directory.Note 1.

SPC Data Any data records stored to the local SPC repository and/or Q-DAS connector back log.Note 2

History Data Any data records stored in the local History Data repository.Note 2

System Setup System configuration settings, installed licenses and log files.

Note 1: Applications, while encouraged to use the system directories,


can store data files to any location on the system. This

Sciemetric Instruments Inc.


12 Performing a Backup

component will only backup files stored to the system


directories. See application documentation to determine if
other disk locations are used.
Note 2: SPC and History data are not allowed to be included in an
internal backup due to the potential size of the files. It is
possible to install backup files to the internal backup
directories that contain small SPC and History data using the
Save to Internal Backup option on the Install dialog (see
“Installing a System Backup File”).
Figure 2-6: Backup Dialog - Back Up

To perform a system backup


1. Select the Back Up radio button from the Type options. The Backup
dialog will change it’s apperarance as seen in Figure 2-6.
2. From the Location drop-down list, select one of the following:
• <Internal Backups> - stores the backup on the system in a local
backup directory [located in the Sciemetric\application\backup
sub-directory of the current users Documents and
Settings\Application Data folder]. Multiple backups can be
created on the system and are useful for quickly switching
between configurations.
Note: Because the SPC and History data are usually larger than the free
disk space remaining on the system, they cannot be included
in an internal backup.
Note: The Install Backup option has the ability to delete internal
backups.
• <Local Disks> (if Managed by Explorer Shell) - opens up file
browser to select the location to store the backup.
• <Network Places> - stores to a network location using the
network browser.

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 13
System Shell

• List of available disks (if Managed by System Shell) - stores to a


disk drive using file browser. Only removable disks (e.g USB
Memory Sticks) are available since the backup cannot reside on
the system (for local backup, use the <Local Internal> selection).
• <Recordable CD/DVD> - supports a writable CD or DVD if it is
enabled for Desktop CD recording (see File Explorer ->
Properties ->Recording to enable). Specify the File Name only in
the File text box. The backup file is always located in the root of
the CD so browsing is not allowed. The file is created in a
temporary staging area on the system then burnt to the CD.
3. For <Network Places>, <Local Disks> and available disks, select
the File to which to store the backup. Click to launch a browser
to select a file, or type the full path/filename in the File text box.
For Recordable CD/DVDs and <Internal Backups>, type the new
file to create in the File text box.
4. (Optional) In the Comment field, enter any additional information.
5. Use the Component Backup options to select the wanted system
information to add to the backup file. Any that are not selected
cannot be retrieved from the backup file (see Table 2-2).
6. Click the OK button to create the backup. A progress bar will show
the progress of creating the backup. When the backup is complete
the dialog will close, returning to the System Shell. If an error is
encountered, the backup file is not created, any temporary files are
removed and the error is presented.

Archiving History Data


This option extracts the local part history from the system as individual
file records. The files can be used for archiving purposes, and can be
viewed using the Part History Viewer or as text or as raw XML.
Figure 2-7: Backup Dialog - Archive History Data

Sciemetric Instruments Inc.


14 Performing a Backup

To archive history data


1. Select the Archive History Data radio button from the Type
options. The Backup dialog will change it’s apperarance as seen in
Figure 2-7.
2. From the Location drop-down list, select one of the following:
• <Local Disks> (if Managed by Explorer Shell) - opens up folder
browser to select the root directory to store the history files.
• <Network Places> - opens up folder browser starting at My
Network Places to select the root directory to store the history
files.
• List of available disks (if Managed by System Shell) - opens up
folder browser starting at the root of the local disk selected to
select the root directory to store the history files. Only removable
disks (e.g USB Memory Sticks) are available since the files
cannot be extracted on the system.
• <Recordable CD/DVD> - supports a writable CD or DVD if it is
enabled for Desktop CD recording (see File Explorer ->
Properties ->Recording to enable). The history files are always
located in the root of the CD so browsing is not required. The
files are created in a temporary staging area on the system then
burnt to the CD.
3. Select the directory to which to store the files. Click to launch a
browser to select a directory. The current selection is displayed in
the Directory text box.
Note: For a writable CD or DVD the files are stored in the root
directory.
4. The Comment box displays:
• the total number of History files that exist
• total size of the History files
• the Date/Time of the oldest available History file
• the Date/Time of the newest available History file
5. Configure the Part Selector to select which parts to archive and
how to arrange the files on the archived media:
• Status Selector - selects parts based on their overall :
•All: all parts.
•Pass Only: only parts that have a Pass status.
•Fail Only: only parts that have a Fail status (i.e. parts that
Failed at least one Feature check).
•Backlogged: only parts that are waiting to be stored to one or
more output connector (e.g. QWX, Q-DAS, Remote Store).

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 15
System Shell

• Sub Directories - selects how to arrange the part files in


subdirectories; select any combination of the following (or none
for no subdirectories) in the respective order:
•Day: a separate sub-directory for each calendar day (YYYY-
MM-DD).
•Model: a separate sub-directory for each Model type (uses
actual model type strings).
•Status: a separate sub-directory for Pass or Fail status (PASS/
FAIL).
• Range - selects a range of the available parts with the selected
Status to archive:
•All: all parts.
•Newest X: the newest X parts.
•Oldest X:the oldest X parts.
•Last X Hours: only parts that were stored in the last X hours
(from the current time).
•Last X Days: only parts that were stored in the last X calendar
days (first day is any parts stored on the current calendar day).
•Date Range: only parts that were stored on or between the start
and end calendar days.
6. Click the OK button to extract the history files. A progress bar will
show the progress of archiving the parts. When the backup is
complete a dialog will summarize the results of the archive process.
Closing this dialow will return to the System Shell.
The history data is extracted and stored to the specified location using
the following naming convention:
PartLabel_model_s/n_date[DDmmYYYY]_time[hh-mm-ss]

Note: Any pre-existing files are overwritten.

Extracting Rejected Part History Files


Part History records that are rejected by one or more connectors are
maintained on the system in the systems Reject directory (see System
Setup -> Connectors -> Common -> Reject/Submit Directory property
for the exact location of the directory on the local system). This option
exports these files to a selected external directory to:
• Clear the files from the system.
• Allow the files to be corrected using text and XML editors, and then
re-submitted (see Submitting Part History Files (.SPH)).

Note: This option is only available if there are rejected files on the
system.

Sciemetric Instruments Inc.


16 Performing a Backup

Figure 2-8: Backup Dialog - Extract Rejected SPH

To extract Part History files


1. Select the Extract Rejected SPH radio button from the Type
options. The Backup - Extract Rejected SPH dialog opens (see
Figure 2-8).
2. From the Location drop-down list, select
• <Local Disks> (if Managed by Explorer Shell) - opens up folder
browser to select the root directory to store the rejected files.
• <Network Places> - opens up folder browser starting at My
Network Places to select the root directory to store the rejected
files.
• List of available disks (if Managed by System Shell) - opens up
folder browser starting at the root of the local disk selected to
select the root directory to store the rejected files. Only
removable disks (e.g USB Memory Sticks) are available since the
files cannot be extracted on the system.
• <Recordable CD/DVD> - supports a writable CD or DVD if it is
enabled for Desktop CD recording (see File Explorer ->
Properties ->Recording to enable). The rejected files are always
located in the root of the CD so browsing is not required. The
files are created in a temporary staging area on the system then
burnt to the CD.
3. Select the directory to store the files to. Click to launch a
browser to select a directory, the current selection is displayed in
the File text box.
Note: for a writable CD or DVD the files is stored in the root
directory.
4. The Comment box displays the number of Rejected files that will be
extracted and the total size of the data.
Note: The size of the files on disk may be larger than reported due
to disk cluster size.

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 17
System Shell

5. Click the OK button to extract the rejected files and return to the
System Shell. The rejected files are extracted and stored to the
specified location using the following naming convention:
PartLabel_model_s/n_date[DDmmYYYY]_time[hh-mm-ss]
Note: Any pre-existing files are overwritten.

Performing an Install
The Install option allows you to perform seven options:
• install all or portions of a system backup file.
• install an application.
• create a new application (requires the IDE).
• clean-up local backups.
• install a newer version of the run-time software (only on embedded
systems - on non-embedded systems use Add/Remove Programs
in Control Panel).
• submit SPH data files to the History gateway and any enabled
output connectors (useful for re-submitting fixed rejected SPH data
files).
• clear portions of the local configuration, calibration or data files.

To perform an install function


1. Click the Install button (see Figure 2-9) or the F3 function key. The
Install dialog box opens (see Figure 2-12).
Note: if the System Setup password is enabled, a password dialog
will prompt for the correct password before this option will be
opened.
2. Select the Install type from the Type radio buttons.
Figure 2-9: Install Button in System Shell Toolbar

Installing a System Backup File


The Backup option backs up selected portions of the system into a
single, compressed file. This option can use that file to restore all or part
of the configuration to the system.

Sciemetric Instruments Inc.


18 Performing an Install

Figure 2-10: Install Dialog - Backup

To install a system backup file


1. Select the Back Up radio button from the Type options. The Install -
Backup dialog box opens (see Figure 2-10).
2. From the Location drop-down list, select from the following:
• <Standard Applications> - restores one of the standard
applications that was pre-loaded on the systems. Click the
Browse button to select a system backup from the standard
applications folder.
Note: Many of the standard applications require separate
licensing (use System Setup -> Application -> Licenses for
requesting and entering license information after the
application is installed).
• <Internal Backups> - restores one of the locally stored system
backup files; click the Browse button to select a specific file from
the local backup directory.
Note: Local Backup Cleanup - once a system backup file has
been selected, the option to delete this file from the system is
presented; click it and the file will be deleted.
• <Local Disks> (if Managed by Explorer Shell) - opens up file
browser to select the location to store the backup.
• <Network Places> - restores from a network location using the
network browser.
• List of available disks (if Managed by System Shell) - restores
from a disk drive using file browser. Only removable (e.g. USB
Memory sticks and CDs) and mapped network disks are
available.
3. For <Local Disks>, <Network Places> and available disks, select
the File from which to restore the backup. Click to launch a
browser to select a file, or type the full path/filename in the File
text box. For <Standard Applications> and <Internal Backups>,

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 19
System Shell

click the Browse button to launch a browser or type the name of the
file to restore in the File text box.
Note: if not installing from <Standard Applications> or <Internal
Backups> the Save to Internal Backups button will be available to
store the backup file to the internal backup directory directly
without the need to first install.
4. Press the Get Properties button to update the properties shown in
the Properties field (contains information about the selected
backup file).
Note: Properties are automatically updated when the file selection
dialog is closed with a new file. The Component Install options are
also updated based on the available information in the backup file.
5. Use the Component Install options to select the information
desired to be restored. Only those components that are available in
the backup file will be enabled (See Backup Components).
6. (Optional) Use the Component Clear First options to select any
pre-existing files from various components that need to be
removed prior to the install. See Installing a New Version of the
Run-Time Software below for details.
7. Click the OK button to restore the selected components and return
to the System Shell.
If installing the Application component over an existing
application, a warning dialog will indicate that the existing
application will be removed from the system (see Figure 2-11).
Only a single application can be installed on a system at any time. If
the existing application needs to be preserved, use the Backup (see
Backing Up the System) option to extract it from the system first.
Figure 2-11: Removing Application Warning Dialog

The system backup component also includes license codes for optional
licensed components:
• If the Unit ID matches the system that created the backup file - the
licenses will be restored if the System is restored

Sciemetric Instruments Inc.


20 Performing an Install

• If the Unit ID does not match, a dialog will be presented that


indicates what licensed components were on the backed-up system
that are not present in the current system (see Figure 2-12).

Figure 2-12: Missing Licenses Dialog

Removing Local Backups


To remove a local backup
1. Select the Back Up radio button from the Type options.
2. From the Location drop-down list, select <Internal Backups>.
3. Type the name of the local backup file to remove or click the
Browse button to launch a browser.
4. Review the Properties to ensure the correct file has been selected.
5. Click the Delete button beside the Browse button to remove the
backup file from the system. The File selection will be cleared.
6. Click the Cancel button to close the dialog or proceed with another
action.

Installing an Application
An application file can be installed onto a system to cause it to function
as a different instrument or to upgrade an existing instrument.

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 21
System Shell

Figure 2-13: Install Dialog - Application

To install an application
1. Select the Application radio button from the Type options. The
Install - Application dialog box opens (see Figure 2-13).
2. From the Location drop-down list, select from the following:
• <Local Disks> (if Managed by Explorer Shell) - opens up file
browser to select the application to install.
• <Network Places> - opens the network browser to select the
application to install.
• List of available disks (if Managed by System Shell) - opens up file
browser on the selected disk to select the application to install.
Only removable (e.g. USB Memory sticks or CDs) and mapped
network disks are available.
• <Create New Application> - creates a new blank application on
the system (see Creating a New Application below).
Note: only available if the IDE is installed and licensed.
3. Select the application file to install. Click to launch a browser to
select a file, or type the full path/filename in the File text box.
4. Press the Get Properties button to update the properties shown in
the Properties field (contains information about the selected
application file).
Note: Properties are automatically updated when the file selection
dialog is closed with a new file.
5. (Optional) Use the Component Clear First options to select any
pre-existing files from various components that need to be
removed prior to the install. See Clearing Component Files below
for details.
6. Click the OK button to restore the selected components and return
to the System Shell.

Sciemetric Instruments Inc.


22 Performing an Install

If installing the Application over an existing application, a warning


dialog will indicate that the existing application will be removed
from the system (see Figure 2-11). Only a single application can be
installed on a system at any time. If the existing application needs
to be preserved, use the Backup (see Backing Up the System) option
to extract it from the system first.

Creating a New Application


The System Shell has the ability to create a new blank application that
can be edited and run interactively using the main System Shell toolbar.
Note: This option is only available if the IDE is installed and licensed on
the system.
To create a new application
1. Select Application radio button from the Type options
2. Select <Create New Application> from the Location combo box.
3. Enter the file name for the new application in the File text box.
4. Click the OK button to create the new application.

Clearing Component Files


The System Shell has the ability to selectively restore portions of the
system/application to initial conditions by removing files for
components. This action can be performed as part of the Backup restore
or Application install procedures or it can be done independent of these
actions using the Clear Now button.
To clear component files
1. From the Install dialog, select either Back Up or Application radio
buttons from the Type options.
2. Select the component(s) to clear using the check-boxes in the Clear
First column of the Component options:
• Calibration - clears any sensor calibration files stored on the
system or calibration related files stored by the application to the
calibration system directory (see application documentation);
sensor calibrations will revert back to the original calibration
factors entered in the application at design time.
• Configuration - clears any configuration files stored by the
application to the configuration system directory (see
application documentation).
• Application Data - clears any data files stored by the application
to the data system directory (see application documentation).
• SPC Data - clears all data files associated with the SPC module.
Note: If you are restoring SPC Data from a system backup file,

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 23
System Shell

this option will be automatically selected because SPC data


cannot be merged and must be overwritten.
• History Data - clears all data files associated with the History
module (including any backlogged files and rejected files).
Note: If you are restoring History Data from a system backup
file, this option will be automatically selected because History
data cannot be merged and must be overwritten. (If you need
to merge history data, first archive the History data to be
merged from the system, next restore the History data from the
system backup and then submit the archived History data
using the Submit SPH file option.)
3. To clear the data without performing an Install operation, first click
the Clear Now button to clear the data files, then click the Cancel
button to exit the dialog.
4. To clear the data while performing an Install operation, click the
OK button. The clear operation is automatically processed before
the install starts.

Installing a New Version of the Run-Time Software


The run-time system may need to be upgraded from time to time to
enhance the system or apply patches. This option allows the installation
of upgrades, modification of installation options, repair of installed
components, or removal of the run-time.
Note: This option is available only on embedded Sciemetric Test
systems that are Managed by System Shell. For other systems use the
Add/Remove Programs option in Control Panel.

Upgrading to a New Version or Build


Navigate to the new install file and install it as per the instructions
below.

Modify Installation Options, Repair or Remove Run-Time


Navigate to the install file for the currently installed run-time version/
build. Launch the installer as per the instructions below and the
Modify/Repair/Remove options will be available for selection.

Reverting to a Previous Version or Build


First, the currently installed file must be un-installed (see above). After
the system has been re-booted, it will prompt for the new run-time
installation media.

Sciemetric Instruments Inc.


24 Performing an Install

Figure 2-14: Install Dialog - Run-Time

To install the Run Time


1. Select the Run Time radio button from the Type options. The
Install - Run Time dialog box opens (see Figure 2-14).
2. From the Location drop-down list, select from the following:
3. From the Location drop-down list, select from the following:
• <Local Disks> (if Managed by Explorer Shell) - opens up file
browser to select the file to install.
• <Network Places> - opens the network browser to select the file
to install.
• List of available disks (if Managed by System Shell) - opens up file
browser on the selected disk to select the file to install. Only
removable (e.g. USB Memory sticks or CDs) and mapped
network disks are available.
4. Select the installation File from which to install the run time. Click
to launch a browser to select an installation file, or type the full
path/filename in the File text box.
5. Press the Get Properties button to update the properties shown in
the Properties field (contains information about the selected
backup file).
Note: Properties are automatically updated when the file selection
dialog is closed with a new file.
6. (Optional) Use the Component Clear First options to select any
pre-existing files from various components that need to be
removed prior to the install. Optionally, the Clear Now option
button can be pressed to clear the files immediately (see Table 2-2).
7. Click the OK button to begin the installation process. The system
needs to be rebooted once the installation is complete. If the
installation fails, the system prompts with the option to restore to
factory, to restore the system to a known condition, or to restore the
selected components and return to the System Shell.

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 25
System Shell

Submitting Part History Files (.SPH)


This option allows Part History (.SPH) files, extracted using the Extract
Rejected Part History Files option (see Extracting Rejected Part History
Files on page 15), to be re-submitted to the system connectors for
storing to the connectors (e.g. QWX) that failed.
Note: Reject part files that are re-submitted and stored successfully
automatically cause the rejected part file on the system to be deleted if it
still exists.
This option can also be used to push archived history data collected
from a stand-alone system to one that has one or more connectors
enabled or to restore backlogged files from a system that has been
cleared. It can also be used as a portal to submit part files stored to a
Remote Store server, to a new QWX server.
Figure 2-15: Install Dialog - Submit SPH Files

To submit Part History files


1. Select the Submit SPH Files radio button from the Type options.
The Install - Submit SPH Files dialog box opens (see Figure 2-15).
2. From the Location drop-down list, select from the following:
• <Local Disks> (if Managed by Explorer Shell) - opens up file
browser to select the files to submit.
• <Network Places> - opens the network browser to select the
files to submit.
• List of available disks (if Managed by System Shell) - opens up file
browser on the selected disk to select the files to submit. Only
removable (e.g. USB Memory sticks or CDs) and mapped
network disks are available.
Note: A USB Memory Stick is supported if connected to the system
through a USB port before selecting the install option from the
main toolbar.

Sciemetric Instruments Inc.


26 Performing an Install

3. Select the File(s) from which to restore the backup. Click to


launch a browser to select one or more files.
4. The Properties field contains information about the selected files to
be submitted.
5. Click the OK button to submit the Part History files and return to
the System Shell.

Restoring Factory Settings


The disk overlay technology used on embedded Sciemetric Test
systems allows a system to be restored back to its base installed image
files.
Note: This option is available only on embedded Sciemetric Test
systems that use disk overlay technology.
Note: This option restores back to the base overlay level. For more disk
overlay options use the Overlay Manager in System Setup (System ->
Platform -> System Disk Overlay).
WARNING: All data will be lost. This option restores the system to the
exact condition in which the system was last imaged or had files
committed to the factory overlay level.
Figure 2-16: Install Restore to Factory Dialog

To restore factory settings


1. Select the Restore to Factory radio button from the Type options.
The Install - Restore to Factory dialog box opens (see Figure 2-16).
2. Click the OK button. The system prompts that the settings have
been restored. The system then prompts that a reboot is needed to
complete the restoration.
3. Click Yes to reboot the system.

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 27
System Shell

Editing the Application


If the system has the IDE installed and licensed, and the current
application is an editable application, the Edit option is available in the
Toolbar so that you can make changes to the installed application.
Figure 2-17: Edit Button in System Shell Toolbar

To edit the current application


1. Click the Edit button or the F4 function key. The IDE launches with
the current application.
2. Exit the IDE to return to the System Shell.

Running the Application


If a valid application is installed on the system, the Run button is
available in the Toolbar.
When the System Shell is first started, if the auto-start option is enabled
in System Setup->Application->Start-up, the application automatically
launches after the configured start delay. Clicking any option other
than Run before the start delay has passed, aborts the automatic start.
Figure 2-18: Run Button in System Shell Toolbar

To run the current application


1. Click the Run button or the F5 function key. The application
launches.
2. Close the application to return to the System Shell.

Launching the System Setup


The System Setup feature allows the configuration of system
parameters, such as passwords, history files, directory information,
connectors, hardware, and date and time.

Sciemetric Instruments Inc.


28 Shutting Down the System or Exit

Figure 2-19: Setup Button in System Shell Toolbar

To run System Setup


1. Click the Setup button or the F8 function key. System Setup
launches.
2. Close System Setup to return to the System Shell.
Note: If the System Setup password is enabled, a password dialog
prompts for the correct password before this option is opened.

Shutting Down the System or Exit


The functionality of the Shutdown or Exit button changes depending
on the system.
Figure 2-20: Shutdown/Exit Button in System Shell Toolbar

When the Shell is running on an embedded Sciemetric System, when


the Shutdown button or the F10 function key is pressed, the operator
now has the option to
• Shutdown - shuts down all applications and powers down the
system
• Restart - shuts down all applications and reboots the system
• Cancel - cancel the Shutdown command

When the System Shell is running on other systems, pressing the Exit
button or the F10 function key closes the Shell application.

Restart on RunTime Critical Stop


When you are running the Shell on an embedded Sciemetric System
and a critical stop of the InspeXion Run-Time is detected, the following
actions take place:
• The system log file is copied to the file LastCriticalStop.log in the
RunTime log directory to ensure the logging information for the
critical stop is not overwritten the next time the system starts.

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 29
System Shell

• If the error did not occur during initial system initialization the
system is automatically rebooted so that the startup application re-
starts with a clean system.

Sciemetric Instruments Inc.


30 Shutting Down the System or Exit

Sciemetric Instruments Inc.


31

Index
A I
Application, 11 Installing a System Back Up File, 17
Application Data, 11 Installing an Application, 20
Application Quick Load & Launch, 9 Internal Backups, 18
Archiving History Data, 13
Automatic Application Startup, 10
L
Launching the Shell, 6
B license, 19
Backup Components, 11 Local Backup Cleanup, 18

C M
Calibration, 11 Managed by Explorer Shell, 6
Clearing Component Files, 22 Managed by System Shell, 6
Configuration, 11 Mini Toolbar View, 8
Creating a New Application, 22
Critical Stop, 28
N
Normal Toolbar View, 8
E
Editing the Application, 27
Exit, 28 P
Part Selector, 14

F
Floating Toolbar View, 8 Q
Q-DAS, 11

H
History Data, 11 R
Rejected Part History Files, 15

Sciemetric Instruments Inc.


32

Removing Local Backups, 20


Repair, 23
Restoring Factory Settings, 26
Running the Application, 27
Run-Time, 23

S
Save to Internal Backups, 19
setup
system shell, 5
Shell View Modes, 6
Shutting Down, 28
SPC Data, 11
Standard Applications, 18
Submitting Part History Files, 25
System Backup, 11
System Setup, 11, 27
System Shell, 5

T
Toolbar Buttons, 7
Toolbar Views, 6

U
Uninstall, 23
Upgrading, 23

V
View Mode, 7

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 33
Index

Sciemetric Instruments Inc.


34

Sciemetric Instruments Inc.


Integrated Development Environment (IDE) 35
Index

Sciemetric Instruments Inc.


36

Sciemetric Instruments Inc.


InspeXion User Guide
Issue 2, October 2008
Describes v6.3

All information and specifications contained in this document are subject


to change without notice and do not represent a commitment on behalf of
Sciemetric Instruments Inc., Canada. No part of this document may be
transmitted, reproduced, or used in any form or by any means,
mechanical or electronic, including photocopying, without the express
written permission of Sciemetric Instruments Inc., Canada.

© Sciemetric Instruments Inc. All Rights Reserved.


Printed in Canada.
InspeXion®, Sigmeter®, QualityWorX®, and the Sciemetric logo are
registered trademarks of Sciemetric Instruments Inc. All rights reserved.
Other product names in this document may be trademarks or registered
trademarks of their respective companies and are the sole property of
their respective owners.

Sciemetric Instruments Inc.


360 Terry Fox Drive,
Ottawa, Ontario, Canada, K2K 2P5
Phone: 1.613.254.7054 or 1.877.581.0112 (Service) Fax:1.613.254.5313
Email: support@sciemetric.com (Service) inquiries@sciemetric.com (Sales)
Web: www.sciemetric.com

You might also like