SampleManager User Guide
SampleManager User Guide
User Guide
Version 12.2
© 2019 Thermo Fisher Scientific Inc. All rights reserved.
Thermo Fisher Scientific Inc. provides this document to its customers with a product purchase to use in
the product operation. This document is copyright protected and any reproduction of the whole or any
part of this document is strictly prohibited, except with the written authorization of Thermo Fisher
Scientific Inc.
The contents of this document are subject to change without notice. All technical information in this
document is for reference purposes only. System configurations and specifications in this document
supersede all previous information received by the purchaser.
Thermo Fisher Scientific Inc. makes no representations that this document is complete, accurate, or
error-free and assumes no responsibility and will not be liable for any errors, omissions, damage, or
loss that might result from any use of this document, even if the information in the document is
followed properly.
This document is not part of any sales contract between Thermo Fisher Scientific Inc. and a purchaser.
This document shall in no way govern or modify any Terms and Conditions of Sale, which Terms and
Conditions of Sale shall govern all conflicting information between the two documents.
Contents
Preface ..................................................................................................................... vii
Related Documentation ................................................................................ vii
Special Notices............................................................................................. viii
Contacting Us.............................................................................................. viii
Preface
Thermo Scientific™ SampleManager LIMS™ software can plan, manage, and maintain an
accurate record of work performed in a laboratory environment. The SampleManager
LIMS software incorporates Laboratory Information Management (LIMS), Data
Management (SDMS), and Process Execution and Procedural Electronic Lab Notebook
(LES) capabilities in a single solution.
This manual demonstrates the features of SampleManager LIMS that you are most likely
to use on a daily basis.
Contents
• Related Documentation
• Special Notices
• Contacting Us
Related Documentation
SampleManager includes Help, manuals, and guides as PDF files.
With the SampleManager client running, you can access Help in the following ways:
• Press the F1 key.
• From the main menu bar at the top of the SampleManager window, choose Help
and then click Contents.
• Click a Help button.
Special Notices
Make sure that you follow the precautionary statements presented in this guide. The
special notices appear in boxes.
Contacting Us
There are several ways to contact Thermo Fisher Scientific for the information you need.
Email [email protected]
Web https://support.thermoinformatics.com/contacts
Introduction
SampleManager is a Laboratory Information Management System (LIMS). It is designed
to maintain an accurate record of work carried out in a laboratory environment.
Contents
• SampleManager Overview
• Using SampleManager
• Background Information
• Logging In to SampleManager
• Changing the SampleManager Fonts
• Changing the SampleManager Skin
SampleManager Overview
SampleManager is a highly adaptable system, which is configured to reflect the working
practices in an individual laboratory. When SampleManager is first installed, all the
information necessary to model the work performed in the laboratory must be entered
into the database. For example:
• Analytical procedures
• Locations in the laboratory
• Personnel working in the laboratory
Feature Description
Using SampleManager
To use SampleManager, you must have a user account. Your system administrator will
set up your account and give you the login name and password that you can use to log in
to SampleManager (page 5) for the first time.
The security settings of your user account control the records that you can access and the
processing options that are available to you. If your user account does not grant you
access, you cannot perform some of the operations described in this manual. If your
account does not grant access to records or options, they are not visible.
Background Information
This section describes some useful background concepts.
System Components
A SampleManager system has the following major components:
• SampleManager Client is installed on each workstation that is used to connect to the
SampleManager server. Use the SampleManager Client to view, process, and manage
the information stored in the database.
• A database stores all the data about your laboratory and the samples it processes. A
single site often maintains several separate databases. For example, a Production
database to hold the genuine data, a Training database for teaching new personnel to
use the LIMS, and a Development database for creating and testing new static data
records before they are implemented in the Production system.
• SampleManager Server handles the connection between the client and the database.
This program also processes the information within the database.
Types of Data
There are two kinds of data held in SampleManager:
• Static data
• Dynamic data
Static Data
Static data is information stored in the database that describes your laboratory
environment, its standard operations, and other supporting information that might be
relevant when processing samples. Examples of static data include:
• Analyses – Analytical procedures carried out by your laboratory.
• Operators – Personnel who work in the laboratory
• Locations – Places that are referred to in sample records. These places can be storage
or testing locations within the laboratory.
When your SampleManager system is first set up, all the static data required to describe
the laboratory and its standard operations is entered. This data must be maintained so
that it always reflects the current state of the laboratory, with appropriate records being
added, modified, or removed as required.
Note The term "removed" has a special meaning in SampleManager. When a record
is removed, it is not deleted from the database, as a missing record would cause
problems when other records refer to it. Instead, the removed record is flagged to stop
it being assigned to any new records.
Dynamic Data
Dynamic data is information stored in the database that relates to the work performed in
the laboratory. All dynamic data has a lifecycle – it is entered, processed, and completed.
Standard lifecycles for the various types of dynamic data are shipped with
SampleManager. The workflow functionality can be used to create custom lifecycles that
meet the requirements of an individual laboratory.
Logging In to SampleManager
To log in to the SampleManager database, you must have the following information
from your system administrator:
• Your username
• Your password
• The name of the server that you should connect to
You can change your password after you have logged in.
To log in to SampleManager
OR
From the Windows Start menu, select All Programs > Thermo SampleManager >
SampleManager.
4. Make sure that the Server setting matches the SampleManager server that you want
to log in to.
5. To log in, click OK. When your user information has been verified, the main
SampleManager window appears. An alert showing the date and time that your user
account logged in to its previous SampleManager session appears in the lower left
corner of the SampleManager window.
To log in to the SampleManager database using a Smart Client connection, you must
have the following information from your system administrator:
• Your username
• Your password
• The name of the server that you should connect to
• The URL of the Smart Client that starts your SampleManager session
You can change your password after you have logged in.
To log in to SampleManager
Your browser opens the Smart Client URL. The browser window closes after the
required information has been downloaded. The Launching Application window
appears. This window closes when the Smart Client has finished comparing your
current Smart Client with the Smart Client on the server.
Figure 1-3. Launching Application window
If the Smart Client on the server has been updated, the Required Update for
SampleManager window appears and the new version of the Smart Client is
installed.
When the latest version of the Smart Client is installed, the SampleManager Login
window appears.
Figure 1-5. SampleManager Login window
4. Make sure that the Server setting matches the SampleManager server that you want
to log in to.
5. To log in, click OK. When your user information has been verified, the main
SampleManager window appears. An alert showing the date and time that your user
account logged in to its previous SampleManager session appears in the lower left
corner of the SampleManager window.
Figure 1-6. Last login alert
1. From the main menu, select Setup >System > Users > Change Password.
The Change Your Password dialog box appears.
Figure 1-7. Change Your Password dialog box
Logging Out
To log out of SampleManager, close the main SampleManager window, or select File >
Exit from the main menu.
To lock a session
The Session Locked dialog box appears and SampleManager locks the session.
Figure 1-8. Session Locked dialog box
2. To unlock your session and continue working, enter your password and click
Resume.
Reconnecting to SampleManager
The Reconnect option closes and then restarts SampleManager. The new session starts
with the login information supplied for the original session.
If updates have been applied to the SampleManager server, your system administrator
might ask you to reconnect.
To reconnect to SampleManager, from the main menu, select File > Reconnect.
To change the current user, from the main menu, select File > Change User.
If the current font does not contain all the characters required for your preferred
language, SampleManager does not render text correctly. To resolve this problem,
change the SampleManager Font settings to one or more fonts that contain the
characters for your language.
Note SampleManager stores font settings on each workstation for the combination
of your Windows user account and the SampleManager server that you are currently
connected to.
The Font Select window sets the font and font size used for text in the following
areas of the user interface:
• Explorer – The Explorer and forms created using the SampleManager Form
Designer
• Menu – The main menu system
• VGL – SampleManager windows and dialog boxes created using the VGL
programming language
• Text editor – Text files
2. To change the font used for an area, click Change. A Font dialog box appears.
3. Select a font and a size. SampleManager does not use the Font style setting.
4. To close the Font dialog box, click OK.
5. When you have set all the fonts you require, click OK to save your settings.
1. From the main menu, select View > Select Fonts. The Font Select window appears.
2. Click Default.
3. Click OK.
• SampleManager Contrast – A dark skin with high contrast colors. This skin is
particularly useful for users with weaker eyesight that may otherwise have trouble
distinguishing different parts of the screen.
Figure 1-11. SampleManager using the SampleManager Contrast skin
• SampleManager Legacy – This skin runs efficiently on older machines and uses
elements from the native Windows operating system, so this skin may look slightly
different on different machines.
To change the SampleManager skin, from the main menu, select View > Appearance >
[Skin]. The SampleManager window updates to show the selected skin.
User Interface
This chapter describes the main components of the SampleManager user interface, and
some of the ways that the interface can be used to help you manage and process your
data.
Note System administrators and users who have appropriate security permissions can
configure many features of the user interface, such as the menu structure and toolbars.
See the SampleManager LIMS Configuration Guide or the online help for more
information.
Contents
• SampleManager Window
• Locating Data
• Grouping Data
• Filtering Data
• Copying Data into Other Applications
• Exporting Data
• Printing Data
• Browsing
• Keyboard Shortcuts for SampleManager Desktop
Client
SampleManager Window
The following figure shows the main SampleManager window. Use this window to
locate, sort, and filter your data. You can copy the data shown in the Explorer and export
it to a range of other applications, or print it as a simple report.
Figure 2-1. SampleManager window
Menus
The menus contain most of the options available to you for working with
SampleManager and the data it contains. The menu options that you can see depend on:
• The security settings in your user account. You can only see menu options for tasks
you are allowed to perform.
• The configuration of the SampleManager system that you are currently logged in to.
A system administrator can remove menu options that are not required, or add new
menu options for tasks specific to a particular laboratory. It is also possible for a
system administrator to change the structure of the menu system.
If you do not see the menu items that you expect, contact your system administrator.
Toolbars
The toolbars provide quick access to frequently performed tasks. See the online help or
the SampleManager Configuration Guide for instructions on customizing the toolbars to
your own requirements.
Navigator
The Navigator shows the data in SampleManager, organized as a tree. The Navigator
synchronizes with the Explorer – when you open an item in the Navigator, the Explorer
display updates to show the contents of that item. Likewise, if you open an item in the
Explorer, the currently selected item in the Navigator changes to match your selection.
Data Structure
The Navigator and Explorer use the following hierarchy to organize the data:
• Cabinets hold groups of related folders. For example, the General cabinet holds
folders for the main types of dynamic data in the system.
• Folders contain records from a single database table, such as the SAMPLE table.
When a folder is opened, it can either display the records it contains in the Explorer,
or open a form in place of the Explorer. Forms linked to folders normally display a
graphical summary of the data in the folder. For example, the following screenshot
shows the Stock Dashboard folder, which is linked to a form that shows a summary
of the remaining quantity of each stock.
Figure 2-2. Folder with a linked form
• Subgroups are used to organize folders that contain many records, such as the folders
for the dynamic data tables. Subgroups divide the records in the folder into groups
based on the value of one or more fields. Like folders, when subgroups are opened
they can either display the data that they contain, or open a form in place of the
Explorer.
The following screenshot shows the default set of subgroups for the Samples folder in the
General cabinet. The Status by Login Date subgroup is expanded. This subgroup
contains one first-level node for each status currently assigned to at least one sample in
the database. The status nodes then contain a further set of nodes corresponding to the
login dates for samples with that status. When the login date node is expanded, the
sample records are shown.
Figure 2-3. Navigator hierarchy
• In the Navigator, click the Refresh icon that appears by the currently selected
cabinet, folder, or subgroup. This option rebuilds the current level and its parent
level.
Explorer
The Explorer lets you locate, view, and work with data. Navigation is performed using
the left mouse button and the buttons on the main toolbar. Right-click to see options for
working with the data that is currently displayed or selected.
The Explorer only displays data that your user account permits you to access. If you
cannot see data that you think should be available to you, contact your system
administrator.
1. Right-click the column header row and select Runtime Column Customization.
The Customization dialog box appears. The Customization dialog box lists all the
columns that are not currently displayed in the Explorer.
Figure 2-4. Customization dialog box
2. Drag the desired column from the Customization dialog box to the desired position
on the column header row.
Figure 2-5. Adding a new column
1. Right-click the column header row and select Runtime Column Customization.
Reordering Columns
To change the position of a column, drag the column header to the desired position.
For example, the Samples > Open Samples menu option opens a new page in the
Explorer pane that contains sample records.
Figure 2-6. Samples > Open Samples menu option
The Setup > Laboratory > Analyses > Open Analyses menu option opens a new page in
the Explorer pane that contains analysis records.
Figure 2-7. Setup > Laboratory > Analyses > Open Analyses menu option
The page created by the Open option behaves like the Explorer, but it is not
synchronized with the Navigator. You can group, filter, and sort records in the same way
as in the Explorer. You can also right-click selected records to process them using the
pop-up menu.
Quick Launcher
The quick launcher lets you search for functions, tables, entities, and areas in
SampleManager. You can search for specific or ambiguous terms, and master menu
items. New searches appear as new pages in the Explorer.
To show or hide the quick launcher, from the main menu, select View > Quick
Launcher.
If you search for a specific term, the function or area searched for appears. For example,
if you search for "server management" the Client Server Manager window appears.
If you search for a more ambiguous term, the Explorer updates to show a list of master
menu items related to the search term.
Figure 2-9. Explorer showing the suggested master menu items for the search term
"server"
2. Searches for records that match the search string. The table or view that is searched is
determined by the search string prefix. Quick Launcher supports the following
search string prefixes:
• @<search_string> – SampleManager searches the description field of the
MASTER_MENU table for values that contain the specified string. If the search
returns any records, SampleManager opens a new page in the Explorer that
contains all the matching records. For example, @hazard opens a new page that
contains all the master menu items that contain hazard.
• t:<table_name> – Searches for a table or view. SampleManager opens a new
page in the Explorer that contains all the records in the table or view. For
example, t:sample opens a new page that contains all the records in the SAMPLE
table.
3. Searches the description field of the MASTER_MENU table for values that contain
the specified string. If the search returns any records, SampleManager opens a new
page in the Explorer that contains all the matching records. For example, hazard
opens a new page that contains all the master menu items that include the string
hazard in the description field.
Custom Commands
You can use aliases to create custom quick launch commands that can be executed by the
quick launcher. Add your custom quick launch commands to the Quick Launch
Customization alias.
Figure 2-10. Explorer showing the Quick Launch Customization alias
If you prefix the alias output with an exclamation mark (!), the command is executed
when the search runs.
For example, if you specify an alias with LOAD DATA as the input, and !grl
$table_loader as the output, when you enter LOAD DATA in the quick launcher the
Load Database Table from File window appears.
For more information about aliases, see the Data Extraction chapter in the
SampleManager LIMS Configuration Guide.
Tasks Panel
The Tasks panel provides access to commonly performed tasks. It is context-sensitive and
displays tasks appropriate to the type of data currently displayed in the Explorer. Like the
menu system and the toolbars, the Tasks panel only displays options that your user
account lets you perform.
Web Workspace
The web workspace (formerly known as the Active Desktop) is a browser that can display
HTML files such as:
• Pages from the internet
• Pages from your intranet
• Specially written HTML pages that let you access common SampleManager
functions
Each user has a designated "homepage", which is displayed on any SampleManager client
that they use to connect to the SampleManager database.
To open the web workspace, from the main menu select View > My Workspace.
The four example pages supplied with SampleManager show the default lifecycles for
lots, jobs, samples, and tests. The Login Links section above the status flow diagram
contains links that initiate the standard SampleManager windows for creating the
appropriate type of item.
The number in each status box shows the number of items currently at that status.
Status Bar
The Status Bar shows information about the SampleManager session.
Figure 2-11. Status Bar
Locating Data
The information shown in the Navigator and Explorer is organized in a hierarchy of
sections, cabinets, folders, and subgroups. The Navigator and Explorer synchronize, so
the selection of a new location in one affects the contents of the other.
Figure 2-12. Navigator
The main toolbar contains buttons that change your current location in the hierarchy:
• Forward – Retrace your steps after using the Back button. This button
becomes active after you use the Back button.
• Up – Go up one level
Selecting Data
When you have located the items that you want to work with, you must normally select
the items before you can perform any work on them.
Grouping Data
The Explorer lets you group the data in a folder according to the values in one or more
columns. Grouping can be used to locate data, and to organize information in the layout
desired for copying, printing or exporting.
The Grouping function can be used to divide the records in the Explorer into subsets
based on the values in a specific column. In the following example, samples have been
grouped according to the project that they are assigned to.
Figure 2-13. Samples Grouped by Project Id
You can view and modify the grouping applied to a folder using the Group By Box. The
Group By Box appears above the column header row at the top of the Explorer.
Figure 2-14. Group By Box
To display the Group By Box, right-click the column header row and select Show Group
By Box.
To hide the Group By Box, right-click the column header row and select Hide Group By
Box.
To group data by a column, drag the column header into the Group By Box, or
right-click the column header and select Group By This Field.
To remove grouping from a folder, right-click a column header and select Clear
Grouping.
You can drag column headings within the Group By Box to change the order of the
grouping.
Figure 2-15. Reordering the grouping
You can group data by more than one column. In the following example, the sample
records are grouped by project and customer.
Figure 2-16. Samples grouped by Project Id and Customer
You can collapse individual groups within the Explorer to let you focus on the data of
interest.
Figure 2-17. Collapsed and expanded groups
Filtering Data
You can filter the data shown in the Explorer to display only records that match specific
criteria.
1. Hover over the header of the column you want to filter. The Filter button
appears in the top right corner of the column header. To open the filter options list,
click the Filter button.
Figure 2-19. Filter List
The filter options list displays all the values that appear in the column, and the
following additional options:
• (All) – Removes any filter that has been applied to the column.
• (Custom) – Apply a custom filter to the column
• (Blanks) – Filters the data to show only those records where the column is left
blank
• (Non Blanks) – Filters the data to show only those records where the column is
not blank
If you selected the (Custom) option, the Custom AutoFilter dialog box appears.
Figure 2-20. Custom Auto Filter dialog box
You can create filter criteria that match one of the following forms:
• field name <relational operator> value
For example, "Project id equals GAMMA"
• (field name <relational operator> value) AND (field name <relational
operator> value)
For example, "(Priority is greater than 1) AND (Priority is less than 5)"
• (field name <relational operator> value) OR (field name <relational
operator> value)
For example, "(Status equals C) OR (Status equals A)"
If necessary, you can repeat the process with other columns to build up a complex
filter.
When you apply a filter to a column, the Filter button is displayed in the column header
with a blue highlight.
The filter expression is shown in the filter bar at the bottom of the Explorer.
Figure 2-21. Explorer with filtering on two columns
To clear the filtering on a single column, click the Filter button on the column
header and select (All) from the list.
To remove filtering from all the columns, click the button on the filter bar.
To remove the filter temporarily, clear the check box on the filter bar.
3. In the Find panel, enter the text you want to find into the text box. As you enter
each character, the records in the Explorer are filtered so that only matching records
appear. The text entered in the Find panel is highlighted in each record.
Figure 2-22. Find panel in the Explorer with filtered records
To copy data
1. If necessary, modify the folder columns (page 20) so that the information you
require is displayed.
4. Open the destination file and use the Paste command to paste the data to the desired
location.
The following example shows the raw data as it appears when copied into a Word
document.
Figure 2-24. Raw data as pasted into a Word document
In a Word document, you can use the Text to Table option to convert the
tab-separated data into a table.
Figure 2-25. Data converted into a table in Word
Exporting Data
You can use the Export function to export all of the data shown in the Explorer to one of
the following formats:
• Excel
• CSV
• Rich Text Format (RTF)
• PDF
• Single web page file (MHT format)
When you export data from the Explorer, the column headings, and any group headings,
are automatically included.
Note If the folder has a default report assigned, then the report is generated in the
specified format when one of the export buttons is clicked. The generation of the
default report overrides the export of the current folder contents.
To export data
1. If available, use the Runtime Column Configuration option to display the required
columns in the Explorer.
2. Use the grouping, sorting and filtering functions to display the data you are
interested in.
3. In the toolbar, click the button for the required export format:
• Excel
• CSV
• Document
• PDF
• Web Page
Note You can also export the contents of the Explorer to Excel by pressing Ctrl +
F12.
4. The data is exported to your chosen format and you can manipulate it as required.
Figure 2-26. Exported data used in an Excel file
Printing Data
The Print function prints the data currently shown in the Explorer.
Note If the folder has a default report assigned, then the report is generated and
opens in the Preview window when you click the Print button. The generation of the
default report overrides the standard Print function.
2. To add any desired header or footer text, follow the instructions in Adding Headers
and Footers (on page 39).
4. If you want to add a watermark to your document, follow the instructions in Adding
a Watermark (on page 41).
5. To send the whole document to the default printer defined on your system, click the
Quick Print button, .
Alternatively, click the Print button, to open the standard Print dialog box, so
that you can select a specific printer, set the number of copies, and select a range of
pages to be printed.
The Header and Footer of the document each contain three sections: left, center,
and right. You can add text to each of these sections by entering information in the
corresponding text box.
You can also add the following information to any of the header or footer sections
using the toolbar buttons:
• Page # of Pages # – Inserts a page number of the format "x of y" where x is
the current page number and y is the number of pages in the document.
• User Name – Inserts the operating system user name of the user logged in
to the workstation
• Image – Inserts an image. To select the image you require, click the down
arrow beside the button. The images in the list are stored in the
Exe\Resource\Image directory on the SampleManager server.
2. You can control the vertical alignment of the text in the header and footer using the
following buttons:
• Align Tops – The top row in each section aligns with the top of the header
or footer area
• Align Middles – The center row in each section aligns with the center of
the header or footer area
• Align Bottoms – The bottom row in each section aligns with the bottom
of the header or footer area
3. To change the appearance of the text in the header and footer, click in the Font
prompt.
4. To update the Preview display with your header and footer settings, click OK.
Adding a Watermark
To add a watermark to your document
2. To add a text watermark, on the Text Watermark page, enter the desired text in the
Text field.
You can use the remaining fields on the Text Watermark page to control the
appearance of the text.
3. To add a graphical watermark, on the Picture Watermark page, click Browse and
select the desired graphic file.
You can use the remaining fields on the Picture Watermark page to control the
position and appearance of the graphic.
Figure 2-30. Watermark window showing the Picture Watermark page
4. Use the Page Range controls to specify whether the watermark appears on all pages,
or a subset of pages.
5. Use the Position controls to define whether the watermark appears in front of the
text in the document, or behind it.
To remove a watermark
Browsing
The browse function helps you to enter valid information when you are prompted for
one of the following:
• The name or identity of a record
• A date
• A time
• An interval
You can access a Browse window from within a prompt in the following ways:
Note In forms created using the form designer, the <F2> shortcut key and the
pop-up menu are only available when browsing for a record identity.
If you enter a value into a prompt that links to a static data table, you can enter either the
name or the identity of the required record.
When you select the item, the Browse window closes and the prompt you browsed on is
filled with the selected entry.
If the number of valid entries for the prompt is large, the Browse window shows a subset
of the valid records. To display more items, use the following buttons:
You can also right-click and select More, or press the F6 key.
To add an item in a Browse window to your favorites list for that type of item, right-click
the item and select Add to Favorites.
To apply a filter
2. Right-click the column and value that you want to use for your filter and select
Filter by Selection >[desired filter].
Figure 2-32. Applying a filter
The display is refreshed to show the items that match the filter. The column used for
the filter is displayed with a colored background.
Figure 2-33. Browse window with Filter by Selection applied
Filter by selection commands are cumulative, so you can refine the search further by
selecting other column and item combinations and adding further Filter by Selection
statements.
To remove this type of filtering, in the grid, right-click, and select Filter by Selection >
Clear.
Note You can use selection criteria to build a more sophisticated SQL statement. See
the SampleManager Reference Manual, or the online help for details.
You can sort and group the records in the browse list in the same way as in the Explorer
grid. See Grouping Data (page 29) for more information.
The menu includes all of the available saved criteria for selecting records from the table
that you are browsing on. If you select a saved criteria from the menu, the criteria is used
to filter the browse list for the prompt when you use the browse function.
Note The selection criteria applies to the prompt until you close the form.
If the prompt does not have any criteria, then your default
criteria for the table is opened for modification.
Default Applies your default saved criteria for the table to the
prompt.
Ctrl + F1 Help Editor If the HELP_EDITOR configuration item is set to Yes, this shortcut
opens the Help Editor window. This window lets you edit the
context-sensitive help assignments for the active control.
Shift + F2 Zoom Displays the contents of a VGL prompt in a text box. This feature is
useful when the text in the prompt is too long to display in the
available space.
F3 Context-dependent Standard VGL window – Shows the list of options that appears when
(see Action column) the Options button on the current window is clicked.
F6 Context-dependent VGL browse list, VGL explorer grid – Load more records.
(see Action column)
VGL criteria editor – Removes the selected line in the criteria grid.
F7 Recent Items Displays a list of recently used items of the type required by the current
prompt.
F8 Criteria Opens the selection criteria that apply to the current prompt.
F9 Build (Add, Modify, or Calls the Build function to add, modify, or display a record in the static
Display mode) data table associated with the current prompt. In VGL windows, this
shortcut also lets you copy a record.
For more information, see "The Build Function" in the "Toolbars and
Menus" chapter in the SampleManager LIMS Configuration Guide.
Alt + F9 Build (Copy mode) Calls the Build function to copy a record in the static data table
associated with the current prompt. This shortcut applies in forms
created using the Form Designer.
For more information, see "The Build Function" in the "Toolbars and
Menus" chapter in the SampleManager LIMS Configuration Guide.
F12 Print Takes a screenshot of the currently active window or Explorer and
opens it in the Print Preview window.
Shift + F12 Export to Excel Exports the current contents of the Explorer to Excel.
Ctrl + F12 Document the current Opens the Document window, which lets you generate a document
window that describes the controls in the window that currently has focus. See
the "Auto-Generated Documentation" chapter in the SampleManager
Form Designer Manual.
Ctrl + Shift Context-dependent While opening an Explorer folder – Resets columns to the default
(see Action column) settings.
Spacebar Toggle check box value If the current control is a check box, this shortcut toggles the check box
value between the selected and cleared states.
Alt + Enter OK In a VGL window, saves changes and closes the current window.
Ctrl + D Propagate Down In a VGL grid, propagates the value of the current field down to the
next field of the same type.
Ctrl + R Propagate Right In a VGL grid, propagates the value of the current field to the next field
of the same type on the right.
Ctrl + E Run Opens the Run dialog box, which lets you run a menu option or VGL
report.
Ctrl + P Print Report In the Report Preview window, prints the report.
Ctrl and click Exit Ignore error In an Error window, ignores the error and continues SampleManager
button execution instead of restarting SampleManager.
Samples
This chapter describes how samples are used in SampleManager to help you manage the
items processed in your laboratory.
Contents
• Introduction
• Identifying Samples
• Default Sample Lifecycle
• Sample Status Values
• Sample Login with Sample Templates
• Assigning Tests
• Sample Login with Workflows
• Displaying Samples
• Modifying Samples
• Processing Samples
Introduction
A sample is an item that has been sent to the laboratory for testing. In the
SampleManager database the information associated with a sample is organized as
follows.
Figure 3-1. Sample, Test, and Result structure
The sample record contains the details about the sample. For example:
• The type of sample
• The customer who sent it
• The location where the sample is stored
A test is created when a specific analysis is assigned to a specific sample. Tests can be
assigned when a sample is logged in, or added later. The test record stores information
about the test, such as the instrument and operator.
Samples in SampleManager are dynamic data and have a lifecycle. A sample is recorded
in the database, tested, has results entered for associated tests, is authorized, and then
stored for future reference. See Default Sample Lifecycle (described on page 54) for more
information.
A sample in the laboratory can often be processed as part of a group of related samples.
SampleManager offers the following features that can be used to group related samples in
the database for ease of data entry and retrieval:
• Jobs – A job is used to link samples with common features. When a job is processed,
the statuses of all the samples in the job are modified automatically.
• Worksheets – A worksheet lists tasks to be carried out in the laboratory. Worksheets
can be used to group a set of samples that all require the same test or preparation.
• Batches – Batches are a specialized form of worksheet. They offer support for quality
control procedures. They provide a way of linking samples to QC standards that
Identifying Samples
At login, each sample is assigned two unique identifiers that are generated automatically:
• Id Numeric is a number, up to ten digits long, obtained from a counter. Each time a
sample is logged in, the counter increments by 1 and the new value is used as the Id
Numeric for that sample.
• Id Text is a text string generated from a set of instructions stored in a syntax record.
The Id Text for a sample can be up to 30 characters long and can include
information about the sample, such as the login date.
Figure 3-2. Id Numeric and Id Text of samples in the Explorer
Either the Id Numeric or Id Text can be used when SampleManager prompts for a
sample identity. The following example shows an Id Text entered in a sample prompt.
Figure 3-4. Sample prompt showing an Id Text
When the user enters the Id Text, the system locates the corresponding sample record
and updates the prompt entries in the dialog box to show both the Id Numeric and Id
Text.
Figure 3-5. Sample prompt showing an Id Numeric and Id Text
Note All samples in SampleManager are associated with a sample lifecycle workflow,
which defines the data collection and processing stages in the laboratory. The default
sample lifecycle represented in the diagram is shipped with SampleManager. Your
SampleManager implementation might use one or more custom sample lifecycles to
handle different types of samples within your laboratory.
Login
Samples are recorded and given unique numeric and textual Ids. Preparations, tests, and
test schedules are assigned.
The possible status values that can be assigned to a sample at login are:
• U (Unreceived) – Sample has been logged in before it has arrived at the laboratory.
• H (On Hold) – Sample is being held pending further information.
• W (Awaiting Preparation) – Sample requires preparation before tests can be
performed.
• V (Available) – Sample is available for testing.
Preparation
The sample might undergo a preparation stage before it is released for testing.
Testing
The tests assigned at the login stage are performed on the sample.
Result Entry
The results of the tests are entered into the database.
Inspection
This stage applies if an inspection plan was assigned to the sample at login. The
personnel included on the inspection plan inspect the sample and its results. Each
inspector can either approve or reject the sample.
When the sample is submitted for inspection, the status changes to I (Inspection). It
remains at this status until:
• All the personnel on the inspection plan approve the sample. When the last person
approves the sample, the status changes to A (Authorised).
OR
• One person rejects the sample. The status changes to R (Rejected).
Authorization
The sample and its results are authorized or rejected. No further processing of the results
is possible.
Status values:
• A (Authorised) – The sample has been authorized.
• R (Rejected) – The sample has been rejected. Samples can only be rejected during
the Inspection phase of the lifecycle.
Data Storage
The sample is moved out of the active database and put into the committed database.
From the committed database, you can move it to long-term storage in archive files.
Status Description
C Complete All results have been entered for every test assigned to the
sample, and all of its subsamples have a status of Complete,
Inspection, Rejected, Canceled, or Authorized. If the
sample, or one of its subsamples, is assigned any further
tests, the status of the sample reverts to V.
Status Description
A Authorised The sample has been authorized. All tests and results
associated with it are automatically authorized. No
alteration of authorized data is possible, however the
sample can be reactivated to add further tests.
E Expired The sample is a retain sample with a Retain Until Date that
is earlier than the current date. Expired retain samples can
be disposed of. See "Retain Samples" in the SampleManager
LIMS Reference Guide for more information.
The following diagram summarizes the basic login process. Your SampleManager system
might be configured to perform extra steps, such as printing sample labels, during the
login process.
Figure 3-7. Sample Login process
If you log in samples using sample templates, when SampleManager is first configured
for your laboratory, a sample template should be defined for each type of sample that
your laboratory normally handles. Unusual samples can be logged in using the Blank
template, which contains all the available fields for samples.
1. From the Login Setup Folders cabinet, open the Sample Templates folder.
The Explorer shows all the sample templates that your user account gives you access
to.
2. Right-click the desired sample template and select Login Sample.
3. The Samples Logged In window appears. This window tracks the progress of your
login session. Set the number of samples to log in with this template in the Repeat
Count field.
Note If you leave the Repeat Count value at 0, then you can continue logging in
samples with the template until you choose to terminate the process.
Figure 3-8. Samples Logged In window at start of session
4. To log in your first sample, click Login. If the template is configured to allow you to
view or edit the fields in the sample record, the sample window appears.
Figure 3-9. Sample window
The Samples Logged In field shows how many samples have been logged in so far
during the current session.
The lower area of the window shows the fields that are displayed or prompt for
information in the sample template.
5. Enter the desired information. If a field has a ">" symbol after the name, you must
enter a value for that field.
6. Click Login. If the template is configured to allow the tests to be edited, and your
user account allows you to edit the tests on a sample, the Edit Tests window appears.
Figure 3-10. Edit Tests window
See Assigning Tests (page 63) for more information about this window.
8. The sample and its associated tests are created. If you have not logged in all the
samples specified by the repeat count, or the repeat count is set to 0, then the sample
window appears for the next sample. Repeat steps 5–7 until you have logged in all
your samples for the current template.
To terminate the login session, click Close on the sample window.
9. When the number of samples logged in is equal to the repeat count, or you click
Close on the sample window, you return to the Samples Logged In window. The
window shows all the samples logged in during the current session.
Figure 3-11. Samples Logged In window
Assigning Tests
In SampleManager, a test is an analysis that has been assigned to a specific sample.
Tests are normally assigned to a sample at login, but the Edit Tests window can be used
to add or modify the tests on an existing sample. To open the Edit Tests window,
right-click the sample in the Explorer and select Login > Edit Tests.
When you log in a sample with a sample template, you can use the following methods to
assign tests to a sample:
• Add individual analyses to the Edit Tests window (page 63).
• Add test schedules to the Edit Tests window (page 65). A test schedule is a list of
analyses that are normally performed together.
• Specify a test schedule in the sample record. If the Test Schedule field of the sample
contains the identity of a test schedule, the standard analyses in that test schedule are
assigned to the sample.
• Specify a work profile as part of the sample details. A work profile includes a test
schedule and a set of limit information that apply to the test results. If a work profile
is assigned to a sample, you must not assign any other test schedules to that sample.
See the SampleManager LIMS Reference Guide or help for more details.
1. In the Edit Tests window, click an empty cell In the Analysis ID column. The
Browse button appears in the cell.
Figure 3-12. Using the Browse button to locate an analysis
The Browse on Analyses window closes and the selected analysis appears in the
Analysis ID column of the edit tests window.
4. If the analysis has component lists, you can optionally select a component in the List
column.
Component lists restrict the results required for a test to a subset of the results
defined for the full analysis.
5. In the Instrument Category column, you can optionally specify the class of
instrument used to perform the test, for example a balance, GC, or refractometer.
6. In the Instrument Type column, you can optionally specify the instrument template
entity that represents the model of instrument used to perform the test.
If the Instrument Category column contains a value, the browse list contains
instrument templates that belong to the specified instrument category.
7. In the Instrument column, you can optionally specify the instrument used to
perform the test.
If the Instrument Category column contains a value, the browse list contains
instruments that belong to the specified instrument category. If the Instrument Type
column contains a value, the browse list contains instruments that are based on the
specified instrument template. If both the Instrument Category and Instrument
Type columns are empty, the browse list contains all available instruments.
8. In the Operator column, you can optionally specify the person who performs the
test.
9. In the Count column, set the number of times the test is to be performed.
10. In the Priority column, set the priority of the test (1 is the highest priority, 999 the
lowest).
Figure 3-14. Final test details
1. Click the Add Test Schedule button . A browse window appears that contains a
list of test schedules.
The browse window closes and the analyses from the test schedule you selected
appear in the Edit Tests window.
3. In the Assign column, select the check box for the analyses that you want to assign
to the sample and clear the check box for the analyses that you do not want to assign.
If an analysis is a standard part of the test schedule, the Std column contains Y and
the Assign check box is selected by default
4. Set the other properties of each analysis as described in Adding an Analysis to the
Edit Tests Window (page 63).
5. To assign the selected tests to the sample, click OK.
To assign a test schedule to the sample, the Test Schedule field must be included in the
fields defined in the sample template.
In the following example, the SOILTESTS test schedule has been added to the Test
Schedule field on the sample. When the Edit Tests window is opened, the analyses on
the test schedule are automatically included in the screen.
Figure 3-16. Sample with a test schedule included in the sample record
In the following example, several of the analyses in the test schedule have the Std column
set to "No". This designation is used when an analysis is not always required for the types
of sample that the test schedule is designed for. These analyses do not have the check box
in the Assign column selected by default. Tests for these analyses are only created for the
sample if the user selects the appropriate Assign check boxes before clicking the OK
button.
Figure 3-17. Analyses from the test schedule added to the Test Editor
In the previous example, tests corresponding to the following analyses are assigned to the
sample when the OK button is clicked:
• EST_TEXTUR
• SOILPH
• SMP_BUFFER
• BRAY1PHOS
• EX_POTASS
• LOSS_IGNIT
Note Samples can be logged in using sample templates, instead of workflows. See
Sample Login with Sample Templates (page 59) for more information.
If you log in samples using sample login workflows, when SampleManager is first
configured for your laboratory, a sample login workflow should be defined for each type
of sample that your laboratory normally handles.
The diagram shows the process for logging in a sample using a sample login workflow.
The following procedure gives basic instructions for logging in samples using a sample
login workflow. For more information, see the SampleManager LIMS Reference Guide.
3. Select the desired workflow and enter the number of times that you want to run the
workflow.
The maximum value for the number of times the workflow should run is 1000.
Figure 3-19. Add Sample Workflow dialog box
5. On the Sample Data page, enter the details for each sample. The information shown
for each sample depends on the entity template assigned to the sample.
If a cell has a yellow background, you must enter a value before you can log in the
sample.
6. On the Test Data page, edit the details of the tests assigned to the samples. The
information required depends on the entity template assigned to the analysis each
test is based on.
Figure 3-21. Sample Workflow Login window Test Data page
7. To edit the list of tests assigned to each sample, click Test Assignment. If the check
box for a test is selected for a sample, the test is assigned to the sample when the
sample is logged in.
Figure 3-22. Sample Workflow Login window Test Assignment page
Displaying Samples
The display options for samples allow you to view the details of samples that have been
logged in. All the information shown for each sample is read-only.
To display a sample in the Display Sample Entry window, right-click the sample in the
Explorer and select Login > Display Sample. The Display Sample Entry window appears.
Figure 3-23. Display Sample Entry window
To display a sample in the Display Full Sample window, right-click the sample in the
Explorer, select Login > Display Full Sample. The Display Full Sample window appears.
Figure 3-24. Display Full Sample window
To open the Sample Admin window, right-click the desired sample in the Explorer and
select Workflow Login > Display. The Sample Admin window appears. The information
for each sample and test is displayed using the settings defined in the entity template that
created the data.
Figure 3-25. Sample Admin window
If you try to display samples that were logged in using a sample template in the Sample
Admin window, an alert appears in the lower right corner of the main SampleManager
window. The alert lists each sample that was logged in with a sample template. To
display the samples that are listed in the alert, select Samples > Login > Display Sample
from the main menu.
Figure 3-26. Entity Templates alert
Modifying Samples
The modify options for samples allow you to edit the details of samples that have been
logged in.
1. In the Explorer, right-click the sample and select Login > Modify.
2. In the properties grid, edit the values of any properties, and click OK.
1. From the main menu, select Samples > Login > Modify Full Sample.
The Modify Full Sample window appears.
Figure 3-28. Modify Full Sample window
4. In the properties grid, edit the values of any properties, and click OK.
1. In the Explorer, right-click the sample and select Workflow Login > Modify.
The Sample Admin window appears. The information for each sample and test is
displayed using the settings defined in the entity template that created the data.
Figure 3-31. Sample Admin window
If you try to modify samples that were logged in using a sample template in the Sample
Admin window, an alert appears in the lower right corner of the main SampleManager
window. The alert lists each sample that was logged in with a sample template. To
modify the samples that are listed in the alert, from the main menu, select Samples >
Login > Modify Sample.
Processing Samples
The Process submenu for samples contains various options that allow you to manipulate
samples. These options can:
• Change the status of the sample. For example, the Complete Preparation option
changes the status of a sample from W (waiting for preparation) to V (available).
• Change the value of a field in the sample record. For example, the Move Sample
option changes the Location field value.
• Change the database location used to store the sample. For example, the Commit
Sample option moves a sample record from the Active Database to the Committed
Database.
The Process menu options that are available for a sample depend on the status of that
sample. For example:
• The Complete Preparation option is only available for samples with a status value of
W.
• The Commit Sample option is only available for samples with a status of A, R, or X.
Many of the Process operations can be performed on a group of selected samples. For
example, you can select several samples with status W, then use the Complete
Preparation option to update all of their status values to V in a single operation.
The following figures show the process menu options for samples at various statuses, and
for a group of samples of different statuses.
Figure 3-33. Process menu for samples where Status=S
See the SampleManager LIMS Reference Guide or online help for details about each of the
Process menu options.
Processing a Sample
Each of the Process options is used in the same way. The figures in the following
procedure use the Move option as an example.
1. In the Explorer, select one or more samples, right-click and select the desired option
from the Process submenu.
Figure 3-37. Choosing the Move option
Contents
• Relationship Between Analyses, Samples, and Tests
• Identifying and Locating Tests
• Locating Tests in the Explorer
• Default Test Lifecycle
• Test Status Values
• Processing Tests
• Identifying and Locating Results
• Types of Result
• Result Status Values
• Entering Results
The following figure shows the Test Editor for a sample being logged in. The
LOSS_IGNIT analysis has been assigned with a Count value of 3, meaning that three
replicates must be performed.
Figure 4-2. Assigning three replicates of an analysis to a sample
The following figure shows the Edit Tests window for the same sample, after the tests
have been created. The "/1", "/2" and "/3" suffixes distinguish the three replicates of the
LOSS_IGNIT test.
Figure 4-3. Tests LOSS_IGNIT/1, LOSS_IGNIT/2, and LOSS_IGNIT/3 on the sample
Note All tests in SampleManager are associated with a test lifecycle workflow, which
defines the data collection and processing stages in the laboratory. The default test
lifecycle represented in the diagram is shipped with SampleManager. Your
SampleManager implementation might use one or more custom test lifecycles to
handle different types of test within your laboratory.
Assignment
Tests can be assigned to a sample at login, or at any stage up to authorization. Tests are
unavailable if the sample they are assigned to is either On Hold (H), Unreceived (U), or
Waiting for Preparation (W). When the sample becomes Available (V), the test status is
automatically updated to either Available (V) or Waiting for Preparation (W).
The possible status values for a test when it is first created are:
• U (Unavailable)
• V (Available)
• W (Waiting for Preparation)
Possible actions:
• Tests with a status of Available (V) can be completed early, without entering results.
The status changes to Complete (C).
• Tests can be suspended at any stage up to authorization. The status changes to
Suspended (S). Suspended tests cannot be processed until they are reactivated.
• Tests can be canceled at any stage up to authorization. The status changes to
Cancelled (X).
Preparation
A test might contain a preparation step, which must be completed before the test is
performed. When the preparation has been completed, the test status changes to V
(Available).
A test that is undergoing a preparation step has a status of W (Waiting for Preparation).
Possible actions:
• The preparation can be completed, either by using the complete preparation option,
or by completing a test preparation worksheet. The status changes to Available (V).
• Tests can be suspended at any stage up to authorization. The status changes to
Suspended (S). Suspended tests cannot be processed until they are reactivated.
• Tests can be canceled at any stage up to authorization. The status changes to
Cancelled (X).
Result Entry
You can enter results as soon as they are obtained. When you enter the first result, the
test status changes from V (Available) to P (In Progress). After all results are entered, the
status changes to C (Complete).
The possible status values for a test while results are being entered are:
• P (In Progress)
• C (Complete)
Possible actions:
• Tests with a status of In Progress (P) can be completed early, without entering all the
results. The status changes to Complete (C).
• Tests can be suspended at any stage up to authorization. The status changes to
Suspended (S). Suspended tests cannot be processed until they are reactivated.
• Tests can be canceled at any stage up to authorization. The status changes to
Cancelled (X).
Completion
After all results for a test are entered, the status automatically changes to C (Complete).
Tests can also be completed early, without all the results being entered.
Possible actions:
• Tests can be suspended at any stage up to authorization. The status changes to
Suspended (S). Suspended tests cannot be processed until they are reactivated.
• Tests can be canceled at any stage up to authorization. The status changes to
Cancelled (X).
Authorization
When a test is Complete (C), it can be authorized. The status changes to Authorised (A)
and no further processing of the results is possible. When a test is authorized, all results
in that test are automatically authorized.
Processing Tests
The Process submenu for tests contains various options that allow you to change the
status of the test record. For example, the Suspend option changes the status of the test
to Suspended (S).
The Process options can be performed on a group of tests that have been selected in the
Explorer.
To process tests
1. In the Explorer, select a test or tests, right-click and select the desired option from
the Process submenu.
The window for your chosen option appears.
The Explorer updates to show the tests associated with the selected sample.
The Explorer updates to show the results associated with the selected test.
Figure 4-7. Results for selected test
The Sample Review window appears showing all the selected samples, with their
associated tests and results.
Figure 4-9. Sample overview tree for selected samples
Types of Result
SampleManager can store the following types of result.
Numeric N A number
The words used to represent the True and False values are
defined in the analysis and copied to the true_word and
false_word fields in the RESULT table. The text and
raw_result fields in the RESULT table contain the text
string that corresponds to the Boolean value obtained. The
value field contains 0.0000000000000000E+00.
Unentered U An empty result that has not yet had a value entered.
Modified M The value of the result has been changed after it was saved
to the database.
Cancelled X The sample or test linked to the result has been canceled.
If a result has not been saved to the database since being entered or modified, the status
will display a * beside it. For example E* indicates that the result has been entered, but
not saved. If the screen is closed without saving the result, then the result will "roll back"
to its previous status and value.
Entering Results
There are several methods of accessing results for entry, display, or authorization,
designed to reflect working patterns in the laboratory. Each method accesses a different
range of tests and results.
This manual describes the Result > Entry by Sample(s) option, available in the Explorer.
See the SampleManager LIMS Reference Guide, or the help, for a description of other
methods of result entry.
Result Windows
The Result windows in SampleManager are highly configurable. The appearance of the
window and the controls that are shown can be modified using configuration items.
Refer to the SampleManager LIMS Configuration Guide for a description of the various
configuration items and their effects. The following figure shows a typical result entry
window.
Figure 4-10. Typical Result Entry window
Toolbar
The result entry toolbar gives access to common result entry functions, such as
Recalculate, Ad Hoc Result, and Read from Instrument.
Note When using SampleManager Web, the Read Instrument button on the
result entry toolbar is not present. The functionality performed by this button is not
supported due to a security limitation of the supported web browsers.
The buttons displayed on the toolbar depend on the configuration settings and on the
operations you are allowed to perform. In some SampleManager systems, you might see a
series of buttons down the right side of the window instead of a toolbar.
The nodes in the sample and test tree show the following information:
• Sample nodes – The ID text of the sample, followed by the ID numeric in
parentheses.
• Test nodes – The name of the analysis that the test is based on, followed by a /
character and the replicate number of the test. If you do not have access to the group
that is assigned to the analysis, SampleManager shows the analysis identity instead of
the name.
If your SampleManager instance is configured to support multiple languages and the
name field in the VERSIONED_ANALYSIS table is translatable, SampleManager
shows the value of the language-specific name field for the language assigned to your
personnel record. For more information about translating text in the user interface
and database, see "Localizing the SampleManager Interface" in the SampleManager
LIMS Configuration Guide.
The limits for each level included in the product are shown on the graph.
Figure 4-14. Graph for current result
The Result Entry window appears. The Result Entry area has a tabular layout. Each
component occupies one row of the table.
Figure 4-16. Result Entry window for a single sample
3. In the Value column, enter the result for each component. It is not necessary to enter
all the results for a sample in a single session. The type of entry required depends on
the value in the Type column:
• N – Enter a numeric value. The system might format the raw value that you
enter, for example rounded to a certain number of decimal places. The settings
of the analysis associated with the test determine the formatting of the value.
• T – Enter text.
• B – Select a value from the drop-down list.
• F – Use browse to select a file.
• C – Select a value from the drop-down list.
• D – Use browse to set a date or time value.
4. If the results have a status value of E*, you must click the Commit to Database
button to save the values to the database. When the result values have been
recorded in the database, the results have a status of E.
5. When you have entered and saved all the results for the current session, close the
window.
The Result Entry window appears. The Result Entry area has a spreadsheet layout.
Each component occupies a column in the spreadsheet and each sample is a row.
Figure 4-17. Result Entry window for multiple samples
It is not necessary to enter all the results in a single session. See Entering Results for a
Sample on page 104 for a description of the entry required for each type of result.
4. If the results have a status value of E*, you must click the Commit to Database
button to save the values to the database. When the result values have been
recorded in the database, the results have a status of E.
5. When you have entered and saved all the results for the current session, close the
window.
Modifying a Result
If you change a result after it has been saved, for example due to a typing error, its status
will be changed to M* (modified but not saved). To save the modified result, click the
Commit to Database button. If you do not save the modified result, when you close the
window the result "rolls back" to its previous status and value.
Note Your system administrator might have restricted your ability to modify results
that have been saved.
1. In the Result Entry window, position the cursor in the Value field for the
component that you would like the ad hoc result to appear above.
Figure 4-19. Adding an ad hoc result above the antimony component
4. Select a result type. If there are any parameters that must be defined for that result
type, the relevant fields appear.
Jobs
This chapter describes how jobs are used in SampleManager to help you group samples
in your laboratory.
Contents
• Introduction
• Identifying Jobs
• Default Job Lifecycle
• Job Status Values
• Job Login with a Job Template
• Job Login with Workflows
• Displaying Jobs
• Displaying the Samples, Tests and Results for a Job
• Modifying Jobs
• Processing Jobs
Introduction
Jobs are used to group a set of related samples so that they can be processed together.
You can use a job to generate preparation and analysis worksheets for the samples as a
group. Using jobs facilitates sample processing, result entry, and reporting.
Figure 5-1. Example Job, Sample, Test, Result hierarchy
Identifying Jobs
Each job has a unique name that is used to identify it within the SampleManager
database. The name can be:
• Generated automatically at login by a set of instructions called a syntax.
• Generated automatically by adding a unique number to the job template name used
to log in the job.
• Entered manually by the user who logs in the job.
The job template used to log in the job to the database determines the method used to
name a job.
Figure 5-2. Jobs in the Explorer
If a sample is associated with a job, the job name appears in the Job Name field of the
sample record.
Note All jobs in SampleManager are associated with a job lifecycle workflow, which
defines the data collection and processing stages in the laboratory. The default job
lifecycle represented in the diagram is shipped with SampleManager. Your
SampleManager implementation might use one or more custom job lifecycles to
handle different types of samples within your laboratory.
During this stage of the lifecycle, jobs can have the following status values:
• V (Available)
• C (Complete)
The job status automatically updates to Complete (C) when all its samples have a
status value of Complete (C), Authorised (A), or Cancelled (X).
Authorization
You can authorize a job when it has a status of Complete (C). Authorization of a job
authorizes all the samples, tests, and results associated with it.
Data Storage
For storage, jobs and their associated samples are moved out of the active database and
into the committed database. From the committed database, they can be moved to
long-term storage in archive files.
Possible actions for jobs that have been consigned to data storage:
• Return a job from the committed database to the active database using the
Deconsign option.
• Move jobs from the committed database into an archive file.
Available V Some of the samples in the job have results that have not
been entered yet.
Cancelled X The job is canceled. Canceling the job gives all samples in
the job a status of Canceled (X).
Authorised A The job has been authorized. When a job is authorized, all
the associated samples are automatically authorized.
The following procedure describes the general method for logging in samples using a job
template.
1. In the Login Setup Folders cabinet, open the Job Templates folder.
The job templates that are available to you appear in the Explorer.
5. To log in the first sample, click Login. If the sample template requires you to enter
any details, the Sample window appears.
Figure 5-8. Sample window
7. If you are required to assign tests to the sample, the Test Editor window appears.
Figure 5-9. Test Editor window
9. Repeat the sample login steps until you have logged in all the samples.
When all the samples have been logged in, the Samples Logged In window appears,
showing the details of the new job and the samples it contains.
1. In the Explorer, right-click a job and select Login > Add Samples.
The Samples logged in window appears. The lower area of the window displays the
samples that are associated with the job.
Figure 5-12. Samples logged in window
2. In the Sample template field, browse for the sample template to use to log in the
samples.
3. In the Repeat Count field, set the number of samples to log in to the job.
If the sample template requires you to enter any details, the Sample window appears.
Figure 5-13. Sample window
If you are required to assign tests to the sample, the Test Editor window appears.
Figure 5-14. Test Editor window
When all of the samples have been logged in, the Samples logged in window appears,
showing the details of the job and the samples it contains.
Figure 5-15. Samples logged in window
If you log in jobs using job login workflows, a job login workflow should be defined for
each type of job that your laboratory normally handles. The job login workflows are
developed as part of the initial configuration of SampleManager for an individual
laboratory. Job login workflows can be created or updated at any time by an operator
with the necessary security permissions.
The following diagram shows the process for logging in a job using a job login workflow.
Note When you log in jobs using a workflow, the job, sample, and test records are
created together at the end of the login process.
The procedure in this section describes the basic process for logging in one or more jobs
using a job login workflow. See the Jobs chapter in the SampleManager LIMS Reference
Guide for more information.
3. Select the workflow that you want to use, and enter the number of times that you
want to run the workflow.
The maximum value for the number of times the workflow should run is 1000.
6. To edit the details of the samples assigned to the jobs, click Sample Data. The
information shown for each sample on the Sample Data page depends on the entity
template assigned to the sample.
If a cell has a yellow background, you must enter a value before you can log in the
sample.
7. To edit the details of the tests assigned to the samples, click Test Data.
Figure 5-20. Job Workflow Login window – Test Data page
8. To edit the list of tests assigned to each sample, click Test Assignment.
Figure 5-21. Job Workflow Login window – Test Assignment page
9. To complete the workflow, click Apply. The job, sample, and test records are
created in a single transaction.
Displaying Jobs
When you display a job you can view all the data contained in that job, including
samples, tests, and results.
This section describes a display method that works for all jobs. If a job was logged in
using a workflow, you can display the job in the Sample Admin window. To open the
Sample Admin window, in the Explorer, right-click a job and select Workflow Login >
Display. See the SampleManager LIMS Reference Guide for more information.
To display a job
The Samples Logged in window appears showing all the samples in the job.
Figure 5-23. Samples logged in window
3. To display a sample record, right-click the sample and select Login > Display.
Modifying Jobs
If a job was logged in using a job template, the information in the job_header record can
be modified using the Modify Job Header window.
This section describes a modification method that works for all jobs. If a job was logged
in using a workflow, you can modify the job in the Sample Admin window. To open the
Sample Admin window, right-click a job in the Explorer and select Workflow Login >
Modify. See the SampleManager LIMS Reference Guide for more information.
To modify a job
1. Right-click the job in the Explorer and select Login > Modify.
The Modify Job Header window appears. The list of fields in the lower area of the
window depends on the fields defined in the job template used to log in the job.
Figure 5-25. Modify Job Header window
Processing Jobs
The Process submenu for jobs contains various options that allow you to manipulate
jobs. These options can:
• Change the status of the job. For example, the Complete option changes the status
of a job from V (available) to C (complete). When you change the status of a job,
you automatically change the status of all samples, tests, and results associated with
that job.
• Change the database location used to store the job and its samples. For example, the
Commit with Samples option moves a job and its associated samples, tests, and
results from the active database to the committed database.
The Process menu options that are available for a job depend on the status of that job.
For example:
• The Complete option is only available for jobs with a status value of V.
• The Commit with Samples option is only available for jobs with a status of A, R, or
X.
Many of the Process operations can be performed on a group of selected jobs. For
example, you can select several jobs with status V, then use the Complete option to
update all of their status values to C in a single operation.
See the SampleManager LIMS Reference Guide or help for details about each of the
Process menu options.
Processing a Job
Each of the Process options is used in the same way. The screenshots in this section show
the Suspend option, which updates the status of jobs to Suspended (S).
3. If you are prompted for any information, enter the required values.
4. To update the jobs, click OK.
Static Data
This chapter describes the standard operations available for working with static data.
For a full description of all the types of static data within a standard SampleManager
system, see the SampleManager LIMS Reference Guide or help.
Contents
• Introduction
• Identifying Static Data
• Static Data Windows
• Standard Operations for Static Data
• Attachments
Introduction
Static data is information stored in the database that describes your laboratory
environment, its standard operations, and other supporting information that might be
relevant when processing samples. When your SampleManager system is first set up, all
the static data required to describe the laboratory and its standard operations must be
entered. This data must be maintained so that it always reflects the current state of the
laboratory, with appropriate records being added, modified, or removed as required.
Note The term "removed" has a special meaning in SampleManager. When a record
is removed, it is not deleted from the database, as a missing record would cause
problems when other records refer to it. Instead, the removed record is flagged to stop
it being assigned to any new records.
The Name field contains a longer descriptive name for the record. Names are
case-sensitive and can contain spaces and non-alphanumeric characters. If the
PROMPT_USE_NAMES configuration item is "Yes", then the name, rather than the
identity, appears in prompts that reference the record. The Point Location prompt in the
following figure shows the name of the location record linked to the BOTTLE_FIN
sample point.
Figure 6-1. Sample Point property sheet showing name of linked location
The type of window that is used depends on the type of static data you are working with,
and on the configuration of your SampleManager system.
Property Sheets
Property sheets are used for all static data types introduced from SampleManager 10
onwards. If your system administrator chooses to use the property sheet rather than the
Laboratory Table Editor, property sheets might also be used for other commonly used
types of static data. The following figure shows a typical property sheet.
Figure 6-2. Typical property sheet
A property sheet always has a General page that contains basic information about the
record. The record identity appears at the top of the General page, beside the entity icon.
The following fields are common to most static data types and normally appear on the
General page:
• Name – A descriptive name for the record. Names are case-sensitive and can contain
spaces and non-alphanumeric characters.
• Description – The long description of the record that appears in Browse windows.
• Group – You can use this option to restrict use of the record to members of a
particular group. If the Group field is blank, then any user whose account allows
them to access static data of that type can see the record. If a group is specified, then
only those users who are members of the group can see the record.
• Modified On – The date and time when the record was last saved.
• Modified By – The identity of the user who last saved the record.
• Modifiable – You can use this option to control whether users can modify the
record after it has been saved for the first time. If the Modifiable check box is
selected, then any user whose account allows them to modify records of that type can
change the record. If the Modifiable check box is cleared, only users with
system-level authority can make changes.
A property sheet can have further tabs to the right of the General page that contain
information specific to that type of static data.
Many property sheets have a Details page. This page lets you view and edit a text file
linked to the record.
The LTE layout has the following standard fields at the top:
• Identity – The unique identity of the record
• Modified On – The date and time when the record was last saved
• Modified By – The identity of the user who last saved the record
The remaining fields appear in the lower half of the window. The following fields are
common to most types of static data:
• Name – A descriptive name for the record. Names are case-sensitive and can contain
spaces and non-alphanumeric characters. The name of a record must be unique in
the database table that stores that record.
• Group – Restricts use of the record to members of a particular group. If the Group
field is blank, then any user whose account allows them to access static data of that
type can see the record. If a group is specified, then only those users who are
members of the group can see the record.
• Description – The long description of the record that appears in Browse windows.
• Modifiable – Controls whether users can modify the record after it has been saved
for the first time. If the Modifiable field is set to Yes, any user whose account allows
them to modify records of that type can change the record. If the field is set to No,
only users with system privilege 9002 (Allow access to data marked as
non-modifiable) can change the record.
An LTE window can have extra buttons that open other windows so you can define data
that is associated with the record defined in the LTE. For example, the Fields button on
the Template Data Entry window opens the Fields for Sample Template window.
• Remove – Flags the record as unavailable for use. Removed records are not normally
displayed in the Explorer or Browse windows.
• Restore – Restores a previously removed record, which makes it available for normal
use. This option is only available for removed items.
For example, to add a hazard open the Hazards folder, right-click and select Hazard
> Add.
Figure 6-5. Select the Add menu option
To copy a record
To modify a record
For example, to modify a sample point, right-click the sample point and select
Sample Point > Modify.
Figure 6-8. Select the Modify option
The appropriate property sheet or LTE appears showing details of the selected
record.
To display a record
2. In the Explorer, right-click the record that you want to view and select Display from
the submenu for the current entity type.
For example, to view an MLP Level, right-click the MLP Level and select MLP
Level > Display.
The appropriate property sheet or LTE window appears showing the selected record.
All the fields are read-only.
To print a record
3. To send the whole document to the default printer defined on your system, click the
Quick Print button, .
Alternatively, click the Print button, to open the standard Print dialog box, so
that you can select a specific printer, set the number of copies, and select a range of
pages to be printed.
2. In the Explorer, right-click and select List from the submenu for the current entity
type.
For example, to list units, right-click a unit and select Unit > List.
3. To send the whole document to the default printer defined on your system, click the
Quick Print button, .
Alternatively, click the Print button, to open the standard Print dialog box, so
that you can select a specific printer, set the number of copies, and select a range of
pages to be printed.
To remove a record
For example, to remove a sample point, right-click the sample point and select
Sample Point > Remove.
Figure 6-14. Select the remove option
To restore a record
The Removeflag field on the record is set to False and the Explorer refreshes. The
record is now available for use.
Attachments
Many static data property sheets have an Attachments page that shows the list of text
notes, files, and URLs associated with the entity.
Note When an entity has one or more attachments, the icon specified by the
HAS_ATTACHMENT_OVERLAY_ICON configuration item appears as an overlay
on the entity icon in the Explorer. The default icon overlay is a yellow note icon .
The upper pane lists all the attachments for the entity. To see all versions of each
attachment, click the Display All Saved Versions button .
The lower pane displays the text of the currently selected text note. To show or hide the
lower pane, click the Toggle Comments Panel button .
To open an attachment
File attachments and links open in the appropriate application. Text notes appear in
the Note Attachment dialog box.
Figure 6-17. Note Attachment dialog box
1. Click the Add a Text Note button . The Note Attachment dialog box appears.
Figure 6-18. Note Attachment dialog box
4. To restrict access to the note to members of a specific group, select the group. If the
Group prompt is empty, all users can access the note.
5. Enter the text of the note in the text box. You can right-click in the text box and
select formatting options to apply to your text.
1. Click the Add Link to File/Web Page button . The Link Attachment dialog box
appears.
Figure 6-19. Link Attachment dialog box
2. In the Link field, enter the URL of a web page or browse for the file path.
1. Click the Upload File to the SampleManager Server button . The File
Attachment dialog box appears.
Figure 6-20. File Attachment dialog box
The default storage location for file attachments is the Attachment folder of your
SampleManager instance. For more information, see the "Operating Environment"
chapter in the SampleManager LIMS System Administration Guide.
Index
A F
attachments, 151 filter by selection, 44
files, 154 filtering data
links, 153 explorer, 32
text notes, 152 fonts, 9
B G
browsing, 42 group by box, 29
favorite items, 44
filter by selection, 44
for record identities, 43, 46 J
recent items, 43, 47 jobs, 110
adding new samples, 120
authorization, 113
C data storage, 114
changing user, 9 displaying, 130
copying data, 35 identifying, 111
lifecycle, 112
login, 112, 123
D sample testing and result entry, 113
dynamic data, 4 status values, 114
E L
explorer, 20 locking a session, 8
choosing columns, 20 logging in to SampleManager, 5
copying data, 35
logging out of SampleManager, 8
data structure, 18
LTEs, 139
exporting data, 36
filtering data, 32
find, 34 M
grouping data, 29 menus, 17
locating data, 27
printing data, 38
reordering, 21 N
selecting data, 28 navigator, 17
exporting data, 36 data structure, 18
locating data, 27 T
tasks panel, 26
P test schedules
password, changing, 8 assigning to samples, 65
printing data, 38 tests, 85
headers and footers, 39 assigning test schedules to samples, 65
assigning to samples, 63
assignment, 89
R authorization, 90
reconnecting, 9 completion, 90
result entry, 100 identifying, 86, 92
ad-hoc results, 107 locating, 86, 92
for a sample, 104 preparation, 89
for multiple samples, 106 result entry, 89
results, 85 status values, 91
ad-hoc results, 107 toolbars, 17
identifying, 92
locating, 92
status values, 99 U
user
account, 3
S change user, 9
sample login, 59 changing password, 8
SampleManager screen, 16 lock session, 8
samples, 52 log in, 5
assigning test schedules, 65 logout, 9
assigning tests, 63 reconnect, 9
displaying, 73 security settings, 3
displaying results, 93
login, 59, 68 W
login to existing job, 120
web workspace, 26
modifying, 76
processing, 80
result entry, 104
skins, 11
static data, 4
adding, 141
copying, 143
displaying, 145
identifying, 136
listing, 147
LTEs, 139
modifying, 144
open, 22
printing, 146
property sheets, 137
removing, 149
restoring, 150
screens, 139
standard options, 140
status bar, 27